| 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 // G4VParticleChange <<
27 // 23 //
28 // Class description: << 24 // $Id: G4VParticleChange.hh,v 1.11 2004/05/08 15:28:13 kurasige Exp $
>> 25 // GEANT4 tag $Name: geant4-06-02 $
29 // 26 //
30 // Abstract class for "Particle Change". << 27 //
>> 28 // ------------------------------------------------------------
>> 29 // GEANT 4 class header file
31 // 30 //
32 // The ParticleChange class contains the resul <<
33 // of a physics process. This includes final s <<
34 // (momentum, energy, etc) and secondary parti <<
35 // interaction. <<
36 // The tracking assumes that all the values of <<
37 // in global reference system, therefore all t <<
38 // transformations must have been already comp <<
39 // data-members of this class. <<
40 // 31 //
41 // This abstract class has following four virt << 32 // ------------------------------------------------------------
>> 33 // Implemented for the new scheme 23 Mar. 1998 H.Kurahige
>> 34 //
>> 35 // Class Description
>> 36 // This class is the abstract class for ParticleChange.
>> 37 //-
>> 38 // The ParticleChange class ontains the results after invocation
>> 39 // of a physics process. This includes final states of parent
>> 40 // particle (momentum, energy, etc) and secondary particles generated
>> 41 // by the interaction.
>> 42 // The tracking assumes that all the values of energy and
>> 43 // momentum are in global reference system, therefore all the
>> 44 // needed Lorentz transformations must have been already Done
>> 45 // when filling the data-members of this class.
>> 46 //-
>> 47 //-
>> 48 // This abstract class has following four virtual methods
42 // virtual G4Step* UpdateStepForAtRest(G4S 49 // virtual G4Step* UpdateStepForAtRest(G4Step* Step);
43 // virtual G4Step* UpdateStepForAlongStep( 50 // virtual G4Step* UpdateStepForAlongStep(G4Step* Step);
44 // virtual G4Step* UpdateStepForPostStep(G 51 // virtual G4Step* UpdateStepForPostStep(G4Step* Step);
45 // virtual void Initialize(const G4Track&) 52 // virtual void Initialize(const G4Track&);
46 // The UpdateStep methods return the pointer t << 53 // The UpdateStep methods return the pointer to the G4Step
47 // the given Step information by using final s << 54 // after updating the given Step information by using final state
48 // given by a physics process. << 55 // information of the track given by a physics process.
49 // User must add methods to keep the final sta << 56 // User must add methods to keep the final state information
50 // class as well as implement UpdateStep() met << 57 // in his derived class as well as implement UpdateStep methods
51 // << 58 // which he want to use.
52 // The Initialize() methods are provided to re << 59 //-
53 // information and should be called by each pr << 60 // The Initialize methods is provided to refresh the final
>> 61 // state information and should be called by each process
>> 62 // at the beginning of DoIt.
>> 63 //
>> 64 // ------------------------------------------------------------
>> 65 // Implement Event Biasing Scheme 9 Nov.,98 H.Kurashige
>> 66 // add CheckIt 13 Apr.,99 H.Kurashige
>> 67 // add accuracy leveles 5 May, 99 H.Kurashige
>> 68 // add check secondaries 11 June, 03 H.Kurashige
>> 69 // add new methods of ProposeXXX 08 May, 04 H.Kurashige
>> 70 #ifndef G4VParticleChange_h
>> 71 #define G4VParticleChange_h 1
54 72
55 // Author: Hisaya Kurashige, 23 March 1998 <<
56 // ------------------------------------------- <<
57 #ifndef G4VParticleChange_hh <<
58 #define G4VParticleChange_hh 1 <<
59 <<
60 #include <vector> <<
61 #include "globals.hh" 73 #include "globals.hh"
62 #include "G4ios.hh" 74 #include "G4ios.hh"
>> 75
>> 76 class G4Track;
>> 77 class G4Step;
>> 78
>> 79 #include "G4TrackFastVector.hh"
63 #include "G4TrackStatus.hh" 80 #include "G4TrackStatus.hh"
64 #include "G4SteppingControl.hh" 81 #include "G4SteppingControl.hh"
65 #include "G4Step.hh" <<
66 #include "G4Track.hh" <<
67 82
68 class G4VParticleChange << 83
>> 84 class G4VParticleChange
69 { 85 {
70 public: 86 public:
71 << 87 // default constructor
72 G4VParticleChange(); 88 G4VParticleChange();
73 89
74 virtual ~G4VParticleChange() = default; << 90 // destructor
75 << 91 virtual ~G4VParticleChange();
76 G4VParticleChange(const G4VParticleChange& <<
77 G4VParticleChange& operator=(const G4VPart <<
78 92
79 // --- the following methods are for updatin << 93 // equal/unequal operator
>> 94 G4bool operator==(const G4VParticleChange &right) const;
>> 95 G4bool operator!=(const G4VParticleChange &right) const;
>> 96 // "equal" means that teo objects have the same pointer.
80 97
>> 98 protected:
>> 99 // hide copy constructor and assignment operaor as protected
>> 100 G4VParticleChange(const G4VParticleChange &right);
>> 101 G4VParticleChange & operator=(const G4VParticleChange &right);
>> 102
>> 103 public: // with description
>> 104 // --- the following methods are for updating G4Step -----
81 virtual G4Step* UpdateStepForAtRest(G4Step 105 virtual G4Step* UpdateStepForAtRest(G4Step* Step);
82 virtual G4Step* UpdateStepForAlongStep(G4S 106 virtual G4Step* UpdateStepForAlongStep(G4Step* Step);
83 virtual G4Step* UpdateStepForPostStep(G4St 107 virtual G4Step* UpdateStepForPostStep(G4Step* Step);
84 // Return the pointer to the G4Step afte << 108 // Return the pointer to the G4Step after updating the Step information
85 // by using final state information of t << 109 // by using final state information of the track given by a physics
86 // process << 110 // process
87 << 111
88 virtual void Initialize(const G4Track&); << 112 protected: // with description
89 // This methods will be called by each p << 113 G4Step* UpdateStepInfo(G4Step* Step);
90 // of DoIt() if necessary << 114 // Update the G4Step specific attributes
91 << 115 // (i.e. SteppingControl, LocalEnergyDeposit, and TrueStepLength)
92 // --- the following methods are for TruePat <<
93 <<
94 inline G4double GetTrueStepLength() const; <<
95 inline void ProposeTrueStepLength(G4double <<
96 // Get/Propose theTrueStepLength <<
97 <<
98 // --- the following methods are for LocalEn <<
99 <<
100 inline G4double GetLocalEnergyDeposit() co <<
101 inline void ProposeLocalEnergyDeposit(G4do <<
102 // Get/Propose the locally deposited ene <<
103 <<
104 // --- the following methods are for nonIoni <<
105 <<
106 inline G4double GetNonIonizingEnergyDeposi <<
107 inline void ProposeNonIonizingEnergyDeposi <<
108 // Get/Propose the non-ionizing deposite <<
109 <<
110 // --- the following methods are for TrackSt <<
111 <<
112 inline G4TrackStatus GetTrackStatus() cons <<
113 inline void ProposeTrackStatus(G4TrackStat <<
114 // Get/Propose the final TrackStatus of <<
115 <<
116 inline const G4Track* GetCurrentTrack() co <<
117 // Get primary track pointer <<
118 <<
119 // --- the following methods are for managem <<
120 <<
121 inline G4SteppingControl GetSteppingContro <<
122 inline void ProposeSteppingControl(G4Stepp <<
123 // Set/Propose a flag to control steppin <<
124 116
125 // --- the following methods are for managem <<
126 117
127 inline G4bool GetFirstStepInVolume() const << 118 public: // with description
128 inline G4bool GetLastStepInVolume() const; << 119 virtual void Initialize(const G4Track&);
129 inline void ProposeFirstStepInVolume(G4boo << 120 // This methods will be called by each process at the beginning of DoIt
130 inline void ProposeLastStepInVolume(G4bool << 121 // if necessary.
131 122
132 // --- the following methods are for managem << 123 protected:
>> 124 void InitializeTrueStepLength(const G4Track&);
>> 125 void InitializeLocalEnergyDeposit(const G4Track&);
>> 126 void InitializeSteppingControl(const G4Track&);
>> 127 void InitializeParentWeight(const G4Track&);
>> 128
>> 129 void InitializeStatusChange(const G4Track&);
>> 130 void InitializeSecondaries(const G4Track&);
>> 131 // ------------------------------------------------------
>> 132
>> 133 public: // with description
>> 134 //---- the following methods are for TruePathLength ----
>> 135 G4double GetTrueStepLength() const;
>> 136 void ProposeTrueStepLength(G4double truePathLength);
>> 137 // Get/Propose theTrueStepLength
>> 138
>> 139 //---- the following methods are for LocalEnergyDeposit ----
>> 140 G4double GetLocalEnergyDeposit() const;
>> 141 void ProposeLocalEnergyDeposit(G4double anEnergyPart);
>> 142 // Get/Propose the locally deposited energy
>> 143
>> 144 //---- the following methods are for TrackStatus -----
>> 145 G4TrackStatus GetTrackStatus() const;
>> 146 void ProposeTrackStatus(G4TrackStatus status);
>> 147 // Get/Propose the final TrackStatus of the current particle.
>> 148 // ------------------------------------------------------
>> 149
>> 150 //---- the following methods are for managements of SteppingControl --
>> 151 G4SteppingControl GetSteppingControl() const;
>> 152 void ProposeSteppingControl(G4SteppingControl StepControlFlag);
>> 153 // Set/Propose a flag to control stepping manager behavier
>> 154 // ------------------------------------------------------
>> 155
>> 156 //---- the following methods are for managements of secondaries --
>> 157 void Clear();
>> 158 // Clear the contents of this objects
>> 159 // This method should be called after the Tracking(Stepping)
>> 160 // manager removes all secondaries in theListOfSecondaries
>> 161
>> 162 void SetNumberOfSecondaries(G4int totSecondaries);
>> 163 // SetNumberOfSecondaries must be called just before AddSecondary()
>> 164 // in order to secure memory space for theListOfSecondaries
>> 165 // This method resets theNumberOfSecondaries to 0
>> 166 // (that will be incremented at every AddSecondary() call).
>> 167
>> 168 G4int GetNumberOfSecondaries() const;
>> 169 // Returns the number of secondaries current stored in
>> 170 // G4TrackFastVector.
>> 171
>> 172 G4Track* GetSecondary(G4int anIndex) const;
>> 173 // Returns the pointer to the generated secondary particle
>> 174 // which is specified by an Index.
133 175
134 inline void Clear(); << 176 void AddSecondary(G4Track* aSecondary);
135 // Clear the contents of this objects << 177 // Add a secondary particle to theListOfSecondaries.
136 // This method should be called after th << 178 // ------------------------------------------------------
137 // manager removes all secondaries in th <<
138 179
139 inline void SetNumberOfSecondaries(G4int t << 180 G4double GetParentWeight() const ;
140 // SetNumberOfSecondaries must be called << 181 // Get weight of the parent (i.e. current) track
141 // in order to secure memory space for t << 182 void ProposeParentWeight(G4double);
142 // This method resets theNumberOfSeconda << 183 // Propse new weight of the parent (i.e. current) track
143 // (that will be incremented at every Ad << 184
>> 185 void SetParentWeightByProcess(G4bool);
>> 186 G4bool IsParentWeightSetByProcess() const;
>> 187 // If fParentWeightByProcess flag is false (true in default),
>> 188 // G4VParticleChange can change the weight of the parent track,
>> 189 // in any DoIt by using SetParentWeight(G4double)
>> 190
>> 191
>> 192 void SetSecondaryWeightByProcess(G4bool);
>> 193 G4bool IsSecondaryWeightSetByProcess() const;
>> 194 // If fSecondaryWeightByProcess flag is false (false in default),
>> 195 // G4VParticleChange set the weight of the secondary tracks
>> 196 // equal to the parent weight when the secondary tracks are added.
144 197
145 inline G4int GetNumberOfSecondaries() cons << 198 virtual void DumpInfo() const;
146 // Returns the number of secondaries cur << 199 // Print out information
147 200
148 inline G4Track* GetSecondary(G4int anIndex << 201 void SetVerboseLevel(G4int vLevel);
149 // Returns the pointer to the generated << 202 G4int GetVerboseLevel() const;
150 // which is specified by an Index, no ch <<
151 203
152 void AddSecondary(G4Track* aSecondary); << 204 public:
153 // Adds a secondary particle to theListO << 205 // Following methods will be removed in release 7.0
>> 206 // Using ProposeXXXX methods is recommended to setting
>> 207 // properties in G4VParticleChange
>> 208
>> 209 void SetTrueStepLength(G4double truePathLength);
>> 210 void SetLocalEnergyDeposit(G4double anEnergyPart);
>> 211 G4TrackStatus GetStatusChange() const;
>> 212 void SetStatusChange(G4TrackStatus status);
>> 213 void SetSteppingControl(G4SteppingControl StepControlFlag);
>> 214 void SetParentWeight(G4double);
154 215
155 // --- the following methods are for managem << 216 protected:
156 217
157 inline G4double GetWeight() const; << 218 G4TrackFastVector* theListOfSecondaries;
158 inline G4double GetParentWeight() const; << 219 // The vector of secondaries.
159 // Get weight of the parent (i.e. curren <<
160 <<
161 inline void ProposeWeight(G4double finalWe <<
162 inline void ProposeParentWeight(G4double f <<
163 // Propose new weight of the parent (i.e <<
164 // As for AlongStepDoIt, the parent weig <<
165 // in accumulated manner, i.e. - If two <<
166 // weight of W1 and W2 respectively for <<
167 // weight of W0 the final weight is set <<
168 <<
169 inline void SetSecondaryWeightByProcess(G4 <<
170 inline G4bool IsSecondaryWeightSetByProces <<
171 // In default (fSecondaryWeightByProcess <<
172 // the weight of secondary tracks will b <<
173 // If fSecondaryWeightByProcess flag is <<
174 // tracks will not be changed by the Par <<
175 // determine the secondary weight) <<
176 // NOTE: <<
177 // Make sure that only one process in Al <<
178 // parent weight; if several processes i <<
179 // the parent weight and add secondaties <<
180 // is set to false, secondary weights ma <<
181 <<
182 void SetParentWeightByProcess(G4bool); <<
183 G4bool IsParentWeightSetByProcess() const; <<
184 // Obsolete <<
185 220
186 // --- Dump and debug methods --- << 221 G4int theNumberOfSecondaries;
>> 222 // The total number of secondaries produced by each process.
187 223
188 virtual void DumpInfo() const; << 224 G4int theSizeOftheListOfSecondaries;
189 // Print out information << 225 // TheSizeOftheListOfSecondaries;
190 226
191 inline void SetVerboseLevel(G4int vLevel); << 227 G4TrackStatus theStatusChange;
192 inline G4int GetVerboseLevel() const; << 228 // The changed (final) track status of a given particle.
>> 229
>> 230 G4SteppingControl theSteppingControlFlag;
>> 231 // a flag to control stepping manager behavior
>> 232
>> 233 G4double theLocalEnergyDeposit;
>> 234 // It represents the part of the energy lost for discrete
>> 235 // or semi-continuous processes which is due to secondaries
>> 236 // not generated because they would have been below their cut
>> 237 // threshold.
>> 238 // The sum of the locally deposited energy + the delta-energy
>> 239 // coming from the continuous processes gives the
>> 240 // total energy loss localized in the current Step.
>> 241
>> 242 G4double theTrueStepLength;
>> 243 // The value of "True" Step Length
>> 244
>> 245 G4int verboseLevel;
>> 246 // The Verbose level
193 247
>> 248 public: // with description
>> 249 // CheckIt method is provided for debug
194 virtual G4bool CheckIt(const G4Track&); 250 virtual G4bool CheckIt(const G4Track&);
195 // CheckIt method for general control in << 251
196 << 252 // CheckIt method is activated
197 inline void ClearDebugFlag(); << 253 // if debug flag is set and 'G4VERBOSE' is defined
198 inline void SetDebugFlag(); << 254 void ClearDebugFlag();
199 inline G4bool GetDebugFlag() const; << 255 void SetDebugFlag();
200 // CheckIt method is activated if debug << 256 G4bool GetDebugFlag() const;
201 // and 'G4VERBOSE' is defined <<
202 257
203 protected: 258 protected:
204 << 259 // CheckSecondary method is provided for debug
205 G4Step* UpdateStepInfo(G4Step* Step); <<
206 // Update the G4Step specific attributes <<
207 // (i.e. SteppingControl, LocalEnergyDep <<
208 <<
209 inline void InitializeLocalEnergyDeposit() <<
210 inline void InitializeSteppingControl(); <<
211 inline void InitializeParentWeight(const G <<
212 inline void InitializeStatusChange(const G <<
213 inline void InitializeSecondaries(); <<
214 inline void InitializeFromStep(const G4Ste <<
215 <<
216 inline G4double ComputeBeta(G4double kinEn <<
217 <<
218 G4bool CheckSecondary(G4Track&); 260 G4bool CheckSecondary(G4Track&);
219 // CheckSecondary method is provided to << 261
220 // in debug regime <<
221 <<
222 G4double GetAccuracyForWarning() const; 262 G4double GetAccuracyForWarning() const;
223 G4double GetAccuracyForException() const; 263 G4double GetAccuracyForException() const;
224 264
225 protected: << 265 protected:
226 << 266 G4bool debugFlag;
>> 267
>> 268 // accuracy levels
227 static const G4double accuracyForWarning; 269 static const G4double accuracyForWarning;
228 static const G4double accuracyForException << 270 static const G4double accuracyForException;
229 static const G4int maxError; <<
230 // accuracy levels <<
231 <<
232 const G4Track* theCurrentTrack = nullptr; <<
233 <<
234 G4TrackStatus theStatusChange = fAlive; <<
235 // The changed (final) track status of a <<
236 <<
237 G4SteppingControl theSteppingControlFlag = <<
238 // A flag to control stepping manager be <<
239 271
240 G4double theLocalEnergyDeposit = 0.0; <<
241 // It represents the part of the energy <<
242 // or semi-continuous processes which is <<
243 // not generated because they would have <<
244 // threshold. <<
245 // The sum of the locally deposited ener <<
246 // coming from the continuous processes <<
247 // total energy loss localized in the cu <<
248 272
249 G4double theNonIonizingEnergyDeposit = 0.0 << 273 protected:
250 // Non-ionizing energu deposit is define << 274 G4double theParentWeight;
251 // energy deposit, which does not cause << 275 G4bool fSetSecondaryWeightByProcess;
252 << 276 G4bool fSetParentWeightByProcess;
253 G4double theTrueStepLength = 0.0; <<
254 // The value of "True" Step Length <<
255 <<
256 G4double theParentWeight = 1.0; <<
257 // Weight ofparent track <<
258 <<
259 G4double theParentGlobalTime = 0.0; <<
260 // Global time of the parent. <<
261 // This is used only for checking <<
262 <<
263 G4int theNumberOfSecondaries = 0; <<
264 // The total number of secondaries produ <<
265 <<
266 G4int theSizeOftheListOfSecondaries = 0; <<
267 // TheSizeOftheListOfSecondaries; <<
268 <<
269 G4int verboseLevel = 1; <<
270 // The Verbose level <<
271 <<
272 G4int nError = 0; <<
273 <<
274 G4bool theFirstStepInVolume = false; <<
275 G4bool theLastStepInVolume = false; <<
276 // Flag for initial/last step <<
277 <<
278 G4bool isParentWeightProposed = false; <<
279 // Flag for Weight of parent track <<
280 G4bool fSetSecondaryWeightByProcess = fals <<
281 // Flag for setting weight of secondarie <<
282 <<
283 G4bool debugFlag = false; <<
284 <<
285 std::vector<G4Track*> theListOfSecondaries <<
286 // The vector of secondaries <<
287 }; 277 };
288 278
>> 279 #include "G4Step.hh"
>> 280 #include "G4Track.hh"
289 #include "G4VParticleChange.icc" 281 #include "G4VParticleChange.icc"
290 282
291 #endif 283 #endif
292 284