| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // G4StepPoint
27 //
28 // Class description:
29 //
30 // This class represents information associated with each end
31 // of a Step like the space/time data of the particle.
32
33 // Author: Hisaya Kurashige, 16 February 2000
34 // --------------------------------------------------------------------
35 #ifndef G4StepPoint_hh
36 #define G4StepPoint_hh 1
37
38 #include <cmath> // Include from 'system'
39 #include <CLHEP/Units/PhysicalConstants.h>
40
41 #include "globals.hh" // Include from 'global'
42 #include "G4Allocator.hh" // Include from 'global'
43 #include "G4ThreeVector.hh" // Include from 'geometry'
44 #include "G4VPhysicalVolume.hh" // Include from 'geometry'
45 #include "G4SteppingControl.hh"
46 #include "G4StepStatus.hh" // Include from 'track'
47 #include "G4TouchableHandle.hh" // Include from 'geometry'
48 #include "G4Material.hh"
49 #include "G4LogicalVolume.hh"
50
51 class G4VProcess;
52 class G4MaterialCutsCouple;
53 class G4VSensitiveDetector;
54
55 class G4StepPoint
56 {
57 public:
58
59 G4StepPoint() = default;
60 ~G4StepPoint()= default;
61 // Constructor/Destructor
62
63 G4StepPoint(const G4StepPoint&) = default;
64 G4StepPoint& operator=(const G4StepPoint&);
65 // Copy Constructor and assignment operator
66
67 inline const G4ThreeVector& GetPosition() const;
68 inline void SetPosition(const G4ThreeVector& aValue);
69 inline void AddPosition(const G4ThreeVector& aValue);
70 // Position
71
72 inline G4double GetLocalTime() const;
73 inline void SetLocalTime(const G4double aValue);
74 inline void AddLocalTime(const G4double aValue);
75 // Time since the track is created
76
77 inline G4double GetGlobalTime() const;
78 inline void SetGlobalTime(const G4double aValue);
79 inline void AddGlobalTime(const G4double aValue);
80 // Time since the event in which the track belongs is created
81
82 inline G4double GetProperTime() const;
83 inline void SetProperTime(const G4double aValue);
84 inline void AddProperTime(const G4double aValue);
85 // Proper time of the particle
86
87 inline const G4ThreeVector& GetMomentumDirection() const;
88 inline void SetMomentumDirection(const G4ThreeVector& aValue);
89 inline void AddMomentumDirection(const G4ThreeVector& aValue);
90 // Direction of momentum (should be an unit vector)
91
92 inline G4ThreeVector GetMomentum() const;
93 // Total momentum of the track
94
95 inline G4double GetTotalEnergy() const;
96 // Total energy of the track
97
98 inline G4double GetKineticEnergy() const;
99 inline void SetKineticEnergy(const G4double aValue);
100 inline void AddKineticEnergy(const G4double aValue);
101 // Kinetic Energy of the track
102
103 inline G4double GetVelocity() const;
104 inline void SetVelocity(G4double v);
105 // Velocity
106
107 inline G4double GetBeta() const;
108 // Velocity of the track in unit of c(light velocity)
109
110 inline G4double GetGamma() const;
111 // Gamma factor (1/sqrt[1-beta*beta]) of the track
112
113 inline G4VPhysicalVolume* GetPhysicalVolume() const;
114
115 inline const G4VTouchable* GetTouchable() const;
116 inline const G4TouchableHandle& GetTouchableHandle() const;
117 inline void SetTouchableHandle(const G4TouchableHandle& apValue);
118
119 inline G4Material* GetMaterial() const;
120 inline void SetMaterial(G4Material*);
121
122 inline const G4MaterialCutsCouple* GetMaterialCutsCouple() const;
123 inline void SetMaterialCutsCouple(const G4MaterialCutsCouple*);
124
125 inline G4VSensitiveDetector* GetSensitiveDetector() const;
126 inline void SetSensitiveDetector(G4VSensitiveDetector*);
127
128 inline G4double GetSafety() const;
129 inline void SetSafety(const G4double aValue);
130
131 inline const G4ThreeVector& GetPolarization() const;
132 inline void SetPolarization(const G4ThreeVector& aValue);
133 inline void AddPolarization(const G4ThreeVector& aValue);
134
135 inline G4StepStatus GetStepStatus() const;
136 inline void SetStepStatus(const G4StepStatus aValue);
137
138 inline const G4VProcess* GetProcessDefinedStep() const;
139 // If the pointer is 0, this means the Step is defined
140 // by the user defined limit in the current volume
141 inline void SetProcessDefinedStep(const G4VProcess* aValue);
142
143 inline G4double GetMass() const;
144 inline void SetMass(G4double value);
145
146 inline G4double GetCharge() const;
147 inline void SetCharge(G4double value);
148
149 inline G4double GetMagneticMoment() const;
150 inline void SetMagneticMoment(G4double value);
151
152 inline void SetWeight(G4double aValue);
153 inline G4double GetWeight() const;
154
155 private:
156
157 G4ThreeVector fPosition;
158 G4double fGlobalTime = 0.0;
159 // Time since event is created
160 G4double fLocalTime = 0.0;
161 // Time since track is created
162 G4double fProperTime = 0.0;
163 // Time since track is created (in rest frame of particle)
164 G4ThreeVector fMomentumDirection;
165 G4double fKineticEnergy = 0.0;
166 G4double fVelocity = 0.0;
167 // Momentum,energy and velocity
168 G4TouchableHandle fpTouchable;
169 // Touchable Handle
170 G4Material* fpMaterial = nullptr;
171 // Material of the volmue
172 const G4MaterialCutsCouple* fpMaterialCutsCouple = nullptr;
173 // MaterialCutsCouple of the volmue
174 G4VSensitiveDetector* fpSensitiveDetector = nullptr;
175 G4double fSafety = 0.0;
176 G4ThreeVector fPolarization;
177 G4StepStatus fStepStatus = fUndefined;
178 // DoIt type which defined the current Step.
179 const G4VProcess* fpProcessDefinedStep = nullptr;
180 // Process which defined the current Step.
181 G4double fMass = 0.0;
182 // Dynamical mass of the particle
183 G4double fCharge = 0.0;
184 // Dynamical Charge of the particle
185 G4double fMagneticMoment = 0.0;
186 // Dynamical MagneticMoment of the particle
187 G4double fWeight = 0.0;
188 // Track Weight
189 };
190
191 #include "G4StepPoint.icc"
192
193 #endif
194