src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/NoHeatTransfer/NoHeatTransfer.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::NoHeatTransfer
  27
  28 Description
  29     Dummy heat transfer model for 'none'
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef NoHeatTransfer_H
  34 #define NoHeatTransfer_H
  35
  36 #include "HeatTransferModel.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42 /*---------------------------------------------------------------------------*\
  43                        Class NoHeatTransfer Declaration
  44 \*---------------------------------------------------------------------------*/
  45
  46 template<class CloudType>
  47 class NoHeatTransfer
  48 :
  49     public HeatTransferModel<CloudType>
  50 {
  51 public:
  52
  53     //- Runtime type information
  54     TypeName("none");
  55
  56
  57     // Constructors
  58
  59         //- Construct from dictionary
  60         NoHeatTransfer(const dictionary&, CloudType& owner);
  61
  62
  63     //- Destructor
  64     virtual ~NoHeatTransfer();
  65
  66
  67     // Member Functions
  68
  69         //- Flag to indicate whether model activates heat transfer model
  70         virtual bool active() const;
  71
  72         //- Nusselt number
  73         virtual scalar Nu
  74         (
  75             const scalar,
  76             const scalar
  77         ) const;
  78
  79         //- Prandtl number
  80         virtual scalar Pr() const;
  81 };
  82
  83
  84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  85
  86 } // End namespace Foam
  87
  88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  89
  90 #ifdef NoRepository
  91 #   include "NoHeatTransfer.C"
  92 #endif
  93
  94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  95
  96 #endif
  97
  98 // ************************************************************************* //