Base class for flame wrinkling Xi generation rate models. More...

Inheritance diagram for XiGModel:

[legend]

Collaboration diagram for XiGModel:

[legend]

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

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

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

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

virtual	~XiGModel ()
	Destructor. More...

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

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

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

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

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

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

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

virtual	~XiGModel ()
	Destructor. More...

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

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

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

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

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

static autoPtr< XiGModel >	New (const dictionary &XiGProperties, const psiuMulticomponentThermo &thermo, const compressible::RASModel &turbulence, const volScalarField &Su)
	Return a reference to the selected XiG 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_

dictionary	XiGModelCoeffs_

const compressible::RASModel &	turbulence_

Detailed Description

Base class for flame wrinkling Xi generation rate models.

Base-class for all Xi generation models used by the b-Xi combustion model. See Technical Report SH/RE/01R for details on the PDR modelling. For details on the use of XiGModel see XiModel.H. The model available is instabilityG.H.

See Foam::XiModel for more details on flame wrinkling modelling.

References:

    Weller, H. G. (1993).
    The development of a new flame area combustion model
    using conditional averaging.
    Thermo-fluids section report TF 9307.

    Weller, H. G., Tabor, G., Gosman, A. D., & Fureby, C. (1998, January).
    Application of a flame-wrinkling LES combustion model
    to a turbulent mixing layer.
    In Symposium (International) on combustion
    (Vol. 27, No. 1, pp. 899-907). Elsevier.

Source files

Definition at line 67 of file XiGModel.H.

Constructor & Destructor Documentation

◆ XiGModel() [1/4]

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

Construct from components.

Definition at line 47 of file XiGModel.C.

◆ XiGModel() [2/4]

XiGModel ( const XiGModel & )

delete

Disallow default bitwise copy construction.

◆ ~XiGModel() [1/2]

~XiGModel ( )

virtual

Destructor.

Definition at line 63 of file XiGModel.C.

◆ XiGModel() [3/4]

XiGModel	(	const dictionary &	XiGProperties,
		const psiuMulticomponentThermo &	thermo,
		const compressible::RASModel &	turbulence,
		const volScalarField &	Su
	)

Construct from components.

Definition at line 39 of file XiGModel.C.

◆ XiGModel() [4/4]

XiGModel ( const XiGModel & )

delete

Disallow default bitwise copy construction.

◆ ~XiGModel() [2/2]

virtual ~XiGModel ( )

virtual

Destructor.

Member Function Documentation

◆ readCoeffs()

bool readCoeffs ( const dictionary & dict )

protectedpure virtual

Update coefficients from given dictionary.

Implemented in KTS, and instability.

Definition at line 39 of file XiGModel.C.

Referenced by instability::readCoeffs(), and KTS::readCoeffs().

Here is the caller graph for this function:

◆ TypeName() [1/2]

TypeName ( "XiGModel" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

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

◆ New() [1/2]

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

static

Return a reference to the selected XiG model.

Definition at line 30 of file XiGModelNew.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:

◆ G() [1/2]

virtual tmp<volScalarField> G ( ) const

pure virtual

Return the flame-wrinkling generation rate.

Implemented in KTS, instability, KTS, instabilityG, and basicSubGrid.

◆ read() [1/2]

bool read ( const dictionary & XiProperties )

Update properties from the given XiProperties dictionary.

Definition at line 69 of file XiGModel.C.

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

Referenced by basicSubGrid::read(), instabilityG::read(), and KTS::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [1/2]

void operator= ( const XiGModel & )

delete

Disallow default bitwise assignment.

◆ TypeName() [2/2]

TypeName ( "XiGModel" )

Runtime type information.

◆ declareRunTimeSelectionTable() [2/2]

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

◆ New() [2/2]

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

static

Return a reference to the selected XiG model.

Definition at line 30 of file XiGModelNew.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:

◆ G() [2/2]

virtual tmp<volScalarField> G ( ) const

pure virtual

Return the flame-wrinkling generation rate.

Implemented in KTS, instability, KTS, instabilityG, and basicSubGrid.

◆ Db()

virtual tmp<volScalarField> Db ( ) const

inlinevirtual

Return the flame diffusivity.

Reimplemented in instabilityG, and basicSubGrid.

Definition at line 133 of file XiGModel.H.

References GeometricField< Type, GeoMesh, PrimitiveField >::New(), momentumTransportModel::nuEff(), compressibleMomentumTransportModel::rho(), and XiGModel::turbulence_.

Here is the call graph for this function:

◆ read() [2/2]

virtual bool read ( const dictionary & XiGProperties )

pure virtual

Update properties from given dictionary.

Implemented in KTS, instabilityG, and basicSubGrid.

◆ operator=() [2/2]

void operator= ( const XiGModel & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ thermo_

const psiuMulticomponentThermo & thermo_

protected

Thermo.

Definition at line 75 of file XiGModel.H.

◆ thermoTransport_

const fluidThermoThermophysicalTransportModel& thermoTransport_

protected

Thermo-physical transport.

Definition at line 78 of file XiGModel.H.

◆ turbulence_ [1/2]

const compressibleMomentumTransportModel& turbulence_

protected

Turbulence.

Definition at line 81 of file XiGModel.H.

Referenced by XiGModel::Db().

◆ Su_

const volScalarField & Su_

protected

Definition at line 83 of file XiGModel.H.

◆ XiGModelCoeffs_

dictionary XiGModelCoeffs_

protected

Definition at line 61 of file XiGModel.H.

◆ turbulence_ [2/2]

const compressible::RASModel& turbulence_

protected

Definition at line 64 of file XiGModel.H.

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

applications/modules/XiFluid/XiModels/XiGModels/XiGModel/XiGModel.H
applications/modules/XiFluid/XiModels/XiGModels/XiGModel/XiGModel.C
applications/modules/XiFluid/XiModels/XiGModels/XiGModel/XiGModelNew.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ XiGModel() [1/4]

◆ XiGModel() [2/4]

◆ ~XiGModel() [1/2]

◆ XiGModel() [3/4]

◆ XiGModel() [4/4]

◆ ~XiGModel() [2/2]

Member Function Documentation

◆ readCoeffs()

◆ TypeName() [1/2]

◆ declareRunTimeSelectionTable() [1/2]

◆ New() [1/2]

◆ G() [1/2]

◆ read() [1/2]

◆ operator=() [1/2]

◆ TypeName() [2/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ New() [2/2]

◆ G() [2/2]

◆ Db()

◆ read() [2/2]

◆ operator=() [2/2]

Member Data Documentation

◆ thermo_

◆ thermoTransport_

◆ turbulence_ [1/2]

◆ Su_

◆ XiGModelCoeffs_

◆ turbulence_ [2/2]