FreeFOAM The Cross-Platform CFD Toolkit
RanzMarshall.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::RanzMarshall
26 
27 Description
28  The Ranz-Marshall correlation for heat transfer
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef RanzMarshall_H
33 #define RanzMarshall_H
34 
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 
42 /*---------------------------------------------------------------------------*\
43  Class RanzMarshall Declaration
44 \*---------------------------------------------------------------------------*/
45 
46 template <class CloudType>
47 class RanzMarshall
48 :
49  public HeatTransferModel<CloudType>
50 {
51 
52 public:
53 
54  //- Runtime type information
55  TypeName("RanzMarshall");
56 
57 
58  // Constructors
59 
60  //- Construct from dictionary
62  (
63  const dictionary& dict,
64  CloudType& cloud
65  );
66 
67 
68  //- Destructor
69  virtual ~RanzMarshall();
70 
71 
72  // Member Functions
73 
74  // Access
75 
76  //- Flag to indicate whether model activates heat transfer model
77  virtual bool active() const;
78 
79 
80  // Evaluation
81 
82  //- Nusselt number
83  virtual scalar Nu
84  (
85  const scalar Re,
86  const scalar Pr
87  ) const;
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace Foam
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 #ifdef NoRepository
99 #endif
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #endif
104 
105 // ************************ vim: set sw=4 sts=4 et: ************************ //