src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.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::KinematicCloud
  27
  28 Description
  29     Templated base class for kinematic cloud
  30
  31     - Kinematic only
  32       - Dispersion model
  33       - Drag model
  34       - Injection model
  35       - Wall interaction model
  36
  37 SourceFiles
  38     KinematicCloudI.H
  39     KinematicCloud.C
  40
  41 \*---------------------------------------------------------------------------*/
  42
  43 #ifndef KinematicCloud_H
  44 #define KinematicCloud_H
  45
  46 #include "Cloud.H"
  47 #include "kinematicCloud.H"
  48 #include "IOdictionary.H"
  49 #include "autoPtr.H"
  50 #include "Random.H"
  51 #include "fvMesh.H"
  52 #include "volFields.H"
  53 #include "fvMatrices.H"
  54 #include "particleForces.H"
  55
  56 #include "IntegrationSchemesFwd.H"
  57
  58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  59
  60 namespace Foam
  61 {
  62
  63 // Forward declaration of classes
  64
  65 template<class CloudType>
  66 class DispersionModel;
  67
  68 template<class CloudType>
  69 class DragModel;
  70
  71 template<class CloudType>
  72 class InjectionModel;
  73
  74 template<class CloudType>
  75 class PostProcessingModel;
  76
  77 template<class CloudType>
  78 class PatchInteractionModel;
  79
  80 /*---------------------------------------------------------------------------*\
  81                        Class KinematicCloud Declaration
  82 \*---------------------------------------------------------------------------*/
  83
  84 template<class ParcelType>
  85 class KinematicCloud
  86 :
  87     public Cloud<ParcelType>,
  88     public kinematicCloud
  89 {
  90     // Private Member Functions
  91
  92         //- Disallow default bitwise copy construct
  93         KinematicCloud(const KinematicCloud&);
  94
  95         //- Disallow default bitwise assignment
  96         void operator=(const KinematicCloud&);
  97
  98
  99 protected:
 100
 101     // Protected data
 102
 103         //- References to the mesh and time databases
 104         const fvMesh& mesh_;
 105
 106         //- Dictionary of particle properties
 107         IOdictionary particleProperties_;
 108
 109         //- Parcel constant properties
 110         typename ParcelType::constantProperties constProps_;
 111
 112         //- Cloud active flag
 113         const Switch active_;
 114
 115         //- Parcel type id - used to flag the type of parcels issued by this
 116         //  cloud
 117         const label parcelTypeId_;
 118
 119         //- Flag to indicate whether parcels are coupled to the carrier phase
 120         //  i.e. whether or not to generate source terms for carrier phase
 121         const Switch coupled_;
 122
 123         //- Flag to correct cell values with latest transfer information
 124         //  during the lagrangian timestep
 125         const Switch cellValueSourceCorrection_;
 126
 127         //- Random number generator - used by some injection routines
 128         Random rndGen_;
 129
 130
 131         // References to the carrier gas fields
 132
 133             //- Density
 134             const volScalarField& rho_;
 135
 136             //- Velocity
 137             const volVectorField& U_;
 138
 139             //- Dynamic viscosity
 140             const volScalarField& mu_;
 141
 142
 143         // Environmental properties
 144
 145             //- Gravity
 146             const dimensionedVector& g_;
 147
 148
 149         //- Optional particle forces
 150         particleForces forces_;
 151
 152         //- Interpolation schemes dictionary
 153         dictionary interpolationSchemes_;
 154
 155
 156         // References to the cloud sub-models
 157
 158             //- Dispersion model
 159             autoPtr<DispersionModel<KinematicCloud<ParcelType> > >
 160                 dispersionModel_;
 161
 162             //- Drag transfer model
 163             autoPtr<DragModel<KinematicCloud<ParcelType> > > dragModel_;
 164
 165             //- Injector model
 166             autoPtr<InjectionModel<KinematicCloud<ParcelType> > >
 167                 injectionModel_;
 168
 169             //- Patch interaction model
 170             autoPtr<PatchInteractionModel<KinematicCloud<ParcelType> > >
 171                 patchInteractionModel_;
 172
 173             //- Post-processing model
 174             autoPtr<PostProcessingModel<KinematicCloud<ParcelType> > >
 175                 postProcessingModel_;
 176
 177
 178         // Reference to the particle integration schemes
 179
 180             //- Velocity integration
 181             autoPtr<vectorIntegrationScheme> UIntegrator_;
 182
 183
 184         // Sources
 185
 186             //- Momentum
 187             DimensionedField<vector, volMesh> UTrans_;
 188
 189
 190         // Cloud evolution functions
 191
 192             //- Pre-evolve
 193             void preEvolve();
 194
 195             //- Evolve the cloud
 196             void evolveCloud();
 197
 198             //- Post-evolve
 199             void postEvolve();
 200
 201
 202 public:
 203
 204     // Constructors
 205
 206         //- Construct given carrier gas fields
 207         KinematicCloud
 208         (
 209             const word& cloudName,
 210             const volScalarField& rho,
 211             const volVectorField& U,
 212             const volScalarField& mu,
 213             const dimensionedVector& g,
 214             bool readFields = true
 215         );
 216
 217
 218     //- Destructor
 219     virtual ~KinematicCloud();
 220
 221
 222     //- Type of parcel the cloud was instantiated for
 223     typedef ParcelType parcelType;
 224
 225
 226     // Member Functions
 227
 228         // Access
 229
 230             // References to the mesh and databases
 231
 232                 //- Return refernce to the mesh
 233                 inline const fvMesh& mesh() const;
 234
 235                 //- Return particle properties dictionary
 236                 inline const IOdictionary& particleProperties() const;
 237
 238                 //- Return the constant properties
 239                 inline const typename ParcelType::constantProperties&
 240                     constProps() const;
 241
 242
 243             // Cloud data
 244
 245                 //- Return the active flag
 246                 inline const Switch active() const;
 247
 248                 //- Return the parcel type id
 249                 inline label parcelTypeId() const;
 250
 251                 //- Return coupled flag
 252                 inline const Switch coupled() const;
 253
 254                 //- Return cell value correction flag
 255                 inline const Switch cellValueSourceCorrection() const;
 256
 257                 //- Return refernce to the random object
 258                 inline Random& rndGen();
 259
 260
 261             // References to the carrier gas fields
 262
 263                 //- Return carrier gas velocity
 264                 inline const volVectorField& U() const;
 265
 266                 //- Return carrier gas density
 267                 inline const volScalarField& rho() const;
 268
 269                 //- Return carrier gas dynamic viscosity
 270                 inline const volScalarField& mu() const;
 271
 272
 273             // Environmental properties
 274
 275                 //- Gravity
 276                 inline const dimensionedVector& g() const;
 277
 278
 279             //- Optional particle forces
 280             inline const particleForces& forces() const;
 281
 282
 283             // Interpolations
 284
 285                 //- Return reference to the interpolation dictionary
 286                 inline const dictionary& interpolationSchemes() const;
 287
 288
 289             // Sub-models
 290
 291                 //- Return const-access to the dispersion model
 292                 inline const DispersionModel<KinematicCloud<ParcelType> >&
 293                     dispersion() const;
 294
 295                 //- Return reference to the dispersion model
 296                 inline DispersionModel<KinematicCloud<ParcelType> >&
 297                     dispersion();
 298
 299                 //- Return const-access to the drag model
 300                 inline const DragModel<KinematicCloud<ParcelType> >&
 301                     drag() const;
 302
 303                 //- Return const access to the injection model
 304                 inline const InjectionModel<KinematicCloud<ParcelType> >&
 305                     injection() const;
 306
 307                 //- Return reference to the injection model
 308                 inline InjectionModel<KinematicCloud<ParcelType> >&
 309                     injection();
 310
 311                 //- Return const-access to the patch interaction model
 312                 inline const PatchInteractionModel<KinematicCloud<ParcelType> >&
 313                     patchInteraction() const;
 314
 315                 //- Return reference to post-processing model
 316                 inline PostProcessingModel<KinematicCloud<ParcelType> >&
 317                     postProcessing();
 318
 319
 320             // Integration schemes
 321
 322                 //-Return reference to velocity integration
 323                 inline const vectorIntegrationScheme& UIntegrator() const;
 324
 325
 326             // Sources
 327
 328                 // Momentum
 329
 330                     //- Return reference to momentum source
 331                     inline DimensionedField<vector, volMesh>& UTrans();
 332
 333                     //- Return tmp momentum source term - fully explicit
 334                     inline tmp<DimensionedField<vector, volMesh> > SU() const;
 335
 336
 337         // Check
 338
 339             //- Total mass injected
 340             inline scalar massInjected() const;
 341
 342             //- Total mass in system
 343             inline scalar massInSystem() const;
 344
 345             //- Print cloud information
 346             void info() const;
 347
 348
 349             // Fields
 350
 351                 //- Return the particle volume fraction field
 352                 //  Note: for particles belonging to this cloud only
 353                 inline const tmp<volScalarField> theta() const;
 354
 355                 //- Return the particle mass fraction field
 356                 //  Note: for particles belonging to this cloud only
 357                 inline const tmp<volScalarField> alpha() const;
 358
 359                 //- Return the particle effective density field
 360                 //  Note: for particles belonging to this cloud only
 361                 inline const tmp<volScalarField> rhoEff() const;
 362
 363
 364         // Cloud evolution functions
 365
 366             //- Check parcel properties
 367             void checkParcelProperties
 368             (
 369                 ParcelType& parcel,
 370                 const scalar lagrangianDt,
 371                 const bool fullyDescribed
 372             );
 373
 374             //- Reset the spray source terms
 375             void resetSourceTerms();
 376
 377             //- Evolve the spray (inject, inject)
 378             void evolve();
 379 };
 380
 381
 382 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 383
 384 } // End namespace Foam
 385
 386 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 387
 388 #include "KinematicCloudI.H"
 389
 390 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 391
 392 #ifdef NoRepository
 393 #   include "KinematicCloud.C"
 394 #endif
 395
 396 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 397
 398 #endif
 399
 400 // ************************************************************************* //