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