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) 2008-2011 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::ThermoCloud
  26
  27 Description
  28     Templated base class for thermodynamic cloud
  29
  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 "KinematicCloud.H"
  43 #include "thermoCloud.H"
  44 #include "SLGThermo.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 // Forward declaration of classes
  52
  53 template<class CloudType>
  54 class HeatTransferModel;
  55
  56 /*---------------------------------------------------------------------------*\
  57                         Class ThermoCloud Declaration
  58 \*---------------------------------------------------------------------------*/
  59
  60 template<class CloudType>
  61 class ThermoCloud
  62 :
  63     public CloudType,
  64     public thermoCloud
  65 {
  66 public:
  67
  68     // Public typedefs
  69
  70         //- Type of cloud this cloud was instantiated for
  71         typedef CloudType cloudType;
  72
  73         //- Type of parcel the cloud was instantiated for
  74         typedef typename CloudType::particleType parcelType;
  75
  76         //- Convenience typedef for this cloud type
  77         typedef ThermoCloud<CloudType> thermoCloudType;
  78
  79
  80 private:
  81
  82     // Private data
  83
  84         //- Cloud copy pointer
  85         autoPtr<ThermoCloud<CloudType> > cloudCopyPtr_;
  86
  87
  88     // Private member functions
  89
  90         //- Disallow default bitwise copy construct
  91         ThermoCloud(const ThermoCloud&);
  92
  93         //- Disallow default bitwise assignment
  94         void operator=(const ThermoCloud&);
  95
  96
  97 protected:
  98
  99     // Protected data
 100
 101         //- Thermo parcel constant properties
 102         typename parcelType::constantProperties constProps_;
 103
 104
 105         // References to the carrier gas fields
 106
 107             //- SLG thermodynamics package
 108             const SLGThermo& thermo_;
 109
 110             //- Temperature [K]
 111             const volScalarField& T_;
 112
 113             //- Pressure [Pa]
 114             const volScalarField& p_;
 115
 116
 117         // References to the cloud sub-models
 118
 119             //- Heat transfer model
 120             autoPtr<HeatTransferModel<ThermoCloud<CloudType> > >
 121                 heatTransferModel_;
 122
 123
 124         // Reference to the particle integration schemes
 125
 126             //- Temperature integration
 127             autoPtr<scalarIntegrationScheme> TIntegrator_;
 128
 129
 130         // Modelling options
 131
 132             //- Include radiation
 133             Switch radiation_;
 134
 135
 136         // Sources
 137
 138             //- Sensible enthalpy transfer [J/kg]
 139             autoPtr<DimensionedField<scalar, volMesh> > hsTrans_;
 140
 141             //- Coefficient for carrier phase hs equation [W/K]
 142             autoPtr<DimensionedField<scalar, volMesh> > hsCoeff_;
 143
 144
 145     // Protected Member Functions
 146
 147          // Initialisation
 148
 149             //- Set cloud sub-models
 150             void setModels();
 151
 152
 153         // Cloud evolution functions
 154
 155             //- Reset state of cloud
 156             void cloudReset(ThermoCloud<CloudType>& c);
 157
 158
 159 public:
 160
 161     // Constructors
 162
 163         //- Construct given carrier gas fields
 164         ThermoCloud
 165         (
 166             const word& cloudName,
 167             const volScalarField& rho,
 168             const volVectorField& U,
 169             const dimensionedVector& g,
 170             const SLGThermo& thermo,
 171             bool readFields = true
 172         );
 173
 174         //- Copy constructor with new name
 175         ThermoCloud(ThermoCloud<CloudType>& c, const word& name);
 176
 177         //- Copy constructor with new name - creates bare cloud
 178         ThermoCloud
 179         (
 180             const fvMesh& mesh,
 181             const word& name,
 182             const ThermoCloud<CloudType>& c
 183         );
 184
 185         //- Construct and return clone based on (this) with new name
 186         virtual autoPtr<Cloud<parcelType> > clone(const word& name)
 187         {
 188             return autoPtr<Cloud<parcelType> >
 189             (
 190                 new ThermoCloud(*this, name)
 191             );
 192         }
 193
 194         //- Construct and return bare clone based on (this) with new name
 195         virtual autoPtr<Cloud<parcelType> > cloneBare(const word& name) const
 196         {
 197             return autoPtr<Cloud<parcelType> >
 198             (
 199                 new ThermoCloud(this->mesh(), name, *this)
 200             );
 201         }
 202
 203
 204     //- Destructor
 205     virtual ~ThermoCloud();
 206
 207
 208     // Member Functions
 209
 210         // Access
 211
 212             //- Return a reference to the cloud copy
 213             inline const ThermoCloud& cloudCopy() const;
 214
 215             //- Return the constant properties
 216             inline const typename parcelType::constantProperties&
 217                 constProps() const;
 218
 219             //- Return const access to thermo package
 220             inline const SLGThermo& thermo() const;
 221
 222             //- Return const access to the carrier temperature field
 223             inline const volScalarField& T() const;
 224
 225             //- Return const access to the carrier prressure field
 226             inline const volScalarField& p() const;
 227
 228
 229             // Sub-models
 230
 231                 //- Return reference to heat transfer model
 232                 inline const HeatTransferModel<ThermoCloud<CloudType> >&
 233                     heatTransfer() const;
 234
 235
 236             // Integration schemes
 237
 238                 //-Return reference to velocity integration
 239                 inline const scalarIntegrationScheme& TIntegrator() const;
 240
 241
 242             // Modelling options
 243
 244                  //- Radiation flag
 245                 inline bool radiation() const;
 246
 247
 248             // Sources
 249
 250                 // Enthalpy
 251
 252                     //- Sensible enthalpy transfer [J/kg]
 253                     inline DimensionedField<scalar, volMesh>& hsTrans();
 254
 255                     //- Sensible enthalpy transfer [J/kg]
 256                     inline const DimensionedField<scalar, volMesh>&
 257                         hsTrans() const;
 258
 259                     //- Return coefficient for carrier phase hs equation
 260                     inline DimensionedField<scalar, volMesh>& hsCoeff();
 261
 262                     //- Return const coefficient for carrier phase hs equation
 263                     inline const DimensionedField<scalar, volMesh>&
 264                         hsCoeff() const;
 265
 266                     //- Return sensible enthalpy source term [J/kg/m3/s]
 267                     inline tmp<fvScalarMatrix> Sh(volScalarField& hs) const;
 268
 269
 270                 // Radiation - overrides thermoCloud virtual abstract members
 271
 272                     //- Return tmp equivalent particulate emission
 273                     inline tmp<volScalarField> Ep() const;
 274
 275                     //- Return tmp equivalent particulate absorption
 276                     inline tmp<volScalarField> ap() const;
 277
 278                     //- Return tmp equivalent particulate scattering factor
 279                     inline tmp<volScalarField> sigmap() const;
 280
 281
 282         // Cloud evolution functions
 283
 284             //- Set parcel thermo properties
 285             void setParcelThermoProperties
 286             (
 287                 parcelType& parcel,
 288                 const scalar lagrangianDt
 289             );
 290
 291             //- Check parcel properties
 292             void checkParcelProperties
 293             (
 294                 parcelType& parcel,
 295                 const scalar lagrangianDt,
 296                 const bool fullyDescribed
 297             );
 298
 299             //- Store the current cloud state
 300             void storeState();
 301
 302             //- Reset the current cloud to the previously stored state
 303             void restoreState();
 304
 305             //- Reset the cloud source terms
 306             void resetSourceTerms();
 307
 308             //- Apply relaxation to (steady state) cloud sources
 309             void relaxSources(const ThermoCloud<CloudType>& cloudOldTime);
 310
 311             //- Apply scaling to (transient) cloud sources
 312             void scaleSources();
 313
 314             //- Pre-evolve
 315             void preEvolve();
 316
 317             //- Evolve the cloud
 318             void evolve();
 319
 320
 321         // Check
 322
 323             //- Print cloud information
 324             void info() const;
 325 };
 326
 327
 328 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 329
 330 } // End namespace Foam
 331
 332 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 333
 334 #include "ThermoCloudI.H"
 335
 336 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 337
 338 #ifdef NoRepository
 339 #   include "ThermoCloud.C"
 340 #endif
 341
 342 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 343
 344 #endif
 345
 346 // ************************************************************************* //