wallHeatTransferCoeffModel.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) 2020-2021 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::wallHeatTransferCoeffModel
26 
27 Description
28  Abstract base class for run time selection of heat transfer coefficient
29  models.
30 
31 SourceFiles
32  wallHeatTransferCoeffModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef wallHeatTransferCoeffModel_H
37 #define wallHeatTransferCoeffModel_H
38 
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class wallHeatTransferCoeffModel Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 {
52 
53 public:
54 
55  //- Runtime type information
56  TypeName("wallHeatTransferCoeffModel");
57 
58 
59  // Declare run-time selection table
60 
62  (
63  autoPtr,
65  word,
66  (
67  const word& name,
68  const fvMesh& mesh,
69  const dictionary& dict
70  ),
71  (name, mesh, dict)
72  );
73 
74 
75  // Constructors
76 
77  //- Construct from name, mesh and dict
79  (
80  const word& name,
81  const fvMesh& mesh,
82  const dictionary&
83  )
84  {}
85 
86  //- Disallow default bitwise copy construction
88 
89  //- Clone
91  {
94  }
95 
96 
97  // Selectors
98 
99  //- Return a reference to the selected subset
101  (
102  const word& name,
103  const fvMesh& mesh,
104  const dictionary&
105  );
106 
107 
108  //- Destructor
110  {}
111 
112 
113  // Member Functions
114 
115  //- Read the wallHeatTransferCoeffModel data
116  virtual bool read(const dictionary&) = 0;
117 
118  //- Interface for heat transfer coefficient
120  (
121  const momentumTransportModel& mmtm,
122  const labelHashSet& patches
123  ) const = 0;
124 
125  //- Calculate wall shear stress
127  (
128  const momentumTransportModel& mmtm,
129  const fvMesh& mesh
130  ) const;
131 
132 
133  // Member Operators
134 
135  //- Disallow default bitwise assignment
136  void operator=(const wallHeatTransferCoeffModel&) = delete;
137 };
138 
139 
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
141 
142 } // End namespace Foam
143 
144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
145 
146 #endif
147 
148 // ************************************************************************* //
const fvPatchList & patches
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
declareRunTimeSelectionTable(autoPtr, wallHeatTransferCoeffModel, word,(const word &name, const fvMesh &mesh, const dictionary &dict),(name, mesh, dict))
wallHeatTransferCoeffModel(const word &name, const fvMesh &mesh, const dictionary &)
Construct from name, mesh and dict.
TypeName("wallHeatTransferCoeffModel")
Runtime type information.
Abstract base class for run time selection of heat transfer coefficient models.
virtual bool read(const dictionary &)=0
Read the wallHeatTransferCoeffModel data.
fvMesh & mesh
static autoPtr< wallHeatTransferCoeffModel > New(const word &name, const fvMesh &mesh, const dictionary &)
Return a reference to the selected subset.
autoPtr< wallHeatTransferCoeffModel > clone() const
Clone.
A class for handling words, derived from string.
Definition: word.H:59
tmp< volSymmTensorField > tau(const momentumTransportModel &mmtm, const fvMesh &mesh) const
Calculate wall shear stress.
void operator=(const wallHeatTransferCoeffModel &)=delete
Disallow default bitwise assignment.
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
Abstract base class for turbulence models (RAS, LES and laminar).
virtual tmp< volScalarField > htcByRhoCp(const momentumTransportModel &mmtm, const labelHashSet &patches) const =0
Interface for heat transfer coefficient.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:95
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
A class for managing temporary objects.
Definition: PtrList.H:53
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:353
Namespace for OpenFOAM.