LiquidEvaporation< CloudType > Class Template Reference

Liquid evaporation model. More...

Inheritance diagram for LiquidEvaporation< CloudType >:
Collaboration diagram for LiquidEvaporation< CloudType >:

Public Member Functions

 TypeName ("liquidEvaporation")
 Runtime type information. More...
 
 LiquidEvaporation (const dictionary &dict, CloudType &cloud)
 Construct from dictionary. More...
 
 LiquidEvaporation (const LiquidEvaporation< CloudType > &pcm)
 Construct copy. More...
 
virtual autoPtr< PhaseChangeModel< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~LiquidEvaporation ()
 Destructor. 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
 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...
 
- Public Member Functions inherited from PhaseChangeModel< CloudType >
 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 ~PhaseChangeModel ()
 Destructor. More...
 
const enthalpyTransferTypeenthalpyTransfer () const
 Return the enthalpy transfer type enumeration. 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 CloudTypeowner () const
 Return const access to the owner cloud. More...
 
virtual bool writeTime () 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)
 Copy constructor. 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 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...
 

Protected Member Functions

scalar Sh (const scalar Re, const scalar Sc) const
 Sherwood number as a function of Reynolds and Schmidt numbers. More...
 
tmp< scalarFieldcalcXc (const label celli) const
 Calculate the carrier phase component volume fractions at celli. More...
 
- Protected Member Functions inherited from PhaseChangeModel< CloudType >
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

const liquidMixturePropertiesliquids_
 Global liquid properties data. More...
 
List< wordactiveLiquids_
 List of active liquid names. More...
 
List< labelliqToCarrierMap_
 Mapping between liquid and carrier species. More...
 
List< labelliqToLiqMap_
 Mapping between local and global liquid species. More...
 
- Protected Attributes inherited from PhaseChangeModel< CloudType >
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...
 

Additional Inherited Members

- Public Types inherited from PhaseChangeModel< CloudType >
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...
 
- Static Public Member Functions inherited from PhaseChangeModel< CloudType >
static autoPtr< PhaseChangeModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 
- Static Public Attributes inherited from PhaseChangeModel< CloudType >
static const Foam::wordList enthalpyTransferTypeNames
 Name representations of enthalpy transfer types. More...
 

Detailed Description

template<class CloudType>
class Foam::LiquidEvaporation< CloudType >

Liquid evaporation model.

- uses ideal gas assumption

Definition at line 47 of file LiquidEvaporation.H.

Constructor & Destructor Documentation

◆ LiquidEvaporation() [1/2]

LiquidEvaporation ( const dictionary dict,
CloudType cloud 
)

Construct from dictionary.

Definition at line 68 of file LiquidEvaporation.C.

References Foam::endl(), forAll, Foam::Info, Foam::nl, and WarningInFunction.

Referenced by LiquidEvaporation< CloudType >::Sh().

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

◆ LiquidEvaporation() [2/2]

Construct copy.

Definition at line 110 of file LiquidEvaporation.C.

◆ ~LiquidEvaporation()

~LiquidEvaporation ( )
virtual

Destructor.

Definition at line 125 of file LiquidEvaporation.C.

References LiquidEvaporation< CloudType >::calculate().

Referenced by LiquidEvaporation< CloudType >::clone().

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

Member Function Documentation

◆ Sh()

Foam::scalar Sh ( const scalar  Re,
const scalar  Sc 
) const
protected

Sherwood number as a function of Reynolds and Schmidt numbers.

Definition at line 55 of file LiquidEvaporation.C.

References Foam::cbrt(), LiquidEvaporation< CloudType >::LiquidEvaporation(), and Foam::sqrt().

Here is the call graph for this function:

◆ calcXc()

Foam::tmp< Foam::scalarField > calcXc ( const label  celli) const
protected

Calculate the carrier phase component volume fractions at celli.

Definition at line 36 of file LiquidEvaporation.C.

References forAll, PhaseChangeModel< CloudType >::Sh(), Foam::sum(), thermo, and Y.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "liquidEvaporation"  )

Runtime type information.

◆ clone()

◆ calculate()

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
virtual

◆ dh()

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

Return the enthalpy per unit mass.

Reimplemented from PhaseChangeModel< CloudType >.

Definition at line 213 of file LiquidEvaporation.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, subModelBase::properties(), and LiquidEvaporation< CloudType >::Tvap().

Referenced by LiquidEvaporation< CloudType >::calculate(), and LiquidEvaporation< CloudType >::clone().

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

◆ Tvap()

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

Return vapourisation temperature.

Reimplemented from PhaseChangeModel< CloudType >.

Definition at line 251 of file LiquidEvaporation.C.

References LiquidEvaporation< CloudType >::TMax().

Referenced by LiquidEvaporation< CloudType >::clone(), and LiquidEvaporation< CloudType >::dh().

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

◆ TMax()

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

Return maximum/limiting temperature.

Reimplemented from PhaseChangeModel< CloudType >.

Definition at line 261 of file LiquidEvaporation.C.

Referenced by LiquidEvaporation< CloudType >::clone(), and LiquidEvaporation< CloudType >::Tvap().

Here is the caller graph for this function:

Member Data Documentation

◆ liquids_

const liquidMixtureProperties& liquids_
protected

Global liquid properties data.

Definition at line 56 of file LiquidEvaporation.H.

◆ activeLiquids_

List<word> activeLiquids_
protected

List of active liquid names.

Definition at line 59 of file LiquidEvaporation.H.

◆ liqToCarrierMap_

List<label> liqToCarrierMap_
protected

Mapping between liquid and carrier species.

Definition at line 62 of file LiquidEvaporation.H.

◆ liqToLiqMap_

List<label> liqToLiqMap_
protected

Mapping between local and global liquid species.

Definition at line 65 of file LiquidEvaporation.H.


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