include/Geant4/G4UHype.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 // G4UHype
0027 //
0028 // Class description:
0029 //
0030 // Wrapper class for G4Hype to make use of VecGeom Hyperboloid.
0031
0032 // Author: Gabriele Cosmo (CERN), 16.10.2017
0033 // --------------------------------------------------------------------
0034 #ifndef G4UHYPE_HH
0035 #define G4UHYPE_HH
0036
0037 #include "G4UAdapter.hh"
0038
0039 #if ( defined(G4GEOM_USE_USOLIDS) || defined(G4GEOM_USE_PARTIAL_USOLIDS) )
0040
0041 #include <VecGeom/volumes/UnplacedHype.h>
0042
0043 #include "G4Polyhedron.hh"
0044
0045 /**
0046  * @brief G4UHype is a wrapper class for G4Hype to make use
0047  * of VecGeom Hyperboloid.
0048  */
0049
0050 class G4UHype : public G4UAdapter<vecgeom::GenericUnplacedHype>
0051 {
0052   using Shape_t = vecgeom::GenericUnplacedHype;
0053   using Base_t  = G4UAdapter<vecgeom::GenericUnplacedHype>;
0054
0055   public:
0056
0057     /**
0058      * Constructs a hyperbolic tube, given its parameters.
0059      *  @param[in] name The solid name.
0060      *  @param[in] newInnerRadius Inner radius.
0061      *  @param[in] newOuterRadius Outer radius.
0062      *  @param[in] newInnerStereo Inner stereo angle in radians.
0063      *  @param[in] newOuterStereo Outer stereo angle in radians.
0064      *  @param[in] newHalfLenZ Half length in Z.
0065      */
0066     G4UHype(const G4String& name,
0067                   G4double  newInnerRadius,
0068                   G4double  newOuterRadius,
0069                   G4double  newInnerStereo,
0070                   G4double  newOuterStereo,
0071                   G4double  newHalfLenZ);
0072
0073     /**
0074      * Default destructor.
0075      */
0076     ~G4UHype() 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 GetInnerRadius () const;
0096     G4double GetOuterRadius () const;
0097     G4double GetZHalfLength () const;
0098     G4double GetInnerStereo () const;
0099     G4double GetOuterStereo () const;
0100
0101     /**
0102      * Modifiers.
0103      */
0104     void SetInnerRadius (G4double newIRad);
0105     void SetOuterRadius (G4double newORad);
0106     void SetZHalfLength (G4double newHLZ);
0107     void SetInnerStereo (G4double newISte);
0108     void SetOuterStereo (G4double newOSte);
0109
0110     /**
0111      * Returns the type ID, "G4Hype" of the solid.
0112      */
0113     inline G4GeometryType GetEntityType() const override;
0114
0115     /**
0116      * Computes the bounding limits of the solid.
0117      *  @param[out] pMin The minimum bounding limit point.
0118      *  @param[out] pMax The maximum bounding limit point.
0119      */
0120     void BoundingLimits(G4ThreeVector& pMin, G4ThreeVector& pMax) const override;
0121
0122     /**
0123      * Calculates the minimum and maximum extent of the solid, when under the
0124      * specified transform, and within the specified limits.
0125      *  @param[in] pAxis The axis along which compute the extent.
0126      *  @param[in] pVoxelLimit The limiting space dictated by voxels.
0127      *  @param[in] pTransform The internal transformation applied to the solid.
0128      *  @param[out] pMin The minimum extent value.
0129      *  @param[out] pMax The maximum extent value.
0130      *  @returns True if the solid is intersected by the extent region.
0131      */
0132     G4bool CalculateExtent(const EAxis pAxis,
0133                            const G4VoxelLimits& pVoxelLimit,
0134                            const G4AffineTransform& pTransform,
0135                            G4double& pmin, G4double& pmax) const override;
0136
0137     /**
0138      * Returns a generated polyhedron as graphical representations.
0139      */
0140     G4Polyhedron* CreatePolyhedron() const override;
0141
0142     /**
0143      * Copy constructor and assignment operator.
0144      */
0145     G4UHype( const G4UHype& source );
0146     G4UHype& operator=( const G4UHype& source );
0147 };
0148
0149 // --------------------------------------------------------------------
0150 // Inline methods
0151 // --------------------------------------------------------------------
0152
0153 inline G4GeometryType G4UHype::GetEntityType() const
0154 {
0155   return "G4Hype";
0156 }
0157
0158 #endif  // G4GEOM_USE_USOLIDS
0159
0160 #endif