Simple constant rate ignition model for the Weller b-Xi combustion models. More...

Inheritance diagram for multiCycleConstantbXiIgnition:

Collaboration diagram for multiCycleConstantbXiIgnition:

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

	multiCycleConstantbXiIgnition (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from explicit source name and mesh. More...

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

virtual bool	igniting () const
	Return true during the ignition duration. More...

virtual bool	ignited () const
	Return true during the combustion duration. More...

virtual bool	read (const dictionary &dict)
	Read source dictionary. More...

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

Public Member Functions inherited from constantbXiIgnition
	TypeName ("constantbXiIgnition")
	Runtime type information. More...

	constantbXiIgnition (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from explicit source name and mesh. More...

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

virtual void	addSup (const volScalarField &rho, const volScalarField &b, fvMatrix< scalar > &eqn) const
	Add ignition contribution to b equation. More...

virtual void	XiCorr (volScalarField &Xi, const volScalarField &b, const volScalarField &mgb) const

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

virtual bool	movePoints ()
	Update for mesh motion. More...

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

Public Member Functions inherited from bXiIgnition
	TypeName ("bXiIgnition")
	Runtime type information. More...

	bXiIgnition (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from explicit source name and mesh. More...

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

virtual wordList	addSupFields () const
	Return the list of fields for which the option adds source term. More...

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

Public Member Functions inherited from fvModel
	TypeName ("fvModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, fvModel, dictionary,(const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict),(name, modelType, mesh, dict))

	fvModel (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from components. More...

autoPtr< fvModel >	clone () const
	Return clone. More...

virtual	~fvModel ()
	Destructor. More...

const word &	name () const
	Return const access to the source name. More...

const word &	keyword () const
	Return name as the keyword. More...

const fvMesh &	mesh () const
	Return const access to the mesh database. More...

const dictionary &	coeffs (const dictionary &) const
	Return the coefficients sub-dictionary. More...

virtual bool	addsSupToField (const word &fieldName) const
	Return true if the fvModel adds a source term to the given. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

virtual void	addSup (fvMatrix< scalar > &eqn) const
	Add a source term to a field-less proxy equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const
	Add a source term to an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const VolField< Type > &field) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const
	Return source for a compressible equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a compressible equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const
	Return source for an equation with a second time derivative. More...

virtual void	preUpdateMesh ()
	Prepare for mesh update. More...

virtual void	correct ()
	Correct the fvModel. More...

virtual bool	write (const bool write=true) const
	Write fvModel data. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class AlphaRhoFieldType >
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField)

template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const

Additional Inherited Members
Static Public Member Functions inherited from fvModel
static const dictionary &	coeffs (const word &modelType, const dictionary &)
	Return the coefficients sub-dictionary for a given model type. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the dimensions of the matrix of a source term. More...

static const dimensionSet &	sourceDims (const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the name of the field associated with a source term. More...

template<class AlphaRhoFieldType >
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField)
	Return the name of the field associated with a source term (base. More...

static const word &	fieldName ()
	Return the name of the field associated with a source term. Special. More...

static autoPtr< fvModel >	New (const word &name, const fvMesh &mesh, const dictionary &dict)
	Return a reference to the selected fvModel. More...

Static Public Attributes inherited from fvModel
static const wordHashSet	keywords
	The keywords read by this class. More...

Protected Member Functions inherited from fvModel
template<class Type >
void	addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to an equation. More...

template<class Type >
void	addSupType (const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a compressible equation. More...

template<class Type >
void	addSupType (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a phase equation. More...

template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const
	Return a source for an equation. More...

Protected Attributes inherited from constantbXiIgnition
fvCellZone	zone_
	The ignition cellZone. More...

autoPtr< XiCorrModel >	XiCorrModel_

dimensionedScalar	start_
	Ignition start time. More...

dimensionedScalar	duration_
	Ignition duration. More...

dimensionedScalar	strength_
	Ignition strength. More...

Detailed Description

Simple constant rate ignition model for the Weller b-Xi combustion models.

Usage

Example usage:

multiCycleConstantbXiIgnition1
{
    type            multiCycleConstantbXiIgnition;

    cellZone        ignition;

    // Timings are defined in crank angles for a multi-cycle engine case
    start           700;
    duration        5;
    combustionDuration 200;
    period          720;

    XiCorr
    {
        type            spherical;
        cellZone        all;
    }
}

Where:

Property	Description	Required
`cellZone`	Correction cellZone	yes
`start`	Ignition start time	yes
`duration`	Ignition duration	yes
`combustionDuration`	Combustion duration	yes
`period`	Ignition repeat period	yes
`strength`	Ignition strength [1/s]	yes
`XiCorr`	Flame-wrinkling correction	yes

See also: Foam::XiCorrModel Foam::XiCorrModels::planar Foam::XiCorrModels::cylindrical Foam::XiCorrModels::spherical

Source files

Definition at line 132 of file multiCycleConstantbXiIgnition.H.

Constructor & Destructor Documentation

◆ multiCycleConstantbXiIgnition() [1/2]

multiCycleConstantbXiIgnition	(	const word &	name,
		const word &	modelType,
		const fvMesh &	mesh,
		const dictionary &	dict
	)

Construct from explicit source name and mesh.

Definition at line 57 of file multiCycleConstantbXiIgnition.C.

◆ multiCycleConstantbXiIgnition() [2/2]

multiCycleConstantbXiIgnition ( const multiCycleConstantbXiIgnition & )

delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "multiCycleConstantbXiIgnition" )

Runtime type information.

◆ igniting()

bool igniting ( ) const

virtual

Return true during the ignition duration.

Reimplemented from constantbXiIgnition.

Definition at line 83 of file multiCycleConstantbXiIgnition.C.

References TimeState::deltaTValue(), Foam::max(), mesh, fvMesh::time(), and dimensioned< Type >::value().

Here is the call graph for this function:

◆ ignited()

bool ignited ( ) const

virtual

Return true during the combustion duration.

Reimplemented from constantbXiIgnition.

Definition at line 103 of file multiCycleConstantbXiIgnition.C.

References TimeState::deltaTValue(), objectRegistry::lookupObjectRef(), mesh, fvMesh::time(), and dimensioned< Type >::value().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read source dictionary.

Reimplemented from constantbXiIgnition.

Definition at line 129 of file multiCycleConstantbXiIgnition.C.

References dict, and constantbXiIgnition::read().

Here is the call graph for this function:

◆ operator=()

void operator= ( const multiCycleConstantbXiIgnition & )

delete

Disallow default bitwise assignment.

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

applications/modules/XiFluid/fvModels/ignition/multiCycleConstantbXiIgnition/multiCycleConstantbXiIgnition.H
applications/modules/XiFluid/fvModels/ignition/multiCycleConstantbXiIgnition/multiCycleConstantbXiIgnition.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ multiCycleConstantbXiIgnition() [1/2]

◆ multiCycleConstantbXiIgnition() [2/2]

Member Function Documentation

◆ TypeName()

◆ igniting()

◆ ignited()

◆ read()

◆ operator=()