Public Member Functions | Protected Attributes | List of all members
PurePhaseModel< BasePhaseModel > Class Template Reference

Class which represents pure phases, i.e. without any species. Returns an empty list of mass fractions. More...

Inheritance diagram for PurePhaseModel< BasePhaseModel >:
Inheritance graph
[legend]
Collaboration diagram for PurePhaseModel< BasePhaseModel >:
Collaboration graph
[legend]

Public Member Functions

 PurePhaseModel (const phaseSystem &fluid, const word &phaseName, const label index)
 
virtual ~PurePhaseModel ()
 Destructor. More...
 
virtual bool pure () const
 Return whether the phase is pure (i.e., not multi-component) More...
 
virtual tmp< fvScalarMatrixYiEqn (volScalarField &Yi)
 Return the species fraction equation. More...
 
virtual const PtrList< volScalarField > & Y () const
 Return the species mass fractions. More...
 
virtual const volScalarFieldY (const word &name) const
 Return a species mass fraction by name. More...
 
virtual PtrList< volScalarField > & YRef ()
 Access the species mass fractions. More...
 
virtual const UPtrList< volScalarField > & YActive () const
 Return the active species mass fractions. More...
 
virtual UPtrList< volScalarField > & YActiveRef ()
 Access the active species mass fractions. More...
 

Protected Attributes

PtrList< volScalarFieldY_
 Empty mass fraction field list. More...
 

Detailed Description

template<class BasePhaseModel>
class Foam::PurePhaseModel< BasePhaseModel >

Class which represents pure phases, i.e. without any species. Returns an empty list of mass fractions.

Source files

Definition at line 50 of file PurePhaseModel.H.

Constructor & Destructor Documentation

◆ PurePhaseModel()

PurePhaseModel ( const phaseSystem fluid,
const word phaseName,
const label  index 
)

◆ ~PurePhaseModel()

virtual ~PurePhaseModel ( )
virtual

Destructor.

Member Function Documentation

◆ pure()

virtual bool pure ( ) const
virtual

Return whether the phase is pure (i.e., not multi-component)

◆ YiEqn()

virtual tmp<fvScalarMatrix> YiEqn ( volScalarField Yi)
virtual

Return the species fraction equation.

◆ Y() [1/2]

virtual const PtrList<volScalarField>& Y ( ) const
virtual

Return the species mass fractions.

◆ Y() [2/2]

virtual const volScalarField& Y ( const word name) const
virtual

Return a species mass fraction by name.

◆ YRef()

virtual PtrList<volScalarField>& YRef ( )
virtual

Access the species mass fractions.

◆ YActive()

virtual const UPtrList<volScalarField>& YActive ( ) const
virtual

Return the active species mass fractions.

◆ YActiveRef()

virtual UPtrList<volScalarField>& YActiveRef ( )
virtual

Access the active species mass fractions.

Member Data Documentation

◆ Y_

PtrList<volScalarField> Y_
protected

Empty mass fraction field list.

Definition at line 59 of file PurePhaseModel.H.


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