VecGeom/volumes/PlacedEllipticalCone.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 Cone volume.
0006 /// @file volumes/PlacedEllipticalCone.h
0007 /// @author Raman Sehgal and Evgueni Tcherniaev
0008
0009 #ifndef VECGEOM_VOLUMES_PLACEDELLIPTICALCONE_H_
0010 #define VECGEOM_VOLUMES_PLACEDELLIPTICALCONE_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/EllipticalConeImplementation.h"
0017 #include "VecGeom/volumes/PlacedVolImplHelper.h"
0018 #include "VecGeom/volumes/UnplacedEllipticalCone.h"
0019
0020 namespace vecgeom {
0021
0022 VECGEOM_DEVICE_FORWARD_DECLARE(class PlacedEllipticalCone;);
0023 VECGEOM_DEVICE_DECLARE_CONV(class, PlacedEllipticalCone);
0024
0025 inline namespace VECGEOM_IMPL_NAMESPACE {
0026
0027 /// Class for the positioned elliptical cone volume
0028 class PlacedEllipticalCone : public PlacedVolumeImplHelper<UnplacedEllipticalCone, VPlacedVolume> {
0029   using Base = PlacedVolumeImplHelper<UnplacedEllipticalCone, 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   PlacedEllipticalCone(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   PlacedEllipticalCone(LogicalVolume const *const logicalVolume, Transformation3D const *const transformation)
0049       : PlacedEllipticalCone("", logicalVolume, transformation)
0050   {
0051   }
0052 #else
0053   /// CUDA version of constructor
0054   VECCORE_ATT_DEVICE PlacedEllipticalCone(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 ~PlacedEllipticalCone() {}
0064
0065   /// Getter for the parameter that specifies inclination of the conical surface in x
0066   VECCORE_ATT_HOST_DEVICE
0067   VECGEOM_FORCE_INLINE
0068   Precision GetSemiAxisX() const { return GetUnplacedVolume()->GetSemiAxisX(); }
0069
0070   /// Getter for the parameter that specifies inclination of the conical surface in y
0071   VECCORE_ATT_HOST_DEVICE
0072   VECGEOM_FORCE_INLINE
0073   Precision GetSemiAxisY() const { return GetUnplacedVolume()->GetSemiAxisY(); }
0074
0075   /// Getter for the height
0076   VECCORE_ATT_HOST_DEVICE
0077   VECGEOM_FORCE_INLINE
0078   Precision GetZMax() const { return GetUnplacedVolume()->GetZMax(); }
0079
0080   /// Getter for the cut in z
0081   VECCORE_ATT_HOST_DEVICE
0082   VECGEOM_FORCE_INLINE
0083   Precision GetZTopCut() const { return GetUnplacedVolume()->GetZTopCut(); }
0084
0085   /// Setter for the elliptical cone parameters
0086   /// @param a Inclination of the conical surface in x
0087   /// @param b Inclination of the conical surface in y
0088   /// @param h Height
0089   /// @param zcut cut in z
0090   VECCORE_ATT_HOST_DEVICE
0091   VECGEOM_FORCE_INLINE
0092   void SetParameters(Precision a, Precision b, Precision h, Precision zcut)
0093   {
0094     const_cast<UnplacedEllipticalCone *>(GetUnplacedVolume())->SetParameters(a, b, h, zcut);
0095   };
0096
0097   VECCORE_ATT_HOST_DEVICE
0098   virtual void PrintType() const override;
0099   virtual void PrintType(std::ostream &os) const override;
0100
0101 // Comparison specific
0102 #ifndef VECCORE_CUDA
0103   virtual VPlacedVolume const *ConvertToUnspecialized() const override;
0104 #ifdef VECGEOM_ROOT
0105   virtual TGeoShape const *ConvertToRoot() const override
0106   {
0107     return nullptr; // There is no suitable TGeo shape 2019.02.19
0108   }
0109 #endif
0110 #ifdef VECGEOM_GEANT4
0111   virtual G4VSolid const *ConvertToGeant4() const override;
0112 #endif
0113 #endif // VECCORE_CUDA
0114 };
0115
0116 } // namespace VECGEOM_IMPL_NAMESPACE
0117 } // namespace vecgeom
0118
0119 #endif