src/lagrangian/dieselSpray/spraySubModels/heatTransferModel/heatTransferModel/heatTransferModel.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::heatTransferModel
  27
  28 Description
  29     Foam::heatTransferModel
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef heatTransferModel_H
  34 #define heatTransferModel_H
  35
  36 #include "IOdictionary.H"
  37 #include "autoPtr.H"
  38 #include "runTimeSelectionTables.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class heatTransferModel Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class heatTransferModel
  50
  51 {
  52
  53 protected:
  54
  55     // Protected data
  56
  57     const dictionary& dict_;
  58
  59 public:
  60
  61     //- Runtime type information
  62         TypeName("heatTransferModel");
  63
  64
  65     // Declare runtime constructor selection table
  66
  67         declareRunTimeSelectionTable
  68         (
  69             autoPtr,
  70             heatTransferModel,
  71             dictionary,
  72             (
  73                 const dictionary& dict
  74             ),
  75             (dict)
  76         );
  77
  78
  79     // Constructors
  80
  81         //- Construct from dictionary
  82         heatTransferModel
  83         (
  84             const dictionary& dict
  85         );
  86
  87
  88     // Destructor
  89
  90         virtual ~heatTransferModel();
  91
  92
  93     // Selector
  94
  95         static autoPtr<heatTransferModel> New
  96         (
  97             const dictionary& dict
  98         );
  99
 100
 101     // Member Functions
 102
 103         //- heat transfer on/off
 104         virtual bool heatTransfer() const = 0;
 105
 106         //- Return Nusselt Number
 107         virtual scalar Nu
 108         (
 109             const scalar ReynoldsNumber,
 110             const scalar PrandtlNumber
 111         ) const = 0;
 112
 113         //- Return the heat transfer relaxation time
 114         virtual scalar relaxationTime
 115         (
 116             const scalar liquidDensity,
 117             const scalar diameter,
 118             const scalar liquidcL,
 119             const scalar kappa,
 120             const scalar ReynoldsNumber,
 121             const scalar PrandtlNumber
 122         ) const = 0;
 123
 124         //- Return the correction function f...
 125         virtual scalar fCorrection(const scalar z) const = 0;
 126
 127 };
 128
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 } // End namespace Foam
 133
 134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 135
 136 #endif
 137
 138 // ************************************************************************* //