DSMCParcel.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-2022 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::DSMCParcel
26 
27 Description
28  DSMC parcel class
29 
30 SourceFiles
31  DSMCParcelI.H
32  DSMCParcel.C
33  DSMCParcelIO.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef DSMCParcel_H
38 #define DSMCParcel_H
39 
40 #include "particle.H"
41 #include "IOstream.H"
42 #include "autoPtr.H"
43 #include "contiguous.H"
44 #include "DSMCCloud.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 template<class ParcelType>
52 class DSMCParcel;
53 
54 // Forward declaration of friend functions
55 
56 template<class ParcelType>
57 Ostream& operator<<
58 (
59  Ostream&,
61 );
62 
63 /*---------------------------------------------------------------------------*\
64  Class DSMCParcel Declaration
65 \*---------------------------------------------------------------------------*/
66 
67 template<class ParcelType>
68 class DSMCParcel
69 :
70  public ParcelType
71 {
72  // Private member data
73 
74  //- Size in bytes of the fields
75  static const std::size_t sizeofFields_;
76 
77 
78 public:
79 
80  //- Class to hold DSMC particle constant properties
81  class constantProperties
82  {
83  // Private Data
84 
85  //- Particle mass [kg] (constant)
86  scalar mass_;
87 
88  //- Particle hard sphere diameter [m] (constant)
89  scalar d_;
90 
91  //- Internal degrees of freedom
92  direction internalDegreesOfFreedom_;
93 
94  //- Viscosity index
95  scalar omega_;
96 
97 
98  public:
99 
100  // Constructors
101 
102  //- Null constructor, allows List of constantProperties to be
103  // created before the contents is initialised
104  inline constantProperties();
105 
106  //- Constructor from dictionary
107  inline constantProperties(const dictionary& dict);
108 
109 
110  // Member Functions
111 
112  //- Return const access to the particle mass [kg]
113  inline scalar mass() const;
114 
115  //- Return const access to the hard sphere diameter [m]
116  inline scalar d() const;
117 
118  //- Return the reference total collision cross section
119  inline scalar sigmaT() const;
120 
121  //- Return the internalDegreesOfFreedom
122  inline direction internalDegreesOfFreedom() const;
123 
124  //- Return the viscosity index
125  inline scalar omega() const;
126 
127  };
128 
129 
130  //- Use base tracking data
131  typedef typename ParcelType::trackingData trackingData;
132 
133 
134 protected:
135 
136  // Protected member data
137 
138  // Parcel properties
139 
140  //- Velocity of Parcel [m/s]
141  vector U_;
142 
143  //- Internal energy of the Parcel, covering all non-translational
144  // degrees of freedom [J]
145  scalar Ei_;
146 
147  //- Parcel type id
148  label typeId_;
149 
150 
151 public:
152 
153  //- Runtime type information
154  TypeName("DSMCParcel");
156  friend class Cloud<ParcelType>;
157 
158 
159  // Constructors
160 
161  //- Construct from components
162  inline DSMCParcel
163  (
164  const polyMesh& mesh,
165  const barycentric& coordinates,
166  const label celli,
167  const label tetFacei,
168  const label tetPti,
169  const vector& U,
170  const scalar Ei,
171  const label typeId
172  );
173 
174  //- Construct from a position and a cell, searching for the rest of the
175  // required topology
176  inline DSMCParcel
177  (
178  const polyMesh& mesh,
179  const vector& position,
180  const label celli,
181  const vector& U,
182  const scalar Ei,
183  const label typeId
184  );
185 
186  //- Construct from Istream
187  DSMCParcel
188  (
189  const polyMesh& mesh,
190  Istream& is,
191  bool readFields = true
192  );
193 
194  //- Construct and return a clone
195  virtual autoPtr<particle> clone() const
196  {
197  return autoPtr<particle>(new DSMCParcel<ParcelType>(*this));
198  }
199 
200  //- Factory class to read-construct particles used for
201  // parallel transfer
202  class iNew
203  {
204  const polyMesh& mesh_;
205 
206  public:
208  iNew(const polyMesh& mesh)
209  :
210  mesh_(mesh)
211  {}
213  autoPtr<DSMCParcel<ParcelType>> operator()(Istream& is) const
214  {
216  (
217  new DSMCParcel<ParcelType>(mesh_, is, true)
218  );
219  }
220  };
221 
222 
223  // Member Functions
224 
225  // Access
226 
227  //- Return type id
228  inline label typeId() const;
229 
230  //- Return const access to velocity
231  inline const vector& U() const;
232 
233  //- Return const access to internal energy
234  inline scalar Ei() const;
235 
236 
237  // Edit
238 
239  //- Return access to velocity
240  inline vector& U();
241 
242  //- Return access to internal energy
243  inline scalar& Ei();
244 
245 
246  // Main calculation loop
247 
248  // Tracking
249 
250  //- Move the parcel
251  template<class TrackCloudType>
252  bool move
253  (
254  TrackCloudType& cloud,
255  trackingData& td,
256  const scalar trackTime
257  );
258 
259 
260  // Patch interactions
261 
262  //- Overridable function to handle the particle hitting a wallPatch
263  template<class TrackCloudType>
264  void hitWallPatch(TrackCloudType&, trackingData&);
265 
266  //- Transform the physical properties of the particle
267  // according to the given transformation tensor
268  virtual void transformProperties(const transformer&);
269 
270 
271  // I-O
272 
273  static void readFields(Cloud<DSMCParcel<ParcelType>>& c);
274 
275  static void writeFields(const Cloud<DSMCParcel<ParcelType>>& c);
276 
277 
278  // Ostream Operator
279 
280  friend Ostream& operator<< <ParcelType>
281  (
282  Ostream&,
284  );
285 };
286 
287 
288 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
289 
290 } // End namespace Foam
291 
292 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
293 
294 #include "DSMCParcelI.H"
295 
296 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
297 
298 #ifdef NoRepository
299  #include "DSMCParcel.C"
300 #endif
301 
302 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
303 
304 #endif
305 
306 // ************************************************************************* //
TypeName("DSMCParcel")
Runtime type information.
dictionary dict
Vector-tensor class used to perform translations, rotations and scaling operations in 3D space...
Definition: transformer.H:83
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
uint8_t direction
Definition: direction.H:45
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
label typeId_
Parcel type id.
Definition: DSMCParcel.H:147
Template function to specify if the data of a type are contiguous.
DSMC parcel class.
Definition: DSMCParcel.H:51
fvMesh & mesh
virtual autoPtr< particle > clone() const
Construct and return a clone.
Definition: DSMCParcel.H:194
const dimensionedScalar c
Speed of light in a vacuum.
void hitWallPatch(TrackCloudType &, trackingData &)
Overridable function to handle the particle hitting a wallPatch.
Definition: DSMCParcel.C:76
scalar sigmaT() const
Return the reference total collision cross section.
Definition: DSMCParcelI.H:111
static void readFields(Cloud< DSMCParcel< ParcelType >> &c)
Definition: DSMCParcelIO.C:79
static void writeFields(const Cloud< DSMCParcel< ParcelType >> &c)
Definition: DSMCParcelIO.C:113
constantProperties()
Null constructor, allows List of constantProperties to be.
Definition: DSMCParcelI.H:31
scalar omega() const
Return the viscosity index.
Definition: DSMCParcelI.H:128
Class to hold DSMC particle constant properties.
Definition: DSMCParcel.H:80
Factory class to read-construct particles used for.
Definition: DSMCParcel.H:201
A cloud is a collection of lagrangian particles.
Definition: cloud.H:51
direction internalDegreesOfFreedom() const
Return the internalDegreesOfFreedom.
Definition: DSMCParcelI.H:119
scalar mass() const
Return const access to the particle mass [kg].
Definition: DSMCParcelI.H:96
Base cloud calls templated on particle type.
Definition: Cloud.H:52
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
scalar d() const
Return const access to the hard sphere diameter [m].
Definition: DSMCParcelI.H:103
bool move(TrackCloudType &cloud, trackingData &td, const scalar trackTime)
Move the parcel.
Definition: DSMCParcel.C:34
virtual void transformProperties(const transformer &)
Transform the physical properties of the particle.
Definition: DSMCParcel.C:168
ParcelType::trackingData trackingData
Use base tracking data.
Definition: DSMCParcel.H:130
scalar Ei_
Internal energy of the Parcel, covering all non-translational.
Definition: DSMCParcel.H:144
scalar Ei() const
Return const access to internal energy.
Definition: DSMCParcelI.H:151
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:76
vector U_
Velocity of Parcel [m/s].
Definition: DSMCParcel.H:140
label typeId() const
Return type id.
Definition: DSMCParcelI.H:137
DSMCParcel(const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti, const vector &U, const scalar Ei, const label typeId)
Construct from components.
Definition: DSMCParcelI.H:56
Namespace for OpenFOAM.
const vector & U() const
Return const access to velocity.
Definition: DSMCParcelI.H:144