Templated phase change model class. More...
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 enthalpyTransferType & | enthalpyTransfer () const |
Return the enthalpy transfer type enumeration. More... | |
virtual void | calculate (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar dt, 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) | |
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< 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 > | |
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 phase change model class.
Definition at line 53 of file PhaseChangeModel.H.
enum enthalpyTransferType |
Enthalpy transfer type.
Enumerator | |
---|---|
etLatentHeat | |
etEnthalpyDifference |
Definition at line 62 of file PhaseChangeModel.H.
PhaseChangeModel | ( | CloudType & | owner | ) |
Construct null from owner.
Definition at line 70 of file PhaseChangeModel.C.
PhaseChangeModel | ( | const dictionary & | dict, |
CloudType & | owner, | ||
const word & | type | ||
) |
Construct from dictionary.
Definition at line 94 of file PhaseChangeModel.C.
PhaseChangeModel | ( | const PhaseChangeModel< CloudType > & | pcm | ) |
Construct copy.
Definition at line 82 of file PhaseChangeModel.C.
|
virtual |
Destructor.
Definition at line 113 of file PhaseChangeModel.C.
|
protected |
Convert word to enthalpy transfer type.
Definition at line 48 of file PhaseChangeModel.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, and Foam::nl.
|
protected |
Sherwood number.
TypeName | ( | "phaseChangeModel" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
PhaseChangeModel< CloudType > | , | ||
dictionary | , | ||
(const dictionary &dict, CloudType &owner) | , | ||
(dict, owner) | |||
) |
Declare runtime constructor selection table.
|
pure virtual |
Construct and return a clone.
Implemented in NoPhaseChange< CloudType >, LiquidEvaporationBoil< CloudType >, and LiquidEvaporation< CloudType >.
|
static |
Selector.
Definition at line 32 of file PhaseChangeModelNew.C.
References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, and Foam::nl.
const Foam::PhaseChangeModel< CloudType >::enthalpyTransferType & enthalpyTransfer |
Return the enthalpy transfer type enumeration.
Definition at line 121 of file PhaseChangeModel.C.
|
pure virtual |
Update model.
Implemented in NoPhaseChange< CloudType >, LiquidEvaporationBoil< CloudType >, and LiquidEvaporation< CloudType >.
Referenced by ReactingParcel< ParcelType >::calcPhaseChange().
Return the enthalpy per unit mass.
Reimplemented in LiquidEvaporationBoil< CloudType >, and LiquidEvaporation< CloudType >.
Definition at line 128 of file PhaseChangeModel.C.
Referenced by ReactingParcel< ParcelType >::calcPhaseChange().
|
virtual |
Return vapourisation temperature.
Reimplemented in LiquidEvaporationBoil< CloudType >, and LiquidEvaporation< CloudType >.
Definition at line 152 of file PhaseChangeModel.C.
Referenced by ReactingParcel< ParcelType >::calcPhaseChange().
|
virtual |
Return maximum/limiting temperature.
Reimplemented in LiquidEvaporationBoil< CloudType >, and LiquidEvaporation< CloudType >.
Definition at line 141 of file PhaseChangeModel.C.
Referenced by ReactingParcel< ParcelType >::calcPhaseChange().
void addToPhaseChangeMass | ( | const scalar | dMass | ) |
Add to phase change mass.
Definition at line 159 of file PhaseChangeModel.C.
Referenced by ReactingParcel< ParcelType >::calcPhaseChange().
|
virtual |
Write injection info to stream.
Reimplemented in NoPhaseChange< CloudType >.
Definition at line 166 of file PhaseChangeModel.C.
References Foam::Info, Foam::nl, and Foam::returnReduce().
|
static |
Name representations of enthalpy transfer types.
Definition at line 69 of file PhaseChangeModel.H.
|
protected |
Enthalpy transfer type enumeration.
Definition at line 77 of file PhaseChangeModel.H.
|
protected |
Mass of lagrangian phase converted.
Definition at line 83 of file PhaseChangeModel.H.