| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer << 3 // * DISCLAIMER *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th << 5 // * The following disclaimer summarizes all the specific disclaimers *
6 // * the Geant4 Collaboration. It is provided << 6 // * of contributors to this software. The specific disclaimers,which *
7 // * conditions of the Geant4 Software License << 7 // * govern, are listed with their locations in: *
8 // * LICENSE and available at http://cern.ch/ << 8 // * http://cern.ch/geant4/license *
9 // * include a list of copyright holders. <<
10 // * 9 // * *
11 // * Neither the authors of this software syst 10 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 11 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 12 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 13 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file << 14 // * use. *
16 // * for the full disclaimer and the limitatio <<
17 // * 15 // * *
18 // * This code implementation is the result << 16 // * This code implementation is the intellectual property of the *
19 // * technical work of the GEANT4 collaboratio << 17 // * GEANT4 collaboration. *
20 // * By using, copying, modifying or distri << 18 // * By copying, distributing or modifying the Program (or any work *
21 // * any work based on the software) you ag << 19 // * based on the Program) you indicate your acceptance of this *
22 // * use in resulting scientific publicati << 20 // * statement, and all its terms. *
23 // * acceptance of all terms of the Geant4 Sof <<
24 // ******************************************* 21 // ********************************************************************
25 // 22 //
26 // 23 //
>> 24 // $Id: G4GlobalFastSimulationManager.hh,v 1.9 2002/11/02 00:10:34 mverderi Exp $
>> 25 // GEANT4 tag $Name: geant4-05-02-patch-01 $
27 // 26 //
28 // << 27 //
29 //-------------------------------------------- 28 //---------------------------------------------------------------
30 // 29 //
31 // G4GlobalFastSimulationManager.hh 30 // G4GlobalFastSimulationManager.hh
32 // 31 //
33 // Description: 32 // Description:
34 // A singleton class which manages the Fast << 33 // A singleton class which manages the Fast Simulation managers
35 // attached to envelopes. 34 // attached to envelopes.
36 // 35 //
37 // History: 36 // History:
38 // June 98: Verderi && MoraDeFreitas - "G4P 37 // June 98: Verderi && MoraDeFreitas - "G4ParallelWorld" becomes
39 // "G4FlavoredParallelWorld"; some 38 // "G4FlavoredParallelWorld"; some method name changes;
40 // GetFlavoredWorldForThis now ret << 39 // GetFlavoredWorldForThis now returns a
41 // G4FlavoredParallelWorld pointer 40 // G4FlavoredParallelWorld pointer.
42 // Feb 98: Verderi && MoraDeFreitas - First 41 // Feb 98: Verderi && MoraDeFreitas - First Implementation.
43 // 42 //
44 //-------------------------------------------- 43 //---------------------------------------------------------------
45 44
46 #ifndef G4GLOBALFASTSIMULATIONMANAGER_HH << 45 #ifndef G4GlobalFastSimulationManager_hh
47 #define G4GLOBALFASTSIMULATIONMANAGER_HH << 46 #define G4GlobalFastSimulationManager_hh
48 47
49 #include "G4FastSimulationManager.hh" <<
50 #include "G4FastSimulationManagerProcess.hh" <<
51 #include "G4FastSimulationVector.hh" <<
52 #include "G4VGlobalFastSimulationManager.hh" <<
53 #include "globals.hh" 48 #include "globals.hh"
>> 49 #include "G4FastSimulationVector.hh"
54 50
55 class G4FastSimulationMessenger; << 51 #include "G4VGlobalFastSimulationManager.hh"
56 template <class T> << 52 #include "G4FastSimulationManager.hh"
57 class G4ThreadLocalSingleton; << 53 #include "G4FastSimulationManagerProcess.hh"
>> 54 #include "G4StateManager.hh"
>> 55 #include "G4VStateDependent.hh"
>> 56 #include "G4FlavoredParallelWorld.hh"
58 57
59 enum listType << 58 enum listType {
60 { <<
61 NAMES_ONLY, 59 NAMES_ONLY,
62 MODELS, 60 MODELS,
63 ISAPPLICABLE 61 ISAPPLICABLE
64 }; 62 };
65 63
>> 64 class G4FastSimulationMessenger;
>> 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 : public G4VStateDependent,
>> 85 public G4VGlobalFastSimulationManager
85 { 86 {
86 friend class G4ThreadLocalSingleton<G4Global << 87 public: // With description
87 88
88 public: << 89 static G4GlobalFastSimulationManager* GetGlobalFastSimulationManager();
89 // Destructor << 90 // Provides a global access to the GlobalFastSimulationManager
90 ~G4GlobalFastSimulationManager(); << 91
91 << 92 G4VFastSimulationModel* GetFastSimulationModel(const G4String& modelName,
92 // Provides a global access to the GlobalF << 93 const G4VFastSimulationModel* previousFound = 0) const;
93 static G4GlobalFastSimulationManager* GetG << 94 // Fetch G4VFastSimulationModel by name:
94 << 95 //
95 // Same as GetGlobalFastSimulationManager( << 96 // o returns the G4VFastSimulationModel* of model with name modelName;
96 static G4GlobalFastSimulationManager* GetI << 97 // o returns 0 if no model found;
97 << 98 //
98 // Iterative fetch of G4VFastSimulationMod << 99 // - usage:
99 // o returns the G4VFastSimulationModel << 100 //
100 // o returns 0 if no model found; << 101 // myModel = gblManager->GetFastSimulationModel("MyModel");
101 // o usage: << 102 //
102 // myModel = gblManager->GetFastSim << 103 // o note for the case of several models having the same name:
103 // o note for the case of several model << 104 // - to get the first "MyModel" model:
104 // - to get the first "MyModel" mod << 105 //
105 // myModel1 = gblManager->GetF << 106 // myModel1 = gblManager->GetFastSimulationModel("MyModel", 0);
106 // - to get the next one: << 107 //
107 // myModel2 = gblManager->GetF << 108 // - to get the next one:
108 // - and so on. << 109 //
109 // - When gblManager->GetFastSimula << 110 // myModel2 = gblManager->GetFastSimulationModel("MyModel", myModel1);
110 // returns a null pointer, no ext << 111 //
111 G4VFastSimulationModel* << 112 // - and so on.
112 GetFastSimulationModel(const G4String& mod << 113 //
113 const G4VFastSimula << 114 // - When gblManager->GetFastSimulationModel("MyModel", myModel_n)
114 << 115 // returns a null pointer, no extra model with name "MyModel" exist.
115 // << 116
116 // G4FastSimulationManager(Process)'s mana << 117
117 // << 118 public: // Without description
118 // Methods for a G4FastSimulationManager t << 119
119 // << 120 // Destructor
120 void AddFastSimulationManager(G4FastSimula << 121 ~G4GlobalFastSimulationManager();
121 void RemoveFastSimulationManager(G4FastSim << 122
122 // << 123 // G4FastSimulationManager's management :
123 // G4FastSimulationManagerProcess bookeepi << 124 //
124 // << 125 // Methods for a G4FastSimulationManager to register itself
125 void AddFSMP(G4FastSimulationManagerProces << 126 //
126 void RemoveFSMP(G4FastSimulationManagerPro << 127 void AddFastSimulationManager(G4FastSimulationManager*);
127 << 128 void RemoveFastSimulationManager(G4FastSimulationManager*);
128 // Flag that the Parameterisation must be << 129
129 void FastSimulationNeedsToBeClosed(); << 130
130 << 131 // Flag that the Parameterisation must be closed.
131 // Show the fast simulation setup : world( << 132 void FastSimulationNeedsToBeClosed();
132 // Requires the geometry to be closed. << 133
133 void ShowSetup(); << 134
134 << 135 public: // With description
135 void ListEnvelopes(const G4String& aName = << 136 void CloseFastSimulation();
136 void ListEnvelopes(const G4ParticleDefinit << 137 // Build the parallel worlds when you are using ghost volumes. In this case the Parameterisation
137 << 138 // MUST be closed BEFORE closing the geometry. It's enough to call this method just before
138 void ActivateFastSimulationModel(const G4S << 139 // closing the geometry.
139 void InActivateFastSimulationModel(const G << 140 //
140 << 141
141 void Flush(); << 142 public: // Without description
142 << 143 // print/control commands
143 private: << 144 void ListEnvelopes(const G4String& aName = "all",
144 // Private construtor insures singleton cl << 145 listType aListType = NAMES_ONLY);
145 G4GlobalFastSimulationManager(); << 146 void ListEnvelopes(const G4ParticleDefinition*);
146 << 147
147 // recursive display of regions, models, e << 148 void ActivateFastSimulationModel(const G4String&);
148 void DisplayRegion(G4Region* motherRegion, << 149 void InActivateFastSimulationModel(const G4String&);
149 std::vector<G4ParticleD << 150
150 << 151 // G4FastSimulationProcess interface
151 G4FastSimulationMessenger* fTheFastSimulat << 152 G4VFlavoredParallelWorld* GetFlavoredWorldForThis(G4ParticleDefinition *);
152 G4FastSimulationVector<G4FastSimulationMan << 153
153 G4FastSimulationVector<G4FastSimulationMan << 154 // G4StateManager interface
>> 155 G4bool Notify(G4ApplicationState requestedState);
>> 156
>> 157 private:
>> 158 // Private construtor insures singleton class
>> 159 G4GlobalFastSimulationManager();
>> 160
>> 161 // The single instance.
>> 162 static G4GlobalFastSimulationManager* fGlobalFastSimulationManager;
>> 163
>> 164 // The G4FastSimulationMessenger
>> 165 G4FastSimulationMessenger* fTheFastSimulationMessenger;
>> 166
>> 167 // List of G4FastSimulationManagers
>> 168 G4FastSimulationVector <G4FastSimulationManager> ManagedManagers;
>> 169
>> 170 // fClosed flags if the NeededFlavoredWorlds List was Build.
>> 171 G4bool fClosed;
>> 172
>> 173 // List of needed ParallelWorlds after close
>> 174 G4FastSimulationVector <G4FlavoredParallelWorld> NeededFlavoredWorlds;
>> 175
>> 176 // Internal fonction to Build world volume clones.
>> 177 G4VPhysicalVolume* GiveMeAWorldVolumeClone();
154 }; 178 };
155 179
156 #endif << 180 #endif
>> 181 // end of #ifndef G4GlobalFastSimulationManager_hh
157 182