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]

Public Member Functions
	TypeName ("interfaceCompositionModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, interfaceCompositionModel, dictionary,(const dictionary &dict, const phaseInterface &interface),(dict, interface))

	interfaceCompositionModel (const dictionary &dict, const phaseInterface &interface)
	Construct from a dictionary and an interface. More...

virtual	~interfaceCompositionModel ()
	Destructor. More...

const sidedPhaseInterface &	interface () const
	Return the interface. More...

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

const rhoMulticomponentThermo &	thermo () const
	Return the thermo. More...

const basicSpecieMixture &	composition () const
	Return the composition. More...

const rhoThermo &	otherThermo () const
	Return the other thermo. More...

bool	otherHasComposition () const
	Return whether the other side has a multi-specie composition. More...

const basicSpecieMixture &	otherComposition () const
	Return the other composition. More...

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

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

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

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

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

Static Public Member Functions
static autoPtr< interfaceCompositionModel >	New (const dictionary &dict, const phaseInterface &interface, const bool outer=true)

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.

Source files

Definition at line 56 of file interfaceCompositionModel.H.

Constructor & Destructor Documentation

◆ interfaceCompositionModel()

interfaceCompositionModel	(	const dictionary &	dict,
		const phaseInterface &	interface
	)

Construct from a dictionary and an interface.

Definition at line 43 of file interfaceCompositionModel.C.

◆ ~interfaceCompositionModel()

~interfaceCompositionModel ( )

virtual

Destructor.

Definition at line 65 of file interfaceCompositionModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "interfaceCompositionModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		interfaceCompositionModel	,
		dictionary	,
		(const dictionary &dict, const phaseInterface &interface)	,
		(dict, interface)
	)

◆ New()

Foam::autoPtr< Foam::interfaceCompositionModel > New	(	const dictionary &	dict,
		const phaseInterface &	interface,
		const bool	outer = `true`
	)

static

Definition at line 32 of file interfaceCompositionModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, phaseInterface::fluid(), Foam::Info, interfaceCompositionModel::interface(), dictionary::lookup(), phaseSystem::modelSubDict(), sidedPhaseInterface::name(), and Foam::outer().

Referenced by nonRandomTwoLiquid::nonRandomTwoLiquid(), and Raoult::Raoult().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interface()

const Foam::sidedPhaseInterface & interface ( ) const

inline

Return the interface.

Definition at line 31 of file interfaceCompositionModelI.H.

Referenced by interfaceCompositionModel::New(), nonRandomTwoLiquid::nonRandomTwoLiquid(), and Raoult::Raoult().

Here is the caller graph for this function:

◆ species()

const Foam::hashedWordList & species ( ) const

inline

Return the transferring species names.

Definition at line 37 of file interfaceCompositionModelI.H.

Referenced by InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correct(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), Henry::Henry(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::InterfaceCompositionPhaseChangePhaseSystem(), nonRandomTwoLiquid::nonRandomTwoLiquid(), Raoult::Raoult(), saturated::saturated(), and InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::specieTransfer().

Here is the caller graph for this function:

◆ thermo()

const Foam::rhoMulticomponentThermo & thermo ( ) const

inline

Return the thermo.

Definition at line 44 of file interfaceCompositionModelI.H.

Referenced by saturated::wRatioByP().

Here is the caller graph for this function:

◆ composition()

const Foam::basicSpecieMixture & composition ( ) const

inline

Return the composition.

Definition at line 51 of file interfaceCompositionModelI.H.

Referenced by nonRandomTwoLiquid::nonRandomTwoLiquid(), and saturated::wRatioByP().

Here is the caller graph for this function:

◆ otherThermo()

const Foam::rhoThermo & otherThermo ( ) const

inline

Return the other thermo.

Definition at line 57 of file interfaceCompositionModelI.H.

◆ otherHasComposition()

bool otherHasComposition ( ) const

inline

Return whether the other side has a multi-specie composition.

Definition at line 63 of file interfaceCompositionModelI.H.

◆ otherComposition()

const Foam::basicSpecieMixture & otherComposition ( ) const

inline

Return the other composition.

Definition at line 70 of file interfaceCompositionModelI.H.

◆ Yf()

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

pure virtual

Interface mass fraction.

Implemented in saturated, Raoult, nonRandomTwoLiquid, and Henry.

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

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 saturated, Raoult, nonRandomTwoLiquid, and Henry.

◆ dY()

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

Mass fraction difference between the interface and the field.

Definition at line 71 of file interfaceCompositionModel.C.

References composition, basicSpecieMixture::species(), and basicSpecieMixture::Y().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dYfPrime()

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

Mass fraction difference between the interface and the field.

derivative w.r.t. temperature

Definition at line 83 of file interfaceCompositionModel.C.

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

Here is the caller graph for this function:

◆ D()

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

Mass diffusivity.

Definition at line 93 of file interfaceCompositionModel.C.

References composition, Cp(), IOobject::groupName(), Foam::constant::electromagnetic::kappa, GeometricField< Type, PatchField, GeoMesh >::New(), p, rho, basicSpecieMixture::species(), and Foam::T().

Referenced by InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correct(), and InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

virtual void update ( const volScalarField & Tf )

pure virtual

Update the composition.

Implemented in saturated, Raoult, nonRandomTwoLiquid, and Henry.

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

Here is the caller graph for this function:

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

applications/modules/multiphaseEuler/interfacialCompositionModels/interfaceCompositionModels/interfaceCompositionModel/interfaceCompositionModel.H
applications/modules/multiphaseEuler/interfacialCompositionModels/interfaceCompositionModels/interfaceCompositionModel/interfaceCompositionModel.C
applications/modules/multiphaseEuler/interfacialCompositionModels/interfaceCompositionModels/interfaceCompositionModel/interfaceCompositionModelI.H
applications/modules/multiphaseEuler/interfacialCompositionModels/interfaceCompositionModels/interfaceCompositionModel/interfaceCompositionModelNew.C

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ interfaceCompositionModel()

◆ ~interfaceCompositionModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ interface()

◆ species()

◆ thermo()

◆ composition()

◆ otherThermo()

◆ otherHasComposition()

◆ otherComposition()

◆ Yf()

◆ YfPrime()

◆ dY()

◆ dYfPrime()

◆ D()

◆ update()