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 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
|
// 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 Declaration of the unplaced volume interfaces.
/// \file volumes/UnplacedVolume.h
/// \author created by Sandro Wenzel
#ifndef VECGEOM_VOLUMES_UNPLACEDVOLUME_H_
#define VECGEOM_VOLUMES_UNPLACEDVOLUME_H_
#include "VecGeom/base/Cuda.h"
#include "VecGeom/base/Global.h"
#include "VecGeom/base/Transformation3D.h"
#include "VecGeom/base/SOA3D.h"
#include "VecGeom/volumes/kernel/BoxImplementation.h"
#include <string>
#include <ostream>
#ifndef VECCORE_CUDA
#include "VecGeom/volumes/SolidMesh.h"
#endif
namespace vecgeom {
VECGEOM_DEVICE_FORWARD_DECLARE(class VUnplacedVolume;);
VECGEOM_DEVICE_DECLARE_CONV(class, VUnplacedVolume);
inline namespace VECGEOM_IMPL_NAMESPACE {
class LogicalVolume;
class VPlacedVolume;
/**
* The abstract interface class for unplaced volumes.
*
* An unplaced volume represents a geometry shape (primitive) and offers
* interfaces to query distance, location, containment, etc. in its "natural"
* system of coordinates.
*/
class VUnplacedVolume {
private:
friend class CudaManager;
Vector3D<Precision> fBBox[2]; ///< bounding box corners
protected:
bool fGlobalConvexity;
bool fIsAssembly = false; // indicates if this volume is an assembly
public:
// alias for the globally selected VectorType
using Real_v = vecgeom::VectorBackend::Real_v;
VECCORE_ATT_HOST_DEVICE
virtual ~VUnplacedVolume() {}
VECGEOM_FORCE_INLINE
VECCORE_ATT_HOST_DEVICE
void SetBBox(Vector3D<Precision> const &amin, Vector3D<Precision> const &amax)
{
fBBox[0] = amin;
fBBox[1] = amax;
}
VECGEOM_FORCE_INLINE
VECCORE_ATT_HOST_DEVICE
void GetBBox(Vector3D<Precision> &amin, Vector3D<Precision> &amax) const
{
amin = fBBox[0];
amax = fBBox[1];
}
VECGEOM_FORCE_INLINE
VECCORE_ATT_HOST_DEVICE
void ComputeBBox()
{
#ifndef VECCORE_CUDA_DEVICE_COMPILATION
Extent(fBBox[0], fBBox[1]);
#endif
}
// ---------------- Contains --------------------------------------------------------------------
/*!
* Returns whether a space point pos is contained or not in the shape.
*/
VECCORE_ATT_HOST_DEVICE
virtual bool Contains(Vector3D<Precision> const &pos) const = 0;
/*!
* Returns whether a space point pos is inside, on the surface or outside
* the shape. The surface is defined by a thickness constant.
*/
VECCORE_ATT_HOST_DEVICE
virtual EnumInside Inside(Vector3D<Precision> const &pos) const = 0;
// ---------------- DistanceToOut functions -----------------------------------------------------
/*!
* Returns the distance from an internal or surface space point pos to the surface
* of the shape along the normalized direction dir.
* Does not have to look for surfaces beyond an optional distance of step_max.
* Calling it with an outside point might result in undefined behaviour.
*
* TODO: Clarify return value in case step_max is non-default.
*/
VECCORE_ATT_HOST_DEVICE
virtual Precision DistanceToOut(Vector3D<Precision> const &pos, Vector3D<Precision> const &dir,
Precision step_max = kInfLength) const = 0;
/*!
* Same as DistanceToOut(pos, dir, step_max) but in addition returns
* @param normal The unit normal vector at the point of exit (pointing out tbc)
* @param convex Whether the shape lies in the half-space behind the plane defined by the exit point and the normal.
*/
VECCORE_ATT_HOST_DEVICE
virtual Precision DistanceToOut(Vector3D<Precision> const &pos, Vector3D<Precision> const &dir,
Vector3D<Precision> &normal, bool &convex, Precision step_max = kInfLength) const;
/*!
* Same as DistanceToOut(pos, dir, step_max) but treating vectored input/output of type Real_v.
* Real_v represents typically a SIMD register type.
*/
VECCORE_ATT_HOST_DEVICE
virtual Real_v DistanceToOutVec(Vector3D<Real_v> const &pos, Vector3D<Real_v> const &dir,
Real_v const &step_max) const;
/*!
* Helper "trampoline" to dispatch to DistanceToOutVec if type is not scalar.
*/
template <typename T>
VECGEOM_FORCE_INLINE
VECCORE_ATT_HOST_DEVICE
T DistanceToOut(Vector3D<T> const &p, Vector3D<T> const &d, T const &step_max) const
{
return DistanceToOutVec(p, d, step_max);
}
/*!
* Same as DistanceToOut(pos, dir, step_max) but processing a collection of points and directions.
* @param output The vector/container of distances
*/
virtual void DistanceToOut(SOA3D<Precision> const &points, SOA3D<Precision> const &directions,
Precision const *const step_max, Precision *const output) const;
// ---------------- SafetyToOut functions -----------------------------------------------------
/*!
* Returns the estimated minimum distance from an internal or surface space point pos to the
* boundary of the shape. The estimate will be strictly smaller or equal to the true value.
* Calling it with an outside point might result in undefined behaviour.
*/
VECCORE_ATT_HOST_DEVICE
virtual Precision SafetyToOut(Vector3D<Precision> const &pos) const = 0;
/*!
* Like SafetToOut(Vector3D<Precision> const &pos) but processing SIMD vector
* input.
*/
VECCORE_ATT_HOST_DEVICE
virtual Real_v SafetyToOutVec(Vector3D<Real_v> const &p) const;
/*!
* Helper trampoline to dispatch to SafetyToOutVec if type is not scalar.
*/
template <typename T>
VECGEOM_FORCE_INLINE
VECCORE_ATT_HOST_DEVICE
T SafetyToOut(Vector3D<T> const &p) const
{
return SafetyToOutVec(p);
}
/*!
* Like SafetyToOut(Vector3D<Precision> const &pos) but processing a collection
* of input points.
*/
virtual void SafetyToOut(SOA3D<Precision> const &points, Precision *const output) const /* = 0*/;
// ---------------- DistanceToIn functions -----------------------------------------------------
/*!
* Returns the distance from an outside space point pos to the surface
* of the shape along the normalized direction dir.
* Does not have to look for surfaces beyond an optional distance of step_max.
* Calling it with an inside point might result in undefined behaviour.
*
* TODO: Clarify return value in case step_max is non-default.
*/
VECCORE_ATT_HOST_DEVICE
virtual Precision DistanceToIn(Vector3D<Precision> const &position, Vector3D<Precision> const &direction,
const Precision step_max = kInfLength) const = 0;
/*!
* Same as DistanceToIn(pos, dir, step_max) but treating vectored input/output of type Real_v.
* Real_v represents typically a SIMD register type.
*/
VECCORE_ATT_HOST_DEVICE
virtual Real_v DistanceToInVec(Vector3D<Real_v> const &position, Vector3D<Real_v> const &direction,
const Real_v &step_max = Real_v(kInfLength)) const /* = 0 */;
/*!
* Helper trampoline to dispatch to DistanceToInVec if type is not scalar.
* The T = Precision this template will not instantiate as the compiler finds another matching function
*/
template <typename T>
VECGEOM_FORCE_INLINE
VECCORE_ATT_HOST_DEVICE
T DistanceToIn(Vector3D<T> const &p, Vector3D<T> const &d, T const &step_max) const
{
return DistanceToInVec(p, d, step_max);
}
// ---------------- SafetyToIn functions -------------------------------------------------------
/*!
* Returns the estimated minimum distance from an outside or surface space point pos to the
* boundary of the shape. The estimate will be strictly smaller or equal to the true value.
* Calling it with an inside point is undefined behaviour.
*/
VECCORE_ATT_HOST_DEVICE
virtual Precision SafetyToIn(Vector3D<Precision> const &pos) const = 0;
/*!
* Like SafetyToIn(Vector3D<Precision> const &) but processing SIMD vector
* input.
*/
VECCORE_ATT_HOST_DEVICE
virtual Real_v SafetyToInVec(Vector3D<Real_v> const &p) const;
/*!
* Helper trampoline to dispatch to SafetyToInVec if type is not scalar.
*/
template <typename T>
VECGEOM_FORCE_INLINE
VECCORE_ATT_HOST_DEVICE
T SafetyToIn(Vector3D<T> const &p) const
{
return SafetyToInVec(p);
}
// ---------------- Normal ---------------------------------------------------------------------
/*!
* Calculates the surface normal unit vector for a space point pos, assuming
* that pos is on the surface (i.e. Inside(pos) == kSurface).
* The behaviour for a point not on the surface is undefined.
* TODO: Clarify whether normal always points outwards.
*/
VECCORE_ATT_HOST_DEVICE
virtual bool Normal(Vector3D<Precision> const &pos, Vector3D<Precision> &normal) const /* = 0 */;
// ---------------- SamplePointOnSurface ----------------------------------------------------------
/*!
* Generates random point pos on the surface of the shape.
* The returned point satisfies Inside(pos)==kSurface.
*/
virtual Vector3D<Precision> SamplePointOnSurface() const /* = 0 */;
// ----------------- Extent --------------------------------------------------------------------
/*!
* Returns the extent of the shape as corner points of the enclosing
* bounding box.
* @param aMin point of bounding box corner with minimum coordinates
* @param aMax point of bounding box corner with maximum coordinates
*/
VECCORE_ATT_HOST_DEVICE
virtual void Extent(Vector3D<Precision> &aMin, Vector3D<Precision> &aMax) const /* = 0 */;
VECGEOM_FORCE_INLINE
VECCORE_ATT_HOST_DEVICE
Precision ApproachSolid(Vector3D<Precision> const &point, Vector3D<Precision> const &invDir) const
{
return BoxImplementation::IntersectCachedKernel2<Precision, Precision>(fBBox, point, invDir,
invDir.x() < 0,
invDir.y() < 0,
invDir.z() < 0,
0, kInfLength);
}
/*!
* Returns whether the shape is (globally) convex or not.
* If not known, returns false.
*/
VECCORE_ATT_HOST_DEVICE
bool IsConvex() const { return fGlobalConvexity; }
/*!
* Returns whether the shape is an assembly
*/
VECCORE_ATT_HOST_DEVICE
bool IsAssembly() const { return fIsAssembly; }
// ----------------- Capacity --------------------------------------------------------------------
/*!
* Returns the (exact or estimated) cubic volume/capacity of the shape.
*/
virtual Precision Capacity() const = 0;
/*!
* Calculates an estimate of the cubic volume of the shape via a sampling technique.
* @param nStat number of sample points to be used
*/
Precision EstimateCapacity(int nStat = 100000) const;
// ----------------- Surface Area ----------------------------------------------------------------
/*!
* Returns the (exact or estimated) surface area of the shape.
*/
virtual Precision SurfaceArea() const = 0;
/*!
* Calculates an estimate of the surface area of the shape via a sampling technique.
* @param nStat number of sample points to be used
*/
Precision EstimateSurfaceArea(int nStat = 100000) const;
/*!
* Standard output operator for a textual representation.
* (Uses the virtual method print(std::ostream &ps))
*/
friend std::ostream &operator<<(std::ostream &os, VUnplacedVolume const &vol);
/*!
* Return the size of the deriving class in bytes. Necessary for
* copying to the GPU.
*/
virtual int MemorySize() const = 0;
#ifdef VECGEOM_CUDA_INTERFACE
virtual size_t DeviceSizeOf() const = 0;
/*!
* Constructs the deriving class on the GPU and returns a pointer to GPU
* memory where the object has been instantiated.
*/
virtual DevicePtr<cuda::VUnplacedVolume> CopyToGpu() const = 0;
virtual DevicePtr<cuda::VUnplacedVolume> CopyToGpu(DevicePtr<cuda::VUnplacedVolume> const gpu_ptr) const = 0;
template <typename Derived, typename... ArgsTypes>
DevicePtr<cuda::VUnplacedVolume> CopyToGpuImpl(DevicePtr<cuda::VUnplacedVolume> const in_gpu_ptr,
ArgsTypes... params) const
{
DevicePtr<CudaType_t<Derived>> gpu_ptr(in_gpu_ptr);
gpu_ptr.Construct(params...);
CudaAssertError();
// Need to go via the void* because the regular c++ compilation
// does not actually see the declaration for the cuda version
// (and thus can not determine the inheritance).
return DevicePtr<cuda::VUnplacedVolume>((void *)gpu_ptr);
}
template <typename Derived>
DevicePtr<cuda::VUnplacedVolume> CopyToGpuImpl() const
{
DevicePtr<CudaType_t<Derived>> gpu_ptr;
gpu_ptr.Allocate();
return this->CopyToGpu(DevicePtr<cuda::VUnplacedVolume>((void *)gpu_ptr));
}
static void CopyBBoxesToGpu(const std::vector<VUnplacedVolume const *> &volumes,
const std::vector<DevicePtr<cuda::VUnplacedVolume>> &gpu_ptrs);
#endif
/*!
* Print a textual representation of the shape to a given outstream os.
* This should typically tell the parameters, class, etc. of the shape.
*/
virtual void Print(std::ostream &os) const = 0;
/**
* C-style printing for CUDA purposes.
* TODO: clarify relation to other Print.
*/
VECCORE_ATT_HOST_DEVICE
virtual void Print() const = 0;
/// Generates mesh representation of the solid
#ifndef VECCORE_CUDA
virtual SolidMesh *CreateMesh3D(Transformation3D const & /*trans*/, const size_t /*nSegments*/) const
{
return nullptr;
};
#endif
// Is not static because a virtual function must be called to initialize
// specialized volume as the shape of the deriving class.
// TODO: clarify
VPlacedVolume *PlaceVolume(char const *const label, LogicalVolume const *const volume,
Transformation3D const *const transformation, VPlacedVolume *const placement = NULL) const;
VPlacedVolume *PlaceVolume(LogicalVolume const *const volume, Transformation3D const *const transformation,
VPlacedVolume *const placement = NULL) const;
private:
#ifndef VECCORE_CUDA
virtual VPlacedVolume *SpecializedVolume(LogicalVolume const *const volume,
Transformation3D const *const transformation,
const TranslationCode trans_code, const RotationCode rot_code,
VPlacedVolume *const placement = NULL) const = 0;
#else
VECCORE_ATT_DEVICE
virtual VPlacedVolume *SpecializedVolume(LogicalVolume const *const volume,
Transformation3D const *const transformation,
const TranslationCode trans_code, const RotationCode rot_code, const int id,
const int copy_no, const int child_id,
VPlacedVolume *const placement = NULL) const = 0;
#endif
};
/*!
* A template structure used to create specialized instances
* of a shape. Used by the shape factory mechanism.
*/
template <typename Shape_t>
struct Maker {
template <typename... ArgTypes>
static Shape_t *MakeInstance(ArgTypes... args)
{
// the default case calls the standard constructor
return new Shape_t(args...);
}
};
std::ostream &operator<<(std::ostream &os, VUnplacedVolume const &vol);
} // namespace VECGEOM_IMPL_NAMESPACE
} // namespace vecgeom
#endif // VECGEOM_VOLUMES_UNPLACEDVOLUME_H_
|