Base class for interface composition models, templated on the two thermodynamic models either side of the interface. More...

Inheritance diagram for InterfaceCompositionModel< Thermo, OtherThermo >:

[legend]

Collaboration diagram for InterfaceCompositionModel< Thermo, OtherThermo >:

[legend]

Public Member Functions
	InterfaceCompositionModel (const dictionary &dict, const phasePair &pair)
	Construct from components. More...

	~InterfaceCompositionModel ()=default
	Destructor. More...

virtual tmp< volScalarField >	dY (const word &speciesName, const volScalarField &Tf) const
	Mass fraction difference between the interface and the field. More...

virtual tmp< volScalarField >	D (const word &speciesName) const
	Mass diffusivity. More...

virtual tmp< volScalarField >	L (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...

	InterfaceCompositionModel (const dictionary &dict, const phasePair &pair)
	Construct from components. More...

	~InterfaceCompositionModel ()=default
	Destructor. More...

virtual tmp< volScalarField >	dY (const word &speciesName, const volScalarField &Tf) const
	Mass fraction difference between the interface and the field. More...

virtual tmp< volScalarField >	Yf (const word &speciesName, const volScalarField &Tf) const
	Reference mass fraction for species based models. More...

virtual tmp< volScalarField >	D (const word &speciesName) const
	Mass diffusivity of the local thermo. More...

virtual tmp< volScalarField >	L (const word &speciesName, const volScalarField &Tf) const
	Latent heat (to - from)(thermo - otherThermo) 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

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...

virtual void	update (const volScalarField &Tf)=0
	Update the composition. More...

const hashedWordList &	species () const
	Return the transferring species names. More...

bool	transports (word &speciesName) const

virtual tmp< volScalarField >	YfPrime (const word &speciesName, const volScalarField &Tf) const =0
	The interface mass fraction derivative w.r.t. temperature. 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 word	transferSpecie () const
	Return the transferring species name. More...

const phasePair &	pair () const
	Return pair. More...

virtual tmp< volScalarField >	Kexp (const volScalarField &field)=0
	Explicit full mass transfer. More...

virtual tmp< volScalarField >	KSp (label modelVariable, const volScalarField &field)=0
	Implicit mass transfer. More...

virtual tmp< volScalarField >	KSu (label modelVariable, const volScalarField &field)=0
	Explicit mass transfer. More...

virtual const dimensionedScalar &	Tactivate () const =0
	Reference value. More...

virtual bool	includeDivU ()

bool	includeVolChange ()
	Add volume change in pEq. More...

const word	variable () const
	Returns the variable on which the model is based. More...

Protected Member Functions
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 >
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< volScalarField >	getSpecieMassFraction (const word &speciesName, const pureMixture< ThermoType > &thermo) const
	Return mass fraction for a pureMixture equal to one. More...

template<class ThermoType >
tmp< volScalarField >	getSpecieMassFraction (const word &speciesName, const multiComponentMixture< ThermoType > &thermo) const
	Return mass fraction for speciesName. More...

template<class ThermoType >
tmp< volScalarField >	MwMixture (const pureMixture< ThermoType > &thermo) const
	Return moleculas weight of the mixture for pureMixture [Kg/mol]. More...

template<class ThermoType >
tmp< volScalarField >	MwMixture (const multiComponentMixture< ThermoType > &) const
	Return moleculas weight of the mixture for multiComponentMixture. More...

Protected Attributes
const Thermo &	thermo_
	Thermo. More...

const OtherThermo &	otherThermo_
	Other Thermo. More...

const dimensionedScalar	Le_
	Lewis number. More...

const Thermo &	fromThermo_
	Thermo (from) More...

const OtherThermo &	toThermo_
	Other Thermo (to) More...

Protected Attributes inherited from interfaceCompositionModel
const phasePair &	pair_
	Phase pair. More...

const hashedWordList	speciesNames_
	Names of the transferring species. More...

word	speciesName_
	Names of the transferring specie. More...

const fvMesh &	mesh_
	Reference to mesh. 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< interfaceCompositionModel >	New (const dictionary &dict, const phasePair &pair)

static autoPtr< interfaceCompositionModel >	New (const dictionary &dict, const phasePair &pair)

Public Attributes inherited from interfaceCompositionModel
modelVariable	modelVariable_
	Enumeration for model variables. More...

bool	includeVolChange_
	Add volume change in pEq. More...

Static Public Attributes inherited from interfaceCompositionModel
static const Enum< modelVariable >	modelVariableNames

Detailed Description

template<class Thermo, class OtherThermo>
class Foam::InterfaceCompositionModel< Thermo, OtherThermo >

Base class for interface composition models, templated on the two thermodynamic models either side of the interface.

Source files

Definition at line 57 of file InterfaceCompositionModel.H.

Constructor & Destructor Documentation

◆ InterfaceCompositionModel() [1/2]

InterfaceCompositionModel	(	const dictionary &	dict,
		const phasePair &	pair
	)

Construct from components.

Definition at line 74 of file InterfaceCompositionModel.C.

◆ ~InterfaceCompositionModel() [1/2]

~InterfaceCompositionModel ( )

default

Destructor.

◆ InterfaceCompositionModel() [2/2]

InterfaceCompositionModel	(	const dictionary &	dict,
		const phasePair &	pair
	)

Construct from components.

◆ ~InterfaceCompositionModel() [2/2]

~InterfaceCompositionModel ( )

default

Destructor.

Member Function Documentation

◆ getLocalThermo() [1/6]

const pureMixture<ThermoType>::thermoType& getLocalThermo	(	const word &	speciesName,
		const pureMixture< ThermoType > &	globalThermo
	)		const

protected

Get a reference to the local thermo for a pure mixture.

◆ getLocalThermo() [2/6]

const multiComponentMixture<ThermoType>::thermoType& getLocalThermo	(	const word &	speciesName,
		const multiComponentMixture< ThermoType > &	globalThermo
	)		const

protected

Get a reference to the local thermo for a multi component mixture.

◆ dY() [1/2]

Foam::tmp< Foam::volScalarField > dY	(	const word &	speciesName,
		const volScalarField &	Tf
	)		const

virtual

Mass fraction difference between the interface and the field.

Implements interfaceCompositionModel.

Definition at line 103 of file InterfaceCompositionModel.C.

◆ D() [1/2]

Foam::tmp< Foam::volScalarField > D ( const word & speciesName ) const

virtual

Mass diffusivity.

Implements interfaceCompositionModel.

Definition at line 120 of file InterfaceCompositionModel.C.

References D, Foam::dimArea, Foam::dimTime, forAll, Foam::New(), p, and T.

Here is the call graph for this function:

◆ L() [1/2]

Foam::tmp< Foam::volScalarField > L	(	const word &	speciesName,
		const volScalarField &	Tf
	)		const

virtual

Latent heat.

Implements interfaceCompositionModel.

Definition at line 163 of file InterfaceCompositionModel.C.

References Foam::dimEnergy, Foam::dimMass, forAll, L(), Foam::New(), and p.

Here is the call graph for this function:

◆ addMDotL()

void addMDotL	(	const volScalarField &	K,
		const volScalarField &	Tf,
		volScalarField &	mDotL,
		volScalarField &	mDotLPrime
	)		const

virtual

Add latent heat flow rate to total.

Implements interfaceCompositionModel.

Definition at line 209 of file InterfaceCompositionModel.C.

References D, and L().

Here is the call graph for this function:

◆ getLocalThermo() [3/6]

const pureMixture<ThermoType>::thermoType& getLocalThermo	(	const word &	speciesName,
		const pureMixture< ThermoType > &	globalThermo
	)		const

protected

Get a reference to the local thermo for a pure mixture.

◆ getLocalThermo() [4/6]

const multiComponentMixture<ThermoType>::thermoType& getLocalThermo	(	const word &	speciesName,
		const multiComponentMixture< ThermoType > &	globalThermo
	)		const

protected

Get a reference to the local thermo for a multi component mixture.

◆ getSpecieMassFraction() [1/2]

tmp<volScalarField> getSpecieMassFraction	(	const word &	speciesName,
		const pureMixture< ThermoType > &	thermo
	)		const

protected

Return mass fraction for a pureMixture equal to one.

◆ getSpecieMassFraction() [2/2]

tmp<volScalarField> getSpecieMassFraction	(	const word &	speciesName,
		const multiComponentMixture< ThermoType > &	thermo
	)		const

protected

Return mass fraction for speciesName.

◆ MwMixture() [1/2]

tmp<volScalarField> MwMixture ( const pureMixture< ThermoType > & thermo ) const

protected

Return moleculas weight of the mixture for pureMixture [Kg/mol].

◆ MwMixture() [2/2]

tmp<volScalarField> MwMixture ( const multiComponentMixture< ThermoType > & ) const

protected

Return moleculas weight of the mixture for multiComponentMixture.

[Kg/mol]

◆ dY() [2/2]

virtual tmp<volScalarField> dY	(	const word &	speciesName,
		const volScalarField &	Tf
	)		const

virtual

Mass fraction difference between the interface and the field.

Implements interfaceCompositionModel.

◆ Yf()

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

virtual

Reference mass fraction for species based models.

Implements interfaceCompositionModel.

Reimplemented in NonRandomTwoLiquid< Thermo, OtherThermo >, Saturated< Thermo, OtherThermo >, Henry< Thermo, OtherThermo >, and Raoult< Thermo, OtherThermo >.

◆ D() [2/2]

virtual tmp<volScalarField> D ( const word & speciesName ) const

virtual

Mass diffusivity of the local thermo.

Implements interfaceCompositionModel.

◆ L() [2/2]

virtual tmp<volScalarField> L	(	const word &	speciesName,
		const volScalarField &	Tf
	)		const

virtual

Latent heat (to - from)(thermo - otherThermo)

Implements interfaceCompositionModel.

◆ getLocalThermo() [5/6]

const Foam::multiComponentMixture<ThermoType>::thermoType& getLocalThermo	(	const word &	speciesName,
		const multiComponentMixture< ThermoType > &	globalThermo
	)		const

Definition at line 41 of file InterfaceCompositionModel.C.

References multiComponentMixture< ThermoType >::getLocalThermo().

Here is the call graph for this function:

◆ getLocalThermo() [6/6]

const Foam::pureMixture<ThermoType>::thermoType& getLocalThermo	(	const word &	speciesName,
		const pureMixture< ThermoType > &	globalThermo
	)		const

Definition at line 61 of file InterfaceCompositionModel.C.

References pureMixture< ThermoType >::cellMixture().

Here is the call graph for this function:

Member Data Documentation

◆ thermo_

const Thermo& thermo_

protected

Thermo.

Definition at line 66 of file InterfaceCompositionModel.H.

◆ otherThermo_

const OtherThermo& otherThermo_

protected

Other Thermo.

Definition at line 69 of file InterfaceCompositionModel.H.

◆ Le_

const dimensionedScalar Le_

protected

Lewis number.

Definition at line 72 of file InterfaceCompositionModel.H.

◆ fromThermo_

const Thermo& fromThermo_

protected

Thermo (from)

Definition at line 66 of file InterfaceCompositionModel.H.

◆ toThermo_

const OtherThermo& toThermo_

protected

Other Thermo (to)

Definition at line 69 of file InterfaceCompositionModel.H.

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

src/phaseSystemModels/reactingEulerFoam/interfacialCompositionModels/interfaceCompositionModels/InterfaceCompositionModel/InterfaceCompositionModel.H
src/phaseSystemModels/reactingEulerFoam/interfacialCompositionModels/interfaceCompositionModels/InterfaceCompositionModel/InterfaceCompositionModel.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Thermo, class OtherThermo> class Foam::InterfaceCompositionModel< Thermo, OtherThermo >

Constructor & Destructor Documentation

◆ InterfaceCompositionModel() [1/2]

◆ ~InterfaceCompositionModel() [1/2]

◆ InterfaceCompositionModel() [2/2]

◆ ~InterfaceCompositionModel() [2/2]

Member Function Documentation

◆ getLocalThermo() [1/6]

◆ getLocalThermo() [2/6]

◆ dY() [1/2]

◆ D() [1/2]

◆ L() [1/2]

◆ addMDotL()

◆ getLocalThermo() [3/6]

◆ getLocalThermo() [4/6]

◆ getSpecieMassFraction() [1/2]

◆ getSpecieMassFraction() [2/2]

◆ MwMixture() [1/2]

◆ MwMixture() [2/2]

◆ dY() [2/2]

◆ Yf()

◆ D() [2/2]

◆ L() [2/2]

◆ getLocalThermo() [5/6]

◆ getLocalThermo() [6/6]

Member Data Documentation

◆ thermo_

◆ otherThermo_

◆ Le_

◆ fromThermo_

◆ toThermo_

template<class Thermo, class OtherThermo>
class Foam::InterfaceCompositionModel< Thermo, OtherThermo >