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...
 
- Public Types inherited from basicSpecieMixture
typedef basicSpecieMixture basicMixtureType
 The base class of the mixture. More...
 
- Public Types inherited from basicMultiComponentMixture
typedef basicMultiComponentMixture 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 ThermoType & cellMixture (const label celli) const
 Get the mixture for the given cell. More...
 
const ThermoType & patchFaceMixture (const label patchi, const label facei) const
 Get the mixture for the given patch face. More...
 
const ThermoType & cellVolMixture (const scalar p, const scalar T, const label celli)
 Get the volumetric mixture for the given cell. More...
 
const ThermoType & patchFaceVolMixture (const scalar p, const scalar T, const label patchi, const label facei) const
 Get the volumetric mixture for the given patch face. More...
 
void read (const dictionary &)
 Read dictionary. More...
 
const ThermoType & getLocalThermo (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...
 
virtual scalar Wi (const label speciei) const =0
 Molecular weight of the given specie [kg/kmol]. 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 scalar Cv (const label speciei, const scalar p, const scalar T) const =0
 Heat capacity at constant volume [J/kg/K]. More...
 
virtual scalar Ha (const label speciei, const scalar p, const scalar T) const =0
 Absolute enthalpy [J/kg]. More...
 
virtual scalar Hs (const label speciei, const scalar p, const scalar T) const =0
 Sensible enthalpy [J/kg]. More...
 
virtual scalar Hc (const label speciei) const =0
 Chemical enthalpy [J/kg]. More...
 
virtual scalar S (const label speciei, const scalar p, const scalar T) const =0
 Entropy [J/kg/K]. More...
 
virtual scalar Es (const label speciei, const scalar p, const scalar T) const =0
 Sensible internal energy [J/kg]. More...
 
virtual scalar G (const label speciei, const scalar p, const scalar T) const =0
 Gibbs free energy [J/kg]. More...
 
virtual scalar A (const label speciei, const scalar p, const scalar T) const =0
 Helmholtz free energy [J/kg]. More...
 
virtual scalar mu (const label speciei, const scalar p, const scalar 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 scalar alphah (const label speciei, const scalar p, const scalar T) const =0
 Thermal diffusivity of enthalpy [kg/m/s]. More...
 
virtual scalar rho (const label speciei, const scalar p, const scalar T) const =0
 Density [kg/m^3]. More...
 
- Public Member Functions inherited from basicMultiComponentMixture
 TypeName ("basicMultiComponentMixture")
 Run time type information. More...
 
 basicMultiComponentMixture (const dictionary &, const wordList &specieNames, const fvMesh &, const word &)
 Construct from dictionary, species names, mesh and phase name. More...
 
virtual ~basicMultiComponentMixture ()
 Destructor. More...
 
const speciesTablespecies () const
 Return the table of species. More...
 
bool contains (const word &specieName) const
 Does the mixture include this 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)
 Set speciei active. More...
 
void setInactive (label speciei)
 Set speciei inactive. 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...
 
- 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 basicMultiComponentMixture
speciesTable species_
 Table of specie names. 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 62 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 80 of file singleComponentMixture.H.

◆ cellMixture()

const ThermoType& cellMixture ( const label  celli) const
inline

Get the mixture for the given cell.

Definition at line 86 of file singleComponentMixture.H.

References singleComponentMixture< ThermoType >::patchFaceMixture().

Here is the call graph for this function:

◆ patchFaceMixture()

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

Get the mixture for the given patch face.

Definition at line 93 of file singleComponentMixture.H.

References singleComponentMixture< ThermoType >::cellVolMixture().

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

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

◆ cellVolMixture()

const ThermoType& cellVolMixture ( const scalar  p,
const scalar  T,
const label  celli 
)
inline

Get the volumetric mixture for the given cell.

Definition at line 103 of file singleComponentMixture.H.

References singleComponentMixture< ThermoType >::patchFaceVolMixture().

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

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

◆ patchFaceVolMixture()

const ThermoType& patchFaceVolMixture ( const scalar  p,
const scalar  T,
const label  patchi,
const label  facei 
) const
inline

Get the volumetric mixture for the given patch face.

Definition at line 114 of file singleComponentMixture.H.

References singleComponentMixture< ThermoType >::read().

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

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 54 of file singleComponentMixture.C.

References dictionary::subDict().

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

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

◆ getLocalThermo()

const ThermoType& getLocalThermo ( const label  speciei) const
inline

Return thermo based on index.

Definition at line 128 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: