initial commit for version 1.5.x patch release
[OpenFOAM-1.5.x.git] / src / lagrangian / intermediate / submodels / Thermodynamic / HeatTransferModel / RanzMarshall / RanzMarshall.H
blob1c60e0b92a741eb7d311f4c97c6b10f50f6276bd
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::RanzMarshall
28 Description
29     The Ranz-Marshall correlation for heat transfer
31 \*---------------------------------------------------------------------------*/
33 #ifndef RanzMarshall_H
34 #define RanzMarshall_H
36 #include "HeatTransferModel.H"
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 namespace Foam
42 /*---------------------------------------------------------------------------*\
43                            Class RanzMarshall Declaration
44 \*---------------------------------------------------------------------------*/
46 template <class CloudType>
47 class RanzMarshall
49     public HeatTransferModel<CloudType>
52     // Private data
54         // Prandtl number
55         const scalar Pr_;
58 public:
60     //- Runtime type information
61     TypeName("RanzMarshall");
64     // Constructors
66         //- Construct from dictionary
67         RanzMarshall
68         (
69             const dictionary& dict,
70             CloudType& cloud
71         );
74     // Destructor
76         ~RanzMarshall();
79     // Member Functions
81         //- Flag to indicate whether model activates heat transfer model
82         bool active() const;
84         //- Nusselt number
85         scalar Nu
86         (
87             const scalar Re,
88             const scalar Pr
89         ) const;
91         //- Prandtl number
92         scalar Pr() const;
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 } // End namespace Foam
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 #ifdef NoRepository
103 #   include "RanzMarshall.C"
104 #endif
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 #endif
110 // ************************************************************************* //