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...

Collaboration diagram for specieCoeffs:
Collaboration graph
[legend]

Public Member Functions

 specieCoeffs ()
 Construct null. More...
 
 specieCoeffs (const speciesTable &species, Istream &is)
 Construct from species table and input stream. More...
 
bool operator== (const specieCoeffs &sc) const
 Equality comparison. More...
 
bool operator!= (const specieCoeffs &sc) const
 Inequality comparison. More...
 

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
 Index of the specie. More...
 
scalar stoichCoeff
 Stoichiometric coefficient. More...
 
specieExponent exponent
 Exponent of the specie concentration. More...
 

Friends

Ostream & operator<< (Ostream &os, const specieCoeffs &sc)
 Write to output stream. More...
 

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

Construct null.

Definition at line 73 of file specieCoeffs.H.

◆ specieCoeffs() [2/2]

specieCoeffs ( const speciesTable &  species,
Istream &  is 
)

Construct from species table and input stream.

Definition at line 33 of file specieCoeffs.C.

References Foam::exit(), specieCoeffs::exponent, Foam::FatalIOError, FatalIOErrorInFunction, hashedWordList::found(), specieCoeffs::index, token::info(), token::isNumber(), token::isWord(), token::number(), specieCoeffs::stoichCoeff, and token::wordToken().

Here is the call graph for this function:

Member Function Documentation

◆ 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 94 of file specieCoeffs.C.

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

Referenced by fluxLimitedLangmuirHinshelwoodReactionRate::fluxLimitedLangmuirHinshelwoodReactionRate(), and reaction::reaction().

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 176 of file specieCoeffs.C.

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

Referenced by reaction::write().

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 202 of file specieCoeffs.C.

◆ operator==()

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

Equality comparison.

Definition at line 116 of file specieCoeffs.H.

References specieCoeffs::index.

◆ operator!=()

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

Inequality comparison.

Definition at line 122 of file specieCoeffs.H.

References specieCoeffs::index.

Friends And Related Function Documentation

◆ operator<<

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

Write to output stream.

Definition at line 128 of file specieCoeffs.H.

Member Data Documentation

◆ index

label index

Index of the specie.

Definition at line 61 of file specieCoeffs.H.

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

◆ stoichCoeff

scalar stoichCoeff

Stoichiometric coefficient.

Definition at line 64 of file specieCoeffs.H.

Referenced by specieCoeffs::specieCoeffs().

◆ exponent

specieExponent exponent

Exponent of the specie concentration.

Definition at line 67 of file specieCoeffs.H.

Referenced by specieCoeffs::specieCoeffs().

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