Public Member Functions | Static Public Member Functions | Friends | List of all members
LandauTellerReactionRate Class Reference

Landau-Teller reaction rate. More...

Public Member Functions

 LandauTellerReactionRate (const scalar A, const scalar beta, const scalar Ta, const scalar B, const scalar C)
 Construct from components. More...
 
 LandauTellerReactionRate (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 LandauTellerReactionRate &)
 

Detailed Description

Landau-Teller reaction rate.

Source files

Definition at line 56 of file LandauTellerReactionRate.H.

Constructor & Destructor Documentation

◆ LandauTellerReactionRate() [1/2]

LandauTellerReactionRate ( const scalar  A,
const scalar  beta,
const scalar  Ta,
const scalar  B,
const scalar  C 
)
inline

Construct from components.

Definition at line 29 of file LandauTellerReactionRateI.H.

◆ LandauTellerReactionRate() [2/2]

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

Construct from dictionary.

Definition at line 46 of file LandauTellerReactionRateI.H.

Member Function Documentation

◆ type()

static word type ( )
inlinestatic

Return the type name.

Definition at line 92 of file LandauTellerReactionRate.H.

References Foam::constant::universal::c, LandauTellerReactionRate::ddc(), LandauTellerReactionRate::ddT(), LandauTellerReactionRate::hasDdc(), p, LandauTellerReactionRate::postEvaluate(), LandauTellerReactionRate::preEvaluate(), Foam::T(), and LandauTellerReactionRate::write().

Here is the call graph for this function:

◆ preEvaluate()

void preEvaluate ( ) const
inline

Pre-evaluation hook.

Definition at line 61 of file LandauTellerReactionRateI.H.

Referenced by LandauTellerReactionRate::type().

Here is the caller graph for this function:

◆ postEvaluate()

void postEvaluate ( ) const
inline

Post-evaluation hook.

Definition at line 65 of file LandauTellerReactionRateI.H.

Referenced by LandauTellerReactionRate::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 70 of file LandauTellerReactionRateI.H.

References Foam::cbrt(), LandauTellerReactionRate::ddT(), Foam::exp(), Foam::mag(), Foam::pow(), and Foam::T().

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 111 of file LandauTellerReactionRateI.H.

References Foam::cbrt(), Foam::exp(), Foam::mag(), Foam::pow(), and Foam::T().

Referenced by LandauTellerReactionRate::operator()(), and LandauTellerReactionRate::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 158 of file LandauTellerReactionRateI.H.

References LandauTellerReactionRate::ddc().

Referenced by LandauTellerReactionRate::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 165 of file LandauTellerReactionRateI.H.

Referenced by LandauTellerReactionRate::hasDdc(), and LandauTellerReactionRate::type().

Here is the caller graph for this function:

◆ write()

void write ( Ostream &  os) const
inline

Write to stream.

Definition at line 177 of file LandauTellerReactionRateI.H.

References Foam::writeEntry().

Referenced by LandauTellerReactionRate::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 LandauTellerReactionRate &   
)
friend
The documentation for this class was generated from the following files: