Public Member Functions | Static Public Member Functions | Protected Attributes | 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]
Collaboration diagram for interfaceCompositionModel:
Collaboration 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...
 
virtual void update (const volScalarField &Tf)=0
 Update the composition. More...
 
const hashedWordListspecies () const
 Return the transferring species names. More...
 
bool transports (word &speciesName) const
 Returns whether the species is transported by the model and. More...
 
virtual tmp< volScalarFieldYf (const word &speciesName, const volScalarField &Tf) const =0
 Interface mass fraction. More...
 
virtual tmp< volScalarFieldYfPrime (const word &speciesName, const volScalarField &Tf) const =0
 The interface mass fraction derivative w.r.t. temperature. More...
 
virtual tmp< volScalarFielddY (const word &speciesName, const volScalarField &Tf) const =0
 Mass fraction difference between the interface and the field. More...
 
virtual tmp< volScalarFieldD (const word &speciesName) const =0
 Mass diffusivity. More...
 
virtual tmp< volScalarFieldL (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...
 

Static Public Member Functions

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

Protected Attributes

const phasePairpair_
 Phase pair. More...
 
const hashedWordList speciesNames_
 Names of the transferring species. 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.

Source files

Definition at line 56 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

◆ update()

virtual void update ( const volScalarField Tf)
pure virtual

◆ species()

const hashedWordList& species ( ) const

Return the transferring species names.

◆ transports()

bool transports ( word speciesName) const

Returns whether the species is transported by the model and.

provides the name of the diffused species

◆ Yf()

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

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

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

◆ D()

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

Mass diffusivity.

Implemented in InterfaceCompositionModel< Thermo, OtherThermo >.

◆ L()

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

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

Member Data Documentation

◆ pair_

const phasePair& pair_
protected

Phase pair.

Definition at line 63 of file interfaceCompositionModel.H.

◆ speciesNames_

const hashedWordList speciesNames_
protected

Names of the transferring species.

Definition at line 66 of file interfaceCompositionModel.H.


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