Public Member Functions | Static Public Member Functions | List of all members
interfaceCompositionModel Class Referenceabstract

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:
Inheritance graph
[legend]

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 ()
 Destructor. More...
 
const phasePair & pair () const
 Return the phase pair. More...
 
const hashedWordList & species () const
 Return the transferring species names. More...
 
const rhoReactionThermo & 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 phasePair &pair)
 

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 57 of file interfaceCompositionModel.H.

Constructor & Destructor Documentation

◆ interfaceCompositionModel()

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

Construct from a dictionary and a phase pair.

◆ ~interfaceCompositionModel()

virtual ~interfaceCompositionModel ( )
virtual

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "interfaceCompositionModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

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

◆ pair()

const Foam::phasePair & pair ( ) const
inline

Return the phase pair.

Definition at line 28 of file interfaceCompositionModelI.H.

◆ species()

const Foam::hashedWordList & species ( ) const
inline

Return the transferring species names.

Definition at line 34 of file interfaceCompositionModelI.H.

◆ thermo()

const Foam::rhoReactionThermo & thermo ( ) const
inline

Return the thermo.

Definition at line 41 of file interfaceCompositionModelI.H.

◆ composition()

const Foam::basicSpecieMixture & composition ( ) const
inline

Return the composition.

Definition at line 48 of file interfaceCompositionModelI.H.

References fluidReactionThermo::composition().

Referenced by interfaceCompositionModel::otherComposition().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ otherThermo()

const Foam::rhoThermo & otherThermo ( ) const
inline

Return the other thermo.

Definition at line 54 of file interfaceCompositionModelI.H.

◆ otherHasComposition()

bool otherHasComposition ( ) const
inline

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

Definition at line 60 of file interfaceCompositionModelI.H.

◆ otherComposition()

const Foam::basicSpecieMixture & otherComposition ( ) const
inline

Return the other composition.

Definition at line 67 of file interfaceCompositionModelI.H.

References interfaceCompositionModel::composition().

Here is the call graph for this function:

◆ Yf()

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

Interface mass fraction.

Implemented in nonRandomTwoLiquid, saturated, Henry, and Raoult.

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

◆ dY()

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

Mass fraction difference between the interface and the field.

◆ dYfPrime()

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

Mass fraction difference between the interface and the field.

derivative w.r.t. temperature

◆ D()

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

Mass diffusivity.

◆ update()

virtual void update ( const volScalarField &  Tf)
pure virtual

Update the composition.

Implemented in nonRandomTwoLiquid, saturated, Henry, and Raoult.

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