src/lagrangian/intermediate/submodels/Kinematic/DispersionModel/GradientDispersionRAS/GradientDispersionRAS.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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::GradientDispersionRAS
  27
  28 Description
  29     The velocity is perturbed in the direction of -grad(k), with a
  30     Gaussian random number distribution with variance sigma.
  31     where sigma is defined below
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef GradientDispersionRAS_H
  36 #define GradientDispersionRAS_H
  37
  38 #include "DispersionRASModel.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                     Class GradientDispersionRAS Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class CloudType>
  50 class GradientDispersionRAS
  51 :
  52     public DispersionRASModel<CloudType>
  53 {
  54 protected:
  55
  56     // Locally cached turbulence fields
  57
  58         //- Gradient of k
  59         const volVectorField* gradkPtr_;
  60
  61
  62 public:
  63
  64     //- Runtime type information
  65     TypeName("GradientDispersionRAS");
  66
  67
  68     // Constructors
  69
  70         //- Construct from components
  71         GradientDispersionRAS
  72         (
  73             const dictionary& dict,
  74             CloudType& owner
  75         );
  76
  77
  78     //- Destructor
  79     virtual ~GradientDispersionRAS();
  80
  81
  82     // Member Functions
  83
  84         //- Flag to indicate whether model activates injection model
  85         bool active() const;
  86
  87         //- Cache carrier fields
  88         virtual void cacheFields(const bool store);
  89
  90         //- Update (disperse particles)
  91         virtual vector update
  92         (
  93             const scalar dt,
  94             const label celli,
  95             const vector& U,
  96             const vector& Uc,
  97             vector& UTurb,
  98             scalar& tTurb
  99         );
 100 };
 101
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 } // End namespace Foam
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 #ifdef NoRepository
 110 #   include "GradientDispersionRAS.C"
 111 #endif
 112
 113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 114
 115 #endif
 116
 117 // ************************************************************************* //