VecGeom/volumes/PlacedEllipticalTube.h

0001 // This file is part of VecGeom and is distributed under the
0002 // conditions in the file LICENSE.txt in the top directory.
0003 // For the full list of authors see CONTRIBUTORS.txt and `git log`.
0004
0005 /// Declaration of the Placed Elliptical Tube volume
0006 /// @file volumes/PlacedEllipticalTube.h
0007 /// @author Raman Sehgal, Evgueni Tcherniaev
0008
0009 #ifndef VECGEOM_VOLUMES_PLACEDELLIPTICALTUBE_H_
0010 #define VECGEOM_VOLUMES_PLACEDELLIPTICALTUBE_H_
0011
0012 #include "VecGeom/base/Global.h"
0013
0014 #include "VecGeom/volumes/PlacedVolume.h"
0015 #include "VecGeom/volumes/UnplacedVolume.h"
0016 #include "VecGeom/volumes/kernel/EllipticalTubeImplementation.h"
0017 #include "VecGeom/volumes/PlacedVolImplHelper.h"
0018 #include "VecGeom/volumes/UnplacedEllipticalTube.h"
0019
0020 namespace vecgeom {
0021
0022 VECGEOM_DEVICE_FORWARD_DECLARE(class PlacedEllipticalTube;);
0023 VECGEOM_DEVICE_DECLARE_CONV(class, PlacedEllipticalTube);
0024
0025 inline namespace VECGEOM_IMPL_NAMESPACE {
0026
0027 /// Class for the positioned elliptical tube volume
0028 class PlacedEllipticalTube : public PlacedVolumeImplHelper<UnplacedEllipticalTube, VPlacedVolume> {
0029   using Base = PlacedVolumeImplHelper<UnplacedEllipticalTube, VPlacedVolume>;
0030
0031 public:
0032 #ifndef VECCORE_CUDA
0033   using Base::Base;
0034
0035   /// Constructor
0036   /// @param label Name of logical volume
0037   /// @param logicalVolume The logical volume to be positioned
0038   /// @param transformation The positioning transformation
0039   PlacedEllipticalTube(char const *const label, LogicalVolume const *const logicalVolume,
0040                        Transformation3D const *const transformation)
0041       : Base(label, logicalVolume, transformation)
0042   {
0043   }
0044
0045   /// Constructor
0046   /// @param logicalVolume The logical volume to be positioned
0047   /// @param transformation The positioning transformation.
0048   PlacedEllipticalTube(LogicalVolume const *const logicalVolume, Transformation3D const *const transformation)
0049       : PlacedEllipticalTube("", logicalVolume, transformation)
0050   {
0051   }
0052 #else
0053   /// CUDA version of constructor
0054   VECCORE_ATT_DEVICE PlacedEllipticalTube(LogicalVolume const *const logicalVolume,
0055                                           Transformation3D const *const transformation, const int id, const int copy_no,
0056                                           const int child_id)
0057       : Base(logicalVolume, transformation, id, copy_no, child_id)
0058   {
0059   }
0060 #endif
0061   /// Destructor
0062   VECCORE_ATT_HOST_DEVICE
0063   virtual ~PlacedEllipticalTube() {}
0064
0065   /// Getter for x semi-axis
0066   VECCORE_ATT_HOST_DEVICE
0067   VECGEOM_FORCE_INLINE
0068   Precision GetDx() const { return GetUnplacedVolume()->GetDx(); }
0069
0070   /// Getter for y semi-axis
0071   VECCORE_ATT_HOST_DEVICE
0072   VECGEOM_FORCE_INLINE
0073   Precision GetDy() const { return GetUnplacedVolume()->GetDy(); }
0074
0075   /// Getter for the half length in z
0076   VECCORE_ATT_HOST_DEVICE
0077   VECGEOM_FORCE_INLINE
0078   Precision GetDz() const { return GetUnplacedVolume()->GetDz(); }
0079
0080   /// Setter for the elliptical tube parameters
0081   /// @param dx Length of x semi-axis
0082   /// @param dy Length of y semi-axis
0083   /// @param dz Half length in z
0084   VECCORE_ATT_HOST_DEVICE
0085   VECGEOM_FORCE_INLINE
0086   void SetParameters(Precision dx, Precision dy, Precision dz)
0087   {
0088     const_cast<UnplacedEllipticalTube *>(GetUnplacedVolume())->SetParameters(dx, dy, dz);
0089   };
0090
0091   /// Set x semi-axis
0092   VECCORE_ATT_HOST_DEVICE
0093   VECGEOM_FORCE_INLINE
0094   void SetDx(Precision dx) { const_cast<UnplacedEllipticalTube *>(GetUnplacedVolume())->SetDx(dx); };
0095
0096   /// Set y semi-axis
0097   VECCORE_ATT_HOST_DEVICE
0098   VECGEOM_FORCE_INLINE
0099   void SetDy(Precision dy) { const_cast<UnplacedEllipticalTube *>(GetUnplacedVolume())->SetDy(dy); };
0100
0101   /// Set half length in z
0102   VECCORE_ATT_HOST_DEVICE
0103   VECGEOM_FORCE_INLINE
0104   void SetDz(Precision dz) { const_cast<UnplacedEllipticalTube *>(GetUnplacedVolume())->SetDz(dz); };
0105
0106   VECCORE_ATT_HOST_DEVICE
0107   virtual void PrintType() const override;
0108   virtual void PrintType(std::ostream &os) const override;
0109
0110 // Comparison specific
0111 #ifndef VECCORE_CUDA
0112   virtual VPlacedVolume const *ConvertToUnspecialized() const override;
0113 #ifdef VECGEOM_ROOT
0114   virtual TGeoShape const *ConvertToRoot() const override;
0115 #endif
0116 #ifdef VECGEOM_GEANT4
0117   virtual G4VSolid const *ConvertToGeant4() const override;
0118 #endif
0119 #endif // VECCORE_CUDA
0120 };
0121
0122 } // namespace VECGEOM_IMPL_NAMESPACE
0123 } // namespace vecgeom
0124
0125 #endif