basicChemistryModel Class Reference

Base class for chemistry models. More...

Inheritance diagram for basicChemistryModel:

[legend]

Collaboration diagram for basicChemistryModel:

[legend]

List of all members.

Public Member Functions
	TypeName ("basicChemistryModel")
	Runtime type information.
	basicChemistryModel (const fvMesh &mesh)
	Construct from mesh.
virtual	~basicChemistryModel ()
	Destructor.
const fvMesh &	mesh () const
	Return const access to the mesh database.
Switch	chemistry () const
	Chemistry activation switch.
const scalarField &	deltaTChem () const
	Return the latest estimation of integration step.
virtual tmp< volScalarField >	RR (const label i) const =0
	Return const access to chemical source terms.
virtual scalar	solve (const scalar t0, const scalar deltaT)=0
	Solve the reaction system for the given start time and.
virtual tmp< volScalarField >	tc () const =0
	Return the chemical time scale.
virtual tmp< volScalarField >	dQ () const =0
	Return the heat release.
Protected Member Functions
scalarField &	deltaTChem ()
	Return non-const access to the latest estimation of integration.
Protected Attributes
const fvMesh &	mesh_
	Reference to the mesh database.
Switch	chemistry_
	Chemistry activation switch.
scalarField	deltaTChem_
	Latest estimation of integration step.

---

Detailed Description

Base class for chemistry models.

Source files

• basicChemistryModel.H
• basicChemistryModelI.H
• basicChemistryModel.C

Definition at line 51 of file basicChemistryModel.H.

---

Constructor & Destructor Documentation

basicChemistryModel

(

const fvMesh &

mesh

)

Construct from mesh.

Definition at line 31 of file basicChemistryModel.C.

References Foam::defineTypeNameAndDebug().

Here is the call graph for this function:

~basicChemistryModel

(

)

[virtual]

Destructor.

Definition at line 56 of file basicChemistryModel.C.

---

Member Function Documentation

Foam::scalarField & deltaTChem

(

)

[inline, protected]

Return non-const access to the latest estimation of integration.

step, e.g. for multi-chemistry model

Definition at line 38 of file basicChemistryModelI.H.

TypeName

(

"basicChemistryModel"

)

Runtime type information.

const Foam::fvMesh & mesh

(

)

const [inline]

Return const access to the mesh database.

Definition at line 20 of file basicChemistryModelI.H.

Foam::Switch chemistry

(

)

const [inline]

Chemistry activation switch.

Definition at line 26 of file basicChemistryModelI.H.

References basicChemistryModel::mesh_.

const Foam::scalarField & deltaTChem

(

)

const [inline]

Return the latest estimation of integration step.

Definition at line 32 of file basicChemistryModelI.H.

virtual tmp<volScalarField> RR

(

const label

i

)

const [pure virtual]

Return const access to chemical source terms.

virtual scalar solve	(	const scalar	t0,
		const scalar	deltaT
	)			[pure virtual]

Solve the reaction system for the given start time and.

timestep and return the characteristic time

virtual tmp<volScalarField> tc

(

)

const [pure virtual]

Return the chemical time scale.

virtual tmp<volScalarField> dQ

(

)

const [pure virtual]

Return the heat release.

---

Member Data Documentation

const fvMesh& mesh_ [protected]

Reference to the mesh database.

Definition at line 69 of file basicChemistryModel.H.

Referenced by basicChemistryModel::chemistry().

Switch chemistry_ [protected]

Chemistry activation switch.

Definition at line 72 of file basicChemistryModel.H.

scalarField deltaTChem_ [protected]

Latest estimation of integration step.

Definition at line 75 of file basicChemistryModel.H.

---

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

• src/thermophysicalModels/chemistryModel/chemistryModel/basicChemistryModel/basicChemistryModel.H
• src/thermophysicalModels/chemistryModel/chemistryModel/basicChemistryModel/basicChemistryModel.C
• src/thermophysicalModels/chemistryModel/chemistryModel/basicChemistryModel/basicChemistryModelI.H