Public Member Functions | List of all members
function2 Class Reference

Function2 heat transfer model. The 2D function returns the heat transfer coefficient as a function of the local and neighbouring velocity magnitudes. An area-per-unit-volume [1/m] field (AoV) must be provided in constant. More...

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

Public Member Functions

 TypeName ("function2")
 Runtime type information. More...
 
 function2 (const dictionary &dict, const interRegionModel &model)
 Construct from dictionary and model. More...
 
virtual ~function2 ()
 Destructor. More...
 
virtual tmp< volScalarField > htc () const
 Get the heat transfer coefficient. More...
 
virtual void correct ()
 Correct the heat transfer coefficient. More...
 
virtual bool read (const dictionary &dict)
 Read dictionary. More...
 
- Public Member Functions inherited from heatTransferModel
 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from heatTransferModel
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

Function2 heat transfer model. The 2D function returns the heat transfer coefficient as a function of the local and neighbouring velocity magnitudes. An area-per-unit-volume [1/m] field (AoV) must be provided in constant.

Usage
Example usage: 
{
    type        function2;

    AoV         1e3;

    htcFunc
    {
        type        constant;
        value       1e5;
    }
}

Definition at line 69 of file function2.H.

Constructor & Destructor Documentation

◆ function2()

function2 ( const dictionary &  dict,
const interRegionModel &  model 
)

Construct from dictionary and model.

Definition at line 59 of file function2.C.

◆ ~function2()

~function2 ( )
virtual

Destructor.

Definition at line 90 of file function2.C.

Member Function Documentation

◆ TypeName()

TypeName ( "function2"  )

Runtime type information.

◆ htc()

virtual tmp<volScalarField> htc ( ) const
inlinevirtual

Get the heat transfer coefficient.

Implements heatTransferModel.

Definition at line 116 of file function2.H.

References function2::correct(), and function2::read().

Here is the call graph for this function:

◆ correct()

void correct ( )
virtual

Correct the heat transfer coefficient.

Implements heatTransferModel.

Definition at line 96 of file function2.C.

References objectRegistry::lookupObject(), Foam::mag(), mesh, and U.

Referenced by function2::htc().

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

◆ read()

bool read ( const dictionary &  dict)
virtual

Read dictionary.

Reimplemented from heatTransferModel.

Definition at line 113 of file function2.C.

References heatTransferModel::read().

Referenced by function2::htc().

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: