Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/geometry/navigation/include/G4TransportationManager.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/navigation/include/G4TransportationManager.hh (Version 11.3.0) and /geometry/navigation/include/G4TransportationManager.hh (Version 8.1)


  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 //
                                                   >>  27 // $Id: G4TransportationManager.hh,v 1.8 2006/06/29 18:36:24 gunter Exp $
                                                   >>  28 // GEANT4 tag $Name: geant4-08-01 $
                                                   >>  29 //
 26 // class G4TransportationManager                   30 // class G4TransportationManager
 27 //                                                 31 //
 28 // Class description:                              32 // Class description:
 29 //                                                 33 //
 30 // A singleton class which stores the (volume)     34 // A singleton class which stores the (volume) navigator used by 
 31 // the transportation process to do the geomet     35 // the transportation process to do the geometrical tracking.
 32 // It also stores a pointer to the propagator      36 // It also stores a pointer to the propagator used in a (magnetic) 
 33 // field and to the field manager.                 37 // field and to the field manager.
 34 // The class instance is created before main()     38 // The class instance is created before main() is called, and
 35 // in turn creates the navigator and the rest.     39 // in turn creates the navigator and the rest.
 36                                                    40 
 37 // Created:  10 March 1997, J. Apostolakis         41 // Created:  10 March 1997, J. Apostolakis
 38 // Reviewed: 26 April 2006, G. Cosmo               42 // Reviewed: 26 April 2006, G. Cosmo
 39 // -------------------------------------------     43 // --------------------------------------------------------------------
                                                   >>  44 
 40 #ifndef  G4TransportationManager_hh                45 #ifndef  G4TransportationManager_hh
 41 #define  G4TransportationManager_hh                46 #define  G4TransportationManager_hh
 42                                                    47 
 43 #include "G4Navigator.hh"                          48 #include "G4Navigator.hh"
 44 #include "G4SafetyHelper.hh"                   << 
 45                                                    49 
 46 #include <vector>                                  50 #include <vector>
 47                                                    51 
 48 class G4PropagatorInField;                         52 class G4PropagatorInField;
 49 class G4GeometryMessenger;                         53 class G4GeometryMessenger;
 50 class G4FieldManager;                              54 class G4FieldManager;
 51 class G4VPhysicalVolume;                           55 class G4VPhysicalVolume;
 52                                                    56 
 53 class G4TransportationManager                      57 class G4TransportationManager 
 54 {                                                  58 {
 55   public:  // with description                     59   public:  // with description
 56                                                    60 
 57      static G4TransportationManager* GetTransp     61      static G4TransportationManager* GetTransportationManager();
 58        // Retrieve the static instance             62        // Retrieve the static instance
 59      static G4TransportationManager* GetInstan << 
 60        // Retrieve singleton instance pointer. << 
 61                                                    63 
 62      inline G4PropagatorInField* GetPropagator     64      inline G4PropagatorInField* GetPropagatorInField() const;
 63      inline void SetPropagatorInField(G4Propag <<  65      inline void SetPropagatorInField( G4PropagatorInField* newFieldPropagator );
 64      inline G4FieldManager* GetFieldManager()      66      inline G4FieldManager* GetFieldManager() const;
 65      void SetFieldManager( G4FieldManager* new     67      void SetFieldManager( G4FieldManager* newFieldManager );
 66        // Accessors for field handling             68        // Accessors for field handling
 67                                                    69 
 68      inline G4Navigator* GetNavigatorForTracki     70      inline G4Navigator* GetNavigatorForTracking() const;
 69      void SetNavigatorForTracking( G4Navigator <<  71      inline void SetNavigatorForTracking( G4Navigator* newNavigator );
 70        // Accessors for the navigator for trac     72        // Accessors for the navigator for tracking
 71                                                    73 
 72      inline void SetWorldForTracking(G4VPhysic <<  74      inline size_t GetNoActiveNavigators() const;
 73        // Set the world volume for tracking    << 
 74        // This method is to be invoked by G4Ru << 
 75                                                << 
 76      inline std::size_t GetNoActiveNavigators( << 
 77      inline std::vector<G4Navigator*>::iterato     75      inline std::vector<G4Navigator*>::iterator GetActiveNavigatorsIterator();
 78        // Return an iterator to the list of ac     76        // Return an iterator to the list of active navigators
 79                                                    77 
 80      inline std::size_t GetNoWorlds() const;   << 
 81      inline std::vector<G4VPhysicalVolume*>::i << 
 82        // Return an iterator to the list of re << 
 83                                                << 
 84      inline G4SafetyHelper* GetSafetyHelper()  << 
 85        // Return the pointer to the navigation << 
 86                                                << 
 87      G4VPhysicalVolume* GetParallelWorld ( con     78      G4VPhysicalVolume* GetParallelWorld ( const G4String& worldName );
 88        // Return an exact copy of the tracking     79        // Return an exact copy of the tracking world volume. If already
 89        // existing just return the pointer         80        // existing just return the pointer
 90                                                    81 
 91      G4VPhysicalVolume* IsWorldExisting ( cons     82      G4VPhysicalVolume* IsWorldExisting ( const G4String& worldName );
 92        // Verify existance or not of an istanc     83        // Verify existance or not of an istance of the world volume with
 93        // same name in the collection              84        // same name in the collection
 94                                                    85 
 95      G4Navigator* GetNavigator ( const G4Strin     86      G4Navigator* GetNavigator ( const G4String& worldName );
 96      G4Navigator* GetNavigator ( G4VPhysicalVo     87      G4Navigator* GetNavigator ( G4VPhysicalVolume* aWorld );
 97        // Return a navigator associated to eit     88        // Return a navigator associated to either the world volume name
 98        // or the pointer to world physical vol     89        // or the pointer to world physical volume. If not existing already
 99        // create it and register it in the col     90        // create it and register it in the collection
100                                                    91 
101      G4bool RegisterWorld( G4VPhysicalVolume*  << 
102      void DeRegisterNavigator( G4Navigator* aN     92      void DeRegisterNavigator( G4Navigator* aNavigator );
103      G4int  ActivateNavigator( G4Navigator* aN     93      G4int  ActivateNavigator( G4Navigator* aNavigator );
104      void DeActivateNavigator( G4Navigator* aN     94      void DeActivateNavigator( G4Navigator* aNavigator );
105      void InactivateAll();                         95      void InactivateAll();
106        // Methods for handling navigators. Nav     96        // Methods for handling navigators. Navigator for tracking is always the
107        // first, i.e. position 0 in the collec     97        // first, i.e. position 0 in the collection and cannot be de-registered
108                                                    98 
109      static G4Navigator* GetFirstTrackingNavig << 
110      static void SetFirstTrackingNavigator(G4N << 
111        // Retrieve/set first navigator pointer << 
112        //                                      << 
113        // It will be used as a template for cl << 
114        //     navigator of additional threads. << 
115                                                << 
116   public:  // without description              << 
117                                                << 
118      void ClearParallelWorlds();               << 
119        // Clear collection of navigators and d << 
120        // associated with parallel worlds. Int << 
121        // by the RunManager when the entire ge << 
122                                                << 
123      ~G4TransportationManager();               << 
124        // Destructor                           << 
125                                                << 
126   protected:                                       99   protected:
127                                                   100 
128      G4TransportationManager();                   101      G4TransportationManager();
129        // Singleton. Protected constructor     << 102      ~G4TransportationManager(); 
                                                   >> 103        // Singleton. Protected constructor and destructor
130                                                   104 
131   private:                                        105   private:
132                                                   106 
133      void ClearNavigators();                      107      void ClearNavigators();
134        // Clear collection of navigators and d    108        // Clear collection of navigators and delete allocated objects
                                                   >> 109      G4bool RegisterWorld( G4VPhysicalVolume* aWorld );
135      void DeRegisterWorld( G4VPhysicalVolume*     110      void DeRegisterWorld( G4VPhysicalVolume* aWorld );
136        // Register/de-register an already allo    111        // Register/de-register an already allocated world volume.
137        // The pointed object is not deleted.      112        // The pointed object is not deleted.
138                                                   113  
139   private:                                        114   private:
140                                                   115 
141      std::vector<G4Navigator*> fNavigators;       116      std::vector<G4Navigator*> fNavigators;
142        // The collection of all navigators reg    117        // The collection of all navigators registered
143      std::vector<G4Navigator*> fActiveNavigato    118      std::vector<G4Navigator*> fActiveNavigators;
144        // The collection of only active naviga    119        // The collection of only active navigators
145      std::vector<G4VPhysicalVolume*> fWorlds;     120      std::vector<G4VPhysicalVolume*> fWorlds;
146        // The collection of worlds associated     121        // The collection of worlds associated to the registered navigators
147                                                   122 
148      G4PropagatorInField* fPropagatorInField;  << 123      G4PropagatorInField*    fPropagatorInField;
149      G4FieldManager*      fFieldManager;       << 124      G4FieldManager*         fFieldManager;
150      G4GeometryMessenger* fGeomMessenger;      << 125      G4GeometryMessenger*    fGeomMessenger;
151      G4SafetyHelper*      fSafetyHelper;       << 
152                                                << 
153      static G4ThreadLocal G4TransportationMana << 
154                                                << 
155      static G4Navigator* fFirstTrackingNavigat << 
156                                                << 
157   public:                                      << 
158                                                   126 
159     static constexpr G4int kMassNavigatorId =  << 127      static G4TransportationManager*  fTransportationManager;
160 };                                                128 };
161                                                   129 
162 #include "G4TransportationManager.icc"            130 #include "G4TransportationManager.icc"
163                                                   131 
164 #endif                                            132 #endif 
165                                                   133