Geant4  10.03
G4Hype.hh
Go to the documentation of this file.
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 //
27 // $Id: G4Hype.hh 100819 2016-11-02 15:17:36Z gcosmo $
28 // $Original: G4Hype.hh,v 1.0 1998/06/09 16:57:50 safai Exp $
29 //
30 //
31 // --------------------------------------------------------------------
32 // GEANT 4 class header file
33 //
34 //
35 // G4Hype
36 //
37 // Class description:
38 //
39 // This class implements a tube with hyperbolic profile.
40 //
41 // It describes an hyperbolic volume with curved sides parallel to
42 // the z-axis. The solid has a specified half-length along the z axis,
43 // about which it is centered, and a given minimum and maximum radius.
44 // A minimum radius of 0 signifies a filled Hype (with hyperbolical
45 // inner surface). To have a filled Hype the user must specify
46 // inner radius = 0 AND inner stereo angle = 0.
47 //
48 // The inner and outer hyperbolical surfaces can have different
49 // stereo angles. A stereo angle of 0 gives a cylindrical surface.
50 
51 // Authors:
52 // Ernesto Lamanna (Ernesto.Lamanna@roma1.infn.it) &
53 // Francesco Safai Tehrani (Francesco.SafaiTehrani@roma1.infn.it)
54 // Rome, INFN & University of Rome "La Sapienza", 9 June 1998.
55 //
56 // --------------------------------------------------------------------
57 #ifndef G4HYPE_HH
58 #define G4HYPE_HH
59 
60 #include "G4VSolid.hh"
61 #include "G4ThreeVector.hh"
62 #include "G4Polyhedron.hh"
63 
64 class G4SolidExtentList;
65 class G4ClippablePolygon;
66 
67 class G4Hype : public G4VSolid
68 {
69  public: // with description
70 
71  G4Hype(const G4String& pName,
72  G4double newInnerRadius,
73  G4double newOuterRadius,
74  G4double newInnerStereo,
75  G4double newOuterStereo,
76  G4double newHalfLenZ);
77 
78  virtual ~G4Hype();
79 
81  const G4int n,
82  const G4VPhysicalVolume* pRep);
83 
84  void Extent(G4ThreeVector& pMin, G4ThreeVector& pMax) const;
85 
86  G4bool CalculateExtent(const EAxis pAxis,
87  const G4VoxelLimits& pVoxelLimit,
88  const G4AffineTransform& pTransform,
89  G4double& pMin, G4double& pMax) const;
90 
91  inline G4double GetInnerRadius () const;
92  inline G4double GetOuterRadius () const;
93  inline G4double GetZHalfLength () const;
94  inline G4double GetInnerStereo () const;
95  inline G4double GetOuterStereo () const;
96 
97  inline void SetInnerRadius (G4double newIRad);
98  inline void SetOuterRadius (G4double newORad);
99  inline void SetZHalfLength (G4double newHLZ);
100  inline void SetInnerStereo (G4double newISte);
101  inline void SetOuterStereo (G4double newOSte);
102 
103  EInside Inside(const G4ThreeVector& p) const;
104 
105  G4ThreeVector SurfaceNormal(const G4ThreeVector& p) const;
106 
107  G4double DistanceToIn(const G4ThreeVector& p, const G4ThreeVector& v) const;
108  G4double DistanceToIn(const G4ThreeVector& p) const;
110  const G4bool calcNorm=G4bool(false),
111  G4bool *validNorm=0, G4ThreeVector *n=0) const;
112  G4double DistanceToOut(const G4ThreeVector& p) const;
113 
115 
116  G4VSolid* Clone() const;
117 
118  std::ostream& StreamInfo(std::ostream& os) const;
119 
122 
124 
125  void DescribeYourselfTo (G4VGraphicsScene& scene) const;
126  G4VisExtent GetExtent () const;
127  G4Polyhedron* CreatePolyhedron () const;
128  G4Polyhedron* GetPolyhedron () const;
129 
130  public: // without description
131 
132  G4Hype(__void__&);
133  // Fake default constructor for usage restricted to direct object
134  // persistency for clients requiring preallocation of memory for
135  // persistifiable objects.
136 
137  G4Hype(const G4Hype& rhs);
138  G4Hype& operator=(const G4Hype& rhs);
139  // Copy constructor and assignment operator.
140 
141  protected: // without description
142 
143  inline G4bool InnerSurfaceExists() const;
144  // whether we have an inner surface or not
145 
147  G4double r0, G4double tanPhi );
149  G4double r0, G4double tan2Phi );
150  // approximate isotropic distance to hyperbolic surface
151 
152  inline G4double HypeInnerRadius2(G4double zVal) const;
153  inline G4double HypeOuterRadius2(G4double zVal) const;
154  // values of hype radius at a given Z
155 
156  static G4int IntersectHype( const G4ThreeVector &p, const G4ThreeVector &v,
157  G4double r2, G4double tan2Phi, G4double s[2] );
158  // intersection with hyperbolic surface
159 
160  protected:
161 
167 
168  // precalculated parameters, squared quantities
169 
172  G4double tanInnerStereo2; // squared tan of Inner Stereo angle
173  G4double tanOuterStereo2; // squared tan of Outer Stereo angle
174  G4double innerRadius2; // squared Inner Radius
175  G4double outerRadius2; // squared Outer Radius
176  G4double endInnerRadius2; // squared endcap Inner Radius
177  G4double endOuterRadius2; // squared endcap Outer Radius
178  G4double endInnerRadius; // endcap Inner Radius
179  G4double endOuterRadius; // endcap Outer Radius
180 
181  // Used by distanceToOut
182 
184 
185  private:
186 
187  G4double asinh(G4double arg);
188 
189  private:
190 
193 
195 
198 };
199 
200 #include "G4Hype.icc"
201 
202 #endif
G4double outerStereo
Definition: G4Hype.hh:166
G4bool fRebuildPolyhedron
Definition: G4Hype.hh:196
G4double GetCubicVolume()
Definition: G4Hype.cc:1133
G4double outerRadius2
Definition: G4Hype.hh:175
G4double fHalfTol
Definition: G4Hype.hh:194
G4double GetOuterStereo() const
G4Hype(const G4String &pName, G4double newInnerRadius, G4double newOuterRadius, G4double newInnerStereo, G4double newOuterStereo, G4double newHalfLenZ)
Definition: G4Hype.cc:74
G4double DistanceToIn(const G4ThreeVector &p, const G4ThreeVector &v) const
Definition: G4Hype.cc:355
G4double GetInnerStereo() const
static constexpr double s
Definition: G4SIunits.hh:169
CLHEP::Hep3Vector G4ThreeVector
G4double GetInnerRadius() const
G4double GetSurfaceArea()
Definition: G4Hype.cc:1144
G4double innerRadius2
Definition: G4Hype.hh:174
G4GeometryType GetEntityType() const
Definition: G4Hype.cc:1115
G4double innerStereo
Definition: G4Hype.hh:165
void ComputeDimensions(G4VPVParameterisation *p, const G4int n, const G4VPhysicalVolume *pRep)
Definition: G4Hype.cc:212
static G4double ApproxDistInside(G4double pr, G4double pz, G4double r0, G4double tan2Phi)
Definition: G4Hype.cc:1091
void Extent(G4ThreeVector &pMin, G4ThreeVector &pMax) const
Definition: G4Hype.cc:223
G4double fSurfaceArea
Definition: G4Hype.hh:192
G4Polyhedron * CreatePolyhedron() const
Definition: G4Hype.cc:1306
G4double endOuterRadius2
Definition: G4Hype.hh:177
void DescribeYourselfTo(G4VGraphicsScene &scene) const
Definition: G4Hype.cc:1284
G4double tanOuterStereo
Definition: G4Hype.hh:171
int G4int
Definition: G4Types.hh:78
G4bool InnerSurfaceExists() const
virtual ~G4Hype()
Definition: G4Hype.cc:152
G4double HypeOuterRadius2(G4double zVal) const
G4double tanOuterStereo2
Definition: G4Hype.hh:173
G4VSolid * Clone() const
Definition: G4Hype.cc:1124
static G4double ApproxDistOutside(G4double pr, G4double pz, G4double r0, G4double tanPhi)
Definition: G4Hype.cc:1033
G4double tanInnerStereo2
Definition: G4Hype.hh:172
void SetOuterRadius(G4double newORad)
G4double outerRadius
Definition: G4Hype.hh:163
G4double HypeInnerRadius2(G4double zVal) const
Definition: G4Hype.hh:67
G4double endOuterRadius
Definition: G4Hype.hh:179
bool G4bool
Definition: G4Types.hh:79
void SetInnerRadius(G4double newIRad)
G4double GetOuterRadius() const
const G4int n
G4double DistanceToOut(const G4ThreeVector &p, const G4ThreeVector &v, const G4bool calcNorm=G4bool(false), G4bool *validNorm=0, G4ThreeVector *n=0) const
Definition: G4Hype.cc:731
G4Hype & operator=(const G4Hype &rhs)
Definition: G4Hype.cc:179
G4double halfLenZ
Definition: G4Hype.hh:164
G4ThreeVector GetPointOnSurface() const
Definition: G4Hype.cc:1179
G4VisExtent GetExtent() const
Definition: G4Hype.cc:1293
static G4int IntersectHype(const G4ThreeVector &p, const G4ThreeVector &v, G4double r2, G4double tan2Phi, G4double s[2])
Definition: G4Hype.cc:965
EInside
Definition: geomdefs.hh:58
G4double fCubicVolume
Definition: G4Hype.hh:191
EAxis
Definition: geomdefs.hh:54
G4double tanInnerStereo
Definition: G4Hype.hh:170
EInside Inside(const G4ThreeVector &p) const
Definition: G4Hype.cc:265
void SetZHalfLength(G4double newHLZ)
G4double GetZHalfLength() const
G4Polyhedron * fpPolyhedron
Definition: G4Hype.hh:197
G4double asinh(G4double arg)
Definition: G4Hype.cc:1336
G4double endInnerRadius2
Definition: G4Hype.hh:176
void SetOuterStereo(G4double newOSte)
double G4double
Definition: G4Types.hh:76
G4double innerRadius
Definition: G4Hype.hh:162
G4double endInnerRadius
Definition: G4Hype.hh:178
std::ostream & StreamInfo(std::ostream &os) const
Definition: G4Hype.cc:1155
G4Polyhedron * GetPolyhedron() const
Definition: G4Hype.cc:1316
G4bool CalculateExtent(const EAxis pAxis, const G4VoxelLimits &pVoxelLimit, const G4AffineTransform &pTransform, G4double &pMin, G4double &pMax) const
Definition: G4Hype.cc:246
void SetInnerStereo(G4double newISte)
G4ThreeVector SurfaceNormal(const G4ThreeVector &p) const
Definition: G4Hype.cc:309