singleComponentMixture< ThermoType > Class Template Reference

Single component mixture. More...

Inheritance diagram for singleComponentMixture< ThermoType >:
Collaboration diagram for singleComponentMixture< 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 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

 singleComponentMixture (const dictionary &, const fvMesh &, const word &)
 Construct from dictionary, mesh and phase name. More...
 
virtual ~singleComponentMixture ()
 Destructor. More...
 
const thermoMixtureTypecellThermoMixture (const label) const
 
const thermoMixtureTypepatchFaceThermoMixture (const label, const label) const
 
const transportMixtureTypecellTransportMixture (const label) const
 
const transportMixtureTypepatchFaceTransportMixture (const label, const label) const
 
const transportMixtureTypecellTransportMixture (const label, const thermoMixtureType &) const
 
const transportMixtureTypepatchFaceTransportMixture (const label, const label, const thermoMixtureType &) 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 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 speciesTablespecies () 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...
 
volScalarFieldY (const label i)
 Return the mass-fraction field for a specie given by index. More...
 
const volScalarFieldY (const label i) const
 Return the const mass-fraction field for a specie given by index. 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...
 
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< volScalarFieldrho (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< volScalarFieldCp (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< scalarFieldHE (const label speciei, const scalarField &p, const scalarField &T) const =0
 Enthalpy/Internal energy [J/kg]. More...
 
virtual tmp< volScalarFieldHE (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< scalarFieldHs (const label speciei, const scalarField &p, const scalarField &T) const =0
 Sensible enthalpy [J/kg]. More...
 
virtual tmp< volScalarFieldHs (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< scalarFieldHa (const label speciei, const scalarField &p, const scalarField &T) const =0
 Enthalpy/Internal energy [J/kg]. More...
 
virtual tmp< volScalarFieldHa (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< volScalarFieldmu (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< volScalarFieldkappa (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...
 

Static Public Member Functions

static word typeName ()
 Return the instantiated type 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 wordphaseName_
 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< volScalarFieldY_
 Species mass fractions. More...
 

Detailed Description

template<class ThermoType>
class Foam::singleComponentMixture< ThermoType >

Single component mixture.

Source files

Definition at line 49 of file singleComponentMixture.H.

Member Typedef Documentation

◆ thermoType

typedef ThermoType thermoType

The type of thermodynamics this mixture is instantiated for.

Definition at line 57 of file singleComponentMixture.H.

◆ thermoMixtureType

typedef ThermoType thermoMixtureType

Mixing type for thermodynamic properties.

Definition at line 60 of file singleComponentMixture.H.

◆ transportMixtureType

typedef ThermoType transportMixtureType

Mixing type for transport properties.

Definition at line 63 of file singleComponentMixture.H.

Constructor & Destructor Documentation

◆ singleComponentMixture()

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

Construct from dictionary, mesh and phase name.

Definition at line 32 of file singleComponentMixture.C.

◆ ~singleComponentMixture()

~singleComponentMixture ( )
virtual

Destructor.

Definition at line 46 of file singleComponentMixture.C.

References singleComponentMixture< ThermoType >::read().

Here is the call graph for this function:

Member Function Documentation

◆ typeName()

static word typeName ( )
inlinestatic

Return the instantiated type name.

Note: This defines the same name as pureMixture so that non-reacting and reacting solvers are compatible

Definition at line 91 of file singleComponentMixture.H.

◆ cellThermoMixture()

const thermoMixtureType& cellThermoMixture ( const label  ) const
inline

Definition at line 96 of file singleComponentMixture.H.

References singleComponentMixture< ThermoType >::patchFaceThermoMixture().

Here is the call graph for this function:

◆ patchFaceThermoMixture()

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

Definition at line 102 of file singleComponentMixture.H.

Referenced by singleComponentMixture< ThermoType >::cellThermoMixture().

Here is the caller graph for this function:

◆ cellTransportMixture() [1/2]

const transportMixtureType& cellTransportMixture ( const label  ) const
inline

Definition at line 110 of file singleComponentMixture.H.

References singleComponentMixture< ThermoType >::patchFaceTransportMixture().

Referenced by singleComponentMixture< ThermoType >::patchFaceTransportMixture().

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

◆ patchFaceTransportMixture() [1/2]

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

Definition at line 116 of file singleComponentMixture.H.

References singleComponentMixture< ThermoType >::cellTransportMixture().

Referenced by singleComponentMixture< 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  
) const
inline

Definition at line 125 of file singleComponentMixture.H.

References singleComponentMixture< ThermoType >::patchFaceTransportMixture().

Here is the call graph for this function:

◆ patchFaceTransportMixture() [2/2]

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

Definition at line 134 of file singleComponentMixture.H.

References singleComponentMixture< ThermoType >::read().

Here is the call graph for this function:

◆ read()

void read ( const dictionary thermoDict)

Read dictionary.

Definition at line 54 of file singleComponentMixture.C.

References dictionary::subDict().

Referenced by singleComponentMixture< ThermoType >::patchFaceTransportMixture(), and singleComponentMixture< ThermoType >::~singleComponentMixture().

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 147 of file singleComponentMixture.H.

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

Here is the call graph for this function:

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