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

Inheritance diagram for heatTransferCoeffModel:

[legend]

Collaboration diagram for heatTransferCoeffModel:

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

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

	heatTransferCoeffModel (const heatTransferCoeffModel &)=delete
	No copy construct. More...

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

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

const fvMesh &	mesh () const noexcept
	Return const reference to the mesh. More...

const labelList &	patchIDs () const noexcept
	Return const reference to wall patches to process. More...

const word &	TName () const noexcept
	Return const reference to name of temperature field. More...

const word &	qrName () const noexcept
	Return const reference to name of radiative heat-flux field. More...

tmp< FieldField< Field, scalar > >	q () const
	Return boundary fields of heat-flux field. More...

virtual bool	calc (volScalarField &result, const FieldField< Field, scalar > &q)
	Calculate the heat transfer coefficient field and return true if successful. More...

virtual bool	read (const dictionary &dict)
	Read from dictionary. More...

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

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

Protected Attributes
const fvMesh &	mesh_
	Const reference to the mesh. More...

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

const word	TName_
	Name of temperature field. More...

word	qrName_
	Name of radiative heat flux field. More...

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 39 of file heatTransferCoeffModel.C.

◆ heatTransferCoeffModel() [2/2]

heatTransferCoeffModel ( const heatTransferCoeffModel & )

delete

No copy construct.

◆ ~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 ReynoldsAnalogy, fixedReferenceTemperature, and localReferenceTemperature.

◆ TypeName()

TypeName ( "heatTransferCoeffModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ 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 28 of file heatTransferCoeffModelNew.C.

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

Referenced by heatTransferCoeffModel::q().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const heatTransferCoeffModel & )

delete

No copy assignment.

◆ mesh()

const fvMesh& mesh ( ) const

inlinenoexcept

Return const reference to the mesh.

Definition at line 169 of file heatTransferCoeffModel.H.

References heatTransferCoeffModel::mesh_.

◆ patchIDs()

const labelList& patchIDs ( ) const

inlinenoexcept

Return const reference to wall patches to process.

Definition at line 177 of file heatTransferCoeffModel.H.

References heatTransferCoeffModel::patchIDs_.

◆ TName()

const word& TName ( ) const

inlinenoexcept

Return const reference to name of temperature field.

Definition at line 185 of file heatTransferCoeffModel.H.

References heatTransferCoeffModel::TName_.

◆ qrName()

const word& qrName ( ) const

inlinenoexcept

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

Definition at line 193 of file heatTransferCoeffModel.H.

References heatTransferCoeffModel::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 Foam::constant::atomic::alpha, alphaEff(), objectRegistry::cfindObject(), dictionary::dictName(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, objectRegistry::foundObject(), he, objectRegistry::lookupObject(), heatTransferCoeffModel::mesh_, heatTransferCoeffModel::New(), Foam::nl, heatTransferCoeffModel::patchIDs_, heatTransferCoeffModel::qrName_, Foam::T(), heatTransferCoeffModel::TName_, turb, and Foam::Zero.

Here is the call 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 130 of file heatTransferCoeffModel.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Read from dictionary.

Reimplemented in ReynoldsAnalogy, faceZoneReferenceTemperature, fixedReferenceTemperature, and localReferenceTemperature.

Definition at line 141 of file heatTransferCoeffModel.C.

References dict, dictionary::get(), polyBoundaryMesh::patchSet(), pbm, dictionary::readIfPresent(), and HashTable< T, Key, Hash >::sortedToc().

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

Here is the call graph for this function:

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 heatTransferCoeffModel::mesh(), heatTransferCoeffModel::q(), 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 heatTransferCoeffModel::patchIDs(), and heatTransferCoeffModel::q().

◆ TName_

const word TName_

protected

Name of temperature field.

Definition at line 76 of file heatTransferCoeffModel.H.

Referenced by heatTransferCoeffModel::q(), and heatTransferCoeffModel::TName().

◆ qrName_

word qrName_

protected

Name of radiative heat flux field.

Definition at line 81 of file heatTransferCoeffModel.H.

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

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_