src/lagrangian/dieselSpray/parcel/parcel.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::parcel
  27
  28 Description
  29     A parcel of particles
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef parcel_H
  34 #define parcel_H
  35
  36 #include "Particle.H"
  37 #include "contiguous.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 class spray;
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class parcel Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class parcel
  51 :
  52     public Particle<parcel>
  53 {
  54     // Private member data
  55
  56         // Reference to the names of the liquid components
  57             List<word> liquidComponents_;
  58
  59         // Defining data (read and written to field files)
  60
  61             //- Diameter of droplets in parcel
  62             scalar d_;
  63
  64             //- Temperature of droplets in parcel
  65             scalar T_;
  66
  67             //- Total parcel mass
  68             scalar m_;
  69
  70             //- Spherical deviation of droplets in parcel
  71             scalar y_;
  72
  73             //- Rate of change of spherical deviation of droplets in parcel
  74             scalar yDot_;
  75
  76             //- Characteristic time of droplets in parcel
  77             scalar ct_;
  78
  79             //- Stripped mass of droplets in parcel
  80             scalar ms_;
  81
  82             //- Time spent in turbulent eddy
  83             scalar tTurb_;
  84
  85             //- Part of liquid core (1-fully liquid, 0-droplet)
  86             scalar liquidCore_;
  87
  88             //- injected from injector
  89             //  Should really be a label, but is scalar due to
  90             //  post-processing reasons
  91             scalar injector_;
  92
  93             //- Velocity of parcel
  94             vector U_;
  95
  96             //- Turbulent velocity fluctuation
  97             vector Uturb_;
  98
  99             //- Normal n_ and axis describe the 2D plane
 100             //  in which the particle moves
 101             vector n_;
 102
 103             //- Liquid components molar fractions
 104             scalarField X_;
 105
 106         // Derived state information (not read or written)
 107
 108             //- Momentum relaxation time of droplets in parcel
 109             scalar tMom_;
 110
 111
 112     // Private member functions
 113
 114         //- Set the relaxation times
 115         void setRelaxationTimes
 116         (
 117             label celli,
 118             scalar& tauMomentum,
 119             scalarField& tauEvaporation,
 120             scalar& tauHeatTransfer,
 121             scalarField& tauBoiling,
 122             const spray& sprayDatabase,
 123             const scalar rho,
 124             const vector& Up,
 125             const scalar temperature,
 126             const scalar pressure,
 127             const scalarField& Yf,
 128             const scalarField& m0,
 129             const scalar dt
 130         );
 131
 132
 133         void updateParcelProperties
 134         (
 135             const scalar dt,
 136             spray& sprayData,
 137             const label celli,
 138             const label facei
 139         );
 140
 141
 142 public:
 143
 144     friend class Cloud<parcel>;
 145
 146
 147     // Constructors
 148
 149         //- Construct from components
 150         parcel
 151         (
 152             const Cloud<parcel>& cloud,
 153             const vector& position,
 154             const label celli,
 155             const vector& n,
 156             const scalar d,
 157             const scalar T,
 158             const scalar m,
 159             const scalar y,
 160             const scalar yDot,
 161             const scalar ct,
 162             const scalar ms,
 163             const scalar tTurb,
 164             const scalar liquidCore,
 165             const scalar injector,
 166             const vector& U,
 167             const vector& Uturb,
 168             const scalarField& X,
 169             const List<word>& liquidNames
 170         );
 171
 172         //- Construct from Istream reading field values if required
 173         parcel
 174         (
 175             const Cloud<parcel>& cloud,
 176             Istream& is,
 177             bool readFields = true
 178         );
 179
 180
 181     // Member Functions
 182
 183         // Access
 184
 185             //- Return the names of the liquid components
 186             inline const List<word>& liquidNames() const;
 187
 188             //- Return the names of the liquid fuel components - identical with liquidNames
 189             inline const List<word>& fuelNames() const;
 190
 191             //- Return diameter of droplets in parcel
 192             inline scalar d() const;
 193
 194             //- Return diameter of droplets in parcel
 195             inline scalar& d();
 196
 197             //- Return temperature of droplets in parcel
 198             inline scalar T() const;
 199
 200             //- Return temperature of droplets in parcel
 201             inline scalar& T();
 202
 203             //- Return total parcel mass
 204             inline scalar m() const;
 205
 206             //- Return total parcel mass
 207             inline scalar& m();
 208
 209             //- Return spherical deviation of droplets in parcel
 210             inline scalar dev() const;
 211
 212             //- Return spherical deviation of droplets in parcel
 213             inline scalar& dev();
 214
 215             //- Return rate of change of spherical deviation of
 216             //  droplets in parcel
 217             inline scalar ddev() const;
 218
 219             //- Return rate of change of spherical deviation of
 220             //  droplets in parcel
 221             inline scalar& ddev();
 222
 223             //- Return characteristic time of droplets in parcel
 224             inline scalar ct() const;
 225
 226             //- Return characteristic time of droplets in parcel
 227             inline scalar& ct();
 228
 229             //- Return stripped mass of droplets in parcel
 230             inline scalar& ms();
 231
 232             //- Return stripped mass of droplets in parcel
 233             inline scalar ms() const;
 234
 235             //- Return time spent in turbulent eddy
 236             inline scalar& tTurb();
 237
 238             //- Return time spent in turbulent eddy
 239             inline scalar tTurb() const;
 240
 241             //- Return part of liquid liquidCore
 242             inline scalar& liquidCore();
 243
 244             //- Return part of liquid liquidCore
 245             inline scalar liquidCore() const;
 246
 247             //- Return the injector from which is injected
 248             inline scalar& injector();
 249
 250             //- Return the injector from which is injected
 251             inline scalar injector() const;
 252
 253             //- Return velocity of parcel
 254             inline const vector& U() const;
 255
 256             //- Return velocity of parcel
 257             inline vector& U();
 258
 259             //- Return turbulent velocity fluctuation
 260             inline const vector& Uturb() const;
 261
 262             //- Return turbulent velocity fluctuation
 263             inline vector& Uturb();
 264
 265             //- Return the normal used for 2D purposes
 266             inline const vector& n() const;
 267
 268             //- Return the normal used for 2D purposes
 269             inline vector& n();
 270
 271             //- Return the liquid components molar fractions
 272             inline const scalarField& X() const;
 273
 274             //- Return the liquid components molar fractions
 275             inline scalarField& X();
 276
 277             //- Return the momentum relaxation time of droplets in parcel
 278             inline scalar& tMom();
 279
 280             //- Return the momentum relaxation time of droplets in parcel
 281             inline scalar tMom() const;
 282
 283
 284         // Derived information
 285
 286             //- Return statistical number of drops in parcel
 287             scalar N(const scalar rho) const;
 288
 289             //- Return relative velocity between given vector and parcel
 290             inline vector Urel(const vector&) const;
 291
 292
 293         // Dimensionless Numbers
 294
 295             //- Reynolds number based on rho an dynamic viscosity
 296             scalar Re
 297             (
 298                 const scalar rho,
 299                 const vector& U,
 300                 const scalar mu
 301             ) const;
 302
 303             //- Reynolds number based on kinematic viscosity
 304             scalar Re
 305             (
 306                 const vector& U,
 307                 const scalar nu
 308             ) const;
 309
 310             //- Weber number
 311             scalar We
 312             (
 313                 const vector& U,
 314                 const scalar rho,
 315                 const scalar sigma
 316             ) const;
 317
 318             //- Schmidt number based on dynamic viscosity and rho
 319             scalar Sc
 320             (
 321                 const scalar mu,
 322                 const scalar rho,
 323                 const scalar massDiffusion
 324             ) const;
 325
 326             //- Schmidt number based on kinematic viscosity
 327             scalar Sc
 328             (
 329                 const scalar nu,
 330                 const scalar massDiffusion
 331             ) const;
 332
 333             //- Prandtl number
 334             scalar Pr
 335             (
 336                 const scalar cp,
 337                 const scalar mu,
 338                 const scalar kappa
 339             ) const;
 340
 341             //- Volume of one droplet in the parcel
 342             scalar Vd() const;
 343
 344             //- Volume of all droplets in parcel
 345             scalar V(const scalar rho) const;
 346
 347
 348         // Parcel operations
 349
 350             bool move(spray& sprayData);
 351
 352             //- Transform the position and physical properties of the particle
 353             //  according to the given transformation tensor
 354             void transformProperties(const tensor& T);
 355
 356             //- Transform the position and physical properties of the particle
 357             //  according to the given separation vector
 358             void transformProperties(const vector& separation);
 359
 360             //- Fix the 2D plane normal,
 361             //  when particle hits a face it is slightly perturbed
 362             //  towards the face centre and n_ will no longer be valid
 363             inline void correctNormal(const vector& sym);
 364
 365
 366     // I/O
 367
 368             static void readFields(Cloud<parcel>& c);
 369
 370             static void writeFields(const Cloud<parcel>& c);
 371
 372
 373     // Ostream Operator
 374
 375         friend Ostream& operator<<(Ostream&, const parcel&);
 376 };
 377
 378
 379 template<>
 380 inline bool contiguous<parcel>()
 381 {
 382     return true;
 383 }
 384
 385
 386 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 387
 388 } // End namespace Foam
 389
 390 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 391
 392 #include "parcelI.H"
 393
 394 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 395
 396 #endif
 397
 398 // ************************************************************************* //