A base class for heat transfer coefficient models. More...

#include <heatTransferCoeffModel.H>

Inheritance diagram for heatTransferCoeffModel:

[legend]

Collaboration diagram for heatTransferCoeffModel:

[legend]

Public Member Functions
	TypeName ("heatTransferCoeffModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, heatTransferCoeffModel, dictionary,(const dictionary &dict, const fvMesh &mesh, const word &TName),(dict, mesh, TName))
	heatTransferCoeffModel (const dictionary &dict, const fvMesh &mesh, const word &TName)
	Construct from components.
	heatTransferCoeffModel (const heatTransferCoeffModel &)=delete
	No copy construct.
void	operator= (const heatTransferCoeffModel &)=delete
	No copy assignment.
virtual	~heatTransferCoeffModel ()=default
	Destructor.
const fvMesh &	mesh () const noexcept
	Return const reference to the mesh.
const labelList &	patchIDs () const noexcept
	Return const reference to wall patches to process.
const word &	TName () const noexcept
	Return const reference to name of temperature field.
const word &	qrName () const noexcept
	Return const reference to name of radiative heat-flux field.
tmp< FieldField< Field, scalar > >	q () const
	Return boundary fields of heat-flux field.
virtual bool	calc (volScalarField &result, const FieldField< Field, scalar > &q)
	Calculate the heat transfer coefficient field and return true if successful.
virtual bool	read (const dictionary &dict)
	Read the function-object dictionary.

Static Public Member Functions
static autoPtr< heatTransferCoeffModel >	New (const dictionary &dict, const fvMesh &mesh, const word &TName)
	Return a reference to the selected heat transfer coefficient model.

Protected Member Functions
virtual void	htc (volScalarField &htc, const FieldField< Field, scalar > &q)=0
	Set the heat transfer coefficient.

Protected Attributes
const fvMesh &	mesh_
	Const reference to the mesh.
labelList	patchIDs_
	List of (wall) patches to process (selected by name).
const word	TName_
	Name of temperature field.
word	qrName_
	Name of radiative heat flux field.

Detailed Description

A base class for heat transfer coefficient models.

Source files

Definition at line 57 of file heatTransferCoeffModel.H.

Constructor & Destructor Documentation

◆ heatTransferCoeffModel() [1/2]

heatTransferCoeffModel	(	const dictionary &	dict,
		const fvMesh &	mesh,
		const word &	TName )

Construct from components.

Definition at line 38 of file heatTransferCoeffModel.C.

References dict, mesh(), mesh_, qrName_, TName(), and TName_.

Referenced by declareRunTimeSelectionTable(), faceZoneReferenceTemperature::faceZoneReferenceTemperature(), fixedReferenceTemperature::fixedReferenceTemperature(), heatTransferCoeffModel(), localReferenceTemperature::localReferenceTemperature(), operator=(), and ReynoldsAnalogy::ReynoldsAnalogy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ heatTransferCoeffModel() [2/2]

heatTransferCoeffModel ( const heatTransferCoeffModel & )

delete

No copy construct.

References heatTransferCoeffModel().

Here is the call graph for this function:

◆ ~heatTransferCoeffModel()

virtual ~heatTransferCoeffModel ( )

virtualdefault

Destructor.

Member Function Documentation

◆ htc()

virtual void htc	(	volScalarField &	htc,
		const FieldField< Field, scalar > &	q )

protectedpure virtual

Set the heat transfer coefficient.

Implemented in fixedReferenceTemperature, localReferenceTemperature, and ReynoldsAnalogy.

References htc(), and q().

Referenced by calc(), and htc().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "heatTransferCoeffModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		heatTransferCoeffModel	,
		dictionary	,
		(const dictionary &dict, const fvMesh &mesh, const word &TName)	,
		(dict, mesh, TName)	)

References dict, heatTransferCoeffModel(), mesh(), and TName().

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::heatTransferCoeffModel > New	(	const dictionary &	dict,
		const fvMesh &	mesh,
		const word &	TName )

static

Return a reference to the selected heat transfer coefficient model.

Definition at line 27 of file heatTransferCoeffModelNew.C.

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

Here is the call graph for this function:

◆ operator=()

void operator= ( const heatTransferCoeffModel & )

delete

No copy assignment.

References heatTransferCoeffModel().

Here is the call graph for this function:

◆ mesh()

const fvMesh & mesh ( ) const

inlinenoexcept

Return const reference to the mesh.

Definition at line 169 of file heatTransferCoeffModel.H.

References mesh_, and Foam::noexcept.

Referenced by declareRunTimeSelectionTable(), faceZoneReferenceTemperature::faceZoneReferenceTemperature(), fixedReferenceTemperature::fixedReferenceTemperature(), heatTransferCoeffModel(), localReferenceTemperature::localReferenceTemperature(), New(), ReynoldsAnalogy::ReynoldsAnalogy(), faceZoneReferenceTemperature::TypeName(), fixedReferenceTemperature::TypeName(), localReferenceTemperature::TypeName(), and ReynoldsAnalogy::TypeName().

Here is the caller graph for this function:

◆ patchIDs()

const labelList & patchIDs ( ) const

inlinenoexcept

Return const reference to wall patches to process.

Definition at line 174 of file heatTransferCoeffModel.H.

References Foam::noexcept, and patchIDs_.

◆ TName()

const word & TName ( ) const

inlinenoexcept

Return const reference to name of temperature field.

Definition at line 179 of file heatTransferCoeffModel.H.

References Foam::noexcept, and TName_.

Referenced by declareRunTimeSelectionTable(), faceZoneReferenceTemperature::faceZoneReferenceTemperature(), fixedReferenceTemperature::fixedReferenceTemperature(), heatTransferCoeffModel(), localReferenceTemperature::localReferenceTemperature(), New(), ReynoldsAnalogy::ReynoldsAnalogy(), faceZoneReferenceTemperature::TypeName(), fixedReferenceTemperature::TypeName(), localReferenceTemperature::TypeName(), and ReynoldsAnalogy::TypeName().

Here is the caller graph for this function:

◆ qrName()

const word & qrName ( ) const

inlinenoexcept

Return const reference to name of radiative heat-flux field.

Definition at line 184 of file heatTransferCoeffModel.H.

References Foam::noexcept, and qrName_.

◆ q()

Foam::tmp< Foam::FieldField< Foam::Field, Foam::scalar > > q ( ) const

Return boundary fields of heat-flux field.

Definition at line 54 of file heatTransferCoeffModel.C.

References alpha, alphaEff(), basicThermo::dictName, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, he, mesh_, Foam::New(), Foam::nl, patchIDs_, q(), qrName_, Foam::T(), TName_, turb, and Foam::Zero.

Referenced by calc(), htc(), fixedReferenceTemperature::htc(), localReferenceTemperature::htc(), ReynoldsAnalogy::htc(), and q().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calc()

bool calc	(	volScalarField &	result,
		const FieldField< Field, scalar > &	q )

virtual

Calculate the heat transfer coefficient field and return true if successful.

Definition at line 129 of file heatTransferCoeffModel.C.

References htc(), and q().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read the function-object dictionary.

Reimplemented in faceZoneReferenceTemperature, fixedReferenceTemperature, localReferenceTemperature, and ReynoldsAnalogy.

Definition at line 141 of file heatTransferCoeffModel.C.

References dict, mesh_, patchIDs_, pbm, and qrName_.

Referenced by faceZoneReferenceTemperature::read(), fixedReferenceTemperature::read(), localReferenceTemperature::read(), and ReynoldsAnalogy::read().

Here is the caller graph for this function:

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Const reference to the mesh.

Definition at line 66 of file heatTransferCoeffModel.H.

Referenced by ReynoldsAnalogy::Cf(), ReynoldsAnalogy::Cp(), ReynoldsAnalogy::devReff(), heatTransferCoeffModel(), fixedReferenceTemperature::htc(), localReferenceTemperature::htc(), mesh(), q(), read(), and ReynoldsAnalogy::rho().

◆ patchIDs_

labelList patchIDs_

protected

List of (wall) patches to process (selected by name).

Definition at line 71 of file heatTransferCoeffModel.H.

Referenced by ReynoldsAnalogy::Cf(), fixedReferenceTemperature::htc(), localReferenceTemperature::htc(), ReynoldsAnalogy::htc(), patchIDs(), q(), and read().

◆ TName_

const word TName_

protected

Name of temperature field.

Definition at line 76 of file heatTransferCoeffModel.H.

Referenced by heatTransferCoeffModel(), fixedReferenceTemperature::htc(), localReferenceTemperature::htc(), q(), and TName().

◆ qrName_

word qrName_

protected

Name of radiative heat flux field.

Definition at line 81 of file heatTransferCoeffModel.H.

Referenced by heatTransferCoeffModel(), q(), qrName(), and read().

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

src/functionObjects/field/heatTransferCoeff/heatTransferCoeffModels/heatTransferCoeffModel/heatTransferCoeffModel.H
src/functionObjects/field/heatTransferCoeff/heatTransferCoeffModels/heatTransferCoeffModel/heatTransferCoeffModel.C
src/functionObjects/field/heatTransferCoeff/heatTransferCoeffModels/heatTransferCoeffModel/heatTransferCoeffModelNew.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ heatTransferCoeffModel() [1/2]

◆ heatTransferCoeffModel() [2/2]

◆ ~heatTransferCoeffModel()

Member Function Documentation

◆ htc()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ operator=()

◆ mesh()

◆ patchIDs()

◆ TName()

◆ qrName()

◆ q()

◆ calc()

◆ read()

Member Data Documentation

◆ mesh_

◆ patchIDs_

◆ TName_

◆ qrName_