Base class for equilibrium flame wrinkling XiEq models. More...

Inheritance diagram for XiEqModel:

[legend]

Collaboration diagram for XiEqModel:

[legend]

Public Member Functions
	TypeName ("XiEqModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, XiEqModel, dictionary,(const dictionary &dict, const psiuMulticomponentThermo &thermo, const fluidThermoThermophysicalTransportModel &turbulence, const volScalarField &Su),(dict, thermo, turbulence, Su))

	XiEqModel (const psiuMulticomponentThermo &thermo, const fluidThermoThermophysicalTransportModel &turbulence, const volScalarField &Su)
	Construct from components. More...

	XiEqModel (const XiEqModel &)=delete
	Disallow default bitwise copy construction. More...

virtual	~XiEqModel ()
	Destructor. More...

virtual tmp< volScalarField >	XiEq () const =0
	Return the flame-wrinkling XiEq. More...

virtual tmp< volScalarField >	Db () const
	Return the flame diffusivity. More...

bool	read (const dictionary &XiProperties)
	Update properties from the given XiProperties dictionary. More...

void	operator= (const XiEqModel &)=delete
	Disallow default bitwise assignment. More...

	TypeName ("XiEqModel")
	Runtime type information. More...

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

	XiEqModel (const dictionary &XiEqProperties, const psiuMulticomponentThermo &thermo, const compressible::RASModel &turbulence, const volScalarField &Su)
	Construct from components. More...

	XiEqModel (const XiEqModel &)=delete
	Disallow default bitwise copy construction. More...

virtual	~XiEqModel ()
	Destructor. More...

virtual tmp< volScalarField >	XiEq () const =0
	Return the flame-wrinkling XiEq. More...

tmp< volScalarField >	calculateSchelkinEffect (const scalar) const
	Return the sub-grid Schelkin effect. More...

virtual bool	read (const dictionary &XiEqProperties)=0
	Update properties from given dictionary. More...

void	writeFields () const
	Write fields. More...

void	operator= (const XiEqModel &)=delete
	Disallow default bitwise assignment. More...

Static Public Member Functions
static autoPtr< XiEqModel >	New (const dictionary &XiProperties, const psiuMulticomponentThermo &thermo, const fluidThermoThermophysicalTransportModel &turbulence, const volScalarField &Su)
	Return a reference to the selected XiEq model. More...

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

Protected Member Functions
virtual bool	readCoeffs (const dictionary &dict)=0
	Update coefficients from given dictionary. More...

Protected Attributes
const psiuMulticomponentThermo &	thermo_
	Thermo. More...

const fluidThermoThermophysicalTransportModel &	thermoTransport_
	Thermo-physical transport. More...

const compressibleMomentumTransportModel &	turbulence_
	Turbulence. More...

const volScalarField &	Su_
	Laminar burning velocity. More...

dictionary	XiEqModelCoeffs_
	Dictionary. More...

const compressible::RASModel &	turbulence_
	Turbulence. More...

Detailed Description

Base class for equilibrium flame wrinkling XiEq models.

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

Definition at line 51 of file XiEqModel.H.

Constructor & Destructor Documentation

◆ XiEqModel() [1/4]

XiEqModel	(	const psiuMulticomponentThermo &	thermo,
		const fluidThermoThermophysicalTransportModel &	turbulence,
		const volScalarField &	Su
	)

Construct from components.

Definition at line 47 of file XiEqModel.C.

◆ XiEqModel() [2/4]

XiEqModel ( const XiEqModel & )

delete

Disallow default bitwise copy construction.

◆ ~XiEqModel() [1/2]

~XiEqModel ( )

virtual

Destructor.

Definition at line 63 of file XiEqModel.C.

◆ XiEqModel() [3/4]

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

Construct from components.

Definition at line 39 of file XiEqModel.C.

◆ XiEqModel() [4/4]

XiEqModel ( const XiEqModel & )

delete

Disallow default bitwise copy construction.

◆ ~XiEqModel() [2/2]

virtual ~XiEqModel ( )

virtual

Destructor.

Member Function Documentation

◆ readCoeffs()

bool readCoeffs ( const dictionary & dict )

protectedpure virtual

Update coefficients from given dictionary.

Implemented in instability, Gulder, and constant.

Definition at line 39 of file XiEqModel.C.

Referenced by constant::readCoeffs(), Gulder::readCoeffs(), and instability::readCoeffs().

Here is the caller graph for this function:

◆ TypeName() [1/2]

TypeName ( "XiEqModel" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable	(	autoPtr	,
		XiEqModel	,
		dictionary	,
		(const dictionary &dict, const psiuMulticomponentThermo &thermo, const fluidThermoThermophysicalTransportModel &turbulence, const volScalarField &Su)	,
		(dict, thermo, turbulence, Su)
	)

◆ New() [1/2]

Foam::autoPtr< Foam::XiEqModel > New	(	const dictionary &	XiProperties,
		const psiuMulticomponentThermo &	thermo,
		const fluidThermoThermophysicalTransportModel &	turbulence,
		const volScalarField &	Su
	)

static

Return a reference to the selected XiEq model.

Definition at line 30 of file XiEqModelNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, dictionary::lookup(), Foam::nl, dictionary::optionalSubDict(), Foam::fvc::Su(), dictionary::subDict(), thermo, and turbulence().

Here is the call graph for this function:

◆ XiEq() [1/2]

virtual tmp<volScalarField> XiEq ( ) const

pure virtual

Return the flame-wrinkling XiEq.

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

◆ Db()

virtual tmp<volScalarField> Db ( ) const

inlinevirtual

Return the flame diffusivity.

Reimplemented in instability.

Definition at line 138 of file XiEqModel.H.

References fluidThermophysicalTransportModel::DEff(), GeometricField< Type, GeoMesh, PrimitiveField >::New(), XiEqModel::thermo_, XiEqModel::thermoTransport_, and psiuMulticomponentThermo::Y().

Here is the call graph for this function:

◆ read() [1/2]

bool read ( const dictionary & XiProperties )

Update properties from the given XiProperties dictionary.

Definition at line 69 of file XiEqModel.C.

References dictionary::optionalSubDict(), dictionary::subDict(), and Foam::type().

Referenced by basicSubGrid::read(), Gulder::read(), instability::read(), and SCOPEXiEq::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [1/2]

void operator= ( const XiEqModel & )

delete

Disallow default bitwise assignment.

◆ TypeName() [2/2]

TypeName ( "XiEqModel" )

Runtime type information.

◆ declareRunTimeSelectionTable() [2/2]

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

◆ New() [2/2]

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

static

Return a reference to the selected XiEq model.

Definition at line 30 of file XiEqModelNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, dictionary::lookup(), Foam::nl, Foam::fvc::Su(), thermo, and turbulence().

Here is the call graph for this function:

◆ XiEq() [2/2]

virtual tmp<volScalarField> XiEq ( ) const

pure virtual

Return the flame-wrinkling XiEq.

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

◆ calculateSchelkinEffect()

Foam::tmp< Foam::volScalarField > calculateSchelkinEffect ( const scalar uPrimeCoef ) const

Return the sub-grid Schelkin effect.

Definition at line 89 of file XiEqModel.C.

References Foam::e, objectRegistry::lookupObject(), Foam::mag(), Foam::max(), fvMesh::mesh(), mesh, dimensioned< Type >::name(), GeometricField< Type, GeoMesh, PrimitiveField >::New(), IOobject::NO_READ, IOobject::NO_WRITE, Foam::pow(), GeometricField< Type, GeoMesh, PrimitiveField >::primitiveFieldRef(), Foam::sqrt(), fvMesh::time(), U, fvMesh::V(), and Foam::Zero.

Here is the call graph for this function:

◆ read() [2/2]

virtual bool read ( const dictionary & XiEqProperties )

pure virtual

Update properties from given dictionary.

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

◆ writeFields()

void writeFields ( ) const

Write fields.

Definition at line 76 of file XiEqModel.C.

References Foam::saturationModels::B.

◆ operator=() [2/2]

void operator= ( const XiEqModel & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ thermo_

const psiuMulticomponentThermo & thermo_

protected

Thermo.

Definition at line 59 of file XiEqModel.H.

Referenced by XiEqModel::Db().

◆ thermoTransport_

const fluidThermoThermophysicalTransportModel& thermoTransport_

protected

Thermo-physical transport.

Definition at line 62 of file XiEqModel.H.

Referenced by XiEqModel::Db().

◆ turbulence_ [1/2]

const compressibleMomentumTransportModel& turbulence_

protected

Turbulence.

Definition at line 65 of file XiEqModel.H.

◆ Su_

const volScalarField & Su_

protected

Laminar burning velocity.

Definition at line 68 of file XiEqModel.H.

◆ XiEqModelCoeffs_

dictionary XiEqModelCoeffs_

protected

Dictionary.

Definition at line 65 of file XiEqModel.H.

◆ turbulence_ [2/2]

const compressible::RASModel& turbulence_

protected

Turbulence.

Definition at line 71 of file XiEqModel.H.

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

applications/modules/XiFluid/XiModels/XiEqModels/XiEqModel/XiEqModel.H
applications/modules/XiFluid/XiModels/XiEqModels/XiEqModel/XiEqModel.C
applications/modules/XiFluid/XiModels/XiEqModels/XiEqModel/XiEqModelNew.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ XiEqModel() [1/4]

◆ XiEqModel() [2/4]

◆ ~XiEqModel() [1/2]

◆ XiEqModel() [3/4]

◆ XiEqModel() [4/4]

◆ ~XiEqModel() [2/2]

Member Function Documentation

◆ readCoeffs()

◆ TypeName() [1/2]

◆ declareRunTimeSelectionTable() [1/2]

◆ New() [1/2]

◆ XiEq() [1/2]

◆ Db()

◆ read() [1/2]

◆ operator=() [1/2]

◆ TypeName() [2/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ New() [2/2]

◆ XiEq() [2/2]

◆ calculateSchelkinEffect()

◆ read() [2/2]

◆ writeFields()

◆ operator=() [2/2]

Member Data Documentation

◆ thermo_

◆ thermoTransport_

◆ turbulence_ [1/2]

◆ Su_

◆ XiEqModelCoeffs_

◆ turbulence_ [2/2]