File: geant321-doc.README.debian

package info (click to toggle)
cernlib 2004.11.04.dfsg-0sarge1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 29,292 kB
  • ctags: 1,159
  • sloc: ansic: 2,285; sh: 840; makefile: 582
file content (173 lines) | stat: -rw-r--r-- 5,702 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
geant321-doc package - README.Debian
--------------------

The documentation available here is as follows.  In parentheses ( ) are the
names that these files originally had in the Cernlib source tree.  The section
of the GEANT3 code described by each document is given in square brackets [ ].

In addition to this documentation, you should look at the README.Debian
for the geant321 or libgeant1-dev package - it describes some functions and
subroutines that had to be removed in order for GEANT to be DFSG-free.

-- Kevin McCarty <kmccarty@princeton.edu> Thu, 10 Mar 2005

GEANT 3 CORE DOCUMENTATION
--------------------------

These files have all been merged into the file
/usr/share/doc/geant321-doc/geant321.txt

If you have Internet access, a graphical version of this document is
available in PDF format at this URL:
http://wwwasdoc.web.cern.ch/wwwasdoc/pdfdir/geant.pdf

* The section [BASE] (gbase.doc) gives an outline of GEANT3, including
  flow charts of program operation, input/output, and program examples.

  Contents:
  + Introduction to GEANT3
    - GEANT3 Applications
    - Event Simulation Framework
    - Initialization
    - Event Processing
    - Termination
  + Simplified Program Flow Chart
  + Overview of COMMON Blocks
    - Introduction
    - Dynamic Core
    - Other Labelled Common Blocks
  + Summary of Data Cards
    - Introduction
    - User Defined Data Cards
    - Summary of the Most Important GEANT3 Data Cards
  + The Reference System and Dimensional Units
    - The Master Reference System (MARS)
    - The Local Reference Systems (MRS and DRS)
    - The Dimensional Units
  + Examples of MAIN Program and User Initialization
  + The System Initialization Routines
  + Steering Routines for Event Processing
  + Examples of User Termination and Related Routines

* The section [CONS] (gcons.doc) describes routines related to storage
  and retrieval of information for materials, tracking media and particles in
  a detector.

  Contents:
  + Introduction to the section CONS
    - The Section CONS
    - Materials
    - Tracking Medium Parameters
    - Particles

* The section [DRAW] (gdraw.doc) describes the routines for drawing the
  detector, the detector geometrical tree, particle trajectories, and hits.

  Contents:
  + Introduction to the Drawing Package
    - The Drawing Package
    - Drawing the Detector
    - Drawing the Geometrical Tree
    - Drawing the Geometrical Specifications
    - Drawing Particle Trajectories
    - Drawing Hits
    - The View Banks
    - Other Features
    - Basic and Advanced Graphics
    - Running Instructions
    - Summary
  + Labelled COMMON Blocks Related to Section DRAW
  + The View Data Structure JDRAW

* The section [GEOM] (ggeom.doc) describes the routines for providing
  geometric information to Geant.

  Contents:
  + Introduction to the Geometry Package
    - The Geometry Package
    - The Volume Definition
    - Volumes with Contents
    - Overlapping Volumes
    - The Physical Tree
    - The Data Structure JVOLUM and the COMMON Block /GCVOLU/
    - The Basic User Tools
    - The Optimisation Tools
  + Labelled COMMON Blocks Related to Section GEOM
  + The System Shapes
  + The Volume Data Structure JVOLUM

* The section [HITS] (ghits.doc) describes the routines to store,
  retrieve and print information about events (hits) in a detector.

  Contents:
  + Introduction to the Detector Response Package
    - The Detector Response Package
    - Sets and Detectors
    - The Basic User Tools
    - Retrieval of Geometrical Information

* The section [IOPA] (giopa.doc) describes routines for reading and writing
  the GEANT3 data structures.

  Contents:
  + The I/O Service Routines
  + Routines to Perform I/O

* The section [KINE] (gkine.doc) defines the kinematics data
  structures, JVERTX and JKINE.

* The section [PHYS] (gphys.doc) describes the routines available for
  simulation of particle physics, such as decays in flight, multiple
  scattering, and hadronic interactions.

  Contents:
  + Introduction to the Section PHYS
    - The Physics Processes
    - Continuous Electromagnetic Processes
    - Discrete Electromagnetic Processes
    - Hadronic Processes
      ** Note that FLUKA is not available in the Debian packages of GEANT3.
    - Muon Interaction

* The section [TRAK] (gtrak.doc) describes routines for tracking
  particles through the matter of a detector.

  Contents:
  + Introduction to the Tracking Package
    - The Tracking Package
    - The Step Size
    - The Subroutines GTREVE and GTRACK
    - Magnetic Field Routines
    - Information Available at Tracking Time, and the Subroutine GUSTEP
    - Connection with the Detector Response Package
    - Connection with the Drawing Package
  

OTHER DOCUMENTS
---------------

* The gheisha/ (ghdoc/) directory contains lists of COMMON parameters and ID
  numbers used by GHEISHA, a set of hadronic interaction routines for GEANT3.

* ertrak.txt (gedoc) describes the ERTRAK routines worked out by the
  European Muon Collaboration for calculating particle trajectories,
  the transport matrix, and the propagated error covariance matrix.

  Contents:
  1. Introduction
  2. Definitions
     2.1. Track Variables, Representations
     2.2. Error Propagation
  3. Description of the User Routines and COMMONs
     3.1. User Routines
     3.2. User Commons
  4. Examples of Application
     4.1. The Simplest Case: Representing the Trajectory at Another Point
     4.2. Joining Track Elements in Different Parts of the Detector
     4.3. Prediction of the Trajectory
     4.4. Fitting Trajectory Parameters
  5. Interface with GEANT
     - Flow Chart for Subroutine ERTRAK
  6. Acknowledgements
  +  References