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

Inheritance diagram for basicSpecieMixture:

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

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

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

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

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

virtual tmp< volScalarField >	alphah (const label speciei, const volScalarField &p, const volScalarField &T) const =0
	Thermal diffusivity of enthalpy [kg/m/s]. More...

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

Protected Attributes
speciesTable	species_
	Table of specie names. More...

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

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

Detailed Description

Specialization 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 77 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 39 of file basicSpecieMixture.C.

References IOobject::AUTO_WRITE, TimePaths::constant(), forAll, IOobject::groupName(), mesh, IOobject::MUST_READ, IOobject::NO_READ, IOobject::NO_WRITE, fvMesh::time(), Time::timeName(), and tmp< T >::valid().

Here is the call graph for this function:

◆ ~basicSpecieMixture()

virtual ~basicSpecieMixture ( )

inlinevirtual

Destructor.

Definition at line 93 of file basicSpecieMixture.H.

References basicSpecieMixture::active(), basicSpecieMixture::alphah(), basicSpecieMixture::contains(), basicSpecieMixture::Cp(), basicSpecieMixture::Ha(), basicSpecieMixture::HE(), basicSpecieMixture::Hf(), basicSpecieMixture::Hs(), basicSpecieMixture::kappa(), basicSpecieMixture::mu(), p, basicSpecieMixture::rho(), basicSpecieMixture::setActive(), basicSpecieMixture::setInactive(), basicSpecieMixture::species(), Foam::T(), basicSpecieMixture::Wi(), and basicSpecieMixture::Y().

Here is the call graph for this function:

Member Function Documentation

◆ 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 greyMean::aCont(), wideBand::aCont(), adsorptionMassFractionFvPatchScalarField::calcPhiYp(), semiPermeableBaffleMassFractionFvPatchScalarField::calcPhiYp(), SLGThermo::carrierId(), ReactingParcel< ParcelType >::correctSurfaceValues(), mixtureFraction< ThermoType >::mixtureFraction(), ReactingCloud< Foam::DSMCCloud >::ReactingCloud(), SLGThermo::SLGThermo(), thermoSingleLayer::thermoSingleLayer(), and basicSpecieMixture::~basicSpecieMixture().

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.

References hashedWordList::found(), and basicSpecieMixture::species_.

Referenced by basicSpecieMixture::~basicSpecieMixture().

Here is the call graph for this function:

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 38 of file basicSpecieMixtureI.H.

References basicSpecieMixture::active_.

Referenced by TDACChemistryModel< CompType, 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 44 of file basicSpecieMixtureI.H.

References basicSpecieMixture::active_.

Referenced by basicSpecieMixture::~basicSpecieMixture().

Here is the caller graph for this function:

◆ setActive()

void setActive ( label speciei ) const

inline

Set speciei active.

Definition at line 50 of file basicSpecieMixtureI.H.

References basicSpecieMixture::active_, IOobject::AUTO_WRITE, and basicSpecieMixture::Y_.

Referenced by TDACChemistryModel< CompType, ThermoType >::solve(), and basicSpecieMixture::~basicSpecieMixture().

Here is the caller graph for this function:

◆ setInactive()

void setInactive ( label speciei ) const

inline

Set speciei inactive.

Definition at line 57 of file basicSpecieMixtureI.H.

References basicSpecieMixture::active_, IOobject::NO_WRITE, and basicSpecieMixture::Y_.

Referenced by TDACChemistryModel< CompType, ThermoType >::TDACChemistryModel(), and basicSpecieMixture::~basicSpecieMixture().

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 64 of file basicSpecieMixtureI.H.

References basicSpecieMixture::Y_.

Referenced by greyMean::aCont(), wideBand::aCont(), COxidationDiffusionLimitedRate< CloudType >::calculate(), COxidationKineticDiffusionLimitedRate< CloudType >::calculate(), COxidationHurtMitchell< CloudType >::calculate(), COxidationIntrinsicRate< CloudType >::calculate(), COxidationMurphyShaddix< CloudType >::calculate(), ReactingParcel< ParcelType >::correctSurfaceValues(), nonUnityLewisEddyDiffusivity< TurbulenceThermophysicalTransportModel >::divq(), mixtureFraction< ThermoType >::mixtureFraction(), specieTransferTemperatureFvPatchScalarField::phiHep(), nonUnityLewisEddyDiffusivity< TurbulenceThermophysicalTransportModel >::q(), basicSpecieMixture::Y(), and basicSpecieMixture::~basicSpecieMixture().

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 71 of file basicSpecieMixtureI.H.

References basicSpecieMixture::Y_.

◆ Y() [3/6]

Foam::volScalarField & Y ( const label i )

inline

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

Definition at line 77 of file basicSpecieMixtureI.H.

References basicSpecieMixture::Y(), and basicSpecieMixture::Y_.

Here is the call graph for this function:

◆ 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 84 of file basicSpecieMixtureI.H.

References basicSpecieMixture::Y(), and basicSpecieMixture::Y_.

Here is the call graph for this function:

◆ Y() [5/6]

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

inline

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

Definition at line 93 of file basicSpecieMixtureI.H.

References basicSpecieMixture::species_, basicSpecieMixture::Y(), and basicSpecieMixture::Y_.

Here is the call graph for this function:

◆ 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 102 of file basicSpecieMixtureI.H.

References basicSpecieMixture::species_, and basicSpecieMixture::Y_.

◆ Wi()

virtual scalar Wi ( const label speciei ) const

pure virtual

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

Referenced by greyMean::aCont(), wideBand::aCont(), adsorptionMassFractionFvPatchScalarField::calcPhiYp(), semiPermeableBaffleMassFractionFvPatchScalarField::calcPhiYp(), waxSolventEvaporation::correctModel(), ReactingParcel< ParcelType >::correctSurfaceValues(), and basicSpecieMixture::~basicSpecieMixture().

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 basicSpecieMixture::~basicSpecieMixture().

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 basicSpecieMixture::~basicSpecieMixture().

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 >::correctSurfaceValues(), and basicSpecieMixture::~basicSpecieMixture().

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].

Referenced by nonUnityLewisEddyDiffusivity< TurbulenceThermophysicalTransportModel >::divq(), specieTransferTemperatureFvPatchScalarField::phiHep(), nonUnityLewisEddyDiffusivity< TurbulenceThermophysicalTransportModel >::q(), and basicSpecieMixture::~basicSpecieMixture().

Here is the caller graph for this function:

◆ 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 basicSpecieMixture::~basicSpecieMixture().

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 basicSpecieMixture::~basicSpecieMixture().

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 basicSpecieMixture::~basicSpecieMixture().

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 basicSpecieMixture::~basicSpecieMixture().

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].

◆ alphah() [1/2]

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

pure virtual

Thermal conductivity [W/m/K].

Referenced by basicSpecieMixture::~basicSpecieMixture().

Here is the caller graph for this function:

◆ alphah() [2/2]

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

pure virtual

Thermal diffusivity of enthalpy [kg/m/s].

Member Data Documentation

◆ species_

speciesTable species_

protected

Table of specie names.

Definition at line 62 of file basicSpecieMixture.H.

Referenced by basicSpecieMixture::contains(), basicSpecieMixture::species(), and basicSpecieMixture::Y().

◆ active_

List<bool> active_

mutableprotected

List of specie active flags.

Definition at line 65 of file basicSpecieMixture.H.

Referenced by basicSpecieMixture::active(), basicSpecieMixture::setActive(), and basicSpecieMixture::setInactive().

◆ Y_

PtrList<volScalarField> Y_

protected

Species mass fractions.

Definition at line 68 of file basicSpecieMixture.H.

Referenced by basicSpecieMixture::setActive(), basicSpecieMixture::setInactive(), and basicSpecieMixture::Y().

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

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

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ basicMixtureType

Constructor & Destructor Documentation

◆ basicSpecieMixture()

◆ ~basicSpecieMixture()

Member Function Documentation

◆ TypeName()

◆ species()

◆ contains()

◆ active() [1/2]

◆ active() [2/2]

◆ setActive()

◆ setInactive()

◆ Y() [1/6]

◆ Y() [2/6]

◆ Y() [3/6]

◆ Y() [4/6]

◆ Y() [5/6]

◆ Y() [6/6]

◆ 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]

◆ alphah() [1/2]

◆ alphah() [2/2]

Member Data Documentation

◆ species_

◆ active_

◆ Y_