Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/examples/advanced/gorad/src/GRParallelWorldBiasingProcess.cc

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 /examples/advanced/gorad/src/GRParallelWorldBiasingProcess.cc (Version 11.3.0) and /examples/advanced/gorad/src/GRParallelWorldBiasingProcess.cc (Version 11.2)


  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 //  Gorad (Geant4 Open-source Radiation Analys     26 //  Gorad (Geant4 Open-source Radiation Analysis and Design)
 27 //                                                 27 //
 28 //  Author : Makoto Asai (SLAC National Accele     28 //  Author : Makoto Asai (SLAC National Accelerator Laboratory)
 29 //                                                 29 //
 30 //  Development of Gorad is funded by NASA Joh     30 //  Development of Gorad is funded by NASA Johnson Space Center (JSC)
 31 //  under the contract NNJ15HK11B.                 31 //  under the contract NNJ15HK11B.
 32 //                                                 32 //
 33 // *******************************************     33 // ********************************************************************
 34 //                                                 34 //
 35 // GRParallelWorldBiasingProcess.cc                35 // GRParallelWorldBiasingProcess.cc
 36 //   A process that takes care of the geometry     36 //   A process that takes care of the geometry importance biasing.
 37 //   This class assumes the existance of a par     37 //   This class assumes the existance of a parallel world dedicated
 38 //   to the geometry importance biasing and bi     38 //   to the geometry importance biasing and biasing parameters are
 39 //   associated to the region defined in that      39 //   associated to the region defined in that parallel world.
 40 //                                                 40 //
 41 // History                                         41 // History
 42 //   September 8th, 2020 : first implementatio     42 //   September 8th, 2020 : first implementation
 43 //                                                 43 //
 44 // *******************************************     44 // ********************************************************************
 45                                                    45 
 46 #include "G4ios.hh"                                46 #include "G4ios.hh"
 47 #include "GRParallelWorldBiasingProcess.hh"        47 #include "GRParallelWorldBiasingProcess.hh"
 48 #include "G4Step.hh"                               48 #include "G4Step.hh"
 49 #include "G4Track.hh"                              49 #include "G4Track.hh"
 50 #include "G4Navigator.hh"                          50 #include "G4Navigator.hh"
 51 #include "G4PathFinder.hh"                         51 #include "G4PathFinder.hh"
 52 #include "G4VTouchable.hh"                         52 #include "G4VTouchable.hh"
 53 #include "G4VPhysicalVolume.hh"                    53 #include "G4VPhysicalVolume.hh"
 54 #include "G4ParticleChange.hh"                     54 #include "G4ParticleChange.hh"
 55 #include "G4ParticleChangeForNothing.hh"           55 #include "G4ParticleChangeForNothing.hh"
 56 #include "Randomize.hh"                            56 #include "Randomize.hh"
 57 #include "G4Region.hh"                             57 #include "G4Region.hh"
 58 #include "GRBiasingRegionInfo.hh"                  58 #include "GRBiasingRegionInfo.hh"
 59                                                    59 
 60 GRParallelWorldBiasingProcess::                    60 GRParallelWorldBiasingProcess::
 61 GRParallelWorldBiasingProcess(const G4String&      61 GRParallelWorldBiasingProcess(const G4String& processName,G4ProcessType theType)
 62 :G4ParallelWorldProcess(processName,theType)       62 :G4ParallelWorldProcess(processName,theType)
 63 {                                                  63 {
 64   particleChange = new G4ParticleChange();         64   particleChange = new G4ParticleChange();
 65   emptyParticleChange = new G4ParticleChangeFo     65   emptyParticleChange = new G4ParticleChangeForNothing();
 66 }                                                  66 }
 67                                                    67 
 68 GRParallelWorldBiasingProcess::~GRParallelWorl     68 GRParallelWorldBiasingProcess::~GRParallelWorldBiasingProcess()
 69 {;}                                                69 {;}
 70                                                    70 
 71 G4VParticleChange* GRParallelWorldBiasingProce     71 G4VParticleChange* GRParallelWorldBiasingProcess::PostStepDoIt(
 72      const G4Track& track,                         72      const G4Track& track,
 73      const G4Step& step)                           73      const G4Step& step)
 74 {                                                  74 { 
 75   fOldGhostTouchable = fGhostPostStepPoint->Ge     75   fOldGhostTouchable = fGhostPostStepPoint->GetTouchableHandle();
 76   CopyStep(step);                                  76   CopyStep(step);
 77                                                    77 
 78   if(fOnBoundary)                                  78   if(fOnBoundary)
 79   {                                                79   {
 80     fNewGhostTouchable = fPathFinder->CreateTo     80     fNewGhostTouchable = fPathFinder->CreateTouchableHandle(fNavigatorID);
 81   }                                                81   }
 82   else                                             82   else
 83   {                                                83   {
 84     fNewGhostTouchable = fOldGhostTouchable;       84     fNewGhostTouchable = fOldGhostTouchable;
 85   }                                                85   }
 86                                                    86     
 87   fGhostPreStepPoint->SetTouchableHandle(fOldG     87   fGhostPreStepPoint->SetTouchableHandle(fOldGhostTouchable);
 88   fGhostPostStepPoint->SetTouchableHandle(fNew     88   fGhostPostStepPoint->SetTouchableHandle(fNewGhostTouchable);
 89                                                    89 
 90   if(fNewGhostTouchable->GetVolume() == nullpt     90   if(fNewGhostTouchable->GetVolume() == nullptr) 
 91   {                                                91   { 
 92     // world volume boundary                       92     // world volume boundary
 93     emptyParticleChange->Initialize(track);        93     emptyParticleChange->Initialize(track);
 94     return emptyParticleChange;                    94     return emptyParticleChange;
 95   }                                                95   }
 96   if(fNewGhostTouchable->GetVolume() == fOldGh     96   if(fNewGhostTouchable->GetVolume() == fOldGhostTouchable->GetVolume()) 
 97   {                                                97   {
 98     // stayed in the same volume                   98     // stayed in the same volume
 99     emptyParticleChange->Initialize(track);        99     emptyParticleChange->Initialize(track);
100     return emptyParticleChange;                   100     return emptyParticleChange;
101   }                                               101   }
102                                                   102 
103   G4int preStepCopyNo = fOldGhostTouchable->Ge    103   G4int preStepCopyNo = fOldGhostTouchable->GetReplicaNumber();
104   G4int postStepCopyNo = fNewGhostTouchable->G    104   G4int postStepCopyNo = fNewGhostTouchable->GetReplicaNumber();
105                                                   105   
106   GRBiasingRegionInfo* biasInfo = static_cast<    106   GRBiasingRegionInfo* biasInfo = static_cast<GRBiasingRegionInfo*>
107     (fNewGhostTouchable->GetVolume()->GetLogic    107     (fNewGhostTouchable->GetVolume()->GetLogicalVolume()->GetRegion()->GetUserInformation());
108   auto probability = biasInfo->GetProbability(    108   auto probability = biasInfo->GetProbability();
109   if(probability < 1.)                            109   if(probability < 1.)
110   {                                               110   {
111     // skip biasing to avoid over biasing         111     // skip biasing to avoid over biasing 
112     G4double ran = G4UniformRand();               112     G4double ran = G4UniformRand();
113     if(ran > probability)                         113     if(ran > probability)
114     {                                             114     {
115       emptyParticleChange->Initialize(track);     115       emptyParticleChange->Initialize(track);
116       return emptyParticleChange;                 116       return emptyParticleChange;
117     }                                             117     }
118   }                                               118   }
119                                                   119 
120   G4double trackWeight = track.GetWeight();       120   G4double trackWeight = track.GetWeight();
121   particleChange->Initialize(track);              121   particleChange->Initialize(track);
122                                                   122 
123   auto biasFactor = biasInfo->GetBiasingFactor    123   auto biasFactor = biasInfo->GetBiasingFactor();
124   if(biasFactor==1)                               124   if(biasFactor==1)
125   {                                               125   {
126     // not biasing                                126     // not biasing
127     emptyParticleChange->Initialize(track);       127     emptyParticleChange->Initialize(track);
128     return emptyParticleChange;                   128     return emptyParticleChange;
129   }                                               129   }
130                                                   130 
131   if(preStepCopyNo < postStepCopyNo)              131   if(preStepCopyNo < postStepCopyNo)
132   {                                               132   {
133     // getting into more important volume, i.e    133     // getting into more important volume, i.e. do splitting
134     trackWeight /= biasFactor;                    134     trackWeight /= biasFactor;
135     particleChange->ProposeParentWeight(trackW    135     particleChange->ProposeParentWeight(trackWeight);
136     for(G4int iClone=1;iClone<biasFactor;iClon    136     for(G4int iClone=1;iClone<biasFactor;iClone++)
137     {                                             137     {
138       G4Track* clonedTrack = new G4Track(track    138       G4Track* clonedTrack = new G4Track(track);
139       clonedTrack->SetWeight(trackWeight);        139       clonedTrack->SetWeight(trackWeight);
140       particleChange->AddSecondary(clonedTrack    140       particleChange->AddSecondary(clonedTrack);
141     }                                             141     }
142     particleChange->SetSecondaryWeightByProces    142     particleChange->SetSecondaryWeightByProcess(true);
143   }                                               143   }
144   else if(preStepCopyNo > postStepCopyNo)         144   else if(preStepCopyNo > postStepCopyNo)
145   {                                               145   {
146     // getting into less important volume, i.e    146     // getting into less important volume, i.e. do Russian Rouletting
147     G4double survivalRate = 1.0/biasFactor;       147     G4double survivalRate = 1.0/biasFactor;
148     G4double ran = G4UniformRand();               148     G4double ran = G4UniformRand();
149     if(ran > survivalRate)                        149     if(ran > survivalRate)
150     {                                             150     {
151       // dead                                     151       // dead
152       particleChange->ProposeTrackStatus(fStop    152       particleChange->ProposeTrackStatus(fStopAndKill);
153     }                                             153     }
154     else                                          154     else
155     {                                             155     {
156       // survive                                  156       // survive
157       trackWeight *= biasFactor;                  157       trackWeight *= biasFactor;
158       particleChange->ProposeParentWeight(trac    158       particleChange->ProposeParentWeight(trackWeight);
159     }                                             159     }
160   }                                               160   } 
161   else                                            161   else
162   {                                               162   {
163     // This should not happen!!                   163     // This should not happen!!
164     G4ExceptionDescription ed;                    164     G4ExceptionDescription ed;
165     ed << "pre step point :  "<<fOldGhostTouch    165     ed << "pre step point :  "<<fOldGhostTouchable->GetVolume()->GetName()<<" - copy no. "<<fOldGhostTouchable->GetReplicaNumber()<<"\n"
166        << "post step point : "<<fNewGhostTouch    166        << "post step point : "<<fNewGhostTouchable->GetVolume()->GetName()<<" - copy no. "<<fNewGhostTouchable->GetReplicaNumber();
167     G4Exception("GRParallelWorldBiasingProcess    167     G4Exception("GRParallelWorldBiasingProcess::PostStepDoIt()","GoradProc0001",FatalException,ed);
168   }                                               168   }
169                                                   169 
170   return particleChange;                          170   return particleChange;
171 }                                                 171 }
172                                                   172 
173                                                   173