Generic base class for interface composition models. These models describe the composition in phase 1 of the supplied pair at the interface with phase 2. More...

Inheritance diagram for interfaceCompositionModel:

[legend]

Collaboration diagram for interfaceCompositionModel:

[legend]

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

Public Member Functions
	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 >	Yf (const word &speciesName, const volScalarField &Tf) const =0
	Interface mass fraction. More...

virtual tmp< volScalarField >	YfPrime (const word &speciesName, const volScalarField &Tf) const =0
	The interface mass fraction derivative w.r.t. temperature. More...

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

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

virtual tmp< volScalarField >	L (const word &speciesName, const volScalarField &Tf) const =0
	Latent heat. More...

virtual void	addMDotL (const volScalarField &K, const volScalarField &Tf, volScalarField &mDotL, volScalarField &mDotLPrime) const =0
	Add latent heat flow rate to total. 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 >	Yf (const word &speciesName, const volScalarField &Tf) const =0
	Interface mass fraction. More...

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

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

virtual tmp< volScalarField >	L (const word &speciesName, const volScalarField &Tf) const =0
	Latent heat (delta Hc) More...

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

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

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

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

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

Public Attributes
modelVariable	modelVariable_
	Enumeration for model variables. More...

Static Public Attributes
static const Enum< modelVariable >	modelVariableNames

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

Detailed Description

Generic base class for interface composition models. These models describe the composition in phase 1 of the supplied pair at the interface with phase 2.

Generic base class for interface models. Mass transer models are interface models between two thermos. Abstract class for mass transfer functions.

Source files

Definition at line 58 of file interfaceCompositionModel.H.

Member Enumeration Documentation

◆ modelVariable

enum modelVariable

Enumeration for variable based mass transfer models.

Enumerator
T
P
Y

Definition at line 65 of file interfaceCompositionModel.H.

Constructor & Destructor Documentation

◆ interfaceCompositionModel() [1/2]

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

Construct from a dictionary and a phase pair.

Definition at line 44 of file interfaceCompositionModel.C.

◆ ~interfaceCompositionModel() [1/2]

virtual ~interfaceCompositionModel ( )

virtualdefault

Destructor.

◆ interfaceCompositionModel() [2/2]

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

Construct from a dictionary and a phase pair.

◆ ~interfaceCompositionModel() [2/2]

virtual ~interfaceCompositionModel ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName() [1/2]

TypeName ( "interfaceCompositionModel" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

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

◆ New() [1/2]

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

static

Definition at line 37 of file newInterfaceCompositionModel.C.

References Foam::abort(), dict, Foam::endl(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, phasePair::phase1(), phasePair::phase2(), and phaseModel::thermo().

Here is the call graph for this function:

◆ update()

virtual void update ( const volScalarField & Tf )

pure virtual

Update the composition.

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

◆ species()

const Foam::hashedWordList & species ( ) const

Return the transferring species names.

Definition at line 56 of file interfaceCompositionModel.C.

References interfaceCompositionModel::speciesNames_.

Referenced by InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::dmdts(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::InterfaceCompositionPhaseChangePhaseSystem(), and InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer().

Here is the caller graph for this function:

◆ transports()

bool transports ( word & speciesName ) const

Returns whether the species is transported by the model and provides the name of the diffused species

Definition at line 62 of file interfaceCompositionModel.C.

◆ Yf() [1/2]

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

pure virtual

Interface mass fraction.

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

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

Here is the caller graph for this function:

◆ YfPrime()

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

pure virtual

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

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

◆ dY() [1/2]

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

◆ D() [1/2]

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

pure virtual

Mass diffusivity.

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

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

Here is the caller graph for this function:

◆ L() [1/2]

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

pure virtual

Latent heat.

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

◆ addMDotL()

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

pure virtual

Add latent heat flow rate to total.

Implemented in InterfaceCompositionModel< Thermo, OtherThermo >.

◆ TypeName() [2/2]

TypeName ( "interfaceCompositionModel" )

Runtime type information.

◆ declareRunTimeSelectionTable() [2/2]

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

◆ New() [2/2]

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

static

◆ transferSpecie()

const word transferSpecie ( ) const

Return the transferring species name.

◆ pair()

const phasePair& pair ( ) const

Return pair.

◆ Yf() [2/2]

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

pure virtual

Interface mass fraction.

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

◆ dY() [2/2]

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

◆ D() [2/2]

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

pure virtual

Mass diffusivity.

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

◆ L() [2/2]

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	(	label	modelVariable,
		const volScalarField &	field
	)

pure virtual

Explicit mass transfer coefficient.

Implemented in kineticGasEvaporation< Thermo, OtherThermo >, and Lee< Thermo, OtherThermo >.

◆ Tactivate()

virtual const dimensionedScalar& Tactivate ( ) const

pure virtual

Reference value.

Implemented in kineticGasEvaporation< Thermo, OtherThermo >, and Lee< Thermo, OtherThermo >.

◆ variable()

const word variable ( ) const

Returns the variable on which the model is based.

Member Data Documentation

◆ pair_

const phasePair & pair_

protected

Phase pair.

Definition at line 65 of file interfaceCompositionModel.H.

◆ speciesNames_

const hashedWordList speciesNames_

protected

Names of the transferring species.

Definition at line 68 of file interfaceCompositionModel.H.

Referenced by interfaceCompositionModel::species().

◆ modelVariableNames

const Enum<modelVariable> modelVariableNames

static

Definition at line 72 of file interfaceCompositionModel.H.

◆ modelVariable_

modelVariable modelVariable_

Enumeration for model variables.

Definition at line 75 of file interfaceCompositionModel.H.

◆ speciesName_

word speciesName_

protected

Names of the transferring specie.

Definition at line 86 of file interfaceCompositionModel.H.

◆ mesh_

const fvMesh& mesh_

protected

Reference to mesh.

Definition at line 89 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
src/phaseSystemModels/reactingEulerFoam/interfacialCompositionModels/interfaceCompositionModels/interfaceCompositionModel/newInterfaceCompositionModel.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ modelVariable

Constructor & Destructor Documentation

◆ interfaceCompositionModel() [1/2]

◆ ~interfaceCompositionModel() [1/2]

◆ interfaceCompositionModel() [2/2]

◆ ~interfaceCompositionModel() [2/2]

Member Function Documentation

◆ TypeName() [1/2]

◆ declareRunTimeSelectionTable() [1/2]

◆ New() [1/2]

◆ update()

◆ species()

◆ transports()

◆ Yf() [1/2]

◆ YfPrime()

◆ dY() [1/2]

◆ D() [1/2]

◆ L() [1/2]

◆ addMDotL()

◆ TypeName() [2/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ New() [2/2]

◆ transferSpecie()

◆ pair()

◆ Yf() [2/2]

◆ dY() [2/2]

◆ D() [2/2]

◆ L() [2/2]

◆ Kexp()

◆ Tactivate()

◆ variable()

Member Data Documentation

◆ pair_

◆ speciesNames_

◆ modelVariableNames

◆ modelVariable_

◆ speciesName_

◆ mesh_