heatTransferCoeffModel Class Referenceabstract

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

Inheritance diagram for heatTransferCoeffModel:
[legend]
Collaboration diagram for heatTransferCoeffModel:
[legend]

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 fvMeshmesh () const
 The mesh reference. More...
 
const labelHashSetpatchSet () const
 Wall patches to process. More...
 
const wordTName () const
 Temperature name. More...
 
const wordqrName () const
 Name of radiative heat flux. More...
 
virtual bool read (const dictionary &dict)
 Read from dictionary. More...
 
virtual bool calc (volScalarField &result, const FieldField< Field, scalar > &q)
 
tmp< FieldField< Field, scalar > > q () const
 Return q boundary fields. More...
 

Static Public Member Functions

static autoPtr< heatTransferCoeffModelNew (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 fvMeshmesh_
 Mesh reference. More...
 
labelHashSet patchSet_
 Optional list of (wall) patches to process. More...
 
const word TName_
 Temperature name. More...
 
word qrName_
 Name of radiative heat flux. More...
 

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

Definition at line 104 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 124 of file heatTransferCoeffModel.C.

◆ heatTransferCoeffModel() [2/2]

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

No copy assignment.

◆ mesh()

const fvMesh& mesh ( ) const
inline

The mesh reference.

Definition at line 190 of file heatTransferCoeffModel.H.

References heatTransferCoeffModel::mesh_.

◆ patchSet()

const labelHashSet& patchSet ( ) const
inline

Wall patches to process.

Definition at line 196 of file heatTransferCoeffModel.H.

References heatTransferCoeffModel::patchSet_.

◆ TName()

const word& TName ( ) const
inline

Temperature name.

Definition at line 202 of file heatTransferCoeffModel.H.

References heatTransferCoeffModel::TName_.

◆ qrName()

const word& qrName ( ) const
inline

Name of radiative heat flux.

Definition at line 208 of file heatTransferCoeffModel.H.

References heatTransferCoeffModel::qrName_.

◆ read()

bool read ( const dictionary dict)
virtual

Read from dictionary.

Reimplemented in ReynoldsAnalogy, fixedReferenceTemperature, and localReferenceTemperature.

Definition at line 139 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 150 of file heatTransferCoeffModel.C.

◆ q()

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

Mesh reference.

Definition at line 111 of file heatTransferCoeffModel.H.

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

◆ patchSet_

labelHashSet patchSet_
protected

Optional list of (wall) patches to process.

Definition at line 114 of file heatTransferCoeffModel.H.

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

◆ TName_

const word TName_
protected

Temperature name.

Definition at line 117 of file heatTransferCoeffModel.H.

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

◆ qrName_

word qrName_
protected

Name of radiative heat flux.

Definition at line 120 of file heatTransferCoeffModel.H.

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


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