Public Types | Public Member Functions | List of all members
multiComponentMixture< ThermoType > Class Template Reference

Foam::multiComponentMixture. More...

Inheritance diagram for multiComponentMixture< ThermoType >:
Inheritance graph
[legend]
Collaboration diagram for multiComponentMixture< ThermoType >:
Collaboration graph
[legend]

Public Types

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

 multiComponentMixture (const dictionary &, const fvMesh &, const word &)
 Construct from dictionary, mesh and phase name. More...
 
 multiComponentMixture (const multiComponentMixture< ThermoType > &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~multiComponentMixture ()
 Destructor. More...
 
const PtrList< ThermoType > & specieThermos () const
 Return the raw specie thermodynamic data. More...
 
void read (const dictionary &)
 Read dictionary. More...
 
const ThermoType & specieThermo (const label speciei) const
 Return thermo based on index. More...
 
const List< specieElement > & specieComposition (const label speciei) const
 Return composition based on index. More...
 
- Public Member Functions inherited from basicSpecieMixture
 TypeName ("basicSpecieMixture")
 Run time type information. More...
 
 basicSpecieMixture (const dictionary &, const wordList &specieNames, const fvMesh &, const word &)
 Construct from dictionary, species names, mesh and phase name. More...
 
virtual ~basicSpecieMixture ()
 Destructor. More...
 
const speciesTable & species () const
 Return the table of species. More...
 
bool contains (const word &specieName) const
 Does the mixture include this specie? More...
 
label defaultSpecie () const
 Return the index of the default specie. More...
 
bool active (label speciei) const
 Return true for active species. More...
 
const List< bool > & active () const
 Return the bool list of active species. More...
 
void setActive (label speciei) const
 Set speciei active. More...
 
void setInactive (label speciei) const
 Set speciei inactive. More...
 
bool solve (label speciei) const
 Return true if the specie should be solved for. More...
 
PtrList< volScalarField > & Y ()
 Return the mass-fraction fields. More...
 
const PtrList< volScalarField > & Y () const
 Return the const mass-fraction fields. More...
 
volScalarField & Y (const label i)
 Return the mass-fraction field for a specie given by index. More...
 
const volScalarField & Y (const label i) const
 Return the const mass-fraction field for a specie given by index. 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...
 
label index (const volScalarField &Yi) const
 Return the specie index of the given mass-fraction field. More...
 
void normalise ()
 Normalise the mass fractions. More...
 
virtual scalar Wi (const label speciei) const =0
 Molecular weight of the given specie [kg/kmol]. More...
 
virtual scalar Hf (const label speciei) const =0
 Enthalpy of formation [J/kg]. More...
 
virtual scalar rho (const label speciei, const scalar p, const scalar T) const =0
 Density [kg/m^3]. More...
 
virtual tmp< volScalarField > rho (const label speciei, const volScalarField &p, const volScalarField &T) const =0
 Density [kg/m^3]. More...
 
virtual scalar Cp (const label speciei, const scalar p, const scalar T) const =0
 Heat capacity at constant pressure [J/kg/K]. More...
 
virtual tmp< volScalarField > Cp (const label speciei, const volScalarField &p, const volScalarField &T) const =0
 Heat capacity at constant pressure [J/kg/K]. More...
 
virtual scalar HE (const label speciei, const scalar p, const scalar T) const =0
 Enthalpy/Internal energy [J/kg]. More...
 
virtual tmp< scalarField > HE (const label speciei, const scalarField &p, const scalarField &T) const =0
 Enthalpy/Internal energy [J/kg]. More...
 
virtual tmp< volScalarField > HE (const label speciei, const volScalarField &p, const volScalarField &T) const =0
 Enthalpy/Internal energy [J/kg]. More...
 
virtual scalar Hs (const label speciei, const scalar p, const scalar T) const =0
 Sensible enthalpy [J/kg]. More...
 
virtual tmp< scalarField > Hs (const label speciei, const scalarField &p, const scalarField &T) const =0
 Sensible enthalpy [J/kg]. More...
 
virtual tmp< volScalarField > Hs (const label speciei, const volScalarField &p, const volScalarField &T) const =0
 Sensible enthalpy [J/kg]. More...
 
virtual scalar Ha (const label speciei, const scalar p, const scalar T) const =0
 Absolute enthalpy [J/kg]. More...
 
virtual tmp< scalarField > Ha (const label speciei, const scalarField &p, const scalarField &T) const =0
 Enthalpy/Internal energy [J/kg]. More...
 
virtual tmp< volScalarField > Ha (const label speciei, const volScalarField &p, const volScalarField &T) const =0
 Absolute enthalpy [J/kg]. More...
 
virtual scalar mu (const label speciei, const scalar p, const scalar T) const =0
 Dynamic viscosity [kg/m/s]. More...
 
virtual tmp< volScalarField > mu (const label speciei, const volScalarField &p, const volScalarField &T) const =0
 Dynamic viscosity [kg/m/s]. More...
 
virtual scalar kappa (const label speciei, const scalar p, const scalar T) const =0
 Thermal conductivity [W/m/K]. More...
 
virtual tmp< volScalarField > kappa (const label speciei, const volScalarField &p, const volScalarField &T) const =0
 Thermal conductivity [W/m/K]. More...
 
- Public Member Functions inherited from basicMixture
 basicMixture (const dictionary &, const fvMesh &, const word &)
 Construct from dictionary, mesh and phase name. More...
 

Additional Inherited Members

- Protected Member Functions inherited from basicSpecieMixture
void correctMassFractions ()
 Scale the mass fractions to sum to 1. More...
 
- Protected Attributes inherited from basicSpecieMixture
const word & phaseName_
 Phase-name. More...
 
speciesTable species_
 Table of specie names. More...
 
word defaultSpecie_
 The name of the default specie. More...
 
label defaultSpecieIndex_
 The index of the default specie. More...
 
List< bool > active_
 List of specie active flags. More...
 
PtrList< volScalarField > Y_
 Species mass fractions. More...
 

Detailed Description

template<class ThermoType>
class Foam::multiComponentMixture< ThermoType >

Foam::multiComponentMixture.

Source files

Definition at line 51 of file multiComponentMixture.H.

Member Typedef Documentation

◆ thermoType

typedef ThermoType thermoType

The type of thermodynamics this mixture is instantiated for.

Definition at line 59 of file multiComponentMixture.H.

Constructor & Destructor Documentation

◆ multiComponentMixture() [1/2]

multiComponentMixture ( const dictionary &  thermoDict,
const fvMesh &  mesh,
const word &  phaseName 
)

Construct from dictionary, mesh and phase name.

Definition at line 91 of file multiComponentMixture.C.

References multiComponentMixture< ThermoType >::read().

Here is the call graph for this function:

◆ multiComponentMixture() [2/2]

multiComponentMixture ( const multiComponentMixture< ThermoType > &  )
delete

Disallow default bitwise copy construction.

◆ ~multiComponentMixture()

virtual ~multiComponentMixture ( )
inlinevirtual

Destructor.

Definition at line 100 of file multiComponentMixture.H.

Member Function Documentation

◆ specieThermos()

const PtrList<ThermoType>& specieThermos ( ) const
inline

Return the raw specie thermodynamic data.

Definition at line 107 of file multiComponentMixture.H.

References multiComponentMixture< ThermoType >::read().

Referenced by coefficientWilkeMultiComponentMixture< ThermoType >::cellThermoMixture(), coefficientWilkeMultiComponentMixture< ThermoType >::cellTransportMixture(), valueMultiComponentMixture< ThermoType >::cellTransportMixture(), coefficientWilkeMultiComponentMixture< ThermoType >::patchFaceThermoMixture(), coefficientWilkeMultiComponentMixture< ThermoType >::patchFaceTransportMixture(), and valueMultiComponentMixture< ThermoType >::patchFaceTransportMixture().

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

◆ read()

void read ( const dictionary &  thermoDict)

Read dictionary.

Definition at line 115 of file multiComponentMixture.C.

References multiComponentMixture< ThermoType >::specieComposition().

Referenced by multiComponentMixture< ThermoType >::multiComponentMixture(), and multiComponentMixture< ThermoType >::specieThermos().

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

◆ specieThermo()

const ThermoType& specieThermo ( const label  speciei) const
inline

Return thermo based on index.

Definition at line 116 of file multiComponentMixture.H.

References multiComponentMixture< ThermoType >::specieComposition().

Here is the call graph for this function:

◆ specieComposition()

const Foam::List< Foam::specieElement > & specieComposition ( const label  speciei) const

Return composition based on index.

Definition at line 127 of file multiComponentMixture.C.

Referenced by multiComponentMixture< ThermoType >::read(), and multiComponentMixture< ThermoType >::specieThermo().

Here is the caller graph for this function:
The documentation for this class was generated from the following files: