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

#include <HeatTransferModel.H>

Inheritance diagram for HeatTransferModel< CloudType >:

[legend]

Collaboration diagram for HeatTransferModel< CloudType >:

[legend]

Public Member Functions
	TypeName ("heatTransferModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, HeatTransferModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table.
void	operator= (const HeatTransferModel< CloudType > &)=delete
	No copy assignment.
	HeatTransferModel (CloudType &owner)
	Construct null from owner.
	HeatTransferModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from dictionary.
	HeatTransferModel (const HeatTransferModel< CloudType > &htm)
	Copy construct.
virtual autoPtr< HeatTransferModel< CloudType > >	clone () const =0
	Construct and return a clone.
virtual	~HeatTransferModel ()=default
	Destructor.
bool	BirdCorrection () const noexcept
	The Bird HTC correction flag.
virtual scalar	Nu (const scalar Re, const scalar Pr) const =0
	Return Nusselt number.
virtual scalar	htc (const scalar dp, const scalar Re, const scalar Pr, const scalar kappa, const scalar NCpW) const
	Return heat transfer coefficient.
Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)
	Construct null from owner cloud.
	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner cloud without name.
	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner cloud with name.
	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
	Construct as copy.
virtual	~CloudSubModelBase ()=default
	Destructor.
const CloudType &	owner () const
	Return const access to the owner cloud.
virtual bool	writeTime () const
	Flag to indicate when to write a property.
virtual fileName	localPath () const
	Output directory.
CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation.
virtual void	info ()
	Write to info.
virtual void	write (Ostream &os) const
	Write to os.
Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null.
	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name.
	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name.
	subModelBase (const subModelBase &smb)
	Construct as copy.
virtual	~subModelBase ()=default
	Destructor.
const word &	modelName () const
	Return const access to the name of the sub-model.
const dictionary &	dict () const
	Return const access to the cloud dictionary.
const word &	baseName () const
	Return const access to the base name of the sub-model.
const word &	modelType () const
	Return const access to the sub-model type.
const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary.
const dictionary &	properties () const
	Return const access to the properties dictionary.
virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg.
virtual bool	active () const
	Return the model 'active' status - default active = true.
virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields.
template<class Type>
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the base model.
template<class Type>
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model.
template<class Type>
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model.
bool	getModelDict (const word &entryName, dictionary &dict) const
	Retrieve dictionary, return true if set.
template<class Type>
bool	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model.
template<class Type>
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the sub-model.
template<class Type>
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model.

Static Public Member Functions
static autoPtr< HeatTransferModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector.

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for.
Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info.
Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line.
Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud.
Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model.
dictionary &	properties_
	Reference to properties dictionary e.g. for restart.
const dictionary	dict_
	Copy of dictionary used during construction.
const word	baseName_
	Name of the sub-model base class.
const word	modelType_
	Type of the sub-model.
const dictionary	coeffDict_
	Coefficients dictionary.

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

	=	Convective heat transfer coefficient of the flow
$\mathrm{Nu}$	=	Nusselt number
$\kappa$	=	Thermal conductivity of carrier in the film
	=	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
	=	Molar flux
	=	Specific heat capacity
	=	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 183 of file HeatTransferModel.H.

Constructor & Destructor Documentation

◆ HeatTransferModel() [1/3]

template<class CloudType>

HeatTransferModel ( CloudType & owner )

Construct null from owner.

Definition at line 27 of file HeatTransferModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), and CloudSubModelBase< CloudType >::owner().

Referenced by declareRunTimeSelectionTable(), HeatTransferModel(), NoHeatTransfer< CloudType >::NoHeatTransfer(), NoHeatTransfer< CloudType >::NoHeatTransfer(), operator=(), RanzMarshall< CloudType >::RanzMarshall(), and RanzMarshall< CloudType >::RanzMarshall().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HeatTransferModel() [2/3]

template<class CloudType>

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

Construct from dictionary.

Definition at line 35 of file HeatTransferModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), subModelBase::coeffDict(), subModelBase::dict(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, and CloudSubModelBase< CloudType >::owner().

Here is the call graph for this function:

◆ HeatTransferModel() [3/3]

template<class CloudType>

HeatTransferModel ( const HeatTransferModel< CloudType > & htm )

Copy construct.

Definition at line 48 of file HeatTransferModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), and HeatTransferModel().

Here is the call graph for this function:

◆ ~HeatTransferModel()

template<class CloudType>

virtual ~HeatTransferModel ( )

virtualdefault

Destructor.

References subModelBase::dict(), and CloudSubModelBase< CloudType >::owner().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

template<class CloudType>

TypeName ( "heatTransferModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

template<class CloudType>

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

Declare runtime constructor selection table.

References subModelBase::dict(), HeatTransferModel(), and CloudSubModelBase< CloudType >::owner().

Here is the call graph for this function:

◆ operator=()

template<class CloudType>

void operator= ( const HeatTransferModel< CloudType > & )

delete

No copy assignment.

References subModelBase::dict(), HeatTransferModel(), and CloudSubModelBase< CloudType >::owner().

Here is the call graph for this function:

◆ clone()

template<class CloudType>

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

pure virtual

Construct and return a clone.

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

◆ New()

template<class CloudType>

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

static

Selector.

Definition at line 28 of file HeatTransferModelNew.C.

References subModelBase::dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, subModelBase::modelType(), and CloudSubModelBase< CloudType >::owner().

Here is the call graph for this function:

◆ BirdCorrection()

template<class CloudType>

bool BirdCorrection ( ) const

inlinenoexcept

The Bird HTC correction flag.

Definition at line 275 of file HeatTransferModel.H.

References Foam::noexcept.

◆ Nu()

template<class CloudType>

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

pure virtual

Return Nusselt number.

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

References Pr(), and Foam::Re().

Referenced by htc().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ htc()

template<class CloudType>

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 61 of file HeatTransferModel.C.

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

Referenced by htc().

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:

src/lagrangian/intermediate/clouds/Templates/ThermoCloud/ThermoCloud.H
src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/HeatTransferModel/HeatTransferModel.H
src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/HeatTransferModel/HeatTransferModel.C
src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/HeatTransferModel/HeatTransferModelNew.C

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HeatTransferModel() [1/3]

◆ HeatTransferModel() [2/3]

◆ HeatTransferModel() [3/3]

◆ ~HeatTransferModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ operator=()

◆ clone()

◆ New()

◆ BirdCorrection()

◆ Nu()

◆ htc()