| 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 // G4StackManager <<
27 // 26 //
28 // Class description: << 27 // $Id: G4StackManager.hh,v 1.13 2009-08-15 15:45:50 asaim Exp $
>> 28 // GEANT4 tag $Name: geant4-09-04-patch-02 $
29 // 29 //
30 // This is the manager class of handling stack <<
31 // This class must be a singleton and be const <<
32 // Almost all methods must be invoked exclusiv <<
33 // Especially, some Clear() methods MUST NOT b <<
34 // Event abortion is handled by G4EventManager <<
35 // 30 //
36 // G4StackManager has three stacks, the urgent <<
37 // waiting stack, and the postpone to next eve <<
38 // of each stack is descrived in the Geant4 Us <<
39 31
40 // Author: Makoto Asai, 1996 <<
41 // <<
42 // History: <<
43 // - 01/Feb/1996, Makoto Asai - Created <<
44 // - 04/Oct/2011, Pere Mato - Use of G4TrackSt <<
45 // - 28/Aug/2023, Makoto Asai - Adding sub-eve <<
46 // ------------------------------------------- <<
47 #ifndef G4StackManager_hh <<
48 #define G4StackManager_hh 1 <<
49 32
50 #include <map> << 33 #ifndef G4StackManager_h
51 #include <vector> << 34 #define G4StackManager_h 1
52 35
53 #include "G4UserStackingAction.hh" 36 #include "G4UserStackingAction.hh"
54 #include "G4StackedTrack.hh" 37 #include "G4StackedTrack.hh"
55 #include "G4TrackStack.hh" 38 #include "G4TrackStack.hh"
56 #include "G4SmartTrackStack.hh" 39 #include "G4SmartTrackStack.hh"
57 #include "G4SubEventTrackStack.hh" <<
58 #include "G4ClassificationOfNewTrack.hh" 40 #include "G4ClassificationOfNewTrack.hh"
59 #include "G4Track.hh" 41 #include "G4Track.hh"
60 #include "G4TrackStatus.hh" 42 #include "G4TrackStatus.hh"
61 #include "G4ExceptionSeverity.hh" <<
62 #include "globals.hh" 43 #include "globals.hh"
63 << 44 #include "evmandefs.hh"
64 class G4StackingMessenger; 45 class G4StackingMessenger;
65 class G4VTrajectory; 46 class G4VTrajectory;
66 class G4Event; << 47
67 class G4ParticleDefinition; << 48 // class description:
>> 49 //
>> 50 // This is the manager class of handling stacks of G4Track objects.
>> 51 // This class must be a singleton and be constructed by G4EventManager.
>> 52 // Almost all methods must be invoked exclusively by G4EventManager.
>> 53 // Especially, some Clear() methods MUST NOT be invoked by the user.
>> 54 // Event abortion is handled by G4EventManager.
>> 55 //
>> 56 // This G4StackingManager has three stacks, the urgent stack, the
>> 57 // waiting stack, and the postpone to next event stack. The meanings
>> 58 // of each stack is descrived in the Geant4 user's manual.
>> 59 //
>> 60
68 61
69 class G4StackManager 62 class G4StackManager
70 { 63 {
71 public: 64 public:
>> 65 G4StackManager();
>> 66 ~G4StackManager();
72 67
73 G4StackManager(); << 68 private:
74 ~G4StackManager(); << 69 const G4StackManager & operator=
75 << 70 (const G4StackManager &right);
76 const G4StackManager& operator=(const G4St << 71 G4int operator==(const G4StackManager &right) const;
77 G4bool operator==(const G4StackManager&) c << 72 G4int operator!=(const G4StackManager &right) const;
78 G4bool operator!=(const G4StackManager&) c <<
79 <<
80 G4int PushOneTrack(G4Track* newTrack, <<
81 G4VTrajectory* newTraje <<
82 G4Track* PopNextTrack(G4VTrajectory** newT <<
83 G4int PrepareNewEvent(G4Event* currentEven <<
84 73
85 void ReClassify(); << 74 public:
86 // Send all tracks stored in the Urgent << 75 G4int PushOneTrack(G4Track *newTrack, G4VTrajectory *newTrajectory = 0);
>> 76 G4Track * PopNextTrack(G4VTrajectory**newTrajectory);
>> 77 G4int PrepareNewEvent();
>> 78
>> 79 public: // with description
>> 80 void ReClassify();
>> 81 // Send all tracks stored in the Urgent stack one by one to
87 // the user's concrete ClassifyNewTrack( 82 // the user's concrete ClassifyNewTrack() method. This method
88 // can be invoked from the user's G4User 83 // can be invoked from the user's G4UserStackingAction concrete
89 // class, especially fron its NewStage() 84 // class, especially fron its NewStage() method. Be aware that
90 // when the urgent stack becomes empty, 85 // when the urgent stack becomes empty, all tracks in the waiting
91 // stack are send to the urgent stack an 86 // stack are send to the urgent stack and then the user's NewStage()
92 // method is invoked. 87 // method is invoked.
93 88
94 void SetNumberOfAdditionalWaitingStacks(G4 << 89 void SetNumberOfAdditionalWaitingStacks(G4int iAdd);
95 // Set the number of additional (optiona << 90 // Set the number of additional (optional) waiting stacks.
96 // This method must be invoked at PreIni 91 // This method must be invoked at PreInit, Init or Idle states.
97 // Once the user set the number of addit 92 // Once the user set the number of additional waiting stacks,
98 // he/she can use the corresponding ENUM 93 // he/she can use the corresponding ENUM in G4ClassificationOfNewTrack.
99 // The user should invoke G4RunManager:: 94 // The user should invoke G4RunManager::SetNumberOfAdditionalWaitingStacks
100 // method, which invokes this method. 95 // method, which invokes this method.
101 96
102 void TransferStackedTracks(G4Classificatio << 97 void TransferStackedTracks(G4ClassificationOfNewTrack origin, G4ClassificationOfNewTrack destination);
103 G4Classificatio << 98 // Transfter all stacked tracks from the origin stack to the destination stack.
104 // Transfer all stacked tracks from the << 99 // The destination stack needs not be empty.
105 // destination stack. The destination st <<
106 // If the destination is fKill, tracks a 100 // If the destination is fKill, tracks are deleted.
107 // If the origin is fKill, nothing happe 101 // If the origin is fKill, nothing happen.
108 102
109 void TransferOneStackedTrack(G4Classificat << 103 void TransferOneStackedTrack(G4ClassificationOfNewTrack origin, G4ClassificationOfNewTrack destination);
110 G4Classificat << 104 // Transfter one stacked track from the origin stack to the destination stack.
111 // Transfter one stacked track from the <<
112 // stack. <<
113 // The transfered track is the one which 105 // The transfered track is the one which came last to the origin stack.
114 // The destination stack needs not be em 106 // The destination stack needs not be empty.
115 // If the destination is fKill, the trac 107 // If the destination is fKill, the track is deleted.
116 // If the origin is fKill, nothing happe 108 // If the origin is fKill, nothing happen.
117 109
118 void RegisterSubEventType(G4int ty, G4int <<
119 // Registering a sub-event type and the <<
120 // stored in a G4SubEvent object of the <<
121 <<
122 void SetDefaultClassification( <<
123 G4TrackStatus, G4ClassificationOf <<
124 G4ExceptionSeverity es = G4Except <<
125 void SetDefaultClassification( <<
126 const G4ParticleDefinition*, G4Cl <<
127 G4ExceptionSeverity es = G4Except <<
128 // Define the default classification for <<
129 // Default can be alternated by the User <<
130 // G4ExceptionSeverity can be set to war <<
131 // is inproperly changed. <<
132 <<
133 inline G4ClassificationOfNewTrack GetDefau <<
134 { return fDefaultClassification; } <<
135 <<
136 public: <<
137 void ReleaseSubEvent(G4int ty); <<
138 inline std::size_t GetNSubEventTypes() <<
139 { return subEvtTypes.size(); } <<
140 inline G4int GetSubEventType(std::size_t i <<
141 { return subEvtTypes[i]; } <<
142 <<
143 void clear(); <<
144 void ClearUrgentStack(); <<
145 void ClearWaitingStack(G4int i=0); <<
146 void ClearPostponeStack(); <<
147 G4int GetNTotalTrack() const; <<
148 G4int GetNUrgentTrack() const; <<
149 G4int GetNWaitingTrack(G4int i=0) const; <<
150 G4int GetNPostponedTrack() const; <<
151 void SetVerboseLevel( G4int const value ); <<
152 void SetUserStackingAction(G4UserStackingA <<
153 <<
154 private: <<
155 void DefineDefaultClassification(const G4T <<
156 void SortOut(G4StackedTrack&,G4Classificat <<
157 <<
158 private: 110 private:
159 << 111 G4UserStackingAction * userStackingAction;
160 G4UserStackingAction* userStackingAction = << 112 G4int verboseLevel;
161 G4int verboseLevel = 0; <<
162 #ifdef G4_USESMARTSTACK 113 #ifdef G4_USESMARTSTACK
163 G4SmartTrackStack* urgentStack = nullptr; << 114 G4SmartTrackStack * urgentStack;
164 #else 115 #else
165 G4TrackStack* urgentStack = nullptr; << 116 G4TrackStack * urgentStack;
166 #endif 117 #endif
167 G4TrackStack* waitingStack = nullptr; << 118 G4TrackStack * waitingStack;
168 G4TrackStack* postponeStack = nullptr; << 119 G4TrackStack * postponeStack;
169 G4StackingMessenger* theMessenger = nullpt << 120 G4StackingMessenger* theMessenger;
170 std::vector<G4TrackStack*> additionalWaiti << 121 std::vector<G4TrackStack*> additionalWaitingStacks;
171 G4int numberOfAdditionalWaitingStacks = 0; << 122 G4int numberOfAdditionalWaitingStacks;
172 <<
173 std::map<G4TrackStatus, <<
174 std::pair<G4ClassificationOfNewTr <<
175 defClassTrackStatus; <<
176 std::map<const G4ParticleDefinition*, <<
177 std::pair<G4ClassificationOfNewTr <<
178 defClassPartDef; <<
179 G4ClassificationOfNewTrack fDefaultClassif <<
180 G4ExceptionSeverity fExceptionSeverity = G <<
181 123
182 std::map<G4int,G4SubEventTrackStack*> subE << 124 public:
183 std::vector<G4int> subEvtTypes; << 125 inline void clear()
>> 126 {
>> 127 ClearUrgentStack();
>> 128 ClearWaitingStack();
>> 129 for(int i=1;i<=numberOfAdditionalWaitingStacks;i++) {ClearWaitingStack(i);}
>> 130 }
>> 131 inline void ClearUrgentStack()
>> 132 { urgentStack->clear(); }
>> 133 inline void ClearWaitingStack(int i=0)
>> 134 {
>> 135 if(i==0) {
>> 136 waitingStack->clear();
>> 137 } else {
>> 138 if(i<=numberOfAdditionalWaitingStacks) additionalWaitingStacks[i-1]->clear();
>> 139 }
>> 140 }
>> 141 inline void ClearPostponeStack()
>> 142 { postponeStack->clear(); }
>> 143 inline G4int GetNTotalTrack() const
>> 144 { int n = urgentStack->GetNTrack() + waitingStack->GetNTrack() + postponeStack->GetNTrack();
>> 145 for(int i=1;i<=numberOfAdditionalWaitingStacks;i++) {n += additionalWaitingStacks[i-1]->GetNTrack();}
>> 146 return n;
>> 147 }
>> 148 inline G4int GetNUrgentTrack() const
>> 149 { return urgentStack->GetNTrack(); }
>> 150 inline G4int GetNWaitingTrack(int i=0) const
>> 151 { if(i==0) { return waitingStack->GetNTrack(); }
>> 152 else {
>> 153 if(i<=numberOfAdditionalWaitingStacks) { return additionalWaitingStacks[i-1]->GetNTrack();}
>> 154 }
>> 155 return 0;
>> 156 }
>> 157 inline G4int GetNPostponedTrack() const
>> 158 { return postponeStack->GetNTrack(); }
>> 159 inline void SetVerboseLevel( G4int const value )
>> 160 { verboseLevel = value; }
>> 161 inline void SetUserStackingAction(G4UserStackingAction* value)
>> 162 {
>> 163 userStackingAction = value;
>> 164 if(userStackingAction) userStackingAction->SetStackManager(this);
>> 165 }
>> 166
>> 167 private:
>> 168 inline G4ClassificationOfNewTrack
>> 169 DefaultClassification(G4Track *aTrack)
>> 170 {
>> 171 G4ClassificationOfNewTrack classification = fUrgent;
>> 172 if( aTrack->GetTrackStatus() == fPostponeToNextEvent )
>> 173 { classification = fPostpone; }
>> 174 return classification;
>> 175 }
184 }; 176 };
185 177
186 #endif 178 #endif
>> 179
187 180