constantNuHeatTransfer.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) 2019-2020 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::heatTransferModels::constantNuHeatTransfer
26 
27 Description
28  Model which applies a user provided constant Nusselt number for interfacial
29  heat transfer.
30 
31 SourceFiles
32  constantNuHeatTransfer.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef constantNuHeatTransfer_H
37 #define constantNuHeatTransfer_H
38 
39 #include "heatTransferModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace heatTransferModels
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class constantNuHeatTransfer Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public heatTransferModel
55 {
56  // Private Data
57 
58  //- Nusselt number
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("constantNu");
65 
66 
67  // Constructors
68 
69  //- Construct from components
71  (
72  const dictionary& dict,
73  const phasePair& pair
74  );
75 
76 
77  //- Destructor
78  virtual ~constantNuHeatTransfer();
79 
80 
81  // Member Functions
82 
83  //- The heat transfer function K used in the enthalpy equation
84  tmp<volScalarField> K(const scalar residualAlpha) const;
85 };
86 
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 } // End namespace heatTransferModels
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
dictionary dict
tmp< volScalarField > K() const
The heat transfer function K used in the enthalpy equation.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
constantNuHeatTransfer(const dictionary &dict, const phasePair &pair)
Construct from components.
Model which applies a user provided constant Nusselt number for interfacial heat transfer.
A class for managing temporary objects.
Definition: PtrList.H:53
TypeName("constantNu")
Runtime type information.
Namespace for OpenFOAM.