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 (C) 1991-2009 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 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                            Class RanzMarshall Declaration
  44 \*---------------------------------------------------------------------------*/
  45
  46 template <class CloudType>
  47 class RanzMarshall
  48 :
  49     public HeatTransferModel<CloudType>
  50 {
  51     // Private data
  52
  53         // Prandtl number
  54         const scalar Pr_;
  55
  56
  57 public:
  58
  59     //- Runtime type information
  60     TypeName("RanzMarshall");
  61
  62
  63     // Constructors
  64
  65         //- Construct from dictionary
  66         RanzMarshall
  67         (
  68             const dictionary& dict,
  69             CloudType& cloud
  70         );
  71
  72
  73     //- Destructor
  74     virtual ~RanzMarshall();
  75
  76
  77     // Member Functions
  78
  79         //- Flag to indicate whether model activates heat transfer model
  80         virtual bool active() const;
  81
  82         //- Nusselt number
  83         virtual scalar Nu
  84         (
  85             const scalar Re,
  86             const scalar Pr
  87         ) const;
  88
  89         //- Prandtl number
  90         virtual scalar Pr() const;
  91 };
  92
  93
  94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  95
  96 } // End namespace Foam
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 #ifdef NoRepository
 101 #   include "RanzMarshall.C"
 102 #endif
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 #endif
 107
 108 // ************************************************************************* //