FreeFOAM The Cross-Platform CFD Toolkit
heatTransferModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
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::heatTransferModel
26 
27 Description
28  Foam::heatTransferModel
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef heatTransferModel_H
33 #define heatTransferModel_H
34 
35 #include <OpenFOAM/IOdictionary.H>
36 #include <OpenFOAM/autoPtr.H>
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 /*---------------------------------------------------------------------------*\
45  Class heatTransferModel Declaration
46 \*---------------------------------------------------------------------------*/
47 
49 
50 {
51 
52 protected:
53 
54  // Protected data
55 
56  const dictionary& dict_;
57 
58 public:
59 
60  //- Runtime type information
61  TypeName("heatTransferModel");
62 
63 
64  // Declare runtime constructor selection table
65 
67  (
68  autoPtr,
70  dictionary,
71  (
72  const dictionary& dict
73  ),
74  (dict)
75  );
76 
77 
78  // Constructors
79 
80  //- Construct from dictionary
82  (
83  const dictionary& dict
84  );
85 
86 
87  // Destructor
88 
89  virtual ~heatTransferModel();
90 
91 
92  // Selector
93 
95  (
96  const dictionary& dict
97  );
98 
99 
100  // Member Functions
101 
102  //- heat transfer on/off
103  virtual bool heatTransfer() const = 0;
104 
105  //- Return Nusselt Number
106  virtual scalar Nu
107  (
108  const scalar ReynoldsNumber,
109  const scalar PrandtlNumber
110  ) const = 0;
111 
112  //- Return the heat transfer relaxation time
113  virtual scalar relaxationTime
114  (
115  const scalar liquidDensity,
116  const scalar diameter,
117  const scalar liquidcL,
118  const scalar kappa,
119  const scalar ReynoldsNumber,
120  const scalar PrandtlNumber
121  ) const = 0;
122 
123  //- Return the correction function f...
124  virtual scalar fCorrection(const scalar z) const = 0;
125 
126 };
127 
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #endif
136 
137 // ************************ vim: set sw=4 sts=4 et: ************************ //