heatTransferCoeff.C
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2017-2020 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26\*---------------------------------------------------------------------------*/
27
28#include "heatTransferCoeff.H"
29#include "dictionary.H"
32
33// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34
35namespace Foam
36{
37namespace functionObjects
38{
41}
42}
43
44// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
45
47{
49
50 htcModelPtr_->calc(htc, htcModelPtr_->q());
51
52 htc *= L_/kappa_;
53
54 return true;
55}
56
57
58// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
59
61(
62 const word& name,
63 const Time& runTime,
64 const dictionary& dict
65)
66:
68 L_(1),
69 kappa_(1),
70 htcModelPtr_(nullptr)
71{
72 read(dict);
73
74 setResultName(typeName, "htc:" + htcModelPtr_->type());
75
76 auto* heatTransferCoeffPtr =
78 (
80 (
83 mesh_,
86 ),
87 mesh_,
89 );
90
91 mesh_.objectRegistry::store(heatTransferCoeffPtr);
92}
93
94
95// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
96
98{
100 {
101 return false;
102 }
103
104 L_ = dict.getCheckOrDefault<scalar>("L", 1, scalarMinMax::ge(0));
105 kappa_ =
106 dict.getCheckOrDefault<scalar>("kappa", 1, scalarMinMax::ge(SMALL));
107 htcModelPtr_ = heatTransferCoeffModel::New(dict, mesh_, fieldName_);
108
109 htcModelPtr_->read(dict);
110
111 return true;
112}
113
114
115// ************************************************************************* //
Macros for easy insertion into run-time selection tables.
#define addToRunTimeSelectionTable(baseType, thisType, argNames)
Add to construction table with typeName as the key.
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:170
static MinMax< scalar > ge(const scalar &minVal)
A semi-infinite range from minVal to the type max.
Definition: MinMaxI.H:31
virtual bool read()
Re-read model coefficients if they have changed.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:80
static autoPtr< Time > New()
Construct (dummy) Time - no functionObjects or libraries.
Definition: Time.C:717
static word timeName(const scalar t, const int precision=precision_)
Definition: Time.C:780
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Abstract base-class for Time/database function objects.
Intermediate class for handling field expression function objects (e.g. blendingFactor etc....
word resultName_
Name of result field.
void setResultName(const word &typeName, const word &defaultArg)
Set the name of result field.
const fvMesh & mesh_
Reference to the fvMesh.
Computes the heat transfer coefficient [W/(m2 K)] as a volScalarField for a given set of patches.
heatTransferCoeff()=delete
No default construct.
virtual bool read(const dictionary &dict)
Read the heatTransferCoeff data.
const Time & time() const
Return the top-level database.
Definition: fvMesh.H:290
Type & lookupObjectRef(const word &name, const bool recursive=false) const
A class for handling words, derived from Foam::string.
Definition: word.H:68
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition: className.H:121
engineTime & runTime
Namespace for OpenFOAM.
const dimensionSet dimPower
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:82
const dimensionSet dimArea(sqr(dimLength))
Definition: dimensionSets.H:59
const dimensionSet dimTemperature(0, 0, 0, 1, 0, 0, 0)
Definition: dimensionSets.H:54
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:131
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
dictionary dict