All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
heatTransferModel.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::regionModels::surfaceFilmModels::heatTransferModel
26 
27 Description
28  Base class for film heat transfer models
29 
30 SourceFiles
31  heatTransferModel.C
32  heatTransferModelNew.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef heatTransferModel_H
37 #define heatTransferModel_H
38 
39 #include "filmSubModelBase.H"
40 #include "runTimeSelectionTables.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace regionModels
47 {
48 namespace surfaceFilmModels
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class heatTransferModel Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
57  public filmSubModelBase
58 {
59 public:
60 
61  //- Runtime type information
62  TypeName("heatTransferModel");
63 
64 
65  // Declare runtime constructor selection table
66 
68  (
69  autoPtr,
71  dictionary,
72  (
74  const dictionary& dict
75  ),
76  (film, dict)
77  );
78 
79 
80  // Constructors
81 
82  //- Construct null
84 
85  //- Construct from type name, dictionary and surface film model
87  (
88  const word& modelType,
90  const dictionary& dict
91  );
92 
93  //- Disallow default bitwise copy construction
94  heatTransferModel(const heatTransferModel&) = delete;
95 
96 
97  // Selectors
98 
99  //- Return a reference to the selected phase change model
101  (
103  const dictionary& dict
104  );
105 
106 
107  //- Destructor
108  virtual ~heatTransferModel();
109 
110 
111  // Member Functions
112 
113  // Evolution
114 
115  //- Correct
116  virtual void correct() = 0;
117 
118  //- Return the heat transfer coefficient [W/m^2/K]
119  virtual tmp<volScalarField::Internal> h() const = 0;
120 
121 
122  // Member Operators
123 
124  //- Disallow default bitwise assignment
125  void operator=(const heatTransferModel&) = delete;
126 };
127 
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 } // End namespace surfaceFilmModels
132 } // End namespace regionModels
133 } // End namespace Foam
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 #endif
138 
139 // ************************************************************************* //
void operator=(const heatTransferModel &)=delete
Disallow default bitwise assignment.
Base class for surface film sub-models.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
heatTransferModel(surfaceFilmRegionModel &film)
Construct null.
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
const surfaceFilmRegionModel & film() const
Return const access to the film surface film model.
declareRunTimeSelectionTable(autoPtr, heatTransferModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict),(film, dict))
A class for handling words, derived from string.
Definition: word.H:59
TypeName("heatTransferModel")
Runtime type information.
const word & modelType() const
Return const access to the sub-model type.
Definition: subModelBase.C:122
virtual tmp< volScalarField::Internal > h() const =0
Return the heat transfer coefficient [W/m^2/K].
static autoPtr< heatTransferModel > New(surfaceFilmRegionModel &film, const dictionary &dict)
Return a reference to the selected phase change model.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Macros to ease declaration of run-time selection tables.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.
Base class for film heat transfer models.