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

General class for handling unimolecular/recombination fall-off reactions. More...

Public Member Functions

 FallOffReactionRate (const ReactionRate &k0, const ReactionRate &kInf, const FallOffFunction &F, const thirdBodyEfficiencies &tbes)
 Construct from components. More...
 
 FallOffReactionRate (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 FallOffReactionRate< ReactionRate, FallOffFunction > &)
 

Detailed Description

template<class ReactionRate, class FallOffFunction>
class Foam::FallOffReactionRate< ReactionRate, FallOffFunction >

General class for handling unimolecular/recombination fall-off reactions.

Source files

Definition at line 47 of file FallOffReactionRate.H.

Constructor & Destructor Documentation

◆ FallOffReactionRate() [1/2]

FallOffReactionRate ( const ReactionRate &  k0,
const ReactionRate &  kInf,
const FallOffFunction &  F,
const thirdBodyEfficiencies &  tbes 
)
inline

Construct from components.

Definition at line 33 of file FallOffReactionRateI.H.

◆ FallOffReactionRate() [2/2]

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

Construct from dictionary.

Definition at line 50 of file FallOffReactionRateI.H.

Member Function Documentation

◆ type()

static word type ( )
inlinestatic

Return the type name.

Definition at line 99 of file FallOffReactionRate.H.

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

Here is the call graph for this function:

◆ preEvaluate()

void preEvaluate ( ) const
inline

Pre-evaluation hook.

Definition at line 66 of file FallOffReactionRateI.H.

Referenced by FallOffReactionRate< ReactionRate, FallOffFunction >::type().

Here is the caller graph for this function:

◆ postEvaluate()

void postEvaluate ( ) const
inline

Post-evaluation hook.

Definition at line 75 of file FallOffReactionRateI.H.

References FallOffReactionRate< ReactionRate, FallOffFunction >::operator.

Referenced by FallOffReactionRate< ReactionRate, FallOffFunction >::type().

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 85 of file FallOffReactionRateI.H.

References FallOffReactionRate< ReactionRate, FallOffFunction >::ddT(), Foam::constant::physicoChemical::F, and M.

Here is the call graph for this function:

◆ 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 105 of file FallOffReactionRateI.H.

References Foam::constant::physicoChemical::F, M, and Foam::sqr().

Referenced by FallOffReactionRate< ReactionRate, FallOffFunction >::operator()(), and FallOffReactionRate< ReactionRate, FallOffFunction >::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 141 of file FallOffReactionRateI.H.

References FallOffReactionRate< ReactionRate, FallOffFunction >::ddc().

Referenced by FallOffReactionRate< ReactionRate, FallOffFunction >::type().

Here is the call graph for this function:
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 149 of file FallOffReactionRateI.H.

References Foam::constant::physicoChemical::F, M, List< T >::size(), Foam::sqr(), and FallOffReactionRate< ReactionRate, FallOffFunction >::write().

Referenced by FallOffReactionRate< ReactionRate, FallOffFunction >::hasDdc(), and FallOffReactionRate< ReactionRate, FallOffFunction >::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 191 of file FallOffReactionRateI.H.

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

Referenced by FallOffReactionRate< ReactionRate, FallOffFunction >::ddc(), and FallOffReactionRate< ReactionRate, FallOffFunction >::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 FallOffReactionRate< ReactionRate, FallOffFunction > &   
)
friend

Referenced by FallOffReactionRate< ReactionRate, FallOffFunction >::postEvaluate(), and FallOffReactionRate< ReactionRate, FallOffFunction >::type().

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