basicSpecieMixture Class Referenceabstract

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

Inheritance diagram for basicSpecieMixture:
Collaboration diagram for basicSpecieMixture:

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 speciesTablespecies () 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...
 
volScalarFieldY (const label i)
 Return the mass-fraction field for a specie given by index. More...
 
const volScalarFieldY (const label i) const
 Return the const mass-fraction field for a specie given by index. More...
 
volScalarFieldY (const word &specieName)
 Return the mass-fraction field for a specie given by name. More...
 
const volScalarFieldY (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< volScalarFieldrho (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< volScalarFieldCp (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< scalarFieldHE (const label speciei, const scalarField &p, const scalarField &T) const =0
 Enthalpy/Internal energy [J/kg]. More...
 
virtual tmp< volScalarFieldHE (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< scalarFieldHs (const label speciei, const scalarField &p, const scalarField &T) const =0
 Sensible enthalpy [J/kg]. More...
 
virtual tmp< volScalarFieldHs (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< scalarFieldHa (const label speciei, const scalarField &p, const scalarField &T) const =0
 Enthalpy/Internal energy [J/kg]. More...
 
virtual tmp< volScalarFieldHa (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< volScalarFieldmu (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< volScalarFieldkappa (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 wordphaseName_
 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< volScalarFieldY_
 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

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

References IOobject::AUTO_WRITE, TimePaths::constant(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, 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()

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::max(), GeometricField< scalar, fvPatchField, volMesh >::New(), and tmp< T >::ref().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "basicSpecieMixture"  )

Run time type information.

◆ species()

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

◆ defaultSpecie()

◆ active() [1/2]

bool active ( label  speciei) const
inline

Return true for active species.

Definition at line 44 of file basicSpecieMixtureI.H.

References basicSpecieMixture::active_.

Referenced by TDACChemistryModel< 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.

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

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

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

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

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

Here is the caller graph for this function:

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

References basicSpecieMixture::active_, and basicSpecieMixture::defaultSpecieIndex_.

Referenced by clouds::addSupFields(), surfaceFilm::addSupFields(), and basicSpecieMixture::~basicSpecieMixture().

Here is the caller graph for this function:

◆ Y() [1/6]

Return the mass-fraction fields.

Definition at line 76 of file basicSpecieMixtureI.H.

References basicSpecieMixture::Y_.

Referenced by greyMean::aCont(), wideBand::aCont(), clouds::addSupFields(), surfaceFilm::addSupFields(), COxidationDiffusionLimitedRate< CloudType >::calculate(), COxidationKineticDiffusionLimitedRate< CloudType >::calculate(), COxidationHurtMitchell< CloudType >::calculate(), COxidationIntrinsicRate< CloudType >::calculate(), COxidationMurphyShaddix< CloudType >::calculate(), coefficientWilkeMultiComponentMixture< ThermoType >::cellThermoMixture(), valueMultiComponentMixture< ThermoType >::cellThermoMixture(), coefficientWilkeMultiComponentMixture< ThermoType >::cellTransportMixture(), valueMultiComponentMixture< ThermoType >::cellTransportMixture(), Fickian< unityLewisFourier< laminarThermophysicalTransportModel > >::correct(), MaxwellStefan< unityLewisFourier< laminarThermophysicalTransportModel > >::correct(), ReactingParcel< ParcelType >::correctSurfaceValues(), MaxwellStefan< unityLewisFourier< laminarThermophysicalTransportModel > >::divj(), Fickian< unityLewisFourier< laminarThermophysicalTransportModel > >::divq(), nonUnityLewisEddyDiffusivity< TurbulenceThermophysicalTransportModel >::divq(), MaxwellStefan< unityLewisFourier< laminarThermophysicalTransportModel > >::divq(), singleStepCombustion::fresCorrect(), coefficientWilkeMultiComponentMixture< ThermoType >::patchFaceThermoMixture(), valueMultiComponentMixture< ThermoType >::patchFaceThermoMixture(), coefficientWilkeMultiComponentMixture< ThermoType >::patchFaceTransportMixture(), valueMultiComponentMixture< ThermoType >::patchFaceTransportMixture(), specieTransferTemperatureFvPatchScalarField::phiHep(), Fickian< unityLewisFourier< laminarThermophysicalTransportModel > >::q(), nonUnityLewisEddyDiffusivity< TurbulenceThermophysicalTransportModel >::q(), MaxwellStefan< unityLewisFourier< laminarThermophysicalTransportModel > >::q(), singleStepCombustion::Qdot(), 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 83 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 89 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 96 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 105 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 114 of file basicSpecieMixtureI.H.

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

Here is the call graph for this function:

◆ index()

◆ 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(), mesh, GeometricField< scalar, fvPatchField, volMesh >::New(), tmp< T >::ref(), and Foam::solve().

Referenced by basicSpecieMixture::~basicSpecieMixture().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Wi()

◆ Hf()

virtual scalar Hf ( const label  speciei) const
pure virtual

Enthalpy of formation [J/kg].

Referenced by singleStepCombustion::calculateqFuel(), and 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

◆ 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 specieTransferTemperatureFvPatchScalarField::phiHep(), 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]

◆ 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

◆ 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

◆ 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

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

Referenced by basicSpecieMixture::defaultSpecie(), and basicSpecieMixture::solve().

◆ active_

List<bool> active_
mutableprotected

◆ Y_

PtrList<volScalarField> Y_
protected

Species mass fractions.

Definition at line 80 of file basicSpecieMixture.H.

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


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