Saturated< Thermo, OtherThermo > Class Template Reference

Model which uses a saturation pressure model for a single species to calculate the interface composition. More...

Inheritance diagram for Saturated< Thermo, OtherThermo >:
[legend]
Collaboration diagram for Saturated< Thermo, OtherThermo >:
[legend]

Public Member Functions

 TypeName ("saturated")
 Runtime type information. More...
 
 Saturated (const dictionary &dict, const phasePair &pair)
 Construct from components. More...
 
virtual ~Saturated ()
 Destructor. More...
 
virtual void update (const volScalarField &Tf)
 Update the composition. More...
 
virtual tmp< volScalarFieldYf (const word &speciesName, const volScalarField &Tf) const
 The interface species fraction. More...
 
virtual tmp< volScalarFieldYfPrime (const word &speciesName, const volScalarField &Tf) const
 The interface species fraction derivative w.r.t. temperature. More...
 
- Public Member Functions inherited from InterfaceCompositionModel< Thermo, OtherThermo >
 InterfaceCompositionModel (const dictionary &dict, const phasePair &pair)
 Construct from components. More...
 
 ~InterfaceCompositionModel ()=default
 Destructor. More...
 
virtual tmp< volScalarFielddY (const word &speciesName, const volScalarField &Tf) const
 Mass fraction difference between the interface and the field. More...
 
virtual tmp< volScalarFieldD (const word &speciesName) const
 Mass diffusivity of the local thermo. More...
 
virtual tmp< volScalarFieldL (const word &speciesName, const volScalarField &Tf) const
 Latent heat (to - from)(thermo - otherThermo) More...
 
 InterfaceCompositionModel (const dictionary &dict, const phasePair &pair)
 Construct from components. More...
 
 ~InterfaceCompositionModel ()=default
 Destructor. More...
 
virtual tmp< volScalarFielddY (const word &speciesName, const volScalarField &Tf) const
 Mass fraction difference between the interface and the field. More...
 
virtual tmp< volScalarFieldD (const word &speciesName) const
 Mass diffusivity. More...
 
virtual tmp< volScalarFieldL (const word &speciesName, const volScalarField &Tf) const
 Latent heat. More...
 
virtual void addMDotL (const volScalarField &K, const volScalarField &Tf, volScalarField &mDotL, volScalarField &mDotLPrime) const
 Add latent heat flow rate to total. More...
 
template<class ThermoType >
const Foam::multiComponentMixture< ThermoType >::thermoType & getLocalThermo (const word &speciesName, const multiComponentMixture< ThermoType > &globalThermo) const
 
template<class ThermoType >
const Foam::pureMixture< ThermoType >::thermoType & getLocalThermo (const word &speciesName, const pureMixture< ThermoType > &globalThermo) const
 
template<class ThermoType >
Foam::tmp< Foam::volScalarFieldgetSpecieMassFraction (const word &speciesName, const multiComponentMixture< ThermoType > &mixture) const
 
template<class ThermoType >
Foam::tmp< Foam::volScalarFieldgetSpecieMassFraction (const word &speciesName, const pureMixture< ThermoType > &mixture) const
 
template<class ThermoType >
Foam::tmp< Foam::volScalarFieldMwMixture (const pureMixture< ThermoType > &mixture) const
 
template<class ThermoType >
Foam::tmp< Foam::volScalarFieldMwMixture (const multiComponentMixture< ThermoType > &mixture) const
 
- Public Member Functions inherited from interfaceCompositionModel
 TypeName ("interfaceCompositionModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, interfaceCompositionModel, dictionary,(const dictionary &dict, const phasePair &pair),(dict, pair))
 
 interfaceCompositionModel (const dictionary &dict, const phasePair &pair)
 Construct from a dictionary and a phase pair. More...
 
virtual ~interfaceCompositionModel ()=default
 Destructor. More...
 
const word transferSpecie () const
 Return the transferring species name. More...
 
const phasePairpair () const
 The phase pair. More...
 
virtual tmp< volScalarFieldKexp (const volScalarField &field)=0
 Explicit full mass transfer. More...
 
virtual tmp< volScalarFieldKSp (label modelVariable, const volScalarField &field)=0
 Implicit mass transfer. More...
 
virtual tmp< volScalarFieldKSu (label modelVariable, const volScalarField &field)=0
 Explicit mass transfer. More...
 
virtual const dimensionedScalarTactivate () const noexcept=0
 Reference value. More...
 
virtual bool includeDivU () const noexcept
 
bool includeVolChange ()
 Add volume change in pEq. More...
 
const wordvariable () const
 Returns the variable on which the model is based. More...
 
 TypeName ("interfaceCompositionModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, interfaceCompositionModel, dictionary,(const dictionary &dict, const phasePair &pair),(dict, pair))
 
 interfaceCompositionModel (const dictionary &dict, const phasePair &pair)
 Construct from a dictionary and a phase pair. More...
 
virtual ~interfaceCompositionModel ()=default
 Destructor. More...
 
const hashedWordListspecies () const
 The transferring species names. More...
 
bool transports (word &speciesName) const
 

Protected Member Functions

tmp< volScalarFieldwRatioByP () const
 Constant of proportionality between partial pressure and mass. More...
 
- Protected Member Functions inherited from InterfaceCompositionModel< Thermo, OtherThermo >
template<class ThermoType >
const pureMixture< ThermoType >::thermoType & getLocalThermo (const word &speciesName, const pureMixture< ThermoType > &globalThermo) const
 Get a reference to the local thermo for a pure mixture. More...
 
template<class ThermoType >
const multiComponentMixture< ThermoType >::thermoType & getLocalThermo (const word &speciesName, const multiComponentMixture< ThermoType > &globalThermo) const
 Get a reference to the local thermo for a multi component mixture. More...
 
template<class ThermoType >
tmp< volScalarFieldgetSpecieMassFraction (const word &speciesName, const pureMixture< ThermoType > &thermo) const
 Return mass fraction for a pureMixture equal to one. More...
 
template<class ThermoType >
tmp< volScalarFieldgetSpecieMassFraction (const word &speciesName, const multiComponentMixture< ThermoType > &thermo) const
 Return mass fraction for speciesName. More...
 
template<class ThermoType >
tmp< volScalarFieldMwMixture (const pureMixture< ThermoType > &thermo) const
 Return moleculas weight of the mixture for pureMixture [Kg/mol]. More...
 
template<class ThermoType >
tmp< volScalarFieldMwMixture (const multiComponentMixture< ThermoType > &) const
 Return moleculas weight of the mixture for multiComponentMixture. More...
 
template<class ThermoType >
const pureMixture< ThermoType >::thermoType & getLocalThermo (const word &speciesName, const pureMixture< ThermoType > &globalThermo) const
 Get a reference to the local thermo for a pure mixture. More...
 
template<class ThermoType >
const multiComponentMixture< ThermoType >::thermoType & getLocalThermo (const word &speciesName, const multiComponentMixture< ThermoType > &globalThermo) const
 Get a reference to the local thermo for a multi component mixture. More...
 

Protected Attributes

word saturatedName_
 Saturated species name. More...
 
label saturatedIndex_
 Saturated species index. More...
 
autoPtr< saturationModelsaturationModel_
 Saturation pressure model. More...
 
- Protected Attributes inherited from InterfaceCompositionModel< Thermo, OtherThermo >
const Thermo & fromThermo_
 Thermo (from) More...
 
const OtherThermo & toThermo_
 Other Thermo (to) More...
 
const dimensionedScalar Le_
 Lewis number. More...
 
const Thermo & thermo_
 Thermo. More...
 
const OtherThermo & otherThermo_
 Other Thermo. More...
 
- Protected Attributes inherited from interfaceCompositionModel
modelVariable modelVariable_
 Enumeration for the model variable. More...
 
bool includeVolChange_
 Add volume change in pEq. More...
 
const phasePairpair_
 Phase pair. More...
 
word speciesName_
 Names of the transferring specie. More...
 
const fvMeshmesh_
 Reference to mesh. More...
 
const hashedWordList speciesNames_
 Names of the transferring species. More...
 

Additional Inherited Members

- Public Types inherited from interfaceCompositionModel
enum  modelVariable { T, P, Y, alpha }
 Enumeration for variable based mass transfer models. More...
 
- Static Public Member Functions inherited from interfaceCompositionModel
static autoPtr< interfaceCompositionModelNew (const dictionary &dict, const phasePair &pair)
 
static autoPtr< interfaceCompositionModelNew (const dictionary &dict, const phasePair &pair)
 
- Static Protected Attributes inherited from interfaceCompositionModel
static const Enum< modelVariablemodelVariableNames_
 Selection names for the modelVariable. More...
 

Detailed Description

template<class Thermo, class OtherThermo>
class Foam::interfaceCompositionModels::Saturated< Thermo, OtherThermo >

Model which uses a saturation pressure model for a single species to calculate the interface composition.

Source files

Definition at line 58 of file Saturated.H.

Constructor & Destructor Documentation

◆ Saturated()

Saturated ( const dictionary dict,
const phasePair pair 
)

Construct from components.

Definition at line 52 of file Saturated.C.

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

Here is the call graph for this function:

◆ ~Saturated()

~Saturated ( )
virtual

Destructor.

Definition at line 84 of file Saturated.C.

Member Function Documentation

◆ wRatioByP()

Foam::tmp< Foam::volScalarField > wRatioByP ( ) const
protected

Constant of proportionality between partial pressure and mass.

fraction

Definition at line 35 of file Saturated.C.

References Foam::dimMass, and Foam::dimMoles.

◆ TypeName()

TypeName ( "saturated"  )

Runtime type information.

◆ update()

void update ( const volScalarField Tf)
virtual

Update the composition.

Implements interfaceCompositionModel.

Definition at line 93 of file Saturated.C.

◆ Yf()

Foam::tmp< Foam::volScalarField > Yf ( const word speciesName,
const volScalarField Tf 
) const
virtual

The interface species fraction.

Reimplemented from InterfaceCompositionModel< Thermo, OtherThermo >.

Definition at line 102 of file Saturated.C.

References Foam::max().

Here is the call graph for this function:

◆ YfPrime()

Foam::tmp< Foam::volScalarField > YfPrime ( const word speciesName,
const volScalarField Tf 
) const
virtual

The interface species fraction derivative w.r.t. temperature.

Implements interfaceCompositionModel.

Definition at line 129 of file Saturated.C.

References Foam::max().

Here is the call graph for this function:

Member Data Documentation

◆ saturatedName_

word saturatedName_
protected

Saturated species name.

Definition at line 67 of file Saturated.H.

◆ saturatedIndex_

label saturatedIndex_
protected

Saturated species index.

Definition at line 70 of file Saturated.H.

◆ saturationModel_

autoPtr<saturationModel> saturationModel_
protected

Saturation pressure model.

Definition at line 73 of file Saturated.H.


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