Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
specieCoeffs Class Reference

Class to hold the specie index and its coefficients in the reaction rate expression. More...

Public Member Functions

 specieCoeffs ()
 
 specieCoeffs (const speciesTable &species, Istream &is)
 
bool operator== (const specieCoeffs &sc) const
 
bool operator!= (const specieCoeffs &sc) const
 

Static Public Member Functions

static void setLRhs (Istream &, const speciesTable &, List< specieCoeffs > &lhs, List< specieCoeffs > &rhs)
 Construct the left- and right-hand-side reaction coefficients. More...
 
static void reactionStr (OStringStream &reaction, const speciesTable &, const List< specieCoeffs > &scs)
 Write the string representation of the specieCoeffs list. More...
 
static string reactionStr (OStringStream &reaction, const speciesTable &, const List< specieCoeffs > &lhs, const List< specieCoeffs > &rhs)
 Return string representation of reaction. More...
 

Public Attributes

label index
 
scalar stoichCoeff
 
scalar exponent
 

Friends

Ostream & operator<< (Ostream &os, const specieCoeffs &sc)
 

Detailed Description

Class to hold the specie index and its coefficients in the reaction rate expression.

Source files

Definition at line 54 of file specieCoeffs.H.

Constructor & Destructor Documentation

◆ specieCoeffs() [1/2]

specieCoeffs ( )
inline

Definition at line 62 of file specieCoeffs.H.

◆ specieCoeffs() [2/2]

specieCoeffs ( const speciesTable &  species,
Istream &  is 
)

Definition at line 34 of file specieCoeffs.C.

References hashedWordList::contains(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, token::info(), token::isNumber(), token::isWord(), token::number(), specieCoeffs::setLRhs(), and token::wordToken().

Here is the call graph for this function:

Member Function Documentation

◆ operator==()

bool operator== ( const specieCoeffs &  sc) const
inline

Definition at line 71 of file specieCoeffs.H.

References specieCoeffs::index.

◆ operator!=()

bool operator!= ( const specieCoeffs &  sc) const
inline

Definition at line 76 of file specieCoeffs.H.

References specieCoeffs::index.

◆ setLRhs()

void setLRhs ( Istream &  is,
const speciesTable &  species,
List< specieCoeffs > &  lhs,
List< specieCoeffs > &  rhs 
)
static

Construct the left- and right-hand-side reaction coefficients.

Definition at line 100 of file specieCoeffs.C.

References DynamicList< T, SizeInc, SizeMult, SizeDiv >::append(), DynamicList< T, SizeInc, SizeMult, SizeDiv >::clear(), UList< T >::empty(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOstream::good(), token::isPunctuation(), UList< T >::last(), Istream::putBack(), specieCoeffs::reactionStr(), DynamicList< T, SizeInc, SizeMult, SizeDiv >::remove(), and DynamicList< T, SizeInc, SizeMult, SizeDiv >::shrink().

Referenced by Foam::operator<<(), and specieCoeffs::specieCoeffs().

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

◆ reactionStr() [1/2]

void reactionStr ( OStringStream &  reaction,
const speciesTable &  species,
const List< specieCoeffs > &  scs 
)
static

Write the string representation of the specieCoeffs list.

Definition at line 182 of file specieCoeffs.C.

References Foam::mag(), and List< T >::size().

Referenced by Foam::operator<<(), and specieCoeffs::setLRhs().

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

◆ reactionStr() [2/2]

Foam::string reactionStr ( OStringStream &  reaction,
const speciesTable &  species,
const List< specieCoeffs > &  lhs,
const List< specieCoeffs > &  rhs 
)
static

Return string representation of reaction.

Definition at line 208 of file specieCoeffs.C.

References OStringStream::str().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream &  os,
const specieCoeffs &  sc 
)
friend

Definition at line 81 of file specieCoeffs.H.

Member Data Documentation

◆ index

label index

Definition at line 58 of file specieCoeffs.H.

Referenced by specieCoeffs::operator!=(), Foam::operator<<(), and specieCoeffs::operator==().

◆ stoichCoeff

scalar stoichCoeff

Definition at line 59 of file specieCoeffs.H.

Referenced by Foam::operator<<().

◆ exponent

scalar exponent

Definition at line 60 of file specieCoeffs.H.

Referenced by Foam::operator<<().

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