Public Member Functions | Static Public Member Functions | List of all members
heatTransferModel Class Referenceabstract

Base class for heat transfer coefficient modelling used in heat transfer fvModels. Area per unit volume [1/m] (AoV) must be provided as a value in the coefficients dictionary or as a field in constant. More...

Inheritance diagram for heatTransferModel:
Inheritance graph
[legend]

Public Member Functions

 TypeName ("heatTransferModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, heatTransferModel, mesh,(const dictionary &dict, const fvMesh &mesh),(dict, mesh))
 
 declareRunTimeSelectionTable (autoPtr, heatTransferModel, model,(const dictionary &dict, const interRegionModel &model),(dict, model))
 
 heatTransferModel (const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from dictionary and mesh. More...
 
 heatTransferModel (const word &modelType, const dictionary &dict, const interRegionModel &model)
 Construct from dictionary and model. More...
 
 heatTransferModel (const heatTransferModel &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~heatTransferModel ()
 Destructor. More...
 
const fvMesh & mesh () const
 Return reference to the mesh. More...
 
const dictionary & coeffs () const
 Return coeffs dictionary. More...
 
tmp< volScalarField > AoV () const
 Get the area per unit volume. 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< heatTransferModel > New (const dictionary &dict, const fvMesh &mesh)
 Select from dictionary and mesh. More...
 
static autoPtr< heatTransferModel > New (const dictionary &dict, const interRegionModel &model)
 Select from dictionary and model. More...
 

Detailed Description

Base class for heat transfer coefficient modelling used in heat transfer fvModels. Area per unit volume [1/m] (AoV) must be provided as a value in the coefficients dictionary or as a field in constant.

Source files

Definition at line 54 of file heatTransferModel.H.

Constructor & Destructor Documentation

◆ heatTransferModel() [1/3]

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

Construct from dictionary and mesh.

Definition at line 78 of file heatTransferModel.C.

◆ heatTransferModel() [2/3]

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

Construct from dictionary and model.

Definition at line 94 of file heatTransferModel.C.

◆ heatTransferModel() [3/3]

heatTransferModel ( const heatTransferModel &  )
delete

Disallow default bitwise copy construction.

◆ ~heatTransferModel()

~heatTransferModel ( )
virtual

Destructor.

Definition at line 162 of file heatTransferModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "heatTransferModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

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

◆ declareRunTimeSelectionTable() [2/2]

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

◆ New() [1/2]

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

Select from dictionary and mesh.

Definition at line 107 of file heatTransferModel.C.

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

Here is the call graph for this function:

◆ New() [2/2]

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

Select from dictionary and model.

Definition at line 133 of file heatTransferModel.C.

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

Here is the call graph for this function:

◆ mesh()

const fvMesh& mesh ( ) const
inline

Return reference to the mesh.

Definition at line 156 of file heatTransferModel.H.

◆ coeffs()

const dictionary& coeffs ( ) const
inline

Return coeffs dictionary.

Definition at line 162 of file heatTransferModel.H.

References heatTransferModel::AoV(), heatTransferModel::correct(), heatTransferModel::htc(), and heatTransferModel::read().

Here is the call graph for this function:

◆ AoV()

Foam::tmp< Foam::volScalarField > AoV ( ) const

Get the area per unit volume.

Definition at line 168 of file heatTransferModel.C.

References GeometricField< scalar, fvPatchField, volMesh >::New(), and Foam::type().

Referenced by heatTransferModel::coeffs().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ htc()

virtual tmp<volScalarField> htc ( ) const
pure virtual

Get the heat transfer coefficient.

Implemented in variable, function2, function1, and constant.

Referenced by heatTransferModel::coeffs().

Here is the caller graph for this function:

◆ correct()

virtual void correct ( )
pure virtual

Correct the heat transfer coefficient.

Implemented in variable, function2, function1, and constant.

Referenced by heatTransferModel::coeffs().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary &  dict)
virtual

Read dictionary.

Reimplemented in variable, function2, function1, and constant.

Definition at line 181 of file heatTransferModel.C.

References dictionary::optionalSubDict(), and Foam::type().

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

Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following files: