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

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