src/lagrangian/intermediate/clouds/Templates/ThermoCloud/ThermoCloud.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::ThermoCloud
  27
  28 Description
  29     Templated base class for thermodynamic cloud
  30     - Adds to kinematic cloud
  31       - Heat transfer
  32
  33 SourceFiles
  34     ThermoCloudI.H
  35     ThermoCloud.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef ThermoCloud_H
  40 #define ThermoCloud_H
  41
  42 #include "autoPtr.H"
  43 #include "hCombustionThermo.H"
  44
  45 #include "KinematicCloud.H"
  46 #include "thermoCloud.H"
  47
  48
  49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  50
  51 namespace Foam
  52 {
  53
  54 // Forward declaration of classes
  55
  56 template<class CloudType>
  57 class HeatTransferModel;
  58
  59 /*---------------------------------------------------------------------------*\
  60                         Class ThermoCloud Declaration
  61 \*---------------------------------------------------------------------------*/
  62
  63 template<class ParcelType>
  64 class ThermoCloud
  65 :
  66     public KinematicCloud<ParcelType>,
  67     public thermoCloud
  68 {
  69
  70     // Private data
  71
  72         //- Thermo parcel constant properties
  73         typename ParcelType::constantProperties constProps_;
  74
  75
  76         // References to the carrier gas fields
  77
  78             //- Thermodynamics package (basic)
  79             basicThermo& carrierThermo_;
  80
  81
  82         // References to the cloud sub-models
  83
  84             //- Heat transfer model
  85             autoPtr<HeatTransferModel<ThermoCloud<ParcelType> > >
  86                 heatTransferModel_;
  87
  88
  89         // Reference to the particle integration schemes
  90
  91             //- Temperature integration
  92             autoPtr<scalarIntegrationScheme> TIntegrator_;
  93
  94
  95         // Modelling options
  96
  97             //- Include radiation
  98             Switch radiation_;
  99
 100
 101         // Sources
 102
 103             //- Enthalpy transfer
 104             DimensionedField<scalar, volMesh> hTrans_;
 105
 106             //- Coefficient for carrier phase h equation
 107             DimensionedField<scalar, volMesh> hCoeff_;
 108
 109
 110     // Private Member Functions
 111
 112         //- Disallow default bitwise copy construct
 113         ThermoCloud(const ThermoCloud&);
 114
 115         //- Disallow default bitwise assignment
 116         void operator=(const ThermoCloud&);
 117
 118
 119 protected:
 120
 121     //- Inject more parcels
 122     template<class TrackingData>
 123     void inject(TrackingData& td);
 124
 125
 126 public:
 127
 128     //- Runtime type information
 129 //    TypeName("ThermoCloud");
 130
 131
 132     // Constructors
 133
 134         //- Construct given carrier gas fields
 135         ThermoCloud
 136         (
 137             const word& cloudType,
 138             const volPointInterpolation& vpi,
 139             const volScalarField& rho,
 140             const volVectorField& U,
 141             const dimensionedVector& g,
 142             basicThermo& thermo
 143         );
 144
 145
 146     // Destructor
 147
 148         virtual ~ThermoCloud();
 149
 150
 151     // Member Functions
 152
 153         // Access
 154
 155             //- Return const access to thermo package
 156             inline const basicThermo& carrierThermo() const;
 157
 158             //- Return access to thermo package
 159             inline basicThermo& carrierThermo();
 160
 161
 162             // Sub-models
 163
 164                 //- Return reference to heat transfer model
 165                 inline const HeatTransferModel<ThermoCloud<ParcelType> >&
 166                     heatTransfer() const;
 167
 168
 169             // Integration schemes
 170
 171                 //-Return reference to velocity integration
 172                 inline const scalarIntegrationScheme& TIntegrator() const;
 173
 174
 175             // Modelling options
 176
 177                 //- Radiation flag
 178                 inline bool radiation() const;
 179
 180
 181             // Sources
 182
 183                 // Enthalpy
 184
 185                     //- Return reference to enthalpy source
 186                     inline DimensionedField<scalar, volMesh>& hTrans();
 187
 188                     //- Coefficient for carrier phase h equation
 189                     inline DimensionedField<scalar, volMesh>& hCoeff();
 190
 191                     //- return tmp enthalpy source term - fully explicit
 192                     inline tmp<DimensionedField<scalar, volMesh> > Sh1() const;
 193
 194                     //- Return tmp enthalpy source term - semi-implicit
 195                     inline tmp<fvScalarMatrix> Sh2(volScalarField& h) const;
 196
 197
 198                 // Radiation - overrides thermoCloud virtual abstract members
 199
 200                     //- Return tmp equivalent particulate emission
 201                     inline tmp<volScalarField> Ep() const;
 202
 203                     //- Return tmp equivalent particulate absorption
 204                     inline tmp<volScalarField> ap() const;
 205
 206                     //- Return tmp equivalent particulate scattering factor
 207                     inline tmp<volScalarField> sigmap() const;
 208
 209
 210         // Cloud evolution functions
 211
 212             //- Reset the spray source terms
 213             void resetSourceTerms();
 214
 215             //- Evolve the spray (inject, move)
 216             void evolve();
 217 };
 218
 219
 220 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 221
 222 } // End namespace Foam
 223
 224 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 225
 226 #include "ThermoCloudI.H"
 227
 228 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 229
 230 #ifdef NoRepository
 231 #   include "ThermoCloud.C"
 232 #endif
 233
 234 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 235
 236 #endif
 237
 238 // ************************************************************************* //