include/Geant4/G4Polyhedra.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 // G4Polyhedra
0027 //
0028 // Class description:
0029 //
0030 //   Class implementing a CSG-like type "PGON" Geant 3.21 volume,
0031 //   inherited from class G4VCSGfaceted:
0032 //
0033 //   G4Polyhedra( const G4String& name,
0034 //                G4double phiStart,         - initial phi starting angle
0035 //                G4double phiTotal,         - total phi angle
0036 //                G4int numSide,             - number sides
0037 //                G4int numZPlanes,          - number of z planes
0038 //                const G4double zPlane[],   - position of z planes
0039 //                const G4double rInner[],   - tangent distance to inner surface
0040 //                const G4double rOuter[]  ) - tangent distance to outer surface
0041 //
0042 //   G4Polyhedra( const G4String& name,
0043 //                G4double phiStart,    - initial phi starting angle
0044 //                G4double phiTotal,    - total phi angle
0045 //                G4int    numSide,     - number sides
0046 //                G4int    numRZ,       - number corners in r,z space
0047 //                const G4double r[],   - r coordinate of these corners
0048 //                const G4double z[] )  - z coordinate of these corners
0049
0050 // Author: David C. Williams (davidw@scipp.ucsc.edu)
0051 // --------------------------------------------------------------------
0052 #ifndef G4POLYHEDRA_HH
0053 #define G4POLYHEDRA_HH
0054
0055 #include "G4GeomTypes.hh"
0056
0057 #if defined(G4GEOM_USE_USOLIDS)
0058 #define G4GEOM_USE_UPOLYHEDRA 1
0059 #endif
0060
0061 #if defined(G4GEOM_USE_UPOLYHEDRA)
0062   #define G4UPolyhedra G4Polyhedra
0063   #include "G4UPolyhedra.hh"
0064 #else
0065
0066 #include "G4VCSGfaceted.hh"
0067 #include "G4PolyhedraSide.hh"
0068 #include "G4PolyhedraHistorical.hh"
0069 #include "G4Polyhedron.hh"
0070
0071 class G4EnclosingCylinder;
0072 class G4ReduciblePolygon;
0073
0074 class G4Polyhedra : public G4VCSGfaceted
0075 {
0076   public:
0077
0078     G4Polyhedra(const G4String& name,
0079                       G4double phiStart,   // initial phi starting angle
0080                       G4double phiTotal,   // total phi angle
0081                       G4int numSide,       // number sides
0082                       G4int numZPlanes,    // number of z planes
0083                 const G4double zPlane[],   // position of z planes
0084                 const G4double rInner[],   // tangent distance to inner surface
0085                 const G4double rOuter[] ); // tangent distance to outer surface
0086
0087     G4Polyhedra(const G4String& name,
0088                       G4double phiStart,   // initial phi starting angle
0089                       G4double phiTotal,   // total phi angle
0090                       G4int    numSide,    // number sides
0091                       G4int    numRZ,      // number corners in r,z space
0092                 const G4double r[],        // r coordinate of these corners
0093                 const G4double z[] );      // z coordinate of these corners
0094
0095     ~G4Polyhedra() override;
0096
0097     EInside Inside( const G4ThreeVector& p ) const override;
0098     G4double DistanceToIn( const G4ThreeVector& p,
0099                            const G4ThreeVector& v ) const override;
0100     G4double DistanceToIn( const G4ThreeVector& p ) const override;
0101
0102     void BoundingLimits(G4ThreeVector& pMin, G4ThreeVector& pMax) const override;
0103     G4bool CalculateExtent(const EAxis pAxis,
0104                            const G4VoxelLimits& pVoxelLimit,
0105                            const G4AffineTransform& pTransform,
0106                                  G4double& pmin, G4double& pmax) const override;
0107
0108     void ComputeDimensions(       G4VPVParameterisation* p,
0109                             const G4int n,
0110                             const G4VPhysicalVolume* pRep) override;
0111
0112     G4GeometryType  GetEntityType() const override;
0113
0114     G4bool IsFaceted () const override;
0115
0116     G4VSolid* Clone() const override;
0117
0118     G4double GetCubicVolume() override;
0119     G4double GetSurfaceArea() override;
0120
0121     G4ThreeVector GetPointOnSurface() const override;
0122
0123     std::ostream& StreamInfo( std::ostream& os ) const override;
0124
0125     G4Polyhedron* CreatePolyhedron() const override;
0126
0127     G4bool Reset();
0128
0129     // Accessors
0130
0131     inline G4int GetNumSide()        const;
0132     inline G4double GetStartPhi()    const;
0133     inline G4double GetEndPhi()      const;
0134     inline G4double GetSinStartPhi() const;
0135     inline G4double GetCosStartPhi() const;
0136     inline G4double GetSinEndPhi()   const;
0137     inline G4double GetCosEndPhi()   const;
0138     inline G4bool IsOpen()           const;
0139     inline G4bool IsGeneric()        const;
0140     inline G4int GetNumRZCorner()    const;
0141     inline G4PolyhedraSideRZ GetCorner( const G4int index ) const;
0142
0143     inline G4PolyhedraHistorical* GetOriginalParameters() const;
0144       // Returns internal scaled parameters.
0145     inline void SetOriginalParameters(G4PolyhedraHistorical* pars);
0146       // Sets internal parameters. Parameters 'Rmin' and 'Rmax' in input must
0147       // be scaled first by a factor computed as 'cos(0.5*phiTotal/theNumSide)',
0148       // if not already scaled.
0149
0150     G4Polyhedra(__void__&);
0151       // Fake default constructor for usage restricted to direct object
0152       // persistency for clients requiring preallocation of memory for
0153       // persistifiable objects.
0154
0155     G4Polyhedra( const G4Polyhedra& source );
0156     G4Polyhedra& operator=( const G4Polyhedra& source );
0157       // Copy constructor and assignment operator.
0158
0159   protected:
0160
0161     void SetOriginalParameters(G4ReduciblePolygon* rz);
0162       // Sets internal parameters for the generic constructor.
0163
0164     void Create( G4double phiStart,           // initial phi starting angle
0165                  G4double phiTotal,           // total phi angle
0166                  G4int    numSide,            // number sides
0167                  G4ReduciblePolygon* rz );    // rz coordinates
0168       // Generates the shape and is called by each constructor, after the
0169       // conversion of the arguments
0170
0171     void CopyStuff( const G4Polyhedra& source );
0172     void DeleteStuff();
0173
0174     // Methods for generation of random points on surface
0175
0176     void SetSurfaceElements() const;
0177
0178   protected:
0179
0180     G4int numSide = 0;    // Number of sides
0181     G4double startPhi;    // Starting phi value (0 < phiStart < 2pi)
0182     G4double endPhi;      // end phi value (0 < endPhi-phiStart < 2pi)
0183     G4bool phiIsOpen = false;   // true if there is a phi segment
0184     G4bool genericPgon = false; // true if created through 2nd generic ctor
0185     G4int numCorner = 0;  // number RZ points
0186     G4PolyhedraSideRZ* corners = nullptr;  // our corners
0187     G4PolyhedraHistorical* original_parameters = nullptr; // original input pars
0188
0189     G4EnclosingCylinder* enclosingCylinder = nullptr;
0190
0191     struct surface_element { G4double area=0.; G4int i0=0, i1=0, i2=0; };
0192     mutable std::vector<surface_element>* fElements = nullptr;
0193 };
0194
0195 #include "G4Polyhedra.icc"
0196
0197 #endif
0198
0199 #endif