src/lagrangian/dieselSpray/spraySubModels/dispersionModel/stochasticDispersionRAS/stochasticDispersionRAS.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::stochasticDispersionRAS
  26
  27 Description
  28     The velocity is perturbed in random direction, with a
  29     Gaussian random number distribution with variance sigma.
  30     where sigma is defined below
  31
  32 \*---------------------------------------------------------------------------*/
  33
  34 #ifndef stochasticDispersionRAS_H
  35 #define stochasticDispersionRAS_H
  36
  37 #include "dispersionRASModel.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 /*---------------------------------------------------------------------------*\
  45                            Class stochasticDispersionRAS Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 class stochasticDispersionRAS
  49 :
  50     public dispersionRASModel
  51 {
  52
  53 public:
  54
  55     //- Runtime type information
  56     TypeName("stochasticDispersionRAS");
  57
  58
  59     // Constructors
  60
  61         //- Construct from components
  62         stochasticDispersionRAS
  63         (
  64             const dictionary& dict,
  65             spray& sm
  66         );
  67
  68
  69     // Destructor
  70
  71         ~stochasticDispersionRAS();
  72
  73
  74     // Member Functions
  75
  76     void disperseParcels() const;
  77 };
  78
  79
  80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  81
  82 } // End namespace Foam
  83
  84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  85
  86 #endif
  87
  88 // ************************************************************************* //