heatTransferCoeffModel Class Reference

An abstract base class for heat transfer coeffcient models. More...

Inheritance diagram for heatTransferCoeffModel:

Collaboration diagram for heatTransferCoeffModel:

Public Member Functions
	TypeName ("heatTransferCoeffModel")
	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)
	heatTransferCoeffModel (const heatTransferCoeffModel &)=delete
void	operator= (const heatTransferCoeffModel &)=delete
virtual	~heatTransferCoeffModel ()=default
const fvMesh &	mesh () const
const labelHashSet &	patchSet () const
const word &	TName () const
const word &	qrName () const
virtual bool	read (const dictionary &dict)
virtual bool	calc (volScalarField &result, const FieldField< Field, scalar > &q)
tmp< FieldField< Field, scalar > >	q () const

Static Public Member Functions
static autoPtr< heatTransferCoeffModel >	New (const dictionary &dict, const fvMesh &mesh, const word &TName)

Protected Member Functions
virtual void	htc (volScalarField &htc, const FieldField< Field, scalar > &q)=0

Protected Attributes
const fvMesh &	mesh_
labelHashSet	patchSet_
const word	TName_
word	qrName_

Detailed Description

An abstract base class for heat transfer coeffcient models.

Usage

Minimal example by using system/controlDict.functions:

heatTransferCoeff1
{
    // Mandatory and other optional entries
    ...

    // Mandatory (inherited) entries (runtime modifiable)
    patches     (<patch1> <patch2> ... <patchN>);

    // Optional (inherited) entries (runtime modifiable)
    qr          <qrName>;
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
patches	Names of operand patches	wordRes	yes	-
qr	Name of radiative heat flux	word	no	qr

Source files

• heatTransferCoeffModel.H
• heatTransferCoeffModel.C
• heatTransferCoeffModelNew.C

Definition at line 101 of file heatTransferCoeffModel.H.

Constructor & Destructor Documentation

heatTransferCoeffModel() [1/2]

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

Definition at line 117 of file heatTransferCoeffModel.C.

heatTransferCoeffModel() [2/2]

heatTransferCoeffModel ( const heatTransferCoeffModel &  )

delete

~heatTransferCoeffModel()

virtual ~heatTransferCoeffModel ( )

virtualdefault

Member Function Documentation

htc()

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

protectedpure virtual

Implemented in ReynoldsAnalogy, fixedReferenceTemperature, and localReferenceTemperature.

TypeName()

TypeName

(

"heatTransferCoeffModel"

)

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

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(), reactingEulerHtcModel::read(), heatTransferCoeff::read(), and ReynoldsAnalogy::rho().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

void operator= ( const heatTransferCoeffModel &  )

delete

mesh()

const fvMesh& mesh ( ) const

inline

Definition at line 187 of file heatTransferCoeffModel.H.

References heatTransferCoeffModel::mesh_.

patchSet()

const labelHashSet& patchSet ( ) const

inline

Definition at line 193 of file heatTransferCoeffModel.H.

References heatTransferCoeffModel::patchSet_.

TName()

const word& TName ( ) const

inline

Definition at line 199 of file heatTransferCoeffModel.H.

References heatTransferCoeffModel::TName_.

qrName()

const word& qrName ( ) const

inline

Definition at line 205 of file heatTransferCoeffModel.H.

References heatTransferCoeffModel::qrName_.

read()

bool read ( const dictionary &  dict )

virtual

Reimplemented in ReynoldsAnalogy, fixedReferenceTemperature, and localReferenceTemperature.

Definition at line 132 of file heatTransferCoeffModel.C.

References dict, dictionary::get(), and dictionary::readIfPresent().

Referenced by ReynoldsAnalogy::read().

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

Definition at line 143 of file heatTransferCoeffModel.C.

q()

Foam::tmp< Foam::FieldField< Foam::Field, Foam::scalar > > q

(

)

const

Definition at line 39 of file heatTransferCoeffModel.C.

References Foam::constant::atomic::alpha, alphaEff(), objectRegistry::cfindObject(), basicThermo::dictName, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, objectRegistry::foundObject(), he, objectRegistry::lookupObject(), heatTransferCoeffModel::mesh_, heatTransferCoeffModel::New(), Foam::nl, heatTransferCoeffModel::patchSet_, heatTransferCoeffModel::qrName_, Foam::T(), heatTransferCoeffModel::TName_, turb, and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

mesh_

const fvMesh& mesh_

protected

Definition at line 108 of file heatTransferCoeffModel.H.

Referenced by heatTransferCoeffModel::mesh(), heatTransferCoeffModel::q(), and ReynoldsAnalogy::rho().

patchSet_

labelHashSet patchSet_

protected

Definition at line 111 of file heatTransferCoeffModel.H.

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

TName_

const word TName_

protected

Definition at line 114 of file heatTransferCoeffModel.H.

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

qrName_

word qrName_

protected

Definition at line 117 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