| 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.13 2007/05/11 13:50:20 mverderi Exp $
>> 28 // GEANT4 tag $Name: geant4-09-01-patch-02 $
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 "G4FastSimulationManagerProcess.hh"
>> 57
54 58
55 class G4FastSimulationMessenger; 59 class G4FastSimulationMessenger;
56 template <class T> <<
57 class G4ThreadLocalSingleton; <<
58 60
59 enum listType << 61 enum listType {
60 { <<
61 NAMES_ONLY, 62 NAMES_ONLY,
62 MODELS, 63 MODELS,
63 ISAPPLICABLE 64 ISAPPLICABLE
64 }; 65 };
65 66
>> 67
66 // Class Description: 68 // Class Description:
67 // This a singleton class which provides the m 69 // This a singleton class which provides the management of the G4FastSimulationManager
68 // objects and some ghost facilities. << 70 // objects and some ghost facilities.
69 // 71 //
70 // You can get access to it by: 72 // You can get access to it by:
71 // 73 //
72 // #include "G4GlobalFastSimulationManager.hh" 74 // #include "G4GlobalFastSimulationManager.hh"
73 // ... 75 // ...
74 // ... 76 // ...
75 // G4GlobalFastSimulationManager* globalFSM; 77 // G4GlobalFastSimulationManager* globalFSM;
76 // globalFSM = G4GlobalFastSimulationManager:: 78 // globalFSM = G4GlobalFastSimulationManager::getGlobalFastSimulationManager();
77 // ... 79 // ...
78 // ... 80 // ...
79 // << 81 //
80 // Presently, you will mainly need to use the << 82 // Presently, you will mainly need to use the GlobalFastSimulationManager if you use ghost
81 // geometries. 83 // geometries.
82 // 84 //
83 85
84 class G4GlobalFastSimulationManager 86 class G4GlobalFastSimulationManager
85 { 87 {
86 friend class G4ThreadLocalSingleton<G4Global <<
87 88
88 public: << 89 public: // With description
89 // Destructor << 90
90 ~G4GlobalFastSimulationManager(); << 91 static G4GlobalFastSimulationManager* GetGlobalFastSimulationManager();
91 << 92 // Provides a global access to the GlobalFastSimulationManager
92 // Provides a global access to the GlobalF << 93 static G4GlobalFastSimulationManager* GetInstance();
93 static G4GlobalFastSimulationManager* GetG << 94 // Same as GetGlobalFastSimulationManager()
94 << 95
95 // Same as GetGlobalFastSimulationManager( << 96 G4VFastSimulationModel* GetFastSimulationModel(const G4String& modelName,
96 static G4GlobalFastSimulationManager* GetI << 97 const G4VFastSimulationModel* previousFound = 0) const;
97 << 98 // Iterative fetch of G4VFastSimulationModel objects by name:
98 // Iterative fetch of G4VFastSimulationMod << 99 // o returns the G4VFastSimulationModel* of model with name modelName;
99 // o returns the G4VFastSimulationModel << 100 // o returns 0 if no model found;
100 // o returns 0 if no model found; << 101 // o usage:
101 // o usage: << 102 // myModel = gblManager->GetFastSimulationModel("MyModel");
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 // myModel1 = gblManager->GetFastSimulationModel("MyModel", 0);
105 // myModel1 = gblManager->GetF << 106 // - to get the next one:
106 // - to get the next one: << 107 // myModel2 = gblManager->GetFastSimulationModel("MyModel", myModel1);
107 // myModel2 = gblManager->GetF << 108 // - and so on.
108 // - and so on. << 109 // - When gblManager->GetFastSimulationModel("MyModel", myModel_n)
109 // - When gblManager->GetFastSimula << 110 // returns a null pointer, no extra model with name "MyModel" exist.
110 // returns a null pointer, no ext << 111
111 G4VFastSimulationModel* << 112
112 GetFastSimulationModel(const G4String& mod << 113 public: // Without description
113 const G4VFastSimula << 114
114 << 115 // Destructor
115 // << 116 ~G4GlobalFastSimulationManager();
116 // G4FastSimulationManager(Process)'s mana << 117
117 // << 118 //
118 // Methods for a G4FastSimulationManager t << 119 // G4FastSimulationManager(Process)'s management, no intended for general use.
119 // << 120 //
120 void AddFastSimulationManager(G4FastSimula << 121 // Methods for a G4FastSimulationManager to register itself
121 void RemoveFastSimulationManager(G4FastSim << 122 //
122 // << 123 void AddFastSimulationManager(G4FastSimulationManager*);
123 // G4FastSimulationManagerProcess bookeepi << 124 void RemoveFastSimulationManager(G4FastSimulationManager*);
124 // << 125 //
125 void AddFSMP(G4FastSimulationManagerProces << 126 // G4FastSimulationManagerProcess bookeeping:
126 void RemoveFSMP(G4FastSimulationManagerPro << 127 //
127 << 128 void AddFSMP(G4FastSimulationManagerProcess*);
128 // Flag that the Parameterisation must be << 129 void RemoveFSMP(G4FastSimulationManagerProcess*);
129 void FastSimulationNeedsToBeClosed(); << 130
130 << 131
131 // Show the fast simulation setup : world( << 132 // Flag that the Parameterisation must be closed.
132 // Requires the geometry to be closed. << 133 void FastSimulationNeedsToBeClosed();
133 void ShowSetup(); << 134
134 << 135
135 void ListEnvelopes(const G4String& aName = << 136 public: // With description
136 void ListEnvelopes(const G4ParticleDefinit << 137 void ShowSetup();
137 << 138 // Show the fast simulation setup : world(s), region(s), model(s) and links between them.
138 void ActivateFastSimulationModel(const G4S << 139 // Requires the geometry to be closed.
139 void InActivateFastSimulationModel(const G << 140
140 << 141
141 void Flush(); << 142 public: // Without description
142 << 143
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
151 G4FastSimulationMessenger* fTheFastSimulat << 152
152 G4FastSimulationVector<G4FastSimulationMan << 153 private:
153 G4FastSimulationVector<G4FastSimulationMan << 154 // Private construtor insures singleton class
>> 155 G4GlobalFastSimulationManager();
>> 156
>> 157 // recursive display of regions, models, etc...
>> 158 void DisplayRegion(G4Region* motherRegion, G4int depth, std::vector<G4ParticleDefinition*>& particles) const;
>> 159
>> 160 // The single instance.
>> 161 static G4GlobalFastSimulationManager* fGlobalFastSimulationManager;
>> 162 G4FastSimulationMessenger* fTheFastSimulationMessenger;
>> 163 G4FastSimulationVector <G4FastSimulationManager> ManagedManagers;
>> 164 G4FastSimulationVector <G4FastSimulationManagerProcess> fFSMPVector;
154 }; 165 };
155 166
156 #endif << 167 #endif
>> 168 // end of #ifndef G4GlobalFastSimulationManager_hh
157 169