src/lagrangian/spray/submodels/BreakupModel/ETAB/ETAB.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::ETAB
  26
  27 Description
  28     The Enhanced TAB model.
  29
  30     Described in the papers below.
  31     @verbatim
  32     F.X. Tanner
  33         "Liquid Jet Atomization and Droplet Breakup Modeling of
  34         Non-Evaporating Diesel Fuel Sprays"
  35         SAE 970050,
  36         SAE Transactions: Journal of Engines, Vol 106, Sec 3 pp 127-140
  37
  38     F.X. Tanner and G. Weisser
  39         "Simulation of Liquid Jet Atomization for
  40         Fuel Sprays by Means of Cascade Drop Breakup Model"
  41         SAE 980808
  42         SAE Technical Paper Series
  43     @endverbatim
  44
  45 See Also
  46     The TAB model
  47
  48 \*---------------------------------------------------------------------------*/
  49
  50 #ifndef ETAB_H
  51 #define ETAB_H
  52
  53 #include "BreakupModel.H"
  54
  55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  56
  57 namespace Foam
  58 {
  59 /*---------------------------------------------------------------------------*\
  60                        Class ETAB Declaration
  61 \*---------------------------------------------------------------------------*/
  62
  63 template<class CloudType>
  64 class ETAB
  65 :
  66     public BreakupModel<CloudType>
  67 {
  68 private:
  69
  70     // Private data
  71
  72         // Model constants
  73
  74             // Cmu_ and Comega_ are the same as in the TAB model
  75             scalar Cmu_;
  76             scalar Comega_;
  77
  78             scalar k1_;
  79             scalar k2_;
  80             scalar WeCrit_;
  81             scalar WeTransition_;
  82             scalar AWe_;
  83
  84
  85 public:
  86
  87     //- Runtime type information
  88     TypeName("ETAB");
  89
  90
  91     // Constructors
  92
  93         //- Construct from dictionary
  94         ETAB(const dictionary&, CloudType&);
  95
  96         //- Construct copy
  97         ETAB(const ETAB<CloudType>& bum);
  98
  99         //- Construct and return a clone
 100         virtual autoPtr<BreakupModel<CloudType> > clone() const
 101         {
 102             return autoPtr<BreakupModel<CloudType> >
 103             (
 104                 new ETAB<CloudType>(*this)
 105             );
 106         }
 107
 108
 109     //- Destructor
 110     virtual ~ETAB();
 111
 112
 113     // Member Functions
 114
 115         //- update the parcel properties
 116         virtual bool update
 117         (
 118             const scalar dt,
 119             const vector& g,
 120             scalar& d,
 121             scalar& tc,
 122             scalar& ms,
 123             scalar& nParticle,
 124             scalar& KHindex,
 125             scalar& y,
 126             scalar& yDot,
 127             const scalar d0,
 128             const scalar rho,
 129             const scalar mu,
 130             const scalar sigma,
 131             const vector& U,
 132             const scalar rhoc,
 133             const scalar muc,
 134             const vector& Urel,
 135             const scalar Urmag,
 136             const scalar tMom,
 137             const scalar averageParcelMass,
 138             scalar& dChild,
 139             scalar& massChild,
 140             cachedRandom& rndGen
 141         ) const;
 142 };
 143
 144
 145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 146
 147 } // End namespace Foam
 148
 149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 150
 151 #ifdef NoRepository
 152 #   include "ETAB.C"
 153 #endif
 154
 155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 156
 157 #endif
 158
 159 // ************************************************************************* //