| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
>> 25 //
>> 26 //
>> 27 // $Id: G4PVPlacement.hh 73250 2013-08-22 13:22:23Z gcosmo $
>> 28 //
25 // 29 //
26 // G4PVPlacement << 30 // class G4PVPlacement
27 // 31 //
28 // Class description: 32 // Class description:
29 // 33 //
30 // Class representing a single volume position 34 // Class representing a single volume positioned within and relative
31 // to a mother volume. 35 // to a mother volume.
32 36
33 // 24.07.95 P.Kent, First non-stub version. << 37 // History:
>> 38 // 24.07.95 P.Kent First non-stub version
>> 39 // 25.07.96 P.Kent Modified interface for new `Replica' capable geometry
>> 40 // 28.08.96 P.Kent Tidied + transform replaced by rotmat+vector
>> 41 // 28.02.97 J.Apostolakis Added 2nd constructor with G4Transform3D of solid.
>> 42 // 11.07.97 J.Apostolakis Added 3rd constructor with pMotherLogical
>> 43 // 11.05.98 J.Apostolakis Added 4th constructor with G4Transform3D & pMotherLV
34 // ------------------------------------------- 44 // ----------------------------------------------------------------------
35 #ifndef G4PVPLACEMENT_HH 45 #ifndef G4PVPLACEMENT_HH
36 #define G4PVPLACEMENT_HH 1 << 46 #define G4PVPLACEMENT_HH
37 47
38 #include "G4VPhysicalVolume.hh" 48 #include "G4VPhysicalVolume.hh"
39 #include "G4Transform3D.hh" 49 #include "G4Transform3D.hh"
40 50
41 class G4PVPlacement : public G4VPhysicalVolume 51 class G4PVPlacement : public G4VPhysicalVolume
42 { 52 {
43 public: << 53 public: // with description
44 54
45 G4PVPlacement(G4RotationMatrix* pRot, << 55 G4PVPlacement(G4RotationMatrix *pRot,
46 const G4ThreeVector& tlate, << 56 const G4ThreeVector &tlate,
47 G4LogicalVolume* pCurrentLog << 57 G4LogicalVolume *pCurrentLogical,
48 const G4String& pName, 58 const G4String& pName,
49 G4LogicalVolume* pMotherLogi << 59 G4LogicalVolume *pMotherLogical,
50 G4bool pMany, 60 G4bool pMany,
51 G4int pCopyNo, 61 G4int pCopyNo,
52 G4bool pSurfChk = false); << 62 G4bool pSurfChk=false);
53 // Initialise a single volume, positione 63 // Initialise a single volume, positioned in a frame which is rotated by
54 // *pRot and traslated by tlate, relativ 64 // *pRot and traslated by tlate, relative to the coordinate system of the
55 // mother volume pMotherLogical. 65 // mother volume pMotherLogical.
56 // If pRot=nullptr the volume is unrotat << 66 // If pRot=0 the volume is unrotated with respect to its mother.
57 // The physical volume is added to the m 67 // The physical volume is added to the mother's logical volume.
58 // Arguments particular to G4PVPlacement 68 // Arguments particular to G4PVPlacement:
59 // pMany Currently NOT used. For futur 69 // pMany Currently NOT used. For future use to identify if the volume
60 // is meant to be considered an 70 // is meant to be considered an overlapping structure, or not.
61 // pCopyNo should be set to 0 for the 71 // pCopyNo should be set to 0 for the first volume of a given type.
62 // pSurfChk if true activates check fo 72 // pSurfChk if true activates check for overlaps with existing volumes.
63 // This is a very natural way of definin 73 // This is a very natural way of defining a physical volume, and is
64 // especially useful when creating subde 74 // especially useful when creating subdetectors: the mother volumes are
65 // not placed until a later stage of the 75 // not placed until a later stage of the assembly program.
66 76
67 G4PVPlacement(const G4Transform3D& Transfo << 77 G4PVPlacement(const G4Transform3D &Transform3D,
68 G4LogicalVolume* pCurr << 78 G4LogicalVolume *pCurrentLogical,
69 const G4String& pName, 79 const G4String& pName,
70 G4LogicalVolume* pMoth << 80 G4LogicalVolume *pMotherLogical,
71 G4bool pMany, 81 G4bool pMany,
72 G4int pCopyNo, 82 G4int pCopyNo,
73 G4bool pSurfChk = fals << 83 G4bool pSurfChk=false);
74 // Additional constructor, which expects 84 // Additional constructor, which expects a G4Transform3D that represents
75 // the direct rotation and translation o 85 // the direct rotation and translation of the solid (NOT of the frame).
76 // The G4Transform3D argument should be 86 // The G4Transform3D argument should be constructed by:
77 // i) First rotating it to align the so 87 // i) First rotating it to align the solid to the system of
78 // reference of its mother volume *p 88 // reference of its mother volume *pMotherLogical, and
79 // ii) Then placing the solid at the loc 89 // ii) Then placing the solid at the location Transform3D.getTranslation(),
80 // with respect to the origin of the 90 // with respect to the origin of the system of coordinates of the
81 // mother volume. 91 // mother volume.
82 // [ This is useful for the people who p 92 // [ This is useful for the people who prefer to think in terms
83 // of moving objects in a given refere 93 // of moving objects in a given reference frame. ]
84 // All other arguments are the same as f 94 // All other arguments are the same as for the previous constructor.
85 95
86 G4PVPlacement(G4RotationMatrix* pRot, << 96 public: // without description
87 const G4ThreeVector& tlate, << 97
88 const G4String& pName, << 98 G4PVPlacement(G4RotationMatrix *pRot,
89 G4LogicalVolume* pLogical, << 99 const G4ThreeVector &tlate,
90 G4VPhysicalVolume* pMother, << 100 const G4String &pName,
>> 101 G4LogicalVolume *pLogical,
>> 102 G4VPhysicalVolume *pMother,
91 G4bool pMany, 103 G4bool pMany,
92 G4int pCopyNo, 104 G4int pCopyNo,
93 G4bool pSurfChk = false); << 105 G4bool pSurfChk=false);
94 // A simple variation of the 1st constru 106 // A simple variation of the 1st constructor, only specifying the
95 // mother volume as a pointer to its phy 107 // mother volume as a pointer to its physical volume instead of its
96 // logical volume. The effect is exactly 108 // logical volume. The effect is exactly the same.
97 109
98 G4PVPlacement(const G4Transform3D& Transfo << 110 G4PVPlacement(const G4Transform3D &Transform3D,
99 const G4String& pName, << 111 const G4String &pName,
100 G4LogicalVolume* pLogi << 112 G4LogicalVolume *pLogical,
101 G4VPhysicalVolume* pMo << 113 G4VPhysicalVolume *pMother,
102 G4bool pMany, 114 G4bool pMany,
103 G4int pCopyNo, 115 G4int pCopyNo,
104 G4bool pSurfChk = fals << 116 G4bool pSurfChk=false);
105 // Utilises both variations above (from 117 // Utilises both variations above (from 2nd and 3rd constructor).
106 // The effect is the same as for the 2nd 118 // The effect is the same as for the 2nd constructor.
107 119
108 ~G4PVPlacement() override; << 120 public: // with description
109 // Default destructor. <<
110 121
111 inline G4int GetCopyNo() const override { << 122 virtual ~G4PVPlacement();
>> 123 // Default destructor.
112 124
113 void SetCopyNo(G4int CopyNo) override; << 125 G4int GetCopyNo() const;
>> 126 void SetCopyNo(G4int CopyNo);
114 // Gets and sets the copy number of the 127 // Gets and sets the copy number of the volume.
115 128
116 G4bool CheckOverlaps(G4int res = 1000, G4d << 129 G4bool CheckOverlaps(G4int res=1000, G4double tol=0.,
117 G4bool verbose = true << 130 G4bool verbose=true, G4int maxErr=1);
118 // Verifies if the placed volume is over 131 // Verifies if the placed volume is overlapping with existing
119 // daughters or with the mother volume. 132 // daughters or with the mother volume. Provides default resolution
120 // for the number of points to be genera 133 // for the number of points to be generated and verified.
121 // A tolerance for the precision of the 134 // A tolerance for the precision of the overlap check can be specified,
122 // by default it is set to maximum preci 135 // by default it is set to maximum precision.
123 // Reports a maximum of overlaps errors 136 // Reports a maximum of overlaps errors according to parameter in input.
124 // Returns true if the volume is overlap 137 // Returns true if the volume is overlapping.
125 138
>> 139 public: // without description
>> 140
126 G4PVPlacement(__void__&); 141 G4PVPlacement(__void__&);
127 // Fake default constructor for usage re 142 // Fake default constructor for usage restricted to direct object
128 // persistency for clients requiring pre 143 // persistency for clients requiring preallocation of memory for
129 // persistifiable objects. 144 // persistifiable objects.
130 145
131 G4PVPlacement(const G4PVPlacement&) = dele << 146 G4bool IsMany() const;
132 G4PVPlacement& operator=(const G4PVPlaceme << 147 G4bool IsReplicated() const;
133 // Copy constructor and assignment opera << 148 G4bool IsParameterised() const;
134 << 149 G4VPVParameterisation* GetParameterisation() const;
135 G4bool IsMany() const override; <<
136 G4bool IsReplicated() const override; <<
137 G4bool IsParameterised() const override; <<
138 G4VPVParameterisation* GetParameterisation <<
139 void GetReplicationData(EAxis& axis, 150 void GetReplicationData(EAxis& axis,
140 G4int& nReplicas, 151 G4int& nReplicas,
141 G4double& width, 152 G4double& width,
142 G4double& offset, 153 G4double& offset,
143 G4bool& consuming) << 154 G4bool& consuming) const;
144 G4bool IsRegularStructure() const override << 155 G4bool IsRegularStructure() const;
145 G4int GetRegularStructureId() const overri << 156 G4int GetRegularStructureId() const;
146 157
147 EVolume VolumeType() const override; <<
148 <<
149 private: 158 private:
150 159
151 static G4RotationMatrix* NewPtrRotMatrix(c << 160 static G4RotationMatrix* NewPtrRotMatrix(const G4RotationMatrix &RotMat);
152 // Auxiliary function for 2nd constructo 161 // Auxiliary function for 2nd constructor (one with G4Transform3D).
153 // Creates a new RotMatrix on the heap ( 162 // Creates a new RotMatrix on the heap (using "new") and copies
154 // its argument into it. 163 // its argument into it.
155 164
>> 165 G4PVPlacement(const G4PVPlacement&);
>> 166 G4PVPlacement& operator=(const G4PVPlacement&);
>> 167 // Private copy constructor and assignment operator.
>> 168
156 private: 169 private:
157 170
158 G4bool fmany = false; // flag for overla << 171 G4bool fmany; // flag for overlapping structure - not used
159 G4bool fallocatedRotM = false; // flag fo << 172 G4bool fallocatedRotM; // flag for allocation of Rotation Matrix
160 G4int fcopyNo = 0; // for identificat << 173 G4int fcopyNo; // for identification
>> 174
161 }; 175 };
162 176
163 #endif 177 #endif
>> 178
164 179