BrownianMotionForce.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-2024 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 "randomGenerator.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  //- Molecular free path length [m]
68  const scalar lambda_;
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("BrownianMotion");
75 
76 
77  // Constructors
78 
79  //- Construct from mesh
81  (
83  const fvMesh& mesh,
84  const dictionary& dict
85  );
86 
87  //- Construct copy
89 
90  //- Construct and return a clone
92  {
94  (
96  );
97  }
98 
99 
100  //- Destructor
101  virtual ~BrownianMotionForce();
102 
103 
104  // Member Functions
105 
106  // Access
107 
108  //- Return const access to the molecular free path length [m]
109  inline scalar lambda() const;
110 
111 
112  // Evaluation
113 
114  //- Calculate the coupled force
115  virtual forceSuSp calcCoupled
116  (
117  const typename CloudType::parcelType& p,
118  const typename CloudType::parcelType::trackingData& td,
119  const scalar dt,
120  const scalar mass,
121  const scalar Re,
122  const scalar muc
123  ) const;
124 };
125 
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 } // End namespace Foam
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #include "BrownianMotionForceI.H"
134 
135 #ifdef NoRepository
136  #include "BrownianMotionForce.C"
137 #endif
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 #endif
142 
143 // ************************************************************************* //
Calculates particle Brownian motion force.
TypeName("BrownianMotion")
Runtime type information.
BrownianMotionForce(CloudType &owner, const fvMesh &mesh, const dictionary &dict)
Construct from mesh.
scalar lambda() const
Return const access to the molecular free path length [m].
virtual ~BrownianMotionForce()
Destructor.
virtual autoPtr< ParticleForce< CloudType > > clone() const
Construct and return a clone.
virtual forceSuSp calcCoupled(const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
Calculate the coupled force.
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:80
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:225
Abstract base class for particle forces.
Definition: ParticleForce.H:54
const CloudType & owner() const
Return const access to the cloud owner.
const fvMesh & mesh() const
Return the mesh database.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Helper container for force Su and Sp terms.
Definition: forceSuSp.H:64
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:96
Namespace for OpenFOAM.
scalarField Re(const UList< complex > &cf)
Definition: complexFields.C:97
dictionary dict
volScalarField & p