FreeFOAM The Cross-Platform CFD Toolkit
GradientDispersionRAS.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::GradientDispersionRAS
26 
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
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef GradientDispersionRAS_H
35 #define GradientDispersionRAS_H
36 
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 /*---------------------------------------------------------------------------*\
45  Class GradientDispersionRAS Declaration
46 \*---------------------------------------------------------------------------*/
47 
48 template<class CloudType>
50 :
51  public DispersionRASModel<CloudType>
52 {
53 protected:
54 
55  // Locally cached turbulence fields
56 
57  //- Gradient of k
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("GradientDispersionRAS");
65 
66 
67  // Constructors
68 
69  //- Construct from components
71  (
72  const dictionary& dict,
73  CloudType& owner
74  );
75 
76 
77  //- Destructor
78  virtual ~GradientDispersionRAS();
79 
80 
81  // Member Functions
82 
83  //- Flag to indicate whether model activates injection model
84  bool active() const;
85 
86  //- Cache carrier fields
87  virtual void cacheFields(const bool store);
88 
89  //- Update (disperse particles)
90  virtual vector update
91  (
92  const scalar dt,
93  const label celli,
94  const vector& U,
95  const vector& Uc,
96  vector& UTurb,
97  scalar& tTurb
98  );
99 };
100 
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #ifdef NoRepository
110 #endif
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 #endif
115 
116 // ************************ vim: set sw=4 sts=4 et: ************************ //