Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/processes/parameterisation/include/G4GlobalFastSimulationManager.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 /processes/parameterisation/include/G4GlobalFastSimulationManager.hh (Version 11.3.0) and /processes/parameterisation/include/G4GlobalFastSimulationManager.hh (Version 11.1.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 //                                                 26 //
 27 //                                                 27 //
 28 //                                             <<  28 //  
 29 //--------------------------------------------     29 //---------------------------------------------------------------
 30 //                                                 30 //
 31 //  G4GlobalFastSimulationManager.hh               31 //  G4GlobalFastSimulationManager.hh
 32 //                                                 32 //
 33 //  Description:                                   33 //  Description:
 34 //    A singleton class which manages the Fast <<  34 //    A singleton class which manages the Fast Simulation managers 
 35 //    attached to envelopes.                       35 //    attached to envelopes.
 36 //                                                 36 //
 37 //  History:                                       37 //  History:
 38 //    June 98: Verderi && MoraDeFreitas - "G4P     38 //    June 98: Verderi && MoraDeFreitas - "G4ParallelWorld" becomes
 39 //             "G4FlavoredParallelWorld"; some     39 //             "G4FlavoredParallelWorld"; some method name changes;
 40 //             GetFlavoredWorldForThis now ret <<  40 //             GetFlavoredWorldForThis now returns a 
 41 //             G4FlavoredParallelWorld pointer     41 //             G4FlavoredParallelWorld pointer.
 42 //    Feb 98: Verderi && MoraDeFreitas - First     42 //    Feb 98: Verderi && MoraDeFreitas - First Implementation.
 43 //                                                 43 //
 44 //--------------------------------------------     44 //---------------------------------------------------------------
 45                                                    45 
 46 #ifndef G4GLOBALFASTSIMULATIONMANAGER_HH       <<  46 #ifndef  G4GlobalFastSimulationManager_hh
 47 #define G4GLOBALFASTSIMULATIONMANAGER_HH       <<  47 #define  G4GlobalFastSimulationManager_hh
 48                                                    48 
 49 #include "G4FastSimulationManager.hh"          <<  49 #include "globals.hh"
 50 #include "G4FastSimulationManagerProcess.hh"   << 
 51 #include "G4FastSimulationVector.hh"               50 #include "G4FastSimulationVector.hh"
                                                   >>  51 
 52 #include "G4VGlobalFastSimulationManager.hh"       52 #include "G4VGlobalFastSimulationManager.hh"
 53 #include "globals.hh"                          <<  53 #include "G4FastSimulationManager.hh"
                                                   >>  54 #include "G4FastSimulationManagerProcess.hh"
                                                   >>  55 
 54                                                    56 
 55 class G4FastSimulationMessenger;                   57 class G4FastSimulationMessenger;
 56 template <class T>                             << 
 57 class G4ThreadLocalSingleton;                  << 
 58                                                    58 
 59 enum listType                                  <<  59 enum  listType {
 60 {                                              << 
 61   NAMES_ONLY,                                      60   NAMES_ONLY,
 62   MODELS,                                          61   MODELS,
 63   ISAPPLICABLE                                     62   ISAPPLICABLE
 64 };                                                 63 };
 65                                                    64 
                                                   >>  65 
 66 // Class Description:                              66 // Class Description:
 67 // This a singleton class which provides the m     67 // This a singleton class which provides the management of the G4FastSimulationManager
 68 // objects and some ghost facilities.          <<  68 // objects and some ghost facilities. 
 69 //                                                 69 //
 70 // You can get access to it by:                    70 // You can get access to it by:
 71 //                                                 71 //
 72 // #include "G4GlobalFastSimulationManager.hh"     72 // #include "G4GlobalFastSimulationManager.hh"
 73 // ...                                             73 // ...
 74 // ...                                             74 // ...
 75 // G4GlobalFastSimulationManager* globalFSM;       75 // G4GlobalFastSimulationManager* globalFSM;
 76 // globalFSM = G4GlobalFastSimulationManager::     76 // globalFSM = G4GlobalFastSimulationManager::getGlobalFastSimulationManager();
 77 // ...                                             77 // ...
 78 // ...                                             78 // ...
 79 //                                             <<  79 //    
 80 // Presently, you will mainly need to use the  <<  80 // Presently, you will mainly need to use the GlobalFastSimulationManager if you use ghost 
 81 // geometries.                                     81 // geometries.
 82 //                                                 82 //
 83                                                    83 
 84 class G4GlobalFastSimulationManager                84 class G4GlobalFastSimulationManager
 85 {                                                  85 {
 86   friend class G4ThreadLocalSingleton<G4Global << 
 87                                                    86 
 88   public:                                      <<  87 public: // With  description 
 89     // Destructor                              <<  88 
 90     ~G4GlobalFastSimulationManager();          <<  89   static G4GlobalFastSimulationManager* GetGlobalFastSimulationManager();
 91                                                <<  90   // Provides a global access to the GlobalFastSimulationManager
 92     // Provides a global access to the GlobalF <<  91   static G4GlobalFastSimulationManager* GetInstance();
 93     static G4GlobalFastSimulationManager* GetG <<  92   // Same as GetGlobalFastSimulationManager()
 94                                                <<  93   
 95     // Same as GetGlobalFastSimulationManager( <<  94   G4VFastSimulationModel* GetFastSimulationModel(const G4String& modelName,
 96     static G4GlobalFastSimulationManager* GetI <<  95              const G4VFastSimulationModel* previousFound = 0) const;
 97                                                <<  96   // Iterative fetch of G4VFastSimulationModel objects by name:
 98     // Iterative fetch of G4VFastSimulationMod <<  97   //    o returns the G4VFastSimulationModel* of model with name modelName;
 99     //    o returns the G4VFastSimulationModel <<  98   //    o returns 0 if no model found;
100     //    o returns 0 if no model found;       <<  99   //    o usage:
101     //    o usage:                             << 100   //        myModel = gblManager->GetFastSimulationModel("MyModel");
102     //        myModel = gblManager->GetFastSim << 101   //    o note for the case of several models having the same name:
103     //    o note for the case of several model << 102   //        - to get the first "MyModel" model:
104     //        - to get the first "MyModel" mod << 103   //             myModel1 = gblManager->GetFastSimulationModel("MyModel", 0);
105     //             myModel1 = gblManager->GetF << 104   //        - to get the next one:
106     //        - to get the next one:           << 105   //             myModel2 = gblManager->GetFastSimulationModel("MyModel", myModel1);
107     //             myModel2 = gblManager->GetF << 106   //        - and so on.
108     //        - and so on.                     << 107   //        - When gblManager->GetFastSimulationModel("MyModel", myModel_n)
109     //        - When gblManager->GetFastSimula << 108   //          returns a null pointer, no extra model with name "MyModel" exist.
110     //          returns a null pointer, no ext << 109 
111     G4VFastSimulationModel*                    << 110    
112     GetFastSimulationModel(const G4String& mod << 111 public: // Without description
113                            const G4VFastSimula << 112 
114                                                << 113   // Destructor
115     //                                         << 114   ~G4GlobalFastSimulationManager(); 
116     // G4FastSimulationManager(Process)'s mana << 115 
117     //                                         << 116   //
118     // Methods for a G4FastSimulationManager t << 117   // G4FastSimulationManager(Process)'s management, no intended for general use.
119     //                                         << 118   //
120     void AddFastSimulationManager(G4FastSimula << 119   // Methods for a G4FastSimulationManager to register itself
121     void RemoveFastSimulationManager(G4FastSim << 120   //
122     //                                         << 121   void    AddFastSimulationManager(G4FastSimulationManager*);
123     // G4FastSimulationManagerProcess bookeepi << 122   void RemoveFastSimulationManager(G4FastSimulationManager*);
124     //                                         << 123   //
125     void AddFSMP(G4FastSimulationManagerProces << 124   // G4FastSimulationManagerProcess bookeeping:
126     void RemoveFSMP(G4FastSimulationManagerPro << 125   //
127                                                << 126   void    AddFSMP(G4FastSimulationManagerProcess*);
128     // Flag that the Parameterisation must be  << 127   void RemoveFSMP(G4FastSimulationManagerProcess*);
129     void FastSimulationNeedsToBeClosed();      << 128 
130                                                << 129 
131     // Show the fast simulation setup : world( << 130   // Flag that the Parameterisation must be closed.
132     // Requires the geometry to be closed.     << 131   void FastSimulationNeedsToBeClosed();
133     void ShowSetup();                          << 132 
134                                                << 133 
135     void ListEnvelopes(const G4String& aName = << 134 public: // With  description 
136     void ListEnvelopes(const G4ParticleDefinit << 135   void ShowSetup();
137                                                << 136   // Show the fast simulation setup : world(s), region(s), model(s) and links between them.
138     void ActivateFastSimulationModel(const G4S << 137   // Requires the geometry to be closed.
139     void InActivateFastSimulationModel(const G << 138 
140                                                << 139 
141     void Flush();                              << 140 public: // Without description
142                                                << 141 
143   private:                                     << 142   void ListEnvelopes(const G4String&                 aName = "all",
144     // Private construtor insures singleton cl << 143          listType                    aListType = NAMES_ONLY);
145     G4GlobalFastSimulationManager();           << 144   void ListEnvelopes(const G4ParticleDefinition*                       );  
146                                                << 145   
147     // recursive display of regions, models, e << 146   void   ActivateFastSimulationModel(const G4String&);
148     void DisplayRegion(G4Region* motherRegion, << 147   void InActivateFastSimulationModel(const G4String&);
149                        std::vector<G4ParticleD << 148 
150                                                << 149   void Flush();
151     G4FastSimulationMessenger* fTheFastSimulat << 150 
152     G4FastSimulationVector<G4FastSimulationMan << 151 private:
153     G4FastSimulationVector<G4FastSimulationMan << 152   // Private construtor insures singleton class
                                                   >> 153   G4GlobalFastSimulationManager();
                                                   >> 154 
                                                   >> 155   // recursive display of regions, models, etc...
                                                   >> 156   void DisplayRegion(G4Region* motherRegion, G4int depth, std::vector<G4ParticleDefinition*>& particles) const;
                                                   >> 157 
                                                   >> 158   // The single instance.
                                                   >> 159   static G4ThreadLocal G4GlobalFastSimulationManager*           fGlobalFastSimulationManager;
                                                   >> 160   G4FastSimulationMessenger*                       fTheFastSimulationMessenger;
                                                   >> 161   G4FastSimulationVector <G4FastSimulationManager>             ManagedManagers;
                                                   >> 162   G4FastSimulationVector <G4FastSimulationManagerProcess>          fFSMPVector;
154 };                                                163 };
155                                                   164 
156 #endif                                         << 165 #endif 
                                                   >> 166 // end of #ifndef G4GlobalFastSimulationManager_hh
157                                                   167