src/lagrangian/intermediate/submodels/Thermodynamic/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     Templated heat transfer model class
  30
  31 SourceFiles
  32     HeatTransferModel.C
  33     NewHeatTransferModel.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef HeatTransferModel_H
  38 #define HeatTransferModel_H
  39
  40 #include "IOdictionary.H"
  41 #include "autoPtr.H"
  42 #include "runTimeSelectionTables.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                        Class HeatTransferModel Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 template<class CloudType>
  54 class HeatTransferModel
  55 {
  56     // Private data
  57
  58         //- The cloud dictionary
  59         const dictionary& dict_;
  60
  61         //- Reference to the owner cloud class
  62         CloudType& owner_;
  63
  64         //- The coefficients dictionary
  65         const dictionary coeffDict_;
  66
  67
  68 public:
  69
  70     //- Runtime type information
  71     TypeName("HeatTransferModel");
  72
  73     //- Declare runtime constructor selection table
  74     declareRunTimeSelectionTable
  75     (
  76         autoPtr,
  77         HeatTransferModel,
  78         dictionary,
  79         (
  80             const dictionary& dict,
  81             CloudType& owner
  82         ),
  83         (dict, owner)
  84     );
  85
  86
  87     // Constructors
  88
  89         //- Construct null from owner
  90         HeatTransferModel(CloudType& owner);
  91
  92         //- Construct from dictionary
  93         HeatTransferModel
  94         (
  95             const dictionary& dict,
  96             CloudType& owner,
  97             const word& type
  98         );
  99
 100
 101     //- Destructor
 102     virtual ~HeatTransferModel();
 103
 104
 105     //- Selector
 106     static autoPtr<HeatTransferModel<CloudType> > New
 107     (
 108         const dictionary& dict,
 109         CloudType& owner
 110     );
 111
 112
 113     // Access
 114
 115         //- Return the cloud dictionary
 116         const dictionary& dict() const;
 117
 118         //- Return the coefficients dictionary
 119         const dictionary& coeffDict() const;
 120
 121         //- Return the owner cloud object
 122         const CloudType& owner() const;
 123
 124
 125     // Member Functions
 126
 127         //- Flag to indicate whether model activates heat transfer model
 128         virtual bool active() const = 0;
 129
 130         //- Nusselt number
 131         virtual scalar Nu
 132         (
 133             const scalar Re,
 134             const scalar Pr
 135         ) const = 0;
 136
 137         //- Prandtl number
 138         virtual scalar Pr() const = 0;
 139
 140         //- Return heat transfer coefficient
 141         virtual scalar h
 142         (
 143             const scalar dp,
 144             const vector& Ur,
 145             const scalar rhoc,
 146             const scalar rhop,
 147             const scalar cpc,
 148             const scalar cpp,
 149             const scalar muc
 150         ) const;
 151
 152         //- Return linearised coefficient for temperature equation
 153         virtual scalar Cu
 154         (
 155             const scalar dp,
 156             const vector& Ur,
 157             const scalar rhoc,
 158             const scalar rhop,
 159             const scalar cpc,
 160             const scalar cpp,
 161             const scalar muc
 162         ) const;
 163 };
 164
 165
 166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 167
 168 } // End namespace Foam
 169
 170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 171
 172 #define makeHeatTransferModel(CloudType)                                      \
 173                                                                               \
 174     defineNamedTemplateTypeNameAndDebug(HeatTransferModel<CloudType>, 0);     \
 175                                                                               \
 176     defineTemplateRunTimeSelectionTable                                       \
 177     (                                                                         \
 178         HeatTransferModel<CloudType>,                                         \
 179         dictionary                                                            \
 180     );
 181
 182
 183 #define makeHeatTransferModelType(SS, CloudType, ParcelType)                  \
 184                                                                               \
 185     defineNamedTemplateTypeNameAndDebug(SS<CloudType<ParcelType> >, 0);       \
 186                                                                               \
 187     HeatTransferModel<CloudType<ParcelType> >::                               \
 188         adddictionaryConstructorToTable<SS<CloudType<ParcelType> > >          \
 189             add##SS##CloudType##ParcelType##ConstructorToTable_;
 190
 191
 192 #define makeHeatTransferModelThermoType(SS, CloudType, ParcelType, ThermoType)\
 193                                                                               \
 194     defineNamedTemplateTypeNameAndDebug                                       \
 195     (                                                                         \
 196         SS<CloudType<ParcelType<ThermoType> > >,                              \
 197         0                                                                     \
 198     );                                                                        \
 199                                                                               \
 200     HeatTransferModel<CloudType<ParcelType<ThermoType> > >::                  \
 201         adddictionaryConstructorToTable                                       \
 202             <SS<CloudType<ParcelType<ThermoType> > > >                        \
 203             add##SS##CloudType##ParcelType##ThermoType##ConstructorToTable_;
 204
 205
 206 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 207
 208 #ifdef NoRepository
 209 #   include "HeatTransferModel.C"
 210 #endif
 211
 212 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 213
 214 #endif
 215
 216 // ************************************************************************* //