include/Geant4/G4UCons.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4UCons
0027 //
0028 // Class description:
0029 //
0030 // Wrapper class for G4Cons to make use of VecGeom Cone.
0031
0032 // Author: G.Cosmo (CERN), 30.10.2013
0033 // --------------------------------------------------------------------
0034 #ifndef G4UCONS_HH
0035 #define G4UCONS_HH
0036
0037 #include "G4UAdapter.hh"
0038
0039 #if ( defined(G4GEOM_USE_USOLIDS) || defined(G4GEOM_USE_PARTIAL_USOLIDS) )
0040
0041 #include <VecGeom/volumes/UnplacedCone.h>
0042
0043 #include "G4Polyhedron.hh"
0044
0045 /**
0046  * @brief G4UCons is a wrapper class for G4Cons to make use of VecGeom Cone.
0047  */
0048
0049 class G4UCons : public G4UAdapter<vecgeom::GenericUnplacedCone>
0050 {
0051   using Shape_t = vecgeom::GenericUnplacedCone;
0052   using Base_t = G4UAdapter<vecgeom::GenericUnplacedCone>;
0053
0054   public:
0055
0056     /**
0057      * Constructs a cone with the given name and dimensions.
0058      *  @param[in] pName The name of the solid.
0059      *  @param[in] pRmin1 Inside radius at -fDz.
0060      *  @param[in] pRmax1 Outside radius at -fDz
0061      *  @param[in] pRmin2 Inside radius at +fDz.
0062      *  @param[in] pRmax2 Outside radius at +fDz
0063      *  @param[in] pDZ Half length in Z.
0064      *  @param[in] pSPhi Starting angle of the segment in radians.
0065      *  @param[in] pDPhi Delta angle of the segment in radians.
0066      */
0067     G4UCons(const G4String& pName,
0068                   G4double pRmin1, G4double pRmax1,
0069                   G4double pRmin2, G4double pRmax2,
0070                   G4double pDz,
0071                   G4double pSPhi, G4double pDPhi);
0072
0073     /**
0074      * Default destructor.
0075      */
0076    ~G4UCons() override = default;
0077
0078     /**
0079      * Dispatch method for parameterisation replication mechanism and
0080      * dimension computation.
0081      */
0082     void ComputeDimensions( G4VPVParameterisation* p,
0083                             const G4int n,
0084                             const G4VPhysicalVolume* pRep ) override;
0085
0086     /**
0087      * Makes a clone of the object for use in multi-treading.
0088      *  @returns A pointer to the new cloned allocated solid.
0089      */
0090     G4VSolid* Clone() const override;
0091
0092     /**
0093      * Accessors.
0094      */
0095     G4double GetInnerRadiusMinusZ() const;
0096     G4double GetOuterRadiusMinusZ() const;
0097     G4double GetInnerRadiusPlusZ()  const;
0098     G4double GetOuterRadiusPlusZ()  const;
0099     G4double GetZHalfLength()       const;
0100     G4double GetStartPhiAngle()     const;
0101     G4double GetDeltaPhiAngle()     const;
0102     G4double GetSinStartPhi()       const;
0103     G4double GetCosStartPhi()       const;
0104     G4double GetSinEndPhi()         const;
0105     G4double GetCosEndPhi()         const;
0106
0107     /**
0108      * Modifiers.
0109      */
0110     void SetInnerRadiusMinusZ (G4double Rmin1 );
0111     void SetOuterRadiusMinusZ (G4double Rmax1 );
0112     void SetInnerRadiusPlusZ  (G4double Rmin2 );
0113     void SetOuterRadiusPlusZ  (G4double Rmax2 );
0114     void SetZHalfLength       (G4double newDz );
0115     void SetStartPhiAngle     (G4double newSPhi, G4bool trig=true);
0116     void SetDeltaPhiAngle     (G4double newDPhi);
0117
0118     /**
0119      * Returns the type ID, "G4Cons" of the solid.
0120      */
0121     inline G4GeometryType GetEntityType() const override;
0122
0123     /**
0124      * Computes the bounding limits of the solid.
0125      *  @param[out] pMin The minimum bounding limit point.
0126      *  @param[out] pMax The maximum bounding limit point.
0127      */
0128     void BoundingLimits(G4ThreeVector& pMin, G4ThreeVector& pMax) const override;
0129
0130     /**
0131      * Calculates the minimum and maximum extent of the solid, when under the
0132      * specified transform, and within the specified limits.
0133      *  @param[in] pAxis The axis along which compute the extent.
0134      *  @param[in] pVoxelLimit The limiting space dictated by voxels.
0135      *  @param[in] pTransform The internal transformation applied to the solid.
0136      *  @param[out] pMin The minimum extent value.
0137      *  @param[out] pMax The maximum extent value.
0138      *  @returns True if the solid is intersected by the extent region.
0139      */
0140     G4bool CalculateExtent(const EAxis pAxis,
0141                            const G4VoxelLimits& pVoxelLimit,
0142                            const G4AffineTransform& pTransform,
0143                                  G4double& pMin, G4double& pMax) const override;
0144
0145     /**
0146      * Returns a generated polyhedron as graphical representations.
0147      */
0148     G4Polyhedron* CreatePolyhedron() const override;
0149
0150     /**
0151      * Copy constructor and assignment operator.
0152      */
0153     G4UCons(const G4UCons& rhs);
0154     G4UCons& operator=(const G4UCons& rhs);
0155 };
0156
0157 // --------------------------------------------------------------------
0158 // Inline methods
0159 // --------------------------------------------------------------------
0160
0161 inline G4GeometryType G4UCons::GetEntityType() const
0162 {
0163   return "G4Cons";
0164 }
0165
0166 #endif  // G4GEOM_USE_USOLIDS
0167
0168 #endif