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