| 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 // G4StepPoint 26 // G4StepPoint
27 // 27 //
28 // Class description: 28 // Class description:
29 // 29 //
30 // This class represents information associate 30 // This class represents information associated with each end
31 // of a Step like the space/time data of the p 31 // of a Step like the space/time data of the particle.
32 32
33 // Author: Hisaya Kurashige, 16 February 2000 33 // Author: Hisaya Kurashige, 16 February 2000
34 // ------------------------------------------- 34 // --------------------------------------------------------------------
35 #ifndef G4StepPoint_hh 35 #ifndef G4StepPoint_hh
36 #define G4StepPoint_hh 1 36 #define G4StepPoint_hh 1
37 37
38 #include <cmath> // Include from 'system' 38 #include <cmath> // Include from 'system'
39 #include <CLHEP/Units/PhysicalConstants.h> 39 #include <CLHEP/Units/PhysicalConstants.h>
40 40
41 #include "globals.hh" // Include fr 41 #include "globals.hh" // Include from 'global'
42 #include "G4Allocator.hh" // Include fr 42 #include "G4Allocator.hh" // Include from 'global'
43 #include "G4ThreeVector.hh" // Include fr 43 #include "G4ThreeVector.hh" // Include from 'geometry'
44 #include "G4VPhysicalVolume.hh" // Include fr 44 #include "G4VPhysicalVolume.hh" // Include from 'geometry'
45 #include "G4SteppingControl.hh" 45 #include "G4SteppingControl.hh"
46 #include "G4StepStatus.hh" // Include fr 46 #include "G4StepStatus.hh" // Include from 'track'
47 #include "G4TouchableHandle.hh" // Include fr 47 #include "G4TouchableHandle.hh" // Include from 'geometry'
48 #include "G4Material.hh" 48 #include "G4Material.hh"
49 #include "G4LogicalVolume.hh" 49 #include "G4LogicalVolume.hh"
50 50
51 class G4VProcess; 51 class G4VProcess;
52 class G4MaterialCutsCouple; 52 class G4MaterialCutsCouple;
53 class G4VSensitiveDetector; 53 class G4VSensitiveDetector;
54 54
55 class G4StepPoint 55 class G4StepPoint
56 { 56 {
57 public: 57 public:
58 58
59 G4StepPoint() = default; 59 G4StepPoint() = default;
60 ~G4StepPoint()= default; << 60 ~G4StepPoint()= default;
61 // Constructor/Destructor 61 // Constructor/Destructor
62 62
63 G4StepPoint(const G4StepPoint&) = default; 63 G4StepPoint(const G4StepPoint&) = default;
64 G4StepPoint& operator=(const G4StepPoint&) 64 G4StepPoint& operator=(const G4StepPoint&);
65 // Copy Constructor and assignment opera 65 // Copy Constructor and assignment operator
66 66
67 inline const G4ThreeVector& GetPosition() << 67 const G4ThreeVector& GetPosition() const;
68 inline void SetPosition(const G4ThreeVecto << 68 void SetPosition(const G4ThreeVector& aValue);
69 inline void AddPosition(const G4ThreeVecto << 69 void AddPosition(const G4ThreeVector& aValue);
70 // Position 70 // Position
71 71
72 inline G4double GetLocalTime() const; << 72 G4double GetLocalTime() const;
73 inline void SetLocalTime(const G4double aV << 73 void SetLocalTime(const G4double aValue);
74 inline void AddLocalTime(const G4double aV << 74 void AddLocalTime(const G4double aValue);
75 // Time since the track is created 75 // Time since the track is created
76 76
77 inline G4double GetGlobalTime() const; << 77 G4double GetGlobalTime() const;
78 inline void SetGlobalTime(const G4double a << 78 void SetGlobalTime(const G4double aValue);
79 inline void AddGlobalTime(const G4double a << 79 void AddGlobalTime(const G4double aValue);
80 // Time since the event in which the tra 80 // Time since the event in which the track belongs is created
81 81
82 inline G4double GetProperTime() const; << 82 G4double GetProperTime() const;
83 inline void SetProperTime(const G4double a << 83 void SetProperTime(const G4double aValue);
84 inline void AddProperTime(const G4double a << 84 void AddProperTime(const G4double aValue);
85 // Proper time of the particle 85 // Proper time of the particle
86 86
87 inline const G4ThreeVector& GetMomentumDir << 87 const G4ThreeVector& GetMomentumDirection() const;
88 inline void SetMomentumDirection(const G4T << 88 void SetMomentumDirection(const G4ThreeVector& aValue);
89 inline void AddMomentumDirection(const G4T << 89 void AddMomentumDirection(const G4ThreeVector& aValue);
90 // Direction of momentum (should be an 90 // Direction of momentum (should be an unit vector)
91 91
92 inline G4ThreeVector GetMomentum() const; << 92 G4ThreeVector GetMomentum() const;
93 // Total momentum of the track 93 // Total momentum of the track
94 94
95 inline G4double GetTotalEnergy() const; << 95 G4double GetTotalEnergy() const;
96 // Total energy of the track 96 // Total energy of the track
97 97
98 inline G4double GetKineticEnergy() const; << 98 G4double GetKineticEnergy() const;
99 inline void SetKineticEnergy(const G4doubl << 99 void SetKineticEnergy(const G4double aValue);
100 inline void AddKineticEnergy(const G4doubl << 100 void AddKineticEnergy(const G4double aValue);
101 // Kinetic Energy of the track 101 // Kinetic Energy of the track
102 102
103 inline G4double GetVelocity() const; << 103 G4double GetVelocity() const;
104 inline void SetVelocity(G4double v); << 104 void SetVelocity(G4double v);
105 // Velocity 105 // Velocity
106 106
107 inline G4double GetBeta() const; << 107 G4double GetBeta() const;
108 // Velocity of the track in unit of c(li 108 // Velocity of the track in unit of c(light velocity)
109 109
110 inline G4double GetGamma() const; << 110 G4double GetGamma() const;
111 // Gamma factor (1/sqrt[1-beta*beta]) of 111 // Gamma factor (1/sqrt[1-beta*beta]) of the track
112 112
113 inline G4VPhysicalVolume* GetPhysicalVolum << 113 G4VPhysicalVolume* GetPhysicalVolume() const;
114 114
115 inline const G4VTouchable* GetTouchable() << 115 const G4VTouchable* GetTouchable() const;
116 inline const G4TouchableHandle& GetTouchab << 116 const G4TouchableHandle& GetTouchableHandle() const;
117 inline void SetTouchableHandle(const G4Tou << 117 void SetTouchableHandle(const G4TouchableHandle& apValue);
118 118
119 inline G4Material* GetMaterial() const; << 119 G4Material* GetMaterial() const;
120 inline void SetMaterial(G4Material*); << 120 void SetMaterial(G4Material*);
121 121
122 inline const G4MaterialCutsCouple* GetMate << 122 const G4MaterialCutsCouple* GetMaterialCutsCouple() const;
123 inline void SetMaterialCutsCouple(const G4 << 123 void SetMaterialCutsCouple(const G4MaterialCutsCouple*);
124 124
125 inline G4VSensitiveDetector* GetSensitiveD << 125 G4VSensitiveDetector* GetSensitiveDetector() const;
126 inline void SetSensitiveDetector(G4VSensit << 126 void SetSensitiveDetector(G4VSensitiveDetector*);
127 127
128 inline G4double GetSafety() const; << 128 G4double GetSafety() const;
129 inline void SetSafety(const G4double aValu << 129 void SetSafety(const G4double aValue);
130 130
131 inline const G4ThreeVector& GetPolarizatio << 131 const G4ThreeVector& GetPolarization() const;
132 inline void SetPolarization(const G4ThreeV << 132 void SetPolarization(const G4ThreeVector& aValue);
133 inline void AddPolarization(const G4ThreeV << 133 void AddPolarization(const G4ThreeVector& aValue);
134 134
135 inline G4StepStatus GetStepStatus() const; << 135 G4StepStatus GetStepStatus() const;
136 inline void SetStepStatus(const G4StepStat << 136 void SetStepStatus(const G4StepStatus aValue);
137 137
138 inline const G4VProcess* GetProcessDefined << 138 const G4VProcess* GetProcessDefinedStep() const;
139 // If the pointer is 0, this means the S 139 // If the pointer is 0, this means the Step is defined
140 // by the user defined limit in the curr 140 // by the user defined limit in the current volume
141 inline void SetProcessDefinedStep(const G4 << 141 void SetProcessDefinedStep(const G4VProcess* aValue);
142 142
143 inline G4double GetMass() const; << 143 G4double GetMass() const;
144 inline void SetMass(G4double value); << 144 void SetMass(G4double value);
145 145
146 inline G4double GetCharge() const; << 146 G4double GetCharge() const;
147 inline void SetCharge(G4double value); << 147 void SetCharge(G4double value);
148 148
149 inline G4double GetMagneticMoment() const; << 149 G4double GetMagneticMoment() const;
150 inline void SetMagneticMoment(G4double val << 150 void SetMagneticMoment(G4double value);
151 151
152 inline void SetWeight(G4double aValue); << 152 void SetWeight(G4double aValue);
153 inline G4double GetWeight() const; << 153 G4double GetWeight() const;
154 154
155 private: 155 private:
156 156
157 G4ThreeVector fPosition; 157 G4ThreeVector fPosition;
158 G4double fGlobalTime = 0.0; 158 G4double fGlobalTime = 0.0;
159 // Time since event is created 159 // Time since event is created
160 G4double fLocalTime = 0.0; 160 G4double fLocalTime = 0.0;
161 // Time since track is created 161 // Time since track is created
162 G4double fProperTime = 0.0; 162 G4double fProperTime = 0.0;
163 // Time since track is created (in rest 163 // Time since track is created (in rest frame of particle)
164 G4ThreeVector fMomentumDirection; 164 G4ThreeVector fMomentumDirection;
165 G4double fKineticEnergy = 0.0; 165 G4double fKineticEnergy = 0.0;
166 G4double fVelocity = 0.0; 166 G4double fVelocity = 0.0;
167 // Momentum,energy and velocity 167 // Momentum,energy and velocity
168 G4TouchableHandle fpTouchable; 168 G4TouchableHandle fpTouchable;
169 // Touchable Handle 169 // Touchable Handle
170 G4Material* fpMaterial = nullptr; 170 G4Material* fpMaterial = nullptr;
171 // Material of the volmue 171 // Material of the volmue
172 const G4MaterialCutsCouple* fpMaterialCuts 172 const G4MaterialCutsCouple* fpMaterialCutsCouple = nullptr;
173 // MaterialCutsCouple of the volmue 173 // MaterialCutsCouple of the volmue
174 G4VSensitiveDetector* fpSensitiveDetector 174 G4VSensitiveDetector* fpSensitiveDetector = nullptr;
175 G4double fSafety = 0.0; 175 G4double fSafety = 0.0;
176 G4ThreeVector fPolarization; 176 G4ThreeVector fPolarization;
177 G4StepStatus fStepStatus = fUndefined; 177 G4StepStatus fStepStatus = fUndefined;
178 // DoIt type which defined the current S 178 // DoIt type which defined the current Step.
179 const G4VProcess* fpProcessDefinedStep = n 179 const G4VProcess* fpProcessDefinedStep = nullptr;
180 // Process which defined the current Ste 180 // Process which defined the current Step.
181 G4double fMass = 0.0; 181 G4double fMass = 0.0;
182 // Dynamical mass of the particle 182 // Dynamical mass of the particle
183 G4double fCharge = 0.0; 183 G4double fCharge = 0.0;
184 // Dynamical Charge of the particle 184 // Dynamical Charge of the particle
185 G4double fMagneticMoment = 0.0; 185 G4double fMagneticMoment = 0.0;
186 // Dynamical MagneticMoment of the parti 186 // Dynamical MagneticMoment of the particle
187 G4double fWeight = 0.0; 187 G4double fWeight = 0.0;
188 // Track Weight 188 // Track Weight
189 }; 189 };
190 190
191 #include "G4StepPoint.icc" 191 #include "G4StepPoint.icc"
192 192
193 #endif 193 #endif
194 194