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

#include <PurePhaseModel.H>

Inheritance diagram for PurePhaseModel< BasePhaseModel, phaseThermo >:

[legend]

Collaboration diagram for PurePhaseModel< BasePhaseModel, phaseThermo >:

[legend]

Public Member Functions
	PurePhaseModel (const multiphaseInterSystem &fluid, const word &phaseName)
virtual	~PurePhaseModel ()=default
	Destructor.
virtual const PtrList< volScalarField > &	Y () const
	Return the species mass fractions.
virtual PtrList< volScalarField > &	Y ()
	Access the species mass fractions.
virtual void	solveYi (PtrList< volScalarField::Internal > &, PtrList< volScalarField::Internal > &)
	Solve species fraction equation.
virtual const phaseThermo &	thermo () const
	Access to const thermo.
virtual phaseThermo &	thermo ()
	Access non-const thermo.
	PurePhaseModel (const phaseSystem &fluid, const word &phaseName, const label index)
virtual	~PurePhaseModel ()
	Destructor.
virtual bool	pure () const
	Return whether the phase is pure (i.e., not multi-component).
virtual tmp< fvScalarMatrix >	YiEqn (volScalarField &Yi)
	Return the species fraction equation.
virtual const PtrList< volScalarField > &	Y () const
	Return the species mass fractions.
virtual const volScalarField &	Y (const word &name) const
	Return a species mass fraction by name.
virtual PtrList< volScalarField > &	YRef ()
	Access the species mass fractions.
virtual const UPtrList< volScalarField > &	YActive () const
	Return the active species mass fractions.
virtual UPtrList< volScalarField > &	YActiveRef ()
	Access the active species mass fractions.

Protected Attributes
PtrList< volScalarField >	Y_
	Empty mass fraction field list.
autoPtr< phaseThermo >	thermoPtr_
	Empty thermophysical model Ptr.

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

Definition at line 52 of file PurePhaseModel.H.

Constructor & Destructor Documentation

◆ PurePhaseModel() [1/2]

template<class BasePhaseModel, class phaseThermo>

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

Definition at line 28 of file PurePhaseModel.C.

References basicThermo::dictName, fluid, basicThermo::phasePropertyName(), and thermoPtr_.

Here is the call graph for this function:

◆ ~PurePhaseModel() [1/2]

template<class BasePhaseModel>

~PurePhaseModel ( )

virtualdefault

Destructor.

Definition at line 41 of file PurePhaseModel.C.

◆ PurePhaseModel() [2/2]

template<class BasePhaseModel>

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

Definition at line 27 of file PurePhaseModel.C.

References fluid.

◆ ~PurePhaseModel() [2/2]

template<class BasePhaseModel, class phaseThermo>

virtual ~PurePhaseModel ( )

virtual

Destructor.

Member Function Documentation

◆ Y() [1/4]

template<class BasePhaseModel>

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

virtual

Return the species mass fractions.

Definition at line 64 of file PurePhaseModel.C.

References Y_.

◆ Y() [2/4]

template<class BasePhaseModel, class phaseThermo>

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

virtual

Access the species mass fractions.

Definition at line 72 of file PurePhaseModel.C.

References Y_.

◆ solveYi()

template<class BasePhaseModel, class phaseThermo>

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

virtual

Solve species fraction equation.

Definition at line 52 of file PurePhaseModel.C.

References NotImplemented.

◆ thermo() [1/2]

template<class BasePhaseModel, class phaseThermo>

const phaseThermo & thermo ( ) const

virtual

Access to const thermo.

Definition at line 79 of file PurePhaseModel.C.

References thermoPtr_.

◆ thermo() [2/2]

template<class BasePhaseModel, class phaseThermo>

phaseThermo & thermo ( )

virtual

Access non-const thermo.

Definition at line 87 of file PurePhaseModel.C.

References thermoPtr_.

◆ pure()

template<class BasePhaseModel>

bool pure ( ) const

virtual

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

Definition at line 48 of file PurePhaseModel.C.

◆ YiEqn()

template<class BasePhaseModel>

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

virtual

Return the species fraction equation.

Definition at line 56 of file PurePhaseModel.C.

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

Here is the call graph for this function:

◆ Y() [3/4]

template<class BasePhaseModel, class phaseThermo>

virtual const PtrList< volScalarField > & Y ( ) const

virtual

Return the species mass fractions.

References Foam::name().

Here is the call graph for this function:

◆ Y() [4/4]

template<class BasePhaseModel>

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

virtual

Return a species mass fraction by name.

Definition at line 78 of file PurePhaseModel.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::name(), and GeometricField< scalar, fvPatchField, volMesh >::null().

Here is the call graph for this function:

◆ YRef()

template<class BasePhaseModel>

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

virtual

Access the species mass fractions.

Definition at line 90 of file PurePhaseModel.C.

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

Here is the call graph for this function:

◆ YActive()

template<class BasePhaseModel>

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

virtual

Return the active species mass fractions.

Definition at line 102 of file PurePhaseModel.C.

References Y_.

◆ YActiveRef()

template<class BasePhaseModel>

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

virtual

Access the active species mass fractions.

Definition at line 112 of file PurePhaseModel.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ Y_

template<class BasePhaseModel, class phaseThermo>

PtrList< volScalarField > Y_

protected

Empty mass fraction field list.

Definition at line 63 of file PurePhaseModel.H.

Referenced by Y(), Y(), YActive(), YActiveRef(), and YRef().

◆ thermoPtr_

template<class BasePhaseModel, class phaseThermo>

autoPtr<phaseThermo> thermoPtr_

protected

Empty thermophysical model Ptr.

Definition at line 68 of file PurePhaseModel.H.

Referenced by PurePhaseModel(), thermo(), and thermo().

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

src/phaseSystemModels/multiphaseInter/phasesSystem/phaseModel/PurePhaseModel/PurePhaseModel.H
src/phaseSystemModels/reactingEuler/multiphaseSystem/phaseModel/PurePhaseModel/PurePhaseModel.H
src/phaseSystemModels/multiphaseInter/phasesSystem/phaseModel/PurePhaseModel/PurePhaseModel.C
src/phaseSystemModels/reactingEuler/multiphaseSystem/phaseModel/PurePhaseModel/PurePhaseModel.C

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PurePhaseModel() [1/2]

◆ ~PurePhaseModel() [1/2]

◆ PurePhaseModel() [2/2]

◆ ~PurePhaseModel() [2/2]

Member Function Documentation

◆ Y() [1/4]

◆ Y() [2/4]

◆ solveYi()

◆ thermo() [1/2]

◆ thermo() [2/2]

◆ pure()

◆ YiEqn()

◆ Y() [3/4]

◆ Y() [4/4]

◆ YRef()

◆ YActive()

◆ YActiveRef()

Member Data Documentation

◆ Y_

◆ thermoPtr_