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

Inheritance diagram for MultiComponentPhaseModel< BasePhaseModel, phaseThermo >:

[legend]

Collaboration diagram for MultiComponentPhaseModel< BasePhaseModel, phaseThermo >:

[legend]

Public Member Functions
	MultiComponentPhaseModel (const phaseSystem &fluid, const word &phaseName)

virtual	~MultiComponentPhaseModel ()=default

const hashedWordList &	species () const

virtual const phaseThermo &	thermo () const

virtual phaseThermo &	thermo ()

virtual void	correct ()

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

virtual const PtrList< volScalarField > &	Y () const

virtual PtrList< volScalarField > &	Y ()

label	inertIndex () const

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

virtual	~MultiComponentPhaseModel ()

virtual void	correctThermo ()

virtual bool	pure () const

virtual tmp< fvScalarMatrix >	YiEqn (volScalarField &Yi)

virtual const PtrList< volScalarField > &	Y () const

virtual const volScalarField &	Y (const word &name) const

virtual PtrList< volScalarField > &	YRef ()

virtual const UPtrList< volScalarField > &	YActive () const

virtual UPtrList< volScalarField > &	YActiveRef ()

Protected Member Functions
void	calculateMassFractions ()

void	calculateVolumeFractions ()

Protected Attributes
hashedWordList	species_

label	inertIndex_

autoPtr< phaseThermo >	thermoPtr_

PtrList< volScalarField >	X_

dimensionedScalar	Sct_

dimensionedScalar	residualAlpha_

UPtrList< volScalarField >	YActive_

Detailed Description

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

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

Source files

Definition at line 51 of file MultiComponentPhaseModel.H.

Constructor & Destructor Documentation

◆ MultiComponentPhaseModel() [1/2]

MultiComponentPhaseModel	(	const phaseSystem &	fluid,
		const word &	phaseName
	)

Definition at line 42 of file MultiComponentPhaseModel.C.

References dictName(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, fluid, forAll, Foam::New(), and Y.

Here is the call graph for this function:

◆ ~MultiComponentPhaseModel() [1/2]

~MultiComponentPhaseModel

virtualdefault

Definition at line 86 of file MultiComponentPhaseModel.C.

◆ MultiComponentPhaseModel() [2/2]

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

Definition at line 38 of file MultiComponentPhaseModel.C.

References forAll, inertSpecie(), and Y.

Here is the call graph for this function:

◆ ~MultiComponentPhaseModel() [2/2]

virtual ~MultiComponentPhaseModel ( )

virtual

Member Function Documentation

◆ calculateMassFractions()

void calculateMassFractions

protected

Definition at line 150 of file MultiComponentPhaseModel.C.

References composition, Foam::endl(), forAll, Foam::Info, Foam::max(), Foam::min(), thermo, and Y.

Here is the call graph for this function:

◆ calculateVolumeFractions()

void calculateVolumeFractions

protected

Definition at line 105 of file MultiComponentPhaseModel.C.

References GeometricField::boundaryField(), composition, GeometricField::correctBoundaryConditions(), Foam::dimMass, Foam::dimMoles, fvPatchField::fixesValue(), forAll, thermo, dimensioned::value(), and Y.

Here is the call graph for this function:

◆ species()

const hashedWordList& species ( ) const

inline

Definition at line 101 of file MultiComponentPhaseModel.H.

References MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::species_.

◆ thermo() [1/2]

phaseThermo & thermo

virtual

Definition at line 172 of file MultiComponentPhaseModel.C.

◆ thermo() [2/2]

virtual phaseThermo& thermo ( )

virtual

◆ correct()

void correct

virtual

Definition at line 187 of file MultiComponentPhaseModel.C.

References thermo.

◆ solveYi()

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

virtual

Definition at line 195 of file MultiComponentPhaseModel.C.

References alpha1, alpha2, GeometricField::boundaryField(), GeometricField::boundaryFieldRef(), fvsPatchField::coupled(), stdFoam::end(), Foam::MULES::explicitSolve(), fluid, Foam::fvc::flux(), fvMatrix::flux(), forAll, forAllConstIter, dictionary::get(), dictionary::getOrDefault(), Foam::MULES::limit(), Foam::mag(), Foam::max(), mesh, Foam::min(), phases, phi, phic(), phir(), PtrList::set(), fvMatrix::solve(), Sp, Su, Yt(), and Foam::vtk::Tools::zeroField().

Here is the call graph for this function:

◆ Y() [1/4]

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

virtual

Definition at line 405 of file MultiComponentPhaseModel.C.

◆ Y() [2/4]

virtual PtrList<volScalarField>& Y ( )

virtual

◆ inertIndex()

Foam::label inertIndex

Definition at line 421 of file MultiComponentPhaseModel.C.

◆ correctThermo()

void correctThermo

virtual

Definition at line 93 of file MultiComponentPhaseModel.C.

References correctThermo(), Foam::dimless, fluid, forAll, mesh, Foam::name(), timeName, and Yt().

Here is the call graph for this function:

◆ pure()

bool pure

virtual

Definition at line 136 of file MultiComponentPhaseModel.C.

◆ YiEqn()

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

virtual

Definition at line 144 of file MultiComponentPhaseModel.C.

References Foam::constant::atomic::alpha, Foam::fac::ddt(), Foam::fac::div(), Foam::fac::interpolate(), Foam::fac::laplacian(), rho, and thermo.

Here is the call graph for this function:

◆ Y() [3/4]

virtual const PtrList<volScalarField>& Y ( ) const

virtual

◆ Y() [4/4]

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

virtual

Definition at line 180 of file MultiComponentPhaseModel.C.

References Foam::name().

Here is the call graph for this function:

◆ YRef()

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

virtual

Definition at line 188 of file MultiComponentPhaseModel.C.

◆ YActive()

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

virtual

Definition at line 196 of file MultiComponentPhaseModel.C.

◆ YActiveRef()

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

virtual

Definition at line 204 of file MultiComponentPhaseModel.C.

Member Data Documentation

◆ species_

hashedWordList species_

protected

Definition at line 60 of file MultiComponentPhaseModel.H.

Referenced by MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::species().

◆ inertIndex_

label inertIndex_

protected

Definition at line 63 of file MultiComponentPhaseModel.H.

◆ thermoPtr_

autoPtr<phaseThermo> thermoPtr_

protected

Definition at line 66 of file MultiComponentPhaseModel.H.

◆ X_

PtrList<volScalarField> X_

protected

Definition at line 69 of file MultiComponentPhaseModel.H.

◆ Sct_

dimensionedScalar Sct_

protected

Definition at line 57 of file MultiComponentPhaseModel.H.

◆ residualAlpha_

dimensionedScalar residualAlpha_

protected

Definition at line 60 of file MultiComponentPhaseModel.H.

◆ YActive_

UPtrList<volScalarField> YActive_

protected

Definition at line 66 of file MultiComponentPhaseModel.H.

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

src/phaseSystemModels/multiphaseInter/phasesSystem/phaseModel/MultiComponentPhaseModel/MultiComponentPhaseModel.H
src/phaseSystemModels/multiphaseInter/phasesSystem/phaseModel/MultiComponentPhaseModel/MultiComponentPhaseModel.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ MultiComponentPhaseModel() [1/2]

◆ ~MultiComponentPhaseModel() [1/2]

◆ MultiComponentPhaseModel() [2/2]

◆ ~MultiComponentPhaseModel() [2/2]

Member Function Documentation

◆ calculateMassFractions()

◆ calculateVolumeFractions()

◆ species()

◆ thermo() [1/2]

◆ thermo() [2/2]

◆ correct()

◆ solveYi()

◆ Y() [1/4]

◆ Y() [2/4]

◆ inertIndex()

◆ correctThermo()

◆ pure()

◆ YiEqn()

◆ Y() [3/4]

◆ Y() [4/4]

◆ YRef()

◆ YActive()

◆ YActiveRef()

Member Data Documentation

◆ species_

◆ inertIndex_

◆ thermoPtr_

◆ X_

◆ Sct_

◆ residualAlpha_

◆ YActive_

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