Public Member Functions | Private Attributes | Friends
thirdBodyEfficiencies Class Reference

Third body efficiencies. More...

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

Public Member Functions

 thirdBodyEfficiencies (const speciesTable &species, const scalarList &efficiencies)
 Construct from components. More...
 
 thirdBodyEfficiencies (const speciesTable &species, Istream &is)
 Construct from Istream. 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
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const T &)
 Construct with given size and value for all elements. More...
 
 List (const List< T > &)
 Copy constructor. More...
 
 List (const Xfer< List< T > > &)
 Construct by transferring the parameter contents. More...
 
 List (List< T > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< T > &, const labelUList &mapAddressing)
 Construct as subset. More...
 
template<class InputIterator >
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
template<unsigned Size>
 List (const FixedList< T, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< T > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< T > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< T > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< T > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (Istream &)
 Construct from Istream. More...
 
autoPtr< List< T > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
label size () const
 Return the number of elements in the UList. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void resize (const label, const T &)
 Alias for setSize(const label, const T&) More...
 
void setSize (const label)
 Reset size of List. More...
 
void setSize (const label, const T &)
 Reset size of List and value for new elements. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const T &)
 Append an element at the end of the list. More...
 
void append (const UList< T > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< T > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< T > &)
 Transfer the contents of the argument List into this list. More...
 
template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
void transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< T > &)
 Transfer the contents of the argument List into this list. More...
 
Xfer< List< T > > xfer ()
 Transfer contents to the Xfer container. More...
 
TnewElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< T > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< T > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< T > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< T > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< T > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
template<class T >
 List (const label s)
 
template<class T >
 List (const label s, const T &a)
 
template<class T >
 List (const List< T > &a)
 
template<class T >
 List (const Xfer< List< T > > &lst)
 
template<class T >
 List (List< T > &a, bool reUse)
 
template<class T >
 List (const UList< T > &a, const labelUList &map)
 
template<class T >
 List (const PtrList< T > &lst)
 
template<class T >
 List (const SLList< T > &lst)
 
template<class T >
 List (const UIndirectList< T > &lst)
 
template<class T >
 List (const BiIndirectList< T > &lst)
 
template<class T >
void transfer (List< T > &a)
 
template<class T >
void transfer (SortableList< T > &a)
 
template<class T >
 List ()
 
template<class T >
 List (Istream &is)
 

Private Attributes

const speciesTablespecies_
 

Friends

Ostreamoperator<< (Ostream &, const thirdBodyEfficiencies &)
 

Additional Inherited Members

- Public Types inherited from List
typedef SubList< TsubList
 Declare type of subList. More...
 
- Static Public Member Functions inherited from List
static const List< T > & null ()
 Return a null List. More...
 
- Protected Member Functions inherited from List
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 

Detailed Description

Third body efficiencies.

Source files

Definition at line 55 of file thirdBodyEfficiencies.H.

Constructor & Destructor Documentation

◆ thirdBodyEfficiencies() [1/3]

thirdBodyEfficiencies ( const speciesTable species,
const scalarList efficiencies 
)
inline

Construct from components.

Definition at line 31 of file thirdBodyEfficienciesI.H.

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

Here is the call graph for this function:

◆ thirdBodyEfficiencies() [2/3]

thirdBodyEfficiencies ( const speciesTable species,
Istream is 
)
inline

◆ thirdBodyEfficiencies() [3/3]

thirdBodyEfficiencies ( const speciesTable species,
const dictionary dict 
)
inline

Construct from dictionary.

Definition at line 106 of file thirdBodyEfficienciesI.H.

References dict, Foam::exit(), FatalErrorInFunction, Foam::FatalIOError, forAll, readScalar, and List::size().

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 140 of file thirdBodyEfficienciesI.H.

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

◆ write()

void write ( Ostream os) const
inline

Write to stream.

Definition at line 152 of file thirdBodyEfficienciesI.H.

References token::END_STATEMENT, forAll, Foam::nl, and Ostream::writeKeyword().

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

Field Documentation

◆ species_

const speciesTable& species_
private

Definition at line 61 of file thirdBodyEfficiencies.H.


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