File: CutTubeImplementation.h

package info (click to toggle)
vecgeom 1.2.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 23,928 kB
  • sloc: cpp: 88,717; ansic: 6,894; python: 1,035; sh: 582; sql: 538; makefile: 29
file content (370 lines) | stat: -rw-r--r-- 15,799 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
/*
 * CutTubeImplementation.h
 *
 *  Created on: 03.11.2016
 *      Author: mgheata
 */

#ifndef VECGEOM_VOLUMES_KERNEL_CUTTUBEIMPLEMENTATION_H_
#define VECGEOM_VOLUMES_KERNEL_CUTTUBEIMPLEMENTATION_H_

#include <cstdio>

#include "VecGeom/base/Vector3D.h"
#include "VecGeom/volumes/kernel/GenericKernels.h"
#include "VecGeom/volumes/CutTubeStruct.h"
#include "TubeImplementation.h"

namespace vecgeom {

VECGEOM_DEVICE_FORWARD_DECLARE(struct CutTubeImplementation;);
VECGEOM_DEVICE_DECLARE_CONV(struct, CutTubeImplementation);

inline namespace VECGEOM_IMPL_NAMESPACE {

class PlacedCutTube;
class UnplacedCutTube;

template <typename T>
struct CutTubeStruct;

struct CutTubeImplementation {

  using PlacedShape_t    = PlacedCutTube;
  using UnplacedStruct_t = CutTubeStruct<Precision>;
  using UnplacedVolume_t = UnplacedCutTube;

  VECCORE_ATT_HOST_DEVICE
  static void PrintType() {}

  template <typename Stream>
  static void PrintType(Stream &s, int transCodeT = translation::kGeneric, int rotCodeT = rotation::kGeneric)
  {
    s << "SpecializedCutTube<" << transCodeT << "," << rotCodeT << ">";
  }

  template <typename Stream>
  static void PrintImplementationType(Stream & /*s*/)
  {
  }

  template <typename Stream>
  static void PrintUnplacedType(Stream & /*s*/)
  {
  }

  template <typename Real_v, typename Bool_v>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static void Contains(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &point, Bool_v &inside);

  template <typename Real_v, typename Inside_t>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static void Inside(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &point, Inside_t &inside);

  template <typename Real_v>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static void DistanceToIn(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &point,
                           Vector3D<Real_v> const &direction, Real_v const &stepMax, Real_v &distance);

  template <typename Real_v>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static void DistanceToInKernel(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &point,
                                 Vector3D<Real_v> const &direction, Real_v const &stepMax, Real_v &distance);

  template <typename Real_v>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static void DistanceToOut(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &point,
                            Vector3D<Real_v> const &direction, Real_v const &stepMax, Real_v &distance);

  template <typename Real_v>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static void SafetyToIn(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &point, Real_v &safety);

  template <typename Real_v>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static void SafetyToOut(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &point, Real_v &safety);

  template <typename Real_v, typename Bool_v>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static void NormalKernel(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &point, Vector3D<Real_v> &normal,
                           Bool_v &valid);
}; // End struct CutTubeImplementation

//********************************
//**** implementations start here
//********************************/

//______________________________________________________________________________
template <typename Real_v, typename Bool_v>
VECGEOM_FORCE_INLINE
VECCORE_ATT_HOST_DEVICE
void CutTubeImplementation::Contains(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &point, Bool_v &contains)
{
  contains                = Bool_v(false);
  Bool_v inside_cutplanes = Bool_v(false);
  // Check the cut planes first
  unplaced.GetCutPlanes().Contains<Real_v, Bool_v>(point, inside_cutplanes);
  if (vecCore::EarlyReturnAllowed()) {
    if (vecCore::MaskEmpty(inside_cutplanes)) return;
  }
  // Check the tube
  TubeImplementation<TubeTypes::UniversalTube>::Contains<Real_v>(unplaced.GetTubeStruct(), point, contains);
  contains &= inside_cutplanes;
}

//______________________________________________________________________________
template <typename Real_v, typename Inside_t>
VECGEOM_FORCE_INLINE
VECCORE_ATT_HOST_DEVICE
void CutTubeImplementation::Inside(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &point, Inside_t &inside)
{
  inside                    = Inside_t(EInside::kOutside);
  Inside_t inside_cutplanes = Inside_t(EInside::kOutside);
  // Check the cut planes first
  unplaced.GetCutPlanes().Inside<Real_v, Inside_t>(point, inside_cutplanes);
  if (vecCore::EarlyReturnAllowed()) {
    if (vecCore::MaskFull(inside_cutplanes == inside)) return;
  }
  // Check the tube
  TubeImplementation<TubeTypes::UniversalTube>::Inside<Real_v, Inside_t>(unplaced.GetTubeStruct(), point, inside);
  vecCore::MaskedAssign(inside,
                        (inside_cutplanes == EInside::kOutside) ||
                            (inside_cutplanes == EInside::kSurface && inside != EInside::kOutside),
                        inside_cutplanes);
}

template <typename Real_v>
VECGEOM_FORCE_INLINE
VECCORE_ATT_HOST_DEVICE
void CutTubeImplementation::DistanceToIn(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &pointT,
                                         Vector3D<Real_v> const &dir, Real_v const &stepMax, Real_v &distance)
{

  Vector3D<Real_v> point = pointT;
  Real_v ptDist          = point.Mag();
  Real_v distToMove(0.);
  using Bool_v    = vecCore::Mask_v<Real_v>;
  Precision order = 100.;
  // Bool_v cond = (ptDist > order*unplaced.fTubeStruct.fMaxVal);
  Bool_v cond = (ptDist > order * unplaced.fMaxVal);
  /* if the point is at a distance (DIST) of more than 100 times of the maximum dimension
   * (of the shape) from the origin of shape, then before calculating distance, first
   * manually move the point with distance ( distToMove = DIST-100.*maxDim) along the
   * direction, and then calculate DistanceToIn of new moved point using DistanceToInKernel,
   *
   * The final distance will be (distToMove + DistanceToIn),
   */
  // vecCore__MaskedAssignFunc(distToMove,cond,(ptDist-Real_v(order*unplaced.fTubeStruct.fMaxVal)));
  vecCore__MaskedAssignFunc(distToMove, cond, (ptDist - Real_v(order * unplaced.fMaxVal)));
  vecCore__MaskedAssignFunc(point, cond, point + distToMove * dir);
  DistanceToInKernel<Real_v>(unplaced, point, dir, stepMax, distance);
  distance += distToMove;
}
//______________________________________________________________________________
template <typename Real_v>
VECGEOM_FORCE_INLINE
VECCORE_ATT_HOST_DEVICE
void CutTubeImplementation::DistanceToInKernel(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &point,
                                               Vector3D<Real_v> const &direction, Real_v const &stepMax,
                                               Real_v &distance)
{

#define USE_CONV_WRONG_SIDE 1
#define USE_CONV_FROM_BOUNDARY 1
  // Compute distance to cut planes
  using Bool_v = vecCore::Mask_v<Real_v>;
  distance     = InfinityLength<Real_v>();

#if USE_CONV_WRONG_SIDE == 1
  using Inside_v = vecCore::Index_v<Real_v>;
  // Check the cut planes first
  Inside_v inside_cutplanes;
  unplaced.GetCutPlanes().Inside<Real_v, Inside_v>(point, inside_cutplanes);
  Inside_v instart;
  // Check the tube
  TubeImplementation<TubeTypes::UniversalTube>::Inside<Real_v, Inside_v>(unplaced.GetTubeStruct(), point, instart);
  vecCore::MaskedAssign(instart,
                        (inside_cutplanes == EInside::kOutside) ||
                            (inside_cutplanes == EInside::kSurface && instart != EInside::kOutside),
                        inside_cutplanes);
  // Points already inside have to return negative distance
  vecCore__MaskedAssignFunc(distance, instart == EInside::kInside, Real_v(-1.));
#endif

  Bool_v inside;
  Real_v dplanes, safplanes;
  // Compute distance to cut planes
  unplaced.GetCutPlanes().DistanceToIn<Real_v>(point, direction, dplanes);
  // We need the safety to cut out points already inside the cut planes.
  // Unfortunately there is no easy way to get the right normal in vector mode to avoid safety calculation
  unplaced.GetCutPlanes().SafetyToIn<Real_v>(point, safplanes);

  // Mark tracks hitting the planes
  Bool_v hitplanes = vecCore::math::Abs(dplanes) < stepMax && safplanes > Real_v(-kTolerance);

#if USE_CONV_WRONG_SIDE == 1
  if (vecCore::EarlyReturnAllowed()) {
    if (vecCore::MaskFull((inside_cutplanes != EInside::kInside) && !hitplanes)) // No particles are hitting
      return;
  }
#endif

  // Propagate with dplanes only the particles that are hitting
  Vector3D<Real_v> propagated = point;
  vecCore__MaskedAssignFunc(dplanes, !hitplanes, Real_v(0.));
  if (vecCore::EarlyReturnAllowed()) {
    if (!vecCore::MaskEmpty(hitplanes)) {
      propagated += dplanes * direction;
      // Hitting the planes does not guarantee that the hit point is between them
      unplaced.GetCutPlanes().Inside<Real_v, Inside_v>(propagated, inside_cutplanes);
    }
  } else {
    // In CUDA we have to propagate in all cases
    propagated += dplanes * direction;
    // Hitting the planes does not guarantee that the hit point is between them
    unplaced.GetCutPlanes().Inside<Real_v, Inside_v>(propagated, inside_cutplanes);
  }
  Bool_v done = inside_cutplanes == EInside::kOutside;
#if USE_CONV_WRONG_SIDE == 1
  done |= instart == EInside::kInside;
#endif
  // Tracks that cannot get between the cut planes cannot hit
  if (vecCore::EarlyReturnAllowed()) {
    if (vecCore::MaskFull(done)) // No particles are hitting
      return;
  }

  // All propagated points not yet marked as done should now lie between the cut planes
  // Check now which of the propagated points already entering the solid
  TubeImplementation<TubeTypes::UniversalTube>::Inside<Real_v>(unplaced.GetTubeStruct(), propagated, instart);
  inside = hitplanes && (instart != EInside::kOutside);
  vecCore::MaskedAssign(distance, inside && !done, dplanes);
  done |= inside;

  if (vecCore::EarlyReturnAllowed()) {
    if (vecCore::MaskFull(done)) { // Some particles hit top/bottom
      // The line below is needed for the convention
      vecCore__MaskedAssignFunc(distance, vecCore::math::Abs(distance) < Real_v(kTolerance), Real_v(0.));
      return;
    }
  }

  // The limit distance for tube crossing cannot exceed the distance to
  // exiting the cut planes
  Real_v dexit = InfinityLength<Real_v>();
  unplaced.GetCutPlanes().DistanceToOut<Real_v>(propagated, direction, dexit);

  // Compute distance to tube
  Real_v dtube = InfinityLength<Real_v>();
  TubeImplementation<TubeTypes::UniversalTube>::DistanceToInKernel<Real_v>(unplaced.GetTubeStruct(), propagated,
                                                                           direction, stepMax, dtube);
  // A.G Propagation to cut planes can put the point inside the tube, so DistanceToIn may return -1
  // In such case we need to set dtube to 0, otherwise we may get wrong negative answers
  vecCore__MaskedAssignFunc(dtube, dtube < Real_v(0.), Real_v(0.));
  vecCore__MaskedAssignFunc(dtube, dexit < dtube, InfinityLength<Real_v>());
  vecCore__MaskedAssignFunc(distance, !done && (dtube + dplanes) < stepMax, dtube + dplanes);
// The line below is needed for the convention
#if USE_CONV_FROM_BOUNDARY == 1
//  vecCore__MaskedAssignFunc(distance, vecCore::math::Abs(distance) < Real_v(kTolerance), Real_v(0.));
#endif
}

//______________________________________________________________________________
template <typename Real_v>
VECGEOM_FORCE_INLINE
VECCORE_ATT_HOST_DEVICE
void CutTubeImplementation::DistanceToOut(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &point,
                                          Vector3D<Real_v> const &direction, Real_v const &stepMax, Real_v &distance)
{
  // Compute distance to cut planes
  distance = InfinityLength<Real_v>();
  unplaced.GetCutPlanes().DistanceToOut<Real_v>(point, direction, distance);

  // Compute distance to tube
  Real_v dtube = InfinityLength<Real_v>();
  TubeImplementation<TubeTypes::UniversalTube>::DistanceToOut<Real_v>(unplaced.GetTubeStruct(), point, direction,
                                                                      stepMax, dtube);
  vecCore::MaskedAssign(distance, dtube < distance, dtube);
  // The line below is needed to avoid din=dout=0 when starting from a boundary
  // A.G. There should be a dir.dot.norm check to avoid the condition above. Rounding to tolerance
  //      prevents G4UnionSolid to exit correctly from the boundary crossing loop
  //vecCore__MaskedAssignFunc(distance, distance >= Real_v(0.) && distance < Real_v(kTolerance), Real_v(kTolerance));
}

//______________________________________________________________________________
template <typename Real_v>
VECGEOM_FORCE_INLINE
VECCORE_ATT_HOST_DEVICE
void CutTubeImplementation::SafetyToIn(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &point, Real_v &safety)
{
  // Compute safety to cut planes. These will contain the sign, i.e. if on
  // the wrong side they will be negative
  unplaced.GetCutPlanes().SafetyToIn<Real_v>(point, safety);
  Real_v saftube;
  // Compute safety to tube
  TubeImplementation<TubeTypes::UniversalTube>::SafetyToIn<Real_v>(unplaced.GetTubeStruct(), point, saftube);
  // The safety is the maximum of the 2 values
  vecCore::MaskedAssign(safety, saftube > safety, saftube);
  // The line below is needed for the rounding convention
  //  vecCore__MaskedAssignFunc(safety, vecCore::math::Abs(safety) < Real_v(kTolerance), Real_v(0.));
}

//______________________________________________________________________________
template <typename Real_v>
VECCORE_ATT_HOST_DEVICE
void CutTubeImplementation::SafetyToOut(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &point, Real_v &safety)
{
  // Compute safety to cut planes. These will contain the sign, i.e. if on
  // the wrong side they will be negative
  unplaced.GetCutPlanes().SafetyToOut<Real_v>(point, safety);
  Real_v saftube;
  // Compute safety to tube
  TubeImplementation<TubeTypes::UniversalTube>::SafetyToOut<Real_v>(unplaced.GetTubeStruct(), point, saftube);
  // The safety is the minimum of the 2 values
  vecCore::MaskedAssign(safety, saftube < safety, saftube);
  // The line below is needed for the rounding convention
  //  vecCore__MaskedAssignFunc(safety, vecCore::math::Abs(safety) < Real_v(kTolerance), Real_v(0.));
}

//______________________________________________________________________________
template <typename Real_v, typename Bool_v>
VECCORE_ATT_HOST_DEVICE
void CutTubeImplementation::NormalKernel(UnplacedStruct_t const &unplaced, Vector3D<Real_v> const &point,
                                         Vector3D<Real_v> &normal, Bool_v &valid)
{
  // Compute safety to cut planes
  valid = Bool_v(true);
  Real_v safcut;
  unplaced.GetCutPlanes().SafetyToOut<Real_v>(point, safcut);
  // Compute safety to tube
  Real_v saftube;
  TubeImplementation<TubeTypes::UniversalTube>::SafetyToOut<Real_v>(unplaced.GetTubeStruct(), point, saftube);
  Bool_v istube = vecCore::math::Abs(saftube) < vecCore::math::Abs(safcut);
  // The statement below works only as long as Real_v is scalar
  if (istube) {
    TubeImplementation<TubeTypes::UniversalTube>::NormalKernel<Real_v, Bool_v>(unplaced.GetTubeStruct(), point, normal,
                                                                               valid);
    return;
  }
  // Select the correct cut plane
  if (point.z() < 0)
    normal = unplaced.fCutPlanes.GetNormal(0);
  else
    normal = unplaced.fCutPlanes.GetNormal(1);
}

//*****************************
//**** Implementations end here
//*****************************
} // namespace VECGEOM_IMPL_NAMESPACE
} // namespace vecgeom

#endif /* VECGEOM_VOLUMES_KERNEL_CUTTUBEIMPLEMENTATION_H_ */