Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
PhaseChangeModel< CloudType > Class Template Referenceabstract

Templated phase change model class. More...

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

Public Types

enum  enthalpyTransferType { etLatentHeat, etEnthalpyDifference }
 Enthalpy transfer type. More...
 
- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 

Public Member Functions

 TypeName ("phaseChangeModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, PhaseChangeModel, dictionary,( const dictionary &dict, CloudType &owner ),(dict, owner))
 Declare runtime constructor selection table. More...
 
 PhaseChangeModel (CloudType &owner)
 Construct null from owner. More...
 
 PhaseChangeModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from dictionary. More...
 
 PhaseChangeModel (const PhaseChangeModel< CloudType > &pcm)
 Construct copy. More...
 
virtual autoPtr< PhaseChangeModel< CloudType > > clone () const =0
 Construct and return a clone. More...
 
virtual ~PhaseChangeModel ()
 Destructor. More...
 
const enthalpyTransferTypeenthalpyTransfer () const
 Return the enthalpy transfer type enumeration. More...
 
virtual void calculate (const scalar dt, const label cellI, const scalar Re, const scalar Pr, const scalar d, const scalar nu, const scalar T, const scalar Ts, const scalar pc, const scalar Tc, const scalarField &X, scalarField &dMassPC) const =0
 Update model. More...
 
virtual scalar dh (const label idc, const label idl, const scalar p, const scalar T) const
 Return the enthalpy per unit mass. More...
 
virtual scalar Tvap (const scalarField &X) const
 Return vapourisation temperature. More...
 
virtual scalar TMax (const scalar p, const scalarField &X) const
 Return maximum/limiting temperature. More...
 
void addToPhaseChangeMass (const scalar dMass)
 Add to phase change mass. More...
 
virtual void info (Ostream &os)
 Write injection info to stream. 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< PhaseChangeModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 

Static Public Attributes

static const Foam::wordList enthalpyTransferTypeNames
 Name representations of enthalpy transfer types. More...
 

Protected Member Functions

enthalpyTransferType wordToEnthalpyTransfer (const word &etName) const
 Convert word to enthalpy transfer type. More...
 
scalar Sh () const
 Sherwood number. More...
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 

Protected Attributes

enthalpyTransferType enthalpyTransfer_
 Enthalpy transfer type enumeration. More...
 
scalar dMass_
 Mass of lagrangian phase converted. 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::PhaseChangeModel< CloudType >

Templated phase change model class.

Source files

Definition at line 55 of file ReactingCloud.H.

Member Enumeration Documentation

Enthalpy transfer type.

Enumerator
etLatentHeat 
etEnthalpyDifference 

Definition at line 62 of file PhaseChangeModel.H.

Constructor & Destructor Documentation

Construct null from owner.

Definition at line 74 of file PhaseChangeModel.C.

Referenced by PhaseChangeModel< CloudType >::PhaseChangeModel(), and PhaseChangeModel< CloudType >::wordToEnthalpyTransfer().

Here is the caller graph for this function:

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

Construct from dictionary.

Definition at line 98 of file PhaseChangeModel.C.

Construct copy.

Definition at line 86 of file PhaseChangeModel.C.

References PhaseChangeModel< CloudType >::PhaseChangeModel().

Here is the call graph for this function:

~PhaseChangeModel ( )
virtual

Destructor.

Definition at line 116 of file PhaseChangeModel.C.

Member Function Documentation

Foam::PhaseChangeModel< CloudType >::enthalpyTransferType wordToEnthalpyTransfer ( const word etName) const
protected

Convert word to enthalpy transfer type.

Definition at line 48 of file PhaseChangeModel.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, forAll, Foam::nl, and PhaseChangeModel< CloudType >::PhaseChangeModel().

Here is the call graph for this function:

scalar Sh ( ) const
protected

Sherwood number.

Referenced by LiquidEvaporation< CloudType >::calcXc(), and LiquidEvaporationBoil< CloudType >::calcXc().

Here is the caller graph for this function:

TypeName ( "phaseChangeModel"  )

Runtime type information.

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

Declare runtime constructor selection table.

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

Selector.

Definition at line 33 of file PhaseChangeModelNew.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::PhaseChangeModel< CloudType >::enthalpyTransferType & enthalpyTransfer ( ) const

Return the enthalpy transfer type enumeration.

Definition at line 124 of file PhaseChangeModel.C.

References PhaseChangeModel< CloudType >::dh().

Here is the call graph for this function:

virtual void calculate ( const scalar  dt,
const label  cellI,
const scalar  Re,
const scalar  Pr,
const scalar  d,
const scalar  nu,
const scalar  T,
const scalar  Ts,
const scalar  pc,
const scalar  Tc,
const scalarField X,
scalarField dMassPC 
) const
pure virtual

Update model.

Implemented in LiquidEvaporationBoil< CloudType >, LiquidEvaporation< CloudType >, and NoPhaseChange< CloudType >.

Referenced by ReactingParcel< ParcelType >::calcPhaseChange().

Here is the caller graph for this function:

Foam::scalar dh ( const label  idc,
const label  idl,
const scalar  p,
const scalar  T 
) const
virtual

Return the enthalpy per unit mass.

Reimplemented in LiquidEvaporationBoil< CloudType >, and LiquidEvaporation< CloudType >.

Definition at line 132 of file PhaseChangeModel.C.

References PhaseChangeModel< CloudType >::TMax().

Referenced by ReactingParcel< ParcelType >::calcPhaseChange(), and PhaseChangeModel< CloudType >::enthalpyTransfer().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar Tvap ( const scalarField X) const
virtual

Return vapourisation temperature.

Reimplemented in LiquidEvaporationBoil< CloudType >, and LiquidEvaporation< CloudType >.

Definition at line 155 of file PhaseChangeModel.C.

Referenced by ReactingParcel< ParcelType >::calcPhaseChange().

Here is the caller graph for this function:

Foam::scalar TMax ( const scalar  p,
const scalarField X 
) const
virtual

Return maximum/limiting temperature.

Reimplemented in LiquidEvaporationBoil< CloudType >, and LiquidEvaporation< CloudType >.

Definition at line 145 of file PhaseChangeModel.C.

Referenced by ReactingParcel< ParcelType >::calcPhaseChange(), and PhaseChangeModel< CloudType >::dh().

Here is the caller graph for this function:

void addToPhaseChangeMass ( const scalar  dMass)

Add to phase change mass.

Definition at line 162 of file PhaseChangeModel.C.

Referenced by ReactingParcel< ParcelType >::calcPhaseChange().

Here is the caller graph for this function:

void info ( Ostream os)
virtual

Write injection info to stream.

Definition at line 169 of file PhaseChangeModel.C.

References Foam::Info, Foam::nl, and Foam::returnReduce().

Here is the call graph for this function:

Member Data Documentation

const Foam::wordList enthalpyTransferTypeNames
static

Name representations of enthalpy transfer types.

Definition at line 69 of file PhaseChangeModel.H.

enthalpyTransferType enthalpyTransfer_
protected

Enthalpy transfer type enumeration.

Definition at line 77 of file PhaseChangeModel.H.

scalar dMass_
protected

Mass of lagrangian phase converted.

Definition at line 83 of file PhaseChangeModel.H.


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