BrownianMotionForce.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) 2011-2016 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::BrownianMotionForce
26 
27 Description
28  Calculates particle Brownian motion force.
29 
30  Reference:
31  \verbatim
32  Li, A., & Ahmadi, G. (1992).
33  Dispersion and deposition of spherical particles from point sources
34  in a turbulent channel flow.
35  Aerosol science and technology,
36  16(4), 209-226.
37  \endverbatim
38 
39 SourceFiles
40  BrownianMotionForceI.H
41  BrownianMotionForce.C
42 
43 \*---------------------------------------------------------------------------*/
44 
45 #ifndef BrownianMotionForce_H
46 #define BrownianMotionForce_H
47 
48 #include "ParticleForce.H"
49 #include "cachedRandom.H"
50 
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52 
53 namespace Foam
54 {
55 
56 /*---------------------------------------------------------------------------*\
57  Class BrownianMotionForce Declaration
58 \*---------------------------------------------------------------------------*/
59 
60 template<class CloudType>
62 :
63  public ParticleForce<CloudType>
64 {
65  // Private data
66 
67  //- Reference to the cloud random number generator
68  cachedRandom& rndGen_;
69 
70  //- Molecular free path length [m]
71  const scalar lambda_;
72 
73  //- Turbulence flag
74  bool turbulence_;
75 
76  //- Pointer to the turbulence kinetic energy field
77  const volScalarField* kPtr_;
78 
79  //- Flag that indicates ownership of turbulence k field
80  bool ownK_;
81 
82 
83  // Private Member Functions
84 
85  //- Inverse erf for Gaussian distribution
86  scalar erfInv(const scalar y) const;
87 
88  //- Return the k field from the turbulence model
89  tmp<volScalarField> kModel() const;
90 
91 
92 public:
93 
94  //- Runtime type information
95  TypeName("BrownianMotion");
96 
97 
98  // Constructors
99 
100  //- Construct from mesh
102  (
103  CloudType& owner,
104  const fvMesh& mesh,
105  const dictionary& dict
106  );
107 
108  //- Construct copy
110 
111  //- Construct and return a clone
112  virtual autoPtr<ParticleForce<CloudType>> clone() const
113  {
115  (
117  );
118  }
119 
120 
121  //- Destructor
122  virtual ~BrownianMotionForce();
123 
124 
125  // Member Functions
126 
127  // Access
128 
129  //- Return const access to the molecular free path length [m]
130  inline scalar lambda() const;
131 
132  //- Return const access to the turbulence flag
133  inline bool turbulence() const;
134 
135 
136  // Evaluation
137 
138  //- Cache fields
139  virtual void cacheFields(const bool store);
140 
141  //- Calculate the coupled force
142  virtual forceSuSp calcCoupled
143  (
144  const typename CloudType::parcelType& p,
145  const scalar dt,
146  const scalar mass,
147  const scalar Re,
148  const scalar muc
149  ) const;
150 };
151 
152 
153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
154 
155 } // End namespace Foam
156 
157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158 
159 #include "BrownianMotionForceI.H"
160 
161 #ifdef NoRepository
162  #include "BrownianMotionForce.C"
163 #endif
164 
165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
166 
167 #endif
168 
169 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const fvMesh & mesh() const
Return the mesh database.
Abstract base class for particle forces.
Definition: ParticleForce.H:53
virtual autoPtr< ParticleForce< CloudType > > clone() const
Construct and return a clone.
Random number generator.
Definition: cachedRandom.H:63
const CloudType & owner() const
Return const access to the cloud owner.
bool turbulence() const
Return const access to the turbulence flag.
Helper container for force Su and Sp terms.
Definition: forceSuSp.H:61
scalar y
TypeName("BrownianMotion")
Runtime type information.
BrownianMotionForce(CloudType &owner, const fvMesh &mesh, const dictionary &dict)
Construct from mesh.
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:218
virtual void cacheFields(const bool store)
Cache fields.
virtual forceSuSp calcCoupled(const typename CloudType::parcelType &p, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
Calculate the coupled force.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
scalar lambda() const
Return const access to the molecular free path length [m].
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
virtual ~BrownianMotionForce()
Destructor.
volScalarField & p
A class for managing temporary objects.
Definition: PtrList.H:53
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:69
scalarField Re(const UList< complex > &cf)
Definition: complexFields.C:97
Namespace for OpenFOAM.
Calculates particle Brownian motion force.