OpenFOAM logo
Open Source CFD Toolkit

Reaction Class Template Reference

Inheritance diagram for Reaction:

Inheritance graph
[legend]
Collaboration diagram for Reaction:

Collaboration graph
[legend]
List of all members.

template<class ReactionThermo>
class Foam::Reaction< ReactionThermo >


Public Member Functions

 TypeName ("Reaction")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, Reaction, Istream,(const speciesTable &species, const HashPtrTable< ReactionThermo > &thermoDatabase, Istream &is),(species, thermoDatabase, is))
 Reaction (const speciesTable &species, const List< specieCoeffs > &lhs, const List< specieCoeffs > &rhs, const HashPtrTable< ReactionThermo > &thermoDatabase)
 Construct from components.
 Reaction (const Reaction< ReactionThermo > &, const speciesTable &species)
 Construct as copy given new speciesTable.
 Reaction (const speciesTable &species, const HashPtrTable< ReactionThermo > &thermoDatabase, Istream &is)
 Construct from Istream.
virtual autoPtr< Reaction<
ReactionThermo > > 
clone () const
 Construct and return a clone.
virtual autoPtr< Reaction<
ReactionThermo > > 
clone (const speciesTable &species) const
 Construct and return a clone with new speciesTable.
virtual ~Reaction ()
const List< specieCoeffs > & lhs () const
const List< specieCoeffs > & rhs () const
virtual scalar kf (const scalar T, const scalar p, const scalarField &c) const
 Forward rate constant.
virtual scalar kr (const scalar kfwd, const scalar T, const scalar p, const scalarField &c) const
 Reverse rate constant from the given forward rate constant.
virtual scalar kr (const scalar T, const scalar p, const scalarField &c) const
 Reverse rate constant.
virtual void write (Ostream &) const
 Write.

Static Public Member Functions

autoPtr< Reaction< ReactionThermo > > New (const speciesTable &species, const HashPtrTable< ReactionThermo > &thermoDatabase, Istream &)
 Return a pointer to a new patchField created on freestore from input.

Friends

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

Constructor & Destructor Documentation

Reaction const speciesTable species,
const List< specieCoeffs > &  lhs,
const List< specieCoeffs > &  rhs,
const HashPtrTable< ReactionThermo > &  thermoDatabase
 

Construct from components.

Reaction const Reaction< ReactionThermo > &  ,
const speciesTable species
 

Construct as copy given new speciesTable.

Reaction const speciesTable species,
const HashPtrTable< ReactionThermo > &  thermoDatabase,
Istream is
 

Construct from Istream.

virtual ~Reaction  )  [inline, virtual]
 

Definition at line 249 of file Reaction.H.


Member Function Documentation

virtual autoPtr<Reaction<ReactionThermo> > clone const speciesTable species  )  const [inline, virtual]
 

Construct and return a clone with new speciesTable.

Reimplemented in IrreversibleReaction, NonEquilibriumReversibleReaction, and ReversibleReaction.

Definition at line 225 of file Reaction.H.

virtual autoPtr<Reaction<ReactionThermo> > clone  )  const [inline, virtual]
 

Construct and return a clone.

Reimplemented in IrreversibleReaction, NonEquilibriumReversibleReaction, and ReversibleReaction.

Definition at line 215 of file Reaction.H.

declareRunTimeSelectionTable autoPtr  ,
Reaction< ReactionThermo >  ,
Istream  ,
(const speciesTable &species, const HashPtrTable< ReactionThermo > &thermoDatabase, Istream &is)  ,
(species, thermoDatabase, is) 
 

virtual scalar kf const scalar  T,
const scalar  p,
const scalarField c
const [virtual]
 

Forward rate constant.

Reimplemented in IrreversibleReaction, NonEquilibriumReversibleReaction, and ReversibleReaction.

virtual scalar kr const scalar  T,
const scalar  p,
const scalarField c
const [virtual]
 

Reverse rate constant.

Note this evaluates the forward rate constant and divides by the equilibrium constant

Reimplemented in NonEquilibriumReversibleReaction, and ReversibleReaction.

virtual scalar kr const scalar  kfwd,
const scalar  T,
const scalar  p,
const scalarField c
const [virtual]
 

Reverse rate constant from the given forward rate constant.

Reimplemented in NonEquilibriumReversibleReaction, and ReversibleReaction.

const List< typename Reaction< ReactionThermo >::specieCoeffs > & lhs  )  const [inline]
 

Definition at line 50 of file ReactionI.H.

autoPtr<Reaction<ReactionThermo> > New const speciesTable species,
const HashPtrTable< ReactionThermo > &  thermoDatabase,
Istream
[static]
 

Return a pointer to a new patchField created on freestore from input.

const List< typename Reaction< ReactionThermo >::specieCoeffs > & rhs  )  const [inline]
 

Definition at line 58 of file ReactionI.H.

TypeName "Reaction< ReactionThermo >"   ) 
 

Runtime type information.

virtual void write Ostream  )  const [virtual]
 

Write.

Reimplemented in IrreversibleReaction, NonEquilibriumReversibleReaction, and ReversibleReaction.


Friends And Related Function Documentation

Ostream& operator Ostream ,
const Reaction< ReactionThermo > & 
[friend]
 


The documentation for this class was generated from the following files:
For further information go to www.openfoam.org