function1 Class Reference

Function1 heat transfer model. The 1D function returns the heat transfer coefficient as a function of the local velocity magnitude. More...

Inheritance diagram for function1:

Collaboration diagram for function1:

Public Member Functions
	TypeName ("function1")
	Runtime type information. More...
	function1 (const dictionary &dict, const fvMesh &mesh)
	Construct from dictionary and mesh. More...
	function1 (const dictionary &dict, const interRegionModel &model)
	Construct from dictionary and model. More...
virtual	~function1 ()
	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

Function1 heat transfer model. The 1D function returns the heat transfer coefficient as a function of the local velocity magnitude.

Usage

Example usage:

{
    type        function1;

    AoV         1e3;

    htcFunc
    {
        type        constant;
        value       1e5;
    }
}

Definition at line 67 of file function1.H.

Constructor & Destructor Documentation

function1() [1/2]

function1	(	const dictionary &	dict,
		const fvMesh &	mesh
	)

Construct from dictionary and mesh.

Definition at line 58 of file function1.C.

function1() [2/2]

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

Construct from dictionary and model.

Definition at line 72 of file function1.C.

~function1()

~function1 ( )

virtual

Destructor.

Definition at line 83 of file function1.C.

Member Function Documentation

TypeName()

TypeName

(

"function1"

)

Runtime type information.

htc()

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

virtual

Get the heat transfer coefficient.

Implements heatTransferModel.

Definition at line 90 of file function1.C.

References Foam::dimArea, Foam::dimPower, Foam::dimTemperature, Foam::mag(), mesh, GeometricField< scalar, fvPatchField, volMesh >::New(), Foam::type(), and U.

Here is the call graph for this function:

correct()

void correct ( )

virtual

Correct the heat transfer coefficient.

Implements heatTransferModel.

Definition at line 110 of file function1.C.

read()

bool read ( const dictionary &  dict )

virtual

Read dictionary.

Reimplemented from heatTransferModel.

Definition at line 114 of file function1.C.

References heatTransferModel::read().

Here is the call graph for this function:

---

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

• src/fvModels/derived/heatTransfer/heatTransferModels/function1/function1.H
• src/fvModels/derived/heatTransfer/heatTransferModels/function1/function1.C