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< T >
constexpr List () noexcept
 Null constructor. More...
 
 List (const label len)
 Construct with given size. More...
 
 List (const label len, const T &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 T &val)
 Construct with length=1, copying the value as the only content. More...
 
 List (const Foam::one, T &&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< T > &a)
 Copy construct from list. More...
 
 List (const UList< T > &a)
 Copy construct contents from list. More...
 
 List (List< T > &a, bool reuse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< T > &list, const labelUList &indices)
 Copy construct subset of list. More...
 
template<unsigned N>
 List (const UList< T > &list, const FixedList< label, N > &indices)
 Copy construct subset of list. More...
 
template<class InputIterator >
 List (InputIterator begIter, InputIterator endIter)
 Construct given begin/end iterators. More...
 
template<unsigned N>
 List (const FixedList< T, N > &list)
 Construct as copy of FixedList<T, N> More...
 
 List (const PtrList< T > &list)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< T > &list)
 Construct as copy of SLList<T> More...
 
template<class Addr >
 List (const IndirectListBase< T, Addr > &list)
 Construct as copy of IndirectList contents. More...
 
 List (std::initializer_list< T > list)
 Construct from an initializer list. More...
 
 List (List< T > &&list)
 Move construct from List. More...
 
template<int SizeMin>
 List (DynamicList< T, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (SortableList< T > &&list)
 Move construct from SortableList. More...
 
 List (SLList< T > &&list)
 Move construct from SLList. More...
 
 List (Istream &is)
 Construct from Istream. More...
 
autoPtr< List< T > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void resize (const label newSize)
 Adjust allocated size of list. More...
 
void resize (const label newSize, const T &val)
 Adjust allocated size of list and set val for new elements. More...
 
void setSize (const label newSize)
 Alias for resize(const label) More...
 
void setSize (const label newSize, const T &val)
 Alias for resize(const label, const T&) More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const T &val)
 Append an element at the end of the list. More...
 
void append (T &&val)
 Move append an element at the end of the list. More...
 
void append (const UList< T > &list)
 Append a List to the end of this list. More...
 
template<class Addr >
void append (const IndirectListBase< T, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
void transfer (List< T > &list)
 
template<int SizeMin>
void transfer (DynamicList< T, SizeMin > &list)
 
void transfer (SortableList< T > &list)
 
TnewElmt (const label i)
 
void operator= (const UList< T > &a)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< T > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< T > &list)
 Assignment to SLList operator. Takes linear time. More...
 
template<class Addr >
void operator= (const IndirectListBase< T, Addr > &list)
 Assignment from IndirectList. Takes linear time. More...
 
template<unsigned N>
void operator= (const FixedList< T, N > &list)
 Copy assignment from FixedList. More...
 
void operator= (std::initializer_list< T > list)
 Assignment to an initializer list. More...
 
void operator= (const T &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< T > &&list)
 Move assignment. Takes constant time. More...
 
template<int SizeMin>
void operator= (DynamicList< T, SizeMin > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SortableList< T > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SLList< T > &&list)
 Move assignment. Takes constant time. More...
 
void shallowCopy (const UList< T > &)=delete
 No shallowCopy permitted. More...
 
template<class TypeT = T>
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...
 
template<>
void resize (const label newSize)
 

Friends

Ostreamoperator<< (Ostream &, const thirdBodyEfficiencies &)
 

Additional Inherited Members

- Public Types inherited from List< T >
typedef SubList< TsubList
 Declare type of subList. More...
 
- Static Public Member Functions inherited from List< T >
static const List< T > & 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(), FatalErrorInFunction, Foam::FatalIOError, 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, 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: