Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/track/include/G4ParticleChange.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

Diff markup

Differences between /track/include/G4ParticleChange.hh (Version 11.3.0) and /track/include/G4ParticleChange.hh (Version 3.2)


  1 //                                                  1 //
  2 // *******************************************      2 // ********************************************************************
  3 // * License and Disclaimer                    <<   3 // * DISCLAIMER                                                       *
  4 // *                                                4 // *                                                                  *
  5 // * The  Geant4 software  is  copyright of th <<   5 // * The following disclaimer summarizes all the specific disclaimers *
  6 // * the Geant4 Collaboration.  It is provided <<   6 // * of contributors to this software. The specific disclaimers,which *
  7 // * conditions of the Geant4 Software License <<   7 // * govern, are listed with their locations in:                      *
  8 // * LICENSE and available at  http://cern.ch/ <<   8 // *   http://cern.ch/geant4/license                                  *
  9 // * include a list of copyright holders.      << 
 10 // *                                                9 // *                                                                  *
 11 // * Neither the authors of this software syst     10 // * Neither the authors of this software system, nor their employing *
 12 // * institutes,nor the agencies providing fin     11 // * institutes,nor the agencies providing financial support for this *
 13 // * work  make  any representation or  warran     12 // * work  make  any representation or  warranty, express or implied, *
 14 // * regarding  this  software system or assum     13 // * regarding  this  software system or assume any liability for its *
 15 // * use.  Please see the license in the file  <<  14 // * use.                                                             *
 16 // * for the full disclaimer and the limitatio << 
 17 // *                                               15 // *                                                                  *
 18 // * This  code  implementation is the result  <<  16 // * This  code  implementation is the  intellectual property  of the *
 19 // * technical work of the GEANT4 collaboratio <<  17 // * GEANT4 collaboration.                                            *
 20 // * By using,  copying,  modifying or  distri <<  18 // * By copying,  distributing  or modifying the Program (or any work *
 21 // * any work based  on the software)  you  ag <<  19 // * based  on  the Program)  you indicate  your  acceptance of  this *
 22 // * use  in  resulting  scientific  publicati <<  20 // * statement, and all its terms.                                    *
 23 // * acceptance of all terms of the Geant4 Sof << 
 24 // *******************************************     21 // ********************************************************************
 25 //                                                 22 //
 26 // G4ParticleChange                            << 
 27 //                                                 23 //
 28 // Class description:                          <<  24 // $Id: G4ParticleChange.hh,v 1.6.4.2 2001/06/28 20:20:14 gunter Exp $
                                                   >>  25 // GEANT4 tag $Name:  $
 29 //                                                 26 //
 30 // Concrete class for ParticleChange containin <<  27 // 
 31 // invocation of a physics process.            <<  28 // ------------------------------------------------------------
 32 // This includes final states of parent partic <<  29 //  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 //                                                 30 //
 39 // IMPORTANT NOTE: Despite the name, what this <<  31 // 
 40 // through its methods, are the "FINAL" values <<  32 // ------------------------------------------------------------
 41 // Momentum, etc.                              <<  33 //   Implemented for the new scheme                 23 Mar. 1998  H.Kurahige
 42                                                <<  34 //
 43 // Author: Hisaya Kurashige, 23 March 1998     <<  35 // Class Description
 44 // ------------------------------------------- <<  36 //  This class is a concrete class for ParticleChange which
 45 #ifndef G4ParticleChange_hh                    <<  37 //  has all functionality in old scheme.
 46 #define G4ParticleChange_hh 1                  <<  38 //-
                                                   >>  39 //  This class contains the results after invocation of a physics process.
                                                   >>  40 //  This includes final states of parent particle (momentum, energy,
                                                   >>  41 //  etc) and secondary particles generated by the interaction.
                                                   >>  42 //  The tracking assumes that all the values of energy and
                                                   >>  43 //  momentum are in global reference system, therefore all the
                                                   >>  44 //  needed Lorentz transformations must have been already Done
                                                   >>  45 //  when filling the data-members of this class.
                                                   >>  46 //-
                                                   >>  47 //  ---------------------------------------------------------------
                                                   >>  48 //  IMPORTANT NOTE: Although the name of the class and methods are
                                                   >>  49 //   "Change", what it stores (and returns in get) are the "FINAL" 
                                                   >>  50 //   values of the Position, Momentum, etc.
                                                   >>  51 // 
                                                   >>  52 //  ------------------------------------------------------------
                                                   >>  53 //  modify AddSecondary methods for "GoodForTracking" flag 
                                                   >>  54 //                                                 8 June 1998 H.Kurashige
                                                   >>  55 //   Add Track weight                              12 Nov. 1998  H.Kurashige
                                                   >>  56 //   Add Get/SetMomentumDirectionChange             6 Feb. 1999 H.Kurashige 
                                                   >>  57 //   Add get/SetDynamicMass                        5 Oct. 1999 H.Kurashige
                                                   >>  58 //   Add get/SetDynamicCharge                       5 Oct. 1999 H.Kurashige
                                                   >>  59 // -------------------------------------------------------------
                                                   >>  60  
                                                   >>  61 #ifndef G4ParticleChange_h
                                                   >>  62 #define G4ParticleChange_h 1
 47                                                    63 
 48 #include "globals.hh"                              64 #include "globals.hh"
 49 #include "G4ios.hh"                                65 #include "G4ios.hh"
 50 #include "G4ThreeVector.hh"                        66 #include "G4ThreeVector.hh"
 51 #include "G4VParticleChange.hh"                <<  67 #include "G4ThreeVector.hh"
 52                                                << 
 53 class G4DynamicParticle;                           68 class G4DynamicParticle;
                                                   >>  69 #include "G4VParticleChange.hh"
 54                                                    70 
 55 class G4ParticleChange : public G4VParticleCha <<  71 class G4ParticleChange: public G4VParticleChange
 56 {                                              <<  72 { 
 57   public:                                          73   public:
 58                                                <<  74     // default constructor
 59     G4ParticleChange();                            75     G4ParticleChange();
 60       // Default constructor                   <<  76     G4ParticleChange(G4bool useEB);
                                                   >>  77 
                                                   >>  78     // destructor
                                                   >>  79     virtual ~G4ParticleChange();
                                                   >>  80 
                                                   >>  81   protected:
                                                   >>  82     // hide copy constructor and assignment operaor as protected
                                                   >>  83     G4ParticleChange(const G4ParticleChange &right);
                                                   >>  84     G4ParticleChange & operator=(const G4ParticleChange &right);
 61                                                    85 
 62     ~G4ParticleChange() override = default;    <<  86   public:
 63       // Destructor                            <<  87     // equal/unequal operator
                                                   >>  88     G4bool operator==(const G4ParticleChange &right) const;
                                                   >>  89     G4bool operator!=(const G4ParticleChange &right) const;
                                                   >>  90 
                                                   >>  91   public: // with description
                                                   >>  92     // ----------------------------------------------------
                                                   >>  93     // --- the following methods are for updating G4Step -----   
                                                   >>  94     // Return the pointer to the G4Step after updating the Step information
                                                   >>  95     // by using final state information of the track given by a physics
                                                   >>  96     // process    
                                                   >>  97     virtual G4Step* UpdateStepForAlongStep(G4Step* Step);
                                                   >>  98     // A physics process gives the final state of the particle 
                                                   >>  99     // relative to the initial state at the beginning of the Step,
                                                   >> 100     // i.e., based on information of G4Track (or equivalently 
                                                   >> 101     // the PreStepPoint)
                                                   >> 102     // In this method, the differences (delta) between these two states 
                                                   >> 103     // are calculated, and are accumulated in PostStepPoint.
                                                   >> 104     // Take note that the return type of GetMomentumChange is a
                                                   >> 105     // pointer to G4ParticleMometum. Also it is a normalized 
                                                   >> 106     // momentum vector.
                                                   >> 107     virtual G4Step* UpdateStepForAtRest(G4Step* Step);
                                                   >> 108     virtual G4Step* UpdateStepForPostStep(G4Step* Step);
                                                   >> 109     // A physics process gives the final state of the particle 
                                                   >> 110     // based on information of G4Track (or equivalently the PreStepPoint)
                                                   >> 111  
                                                   >> 112     virtual void Initialize(const G4Track&);
                                                   >> 113     // Initialize all propoerties by using G4Track information
 64                                                   114 
 65     G4ParticleChange(const G4ParticleChange& r << 115   protected: // with description
 66     G4ParticleChange& operator=(const G4Partic << 116     G4Step* UpdateStepInfo(G4Step* Step);
                                                   >> 117     //  Update the G4Step specific attributes 
                                                   >> 118     //  (i.e. SteppingControl, LocalEnergyDeposit, and TrueStepLength)
 67                                                   119 
 68   // --- the following methods are for updatin << 120   public:     // with description
 69   // Return the pointer to G4Step after updati << 121     
 70   // by using final state of the track given b << 122     // ----------------------------------------------------
 71                                                << 123     //--- methods to keep information of the final state--
 72     G4Step* UpdateStepForAlongStep(G4Step* Ste << 124     //  IMPORTANT NOTE: Although the name of the class and methods are
 73       // A physics process gives the final sta << 125     //   "Change", what it stores (and returns in get) are the "FINAL" 
 74       // relative to the initial state at the  << 126     //   values of the Position, Momentum, etc.
 75       // i.e., based on information of G4Track << 127 
 76       // the PreStepPoint).                    << 128     const G4ThreeVector* GetMomentumDirectionChange() const;
 77       // In this method, the differences (delt << 129     void SetMomentumDirectionChange(G4double Px, G4double Py, G4double Pz);
 78       // are calculated, and are accumulated i << 130     void SetMomentumDirectionChange(const G4ThreeVector& Pfinal);
 79       // Take note that the return type of Get << 131     const G4ThreeVector* GetMomentumChange() const;
 80       // pointer to G4ParticleMomentum. Also i << 132     void SetMomentumChange(G4double Px, G4double Py, G4double Pz);
 81       // momentum vector                       << 133     void SetMomentumChange(const G4ThreeVector& Pfinal);
 82                                                << 134     // Get/Set theMomentumDirectionChange vector: it is the final momentum direction.
 83     G4Step* UpdateStepForAtRest(G4Step* Step)  << 135 
 84     G4Step* UpdateStepForPostStep(G4Step* Step << 136     const G4ThreeVector* GetPolarizationChange() const;
 85       // A physics process gives the final sta << 137     void SetPolarizationChange(G4double Px, G4double Py, G4double Pz);
 86       // based on information of G4Track (or e << 138     void SetPolarizationChange(const G4ThreeVector& finalPoralization);
 87                                                << 139     // Get/Set thePolarizationChange vector.
 88     void Initialize(const G4Track&) override;  << 140 
 89       // Initialize all propoerties by using G << 141     G4double GetEnergyChange() const;
 90                                                << 142     void SetEnergyChange(G4double theEnergyChange);
 91   // --- methods to keep information of the fi << 143     // Get/Set the final kinetic energy of the current particle.
 92   //                                           << 144 
 93   //  The ProposeXXX methods store (and return << 145     G4double GetProperTimeChange() const;
 94   //  the "FINAL" values of the Position, Mome << 146     void SetProperTimeChange(G4double t);
 95                                                << 147     //  Get/Set theProperTimeChange vector
 96     inline const G4ThreeVector* GetMomentumDir << 148 
 97     inline void ProposeMomentumDirection(G4dou << 149     const G4ThreeVector* GetPositionChange() const;
 98     inline void ProposeMomentumDirection(const << 150     void SetPositionChange(G4double x, G4double y, G4double z);
 99       // Get/Propose the MomentumDirection vec << 151     void SetPositionChange(const G4ThreeVector& finalPosition);
100       // direction                             << 152     //  Get/Set the final position of the current particle.
101                                                << 153 
102     inline const G4ThreeVector* GetPolarizatio << 154     G4double GetTimeChange() const;
103     inline void ProposePolarization(G4double P << 155     void SetTimeChange(G4double t);
104     inline void ProposePolarization(const G4Th << 156     //  Get/Set theTimeChange vector.
105       // Get/Propose the final Polarization ve << 157  
106                                                << 158     G4double GetMassChange() const;
107     inline G4double GetEnergy() const;         << 159     void SetMassChange(G4double mass);
108     inline void ProposeEnergy(G4double finalEn << 160     //   Get/Set theMassChange 
109       // Get/Propose the final kinetic energy  << 161 
110                                                << 162     G4double GetChargeChange() const;
111     inline G4double GetVelocity() const;       << 163     void SetChargeChange(G4double mass);
112     inline void ProposeVelocity(G4double final << 164     //   Get/Set theChargeChange 
113       // Get/Propose the final velocity of the << 165   
114                                                << 166     G4double GetWeightChange() const;
115     inline G4double GetProperTime() const;     << 167     void SetWeightChange(G4double w);
116     inline void ProposeProperTime(G4double fin << 168     //   Get/Set theWeightChange 
117       // Get/Propose the final ProperTime      << 169 
118                                                << 170     //  -- Utility functions --
119     inline const G4ThreeVector* GetPosition()  << 171     G4ThreeVector GetGlobalPosition(const G4ThreeVector& displacement) const;
120     inline void ProposePosition(G4double x, G4 << 172     //  Convert the position displacement to the global position.
121     inline void ProposePosition(const G4ThreeV << 173 
122       // Get/Propose the final position of the << 174     G4double GetGlobalTime(G4double timeDelay) const;
123                                                << 175     //  Convert the time delay to the global time.
124     inline void ProposeGlobalTime(G4double t); << 176 
125     inline void ProposeLocalTime(G4double t);  << 177     G4ThreeVector CalcMomentum(G4double           energy,
126       // Get/Propose the final global/local Ti << 178              G4ThreeVector direction,
127       // NOTE: DO NOT INVOKE both methods in a << 179              G4double           mass      ) const;
128       //       Each method affects both local  << 180     //  Calculate momentum by using Energy, Momentum Direction, and Mass 
129                                                << 181     // ----------------------------------------------------
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 
                                                   >> 243   public:
                                                   >> 244     // these methods is used for switch on/off EB in all ParticleChange objects
                                                   >> 245     static void SwOnAllEB();
                                                   >> 246     static void SwOffAllEB();
                                                   >> 247 
                                                   >> 248   private:
                                                   >> 249     static G4bool fUseEBForAll;
                                                   >> 250 
                                                   >> 251   public:
                                                   >> 252     // for Debug 
                                                   >> 253     virtual G4bool CheckIt(const G4Track&);
                                                   >> 254 };
                                                   >> 255 
                                                   >> 256 #include "G4ParticleChange.icc"
                                                   >> 257 
                                                   >> 258 #endif
                                                   >> 259 
                                                   >> 260 
                                                   >> 261 
                                                   >> 262 
                                                   >> 263 
194                                                   264 
195     G4double theEnergyChange = 0.0;            << 
196       // The final kinetic energy of the curre << 
197                                                   265 
198     G4double theVelocityChange = 0.0;          << 
199     G4bool isVelocityChanged = false;          << 
200       // The final velocity of the current tra << 
201                                                   266 
202     G4ThreeVector thePositionChange;           << 
203       // The changed (final) position of a giv << 
204                                                   267 
205     G4double theGlobalTime0 = 0.0;             << 
206       // The global time at Initial            << 
207     G4double theLocalTime0 = 0.0;              << 
208       // The local time at Initial             << 
209                                                   268 
210     G4double theTimeChange = 0.0;              << 
211       // The change of local time of a given p << 
212                                                   269 
213     G4double theProperTimeChange = 0.0;        << 
214       // The changed (final) proper time of a  << 
215                                                   270 
216     G4double theMassChange = 0.0;              << 
217       // The Changed (final) mass of a given t << 
218                                                   271 
219     G4double theChargeChange = 0.0;            << 
220      // The Changed (final) charge of a given  << 
221                                                   272 
222     G4double theMagneticMomentChange = 0.0;    << 
223      // The Changed (final) MagneticMoment of  << 
224 };                                             << 
225                                                   273 
226 #include "G4ParticleChange.icc"                << 
227                                                   274 
228 #endif                                         << 
229                                                   275