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

Definition at line 41 of file MulticomponentPhaseModel.C.

References forAll, MulticomponentPhaseModel< BasePhaseModel >::Y(), and MulticomponentPhaseModel< BasePhaseModel >::YActive_.

Here is the call graph for this function:

~MulticomponentPhaseModel()

~MulticomponentPhaseModel

virtual

Destructor.

Definition at line 68 of file MulticomponentPhaseModel.C.

Member Function Documentation

correctSpecies()

void correctSpecies

virtual

Correct the species fractions.

Definition at line 75 of file MulticomponentPhaseModel.C.

pure()

bool pure

virtual

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

Definition at line 83 of file MulticomponentPhaseModel.C.

YiEqn()

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

virtual

Return the species fraction equation.

Definition at line 91 of file MulticomponentPhaseModel.C.

References alpha(), Foam::correction(), Foam::fvm::ddt(), Foam::fvm::div(), Foam::max(), IOobject::name(), rho, and Foam::fvm::Sp().

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 122 of file MulticomponentPhaseModel.C.

Referenced by MulticomponentPhaseModel< BasePhaseModel >::MulticomponentPhaseModel().

Here is the caller graph for this function:

Y() [2/2]

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

virtual

Return a species mass fraction by name.

Definition at line 130 of file MulticomponentPhaseModel.C.

References Foam::name().

Here is the call graph for this function:

YRef()

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

virtual

Access the species mass fractions.

Definition at line 138 of file MulticomponentPhaseModel.C.

YActive()

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

virtual

Return the active species mass fractions.

Definition at line 146 of file MulticomponentPhaseModel.C.

YActiveRef()

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

virtual

Access the active species mass fractions.

Definition at line 154 of file MulticomponentPhaseModel.C.

Member Data Documentation

YActive_

UPtrList<volScalarField> YActive_

protected

Pointer list to active species.

Definition at line 59 of file MulticomponentPhaseModel.H.

Referenced by MulticomponentPhaseModel< BasePhaseModel >::MulticomponentPhaseModel().

---

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

• applications/modules/multiphaseEuler/phaseSystems/phaseModel/MulticomponentPhaseModel/MulticomponentPhaseModel.H
• applications/modules/multiphaseEuler/phaseSystems/phaseModel/MulticomponentPhaseModel/MulticomponentPhaseModel.C