Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/processes/electromagnetic/utils/include/G4EmBiasingManager.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 /processes/electromagnetic/utils/include/G4EmBiasingManager.hh (Version 11.3.0) and /processes/electromagnetic/utils/include/G4EmBiasingManager.hh (Version 10.0.p4)


  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 // $Id: G4EmBiasingManager.hh 66241 2012-12-13 18:34:42Z gunter $
 26 //                                                 27 //
 27 // -------------------------------------------     28 // -------------------------------------------------------------------
 28 //                                                 29 //
 29 // GEANT4 Class header file                        30 // GEANT4 Class header file
 30 //                                                 31 //
 31 //                                                 32 //
 32 // File name:     G4EmBiasingManager               33 // File name:     G4EmBiasingManager
 33 //                                                 34 //
 34 // Author:        Vladimir Ivanchenko              35 // Author:        Vladimir Ivanchenko
 35 //                                                 36 //
 36 // Creation date: 28.07.2011                       37 // Creation date: 28.07.2011
 37 //                                                 38 //
 38 // Modifications:                                  39 // Modifications:
 39 //                                                 40 //
 40 // Class Description:                              41 // Class Description:
 41 //                                                 42 //
 42 // It is a class providing step limit for forc     43 // It is a class providing step limit for forced process biasing
 43                                                    44 
 44 // -------------------------------------------     45 // -------------------------------------------------------------------
 45 //                                                 46 //
 46                                                    47 
 47 #ifndef G4EmBiasingManager_h                       48 #ifndef G4EmBiasingManager_h
 48 #define G4EmBiasingManager_h 1                     49 #define G4EmBiasingManager_h 1
 49                                                    50 
 50 #include "globals.hh"                              51 #include "globals.hh"
 51 #include "G4ParticleDefinition.hh"                 52 #include "G4ParticleDefinition.hh"
 52 #include "G4DynamicParticle.hh"                    53 #include "G4DynamicParticle.hh"
 53 #include "Randomize.hh"                            54 #include "Randomize.hh"
 54 #include <vector>                                  55 #include <vector>
 55                                                    56 
 56 //....oooOO0OOooo........oooOO0OOooo........oo     57 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
 57                                                    58 
 58 class G4Region;                                    59 class G4Region;
 59 class G4Track;                                     60 class G4Track;
 60 class G4VEnergyLossProcess;                        61 class G4VEnergyLossProcess;
 61 class G4VEmModel;                                  62 class G4VEmModel;
 62 class G4MaterialCutsCouple;                        63 class G4MaterialCutsCouple;
 63 class G4ParticleChangeForLoss;                     64 class G4ParticleChangeForLoss;
 64 class G4ParticleChangeForGamma;                    65 class G4ParticleChangeForGamma;
 65                                                    66 
 66 class G4EmBiasingManager                           67 class G4EmBiasingManager 
 67 {                                                  68 {
 68 public:                                            69 public:
 69                                                    70 
 70   G4EmBiasingManager();                            71   G4EmBiasingManager();
 71                                                    72 
 72   ~G4EmBiasingManager();                           73   ~G4EmBiasingManager();
 73                                                    74 
 74   void Initialise(const G4ParticleDefinition&      75   void Initialise(const G4ParticleDefinition& part,
 75       const G4String& procName, G4int verbose)     76       const G4String& procName, G4int verbose);
 76                                                    77 
 77   // default parameters are possible               78   // default parameters are possible
 78   void ActivateForcedInteraction(G4double leng     79   void ActivateForcedInteraction(G4double length = 0.0, 
 79          const G4String& r = "");                  80          const G4String& r = "");
 80                                                    81 
 81   // no default parameters                         82   // no default parameters
 82   void ActivateSecondaryBiasing(const G4String     83   void ActivateSecondaryBiasing(const G4String& region, G4double factor,
 83         G4double energyLimit);                     84         G4double energyLimit);
 84                                                    85 
 85   // return forced step limit                      86   // return forced step limit
 86   G4double GetStepLimit(G4int coupleIdx, G4dou     87   G4double GetStepLimit(G4int coupleIdx, G4double previousStep);
 87                                                    88 
 88   // return weight of splitting or Russian rou     89   // return weight of splitting or Russian roulette
 89   // G4DynamicParticle may be deleted              90   // G4DynamicParticle may be deleted
 90   // two functions are required because of the     91   // two functions are required because of the different ParticleChange
 91   // ApplySecondaryBiasing() are wrappers          92   // ApplySecondaryBiasing() are wrappers
 92                                                    93 
 93   // for G4VEmProcess                              94   // for G4VEmProcess 
 94   G4double ApplySecondaryBiasing(std::vector<G     95   G4double ApplySecondaryBiasing(std::vector<G4DynamicParticle*>&, 
 95          const G4Track& track,                     96          const G4Track& track,
 96          G4VEmModel* currentModel,                 97          G4VEmModel* currentModel,
 97          G4ParticleChangeForGamma* pParticleCh     98          G4ParticleChangeForGamma* pParticleChange,
 98          G4double& eloss,                      <<  99          G4double& eloss, 
 99          G4int coupleIdx,                      << 100            G4int coupleIdx,  
100          G4double tcut,                        << 101          G4double tcut, 
101          G4double safety = 0.0);                  102          G4double safety = 0.0);
102                                                   103 
103   // for G4VEnergyLossProcess                     104   // for G4VEnergyLossProcess 
104   G4double ApplySecondaryBiasing(std::vector<G    105   G4double ApplySecondaryBiasing(std::vector<G4DynamicParticle*>&,
105          const G4Track& track,                    106          const G4Track& track,
106          G4VEmModel* currentModel,                107          G4VEmModel* currentModel,
107          G4ParticleChangeForLoss* pParticleCha    108          G4ParticleChangeForLoss* pParticleChange,
108          G4double& eloss,                         109          G4double& eloss, 
109                  G4int coupleIdx,              << 110            G4int coupleIdx,  
110          G4double tcut,                           111          G4double tcut, 
111          G4double safety = 0.0);                  112          G4double safety = 0.0);
112                                                   113 
113   // for G4VEnergyLossProcess                     114   // for G4VEnergyLossProcess 
114   G4double ApplySecondaryBiasing(std::vector<G    115   G4double ApplySecondaryBiasing(std::vector<G4Track*>&,
115          G4int coupleIdx);                        116          G4int coupleIdx);
116                                                   117 
117   inline G4bool SecondaryBiasingRegion(G4int c    118   inline G4bool SecondaryBiasingRegion(G4int coupleIdx);
118                                                   119 
119   inline G4bool ForcedInteractionRegion(G4int     120   inline G4bool ForcedInteractionRegion(G4int coupleIdx);
120                                                   121 
121   inline void ResetForcedInteraction();           122   inline void ResetForcedInteraction();
122                                                   123 
123   G4bool CheckDirection(G4ThreeVector pos, G4T << 
124                                                << 
125   G4bool  GetDirectionalSplitting() { return f << 
126   void    SetDirectionalSplitting(G4bool v) {  << 
127                                                << 
128   void SetDirectionalSplittingTarget(G4ThreeVe << 
129     { fDirectionalSplittingTarget = v; }       << 
130   void SetDirectionalSplittingRadius(G4double  << 
131     { fDirectionalSplittingRadius = r; }       << 
132   G4double GetWeight(G4int i);                 << 
133                                                << 
134   // hide copy constructor and assignment oper << 
135   G4EmBiasingManager(G4EmBiasingManager &) = d << 
136   G4EmBiasingManager & operator=(const G4EmBia << 
137                                                << 
138 private:                                          124 private:
139                                                   125 
140   void ApplyRangeCut(std::vector<G4DynamicPart    126   void ApplyRangeCut(std::vector<G4DynamicParticle*>& vd,
141          const G4Track& track,                    127          const G4Track& track,
142          G4double& eloss,                         128          G4double& eloss, 
143          G4double safety);                        129          G4double safety);
144                                                   130 
145   G4double ApplySplitting(std::vector<G4Dynami    131   G4double ApplySplitting(std::vector<G4DynamicParticle*>& vd,
146         const G4Track& track,                     132         const G4Track& track,
147         G4VEmModel* currentModel,                 133         G4VEmModel* currentModel, 
148         G4int index,                              134         G4int index,
149         G4double tcut);                           135         G4double tcut);
150                                                   136 
151   G4double ApplyDirectionalSplitting(std::vect << 
152         const G4Track& track,                  << 
153         G4VEmModel* currentModel,              << 
154         G4int index,                           << 
155         G4double tcut,                         << 
156         G4ParticleChangeForGamma* partChange); << 
157                                                << 
158   G4double ApplyDirectionalSplitting(std::vect << 
159         const G4Track& track,                  << 
160         G4VEmModel* currentModel,              << 
161         G4int index,                           << 
162         G4double tcut);                        << 
163                                                << 
164   inline G4double ApplyRussianRoulette(std::ve    137   inline G4double ApplyRussianRoulette(std::vector<G4DynamicParticle*>& vd,
165                G4int index);                      138                G4int index); 
166                                                   139 
167   G4VEnergyLossProcess* eIonisation = nullptr; << 140   // copy constructor and hide assignment operator
168                                                << 141   G4EmBiasingManager(G4EmBiasingManager &);
169   const G4ParticleDefinition* theElectron;     << 142   G4EmBiasingManager & operator=(const G4EmBiasingManager &right);
170   const G4ParticleDefinition* theGamma;        << 
171                                                << 
172   G4double fSafetyMin;                         << 
173   G4double currentStepLimit = 0.0;             << 
174   G4double fDirectionalSplittingRadius = 0.0;  << 
175                                                << 
176   G4int nForcedRegions = 0;                    << 
177   G4int nSecBiasedRegions = 0;                 << 
178                                                << 
179   G4bool startTracking = true;                 << 
180   G4bool fDirectionalSplitting = false;        << 
181                                                << 
182   G4ThreeVector fDirectionalSplittingTarget;   << 
183   std::vector<G4double> fDirectionalSplittingW << 
184                                                   143 
                                                   >> 144   G4int                        nForcedRegions;
                                                   >> 145   G4int                        nSecBiasedRegions;
                                                   >> 146   std::vector<const G4Region*> forcedRegions;
185   std::vector<G4double>        lengthForRegion    147   std::vector<G4double>        lengthForRegion;
                                                   >> 148   std::vector<const G4Region*> secBiasedRegions;
186   std::vector<G4double>        secBiasedWeight    149   std::vector<G4double>        secBiasedWeight;
187   std::vector<G4double>        secBiasedEnegry    150   std::vector<G4double>        secBiasedEnegryLimit;
188                                                << 
189   std::vector<const G4Region*> forcedRegions;  << 
190   std::vector<const G4Region*> secBiasedRegion << 
191                                                << 
192   std::vector<G4int>           nBremSplitting;    151   std::vector<G4int>           nBremSplitting;
                                                   >> 152 
193   std::vector<G4int>           idxForcedCouple    153   std::vector<G4int>           idxForcedCouple;
194   std::vector<G4int>           idxSecBiasedCou    154   std::vector<G4int>           idxSecBiasedCouple;
195                                                   155 
196   std::vector<G4DynamicParticle*> tmpSecondari    156   std::vector<G4DynamicParticle*> tmpSecondaries;
                                                   >> 157 
                                                   >> 158   G4VEnergyLossProcess*         eIonisation;
                                                   >> 159 
                                                   >> 160   const G4ParticleDefinition*  theElectron;
                                                   >> 161 
                                                   >> 162   G4double fSafetyMin;
                                                   >> 163   G4double currentStepLimit;
                                                   >> 164   G4bool   startTracking;
197 };                                                165 };
198                                                   166 
199 inline G4bool                                     167 inline G4bool 
200 G4EmBiasingManager::SecondaryBiasingRegion(G4i    168 G4EmBiasingManager::SecondaryBiasingRegion(G4int coupleIdx)
201 {                                                 169 {
202   G4bool res = false;                             170   G4bool res = false;
203   if(nSecBiasedRegions > 0) {                     171   if(nSecBiasedRegions > 0) {
204     if(idxSecBiasedCouple[coupleIdx] >= 0) { r    172     if(idxSecBiasedCouple[coupleIdx] >= 0) { res = true; }
205   }                                               173   }
206   return res;                                     174   return res;
207 }                                                 175 }
208                                                   176 
209 inline G4bool G4EmBiasingManager::ForcedIntera    177 inline G4bool G4EmBiasingManager::ForcedInteractionRegion(G4int coupleIdx)
210 {                                                 178 {
211   G4bool res = false;                             179   G4bool res = false;
212   if(nForcedRegions > 0) {                        180   if(nForcedRegions > 0) {
213     if(idxForcedCouple[coupleIdx] >= 0) { res     181     if(idxForcedCouple[coupleIdx] >= 0) { res = true; }
214   }                                               182   }
215   return res;                                     183   return res;
216 }                                                 184 }
217                                                   185 
218 inline void G4EmBiasingManager::ResetForcedInt    186 inline void G4EmBiasingManager::ResetForcedInteraction()
219 {                                                 187 {
220   startTracking = true;                           188   startTracking = true;
221 }                                                 189 }
222                                                   190 
223 //....oooOO0OOooo........oooOO0OOooo........oo    191 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
224                                                   192 
225 inline G4double                                   193 inline G4double
226 G4EmBiasingManager::ApplyRussianRoulette(std::    194 G4EmBiasingManager::ApplyRussianRoulette(std::vector<G4DynamicParticle*>& vd,
227            G4int index)                           195            G4int index)
228 {                                                 196 {
229   size_t n = vd.size();                           197   size_t n = vd.size();
230   G4double weight = secBiasedWeight[index];       198   G4double weight = secBiasedWeight[index];
231   for(size_t k=0; k<n; ++k) {                     199   for(size_t k=0; k<n; ++k) {
232     if(G4UniformRand()*weight > 1.0) {            200     if(G4UniformRand()*weight > 1.0) {
233       const G4DynamicParticle* dp = vd[k];        201       const G4DynamicParticle* dp = vd[k];
234       delete dp;                                  202       delete dp;
235       vd[k] = nullptr;                         << 203       vd[k] = 0;
236     }                                             204     }
237   }                                               205   }
238   return weight;                                  206   return weight;
239 }                                                 207 }
240                                                   208 
241 //....oooOO0OOooo........oooOO0OOooo........oo    209 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
242                                                   210 
243 #endif                                            211 #endif
244                                                   212