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

Single component mixture. More...

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 Member Functions

 singleComponentMixture (const dictionary &)
 Construct from a dictionary. More...
 
const speciesTable & species () const
 Return the table of species. More...
 
const boolList & speciesActive () const
 Access the specie active flags. More...
 
boolList & speciesActive ()
 Access the specie active flags. More...
 
const thermoMixtureType & thermoMixture (const scalarFieldListSlice &) const
 Return the mixture for thermodynamic properties. More...
 
const transportMixtureType & transportMixture (const scalarFieldListSlice &) const
 Return the mixture for transport properties. More...
 
const transportMixtureType & transportMixture (const scalarFieldListSlice &, const thermoMixtureType &) const
 Return the mixture for transport properties. More...
 
void read (const dictionary &)
 Read dictionary. More...
 
const ThermoType & specieThermo (const label speciei) const
 Return thermo based on index. More...
 

Static Public Member Functions

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

Detailed Description

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

Single component mixture.

Source files

Definition at line 50 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 &  dict)

Construct from a dictionary.

Definition at line 31 of file singleComponentMixture.C.

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

◆ species()

const speciesTable& species ( ) const
inline

Return the table of species.

Definition at line 93 of file singleComponentMixture.H.

References hashedWordList::null.

◆ speciesActive() [1/2]

const boolList& speciesActive ( ) const
inline

Access the specie active flags.

Definition at line 99 of file singleComponentMixture.H.

References NotImplemented, and List< bool >::null().

Here is the call graph for this function:

◆ speciesActive() [2/2]

boolList& speciesActive ( )
inline

Access the specie active flags.

Definition at line 106 of file singleComponentMixture.H.

References NotImplemented, and List< bool >::null().

Here is the call graph for this function:

◆ thermoMixture()

const thermoMixtureType& thermoMixture ( const scalarFieldListSlice &  ) const
inline

Return the mixture for thermodynamic properties.

Definition at line 113 of file singleComponentMixture.H.

◆ transportMixture() [1/2]

const transportMixtureType& transportMixture ( const scalarFieldListSlice &  ) const
inline

Return the mixture for transport properties.

Definition at line 122 of file singleComponentMixture.H.

◆ transportMixture() [2/2]

const transportMixtureType& transportMixture ( const scalarFieldListSlice &  ,
const thermoMixtureType &   
) const
inline

Return the mixture for transport properties.

Definition at line 131 of file singleComponentMixture.H.

◆ read()

void read ( const dictionary &  dict)

Read dictionary.

Definition at line 43 of file singleComponentMixture.C.

References dict, and dictionary::subDict().

Here is the call graph for this function:

◆ specieThermo()

const ThermoType& specieThermo ( const label  speciei) const
inline

Return thermo based on index.

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