src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/RanzMarshall/RanzMarshall.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::RanzMarshall
  27
  28 Description
  29     The Ranz-Marshall correlation for heat transfer
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef RanzMarshall_H
  34 #define RanzMarshall_H
  35
  36 #include "HeatTransferModel.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42
  43 /*---------------------------------------------------------------------------*\
  44                          Class RanzMarshall Declaration
  45 \*---------------------------------------------------------------------------*/
  46
  47 template <class CloudType>
  48 class RanzMarshall
  49 :
  50     public HeatTransferModel<CloudType>
  51 {
  52
  53 public:
  54
  55     //- Runtime type information
  56     TypeName("RanzMarshall");
  57
  58
  59     // Constructors
  60
  61         //- Construct from dictionary
  62         RanzMarshall
  63         (
  64             const dictionary& dict,
  65             CloudType& cloud
  66         );
  67
  68
  69     //- Destructor
  70     virtual ~RanzMarshall();
  71
  72
  73     // Member Functions
  74
  75         // Access
  76
  77             //- Flag to indicate whether model activates heat transfer model
  78             virtual bool active() const;
  79
  80
  81         // Evaluation
  82
  83             //- Nusselt number
  84             virtual scalar Nu
  85             (
  86                 const scalar Re,
  87                 const scalar Pr
  88             ) const;
  89 };
  90
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 } // End namespace Foam
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 #ifdef NoRepository
  99 #   include "RanzMarshall.C"
 100 #endif
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 #endif
 105
 106 // ************************************************************************* //