Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/geometry/biasing/src/G4IStore.cc

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

  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 // G4IStore implementation
 27 //
 28 // Author: Michael Dressel (CERN), 2002
 29 // Modified: Alex Howard (CERN), 2013 - Changed class to a 'singleton'
 30 // ----------------------------------------------------------------------
 31 
 32 #include "G4IStore.hh"
 33 #include "G4VPhysicalVolume.hh"
 34 #include "G4GeometryCell.hh"
 35 #include "G4GeometryCellStepStream.hh"
 36 #include "G4LogicalVolume.hh"
 37 #include "G4TransportationManager.hh"
 38 
 39 #include "G4AutoLock.hh"
 40 
 41 namespace
 42 {
 43   G4Mutex IStoreMutex = G4MUTEX_INITIALIZER;
 44 }
 45 
 46 // ***************************************************************************
 47 // Static class variable: ptr to single instance of class
 48 // ***************************************************************************
 49 G4ThreadLocal G4IStore* G4IStore::fInstance = nullptr;
 50 
 51 G4IStore::G4IStore()
 52   : fWorldVolume(G4TransportationManager::GetTransportationManager()
 53                  ->GetNavigatorForTracking()->GetWorldVolume())
 54 {
 55 }
 56 
 57 G4IStore::G4IStore(const G4String& ParallelWorldName)
 58   : fWorldVolume(G4TransportationManager::GetTransportationManager()
 59                  ->GetParallelWorld(ParallelWorldName))
 60 {
 61 #ifdef G4VERBOSE
 62   G4cout << " G4IStore:: ParallelWorldName = "
 63          << ParallelWorldName << G4endl;
 64   G4cout << " G4IStore:: fParallelWorldVolume = "
 65          << fWorldVolume->GetName() << G4endl;
 66 #endif
 67 }
 68 
 69 G4IStore::~G4IStore() = default;
 70 
 71 void G4IStore::Clear()
 72 {
 73   fGeometryCelli.clear();
 74 }
 75 
 76 void G4IStore::SetWorldVolume()
 77 {
 78   G4cout << " G4IStore:: SetWorldVolume " << G4endl;
 79   fWorldVolume = G4TransportationManager::GetTransportationManager()
 80                  ->GetNavigatorForTracking()->GetWorldVolume();
 81   G4cout << " World volume is: " << fWorldVolume->GetName() << G4endl;
 82   // fGeometryCelli = new G4GeometryCellImportance;
 83 }
 84 
 85 void G4IStore::SetParallelWorldVolume(const G4String& paraName)
 86 {
 87   G4cout << " G4IStore:: SetParallelWorldVolume " << G4endl;
 88   fWorldVolume = G4TransportationManager::GetTransportationManager()
 89                  ->GetParallelWorld(paraName);
 90   G4cout << " ParallelWorld volume is: " << fWorldVolume->GetName() << G4endl;
 91   // fGeometryCelli = new G4GeometryCellImportance;
 92 }
 93 
 94 const G4VPhysicalVolume& G4IStore::GetWorldVolume() const
 95 {
 96   return *fWorldVolume;
 97 }
 98 
 99 const G4VPhysicalVolume* G4IStore::GetParallelWorldVolumePointer() const
100 {
101   return fWorldVolume;
102 }
103 
104 void G4IStore::SetInternalIterator(const G4GeometryCell& gCell) const
105 {
106   fCurrentIterator = fGeometryCelli.find(gCell);
107 }
108 
109 void G4IStore::AddImportanceGeometryCell(G4double importance,
110                                          const G4GeometryCell& gCell)
111 {
112   if (importance < 0 )
113   {
114     Error("AddImportanceGeometryCell() - Invalid importance value given.");
115   }  
116   if (!IsInWorld(gCell.GetPhysicalVolume()) )
117   {
118     Error("AddImportanceGeometryCell() - Physical volume not found!");
119   }
120   SetInternalIterator(gCell);
121   if (fCurrentIterator != fGeometryCelli.cend())
122   {
123     Error("AddImportanceGeometryCell() - Region already existing!");
124   }
125   fGeometryCelli[gCell] = importance;
126 }
127 
128 void G4IStore::AddImportanceGeometryCell(G4double importance,
129                                          const G4VPhysicalVolume& aVolume,
130                                          G4int aRepNum)
131 {
132   AddImportanceGeometryCell(importance, G4GeometryCell(aVolume, aRepNum));
133 }
134 
135 void G4IStore::ChangeImportance(G4double importance,
136                                 const G4GeometryCell& gCell)
137 {
138   if (importance < 0 )
139   {
140     Error("ChangeImportance() - Invalid importance value given.");
141   }
142   if (!IsInWorld(gCell.GetPhysicalVolume()))
143   {
144     Error("ChangeImportance() - Physical volume not found!");
145   }
146   SetInternalIterator(gCell);
147   if (fCurrentIterator == fGeometryCelli.cend())
148   {
149     Error("ChangeImportance() - Region does not exist!");
150   }
151   fGeometryCelli[gCell] = importance;
152 
153 }
154 
155 void G4IStore::ChangeImportance(G4double importance,
156                                 const G4VPhysicalVolume& aVolume,
157                                 G4int aRepNum)
158 {
159   ChangeImportance(importance, G4GeometryCell(aVolume, aRepNum));
160 }
161 
162 G4double G4IStore::GetImportance(const G4VPhysicalVolume& aVolume,
163                                  G4int aRepNum) const
164 {  
165   G4AutoLock l(&IStoreMutex);
166   SetInternalIterator(G4GeometryCell(aVolume, aRepNum));
167   auto gCellIterator = fCurrentIterator;
168   if (gCellIterator == fGeometryCelli.cend())
169   {
170     Error("GetImportance() - Region does not exist!");
171     return 0.;
172   }
173   G4double importance_value = (*fCurrentIterator).second;
174   l.unlock();
175 
176   return importance_value;
177 }
178 
179 G4double G4IStore::GetImportance(const G4GeometryCell& gCell) const
180 {
181   G4AutoLock l(&IStoreMutex);
182   SetInternalIterator(gCell);
183   auto gCellIterator = fCurrentIterator;
184   if (gCellIterator == fGeometryCelli.cend())
185   {
186     std::ostringstream err_mess;
187     err_mess << "GetImportance() - Region does not exist!" << G4endl
188              << "Geometry cell, " << gCell
189              << ", not found in: " << fGeometryCelli << ".";
190     Error(err_mess.str());
191     return 0.;
192   }
193   G4double importance_value = (*fCurrentIterator).second;
194   l.unlock();
195 
196   return importance_value;
197 }
198 
199 G4bool G4IStore::IsKnown(const G4GeometryCell& gCell) const
200 {
201   G4AutoLock l(&IStoreMutex);
202   G4bool inWorldKnown(IsInWorld(gCell.GetPhysicalVolume()));
203                       
204   if ( inWorldKnown )
205   {
206     SetInternalIterator(gCell);
207     inWorldKnown = (fCurrentIterator != fGeometryCelli.cend());
208   }
209   l.unlock();
210 
211   return inWorldKnown;
212 }
213 
214 G4bool G4IStore::IsInWorld(const G4VPhysicalVolume& aVolume) const
215 {
216   G4bool isIn(true);
217   if (!(aVolume == *fWorldVolume))
218   {
219     isIn = fWorldVolume->GetLogicalVolume()->IsAncestor(&aVolume);
220   }
221   return isIn;
222 }
223 
224 void G4IStore::Error(const G4String& msg) const
225 {
226   G4Exception("G4IStore::Error()", "GeomBias0002", FatalException, msg);
227 }
228 
229 // ***************************************************************************
230 // Returns the instance of the singleton.
231 // Creates it in case it's called for the first time.
232 // ***************************************************************************
233 //
234 G4IStore* G4IStore::GetInstance()
235 {
236   if (fInstance == nullptr)
237   {
238 #ifdef G4VERBOSE
239     G4cout << "G4IStore:: Creating new MASS IStore " << G4endl;
240 #endif
241     fInstance = new G4IStore();
242   }
243   return fInstance;    
244 }
245 
246 // ***************************************************************************
247 // Returns the instance of the singleton.
248 // Creates it in case it's called for the first time.
249 // ***************************************************************************
250 //
251 G4IStore* G4IStore::GetInstance(const G4String& ParallelWorldName)
252 {
253   if (fInstance == nullptr)
254   {
255 #ifdef G4VERBOSE
256     G4cout << "G4IStore:: Creating new Parallel IStore "
257            << ParallelWorldName << G4endl;
258 #endif
259     fInstance = new G4IStore(ParallelWorldName);
260   }
261   return fInstance;    
262 }
263