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...
 
typedef ThermoType thermoMixtureType
 Mixing type for thermodynamic properties. More...
 
typedef ThermoType transportMixtureType
 Mixing type for transport properties. 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...
 
 inhomogeneousMixture (const inhomogeneousMixture< ThermoType > &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~inhomogeneousMixture ()
 Destructor. More...
 
const dimensionedScalarstoicRatio () const
 
const thermoTypemixture (const scalar, const scalar) const
 
const thermoMixtureTypecellThermoMixture (const label celli) const
 
const thermoMixtureTypepatchFaceThermoMixture (const label patchi, const label facei) const
 
const transportMixtureTypecellTransportMixture (const label celli) const
 
const transportMixtureTypepatchFaceTransportMixture (const label patchi, const label facei) const
 
const transportMixtureTypecellTransportMixture (const label, const thermoMixtureType &thermoMixture) const
 
const transportMixtureTypepatchFaceTransportMixture (const label, const label, const thermoMixtureType &thermoMixture) const
 
const thermoTypecellReactants (const label celli) const
 
const thermoTypepatchFaceReactants (const label patchi, const label facei) const
 
const thermoTypecellProducts (const label celli) const
 
const thermoTypepatchFaceProducts (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...
 
void operator= (const inhomogeneousMixture< ThermoType > &)=delete
 Disallow default bitwise assignment. 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 57 of file inhomogeneousMixture.H.

◆ thermoMixtureType

typedef ThermoType thermoMixtureType

Mixing type for thermodynamic properties.

Definition at line 60 of file inhomogeneousMixture.H.

◆ transportMixtureType

typedef ThermoType transportMixtureType

Mixing type for transport properties.

Definition at line 63 of file inhomogeneousMixture.H.

Constructor & Destructor Documentation

◆ inhomogeneousMixture() [1/2]

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() [2/2]

inhomogeneousMixture ( const inhomogeneousMixture< ThermoType > &  )
delete

Disallow default bitwise copy construction.

◆ ~inhomogeneousMixture()

virtual ~inhomogeneousMixture ( )
inlinevirtual

Destructor.

Definition at line 100 of file inhomogeneousMixture.H.

Member Function Documentation

◆ typeName()

static word typeName ( )
inlinestatic

Return the instantiated type name.

Definition at line 107 of file inhomogeneousMixture.H.

◆ stoicRatio()

const dimensionedScalar& stoicRatio ( ) const
inline

Definition at line 112 of file inhomogeneousMixture.H.

References inhomogeneousMixture< ThermoType >::mixture().

Here is the call graph for this function:

◆ mixture()

◆ cellThermoMixture()

const thermoMixtureType& cellThermoMixture ( const label  celli) const
inline

Definition at line 119 of file inhomogeneousMixture.H.

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

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

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

◆ patchFaceThermoMixture()

const thermoMixtureType& patchFaceThermoMixture ( const label  patchi,
const label  facei 
) const
inline

◆ cellTransportMixture() [1/2]

const transportMixtureType& cellTransportMixture ( const label  celli) const
inline

◆ patchFaceTransportMixture() [1/2]

const transportMixtureType& patchFaceTransportMixture ( const label  patchi,
const label  facei 
) const
inline

Definition at line 146 of file inhomogeneousMixture.H.

References inhomogeneousMixture< ThermoType >::cellTransportMixture(), and inhomogeneousMixture< ThermoType >::patchFaceThermoMixture().

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

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

◆ cellTransportMixture() [2/2]

const transportMixtureType& cellTransportMixture ( const label  ,
const thermoMixtureType thermoMixture 
) const
inline

Definition at line 155 of file inhomogeneousMixture.H.

References inhomogeneousMixture< ThermoType >::patchFaceTransportMixture().

Here is the call graph for this function:

◆ patchFaceTransportMixture() [2/2]

const transportMixtureType& patchFaceTransportMixture ( const label  ,
const label  ,
const thermoMixtureType thermoMixture 
) const
inline

Definition at line 164 of file inhomogeneousMixture.H.

◆ cellReactants()

const thermoType& cellReactants ( const label  celli) const
inline

Definition at line 173 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 179 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 191 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:

◆ operator=()

void operator= ( const inhomogeneousMixture< ThermoType > &  )
delete

Disallow default bitwise assignment.

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

Here is the caller graph for this function:

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