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 // G4Step << 27 // 26 // 28 // Class description: << 27 // $Id: G4Step.hh,v 1.16 2006/10/30 09:50:13 kurasige Exp $ >> 28 // GEANT4 tag $Name: geant4-08-03-patch-01 $ 29 // 29 // 30 // This class represents the Step of a particl << 30 // 31 // It includes information of: << 31 //--------------------------------------------------------------- >> 32 // >> 33 // G4Step.hh >> 34 // >> 35 // Class Description: >> 36 // This class represents the Step of a particle tracked. >> 37 // It includes information of 32 // 1) List of Step points which compose th 38 // 1) List of Step points which compose the Step, 33 // 2) static information of particle which << 39 // 2) static information of particle which generated the >> 40 // Step, 34 // 3) trackID and parent particle ID of th 41 // 3) trackID and parent particle ID of the Step, 35 // 4) termination condition of the Step. << 42 // 4) termination condition of the Step, 36 << 43 // 37 // Authors: << 44 // Contact: 38 // Katsuya Amako (e-mail: Katsuya.Amako@kek << 45 // Questions and comments to this code should be sent to 39 // Takashi Sasaki (e-mail: Takashi.Sasaki@ke << 46 // Katsuya Amako (e-mail: Katsuya.Amako@kek.jp) 40 // Revisions: << 47 // Takashi Sasaki (e-mail: Takashi.Sasaki@kek.jp) 41 // Hisaya Kurashige, 1998-2007 << 48 // 42 // ------------------------------------------- << 49 // --------------------------------------------------------------- 43 #ifndef G4Step_hh << 50 // Modified for the new G4ParticleChange 12 Mar. 1998 H.Kurahige 44 #define G4Step_hh 1 << 51 // Correct treatment of touchable in G4Step::UpdateTrack 45 << 52 // 12 May. 1998 H.Kurashige 46 #include <cstdlib> // Include fr << 53 // --------------------------------------------------------------- 47 #include <cmath> // Include fr << 54 // Separate implementation of inline functions inti G4Step.icc 48 #include "G4ios.hh" // Include fr << 55 // Add updating mass/charge 49 #include <iomanip> // Include fr << 56 // 6 Oct. 1999 H.Kurashige 50 #include "globals.hh" // Include fr << 57 // Repository test - Dennis Wright 51 #include "G4ThreeVector.hh" // Include fr << 58 // 52 #include "G4VPhysicalVolume.hh" // Include fr << 59 #ifndef G4Step_h 53 #include "G4StepPoint.hh" // Include fr << 60 #define G4Step_h 1 54 #include "G4StepStatus.hh" // Include fr << 55 #include "G4TrackVector.hh" // Include fr << 56 61 57 class G4Polyline; // Forward de << 62 #include <stdlib.h> // Include from 'system' 58 class G4Track; // Forward de << 63 #include <cmath> // Include from 'system' >> 64 #include "G4ios.hh" // Include from 'system' >> 65 #include <iomanip> // Include from 'system' >> 66 #include "globals.hh" // Include from 'global' >> 67 #include "G4ThreeVector.hh" // Include from 'global' >> 68 #include "G4VPhysicalVolume.hh" // Include from 'geometry' >> 69 #include "G4StepPoint.hh" // Include from 'track' >> 70 #include "G4StepStatus.hh" // Include from 'track' >> 71 class G4Polyline; // Forward declaration. >> 72 class G4Track; // Forward declaration. >> 73 #include "G4TrackVector.hh" // Include from 'tracking' 59 74 >> 75 //////////// 60 class G4Step 76 class G4Step >> 77 //////////// 61 { 78 { 62 public: << 63 G4Step(); << 64 ~G4Step(); << 65 // Constructor/Destructor << 66 79 67 G4Step(const G4Step&); << 80 //-------- 68 G4Step& operator=(const G4Step&); << 81 public: 69 // Copy Constructor and assignment opera << 70 << 71 inline G4Track* GetTrack() const; << 72 inline void SetTrack(G4Track* value); << 73 // Current track << 74 << 75 inline G4StepPoint* GetPreStepPoint() cons << 76 inline void SetPreStepPoint(G4StepPoint* v << 77 inline G4StepPoint* ResetPreStepPoint(G4St << 78 // Pre-Step points << 79 // If Set method is invoked, the previou << 80 // If Reset method is invoked, the previ << 81 // but its pointer is returned. Thus it' << 82 // properly delete it. << 83 << 84 inline G4StepPoint* GetPostStepPoint() con << 85 inline void SetPostStepPoint(G4StepPoint* << 86 inline G4StepPoint* ResetPostStepPoint(G4S << 87 // Post-Step points << 88 // If Set method is invoked, the previou << 89 // If Reset method is invoked, the previ << 90 // but its pointer is returned. Thus it' << 91 // properly delete it. << 92 << 93 inline G4double GetStepLength() const; << 94 inline void SetStepLength(G4double value); << 95 // Before the end of the AlongStepDoIt l << 96 // the initial value which is determined << 97 // proposed by a physics process. After << 98 // it will be set equal to 'StepLength' << 99 << 100 inline G4double GetTotalEnergyDeposit() co << 101 inline void SetTotalEnergyDeposit(G4double << 102 // Total energy deposit << 103 << 104 inline G4double GetNonIonizingEnergyDeposi << 105 inline void SetNonIonizingEnergyDeposit(G4 << 106 // Total non-ionizing energy deposit << 107 << 108 inline G4SteppingControl GetControlFlag() << 109 inline void SetControlFlag(G4SteppingContr << 110 // Control flag for stepping << 111 << 112 inline void AddTotalEnergyDeposit(G4double << 113 inline void ResetTotalEnergyDeposit(); << 114 // Manipulation of total energy deposit << 115 << 116 inline void AddNonIonizingEnergyDeposit(G4 << 117 inline void ResetNonIonizingEnergyDeposit( << 118 // Manipulation of non-ionizing energy d << 119 << 120 inline G4bool IsFirstStepInVolume() const; << 121 inline G4bool IsLastStepInVolume() const; << 122 << 123 inline void SetFirstStepFlag(); << 124 inline void ClearFirstStepFlag(); << 125 inline void SetLastStepFlag(); << 126 inline void ClearLastStepFlag(); << 127 // Get/Set/Clear flag for initial/last s << 128 // NOTE: flags are not used << 129 << 130 inline G4ThreeVector GetDeltaPosition() co << 131 inline G4double GetDeltaTime() const; << 132 // Difference of position, time, momentu << 133 << 134 inline G4ThreeVector GetDeltaMomentum() co << 135 inline G4double GetDeltaEnergy() const; << 136 // These methods provide difference betw << 137 // at a step, it is incorrect to use the << 138 // deposition in media during the step, << 139 // be produced. For energy deposition us << 140 << 141 inline void InitializeStep(G4Track* aValue << 142 // Initialize contents of G4Step << 143 << 144 inline void UpdateTrack(); << 145 // Update track by using G4Step informat << 146 << 147 inline void CopyPostToPreStepPoint(); << 148 // Copy PostStepPoint to PreStepPoint << 149 << 150 inline void SetPointerToVectorOfAuxiliaryP << 151 inline std::vector<G4ThreeVector>* GetPoin << 152 // Auxiliary points modifiers << 153 << 154 // --- Secondary buckets --- << 155 << 156 inline std::size_t GetNumberOfSecondariesI << 157 // Secondaries in the current step << 158 << 159 const std::vector<const G4Track*>* GetSeco << 160 << 161 inline const G4TrackVector* GetSecondary() << 162 inline G4TrackVector* GetfSecondary(); << 163 inline G4TrackVector* NewSecondaryVector() << 164 // NOTE: Secondary bucket of the Step co << 165 // all secondaries during tracking << 166 // (i.e. NOT secondaries produced << 167 // all these methods give same object (i << 168 // but 2nd one will create bucket in add << 169 << 170 inline void DeleteSecondaryVector(); << 171 // Just delete secondary bucket << 172 // NOTE: G4Track objects inside the buck << 173 << 174 inline void SetSecondary(G4TrackVector* va << 175 // Add secondary tracks to the bucket << 176 << 177 protected: << 178 << 179 G4double fTotalEnergyDeposit = 0.0; << 180 // Accumulated total energy deposit in t << 181 << 182 G4double fNonIonizingEnergyDeposit = 0.0; << 183 // Accumulated non-ionizing energy deposi << 184 << 185 private: << 186 << 187 G4StepPoint* fpPreStepPoint = nullptr; << 188 G4StepPoint* fpPostStepPoint = nullptr; << 189 G4double fStepLength = 0.0; << 190 // Step length which may be updated at e << 191 // AlongStepDoIt and PostStepDoIt << 192 << 193 G4Track* fpTrack = nullptr; << 194 << 195 G4SteppingControl fpSteppingControlFlag = << 196 // A flag to control SteppingManager beh << 197 << 198 G4bool fFirstStepInVolume = false; << 199 G4bool fLastStepInVolume = false; << 200 // Flags for initial/last step << 201 << 202 G4TrackVector* fSecondary = nullptr; << 203 // Secondary bucket implemented by using << 204 82 205 std::size_t nSecondaryByLastStep = 0; << 83 // Constructor/Destrcutor 206 // number of secondaries which have been << 84 G4Step(); >> 85 ~G4Step(); 207 86 208 std::vector<const G4Track*>* secondaryInCu << 87 //-------- >> 88 public: // WIth description >> 89 >> 90 // Get/Set functions >> 91 // currnet track >> 92 G4Track* GetTrack() const; >> 93 void SetTrack(G4Track* value); >> 94 >> 95 // step points >> 96 G4StepPoint* GetPreStepPoint() const; >> 97 void SetPreStepPoint(G4StepPoint* value); >> 98 >> 99 G4StepPoint* GetPostStepPoint() const; >> 100 void SetPostStepPoint(G4StepPoint* value); >> 101 >> 102 // step length >> 103 G4double GetStepLength() const; >> 104 void SetStepLength(G4double value); >> 105 >> 106 // total energy deposit >> 107 G4double GetTotalEnergyDeposit() const; >> 108 void SetTotalEnergyDeposit(G4double value); >> 109 >> 110 // cotrole flag for stepping >> 111 G4SteppingControl GetControlFlag() const; >> 112 void SetControlFlag(G4SteppingControl StepControlFlag); >> 113 >> 114 // difference of position, time, momentum and energy >> 115 G4ThreeVector GetDeltaPosition() const; >> 116 G4double GetDeltaTime() const; >> 117 >> 118 G4ThreeVector GetDeltaMomentum() const; >> 119 G4double GetDeltaEnergy() const; >> 120 >> 121 // manipulation of total energy deposit >> 122 void AddTotalEnergyDeposit(G4double value); >> 123 void ResetTotalEnergyDeposit(); >> 124 >> 125 >> 126 // Get/Set/Clear flag for initial/last step >> 127 G4bool IsFirstStepInVolume() const; >> 128 G4bool IsLastStepInVolume() const; >> 129 >> 130 void SetFirstStepFlag(); >> 131 void ClearFirstStepFlag(); >> 132 void SetLastStepFlag(); >> 133 void ClearLastStepFlag(); >> 134 >> 135 // Other member functions >> 136 void InitializeStep( G4Track* aValue ); >> 137 // initiaize contents of G4Step >> 138 >> 139 void UpdateTrack( ); >> 140 // update track by using G4Step information >> 141 >> 142 void CopyPostToPreStepPoint( ); >> 143 // copy PostStepPoint to PreStepPoint >> 144 >> 145 G4Polyline* CreatePolyline () const; >> 146 // for visualization >> 147 >> 148 //----------- >> 149 protected: >> 150 //----------- >> 151 >> 152 // Member data >> 153 G4double fTotalEnergyDeposit; >> 154 // Accummulated total energy desposit in the current Step >> 155 >> 156 //--------- >> 157 private: >> 158 //--------- >> 159 >> 160 // Member data >> 161 G4StepPoint* fpPreStepPoint; >> 162 G4StepPoint* fpPostStepPoint; >> 163 G4double fStepLength; >> 164 // Step length which may be updated at each invocation of >> 165 // AlongStepDoIt and PostStepDoIt >> 166 G4Track* fpTrack; >> 167 // >> 168 G4SteppingControl fpSteppingControlFlag; >> 169 // A flag to control SteppingManager behavier from process >> 170 >> 171 // flag for initial/last step >> 172 G4bool fFirstStepInVolume; >> 173 G4bool fLastStepInVolume; >> 174 >> 175 // Secondary buckets >> 176 public: >> 177 G4TrackVector* GetSecondary() const; >> 178 G4TrackVector* GetfSecondary(); >> 179 G4TrackVector* NewSecondaryVector(); >> 180 void DeleteSecondaryVector(); >> 181 void SetSecondary( G4TrackVector* value); >> 182 private: >> 183 G4TrackVector* fSecondary; >> 184 >> 185 // Prototyping implementation of smooth representation of curved >> 186 // trajectories. (jacek 30/10/2002) >> 187 public: >> 188 // Auxiliary points are ThreeVectors for now; change to >> 189 // G4VAuxiliaryPoints or some such (jacek 30/10/2002) >> 190 void SetPointerToVectorOfAuxiliaryPoints( std::vector<G4ThreeVector>* theNewVectorPointer ) { >> 191 fpVectorOfAuxiliaryPointsPointer = theNewVectorPointer; >> 192 } >> 193 std::vector<G4ThreeVector>* GetPointerToVectorOfAuxiliaryPoints() const { >> 194 return fpVectorOfAuxiliaryPointsPointer; >> 195 } >> 196 private: >> 197 // Explicity including the word "Pointer" in the name as I keep >> 198 // forgetting the * (jacek 30/10/2002) >> 199 std::vector<G4ThreeVector>* fpVectorOfAuxiliaryPointsPointer; 209 200 210 std::vector<G4ThreeVector>* fpVectorOfAuxi << 211 }; 201 }; 212 202 213 #include "G4Step.icc" 203 #include "G4Step.icc" >> 204 214 205 215 #endif 206 #endif 216 207