inhomogeneousMixture< ThermoType > Class Template Reference

Foam::inhomogeneousMixture. More...

Inheritance diagram for inhomogeneousMixture< ThermoType >:
Collaboration diagram for inhomogeneousMixture< ThermoType >:

Public Types

typedef ThermoType thermoType
 The type of thermodynamics this mixture is instantiated for. More...
 
- Public Types inherited from basicCombustionMixture
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

 inhomogeneousMixture (const dictionary &, const fvMesh &, const word &)
 Construct from dictionary, mesh and phase name. More...
 
virtual ~inhomogeneousMixture ()
 Destructor. More...
 
const dimensionedScalarstoicRatio () const
 
const ThermoType & mixture (const scalar, const scalar) const
 
const ThermoType & cellMixture (const label celli) const
 
const ThermoType & patchFaceMixture (const label patchi, const label facei) const
 
const ThermoType & cellReactants (const label celli) const
 
const ThermoType & patchFaceReactants (const label patchi, const label facei) const
 
const ThermoType & cellProducts (const label celli) const
 
const ThermoType & patchFaceProducts (const label patchi, const label facei) const
 
void read (const dictionary &)
 Read dictionary. More...
 
const ThermoType & specieThermo (const label speciei) const
 Return thermo based on index. More...
 
- Public Member Functions inherited from basicCombustionMixture
 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...
 
volScalarFieldY (const word &specieName)
 Return the mass-fraction field for a specie given by name. More...
 
const volScalarFieldY (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< volScalarFieldfres (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...
 

Static Public Member Functions

static word typeName ()
 Return the instantiated type name. More...
 

Additional Inherited Members

- Protected Attributes inherited from basicCombustionMixture
speciesTable species_
 Table of specie names. More...
 
PtrList< volScalarFieldY_
 Species mass fractions. More...
 

Detailed Description

template<class ThermoType>
class Foam::inhomogeneousMixture< ThermoType >

Foam::inhomogeneousMixture.

Source files

Definition at line 49 of file inhomogeneousMixture.H.

Member Typedef Documentation

◆ thermoType

typedef ThermoType thermoType

The type of thermodynamics this mixture is instantiated for.

Definition at line 79 of file inhomogeneousMixture.H.

Constructor & Destructor Documentation

◆ inhomogeneousMixture()

inhomogeneousMixture ( const dictionary thermoDict,
const fvMesh mesh,
const word phaseName 
)

Construct from dictionary, mesh and phase name.

Definition at line 43 of file inhomogeneousMixture.C.

References inhomogeneousMixture< ThermoType >::mixture().

Here is the call graph for this function:

◆ ~inhomogeneousMixture()

virtual ~inhomogeneousMixture ( )
inlinevirtual

Destructor.

Definition at line 89 of file inhomogeneousMixture.H.

Member Function Documentation

◆ typeName()

static word typeName ( )
inlinestatic

Return the instantiated type name.

Definition at line 96 of file inhomogeneousMixture.H.

◆ stoicRatio()

const dimensionedScalar& stoicRatio ( ) const
inline

Definition at line 101 of file inhomogeneousMixture.H.

References inhomogeneousMixture< ThermoType >::mixture().

Here is the call graph for this function:

◆ mixture()

◆ cellMixture()

const ThermoType& cellMixture ( const label  celli) const
inline

Definition at line 108 of file inhomogeneousMixture.H.

References inhomogeneousMixture< ThermoType >::mixture(), and inhomogeneousMixture< ThermoType >::patchFaceMixture().

Here is the call graph for this function:

◆ patchFaceMixture()

const ThermoType& patchFaceMixture ( const label  patchi,
const label  facei 
) const
inline

Definition at line 114 of file inhomogeneousMixture.H.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), inhomogeneousMixture< ThermoType >::mixture(), and patchi.

Referenced by inhomogeneousMixture< ThermoType >::cellMixture().

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

◆ cellReactants()

const ThermoType& cellReactants ( const label  celli) const
inline

Definition at line 126 of file inhomogeneousMixture.H.

References inhomogeneousMixture< ThermoType >::mixture(), and inhomogeneousMixture< ThermoType >::patchFaceReactants().

Here is the call graph for this function:

◆ patchFaceReactants()

const ThermoType& patchFaceReactants ( const label  patchi,
const label  facei 
) const
inline

Definition at line 132 of file inhomogeneousMixture.H.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), inhomogeneousMixture< ThermoType >::mixture(), and patchi.

Referenced by inhomogeneousMixture< ThermoType >::cellReactants().

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

◆ cellProducts()

const ThermoType& cellProducts ( const label  celli) const
inline

Definition at line 144 of file inhomogeneousMixture.H.

References inhomogeneousMixture< ThermoType >::mixture(), and inhomogeneousMixture< ThermoType >::patchFaceProducts().

Here is the call graph for this function:

◆ patchFaceProducts()

const ThermoType& patchFaceProducts ( const label  patchi,
const label  facei 
) const
inline

◆ read()

void read ( const dictionary thermoDict)

Read dictionary.

Definition at line 99 of file inhomogeneousMixture.C.

References dictionary::lookup(), inhomogeneousMixture< ThermoType >::specieThermo(), and dictionary::subDict().

Referenced by inhomogeneousMixture< ThermoType >::patchFaceProducts().

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

◆ specieThermo()

const ThermoType & specieThermo ( const label  speciei) const

Return thermo based on index.

Definition at line 111 of file inhomogeneousMixture.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Referenced by inhomogeneousMixture< ThermoType >::patchFaceProducts(), and inhomogeneousMixture< ThermoType >::read().

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

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