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 multiphaseInterSystem &fluid, const word &phaseName)

virtual	~MultiComponentPhaseModel ()=default
	Destructor. More...

const hashedWordList &	species () const
	Species table. More...

virtual const phaseThermo &	thermo () const
	Access to thermo. More...

virtual phaseThermo &	thermo ()
	Access non-const thermo. More...

virtual void	correct ()
	Correct phase thermo. More...

virtual void	solveYi (PtrList< volScalarField::Internal > &, PtrList< volScalarField::Internal > &)
	Solve species fraction equation. More...

virtual const PtrList< volScalarField > &	Y () const
	Constant access the species mass fractions. More...

virtual PtrList< volScalarField > &	Y ()
	Access the species mass fractions. More...

label	inertIndex () const
	Return inert species index. More...

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

virtual	~MultiComponentPhaseModel ()
	Destructor. More...

virtual void	correctThermo ()
	Correct the thermodynamics. 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 Member Functions
void	calculateMassFractions ()
	Transfor volume fraction into mass fractions. More...

void	calculateVolumeFractions ()
	Transfor mass fraction into volume fractions. More...

Protected Attributes
hashedWordList	species_
	Species table. More...

label	inertIndex_
	Inert species index. More...

autoPtr< phaseThermo >	thermoPtr_
	Thermophysical model. More...

PtrList< volScalarField >	X_
	Ptr list of volumetric fractions for species. More...

bool	addDiffusion_
	Add diffusion transport on Yi's Eq. More...

scalar	Sct_
	Schmidt number. More...

dimensionedScalar	Sct_
	Turbulent Schmidt number. More...

dimensionedScalar	residualAlpha_
	Residual phase fraction. More...

UPtrList< volScalarField >	YActive_
	Pointer list to active species. More...

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 55 of file MultiComponentPhaseModel.H.

Constructor & Destructor Documentation

◆ MultiComponentPhaseModel() [1/2]

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

Definition at line 46 of file MultiComponentPhaseModel.C.

Here is the call graph for this function:

◆ ~MultiComponentPhaseModel() [1/2]

~MultiComponentPhaseModel

virtualdefault

Destructor.

Definition at line 93 of file MultiComponentPhaseModel.C.

◆ MultiComponentPhaseModel() [2/2]

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

Definition at line 44 of file MultiComponentPhaseModel.C.

References Foam::dimless, forAll, MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::inertIndex_, inertSpecie(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::Y(), and MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::YActive_.

Here is the call graph for this function:

◆ ~MultiComponentPhaseModel() [2/2]

virtual ~MultiComponentPhaseModel ( )

virtual

Destructor.

Member Function Documentation

◆ calculateMassFractions()

void calculateMassFractions

protected

Transfor volume fraction into mass fractions.

Definition at line 161 of file MultiComponentPhaseModel.C.

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

Here is the call graph for this function:

◆ calculateVolumeFractions()

void calculateVolumeFractions

protected

Transfor mass fraction into volume fractions.

Definition at line 117 of file MultiComponentPhaseModel.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), composition, GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::dimMass, Foam::dimMoles, fvPatchField< Type >::fixesValue(), forAll, dimensioned< Type >::value(), and Y.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ species()

const hashedWordList & species ( ) const

inline

Species table.

Definition at line 111 of file MultiComponentPhaseModel.H.

References MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::species_.

◆ thermo() [1/2]

const phaseThermo & thermo

virtual

Access to thermo.

Definition at line 184 of file MultiComponentPhaseModel.C.

◆ thermo() [2/2]

phaseThermo & thermo

virtual

Access non-const thermo.

Definition at line 192 of file MultiComponentPhaseModel.C.

◆ correct()

void correct

virtual

Correct phase thermo.

Definition at line 199 of file MultiComponentPhaseModel.C.

◆ solveYi()

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

virtual

Solve species fraction equation.

Definition at line 206 of file MultiComponentPhaseModel.C.

References alpha, alpha1, alpha2, GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), fvsPatchField< Type >::coupled(), Foam::fvc::ddt(), Foam::fvm::ddt(), TimeState::deltaT(), Foam::MULES::explicitSolve(), fluid, fvMatrix< Type >::flux(), Foam::fvc::flux(), forAll, forAllConstIter, dictionary::get(), dictionary::getOrDefault(), Foam::fvm::laplacian(), Foam::MULES::limit(), Foam::mag(), fvMesh::magSf(), GeometricField< Type, PatchField, GeoMesh >::max(), Foam::max(), mesh, DimensionedField< Type, GeoMesh >::mesh(), Foam::min(), IOobject::name(), nut, phases, phi, twoPhaseSystem::phi(), phic(), phir(), PtrList< T >::set(), fvMatrix< Type >::solve(), solution::solver(), solution::solverDict(), Sp, Foam::fvm::Sp(), Su, fvMesh::time(), turbulence, dimensioned< Type >::value(), and Yt().

Here is the call graph for this function:

◆ Y() [1/4]

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

virtual

Constant access the species mass fractions.

Definition at line 439 of file MultiComponentPhaseModel.C.

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

Here is the caller graph for this function:

◆ Y() [2/4]

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

virtual

Access the species mass fractions.

Definition at line 447 of file MultiComponentPhaseModel.C.

◆ inertIndex()

Foam::label inertIndex

Return inert species index.

Definition at line 455 of file MultiComponentPhaseModel.C.

◆ correctThermo()

void correctThermo

virtual

Correct the thermodynamics.

Definition at line 100 of file MultiComponentPhaseModel.C.

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

Here is the call graph for this function:

◆ pure()

bool pure

virtual

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

Definition at line 143 of file MultiComponentPhaseModel.C.

◆ YiEqn()

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

virtual

Return the species fraction equation.

Definition at line 151 of file MultiComponentPhaseModel.C.

References alpha, Foam::fvc::ddt(), Foam::fvm::ddt(), Foam::fvm::div(), Foam::fvc::interpolate(), Foam::fvm::laplacian(), IOobject::name(), and rho.

Here is the call graph for this function:

◆ Y() [3/4]

virtual const PtrList< volScalarField > & Y ( ) const

virtual

Return the species mass fractions.

◆ Y() [4/4]

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

virtual

Return a species mass fraction by name.

Definition at line 187 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 195 of file MultiComponentPhaseModel.C.

◆ YActive()

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

virtual

Return the active species mass fractions.

Definition at line 203 of file MultiComponentPhaseModel.C.

◆ YActiveRef()

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

virtual

Access the active species mass fractions.

Definition at line 211 of file MultiComponentPhaseModel.C.

Member Data Documentation

◆ species_

hashedWordList species_

protected

Species table.

Definition at line 64 of file MultiComponentPhaseModel.H.

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

◆ inertIndex_

label inertIndex_

protected

Inert species index.

Definition at line 67 of file MultiComponentPhaseModel.H.

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

◆ thermoPtr_

autoPtr<phaseThermo> thermoPtr_

protected

Thermophysical model.

Definition at line 70 of file MultiComponentPhaseModel.H.

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

◆ X_

PtrList<volScalarField> X_

protected

Ptr list of volumetric fractions for species.

Definition at line 73 of file MultiComponentPhaseModel.H.

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

◆ addDiffusion_

bool addDiffusion_

protected

Add diffusion transport on Yi's Eq.

Definition at line 76 of file MultiComponentPhaseModel.H.

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

◆ Sct_ [1/2]

scalar Sct_

protected

Schmidt number.

Definition at line 79 of file MultiComponentPhaseModel.H.

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

◆ Sct_ [2/2]

dimensionedScalar Sct_

protected

Turbulent Schmidt number.

Definition at line 61 of file MultiComponentPhaseModel.H.

◆ residualAlpha_

dimensionedScalar residualAlpha_

protected

Residual phase fraction.

Definition at line 64 of file MultiComponentPhaseModel.H.

◆ YActive_

UPtrList<volScalarField> YActive_

protected

Pointer list to active species.

Definition at line 70 of file MultiComponentPhaseModel.H.

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

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

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_

◆ addDiffusion_

◆ Sct_ [1/2]

◆ Sct_ [2/2]

◆ residualAlpha_

◆ YActive_