Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/examples/extended/biasing/README

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/extended/biasing/README (Version 11.3.0) and /examples/extended/biasing/README (Version 9.3)


  1                                                     1 
  2                Examples for event biasing: B01 <<   2                     Examples for event biasing: B01 and B02
  3                ------------------------------- <<   3                     ---------------------------------------
  4                                                     4 
  5 B01, B02 and B03 applications demonstrate the  <<   5 B01 and B02 applications demonstrate the usage of different variance
  6 reduction techniques supported in Geant4, or p      6 reduction techniques supported in Geant4, or possible from the user
  7 applications.                                       7 applications.
  8                                                     8 
  9 General remark to variance reduction                9 General remark to variance reduction
 10 ------------------------------------               10 ------------------------------------
 11 The tools provided for importance sampling (or     11 The tools provided for importance sampling (or geometrical splitting and
 12 Russian roulette) and for the weight window te     12 Russian roulette) and for the weight window technique require the user to 
 13 have a good understanding of the physics in th     13 have a good understanding of the physics in the problem. This is because 
 14 the user has to decide which particle types ha     14 the user has to decide which particle types have to be biased, define the 
 15 cells (physical volumes, replicas) and assign      15 cells (physical volumes, replicas) and assign importances or weight 
 16 windows to that cells. If this is not done pro     16 windows to that cells. If this is not done properly it can not be 
 17 expected that the results describe a real expe     17 expected that the results describe a real experiment. The examples given 
 18 here only demonstrate how to use the tools tec     18 here only demonstrate how to use the tools technically. They don't intend 
 19 to produce physical correct results.               19 to produce physical correct results.
 20                                                    20 
 21 General remark to scoring                          21 General remark to scoring
 22 -------------------------                          22 -------------------------
 23 Scoring is carried out using the built-in Mult <<  23 A interface G4VScorer is provided for the user. The user may create his 
 24 parallel geometries this requires a special sc <<  24 own class to perform the desired scoring. The user defined class 
 25 See examples/extended/runAndEvent (especailly  <<  25 therefore should inherit from the interface G4VScorer. 
                                                   >>  26 An example of an implementation of a scorer is G4Scorer
                                                   >>  27 which may be found in source/event. 
                                                   >>  28 The scoring in these examples is done with a G4Scorer.
                                                   >>  29 The variance reduction techniques and scoring do not support all options
                                                   >>  30 of the Geant4 geometry. It only supports physical volumes and simple 
                                                   >>  31 replicas.
                                                   >>  32 To identify a physical volume (or replica) objects of the class
                                                   >>  33 G4GeometryCell are used. Scoring is done according to these
                                                   >>  34 cells and importance values or the weight windows  may be assigned to 
                                                   >>  35 them.
                                                   >>  36 When scoring is done in a parallel geometry special action has to be taken
                                                   >>  37 to prevent counting of "collisions" with boundaries of the mass geometry 
                                                   >>  38 as interactions. This is differently handled when scoring is done in the 
                                                   >>  39 mass geometry.
 26                                                    40 
 27 Known problems - should not happen             <<  41 --> G4GeometryCell of the parallel geometry must not share boundaries with
 28 ----------------------------------             <<  42 the world volume! <--
                                                   >>  43 
                                                   >>  44 Known problems
                                                   >>  45 --------------
 29 In the following scenario it can happen that a     46 In the following scenario it can happen that a particle is not
 30 biased and it's weight is therefore not change     47 biased and it's weight is therefore not changed even if it crosses
 31 a boundary where biasing should happen.            48 a boundary where biasing should happen.
 32 Importance and weight window sampling create p     49 Importance and weight window sampling create particles on boundaries 
 33 between volumes. If the GPIL method of a physi     50 between volumes. If the GPIL method of a physical process returns 
 34 0 as step length for a particle on a boundary      51 0 as step length for a particle on a boundary and if the PostStepDoIt of
 35 that process changes the direction of the part     52 that process changes the direction of the particle to go back in the 
 36 former volume the biasing won't be invoked.        53 former volume the biasing won't be invoked. 
 37 This will produce particles with weights that      54 This will produce particles with weights that do not correspondent to the
 38 importance of the current volumes.                 55 importance of the current volumes.
 39                                                    56 
 40 Further information:                               57 Further information:
 41 --------------------                               58 --------------------
 42 Short description of importance sampling and s     59 Short description of importance sampling and scoring:
 43 https://geant4.web.cern.ch/collaboration/worki <<  60 http://cern.ch/geant4/working_groups/geometry/biasing/Sampling.html
 44                                                    61 
 45 Example B01                                        62 Example B01
 46 ===========                                        63 ===========
 47                                                    64 
 48 The example uses importance sampling or the we     65 The example uses importance sampling or the weight window technique 
 49 according to an input parameter. It uses scori     66 according to an input parameter. It uses scoring in both cases. 
 50 Importance values or weight windows are define     67 Importance values or weight windows are defined according to the mass 
 51 geometry. In this example the weight window te     68 geometry. In this example the weight window technique is configured such 
 52 that it behaves equivalent to importance sampl     69 that it behaves equivalent to importance sampling: The window is actually 
 53 not a window but simply the inverse of the imp     70 not a window but simply the inverse of the importance value and only
 54 one energy region is used that covers all ener     71 one energy region is used that covers all energies in the problem.
 55 The user may change the weight window configur     72 The user may change the weight window configuration by changing the
 56 initialization of the weight window algorithm      73 initialization of the weight window algorithm in example,cc. 
 57 Different energy bounds for the weight window      74 Different energy bounds for the weight window technique may be specified 
 58 in B01DetectorConstruction.                        75 in B01DetectorConstruction.
 59                                                    76 
 60 The executable takes one optional argument: 0      77 The executable takes one optional argument: 0 or 1. Without argument or
 61 with argument: 0, the importance sampling is a     78 with argument: 0, the importance sampling is applied with argument: 1,
 62 the weight window technique is applied.            79 the weight window technique is applied.
 63                                                    80 
 64 A modular approach is applied to the physicsli << 
 65                                                    81 
 66 Example B02                                        82 Example B02
 67 ===========                                        83 ===========
 68                                                    84 
 69 This example uses a parallel geometry to defin     85 This example uses a parallel geometry to define G4GeometryCell objects
 70 for scoring and importance sampling. The outpu <<  86 for scoring and importance sampling. In addition it customizes
 71                                                <<  87 the scoring. In this example one scorer creates a histogram.
 72 A modular approach is applied to the physicsli << 
 73 The parallel geometry is included in this exte << 
 74                                                << 
 75 Example B03                                    << 
 76 ===========                                    << 
 77                                                << 
 78 This example uses a parallel geometry to defin << 
 79 for scoring and importance sampling. The outpu << 
 80 equivalent to B02 (and B01).                   << 
 81                                                << 
 82 This demonstrates a customised "flat" physics  << 
 83 of biasing. Complementary approach to the modu << 
 84                                                << 
 85                                                << 
 86  _____________________________________________ << 
 87                                                << 
 88                                                << 
 89                   Generic biasing examples GB0 << 
 90                   ---------------------------- << 
 91                                                << 
 92 These examples illustrate the usage of a biasi << 
 93 version Geant4 10.0.                           << 
 94 The scheme is meant to be extensible, not limi << 
 95                                                << 
 96 Example GB01:                                  << 
 97 =============                                  << 
 98                                                << 
 99 This example illustrates how to bias process c << 
100                                                << 
101                                                << 
102 Example GB02:                                  << 
103 =============                                  << 
104                                                << 
105 Illustrates a force collision scheme similar t << 
106                                                << 
107                                                << 
108 Example GB03:                                  << 
109 =============                                  << 
110                                                << 
111 Illustrates geometry based biasing.            << 
112                                                << 
113                                                << 
114 Example GB04:                                  << 
115 =============                                  << 
116                                                << 
117 Illustrates a bremsstrahlung splitting.        << 
118                                                << 
119                                                << 
120 Example GB05:                                  << 
121 =============                                  << 
122                                                << 
123 Illustrates a "splitting by cross-section" tec << 
124 technique using absorption cross-section to co << 
125                                                << 
126                                                << 
127 Example GB06:                                  << 
128 =============                                  << 
129                                                << 
130 Illustrates the usage of parallel geometries w << 
131                                                << 
132 Example GB07:                                  << 
133 =============                                  << 
134                                                << 
135 Illustrates the usage of leading particle bias << 
136                                                    88 
                                                   >>  89 Compiling and running
                                                   >>  90 ---------------------
                                                   >>  91 To compile this example you need AIDA installed. To link 
                                                   >>  92 and run it you need a AIDA compliant analysis package.
                                                   >>  93 Histograms are saved in HBOOK format.
                                                   >>  94 You need to set the following variable in your environment:
                                                   >>  95    "G4ANALYSIS_USE"
                                                   >>  96 The example stores the plot in the file b02.hbook.
137                                                    97 
138  _____________________________________________     98  ___________________________________________________________________________
139                                                    99 
140                                                   100 
141              Reverse MonteCarlo Technique exam    101              Reverse MonteCarlo Technique example: ReverseMC01
142              ---------------------------------    102              -------------------------------------------------
143                                                   103 
144 Example ReverseMC01                               104 Example ReverseMC01
145 ===================                               105 ===================
146                                                   106 
147 Example illustrating the use of the Reverse Mo    107 Example illustrating the use of the Reverse Monte Carlo (RMC) mode in a Geant4
148 application. See details in ReverseMC01/README    108 application. See details in ReverseMC01/README.
149                                                   109