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 >:

Collaboration diagram for PurePhaseModel< BasePhaseModel >:

Public Member Functions
	PurePhaseModel (const phaseSystem &fluid, const word &phaseName, const bool referencePhase, 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 bool	solveSpecie (const label speciei) const
	Should the given specie be solved for? I.e., is it active and. More...

Protected Attributes
PtrList< volScalarField >	Y_
	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

• PurePhaseModel.H
• PurePhaseModel.C

Definition at line 50 of file PurePhaseModel.H.

Constructor & Destructor Documentation

PurePhaseModel()

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

Definition at line 32 of file PurePhaseModel.C.

~PurePhaseModel()

~PurePhaseModel

virtual

Destructor.

Definition at line 47 of file PurePhaseModel.C.

Member Function Documentation

pure()

bool pure

virtual

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

Definition at line 54 of file PurePhaseModel.C.

YiEqn()

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

virtual

Return the species fraction equation.

Definition at line 62 of file PurePhaseModel.C.

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

Here is the call graph for this function:

Y() [1/2]

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

virtual

Return the species mass fractions.

Definition at line 74 of file PurePhaseModel.C.

Y() [2/2]

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

virtual

Return a species mass fraction by name.

Definition at line 84 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 96 of file PurePhaseModel.C.

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

Here is the call graph for this function:

solveSpecie()

bool solveSpecie ( const label  speciei ) const

virtual

Should the given specie be solved for? I.e., is it active and.

not the default specie?

Definition at line 107 of file PurePhaseModel.C.

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 files:

• applications/modules/multiphaseEuler/phaseSystem/phaseModels/PurePhaseModel/PurePhaseModel.H
• applications/modules/multiphaseEuler/phaseSystem/phaseModels/PurePhaseModel/PurePhaseModel.C