ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / lagrangian / dieselSpray / spraySubModels / dispersionModel / gradientDispersionRAS / gradientDispersionRAS.H
blob2ea38670d701e9d6603b17b92ede4152a01fc7c6
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.
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.
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, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::gradientDispersionRAS
27 Description
28     The velocity is perturbed in the direction of -grad(k), with a
29     Gaussian random number distribution with variance sigma.
30     where sigma is defined below
32 \*---------------------------------------------------------------------------*/
34 #ifndef gradientDispersionRAS_H
35 #define gradientDispersionRAS_H
37 #include "dispersionRASModel.H"
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 namespace Foam
44 /*---------------------------------------------------------------------------*\
45                   Class gradientDispersionRAS Declaration
46 \*---------------------------------------------------------------------------*/
48 class gradientDispersionRAS
50     public dispersionRASModel
53 public:
55     //- Runtime type information
56     TypeName("gradientDispersionRAS");
59     // Constructors
61         //- Construct from components
62         gradientDispersionRAS(const dictionary& dict, spray& sm);
65     //- Destructor
66     virtual ~gradientDispersionRAS();
69     // Member Functions
71     void disperseParcels() const;
75 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
77 } // End namespace Foam
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 #endif
83 // ************************************************************************* //