Abstract base-class for timed ignition models for the Weller b-Xi combustion models. More...

Inheritance diagram for bXiTimedIgnition:

[legend]

Collaboration diagram for bXiTimedIgnition:

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

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

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

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

virtual bool	igniting (const dimensionedScalar duration) const
	Return true during the specified ignition duration. 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 bXiTimedIgnition &)=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...

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 bool	movePoints ()=0
	Update for mesh motion. More...

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

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

virtual void	distribute (const polyDistributionMap &)=0
	Redistribute or update using the given distribution map. 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

Protected Member Functions
scalar	ignRelTime (const scalar t) const
	Return the time relative to the ignition time. 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
dimensionedScalar	start_
	Ignition start time. More...

dimensionedScalar	duration_
	Ignition duration. More...

dimensionedScalar	period_
	Ignition repeat period. More...

dimensionedScalar	combustionDuration_
	Combustion duration. More...

bool	reset_
	Set true when the composition is reset. More...

Protected Attributes inherited from bXiIgnition
const solvers::XiFluid &	XiFluid_
	The XiFluid solver. More...

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...

Detailed Description

Abstract base-class for timed ignition models for the Weller b-Xi combustion models.

Source files

Definition at line 51 of file bXiTimedIgnition.H.

Constructor & Destructor Documentation

◆ bXiTimedIgnition() [1/2]

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

Construct from explicit source name and mesh.

Definition at line 52 of file bXiTimedIgnition.C.

References bXiTimedIgnition::ignited(), and bXiTimedIgnition::reset_.

Here is the call graph for this function:

◆ bXiTimedIgnition() [2/2]

bXiTimedIgnition ( const bXiTimedIgnition & )

delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ ignRelTime()

Foam::scalar ignRelTime ( const scalar t ) const

protected

Return the time relative to the ignition time.

for the current period

Definition at line 89 of file bXiTimedIgnition.C.

◆ TypeName()

TypeName ( "bXiTimedIgnition" )

Runtime type information.

◆ addSupFields()

Foam::wordList addSupFields ( ) const

virtual

Return the list of fields for which the option adds source term.

to the transport equation

Reimplemented from bXiIgnition.

Definition at line 76 of file bXiTimedIgnition.C.

References List< word >::null().

Here is the call graph for this function:

◆ igniting() [1/2]

bool igniting ( const dimensionedScalar duration ) const

virtual

Return true during the specified ignition duration.

Implements bXiIgnition.

Definition at line 98 of file bXiTimedIgnition.C.

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

Here is the call graph for this function:

◆ igniting() [2/2]

bool igniting ( ) const

virtual

Return true during the ignition duration.

Implements bXiIgnition.

Definition at line 121 of file bXiTimedIgnition.C.

◆ ignited()

bool ignited ( ) const

virtual

Return true during the combustion duration.

Implements bXiIgnition.

Definition at line 127 of file bXiTimedIgnition.C.

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

Referenced by bXiTimedIgnition::bXiTimedIgnition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read source dictionary.

Reimplemented from fvModel.

Reimplemented in GaussianbXiIgnition, and constantbXiIgnition.

Definition at line 153 of file bXiTimedIgnition.C.

References dict, and fvModel::read().

Here is the call graph for this function:

◆ operator=()

void operator= ( const bXiTimedIgnition & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ start_

dimensionedScalar start_

protected

Ignition start time.

Definition at line 60 of file bXiTimedIgnition.H.

◆ duration_

dimensionedScalar duration_

protected

Ignition duration.

Definition at line 63 of file bXiTimedIgnition.H.

◆ period_

dimensionedScalar period_

protected

Ignition repeat period.

Definition at line 66 of file bXiTimedIgnition.H.

◆ combustionDuration_

dimensionedScalar combustionDuration_

protected

Combustion duration.

after which ignited is set false and the composition reset

Definition at line 70 of file bXiTimedIgnition.H.

◆ reset_

bool reset_

mutableprotected

Set true when the composition is reset.

at the end of the combustion duration and reset false at the beginning of ignition

Definition at line 75 of file bXiTimedIgnition.H.

Referenced by bXiTimedIgnition::bXiTimedIgnition().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ bXiTimedIgnition() [1/2]

◆ bXiTimedIgnition() [2/2]

Member Function Documentation

◆ ignRelTime()

◆ TypeName()

◆ addSupFields()

◆ igniting() [1/2]

◆ igniting() [2/2]

◆ ignited()

◆ read()

◆ operator=()

Member Data Documentation

◆ start_

◆ duration_

◆ period_

◆ combustionDuration_

◆ reset_