solidReaction< ReactionThermo > Class Template Reference

Read solid reactions of the type S1 = S2 + G1. More...

Inheritance diagram for solidReaction< ReactionThermo >:
[legend]
Collaboration diagram for solidReaction< ReactionThermo >:
[legend]

Public Member Functions

 TypeName ("SolidReaction")
 Runtime type information. More...
 
 solidReaction (const Reaction< ReactionThermo > &reaction, const speciesTable &pyrolisisGases, const List< specieCoeffs > &glhs, const List< specieCoeffs > &grhs)
 Construct from components. More...
 
 solidReaction (const solidReaction< ReactionThermo > &, const speciesTable &pyrolisisGases)
 Construct as copy given new speciesTable. More...
 
 solidReaction (const speciesTable &species, const ReactionTable< ReactionThermo > &thermoDatabase, const dictionary &dict)
 Construct from dictionary. More...
 
virtual autoPtr< Reaction< ReactionThermo > > clone () const
 Construct and return a clone. More...
 
virtual autoPtr< Reaction< ReactionThermo > > clone (const speciesTable &species) const
 Construct and return a clone with new speciesTable. More...
 
virtual ~solidReaction ()=default
 Destructor. More...
 
virtual const List< specieCoeffs > & grhs () const
 Access to gas components of the reaction. More...
 
virtual const List< specieCoeffs > & glhs () const
 
virtual const speciesTablegasSpecies () const
 Access to gas specie list. More...
 
virtual void write (Ostream &os) const
 Write. More...
 
- Public Member Functions inherited from Reaction< ReactionThermo >
 TypeName ("Reaction")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Reaction, dictionary,(const speciesTable &species, const ReactionTable< ReactionThermo > &thermoDatabase, const dictionary &dict),(species, thermoDatabase, dict))
 
 Reaction (const speciesTable &species, const List< specieCoeffs > &lhs, const List< specieCoeffs > &rhs, const ReactionTable< ReactionThermo > &thermoDatabase, bool initReactionThermo=true)
 Construct from components. More...
 
 Reaction (const Reaction< ReactionThermo > &, const speciesTable &species)
 Construct as copy given new speciesTable. More...
 
 Reaction (const speciesTable &species, const ReactionTable< ReactionThermo > &thermoDatabase, const dictionary &dict, bool initReactionThermo=true, bool failUnknownSpecie=true)
 Construct from dictionary. More...
 
virtual autoPtr< Reaction< ReactionThermo > > clone () const
 Construct and return a clone. More...
 
virtual autoPtr< Reaction< ReactionThermo > > clone (const speciesTable &species) const
 Construct and return a clone with new speciesTable. More...
 
virtual ~Reaction ()=default
 Destructor. More...
 
const wordname () const noexcept
 Name of reaction. More...
 
const speciesTablespecies () const noexcept
 Access to specie list. More...
 
const List< specieCoeffs > & lhs () const noexcept
 Specie info for the left-hand-side of the reaction. More...
 
const List< specieCoeffs > & rhs () const noexcept
 Specie info for the right-hand-side of the reaction. More...
 
virtual const speciesTablegasSpecies () const
 Access to gas specie list. More...
 
virtual const List< specieCoeffs > & grhs () const
 Access to gas components of the reaction. More...
 
virtual const List< specieCoeffs > & glhs () const
 
void setLRhs (Istream &, const speciesTable &, List< specieCoeffs > &lhs, List< specieCoeffs > &rhs, bool failUnknownSpecie=true)
 Construct the left- and right-hand-side reaction coefficients. More...
 
virtual scalar kf (const scalar p, const scalar T, const scalarField &c) const
 Forward rate constant. More...
 
virtual scalar kr (const scalar kfwd, const scalar p, const scalar T, const scalarField &c) const
 Reverse rate constant from the given forward rate constant. More...
 
virtual scalar kr (const scalar p, const scalar T, const scalarField &c) const
 Reverse rate constant. More...
 
virtual void write (Ostream &os) const
 Write. More...
 

Friends

Ostreamoperator (Ostream &, const solidReaction< ReactionThermo > &)
 

Additional Inherited Members

- Static Public Member Functions inherited from Reaction< ReactionThermo >
static autoPtr< Reaction< ReactionThermo > > New (const speciesTable &species, const ReactionTable< ReactionThermo > &thermoDatabase, const dictionary &dict)
 Return a pointer to new patchField created on freestore from dict. More...
 
- Static Public Attributes inherited from Reaction< ReactionThermo >
static label nUnNamedReactions = 0
 Number of un-named reactions. More...
 
- Protected Member Functions inherited from Reaction< ReactionThermo >
void reactionStrLeft (OStringStream &reaction) const
 Add string representation of the left of the reaction. More...
 
void reactionStrRight (OStringStream &reaction) const
 Add string representation of the right of the reaction. More...
 
- Static Protected Member Functions inherited from Reaction< ReactionThermo >
static void reactionStr (OStringStream &reaction, const speciesTable &species, const List< specieCoeffs > &reactCoeffs)
 Add string representation for given species reaction coeffs. More...
 

Detailed Description

template<class ReactionThermo>
class Foam::solidReaction< ReactionThermo >

Read solid reactions of the type S1 = S2 + G1.

Source files

Definition at line 61 of file solidReaction.H.

Constructor & Destructor Documentation

◆ solidReaction() [1/3]

solidReaction ( const Reaction< ReactionThermo > &  reaction,
const speciesTable pyrolisisGases,
const List< specieCoeffs > &  glhs,
const List< specieCoeffs > &  grhs 
)

Construct from components.

Definition at line 35 of file solidReaction.C.

◆ solidReaction() [2/3]

solidReaction ( const solidReaction< ReactionThermo > &  r,
const speciesTable pyrolisisGases 
)

Construct as copy given new speciesTable.

Definition at line 51 of file solidReaction.C.

◆ solidReaction() [3/3]

solidReaction ( const speciesTable species,
const ReactionTable< ReactionThermo > &  thermoDatabase,
const dictionary dict 
)

Construct from dictionary.

Definition at line 65 of file solidReaction.C.

References hashedWordList::appendUniq(), dict, dictionary::getString(), Reaction< ReactionThermo >::setLRhs(), and Reaction< ReactionThermo >::species().

Here is the call graph for this function:

◆ ~solidReaction()

virtual ~solidReaction ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "SolidReaction"  )

Runtime type information.

◆ clone() [1/2]

virtual autoPtr< Reaction< ReactionThermo > > clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from Reaction< ReactionThermo >.

Definition at line 130 of file solidReaction.H.

◆ clone() [2/2]

virtual autoPtr< Reaction< ReactionThermo > > clone ( const speciesTable species) const
inlinevirtual

Construct and return a clone with new speciesTable.

Reimplemented from Reaction< ReactionThermo >.

Definition at line 139 of file solidReaction.H.

References Reaction< ReactionThermo >::species().

Here is the call graph for this function:

◆ grhs()

const Foam::List< typename Foam::Reaction< ReactionThermo >::specieCoeffs > & grhs
virtual

Access to gas components of the reaction.

Reimplemented from Reaction< ReactionThermo >.

Definition at line 125 of file solidReaction.C.

◆ glhs()

const Foam::List< typename Foam::solidReaction< ReactionThermo >::specieCoeffs > & glhs
virtual

Reimplemented from Reaction< ReactionThermo >.

Definition at line 117 of file solidReaction.C.

◆ gasSpecies()

const Foam::speciesTable & gasSpecies
virtual

Access to gas specie list.

Reimplemented from Reaction< ReactionThermo >.

Definition at line 132 of file solidReaction.C.

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from Reaction< ReactionThermo >.

Definition at line 140 of file solidReaction.C.

References os(), reaction, and Ostream::writeEntry().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

Ostream & operator ( Ostream ,
const solidReaction< ReactionThermo > &   
)
friend

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