Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
Reaction Class Reference

Simple extension of ReactionThermo to handle reaction kinetics in addition to the equilibrium thermodynamics already handled. More...

Classes

struct  specieCoeffs
 

Public Member Functions

 TypeName ("Reaction")
 
 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)
 
 Reaction (const Reaction< ReactionThermo > &, const speciesTable &species)
 
 Reaction (const speciesTable &species, const ReactionTable< ReactionThermo > &thermoDatabase, const dictionary &dict, bool initReactionThermo=true)
 
virtual autoPtr< Reaction< ReactionThermo > > clone () const
 
virtual autoPtr< Reaction< ReactionThermo > > clone (const speciesTable &species) const
 
virtual ~Reaction ()=default
 
const word & name () const noexcept
 
const speciesTable & species () const noexcept
 
const List< specieCoeffs > & lhs () const noexcept
 
const List< specieCoeffs > & rhs () const noexcept
 
virtual const speciesTable & gasSpecies () const
 
virtual const List< specieCoeffs > & grhs () const
 
virtual const List< specieCoeffs > & glhs () const
 
void setLRhs (Istream &, const speciesTable &, List< specieCoeffs > &lhs, List< specieCoeffs > &rhs)
 
virtual scalar kf (const scalar p, const scalar T, const scalarField &c) const
 
virtual scalar kr (const scalar kfwd, const scalar p, const scalar T, const scalarField &c) const
 
virtual scalar kr (const scalar p, const scalar T, const scalarField &c) const
 
virtual void write (Ostream &os) const
 

Static Public Member Functions

static autoPtr< Reaction< ReactionThermo > > New (const speciesTable &species, const ReactionTable< ReactionThermo > &thermoDatabase, const dictionary &dict)
 

Static Public Attributes

static label nUnNamedReactions = 0
 

Protected Member Functions

void reactionStrLeft (OStringStream &reaction) const
 
void reactionStrRight (OStringStream &reaction) const
 

Friends

Ostream & operator (Ostream &, const Reaction< ReactionThermo > &)
 

Detailed Description

Simple extension of ReactionThermo to handle reaction kinetics in addition to the equilibrium thermodynamics already handled.

Source files

Definition at line 55 of file Reaction.H.

Constructor & Destructor Documentation

◆ Reaction() [1/3]

Reaction ( const speciesTable &  species,
const List< specieCoeffs > &  lhs,
const List< specieCoeffs > &  rhs,
const ReactionTable< ReactionThermo > &  thermoDatabase,
bool  initReactionThermo = true 
)

◆ Reaction() [2/3]

Reaction ( const Reaction< ReactionThermo > &  ,
const speciesTable &  species 
)

◆ Reaction() [3/3]

Reaction ( const speciesTable &  species,
const ReactionTable< ReactionThermo > &  thermoDatabase,
const dictionary &  dict,
bool  initReactionThermo = true 
)

◆ ~Reaction()

virtual ~Reaction ( )
virtualdefault

Member Function Documentation

◆ reactionStrLeft()

void reactionStrLeft ( OStringStream &  reaction) const
protected

Definition at line 35 of file Reaction.C.

References Foam::mag(), and reaction.

Here is the call graph for this function:

◆ reactionStrRight()

void reactionStrRight ( OStringStream &  reaction) const
protected

Definition at line 60 of file Reaction.C.

References Foam::mag(), and reaction.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "Reaction"  )

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
Reaction  ,
dictionary  ,
(const speciesTable &species, const ReactionTable< ReactionThermo > &thermoDatabase, const dictionary &dict)  ,
(species, thermoDatabase, dict)   
)

◆ clone() [1/2]

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

Definition at line 214 of file Reaction.H.

References Reaction::New().

Here is the call graph for this function:

◆ clone() [2/2]

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

Definition at line 221 of file Reaction.H.

References Reaction::New(), and Reaction::species().

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::Reaction< ReactionThermo > > New ( const speciesTable &  species,
const ReactionTable< ReactionThermo > &  thermoDatabase,
const dictionary &  dict 
)
static

Definition at line 347 of file Reaction.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and dictionary::get().

Referenced by Reaction::clone().

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

◆ name()

const word& name ( ) const
inlinenoexcept

Definition at line 249 of file Reaction.H.

Referenced by ReactionList< Foam::sutherlandTransport >::write().

Here is the caller graph for this function:

◆ species()

const speciesTable& species ( ) const
inlinenoexcept

Definition at line 252 of file Reaction.H.

Referenced by Reaction::clone().

Here is the caller graph for this function:

◆ lhs()

const List<specieCoeffs>& lhs ( ) const
inlinenoexcept

Definition at line 255 of file Reaction.H.

◆ rhs()

const List<specieCoeffs>& rhs ( ) const
inlinenoexcept

Definition at line 258 of file Reaction.H.

◆ gasSpecies()

const Foam::speciesTable & gasSpecies ( ) const
virtual

Definition at line 423 of file Reaction.C.

References NotImplemented.

◆ grhs()

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

Definition at line 441 of file Reaction.C.

References NotImplemented.

◆ glhs()

const Foam::List< typename Foam::Reaction< ReactionThermo >::specieCoeffs > & glhs ( ) const
virtual

Definition at line 432 of file Reaction.C.

References NotImplemented.

◆ setLRhs()

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

Definition at line 233 of file Reaction.C.

References token::ADD, DynamicList::append(), token::ASSIGN, DynamicList::clear(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOstream::good(), token::isPunctuation(), Istream::putBack(), DynamicList::remove(), and DynamicList::shrink().

Here is the call graph for this function:

◆ kf()

Foam::scalar kf ( const scalar  p,
const scalar  T,
const scalarField &  c 
) const
virtual

Definition at line 387 of file Reaction.C.

◆ kr() [1/2]

Foam::scalar kr ( const scalar  kfwd,
const scalar  p,
const scalar  T,
const scalarField &  c 
) const
virtual

Definition at line 399 of file Reaction.C.

◆ kr() [2/2]

Foam::scalar kr ( const scalar  p,
const scalar  T,
const scalarField &  c 
) const
virtual

Definition at line 412 of file Reaction.C.

◆ write()

void write ( Ostream &  os) const
virtual

Definition at line 378 of file Reaction.C.

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

Referenced by ReactionList< Foam::sutherlandTransport >::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 Reaction< ReactionThermo > &   
)
friend

Member Data Documentation

◆ nUnNamedReactions

Foam::label nUnNamedReactions = 0
static

Definition at line 75 of file Reaction.H.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17