src/lagrangian/dieselSpray/spray/spray.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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::spray
  26
  27 Description
  28     A spray is a cloud of parcels
  29
  30 \*---------------------------------------------------------------------------*/
  31
  32 #ifndef spray_H
  33 #define spray_H
  34
  35 #include "autoPtr.H"
  36 #include "parcel.H"
  37 #include "injector.H"
  38 #include "IOPtrList.H"
  39 #include "interpolation.H"
  40 #include "liquidProperties.H"
  41 #include "liquidMixtureProperties.H"
  42 #include "cachedRandom.H"
  43 #include "thermoPhysicsTypes.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 class atomizationModel;
  51 class breakupModel;
  52 class collisionModel;
  53 class dispersionModel;
  54 class dragModel;
  55 class evaporationModel;
  56 class injectorModel;
  57 class heatTransferModel;
  58 class wallModel;
  59
  60 class basicMultiComponentMixture;
  61
  62 /*---------------------------------------------------------------------------*\
  63                         Class spray Declaration
  64 \*---------------------------------------------------------------------------*/
  65
  66 class spray
  67 :
  68     public Cloud<parcel>
  69 {
  70     // Private data
  71
  72         // References to the database and meshes
  73
  74             const Time& runTime_;
  75             scalar time0_;
  76             const fvMesh& mesh_;
  77
  78             //- Random number generator
  79             cachedRandom rndGen_;
  80
  81         //- Acceleration due to gravity
  82         const vector& g_;
  83
  84
  85         // References to the physical fields
  86
  87             const volVectorField& U_;
  88             const volScalarField& rho_;
  89             const volScalarField& p_;
  90             const volScalarField& T_;
  91
  92
  93         //- The spray properties
  94         IOdictionary sprayProperties_;
  95
  96
  97         //- Ambient Pressure
  98         scalar ambientPressure_;
  99
 100         //- Ambient Temperature
 101         scalar ambientTemperature_;
 102
 103
 104         //- The injectors
 105         IOPtrList<injector> injectors_;
 106
 107
 108         // References to the spray sub-models
 109
 110             autoPtr<atomizationModel> atomization_;
 111             autoPtr<dragModel> drag_;
 112             autoPtr<evaporationModel> evaporation_;
 113             autoPtr<heatTransferModel> heatTransfer_;
 114             autoPtr<wallModel> wall_;
 115             autoPtr<breakupModel> breakupModel_;
 116             autoPtr<collisionModel> collisionModel_;
 117             autoPtr<dispersionModel> dispersionModel_;
 118             autoPtr<liquidMixtureProperties> fuels_;
 119             autoPtr<injectorModel> injectorModel_;
 120
 121
 122         //- Minimum number of lagrangian subcycles
 123         const label subCycles_;
 124
 125
 126         // Composition properties
 127
 128             const PtrList<gasThermoPhysics>& gasProperties_;
 129             const basicMultiComponentMixture& composition_;
 130
 131             List<label> liquidToGasIndex_;
 132             List<label> gasToLiquidIndex_;
 133             List<bool> isLiquidFuel_;
 134
 135
 136         // Necessary 2D-information
 137
 138             bool twoD_;
 139             vector axisOfSymmetry_;
 140             vector axisOfWedge_;
 141             vector axisOfWedgeNormal_;
 142             scalar angleOfWedge_;
 143
 144
 145         // Interpolation
 146
 147             dictionary interpolationSchemes_;
 148
 149             autoPtr<interpolation<vector> > UInterpolator_;
 150             autoPtr<interpolation<scalar> > rhoInterpolator_;
 151             autoPtr<interpolation<scalar> > pInterpolator_;
 152             autoPtr<interpolation<scalar> > TInterpolator_;
 153
 154
 155         // Spray Source Terms
 156
 157             //- Momentum
 158             vectorField sms_;
 159
 160             //- Enthalpy
 161             scalarField shs_;
 162
 163             //- Mass
 164             PtrList<scalarField> srhos_;
 165
 166             //- The total mass of the injected liquid
 167             scalar totalInjectedLiquidMass_;
 168
 169             //- The (total added) injected kinetic energy of the liquid
 170             scalar injectedLiquidKE_;
 171
 172
 173     // Private Member Functions
 174
 175         //- Disallow default bitwise copy construct
 176         spray(const spray&);
 177
 178         //- Disallow default bitwise assignment
 179         void operator=(const spray&);
 180
 181
 182 public:
 183
 184     // Constructors
 185
 186         //- Construct from components
 187         spray
 188         (
 189             const volVectorField& U,
 190             const volScalarField& rho,
 191             const volScalarField& p,
 192             const volScalarField& T,
 193             const basicMultiComponentMixture& composition,
 194             const PtrList<gasThermoPhysics>& gasProperties,
 195             const dictionary& thermophysicalProperties,
 196             const dimensionedVector& g,
 197             bool readFields = true
 198         );
 199
 200
 201     //- Destructor
 202     ~spray();
 203
 204
 205     // Member Functions
 206
 207         // Spray tracking and evolution functions
 208
 209             //- Evolve the spray (move, inject and breakup)
 210             void evolve();
 211
 212             //- Move the spray parcels
 213             void move();
 214
 215             //- Inject more parcels
 216             void inject();
 217
 218             //- Primary breakup droplets
 219             void atomizationLoop();
 220
 221
 222             //- Secondary breakup droplets
 223             void breakupLoop();
 224
 225
 226         // Access
 227
 228             inline const Time& runTime() const;
 229             inline const fvMesh& mesh() const;
 230
 231             inline const volVectorField& U() const;
 232             inline const volScalarField& rho() const;
 233             inline const volScalarField& p() const;
 234             inline const volScalarField& T() const;
 235
 236             inline PtrList<injector>& injectors();
 237             inline const PtrList<injector>& injectors() const;
 238
 239             inline const atomizationModel& atomization() const;
 240             inline const breakupModel& breakup() const;
 241             inline const collisionModel& collisions() const;
 242             inline const dispersionModel& dispersion() const;
 243             inline const dragModel& drag() const;
 244             inline const evaporationModel& evaporation() const;
 245             inline const heatTransferModel& heatTransfer() const;
 246             inline const injectorModel& injection() const;
 247             inline const wallModel& wall() const;
 248
 249             inline tmp<volVectorField> momentumSource() const;
 250             inline tmp<volScalarField> evaporationSource(const label i) const;
 251             inline tmp<volScalarField> heatTransferSource() const;
 252
 253             inline cachedRandom& rndGen();
 254             inline label subCycles() const;
 255             inline const vector& g() const;
 256
 257             inline const liquidMixtureProperties& fuels() const;
 258             inline const PtrList<gasThermoPhysics>& gasProperties() const;
 259             inline const basicMultiComponentMixture& composition() const;
 260
 261             inline const List<label>& liquidToGasIndex() const;
 262             inline const List<label>& gasToLiquidIndex() const;
 263             inline const List<bool>& isLiquidFuel() const;
 264
 265             inline bool twoD() const;
 266             inline const vector& axisOfSymmetry() const;
 267             inline const vector& axisOfWedge() const;
 268             inline const vector& axisOfWedgeNormal() const;
 269             inline scalar angleOfWedge() const;
 270
 271             inline const interpolation<vector>& UInterpolator() const;
 272             inline const interpolation<scalar>& rhoInterpolator() const;
 273             inline const interpolation<scalar>& pInterpolator() const;
 274             inline const interpolation<scalar>& TInterpolator() const;
 275
 276             inline vectorField& sms();
 277             inline const vectorField& sms() const;
 278
 279             inline scalarField& shs();
 280             inline const scalarField& shs() const;
 281
 282             inline PtrList<scalarField>& srhos();
 283             inline const PtrList<scalarField>& srhos() const;
 284
 285             inline scalar ambientPressure() const;
 286
 287             inline scalar ambientTemperature() const;
 288
 289
 290         // Check
 291
 292             //- Returns the liquid mass that has been injected
 293             scalar injectedMass(const scalar t) const;
 294
 295            //- Returns the liquid mass that will be injected by the injectors
 296             scalar totalMassToInject() const;
 297
 298             //- Returns the injected enthalpy
 299             scalar injectedEnthalpy(const scalar t) const;
 300
 301             //- Returns current total liquid mass in the domain
 302             scalar liquidMass() const;
 303
 304             //- Returns the enthalpy of all the liquid in the domain
 305             // Hdrop = Hgas - Hlat
 306             scalar liquidEnthalpy() const;
 307
 308             //- Returns the enthalpy (total) of all the liquid in the domain
 309             // Hdrop = Hgas - Hlat + (P-Psat)/rhoDrop;
 310             scalar liquidTotalEnthalpy() const;
 311
 312             //- Returns the kinetic energy of the liquid phase
 313             scalar liquidKineticEnergy() const;
 314
 315             //- Returns the injected kinetic energy of the liquid phase
 316             scalar injectedLiquidKineticEnergy() const;
 317
 318             //- Returns the droplet penetration for 'prc' percent of the
 319             //  liquid from nozzle 'nozzlei'
 320             scalar liquidPenetration
 321             (
 322                 const label nozzlei,
 323                 const scalar prc
 324             ) const;
 325
 326             //- Returns the droplet penetration for 'prc' percent of the
 327             //  liquid from nozzle 0
 328             scalar liquidPenetration(const scalar prc) const;
 329
 330             //- Return Sauter Mean Diameter
 331             scalar smd() const;
 332
 333             //- Return Maximum Diameter
 334             scalar maxD() const;
 335
 336             //- Return Ambient Pressure
 337             void calculateAmbientPressure();
 338
 339             //- Return Ambient Temperature
 340             void calculateAmbientTemperature();
 341 };
 342
 343
 344 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 345
 346 } // End namespace Foam
 347
 348 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 349
 350 #include "sprayI.H"
 351
 352 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 353
 354 #endif
 355
 356 // ************************************************************************* //