CCC-0331 EGS4.

1. NAME OR DESIGNATION OF PROGRAM:  EGS4.

3. DESCRIPTION OF PROGRAM OR FUNCTION

The EGS code system is one of a chain of three codes designed to solve the electromagnetic shower  problem by Monte Carlo simulation. This chain makes possible simulation of almost any electron-photon transport problem conceivable. The structure of the system, with its global features,  modular form, and structured programming, is readily adaptable to virtually any interfacing scheme that is desired on the part of the  user.
EGS4 is a package of subroutines plus block data with a flexible user interface. This allows for greater flexibility without requiring the user to be overly familiar with the internal details of the code. Combining this with the macro facility capabilities of  the Mortran3 language, this reduces the likelihood that user edits will introduce bugs into the code. EGS4 uses material cross section  and branching ratio data created and fit by the companion code, PEGS4.
EGS4 allows for the implementation of importance sampling and other variance reduction techniques such as leading particle biasing, splitting, path length biasing, Russian roulette, etc.

4. METHOD OF SOLUTION

EGS employs the Monte Carlo method of solution. It allows all of the fundamental processes to be included and arbitrary geometries can be treated, also. Other minor processes, such as photoneutron production, can be added as a further generalization. Since showers develop randomly according to the quantum laws of probability, each shower is different. We again are  led to the Monte Carlo method.

5. RESTRICTIONS ON THE COMPLEXITY OF THE PROBLEM:  None noted.

6. TYPICAL RUNNING TIME

The running time is dependent upon the problem being solved.

NEA-DB ran most of the test cases included in this package on VAX-11/780 and IBM 3090 computers. Execution times for the test cases together with cross section preparation with PEGS4 were up to 30 minutes on VAX.

This version is the UNIX Version 3.0. It was installed and the sample problems have been executed by the NEA Data Bank in the following systems:
1) DEC 3000 Model 300X (Alpha architecture workstation) under DEC OSF/1 V3.2
2) Sun Solaris (UNIX System V Release 4.0 (psisun)) under SunOS 5.3
The following sample problems and benchmark programs are provided with this package:
tutor1    \
tutor2    |
tutor3    |
tutor4    \___> seven tutorial cases
tutor4p   /
tutor5    |
tutor6    |
tutor7    /
xyzdos   - timing benchmark code (running on 2 sample problems)
dosrz    - general purpose dose scoring code for cylindrical-
           planar geometry
flurz    - general purpose fluence scoring code for cylindrical-
           planar geometry
xyzp     - running the xyzdos benchmark code using the PRESTA
           algorithm (PRESTA = Parameter Reduced Electron Step
           Transport Algorithm, special algorithm for electron
           transport)
The seven tutorial codes running time range from a few seconds to a
few dozens of seconds. In the DEC-Alpha workstation, the benchmark code xyzdos, takes about 90 seconds to run the problem specified in  the input file 'benchf' and about 920 seconds to run the problem specified in the input file 'benche' whereas the code xyzp, implementing the PRESTA algorithm, takes about 120 seconds to run the test case of input file 'benchf' and about 1460 to run the test  case of input file 'benche'.

This version is the PC Version 3.1. It was installed and the sample problems have been executed by the NEA Data Bank in a PC DELL Optiplex GXPRO equipped with a Pentium PRO processor at 200 MHz,
total memory 64 MByte, under Windows NT 4.00 (execution under DOS).
    The following sample problems and benchmark programs are provided        
with this package:                                                          
    tutor1    \
    tutor2    |
    tutor3    |
    tutor4    \___> seven tutorial cases
    tutor4p   /
    tutor5    |
    tutor6    |
    tutor7    /
    xyzdos   - timing benchmark code (running on 2 sample problems)             
    dosrz    - general purpose dose scoring code for cylindrical-               
               planar geometry
    flurz    - general purpose fluence scoring code for cylindrical-            
               planar geometry
    xyzp     - running the xyzdos benchmark code using the PRESTA               
               algorithm (PRESTA = Parameter Reduced Electron Step              
               Transport Algorithm, special algorithm for electron              
               transport)
    The seven tutorial codes running time range from a few tens of seconds to a few seconds. The benchmark code XYZDOS, takes about 21.2 seconds to run the problem specified in the input file BENCHF.INP and about 220.9 seconds to run the problem specified in the input file BENCHE.INP; the CPU time required to execute the benchmark code XYZP on the input files BENCHF.INP and BENCHE.INP is of about 21.2 seconds and 447.9 seconds respectively. The code DOSRZ takes about 137.5 seconds to run the test case of input file CO60SPEC.INP (100000 histories) and about 152.3 seconds to run the test case of input file CO60MONO.INP (100000 histories).

7. UNUSUAL FEATURES OF THE PROGRAM:

8. RELATED AND AUXILIARY PROGRAMS

DATA LIBRARIES:
A variety of automated data sets (18 files) is provided.
EGS (Electron-Gamma Shower), based on code development in the early 1960s by H.H. Nagel, represents several years of additional development.

10. REFERENCES

- Richard L. Ford and Walter R. Nelson
  The EGS Code System: Computer Programs for the Monte Carlo
  Simulation of Electromagnetic Cascade Showers, (Version 3)
  SLAC-210 (June 1978).
- Hideo Hirayama:
  Revision of the Sternheimer Density Effect Coefficients in PEGS4
  KEK Internal 95-17 (November 1995) R

- W.R. Nelson, H. Hirayama and W.O. Rogers:
The EGS4 Code System SLAC-265 (December 1985).
- A. Bielajew:
PRESTA Information Informal Notes (July 1987).
- W.R. Nelson and T.M. Jenkins:
Writing SUBROUTINE HOWFAR for EGS4 SLAC TN-87-4, SLAC, Stanford (August 1988).
- NEA-DB:
Appendix to the EGS4 Report - Source: "Review of Particle Properties", by the
Particle Data Group Physics Letters B239, 12 April 1990 (NEA-DB (10-12-93))
- A. Bielajew et al.:
History, Overview and Recent Improvements of EGS4 SLAC-PUB-6499 (NRC-PIRS-0436,
KEK Internal 94-4) (Revised June 1, 1994)
- A.F. Bielajew and D.W.O. Rogers:
PRESTA - The Parameter Reduced Electron - Step Transport Algorithm for Electron
Monte Carlo Transport PIRS No.042 (July 1986)
- A. F. Bielajew: README.general.3.0 (December 26, 1996)
- A. F. Bielajew: Directions for EGS4 Installation (October 19, 1995)
- W.R. Nelson, H. Hirayama and W.O. Rogers:
The EGS4 Code System SLAC-265 (December 1985).
- A. Bielajew:
PRESTA Information Informal Notes (July 1987).
- W.R. Nelson and T.M. Jenkins:
Writing SUBROUTINE HOWFAR for EGS4 SLAC TN-87-4, SLAC, Stanford (August 1988).
- NEA-DB:
Appendix to the EGS4 Report - Source: "Review of Particle Properties", by the
Particle Data Group Physics Letters B239, 12 April 1990 NEA-DB (10-12-93).
- A. Bielajew et al.:
History, Overview and Recent Improvements of EGS4 SLAC-PUB-6499 (NRC-PIRS-0436,
KEK Internal 94-4) (Revised June 1, 1994)
- A.F. Bielajew and D.W.O. Rogers:
PRESTA - The Parameter Reduced Electron - Step Transport Algorithm for Electron
Monte Carlo Transport PIRS No.042 (July 1986)
- A. F. Bielajew: README.general.3.0 (December 26, 1996)
- A. F. Bielajew: Directions for EGS4 Installation (October 19, 1995)
- W.R. Nelson, H. Hirayama and W.O. Rogers:
The EGS4 Code System SLAC-265 (December 1985).
- A. Bielajew:
PRESTA Information Informal Notes (July 1987).
- W.R. Nelson and T.M. Jenkins:
Writing SUBROUTINE HOWFAR for EGS4 SLAC TN-87-4, SLAC, Stanford, California
(August 1988).
- NEA-DB:
Appendix to the EGS4 Report - Source: "Review of Particle Properties", by the
Particle Data Group Physics Letters B239, 12 April 1990 NEA-DB (10-12-93).
- A. Bielajew et al.:
History, Overview and Recent Improvements of EGS4 SLAC-PUB-6499 (NRC-PIRS-0436,
KEK Internal 94-4) (Revised June 1, 1994)
- A.F. Bielajew and D.W.O. Rogers:
PRESTA - The Parameter Reduced Electron - Step Transport Algorithm for Electron
Monte Carlo Transport PIRS No.042 (July 1986)
- A. F. Bielajew: README.general.3.0 (December 26, 1996)
- A. F. Bielajew: Directions for EGS4 Installation (October 19, 1995)

11. MACHINE REQUIREMENTS

An IBM 3081 or a VAX computer is required for version CCC-0331/01. The PC version runs on a Compaq 80386/20 MHz with 4-5 Mbytes of memory (RAM).

To run the EGS4 test cases, peak page file size was 2200 on VAX-11/780; and 500K bytes on IBM 3090.

This version for UNIX systems have been installed and executed by the NEA Data Bank in the following systems: DEC 3000 Model 300X (Alpha architecture workstation) and on a Sun Solaris (UNIX System V Release 4.0 (psisun)) About 26 MByte of disk space are required to hold ALL the package files. (This amount includes the diskspace occupied by intermediate files for MORTRAN processing, FORTRAN compilation, .obj files, executable files, input files, data files, etc.) The diskspace allocated by the executable files is of about 3.8 MByte. The diskspace allocated by the PEGS data files is of the order of 3.8 Mbyte. The diskspace required by the PEGS the density-correction data files (for elements and compounds) is of about 2.5 Mbyte.

This version for PC systems has been installed and executed by the NEA Data Bank in a PC DELL Optiplex GXPRO equipped with a Pentium PRO processor at 200 MHz, total memory 64 MByte, under Windows NT 4.00 (DOS). About 20 MByte of disk space are required to hold ALL the  package files. (This amount includes the diskspace occupied by intermediate files for MORTRAN processing, FORTRAN compilation, .obj files, executable files, input files, data files, etc.)

13. OPERATING SYSTEM UNDER WHICH PROGRAM IS EXECUTED

A FORTRAN compiler is required. MORTRAN is a structured programming language that is implemented as a set of macros which are used by a macro- processor to translate the language into ANSI-standard FORTRAN ( a
preliminary step in the job). The resulting program is then run like any other FORTRAN program. The version /03 runs using the Lahey Fortran Compiler F77L/32/EM and A.I. Architect's operating system OS-386. The NDP Fortran and Pharlap Operating System can be used, but modifications are required. Both of these 32-bit compilers run in protected mode, making use of extended memory to exceed the 640 Kbyte limit of MS-DOS necessary for full support of EGS4; and, therefore, require their respective memory manager operating systems.

VMS V4.6 (VAX-11/780); MVS/XA with compiler VS FORTRAN  LEVEL 2.1.1 (IBM 3090).

The Unix Version 3.0 of EGS4 was installed, compiled and the sample problems executed in the following systems and using  the following compilers: 1) DEC 3000 Model 300X (Alpha architecture  workstation) under DEC OSF/1 V3.2, using the DEC Fortran compiler V3.4 2) Sun Solaris (UNIX System V Release 4.0 (psisun)) under SunOS 5.3, using the FORTRAN 3.0 compiler from SUNPro

The PC Version 3.1 of EGS4 was installed, compiled and the sample problems executed in a PC DELL Optiplex GXPRO equipped with a Pentium PRO processor at 200 MHz, total memory 64 MByte, under Windows NT 4.00 (execution under DOS). The Lahey Fortran-77 compiler F77L/EM-32
Version 5.20 and linker (Version 5.1) were used for the compilation and creation of the PC-executables.

14. OTHER PROGRAMMING OR OPERATING INFORMATION OR RESTRICTIONS:

15. NAME AND ESTABLISHMENT OF AUTHORS

Contributed by:
          Radiation Safety Information Computational Center
          Oak Ridge National Laboratory
          Oak Ridge, Tennessee, U. S. A.

Developed by:
          Radiation Physics Group
          Stanford Linear Accelerator Center
          Stanford University, Stanford, California

          National Laboratory for High Energy Physics (KEK)
          Oho-machi, Tsu-kuba-gun, Ibaraki-ken, Japan

          National Research Council of Canada, Ottawa, Canada

          Institute for Applied Physiology and Medicine, Seattle,
          Washington

egs4pc31.zip Zip-compressed archive file
egs4pc31.zip Zip-compressed archive file
egs4pc31.zip Zip-compressed archive file

File name	File description	Records
CCC0331_01.001	INFORMATION FILE	179
CCC0331_01.002	CONTENTS OF THE EGS4 DISTRIBUTION TAPE	600
CCC0331_01.003	SLAC-265 APP.5:EGS4 SYSTEM CONSIDERATIONS	840
CCC0331_01.004	SLAC-265 APP.2:EGS4 USER MANUAL	1920
CCC0331_01.005	SLAC-265 APP.3:PEGS4 USER MANUAL	2640
CCC0331_01.006	SLAC-265 APP.4:EGS4 USER GUIDE TO MORTRAN3	1260
CCC0331_01.007	SLAC-265 APP.7:BIBLIOGRAPHY OF EGS PAPERS	840
CCC0331_01.008	FORTRAN77 "MORTRAN3 STRING PROCESSOR"	2148
CCC0331_01.009	MORTRAN MACROS IN RAW FORMAT FOR FORTRAN77	268
CCC0331_01.010	FORTRAN IV "MORTRAN3 STRING PROCESSOR"	2158
CCC0331_01.011	MORTRAN MACROS IN RAW FORMAT FOR FORTRAN IV	269
CCC0331_01.012	MORTRAN3 SOURCE OF PEGS4 CODE	4262
CCC0331_01.013	PEGS4 INPUT DATA (UNIT 8)	1087
CCC0331_01.014	PEGS4 INPUT DATA (UNIT 9)	930
CCC0331_01.015	FORTRAN77 VERSION OF PEGS4	5283
CCC0331_01.016	SAMPLE INPUT FOR PEGS4 (UNIT 5)	12
CCC0331_01.017	SAMPLE INPUT FOR PEGS4 (UNIT 5)	12
CCC0331_01.018	SAMPLE INPUT FOR PEGS4 (UNIT 5)	12
CCC0331_01.019	SAMPLE INPUT FOR PEGS4 (UNIT 5)	10
CCC0331_01.020	EGS4 SOURCE CODE IN MORTRAN3	1690
CCC0331_01.021	SET OF MACROS REQUIRED BY EGS4	887
CCC0331_01.022	BLOCK DATA SOURCE CODE FOR EGS4	147
CCC0331_01.023	FORTRAN77 VERSION OF EGS4	3254
CCC0331_01.024	PEGS OUTPUT FOR WATER AND LEAD (IBM-3081)	1099
CCC0331_01.025	PEGS OUTPUT FOR WATER AND LEAD (VAX)	1367
CCC0331_01.026	PEGS OUTPUT FOR VARIOUS MATERIALS	14262
CCC0331_01.027	GEOMETRY SUBROUTINES IN MORTRAN3	459
CCC0331_01.028	MORTRAN3 SUBROUTINE ECNSV1	112
CCC0331_01.029	MORTRAN3 SUBROUTINE NTALLY	100
CCC0331_01.030	FEW MACROS FOR DEBUGGING PURPOSES	16
CCC0331_01.031	MORTRAN PROGRAM FOR TESTING MORTRAN3 SYSTEM	46
CCC0331_01.032	FIXTMX.MOR AUXILIARY CODE FROM NRCC	67
CCC0331_01.033	WATCH.MOR AUXILIARY CODE FROM NRCC	92
CCC0331_01.034	EXAMIN.MOR AUXILIARY CODE FROM NRCC	207
CCC0331_01.035	INHOM.MOR AUXILIARY CODE FROM NRCC	1532
CCC0331_01.036	NRCC4MAC.MOR AUXILIARY CODE FROM NRCC	268
CCC0331_01.037	NRCCAUX.MOR AUXILIARY CODE FROM NRCC	413
CCC0331_01.038	ROUTINE FOR SETTING UP AN LA120 LINE PRINTER	83
CCC0331_01.039	VAX ASSEMBLER ROUTINE TO PROVIDE CPUTIME	26
CCC0331_01.040	IBM/VM PROC.FOR CREATING MORNEW77 MODULE	13
CCC0331_01.041	IBM/VM PROC.FOR CREATING MORNEW77 DATA	11
CCC0331_01.042	IBM/VM PROC.FOR CREATING MORNEW MODULE	13
CCC0331_01.043	IBM/VM PROC.FOR CREATING MORNEW DATA	12
CCC0331_01.044	IBM/VM PROC. FOR RUNNING EGS4 JOBS	128
CCC0331_01.045	IBM/VM PROC. FOR RUNNING PEGS4 JOBS	149
CCC0331_01.046	IBM/VM PROC. FOR RUNNING MORTRAN JOBS	86
CCC0331_01.047	IBM/MVS JCL1 TO CONVERT MORNEW77 RAW TO HEX	98
CCC0331_01.048	IBM/MVS JCL2 TO CONVERT MORNEW77 RAW TO HEX	1
CCC0331_01.049	IBM/MVS JCL3 TO CONVERT MORNEW77 RAW TO HEX	1
CCC0331_01.050	IBM/MVS JCL1 TO RUN MORTRAN TEST CASE	16
CCC0331_01.051	IBM/MVS JCL2 TO RUN MORTRAN TEST CASE	1
CCC0331_01.052	IBM/MVS JCL3 TO RUN MORTRAN TEST CASE	1
CCC0331_01.053	IBM/MVS JCL FIL.1 FOR RUNNING PEGS4	98
CCC0331_01.054	IBM/MVS JCL FILE 2 FOR RUNNING PEGS4	1
CCC0331_01.055	IBM/MVS JCL FILE 3 FOR RUNNING PEGS4	1
CCC0331_01.056	IBM/MVS JCL FILE 4 FOR RUNNING PEGS4	1
CCC0331_01.057	IBM/MVS JCL FILE 1 TO RUN EGS4 USER CODE	98
CCC0331_01.058	IBM/MVS JCL FILE 2 TO RUN EGS4 USER CODE	2
CCC0331_01.059	IBM/MVS JCL FILE 3 TO RUN EGS4 USER CODE	1
CCC0331_01.060	VAX/VMS PROC. TO TURN RAW TO HEX DATA FILE	25
CCC0331_01.061	VAX/VMS PROC.:RUNS MORTRAN FOR STANDALONE CO	28
CCC0331_01.062	VAX/VMS PROC.:RUNS MORTRAN FOR EGS4 USER COD	30
CCC0331_01.063	VAX/VMS PROC.:CREATES PEGS4 EXECUT.MODULE	23
CCC0331_01.064	VAX/VMS PROC.:RUNS PEGS4	25
CCC0331_01.065	VAX/VMS PROC. FOR RUNNING EGS4 SYSTEM	72
CCC0331_01.066	DUMMY EGS CODE	9
CCC0331_01.067	USER CODE EXAMPLE	174
CCC0331_01.068	USER CODE TO TEST SAMPLING ROUTINE	302
CCC0331_01.069	CYLINDER-SLAB USER CODE EXAMPLE	816
CCC0331_01.070	MAGNETIC FIELD USER CODE EXAMPLE	1013
CCC0331_01.071	FLUORESCENT PHOTON USER CODE EXAMPLE	755
CCC0331_01.072	COMBINATORIAL GEOMETRY USER CODE EXAMPLE	1801
CCC0331_01.073	MORTRAN3 SOURCE CODE FOR TUTOR1	186
CCC0331_01.074	MORTRAN3 LISTING FOR TUTOR1	186
CCC0331_01.075	FORTRAN77 VERSION OF TUTOR1	108
CCC0331_01.076	MORTRAN3 SOURCE FOR TUTOR2	181
CCC0331_01.077	MORTRAN3 LISTING FOR TUTOR2	178
CCC0331_01.078	FORTRAN77 VERSION OF TUTOR2	118
CCC0331_01.079	MORTRAN3 SOURCE FOR TUTOR3	196
CCC0331_01.080	MORTRAN3 LISTING FOR TUTOR3	193
CCC0331_01.081	FORTRAN77 VERSION OF TUTOR3	131
CCC0331_01.082	MORTRAN3 SOURCE FOR TUTOR4	255
CCC0331_01.083	MORTRAN3 LISTING FOR TUTOR4	254
CCC0331_01.084	FORTRAN77 VERSION OF TUTOR4	173
CCC0331_01.085	MORTRAN3 SOURCE FOR TUTOR5	252
CCC0331_01.086	MORTRAN3 LISTING FOR TUTOR5	252
CCC0331_01.087	FORTRAN77 VERSION OF TUTOR5	2063
CCC0331_01.088	MORTRAN3 SOURCE FOR TUTOR6	316
CCC0331_01.089	MORTRAN3 LISTING FOR TUTOR6	312
CCC0331_01.090	FORTRAN77 VERSION OF TUTOR6	2053
CCC0331_01.091	MORTRAN3 SOURCE FOR TUTOR7	201
CCC0331_01.092	MORTRAN3 LISTING FOR TUTOR7	197
CCC0331_01.093	FORTRAN77 VERSION OF TUTOR7	2035

File name	File description	Records
CCC0331_07.001	Information file of package EGS4 (UNIX V3.0)	1826
CCC0331_07.002	Script for EGS4 installation	742
CCC0331_07.003	Tar file with the EGS4 package files	0