A Hands-on introduction to Geant4 - PowerPoint PPT Presentation

a hands on introduction to geant4 n.
Skip this Video
Loading SlideShow in 5 Seconds..
A Hands-on introduction to Geant4 PowerPoint Presentation
Download Presentation
A Hands-on introduction to Geant4

play fullscreen
1 / 200
A Hands-on introduction to Geant4
Download Presentation
Download Presentation

A Hands-on introduction to Geant4

- - - - - - - - - - - - - - - - - - - - - - - - - - - E N D - - - - - - - - - - - - - - - - - - - - - - - - - - -
Presentation Transcript

  1. A Hands-on introduction to Geant4 Andrea Dell’Acqua CERN-EP/ATC dellacqu@mail.cern.ch

  2. Monday, Oct. 8th • 9:00-12:30 • Introduction • Installation • DAWN + display features • Rotation Matrixes • 3-vectors • 14:00-17:00 • Geometry (part I) • Simple solids • Logical Volumes • Positioning

  3. Introduction

  4. Geant4 - Why? • Geant3 was a detector simulation program developed for the LEP era • Fortran, ZEBRA • Electromagnetic physics directly from EGS • Hadronic physics added as an afterthought (and always by interfacing with external packages) • Powerful but simplistic geometry model • Physics processes very often limited to LEP energy range (100 Gev) • (Painfully) debugged with the help and the collaboration of 100s of physicist from all over the world • LHC detectors need powerful simulation tools for the next 20 years • reliability, extensibility, maintainability, openness • good physics, with the possibility of extending

  5. Geant4 - Why? Geant3 The geometry model is limited to a pre-defined set of basic shapes. Adding a new shape requires changing the code of several (~20) routines. Interface to CAD systems in not possible Tracking is the result of several iterations (by different people) and as such it has become a garbled mess. Not for the fainthearted EM physics is built in, but several processes are missing and their implementation would be very hard Hadronic physics is implemented via external (and obsolete) packages. Modifications require the author’s intervention Geant4 The geometry has been based since the beginning on a CAD-oriented model. The introduction of a new shape does not influence tracking Tracking has been made independent from geometrical navigation, tracking in electromagnetic fields (or any field) has been improved EM and hadronic physics implemented in terms of processes. A process can be easily added or modified by the user and assigned to the relevant particles with no change in the tracking. The cut philosophy has been changed so as to make result less dependent on the cuts used for the simulation. Framework for physics parameterisation in place

  6. Geant4 - How? • The principle points behind the Geant4 development have been: • Ease on maintainability • openness of the design • performance • development by a rather substantial group of physicists • An Object Oriented approach facilitates the achievement of these goals • the problem domain is naturally split into categories which can be tackled by different groups (with different expertise) • the process (if done properly) is self-documenting. The components are relatively independent from each other and can easily be replaced without affecting the whole program too much

  7. Geant4 - How? (2) • Geant4 is a toolkit • the framework part in Geant4 has been reduced to a minimum, so as to allow the user to implement his/her own program structure • bits and pieces of Geant4 can be used independently from the rest • no main program is provided • libraries have been made as granular as possible, in order to reduce (re-) compilation time and to allow the user to only link against those parts of G4 which are needed • C++ as implementation language • de-facto standard for what concerns OO programming these days • high performance • big commercial support, well known in the scientific world • there is practically no Fortran in Geant4 anymore, hence the user must know some elements of C++ in order to get the best from G4

  8. Geant4 - How? (3) • Make Geant4 as independent as possible from commercial packages • You don’t need an Objectivity license to run Geant4! • Interfaces to commercial products have been provided whenever it was felt appropriate (so you can use Objectivity to store your data) • The only commercial package which was needed to run Geant4 was Rogue Wave’s Tools.h++ which did provide utility classes (as vectors, strings, containers and iterators), waiting for the Standard Template Library to become available. An interface to STL has been made available with the 4.0.1 release, hence Tools.h++ in not needed anymore (in principle…) • The Geant4 code is written in reasonable C++ • migration to ISO/ANSI C++ to follow when most of the compilers will deal with it… • for the moment use Stroustrup’s 2nd edition...

  9. Geant4 documentation • For a complete documentation set go to: • http://wwwinfo.cern.ch/asd/geant4/geant4.html • There you’ll find • Information on how to install a Geant4 application • Documentation on how to get started with Geant4 and how to build your detector simulation program • Class diagrams which document the G4 design • A complete Class Documentation set • Useful links

  10. Geant4 status • In terms of performance and potentiality, Geant4 should be at least at the same level of Geant3 • First “production” version (geant4.0.0) released at the end of 1998 • Full of bugs • Several part still under heavy development • Many improvements proposed, A&D cycles still undergoing • Physics part still being improved • new version (geant4.0.1) available since the end of July • bug fixes • Interface to STL • Breaks user’s code :( • geant4.1.0 foreseen by the end of 1999 • new hadronic physics, bug fixes • move to ISO/ANSI C++, based on STL, drop Tools.h++

  11. A word on STL • STL provides a set of utility classes (vectors, lists, maps) to be used as tools • No compiler (as of today) provides a consistent set • Tools.h++ was chosen (when the G4 project was started) as an interim replacement for STL, with the idea of migrating to STL as soon as a standard implementation would become available • 4.0.1 provides an interface to STL (prototype) but • using the ObjectSpace STL on HP and SUN • using the native STL on Linux (but needs modifying a system include to get it running on RedHat 5.2!) • We are going to use Tools.h++ for the moment, waiting for better days...

  12. Installation

  13. How to install Geant4 • To run a Geant4 application you must: • Install the Geant4 libraries on your system • The source code is available from the web • Install the CLHEP library and code • These can be taken from • or from http://wwwinfo.cern.ch/asd/geant4/geant4.html and then click on source /afs/cern.ch/sw/lhcxx /afs/cern.ch/atlas/project/geant4/CLHEP

  14. How to install Geant4 (2) • In case you want to use Tools.h++, install the Rogue Wave Tools.h++ libraries and code • This is the only commercial component need by Geant4 as of today • Used for container classes (like vectors, maps, lists) but soon to be replaced by an interface built on top of the Standard Template Library (STL) • The RW stuff is commercial, but waiting for the STL interface, you can “steal” it from: • or from /afs/cern.ch/atlas/project/geant4/rogue http://home.cern.ch/rimoldi/g4simulation/geant4.html

  15. How to install Geant4 (3) • Once you got all this code on your machine, you simply follow a straightforward procedure • Set the G4SYSTEM variable • Set the CLHEP_BASE_DIR variable to point to where you put the CLHEP stuff • Set the RWBASE variable to point to where you installed RW Tools.h++ • cd to the source directory of your geant4 installation and make all libraries setenv G4SYSTEM SUN-CC setenv CLHEP_BASE_DIR /afs/cern.ch/atlas/project/geant4/CLHEP/$G4SYSTEM/pro setenv RWBASE /afs/cern.ch/atlas/project/geant4/rogue/$G4SYSTEM cd /afs/cern.ch/atlas/project/geant4/4.0.1/geant4.0.1/source gmake

  16. How to install Geant4 (4) • In case you want to use the STL interface, set the G4USE_STL variable setenv G4USE_STL 1 • if you are using a system where the ObjectSpace implementation of STL is required, set the G4USE_OSPACE variable and tell the system where the ObjectSpace stuff was installed setenv G4USE_OSPACE 1 setenv OSPACE_BASE_DIR /afs/cern.ch/sw/lhcxx/specific/sun/ObjectSpace/2.1/ToolKit

  17. How to install Geant4 (5) • G4SYSTEM is the variable one must set to tell gmake which system and compiler are you running on • G4SYSTEM can be: AIX-xlC AIX 4.3, xlC set for AIX (default) SUN-CC SunOS 5.6, CC 4.2 HP-aCC HP/UX 10.20, aCC A.01.09 SGI-CC SGI-IRIX 6.2, C++ 7.2 DEC-cxx DEC-OSF/1 4.0, DEC C++ Linux-g++ Linux (RH 5.1), egcs 1.1 WIN32-VC-NICE NiceNT and MSVC++ 5.0, installed locally together with CYGWIN32 WIN32-G++-NICE NiceNT and CYGWIN32 with g++ as base compiler

  18. How to install Geant4 (6) • The visualization libraries will need some special treatment • Go to the source/visualization directory of your Geant4 installation • Read the README file over there and choose the graphics drivers you want to get installed • make the visualization libraries cd /afs/cern.ch/atlas/project/geant4/4.0.1/geant4.0.1/source/visualization setenv G4VIS_BUILD_DAWN_DRIVER 1 setenv G4VIS_BUILD_DAWNFILE_DRIVER 1 gmake

  19. How to build an example • Set the G4INSTALL variable to point where Geant4 was installed • Set the CLHEP_BASE_DIR and RWBASE variable as in the case of the Geant4 installation • Set the G4SYSTEM variable • Set the G4WORKDIR variable to point to your working directory • go into the example directory (e.g $G4WORKDIR/N02), run gmake and pray… The executable will be put in $G4WORKDIR/bin/$G4SYSTEM setenv G4INSTALL /afs/cern.ch/atlas/project/geant4/4.0.1/geant4.0.0 setenv G4WORKDIR /export/home/userN/geant4

  20. How to build an example (2) • For examples using graphics you have to set a few more variables. We are going to use the simplest among the graphics systems implemented with Geant4, DAWN • Tell the visualisation that we are going to use DAWN • Tell the visualisation where to find the DAWN executable • Reset your PATH to include G4DAWN_HOME setenv G4VIS_USE_DAWN 1 setenv G4DAWN_MULTI_WINDOW 1 setenv G4DAWN_HOME /afs/cern.ch/atlas/project/geant4/DAWN/SUN-CC set path= ( $path $G4DAWN_HOME )

  21. To sum up... setenv G4INSTALL /afs/.fnal.gov/ups/geant/v4.0.1/geant4 setenv CLHEP_BASE_DIR /afs/.fnal.gov/ups/geant/v4.0.1/CLHEP/$G4SYSTEM/1.4 setenv RWBASE /afs/.fnal.gov/ups/geant/v4.0.1/rogue/$G4SYSTEM setenv G4SYSTEM SUN-CC setenv G4WORKDIR /afs/fnal.gov/files/home/room1/classN/geant4 setenv G4VIS_USE_DAWN 1 setenv G4DAWN_MULTI_WINDOW 1 setenv G4DAWN_HOME /afs/.fnal.gov/ups/geant/v4.0.1/DAWN/SUN-CC set path = ( $path $G4DAWN_HOME ) • The variables to set for this course (every time you log in) are • These definitions (bar G4WORKDIR) should be grouped into a file to be “sourced” at the beginning of a session source G4Setup_Sun.sh (find one under /afs/.fnal.gov/ups/geant/v4.0.1)

  22. How GNUmake works in Geant4 • The GNUmake process in Geant4 is mainly controlled by the following scripts (placed into $G4INSTALL/config) • architecture.gmk • defines the architecture specific settings and paths • common.gmk • defines all general GNUmake rules for building objects and libraries • globlib.gmk • defines all general GNUmake rules for building compound libraries • binmake.gmk • defines all general GNUmake rules for building executables • GNUmakefiles • placed inside each directory in the Geant4 distribution and defining specific directives to build a library (or a set of libraries) or an executable

  23. How GNUmake works in Geant4 (2) • The kernel libraries are placed by default in $G4INSTALL/lib/$G4SYSTEM • Executable binaries are placed in $G4WORKDIR/bin/$G4SYSTEM • Temporary files (object files, dependency files, data products of the compilation process) are placed in $G4WORKDIR/tmp/$G4SYSTEM • don’t delete it!!! You would have to recompile all your files!!! • G4WORKDIR is set by default to $G4INSTALL and it should be reset by the user

  24. Naming conventions • Sorry, but it is necessary… • All Geant4 source files have a .cc extensions, all Geant4 header files carry a .hh extension • All Geant4 classes have their name prefixed with a G4 • G4RunManager, G4Step, G4LogicalVolume • Abstract classes add a V to the prefix • G4VHit, G4VPhysicalVolume • Each word in a composite name is capitalized • G4UserAction, G4VPVParameterisation • Methods and functions obey the same naming conventions as the class names • G4RunManager::SetUserAction(), G4LogicalVolume::GetName()

  25. Basic types • For basic numeric types, different compilers on different plattforms provide different value ranges • To assure portability, Geant4 redefines the basic types for them to have always the same bit yield • the definitions of these types are all placed in a single header file (globals.hh), which also provides inclusion of all system headers, as well as global functions needed by the Geant4 kernel int  G4int long  G4long float  G4float double  G4double bool  G4bool (native, or from RW, or from CLHEP) string  G4String (from RW, and now from STL)

  26. The main program • Geant4 is a detector simulation toolkit, hence it does not provide a main() method • Users must supply their own main program to build their simulation program • The G4RunManager class is the only manager class in the Geant4 kernel which should be explicitly instantiated in the main program to specify: • How the detector geometry should be built • Which physics processes one is interested in • How the primary particles in an event should be produced • Additional requests during the simulation procedures

  27. G4RunManager • G4RunManager is the root class of the Geant4 hierarchy • It controls the main flow of the program: • Construct the manager classes of Geant4 (in its constructor) • Manages initialization procedures including methods in the user initialization classes (in its method Initialize() ) • Manages event loops (in its method BeamOn() ) • Terminates manager classes in Geant4 (in its destructor)

  28. User initialization and action classes • Geant4 has two kinds of user defined classes • User initialization classes • used for customizing the Geant4 initialization • assigned to G4RunManager by invoking the SetUserInitialization() method • User action classes • used during the run processing • assigned to G4RunManager by invoking the SetUserAction() method • The implementation of three user defined classes is mandatory • setting up of the geometry • event kinematics • physics processes

  29. Mandatory user classes Three user classes have to be implemented by the user (two initialization classes and one action class) The base classes of these mandatory classes are abstract and no default implementation is provided G4RunManager checks whether objects belonging to these classes have been instanciated when Initialize() and BeamOn() are invoked Users must inherit from the abstract base classes provided by Geant4 and derive their own classes

  30. Mandatory user classes (2) G4VUserDetectorConstruction (initialization) the detector set-up must be described in a class derived from this Materials Geometry of the detector Definition of sensitive detectors Readout schemes G4VUserPhysicsList (initialization) Particles and processes to be used in the simulation cutoff parameters G4VUserPrimaryGeneratorAction (action) Primary event kinematics

  31. Optional user action classes G4UserRunAction run by run G4UserEventAction event by event G4UserStackingAction to control the order with which particles are propagated through the detector G4UserTrackingAction Actions to be undertaken at each end of the step G4UserSteppingAction Actions to be undertaken at the end of every step

  32. An example of main() (batch program) #include “G4RunManager.hh” // from Geant4, declaration of the run manager #include “G4UImanager.hh // from Geant4, declaration of the User Interface manager #include “MyDetectorConstruction.hh” // by the user; definition of the detector geometry #include “MyPhysicsList.hh” // by the user, list of physics processes to be added #include “MyPrimaryGenerator.hh” // by the user, kinematics of the event int main () { G4RunManager* runManager=new G4RunManager; // the run manager runManager->SetUserInitialization(new MyDetectorConstruction); // the geometry runManager->SetUserInitialization(new MyPhysicsList); // the physics runManager->SetUserAction(new MyPrimaryGenerator); // the kinematics runManager->Initialize(); // run initialization G4UImanager* UI=G4UImanager::GetUIpointer(); // pointer to the UI UI->ApplyCommand(“run/verbose 1”); // set the “print”level int numberOfEvent=3; // nr. of evts to be run runManager->BeamOn(numberOfEvent); // generate the events delete runManager; // end of run return 0; }

  33. Batch mode with macro file int main(int argc, char** argv) { // construct the default run manager G4RunManager* runManager = new G4RunManager; runManager->SetUserInitialization(new MyDetectorConstruction); runManager->SetUserInitialization(new MyPhysicsList) runManager->SetUserAction(new MyPrimaryGeneratorAction); runManager->Initialize(); // read a macro file G4UIManager* UI = G4UImanager::GetUIpointer(); G4String command = “/control/execute “; G4String fileName = argv[1]; UI->ApplyCommand(command+fileName); delete runManager; return 0; }

  34. Batch mode with macro file (2) • The previous example can be run with the command > myProgram run.macro where myProgram is the name of the executable and run.macro is a command macro which could look like: # set verbose level for this run /run/verbose 2 /event/verbose 0 /tracking/verbose 2 # 100 electrons of 1GeV Energy /gun/particle e- /gun/energy 1 GeV /run/beamOn 100

  35. Interactive mode int main(int argc, char** argv) { G4RunManager* runManager = new G4RunManager; runManager->SetUserInitialization(new MyDetectorConstruction); runManager->SetUserInitialization(new MyPhysicsList); G4VisManager* visManager = new MyVisManager; visManager->initialize(); runManager->SetUserAction(new MyPrimaryGeneratorAction); runManager->Initialize(); G4UIsession* session = new G4UIterminal; session->SessionStart(); delete session; delete visManager; delete runManager; return 0; }

  36. Interactive mode (2) • The previous example will be run with the command > myProgram • where myProgram is the name of your executable object • After the initialization phase, Geant4 will prompt: Idle> • At this point, an interactive session can begin: Idle> /vis~/create_view/new_graphics_system DAWN Idle> /vis/draw/current Idle> /run/verbose 1 Idle> /event/verbose 1 Idle> /tracking/verbose 1 Idle> /gun/particle mu+ Idle> /gun/energy 10 GeV Idle> /run/beamOn 1 Idle> /vis/show/view

  37. ExampleN02 • Very basic example, depicting some kind of fix target experimental setup • not very well written but very much complete and good for reference • Change directory to geant4/N02 which contains: • a GNUmakefile • very basic, essentially defining the name of the executable and running binmake.gmk • the main program (exampleN02.cc) • a macro file (prerun.g4mac) • an include directory • class header files • a src directory • implementation of all methods

  38. ExampleN02 (cont’d) • create the executable with gmake • run the executable by typing • $G4WORKDIR/bin/$G4SYSTEM/exampleN02 • start the DAWN graphics system by typing • /vis~/create_view/new_graphics_system DAWN • draw the experimental setup by • /vis/draw/current • and get the GUI by • /vis/show/view • tell the tracking of storing all track segments by • /tracking/storeTrajectory 1 • and run one event • /run/beamOn 1

  39. ExampleN02 (cont’d) • You can change the beam condition by using the /gun commands • /gun/List // to have a list of all possible particles • /gun/particle e+ • /gun/energy 10 GeV • /gun/position 0 10 30 cm • /gun/direction .3 .3 .1 • have a look at the online help to see what can you do...

  40. ExampleN02 (cont’d)

  41. DAWN • DAWN is a vectorized 3D PostScript processor developed at the Fukui University • Well suited to prepare high quality outputs for presentation and/or documentation • Useful for detector geometry debugging (it comes with a facility, DAVID, which allows to detect overlapping volumes) • Remote visualization, cut view, off-line re-visualization are supported by DAWN • A DAWN process is automatically invoked as a co-process of Geant4 when visualization is performed and 3D data is passed with inter-process communication via a file or the TCP/IP socket

  42. DAWN (2) • There are two kinds of DAWN drivers • DAWN-File • DAWN-Network • The DAWN-File driver send 3D data to DAWN via an intermediate file (called g4.prim) in the current directory. The contents of the file can be re-visualized (without running Geant4) by simply running DAWN on it dawn g4.prim • The DAWN-Network driver send 3D data to DAWN via the TCP/IP socket or the named pipe and it can be used to perform remote visualization • If you have no network, set the environment variable G4DAWN_NAMED_PIPE to 1, to switch the default socket connection to the named pipe within the same host machine

  43. DAWN GUI (page 1) Next page Camera distance Angles Camera Position Size Viewing mode Axes

  44. DAWN GUI (page 2)

  45. DAWN GUI (page 3)

  46. DAWN GUI (page 4) Save the picture in an EPS file Don’t forget this! Have a preview of the picture

  47. Geant4 and CLHEP • Geant4 makes a rather substantial use of CLHEP components • System of units • Vector classes and matrices • G4ThreeVector (typedef to Hep3Vector) • G4RotationMatrix (typedef to HepRotation) • G4LorentzVector (typedef to HepLorentzVector) • G4LorentzRotation (typedef to HepLorentzRotation) • Geometrical classes • G4Plane3D (typedef to HepPlane3D) • G4Transform3D (typedef to HepTransform3D) • G4Normal3D (typedef to HepNormal3D) • G4Point3D (typedef to HepPoint3D) • G4Vector3D (typedef to HepVector3D)

  48. System of units • Geant4 offers the possibility to choose and use the units one prefers for any quantity • Geant4 uses an internal and consistent set of units based on: • millimeter (mm) • nanosecond (ns) • Mega electron Volt (MeV) • Positron charge (eplus) • Degree Kelvin (kelvin) • Amount of substance (mole) • Luminosity intensity (candela) • Radian (radian) • steradian (steradian)

  49. System of units (2) millimeter=mm=1; meter = m = 1000*mm; ……. m3 = m*m*m; …….. • All the units are defined from the basic ones • These definitions are available in the file • source/global/management/include/SystemOfUnits • … and are now part of CLHEP • The user is free to change the system of units to be used by the kernel

  50. System of units (3) • Avoid hard coded data • you better specify the unit of the data you are going to introduce • The Geant4 code is written respecting these specification and this makes the code independent from the system of units chosen by the user • Be careful!!! • Some built-in commands for the User interface require the unit to be specified G4double Size = 15.*km, KineticEnergy = 90.3*GeV, density = 11*mg/cm3; G4double radius=10.*m; // internally converted: radius=10000 …. G4double xposition = (radius*cos(alpha*rad))*cm // is this really what you want to do?? G4double yposition = (radius*sin(alpha*rad))*cm /gun/energy 10 GeV