src/lagrangian/spray/submodels/BreakupModel/NoBreakup/NoBreakup.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::NoBreakup
  26
  27 Description
  28     Dummy breakup model for 'none'
  29
  30 \*---------------------------------------------------------------------------*/
  31
  32 #ifndef NoBreakup_H
  33 #define NoBreakup_H
  34
  35 #include "BreakupModel.H"
  36
  37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  38
  39 namespace Foam
  40 {
  41 /*---------------------------------------------------------------------------*\
  42                        Class NoBreakup Declaration
  43 \*---------------------------------------------------------------------------*/
  44
  45 template<class CloudType>
  46 class NoBreakup
  47 :
  48     public BreakupModel<CloudType>
  49 {
  50 public:
  51
  52     //- Runtime type information
  53     TypeName("none");
  54
  55
  56     // Constructors
  57
  58         //- Construct from dictionary
  59         NoBreakup(const dictionary&, CloudType&);
  60
  61         //- Construct copy
  62         NoBreakup(const NoBreakup<CloudType>& bum);
  63
  64         //- Construct and return a clone
  65         virtual autoPtr<BreakupModel<CloudType> > clone() const
  66         {
  67             return autoPtr<BreakupModel<CloudType> >
  68             (
  69                 new NoBreakup<CloudType>(*this)
  70             );
  71         }
  72
  73
  74     //- Destructor
  75     virtual ~NoBreakup();
  76
  77
  78     // Member Functions
  79
  80         //- Flag to indicate whether model activates break-up model
  81         virtual bool active() const;
  82
  83         //- update the parcel properties
  84         virtual bool update
  85         (
  86             const scalar dt,
  87             const vector& g,
  88             scalar& d,
  89             scalar& tc,
  90             scalar& ms,
  91             scalar& nParticle,
  92             scalar& KHindex,
  93             scalar& y,
  94             scalar& yDot,
  95             const scalar d0,
  96             const scalar rho,
  97             const scalar mu,
  98             const scalar sigma,
  99             const vector& U,
 100             const scalar rhoc,
 101             const scalar muc,
 102             const vector& Urel,
 103             const scalar Urmag,
 104             const scalar tMom,
 105             const scalar averageParcelMass,
 106             scalar& dChild,
 107             scalar& massChild,
 108             cachedRandom& rndGen
 109         ) const;
 110 };
 111
 112
 113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 114
 115 } // End namespace Foam
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 #ifdef NoRepository
 120 #   include "NoBreakup.C"
 121 #endif
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 #endif
 126
 127 // ************************************************************************* //