Public Member Functions | Static Public Member Functions | List of all members
CompositionModel< CloudType > Class Template Referenceabstract

Templated reacting parcel composition model class Consists of carrier species (via thermo package), and additional liquids and solids. More...

Inheritance diagram for CompositionModel< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for CompositionModel< CloudType >:
Collaboration graph
[legend]

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 SLGThermothermo () const
 Return the thermo database. More...
 
const basicSpecieMixturecarrier () const
 Return the carrier components (wrapper function) More...
 
const liquidMixturePropertiesliquids () const
 Return the global (additional) liquids. More...
 
const solidMixturePropertiessolids () const
 Return the global (additional) solids. More...
 
const phasePropertiesListphaseProps () const
 Return the list of phase properties. More...
 
label nPhase () const
 Return the number of phases. More...
 
const wordListphaseTypes () const
 Return the list of phase type names. More...
 
const wordListstateLabels () const
 Return the list of state labels (s), (l), (g) etc. More...
 
const wordListcomponentNames (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 scalarFieldY0 (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 scalarFieldYMixture0 () 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 H (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 Hc (const label phaseI, const scalarField &Y, const scalar p, const scalar T) const
 Return chemical 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 caoacity 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)
 Construct as copy. More...
 
virtual ~CloudSubModelBase ()
 Destructor. More...
 
const CloudTypeowner () const
 Return const access to the owner cloud. More...
 
virtual bool outputTime () const
 Flag to indicate when to write a property. More...
 
CloudTypeowner ()
 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)
 Construct as copy. More...
 
virtual ~subModelBase ()
 Destructor. More...
 
const wordmodelName () const
 Return const access to the name of the sub-model. More...
 
const dictionarydict () const
 Return const access to the cloud dictionary. More...
 
const wordbaseName () const
 Return const access to the base name of the sub-model. More...
 
const wordmodelType () const
 Return const access to the sub-model type. More...
 
const dictionarycoeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionaryproperties () 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 bool active () const
 Return the model 'active' status - default active = true. More...
 
virtual void cacheFields (const bool store)
 Cache dependant 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...
 

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 >
CloudTypeowner_
 Reference to the cloud. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 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...
 

Detailed Description

template<class CloudType>
class Foam::CompositionModel< CloudType >

Templated reacting parcel composition model class Consists of carrier species (via thermo package), and additional liquids and solids.

Source files

Definition at line 52 of file ReactingCloud.H.

Constructor & Destructor Documentation

Construct null from owner.

Definition at line 31 of file CompositionModel.C.

Referenced by CompositionModel< CloudType >::CompositionModel().

Here is the caller graph for this function:

CompositionModel ( const dictionary dict,
CloudType owner,
const word type 
)

Construct from dictionary.

Definition at line 41 of file CompositionModel.C.

References CompositionModel< CloudType >::CompositionModel().

Here is the call graph for this function:

Construct copy.

Definition at line 61 of file CompositionModel.C.

~CompositionModel ( )
virtual

Destructor.

Definition at line 74 of file CompositionModel.C.

Member Function Documentation

TypeName ( "compositionModel"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
CompositionModel< CloudType ,
dictionary  ,
( const dictionary &dict, CloudType &owner ,
(dict, owner  
)

Declare runtime constructor selection table.

virtual autoPtr<CompositionModel<CloudType> > clone ( ) const
pure virtual
Foam::autoPtr< Foam::CompositionModel< CloudType > > New ( const dictionary dict,
CloudType owner 
)
static

Selector.

Definition at line 33 of file CompositionModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), and Foam::nl.

Here is the call graph for this function:

const Foam::SLGThermo & thermo ( ) const

Return the thermo database.

Definition at line 81 of file CompositionModel.C.

const Foam::basicSpecieMixture & carrier ( ) const

Return the carrier components (wrapper function)

Definition at line 89 of file CompositionModel.C.

References SLGThermo::carrier().

Referenced by ReactingParcel< ParcelType >::calc(), ReactingMultiphaseParcel< ParcelType >::calc(), ReactingMultiphaseParcel< ParcelType >::calcDevolatilisation(), and ReactingParcel< ParcelType >::calcPhaseChange().

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::liquidMixtureProperties & liquids ( ) const

Return the global (additional) liquids.

Definition at line 97 of file CompositionModel.C.

References SLGThermo::liquids().

Referenced by SprayParcel< ParcelType >::calc(), SprayParcel< ParcelType >::calcAtomization(), ReactingParcel< ParcelType >::calcPhaseChange(), and SprayParcel< ParcelType >::chi().

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::solidMixtureProperties & solids ( ) const

Return the global (additional) solids.

Definition at line 105 of file CompositionModel.C.

References SLGThermo::solids().

Here is the call graph for this function:

const Foam::phasePropertiesList & phaseProps ( ) const

Return the list of phase properties.

Definition at line 113 of file CompositionModel.C.

Foam::label nPhase ( ) const

Return the number of phases.

Definition at line 120 of file CompositionModel.C.

References phasePropertiesList::size().

Here is the call graph for this function:

const Foam::wordList & phaseTypes ( ) const

Return the list of phase type names.

If only 1 phase, return the component names of that phase

Definition at line 127 of file CompositionModel.C.

References phasePropertiesList::phaseTypes(), and phasePropertiesList::size().

Here is the call graph for this function:

const Foam::wordList & stateLabels ( ) const

Return the list of state labels (s), (l), (g) etc.

Definition at line 142 of file CompositionModel.C.

References phasePropertiesList::stateLabels().

Here is the call graph for this function:

const Foam::wordList & componentNames ( const label  phaseI) const

Return the list of component names for phaseI.

Definition at line 150 of file CompositionModel.C.

References CompositionModel< CloudType >::carrierId(), and phasei.

Here is the call graph for this function:

Foam::label carrierId ( const word cmptName,
const bool  allowNotFound = false 
) const

Return global id of component cmptName in carrier thermo.

Definition at line 158 of file CompositionModel.C.

References Foam::abort(), SLGThermo::carrier(), SLGThermo::carrierId(), Foam::FatalError, FatalErrorIn, CompositionModel< CloudType >::localId(), Foam::nl, and basicMultiComponentMixture::species().

Referenced by CompositionModel< CloudType >::componentNames().

Here is the call graph for this function:

Here is the caller graph for this function:

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 186 of file CompositionModel.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, CompositionModel< CloudType >::localToCarrierId(), and phasei.

Referenced by CompositionModel< CloudType >::carrierId().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label localToCarrierId ( const label  phaseI,
const label  id,
const bool  allowNotFound = false 
) const
const Foam::scalarField & Y0 ( const label  phaseI) const

Return the list of phase phaseI mass fractions.

Definition at line 244 of file CompositionModel.C.

References phasei, and CompositionModel< CloudType >::X().

Referenced by CompositionModel< CloudType >::localToCarrierId().

Here is the call graph for this function:

Here is the caller graph for this function:

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 254 of file CompositionModel.C.

References Foam::abort(), SLGThermo::carrier(), phaseProperties::carrierIds(), Foam::FatalError, FatalErrorIn, forAll, phaseProperties::GAS, CompositionModel< CloudType >::H(), phaseProperties::LIQUID, SLGThermo::liquids(), phaseProperties::phase(), phasei, liquidMixtureProperties::properties(), List< T >::size(), and basicSpecieMixture::W().

Referenced by CompositionModel< CloudType >::Y0().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const scalarField& YMixture0 ( ) const
pure virtual

Return the list of mixture mass fractions.

If only 1 phase, return component fractions of that phase

Implemented in SingleMixtureFraction< CloudType >, SinglePhaseMixture< CloudType >, and NoComposition< CloudType >.

virtual label idGas ( ) const
pure virtual

Gas id.

Implemented in SingleMixtureFraction< CloudType >, SinglePhaseMixture< CloudType >, and NoComposition< CloudType >.

Referenced by ReactingMultiphaseParcel< ParcelType >::calc().

Here is the caller graph for this function:

virtual label idLiquid ( ) const
pure virtual

Liquid id.

Implemented in SingleMixtureFraction< CloudType >, SinglePhaseMixture< CloudType >, and NoComposition< CloudType >.

Referenced by ReactingMultiphaseParcel< ParcelType >::calc().

Here is the caller graph for this function:

virtual label idSolid ( ) const
pure virtual

Solid id.

Implemented in SingleMixtureFraction< CloudType >, SinglePhaseMixture< CloudType >, and NoComposition< CloudType >.

Referenced by ReactingMultiphaseParcel< ParcelType >::calc().

Here is the caller graph for this function:

Foam::scalar H ( const label  phaseI,
const scalarField Y,
const scalar  p,
const scalar  T 
) const
virtual
Foam::scalar Hs ( const label  phaseI,
const scalarField Y,
const scalar  p,
const scalar  T 
) const
virtual
Foam::scalar Hc ( const label  phaseI,
const scalarField Y,
const scalar  p,
const scalar  T 
) const
virtual
Foam::scalar Cp ( const label  phaseI,
const scalarField Y,
const scalar  p,
const scalar  T 
) const
virtual
Foam::scalar L ( const label  phaseI,
const scalarField Y,
const scalar  p,
const scalar  T 
) const
virtual

Return latent heat for the phase phaseI.

Definition at line 547 of file CompositionModel.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorIn, forAll, phaseProperties::GAS, phaseProperties::LIQUID, SLGThermo::liquids(), phaseProperties::phase(), phasei, liquidMixtureProperties::properties(), phaseProperties::SOLID, and WarningIn.

Referenced by CompositionModel< CloudType >::Cp().

Here is the call graph for this function:

Here is the caller graph for this function:


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