include/Geant4/G4UTrd.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 // G4UTrd
0027 //
0028 // Class description:
0029 //
0030 // Wrapper class for G4Trd to make use of VecGeom Trd.
0031
0032 // Author: G.Cosmo (CERN), 13.09.2013
0033 // --------------------------------------------------------------------
0034 #ifndef G4UTRD_HH
0035 #define G4UTRD_HH
0036
0037 #include "G4UAdapter.hh"
0038
0039 #if ( defined(G4GEOM_USE_USOLIDS) || defined(G4GEOM_USE_PARTIAL_USOLIDS) )
0040
0041 #include <VecGeom/volumes/UnplacedTrd.h>
0042
0043 #include "G4Polyhedron.hh"
0044
0045 /**
0046  * @brief G4UTrd is a wrapper class for G4Trd to make use of VecGeom Trd.
0047  */
0048
0049 class G4UTrd : public G4UAdapter<vecgeom::GenericUnplacedTrd>
0050 {
0051   using Shape_t = vecgeom::GenericUnplacedTrd;
0052   using Base_t  = G4UAdapter<vecgeom::GenericUnplacedTrd>;
0053
0054   public:
0055
0056     /**
0057      * Constructs a trapezoid with name, and half lengths.
0058      *  @param[in] pName The name of the solid.
0059      *  @param[in] pdx1 Half-length along X at the surface positioned at -dz.
0060      *  @param[in] pdx2 Half-length along X at the surface positioned at +dz.
0061      *  @param[in] pdy1 Half-length along Y at the surface positioned at -dz.
0062      *  @param[in] pdy2 Half-length along Y at the surface positioned at +dz.
0063      *  @param[in] pdz Half-length along Z axis.
0064      */
0065     G4UTrd(const G4String& pName,
0066                  G4double pdx1, G4double pdx2,
0067                  G4double pdy1, G4double pdy2,
0068                  G4double pdz);
0069
0070     /**
0071      * Default destructor.
0072      */
0073     ~G4UTrd() override = default;
0074
0075     /**
0076      * Dispatch method for parameterisation replication mechanism and
0077      * dimension computation.
0078      */
0079     void ComputeDimensions(G4VPVParameterisation* p,
0080                            const G4int n,
0081                            const G4VPhysicalVolume* pRep) override;
0082
0083     /**
0084      * Makes a clone of the object for use in multi-treading.
0085      *  @returns A pointer to the new cloned allocated solid.
0086      */
0087     G4VSolid* Clone() const override;
0088
0089     /**
0090      * Accessors.
0091      */
0092     G4double GetXHalfLength1() const;
0093     G4double GetXHalfLength2() const;
0094     G4double GetYHalfLength1() const;
0095     G4double GetYHalfLength2() const;
0096     G4double GetZHalfLength()  const;
0097
0098     /**
0099      * Modifiers.
0100      */
0101     void SetXHalfLength1(G4double val);
0102     void SetXHalfLength2(G4double val);
0103     void SetYHalfLength1(G4double val);
0104     void SetYHalfLength2(G4double val);
0105     void SetZHalfLength(G4double val);
0106
0107     /**
0108      * Sets all parameters, as for constructor. Checks and sets half-widths.
0109      */
0110     void SetAllParameters(G4double pdx1, G4double pdx2,
0111                           G4double pdy1, G4double pdy2, G4double pdz);
0112
0113     /**
0114      * Returns the type ID, "G4Trd" of the solid.
0115      */
0116     inline G4GeometryType GetEntityType() const override;
0117
0118     /**
0119      * Returns true as the solid has only planar faces.
0120      */
0121     inline G4bool IsFaceted() 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     G4UTrd(const G4UTrd& rhs);
0154     G4UTrd& operator=(const G4UTrd& rhs);
0155 };
0156
0157 // --------------------------------------------------------------------
0158 // Inline methods
0159 // --------------------------------------------------------------------
0160
0161 inline G4GeometryType G4UTrd::GetEntityType() const
0162 {
0163   return "G4Trd";
0164 }
0165
0166 inline G4bool G4UTrd::IsFaceted() const
0167 {
0168   return true;
0169 }
0170
0171 #endif  // G4GEOM_USE_USOLIDS
0172
0173 #endif