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 // G4Track << 27 // 26 // 28 // Class description: << 27 // $Id: G4Track.hh,v 1.19 2008/10/24 08:22:20 kurasige Exp $ >> 28 // GEANT4 tag $Name: geant4-09-02 $ 29 // 29 // 30 // This class describes the particle under tra << 30 // 31 // It includes information related to tracking << 31 //--------------------------------------------------------------- >> 32 // >> 33 // G4Track.hh >> 34 // >> 35 // Class Description: >> 36 // This class represents the partilce under tracking. >> 37 // It includes information related to tracking for examples: 32 // 1) current position/time of the particl 38 // 1) current position/time of the particle, 33 // 2) static particle information, 39 // 2) static particle information, 34 // 3) the pointer to the physical volume w 40 // 3) the pointer to the physical volume where currently 35 // the particle exists 41 // the particle exists 36 << 42 // 37 // Author: Katsuya Amako, KEK - 1995 << 43 //--------------------------------------------------------------- 38 // Revisions: Hisaya Kurashige, 1998-2011 << 44 // Modification for G4TouchableHandle 22 Oct. 2001 R.Chytracek 39 // ------------------------------------------- << 45 // Add MaterialCutCouple 08 Oct. 2002 H.Kurashige 40 #ifndef G4Track_hh << 46 41 #define G4Track_hh 1 << 47 #ifndef G4Track_h 42 << 48 #define G4Track_h 1 43 #include <cmath> // Include from 'system' << 49 44 #include <map> << 50 #include "globals.hh" // Include from 'global' 45 #include <CLHEP/Units/PhysicalConstants.h> << 51 #include <cmath> // Include from 'system' 46 << 52 #include "G4ThreeVector.hh" // Include from 'geometry' 47 #include "globals.hh" // Include fr << 53 #include "G4LogicalVolume.hh" // Include from 'geometry' 48 #include "trkdefs.hh" // Include DL << 54 #include "G4VPhysicalVolume.hh" // Include from 'geometry' 49 #include "G4ThreeVector.hh" // Include fr << 55 #include "G4Allocator.hh" // Include from 'particle+matter' 50 #include "G4LogicalVolume.hh" // Include fr << 56 #include "G4DynamicParticle.hh" // Include from 'particle+matter' 51 #include "G4VPhysicalVolume.hh" // Include fr << 57 #include "G4TrackStatus.hh" // Include from 'tracking' 52 #include "G4Allocator.hh" // Include fr << 58 #include "G4TouchableHandle.hh" // Include from 'geometry' 53 #include "G4DynamicParticle.hh" // Include fr << 54 #include "G4TrackStatus.hh" // Include fr << 55 #include "G4TouchableHandle.hh" // Include fr << 56 #include "G4VUserTrackInformation.hh" 59 #include "G4VUserTrackInformation.hh" 57 #include "G4PhysicsModelCatalog.hh" << 60 58 #include "G4Material.hh" 61 #include "G4Material.hh" 59 62 60 class G4Step; // Forward declaration << 63 class G4Step; // Forward declaration 61 class G4MaterialCutsCouple; 64 class G4MaterialCutsCouple; 62 class G4VAuxiliaryTrackInformation; << 63 class G4VProcess; << 64 65 >> 66 ////////////// 65 class G4Track 67 class G4Track >> 68 ////////////// 66 { 69 { 67 public: << 68 G4Track(); << 69 // Default constructor << 70 G4Track(G4DynamicParticle* apValueDynamicP << 71 G4double aValueTime, << 72 const G4ThreeVector& aValuePositio << 73 // Constructor - aValueTime is a global << 74 70 75 G4Track(const G4Track&,G4bool copyTouchabl << 71 //-------- 76 // Copy Constructor - copies members oth << 72 public: // With description 77 73 78 ~G4Track(); << 74 // Constructor 79 // Destructor << 75 G4Track(); >> 76 G4Track(G4DynamicParticle* apValueDynamicParticle, >> 77 G4double aValueTime, >> 78 const G4ThreeVector& aValuePosition); >> 79 // aValueTime is a global time >> 80 G4Track(const G4Track&); >> 81 // Copy Constructor copys members other than tracking information >> 82 >> 83 private: >> 84 // Hide assignment operator as private >> 85 G4Track& operator=(const G4Track&); 80 86 81 inline void* operator new(std::size_t); << 87 //-------- 82 // Override "new" for "G4Allocator". << 88 public: // With description 83 inline void operator delete(void* aTrack); << 84 // Override "delete" for "G4Allocator". << 85 89 86 G4Track& operator=(const G4Track&); << 90 // Destrcutor 87 // Assignment operator << 91 ~G4Track(); 88 92 89 inline G4bool operator==(const G4Track&); << 93 // Operators 90 inline G4bool operator!=(const G4Track&); << 94 inline void *operator new(size_t); 91 // Equality operators << 95 // Override "new" for "G4Allocator". >> 96 inline void operator delete(void *aTrack); >> 97 // Override "delete" for "G4Allocator". 92 98 93 void CopyTrackInfo(const G4Track&, G4bool << 99 G4bool operator==( const G4Track& ); 94 // Copy information of the track (w/o tr << 100 >> 101 //-------- >> 102 public: // With description >> 103 // Copy information of the track (w/o tracking information) >> 104 void CopyTrackInfo(const G4Track&); >> 105 >> 106 // Get/Set functions >> 107 // track ID >> 108 G4int GetTrackID() const; >> 109 void SetTrackID(const G4int aValue); >> 110 >> 111 G4int GetParentID() const; >> 112 void SetParentID(const G4int aValue); >> 113 >> 114 // dynamic particle >> 115 const G4DynamicParticle* GetDynamicParticle() const; >> 116 >> 117 // particle definition >> 118 G4ParticleDefinition* GetDefinition() const; >> 119 >> 120 // position, time >> 121 const G4ThreeVector& GetPosition() const; >> 122 void SetPosition(const G4ThreeVector& aValue); >> 123 >> 124 G4double GetGlobalTime() const; >> 125 void SetGlobalTime(const G4double aValue); >> 126 // Time since the event in which the track belongs is created. >> 127 >> 128 G4double GetLocalTime() const; >> 129 void SetLocalTime(const G4double aValue); >> 130 // Time since the current track is created. 95 131 96 inline G4int GetTrackID() const; << 132 G4double GetProperTime() const; 97 inline void SetTrackID(const G4int aValue) << 133 void SetProperTime(const G4double aValue); 98 // Get/Set functions track ID << 134 // Proper time of the current track 99 135 100 inline G4int GetParentID() const; << 136 // volume, material, touchable 101 inline void SetParentID(const G4int aValue << 137 G4VPhysicalVolume* GetVolume() const; >> 138 G4VPhysicalVolume* GetNextVolume() const; 102 139 103 inline const G4DynamicParticle* GetDynamic << 140 G4Material* GetMaterial() const; 104 // Dynamic particle << 141 G4Material* GetNextMaterial() const; 105 142 106 inline const G4ParticleDefinition* GetPart << 143 const G4MaterialCutsCouple* GetMaterialCutsCouple() const; 107 // Particle definition << 144 const G4MaterialCutsCouple* GetNextMaterialCutsCouple() const; 108 inline G4ParticleDefinition* GetDefinition << 109 // Obsolete, for backwards compatibility << 110 145 111 inline const G4ThreeVector& GetPosition() << 146 const G4VTouchable* GetTouchable() const; 112 inline void SetPosition(const G4ThreeVecto << 147 const G4TouchableHandle& GetTouchableHandle() const; 113 // Position, time << 148 void SetTouchableHandle( const G4TouchableHandle& apValue); 114 149 115 inline G4double GetGlobalTime() const; << 150 const G4VTouchable* GetNextTouchable() const; 116 inline void SetGlobalTime(const G4double a << 151 const G4TouchableHandle& GetNextTouchableHandle() const; 117 // Time since the event in which the tra << 152 void SetNextTouchableHandle( const G4TouchableHandle& apValue); 118 153 119 inline G4double GetLocalTime() const; << 154 // energy 120 inline void SetLocalTime(const G4double aV << 155 G4double GetKineticEnergy() const; 121 // Time since the current track is creat << 156 void SetKineticEnergy(const G4double aValue); 122 157 123 inline G4double GetProperTime() const; << 158 G4double GetTotalEnergy() const; 124 inline void SetProperTime(const G4double a << 125 // Proper time of the current track << 126 159 127 inline G4VPhysicalVolume* GetVolume() cons << 128 inline G4VPhysicalVolume* GetNextVolume() << 129 // Volume, material, touchable << 130 << 131 inline G4Material* GetMaterial() const; << 132 inline G4Material* GetNextMaterial() const << 133 << 134 inline const G4MaterialCutsCouple* GetMate << 135 inline const G4MaterialCutsCouple* GetNext << 136 << 137 inline const G4VTouchable* GetTouchable() << 138 inline const G4TouchableHandle& GetTouchab << 139 inline void SetTouchableHandle(const G4Tou << 140 << 141 inline const G4VTouchable* GetNextTouchabl << 142 inline const G4TouchableHandle& GetNextTou << 143 inline void SetNextTouchableHandle(const G << 144 << 145 inline const G4VTouchable* GetOriginToucha << 146 inline const G4TouchableHandle& GetOriginT << 147 inline void SetOriginTouchableHandle(const << 148 << 149 inline G4double GetKineticEnergy() const; << 150 inline G4double GetTotalEnergy() const; << 151 inline void SetKineticEnergy(const G4doubl << 152 // Energy << 153 << 154 inline G4ThreeVector GetMomentum() const; << 155 inline const G4ThreeVector& GetMomentumDir << 156 inline void SetMomentumDirection(const G4T << 157 // Momentum << 158 << 159 inline G4double GetVelocity() const; << 160 inline void SetVelocity(G4double val); << 161 // Velocity << 162 << 163 inline G4double CalculateVelocity() const; << 164 G4double CalculateVelocityForOpticalPhoton << 165 << 166 inline G4bool UseGivenVelocity() const; << 167 inline void UseGivenVelocity(G4bool val); << 168 << 169 inline const G4ThreeVector& GetPolarizatio << 170 inline void SetPolarization(const G4ThreeV << 171 // Polarization << 172 << 173 inline G4TrackStatus GetTrackStatus() cons << 174 inline void SetTrackStatus(const G4TrackSt << 175 // Track status, flags for tracking << 176 << 177 inline G4bool IsBelowThreshold() const; << 178 inline void SetBelowThresholdFlag(G4bool v << 179 // The flag of "BelowThreshold" is set t << 180 // If this track energy is below thresho << 181 // in this material is determined by the << 182 << 183 inline G4bool IsGoodForTracking() const; << 184 inline void SetGoodForTrackingFlag(G4bool << 185 // The flag of "GoodForTracking" is set << 186 // if this track should be tracked << 187 // even if the energy is below threshold << 188 << 189 inline G4double GetTrackLength() const; << 190 inline void AddTrackLength(const G4double << 191 // Accumulated track length << 192 << 193 inline const G4Step* GetStep() const; << 194 inline void SetStep(const G4Step* aValue); << 195 // Step information << 196 << 197 inline G4int GetCurrentStepNumber() const; << 198 inline void IncrementCurrentStepNumber(); << 199 << 200 inline G4double GetStepLength() const; << 201 inline void SetStepLength(G4double value); << 202 // Before the end of the AlongStepDoIt() << 203 // the initial value which is determined << 204 // proposed by a physics process. After << 205 // it will be set equal to 'StepLength' << 206 << 207 inline const G4ThreeVector& GetVertexPosit << 208 inline void SetVertexPosition(const G4Thre << 209 // Vertex (where this track was created) << 210 << 211 inline const G4ThreeVector& GetVertexMomen << 212 inline void SetVertexMomentumDirection(con << 213 << 214 inline G4double GetVertexKineticEnergy() c << 215 inline void SetVertexKineticEnergy(const G << 216 << 217 inline const G4LogicalVolume* GetLogicalVo << 218 inline void SetLogicalVolumeAtVertex(const << 219 << 220 inline const G4VProcess* GetCreatorProcess << 221 inline void SetCreatorProcess(const G4VPro << 222 << 223 inline void SetCreatorModelID(const G4int << 224 inline G4int GetCreatorModelID() const; << 225 inline G4int GetCreatorModelIndex() const; << 226 inline const G4String GetCreatorModelName( << 227 // Identification of the physics model t << 228 // each of the three information (ID, in << 229 // (the model ID and its name are suppos << 230 // code, whereas the index is meant for << 231 << 232 inline const G4ParticleDefinition* GetPare << 233 inline void SetParentResonanceDef(const G4 << 234 inline G4int GetParentResonanceID() const; << 235 inline void SetParentResonanceID(const G4i << 236 inline G4bool HasParentResonance() const; << 237 inline G4int GetParentResonancePDGEncoding << 238 inline G4String GetParentResonanceName() c << 239 inline G4double GetParentResonanceMass() c << 240 // Because short-lived resonances (e.g. << 241 // do not have corresponding track objec << 242 // by a resonance parent, these methods << 243 // regarding this short-lived parent. << 244 // The ID is a unique (integer) identifi << 245 // corresponds to the rounded integer of << 246 // in keV), which allows to know if two << 247 // from the same parent resonance: this << 248 // the parent-track-ID (fParentID) which << 249 // ancestor which is not a short-lived r << 250 // a corresponding track object). << 251 // In the case of a track non originatin << 252 // the above "Get" methods return, respe << 253 // 0, "", 0. << 254 << 255 inline G4double GetWeight() const; << 256 inline void SetWeight(G4double aValue); << 257 // Track weight; methods for manipulatin << 258 << 259 inline G4VUserTrackInformation* GetUserInf << 260 inline void SetUserInformation(G4VUserTrac << 261 // User information << 262 << 263 void SetAuxiliaryTrackInformation(G4int id << 264 G4VAuxil << 265 G4VAuxiliaryTrackInformation* GetAuxiliary << 266 inline std::map<G4int, G4VAuxiliaryTrackIn << 267 GetAuxiliaryTrackInformationMap() c << 268 << 269 void RemoveAuxiliaryTrackInformation(G4int << 270 void RemoveAuxiliaryTrackInformation(G4Str << 271 // Note: G4VAuxiliaryTrackInformation ob << 272 << 273 private: << 274 << 275 void ClearAuxiliaryTrackInformation(); << 276 << 277 // Member data << 278 << 279 G4ThreeVector fPosition; << 280 // Current positon << 281 G4double fGlobalTime = 0.0; << 282 // Time since the event is created << 283 G4double fLocalTime = 0.0; << 284 // Time since the track is created << 285 G4double fTrackLength = 0.0; << 286 // Accumulated track length << 287 160 288 G4double fVelocity = 0.0; << 161 // moemtnum >> 162 const G4ThreeVector& GetMomentumDirection() const; >> 163 void SetMomentumDirection(const G4ThreeVector& aValue); >> 164 >> 165 G4ThreeVector GetMomentum() const; >> 166 >> 167 G4double GetVelocity() const; >> 168 >> 169 >> 170 // polarization >> 171 const G4ThreeVector& GetPolarization() const; >> 172 void SetPolarization(const G4ThreeVector& aValue); >> 173 >> 174 // track status, flags for tracking >> 175 G4TrackStatus GetTrackStatus() const; >> 176 void SetTrackStatus(const G4TrackStatus aTrackStatus); >> 177 >> 178 G4bool IsBelowThreshold() const; >> 179 void SetBelowThresholdFlag(G4bool value = true); >> 180 // The flag of "BelowThreshold" is set to true >> 181 // if this track energy is below threshold energy >> 182 // in this material determined by the range cut value >> 183 >> 184 G4bool IsGoodForTracking() const; >> 185 void SetGoodForTrackingFlag(G4bool value = true); >> 186 // The flag of "GoodForTracking" is set by processes >> 187 // if this track should be tracked >> 188 // even if the energy is below threshold >> 189 >> 190 // track length >> 191 G4double GetTrackLength() const; >> 192 void AddTrackLength(const G4double aValue); >> 193 // Accumulated the track length >> 194 >> 195 // step information >> 196 const G4Step* GetStep() const; >> 197 void SetStep(const G4Step* aValue); >> 198 >> 199 G4int GetCurrentStepNumber() const; >> 200 void IncrementCurrentStepNumber(); >> 201 >> 202 G4double GetStepLength() const; >> 203 void SetStepLength(G4double value); >> 204 // Before the end of the AlongStepDoIt loop,StepLength keeps >> 205 // the initial value which is determined by the shortest geometrical Step >> 206 // proposed by a physics process. After finishing the AlongStepDoIt, >> 207 // it will be set equal to 'StepLength' in G4Step. 289 208 290 G4TouchableHandle fpTouchable; << 209 // vertex (,where this track was created) information 291 G4TouchableHandle fpNextTouchable; << 210 const G4ThreeVector& GetVertexPosition() const; 292 G4TouchableHandle fpOriginTouchable; << 211 void SetVertexPosition(const G4ThreeVector& aValue); 293 // Touchable Handle << 212 294 << 213 const G4ThreeVector& GetVertexMomentumDirection() const; 295 G4DynamicParticle* fpDynamicParticle = nul << 214 void SetVertexMomentumDirection(const G4ThreeVector& aValue); 296 mutable G4TrackStatus fTrackStatus = fAliv << 215 297 << 216 G4double GetVertexKineticEnergy() const; 298 G4double fStepLength = 0.0; << 217 void SetVertexKineticEnergy(const G4double aValue); 299 // Before the end of the AlongStepDoIt l << 218 300 // Step length which is determined by th << 219 const G4LogicalVolume* GetLogicalVolumeAtVertex() const; >> 220 void SetLogicalVolumeAtVertex(const G4LogicalVolume* ); >> 221 >> 222 const G4VProcess* GetCreatorProcess() const; >> 223 void SetCreatorProcess(const G4VProcess* aValue); >> 224 >> 225 // track weight >> 226 // These are methods for manipulating a weight for this track. >> 227 G4double GetWeight() const; >> 228 void SetWeight(G4double aValue); >> 229 >> 230 // User information >> 231 G4VUserTrackInformation* GetUserInformation() const; >> 232 void SetUserInformation(G4VUserTrackInformation* aValue); >> 233 >> 234 //--------- >> 235 private: >> 236 //--------- >> 237 >> 238 // Member data >> 239 G4int fCurrentStepNumber; // Total steps number up to now >> 240 G4ThreeVector fPosition; // Current positon >> 241 G4double fGlobalTime; // Time since the event is created >> 242 G4double fLocalTime; // Time since the track is created >> 243 G4double fTrackLength; // Accumulated track length >> 244 G4int fParentID; >> 245 G4int fTrackID; >> 246 >> 247 G4TouchableHandle fpTouchable; >> 248 G4TouchableHandle fpNextTouchable; >> 249 // Touchable Handle >> 250 >> 251 G4DynamicParticle* fpDynamicParticle; >> 252 G4TrackStatus fTrackStatus; >> 253 >> 254 G4bool fBelowThreshold; >> 255 // This flag is set to true if this track energy is below >> 256 // threshold energy in this material determined by the range cut value >> 257 G4bool fGoodForTracking; >> 258 // This flag is set by processes if this track should be tracked >> 259 // even if the energy is below threshold >> 260 >> 261 G4double fStepLength; >> 262 // Before the end of the AlongStepDoIt loop, this keeps the initial >> 263 // Step length which is determined by the shortest geometrical Step 301 // proposed by a physics process. After 264 // proposed by a physics process. After finishing the AlongStepDoIt, 302 // this will be set equal to 'StepLength 265 // this will be set equal to 'StepLength' in G4Step. 303 266 304 G4double fWeight = 1.0; << 267 G4double fWeight; 305 // This is a weight for this track << 268 // This is a weight for this track 306 << 307 const G4Step* fpStep = nullptr; << 308 269 309 G4ThreeVector fVtxPosition; << 270 const G4Step* fpStep; 310 // (x,y,z) of the vertex << 311 G4ThreeVector fVtxMomentumDirection; << 312 // Momentum direction at the vertex << 313 G4double fVtxKineticEnergy = 0.0; << 314 // Kinetic energy at the vertex << 315 const G4LogicalVolume* fpLVAtVertex = null << 316 // Logical Volume at the vertex << 317 const G4VProcess* fpCreatorProcess = nullp << 318 // Process which created the track << 319 << 320 mutable G4VUserTrackInformation* fpUserInf << 321 << 322 mutable G4Material* prev_mat = nullptr; << 323 mutable G4MaterialPropertyVector* groupvel << 324 mutable G4double prev_velocity = 0.0; << 325 mutable G4double prev_momentum = 0.0; << 326 // cached values for CalculateVelocity << 327 << 328 mutable std::map<G4int, G4VAuxiliaryTrackI << 329 fpAuxiliaryTrackInformationMap = n << 330 << 331 G4int fCurrentStepNumber = 0; << 332 // Total steps number up to now << 333 << 334 G4int fCreatorModelID = -1; << 335 // ID of the physics model which created << 336 << 337 const G4ParticleDefinition* fParentResonan << 338 // Pointer to the particle definition of << 339 // in the case that the track is produce << 340 // (which does not have a corresponding << 341 G4int fParentResonanceID = 0; << 342 // Unique ID for the parent resonance, i << 343 // is produced by a resonance parent, el << 344 << 345 G4int fParentID = 0; << 346 G4int fTrackID = 0; << 347 << 348 G4bool fBelowThreshold = false; << 349 // This flag is set to true if this trac << 350 // threshold energy in this material det << 351 G4bool fGoodForTracking = false; << 352 // This flag is set by processes if this << 353 // even if the energy is below threshold << 354 << 355 G4bool is_OpticalPhoton = false; << 356 << 357 G4bool useGivenVelocity = false; << 358 // do not calculate velocity and just us << 359 // if this flag is set << 360 271 361 G4bool fCopyTouchables = true; << 272 G4ThreeVector fVtxPosition; // (x,y,z) of the vertex >> 273 G4ThreeVector fVtxMomentumDirection; // Momentum direction at the vertex >> 274 G4double fVtxKineticEnergy; // Kinetic energy at the vertex >> 275 const G4LogicalVolume* fpLVAtVertex; //Logical Volume at the vertex >> 276 const G4VProcess* fpCreatorProcess; // Process which created the track >> 277 >> 278 G4VUserTrackInformation* fpUserInformation; 362 }; 279 }; 363 << 280 #include "G4Step.hh" 364 #include "G4Track.icc" 281 #include "G4Track.icc" 365 282 366 #endif 283 #endif >> 284 >> 285 >> 286 >> 287 >> 288 >> 289 >> 290 >> 291 >> 292 >> 293 >> 294 >> 295 >> 296 >> 297 >> 298 367 299