constantNuHeatTransfer.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2019 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::heatTransferModels::constantNuHeatTransfer
28 
29 Description
30  Model which applies a user provided constant Nusselt number for interfacial
31  heat transfer.
32 
33 SourceFiles
34  constantNuHeatTransfer.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef constantNuHeatTransfer_H
39 #define constantNuHeatTransfer_H
40 
41 #include "heatTransferModel.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 class phasePair;
49 
50 namespace heatTransferModels
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class constantNuHeatTransfer Declaration
55 \*---------------------------------------------------------------------------*/
56 
58 :
59  public heatTransferModel
60 {
61  // Private data
62 
63  //- Nusselt number
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("constantNu");
70 
71 
72  // Constructors
73 
74  //- Construct from components
76  (
77  const dictionary& dict,
78  const phasePair& pair
79  );
80 
81 
82  //- Destructor
83  virtual ~constantNuHeatTransfer();
84 
85 
86  // Member Functions
87 
88  //- The heat transfer function K used in the enthalpy equation
89  tmp<volScalarField> K(const scalar residualAlpha) const;
90 };
91 
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 } // End namespace heatTransferModels
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #endif
101 
102 // ************************************************************************* //
Foam::heatTransferModels::constantNuHeatTransfer::constantNuHeatTransfer
constantNuHeatTransfer(const dictionary &dict, const phasePair &pair)
Construct from components.
Definition: constantNuHeatTransfer.C:52
Foam::phasePair
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition: phasePair.H:53
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::heatTransferModels::constantNuHeatTransfer::TypeName
TypeName("constantNu")
Runtime type information.
Foam::heatTransferModels::constantNuHeatTransfer
Model which applies a user provided constant Nusselt number for interfacial heat transfer.
Definition: constantNuHeatTransfer.H:56
Foam::heatTransferModels::constantNuHeatTransfer::~constantNuHeatTransfer
virtual ~constantNuHeatTransfer()
Destructor.
Definition: constantNuHeatTransfer.C:64
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::dimensioned< scalar >
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::heatTransferModel
Definition: heatTransferModel.H:53
Foam::heatTransferModel::K
tmp< volScalarField > K() const
The heat transfer function K used in the enthalpy equation.
Definition: heatTransferModel.C:102