File: OrbImplementation.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 (245 lines) | stat: -rw-r--r-- 9,209 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
// This file is part of VecGeom and is distributed under the
// conditions in the file LICENSE.txt in the top directory.
// For the full list of authors see CONTRIBUTORS.txt and `git log`.

/// \brief This file implements the algorithms for Orb
/// \file volumes/kernel/orbImplementation.h
/// \author Raman Sehgal

/// History notes:
/// 2014 - 2015: original development (abstracted kernels); Raman Sehgal
/// July 2016: revision + moving to new backend structure (Raman Sehgal)

#ifndef VECGEOM_VOLUMES_KERNEL_ORBIMPLEMENTATION_H_
#define VECGEOM_VOLUMES_KERNEL_ORBIMPLEMENTATION_H_

#include "VecGeom/base/Vector3D.h"
#include "VecGeom/volumes/OrbStruct.h"
#include "VecGeom/volumes/kernel/GenericKernels.h"
#include <VecCore/VecCore>

#include <cstdio>

namespace vecgeom {

VECGEOM_DEVICE_FORWARD_DECLARE(struct OrbImplementation;);
VECGEOM_DEVICE_DECLARE_CONV(struct, OrbImplementation);

inline namespace VECGEOM_IMPL_NAMESPACE {

class PlacedOrb;
template <typename T>
struct OrbStruct;
class UnplacedOrb;

struct OrbImplementation {

  using PlacedShape_t    = PlacedOrb;
  using UnplacedStruct_t = OrbStruct<Precision>;
  using UnplacedVolume_t = UnplacedOrb;

  VECCORE_ATT_HOST_DEVICE
  static void PrintType()
  {
    //  printf("SpecializedOrb<%i, %i>", transCodeT, rotCodeT);
  }

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

  template <typename Stream>
  static void PrintImplementationType(Stream &st)
  {
    (void)st;
    // st << "OrbImplementation<" << transCodeT << "," << rotCodeT << ">";
  }

  template <typename Stream>
  static void PrintUnplacedType(Stream &st)
  {
    (void)st;
    // TODO: this is wrong
    // st << "UnplacedOrb";
  }

  template <typename Real_v, typename Bool_v>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static void Contains(UnplacedStruct_t const &orb, Vector3D<Real_v> const &point, Bool_v &inside)
  {
    Bool_v unused, outside;
    GenericKernelForContainsAndInside<Real_v, Bool_v, false>(orb, point, unused, outside);
    inside = !outside;
  }

  // BIG QUESTION: DO WE WANT TO GIVE ALL 3 TEMPLATE PARAMETERS
  // -- OR -- DO WE WANT TO DEDUCE Bool_v, Index_t from Real_v???
  template <typename Real_v, typename Inside_t>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static void Inside(UnplacedStruct_t const &orb, Vector3D<Real_v> const &point, Inside_t &inside)
  {

    using Bool_v       = vecCore::Mask_v<Real_v>;
    using InsideBool_v = vecCore::Mask_v<Inside_t>;
    Bool_v completelyinside, completelyoutside;
    GenericKernelForContainsAndInside<Real_v, Bool_v, true>(orb, point, completelyinside, completelyoutside);
    inside = EInside::kSurface;
    vecCore::MaskedAssign(inside, (InsideBool_v)completelyoutside, Inside_t(EInside::kOutside));
    vecCore::MaskedAssign(inside, (InsideBool_v)completelyinside, Inside_t(EInside::kInside));
  }

  template <typename Real_v, typename Bool_v, bool ForInside>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static void GenericKernelForContainsAndInside(UnplacedStruct_t const &orb, Vector3D<Real_v> const &localPoint,
                                                Bool_v &completelyinside, Bool_v &completelyoutside)
  {
    Precision fR = orb.fR;
    Real_v rad2  = localPoint.Mag2();
    Real_v tolR  = fR - Real_v(kTolerance);
    if (ForInside) completelyinside = (rad2 <= tolR * tolR);
    tolR              = fR + Real_v(kTolerance);
    completelyoutside = (rad2 >= tolR * tolR);
    return;
  }

  template <typename Real_v>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static void DistanceToIn(UnplacedStruct_t const &orb, Vector3D<Real_v> const &point,
                           Vector3D<Real_v> const &direction, Real_v const & /*stepMax*/, Real_v &distance)
  {
    using Bool_v         = vecCore::Mask_v<Real_v>;
    distance             = kInfLength;
    Real_v rad           = point.Mag();
    Bool_v isPointInside = (rad < Real_v(orb.fR - kTolerance));
    vecCore__MaskedAssignFunc(distance, isPointInside, Real_v(-1.));
    Bool_v done = isPointInside;
    if (vecCore::MaskFull(done)) return;

    Real_v pDotV3D          = point.Dot(direction);
    Bool_v isPointOnSurface = (rad >= Real_v(orb.fR - kTolerance)) && (rad <= Real_v(orb.fR + kTolerance));
    Bool_v cond             = (isPointOnSurface && (pDotV3D < Real_v(0.)));
    vecCore__MaskedAssignFunc(distance, !done && cond, Real_v(0.));
    done |= cond;
    if (vecCore::MaskFull(done)) return;
    Real_v dist(kInfLength);
    vecCore::MaskedAssign(
        distance, !done && DetectIntersectionAndCalculateDistance<Real_v, true>(orb, point, direction, dist), dist);
  }

  template <typename Real_v>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static void DistanceToOut(UnplacedStruct_t const &orb, Vector3D<Real_v> const &point,
                            Vector3D<Real_v> const &direction, Real_v const & /* stepMax */, Real_v &distance)
  {
    using Bool_v = vecCore::Mask_v<Real_v>;

    distance = kInfLength;

    Real_v rad            = point.Mag();
    Bool_v isPointOutside = (rad > Real_v(orb.fR + kTolerance));
    vecCore__MaskedAssignFunc(distance, isPointOutside, Real_v(-1.));
    Bool_v done = isPointOutside;
    if (vecCore::MaskFull(done)) return;

    Real_v pDotV3D          = point.Dot(direction);
    Bool_v isPointOnSurface = (rad >= Real_v(orb.fR - kTolerance)) && (rad <= Real_v(orb.fR + kTolerance));
    Bool_v cond             = (isPointOnSurface && (pDotV3D > Real_v(0.)));
    vecCore__MaskedAssignFunc(distance, !done && cond, Real_v(0.));
    done |= cond;
    if (vecCore::MaskFull(done)) return;
    Real_v dist(kInfLength);
    vecCore::MaskedAssign(
        distance, !done && DetectIntersectionAndCalculateDistance<Real_v, false>(orb, point, direction, dist), dist);

    return;
  }

  template <typename Real_v>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static void SafetyToIn(UnplacedStruct_t const &orb, Vector3D<Real_v> const &point, Real_v &safety)
  {
    using Bool_v         = vecCore::Mask_v<Real_v>;
    Real_v rad           = point.Mag();
    safety               = rad - Real_v(orb.fR);
    Bool_v isPointInside = (rad < Real_v(orb.fR - kTolerance));
    vecCore__MaskedAssignFunc(safety, isPointInside, Real_v(-1.));
    if (vecCore::MaskFull(isPointInside)) return;

    Bool_v isPointOnSurface = (rad > Real_v(orb.fR - kTolerance)) && (rad < Real_v(orb.fR + kTolerance));
    vecCore__MaskedAssignFunc(safety, isPointOnSurface, Real_v(0.));
  }

  template <typename Real_v>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static void SafetyToOut(UnplacedStruct_t const &orb, Vector3D<Real_v> const &point, Real_v &safety)
  {
    using Bool_v = vecCore::Mask_v<Real_v>;

    Real_v rad = point.Mag();
    safety     = Real_v(orb.fR) - rad;

    Bool_v isPointOutside = (rad > Real_v(orb.fR + kTolerance));
    vecCore__MaskedAssignFunc(safety, isPointOutside, Real_v(-1.));
    if (vecCore::MaskFull(isPointOutside)) return;

    Bool_v isPointOnSurface = (rad > Real_v(orb.fR - kTolerance)) && (rad < Real_v(orb.fR + kTolerance));
    vecCore__MaskedAssignFunc(safety, isPointOnSurface, Real_v(0.));
  }

  template <typename Real_v, bool ForDistanceToIn>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static typename vecCore::Mask_v<Real_v> DetectIntersectionAndCalculateDistance(UnplacedStruct_t const &orb,
                                                                                 Vector3D<Real_v> const &point,
                                                                                 Vector3D<Real_v> const &direction,
                                                                                 Real_v &distance)
  {

    using Bool_v   = vecCore::Mask_v<Real_v>;
    Real_v rad2    = point.Mag2();
    Real_v pDotV3D = point.Dot(direction);
    Precision fR   = orb.fR;
    Real_v c       = rad2 - fR * fR;
    Real_v d2      = (pDotV3D * pDotV3D - c);

    if (ForDistanceToIn) {
      Bool_v cond = ((d2 >= Real_v(0.)) && (pDotV3D <= Real_v(0.)));
      vecCore__MaskedAssignFunc(distance, cond, (-pDotV3D - Sqrt(vecCore::math::Abs(d2))));
      return cond;
    } else {
      vecCore__MaskedAssignFunc(distance, (d2 >= Real_v(0.)), (-pDotV3D + Sqrt(vecCore::math::Abs(d2))));
      return (d2 >= Real_v(0.));
    }
  }

  template <typename Real_v>
  VECGEOM_FORCE_INLINE
  VECCORE_ATT_HOST_DEVICE
  static Vector3D<Real_v> NormalKernel(UnplacedStruct_t const &orb, Vector3D<Real_v> const &point,
                                       typename vecCore::Mask_v<Real_v> &valid)
  {
    Real_v rad2             = point.Mag2();
    Real_v invRadius        = Real_v(1.) / Sqrt(rad2);
    Vector3D<Real_v> normal = point * invRadius;

    Real_v tolRMaxO = orb.fR + kTolerance;
    Real_v tolRMaxI = orb.fR - kTolerance;

    // Check radial surface
    valid = ((rad2 <= tolRMaxO * tolRMaxO) && (rad2 >= tolRMaxI * tolRMaxI)); // means we are on surface
    return normal;
  }
};
} // namespace VECGEOM_IMPL_NAMESPACE
} // namespace vecgeom

#endif // VECGEOM_VOLUMES_KERNEL_orbIMPLEMENTATION_H_