MultiComponentPhaseModel< BasePhaseModel > Class Template Reference

Class which represents a phase with multiple species. Returns the species' mass fractions, and their governing equations. More...

Inheritance diagram for MultiComponentPhaseModel< BasePhaseModel >:

Collaboration diagram for MultiComponentPhaseModel< BasePhaseModel >:

Public Member Functions
	MultiComponentPhaseModel (const phaseSystem &fluid, const word &phaseName, const bool referencePhase, const label index)
virtual	~MultiComponentPhaseModel ()
	Destructor. More...
virtual void	correctSpecies ()
	Correct the species fractions. 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
dimensionedScalar	residualAlpha_
	Residual phase fraction. More...
label	inertIndex_
	Inert species index. More...
UPtrList< volScalarField >	YActive_
	Pointer list to active species. More...

Detailed Description

template<class BasePhaseModel>
class Foam::MultiComponentPhaseModel< BasePhaseModel >

Class which represents a phase with multiple species. Returns the species' mass fractions, and their governing equations.

Source files

• MultiComponentPhaseModel.H
• MultiComponentPhaseModel.C

Definition at line 50 of file MultiComponentPhaseModel.H.

Constructor & Destructor Documentation

MultiComponentPhaseModel()

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

~MultiComponentPhaseModel()

virtual ~MultiComponentPhaseModel ( )

virtual

Destructor.

Member Function Documentation

correctSpecies()

virtual void correctSpecies ( )

virtual

Correct the species fractions.

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

residualAlpha_

dimensionedScalar residualAlpha_

protected

Residual phase fraction.

Definition at line 59 of file MultiComponentPhaseModel.H.

inertIndex_

label inertIndex_

protected

Inert species index.

Definition at line 62 of file MultiComponentPhaseModel.H.

YActive_

UPtrList<volScalarField> YActive_

protected

Pointer list to active species.

Definition at line 65 of file MultiComponentPhaseModel.H.

---

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

• applications/solvers/multiphase/multiphaseEulerFoam/phaseSystems/phaseModel/MultiComponentPhaseModel/MultiComponentPhaseModel.H