Specialisation of basicMixture for a mixture consisting of a number for molecular species. More...

Inheritance diagram for basicSpecieMixture:

[legend]

Collaboration diagram for basicSpecieMixture:

[legend]

Public Types
typedef basicSpecieMixture	basicMixtureType
	The base class of the mixture. More...

Public Types inherited from basicMixture
typedef basicMixture	basicMixtureType
	The base class of the mixture. More...

Public Member Functions
	TypeName ("basicSpecieMixture")
	Run time type information. More...

	basicSpecieMixture (const dictionary &, const wordList &specieNames, const fvMesh &, const word &)
	Construct from dictionary, species names, mesh and phase name. More...

virtual	~basicSpecieMixture ()
	Destructor. More...

const speciesTable &	species () const
	Return the table of species. More...

bool	contains (const word &specieName) const
	Does the mixture include this specie? More...

label	defaultSpecie () const
	Return the index of the default specie. More...

bool	active (label speciei) const
	Return true for active species. More...

const List< bool > &	active () const
	Return the bool list of active species. More...

void	setActive (label speciei) const
	Set speciei active. More...

void	setInactive (label speciei) const
	Set speciei inactive. More...

bool	solve (label speciei) const
	Return true if the specie should be solved for. More...

PtrList< volScalarField > &	Y ()
	Return the mass-fraction fields. More...

const PtrList< volScalarField > &	Y () const
	Return the const mass-fraction fields. More...

volScalarField &	Y (const label i)
	Return the mass-fraction field for a specie given by index. More...

const volScalarField &	Y (const label i) const
	Return the const mass-fraction field for a specie given by index. More...

volScalarField &	Y (const word &specieName)
	Return the mass-fraction field for a specie given by name. More...

const volScalarField &	Y (const word &specieName) const
	Return the const mass-fraction field for a specie given by name. More...

label	index (const volScalarField &Yi) const
	Return the specie index of the given mass-fraction field. More...

void	normalise ()
	Normalise the mass fractions. More...

virtual scalar	Wi (const label speciei) const =0
	Molecular weight of the given specie [kg/kmol]. More...

virtual scalar	Hf (const label speciei) const =0
	Enthalpy of formation [J/kg]. More...

virtual scalar	rho (const label speciei, const scalar p, const scalar T) const =0
	Density [kg/m^3]. More...

virtual tmp< volScalarField >	rho (const label speciei, const volScalarField &p, const volScalarField &T) const =0
	Density [kg/m^3]. More...

virtual scalar	Cp (const label speciei, const scalar p, const scalar T) const =0
	Heat capacity at constant pressure [J/kg/K]. More...

virtual tmp< volScalarField >	Cp (const label speciei, const volScalarField &p, const volScalarField &T) const =0
	Heat capacity at constant pressure [J/kg/K]. More...

virtual scalar	HE (const label speciei, const scalar p, const scalar T) const =0
	Enthalpy/Internal energy [J/kg]. More...

virtual tmp< scalarField >	HE (const label speciei, const scalarField &p, const scalarField &T) const =0
	Enthalpy/Internal energy [J/kg]. More...

virtual tmp< volScalarField >	HE (const label speciei, const volScalarField &p, const volScalarField &T) const =0
	Enthalpy/Internal energy [J/kg]. More...

virtual scalar	Hs (const label speciei, const scalar p, const scalar T) const =0
	Sensible enthalpy [J/kg]. More...

virtual tmp< scalarField >	Hs (const label speciei, const scalarField &p, const scalarField &T) const =0
	Sensible enthalpy [J/kg]. More...

virtual tmp< volScalarField >	Hs (const label speciei, const volScalarField &p, const volScalarField &T) const =0
	Sensible enthalpy [J/kg]. More...

virtual scalar	Ha (const label speciei, const scalar p, const scalar T) const =0
	Absolute enthalpy [J/kg]. More...

virtual tmp< scalarField >	Ha (const label speciei, const scalarField &p, const scalarField &T) const =0
	Enthalpy/Internal energy [J/kg]. More...

virtual tmp< volScalarField >	Ha (const label speciei, const volScalarField &p, const volScalarField &T) const =0
	Absolute enthalpy [J/kg]. More...

virtual scalar	mu (const label speciei, const scalar p, const scalar T) const =0
	Dynamic viscosity [kg/m/s]. More...

virtual tmp< volScalarField >	mu (const label speciei, const volScalarField &p, const volScalarField &T) const =0
	Dynamic viscosity [kg/m/s]. More...

virtual scalar	kappa (const label speciei, const scalar p, const scalar T) const =0
	Thermal conductivity [W/m/K]. More...

virtual tmp< volScalarField >	kappa (const label speciei, const volScalarField &p, const volScalarField &T) const =0
	Thermal conductivity [W/m/K]. More...

Public Member Functions inherited from basicMixture
	basicMixture (const dictionary &, const fvMesh &, const word &)
	Construct from dictionary, mesh and phase name. More...

Protected Member Functions
void	correctMassFractions ()
	Scale the mass fractions to sum to 1. More...

Protected Attributes
const word &	phaseName_
	Phase-name. More...

speciesTable	species_
	Table of specie names. More...

word	defaultSpecie_
	The name of the default specie. More...

label	defaultSpecieIndex_
	The index of the default specie. More...

List< bool >	active_
	List of specie active flags. More...

PtrList< volScalarField >	Y_
	Species mass fractions. More...

Detailed Description

Specialisation of basicMixture for a mixture consisting of a number for molecular species.

Source files

Definition at line 52 of file basicSpecieMixture.H.

Member Typedef Documentation

◆ basicMixtureType

typedef basicSpecieMixture basicMixtureType

The base class of the mixture.

Definition at line 95 of file basicSpecieMixture.H.

Constructor & Destructor Documentation

◆ basicSpecieMixture()

basicSpecieMixture	(	const dictionary &	thermoDict,
		const wordList &	specieNames,
		const fvMesh &	mesh,
		const word &	phaseName
	)

Construct from dictionary, species names, mesh and phase name.

Definition at line 38 of file basicSpecieMixture.C.

◆ ~basicSpecieMixture()

virtual ~basicSpecieMixture ( )

inlinevirtual

Destructor.

Definition at line 111 of file basicSpecieMixture.H.

Member Function Documentation

◆ correctMassFractions()

void correctMassFractions ( )

protected

Scale the mass fractions to sum to 1.

Definition at line 183 of file basicSpecieMixture.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, IOobject::groupName(), Foam::mag(), Foam::min(), GeometricField< Type, PatchField, GeoMesh >::New(), and tmp< T >::ref().

Referenced by multicomponentMixture< ThermoType >::multicomponentMixture().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "basicSpecieMixture" )

Run time type information.

◆ species()

const Foam::speciesTable & species ( ) const

inline

Return the table of species.

Definition at line 26 of file basicSpecieMixtureI.H.

References basicSpecieMixture::species_.

Referenced by HeatTransferPhaseSystem< BasePhaseSystem >::addDmidtHefs(), HeatTransferPhaseSystem< BasePhaseSystem >::addDmidtHefsWithoutL(), ReactingParcel< ParcelType >::calc(), ReactingParcel< ParcelType >::correctSurfaceValues(), interfaceCompositionModel::D(), interfaceCompositionModel::dY(), HeatTransferPhaseSystem< BasePhaseSystem >::Li(), nonRandomTwoLiquid::nonRandomTwoLiquid(), MaxwellStefan< BasicThermophysicalTransportModel >::read(), and singleStepCombustion::singleStepCombustion().

Here is the caller graph for this function:

◆ contains()

bool contains ( const word & specieName ) const

inline

Does the mixture include this specie?

Definition at line 32 of file basicSpecieMixtureI.H.

◆ defaultSpecie()

Foam::label defaultSpecie ( ) const

inline

Return the index of the default specie.

Definition at line 38 of file basicSpecieMixtureI.H.

Referenced by Fickian< BasicThermophysicalTransportModel >::divq(), MaxwellStefan< BasicThermophysicalTransportModel >::divq(), MaxwellStefan< BasicThermophysicalTransportModel >::j(), MaxwellStefan< unityLewisFourier< laminarThermophysicalTransportModel > >::predict(), Fickian< BasicThermophysicalTransportModel >::q(), and MaxwellStefan< BasicThermophysicalTransportModel >::q().

Here is the caller graph for this function:

◆ active() [1/2]

bool active ( label speciei ) const

inline

Return true for active species.

Definition at line 44 of file basicSpecieMixtureI.H.

Referenced by chemistryModel< ThermoType >::solve().

Here is the caller graph for this function:

◆ active() [2/2]

const Foam::List< bool > & active ( ) const

inline

Return the bool list of active species.

Definition at line 50 of file basicSpecieMixtureI.H.

◆ setActive()

void setActive ( label speciei ) const

inline

Set speciei active.

Definition at line 56 of file basicSpecieMixtureI.H.

References IOobject::AUTO_WRITE.

Referenced by chemistryModel< ThermoType >::solve().

Here is the caller graph for this function:

◆ setInactive()

void setInactive ( label speciei ) const

inline

Set speciei inactive.

Definition at line 63 of file basicSpecieMixtureI.H.

References IOobject::NO_WRITE.

◆ solve()

bool solve ( label speciei ) const

inline

Return true if the specie should be solved for.

i.e. active and not the default specie

Definition at line 70 of file basicSpecieMixtureI.H.

Referenced by multicomponentFluid::thermophysicalPredictor().

Here is the caller graph for this function:

◆ Y() [1/6]

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

inline

Return the mass-fraction fields.

Definition at line 76 of file basicSpecieMixtureI.H.

Referenced by HeatTransferPhaseSystem< BasePhaseSystem >::addDmidtHefs(), HeatTransferPhaseSystem< BasePhaseSystem >::addDmidtHefsWithoutL(), COxidationDiffusionLimitedRate< CloudType >::calculate(), COxidationHurtMitchell< CloudType >::calculate(), COxidationIntrinsicRate< CloudType >::calculate(), COxidationKineticDiffusionLimitedRate< CloudType >::calculate(), COxidationMurphyShaddix< CloudType >::calculate(), coefficientWilkeMulticomponentMixture< ThermoType >::cellThermoMixture(), coefficientWilkeMulticomponentMixture< ThermoType >::cellTransportMixture(), ReactingParcel< ParcelType >::correctSurfaceValues(), Fickian< BasicThermophysicalTransportModel >::divq(), MaxwellStefan< BasicThermophysicalTransportModel >::divq(), interfaceCompositionModel::dY(), MaxwellStefan< BasicThermophysicalTransportModel >::j(), coefficientWilkeMulticomponentMixture< ThermoType >::patchFaceThermoMixture(), coefficientWilkeMulticomponentMixture< ThermoType >::patchFaceTransportMixture(), specieTransferVelocityFvPatchVectorField::phip(), Fickian< BasicThermophysicalTransportModel >::q(), MaxwellStefan< BasicThermophysicalTransportModel >::q(), and Foam::W().

Here is the caller graph for this function:

◆ Y() [2/6]

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

inline

Return the const mass-fraction fields.

Definition at line 83 of file basicSpecieMixtureI.H.

◆ Y() [3/6]

Foam::volScalarField & Y ( const label i )

inline

Return the mass-fraction field for a specie given by index.

Definition at line 89 of file basicSpecieMixtureI.H.

◆ Y() [4/6]

const Foam::volScalarField & Y ( const label i ) const

inline

Return the const mass-fraction field for a specie given by index.

Definition at line 95 of file basicSpecieMixtureI.H.

◆ Y() [5/6]

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

inline

Return the mass-fraction field for a specie given by name.

Definition at line 104 of file basicSpecieMixtureI.H.

◆ Y() [6/6]

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

inline

Return the const mass-fraction field for a specie given by name.

Definition at line 113 of file basicSpecieMixtureI.H.

◆ index()

Foam::label index ( const volScalarField & Yi ) const

inline

Return the specie index of the given mass-fraction field.

Definition at line 122 of file basicSpecieMixtureI.H.

References IOobject::member().

Referenced by Fickian< BasicThermophysicalTransportModel >::DEff(), MaxwellStefan< BasicThermophysicalTransportModel >::DEff(), Fickian< BasicThermophysicalTransportModel >::divj(), MaxwellStefan< BasicThermophysicalTransportModel >::divj(), Fickian< BasicThermophysicalTransportModel >::j(), and MaxwellStefan< BasicThermophysicalTransportModel >::j().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ normalise()

void normalise ( )

Normalise the mass fractions.

by clipping positive and deriving the default specie mass fraction from the other species

Definition at line 218 of file basicSpecieMixture.C.

References Foam::dimless, forAll, IOobject::groupName(), GeometricField< Type, PatchField, GeoMesh >::max(), GeometricField< Type, PatchField, GeoMesh >::New(), tmp< T >::ref(), and Foam::solve().

Referenced by multicomponentFluid::thermophysicalPredictor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Wi()

virtual scalar Wi ( const label speciei ) const

pure virtual

Molecular weight of the given specie [kg/kmol].

Referenced by singleStepCombustion::calculateqFuel(), ReactingParcel< ParcelType >::correctSurfaceValues(), and Foam::W().

Here is the caller graph for this function:

◆ Hf()

virtual scalar Hf ( const label speciei ) const

pure virtual

Enthalpy of formation [J/kg].

Referenced by singleStepCombustion::calculateqFuel().

Here is the caller graph for this function:

◆ rho() [1/2]

virtual scalar rho	(	const label	speciei,
		const scalar	p,
		const scalar	T
	)		const

pure virtual

Density [kg/m^3].

Referenced by Fickian< BasicThermophysicalTransportModel >::DEff(), and MaxwellStefan< BasicThermophysicalTransportModel >::DEff().

Here is the caller graph for this function:

◆ rho() [2/2]

virtual tmp<volScalarField> rho	(	const label	speciei,
		const volScalarField &	p,
		const volScalarField &	T
	)		const

pure virtual

Density [kg/m^3].

◆ Cp() [1/2]

virtual scalar Cp	(	const label	speciei,
		const scalar	p,
		const scalar	T
	)		const

pure virtual

Heat capacity at constant pressure [J/kg/K].

Referenced by ReactingParcel< ParcelType >::calc(), and ReactingParcel< ParcelType >::correctSurfaceValues().

Here is the caller graph for this function:

◆ Cp() [2/2]

virtual tmp<volScalarField> Cp	(	const label	speciei,
		const volScalarField &	p,
		const volScalarField &	T
	)		const

pure virtual

Heat capacity at constant pressure [J/kg/K].

◆ HE() [1/3]

virtual scalar HE	(	const label	speciei,
		const scalar	p,
		const scalar	T
	)		const

pure virtual

Enthalpy/Internal energy [J/kg].

◆ HE() [2/3]

virtual tmp<scalarField> HE	(	const label	speciei,
		const scalarField &	p,
		const scalarField &	T
	)		const

pure virtual

Enthalpy/Internal energy [J/kg].

◆ HE() [3/3]

virtual tmp<volScalarField> HE	(	const label	speciei,
		const volScalarField &	p,
		const volScalarField &	T
	)		const

pure virtual

Enthalpy/Internal energy [J/kg].

◆ Hs() [1/3]

virtual scalar Hs	(	const label	speciei,
		const scalar	p,
		const scalar	T
	)		const

pure virtual

Sensible enthalpy [J/kg].

Referenced by HeatTransferPhaseSystem< BasePhaseSystem >::addDmidtHefs(), HeatTransferPhaseSystem< BasePhaseSystem >::addDmidtHefsWithoutL(), ReactingParcel< ParcelType >::calc(), Fickian< BasicThermophysicalTransportModel >::divq(), MaxwellStefan< BasicThermophysicalTransportModel >::divq(), Foam::h0(), Fickian< BasicThermophysicalTransportModel >::q(), and MaxwellStefan< BasicThermophysicalTransportModel >::q().

Here is the caller graph for this function:

◆ Hs() [2/3]

virtual tmp<scalarField> Hs	(	const label	speciei,
		const scalarField &	p,
		const scalarField &	T
	)		const

pure virtual

Sensible enthalpy [J/kg].

◆ Hs() [3/3]

virtual tmp<volScalarField> Hs	(	const label	speciei,
		const volScalarField &	p,
		const volScalarField &	T
	)		const

pure virtual

Sensible enthalpy [J/kg].

◆ Ha() [1/3]

virtual scalar Ha	(	const label	speciei,
		const scalar	p,
		const scalar	T
	)		const

pure virtual

Absolute enthalpy [J/kg].

Referenced by HeatTransferPhaseSystem< BasePhaseSystem >::Li().

Here is the caller graph for this function:

◆ Ha() [2/3]

virtual tmp<scalarField> Ha	(	const label	speciei,
		const scalarField &	p,
		const scalarField &	T
	)		const

pure virtual

Enthalpy/Internal energy [J/kg].

◆ Ha() [3/3]

virtual tmp<volScalarField> Ha	(	const label	speciei,
		const volScalarField &	p,
		const volScalarField &	T
	)		const

pure virtual

Absolute enthalpy [J/kg].

◆ mu() [1/2]

virtual scalar mu	(	const label	speciei,
		const scalar	p,
		const scalar	T
	)		const

pure virtual

Dynamic viscosity [kg/m/s].

Referenced by ReactingParcel< ParcelType >::correctSurfaceValues(), and coefficientWilkeMulticomponentMixture< ThermoType >::transportMixture::mu().

Here is the caller graph for this function:

◆ mu() [2/2]

virtual tmp<volScalarField> mu	(	const label	speciei,
		const volScalarField &	p,
		const volScalarField &	T
	)		const

pure virtual

Dynamic viscosity [kg/m/s].

◆ kappa() [1/2]

virtual scalar kappa	(	const label	speciei,
		const scalar	p,
		const scalar	T
	)		const

pure virtual

Thermal conductivity [W/m/K].

Referenced by ReactingParcel< ParcelType >::correctSurfaceValues(), and coefficientWilkeMulticomponentMixture< ThermoType >::transportMixture::kappa().

Here is the caller graph for this function:

◆ kappa() [2/2]

virtual tmp<volScalarField> kappa	(	const label	speciei,
		const volScalarField &	p,
		const volScalarField &	T
	)		const

pure virtual

Thermal conductivity [W/m/K].

Member Data Documentation

◆ phaseName_

const word& phaseName_

protected

Phase-name.

Definition at line 62 of file basicSpecieMixture.H.

◆ species_

speciesTable species_

protected

Table of specie names.

Definition at line 65 of file basicSpecieMixture.H.

Referenced by basicSpecieMixture::species().

◆ defaultSpecie_

word defaultSpecie_

protected

The name of the default specie.

The mass fraction of which is derived from the other species rather than solved. Also used as the carrier specie in multicomponent diffusion

Definition at line 71 of file basicSpecieMixture.H.

◆ defaultSpecieIndex_

label defaultSpecieIndex_

protected

The index of the default specie.

Definition at line 74 of file basicSpecieMixture.H.

◆ active_

List<bool> active_

mutableprotected

List of specie active flags.

Definition at line 77 of file basicSpecieMixture.H.

◆ Y_

PtrList<volScalarField> Y_

protected

Species mass fractions.

Definition at line 80 of file basicSpecieMixture.H.

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

src/thermophysicalModels/multicomponentThermo/mixtures/basicSpecieMixture/basicSpecieMixture.H
src/thermophysicalModels/multicomponentThermo/mixtures/basicSpecieMixture/basicSpecieMixture.C
src/thermophysicalModels/multicomponentThermo/mixtures/basicSpecieMixture/basicSpecieMixtureI.H

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ basicMixtureType

Constructor & Destructor Documentation

◆ basicSpecieMixture()

◆ ~basicSpecieMixture()

Member Function Documentation

◆ correctMassFractions()

◆ TypeName()

◆ species()

◆ contains()

◆ defaultSpecie()

◆ active() [1/2]

◆ active() [2/2]

◆ setActive()

◆ setInactive()

◆ solve()

◆ Y() [1/6]

◆ Y() [2/6]

◆ Y() [3/6]

◆ Y() [4/6]

◆ Y() [5/6]

◆ Y() [6/6]

◆ index()

◆ normalise()

◆ Wi()

◆ Hf()

◆ rho() [1/2]

◆ rho() [2/2]

◆ Cp() [1/2]

◆ Cp() [2/2]

◆ HE() [1/3]

◆ HE() [2/3]

◆ HE() [3/3]

◆ Hs() [1/3]

◆ Hs() [2/3]

◆ Hs() [3/3]

◆ Ha() [1/3]

◆ Ha() [2/3]

◆ Ha() [3/3]

◆ mu() [1/2]

◆ mu() [2/2]

◆ kappa() [1/2]

◆ kappa() [2/2]

Member Data Documentation

◆ phaseName_

◆ species_

◆ defaultSpecie_

◆ defaultSpecieIndex_

◆ active_

◆ Y_