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 bool	solveSpecie (const label speciei) const
	Should the given specie be solved for? I.e., is it active and. 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.

~MulticomponentPhaseModel()

~MulticomponentPhaseModel

virtual

Destructor.

Definition at line 56 of file MulticomponentPhaseModel.C.

Member Function Documentation

correctSpecies()

void correctSpecies

virtual

Correct the species fractions.

Definition at line 63 of file MulticomponentPhaseModel.C.

pure()

bool pure

virtual

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

Definition at line 71 of file MulticomponentPhaseModel.C.

YiEqn()

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

virtual

Return the species fraction equation.

Definition at line 79 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 110 of file MulticomponentPhaseModel.C.

Y() [2/2]

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

virtual

Return a species mass fraction by name.

Definition at line 118 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 126 of file MulticomponentPhaseModel.C.

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

---

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

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