| 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 // 26 //
>> 27 // $Id: G4Transportation.hh 90840 2015-06-10 09:51:07Z gcosmo $
27 // 28 //
28 // 29 //
29 // ------------------------------------------- 30 // ------------------------------------------------------------
30 // GEANT 4 include file implementation 31 // GEANT 4 include file implementation
31 // ------------------------------------------- 32 // ------------------------------------------------------------
32 // 33 //
33 // Class description: 34 // Class description:
34 // 35 //
35 // G4Transportation is a process responsible f 36 // G4Transportation is a process responsible for the transportation of
36 // a particle, i.e. the geometrical propagatio 37 // a particle, i.e. the geometrical propagation encountering the
37 // geometrical sub-volumes of the detectors. 38 // geometrical sub-volumes of the detectors.
38 // It is also tasked with part of updating the 39 // It is also tasked with part of updating the "safety".
39 40
40 // =========================================== 41 // =======================================================================
41 // Created: 19 March 1997, J. Apostolakis 42 // Created: 19 March 1997, J. Apostolakis
42 // =========================================== 43 // =======================================================================
43 #ifndef G4Transportation_hh 44 #ifndef G4Transportation_hh
44 #define G4Transportation_hh 1 45 #define G4Transportation_hh 1
45 46
46 #include "G4VProcess.hh" 47 #include "G4VProcess.hh"
>> 48 #include "G4FieldManager.hh"
47 49
>> 50 #include "G4Navigator.hh"
>> 51 #include "G4TransportationManager.hh"
>> 52 #include "G4PropagatorInField.hh"
48 #include "G4Track.hh" 53 #include "G4Track.hh"
49 #include "G4Step.hh" 54 #include "G4Step.hh"
50 #include "G4ParticleChangeForTransport.hh" 55 #include "G4ParticleChangeForTransport.hh"
51 <<
52 class G4Navigator; <<
53 class G4PropagatorInField; <<
54 class G4SafetyHelper; 56 class G4SafetyHelper;
55 class G4TransportationLogger; << 57 class G4CoupledTransportation;
56 58
57 class G4Transportation : public G4VProcess 59 class G4Transportation : public G4VProcess
58 { 60 {
59 // Concrete class that does the geometrical 61 // Concrete class that does the geometrical transport
60 62
61 public: // with description 63 public: // with description
62 64
63 G4Transportation( G4int verbosityLevel= 1 << 65 G4Transportation( G4int verbosityLevel= 1);
64 ~G4Transportation(); 66 ~G4Transportation();
65 67
66 G4double AlongStepGetPhysicalInterac 68 G4double AlongStepGetPhysicalInteractionLength(
67 const G4Track& tr 69 const G4Track& track,
68 G4double p 70 G4double previousStepSize,
69 G4double c 71 G4double currentMinimumStep,
70 G4double& c 72 G4double& currentSafety,
71 G4GPILSelec 73 G4GPILSelection* selection
72 ); // override; << 74 );
73 75
74 G4VParticleChange* AlongStepDoIt( 76 G4VParticleChange* AlongStepDoIt(
75 const G4Track& tr 77 const G4Track& track,
76 const G4Step& ste 78 const G4Step& stepData
77 ); // override; << 79 );
78 80
79 G4VParticleChange* PostStepDoIt( 81 G4VParticleChange* PostStepDoIt(
80 const G4Track& tr 82 const G4Track& track,
81 const G4Step& st 83 const G4Step& stepData
82 ); // override; << 84 );
83 // Responsible for the relocation << 85 // Responsible for the relocation.
84 86
85 G4double PostStepGetPhysicalInteractionLe 87 G4double PostStepGetPhysicalInteractionLength(
86 const G4Track& , 88 const G4Track& ,
87 G4double previo 89 G4double previousStepSize,
88 G4ForceCondition* 90 G4ForceCondition* pForceCond
89 ); // override; << 91 );
90 // Forces the PostStepDoIt action to be 92 // Forces the PostStepDoIt action to be called,
91 // but does not limit the step << 93 // but does not limit the step.
92 94
93 inline G4bool FieldExertedForce() { retur << 95 G4bool FieldExertedForce() { return fFieldExertedForce; }
94 96
95 G4PropagatorInField* GetPropagatorInField 97 G4PropagatorInField* GetPropagatorInField();
96 void SetPropagatorInField( G4PropagatorIn 98 void SetPropagatorInField( G4PropagatorInField* pFieldPropagator);
97 // Access/set the assistant class that << 99 // Access/set the assistant class that Propagate in a Field.
>> 100
>> 101 inline void SetVerboseLevel( G4int verboseLevel );
>> 102 inline G4int GetVerboseLevel() const;
>> 103 // Level of warnings regarding eg energy conservation
>> 104 // in field integration.
98 105
99 inline G4double GetThresholdWarningEnergy 106 inline G4double GetThresholdWarningEnergy() const;
100 inline G4double GetThresholdImportantEner 107 inline G4double GetThresholdImportantEnergy() const;
101 inline G4int GetThresholdTrials() const; 108 inline G4int GetThresholdTrials() const;
102 109
103 inline void SetThresholdWarningEnergy( G4 110 inline void SetThresholdWarningEnergy( G4double newEnWarn );
104 inline void SetThresholdImportantEnergy( 111 inline void SetThresholdImportantEnergy( G4double newEnImp );
105 inline void SetThresholdTrials(G4int newM 112 inline void SetThresholdTrials(G4int newMaxTrials );
>> 113
106 // Get/Set parameters for killing loopers 114 // Get/Set parameters for killing loopers:
107 // Above 'important' energy a 'looping' 115 // Above 'important' energy a 'looping' particle in field will
108 // *NOT* be abandoned, except after fTh 116 // *NOT* be abandoned, except after fThresholdTrials attempts.
109 // Below Warning energy, no verbosity for 117 // Below Warning energy, no verbosity for looping particles is issued
110 118
111 void SetHighLooperThresholds(); // Shortc <<
112 void SetLowLooperThresholds(); // Set low <<
113 void PushThresholdsToLogger(); // Inform <<
114 void ReportLooperThresholds(); // Print v <<
115 <<
116 inline G4double GetMaxEnergyKilled() cons 119 inline G4double GetMaxEnergyKilled() const;
117 inline G4double GetSumEnergyKilled() cons 120 inline G4double GetSumEnergyKilled() const;
118 inline void ResetKilledStatistics( G4int 121 inline void ResetKilledStatistics( G4int report = 1);
119 // Statistics for tracks killed (currentl 122 // Statistics for tracks killed (currently due to looping in field)
120 123
121 inline void EnableShortStepOptimisation(G 124 inline void EnableShortStepOptimisation(G4bool optimise=true);
122 // Whether short steps < safety will avoi 125 // Whether short steps < safety will avoid to call Navigator (if field=0)
123 126
124 static G4bool EnableMagneticMoment(G4bool << 127 static G4bool EnableUseMagneticMoment(G4bool useMoment=true);
125 // Whether to enable particles to be defl << 128 // Whether to deflect particles with force due to magnetic moment
126 <<
127 static G4bool EnableGravity(G4bool useGra <<
128 // Whether to enable particles to be defl <<
129 129
130 static void SetSilenceLooperWarnings( G <<
131 // Do not warn (or throw exception) about <<
132 static G4bool GetSilenceLooperWarnings(); <<
133 <<
134 public: // without description <<
135 static G4bool EnableUseMagneticMoment(G4b <<
136 { return EnableMagneticMoment(useMoment); <<
137 <<
138 public: // without description 130 public: // without description
139 131
140 G4double AtRestGetPhysicalInteractionLeng << 132 G4double AtRestGetPhysicalInteractionLength(
141 << 133 const G4Track& ,
142 { return -1.0; } // No operation in At << 134 G4ForceCondition*
>> 135 ) { return -1.0; };
>> 136 // No operation in AtRestDoIt.
143 137
144 G4VParticleChange* AtRestDoIt( const G4Tr << 138 G4VParticleChange* AtRestDoIt(
145 { return 0; } // No operation in At << 139 const G4Track& ,
>> 140 const G4Step&
>> 141 ) {return 0;};
>> 142 // No operation in AtRestDoIt.
146 143
147 void StartTracking(G4Track* aTrack); << 144 void StartTracking(G4Track* aTrack);
148 // Reset state for new (potentially res 145 // Reset state for new (potentially resumed) track
149 146
150 virtual void ProcessDescription(std::ostr <<
151 void PrintStatistics( std::ostream& outSt <<
152 <<
153 protected: 147 protected:
154 148
155 void SetTouchableInformation(const G4Touc << 149 G4bool DoesGlobalFieldExist();
>> 150 // Checks whether a field exists for the "global" field manager.
156 151
157 void ReportMissingLogger(const char * met << 152 private:
158 <<
159 protected: <<
160 153
161 G4Navigator* fLinearNavigator; << 154 G4Navigator* fLinearNavigator;
162 // The navigator for the 'mass' geometr <<
163 // (the real one, that physics occurs i <<
164 G4PropagatorInField* fFieldPropagator; 155 G4PropagatorInField* fFieldPropagator;
165 // The Propagators used to transport th 156 // The Propagators used to transport the particle
166 157
167 G4ThreeVector fTransportEndPosition= << 158 // G4FieldManager* fGlobalFieldMgr; // Used MagneticField CC
168 G4ThreeVector fTransportEndMomentumDir= << 159 // Field Manager for the whole Detector
169 G4double fTransportEndKineticEnergy= << 160
170 G4ThreeVector fTransportEndSpin= G4Three << 161 G4ThreeVector fTransportEndPosition;
171 G4bool fMomentumChanged= true; << 162 G4ThreeVector fTransportEndMomentumDir;
172 G4bool fEndGlobalTimeComputed= fal << 163 G4double fTransportEndKineticEnergy;
173 G4double fCandidateEndGlobalTime= 0. << 164 G4ThreeVector fTransportEndSpin;
>> 165 G4bool fMomentumChanged;
>> 166 G4bool fEndGlobalTimeComputed;
>> 167 G4double fCandidateEndGlobalTime;
174 // The particle's state after this Step 168 // The particle's state after this Step, Store for DoIt
175 169
176 G4bool fAnyFieldExists= false; << 170 G4bool fParticleIsLooping;
177 << 171 G4bool fNewTrack; // Flag from StartTracking
178 G4bool fParticleIsLooping = false; << 172 G4bool fFirstStepInVolume;
179 G4bool fNewTrack= true; // Flag << 173 G4bool fLastStepInVolume; // Last step - almost same as next flag
180 G4bool fFirstStepInVolume= true; << 174 // (temporary redundancy for checking)
181 G4bool fLastStepInVolume= false; // Last << 175 G4bool fGeometryLimitedStep; // Flag to determine whether a boundary was reached.
182 // (temporary <<
183 G4bool fGeometryLimitedStep= true; <<
184 // Flag to determine whether a boundary <<
185 176
186 G4bool fFieldExertedForce= false; // Duri << 177 G4bool fFieldExertedForce; // During current step
187 178
188 G4TouchableHandle fCurrentTouchableHandle << 179 G4TouchableHandle fCurrentTouchableHandle;
189 180
190 G4ThreeVector fPreviousSftOrigin; << 181 G4ThreeVector fPreviousSftOrigin;
191 G4double fPreviousSafety; << 182 G4double fPreviousSafety;
192 // Remember last safety origin & value. 183 // Remember last safety origin & value.
193 184
194 G4ParticleChangeForTransport fParticleCha 185 G4ParticleChangeForTransport fParticleChange;
195 // New ParticleChange 186 // New ParticleChange
196 187
197 G4double fEndPointDistance; 188 G4double fEndPointDistance;
198 189
199 // Thresholds for looping particles: << 190 // Thresholds for looping particles:
200 // << 191 //
201 G4double fThreshold_Warning_Energy = 1. << 192 G4double fThreshold_Warning_Energy; // Warn above this energy
202 G4double fThreshold_Important_Energy = 1. << 193 G4double fThreshold_Important_Energy; // Hesitate above this
203 G4int fThresholdTrials = 10; // << 194 G4int fThresholdTrials; // for this no of trials
204 // Above 'important' energy a 'looping' 195 // Above 'important' energy a 'looping' particle in field will
205 // *NOT* be abandoned, except after fTh << 196 // *NOT* be abandoned, except after fThresholdTrials attempts.
206 G4int fAbandonUnstableTrials = 0; // << 197
207 // << 198 // Counter for steps in which particle reports 'looping',
208 // Counter for steps in which particle re << 199 // if it is above 'Important' Energy
209 // ( Used if it is above 'Important' Ene << 200 G4int fNoLooperTrials;
210 G4int fNoLooperTrials= 0; << 201 // Statistics for tracks abandoned
211 << 202 G4double fSumEnergyKilled;
212 // Statistics for tracks abandoned due to << 203 G4double fMaxEnergyKilled;
213 // << 204
214 G4double fSumEnergyKilled= 0.0; << 205 // Whether to avoid calling G4Navigator for short step ( < safety)
215 G4double fSumEnerSqKilled= 0.0; << 206 // If using it, the safety estimate for endpoint will likely be smaller.
216 G4double fMaxEnergyKilled= -1.0; <<
217 G4int fMaxEnergyKilledPDG= 0; <<
218 unsigned long fNumLoopersKilled= 0; <<
219 G4double fSumEnergyKilled_NonElectron= 0. <<
220 G4double fSumEnerSqKilled_NonElectron= 0. <<
221 G4double fMaxEnergyKilled_NonElectron= -1 <<
222 G4int fMaxEnergyKilled_NonElecPDG= 0; <<
223 unsigned long fNumLoopersKilled_NonElectr <<
224 G4double fSumEnergySaved= 0.0; <<
225 G4double fMaxEnergySaved= -1.0; <<
226 G4double fSumEnergyUnstableSaved = 0.0; <<
227 // Whether to avoid calling G4Navigator f <<
228 // If using it, the safety estimate for e <<
229 // <<
230 G4bool fShortStepOptimisation; 207 G4bool fShortStepOptimisation;
231 208
232 G4SafetyHelper* fpSafetyHelper; // To << 209 G4SafetyHelper* fpSafetyHelper; // To pass it the safety value obtained
233 G4TransportationLogger* fpLogger; // Rep <<
234 210
235 protected: << 211 // Verbosity
>> 212 G4int fVerboseLevel;
>> 213 // Verbosity level for warnings
>> 214 // eg about energy non-conservation in magnetic field.
>> 215
>> 216 // Whether to track state change from magnetic moment in a B-field
>> 217
>> 218 private:
>> 219 friend class G4CoupledTransportation;
>> 220 static G4bool fUseMagneticMoment;
236 221
237 static G4bool fUseMagneticMoment; <<
238 static G4bool fUseGravity; <<
239 static G4bool fSilenceLooperWarnings; // <<
240 <<
241 }; 222 };
242 223
243 #include "G4Transportation.icc" 224 #include "G4Transportation.icc"
244 225
245 #endif 226 #endif
246 227