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

Reaction base-class holding the specie names and coefficients. More...

Inheritance diagram for reaction:
Inheritance graph
[legend]

Public Member Functions

 reaction (const speciesTable &species, const List< specieCoeffs > &lhs, const List< specieCoeffs > &rhs)
 Construct from components. More...
 
 reaction (const reaction &, const speciesTable &species)
 Construct as copy given new speciesTable. More...
 
 reaction (const speciesTable &species, const dictionary &dict)
 Construct from dictionary. More...
 
 ~reaction ()
 Destructor. More...
 
const word & name () const
 Return the name of the reaction. More...
 
const List< specieCoeffs > & lhs () const
 Return the components of the left hand side. More...
 
const List< specieCoeffs > & rhs () const
 Return the components of the right hand side. More...
 
const speciesTable & species () const
 Return the specie list. More...
 
void write (Ostream &) const
 Write. More...
 
void operator= (const reaction &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Attributes

static label nUnNamedReactions
 Number of un-named reactions. More...
 

Friends

Ostream & operator<< (Ostream &, const reaction &)
 

Detailed Description

Reaction base-class holding the specie names and coefficients.

Source files

Definition at line 56 of file reaction.H.

Constructor & Destructor Documentation

◆ reaction() [1/3]

reaction ( const speciesTable &  species,
const List< specieCoeffs > &  lhs,
const List< specieCoeffs > &  rhs 
)

Construct from components.

Definition at line 45 of file reaction.C.

◆ reaction() [2/3]

reaction ( const reaction &  r,
const speciesTable &  species 
)

Construct as copy given new speciesTable.

Definition at line 59 of file reaction.C.

◆ reaction() [3/3]

reaction ( const speciesTable &  species,
const dictionary &  dict 
)

Construct from dictionary.

Definition at line 72 of file reaction.C.

References dict, and specieCoeffs::setLRhs().

Here is the call graph for this function:

◆ ~reaction()

~reaction ( )
inline

Destructor.

Definition at line 114 of file reaction.H.

Member Function Documentation

◆ name()

const Foam::word & name ( ) const
inline

Return the name of the reaction.

Definition at line 30 of file reactionI.H.

◆ lhs()

const Foam::List< Foam::specieCoeffs > & lhs ( ) const
inline

Return the components of the left hand side.

Definition at line 36 of file reactionI.H.

Referenced by singleStepCombustion::calculateqFuel().

Here is the caller graph for this function:

◆ rhs()

const Foam::List< Foam::specieCoeffs > & rhs ( ) const
inline

Return the components of the right hand side.

Definition at line 42 of file reactionI.H.

Referenced by singleStepCombustion::calculateqFuel(), and mixtureFraction::mixtureFraction().

Here is the caller graph for this function:

◆ species()

const Foam::speciesTable & species ( ) const
inline

Return the specie list.

Definition at line 48 of file reactionI.H.

Referenced by IrreversibleReaction< ThermoType, ReactionRate >::clone(), NonEquilibriumReversibleReaction< ThermoType, ReactionRate >::clone(), and ReversibleReaction< ThermoType, ReactionRate >::clone().

Here is the caller graph for this function:

◆ write()

void write ( Ostream &  os) const

Write.

Definition at line 93 of file reaction.C.

References specieCoeffs::reactionStr(), and Foam::writeEntry().

Referenced by Foam::operator<<(), and Reaction< ThermoType >::write().

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

◆ operator=()

void operator= ( const reaction &  )
delete

Disallow default bitwise assignment.

Friends And Related Function Documentation

◆ operator<<

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

Member Data Documentation

◆ nUnNamedReactions

Foam::label nUnNamedReactions
static

Number of un-named reactions.

Definition at line 64 of file reaction.H.

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