Public Member Functions | Protected Attributes | List of all members
PurePhaseModel< BasePhaseModel, phaseThermo > 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, phaseThermo >:
[legend]
Collaboration diagram for PurePhaseModel< BasePhaseModel, phaseThermo >:
[legend]

Public Member Functions

 PurePhaseModel (const phaseSystem &fluid, const word &phaseName)
 
virtual ~PurePhaseModel ()=default
 Destructor. More...
 
virtual const PtrList< volScalarField > & Y () const
 Return the species mass fractions. More...
 
virtual PtrList< volScalarField > & Y ()
 Access the species mass fractions. More...
 
virtual void solveYi (PtrList< volScalarField::Internal > &, PtrList< volScalarField::Internal > &)
 Solve species fraction equation. More...
 
virtual const phaseThermo & thermo () const
 Access to const thermo. More...
 
virtual phaseThermo & thermo ()
 Access non-const thermo. More...
 
 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< fvScalarMatrix > YiEqn (volScalarField &Yi)
 Return the species fraction equation. More...
 
virtual const PtrList< volScalarField > & Y () const
 Return the species mass fractions. More...
 
virtual const volScalarField & Y (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< volScalarField > Y_
 Empty mass fraction field list. More...
 
autoPtr< phaseThermo > thermoPtr_
 Empty thermophysical model Ptr. More...
 

Detailed Description

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

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

Source files

Source files

Definition at line 56 of file PurePhaseModel.H.

Constructor & Destructor Documentation

◆ PurePhaseModel() [1/2]

PurePhaseModel ( const phaseSystem &  fluid,
const word &  phaseName 
)

Definition at line 36 of file PurePhaseModel.C.

References dictName(), fluid, and Foam::New().

Here is the call graph for this function:

◆ ~PurePhaseModel() [1/2]

~PurePhaseModel ( )
virtualdefault

Destructor.

Definition at line 48 of file PurePhaseModel.C.

◆ PurePhaseModel() [2/2]

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

Definition at line 35 of file PurePhaseModel.C.

◆ ~PurePhaseModel() [2/2]

virtual ~PurePhaseModel ( )
virtual

Destructor.

Member Function Documentation

◆ Y() [1/4]

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

Return the species mass fractions.

Definition at line 71 of file PurePhaseModel.C.

◆ Y() [2/4]

Foam::PtrList< Foam::volScalarField > & Y ( )
virtual

Access the species mass fractions.

Definition at line 79 of file PurePhaseModel.C.

◆ solveYi()

void solveYi ( PtrList< volScalarField::Internal > &  ,
PtrList< volScalarField::Internal > &   
)
virtual

Solve species fraction equation.

Definition at line 60 of file PurePhaseModel.C.

References NotImplemented.

◆ thermo() [1/2]

const phaseThermo & thermo ( ) const
virtual

Access to const thermo.

Definition at line 87 of file PurePhaseModel.C.

◆ thermo() [2/2]

phaseThermo & thermo ( )
virtual

Access non-const thermo.

Definition at line 94 of file PurePhaseModel.C.

◆ pure()

bool pure ( ) const
virtual

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

Definition at line 55 of file PurePhaseModel.C.

◆ YiEqn()

Foam::tmp< Foam::fvScalarMatrix > YiEqn ( volScalarField &  Yi)
virtual

Return the species fraction equation.

Definition at line 63 of file PurePhaseModel.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ Y() [3/4]

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

Return the species mass fractions.

◆ Y() [4/4]

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

Return a species mass fraction by name.

Definition at line 85 of file PurePhaseModel.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ YRef()

Foam::PtrList< Foam::volScalarField > & YRef ( )
virtual

Access the species mass fractions.

Definition at line 97 of file PurePhaseModel.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ YActive()

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

Return the active species mass fractions.

Definition at line 109 of file PurePhaseModel.C.

◆ YActiveRef()

Foam::UPtrList< Foam::volScalarField > & YActiveRef ( )
virtual

Access the active species mass fractions.

Definition at line 119 of file PurePhaseModel.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

Member Data Documentation

◆ Y_

PtrList< volScalarField > Y_
protected

Empty mass fraction field list.

Definition at line 65 of file PurePhaseModel.H.

◆ thermoPtr_

autoPtr<phaseThermo> thermoPtr_
protected

Empty thermophysical model Ptr.

Definition at line 68 of file PurePhaseModel.H.

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