Templated reacting parcel composition model class Consists of carrier species (via thermo package), and additional liquids and solids. More...
Public Member Functions | |
TypeName ("compositionModel") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, CompositionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner)) | |
Declare runtime constructor selection table. More... | |
CompositionModel (CloudType &owner) | |
Construct null from owner. More... | |
CompositionModel (const dictionary &dict, CloudType &owner, const word &type) | |
Construct from dictionary. More... | |
CompositionModel (const CompositionModel< CloudType > &cm) | |
Construct copy. More... | |
virtual autoPtr< CompositionModel< CloudType > > | clone () const =0 |
Construct and return a clone. More... | |
virtual | ~CompositionModel () |
Destructor. More... | |
const parcelThermo & | thermo () const |
Return the thermo database. More... | |
const fluidMulticomponentThermo & | carrier () const |
Return the carrier components (wrapper function) More... | |
const liquidMixtureProperties & | liquids () const |
Return the global (additional) liquids. More... | |
const solidMixtureProperties & | solids () const |
Return the global (additional) solids. More... | |
const phasePropertiesList & | phaseProps () const |
Return the list of phase properties. More... | |
label | nPhase () const |
Return the number of phases. More... | |
const wordList & | phaseTypes () const |
Return the list of phase type names. More... | |
const wordList & | stateLabels () const |
Return the list of state labels (s), (l), (g) etc. More... | |
const wordList & | componentNames (const label phaseI) const |
Return the list of component names for phaseI. More... | |
label | carrierId (const word &cmptName, const bool allowNotFound=false) const |
Return global id of component cmptName in carrier thermo. More... | |
label | localId (const label phaseI, const word &cmptName, const bool allowNotFound=false) const |
Return local id of component cmptName in phase phaseI. More... | |
label | localToCarrierId (const label phaseI, const label id, const bool allowNotFound=false) const |
Return carrier id of component given local id. More... | |
const scalarField & | Y0 (const label phaseI) const |
Return the list of phase phaseI mass fractions. More... | |
scalarField | X (const label phaseI, const scalarField &Y) const |
Return the list of phase phaseI volume fractions fractions. More... | |
virtual const scalarField & | YMixture0 () const =0 |
Return the list of mixture mass fractions. More... | |
virtual label | idGas () const =0 |
Gas id. More... | |
virtual label | idLiquid () const =0 |
Liquid id. More... | |
virtual label | idSolid () const =0 |
Solid id. More... | |
virtual scalar | ha (const label phaseI, const scalarField &Y, const scalar p, const scalar T) const |
Return total enthalpy for the phase phaseI. More... | |
virtual scalar | hs (const label phaseI, const scalarField &Y, const scalar p, const scalar T) const |
Return sensible enthalpy for the phase phaseI. More... | |
virtual scalar | Cp (const label phaseI, const scalarField &Y, const scalar p, const scalar T) const |
Return specific heat capacity for the phase phaseI. More... | |
virtual scalar | L (const label phaseI, const scalarField &Y, const scalar p, const scalar T) const |
Return latent heat for the phase phaseI. More... | |
Public Member Functions inherited from CloudSubModelBase< CloudType > | |
CloudSubModelBase (CloudType &owner) | |
Construct null from owner cloud. More... | |
CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs") | |
Construct from owner cloud without name. More... | |
CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType) | |
Construct from owner cloud with name. More... | |
CloudSubModelBase (const CloudSubModelBase< CloudType > &smb) | |
Copy constructor. More... | |
virtual | ~CloudSubModelBase () |
Destructor. More... | |
const CloudType & | owner () const |
Return const access to the owner cloud. More... | |
virtual bool | writeTime () const |
Flag to indicate when to write a property. More... | |
CloudType & | owner () |
Return non-const access to the owner cloud for manipulation. More... | |
virtual void | write (Ostream &os) const |
Write. More... | |
Public Member Functions inherited from subModelBase | |
subModelBase (dictionary &properties) | |
Construct null. More... | |
subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs") | |
Construct from components without name. More... | |
subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType) | |
Construct from components with name. More... | |
subModelBase (const subModelBase &smb) | |
Copy constructor. More... | |
virtual | ~subModelBase () |
Destructor. More... | |
const word & | modelName () const |
Return const access to the name of the sub-model. More... | |
const dictionary & | dict () const |
Return const access to the cloud dictionary. More... | |
const word & | baseName () const |
Return const access to the base name of the sub-model. More... | |
const word & | modelType () const |
Return const access to the sub-model type. More... | |
const dictionary & | coeffDict () const |
Return const access to the coefficients dictionary. More... | |
const dictionary & | properties () const |
Return const access to the properties dictionary. More... | |
virtual bool | defaultCoeffs (const bool printMsg) const |
Returns true if defaultCoeffs is true and outputs on printMsg. More... | |
virtual void | cacheFields (const bool store) |
Cache dependent sub-model fields. More... | |
template<class Type > | |
Type | getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const |
Retrieve generic property from the base model. More... | |
template<class Type > | |
void | getBaseProperty (const word &entryName, Type &value) const |
Retrieve generic property from the base model. More... | |
template<class Type > | |
void | setBaseProperty (const word &entryName, const Type &value) |
Add generic property to the base model. More... | |
template<class Type > | |
void | getModelProperty (const word &entryName, Type &value) const |
Retrieve generic property from the sub-model. More... | |
template<class Type > | |
Type | getModelProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const |
Retrieve generic property from the sub-model. More... | |
template<class Type > | |
void | setModelProperty (const word &entryName, const Type &value) |
Add generic property to the sub-model. More... | |
void | operator= (const subModelBase &)=delete |
Disallow default bitwise assignment. More... | |
Static Public Member Functions | |
static autoPtr< CompositionModel< CloudType > > | New (const dictionary &dict, CloudType &owner) |
Selector. More... | |
Additional Inherited Members | |
Public Types inherited from CloudSubModelBase< CloudType > | |
typedef CloudType | cloudType |
Type of cloud this model was instantiated for. More... | |
Protected Member Functions inherited from subModelBase | |
bool | inLine () const |
Flag to indicate whether data is/was read in-line. More... | |
Protected Attributes inherited from CloudSubModelBase< CloudType > | |
CloudType & | owner_ |
Reference to the cloud. More... | |
Protected Attributes inherited from subModelBase | |
const word | modelName_ |
Name of the sub-model. More... | |
dictionary & | properties_ |
Reference to properties dictionary e.g. for restart. More... | |
const dictionary | dict_ |
Copy of dictionary used during construction. More... | |
const word | baseName_ |
Name of the sub-model base class. More... | |
const word | modelType_ |
Type of the sub-model. More... | |
const dictionary | coeffDict_ |
Coefficients dictionary. More... | |
Templated reacting parcel composition model class Consists of carrier species (via thermo package), and additional liquids and solids.
Definition at line 56 of file CompositionModel.H.
CompositionModel | ( | CloudType & | owner | ) |
Construct null from owner.
Definition at line 32 of file CompositionModel.C.
CompositionModel | ( | const dictionary & | dict, |
CloudType & | owner, | ||
const word & | type | ||
) |
Construct from dictionary.
Definition at line 48 of file CompositionModel.C.
CompositionModel | ( | const CompositionModel< CloudType > & | cm | ) |
Construct copy.
Definition at line 77 of file CompositionModel.C.
|
virtual |
Destructor.
Definition at line 93 of file CompositionModel.C.
TypeName | ( | "compositionModel" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
CompositionModel< CloudType > | , | ||
dictionary | , | ||
(const dictionary &dict, CloudType &owner) | , | ||
(dict, owner) | |||
) |
Declare runtime constructor selection table.
|
pure virtual |
Construct and return a clone.
Implemented in SinglePhaseMixture< CloudType >, SingleMixtureFraction< CloudType >, and NoComposition< CloudType >.
|
static |
Selector.
Definition at line 32 of file CompositionModelNew.C.
References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, and Foam::nl.
const Foam::parcelThermo & thermo |
Return the thermo database.
Definition at line 100 of file CompositionModel.C.
const Foam::fluidMulticomponentThermo & carrier |
Return the carrier components (wrapper function)
Definition at line 108 of file CompositionModel.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
Referenced by ReactingMultiphaseParcel< ParcelType >::calc(), ReactingParcel< ParcelType >::calc(), ReactingMultiphaseParcel< ParcelType >::calcDevolatilisation(), and ReactingParcel< ParcelType >::calcPhaseChange().
const Foam::liquidMixtureProperties & liquids |
Return the global (additional) liquids.
Definition at line 123 of file CompositionModel.C.
Referenced by SprayParcel< ParcelType >::calc(), SprayParcel< ParcelType >::calcAtomisation(), ReactingParcel< ParcelType >::calcPhaseChange(), and SprayParcel< ParcelType >::chi().
const Foam::solidMixtureProperties & solids |
Return the global (additional) solids.
Definition at line 131 of file CompositionModel.C.
const Foam::phasePropertiesList & phaseProps |
Return the list of phase properties.
Definition at line 139 of file CompositionModel.C.
Referenced by SingleMixtureFraction< CloudType >::SingleMixtureFraction().
Foam::label nPhase |
Return the number of phases.
Definition at line 146 of file CompositionModel.C.
const Foam::wordList & phaseTypes |
Return the list of phase type names.
If only 1 phase, return the component names of that phase
Definition at line 153 of file CompositionModel.C.
const Foam::wordList & stateLabels |
Return the list of state labels (s), (l), (g) etc.
Definition at line 168 of file CompositionModel.C.
const Foam::wordList & componentNames | ( | const label | phaseI | ) | const |
Return the list of component names for phaseI.
Definition at line 176 of file CompositionModel.C.
Foam::label carrierId | ( | const word & | cmptName, |
const bool | allowNotFound = false |
||
) | const |
Return global id of component cmptName in carrier thermo.
Definition at line 183 of file CompositionModel.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, and Foam::nl.
Foam::label localId | ( | const label | phaseI, |
const word & | cmptName, | ||
const bool | allowNotFound = false |
||
) | const |
Return local id of component cmptName in phase phaseI.
Definition at line 213 of file CompositionModel.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
Foam::label localToCarrierId | ( | const label | phaseI, |
const label | id, | ||
const bool | allowNotFound = false |
||
) | const |
Return carrier id of component given local id.
Definition at line 234 of file CompositionModel.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
Referenced by ReactingMultiphaseParcel< ParcelType >::calc(), ReactingParcel< ParcelType >::calc(), ReactingMultiphaseParcel< ParcelType >::calcDevolatilisation(), and ReactingParcel< ParcelType >::calcPhaseChange().
const Foam::scalarField & Y0 | ( | const label | phaseI | ) | const |
Return the list of phase phaseI mass fractions.
Definition at line 256 of file CompositionModel.C.
Foam::scalarField X | ( | const label | phaseI, |
const scalarField & | Y | ||
) | const |
Return the list of phase phaseI volume fractions fractions.
based on supplied mass fractions Y
Definition at line 266 of file CompositionModel.C.
References Foam::abort(), phaseProperties::carrierId(), Foam::FatalError, FatalErrorInFunction, forAll, phaseProperties::GAS, phaseProperties::LIQUID, phaseProperties::phase(), and Y.
|
pure virtual |
Return the list of mixture mass fractions.
If only 1 phase, return component fractions of that phase
Implemented in SinglePhaseMixture< CloudType >, SingleMixtureFraction< CloudType >, and NoComposition< CloudType >.
|
pure virtual |
Gas id.
Implemented in SinglePhaseMixture< CloudType >, SingleMixtureFraction< CloudType >, and NoComposition< CloudType >.
Referenced by ReactingMultiphaseParcel< ParcelType >::calc().
|
pure virtual |
Liquid id.
Implemented in SinglePhaseMixture< CloudType >, SingleMixtureFraction< CloudType >, and NoComposition< CloudType >.
Referenced by ReactingMultiphaseParcel< ParcelType >::calc().
|
pure virtual |
Solid id.
Implemented in SinglePhaseMixture< CloudType >, SingleMixtureFraction< CloudType >, and NoComposition< CloudType >.
Referenced by ReactingMultiphaseParcel< ParcelType >::calc().
|
virtual |
Return total enthalpy for the phase phaseI.
Definition at line 311 of file CompositionModel.C.
References Foam::abort(), phaseProperties::carrierId(), Foam::FatalError, FatalErrorInFunction, forAll, phaseProperties::GAS, phaseProperties::LIQUID, p, phaseProperties::phase(), phaseProperties::SOLID, Foam::T(), and Y.
|
virtual |
Return sensible enthalpy for the phase phaseI.
Definition at line 360 of file CompositionModel.C.
References Foam::abort(), phaseProperties::carrierId(), Foam::FatalError, FatalErrorInFunction, forAll, phaseProperties::GAS, phaseProperties::LIQUID, p, phaseProperties::phase(), phaseProperties::SOLID, Foam::T(), and Y.
|
virtual |
Return specific heat capacity for the phase phaseI.
Definition at line 411 of file CompositionModel.C.
References Foam::abort(), phaseProperties::carrierId(), Foam::FatalError, FatalErrorInFunction, forAll, phaseProperties::GAS, phaseProperties::LIQUID, p, phaseProperties::phase(), phaseProperties::SOLID, Foam::T(), and Y.
Referenced by ReactingParcel< ParcelType >::calc().
|
virtual |
Return latent heat for the phase phaseI.
Definition at line 461 of file CompositionModel.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, phaseProperties::GAS, phaseProperties::LIQUID, p, phaseProperties::phase(), phaseProperties::SOLID, Foam::T(), WarningInFunction, and Y.