Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/geometry/management/include/G4RegionStore.hh

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 ]

Diff markup

Differences between /geometry/management/include/G4RegionStore.hh (Version 11.3.0) and /geometry/management/include/G4RegionStore.hh (Version 11.2)


  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 // G4RegionStore                                   26 // G4RegionStore
 27 //                                                 27 //
 28 // Class description:                              28 // Class description:
 29 //                                                 29 //
 30 // Container for all regions, with functionali     30 // Container for all regions, with functionality derived from
 31 // std::vector<T>. The class is a 'singleton',     31 // std::vector<T>. The class is a 'singleton', in that only
 32 // one can exist, and access is provided via t     32 // one can exist, and access is provided via the static method
 33 // G4RegionStore::GetInstance().                   33 // G4RegionStore::GetInstance().
 34 //                                                 34 //
 35 // All regions should be registered with G4Reg     35 // All regions should be registered with G4RegionStore, and removed on their
 36 // destruction. The underlying container initi     36 // destruction. The underlying container initially has a capacity of 20.
 37 // A map indexed by volume names is also recor     37 // A map indexed by volume names is also recorded for fast search;
 38 // pointers to regions with same name are stor     38 // pointers to regions with same name are stored in buckets.
 39 //                                                 39 //
 40 // If much additional functionality is added,      40 // If much additional functionality is added, should consider containment
 41 // instead of inheritance for std::vector<T>.      41 // instead of inheritance for std::vector<T>.
 42                                                    42 
 43 // 18.09.02, G.Cosmo - Initial version             43 // 18.09.02, G.Cosmo - Initial version
 44 // -------------------------------------------     44 // --------------------------------------------------------------------
 45 #ifndef G4REGIONSTORE_HH                           45 #ifndef G4REGIONSTORE_HH
 46 #define G4REGIONSTORE_HH 1                         46 #define G4REGIONSTORE_HH 1
 47                                                    47 
 48 #include <vector>                                  48 #include <vector>
 49 #include <map>                                     49 #include <map>
 50                                                    50 
 51 #include "G4Types.hh"                              51 #include "G4Types.hh"
 52 #include "G4String.hh"                             52 #include "G4String.hh"
 53 #include "G4VStoreNotifier.hh"                     53 #include "G4VStoreNotifier.hh"
 54                                                    54 
 55 class G4Region;                                    55 class G4Region;
 56 class G4VPhysicalVolume;                           56 class G4VPhysicalVolume;
 57                                                    57 
 58 class G4RegionStore : public std::vector<G4Reg     58 class G4RegionStore : public std::vector<G4Region*>
 59 {                                                  59 {
 60   public:                                          60   public:
 61                                                    61 
 62     static void Register(G4Region* pRegion);       62     static void Register(G4Region* pRegion);
 63       // Add the region to the collection.         63       // Add the region to the collection.
 64     static void DeRegister(G4Region* pRegion);     64     static void DeRegister(G4Region* pRegion);
 65       // Remove the region from the collection     65       // Remove the region from the collection.
 66     static G4RegionStore* GetInstance();           66     static G4RegionStore* GetInstance();
 67       // Get a ptr to the unique G4RegionStore     67       // Get a ptr to the unique G4RegionStore, creating it if necessary.
 68     static void SetNotifier(G4VStoreNotifier*      68     static void SetNotifier(G4VStoreNotifier* pNotifier);
 69       // Assign a notifier for allocation/deal     69       // Assign a notifier for allocation/deallocation of regions.
 70     static void Clean();                           70     static void Clean();
 71       // Delete all regions from the store exc     71       // Delete all regions from the store except for the world region.
 72                                                    72 
 73     G4bool IsModified() const;                     73     G4bool IsModified() const;
 74       // Loops through all regions to verify i     74       // Loops through all regions to verify if a region has been
 75       // modified. It returns TRUE if just one     75       // modified. It returns TRUE if just one region is modified.
 76     void ResetRegionModified();                    76     void ResetRegionModified();
 77       // Loops through all regions to reset fl     77       // Loops through all regions to reset flag for modification
 78       // to FALSE. Used by the run manager to      78       // to FALSE. Used by the run manager to notify that the
 79       // physics table has been updated.           79       // physics table has been updated.
 80                                                    80 
 81     void UpdateMaterialList(G4VPhysicalVolume*     81     void UpdateMaterialList(G4VPhysicalVolume* currentWorld=nullptr);
 82       // Forces recomputation of material list     82       // Forces recomputation of material lists in all regions
 83       // in the store.                             83       // in the store.
 84                                                    84 
 85     G4Region* GetRegion(const G4String& name,      85     G4Region* GetRegion(const G4String& name, G4bool verbose = true) const;
 86       // Returns a region through its name spe     86       // Returns a region through its name specification. Uses the internal
 87       // map for fast search and warns if a re     87       // map for fast search and warns if a region in the collection is not
 88       // unique or not found.                      88       // unique or not found.
 89                                                    89 
 90     inline G4bool IsMapValid() const  { return     90     inline G4bool IsMapValid() const  { return mvalid; }
 91     inline void SetMapValid(G4bool val)  { mva     91     inline void SetMapValid(G4bool val)  { mvalid = val; }
 92       // Accessor to assess validity of the in     92       // Accessor to assess validity of the internal map.
 93     inline const std::map<G4String,                93     inline const std::map<G4String,
 94             std::vector<G4Region*> >& GetMap()     94             std::vector<G4Region*> >& GetMap() const { return bmap; }
 95       // Return the internal map.                  95       // Return the internal map.
 96     void UpdateMap();                              96     void UpdateMap();
 97       // Bring contents of internal map up to      97       // Bring contents of internal map up to date and resets validity flag.
 98                                                    98 
 99     G4Region* FindOrCreateRegion(const G4Strin     99     G4Region* FindOrCreateRegion(const G4String& name);
100       // Returns a region through its name spe    100       // Returns a region through its name specification, if it exists.
101       // If it does not exist it will allocate    101       // If it does not exist it will allocate one delegating ownership
102       // to the client.                           102       // to the client.
103                                                   103 
104     void SetWorldVolume();                        104     void SetWorldVolume();
105       // Set a world volume pointer to a regio    105       // Set a world volume pointer to a region that belongs to it.
106       // Scan over all world volumes.             106       // Scan over all world volumes.
107       // This method should be exclusively use    107       // This method should be exclusively used by G4RunManagerKernel.
108                                                   108 
109     virtual ~G4RegionStore();                     109     virtual ~G4RegionStore();
110       // Destructor: takes care to delete allo    110       // Destructor: takes care to delete allocated regions.
111                                                   111 
112     G4RegionStore(const G4RegionStore&) = dele    112     G4RegionStore(const G4RegionStore&) = delete;
113     G4RegionStore& operator=(const G4RegionSto    113     G4RegionStore& operator=(const G4RegionStore&) = delete;
114       // Forbidden copy constructor and assign    114       // Forbidden copy constructor and assignment operator
115                                                   115 
116   protected:                                      116   protected:
117                                                   117 
118     G4RegionStore();                              118     G4RegionStore();
119       // Protected singleton constructor.         119       // Protected singleton constructor.
120                                                   120 
121   private:                                        121   private:
122                                                   122 
123     static G4RegionStore* fgInstance;             123     static G4RegionStore* fgInstance;
124     static G4ThreadLocal G4VStoreNotifier* fgN    124     static G4ThreadLocal G4VStoreNotifier* fgNotifier;
125     static G4ThreadLocal G4bool locked;           125     static G4ThreadLocal G4bool locked;
126                                                   126 
127     std::map<G4String, std::vector<G4Region*>     127     std::map<G4String, std::vector<G4Region*> > bmap;
128     G4bool mvalid = false;  // Flag to indicat    128     G4bool mvalid = false;  // Flag to indicate if map is up to date or not
129 };                                                129 };
130                                                   130 
131 #endif                                            131 #endif
132                                                   132