Import Geant4 11.4.0 source tree

source/geometry/solids/CSG/include/G4USphere.hh

@@ -29,7 +29,7 @@
 //
 // Wrapper class for G4Sphere to make use of VecGeom Sphere.
 
-// 13.09.13 G.Cosmo, CERN
+// Author: G.Cosmo (CERN), 13.09.2013
 // --------------------------------------------------------------------
 #ifndef G4USPHERE_HH
 #define G4USPHERE_HH
@@ -42,6 +42,11 @@
 
 #include "G4Polyhedron.hh"
 
+/**
+ * @brief G4USphere is a wrapper class for G4Sphere to make use of
+ * VecGeom Sphere.
+ */
+
 class G4USphere : public G4UAdapter<vecgeom::UnplacedSphere>
 {
   using Shape_t = vecgeom::UnplacedSphere;
@@ -49,21 +54,44 @@ class G4USphere : public G4UAdapter<vecgeom::UnplacedSphere>
 
   public:
 
+    /**
+     * Constructs a sphere or sphere shell section with the given
+     * name and dimensions.
+     *  @param[in] pName The name of the solid.
+     *  @param[in] pRmin Inner radius.
+     *  @param[in] pRmax Outer radius.
+     *  @param[in] pSPhi Starting Phi angle of the segment in radians.
+     *  @param[in] pDPhi Delta Phi angle of the segment in radians.
+     *  @param[in] pSTheta Starting Theta angle of the segment in radians.
+     *  @param[in] pDTheta Delta Theta angle of the segment in radians.
+     */
     G4USphere(const G4String& pName,
                     G4double pRmin, G4double pRmax,
                     G4double pSPhi, G4double pDPhi,
                     G4double pSTheta, G4double pDTheta);
-      // Constructs a sphere or sphere shell section
-      // with the given name and dimensions
        
-   ~G4USphere() override;
+    /**
+     * Default destructor.
+     */
+    ~G4USphere() override = default;
 
-    void ComputeDimensions(      G4VPVParameterisation* p,
+    /**
+     * Dispatch method for parameterisation replication mechanism and
+     * dimension computation.
+     */
+    void ComputeDimensions(G4VPVParameterisation* p,
                            const G4int n,
                            const G4VPhysicalVolume* pRep) override;
 
+    /**
+     * Makes a clone of the object for use in multi-treading.
+     *  @returns A pointer to the new cloned allocated solid.
+     */
     G4VSolid* Clone() const override;
 
+    /**
+     * Accessors.
+     */
     G4double GetInnerRadius    () const;
     G4double GetOuterRadius    () const;
     G4double GetStartPhiAngle  () const;
@@ -79,6 +107,9 @@ class G4USphere : public G4UAdapter<vecgeom::UnplacedSphere>
     G4double GetSinEndTheta    () const;
     G4double GetCosEndTheta    () const;
 
+    /**
+     * Modifiers.
+     */
     void SetInnerRadius    (G4double newRMin);
     void SetOuterRadius    (G4double newRmax);
     void SetStartPhiAngle  (G4double newSphi, G4bool trig=true);
@@ -86,20 +117,43 @@ class G4USphere : public G4UAdapter<vecgeom::UnplacedSphere>
     void SetStartThetaAngle(G4double newSTheta);
     void SetDeltaThetaAngle(G4double newDTheta);
 
+    /**
+     * Returns the type ID, "G4Sphere" of the solid.
+     */
     inline G4GeometryType GetEntityType() const override;
 
+    /**
+     * Computes the bounding limits of the solid.
+     *  @param[out] pMin The minimum bounding limit point.
+     *  @param[out] pMax The maximum bounding limit point.
+     */
     void BoundingLimits(G4ThreeVector& pMin, G4ThreeVector& pMax) const override;
 
+    /**
+     * Calculates the minimum and maximum extent of the solid, when under the
+     * specified transform, and within the specified limits.
+     *  @param[in] pAxis The axis along which compute the extent.
+     *  @param[in] pVoxelLimit The limiting space dictated by voxels.
+     *  @param[in] pTransform The internal transformation applied to the solid.
+     *  @param[out] pMin The minimum extent value.
+     *  @param[out] pMax The maximum extent value.
+     *  @returns True if the solid is intersected by the extent region.
+     */
     G4bool CalculateExtent(const EAxis pAxis,
                            const G4VoxelLimits& pVoxelLimit,
                            const G4AffineTransform& pTransform,
                                  G4double& pMin, G4double& pMax) const override;
 
+    /**
+     * Returns a generated polyhedron as graphical representations.
+     */
     G4Polyhedron* CreatePolyhedron() const override;
 
+    /**
+     * Copy constructor and assignment operator.
+     */
     G4USphere(const G4USphere& rhs);
     G4USphere& operator=(const G4USphere& rhs); 
-      // Copy constructor and assignment operator.
 };
 
 // --------------------------------------------------------------------