StochasticDispersionRAS.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
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::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 template<class CloudType>
50 :
51  public DispersionRASModel<CloudType>
52 {
53 public:
54 
55  //- Runtime type information
56  TypeName("stochasticDispersionRAS");
57 
58 
59  // Constructors
60 
61  //- Construct from components
63 
64  //- Construct copy
66 
67  //- Construct and return a clone
69  {
71  (
73  );
74  }
75 
76 
77  //- Destructor
78  virtual ~StochasticDispersionRAS();
79 
80 
81  // Member Functions
82 
83  //- Update (disperse particles)
84  virtual vector update
85  (
86  const scalar dt,
87  const label celli,
88  const vector& U,
89  const vector& Uc,
90  vector& UTurb,
91  scalar& tTurb
92  );
93 };
94 
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #ifdef NoRepository
103  #include "StochasticDispersionRAS.C"
104 #endif
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual ~StochasticDispersionRAS()
Destructor.
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
const CloudType & owner() const
Return const access to the owner cloud.
TypeName("stochasticDispersionRAS")
Runtime type information.
virtual vector update(const scalar dt, const label celli, const vector &U, const vector &Uc, vector &UTurb, scalar &tTurb)
Update (disperse particles)
U
Definition: pEqn.H:72
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Base class for particle dispersion models based on RAS turbulence.
virtual autoPtr< DispersionModel< CloudType > > clone() const
Construct and return a clone.
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:69
StochasticDispersionRAS(const dictionary &dict, CloudType &owner)
Construct from components.
The velocity is perturbed in random direction, with a Gaussian random number distribution with varian...
Namespace for OpenFOAM.