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
|
// 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`.
/// Declaration of the unplaced ellipsoid shape
/// @file volumes/UnplacedEllipsoid.h
/// @author Evgueni Tcherniaev
#ifndef VECGEOM_VOLUMES_UNPLACEDELLIPSOID_H_
#define VECGEOM_VOLUMES_UNPLACEDELLIPSOID_H_
#include "VecGeom/base/Cuda.h"
#include "VecGeom/base/Global.h"
#include "VecGeom/base/AlignedBase.h"
#include "VecGeom/base/Vector3D.h"
#include "VecGeom/volumes/UnplacedVolume.h"
#include "VecGeom/volumes/EllipsoidStruct.h"
#include "VecGeom/volumes/kernel/EllipsoidImplementation.h"
#include "VecGeom/volumes/UnplacedVolumeImplHelper.h"
namespace vecgeom {
VECGEOM_DEVICE_FORWARD_DECLARE(class UnplacedEllipsoid;);
VECGEOM_DEVICE_DECLARE_CONV(class, UnplacedEllipsoid);
inline namespace VECGEOM_IMPL_NAMESPACE {
/// Class for ellipsoid shape primitive
///
/// Ellipsoid shape is limited by a quadratic surface given by the equation:
///
/// (x/dx)^2 + (y/dy)^2 + (z/dz)^2 = 1
///
/// where dx, dy and dz are lengths of the semi-axes. The shape is centered at the origin
/// and and optionally may have cuts in z.
///
class UnplacedEllipsoid : public SIMDUnplacedVolumeImplHelper<EllipsoidImplementation>, public AlignedBase {
private:
EllipsoidStruct<Precision> fEllipsoid;
/// Check correctness of the parameters and set the data members
VECCORE_ATT_HOST_DEVICE
void CheckParameters();
/// Compute area of lateral surface
VECCORE_ATT_HOST_DEVICE
Precision LateralSurfaceArea() const;
public:
/// Default constructor
VECCORE_ATT_HOST_DEVICE
UnplacedEllipsoid();
/// Constructor
/// @param dx Length of x semi-axis
/// @param dy Length of y semi-axis
/// @param dz Length of z semi-axis
/// @param zBottomCut Bottom cut in z, shape lies above this plane
/// @param zTopCut Top cut in z, shape lies below this plane
VECCORE_ATT_HOST_DEVICE
UnplacedEllipsoid(Precision dx, Precision dy, Precision dz, Precision zBottomCut = 0., Precision zTopCut = 0.);
/// Getter for the structure storing ellipsoid data
VECCORE_ATT_HOST_DEVICE
EllipsoidStruct<Precision> const &GetStruct() const { return fEllipsoid; }
/// Getter for x semi-axis
VECCORE_ATT_HOST_DEVICE
VECGEOM_FORCE_INLINE
Precision GetDx() const { return fEllipsoid.fDx; }
/// Getter for y semi-axis
VECCORE_ATT_HOST_DEVICE
VECGEOM_FORCE_INLINE
Precision GetDy() const { return fEllipsoid.fDy; }
/// Getter for z semi-axis
VECCORE_ATT_HOST_DEVICE
VECGEOM_FORCE_INLINE
Precision GetDz() const { return fEllipsoid.fDz; }
/// Getter for bottom cut in z, return -dz if the cut is not set
VECCORE_ATT_HOST_DEVICE
VECGEOM_FORCE_INLINE
Precision GetZBottomCut() const { return fEllipsoid.fZBottomCut; }
/// Getter for top cut in z, return +dz if the cut is not set
VECCORE_ATT_HOST_DEVICE
VECGEOM_FORCE_INLINE
Precision GetZTopCut() const { return fEllipsoid.fZTopCut; }
/// Set ellipsoid dimensions
/// @param dx Length of x semi-axis
/// @param dy Length of y semi-axis
/// @param dy Length of z semi-axis
VECCORE_ATT_HOST_DEVICE
VECGEOM_FORCE_INLINE
void SetSemiAxes(Precision dx, Precision dy, Precision dz)
{
fEllipsoid.fDx = dx;
fEllipsoid.fDy = dy;
fEllipsoid.fDz = dz;
CheckParameters();
};
/// Set cuts in z
/// @param zBottomCut Bottom cut in z, shape lies above this plane
/// @param zTopCut Top cut in z, shape lies below this plane
VECCORE_ATT_HOST_DEVICE
VECGEOM_FORCE_INLINE
void SetZCuts(Precision zBottomCut, Precision zTopCut)
{
fEllipsoid.fZBottomCut = zBottomCut;
fEllipsoid.fZTopCut = zTopCut;
CheckParameters();
};
VECCORE_ATT_HOST_DEVICE
void Extent(Vector3D<Precision> &, Vector3D<Precision> &) const override;
Precision Capacity() const override { return fEllipsoid.fCubicVolume; }
Precision SurfaceArea() const override { return fEllipsoid.fSurfaceArea; }
Vector3D<Precision> SamplePointOnSurface() const override;
VECCORE_ATT_HOST_DEVICE
virtual bool Normal(Vector3D<Precision> const &p, Vector3D<Precision> &normal) const override
{
bool valid;
normal = EllipsoidImplementation::NormalKernel(fEllipsoid, p, valid);
return valid;
}
/// Return type of the solid as a string
std::string GetEntityType() const { return "Ellipsoid"; }
/// Dump volume parameters to an output stream
std::ostream &StreamInfo(std::ostream &os) const;
public:
virtual int MemorySize() const final { return sizeof(*this); }
VECCORE_ATT_HOST_DEVICE
virtual void Print() const override;
virtual void Print(std::ostream &os) const override;
#ifndef VECCORE_CUDA
virtual SolidMesh *CreateMesh3D(Transformation3D const &trans, size_t nSegments) const override;
#endif
#ifdef VECGEOM_CUDA_INTERFACE
virtual size_t DeviceSizeOf() const override { return DevicePtr<cuda::UnplacedEllipsoid>::SizeOf(); }
virtual DevicePtr<cuda::VUnplacedVolume> CopyToGpu() const override;
virtual DevicePtr<cuda::VUnplacedVolume> CopyToGpu(DevicePtr<cuda::VUnplacedVolume> const gpu_ptr) const override;
#endif
/// Templated factory for creating a placed volume
#ifndef VECCORE_CUDA
template <TranslationCode trans_code, RotationCode rot_code>
static VPlacedVolume *Create(LogicalVolume const *const logical_volume, Transformation3D const *const transformation,
VPlacedVolume *const placement = NULL);
VPlacedVolume *SpecializedVolume(LogicalVolume const *const volume, Transformation3D const *const transformation,
const TranslationCode trans_code, const RotationCode rot_code,
VPlacedVolume *const placement) const override;
#else
template <TranslationCode trans_code, RotationCode rot_code>
VECCORE_ATT_DEVICE
static VPlacedVolume *Create(LogicalVolume const *const logical_volume, Transformation3D const *const transformation,
const int id, const int copy_no, const int child_id,
VPlacedVolume *const placement = NULL);
VECCORE_ATT_DEVICE 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) const override;
#endif
};
} // namespace VECGEOM_IMPL_NAMESPACE
} // namespace vecgeom
#endif
|