HeatTransferModel< CloudType > Class Template Referenceabstract

Templated class to calculate the fluid-particle heat transfer coefficients based on a specified Nusselt-number model. More...

Inheritance diagram for HeatTransferModel< CloudType >:
[legend]
Collaboration diagram for HeatTransferModel< CloudType >:
[legend]

Public Member Functions

 TypeName ("heatTransferModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, HeatTransferModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table. More...
 
void operator= (const HeatTransferModel< CloudType > &)=delete
 No copy assignment. More...
 
 HeatTransferModel (CloudType &owner)
 Construct null from owner. More...
 
 HeatTransferModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from dictionary. More...
 
 HeatTransferModel (const HeatTransferModel< CloudType > &htm)
 Copy construct. More...
 
virtual autoPtr< HeatTransferModel< CloudType > > clone () const =0
 Construct and return a clone. More...
 
virtual ~HeatTransferModel ()=default
 Destructor. More...
 
bool BirdCorrection () const noexcept
 The Bird HTC correction flag. More...
 
virtual scalar Nu (const scalar Re, const scalar Pr) const =0
 Return Nusselt number. More...
 
virtual scalar htc (const scalar dp, const scalar Re, const scalar Pr, const scalar kappa, const scalar NCpW) const
 Return heat transfer coefficient. 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 writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. 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 dependent sub-model fields. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. More...
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=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...
 
bool getModelDict (const word &entryName, dictionary &dict) const
 Retrieve dictionary, return true if set. More...
 
template<class Type >
bool 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=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...
 
virtual void write (Ostream &os) const
 Write. More...
 

Static Public Member Functions

static autoPtr< HeatTransferModel< 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::HeatTransferModel< CloudType >

Templated class to calculate the fluid-particle heat transfer coefficients based on a specified Nusselt-number model.

\[ h = \frac{\mathrm{Nu} \, \kappa}{d_p} \]

where

\( h \) = Convective heat transfer coefficient of the flow
\( \mathrm{Nu} \) = Nusselt number
\( \kappa \) = Thermal conductivity of carrier in the film
\( d_p \) = Particle diameter

Optionally, Bird-Stewart-Lightfoot correction can be applied to correct the heat transfer coefficient for evaporation:

\[ h_{corr} = h \, \frac{\beta}{ \exp(\beta) + 1 } \]

with

\[ \beta = \frac{N \, C_p \, W}{h} \]

where

\( \beta \) = Correction factor
\( N \) = Molar flux
\( C_p \) = Specific heat capacity
\( W \) = Molecular weight

Reference:

        Bird, R. B., Stewart, W. E., & Lightfoot, E. N. (1960).
        Transport phenomena.
        John Wiley & Sons., New York.
        DOI:10.1002/aic.690070245
Usage
Minimal example by using constant/<CloudProperties>:
subModels
{
    heatTransferModel    <model>;

    <model>Coeffs
    {
        BirdCorrection   true;
    }
}

where the entries mean:

Property Description Type Reqd Deflt
heatTransferModel Type name: <model> word yes -
<model>Coeffs Model properties dict cndtnl -
BirdCorrection

Flag to apply Bird-Stewart-Lightfoot's

correction to the heat transfer coefficient

bool cndtnl -

Options for the <model> entry:

      RanzMarshall   | Ranz-Marshall correlation for Nusselt number
      none           | No active model
Source files

Definition at line 187 of file HeatTransferModel.H.

Constructor & Destructor Documentation

◆ HeatTransferModel() [1/3]

Construct null from owner.

Definition at line 34 of file HeatTransferModel.C.

◆ HeatTransferModel() [2/3]

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

Construct from dictionary.

Definition at line 42 of file HeatTransferModel.C.

◆ HeatTransferModel() [3/3]

Copy construct.

Definition at line 55 of file HeatTransferModel.C.

◆ ~HeatTransferModel()

virtual ~HeatTransferModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "heatTransferModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

◆ operator=()

void operator= ( const HeatTransferModel< CloudType > &  )
delete

No copy assignment.

◆ clone()

virtual autoPtr< HeatTransferModel< CloudType > > clone ( ) const
pure virtual

Construct and return a clone.

Implemented in NoHeatTransfer< CloudType >, and RanzMarshall< CloudType >.

◆ New()

Foam::autoPtr< Foam::HeatTransferModel< CloudType > > New ( const dictionary dict,
CloudType owner 
)
static

Selector.

Definition at line 35 of file HeatTransferModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::Info.

Here is the call graph for this function:

◆ BirdCorrection()

bool BirdCorrection ( ) const
inlinenoexcept

The Bird HTC correction flag.

Definition at line 257 of file HeatTransferModel.H.

◆ Nu()

virtual scalar Nu ( const scalar  Re,
const scalar  Pr 
) const
pure virtual

Return Nusselt number.

Implemented in NoHeatTransfer< CloudType >, and RanzMarshall< CloudType >.

◆ htc()

Foam::scalar htc ( const scalar  dp,
const scalar  Re,
const scalar  Pr,
const scalar  kappa,
const scalar  NCpW 
) const
virtual

Return heat transfer coefficient.

Definition at line 68 of file HeatTransferModel.C.

References Foam::exp(), Foam::mag(), Foam::min(), Pr(), and Foam::Re().

Here is the call graph for this function:

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