src/lagrangian/spray/submodels/BreakupModel/PilchErdman/PilchErdman.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::PilchErdman
  26
  27 Description
  28     secondary breakup model
  29
  30     @verbatim
  31     Pilch, M. and Erdman, C.A.
  32     "Use of breakup time data and velocity history data
  33      to predict the maximum size of stable fragments for acceleration
  34      induced breakup of a liquid drop."
  35     Int. J. Multiphase Flows 13 (1987), 741-757
  36     @endverbatim
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef PilchErdman_H
  41 #define PilchErdman_H
  42
  43 #include "BreakupModel.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49 /*---------------------------------------------------------------------------*\
  50                        Class PilchErdman Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 template<class CloudType>
  54 class PilchErdman
  55 :
  56     public BreakupModel<CloudType>
  57 {
  58 private:
  59
  60     // Private data
  61
  62         scalar B1_;
  63         scalar B2_;
  64
  65
  66 public:
  67
  68     //- Runtime type information
  69     TypeName("PilchErdman");
  70
  71
  72     // Constructors
  73
  74         //- Construct from dictionary
  75         PilchErdman(const dictionary&, CloudType&);
  76
  77         //- Construct copy
  78         PilchErdman(const PilchErdman<CloudType>& bum);
  79
  80         //- Construct and return a clone
  81         virtual autoPtr<BreakupModel<CloudType> > clone() const
  82         {
  83             return autoPtr<BreakupModel<CloudType> >
  84             (
  85                 new PilchErdman<CloudType>(*this)
  86             );
  87         }
  88
  89
  90     //- Destructor
  91     virtual ~PilchErdman();
  92
  93
  94     // Member Functions
  95
  96         //- update the parcel properties
  97         virtual bool update
  98         (
  99             const scalar dt,
 100             const vector& g,
 101             scalar& d,
 102             scalar& tc,
 103             scalar& ms,
 104             scalar& nParticle,
 105             scalar& KHindex,
 106             scalar& y,
 107             scalar& yDot,
 108             const scalar d0,
 109             const scalar rho,
 110             const scalar mu,
 111             const scalar sigma,
 112             const vector& U,
 113             const scalar rhoc,
 114             const scalar muc,
 115             const vector& Urel,
 116             const scalar Urmag,
 117             const scalar tMom,
 118             const scalar averageParcelMass,
 119             scalar& dChild,
 120             scalar& massChild,
 121             cachedRandom& rndGen
 122         ) const;
 123 };
 124
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 } // End namespace Foam
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 #ifdef NoRepository
 133 #   include "PilchErdman.C"
 134 #endif
 135
 136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 137
 138 #endif
 139
 140 // ************************************************************************* //