initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / lagrangian / dieselSpray / spraySubModels / dispersionModel / stochasticDispersionRAS / stochasticDispersionRAS.H
blob9cf767d49db6c07dfe2a6c2640877f07d3a36d1a
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.
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.
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.
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
25 Class
26     Foam::stochasticDispersionRAS
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 
33 \*---------------------------------------------------------------------------*/
35 #ifndef stochasticDispersionRAS_H
36 #define stochasticDispersionRAS_H
38 #include "dispersionRASModel.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 /*---------------------------------------------------------------------------*\
46                            Class stochasticDispersionRAS Declaration
47 \*---------------------------------------------------------------------------*/
49 class stochasticDispersionRAS
51     public dispersionRASModel
54 public:
56     //- Runtime type information
57     TypeName("stochasticDispersionRAS");
60     // Constructors
62         //- Construct from components
63         stochasticDispersionRAS
64         (
65             const dictionary& dict,
66             spray& sm
67         );
70     // Destructor
72         ~stochasticDispersionRAS();
75     // Member Functions
77     void disperseParcels() const;
81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 } // End namespace Foam
85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 #endif
89 // ************************************************************************* //