SRIFallOffFunction Class Reference

The SRI fall-off function. More...

#include <SRIFallOffFunction.H>

Public Member Functions
	SRIFallOffFunction (const scalar a, const scalar b, const scalar c, const scalar d, const scalar e)
	Construct from components.
	SRIFallOffFunction (const dictionary &dict)
	Construct from dictionary.
scalar	operator() (const scalar T, const scalar Pr) const
void	write (Ostream &os) const
	Write to stream.

Static Public Member Functions
static word	type ()
	Return the type name.

Friends
Ostream &	operator<< (Ostream &, const SRIFallOffFunction &)

Detailed Description

The SRI fall-off function.

Source files

• SRIFallOffFunction.H
• SRIFallOffFunctionI.H

Definition at line 52 of file SRIFallOffFunction.H.

Constructor & Destructor Documentation

SRIFallOffFunction() [1/2]

SRIFallOffFunction ( const scalar a, const scalar b, const scalar c, const scalar d, const scalar e )

inline

Construct from components.

Definition at line 23 of file SRIFallOffFunctionI.H.

References b, and e.

Referenced by operator<<.

Here is the caller graph for this function:

SRIFallOffFunction() [2/2]

SRIFallOffFunction ( const dictionary & dict )

inline

Construct from dictionary.

Definition at line 40 of file SRIFallOffFunctionI.H.

References dict.

Member Function Documentation

type()

word type ( )

inlinestatic

Return the type name.

Definition at line 86 of file SRIFallOffFunction.H.

operator()()

Foam::scalar operator() ( const scalar T, const scalar Pr ) const

inline

Definition at line 52 of file SRIFallOffFunctionI.H.

References Foam::exp(), Foam::log10(), Foam::max(), Foam::pow(), Pr(), Foam::sqr(), and Foam::T().

Here is the call graph for this function:

write()

void write ( Ostream & os ) const

inline

Write to stream.

Definition at line 63 of file SRIFallOffFunctionI.H.

References os().

Here is the call graph for this function:

Friends And Related Symbol Documentation

operator<<

Ostream & operator<< ( Ostream & , const SRIFallOffFunction &  )

friend

References SRIFallOffFunction().

---

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

• src/thermophysicalModels/specie/reaction/reactionRate/fallOffFunctions/SRIFallOffFunction/SRIFallOffFunction.H
• src/thermophysicalModels/specie/reaction/reactionRate/fallOffFunctions/SRIFallOffFunction/SRIFallOffFunctionI.H