XiEqModel Class Reference

Base-class for all XiEq models used by the b-XiEq combustion model. The available models are : basicXiSubXiEq.H Gulder.H instabilityXiEq.H SCOPEBlendXiEq.H SCOPEXiEq.H. More...

#include <XiEqModel.H>

Inheritance diagram for XiEqModel:

Collaboration diagram for XiEqModel:

Public Member Functions
	TypeName ("XiEqModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, XiEqModel, dictionary,(const dictionary &XiEqProperties, const psiuReactionThermo &thermo, const compressible::RASModel &turbulence, const volScalarField &Su),(XiEqProperties, thermo, turbulence, Su))
	XiEqModel (const dictionary &XiEqProperties, const psiuReactionThermo &thermo, const compressible::RASModel &turbulence, const volScalarField &Su)
	Construct from components.
virtual	~XiEqModel ()
	Destructor.
virtual tmp< volScalarField >	XiEq () const
	Return the flame-wrinkling XiEq.
tmp< volScalarField >	calculateSchelkinEffect (const scalar) const
	Return the sub-grid Schelkin effect.
virtual bool	read (const dictionary &XiEqProperties)=0
	Update properties from given dictionary.
void	writeFields () const
	Write fields.

Static Public Member Functions
static autoPtr< XiEqModel >	New (const dictionary &XiEqProperties, const psiuReactionThermo &thermo, const compressible::RASModel &turbulence, const volScalarField &Su)
	Return a reference to the selected XiEq model.

Protected Attributes
dictionary	XiEqModelCoeffs_
	Dictionary.
const psiuReactionThermo &	thermo_
	Thermo.
const compressible::RASModel &	turbulence_
	Turbulence.
const volScalarField &	Su_
	Laminar burning velocity.

Detailed Description

Base-class for all XiEq models used by the b-XiEq combustion model. The available models are : basicXiSubXiEq.H Gulder.H instabilityXiEq.H SCOPEBlendXiEq.H SCOPEXiEq.H.

Source files

• XiEqModel.H
• XiEqModel.C

Definition at line 55 of file XiEqModel.H.

Constructor & Destructor Documentation

XiEqModel()

XiEqModel	(	const dictionary &	XiEqProperties,
		const psiuReactionThermo &	thermo,
		const compressible::RASModel &	turbulence,
		const volScalarField &	Su )

Construct from components.

References Foam::Su().

Here is the call graph for this function:

~XiEqModel()

virtual ~XiEqModel ( )

virtual

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"XiEqModel"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		XiEqModel	,
		dictionary	,
		(const dictionary &XiEqProperties, const psiuReactionThermo &thermo, const compressible::RASModel &turbulence, const volScalarField &Su)	,
		(XiEqProperties, thermo, turbulence, Su)	)

References Foam::Su().

Here is the call graph for this function:

New()

autoPtr< XiEqModel > New ( const dictionary & XiEqProperties, const psiuReactionThermo & thermo, const compressible::RASModel & turbulence, const volScalarField & Su )

static

Return a reference to the selected XiEq model.

References Foam::Su().

Here is the call graph for this function:

XiEq()

virtual tmp< volScalarField > XiEq ( ) const

inlinevirtual

Return the flame-wrinkling XiEq.

Reimplemented in basicSubGrid, Gulder, instability, SCOPEBlend, and SCOPEXiEq.

Definition at line 167 of file XiEqModel.H.

References turbulence_.

calculateSchelkinEffect()

tmp< volScalarField > calculateSchelkinEffect

(

const scalar

)

const

Return the sub-grid Schelkin effect.

read()

virtual bool read ( const dictionary & XiEqProperties )

pure virtual

Update properties from given dictionary.

Implemented in basicSubGrid, Gulder, instability, SCOPEBlend, and SCOPEXiEq.

writeFields()

void writeFields

(

)

const

Write fields.

Member Data Documentation

XiEqModelCoeffs_

dictionary XiEqModelCoeffs_

protected

Dictionary.

Definition at line 65 of file XiEqModel.H.

thermo_

const psiuReactionThermo& thermo_

protected

Thermo.

Definition at line 70 of file XiEqModel.H.

turbulence_

const compressible::RASModel& turbulence_

protected

Turbulence.

Definition at line 75 of file XiEqModel.H.

Referenced by XiEq().

Su_

const volScalarField& Su_

protected

Laminar burning velocity.

Definition at line 80 of file XiEqModel.H.

---

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

• applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/XiEqModel/XiEqModel.H