dna/range/README.md

0001 \page Examplerange Example range
0002
0003 \author S. Incerti et al. (a, *) \n
0004 a. LP2i, IN2P3 / CNRS / Bordeaux University, 33175 Gradignan, France \n
0005 * e-mail: incerti@lp2ib.in2p3.fr  \n
0006
0007 ## INTRODUCTION.
0008
0009 The range example shows how to calculate range of electrons
0010 in liquid water using the Geant4-DNA physics processes and models.
0011
0012 It is adapted from svalue.
0013
0014 This example is provided by the Geant4-DNA collaboration.
0015
0016 These processes and models are further described at:
0017 http://geant4-dna.org
0018
0019 Any report or published results obtained using the Geant4-DNA software shall
0020 cite the following Geant4-DNA collaboration publications:
0021 Med. Phys. 51 (2024) 5873–5889 \n
0022 Med. Phys. 45 (2018) e722-e739 \n
0023 Phys. Med. 31 (2015) 861-874 \n
0024 Med. Phys. 37 (2010) 4692-4708 \n
0025 Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178 \n
0026
0027 ## GEOMETRY SET-UP
0028
0029 The geometry is a 1 m radius sphere of liquid water (G4_WATER
0030 material). Particles are shot randomly from the sphere centre.
0031
0032 Radius of the sphere, physics constructor and energy can be
0033 controlled by the range.in macro file.
0034
0035 ## SET-UP
0036
0037 Make sure G4LEDATA points to the low energy electromagnetic data files.
0038
0039 The code can be compiled with cmake.
0040
0041 It works in MT mode.
0042
0043 ## HOW TO RUN THE EXAMPLE
0044
0045 In interactive mode, run:
0046
0047 ```
0048 ./range range.in
0049 ```
0050
0051 The range.in macro allows a full control of the simulation.
0052
0053 The histo.in macro is also provided for the creation of histograms.
0054
0055 The computation of ranges is performed in the
0056 TrackingAction::PostUserTrackingAction method. The computation
0057 for electrons uses the primary particle track length and the computation
0058 for incident particles undergoing Geant4-DNA charge exchange processes, such
0059 as protons, hydrogen, alpha particles and their charge states, is specific.
0060
0061 ## PHYSICS
0062
0063 You can select Geant4-DNA physics constructor in range.in.
0064
0065 A tracking cut can be applied if requested.
0066
0067 ## SIMULATION OUTPUT AND RESULT ANALYSIS
0068
0069 The output results consist in a text file (range.txt), containing :
0070 - energy of incident particles (in eV)
0071 - track length of primary particle (in nm)
0072 - rms of track length of primary particle (in nm)
0073 - projected length of primary particle (in nm)
0074 - rms of projected length of primary particle (in nm)
0075 - penetration of primary particle (in nm)
0076 - rms of penetration of primary particle (in nm)
0077
0078 Note: rms values correspond to standard deviation.
0079
0080 Results in this file can be displayed using the ROOT macro plot.C:
0081 ```
0082 root plot.C
0083 ```