interfaceCompositionModel Class Referenceabstract
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. 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...
 
const multiphaseInterSystemfluid () const
 Return the multiphaseInterSystem this interface belongs to. More...
 
virtual tmp< volScalarFieldYf (const word &speciesName, const volScalarField &Tf) const =0
 Interface mass fraction. More...
 
virtual tmp< volScalarFielddY (const word &speciesName, const volScalarField &Tf) const =0
 Mass fraction difference between the interface and the field. More...
 
virtual tmp< volScalarFieldDfrom (const word &speciesName) const =0
 Specie mass diffusivity for pure mixture. More...
 
virtual tmp< volScalarFieldDto (const word &speciesName) const =0
 Specie mass diffusivity for specie in a multicomponent. More...
 
virtual tmp< volScalarFieldL (const word &speciesName, const volScalarField &Tf) const =0
 Latent heat (delta Hc) 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...
 

Static Public Member Functions

static autoPtr< interfaceCompositionModelNew (const dictionary &dict, const phasePair &pair)
 

Protected Attributes

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

Static Protected Attributes

static const Enum< modelVariablemodelVariableNames_
 Selection names for the modelVariable. More...
 

Detailed Description

Definition at line 65 of file interfaceCompositionModel.H.

Member Enumeration Documentation

◆ modelVariable

Enumeration for variable based mass transfer models.

Enumerator
alpha 

Definition at line 72 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 58 of file interfaceCompositionModel.C.

◆ ~interfaceCompositionModel()

virtual ~interfaceCompositionModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "interfaceCompositionModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

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

Definition at line 83 of file interfaceCompositionModel.C.

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

Here is the call graph for this function:

◆ transferSpecie()

const Foam::word transferSpecie ( ) const

Return the transferring species name.

Definition at line 121 of file interfaceCompositionModel.C.

Referenced by kineticGasEvaporation< Thermo, OtherThermo >::kineticGasEvaporation().

Here is the caller graph for this function:

◆ pair()

const Foam::phasePair & pair ( ) const

The phase pair.

Definition at line 128 of file interfaceCompositionModel.C.

Referenced by NonRandomTwoLiquid< Thermo, OtherThermo >::NonRandomTwoLiquid(), and Raoult< Thermo, OtherThermo >::Raoult().

Here is the caller graph for this function:

◆ fluid()

const Foam::multiphaseInterSystem & fluid ( ) const

Return the multiphaseInterSystem this interface belongs to.

Definition at line 135 of file interfaceCompositionModel.C.

◆ Yf()

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

Interface mass fraction.

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

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

◆ Kexp()

◆ KSp()

◆ KSu()

◆ Tactivate()

◆ 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 149 of file interfaceCompositionModel.C.

◆ includeVolChange()

bool includeVolChange ( )

Add volume change in pEq.

Definition at line 156 of file interfaceCompositionModel.C.

◆ variable()

const Foam::word & variable ( ) const

Returns the variable on which the model is based.

Definition at line 142 of file interfaceCompositionModel.C.

Member Data Documentation

◆ modelVariableNames_

◆ modelVariable_

modelVariable modelVariable_
protected

Enumeration for the model variable.

Definition at line 88 of file interfaceCompositionModel.H.

◆ includeVolChange_

bool includeVolChange_
protected

Add volume change in pEq.

Definition at line 91 of file interfaceCompositionModel.H.

◆ pair_

const phasePair& pair_
protected

Phase pair.

Definition at line 94 of file interfaceCompositionModel.H.

◆ speciesName_

word speciesName_
protected

Names of the transferring specie.

Definition at line 97 of file interfaceCompositionModel.H.

◆ mesh_

const fvMesh& mesh_
protected

Reference to mesh.

Definition at line 100 of file interfaceCompositionModel.H.


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