Public Types | Public Member Functions | Protected Attributes | List of all members
basicCombustionMixture Class Reference

Specialisation of the basicMixture for combustion. More...

Inheritance diagram for basicCombustionMixture:
Inheritance graph
[legend]
Collaboration diagram for basicCombustionMixture:
Collaboration graph
[legend]

Public Types

typedef basicCombustionMixture basicMixtureType
 The base class of the mixture. More...
 
- Public Types inherited from basicMixture
typedef basicMixture basicMixtureType
 The base class of the mixture. More...
 

Public Member Functions

 TypeName ("basicCombustionMixture")
 Run time type information. More...
 
 basicCombustionMixture (const dictionary &, const wordList &specieNames, const fvMesh &, const word &)
 Construct from dictionary, specie names, mesh and phase name. More...
 
virtual ~basicCombustionMixture ()
 Destructor. More...
 
bool contains (const word &specieName) const
 Does the mixture include this specie? More...
 
volScalarField & Y (const word &specieName)
 Return the mass-fraction field for a specie given by name. More...
 
const volScalarField & Y (const word &specieName) const
 Return the const mass-fraction field for a specie given by name. More...
 
scalar fres (const scalar ft, const scalar stoicRatio) const
 
tmp< volScalarField > fres (const volScalarField &ft, const dimensionedScalar &stoicRatio) const
 
- Public Member Functions inherited from basicMixture
 basicMixture (const dictionary &, const fvMesh &, const word &)
 Construct from dictionary, mesh and phase name. More...
 

Protected Attributes

speciesTable species_
 Table of specie names. More...
 
PtrList< volScalarField > Y_
 Species mass fractions. More...
 

Detailed Description

Specialisation of the basicMixture for combustion.

Source files

Definition at line 51 of file basicCombustionMixture.H.

Member Typedef Documentation

◆ basicMixtureType

typedef basicCombustionMixture basicMixtureType

The base class of the mixture.

Definition at line 74 of file basicCombustionMixture.H.

Constructor & Destructor Documentation

◆ basicCombustionMixture()

basicCombustionMixture ( const dictionary &  thermoDict,
const wordList &  specieNames,
const fvMesh &  mesh,
const word &  phaseName 
)

Construct from dictionary, specie names, mesh and phase name.

Definition at line 39 of file basicCombustionMixture.C.

References IOobject::AUTO_WRITE, forAll, IOobject::groupName(), mesh, IOobject::MUST_READ, fvMesh::time(), and Time::timeName().

Here is the call graph for this function:

◆ ~basicCombustionMixture()

virtual ~basicCombustionMixture ( )
inlinevirtual

Destructor.

Definition at line 90 of file basicCombustionMixture.H.

References basicCombustionMixture::contains(), basicCombustionMixture::fres(), and basicCombustionMixture::Y().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "basicCombustionMixture"  )

Run time type information.

◆ contains()

bool contains ( const word &  specieName) const
inline

Does the mixture include this specie?

Definition at line 27 of file basicCombustionMixtureI.H.

References basicCombustionMixture::Y().

Referenced by basicCombustionMixture::~basicCombustionMixture().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Y() [1/2]

Foam::volScalarField & Y ( const word &  specieName)
inline

Return the mass-fraction field for a specie given by name.

Definition at line 36 of file basicCombustionMixtureI.H.

Referenced by basicCombustionMixture::contains(), and basicCombustionMixture::~basicCombustionMixture().

Here is the caller graph for this function:

◆ Y() [2/2]

const Foam::volScalarField & Y ( const word &  specieName) const
inline

Return the const mass-fraction field for a specie given by name.

Definition at line 45 of file basicCombustionMixtureI.H.

References basicCombustionMixture::fres().

Here is the call graph for this function:

◆ fres() [1/2]

Foam::scalar fres ( const scalar  ft,
const scalar  stoicRatio 
) const
inline

Definition at line 54 of file basicCombustionMixtureI.H.

References Foam::max().

Referenced by veryInhomogeneousMixture< ThermoType >::cellProducts(), veryInhomogeneousMixture< ThermoType >::patchFaceProducts(), basicCombustionMixture::Y(), and basicCombustionMixture::~basicCombustionMixture().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ fres() [2/2]

Foam::tmp< Foam::volScalarField > fres ( const volScalarField &  ft,
const dimensionedScalar &  stoicRatio 
) const
inline

Definition at line 64 of file basicCombustionMixtureI.H.

References Foam::max(), and dimensioned< Type >::value().

Here is the call graph for this function:

Member Data Documentation

◆ species_

speciesTable species_
protected

Table of specie names.

Definition at line 61 of file basicCombustionMixture.H.

◆ Y_

PtrList<volScalarField> Y_
protected

Species mass fractions.

Definition at line 64 of file basicCombustionMixture.H.

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