Templated heat transfer model class. More...

Inheritance diagram for HeatTransferModel< CloudType >:

[legend]

Collaboration diagram for HeatTransferModel< CloudType >:

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...

	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)
	Construct copy. More...

virtual autoPtr< HeatTransferModel< CloudType > >	clone () const =0
	Construct and return a clone. More...

virtual	~HeatTransferModel ()
	Destructor. More...

const Switch &	BirdCorrection () const
	Return the Bird htc correction flag. More...

virtual scalar	Nu (const scalar Re, const scalar Pr) const =0
	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)
	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 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...

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 >
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...

Detailed Description

template<class CloudType>
class Foam::HeatTransferModel< CloudType >

Templated heat transfer model class.

Source files

Definition at line 53 of file ThermoCloud.H.

Constructor & Destructor Documentation

◆ HeatTransferModel() [1/3]

HeatTransferModel ( CloudType & owner )

Construct null from owner.

Definition at line 31 of file HeatTransferModel.C.

Referenced by HeatTransferModel< Foam::ThermoCloud< CloudType > >::HeatTransferModel().

Here is the caller graph for this function:

◆ HeatTransferModel() [2/3]

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

Construct from dictionary.

Definition at line 40 of file HeatTransferModel.C.

◆ HeatTransferModel() [3/3]

HeatTransferModel ( const HeatTransferModel< CloudType > & htm )

Construct copy.

Definition at line 53 of file HeatTransferModel.C.

◆ ~HeatTransferModel()

~HeatTransferModel ( )

virtual

Destructor.

Definition at line 65 of file HeatTransferModel.C.

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.

◆ clone()

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

pure virtual

Construct and return a clone.

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

◆ New()

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

static

Selector.

Definition at line 33 of file HeatTransferModelNew.C.

◆ BirdCorrection()

const Foam::Switch & BirdCorrection ( ) const

Return the Bird htc correction flag.

Definition at line 72 of file HeatTransferModel.C.

◆ Nu()

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

pure virtual

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

Referenced by HeatTransferModel< Foam::ThermoCloud< CloudType > >::BirdCorrection().