Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/examples/advanced/purging_magnet/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 ] 

  1 -------------------------------------------------------------------
  2 
  3      =========================================================
  4      Geant4 - an Object-Oriented Toolkit for Simulation in HEP
  5      =========================================================
  6 
  7                         purgin_magnet
  8                         -------------
  9                      s. Larsson, May 2004
 10 
 11 -----------------------------------------------------------------
 12 Acknowledgments to the GEANT4 Collaboration, in particular to J. Apostolakis,
 13 J Generowicz, G. Folger, Vladimir Ivanchenko,  M.G.Pia and 
 14 S. Guatelli. 
 15 -----------------------------------------------------------------
 16 
 17 0. Introduction
 18 ----------------
 19 
 20 This example simulates electrons traveling through a 3D magnetic field. 
 21 
 22 The Purging Magnet example is an application of Geant4 in a medical
 23 environment. It simulates a strong purging magnet in a treatment head. 
 24 The geometry is very simplified. The major idea of this example is to 
 25 implement an external magnetic field grid and test if the deviation of 
 26 electrons are as expected in this particular field. The data (position, 
 27 energy and momentum) are collected in a measurement volume. The data is
 28 stored in a CSV file (or, optionally in a ROOT, or a XML file, by changing
 29 the G4AnalysisManager default file type in PurgMagRunAction::Book().
 30 
 31 <<<<<<< HEAD
 32   
 33 =======
 34 >>>>>>> Migration to G4RunManagerFactory done.
 35 1. Setting up the environment variables
 36 ---------------------------------------
 37 
 38 The following environment variables need to be set:                     
 39 
 40 G4LEDATA: points to low energy data base 
 41 
 42 The required data-file for the detailed field map can be downloaded from:
 43    http://cern.ch/geant4-data/datasets/PurgMag3D.TABLE.gz
 44 
 45 
 46 2. How to run the example
 47 -------------------------
 48 
 49 - Run the "PurgMag" executable.
 50 - File PurgMag.TABLE needs to be available in the current directory in order to run correctly.
 51 - For visualisation use vis.mac. 
 52 - Interactive or batch modes possible.
 53   Default: Interactive mode.
 54 
 55 To run a certain number of events in interactive mode, 
 56 type the following at the "idle>" prompt:
 57 
 58 idle> run/beamOn  NumberOfEvents
 59 idle> exit
 60 
 61 - Simulation histogram output is stored in purgmag_101.cvs (e-), 
 62  purgmag_102.cvs (gammas), purgman_103.cvs (e+) 
 63 
 64 1)Ntuple with position, energy and momentum for electrons
 65 2)Ntuple with position, energy and momentum for photons 
 66   (not needed in this example, will be used in further development)
 67 3)Ntuple with position, energy and momentum for positrons
 68   (not needed in this example, will be used in further development)
 69 
 70 A default visualisation macro (vis.mac) is pre-loaded before interactive runs.
 71 Executing it from the build directory:
 72     $ ./PurgMag 
 73 runs vis.mac before giving you an interactive prompt.
 74 
 75   
 76 3. Detector description
 77 -----------------------
 78 
 79 Simply a measurement volume. All particles entering the volume are scored.
 80 
 81 
 82 4. Physics processes
 83 --------------------
 84 
 85 This example uses the standard Electromagnetic processes.
 86 
 87 
 88 5. Particle Generator
 89 ----------------------
 90 
 91 The PurgMagPrimaryGeneratorAction sets the initial state of tracks to
 92 
 93 -electrons 50MeV
 94 -Start position (0, 0, 15cm)
 95 -Momentum direction (0, 0, -1)
 96 
 97  
 98 6. Geometry and materials
 99 --------------------------
100 
101 The world consists of Vacuum to minimize interactions of the electrons
102 with the medium. The purging magnet is implemented as a 3D field grid 
103 of field values and geometerically as a pole gap made of iron. The 
104 measurement volume also contains vacuum. 
105 
106 The field is interpolated using a simple linear interpolation in two 
107 dimensions (z and rho).
108 
109 7. Comparison
110 --------------
111 
112 The design of the magnetic field was made with the OPERA 3D package 
113 which is an electromagnetic finite element and finite difference 
114 analysis software. The deviation in the y-direction (ey in Ntuple 1)
115 has also been calculated in the OPERA 3D module TOSCA for comparison. 
116 
117 TOSCA:  deviation y-direction: 35.112 cm
118 GEANT4: deviation y-direction: 35.170 cm (updated after PurgMag.pdf)
119 
120 ****************************************************************
121 *                                                              *
122 * More information about the setup and geometry in PurgMag.pdf *
123 *                                                              *
124 ****************************************************************