| 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 // G4Track <<
27 // 23 //
28 // Class description: << 24 // $Id: G4Track.hh,v 1.10.2.1 2001/06/28 19:15:24 gunter Exp $
>> 25 // GEANT4 tag $Name: $
29 // 26 //
30 // This class describes the particle under tra << 27 //
31 // It includes information related to tracking << 28 //---------------------------------------------------------------
>> 29 //
>> 30 // G4Track.hh
>> 31 //
>> 32 // Class Description:
>> 33 // This class represents the partilce under tracking.
>> 34 // It includes information related to tracking for examples:
32 // 1) current position/time of the particl 35 // 1) current position/time of the particle,
33 // 2) static particle information, 36 // 2) static particle information,
34 // 3) the pointer to the physical volume w 37 // 3) the pointer to the physical volume where currently
35 // the particle exists << 38 // the particle exists,
>> 39 //
>> 40 // Contact:
>> 41 // Questions and comments to this code should be sent to
>> 42 // Katsuya Amako (e-mail: Katsuya.Amako@kek.jp)
>> 43 // Takashi Sasaki (e-mail: Takashi.Sasaki@kek.jp)
>> 44 //
>> 45 //---------------------------------------------------------------
36 46
37 // Author: Katsuya Amako, KEK - 1995 << 47 #ifndef G4Track_h
38 // Revisions: Hisaya Kurashige, 1998-2011 << 48 #define G4Track_h 1
39 // ------------------------------------------- << 49
40 #ifndef G4Track_hh << 50 #include "globals.hh" // Include from 'global'
41 #define G4Track_hh 1 << 51 #include "G4ThreeVector.hh" // Include from 'geometry'
42 << 52 #include "G4LogicalVolume.hh" // Include from 'geometry'
43 #include <cmath> // Include from 'system' << 53 #include "G4VPhysicalVolume.hh" // Include from 'geometry'
44 #include <map> << 54 #include "G4Allocator.hh" // Include from 'particle+matter'
45 #include <CLHEP/Units/PhysicalConstants.h> << 55 #include "G4DynamicParticle.hh" // Include from 'particle+matter'
46 << 56 #include "G4TrackStatus.hh" // Include from 'tracking'
47 #include "globals.hh" // Include fr << 57 #include "G4VTouchable.hh" // Include from 'geometry'
48 #include "trkdefs.hh" // Include DL <<
49 #include "G4ThreeVector.hh" // Include fr <<
50 #include "G4LogicalVolume.hh" // Include fr <<
51 #include "G4VPhysicalVolume.hh" // Include fr <<
52 #include "G4Allocator.hh" // Include fr <<
53 #include "G4DynamicParticle.hh" // Include fr <<
54 #include "G4TrackStatus.hh" // Include fr <<
55 #include "G4TouchableHandle.hh" // Include fr <<
56 #include "G4VUserTrackInformation.hh" 58 #include "G4VUserTrackInformation.hh"
57 #include "G4PhysicsModelCatalog.hh" << 59
58 #include "G4Material.hh" 60 #include "G4Material.hh"
59 61
60 class G4Step; // Forward declaration << 62 class G4Step; // Forward declaration
61 class G4MaterialCutsCouple; <<
62 class G4VAuxiliaryTrackInformation; <<
63 class G4VProcess; <<
64 63
>> 64 //////////////
65 class G4Track 65 class G4Track
>> 66 //////////////
66 { 67 {
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 68
75 G4Track(const G4Track&,G4bool copyTouchabl << 69 //--------
76 // Copy Constructor - copies members oth << 70 public: // With description
77 71
78 ~G4Track(); << 72 // Constructor
79 // Destructor << 73 G4Track();
>> 74 G4Track(const G4Track&);
>> 75 G4Track(G4DynamicParticle* apValueDynamicParticle,
>> 76 G4double aValueTime,
>> 77 const G4ThreeVector& aValuePosition);
>> 78 // aValueTime is a global time
>> 79
>> 80 G4Track& operator=(const G4Track&);
>> 81 //--------
>> 82 public:
80 83
81 inline void* operator new(std::size_t); << 84 // Destrcutor
>> 85 ~G4Track();
>> 86
>> 87 // Operators
>> 88 inline void *operator new(size_t);
82 // Override "new" for "G4Allocator". 89 // Override "new" for "G4Allocator".
83 inline void operator delete(void* aTrack); << 90 inline void operator delete(void *aTrack);
84 // Override "delete" for "G4Allocator". 91 // Override "delete" for "G4Allocator".
85 92
86 G4Track& operator=(const G4Track&); << 93 int operator==( const G4Track& s);
87 // Assignment operator << 94 // Define "==" operator because "G4TrackVector" uses
88 << 95 //"RWPtrOrderdVector" which requires this.
89 inline G4bool operator==(const G4Track&); <<
90 inline G4bool operator!=(const G4Track&); <<
91 // Equality operators <<
92 96
93 void CopyTrackInfo(const G4Track&, G4bool << 97 //--------
94 // Copy information of the track (w/o tr << 98 public: // With description
95 99
96 inline G4int GetTrackID() const; << 100 // Get/Set functions
97 inline void SetTrackID(const G4int aValue) << 101 // track ID
98 // Get/Set functions track ID << 102 G4int GetTrackID() const;
>> 103 void SetTrackID(const G4int aValue);
99 104
100 inline G4int GetParentID() const; << 105 G4int GetParentID() const;
101 inline void SetParentID(const G4int aValue << 106 void SetParentID(const G4int aValue);
102 107
103 inline const G4DynamicParticle* GetDynamic << 108 // dynamic particle
104 // Dynamic particle << 109 const G4DynamicParticle* GetDynamicParticle() const;
105 110
106 inline const G4ParticleDefinition* GetPart << 111 // particle definition
107 // Particle definition << 112 G4ParticleDefinition* GetDefinition() const;
108 inline G4ParticleDefinition* GetDefinition <<
109 // Obsolete, for backwards compatibility <<
110 113
111 inline const G4ThreeVector& GetPosition() << 114 // position, time
112 inline void SetPosition(const G4ThreeVecto << 115 const G4ThreeVector& GetPosition() const;
113 // Position, time << 116 void SetPosition(const G4ThreeVector& aValue);
114 117
115 inline G4double GetGlobalTime() const; << 118 G4double GetGlobalTime() const;
116 inline void SetGlobalTime(const G4double a << 119 void SetGlobalTime(const G4double aValue);
117 // Time since the event in which the tra << 120 // Time since the event in which the track belongs is created.
118 121
119 inline G4double GetLocalTime() const; << 122 G4double GetLocalTime() const;
120 inline void SetLocalTime(const G4double aV << 123 void SetLocalTime(const G4double aValue);
121 // Time since the current track is creat << 124 // Time since the current track is created.
122 125
123 inline G4double GetProperTime() const; << 126 G4double GetProperTime() const;
124 inline void SetProperTime(const G4double a << 127 void SetProperTime(const G4double aValue);
125 // Proper time of the current track 128 // Proper time of the current track
126 129
127 inline G4VPhysicalVolume* GetVolume() cons << 130 // volume, material, touchable
128 inline G4VPhysicalVolume* GetNextVolume() << 131 G4VPhysicalVolume* GetVolume() const;
129 // Volume, material, touchable << 132 G4VPhysicalVolume* GetNextVolume() const;
130 << 133
131 inline G4Material* GetMaterial() const; << 134 G4Material* GetMaterial() const;
132 inline G4Material* GetNextMaterial() const << 135 G4Material* GetNextMaterial() const;
133 << 136
134 inline const G4MaterialCutsCouple* GetMate << 137 const G4VTouchable* GetTouchable() const;
135 inline const G4MaterialCutsCouple* GetNext << 138 void SetTouchable(const G4VTouchable* apValue);
136 << 139
137 inline const G4VTouchable* GetTouchable() << 140 const G4VTouchable* GetNextTouchable() const;
138 inline const G4TouchableHandle& GetTouchab << 141 void SetNextTouchable(const G4VTouchable* apValue);
139 inline void SetTouchableHandle(const G4Tou << 142
140 << 143 // energy
141 inline const G4VTouchable* GetNextTouchabl << 144 G4double GetKineticEnergy() const;
142 inline const G4TouchableHandle& GetNextTou << 145 void SetKineticEnergy(const G4double aValue);
143 inline void SetNextTouchableHandle(const G << 146
144 << 147 G4double GetTotalEnergy() const;
145 inline const G4VTouchable* GetOriginToucha << 148
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 149
288 G4double fVelocity = 0.0; << 150 // moemtnum
>> 151 const G4ThreeVector& GetMomentumDirection() const;
>> 152 void SetMomentumDirection(const G4ThreeVector& aValue);
>> 153
>> 154 G4ThreeVector GetMomentum() const;
>> 155
>> 156 G4double GetVelocity() const;
>> 157
>> 158
>> 159 // polarization
>> 160 const G4ThreeVector& GetPolarization() const;
>> 161 void SetPolarization(const G4ThreeVector& aValue);
>> 162
>> 163 // track status, flags for tracking
>> 164 G4TrackStatus GetTrackStatus() const;
>> 165 void SetTrackStatus(const G4TrackStatus aTrackStatus);
>> 166
>> 167 G4bool IsBelowThreshold() const;
>> 168 void SetBelowThresholdFlag(G4bool value = true);
>> 169 // The flag of "BelowThreshold" is set to true
>> 170 // if this track energy is below threshold energy
>> 171 // in this material determined by the range cut value
>> 172
>> 173 G4bool IsGoodForTracking() const;
>> 174 void SetGoodForTrackingFlag(G4bool value = true);
>> 175 // The flag of "GoodForTracking" is set by processes
>> 176 // if this track should be tracked
>> 177 // even if the energy is below threshold
>> 178
>> 179 // track length
>> 180 G4double GetTrackLength() const;
>> 181 void AddTrackLength(const G4double aValue);
>> 182 // Accumulated the track length
>> 183
>> 184 // step information
>> 185 const G4Step* GetStep() const;
>> 186 void SetStep(const G4Step* aValue);
>> 187
>> 188 G4int GetCurrentStepNumber() const;
>> 189 void IncrementCurrentStepNumber();
>> 190
>> 191 G4double GetStepLength() const;
>> 192 void SetStepLength(G4double value);
>> 193 // Before the end of the AlongStepDoIt loop,StepLength keeps
>> 194 // the initial value which is determined by the shortest geometrical Step
>> 195 // proposed by a physics process. After finishing the AlongStepDoIt,
>> 196 // it will be set equal to 'StepLength' in G4Step.
289 197
290 G4TouchableHandle fpTouchable; << 198 // vertex (,where this track was created) information
291 G4TouchableHandle fpNextTouchable; << 199 const G4ThreeVector& GetVertexPosition() const;
292 G4TouchableHandle fpOriginTouchable; << 200 void SetVertexPosition(const G4ThreeVector& aValue);
293 // Touchable Handle << 201
294 << 202 const G4ThreeVector& GetVertexMomentumDirection() const;
295 G4DynamicParticle* fpDynamicParticle = nul << 203 void SetVertexMomentumDirection(const G4ThreeVector& aValue);
296 mutable G4TrackStatus fTrackStatus = fAliv << 204
297 << 205 G4double GetVertexKineticEnergy() const;
298 G4double fStepLength = 0.0; << 206 void SetVertexKineticEnergy(const G4double aValue);
299 // Before the end of the AlongStepDoIt l << 207
300 // Step length which is determined by th << 208 G4LogicalVolume* GetLogicalVolumeAtVertex() const;
>> 209 void SetLogicalVolumeAtVertex(G4LogicalVolume* );
>> 210
>> 211 const G4VProcess* GetCreatorProcess() const;
>> 212 void SetCreatorProcess(G4VProcess* aValue);
>> 213
>> 214 // track weight
>> 215 // These are methods for manipulating a weight for this track.
>> 216 // The track weight is used by G4VEvtBiasMechanism
>> 217 // to execute inclusive simulation for hadronic/electomagnetic shower
>> 218 // and neutron transportation etc.
>> 219 G4double GetWeight() const;
>> 220 void SetWeight(G4double aValue);
>> 221
>> 222 // User information
>> 223 G4VUserTrackInformation* GetUserInformation() const;
>> 224 void SetUserInformation(G4VUserTrackInformation* aValue);
>> 225
>> 226 //---------
>> 227 private:
>> 228 //---------
>> 229
>> 230 // Member data
>> 231 G4int fCurrentStepNumber; // Total steps number up to now
>> 232 G4ThreeVector fPosition; // Current positon
>> 233 G4double fGlobalTime; // Time since the event is created
>> 234 G4double fLocalTime; // Time since the track is created
>> 235 G4double fTrackLength; // Accumulated track length
>> 236 G4int fParentID;
>> 237 G4int fTrackID;
>> 238
>> 239 const G4VTouchable* fpTouchable;
>> 240 const G4VTouchable* fpNextTouchable;
>> 241
>> 242 G4DynamicParticle* fpDynamicParticle;
>> 243 G4TrackStatus fTrackStatus;
>> 244
>> 245 G4bool fBelowThreshold;
>> 246 // This flag is set to true if this track energy is below
>> 247 // threshold energy in this material determined by the range cut value
>> 248 G4bool fGoodForTracking;
>> 249 // This flag is set by processes if this track should be tracked
>> 250 // even if the energy is below threshold
>> 251
>> 252 G4double fStepLength;
>> 253 // Before the end of the AlongStepDoIt loop, this keeps the initial
>> 254 // Step length which is determined by the shortest geometrical Step
301 // proposed by a physics process. After 255 // proposed by a physics process. After finishing the AlongStepDoIt,
302 // this will be set equal to 'StepLength 256 // this will be set equal to 'StepLength' in G4Step.
303 257
304 G4double fWeight = 1.0; << 258 G4double fWeight;
305 // This is a weight for this track << 259 // This is a weight for this track used by G4VEvtBiasMechanism
>> 260 // to execute inclusive simulation for hadronic/electomagnetic shower
>> 261 // and neutron transportation etc.
>> 262
>> 263 const G4Step* fpStep;
>> 264
>> 265 G4ThreeVector fVtxPosition; // (x,y,z) of the vertex
>> 266 G4ThreeVector fVtxMomentumDirection; // Momentum direction at the vertex
>> 267 G4double fVtxKineticEnergy; // Kinetic energy at the vertex
>> 268 G4LogicalVolume* fpLVAtVertex; //Logical Volume at the vertex
>> 269 G4VProcess* fpCreatorProcess; // Process which created the track
>> 270
>> 271 G4VUserTrackInformation* fpUserInformation;
>> 272 };
>> 273 #include "G4Step.hh"
>> 274 #include "G4Track.icc"
>> 275
>> 276 #endif
>> 277
>> 278
>> 279
>> 280
>> 281
>> 282
>> 283
>> 284
>> 285
>> 286
306 287
307 const G4Step* fpStep = nullptr; <<
308 288
309 G4ThreeVector fVtxPosition; <<
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 289
361 G4bool fCopyTouchables = true; <<
362 }; <<
363 290
364 #include "G4Track.icc" <<
365 291
366 #endif <<
367 292