src/lagrangian/spray/submodels/BreakupModel/ReitzKHRT/ReitzKHRT.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::ReitzKHRT
  26
  27 Description
  28    secondary breakup model which uses the Kelvin-Helmholtz
  29     instability theory to predict the 'stripped' droplets... and
  30     the Raleigh-Taylor instability as well.
  31
  32 \*---------------------------------------------------------------------------*/
  33
  34 #ifndef ReitzKHRT_H
  35 #define ReitzKHRT_H
  36
  37 #include "BreakupModel.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43 /*---------------------------------------------------------------------------*\
  44                        Class ReitzKHRT Declaration
  45 \*---------------------------------------------------------------------------*/
  46
  47 template<class CloudType>
  48 class ReitzKHRT
  49 :
  50     public BreakupModel<CloudType>
  51 {
  52 private:
  53
  54     // Private data
  55
  56         // model constants
  57         scalar b0_;
  58         scalar b1_;
  59         scalar cTau_;
  60         scalar cRT_;
  61         scalar msLimit_;
  62         scalar weberLimit_;
  63
  64
  65 public:
  66
  67     //- Runtime type information
  68     TypeName("ReitzKHRT");
  69
  70
  71     // Constructors
  72
  73         //- Construct from dictionary
  74         ReitzKHRT(const dictionary&, CloudType&);
  75
  76         //- Construct copy
  77         ReitzKHRT(const ReitzKHRT<CloudType>& bum);
  78
  79         //- Construct and return a clone
  80         virtual autoPtr<BreakupModel<CloudType> > clone() const
  81         {
  82             return autoPtr<BreakupModel<CloudType> >
  83             (
  84                 new ReitzKHRT<CloudType>(*this)
  85             );
  86         }
  87
  88
  89     //- Destructor
  90     virtual ~ReitzKHRT();
  91
  92
  93     // Member Functions
  94
  95         //- update the parcel diameter
  96         virtual bool update
  97         (
  98             const scalar dt,
  99             const vector& g,
 100             scalar& d,
 101             scalar& tc,
 102             scalar& ms,
 103             scalar& nParticle,
 104             scalar& KHindex,
 105             scalar& y,
 106             scalar& yDot,
 107             const scalar d0,
 108             const scalar rho,
 109             const scalar mu,
 110             const scalar sigma,
 111             const vector& U,
 112             const scalar rhoc,
 113             const scalar muc,
 114             const vector& Urel,
 115             const scalar Urmag,
 116             const scalar tMom,
 117             const scalar averageParcelMass,
 118             scalar& dChild,
 119             scalar& massChild,
 120             cachedRandom& rndGen
 121         ) const;
 122 };
 123
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 } // End namespace Foam
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 #ifdef NoRepository
 132 #   include "ReitzKHRT.C"
 133 #endif
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 #endif
 138
 139 // ************************************************************************* //