Nusselt-number model providing an interface to the properties of HeatTransferModel without any active model. More...

Inheritance diagram for NoHeatTransfer< CloudType >:

Collaboration diagram for NoHeatTransfer< CloudType >:

Public Member Functions
	TypeName ("none")
	Runtime type information. More...

void	operator= (const NoHeatTransfer &)=delete
	No copy assignment. More...

	NoHeatTransfer (const dictionary &, CloudType &owner)
	Construct from dictionary. More...

	NoHeatTransfer (const NoHeatTransfer< CloudType > &im)
	Copy construct. More...

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

virtual	~NoHeatTransfer ()=default
	Destructor. More...

virtual bool	active () const
	Flag to indicate whether model activates heat transfer model. More...

virtual scalar	Nu (const scalar Re, const scalar Pr) const
	Return Nusselt number. More...

virtual scalar	Pr () const
	Return Prandtl number. More...

Public Member Functions inherited from HeatTransferModel< CloudType >
	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 CloudType &	owner () 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...

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

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

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for. More...

Static Public Member Functions inherited from HeatTransferModel< CloudType >
static autoPtr< HeatTransferModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector. 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::NoHeatTransfer< CloudType >

Nusselt-number model providing an interface to the properties of HeatTransferModel without any active model.

Usage

Minimal example by using constant/<CloudProperties>:

subModels
{
    heatTransferModel    none;
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`heatTransferModel`	Type name: none	word	yes	-

Source files

Definition at line 83 of file NoHeatTransfer.H.

Constructor & Destructor Documentation

◆ NoHeatTransfer() [1/2]

NoHeatTransfer	(	const dictionary &	,
		CloudType &	owner
	)

Construct from dictionary.

Definition at line 34 of file NoHeatTransfer.C.

◆ NoHeatTransfer() [2/2]

NoHeatTransfer ( const NoHeatTransfer< CloudType > & im )

Copy construct.

Definition at line 45 of file NoHeatTransfer.C.

◆ ~NoHeatTransfer()

virtual ~NoHeatTransfer ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "none" )

Runtime type information.

◆ operator=()

void operator= ( const NoHeatTransfer< CloudType > & )

delete

No copy assignment.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Implements HeatTransferModel< CloudType >.

Definition at line 108 of file NoHeatTransfer.H.

◆ active()

virtual bool active ( ) const

inlinevirtual

Flag to indicate whether model activates heat transfer model.

Reimplemented from subModelBase.

Definition at line 124 of file NoHeatTransfer.H.

◆ Nu()

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

inlinevirtual

Return Nusselt number.

Implements HeatTransferModel< CloudType >.

Definition at line 133 of file NoHeatTransfer.H.

◆ Pr()

virtual scalar Pr ( ) const

inlinevirtual

Return Prandtl number.

Definition at line 139 of file NoHeatTransfer.H.

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

src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/NoHeatTransfer/NoHeatTransfer.H
src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/NoHeatTransfer/NoHeatTransfer.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NoHeatTransfer() [1/2]

◆ NoHeatTransfer() [2/2]

◆ ~NoHeatTransfer()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ clone()

◆ active()

◆ Nu()

◆ Pr()