All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
constantHeatTransfer.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::fv::constantHeatTransfer
26 
27 Description
28  Constant heat transfer model. htcConst [W/m^2/K] and area/volume [1/m]
29  must be provided.
30 
31 \*---------------------------------------------------------------------------*/
32 
33 #ifndef constantHeatTransfer_H
34 #define constantHeatTransfer_H
35 
37 #include "autoPtr.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 namespace fv
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class constantHeatTransfer Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
53 {
54  // Private Data
55 
56  //- Constant heat transfer coefficient [W/m^2/K]
57  autoPtr<volScalarField> htcConst_;
58 
59  //- Area per unit volume of heat exchanger [1/m]
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("constantHeatTransfer");
67 
68 
69  // Constructors
70 
71  //- Construct from dictionary
73  (
74  const word& name,
75  const word& modelType,
76  const dictionary& dict,
77  const fvMesh& mesh
78  );
79 
80 
81  //- Destructor
82  virtual ~constantHeatTransfer();
83 
84 
85  // Public Functions
86 
87  //- Calculate the heat transfer coefficient
88  virtual void calculateHtc();
89 
90 
91  // IO
92 
93  //- Read dictionary
94  virtual bool read(const dictionary& dict);
95 };
96 
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 } // End namespace fv
101 } // End namespace Foam
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #endif
106 
107 // ************************************************************************* //
Constant heat transfer model. htcConst [W/m^2/K] and area/volume [1/m] must be provided.
dictionary dict
Base class for inter region heat exchange. The derived classes must provide the heat transfer coeffic...
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
const fvMesh & mesh() const
Return const access to the mesh database.
Definition: fvOptionI.H:34
virtual ~constantHeatTransfer()
Destructor.
A class for handling words, derived from string.
Definition: word.H:59
labelList fv(nPoints)
const word & name() const
Return const access to the source name.
Definition: fvOptionI.H:28
virtual bool read(const dictionary &dict)
Read dictionary.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
TypeName("constantHeatTransfer")
Runtime type information.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
virtual void calculateHtc()
Calculate the heat transfer coefficient.
Namespace for OpenFOAM.
constantHeatTransfer(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
Construct from dictionary.