FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

Base class for chemistry models. More...

#include <chemistryModel/basicChemistryModel.H>


Detailed Description

Base class for chemistry models.

Source files

Definition at line 56 of file basicChemistryModel.H.

Inheritance diagram for basicChemistryModel:
Collaboration diagram for basicChemistryModel:

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 >  Sh () const =0
 Return source for enthalpy equation [kg/m/s3].
virtual tmp< volScalarField >  dQ () const =0
 Return the heat release, i.e. enthalpy/sec [m2/s3].

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.

Constructor & Destructor Documentation

basicChemistryModel ( const fvMesh &   mesh  )

Construct from mesh.

Definition at line 39 of file basicChemistryModel.C.

~basicChemistryModel (  ) [virtual]

Destructor.

Definition at line 64 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 46 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 28 of file basicChemistryModelI.H.

References basicChemistryModel::mesh_.

Foam::Switch chemistry (  ) const [inline]

Chemistry activation switch.

Definition at line 34 of file basicChemistryModelI.H.

const Foam::scalarField & deltaTChem (  ) const [inline]

Return the latest estimation of integration step.

Definition at line 40 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> Sh (  ) const [pure virtual]

Return source for enthalpy equation [kg/m/s3].

virtual tmp<volScalarField> dQ (  ) const [pure virtual]

Return the heat release, i.e. enthalpy/sec [m2/s3].


Member Data Documentation

const fvMesh& mesh_ [protected]

Reference to the mesh database.

Definition at line 74 of file basicChemistryModel.H.

Referenced by basicChemistryModel::mesh().

Switch chemistry_ [protected]

Chemistry activation switch.

Definition at line 77 of file basicChemistryModel.H.

scalarField deltaTChem_ [protected]

Latest estimation of integration step.

Definition at line 80 of file basicChemistryModel.H.


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