| 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 // 25 //
26 // G4Region << 26 //
>> 27 // $Id: G4Region.hh,v 1.21 2009-11-27 16:34:37 gcosmo Exp $
>> 28 // GEANT4 tag $Name: geant4-09-04-patch-01 $
>> 29 //
>> 30 // class G4Region
27 // 31 //
28 // Class description: 32 // Class description:
29 // 33 //
30 // Defines a region or a group of regions in t 34 // Defines a region or a group of regions in the detector geometry
31 // setup, sharing properties associated to mat 35 // setup, sharing properties associated to materials or production
32 // cuts which may affect or bias specific phys 36 // cuts which may affect or bias specific physics processes.
33 37
34 // 18.09.02, G.Cosmo - Initial version << 38 // History:
>> 39 // 18.09.02 G.Cosmo Initial version
35 // ------------------------------------------- 40 // --------------------------------------------------------------------
36 #ifndef G4REGION_HH 41 #ifndef G4REGION_HH
37 #define G4REGION_HH 1 << 42 #define G4REGION_HH
38 <<
39 #include <vector> <<
40 #include <map> <<
41 #include <algorithm> <<
42 <<
43 #include "G4Types.hh" <<
44 #include "G4String.hh" <<
45 #include "G4GeomSplitter.hh" <<
46 43
47 class G4ProductionCuts; 44 class G4ProductionCuts;
48 class G4LogicalVolume; 45 class G4LogicalVolume;
49 class G4Material; 46 class G4Material;
50 class G4VUserRegionInformation; 47 class G4VUserRegionInformation;
51 class G4MaterialCutsCouple; 48 class G4MaterialCutsCouple;
52 class G4UserLimits; 49 class G4UserLimits;
53 class G4FieldManager; 50 class G4FieldManager;
54 class G4FastSimulationManager; 51 class G4FastSimulationManager;
55 class G4VPhysicalVolume; 52 class G4VPhysicalVolume;
56 class G4UserSteppingAction; 53 class G4UserSteppingAction;
57 54
58 class G4RegionData << 55 #include <vector>
59 { << 56 #include <map>
60 // Encapsulates the fields associated to the << 57 #include <algorithm>
61 // G4Region that may not be read-only. <<
62 <<
63 public: <<
64 <<
65 void initialize() <<
66 { <<
67 fFastSimulationManager = nullptr; <<
68 fRegionalSteppingAction = nullptr; <<
69 } <<
70 <<
71 G4FastSimulationManager* fFastSimulationMa <<
72 G4UserSteppingAction* fRegionalSteppingAct <<
73 }; <<
74 58
75 // The type G4RegionManager is introduced to e << 59 #include "G4Types.hh"
76 // both the master thread and worker threads t << 60 #include "G4String.hh"
77 // the fields encapsulated by the class G4Regi <<
78 // initializes the value for these fields, it <<
79 // definition defined below. For every G4Regio <<
80 // corresponding G4RegionData instance. All G4 <<
81 // organized by the class G4RegionManager as a <<
82 // The field "int instanceID" is added to the <<
83 // The value of this field in each G4Region in <<
84 // of the corresponding G4RegionData instance. <<
85 // In order to use the class G4RegionManager, <<
86 // the class G4Region as follows: "static G4Re <<
87 // For the master thread, the array for G4Regi <<
88 // dynamically along with G4Region instances a <<
89 // thread, it copies the array of G4RegionData <<
90 // In addition, it invokes a method similiar t <<
91 // to achieve the partial effect for each inst <<
92 // <<
93 using G4RegionManager = G4GeomSplitter<G4Regio <<
94 61
95 class G4Region 62 class G4Region
96 { 63 {
97 public: << 64 typedef std::vector<G4LogicalVolume*> G4RootLVList;
>> 65 typedef std::vector<G4Material*> G4MaterialList;
>> 66 typedef std::pair<G4Material*,G4MaterialCutsCouple*> G4MaterialCouplePair;
>> 67 typedef std::map<G4Material*,G4MaterialCutsCouple*> G4MaterialCoupleMap;
>> 68
>> 69 public: // with description
98 70
99 G4Region(const G4String& name); 71 G4Region(const G4String& name);
100 virtual ~G4Region(); 72 virtual ~G4Region();
101 73
102 G4Region(const G4Region&) = delete; <<
103 G4Region& operator=(const G4Region&) = del <<
104 // Copy constructor and assignment opera <<
105 <<
106 inline G4bool operator==(const G4Region& r 74 inline G4bool operator==(const G4Region& rg) const;
107 // Equality defined by address only. 75 // Equality defined by address only.
108 76
109 void AddRootLogicalVolume(G4LogicalVolume* << 77 void AddRootLogicalVolume(G4LogicalVolume* lv);
110 void RemoveRootLogicalVolume(G4LogicalVolu 78 void RemoveRootLogicalVolume(G4LogicalVolume* lv, G4bool scan=true);
111 // Add/remove root logical volumes and s 79 // Add/remove root logical volumes and set/reset their
112 // daughters flags as regions. They also 80 // daughters flags as regions. They also recompute the
113 // materials list for the region. Flag f << 81 // materials list for the region.
114 // always enabled by default. Search in <<
115 // when adding, assuming the user guaran <<
116 // NOT already inserted, in which case s <<
117 // achieved in very complex flat geometr <<
118 82
119 void SetName(const G4String& name); << 83 inline void SetName(const G4String& name);
120 inline const G4String& GetName() const; 84 inline const G4String& GetName() const;
121 // Set/get region's name. 85 // Set/get region's name.
122 86
123 inline void RegionModified(G4bool flag); 87 inline void RegionModified(G4bool flag);
124 inline G4bool IsModified() const; 88 inline G4bool IsModified() const;
125 // Accessors to flag identifying if a re 89 // Accessors to flag identifying if a region has been modified
126 // (and still cuts needs to be computed) 90 // (and still cuts needs to be computed) or not.
127 91
128 inline void SetProductionCuts(G4Production 92 inline void SetProductionCuts(G4ProductionCuts* cut);
129 inline G4ProductionCuts* GetProductionCuts 93 inline G4ProductionCuts* GetProductionCuts() const;
130 94
131 inline std::vector<G4LogicalVolume*>::iter 95 inline std::vector<G4LogicalVolume*>::iterator
132 GetRootLogicalVolumeIterator(); 96 GetRootLogicalVolumeIterator();
133 inline std::vector<G4Material*>::const_ite 97 inline std::vector<G4Material*>::const_iterator
134 GetMaterialIterator() const; 98 GetMaterialIterator() const;
135 // Return iterators to lists of root log 99 // Return iterators to lists of root logical volumes and materials.
136 100
137 inline std::size_t GetNumberOfMaterials() << 101 inline size_t GetNumberOfMaterials() const;
138 inline std::size_t GetNumberOfRootVolumes( << 102 inline size_t GetNumberOfRootVolumes() const;
139 // Return the number of elements in the 103 // Return the number of elements in the lists of materials and
140 // root logical volumes. 104 // root logical volumes.
141 105
142 void UpdateMaterialList(); 106 void UpdateMaterialList();
143 // Clears material list and recomputes i 107 // Clears material list and recomputes it looping through
144 // each root logical volume in the regio 108 // each root logical volume in the region.
145 109
146 void ClearMaterialList(); 110 void ClearMaterialList();
147 // Clears the material list. 111 // Clears the material list.
148 112
149 void ScanVolumeTree(G4LogicalVolume* lv, G 113 void ScanVolumeTree(G4LogicalVolume* lv, G4bool region);
150 // Scans recursively the 'lv' logical vo 114 // Scans recursively the 'lv' logical volume tree, retrieves
151 // and places all materials in the list 115 // and places all materials in the list if becoming a region.
152 116
153 inline void SetUserInformation(G4VUserRegi 117 inline void SetUserInformation(G4VUserRegionInformation* ui);
154 inline G4VUserRegionInformation* GetUserIn 118 inline G4VUserRegionInformation* GetUserInformation() const;
155 // Set and Get methods for user informat 119 // Set and Get methods for user information.
156 120
157 inline void SetUserLimits(G4UserLimits* ul 121 inline void SetUserLimits(G4UserLimits* ul);
158 inline G4UserLimits* GetUserLimits() const 122 inline G4UserLimits* GetUserLimits() const;
159 // Set and Get methods for userL-limits 123 // Set and Get methods for userL-limits associated to a region.
160 // Once user-limits are set, it will pro 124 // Once user-limits are set, it will propagate to daughter volumes.
161 125
162 inline void ClearMap(); 126 inline void ClearMap();
163 // Reset G4MaterialCoupleMap 127 // Reset G4MaterialCoupleMap
164 128
165 inline void RegisterMaterialCouplePair(G4M 129 inline void RegisterMaterialCouplePair(G4Material* mat,
166 G4M 130 G4MaterialCutsCouple* couple);
167 // Method invoked by G4ProductionCutsTab 131 // Method invoked by G4ProductionCutsTable to register the pair.
168 132
169 inline G4MaterialCutsCouple* FindCouple(G4 133 inline G4MaterialCutsCouple* FindCouple(G4Material* mat);
170 // Find a G4MaterialCutsCouple which cor 134 // Find a G4MaterialCutsCouple which corresponds to the material
171 // in this region. 135 // in this region.
172 136
173 void SetFastSimulationManager(G4FastSimula << 137 inline void SetFastSimulationManager(G4FastSimulationManager* fsm);
174 G4FastSimulationManager* GetFastSimulation << 138 inline G4FastSimulationManager* GetFastSimulationManager() const;
175 // Set and Get methods for G4FastSimulat 139 // Set and Get methods for G4FastSimulationManager.
176 // The root logical volume that has the 140 // The root logical volume that has the region with G4FastSimulationManager
177 // becomes an envelope of fast simulatio 141 // becomes an envelope of fast simulation.
178 142
179 void ClearFastSimulationManager(); 143 void ClearFastSimulationManager();
180 // Set G4FastSimulationManager pointer t 144 // Set G4FastSimulationManager pointer to the one for the parent region
181 // if it exists. Otherwise set to null. 145 // if it exists. Otherwise set to null.
182 146
183 inline void SetFieldManager(G4FieldManager 147 inline void SetFieldManager(G4FieldManager* fm);
184 inline G4FieldManager* GetFieldManager() c 148 inline G4FieldManager* GetFieldManager() const;
185 // Set and Get methods for G4FieldManage 149 // Set and Get methods for G4FieldManager.
186 // The region with assigned field-manage 150 // The region with assigned field-manager sets the field to the
187 // geometrical area associated with it; 151 // geometrical area associated with it; priority is anyhow given
188 // to local fields eventually set to log 152 // to local fields eventually set to logical volumes.
189 153
190 inline G4VPhysicalVolume* GetWorldPhysical 154 inline G4VPhysicalVolume* GetWorldPhysical() const;
191 // Get method for the world physical vol 155 // Get method for the world physical volume which this region
192 // belongs to. A valid pointer will be a 156 // belongs to. A valid pointer will be assigned by G4RunManagerKernel
193 // through G4RegionStore when the geomet 157 // through G4RegionStore when the geometry is to be closed. Thus, this
194 // pointer may be incorrect at PreInit a 158 // pointer may be incorrect at PreInit and Idle state. If the pointer
195 // is null at the proper state, this par 159 // is null at the proper state, this particular region does not belong
196 // to any world (maybe not assigned to a 160 // to any world (maybe not assigned to any volume, etc.).
197 161
198 void SetWorld(G4VPhysicalVolume* wp); 162 void SetWorld(G4VPhysicalVolume* wp);
199 // Set the world physical volume if this 163 // Set the world physical volume if this region belongs to this world.
200 // If wp is null, reset the pointer. 164 // If wp is null, reset the pointer.
201 165
202 G4bool BelongsTo(G4VPhysicalVolume* thePhy 166 G4bool BelongsTo(G4VPhysicalVolume* thePhys) const;
203 // Returns whether this region belongs t 167 // Returns whether this region belongs to the given physical volume
204 // (recursively scanned to the bottom of 168 // (recursively scanned to the bottom of the hierarchy).
205 169
206 G4Region* GetParentRegion(G4bool& unique) 170 G4Region* GetParentRegion(G4bool& unique) const;
207 // Returns a region that contains this r 171 // Returns a region that contains this region. Otherwise null returned.
208 // Flag 'unique' is true if there is onl 172 // Flag 'unique' is true if there is only one parent region containing
209 // the current region. 173 // the current region.
210 174
211 void SetRegionalSteppingAction(G4UserStepp << 175 inline void SetRegionalSteppingAction(G4UserSteppingAction* rusa);
212 G4UserSteppingAction* GetRegionalSteppingA << 176 inline G4UserSteppingAction* GetRegionalSteppingAction() const;
213 // Set/Get method of the regional user s 177 // Set/Get method of the regional user stepping action
214 178
215 public: << 179 public: // without description
216 180
217 G4Region(__void__&); 181 G4Region(__void__&);
218 // Fake default constructor for usage re 182 // Fake default constructor for usage restricted to direct object
219 // persistency for clients requiring pre 183 // persistency for clients requiring preallocation of memory for
220 // persistifiable objects. 184 // persistifiable objects.
221 185
222 inline G4int GetInstanceID() const; <<
223 // Returns the instance ID. <<
224 <<
225 static const G4RegionManager& GetSubInstan <<
226 // Returns the private data instance man <<
227 <<
228 static void Clean(); <<
229 // Clear memory allocated by sub-instanc <<
230 <<
231 inline void UsedInMassGeometry(G4bool val <<
232 inline void UsedInParallelGeometry(G4bool <<
233 inline G4bool IsInMassGeometry() const; <<
234 inline G4bool IsInParallelGeometry() const <<
235 // Utility methods to identify if region <<
236 // geometry for tracking or a parallel g <<
237 <<
238 private: 186 private:
239 187
>> 188 G4Region(const G4Region&);
>> 189 G4Region& operator=(const G4Region&);
>> 190 // Private copy constructor and assignment operator.
>> 191
240 inline void AddMaterial (G4Material* aMate 192 inline void AddMaterial (G4Material* aMaterial);
241 // Searchs the specified material in the 193 // Searchs the specified material in the material table and
242 // if not present adds it. 194 // if not present adds it.
243 195
244 private: 196 private:
245 197
246 using G4RootLVList = std::vector<G4Logical <<
247 using G4MaterialList = std::vector<G4Mater <<
248 using G4MaterialCouplePair = std::pair<G4M <<
249 using G4MaterialCoupleMap = std::map<G4Mat <<
250 <<
251 G4String fName; 198 G4String fName;
252 199
253 G4RootLVList fRootVolumes; 200 G4RootLVList fRootVolumes;
254 G4MaterialList fMaterials; 201 G4MaterialList fMaterials;
255 G4MaterialCoupleMap fMaterialCoupleMap; 202 G4MaterialCoupleMap fMaterialCoupleMap;
256 203
257 G4bool fRegionMod = true; << 204 G4bool fRegionMod;
258 G4ProductionCuts* fCut = nullptr; << 205 G4ProductionCuts* fCut;
>> 206
>> 207 G4VUserRegionInformation* fUserInfo;
>> 208 G4UserLimits* fUserLimits;
>> 209 G4FieldManager* fFieldManager;
259 210
260 G4VUserRegionInformation* fUserInfo = null << 211 G4FastSimulationManager* fFastSimulationManager;
261 G4UserLimits* fUserLimits = nullptr; << 212
262 G4FieldManager* fFieldManager = nullptr; << 213 G4VPhysicalVolume* fWorldPhys;
263 << 214
264 G4VPhysicalVolume* fWorldPhys = nullptr; << 215 G4UserSteppingAction* fRegionalSteppingAction;
265 <<
266 G4bool fInMassGeometry = false; <<
267 G4bool fInParallelGeometry = false; <<
268 <<
269 G4int instanceID; <<
270 // This field is used as instance ID. <<
271 G4GEOM_DLL static G4RegionManager subInsta <<
272 // This field helps to use the class G4R <<
273 }; 216 };
274 217
275 #include "G4Region.icc" 218 #include "G4Region.icc"
276 219
277 #endif 220 #endif
278 221