Geant4  10.02.p02
G4VPhysicalVolume.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: G4VPhysicalVolume.hh 93287 2015-10-15 09:50:22Z gcosmo $
28 //
29 //
30 // class G4VPhysicalVolume
31 //
32 // Class description:
33 //
34 // This is an Abstract Base class for the representation of positioned volume.
35 // The volume is placed within a mother volume, relative to its coordinate
36 // system. Either a single positioned volume or many positioned volume can
37 // be represented by a particular G4VPhysicalVolume.
38 
39 // History:
40 // 15.01.13 G.Cosmo, A.Dotti: Modified for thread-safety for MT
41 // 09.11.99 J.Apostolakis: Added GetObjectRotationValue() method & comments
42 // 28.08.96 P.Kent: Replaced transform by rotmat + vector
43 // 25.07.96 P.Kent: Modified interface for new `Replica' capable geometry
44 // 24.07.95 P.Kent: First non-stub version
45 // --------------------------------------------------------------------
46 #ifndef G4VPHYSICALVOLUME_HH
47 #define G4VPHYSICALVOLUME_HH
48 
49 #include "G4Types.hh"
50 #include "G4String.hh"
51 
52 #include "geomdefs.hh"
53 
54 #include "G4RotationMatrix.hh"
55 #include "G4ThreeVector.hh"
56 #include "G4GeomSplitter.hh"
57 
58 class G4LogicalVolume;
60 
61 class G4PVData
62 {
63  // Encapsulates the fields associated to G4VPhysicalVolume
64  // that are not read-only - they will change during simulation
65  // and must have a per-thread state.
66 
67  public:
68  G4PVData():frot(0) {}
69 
70  void initialize() {
71  frot = 0;
72  ftrans = G4ThreeVector(0,0,0);
73  }
74 
77 };
78 
80 // Implementation detail for use of G4PVData objects
81 
83 {
84  public: // with description
85 
87  const G4ThreeVector &tlate,
88  const G4String &pName,
89  G4LogicalVolume *pLogical,
90  G4VPhysicalVolume *pMother);
91  // Initialise volume, positioned in a frame which is rotated by *pRot,
92  // relative to the coordinate system of the mother volume pMother.
93  // The center of the object is then placed at tlate in the new
94  // coordinates. If pRot=0 the volume is unrotated with respect to its
95  // mother. The physical volume is added to the mother's logical volume.
96  //
97  // Must be called by all subclasses. pMother must point to a valid parent
98  // volume, except in the case of the world/top volume, when it =0.
99  //
100  // The constructor also registers volume with physical volume Store.
101  // Note that the Store may be removed or dynamically built in future
102  // because of memory constraints.
103 
104  virtual ~G4VPhysicalVolume();
105  // Destructor, will be subclassed. Removes volume from volume Store.
106 
107  inline G4bool operator == (const G4VPhysicalVolume& p) const;
108  // Equality defined by equal addresses only.
109 
110  // Access functions
111  //
112  // The following are accessor functions that make a distinction
113  // between whether the rotation/translation is being made for the
114  // frame or the object/volume that is being placed.
115  // (They are the inverse of each other).
116 
117  G4RotationMatrix* GetObjectRotation() const; // Obsolete
118  inline G4RotationMatrix GetObjectRotationValue() const; // Replacement
119  inline G4ThreeVector GetObjectTranslation() const;
120  // Return the rotation/translation of the Object relative to the mother.
121  inline const G4RotationMatrix* GetFrameRotation() const;
122  inline G4ThreeVector GetFrameTranslation() const;
123  // Return the rotation/translation of the Frame used to position
124  // this volume in its mother volume (opposite of object rot/trans).
125 
126  // Older access functions, that do not distinguish between frame/object!
127 
128  inline const G4ThreeVector& GetTranslation() const;
129  inline const G4RotationMatrix* GetRotation() const;
130  // Old access functions, that do not distinguish between frame/object!
131  // They return the translation/rotation of the volume.
132 
133  // Set functions
134 
135  inline void SetTranslation(const G4ThreeVector &v);
136  inline G4RotationMatrix* GetRotation();
137  inline void SetRotation(G4RotationMatrix*);
138  // NOT INTENDED FOR GENERAL USE.
139  // Non constant versions of above. Used to change transformation
140  // for replication/parameterisation mechanism.
141 
142  inline G4LogicalVolume* GetLogicalVolume() const;
143  // Return the associated logical volume.
144  inline void SetLogicalVolume(G4LogicalVolume *pLogical);
145  // Set the logical volume. Must not be called when geometry closed.
146 
147  inline G4LogicalVolume* GetMotherLogical() const;
148  // Return the current mother logical volume pointer.
149  inline void SetMotherLogical(G4LogicalVolume *pMother);
150  // Set the mother logical volume. Must not be called when geometry closed.
151 
152  inline const G4String& GetName() const;
153  // Return the volume's name.
154  inline void SetName(const G4String& pName);
155  // Set the volume's name.
156 
157  inline EVolume VolumeType() const;
158  // Characterise the `type' of volume - normal/replicated/parameterised.
159 
160  virtual G4int GetMultiplicity() const;
161  // Returns number of object entities (1 for normal placements,
162  // n for replicas or parameterised).
163 
164  // Functions required of subclasses
165 
166  virtual G4bool IsMany() const = 0;
167  // Return true if the volume is MANY (not implemented yet).
168  virtual G4int GetCopyNo() const = 0;
169  // Return the volumes copy number.
170  virtual void SetCopyNo(G4int CopyNo) = 0;
171  // Set the volumes copy number.
172  virtual G4bool IsReplicated() const = 0;
173  // Return true if replicated (single object instance represents
174  // many real volumes), else false.
175  virtual G4bool IsParameterised() const = 0;
176  // Return true if parameterised (single object instance represents
177  // many real parameterised volumes), else false.
178  virtual G4VPVParameterisation* GetParameterisation() const = 0;
179  // Return replicas parameterisation object (able to compute dimensions
180  // and transformations of replicas), or NULL if not applicable.
181  virtual void GetReplicationData(EAxis& axis,
182  G4int& nReplicas,
183  G4double& width,
184  G4double& offset,
185  G4bool& consuming) const = 0;
186  // Return replication information. No-op for no replicated volumes.
187  virtual G4bool IsRegularStructure() const = 0;
188  // Returns true if the underlying volume structure is regular.
189  virtual G4int GetRegularStructureId() const = 0;
190  // Returns non-zero code in case the underlying volume structure
191  // is regular, voxel-like. Value is id for structure type.
192  // If non-zero the volume is a candidate for specialised
193  // navigation such as 'nearest neighbour' directly on volumes.
194  virtual G4bool CheckOverlaps(G4int res=1000, G4double tol=0.,
195  G4bool verbose=true, G4int errMax=1);
196  // Verifies if the placed volume is overlapping with existing
197  // daughters or with the mother volume. Provides default resolution
198  // for the number of points to be generated and verified.
199  // Concrete implementation is done and required only for placed and
200  // parameterised volumes. Returns true if the volume is overlapping.
201 
202  public: // without description
203 
204  G4VPhysicalVolume(__void__&);
205  // Fake default constructor for usage restricted to direct object
206  // persistency for clients requiring preallocation of memory for
207  // persistifiable objects.
208 
209  inline G4int GetInstanceID() const;
210  // Returns the instance ID.
211 
212  static const G4PVManager& GetSubInstanceManager();
213  // Returns the private data instance manager.
214 
215  protected:
216 
217  void InitialiseWorker(G4VPhysicalVolume *pMasterObject,
218  G4RotationMatrix *pRot, const G4ThreeVector &tlate);
219  // This method is similar to the constructor. It is used by each worker
220  // thread to achieve the partial effect as that of the master thread.
221 
222  void TerminateWorker(G4VPhysicalVolume *pMasterObject);
223  // This method is similar to the destructor. It is used by each worker
224  // thread to achieve the partial effect as that of the master thread.
225 
226  protected:
227 
229  // For use in implementing the per-thread data,
230  // It is equivalent to a pointer to a G4PVData object.
232  // Needed to use G4PVManager for the G4PVData per-thread objects.
233 
234  private:
235 
238  // Private copy constructor and assignment operator.
239 
240  private:
241 
242  G4LogicalVolume* flogical; // The logical volume representing the
243  // physical and tracking attributes of
244  // the volume
245  G4String fname; // The name of the volume
246  G4LogicalVolume* flmother; // The current mother logical volume
247 
248  G4PVData* pvdata; // Shadow pointer for use of object persistency
249 };
250 
251 // NOTE:
252 // The type G4PVManager is introduced to encapsulate the methods used by
253 // both the master thread and worker threads to allocate memory space for
254 // the fields encapsulated by the class G4PVData. When each thread
255 // initializes the value for these fields, it refers to them using a macro
256 // definition defined below. For every G4VPhysicalVolume instance, there is
257 // a corresponding G4PVData instance. All G4PVData instances are organized
258 // by the class G4PVManager as an array.
259 // The field "int instanceID" is added to the class G4VPhysicalVolume.
260 // The value of this field in each G4VPhysicalVolume instance is the subscript
261 // of the corresponding G4PVData instance.
262 // In order to use the class G4PVManager, we add a static member in the class
263 // G4VPhysicalVolume as follows: "static G4PVManager subInstanceManager;".
264 // For the master thread, the array for G4PVData instances grows dynamically
265 // along with G4VPhysicalVolume instances are created. For each worker thread,
266 // it copies the array of G4PVData instances from the master thread.
267 // In addition, it invokes a method similiar to the constructor explicitly
268 // to achieve the partial effect for each instance in the array.
269 //
270 
271 #include "G4VPhysicalVolume.icc"
272 
273 #endif
EVolume VolumeType() const
G4ThreeVector GetFrameTranslation() const
const G4ThreeVector & GetTranslation() const
G4VPhysicalVolume(G4RotationMatrix *pRot, const G4ThreeVector &tlate, const G4String &pName, G4LogicalVolume *pLogical, G4VPhysicalVolume *pMother)
CLHEP::Hep3Vector G4ThreeVector
CLHEP::HepRotation G4RotationMatrix
virtual G4bool IsReplicated() const =0
G4ThreeVector ftrans
#define width
void SetName(const G4String &pName)
int G4int
Definition: G4Types.hh:78
static G4GEOM_DLL G4PVManager subInstanceManager
void SetRotation(G4RotationMatrix *)
G4bool operator==(const G4VPhysicalVolume &p) const
void InitialiseWorker(G4VPhysicalVolume *pMasterObject, G4RotationMatrix *pRot, const G4ThreeVector &tlate)
const G4RotationMatrix * GetFrameRotation() const
void TerminateWorker(G4VPhysicalVolume *pMasterObject)
G4int GetInstanceID() const
G4LogicalVolume * flogical
static const G4PVManager & GetSubInstanceManager()
const G4String & GetName() const
virtual G4bool IsMany() const =0
bool G4bool
Definition: G4Types.hh:79
virtual G4int GetRegularStructureId() const =0
virtual G4VPVParameterisation * GetParameterisation() const =0
virtual void SetCopyNo(G4int CopyNo)=0
G4RotationMatrix GetObjectRotationValue() const
void SetTranslation(const G4ThreeVector &v)
G4LogicalVolume * GetMotherLogical() const
G4VPhysicalVolume & operator=(const G4VPhysicalVolume &)
virtual G4bool IsParameterised() const =0
G4GeomSplitter< G4PVData > G4PVManager
G4LogicalVolume * GetLogicalVolume() const
EAxis
Definition: geomdefs.hh:54
virtual G4int GetCopyNo() const =0
const G4RotationMatrix * GetRotation() const
virtual G4int GetMultiplicity() const
G4RotationMatrix * GetObjectRotation() const
virtual void GetReplicationData(EAxis &axis, G4int &nReplicas, G4double &width, G4double &offset, G4bool &consuming) const =0
void initialize()
void SetMotherLogical(G4LogicalVolume *pMother)
G4ThreeVector GetObjectTranslation() const
EVolume
Definition: geomdefs.hh:68
double G4double
Definition: G4Types.hh:76
virtual G4bool IsRegularStructure() const =0
G4LogicalVolume * flmother
#define G4GEOM_DLL
Definition: geomwdefs.hh:48
virtual G4bool CheckOverlaps(G4int res=1000, G4double tol=0., G4bool verbose=true, G4int errMax=1)
void SetLogicalVolume(G4LogicalVolume *pLogical)
G4RotationMatrix * frot