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

Inheritance diagram for constantbXiIgnition:

Collaboration diagram for constantbXiIgnition:

[legend]

Public Member Functions
	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	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...

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

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

Public Member Functions inherited from bXiTimedIgnition
	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...

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 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 Attributes
fvCellZone	zone_
	The ignition cellZone. More...

dimensionedScalar	strength_
	Ignition strength. More...

Protected Attributes inherited from bXiTimedIgnition
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...

Protected Member Functions inherited from bXiTimedIgnition
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...

Detailed Description

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

Usage

Example usage:

constantbXiIgnition1
{
    type            constantbXiIgnition;

    cellZone        ignition;

    start           0;
    duration        0.003;
    strength        2;
}

Where:

Property	Description	Required
`cellZone`	Correction cellZone	yes
`start`	Ignition start time	yes
`duration`	Ignition duration	yes
`strength`	Ignition strength [1/s]	yes

Source files

Definition at line 99 of file constantbXiIgnition.H.

Constructor & Destructor Documentation

◆ constantbXiIgnition() [1/2]

constantbXiIgnition	(	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 constantbXiIgnition.C.

◆ constantbXiIgnition() [2/2]

constantbXiIgnition ( const constantbXiIgnition & )

delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "constantbXiIgnition" )

Runtime type information.

◆ addSup()

void addSup	(	const volScalarField &	rho,
		const volScalarField &	b,
		fvMatrix< scalar > &	eqn
	)		const

virtual

Add ignition contribution to b equation.

Definition at line 73 of file constantbXiIgnition.C.

References b, cells, lduMatrix::diag(), Foam::endl(), forAll, IOobject::groupName(), Foam::Info, objectRegistry::lookupObject(), mesh, fvMatrix< Type >::psi(), Foam::fvc::Sp(), Foam::type(), ubRhoThermo::unburntPhaseName, and fvMesh::V().

Here is the call graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Implements fvModel.

Definition at line 109 of file constantbXiIgnition.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 118 of file constantbXiIgnition.C.

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 124 of file constantbXiIgnition.C.

◆ movePoints()

bool movePoints ( )

virtual

Update for mesh motion.

Implements fvModel.

Definition at line 133 of file constantbXiIgnition.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Read source dictionary.

Reimplemented from bXiTimedIgnition.

Definition at line 140 of file constantbXiIgnition.C.

References dict, and fvModel::read().

Here is the call graph for this function:

◆ operator=()

void operator= ( const constantbXiIgnition & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ zone_

fvCellZone zone_

protected

The ignition cellZone.

Definition at line 109 of file constantbXiIgnition.H.

◆ strength_

dimensionedScalar strength_

protected

Ignition strength.

Definition at line 112 of file constantbXiIgnition.H.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ constantbXiIgnition() [1/2]

◆ constantbXiIgnition() [2/2]

Member Function Documentation

◆ TypeName()

◆ addSup()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ movePoints()

◆ read()

◆ operator=()

Member Data Documentation

◆ zone_

◆ strength_