#include <interfaceCompositionModel.H>

Inheritance diagram for interfaceCompositionModel:

[legend]

Collaboration diagram for interfaceCompositionModel:

[legend]

Public Types
enum	modelVariable { T , P , Y , alpha }
	Enumeration for variable based mass transfer models. More...

Public Member Functions
	TypeName ("interfaceCompositionModel")
	Runtime type information.
	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.
virtual	~interfaceCompositionModel ()=default
	Destructor.
const word	transferSpecie () const
	Return the transferring species name.
const phasePair &	pair () const
	The phase pair.
const multiphaseInterSystem &	fluid () const
	Return the multiphaseInterSystem this interface belongs to.
virtual tmp< volScalarField >	Yf (const word &speciesName, const volScalarField &Tf) const =0
	Interface mass fraction.
virtual tmp< volScalarField >	dY (const word &speciesName, const volScalarField &Tf) const =0
	Mass fraction difference between the interface and the field.
virtual tmp< volScalarField >	Dfrom (const word &speciesName) const =0
	Specie mass diffusivity for pure mixture.
virtual tmp< volScalarField >	Dto (const word &speciesName) const =0
	Specie mass diffusivity for specie in a multicomponent.
virtual tmp< volScalarField >	L (const word &speciesName, const volScalarField &Tf) const =0
	Latent heat (delta Hc).
virtual tmp< volScalarField >	Kexp (const volScalarField &field)=0
	Explicit full mass transfer.
virtual tmp< volScalarField >	KSp (label modelVariable, const volScalarField &field)=0
	Implicit mass transfer.
virtual tmp< volScalarField >	KSu (label modelVariable, const volScalarField &field)=0
	Explicit mass transfer.
virtual const dimensionedScalar &	Tactivate () const noexcept=0
	Reference value.
virtual bool	includeDivU () const noexcept
	Add/subtract alpha*div(U) as a source term for alpha, substituting div(U) = mDot(1/rho1 - 1/rho2).
bool	includeVolChange ()
	Add volume change in pEq.
const word &	variable () const
	Returns the variable on which the model is based.

Static Public Member Functions
static autoPtr< interfaceCompositionModel >	New (const dictionary &dict, const phasePair &pair)

Protected Attributes
modelVariable	modelVariable_
	Enumeration for the model variable.
bool	includeVolChange_
	Add volume change in pEq.
const phasePair &	pair_
	Phase pair.
word	speciesName_
	Names of the transferring specie.
const fvMesh &	mesh_
	Reference to mesh.

Static Protected Attributes
static const Enum< modelVariable >	modelVariableNames_
	Selection names for the modelVariable.

Detailed Description

Definition at line 61 of file interfaceCompositionModel.H.

Member Enumeration Documentation

◆ modelVariable

enum modelVariable

Enumeration for variable based mass transfer models.

Enumerator
T
P
Y
alpha

Definition at line 70 of file interfaceCompositionModel.H.

Constructor & Destructor Documentation

◆ interfaceCompositionModel()

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

Construct from a dictionary and a phase pair.

Definition at line 51 of file interfaceCompositionModel.C.

References dict, includeVolChange_, mesh, mesh_, modelVariable_, modelVariableNames_, pair(), pair_, speciesName_, and T.

Referenced by declareRunTimeSelectionTable(), and InterfaceCompositionModel< Thermo, OtherThermo >::InterfaceCompositionModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~interfaceCompositionModel()

virtual ~interfaceCompositionModel ( )

virtualdefault

Destructor.

References dict, and pair().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "interfaceCompositionModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		interfaceCompositionModel	,
		dictionary	,
		(const dictionary &dict, const phasePair &pair)	,
		(dict, pair)	)

References dict, interfaceCompositionModel(), and pair().

Here is the call graph for this function:

◆ New()

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

static

Definition at line 76 of file interfaceCompositionModel.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and pair().

Referenced by diffusionGasEvaporation< Thermo, OtherThermo >::diffusionGasEvaporation(), and Saturated< Thermo, OtherThermo >::Saturated().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transferSpecie()

const Foam::word transferSpecie ( ) const

Return the transferring species name.

Definition at line 114 of file interfaceCompositionModel.C.

References speciesName_.

Referenced by diffusionGasEvaporation< Thermo, OtherThermo >::Kexp(), interfaceHeatResistance< Thermo, OtherThermo >::Kexp(), kineticGasEvaporation< Thermo, OtherThermo >::Kexp(), and kineticGasEvaporation< Thermo, OtherThermo >::kineticGasEvaporation().

Here is the caller graph for this function:

◆ pair()

const Foam::phasePair & pair ( ) const

The phase pair.

Definition at line 121 of file interfaceCompositionModel.C.

References pair_.

Here is the caller graph for this function:

◆ fluid()

const Foam::multiphaseInterSystem & fluid ( ) const

Return the multiphaseInterSystem this interface belongs to.

Definition at line 128 of file interfaceCompositionModel.C.

References pair().

Referenced by diffusionGasEvaporation< Thermo, OtherThermo >::Kexp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Yf()

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

pure virtual

Interface mass fraction.

Referenced by InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer().

Here is the caller graph for this function:

◆ dY()

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

pure virtual

Mass fraction difference between the interface and the field.

Implemented in InterfaceCompositionModel< Thermo, OtherThermo >, and InterfaceCompositionModel< Thermo, OtherThermo >.

◆ Dfrom()

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

pure virtual

Specie mass diffusivity for pure mixture.

Implemented in InterfaceCompositionModel< Thermo, OtherThermo >.

◆ Dto()

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

pure virtual

Specie mass diffusivity for specie in a multicomponent.

Implemented in InterfaceCompositionModel< Thermo, OtherThermo >.

◆ L()

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

pure virtual

Latent heat (delta Hc).

Implemented in InterfaceCompositionModel< Thermo, OtherThermo >, and InterfaceCompositionModel< Thermo, OtherThermo >.

◆ Kexp()

virtual tmp< volScalarField > Kexp ( const volScalarField & field )

pure virtual

Explicit full mass transfer.

Implemented in diffusionGasEvaporation< Thermo, OtherThermo >, interfaceHeatResistance< Thermo, OtherThermo >, interfaceOxideRate< Thermo, OtherThermo >, kineticGasEvaporation< Thermo, OtherThermo >, and Lee< Thermo, OtherThermo >.

References field().

Here is the call graph for this function:

◆ KSp()

virtual tmp< volScalarField > KSp	(	label	modelVariable,
		const volScalarField &	field )

pure virtual

Implicit mass transfer.

Implemented in diffusionGasEvaporation< Thermo, OtherThermo >, interfaceHeatResistance< Thermo, OtherThermo >, interfaceOxideRate< Thermo, OtherThermo >, kineticGasEvaporation< Thermo, OtherThermo >, and Lee< Thermo, OtherThermo >.

References field().

Here is the call graph for this function:

◆ KSu()

virtual tmp< volScalarField > KSu	(	label	modelVariable,
		const volScalarField &	field )

pure virtual

Explicit mass transfer.

Implemented in diffusionGasEvaporation< Thermo, OtherThermo >, interfaceHeatResistance< Thermo, OtherThermo >, interfaceOxideRate< Thermo, OtherThermo >, kineticGasEvaporation< Thermo, OtherThermo >, and Lee< Thermo, OtherThermo >.

References field().

Here is the call graph for this function:

◆ Tactivate()

virtual const dimensionedScalar & Tactivate ( ) const

pure virtualnoexcept

Reference value.

Implemented in diffusionGasEvaporation< Thermo, OtherThermo >, interfaceHeatResistance< Thermo, OtherThermo >, interfaceOxideRate< Thermo, OtherThermo >, kineticGasEvaporation< Thermo, OtherThermo >, and Lee< Thermo, OtherThermo >.

References includeDivU(), includeVolChange(), Foam::noexcept, and variable().

Here is the call graph for this function:

◆ includeDivU()

bool includeDivU ( ) const

virtualnoexcept

Add/subtract alpha*div(U) as a source term for alpha, substituting div(U) = mDot(1/rho1 - 1/rho2).

Reimplemented in diffusionGasEvaporation< Thermo, OtherThermo >, interfaceHeatResistance< Thermo, OtherThermo >, interfaceOxideRate< Thermo, OtherThermo >, kineticGasEvaporation< Thermo, OtherThermo >, and Lee< Thermo, OtherThermo >.

Definition at line 142 of file interfaceCompositionModel.C.

References Foam::noexcept.

Referenced by Tactivate().

Here is the caller graph for this function:

◆ includeVolChange()

bool includeVolChange ( )

Add volume change in pEq.

Definition at line 149 of file interfaceCompositionModel.C.

References includeVolChange_.

Referenced by Tactivate().

Here is the caller graph for this function:

◆ variable()

const Foam::word & variable ( ) const

Returns the variable on which the model is based.

Definition at line 135 of file interfaceCompositionModel.C.

References modelVariable_, and modelVariableNames_.

Here is the caller graph for this function:

Member Data Documentation

◆ modelVariableNames_

const Foam::Enum< Foam::multiphaseInter::interfaceCompositionModel::modelVariable > modelVariableNames_

staticprotected

Initial value:

{
    { modelVariable::T, "temperature" },
    { modelVariable::P, "pressure" },
    { modelVariable::Y, "massFraction" },
    { modelVariable::alpha, "alphaVolumeFraction" },
}

Selection names for the modelVariable.

Definition at line 40 of file interfaceCompositionModel.H.

Referenced by interfaceCompositionModel(), and variable().

◆ modelVariable_

modelVariable modelVariable_

protected

Enumeration for the model variable.

Definition at line 90 of file interfaceCompositionModel.H.

Referenced by interfaceCompositionModel(), interfaceHeatResistance< Thermo, OtherThermo >::KSp(), kineticGasEvaporation< Thermo, OtherThermo >::KSp(), Lee< Thermo, OtherThermo >::KSp(), interfaceHeatResistance< Thermo, OtherThermo >::KSu(), kineticGasEvaporation< Thermo, OtherThermo >::KSu(), Lee< Thermo, OtherThermo >::KSu(), and variable().

◆ includeVolChange_

bool includeVolChange_

protected

Add volume change in pEq.

Definition at line 95 of file interfaceCompositionModel.H.

Referenced by includeVolChange(), and interfaceCompositionModel().

◆ pair_

const phasePair& pair_

protected

Phase pair.

Definition at line 100 of file interfaceCompositionModel.H.

Referenced by InterfaceCompositionModel< Thermo, OtherThermo >::D(), InterfaceCompositionModel< Thermo, OtherThermo >::Dfrom(), InterfaceCompositionModel< Thermo, OtherThermo >::Dto(), interfaceCompositionModel(), InterfaceCompositionModel< Thermo, OtherThermo >::L(), pair(), and Henry< Thermo, OtherThermo >::YfPrime().

◆ speciesName_

word speciesName_

protected

Names of the transferring specie.

Definition at line 105 of file interfaceCompositionModel.H.

Referenced by interfaceCompositionModel(), and transferSpecie().

◆ mesh_

const fvMesh& mesh_

protected

Reference to mesh.

Definition at line 110 of file interfaceCompositionModel.H.

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

src/phaseSystemModels/multiphaseInter/phasesSystem/interfaceCompositionModel/interfaceCompositionModel.H
src/phaseSystemModels/multiphaseInter/phasesSystem/interfaceCompositionModel/interfaceCompositionModel.C
src/phaseSystemModels/reactingEuler/multiphaseSystem/interfacialCompositionModels/interfaceCompositionModels/interfaceCompositionModel/interfaceCompositionModel.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ modelVariable

Constructor & Destructor Documentation

◆ interfaceCompositionModel()

◆ ~interfaceCompositionModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ transferSpecie()

◆ pair()

◆ fluid()

◆ Yf()

◆ dY()

◆ Dfrom()

◆ Dto()

◆ L()

◆ Kexp()

◆ KSp()

◆ KSu()

◆ Tactivate()

◆ includeDivU()

◆ includeVolChange()

◆ variable()

Member Data Documentation

◆ modelVariableNames_

◆ modelVariable_

◆ includeVolChange_

◆ pair_

◆ speciesName_

◆ mesh_