Public Member Functions | Static Public Member Functions | Friends | List of all members
ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction > Class Template Reference

General class for handling chemically-activated bimolecular reactions. More...

Public Member Functions

 ChemicallyActivatedReactionRate (const ReactionRate &k0, const ReactionRate &kInf, const ChemicallyActivationFunction &F, const thirdBodyEfficiencies &tbes)
 Construct from components. More...
 
 ChemicallyActivatedReactionRate (const speciesTable &species, const dictionary &dict)
 Construct from dictionary. More...
 
void preEvaluate () const
 Pre-evaluation hook. More...
 
void postEvaluate () const
 Post-evaluation hook. More...
 
scalar operator() (const scalar p, const scalar T, const scalarField &c, const label li) const
 Return the rate. More...
 
scalar ddT (const scalar p, const scalar T, const scalarField &c, const label li) const
 The derivative of the rate w.r.t. temperature. More...
 
bool hasDdc () const
 Is the rate a function of concentration? More...
 
void ddc (const scalar p, const scalar T, const scalarField &c, const label li, scalarField &ddc) const
 The derivative of the rate w.r.t. concentration. More...
 
void write (Ostream &os) const
 Write to stream. More...
 

Static Public Member Functions

static word type ()
 Return the type name. More...
 

Friends

Ostream & operator (Ostream &, const ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction > &)
 

Detailed Description

template<class ReactionRate, class ChemicallyActivationFunction>
class Foam::ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >

General class for handling chemically-activated bimolecular reactions.

Source files

Definition at line 47 of file ChemicallyActivatedReactionRate.H.

Constructor & Destructor Documentation

◆ ChemicallyActivatedReactionRate() [1/2]

ChemicallyActivatedReactionRate ( const ReactionRate &  k0,
const ReactionRate &  kInf,
const ChemicallyActivationFunction &  F,
const thirdBodyEfficiencies &  tbes 
)
inline

Construct from components.

Definition at line 36 of file ChemicallyActivatedReactionRateI.H.

◆ ChemicallyActivatedReactionRate() [2/2]

ChemicallyActivatedReactionRate ( const speciesTable &  species,
const dictionary &  dict 
)
inline

Construct from dictionary.

Definition at line 56 of file ChemicallyActivatedReactionRateI.H.

Member Function Documentation

◆ type()

static word type ( )
inlinestatic

Return the type name.

Definition at line 97 of file ChemicallyActivatedReactionRate.H.

References Foam::constant::universal::c, ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::ddc(), ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::ddT(), ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::hasDdc(), ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::operator, p, ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::postEvaluate(), ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::preEvaluate(), Foam::T(), Foam::type(), and ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::write().

Here is the call graph for this function:

◆ preEvaluate()

void preEvaluate ( ) const
inline

Pre-evaluation hook.

Definition at line 75 of file ChemicallyActivatedReactionRateI.H.

References ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::preEvaluate().

Referenced by ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::preEvaluate(), and ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::type().

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

◆ postEvaluate()

void postEvaluate ( ) const
inline

Post-evaluation hook.

Definition at line 87 of file ChemicallyActivatedReactionRateI.H.

References ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::postEvaluate().

Referenced by ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::postEvaluate(), and ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::type().

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

◆ operator()()

Foam::scalar operator() ( const scalar  p,
const scalar  T,
const scalarField &  c,
const label  li 
) const
inline

Return the rate.

Definition at line 100 of file ChemicallyActivatedReactionRateI.H.

References M.

◆ ddT()

Foam::scalar ddT ( const scalar  p,
const scalar  T,
const scalarField &  c,
const label  li 
) const
inline

The derivative of the rate w.r.t. temperature.

Definition at line 123 of file ChemicallyActivatedReactionRateI.H.

References M, and Foam::sqr().

Referenced by ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::type().

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

◆ hasDdc()

bool hasDdc ( ) const
inline

Is the rate a function of concentration?

Definition at line 162 of file ChemicallyActivatedReactionRateI.H.

Referenced by ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::type().

Here is the caller graph for this function:

◆ ddc()

void ddc ( const scalar  p,
const scalar  T,
const scalarField &  c,
const label  li,
scalarField &  ddc 
) const
inline

The derivative of the rate w.r.t. concentration.

Definition at line 174 of file ChemicallyActivatedReactionRateI.H.

References M, List< T >::size(), and Foam::sqr().

Referenced by ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::type().

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

◆ write()

void write ( Ostream &  os) const
inline

Write to stream.

Definition at line 219 of file ChemicallyActivatedReactionRateI.H.

References Foam::decrIndent(), Foam::incrIndent(), Foam::indent(), Foam::nl, and Ostream::write().

Referenced by ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::type().

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 ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction > &   
)
friend

Referenced by ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::type().

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