thirdBodyEfficiencies Class Reference

Third body efficiencies. More...

Inheritance diagram for thirdBodyEfficiencies:
[legend]
Collaboration diagram for thirdBodyEfficiencies:
[legend]

Public Member Functions

 thirdBodyEfficiencies (const speciesTable &species, const scalarList &efficiencies)
 Construct from components. More...
 
 thirdBodyEfficiencies (const speciesTable &species, const dictionary &dict)
 Construct from dictionary. More...
 
scalar M (const scalarList &c) const
 Calculate and return M, the concentration of the third-bodies. More...
 
void write (Ostream &os) const
 Write to stream. More...
 
- Public Member Functions inherited from List< scalar >
constexpr List () noexcept
 Default construct. More...
 
 List (const label len)
 Construct with given size. More...
 
 List (const label len, const scalar &val)
 Construct with given size and value for all elements. More...
 
 List (const label len, const Foam::zero)
 Construct with given size initializing all elements to zero. More...
 
 List (const Foam::one, const scalar &val)
 Construct with length=1, copying the value as the only content. More...
 
 List (const Foam::one, scalar &&val)
 Construct with length=1, moving the value as the only content. More...
 
 List (const Foam::one, const Foam::zero)
 Construct with length=1, initializing content to zero. More...
 
 List (const List< scalar > &a)
 Copy construct from list. More...
 
 List (const UList< scalar > &a)
 Copy construct contents from list. More...
 
 List (List< scalar > &a, bool reuse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< scalar > &list, const labelUList &indices)
 Copy construct subset of list. More...
 
 List (const UList< scalar > &list, const FixedList< label, N > &indices)
 Copy construct subset of list. More...
 
 List (const FixedList< scalar, N > &list)
 Construct as copy of FixedList<T, N> More...
 
 List (const PtrList< scalar > &list)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< scalar > &list)
 Construct as copy of SLList<T> More...
 
 List (const IndirectListBase< scalar, Addr > &list)
 Construct as copy of IndirectList contents. More...
 
 List (std::initializer_list< scalar > list)
 Construct from an initializer list. More...
 
 List (List< scalar > &&list)
 Move construct from List. More...
 
 List (DynamicList< scalar, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (SortableList< scalar > &&list)
 Move construct from SortableList. More...
 
 List (SLList< scalar > &&list)
 Move construct from SLList. More...
 
 List (Istream &is)
 Construct from Istream. More...
 
autoPtr< List< scalar > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void resize (const label len)
 Adjust allocated size of list. More...
 
void resize (const label len, const scalar &val)
 Adjust allocated size of list and set val for new elements. More...
 
void resize (const label newLen)
 
void resize_nocopy (const label len)
 Adjust allocated size of list without necessarily. More...
 
void setSize (const label n)
 Alias for resize() More...
 
void setSize (const label n, const scalar &val)
 Alias for resize() More...
 
void append (const scalar &val)
 Append an element at the end of the list. More...
 
void append (scalar &&val)
 Move append an element at the end of the list. More...
 
void append (const UList< scalar > &list)
 Append a List to the end of this list. More...
 
void append (const IndirectListBase< scalar, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label appendUniq (const scalar &val)
 Append an element if not already in the list. More...
 
void transfer (List< scalar > &list)
 
void transfer (DynamicList< scalar, SizeMin > &list)
 
void transfer (SortableList< scalar > &list)
 
scalar & newElmt (const label i)
 
void operator= (const UList< scalar > &a)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< scalar > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< scalar > &list)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const IndirectListBase< scalar, Addr > &list)
 Assignment from IndirectList. Takes linear time. More...
 
void operator= (const FixedList< scalar, N > &list)
 Copy assignment from FixedList. More...
 
void operator= (std::initializer_list< scalar > list)
 Assignment to an initializer list. More...
 
void operator= (const scalar &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
void operator= (List< scalar > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (DynamicList< scalar, SizeMin > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SortableList< scalar > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SLList< scalar > &&list)
 Move assignment. Takes constant time. More...
 
IstreamreadList (Istream &is)
 Read List from Istream, discarding contents of existing List. More...
 
IstreamreadList (Istream &is)
 
IstreamreadList (Istream &is)
 
void shallowCopy (const UList< scalar > &)=delete
 No shallowCopy permitted. More...
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type set (const label i, bool val=true)
 A bitSet::set() method for a list of bool. More...
 

Friends

Ostreamoperator<< (Ostream &, const thirdBodyEfficiencies &)
 

Additional Inherited Members

- Public Types inherited from List< scalar >
typedef SubList< scalar > subList
 Declare type of subList. More...
 
- Static Public Member Functions inherited from List< scalar >
static const List< scalar > & null ()
 Return a null List. More...
 

Detailed Description

Third body efficiencies.

Source files

Definition at line 57 of file thirdBodyEfficiencies.H.

Constructor & Destructor Documentation

◆ thirdBodyEfficiencies() [1/2]

thirdBodyEfficiencies ( const speciesTable species,
const scalarList efficiencies 
)
inline

Construct from components.

Definition at line 33 of file thirdBodyEfficienciesI.H.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ thirdBodyEfficiencies() [2/2]

thirdBodyEfficiencies ( const speciesTable species,
const dictionary dict 
)
inline

Construct from dictionary.

Definition at line 52 of file thirdBodyEfficienciesI.H.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and forAll.

Here is the call graph for this function:

Member Function Documentation

◆ M()

Foam::scalar M ( const scalarList c) const
inline

Calculate and return M, the concentration of the third-bodies.

Definition at line 86 of file thirdBodyEfficienciesI.H.

References Foam::constant::universal::c, and forAll.

◆ write()

void write ( Ostream os) const
inline

Write to stream.

Definition at line 98 of file thirdBodyEfficienciesI.H.

References forAll, os(), and Ostream::writeEntry().

Referenced by thirdBodyArrheniusReactionRate::write().

Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream ,
const thirdBodyEfficiencies  
)
friend

The documentation for this class was generated from the following files: