Single component mixture. More...

#include <singleComponentMixture.H>

Inheritance diagram for singleComponentMixture< ThermoType >:

Collaboration diagram for singleComponentMixture< ThermoType >:

Public Types
typedef ThermoType	thermoType
	The type of thermodynamics this mixture is instantiated for.
Public Types inherited from basicSpecieMixture
typedef basicSpecieMixture	basicMixtureType
	The base class of the mixture.
Public Types inherited from basicMultiComponentMixture
typedef basicMultiComponentMixture	basicMixtureType
	The base class of the mixture.
Public Types inherited from basicMixture
typedef basicMixture	basicMixtureType
	The base class of the mixture.

Public Member Functions
	singleComponentMixture (const dictionary &thermoDict, const fvMesh &mesh, const word &phaseName)
	Construct from dictionary, mesh and phase name.
virtual	~singleComponentMixture ()=default
	Destructor.
const ThermoType &	cellMixture (const label celli) const
	Get the mixture for the given cell.
const ThermoType &	patchFaceMixture (const label patchi, const label facei) const
	Get the mixture for the given patch face.
const ThermoType &	cellVolMixture (const scalar p, const scalar T, const label celli)
	Get the volumetric mixture for the given cell.
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.
void	read (const dictionary &)
	Read dictionary.
const ThermoType &	getLocalThermo (const label speciei) const
	Return thermo based on index.
Public Member Functions inherited from basicSpecieMixture
	TypeName ("basicSpecieMixture")
	Run time type information.
	basicSpecieMixture (const dictionary &thermoDict, const wordList &specieNames, const fvMesh &mesh, const word &phaseName)
	Construct from dictionary, species names, mesh and phase name.
virtual	~basicSpecieMixture ()=default
	Destructor.
virtual scalar	W (const label speciei) const =0
	Molecular weight of the given specie [kg/kmol].
virtual scalar	Hc (const label speciei) const =0
	Chemical enthalpy [J/kg].
virtual scalar	Cp (const label speciei, const scalar p, const scalar T) const =0
	Heat capacity at constant pressure [J/(kg K)].
virtual scalar	Cv (const label speciei, const scalar p, const scalar T) const =0
	Heat capacity at constant volume [J/(kg K)].
virtual scalar	HE (const label speciei, const scalar p, const scalar T) const =0
	Enthalpy/Internal energy [J/kg].
virtual scalar	Ha (const label speciei, const scalar p, const scalar T) const =0
	Absolute enthalpy [J/kg].
virtual scalar	Hs (const label speciei, const scalar p, const scalar T) const =0
	Sensible enthalpy [J/kg].
virtual scalar	S (const label speciei, const scalar p, const scalar T) const =0
	Entropy [J/(kg K)].
virtual scalar	Es (const label speciei, const scalar p, const scalar T) const =0
	Sensible internal energy [J/kg].
virtual scalar	G (const label speciei, const scalar p, const scalar T) const =0
	Gibbs free energy [J/kg].
virtual scalar	A (const label speciei, const scalar p, const scalar T) const =0
	Helmholtz free energy [J/kg].
virtual scalar	mu (const label speciei, const scalar p, const scalar T) const =0
	Dynamic viscosity [kg/m/s].
virtual scalar	kappa (const label speciei, const scalar p, const scalar T) const =0
	Thermal conductivity [W/m/K].
virtual scalar	alphah (const label speciei, const scalar p, const scalar T) const =0
	Thermal diffusivity of enthalpy [kg/m/s].
virtual scalar	rho (const label speciei, const scalar p, const scalar T) const =0
	Density [kg/m3].
virtual autoPtr< speciesCompositionTable >	specieComposition () const
	Species composition.
Public Member Functions inherited from basicMultiComponentMixture
	TypeName ("basicMultiComponentMixture")
	Run time type information.
	basicMultiComponentMixture (const dictionary &thermoDict, const wordList &specieNames, const fvMesh &mesh, const word &phaseName)
	Construct from dictionary, species names, mesh and phase name.
virtual	~basicMultiComponentMixture ()=default
	Destructor.
const speciesTable &	species () const
	Return the table of species.
bool	contains (const word &specieName) const
	Does the mixture include this specie?
bool	active (label speciei) const
	Return true for active species.
const List< bool > &	active () const
	Return the bool list of active species.
void	setActive (label speciei)
	Set speciei active.
void	setInactive (label speciei)
	Set speciei inactive.
PtrList< volScalarField > &	Y ()
	Return the mass-fraction fields.
const PtrList< volScalarField > &	Y () const
	Return the const mass-fraction fields.
volScalarField &	Y (const label i)
	Return the mass-fraction field for a specie given by index.
const volScalarField &	Y (const label i) const
	Return the const mass-fraction field for a specie given by index.
volScalarField &	Y (const word &specieName)
	Return the mass-fraction field for a specie given by name.
const volScalarField &	Y (const word &specieName) const
	Return the const mass-fraction field for a specie given by name.
Public Member Functions inherited from basicMixture
	basicMixture (const dictionary &, const fvMesh &, const word &)
	Construct from dictionary, mesh and phase name.

Static Public Member Functions
static word	typeName ()
	Return the instantiated type name.

Additional Inherited Members
Protected Attributes inherited from basicMultiComponentMixture
speciesTable	species_
	Table of specie names.
List< bool >	active_
	List of specie active flags.
PtrList< volScalarField >	Y_
	Species mass fractions.

Detailed Description

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

Single component mixture.

Source files

Definition at line 47 of file singleComponentMixture.H.

Member Typedef Documentation

◆ thermoType

template<class ThermoType>

typedef ThermoType thermoType

The type of thermodynamics this mixture is instantiated for.

Definition at line 64 of file singleComponentMixture.H.

Constructor & Destructor Documentation

◆ singleComponentMixture()

template<class ThermoType>

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

Construct from dictionary, mesh and phase name.

Definition at line 26 of file singleComponentMixture.C.

References basicSpecieMixture::basicSpecieMixture(), mesh, and thermoDict.

Here is the call graph for this function:

◆ ~singleComponentMixture()

template<class ThermoType>

virtual ~singleComponentMixture ( )

virtualdefault

Destructor.

Member Function Documentation

◆ typeName()

template<class ThermoType>

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

◆ cellMixture()

template<class ThermoType>

const ThermoType & cellMixture ( const label celli ) const

inline

Get the mixture for the given cell.

Definition at line 102 of file singleComponentMixture.H.

◆ patchFaceMixture()

template<class ThermoType>

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

inline

Get the mixture for the given patch face.

Definition at line 110 of file singleComponentMixture.H.

◆ cellVolMixture()

template<class ThermoType>

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

inline

Get the volumetric mixture for the given cell.

Definition at line 122 of file singleComponentMixture.H.

References p, and Foam::T().

Here is the call graph for this function:

◆ patchFaceVolMixture()

template<class ThermoType>

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

References p, and Foam::T().

Here is the call graph for this function:

◆ read()

template<class ThermoType>

void read ( const dictionary & thermoDict )

Read dictionary.

Definition at line 41 of file singleComponentMixture.C.

References thermoDict.

◆ getLocalThermo()

template<class ThermoType>

const ThermoType & getLocalThermo ( const label speciei ) const

inline

Return thermo based on index.

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

src/thermophysicalModels/reactionThermo/mixtures/singleComponentMixture/singleComponentMixture.H
src/thermophysicalModels/reactionThermo/mixtures/singleComponentMixture/singleComponentMixture.C

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ thermoType

Constructor & Destructor Documentation

◆ singleComponentMixture()

◆ ~singleComponentMixture()

Member Function Documentation

◆ typeName()

◆ cellMixture()

◆ patchFaceMixture()

◆ cellVolMixture()

◆ patchFaceVolMixture()

◆ read()

◆ getLocalThermo()