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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::ReactingMultiphaseCloud
  27
  28 Description
  29     Templated base class for multiphase reacting cloud
  30
  31     - Adds to reacting cloud
  32       - multiphase composition
  33       - devolatilisatsion
  34       - surface reactions
  35
  36 SourceFiles
  37     ReactingMultiphaseCloudI.H
  38     ReactingMultiphaseCloud.C
  39
  40 \*---------------------------------------------------------------------------*/
  41
  42 #ifndef ReactingMultiphaseCloud_H
  43 #define ReactingMultiphaseCloud_H
  44
  45 #include "ReactingCloud.H"
  46 #include "reactingMultiphaseCloud.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 // Forward declaration of classes
  54
  55 template<class CloudType>
  56 class DevolatilisationModel;
  57
  58 template<class CloudType>
  59 class SurfaceReactionModel;
  60
  61 /*---------------------------------------------------------------------------*\
  62                    Class ReactingMultiphaseCloud Declaration
  63 \*---------------------------------------------------------------------------*/
  64
  65 template<class ParcelType>
  66 class ReactingMultiphaseCloud
  67 :
  68     public ReactingCloud<ParcelType>,
  69     public reactingMultiphaseCloud
  70 {
  71     // Private member functions
  72
  73         //- Disallow default bitwise copy construct
  74         ReactingMultiphaseCloud(const ReactingMultiphaseCloud&);
  75
  76         //- Disallow default bitwise assignment
  77         void operator=(const ReactingMultiphaseCloud&);
  78
  79
  80 protected:
  81
  82     // Protected data
  83
  84         //- Parcel constant properties
  85         typename ParcelType::constantProperties constProps_;
  86
  87
  88         // References to the cloud sub-models
  89
  90             //- Devolatilisation model
  91             autoPtr
  92             <
  93                 DevolatilisationModel<ReactingMultiphaseCloud<ParcelType> >
  94             >
  95             devolatilisationModel_;
  96
  97             //- Surface reaction model
  98             autoPtr
  99             <
 100                 SurfaceReactionModel<ReactingMultiphaseCloud<ParcelType> >
 101             >
 102             surfaceReactionModel_;
 103
 104
 105         // Check
 106
 107             //- Total mass transferred to continuous phase via devolatilisation
 108             scalar dMassDevolatilisation_;
 109
 110             //- Total mass transferred to continuous phase via surface
 111             //  reactions
 112             scalar dMassSurfaceReaction_;
 113
 114
 115     // Protected member functions
 116
 117         // Cloud evolution functions
 118
 119             //- Pre-evolve
 120             void preEvolve();
 121
 122             //- Evolve the cloud
 123             void evolveCloud();
 124
 125             //- Post-evolve
 126             void postEvolve();
 127
 128
 129 public:
 130
 131     // Constructors
 132
 133         //- Construct given carrier gas fields
 134         ReactingMultiphaseCloud
 135         (
 136             const word& cloudName,
 137             const volScalarField& rho,
 138             const volVectorField& U,
 139             const dimensionedVector& g,
 140             basicThermo& thermo,
 141             bool readFields = true
 142         );
 143
 144
 145     //- Destructor
 146     virtual ~ReactingMultiphaseCloud();
 147
 148
 149     //- Type of parcel the cloud was instantiated for
 150     typedef ParcelType parcelType;
 151
 152
 153     // Member Functions
 154
 155         // Access
 156
 157             //- Return the constant properties
 158             inline const typename ParcelType::constantProperties&
 159                 constProps() const;
 160
 161
 162             // Sub-models
 163
 164                 //- Return reference to devolatilisation model
 165                 inline const DevolatilisationModel
 166                 <
 167                     ReactingMultiphaseCloud<ParcelType>
 168                 >&
 169                 devolatilisation() const;
 170
 171                 //- Return reference to reacting surface reaction model
 172                 inline const SurfaceReactionModel
 173                 <
 174                     ReactingMultiphaseCloud<ParcelType>
 175                 >&
 176                 surfaceReaction() const;
 177
 178
 179         // Check
 180
 181             //- Print cloud information
 182             void info() const;
 183
 184             //- Add to cumulative volatilisation mass transfer
 185             void addToMassDevolatilisation(const scalar dMass);
 186
 187             //- Add to cumulative surface reaction transfer
 188             void addToMassSurfaceReaction(const scalar dMass);
 189
 190
 191         // Cloud evolution functions
 192
 193             //- Check parcel properties
 194             void checkParcelProperties
 195             (
 196                 ParcelType& parcel,
 197                 const scalar lagrangianDt,
 198                 const bool fullyDescribed
 199             );
 200
 201             //- Reset the spray source terms
 202             void resetSourceTerms();
 203
 204             //- Evolve the spray (inject, move)
 205             void evolve();
 206 };
 207
 208
 209 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 210
 211 } // End namespace Foam
 212
 213 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 214
 215 #include "ReactingMultiphaseCloudI.H"
 216
 217 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 218
 219 #ifdef NoRepository
 220 #   include "ReactingMultiphaseCloud.C"
 221 #endif
 222
 223 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 224
 225 #endif
 226
 227 // ************************************************************************* //