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