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.9 2003/06/11 07:16:28 kurasige Exp $ >> 25 // GEANT4 tag $Name: geant4-06-00 $ 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 #ifndef G4VParticleChange_h >> 70 #define G4VParticleChange_h 1 54 71 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" 72 #include "globals.hh" 62 #include "G4ios.hh" 73 #include "G4ios.hh" >> 74 >> 75 class G4Track; >> 76 class G4Step; >> 77 >> 78 #include "G4TrackFastVector.hh" 63 #include "G4TrackStatus.hh" 79 #include "G4TrackStatus.hh" 64 #include "G4SteppingControl.hh" 80 #include "G4SteppingControl.hh" 65 #include "G4Step.hh" << 66 #include "G4Track.hh" << 67 81 68 class G4VParticleChange << 82 >> 83 class G4VParticleChange 69 { 84 { 70 public: 85 public: 71 << 86 // default constructor 72 G4VParticleChange(); 87 G4VParticleChange(); 73 88 74 virtual ~G4VParticleChange() = default; << 89 // destructor 75 << 90 virtual ~G4VParticleChange(); 76 G4VParticleChange(const G4VParticleChange& << 77 G4VParticleChange& operator=(const G4VPart << 78 91 79 // --- the following methods are for updatin << 92 // equal/unequal operator >> 93 G4bool operator==(const G4VParticleChange &right) const; >> 94 G4bool operator!=(const G4VParticleChange &right) const; >> 95 // "equal" means that teo objects have the same pointer. 80 96 >> 97 protected: >> 98 // hide copy constructor and assignment operaor as protected >> 99 G4VParticleChange(const G4VParticleChange &right); >> 100 G4VParticleChange & operator=(const G4VParticleChange &right); >> 101 >> 102 public: // with description >> 103 // --- the following methods are for updating G4Step ----- 81 virtual G4Step* UpdateStepForAtRest(G4Step 104 virtual G4Step* UpdateStepForAtRest(G4Step* Step); 82 virtual G4Step* UpdateStepForAlongStep(G4S 105 virtual G4Step* UpdateStepForAlongStep(G4Step* Step); 83 virtual G4Step* UpdateStepForPostStep(G4St 106 virtual G4Step* UpdateStepForPostStep(G4Step* Step); 84 // Return the pointer to the G4Step afte << 107 // Return the pointer to the G4Step after updating the Step information 85 // by using final state information of t << 108 // by using final state information of the track given by a physics 86 // process << 109 // process 87 << 110 88 virtual void Initialize(const G4Track&); << 111 protected: // with description 89 // This methods will be called by each p << 112 G4Step* UpdateStepInfo(G4Step* Step); 90 // of DoIt() if necessary << 113 // Update the G4Step specific attributes 91 << 114 // (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 << 125 // --- the following methods are for managem << 126 << 127 inline G4bool GetFirstStepInVolume() const << 128 inline G4bool GetLastStepInVolume() const; << 129 inline void ProposeFirstStepInVolume(G4boo << 130 inline void ProposeLastStepInVolume(G4bool << 131 << 132 // --- the following methods are for managem << 133 << 134 inline void Clear(); << 135 // Clear the contents of this objects << 136 // This method should be called after th << 137 // manager removes all secondaries in th << 138 115 139 inline void SetNumberOfSecondaries(G4int t << 140 // SetNumberOfSecondaries must be called << 141 // in order to secure memory space for t << 142 // This method resets theNumberOfSeconda << 143 // (that will be incremented at every Ad << 144 116 145 inline G4int GetNumberOfSecondaries() cons << 117 public: // with description 146 // Returns the number of secondaries cur << 118 virtual void Initialize(const G4Track&); >> 119 // This methods will be called by each process at the beginning of DoIt >> 120 // if necessary. 147 121 148 inline G4Track* GetSecondary(G4int anIndex << 122 protected: 149 // Returns the pointer to the generated << 123 void InitializeTrueStepLength(const G4Track&); 150 // which is specified by an Index, no ch << 124 void InitializeLocalEnergyDeposit(const G4Track&); >> 125 void InitializeSteppingControl(const G4Track&); >> 126 void InitializeParentWeight(const G4Track&); >> 127 >> 128 void InitializeStatusChange(const G4Track&); >> 129 void InitializeSecondaries(const G4Track&); >> 130 // ------------------------------------------------------ >> 131 >> 132 public: // with description >> 133 //---- the following methods are for TruePathLength ---- >> 134 G4double GetTrueStepLength() const; >> 135 void SetTrueStepLength(G4double truePathLength); >> 136 // Get/Set theTrueStepLength >> 137 >> 138 //---- the following methods are for LocalEnergyDeposit ---- >> 139 G4double GetLocalEnergyDeposit() const; >> 140 void SetLocalEnergyDeposit(G4double anEnergyPart); >> 141 // Get/Set the locally deposited energy >> 142 >> 143 //---- the following methods are for TrackStatus ----- >> 144 G4TrackStatus GetStatusChange() const; >> 145 void SetStatusChange(G4TrackStatus status); >> 146 // Get/Set the final TrackStatus of the current particle. >> 147 // ------------------------------------------------------ >> 148 >> 149 //---- the following methods are for managements of SteppingControl -- >> 150 G4SteppingControl GetSteppingControl() const; >> 151 void SetSteppingControl(G4SteppingControl StepControlFlag); >> 152 // Set/Get a flag to control stepping manager behavier >> 153 // ------------------------------------------------------ >> 154 >> 155 //---- the following methods are for managements of secondaries -- >> 156 void Clear(); >> 157 // Clear the contents of this objects >> 158 // This method should be called after the Tracking(Stepping) >> 159 // manager removes all secondaries in theListOfSecondaries >> 160 >> 161 void SetNumberOfSecondaries(G4int totSecondaries); >> 162 // SetNumberOfSecondaries must be called just before AddSecondary() >> 163 // in order to secure memory space for theListOfSecondaries >> 164 // This method resets theNumberOfSecondaries to 0 >> 165 // (that will be incremented at every AddSecondary() call). >> 166 >> 167 G4int GetNumberOfSecondaries() const; >> 168 // Returns the number of secondaries current stored in >> 169 // G4TrackFastVector. >> 170 >> 171 G4Track* GetSecondary(G4int anIndex) const; >> 172 // Returns the pointer to the generated secondary particle >> 173 // which is specified by an Index. 151 174 152 void AddSecondary(G4Track* aSecondary); 175 void AddSecondary(G4Track* aSecondary); 153 // Adds a secondary particle to theListO << 176 // Add a secondary particle to theListOfSecondaries. >> 177 // ------------------------------------------------------ 154 178 155 // --- the following methods are for managem << 179 G4double GetParentWeight() const ; >> 180 // Get weight of the parent (i.e. current) track 156 181 157 inline G4double GetWeight() const; << 182 void SetParentWeight(G4double); 158 inline G4double GetParentWeight() const; << 183 void SetParentWeightByProcess(G4bool); 159 // Get weight of the parent (i.e. curren << 184 G4bool IsParentWeightSetByProcess() const; 160 << 185 // If fParentWeightByProcess flag is false (true in default), 161 inline void ProposeWeight(G4double finalWe << 186 // G4VParticleChange can change the weight of the parent track, 162 inline void ProposeParentWeight(G4double f << 187 // in any DoIt by using SetParentWeight(G4double) 163 // Propose new weight of the parent (i.e << 188 164 // As for AlongStepDoIt, the parent weig << 189 165 // in accumulated manner, i.e. - If two << 190 void SetSecondaryWeightByProcess(G4bool); 166 // weight of W1 and W2 respectively for << 191 G4bool IsSecondaryWeightSetByProcess() const; 167 // weight of W0 the final weight is set << 192 // If fSecondaryWeightByProcess flag is false (false in default), 168 << 193 // G4VParticleChange set the weight of the secondary tracks 169 inline void SetSecondaryWeightByProcess(G4 << 194 // equal to the parent weight when the secondary tracks are added. 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 << 186 // --- Dump and debug methods --- << 187 195 188 virtual void DumpInfo() const; 196 virtual void DumpInfo() const; 189 // Print out information << 197 // Print out information 190 198 191 inline void SetVerboseLevel(G4int vLevel); << 199 void SetVerboseLevel(G4int vLevel); 192 inline G4int GetVerboseLevel() const; << 200 G4int GetVerboseLevel() const; 193 << 194 virtual G4bool CheckIt(const G4Track&); << 195 // CheckIt method for general control in << 196 << 197 inline void ClearDebugFlag(); << 198 inline void SetDebugFlag(); << 199 inline G4bool GetDebugFlag() const; << 200 // CheckIt method is activated if debug << 201 // and 'G4VERBOSE' is defined << 202 201 203 protected: 202 protected: 204 203 205 G4Step* UpdateStepInfo(G4Step* Step); << 204 G4TrackFastVector* theListOfSecondaries; 206 // Update the G4Step specific attributes << 205 // The vector of secondaries. 207 // (i.e. SteppingControl, LocalEnergyDep << 208 206 209 inline void InitializeLocalEnergyDeposit() << 207 G4int theNumberOfSecondaries; 210 inline void InitializeSteppingControl(); << 208 // The total number of secondaries produced by each process. 211 inline void InitializeParentWeight(const G << 212 inline void InitializeStatusChange(const G << 213 inline void InitializeSecondaries(); << 214 inline void InitializeFromStep(const G4Ste << 215 209 216 inline G4double ComputeBeta(G4double kinEn << 210 G4int theSizeOftheListOfSecondaries; >> 211 // TheSizeOftheListOfSecondaries; 217 212 218 G4bool CheckSecondary(G4Track&); << 213 G4TrackStatus theStatusChange; 219 // CheckSecondary method is provided to << 214 // The changed (final) track status of a given particle. 220 // in debug regime << 215 >> 216 G4SteppingControl theSteppingControlFlag; >> 217 // a flag to control stepping manager behavior >> 218 >> 219 G4double theLocalEnergyDeposit; >> 220 // It represents the part of the energy lost for discrete >> 221 // or semi-continuous processes which is due to secondaries >> 222 // not generated because they would have been below their cut >> 223 // threshold. >> 224 // The sum of the locally deposited energy + the delta-energy >> 225 // coming from the continuous processes gives the >> 226 // total energy loss localized in the current Step. >> 227 >> 228 G4double theTrueStepLength; >> 229 // The value of "True" Step Length >> 230 >> 231 G4int verboseLevel; >> 232 // The Verbose level 221 233 222 G4double GetAccuracyForWarning() const; << 234 public: // with description 223 G4double GetAccuracyForException() const; << 235 // CheckIt method is provided for debug >> 236 virtual G4bool CheckIt(const G4Track&); >> 237 >> 238 // CheckIt method is activated >> 239 // if debug flag is set and 'G4VERBOSE' is defined >> 240 void ClearDebugFlag(); >> 241 void SetDebugFlag(); >> 242 G4bool GetDebugFlag() const; 224 243 225 protected: 244 protected: 226 << 245 // CheckSecondary method is provided for debug >> 246 G4bool CheckSecondary(G4Track&); >> 247 >> 248 const G4double GetAccuracyForWarning() const; >> 249 const G4double GetAccuracyForException() const; >> 250 >> 251 protected: >> 252 G4bool debugFlag; >> 253 >> 254 // accuracy levels 227 static const G4double accuracyForWarning; 255 static const G4double accuracyForWarning; 228 static const G4double accuracyForException << 256 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 257 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 258 249 G4double theNonIonizingEnergyDeposit = 0.0 << 259 protected: 250 // Non-ionizing energu deposit is define << 260 G4double theParentWeight; 251 // energy deposit, which does not cause << 261 G4bool fSetSecondaryWeightByProcess; 252 << 262 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 }; 263 }; 288 264 >> 265 #include "G4Step.hh" >> 266 #include "G4Track.hh" 289 #include "G4VParticleChange.icc" 267 #include "G4VParticleChange.icc" 290 268 291 #endif 269 #endif 292 270