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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2016 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::GradientDispersionRAS
28
29Description
30 The velocity is perturbed in the direction of -grad(k), with a
31 Gaussian random number distribution with variance sigma.
32 where sigma is defined below
33
34\*---------------------------------------------------------------------------*/
35
36#ifndef GradientDispersionRAS_H
37#define GradientDispersionRAS_H
38
39#include "DispersionRASModel.H"
40
41// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42
43namespace Foam
44{
45
46/*---------------------------------------------------------------------------*\
47 Class GradientDispersionRAS Declaration
48\*---------------------------------------------------------------------------*/
49
50template<class CloudType>
52:
53 public DispersionRASModel<CloudType>
54{
55protected:
56
57 // Protected data
58
59 // Locally cached turbulence fields
60
61 //- Gradient of k
63
64 //- Take ownership of the grad(k)
65 mutable bool ownGradK_;
66
67
68public:
69
70 //- Runtime type information
71 TypeName("gradientDispersionRAS");
72
73
74 // Constructors
75
76 //- Construct from components
78
79 //- Construct copy
81
82 //- Construct and return a clone
84 {
86 (
88 );
89 }
90
91
92 //- Destructor
93 virtual ~GradientDispersionRAS();
94
95
96 // Member Functions
97
98 //- Cache carrier fields
99 virtual void cacheFields(const bool store);
100
101 //- Update (disperse particles)
102 virtual vector update
103 (
104 const scalar dt,
105 const label celli,
106 const vector& U,
107 const vector& Uc,
108 vector& UTurb,
109 scalar& tTurb
110 );
111};
112
113
114// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115
116} // End namespace Foam
117
118// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119
120#ifdef NoRepository
121 #include "GradientDispersionRAS.C"
122#endif
123
124// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125
126#endif
127
128// ************************************************************************* //
const CloudType & owner() const
Return const access to the owner cloud.
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:75
Base class for particle dispersion models based on RAS turbulence.
The velocity is perturbed in the direction of -grad(k), with a Gaussian random number distribution wi...
virtual ~GradientDispersionRAS()
Destructor.
TypeName("gradientDispersionRAS")
Runtime type information.
virtual void cacheFields(const bool store)
Cache carrier fields.
const volVectorField * gradkPtr_
Gradient of k.
virtual autoPtr< DispersionModel< CloudType > > clone() const
Construct and return a clone.
bool ownGradK_
Take ownership of the grad(k)
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
U
Definition: pEqn.H:72
mesh update()
Namespace for OpenFOAM.
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73