ReactionProxy< ReactionThermo > Class Template Reference

Proxy version of Reaction which provides dummy implementations of the abstract virtual functions. More...

Inheritance diagram for ReactionProxy< ReactionThermo >:
Collaboration diagram for ReactionProxy< ReactionThermo >:

Public Member Functions

 ReactionProxy (const speciesTable &species, const List< specieCoeffs > &lhs, const List< specieCoeffs > &rhs, const HashPtrTable< ReactionThermo > &thermoDatabase)
 Construct from components. More...
 
 ReactionProxy (const Reaction< ReactionThermo > &, const speciesTable &species)
 Construct as copy given new speciesTable. More...
 
 ReactionProxy (const speciesTable &species, const HashPtrTable< 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 ~ReactionProxy ()
 Destructor. 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 scalar dkfdT (const scalar p, const scalar T, const scalarField &c) const
 Temperature derivative of forward rate. More...
 
virtual scalar dkrdT (const scalar p, const scalar T, const scalarField &c, const scalar dkfdT, const scalar kr) const
 Temperature derivative of reverse rate. More...
 
virtual const List< Tuple2< label, scalar > > & beta () const
 Third-body efficiencies (beta = 1-alpha) More...
 
virtual void dcidc (const scalar p, const scalar T, const scalarField &c, scalarField &dcidc) const
 Species concentration derivative of the pressure dependent term. More...
 
virtual scalar dcidT (const scalar p, const scalar T, const scalarField &c) const
 Temperature derivative of the pressure dependent term. More...
 
- Public Member Functions inherited from Reaction< ReactionThermo >
 TypeName ("Reaction")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Reaction, dictionary,(const speciesTable &species, const HashPtrTable< ReactionThermo > &thermoDatabase, const dictionary &dict),(species, thermoDatabase, dict))
 
 Reaction (const speciesTable &species, const List< specieCoeffs > &lhs, const List< specieCoeffs > &rhs, const HashPtrTable< ReactionThermo > &thermoDatabase)
 Construct from components. More...
 
 Reaction (const Reaction< ReactionThermo > &, const speciesTable &species)
 Construct as copy given new speciesTable. More...
 
 Reaction (const speciesTable &species, const HashPtrTable< ReactionThermo > &thermoDatabase, const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~Reaction ()
 Destructor. More...
 
const wordname () const
 Return the name of the reaction. More...
 
scalar Tlow () const
 Return the lower temperature limit for the reaction. More...
 
scalar Thigh () const
 Return the upper temperature limit for 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 speciesTablespecies () const
 Return the specie list. More...
 
void ddot (const scalar p, const scalar T, const scalarField &c, scalarField &d) const
 Forward reaction rate. More...
 
void fdot (const scalar p, const scalar T, const scalarField &c, scalarField &f) const
 Backward reaction rate. More...
 
void omega (const scalar p, const scalar T, const scalarField &c, scalarField &dcdt) const
 Net reaction rate for individual species. More...
 
scalar omega (const scalar p, const scalar T, const scalarField &c, scalar &pf, scalar &cf, label &lRef, scalar &pr, scalar &cr, label &rRef) const
 Net reaction rate. More...
 
void dwdc (const scalar p, const scalar T, const scalarField &c, scalarSquareMatrix &J, scalarField &dcdt, scalar &omegaI, scalar &kfwd, scalar &kbwd, const bool reduced, const List< label > &c2s) const
 Derivative of the net reaction rate for each species involved. More...
 
void dwdT (const scalar p, const scalar T, const scalarField &c, const scalar omegaI, const scalar kfwd, const scalar kbwd, scalarSquareMatrix &J, const bool reduced, const List< label > &c2s, const label indexT) const
 Derivative of the net reaction rate for each species involved. More...
 
virtual void write (Ostream &) const
 Write. More...
 
void operator= (const Reaction< ReactionThermo > &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Reaction< ReactionThermo >
static autoPtr< Reaction< ReactionThermo > > New (const speciesTable &species, const HashPtrTable< 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
 Number of un-named reactions. More...
 
static scalar TlowDefault
 Default temperature limits of applicability of reaction rates. More...
 
static scalar ThighDefault
 

Detailed Description

template<class ReactionThermo>
class Foam::ReactionProxy< ReactionThermo >

Proxy version of Reaction which provides dummy implementations of the abstract virtual functions.

Used for read-construction and format conversion.

Source files

Definition at line 52 of file ReactionProxy.H.

Constructor & Destructor Documentation

◆ ReactionProxy() [1/3]

ReactionProxy ( const speciesTable species,
const List< specieCoeffs > &  lhs,
const List< specieCoeffs > &  rhs,
const HashPtrTable< ReactionThermo > &  thermoDatabase 
)

Construct from components.

Definition at line 32 of file ReactionProxy.C.

Referenced by ReactionProxy< ReactionThermo >::ReactionProxy().

Here is the caller graph for this function:

◆ ReactionProxy() [2/3]

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

Construct as copy given new speciesTable.

Definition at line 51 of file ReactionProxy.C.

References ReactionProxy< ReactionThermo >::ReactionProxy().

Here is the call graph for this function:

◆ ReactionProxy() [3/3]

ReactionProxy ( const speciesTable species,
const HashPtrTable< ReactionThermo > &  thermoDatabase,
const dictionary dict 
)

Construct from dictionary.

Definition at line 66 of file ReactionProxy.C.

◆ ~ReactionProxy()

Member Function Documentation

◆ clone() [1/2]

Foam::autoPtr< Foam::Reaction< ReactionThermo > > clone ( ) const
virtual

Construct and return a clone.

Implements Reaction< ReactionThermo >.

Definition at line 83 of file ReactionProxy.C.

References NotImplemented.

◆ clone() [2/2]

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

Construct and return a clone with new speciesTable.

Implements Reaction< ReactionThermo >.

Definition at line 93 of file ReactionProxy.C.

References ReactionProxy< ReactionThermo >::kf(), and NotImplemented.

Here is the call graph for this function:

◆ kf()

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

Forward rate constant.

Implements Reaction< ReactionThermo >.

Definition at line 106 of file ReactionProxy.C.

References ReactionProxy< ReactionThermo >::kr(), and NotImplemented.

Referenced by ReactionProxy< ReactionThermo >::clone(), and ReactionProxy< ReactionThermo >::~ReactionProxy().

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

◆ kr() [1/2]

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

Reverse rate constant from the given forward rate constant.

Implements Reaction< ReactionThermo >.

Definition at line 119 of file ReactionProxy.C.

References NotImplemented.

Referenced by ReactionProxy< ReactionThermo >::kf(), and ReactionProxy< ReactionThermo >::~ReactionProxy().

Here is the caller graph for this function:

◆ kr() [2/2]

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

Reverse rate constant.

Implements Reaction< ReactionThermo >.

Definition at line 133 of file ReactionProxy.C.

References ReactionProxy< ReactionThermo >::dkfdT(), and NotImplemented.

Here is the call graph for this function:

◆ dkfdT()

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

Temperature derivative of forward rate.

Implements Reaction< ReactionThermo >.

Definition at line 146 of file ReactionProxy.C.

References ReactionProxy< ReactionThermo >::dkrdT(), and NotImplemented.

Referenced by ReactionProxy< ReactionThermo >::kr(), and ReactionProxy< ReactionThermo >::~ReactionProxy().

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

◆ dkrdT()

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

Temperature derivative of reverse rate.

Implements Reaction< ReactionThermo >.

Definition at line 159 of file ReactionProxy.C.

References NotImplemented.

Referenced by ReactionProxy< ReactionThermo >::dkfdT(), and ReactionProxy< ReactionThermo >::~ReactionProxy().

Here is the caller graph for this function:

◆ beta()

const Foam::List< Foam::Tuple2< Foam::label, Foam::scalar > > & beta ( ) const
virtual

Third-body efficiencies (beta = 1-alpha)

non-empty only for third-body reactions with enhanced molecularity (alpha != 1)

Implements Reaction< ReactionThermo >.

Definition at line 174 of file ReactionProxy.C.

References ReactionProxy< ReactionThermo >::dcidc(), and NotImplemented.

Referenced by ReactionProxy< ReactionThermo >::~ReactionProxy().

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

◆ dcidc()

void dcidc ( const scalar  p,
const scalar  T,
const scalarField c,
scalarField dcidc 
) const
virtual

Species concentration derivative of the pressure dependent term.

Implements Reaction< ReactionThermo >.

Definition at line 183 of file ReactionProxy.C.

References ReactionProxy< ReactionThermo >::dcidT(), and NotImplemented.

Referenced by ReactionProxy< ReactionThermo >::beta(), and ReactionProxy< ReactionThermo >::~ReactionProxy().

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

◆ dcidT()

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

Temperature derivative of the pressure dependent term.

Implements Reaction< ReactionThermo >.

Definition at line 196 of file ReactionProxy.C.

References NotImplemented.

Referenced by ReactionProxy< ReactionThermo >::dcidc(), and ReactionProxy< ReactionThermo >::~ReactionProxy().

Here is the caller graph for this function:

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