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