Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
heatTransferCoefficientModel Class Referenceabstract

Base class for heat transfer coefficient modelling used in heat transfer fvModels. More...

Inheritance diagram for heatTransferCoefficientModel:
Inheritance graph
[legend]
Collaboration diagram for heatTransferCoefficientModel:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("heatTransferCoefficientModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, heatTransferCoefficientModel, mesh,(const dictionary &dict, const fvMesh &mesh),(dict, mesh))
 
 declareRunTimeSelectionTable (autoPtr, heatTransferCoefficientModel, model,(const dictionary &dict, const interRegionModel &model),(dict, model))
 
 heatTransferCoefficientModel (const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from dictionary and mesh. More...
 
 heatTransferCoefficientModel (const word &modelType, const dictionary &dict, const interRegionModel &model)
 Construct from dictionary and model. More...
 
 heatTransferCoefficientModel (const heatTransferCoefficientModel &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~heatTransferCoefficientModel ()
 Destructor. More...
 
virtual tmp< volScalarField > htc () const =0
 Get the heat transfer coefficient. More...
 
virtual void correct ()=0
 Correct the heat transfer coefficient. More...
 
virtual bool read (const dictionary &dict)
 Read dictionary. More...
 

Static Public Member Functions

static autoPtr< heatTransferCoefficientModel > New (const dictionary &dict, const fvMesh &mesh)
 Select from dictionary and mesh. More...
 
static autoPtr< heatTransferCoefficientModel > New (const dictionary &dict, const interRegionModel &model)
 Select from dictionary and model. More...
 

Protected Attributes

const fvMesh & mesh_
 Reference to the mesh. More...
 

Detailed Description

Base class for heat transfer coefficient modelling used in heat transfer fvModels.

Source files

Definition at line 53 of file heatTransferCoefficientModel.H.

Constructor & Destructor Documentation

◆ heatTransferCoefficientModel() [1/3]

heatTransferCoefficientModel ( const word &  modelType,
const dictionary &  dict,
const fvMesh &  mesh 
)

Construct from dictionary and mesh.

Definition at line 43 of file heatTransferCoefficientModel.C.

◆ heatTransferCoefficientModel() [2/3]

heatTransferCoefficientModel ( const word &  modelType,
const dictionary &  dict,
const interRegionModel &  model 
)

Construct from dictionary and model.

Definition at line 54 of file heatTransferCoefficientModel.C.

◆ heatTransferCoefficientModel() [3/3]

heatTransferCoefficientModel ( const heatTransferCoefficientModel &  )
delete

Disallow default bitwise copy construction.

◆ ~heatTransferCoefficientModel()

~heatTransferCoefficientModel ( )
virtual

Destructor.

Definition at line 137 of file heatTransferCoefficientModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "heatTransferCoefficientModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable ( autoPtr  ,
heatTransferCoefficientModel  ,
mesh  ,
(const dictionary &dict, const fvMesh &mesh)  ,
(dict, mesh)   
)

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable ( autoPtr  ,
heatTransferCoefficientModel  ,
model  ,
(const dictionary &dict, const interRegionModel &model)  ,
(dict, model)   
)

◆ New() [1/2]

Foam::autoPtr< Foam::fv::heatTransferCoefficientModel > New ( const dictionary &  dict,
const fvMesh &  mesh 
)
static

Select from dictionary and mesh.

Definition at line 68 of file heatTransferCoefficientModel.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, and mesh.

Here is the call graph for this function:

◆ New() [2/2]

Foam::autoPtr< Foam::fv::heatTransferCoefficientModel > New ( const dictionary &  dict,
const interRegionModel &  model 
)
static

Select from dictionary and model.

Definition at line 102 of file heatTransferCoefficientModel.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::Info.

Here is the call graph for this function:

◆ htc()

virtual tmp<volScalarField> htc ( ) const
pure virtual

Get the heat transfer coefficient.

Implemented in variable, function2, function1, and constant.

◆ correct()

virtual void correct ( )
pure virtual

Correct the heat transfer coefficient.

Implemented in variable, function2, function1, and constant.

◆ read()

bool read ( const dictionary &  dict)
virtual

Read dictionary.

Reimplemented in variable, function2, function1, and constant.

Definition at line 143 of file heatTransferCoefficientModel.C.

Referenced by constant::read(), function1::read(), function2::read(), and variable::read().

Here is the caller graph for this function:

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

Reference to the mesh.

Definition at line 60 of file heatTransferCoefficientModel.H.

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