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.12 2006/06/29 21:14:15 gunter Exp $ >> 28 // GEANT4 tag $Name: geant4-08-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 // ------------------------------------------------------------- >> 63 >> 64 #ifndef G4ParticleChange_h >> 65 #define G4ParticleChange_h 1 47 66 48 #include "globals.hh" 67 #include "globals.hh" 49 #include "G4ios.hh" 68 #include "G4ios.hh" 50 #include "G4ThreeVector.hh" 69 #include "G4ThreeVector.hh" 51 #include "G4VParticleChange.hh" << 70 #include "G4ThreeVector.hh" 52 << 53 class G4DynamicParticle; 71 class G4DynamicParticle; >> 72 #include "G4VParticleChange.hh" 54 73 55 class G4ParticleChange : public G4VParticleCha << 74 class G4ParticleChange: public G4VParticleChange 56 { << 75 { 57 public: 76 public: 58 << 77 // default constructor 59 G4ParticleChange(); 78 G4ParticleChange(); 60 // Default constructor << 79 // G4ParticleChange(G4bool useEB); >> 80 >> 81 // destructor >> 82 virtual ~G4ParticleChange(); >> 83 >> 84 protected: >> 85 // hide copy constructor and assignment operaor as protected >> 86 G4ParticleChange(const G4ParticleChange &right); >> 87 G4ParticleChange & operator=(const G4ParticleChange &right); 61 88 62 ~G4ParticleChange() override = default; << 89 public: 63 // Destructor << 90 // equal/unequal operator >> 91 G4bool operator==(const G4ParticleChange &right) const; >> 92 G4bool operator!=(const G4ParticleChange &right) const; >> 93 >> 94 public: // with description >> 95 // ---------------------------------------------------- >> 96 // --- the following methods are for updating G4Step ----- >> 97 // Return the pointer to the G4Step after updating the Step information >> 98 // by using final state information of the track given by a physics >> 99 // process >> 100 virtual G4Step* UpdateStepForAlongStep(G4Step* Step); >> 101 // A physics process gives the final state of the particle >> 102 // relative to the initial state at the beginning of the Step, >> 103 // i.e., based on information of G4Track (or equivalently >> 104 // the PreStepPoint) >> 105 // In this method, the differences (delta) between these two states >> 106 // are calculated, and are accumulated in PostStepPoint. >> 107 // Take note that the return type of GetMomentumChange is a >> 108 // pointer to G4ParticleMometum. Also it is a normalized >> 109 // momentum vector. >> 110 virtual G4Step* UpdateStepForAtRest(G4Step* Step); >> 111 virtual G4Step* UpdateStepForPostStep(G4Step* Step); >> 112 // A physics process gives the final state of the particle >> 113 // based on information of G4Track (or equivalently the PreStepPoint) >> 114 >> 115 virtual void Initialize(const G4Track&); >> 116 // Initialize all propoerties by using G4Track information 64 117 65 G4ParticleChange(const G4ParticleChange& r << 118 protected: // with description 66 G4ParticleChange& operator=(const G4Partic << 119 G4Step* UpdateStepInfo(G4Step* Step); >> 120 // Update the G4Step specific attributes >> 121 // (i.e. SteppingControl, LocalEnergyDeposit, and TrueStepLength) 67 122 68 // --- the following methods are for updatin << 123 public: // with description 69 // Return the pointer to G4Step after updati << 124 70 // by using final state of the track given b << 125 // ---------------------------------------------------- 71 << 126 //--- methods to keep information of the final state-- 72 G4Step* UpdateStepForAlongStep(G4Step* Ste << 127 // IMPORTANT NOTE: 73 // A physics process gives the final sta << 128 // These ProposeXXX methods stores (and returns in GetXXX methods) 74 // relative to the initial state at the << 129 // the "FINAL" values of the Position, Momentum, etc. 75 // i.e., based on information of G4Track << 130 76 // the PreStepPoint). << 131 const G4ThreeVector* GetMomentumDirection() const; 77 // In this method, the differences (delt << 132 void ProposeMomentumDirection(G4double Px, G4double Py, G4double Pz); 78 // are calculated, and are accumulated i << 133 void ProposeMomentumDirection(const G4ThreeVector& Pfinal); 79 // Take note that the return type of Get << 134 // Get/Propose the MomentumDirection vector: it is the final momentum direction. 80 // pointer to G4ParticleMomentum. Also i << 135 81 // momentum vector << 136 const G4ThreeVector* GetPolarization() const; 82 << 137 void ProposePolarization(G4double Px, G4double Py, G4double Pz); 83 G4Step* UpdateStepForAtRest(G4Step* Step) << 138 void ProposePolarization(const G4ThreeVector& finalPoralization); 84 G4Step* UpdateStepForPostStep(G4Step* Step << 139 // Get/Propose the final Polarization vector. 85 // A physics process gives the final sta << 140 86 // based on information of G4Track (or e << 141 G4double GetEnergy() const; 87 << 142 void ProposeEnergy(G4double finalEnergy); 88 void Initialize(const G4Track&) override; << 143 // Get/Propose the final kinetic energy of the current particle. 89 // Initialize all propoerties by using G << 144 90 << 145 G4double GetProperTime() const; 91 // --- methods to keep information of the fi << 146 void ProposeProperTime(G4double finalProperTime); 92 // << 147 // Get/Propose th final eProperTime 93 // The ProposeXXX methods store (and return << 148 94 // the "FINAL" values of the Position, Mome << 149 const G4ThreeVector* GetPosition() const; 95 << 150 void ProposePosition(G4double x, G4double y, G4double z); 96 inline const G4ThreeVector* GetMomentumDir << 151 void ProposePosition(const G4ThreeVector& finalPosition); 97 inline void ProposeMomentumDirection(G4dou << 152 // Get/Propose the final position of the current particle. 98 inline void ProposeMomentumDirection(const << 153 99 // Get/Propose the MomentumDirection vec << 154 G4double GetGlobalTime() const; 100 // direction << 155 void ProposeGlobalTime(G4double finalGlobalTime); 101 << 156 // Get/Propose the final GlobalTime 102 inline const G4ThreeVector* GetPolarizatio << 157 103 inline void ProposePolarization(G4double P << 158 G4double GetMass() const; 104 inline void ProposePolarization(const G4Th << 159 void ProposeMass(G4double finalMass); 105 // Get/Propose the final Polarization ve << 160 // Get/Propose the final dynamical Mass in G4DynamicParticle 106 << 161 107 inline G4double GetEnergy() const; << 162 G4double GetCharge() const; 108 inline void ProposeEnergy(G4double finalEn << 163 void ProposeCharge(G4double finalCharge); 109 // Get/Propose the final kinetic energy << 164 // Get/Propose the final dynamical Charge in G4DynamicParticl 110 << 165 111 inline G4double GetVelocity() const; << 166 G4double GetWeight() const; 112 inline void ProposeVelocity(G4double final << 167 void ProposeWeight(G4double finalWeight); 113 // Get/Propose the final velocity of the << 168 // Get/Propose the final Weight of the current particle 114 << 169 115 inline G4double GetProperTime() const; << 170 // -- Utility functions -- 116 inline void ProposeProperTime(G4double fin << 171 G4ThreeVector GetGlobalPosition(const G4ThreeVector& displacement) const; 117 // Get/Propose the final ProperTime << 172 // Convert the position displacement to the global position. 118 << 173 119 inline const G4ThreeVector* GetPosition() << 174 G4double GetGlobalTime(G4double timeDelay) const; 120 inline void ProposePosition(G4double x, G4 << 175 // Convert the time delay to the global time. 121 inline void ProposePosition(const G4ThreeV << 176 122 // Get/Propose the final position of the << 177 G4ThreeVector CalcMomentum(G4double energy, 123 << 178 G4ThreeVector direction, 124 inline void ProposeGlobalTime(G4double t); << 179 G4double mass ) const; 125 inline void ProposeLocalTime(G4double t); << 180 // Calculate momentum by using Energy, Momentum Direction, and Mass 126 // Get/Propose the final global/local Ti << 181 // ---------------------------------------------------- 127 // NOTE: DO NOT INVOKE both methods in a << 128 // Each method affects both local << 129 << 130 inline G4double GetGlobalTime(G4double tim << 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 182 155 // --- methods for adding secondaries --- << 156 183 >> 184 // ---------------------------------------------------- >> 185 // --- methods for adding secondaries 157 void AddSecondary(G4Track* aSecondary); 186 void AddSecondary(G4Track* aSecondary); 158 // Add a secondary particle to theListOf << 187 // Add a secondary particle to theListOfSecondaries. 159 188 160 void AddSecondary(G4DynamicParticle* aSeco 189 void AddSecondary(G4DynamicParticle* aSecondary, 161 G4bool IsGoodForTracking << 190 G4bool IsGoodForTracking = false ); 162 // Add a secondary particle to theListOf << 191 // Add a secondary particle to theListOfSecondaries. 163 // Position and time are same as thePosi << 192 // position and time are same as thePositionChange and theTimeChange 164 << 193 165 void AddSecondary(G4DynamicParticle* aSeco << 194 void AddSecondary(G4DynamicParticle* aSecondary, 166 G4bool IsGoodForTracking << 195 G4ThreeVector position, 167 // Add a secondary particle to theListOf << 196 G4bool IsGoodForTracking = false ); 168 // Global time are same as theTimeChange << 197 // Add a secondary particle to theListOfSecondaries. 169 << 198 // global time are same as theTimeChange and theTimeChange 170 void AddSecondary(G4DynamicParticle* aSeco << 199 171 G4bool IsGoodForTracking << 200 void AddSecondary(G4DynamicParticle* aSecondary, 172 // Add a secondary particle to theListOf << 201 G4double time, 173 // Position and are same as thePositionC << 202 G4bool IsGoodForTracking = false ); 174 << 203 // Add a secondary particle to theListOfSecondaries. 175 // --- Dump and debug methods --- << 204 // position and are same as thePositionChange >> 205 // ---------------------------------------------------- 176 206 177 void DumpInfo() const override; << 207 public: >> 208 virtual void DumpInfo() const; 178 209 179 protected: 210 protected: 180 << 181 G4Step* UpdateStepInfo(G4Step* Step); << 182 // Update the G4Step specific attributes << 183 // (i.e. SteppingControl, LocalEnergyDep << 184 << 185 G4ThreeVector theMomentumDirectionChange; 211 G4ThreeVector theMomentumDirectionChange; 186 // It is the vector containing the final << 212 // It is the vector containing the final momentum direction 187 // after the invoked process. The applic << 213 // after the invoked process. The application of the change 188 // of the momentum direction of the part << 214 // of the momentum direction of the particle is not Done here. 189 // The responsibility to apply the chang << 215 // The responsibility to apply the change is up the entity 190 // which invoked the process << 216 // which invoked the process. 191 217 192 G4ThreeVector thePolarizationChange; 218 G4ThreeVector thePolarizationChange; 193 // The changed (final) polarization of a << 219 // The changed (final) polarization of a given track >> 220 >> 221 G4double theEnergyChange; >> 222 // The final kinetic energy of the current track >> 223 >> 224 G4ThreeVector thePositionChange; >> 225 // The changed (final) position of a given track >> 226 >> 227 G4double theTimeChange; >> 228 // The changed (final) global time of a given track >> 229 >> 230 G4double theProperTimeChange; >> 231 // The changed (final) proper time of a given track >> 232 >> 233 G4double theWeightChange; >> 234 // The Changed (final) weight of a given track >> 235 >> 236 G4double theMassChange; >> 237 // The Changed (final) mass of a given track >> 238 >> 239 G4double theChargeChange; >> 240 // The Changed (final) charge of a given track >> 241 >> 242 const G4Track* theCurrentTrack; >> 243 >> 244 public: >> 245 // for Debug >> 246 virtual G4bool CheckIt(const G4Track&); >> 247 }; >> 248 >> 249 #include "G4ParticleChange.icc" >> 250 >> 251 #endif >> 252 >> 253 >> 254 >> 255 >> 256 194 257 195 G4double theEnergyChange = 0.0; << 196 // The final kinetic energy of the curre << 197 258 198 G4double theVelocityChange = 0.0; << 199 G4bool isVelocityChanged = false; << 200 // The final velocity of the current tra << 201 259 202 G4ThreeVector thePositionChange; << 203 // The changed (final) position of a giv << 204 260 205 G4double theGlobalTime0 = 0.0; << 206 // The global time at Initial << 207 G4double theLocalTime0 = 0.0; << 208 // The local time at Initial << 209 261 210 G4double theTimeChange = 0.0; << 211 // The change of local time of a given p << 212 262 213 G4double theProperTimeChange = 0.0; << 214 // The changed (final) proper time of a << 215 263 216 G4double theMassChange = 0.0; << 217 // The Changed (final) mass of a given t << 218 264 219 G4double theChargeChange = 0.0; << 220 // The Changed (final) charge of a given << 221 265 222 G4double theMagneticMomentChange = 0.0; << 223 // The Changed (final) MagneticMoment of << 224 }; << 225 266 226 #include "G4ParticleChange.icc" << 227 267 228 #endif << 229 268