| 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 // G4ParticleChange <<
27 // 26 //
28 // Class description: << 27 // $Id: G4ParticleChange.hh,v 1.13 2007/03/11 07:19:06 kurasige Exp $
>> 28 // GEANT4 tag $Name: geant4-09-01-patch-02 $
29 // 29 //
30 // Concrete class for ParticleChange containin << 30 //
31 // invocation of a physics process. << 31 // ------------------------------------------------------------
32 // This includes final states of parent partic << 32 // GEANT 4 class header file
33 // etc) and secondary particles generated by t <<
34 // The tracking assumes that all the values of <<
35 // are in global reference system, therefore a <<
36 // transformations must have been already comp <<
37 // data-members of this class. <<
38 // 33 //
39 // IMPORTANT NOTE: Despite the name, what this << 34 //
40 // through its methods, are the "FINAL" values << 35 // ------------------------------------------------------------
41 // Momentum, etc. << 36 // Implemented for the new scheme 23 Mar. 1998 H.Kurahige
42 << 37 //
43 // Author: Hisaya Kurashige, 23 March 1998 << 38 // Class Description
44 // ------------------------------------------- << 39 // This class is a concrete class for ParticleChange which
45 #ifndef G4ParticleChange_hh << 40 // has all functionality in old scheme.
46 #define G4ParticleChange_hh 1 << 41 //-
>> 42 // This class contains the results after invocation of a physics process.
>> 43 // This includes final states of parent particle (momentum, energy,
>> 44 // etc) and secondary particles generated by the interaction.
>> 45 // The tracking assumes that all the values of energy and
>> 46 // momentum are in global reference system, therefore all the
>> 47 // needed Lorentz transformations must have been already Done
>> 48 // when filling the data-members of this class.
>> 49 //-
>> 50 // ---------------------------------------------------------------
>> 51 // IMPORTANT NOTE: Although the name of the class and methods are
>> 52 // "Change", what it stores (and returns in get) are the "FINAL"
>> 53 // values of the Position, Momentum, etc.
>> 54 //
>> 55 // ------------------------------------------------------------
>> 56 // modify AddSecondary methods for "GoodForTracking" flag
>> 57 // 8 June 1998 H.Kurashige
>> 58 // Add Track weight 12 Nov. 1998 H.Kurashige
>> 59 // Add Get/SetMomentumDirectionChange 6 Feb. 1999 H.Kurashige
>> 60 // Add Get/SetDynamicMass 5 Oct. 1999 H.Kurashige
>> 61 // Add Get/SetDynamicCharge 5 Oct. 1999 H.Kurashige
>> 62 // Rename SetXXX methods to ProposeXXX DynamicCharge Oct. 2005 H.Kurashige
>> 63 // Add get/ProposeMagneticMoment Mar 2007 H.Kurashige
>> 64 // Fix treatment of weight Mar 2007 H.Kurashige
>> 65 // -------------------------------------------------------------
>> 66
>> 67 #ifndef G4ParticleChange_h
>> 68 #define G4ParticleChange_h 1
47 69
48 #include "globals.hh" 70 #include "globals.hh"
49 #include "G4ios.hh" 71 #include "G4ios.hh"
50 #include "G4ThreeVector.hh" 72 #include "G4ThreeVector.hh"
51 #include "G4VParticleChange.hh" << 73 #include "G4ThreeVector.hh"
52 <<
53 class G4DynamicParticle; 74 class G4DynamicParticle;
>> 75 #include "G4VParticleChange.hh"
54 76
55 class G4ParticleChange : public G4VParticleCha << 77 class G4ParticleChange: public G4VParticleChange
56 { << 78 {
57 public: 79 public:
58 << 80 // default constructor
59 G4ParticleChange(); 81 G4ParticleChange();
60 // Default constructor << 82 // G4ParticleChange(G4bool useEB);
>> 83
>> 84 // destructor
>> 85 virtual ~G4ParticleChange();
>> 86
>> 87 protected:
>> 88 // hide copy constructor and assignment operaor as protected
>> 89 G4ParticleChange(const G4ParticleChange &right);
>> 90 G4ParticleChange & operator=(const G4ParticleChange &right);
61 91
62 ~G4ParticleChange() override = default; << 92 public:
63 // Destructor << 93 // equal/unequal operator
>> 94 G4bool operator==(const G4ParticleChange &right) const;
>> 95 G4bool operator!=(const G4ParticleChange &right) const;
>> 96
>> 97 public: // with description
>> 98 // ----------------------------------------------------
>> 99 // --- the following methods are for updating G4Step -----
>> 100 // Return the pointer to the G4Step after updating the Step information
>> 101 // by using final state information of the track given by a physics
>> 102 // process
>> 103 virtual G4Step* UpdateStepForAlongStep(G4Step* Step);
>> 104 // A physics process gives the final state of the particle
>> 105 // relative to the initial state at the beginning of the Step,
>> 106 // i.e., based on information of G4Track (or equivalently
>> 107 // the PreStepPoint)
>> 108 // In this method, the differences (delta) between these two states
>> 109 // are calculated, and are accumulated in PostStepPoint.
>> 110 // Take note that the return type of GetMomentumChange is a
>> 111 // pointer to G4ParticleMometum. Also it is a normalized
>> 112 // momentum vector.
>> 113 virtual G4Step* UpdateStepForAtRest(G4Step* Step);
>> 114 virtual G4Step* UpdateStepForPostStep(G4Step* Step);
>> 115 // A physics process gives the final state of the particle
>> 116 // based on information of G4Track (or equivalently the PreStepPoint)
>> 117
>> 118 virtual void Initialize(const G4Track&);
>> 119 // Initialize all propoerties by using G4Track information
64 120
65 G4ParticleChange(const G4ParticleChange& r << 121 protected: // with description
66 G4ParticleChange& operator=(const G4Partic << 122 G4Step* UpdateStepInfo(G4Step* Step);
>> 123 // Update the G4Step specific attributes
>> 124 // (i.e. SteppingControl, LocalEnergyDeposit, and TrueStepLength)
67 125
68 // --- the following methods are for updatin << 126 public: // with description
69 // Return the pointer to G4Step after updati << 127
70 // by using final state of the track given b << 128 // ----------------------------------------------------
71 << 129 //--- methods to keep information of the final state--
72 G4Step* UpdateStepForAlongStep(G4Step* Ste << 130 // IMPORTANT NOTE:
73 // A physics process gives the final sta << 131 // These ProposeXXX methods stores (and returns in GetXXX methods)
74 // relative to the initial state at the << 132 // the "FINAL" values of the Position, Momentum, etc.
75 // i.e., based on information of G4Track << 133
76 // the PreStepPoint). << 134 const G4ThreeVector* GetMomentumDirection() const;
77 // In this method, the differences (delt << 135 void ProposeMomentumDirection(G4double Px, G4double Py, G4double Pz);
78 // are calculated, and are accumulated i << 136 void ProposeMomentumDirection(const G4ThreeVector& Pfinal);
79 // Take note that the return type of Get << 137 // Get/Propose the MomentumDirection vector: it is the final momentum direction.
80 // pointer to G4ParticleMomentum. Also i << 138
81 // momentum vector << 139 const G4ThreeVector* GetPolarization() const;
82 << 140 void ProposePolarization(G4double Px, G4double Py, G4double Pz);
83 G4Step* UpdateStepForAtRest(G4Step* Step) << 141 void ProposePolarization(const G4ThreeVector& finalPoralization);
84 G4Step* UpdateStepForPostStep(G4Step* Step << 142 // Get/Propose the final Polarization vector.
85 // A physics process gives the final sta << 143
86 // based on information of G4Track (or e << 144 G4double GetEnergy() const;
87 << 145 void ProposeEnergy(G4double finalEnergy);
88 void Initialize(const G4Track&) override; << 146 // Get/Propose the final kinetic energy of the current particle.
89 // Initialize all propoerties by using G << 147
90 << 148 G4double GetProperTime() const;
91 // --- methods to keep information of the fi << 149 void ProposeProperTime(G4double finalProperTime);
92 // << 150 // Get/Propose th final eProperTime
93 // The ProposeXXX methods store (and return << 151
94 // the "FINAL" values of the Position, Mome << 152 const G4ThreeVector* GetPosition() const;
95 << 153 void ProposePosition(G4double x, G4double y, G4double z);
96 inline const G4ThreeVector* GetMomentumDir << 154 void ProposePosition(const G4ThreeVector& finalPosition);
97 inline void ProposeMomentumDirection(G4dou << 155 // Get/Propose the final position of the current particle.
98 inline void ProposeMomentumDirection(const << 156
99 // Get/Propose the MomentumDirection vec << 157 G4double GetGlobalTime() const;
100 // direction << 158 void ProposeGlobalTime(G4double finalGlobalTime);
101 << 159 // Get/Propose the final GlobalTime
102 inline const G4ThreeVector* GetPolarizatio << 160
103 inline void ProposePolarization(G4double P << 161 G4double GetMass() const;
104 inline void ProposePolarization(const G4Th << 162 void ProposeMass(G4double finalMass);
105 // Get/Propose the final Polarization ve << 163 // Get/Propose the final dynamical Mass in G4DynamicParticle
106 << 164
107 inline G4double GetEnergy() const; << 165 G4double GetCharge() const;
108 inline void ProposeEnergy(G4double finalEn << 166 void ProposeCharge(G4double finalCharge);
109 // Get/Propose the final kinetic energy << 167 // Get/Propose the final dynamical Charge in G4DynamicParticle
110 << 168
111 inline G4double GetVelocity() const; << 169 G4double GetMagneticMoment() const;
112 inline void ProposeVelocity(G4double final << 170 void ProposeMagneticMoment(G4double finalMagneticMoment);
113 // Get/Propose the final velocity of the << 171 // Get/Propose the final MagneticMoment in G4DynamicParticle
114 << 172
115 inline G4double GetProperTime() const; << 173 G4double GetWeight() const;
116 inline void ProposeProperTime(G4double fin << 174 void ProposeWeight(G4double finalWeight);
117 // Get/Propose the final ProperTime << 175 // Get/Propose the final Weight of the parent particle
118 << 176
119 inline const G4ThreeVector* GetPosition() << 177 // -- Utility functions --
120 inline void ProposePosition(G4double x, G4 << 178 G4ThreeVector GetGlobalPosition(const G4ThreeVector& displacement) const;
121 inline void ProposePosition(const G4ThreeV << 179 // Convert the position displacement to the global position.
122 // Get/Propose the final position of the << 180
123 << 181 G4double GetGlobalTime(G4double timeDelay) const;
124 inline void ProposeGlobalTime(G4double t); << 182 // Convert the time delay to the global time.
125 inline void ProposeLocalTime(G4double t); << 183
126 // Get/Propose the final global/local Ti << 184 G4ThreeVector CalcMomentum(G4double energy,
127 // NOTE: DO NOT INVOKE both methods in a << 185 G4ThreeVector direction,
128 // Each method affects both local << 186 G4double mass ) const;
129 << 187 // Calculate momentum by using Energy, Momentum Direction, and Mass
130 inline G4double GetGlobalTime(G4double tim << 188 // ----------------------------------------------------
131 inline G4double GetLocalTime(G4double time <<
132 // Convert the time delay to the glocbal <<
133 // Can get the final global/local time w <<
134 <<
135 inline G4double GetMass() const; <<
136 inline void ProposeMass(G4double finalMass <<
137 // Get/Propose the final dynamical mass <<
138 <<
139 inline G4double GetCharge() const; <<
140 inline void ProposeCharge(G4double finalCh <<
141 // Get/Propose the final dynamical charg <<
142 <<
143 inline G4double GetMagneticMoment() const; <<
144 inline void ProposeMagneticMoment(G4double <<
145 // Get/Propose the final MagneticMoment <<
146 <<
147 inline G4ThreeVector <<
148 GetGlobalPosition(const G4ThreeVector& dis <<
149 // Convert the position displacement to <<
150 <<
151 inline G4ThreeVector CalcMomentum(G4double <<
152 G4double <<
153 // Calculate momentum by using Energy, M <<
154 189
155 // --- methods for adding secondaries --- <<
156 190
>> 191 // ----------------------------------------------------
>> 192 // --- methods for adding secondaries
157 void AddSecondary(G4Track* aSecondary); 193 void AddSecondary(G4Track* aSecondary);
158 // Add a secondary particle to theListOf << 194 // Add a secondary particle to theListOfSecondaries.
159 195
160 void AddSecondary(G4DynamicParticle* aSeco 196 void AddSecondary(G4DynamicParticle* aSecondary,
161 G4bool IsGoodForTracking << 197 G4bool IsGoodForTracking = false );
162 // Add a secondary particle to theListOf << 198 // Add a secondary particle to theListOfSecondaries.
163 // Position and time are same as thePosi << 199 // position and time are same as thePositionChange and theTimeChange
164 << 200
165 void AddSecondary(G4DynamicParticle* aSeco << 201 void AddSecondary(G4DynamicParticle* aSecondary,
166 G4bool IsGoodForTracking << 202 G4ThreeVector position,
167 // Add a secondary particle to theListOf << 203 G4bool IsGoodForTracking = false );
168 // Global time are same as theTimeChange << 204 // Add a secondary particle to theListOfSecondaries.
169 << 205 // global time are same as theTimeChange and theTimeChange
170 void AddSecondary(G4DynamicParticle* aSeco << 206
171 G4bool IsGoodForTracking << 207 void AddSecondary(G4DynamicParticle* aSecondary,
172 // Add a secondary particle to theListOf << 208 G4double time,
173 // Position and are same as thePositionC << 209 G4bool IsGoodForTracking = false );
174 << 210 // Add a secondary particle to theListOfSecondaries.
175 // --- Dump and debug methods --- << 211 // position and are same as thePositionChange
>> 212 // ----------------------------------------------------
176 213
177 void DumpInfo() const override; << 214 public:
>> 215 virtual void DumpInfo() const;
178 216
179 protected: 217 protected:
180 <<
181 G4Step* UpdateStepInfo(G4Step* Step); <<
182 // Update the G4Step specific attributes <<
183 // (i.e. SteppingControl, LocalEnergyDep <<
184 <<
185 G4ThreeVector theMomentumDirectionChange; 218 G4ThreeVector theMomentumDirectionChange;
186 // It is the vector containing the final << 219 // It is the vector containing the final momentum direction
187 // after the invoked process. The applic << 220 // after the invoked process. The application of the change
188 // of the momentum direction of the part << 221 // of the momentum direction of the particle is not Done here.
189 // The responsibility to apply the chang << 222 // The responsibility to apply the change is up the entity
190 // which invoked the process << 223 // which invoked the process.
191 224
192 G4ThreeVector thePolarizationChange; 225 G4ThreeVector thePolarizationChange;
193 // The changed (final) polarization of a << 226 // The changed (final) polarization of a given track
>> 227
>> 228 G4double theEnergyChange;
>> 229 // The final kinetic energy of the current track
>> 230
>> 231 G4ThreeVector thePositionChange;
>> 232 // The changed (final) position of a given track
>> 233
>> 234 G4double theTimeChange;
>> 235 // The changed (final) global time of a given track
>> 236
>> 237 G4double theProperTimeChange;
>> 238 // The changed (final) proper time of a given track
>> 239
>> 240 // Obsolete Mar 2007
>> 241 // G4double theWeightChange;
>> 242 // The Changed (final) weight of a given track
>> 243
>> 244 G4double theMassChange;
>> 245 // The Changed (final) mass of a given track
>> 246
>> 247 G4double theChargeChange;
>> 248 // The Changed (final) charge of a given track
>> 249
>> 250 G4double theMagneticMomentChange;
>> 251 // The Changed (final) MagneticMoment of a given track
>> 252
>> 253 const G4Track* theCurrentTrack;
>> 254
>> 255 public:
>> 256 // for Debug
>> 257 virtual G4bool CheckIt(const G4Track&);
>> 258 };
>> 259
>> 260 #include "G4ParticleChange.icc"
>> 261
>> 262 #endif
>> 263
>> 264
>> 265
>> 266
>> 267
194 268
195 G4double theEnergyChange = 0.0; <<
196 // The final kinetic energy of the curre <<
197 269
198 G4double theVelocityChange = 0.0; <<
199 G4bool isVelocityChanged = false; <<
200 // The final velocity of the current tra <<
201 270
202 G4ThreeVector thePositionChange; <<
203 // The changed (final) position of a giv <<
204 271
205 G4double theGlobalTime0 = 0.0; <<
206 // The global time at Initial <<
207 G4double theLocalTime0 = 0.0; <<
208 // The local time at Initial <<
209 272
210 G4double theTimeChange = 0.0; <<
211 // The change of local time of a given p <<
212 273
213 G4double theProperTimeChange = 0.0; <<
214 // The changed (final) proper time of a <<
215 274
216 G4double theMassChange = 0.0; <<
217 // The Changed (final) mass of a given t <<
218 275
219 G4double theChargeChange = 0.0; <<
220 // The Changed (final) charge of a given <<
221 276
222 G4double theMagneticMomentChange = 0.0; <<
223 // The Changed (final) MagneticMoment of <<
224 }; <<
225 277
226 #include "G4ParticleChange.icc" <<
227 278
228 #endif <<
229 279