diff --git a/HEN_HOUSE/doc/src/getting-started/getting-started.tex b/HEN_HOUSE/doc/src/getting-started/getting-started.tex index 9e2052ad2..a018f3b02 100644 --- a/HEN_HOUSE/doc/src/getting-started/getting-started.tex +++ b/HEN_HOUSE/doc/src/getting-started/getting-started.tex @@ -2501,7 +2501,7 @@ \subsection{Build a new BEAMnrc accelerator} Create a new text file, that will provide the dynamic motion of the jaws. There are examples for all of the syncronized CMs in \,\Verb|$HEN_HOUSE/omega/beamnrc/CMs/sample_sequences/|. Copy the text at the end of this section and save the file as \,\Verb|example.sequence|\, in \\ \,\Verb|$EGS_HOME/BEAM_syncjaws|\,. Now go back to the settings of the SYNCJAWS CM, click the \,\Verb|Browse|\, button and select the file (make sure the mode is set to \,\Verb|Dynamic|\,). Click \,\Verb|Preview|\, to view the first position of the jaws, before motion begins. -The format of the sequence file is described in section 15.3.8 of the BEAMnrc Users Manual (\href{https://nrc-cnrc.github.io/EGSnrc/doc/pirs509a-beamnrc.pdf}{PIRS509a}). Using this file, it is possible to model motion like jaw tracking, based on the the \textit{index} parameter (i.e. fractional MU or cumulative meterset weight). If multiple SYNC CMs are included, the index is used to synchronize motion. Use a repeated index to simulate motion with the beam off. +The format of the sequence file is described in section 15.3.8 of the BEAMnrc Users Manual (\href{https://nrc-cnrc.github.io/EGSnrc/doc/pirs509a-beamnrc.pdf}{PIRS509a}). Using this file, it is possible to model motion like jaw tracking, based on the \textit{index} parameter (i.e. fractional MU or cumulative meterset weight). If multiple SYNC CMs are included, the index is used to synchronize motion. Use a repeated index to simulate motion with the beam off. In the following, we define 2 static fields and 1 dynamic field in 6 steps. The upper y-jaws are at $40 \le z \le 50$ and x-jaws at $51 \le z \le 61$. From index 0.0 to 3.0 (30\% of the simulation), the jaws are statically positioned. Similarly from 0.3 to 0.6. The repeated indices, 0.3 and 0.6, result in simulated collimator shifts while the beam is off. Finally, from index 0.6 to 1.0 (40\%) there is a motion of the x-jaws from a nearly-closed position to a $2 \times 2$ opening. diff --git a/HEN_HOUSE/doc/src/pirs509a-beamnrc/inputformats/BEAM28.inp b/HEN_HOUSE/doc/src/pirs509a-beamnrc/inputformats/BEAM28.inp index 380c6cd59..5f086c68c 100644 --- a/HEN_HOUSE/doc/src/pirs509a-beamnrc/inputformats/BEAM28.inp +++ b/HEN_HOUSE/doc/src/pirs509a-beamnrc/inputformats/BEAM28.inp @@ -19,7 +19,7 @@ [ pair_nrc ] Photoelectron angular sampling= Off or On (Default is On) If Off, photo-electrons get the direction of the - `mother' photon, with On, Sauter's furmula is + `mother' photon, with On, Sauter's formula is used (which is, strictly speaking, valid only for K-shell photo-absorption). If the user has a better approach, replace the macro diff --git a/HEN_HOUSE/doc/src/pirs509a-beamnrc/pirs509a-beamnrc.tex b/HEN_HOUSE/doc/src/pirs509a-beamnrc/pirs509a-beamnrc.tex index ea3afe440..5b0e13c8b 100644 --- a/HEN_HOUSE/doc/src/pirs509a-beamnrc/pirs509a-beamnrc.tex +++ b/HEN_HOUSE/doc/src/pirs509a-beamnrc/pirs509a-beamnrc.tex @@ -5976,7 +5976,7 @@ \subsection{ {\tt Pair angular sampling} ({\tt IPRDST})} by Motz et al\cite{Mo69} is used to determine the positron/electron emission angles. This option is similar to the sampling technique used by EGS4/BEAM. Finally if {\tt Pair angular sampling= Simple} (the default), then only -the first term in the the Motz et al equation 3D-2003 is used. The {\tt KM} option +the first term in the Motz et al equation 3D-2003 is used. The {\tt KM} option becomes less efficient with increasing accelerator energies and, moreover, involves assumptions that are questionable at low energy. For these reasons, the default setting is {\tt Simple}. @@ -6082,7 +6082,7 @@ \subsection{{\tt Photon cross sections} ({\tt photon\_xsections})} \& Salvat's renormalized cross sections when simulating photoelectric events, with either the XCOM ({\tt mcdf-xcom}) or Evaluated Photon Data Library ({\tt mcdf-epdl}) used for all other cross sections. The more accurate modeling of -photoelectric events allowed by the the Sabbatucci \& Salvat cross sections does +photoelectric events allowed by the Sabbatucci \& Salvat cross sections does incur a CPU time penalty (up to 6\% for a 30 kV beam) and so this option is only of interest for low energy simulations. Use of these renormalized cross sections is necessary for agreement with PENELOPE results in ICRU90\cite{ICRU90}. @@ -7486,7 +7486,7 @@ \subsubsection{SYNCJAWS} that used by any other synchronized CMs in the accelerator. {\tt MU\_RND} is generated by the first (most upstream) synchronized CM (which could be SYNCJAWS) and is then passed on to any downstream synchronized CMs. Thus, the dynamic motion of the jaws can be coordinated (synchronized) with the dynamic motion of all other synchronized CMs -in the the accelerator. Moreover, if an accelerator with synchronized CMs has been compiled as a shared library for use +in the accelerator. Moreover, if an accelerator with synchronized CMs has been compiled as a shared library for use in DOSXYZnrc source 20 (synchronized phase space source) or source 21 (synchronized BEAM treatment head simulation), then {\tt MU\_RND} is passed from the accelerator simulation to DOSXYZnrc. This allows the dynamic motion of the source plane in DOSXYZnrc sources 20 and 21 to be synchronized with @@ -9013,7 +9013,7 @@ \subsection{Creating additional cross section data} \index{PEGS4!input file} where {\tt inputfile} omits the {\tt .pegs4inp} extention and {\tt densityfile} omits the {\tt .density} extension. The {\tt .pegs4inp} -file specifies whether the the medium is an element ({\tt ELEM}), +file specifies whether the medium is an element ({\tt ELEM}), compound ({\tt COMP}) or mixture ({\tt MIXT}); the composition of the medium (by mass, {\tt RHOZ}, in the case of {\tt MIXT} and number of atoms, {\tt PZ}, in the case of {\tt COMP}); the density ({\tt RHO}; @@ -9225,8 +9225,8 @@ \subsection{Pegsless Mode} correction to apply to calculated bremsstrahlung cross-sections. Options are: \begin{itemize} -\item {\tt KM} $[$IAPRIM=0$]$ (the default): Apply Koch and Motz\cite{KM59} empirical corrections. -\item {\tt NRC} $[$IAPRIM=1$]$: Apply NRC corrections based on NIST/ICRU\cite{Ro89a}. These corrections are read from the file +\item {\tt KM} $[$IAPRIM=0$]$ : Apply Koch and Motz\cite{KM59} empirical corrections. +\item {\tt NRC} $[$IAPRIM=1$]$: (the default) Apply NRC corrections based on NIST/ICRU\cite{Ro89a}. These corrections are read from the file {\tt \$HEN\_HOUSE/pegs4/aprime.data}. \item {\tt None} $[$IAPRIM=2$]$: No corrections applied. \end{itemize} @@ -10428,7 +10428,7 @@ \subsection{Changes from {\tt BEAM00} to {\tt BEAMnrc02}} space source incident from multiple, user-selected angles. This allows modelling of arc therapy. -\item Added an option to DOSXYZnrc which allows the the user to output a +\item Added an option to DOSXYZnrc which allows the user to output a {\tt .egsphant} file from non-CT data. This allows you to display isodose contours using {\tt dosxyz\_show} in non-CT phantoms. diff --git a/HEN_HOUSE/doc/src/pirs623-gui/pirs623-gui.tex b/HEN_HOUSE/doc/src/pirs623-gui/pirs623-gui.tex index f4bf2890d..ca9ee8408 100644 --- a/HEN_HOUSE/doc/src/pirs623-gui/pirs623-gui.tex +++ b/HEN_HOUSE/doc/src/pirs623-gui/pirs623-gui.tex @@ -413,7 +413,7 @@ \subsection{The fast track} accelerator defined in {\em modulename}{\tt .module}. Alternatively, if the accelerator has already been compiled and the input file exists -in the the {\tt \$EGS\_HOME/BEAM\_accelname} directory, you can specify the input file +in the {\tt \$EGS\_HOME/BEAM\_accelname} directory, you can specify the input file (and accompanying PEGS4 data) as command line arguments. Within the {\tt \$EGS\_HOME/BEAM\_accelname} directory type: \begin{verbatim} @@ -699,7 +699,7 @@ \subsection{Defining the phantom voxel-by-voxel} in the group, for as many groups as is required. The second step is to define the media used in the phantom. The number -of media that you intend to use must be entered first, the the {\sf +of media that you intend to use must be entered first, the {\sf Define media} button selected. On this new window, an option menu is used to select each medium. The first entry, medium 1, is the default medium. Once these have been specified, click diff --git a/HEN_HOUSE/doc/src/pirs624-dosxyzshow/pirs624-dosxyzshow.tex b/HEN_HOUSE/doc/src/pirs624-dosxyzshow/pirs624-dosxyzshow.tex index 6ccfb8d0e..675a75ecd 100644 --- a/HEN_HOUSE/doc/src/pirs624-dosxyzshow/pirs624-dosxyzshow.tex +++ b/HEN_HOUSE/doc/src/pirs624-dosxyzshow/pirs624-dosxyzshow.tex @@ -212,7 +212,7 @@ \section{\sffamily Compiling and running} i_{\rm gray} = {\sqrt{\rho} - \sqrt{\rho_{min}} \over \sqrt{\rho_{max}} - \sqrt{\rho_{min}}} N_{\rm gray} \end{displaymath} -where $\rho$ is the the actual voxel density, $\rho_{min}$ and +where $\rho$ is the actual voxel density, $\rho_{min}$ and $\rho_{max}$ the minimum and maximum density of the specified displayable density window (see below) and $N_{\rm gray}$ the number of gray shades allocated. Note that the diff --git a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/chapter2_2.tex b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/chapter2_2.tex index 364e9b437..c3969067e 100644 --- a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/chapter2_2.tex +++ b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/chapter2_2.tex @@ -1122,7 +1122,7 @@ \subsubsection{Incoherent (Compton) scattering} time when electron transport is included. Binding effects and Doppler broadening for coherent scattering are therefore turned on by default in the {\tt block data} sub-program (the switch -{\tt IBCMP} is set to unity). +{\tt IBCMP} is set to 3, {\tt norej}). \index{IBCMP} Since the 2009 release of EGSnrc, the user has the option to change @@ -1268,7 +1268,7 @@ \subsubsection{Photo-electric absorption} (in the {\tt COMIN/EDGE} common block-see Section~\ref{common_blocks}). If {\tt IEDGFL} of the region is non-zero, a detailed simulation is performed, otherwise a simplified treatment of the photo-absorption process -is undertaken. The default setting of {\tt IEDGFL} is one. +is undertaken. The default setting of {\tt IEDGFL} is 1. \index{IEDGFL} \paragraph{Detailed simulation of photo-electric absorption}\hfill @@ -1726,7 +1726,7 @@ \subsubsection{Changing photon cross sections} In the current version of EGSnrc, the user has the option to use photon cross section data other than the default -Storm \& Israel data. To do this, the user must +XCOM data. To do this, the user must set the character variable {\tt photon\_xsections} (part of the {\tt COMIN/MEDIA} common block) to the name of the cross section data to use. Cross sections included with the EGSnrc distribution @@ -2046,4 +2046,3 @@ \subsection{Atomic Relaxations} \index{AUSGAB} \index{IARG!25,26,27:} %\clearpage - diff --git a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/chapter2_3.tex b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/chapter2_3.tex index 4fd0a7fde..24f6d760a 100644 --- a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/chapter2_3.tex +++ b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/chapter2_3.tex @@ -606,7 +606,7 @@ \subsubsection{Bremsstrahlung} $\tilde{f}_c(E,Z)$ have the same definitions as for the pair production process (see section \ref{pair}), and $A'(E,Z)$ is an empirical correction factor (see below). -For compounds and mixture the the cross section can be +For compounds and mixture the cross section can be approximated in the same form with the replacements given by Eq. (\ref{pair_replace}) in section \ref{pair} (page~\pageref{pair}). @@ -1326,7 +1326,7 @@ \subsubsection{Two Photon Positron-Electron Annihilation} has a maximum of $1$ for $\epsilon = 1/(\tau+2)$ and thus is a valid rejection function\footnote{Note that our $g(\varepsilon)$ is -the $g(\varepsilon)$ defined in Eq (2.12.26) of the the EGS4 manual +the $g(\varepsilon)$ defined in Eq (2.12.26) of the EGS4 manual divided by its maximum.}. The sampling algorithm is then as follows: \begin{enumerate} \item diff --git a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/egsnrc_system_considerations.tex b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/egsnrc_system_considerations.tex index 3693c513d..5ad75c2ea 100644 --- a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/egsnrc_system_considerations.tex +++ b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/egsnrc_system_considerations.tex @@ -526,7 +526,7 @@ \subsection{Execution} \index{execution in batch} If \verb+queue+ is not specified when the batch option ``{\tt b}'' is being -used, then the default que on your system is used. +used, then the default queue on your system is used. \index{interactive execution} \index{debug} diff --git a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/mortran3_man.tex b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/mortran3_man.tex index b0ea04b19..90cb95a5c 100644 --- a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/mortran3_man.tex +++ b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/mortran3_man.tex @@ -740,8 +740,8 @@ \section{EGS User Guide to MORTRAN3} but not Y = DUMPX; - Normally, the text generated by a macro is itself elegible - for replacement by other macros, or even by the the same macro + Normally, the text generated by a macro is itself eligible + for replacement by other macros, or even by the same macro that generated the text. \end{verbatim} diff --git a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/new_um_app2.tex b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/new_um_app2.tex index 095c721cc..6a0e4307a 100644 --- a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/new_um_app2.tex +++ b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/new_um_app2.tex @@ -431,7 +431,7 @@ \subsection{ The COMMON Blocks} % it is never turned off in default EGSnrc.\\ &IRAYLR &Array(\$MXREG) of flags for turning on (=1) coherent (Rayleigh) scattering in - various regions (default=0$\Rightarrow$ off).\\ + various regions (default=1$\Rightarrow$ on).\\ &&\\ \hline \multicolumn{3}{c}{$^*$ NOSCAT is no longer available since there is @@ -1233,7 +1233,7 @@ \subsubsection{Pre-HATCH Call Initialisation (Step 2)} \item[IRAYLR] The elements of this integer array (dimensioned {\tt IRAYLR(\$MXREG)} and passed in\\ {\tt COMMON/MISC/)} are to be set to 1 prior to calling {\tt HATCH} if coherent (Rayleigh) scattering is to be done -in a particular region. The default values are 0. +in a particular region. The default values are 1. See section~\ref{rayleigh}(page~\pageref{rayleigh}). Execution is only terminated if set to 1, user wants to use photon data from PEGS4 file, and Rayleigh data are not included. @@ -1334,7 +1334,7 @@ \subsubsection{Pre-HATCH Call Initialisation (Step 2)} The cross section data must be contained in file {\tt \$HEN\_HOUSE/data/comp\_xsections\_compton.data}. If the user does not supply a name for {\tt comp\_xsections}, then the default Compton -data used with {\tt IBCMP}=2 is in {\tt \$HEN\_HOUSE/data/compton\_sigma.data}. +data used with {\tt IBCMP}=3 is in {\tt \$HEN\_HOUSE/data/compton\_sigma.data}. See section~\ref{comp_xsect} (page~\pageref{comp_xsect}). If using {\tt get\_transport\_parameter}, then {\tt comp\_xsections} can be @@ -1395,10 +1395,10 @@ \subsubsection{Pre-HATCH Call Initialisation (Step 2)} \item[photon\_xsections] A character variable ({\tt character*16}) defined in {\tt COMMON/MEDIA} which must be defined prior to calling {\tt HATCH} if the user wants to use photon cross section data other than the default -(Storm \& Israel\cite{SI70}) data. Current possible settings of +XCOM data. Current possible settings of {\tt photon\_xsections} are: {\tt epdl} (the Evaluated Photon Data -Library\cite{Cu90}), {\tt xcom} (XCOM from Berger \& Hubbell\cite{BH87}), -{\tt si} (Storm \& Israel--also the default if not set), +Library\cite{Cu90}), {\tt xcom} (XCOM from Berger \& Hubbell\cite{BH87}, default), +{\tt si} (Storm \& Israel), and {\tt pegs4} (to use PEGS4 photon data). The user can supply their own cross section data. For a user-supplied data set, {\tt photon\_xsections}, the cross section data for photoelectric, @@ -1422,7 +1422,7 @@ \subsubsection{Pre-HATCH Call Initialisation (Step 2)} be set to 1 prior to calling {\tt HATCH} if the user wants to output a summary of the photon cross section data. The default value is 0. Cross section data is written to the file\\ {\tt \$EGS\_HOME/user\_code/inputfile.xsections}. -Prior to the current EGSnrc release, the default was to print this file and +Previously, the default was to print this file and there was no input for turning it off. If using {\tt get\_transport\_parameter}, then {\tt xsec\_out} can be set diff --git a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/pegs4_um.tex b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/pegs4_um.tex index e9864bb79..b836aaca7 100644 --- a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/pegs4_um.tex +++ b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/pegs4_um.tex @@ -117,12 +117,10 @@ \subsubsection{Photon data for EGSnrc} grid with {\tt \$MXGE} energy points. However, EGSnrc still needs the PEGS4 data file for material information, photon threshold energies ({\tt AP, UP}), and a fraction of the electron data. -By default data is read from the -Storm and Israel\cite{SI70} photon cross section compilation -({\tt si\_pair.data, si\_photo.data, si\_rayleigh.data and -si\_triplet.data}). -As alternative, EGSnrc offers such cross section data files -for the XCOM\cite{HS95} ({\tt xcom\_*.data}) and EPDL97\cite{Cu89} +By default data is read from the XCOM\cite{HS95} photon cross section +compilation ({\tt xcom\_pair.data, xcom\_photo.data, xcom\_rayleigh.data and +xcom\_triplet.data}). As alternatives, EGSnrc offers cross section data files +for the Storm and Israel\cite{SI70}({\tt si\_*.data}) and EPDL97\cite{Cu89} ({\tt epdl\_*.data}) photon cross section compilations. New photon cross section compilations can be added following the same format as above, \ie, {\tt prefix\_*.data}. @@ -132,7 +130,7 @@ \subsubsection{Photon data for EGSnrc} :start MC transport parameter: . # This entry is case sensitive - Photon cross sections = xcom # xcom, epdl, si(default) or any_prefix + Photon cross sections = xcom # xcom (default), epdl, si or any_prefix . :stop MC transport parameter: diff --git a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/pegsless_um.tex b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/pegsless_um.tex index e1cb228b9..3454b7105 100644 --- a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/pegsless_um.tex +++ b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/pegsless_um.tex @@ -23,7 +23,7 @@ % % Author: Blake Walters, 2013 % -% Contributors: +% Contributors: Frederic Tessier % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -135,8 +135,8 @@ \subsection{User Code Inputs for Pegsless Mode} correction to apply to calculated bremsstrahlung cross-sections. Options are: \begin{itemize} -\item {\tt KM} $[$IAPRIM=0$]$ (the default): Apply Koch and Motz\cite{KM59} empirical corrections. -\item {\tt NRC} $[$IAPRIM=1$]$: Apply NRC corrections based on NIST/ICRU\cite{Ro89a}. These corrections are read from the file +\item {\tt KM} $[$IAPRIM=0$]$: Apply Koch and Motz\cite{KM59} empirical corrections. +\item {\tt NRC} $[$IAPRIM=1$]$: (the default) Apply NRC corrections based on NIST/ICRU\cite{Ro89a}. These corrections are read from the file {\tt \$HEN\_HOUSE/pegs4/aprime.data}. \item {\tt None} $[$IAPRIM=2$]$: No corrections applied. \end{itemize} diff --git a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/transport_parameters.tex b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/transport_parameters.tex index b24f539ab..fadc739fc 100644 --- a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/transport_parameters.tex +++ b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/transport_parameters.tex @@ -31,14 +31,14 @@ \index{ECUT} \begin{verbatim} Global ECUT= Global (in all regions) electron transport cut - off energy (in MeV). If this imput is missing, + off energy (in MeV). If this input is missing, AE(medium) will be used. [ ECUT ] \end{verbatim} \index{PCUT} \begin{verbatim} Global PCUT= Global (in all regions) photon transport cut - off energy (in MeV). If this imput is missing, + off energy (in MeV). If this input is missing, AP(medium) will be used. [ PCUT ] \end{verbatim} @@ -59,7 +59,7 @@ ESTEPE= Maximum fractional energy loss per step. Note that this is a global option only, no region-by-region setting is possible. If missing, - the defualt is 0.25 (25%). + the default is 0.25 (25%). [ ESTEPE ] \end{verbatim} \index{XImax} @@ -74,8 +74,8 @@ \index{exact\_bca} \index{transport\_algorithm} \begin{verbatim} - Boundary crossing algorithm= - There are two selections possible: EXACT, means + Boundary crossing algorithm= EXACT (default), PRESTA-I + There are two selections possible: EXACT means the algorithm will cross boundaries in a single scattering (SS) mode, the distance from a boundary at which the transition to SS mode is made is @@ -93,23 +93,21 @@ Determines the distance from a boundary (in elastic MFP) at which the algorithm will go into single scattering mode (if EXACT boundary crossing) or - swith off lateral correlations (if PRESTA-I boundary + switch off lateral correlations (if PRESTA-I boundary crossing). Default value is 3 for EXACT or exp(BLCMIN)/BLCMIN for PRESTA-I (see the PRESTA paper for a definition of BLCMIN). Note that if you choose EXACT boundary crossing and set Skin depth for BCA to a very large number (e.g. 1e10), the entire - calculation will be in SS mode. If you choose - PRESTA-I boundary crossing and make Skin depth for BCA - large, you will get default EGS4 behavious (no PRESTA) + calculation will be in single-scattering mode. If you + choose PRESTA-I boundary crossing and make Skin depth + for BCA large, you will get default EGS4 behaviour + (no PRESTA). [ skindepth_for_bca ] \end{verbatim} \index{electron step algorithm} \begin{verbatim} - Electron-step algorithm= - PRESTA-II (the default), the name is - used for historical reasons - or PRESTA-I + Electron-step algorithm= PRESTA-II (default), PRESTA-I (legacy) Determines the algorithm used to take into account lateral and longitudinal correlations in a condensed history step. @@ -118,7 +116,7 @@ \index{spin effects} \index{spin\_effects} \begin{verbatim} - Spin effects= Off, On, default is On + Spin effects= Off, On (default) Turns off/on spin effects for electron elastic scattering. Spin On is ABSOLUTELY necessary for good backscattering calculations. Will make a @@ -130,10 +128,10 @@ \index{brems angular sampling} \index{IBRDST} \begin{verbatim} - Brems angular sampling= Simple, KM, default is KM + Brems angular sampling= Simple, KM (default) If Simple, use only the leading term of the Koch-Motz distribution to determine the emission angle of - bremsstrahlung photons. If On, complete + bremsstrahlung photons. If KM, complete modified Koch-Motz 2BS is used (modifications concern proper handling of kinematics at low energies, makes 2BS almost the same as 2BN at low energies). @@ -142,7 +140,7 @@ \index{brems cross section} \index{ibr\_nist} \begin{verbatim} - Brems cross sections= BH, NIST, NRC default is BH + Brems cross sections= BH (default), NIST, NRC If BH is selected, the Bethe-Heitler bremsstrahlung cross sections (Coulomb corrected above 50 MeV) will be used. If NIST is selected, the NIST brems @@ -186,7 +184,7 @@ \index{radiative Compton corrections} \index{radc\_flag} \begin{verbatim} - Radiative Compton corrections= On or Off (default). If on, then + Radiative Compton corrections= On or Off (default). If On, then include radiative corrections for Compton scattering. Equations are based on original Brown & Feynman equations (Phys. Rev. 85, p 231--1952). Requires @@ -216,14 +214,14 @@ \index{pair angular sampling} \index{IPRDST} \begin{verbatim} - Pair angular sampling= Off, Simple, KM. + Pair angular sampling= Off, Simple (default), KM. If off, pairs are set in motion at an angle m/E relative to the photon direction (m is electron rest energy, E the photon energy). Simple turns on the leading term of the angular distribution (this is sufficient for most applications), KM (comes from Koch and Motz) turns on using 2BS - from the article by Koch and Motz. Uniform + from the article by Koch and Motz. Default is Simple, make sure you always use Simple or KM [ IPRDST ] @@ -236,7 +234,7 @@ to NRC, then use NRC pair production cross-sections (in file $HEN_HOUSE/data/pair_nrc1.data). Only of interest at low energies, where the NRC cross- - sections take into account the assymmetry in the + sections take into account the asymmetry in the positron-electron energy distribution. [ pair_nrc ] \end{verbatim} @@ -244,19 +242,24 @@ \index{photon\_xsections} \begin{verbatim} Photon cross sections= Photon cross-section data. Current options are - si (Storm-Israel--the default), epdl (Evaluated Photon - Data Library), and xcom. Allows the user to use photon - cross-sections other than the default PEGS4 (Storm- - Israel) values. Note that the user can supply their - own cross-section data as well. The requirement is - that the files + si (Storm-Israel), epdl (Evaluated Photon Data + Library), xcom (default), pegs4, mcdf-xcom and + mcdf-epdl: + Allows the use of photon cross-sections other than + from the PEGS4 file (unless the pegs4 option is + specified). Options mcdf-xcom and mcdf-epdl use + Sabbatucci and Salvat's renormalized photoelectric + cross sections with either xcom or epdl for all other + cross sections. These are more accurate but can + increase CPU time by up to 6 %. + Note that the user can supply their own cross-section + data as well. The requirement is that the files photon_xsections_photo.data, photon_xsections_pair.data, photon_xsections_triplet.data, and photon_xsections_rayleigh.data exist in the $HEN_HOUSE/data directory, where photon_xsections - is the name specified. - Entry is case-sensitive except for the pegs4 option. + is the name specified. This entry is case-sensitive. [ photon_xsections ] \end{verbatim} \index{photon cross sections!output} @@ -284,14 +287,13 @@ \index{Rayleigh scattering!custom form factors} \index{IRAYLR} \begin{verbatim} - Rayleigh scattering= Off, On, custom - If On, turned on coherent (Rayleigh) scattering. - Default is Off. Should be turned on for low energy + Rayleigh scattering= Off, On (default), custom + If On, turns on coherent (Rayleigh) scattering. + Default is On. Should be turned on for low energy applications. If custom, user must provide media names and form factor files for each desired medium. The rest of the media use the default atomic form factors. - Not set to On by default for historical reasons since - a PEGS4 data set is not required anymore. + A PEGS4 data set is not required anymore. [ IRAYLR ] \end{verbatim} \index{iray\_ff\_media} @@ -313,53 +315,82 @@ $HEN_HOUSE/data/molecular_form_factors. [ iray_ff_file($MXMED) ] \end{verbatim} +\index{photonuclear attenuation} +\index{IPHOTONUCR} +\begin{verbatim} + Photonuclear attenuation= Off (default) or On + If On, models the photonuclear effect. Current + implementation is crude. Available on a + region-by-region basis (see below) + [ IPHOTONUCR ] +\end{verbatim} +\index{photonuclear cross sections} +\index{photonuc\_xsections} +\begin{verbatim} + Photonuclear cross sections= Total photonuclear cross sections. User- + supplied total photonuclear cross-sections in + $HEN_HOUSE/data/photonuc_xsections_photonuc.data, + where photonuc_xsections is the name supplied for + this input (case sensitive). In the absence of + any user-supplied data, or if photonuc_xsections + is set to 'default', the default file is + iaea_photonuc.data. + [ photonuc_xsections ] +\end{verbatim} \index{photoelectron angular sampling} \index{IPHTER} \begin{verbatim} - Photoelectron angular sampling= Off or On + Photoelectron angular sampling= Off or On (default) If Off, photo-electrons get the direction of the - `mother' photon, with On, Sauter's furmula is - used (which is, striktly speaking, valid only for + `mother' photon, with On, Sauter's formula is + used (which is, strictly speaking, valid only for K-shell photo-absorption). If the user has a better approach, replace the macro $SELECT-PHOTOELECTRON-DIRECTION; - The only application that - I encountered until now where this option made a - small difference was a big ion chamber (cavity size - comparable with electron range) with high-Z walls - in a low energy photon beam. - Default is On + The only application encountered where this option + made a small difference was a big ion chamber + (cavity size comparable with electron range) + with high-Z walls in a low energy photon beam. [ IPHTER ] \end{verbatim} \index{atomic relaxations} \index{IEDGFL} \begin{verbatim} - Atomic relaxations= Off, On - Default is On. The effect of using On is twofold: + Atomic relaxations= Off, On, eadl (default), simple + On defaults to eadl. + When simulating atomic relaxations: - In photo-electric absorption events, the element (if material is mixture) and the shell the photon is interacting with are sampled from the appropriate - cross seections - - Shell vacancies created in photo-absorption events + cross sections + - Shell vacancies created in photoelectric, + compton and electron impact ionization events are relaxed via emission of fluorescent X-Rays, Auger and Koster-Cronig electrons. - Make sure to turn this option on for low energy - applications. - [ IEDGFL ] + The eadl option features a more accurate treatment + of relaxation events and uses binding energies + consistent with those in of the photon cross sections + used in the simulation. If using mcdf-xcom or + mcdf-epdl photon cross sections, you cannot use + the simple option and this will automatically get + reset to eadl. Make sure to use eadl or simple for + low energy applications. + [ IEDGFL ] \end{verbatim} \noindent -Atomic relaxations, Rayleigh scattering, Photoelectron angular sampling -and Bound Compton scattering can also be turned On/Off on a -region-by-region basis. An example for Atomic relaxations on a region- -by-region basis is: +Atomic relaxations, Rayleigh scattering, Photoelectron angular sampling, +Bound Compton scattering and photonuclear effect +can also be turned On/Off on a region-by-region basis. An example for +Atomic relaxations on a region-by-region basis is: \begin{verbatim} Atomic relaxations= On in Regions or Atomic relaxations= Off in regions \end{verbatim} -Then define the regions in which you want the feature to be turned on: +Then define the regions in which you want +the feature to be turned on: \begin{verbatim} Bound Compton start region= @@ -374,8 +405,9 @@ PE sampling start region= PE sampling stop region= \end{verbatim} -each followed by a list of one or more start and stop regions -separated by commas. Example: +each followed by a list of one or more +start and stop regions separated by commas. +Example: \begin{verbatim} Atomic relaxations= On in Regions Relaxations start region= 1, 40 @@ -383,8 +415,8 @@ \end{verbatim} will first turn off relaxations everywhere and then turn on in regions 1-10 and 40-99. -Note that the input is checked against minimum and maximum -region number and ignored if +Note that the input is checked against minimum +and maximum region numbers and ignored if \verb+start region < 1+ or \verb+stop_region > $MXREG+ or \verb+start region > stop region+. diff --git a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/tutorials.tex b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/tutorials.tex index 01c96444c..681d6d3f7 100644 --- a/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/tutorials.tex +++ b/HEN_HOUSE/doc/src/pirs701-egsnrc/inputs/tutorials.tex @@ -69,13 +69,11 @@ User Codes are presented. The complete source for each (and the corresponding Fortran 77 code) is found on the EGSnrc Distribution. -Note that we changed the default parameters in EGSnrc after this section of -the manual was written so there will be some minor differences when you run -the calculations (e.g. bound Compton scattering and atomic relaxations are -modelled by default, \$REAL now defaults to real*8). Also, use of the MP -system requires a Step 0: {\tt call egs\_init;} and a Step 9: {\tt call -egs\_finish;} which are in the distributed versions but not updated here. -\index{\$REAL} +Note that default parameters in EGSnrc may change from time to time, in which +case there could be some minor differences when you run the calculations. Also, +use of the MP system requires a Step 0: {\tt call egs\_init;} and a Step 9: +{\tt call egs\_finish;} which are in the distributed versions but not updated +here. \index{\$REAL} % To see the expected output, see % {\tt \$HEN\_HOUSE/test\_distribution\_outputs/}. @@ -648,4 +646,3 @@ \subsection{Sophisticated User Codes} statistical analysis etc. The BEAM system is for modelling linear accelerators and doing dose calculations in a CT-based patient phantom\cite{Ro95,Ro98a,Ma01b}. - diff --git a/HEN_HOUSE/doc/src/pirs702-egsnrc-codes/inputs/transport_parameters.tex b/HEN_HOUSE/doc/src/pirs702-egsnrc-codes/inputs/transport_parameters.tex index 12e9fbc20..17dbb0e3c 100644 --- a/HEN_HOUSE/doc/src/pirs702-egsnrc-codes/inputs/transport_parameters.tex +++ b/HEN_HOUSE/doc/src/pirs702-egsnrc-codes/inputs/transport_parameters.tex @@ -32,14 +32,14 @@ \index{ECUT} \begin{verbatim} Global ECUT= Global (in all regions) electron transport cut - off energy (in MeV). If this imput is missing, + off energy (in MeV). If this input is missing, AE(medium) will be used. [ ECUT ] \end{verbatim} \index{PCUT} \begin{verbatim} Global PCUT= Global (in all regions) photon transport cut - off energy (in MeV). If this imput is missing, + off energy (in MeV). If this input is missing, AP(medium) will be used. [ PCUT ] \end{verbatim} @@ -60,7 +60,7 @@ ESTEPE= Maximum fractional energy loss per step. Note that this is a global option only, no region-by-region setting is possible. If missing, - the defualt is 0.25 (25%). + the default is 0.25 (25%). [ ESTEPE ] \end{verbatim} \index{XImax} @@ -75,8 +75,8 @@ \index{exact\_bca} \index{transport\_algorithm} \begin{verbatim} - Boundary crossing algorithm= - There are two selections possible: EXACT, means + Boundary crossing algorithm= EXACT (default), PRESTA-I + There are two selections possible: EXACT means the algorithm will cross boundaries in a single scattering (SS) mode, the distance from a boundary at which the transition to SS mode is made is @@ -94,23 +94,21 @@ Determines the distance from a boundary (in elastic MFP) at which the algorithm will go into single scattering mode (if EXACT boundary crossing) or - swith off lateral correlations (if PRESTA-I boundary + switch off lateral correlations (if PRESTA-I boundary crossing). Default value is 3 for EXACT or exp(BLCMIN)/BLCMIN for PRESTA-I (see the PRESTA paper for a definition of BLCMIN). Note that if you choose EXACT boundary crossing and set Skin depth for BCA to a very large number (e.g. 1e10), the entire - calculation will be in SS mode. If you choose - PRESTA-I boundary crossing and make Skin depth for BCA - large, you will get default EGS4 behavious (no PRESTA) + calculation will be in single-scattering mode. If you + choose PRESTA-I boundary crossing and make Skin depth + for BCA large, you will get default EGS4 behaviour + (no PRESTA). [ skindepth_for_bca ] \end{verbatim} \index{electron step algorithm} \begin{verbatim} - Electron-step algorithm= - PRESTA-II (the default), the name is - used for historical reasons - or PRESTA-I + Electron-step algorithm= PRESTA-II (default), PRESTA-I (legacy) Determines the algorithm used to take into account lateral and longitudinal correlations in a condensed history step. @@ -119,7 +117,7 @@ \index{spin effects} \index{spin\_effects} \begin{verbatim} - Spin effects= Off, On, default is On + Spin effects= Off, On (default) Turns off/on spin effects for electron elastic scattering. Spin On is ABSOLUTELY necessary for good backscattering calculations. Will make a @@ -131,10 +129,10 @@ \index{brems angular sampling} \index{IBRDST} \begin{verbatim} - Brems angular sampling= Simple, KM, default is KM + Brems angular sampling= Simple, KM (default) If Simple, use only the leading term of the Koch-Motz distribution to determine the emission angle of - bremsstrahlung photons. If On, complete + bremsstrahlung photons. If KM, complete modified Koch-Motz 2BS is used (modifications concern proper handling of kinematics at low energies, makes 2BS almost the same as 2BN at low energies). @@ -143,7 +141,7 @@ \index{brems cross section} \index{ibr\_nist} \begin{verbatim} - Brems cross sections= BH, NIST, NRC default is BH + Brems cross sections= BH (default), NIST, NRC If BH is selected, the Bethe-Heitler bremsstrahlung cross sections (Coulomb corrected above 50 MeV) will be used. If NIST is selected, the NIST brems @@ -187,7 +185,7 @@ \index{radiative Compton corrections} \index{radc\_flag} \begin{verbatim} - Radiative Compton corrections= On or Off (default). If on, then + Radiative Compton corrections= On or Off (default). If On, then include radiative corrections for Compton scattering. Equations are based on original Brown & Feynman equations (Phys. Rev. 85, p 231--1952). Requires @@ -199,7 +197,6 @@ \end{verbatim} \index{electron impact ionization} \index{eii\_flag} -\index{eii\_xfile} \begin{verbatim} Electron Impact Ionization= Off (default), On, casnati, kolbenstvedt, gryzinski or penelope. If set to On or ik, then @@ -218,14 +215,14 @@ \index{pair angular sampling} \index{IPRDST} \begin{verbatim} - Pair angular sampling= Off, Simple, KM. + Pair angular sampling= Off, Simple (default), KM. If off, pairs are set in motion at an angle m/E relative to the photon direction (m is electron rest energy, E the photon energy). Simple turns on the leading term of the angular distribution (this is sufficient for most applications), KM (comes from Koch and Motz) turns on using 2BS - from the article by Koch and Motz. Uniform + from the article by Koch and Motz. Default is Simple, make sure you always use Simple or KM [ IPRDST ] @@ -238,7 +235,7 @@ to NRC, then use NRC pair production cross-sections (in file $HEN_HOUSE/data/pair_nrc1.data). Only of interest at low energies, where the NRC cross- - sections take into account the assymmetry in the + sections take into account the asymmetry in the positron-electron energy distribution. [ pair_nrc ] \end{verbatim} @@ -246,19 +243,24 @@ \index{photon\_xsections} \begin{verbatim} Photon cross sections= Photon cross-section data. Current options are - si (Storm-Israel--the default), epdl (Evaluated Photon - Data Library), xcom, and pegs4. Allows the use of photon - cross-sections other than from the PEGS4 file unless - the pegs4 option is specified. + si (Storm-Israel), epdl (Evaluated Photon Data + Library), xcom (default), pegs4, mcdf-xcom and + mcdf-epdl: + Allows the use of photon cross-sections other than + from the PEGS4 file (unless the pegs4 option is + specified). Options mcdf-xcom and mcdf-epdl use + Sabbatucci and Salvat's renormalized photoelectric + cross sections with either xcom or epdl for all other + cross sections. These are more accurate but can + increase CPU time by up to 6 %. Note that the user can supply their own cross-section - data as well. The requirement is that the files + data as well. The requirement is that the files photon_xsections_photo.data, photon_xsections_pair.data, photon_xsections_triplet.data, and photon_xsections_rayleigh.data exist in the $HEN_HOUSE/data directory, where photon_xsections - is the name specified. - Entry is case-sensitive except for the pegs4 option. + is the name specified. This entry is case-sensitive. [ photon_xsections ] \end{verbatim} \index{photon cross sections!output} @@ -286,14 +288,13 @@ \index{Rayleigh scattering!custom form factors} \index{IRAYLR} \begin{verbatim} - Rayleigh scattering= Off, On, custom - If On, turned on coherent (Rayleigh) scattering. - Default is Off. Should be turned on for low energy + Rayleigh scattering= Off, On (default), custom + If On, turns on coherent (Rayleigh) scattering. + Default is On. Should be turned on for low energy applications. If custom, user must provide media names and form factor files for each desired medium. The rest of the media use the default atomic form factors. - Not set to On by default for historical reasons since - a PEGS4 data set is not required anymore. + A PEGS4 data set is not required anymore. [ IRAYLR ] \end{verbatim} \index{iray\_ff\_media} @@ -315,53 +316,82 @@ $HEN_HOUSE/data/molecular_form_factors. [ iray_ff_file($MXMED) ] \end{verbatim} +\index{photonuclear attenuation} +\index{IPHOTONUCR} +\begin{verbatim} + Photonuclear attenuation= Off (default) or On + If On, models the photonuclear effect. Current + implementation is crude. Available on a + region-by-region basis (see below) + [ IPHOTONUCR ] +\end{verbatim} +\index{photonuclear cross sections} +\index{photonuc\_xsections} +\begin{verbatim} + Photonuclear cross sections= Total photonuclear cross sections. User- + supplied total photonuclear cross-sections in + $HEN_HOUSE/data/photonuc_xsections_photonuc.data, + where photonuc_xsections is the name supplied for + this input (case sensitive). In the absence of + any user-supplied data, or if photonuc_xsections + is set to 'default', the default file is + iaea_photonuc.data. + [ photonuc_xsections ] +\end{verbatim} \index{photoelectron angular sampling} \index{IPHTER} \begin{verbatim} - Photoelectron angular sampling= Off or On + Photoelectron angular sampling= Off or On (default) If Off, photo-electrons get the direction of the - `mother' photon, with On, Sauter's furmula is - used (which is, striktly speaking, valid only for + `mother' photon, with On, Sauter's formula is + used (which is, strictly speaking, valid only for K-shell photo-absorption). If the user has a better approach, replace the macro $SELECT-PHOTOELECTRON-DIRECTION; - The only application that - I encountered until now where this option made a - small difference was a big ion chamber (cavity size - comparable with electron range) with high-Z walls - in a low energy photon beam. - Default is On + The only application encountered where this option + made a small difference was a big ion chamber + (cavity size comparable with electron range) + with high-Z walls in a low energy photon beam. [ IPHTER ] \end{verbatim} \index{atomic relaxations} \index{IEDGFL} \begin{verbatim} - Atomic relaxations= Off, On - Default is On. The effect of using On is twofold: + Atomic relaxations= Off, On, eadl (default), simple + On defaults to eadl. + When simulating atomic relaxations: - In photo-electric absorption events, the element (if material is mixture) and the shell the photon is interacting with are sampled from the appropriate - cross seections - - Shell vacancies created in photo-absorption events + cross sections + - Shell vacancies created in photoelectric, + compton and electron impact ionization events are relaxed via emission of fluorescent X-Rays, Auger and Koster-Cronig electrons. - Make sure to turn this option on for low energy - applications. - [ IEDGFL ] + The eadl option features a more accurate treatment + of relaxation events and uses binding energies + consistent with those in of the photon cross sections + used in the simulation. If using mcdf-xcom or + mcdf-epdl photon cross sections, you cannot use + the simple option and this will automatically get + reset to eadl. Make sure to use eadl or simple for + low energy applications. + [ IEDGFL ] \end{verbatim} \noindent -Atomic relaxations, Rayleigh scattering, Photoelectron angular sampling -and Bound Compton scattering can also be turned On/Off on a -region-by-region basis. An example for Atomic relaxations on a region- -by-region basis is: +Atomic relaxations, Rayleigh scattering, Photoelectron angular sampling, +Bound Compton scattering and photonuclear effect +can also be turned On/Off on a region-by-region basis. An example for +Atomic relaxations on a region-by-region basis is: \begin{verbatim} Atomic relaxations= On in Regions or Atomic relaxations= Off in regions \end{verbatim} -Then define the regions in which you want the feature to be turned on: +Then define the regions in which you want +the feature to be turned on: \begin{verbatim} Bound Compton start region= @@ -375,18 +405,25 @@ or PE sampling start region= PE sampling stop region= + or + Photonuclear start region= + Photonuclear stop region= \end{verbatim} -each followed by a list of one or more start and stop regions -separated by commas. Example: + +each followed by a list of one or more +start and stop regions separated by commas. +Example: + \begin{verbatim} Atomic relaxations= On in Regions Relaxations start region= 1, 40 Relaxations stop region= 10, 99 \end{verbatim} + will first turn off relaxations everywhere and then turn on in regions 1-10 and 40-99. -Note that the input is checked against minimum and maximum -region number and ignored if +Note that the input is checked against minimum +and maximum region numbers and ignored if \verb+start region < 1+ or \verb+stop_region > $MXREG+ or \verb+start region > stop region+. diff --git a/HEN_HOUSE/doc/src/pirs702-egsnrc-codes/pirs702-egsnrc-codes.tex b/HEN_HOUSE/doc/src/pirs702-egsnrc-codes/pirs702-egsnrc-codes.tex index 87ecda6b4..e36dc2978 100644 --- a/HEN_HOUSE/doc/src/pirs702-egsnrc-codes/pirs702-egsnrc-codes.tex +++ b/HEN_HOUSE/doc/src/pirs702-egsnrc-codes/pirs702-egsnrc-codes.tex @@ -974,7 +974,7 @@ \subsubsection{previewRZ} \htmladdnormallink{{\tt http://www.scriptics.com/software/8.4.html}}{http://www.scriptics.com/software/8.4.html} or \\ \htmladdnormallink{{\tt http://www.activestate.com/Products/ActiveTcl}} {http://www.activestate.com/Products/ActiveTcl}. We recommend using -the the ``ActiveTcl'' site, since it includes a wizard +the ``ActiveTcl'' site, since it includes a wizard which makes installation much easier (especially on Windows systems). Once you have installed {\tt Tcl/Tk} you must ensure that the directory {\tt /(directory where Tcl/Tk was installed)/bin} is included in your @@ -2563,8 +2563,8 @@ \subsubsection{Pegsless Inputs} correction to apply to calculated bremsstrahlung cross-sections. Options are: \begin{itemize} -\item {\tt KM} $[$IAPRIM=0$]$ (the default): Apply Koch and Motz\cite{KM59} empirical corrections. -\item {\tt NRC} $[$IAPRIM=1$]$: Apply NRC corrections based on NIST/ICRU\cite{Ro89a}. These corrections are read from the file +\item {\tt KM} $[$IAPRIM=0$]$ Apply Koch and Motz\cite{KM59} empirical corrections. +\item {\tt NRC} $[$IAPRIM=1$]$: (the default) Apply NRC corrections based on NIST/ICRU\cite{Ro89a}. These corrections are read from the file {\tt \$HEN\_HOUSE/pegs4/aprime.data}. \item {\tt None} $[$IAPRIM=2$]$: No corrections applied. \end{itemize} @@ -3373,7 +3373,7 @@ \subsection{Photon cross section enhancement (DOSRZnrc)} where $\rho$ is the mass density in the region. If C is selected so that $C_e \le 1$ (eg if the attenuation coefficient is very large), cross section enhancement is turned off. This is exactly the desired -behaviour: if the the photon already interacts at a very high rate due +behaviour: if the photon already interacts at a very high rate due to its large attenuation coefficient, there is no need of an additional increase in the interaction density. diff --git a/HEN_HOUSE/doc/src/pirs794-dosxyznrc/inputs/dosxyznrc.inp b/HEN_HOUSE/doc/src/pirs794-dosxyznrc/inputs/dosxyznrc.inp index 3dd735626..4722cd2d4 100644 --- a/HEN_HOUSE/doc/src/pirs794-dosxyznrc/inputs/dosxyznrc.inp +++ b/HEN_HOUSE/doc/src/pirs794-dosxyznrc/inputs/dosxyznrc.inp @@ -1028,7 +1028,7 @@ Record SC1-20a and SC1-21a (required for sources 20 and 21) All input associated with selection of EGSnrc transport parameter is not crucial for the execution as there are default values set. Therefore, if some of the input options in this section are - missing/misspelled, this will be ignored and defualt parameter assumed + missing/misspelled, this will be ignored and default parameter assumed As the transport parameter input routine uses get_inputs, a lot of error/warning messages may be produced on UNIT 15, though. If you don't have the intention of changing default settings, @@ -1040,19 +1040,19 @@ Record SC1-20a and SC1-21a (required for sources 20 and 21) :stop mc transport parameter: Currently, the following options are available (case does not matter and - the internal variables are shown in [ ] brackets): + the internal variables are shown in [ ] brackets): Global ECUT= Global (in all regions) electron transport cut - off energy (in MeV). If this imput is missing, + off energy (in MeV). If this input is missing, or is < ECUTIN from the main DOSXYZnrc inputs (See above) then ECUTIN is used for global ECUT. - ECUT defaults to AE(medium). + If this input is missing, AE(medium) will be used. [ ECUT ] Global PCUT= Global (in all regions) photon transport cut - off energy (in MeV). If this imput is missing, + off energy (in MeV). If this input is missing, or is < PCUTIN from the main DOSXYZnrc inputs (See above) then PCUTIN is used for global PCUT. - PCUT defaults to AP(medium). + If this input is missing, AP(medium) will be used. [ PCUT ] Global SMAX= Global (in all regions) maximum step-size restriction for electron transport (in cm). @@ -1062,30 +1062,28 @@ Record SC1-20a and SC1-21a (required for sources 20 and 21) will default to 1e10. However, if either Electron-step algorithm= PRESTA-I or - Boundary crossing algorithm= PRESTA-I (the default), - then a step-size restriction is necessary, and - SMAX will default to 5 cm. + Boundary crossing algorithm= PRESTA-I (the default in + DOSXYZnrc), then a step-size restriction is necessary, + and SMAX will default to 5 cm. [ SMAXIR ] ESTEPE= Maximum fractional energy loss per step. Note that this is a global option only, no region-by-region setting is possible. If missing, - the defualt is 0.25 (25%). + the default is 0.25 (25%). [ ESTEPE ] XImax= Maximum first elastic scattering moment per step. Default is 0.5, NEVER use value greater than 1 as this is beyond the range of MS data available. [ XIMAX ] - Boundary crossing algorithm= - There are two selections possible: EXACT and - PRESTA-I. PRESTA-I means that boundaries will - be crossed a la PRESTA. That is, with lateral - correlations turned off at a distance given by - `Skin depth for BCA' (see below) from the boundary - and MS forced at the boundary. EXACT means + Boundary crossing algorithm= EXACT, PRESTA-I (default in DOSXYZnrc) + There are two selections possible: EXACT means the algorithm will cross boundaries in a single scattering (SS) mode, the distance from a boundary at which the transition to SS mode is made is - determined by `Skin depth for BCA' (see below). + determined by 'Skin depth for BCA' (see below). + The second option is PRESTA-I, if selected boundaries + will be crossed a la PRESTA, i.e. with lateral + correlations turned off and MS forced at boundaries. Default is PRESTA-I for efficiency reasons. This is known not to be exactly correct, and when charged particle equilibrium does not hold or when there is @@ -1095,25 +1093,22 @@ Record SC1-20a and SC1-21a (required for sources 20 and 21) cases, swich to EXACT BCA. [ bca_algorithm, exact_bca ] Skin depth for BCA= - If Boundary crossing algorithm= PRESTA-I (default) - then this is the distance from the boundary (in - elastic MFP) at which lateral correlations will be - switched off. The default in this case is to - calculate a value based on the scattering power at - ECUT (same as PRESTA in EGS4). If - Boundary crossing algorithm= EXACT then this is - the distance from the boundary (in elastic + Determines the distance from a boundary (in elastic MFP) at which the algorithm will go into single - scattering mode and defaults to 3 mfp. - Note that if you choose EXACT boundary crossing and - set Skin depth for BCA to a very large number (e.g. - 1e10), the entire calculation will be in SS mode. - If you choose PRESTA-I boundary crossing and make - Skin depth for BCA large, you will get default EGS4 - behaviour (no PRESTA). + scattering mode (if EXACT boundary crossing) or + switch off lateral correlations (if PRESTA-I boundary + crossing). Default value is 3 for EXACT or + exp(BLCMIN)/BLCMIN for PRESTA-I (see the PRESTA paper + for a definition of BLCMIN). Note that if you choose + EXACT boundary crossing and set Skin depth for BCA + to a very large number (e.g. 1e10), the entire + calculation will be in single-scattering mode. + If you choose PRESTA-I boundary crossing (default + in DOSXYZnrc) and make Skin depth for BCA large, + you will get default EGS4 behaviour (no PRESTA). [ skindepth_for_bca ] - Note that the above defaults have been choosen as a compromise + Note that the above defaults have been chosen as a compromise between accuracy (EXACT BCA) and efficiency (PRESTA-I BCA) since the PRESTA-I BCA algorithm has proven to generally produce satisfactory results. Note that the new transport @@ -1121,15 +1116,12 @@ Record SC1-20a and SC1-21a (required for sources 20 and 21) that one always has the option of verifying the accuracy by doing a long run with the EXACT BCA. - Electron-step algorithm= - PRESTA-II (the default), the name is - used for historical reasons - or PRESTA-I + Electron-step algorithm= PRESTA-II (default), PRESTA-I (legacy) Determines the algorithm used to take into account lateral and longitudinal correlations in a condensed history step. [ transport_algorithm ] - Spin effects= Off, On, default is On + Spin effects= Off, On (default) Turns off/on spin effects for electron elastic scattering. Spin On is ABSOLUTELY necessary for good backscattering calculations. Will make a @@ -1137,47 +1129,47 @@ Record SC1-20a and SC1-21a (required for sources 20 and 21) (e.g. depth dose curves for RTP energy range electrons). [ spin_effects ] - Brems angular sampling= Simple, KM, default is Simple + Brems angular sampling= Simple, KM (default) If Simple, use only the leading term of the Koch-Motz distribution to determine the emission angle of bremsstrahlung photons. If KM, complete modified Koch-Motz 2BS is used (modifications - concern proper handling of kinematics at low - energies, makes 2BS almost the same as 2BN at low - energies). + concern proper handling of kinematics at low energies, + makes 2BS almost the same as 2BN at low energies). [ IBRDST ] - Brems cross sections= BH, NIST, NRC, default is BH + Brems cross sections= BH (default), NIST, NRC If BH is selected, the Bethe-Heitler bremsstrahlung cross sections (Coulomb corrected above 50 MeV) will be used. If NIST is selected, the NIST brems cross section data base (which is the basis for the ICRU radiative stopping powers) will be employed. Differences are negligible for E > ,say, 10 MeV, - but signifficant in the keV energy range. If NRC is - selected, NIST data including corrections for - electron-electron brems will be used (typically only + but significant in the keV energy range. If NRC is + selected, the NRC brems cross-section data base will + be used, which is a version of the NIST data base + with corrected electron-electron brems contributions + (corrections to the NIST data is typically only significant for low values of the atomic number Z and for k/T < 0.005). - Bound Compton scattering= On, Off or Norej (Default is On) + [ ibr_nist ] + Triplet production= On or Off (default). Turns on/off simulation + of triplet production. If On, then Borsellino's + first Born approximation is used to sample triplet + events based on the triplet cross-section data. + [ itriplet ] + Bound Compton scattering= On, Off, Simple or norej (default) If Off, Compton scattering will be treated with Klein-Nishina, with On Compton scattering is treated in the Impulse approximation. + With Simple, the impulse approximation incoherent + scattering function will be used (i.e., no Doppler + broadenning). With norej the actual total bound + Compton cross section is used and there are no + rejections at run time. Make sure to turn on for low energy applications, - not necessary above, say, 1 MeV. Option Norej - uses full bound Compton cross section data - supplied in input below and does not reject - interactions. + not necessary above, say, 1 MeV. [ IBCMP ] - Compton cross sections= Bound Compton cross-section data. User- - supplied bound Compton cross-sections in the file - $HEN_HOUSE/data/comp_xsections_compton.data, where - comp_xsections is the name supplied for this input. - This is only used if Bound Compton scattering= Simple - and is not available on a region-by-region basis - (see below). The default file (ie in the absence - of any user-supplied data) is compton_sigma.data. - [ comp_xsections ] - Radiative Compton corrections= On or Off (default). If on, then + Radiative Compton corrections= On or Off (default). If On, then include radiative corrections for Compton scattering. Equations are based on original Brown & Feynman equations (Phys. Rev. 85, p 231--1952). Requires @@ -1186,7 +1178,20 @@ Record SC1-20a and SC1-21a (required for sources 20 and 21) SOURCES (just before $(EGS_SOURCEDIR)get_inputs.mortran). [ radc_flag ] - Pair angular sampling= Off, Simple or KM + Electron Impact Ionization= Off (default), On, casnati, kolbenstvedt, + gryzinski or penelope. If set to On or ik, then + use Kawrakow's theory to derive EII cross-sections. + If set to casnati, then use the cross-sections of + Casnati (from file $HEN_HOUSE/data/eii_casnati.data). + Similar for kolbenstvedt, gryzinski and penelope. + This is only of interest in kV X-ray calculations. + Note that the user can supply their own EII + cross-section data as well. The requirement is that + the file eii_suffix.data exists in the $HEN_HOUSE/data + directory, where suffix is the name specified. + Entry is case-sensitive except for Off, On or ik. + [ eii_flag, eii_xfile ] + Pair angular sampling= Off, Simple (default), KM. If off, pairs are set in motion at an angle m/E relative to the photon direction (m is electron rest energy, E the photon energy). Simple turns on @@ -1202,83 +1207,120 @@ Record SC1-20a and SC1-21a (required for sources 20 and 21) to NRC, then use NRC pair production cross-sections (in file $HEN_HOUSE/data/pair_nrc1.data). Only of interest at low energies, where the NRC cross- - sections take into account the assymmetry in the + sections take into account the asymmetry in the positron-electron energy distribution. [ pair_nrc ] - Photoelectron angular sampling= Off or On + Photon cross sections= Photon cross-section data. Current options are + si (Storm-Israel), epdl (Evaluated Photon Data + Library), xcom (default), pegs4, mcdf-xcom and + mcdf-epdl: + Allows the use of photon cross-sections other than + from the PEGS4 file (unless the pegs4 option is + specified). Options mcdf-xcom and mcdf-epdl use + Sabbatucci and Salvat's renormalized photoelectric + cross sections with either xcom or epdl for all other + cross sections. These are more accurate but can + increase CPU time by up to 6 %. + Note that the user can supply their own cross-section + data as well. The requirement is that the files + photon_xsections_photo.data, + photon_xsections_pair.data, + photon_xsections_triplet.data, and + photon_xsections_rayleigh.data exist in the + $HEN_HOUSE/data directory, where photon_xsections + is the name specified. This entry is case-sensitive. + [ photon_xsections ] + Photon cross-sections output= Off (default) or On. If On, then + a file $EGS_HOME/user_code/inputfile.xsections is + output containing photon cross-section data used. + [ xsec_out ] + Compton cross sections= Bound Compton cross-section data. User- + supplied bound Compton cross-sections in the file + $HEN_HOUSE/data/comp_xsections_compton.data, where + comp_xsections is the name supplied for this input. + This is only used if Bound Compton scattering= Simple + and is not available on a region-by-region basis + (see below). The default file (ie in the absence + of any user-supplied data) is compton_sigma.data. + [ comp_xsections ] + Rayleigh scattering= Off, On (default), custom + If On, turns on coherent (Rayleigh) scattering. + Default is On. Should be turned on for low energy + applications. If custom, user must provide media names + and form factor files for each desired medium. The + rest of the media use the default atomic form factors. + A PEGS4 data set is not required anymore. + [ IRAYLR ] + ff media names = A list of media names (must match media found in + PEGS4 data file) for which the user is going to + provide custom Rayleigh form factor data. + [ iray_ff_media($MXMED) ] + ff file names = A list of names of files containing the Rayleigh + form factor data for the media specified by + the ff media names = input above. Full directory + paths must be given for all files, and for each medium + specified, iray_ff_media(i), there must be a + corresponding file name, iray_ff_file(i). For + example files, see the directory + $HEN_HOUSE/data/molecular_form_factors. + [ iray_ff_file($MXMED) ] + Photonuclear attenuation= Off (default) or On + If On, models the photonuclear effect. Current + implementation is crude. Available on a + region-by-region basis (see below) + [ IPHOTONUCR ] + Photonuclear cross sections= Total photonuclear cross sections. User- + supplied total photonuclear cross-sections in + $HEN_HOUSE/data/photonuc_xsections_photonuc.data, + where photonuc_xsections is the name supplied for + this input (case sensitive). In the absence of + any user-supplied data, or if photonuc_xsections + is set to 'default', the default file is + iaea_photonuc.data. + [ photonuc_xsections ] + Photoelectron angular sampling= Off or On (default) If Off, photo-electrons get the direction of the - `mother' photon, with On, Sauter's furmula is - used (which is, striktly speaking, valid only for + `mother' photon, with On, Sauter's formula is + used (which is, strictly speaking, valid only for K-shell photo-absorption). If the user has a better approach, replace the macro $SELECT-PHOTOELECTRON-DIRECTION; - The only application that - I encountered until now where this option made a - small difference was a big ion chamber (cavity size - comparable with electron range) with high-Z walls - in a low energy photon beam. - Default is Off + The only application encountered where this option + made a small difference was a big ion chamber + (cavity size comparable with electron range) + with high-Z walls in a low energy photon beam. [ IPHTER ] - Rayleigh scattering= Off, On, custom - If On, turned on coherent (Rayleigh) scattering. - Default is Off. Should be turned on for low energy - applications. Not set to On by default because - On requires a special PEGS4 data set. If set to - custom, then media for which custom form factors - are to be specified are listed in the input: - ff media names= - and the corresponding files containing custom data - are listed in: - ff file names= - [ IRAYLR ] - Atomic relaxations= Off, On - Default is Off. The effect of using On is twofold: + Atomic relaxations= Off, On, eadl (default), simple + On defaults to eadl. + When simulating atomic relaxations: - In photo-electric absorption events, the element (if material is mixture) and the shell the photon - is interacting with are sampled from the - appropriate cross seections - - Shell vacancies created in photo-absorption events + is interacting with are sampled from the appropriate + cross sections + - Shell vacancies created in photoelectric, + compton and electron impact ionization events are relaxed via emission of fluorescent X-Rays, Auger and Koster-Cronig electrons. - Make sure to turn this option on for low energy - applications. - [ IEDGFL ] - Electron impact ionization= Off, On, Casnati, Kolbenstvedt, Gryzinski - (Default is Off) - Determines which, if any, theory is used to model - electron impact ionization. If set to 'On' then the - theory of Kawrakow is used. Other settings use the - theory associated with the name given. See future - editions of the EGSnrc Manual (PIRS-701) for more - details. This is only of interest in keV X-Ray - simulations. Otherwise, leave it Off. - [ eii_flag ] - Photon cross sections= epdl, xcom, customized (Default is Storm-Israel - cross-sections from PEGS4) - The name of the cross-section data for photon - interactions. This input line must be left out - to access the default Storm-Israel cross-sections - from PEGS4. 'edpl' uses cross-sections from the - evaluated photon data library (EPDL) from Lawrence - Livermore. 'xcom' will use the XCOM cross-sections - from Burger and Hubbell. The user also has the - option of using their own customized cross-section - data. See the BEAMnrc manual for more details. - [ photon_xsections ] - Photon cross-sections output= Off (default) or On. If On, then - a file $EGS_HOME/user_code/inputfile.xsections is - output containing photon cross-section data used. - [ xsec_out ] - - Atomic relaxations, Rayleigh scattering, - Photoelectron angular sampling and Bound Compton scattering - can also be turned On/Off on a region-by-region - basis. To do so, put e.g. + The eadl option features a more accurate treatment + of relaxation events and uses binding energies + consistent with those in of the photon cross sections + used in the simulation. If using mcdf-xcom or + mcdf-epdl photon cross sections, you cannot use + the simple option and this will automatically get + reset to eadl. Make sure to use eadl or simple for + low energy applications. + [ IEDGFL ] + + Atomic relaxations, Rayleigh scattering, Photoelectron angular sampling, + Bound Compton scattering and photonuclear effect + can also be turned On/Off on a region-by-region basis. An example for + Atomic relaxations on a region-by-region basis is: Atomic relaxations= On in Regions or Atomic relaxations= Off in regions - in your input file. Then use + Then define the regions in which you want + the feature to be turned on: Bound Compton start region= Bound Compton stop region= @@ -1291,19 +1333,35 @@ Record SC1-20a and SC1-21a (required for sources 20 and 21) or PE sampling start region= PE sampling stop region= + or + Photonuclear start region= + Photonuclear stop region= - each followed by a lost of of one or more + each followed by a list of one or more start and stop regions separated by commas. Example: + Atomic relaxations= On in Regions Relaxations start region= 1, 40 Relaxations stop region= 10, 99 + will first turn off relaxations everywhere and then turn on in regions 1-10 and 40-99. - Note that input is checked against min. and max. - region number and ignored if + Note that the input is checked against minimum + and maximum region numbers and ignored if start region < 1 or stop_region > $MXREG or start region > stop region. + ECUT, PCUT and SMAX can also be set on a + region-by-region basis. To do so, iclude + in your input file + + Set XXXX= f_value1, f_value2, ... + Set XXXX start region= i_value1, i_value2, ... + Set XXXX stop region= j_value1, j_value2, ... + where XXXX is ECUT, PCUT or SMAX , + f_value1, f_value2,... are the desired values for XXXX + and i_value_i and j_value_i are the start and + stop regions. \end{verbatim} diff --git a/HEN_HOUSE/doc/src/pirs794-dosxyznrc/pirs794-dosxyznrc.tex b/HEN_HOUSE/doc/src/pirs794-dosxyznrc/pirs794-dosxyznrc.tex index 293e87636..6d3a92ffd 100644 --- a/HEN_HOUSE/doc/src/pirs794-dosxyznrc/pirs794-dosxyznrc.tex +++ b/HEN_HOUSE/doc/src/pirs794-dosxyznrc/pirs794-dosxyznrc.tex @@ -2098,7 +2098,7 @@ \subsubsection{Phase space source incident through a shared library geometry} the DOSXYZnrc phantom per particle incident from the phase space source. Thus, the original estimate of {\tt NRCYCL} is incorrect. To overcome this when a BEAM shared library is used, an initial calibration comprising 1x10$^6$ particles run through the BEAM geometry only is used to determine the ratio of the number of particles -emerging from the the bottom of the BEAM library geometry to the number of incident particles (survival ratio). +emerging from the bottom of the BEAM library geometry to the number of incident particles (survival ratio). {\tt NRCYCL} is then recalculated by multiplying the original estimate by 1/(survival ratio). \indexm{calflag} @@ -3910,7 +3910,7 @@ \subsection{{\tt Pair angular sampling} ({\tt IPRDST})} Motz et al\cite{Mo69} is used to determine the positron/electron emission angles. This option is similar to the sampling technique used by the current version of EGS4/DOSXYZ. Finally if {\tt Pair angular sampling= Simple} (the default), then only -the first term in the the Motz et al eqn 3D-2003 is used. The {\tt KM} option +the first term in the Motz et al eqn 3D-2003 is used. The {\tt KM} option becomes less efficient with increasing accelerator energies and, moreover, involves assumptions that are questionable at low energy. For these reasons, the default setting is {\tt Simple}. @@ -3934,9 +3934,9 @@ \subsection{{\tt Photoelectron angular sampling} ({\tt IPHTER})} The {\tt Photoelectron angular sampling} input determines the sampling method used by EGSnrc to determine the angle of emission of photoelectrons. -If {\tt Photoelectron angular sampling= Off} (the default), then +If {\tt Photoelectron angular sampling= Off}, then photoelectrons inherit the direction of the incident photon. If -{\tt Photoelectron angular sampling= On}, then Sauter's formula +{\tt Photoelectron angular sampling= On} (the default), then Sauter's formula \cite{Sa31} is used to determine the angle of the photoelectron. Note that, in most applications, we have not observed any difference between the ``Off" and ``On" settings of this parameters. Also note that, @@ -3962,11 +3962,11 @@ \subsection{{\tt Rayleigh scattering} ({\tt IRAYLR})} This input determines whether Rayleigh (coherent) scattering is simulated or not. -If {\tt Rayleigh scattering= On}, then Rayleigh events are simulated +If {\tt Rayleigh scattering= On} (the default), then Rayleigh events are simulated using the total coherent cross-sections from Storm and Israel\cite{SI70} and atomic form factors from Hubbell and {\O}verb{\o}\cite{HO79}. This data must be included in the PEGS4 material data set. -If {\tt Rayleigh scattering= Off} (the default), then Rayleigh +If {\tt Rayleigh scattering= Off}, then Rayleigh events are not simulated. Rayleigh scattering is only recommended for low-energy ($<$ 1 MeV) simulations. Also, for proper simulation of Rayleigh events, bound Compton scattering (see section~\ref{bcsect} above) @@ -3993,13 +3993,13 @@ \subsection{{\tt Atomic Relaxations} ({\tt IEDGFL})} This input determines whether or not the relaxation of atoms to their ground state after Compton and photoelectric events is simulated. -If {\tt Atomic Relaxations= On}, then relaxation after +If {\tt Atomic Relaxations= On} (the default), then relaxation after Compton and photoelectric events is simulated via the emission of any combination of K-, L-, M- and N-shell fluorescent photons, Auger electrons and Coster-Kronig electrons. The lower energy limit for relaxation processes is 1 keV. Thus, only relaxation in shells with binding energy $>$ 1 keV is simulated. -If {\tt Atomic Relaxations= Off} (the default), then atomic relaxations +If {\tt Atomic Relaxations= Off}, then atomic relaxations are not simulated. In this case, when there is a photoelectric event, EGSnrc transfers all of the photon energy to the photoelectron. This is different from EGS4/DOSXYZ, where the binding energy @@ -4045,7 +4045,7 @@ \subsection{ {\tt Photon cross sections} ({\tt photon\_xsections})} \index{photon cross-sections!Storm-Israel} \index{photon cross-sections!EPDL} \index{photon cross-sections!XCOM} -``Storm-Israel'' (the default), ``epdl'' and ``xcom''. +``Storm-Israel'', ``epdl'' and ``xcom'' (the default). The Storm-Israel cross-sections are the standard PEGS4 cross-sections. The ``epdl'' setting will use cross-sections from the evaluated photon data library (EPDL) from Lawrence Livermore\cite{Cu90}. @@ -4885,7 +4885,7 @@ \subsubsection{{\tt CTFilename}} \indexm{CT!data file} \indexm{CTFilename} {\tt CTFilename} is the full name of a file, the contents of which depend -on the the CT data format: +on the CT data format: \begin {description} \item [Pinnacle format] \indexm{Pinnacle CT} diff --git a/HEN_HOUSE/doc/src/pirs801-egsinprz/pirs801-egsinprz.tex b/HEN_HOUSE/doc/src/pirs801-egsinprz/pirs801-egsinprz.tex index a5bf673c7..542748696 100644 --- a/HEN_HOUSE/doc/src/pirs801-egsinprz/pirs801-egsinprz.tex +++ b/HEN_HOUSE/doc/src/pirs801-egsinprz/pirs801-egsinprz.tex @@ -899,7 +899,7 @@ \subsection{The Cavity Tab} {\tt geometry tab} (upper left corner) is {\em groups} or {\em individual}, the user can define the regions comprising the cavity there. If on the other hand, the input method selected is {\em cavity description}, then the rest of the input fields in the {\tt the geometry tab} -are disabled and the the whole geometry input occurs here. The materials for the chamber wall +are disabled and the whole geometry input occurs here. The materials for the chamber wall and the electrode can be selected from available media in the current PEGS4 data file. This option was useful for early calculations but is not adequate for chambers in which one wants to include much detail. diff --git a/HEN_HOUSE/doc/src/pirs898-egs++/geometry.doxy b/HEN_HOUSE/doc/src/pirs898-egs++/geometry.doxy index 977b27f8f..38eab9888 100644 --- a/HEN_HOUSE/doc/src/pirs898-egs++/geometry.doxy +++ b/HEN_HOUSE/doc/src/pirs898-egs++/geometry.doxy @@ -240,7 +240,7 @@ used by the \c EGS_Xplanes constructor). All geometries can be filled with media by including a media input -property within the the geometry definition. +property within the geometry definition. Because geometries can be used as building blocks for other geometries, which could fill the regions with media, it is not considered a mistake if a geometry does not define its media. However, diff --git a/HEN_HOUSE/egs++/egs_application.h b/HEN_HOUSE/egs++/egs_application.h index c7842f38b..81b1a2809 100644 --- a/HEN_HOUSE/egs++/egs_application.h +++ b/HEN_HOUSE/egs++/egs_application.h @@ -924,7 +924,7 @@ class EGS_EXPORT EGS_Application { This function is re-implemented in the EGS_AdvancedApplication class, from which EGSnrc applications using the mortran EGSnrc - physics subroutines should be derived. The defualt implementation + physics subroutines should be derived. The default implementation is to set transport parameter and cross section options from input between :start MC Transport parameter: and :stop MC Transport parameter: in the input file, diff --git a/HEN_HOUSE/egs++/egs_base_source.h b/HEN_HOUSE/egs++/egs_base_source.h index 1ddbc555f..4115ccde6 100644 --- a/HEN_HOUSE/egs++/egs_base_source.h +++ b/HEN_HOUSE/egs++/egs_base_source.h @@ -459,7 +459,7 @@ class EGS_EXPORT EGS_BaseSpectrum { /*! \brief Reset the state of this spectrum object. * - * The defualt implementation of this method sets #count, #sum_E + * The default implementation of this method sets #count, #sum_E * and #sum_E2 to zero. It should be re-implemented by derived classes * if additional data is needed to describe the state of the spectrum * object to reset this data as well. diff --git a/HEN_HOUSE/egs++/egs_functions.h b/HEN_HOUSE/egs++/egs_functions.h index 26d8461e0..c0f90c362 100644 --- a/HEN_HOUSE/egs++/egs_functions.h +++ b/HEN_HOUSE/egs++/egs_functions.h @@ -138,7 +138,7 @@ typedef void (*EGS_InfoFunction)(const char *,...); * * \ingroup egspp_main * - * By defualt the output goes to the standard output. This behaviour + * By default the output goes to the standard output. This behaviour * can be changed using egsSetInfoFunction(). This is used, for instance, * to write output generated in the C++ part of an EGSnrc application to * a string and then pass it to the EGSnrc mortran back-end using @@ -152,7 +152,7 @@ extern EGS_EXPORT EGS_InfoFunction egsInformation; * * \ingroup egspp_main * - * By defualt the output goes to standard error. This behaviour + * By default the output goes to standard error. This behaviour * can be changed using egsSetInfoFunction(). * * \sa egsInformation, egsFatal @@ -163,7 +163,7 @@ extern EGS_EXPORT EGS_InfoFunction egsWarning; * * \ingroup egspp_main * - * By defualt the output goes to standard error and the \c exit function + * By default the output goes to standard error and the \c exit function * is called. This behaviour can be changed using egsSetInfoFunction(). * However, keep in mind that there may be code that is not prepared to * deal with the situation that egsFatal actually returns. diff --git a/HEN_HOUSE/gui/egs_inprz/include/tooltips.h b/HEN_HOUSE/gui/egs_inprz/include/tooltips.h index 15027ac7d..bfc185d81 100644 --- a/HEN_HOUSE/gui/egs_inprz/include/tooltips.h +++ b/HEN_HOUSE/gui/egs_inprz/include/tooltips.h @@ -446,7 +446,7 @@ static const char* sources[] = { "\nelse treated with Klein-Nishina. Make sure to turn it on for" \ "\nlow energy applications. Default is On." #define PE_ANG_SAMPLING "If Off, photo-electrons get direction of `mother' photon," \ - "\nelse Sauter's formula used (which is, striktly speaking," \ + "\nelse Sauter's formula used (which is, strictly speaking," \ "\nvalid only for K-shell photo-absorption)." #define RAYLEIGH_SCAT "Turns on/off coherent (Rayleigh) scattering." \ @@ -585,4 +585,3 @@ static const char* sources[] = { "\nto collision stopping powers. Superseded if a density correction file is specified." #endif - diff --git a/HEN_HOUSE/gui/egs_inprz/src/tools.cpp b/HEN_HOUSE/gui/egs_inprz/src/tools.cpp index 9da450864..71042aebe 100644 --- a/HEN_HOUSE/gui/egs_inprz/src/tools.cpp +++ b/HEN_HOUSE/gui/egs_inprz/src/tools.cpp @@ -118,7 +118,7 @@ QString forwardItUp( const QString& str ){ } /*And last, but not least, if we want to get a proper - name according the the OS, we can use this little + name according to the OS, we can use this little tool to first get the proper separator and then remove multiplicities @@ -486,5 +486,3 @@ void changeTextColor( QLabel* l, const QString& color ) QString s = l->text(); l->setText( "

"+ s + "

"); } - - diff --git a/HEN_HOUSE/interface/egs_interface1.h b/HEN_HOUSE/interface/egs_interface1.h index 9b7a3b549..6d3760a4d 100644 --- a/HEN_HOUSE/interface/egs_interface1.h +++ b/HEN_HOUSE/interface/egs_interface1.h @@ -97,7 +97,7 @@ functions */ #define MXAUS 35 /* there are 35 different calls to ausgab */ -/*! \brief A structure corresponding to the the EGSnrc particle stack +/*! \brief A structure corresponding to the EGSnrc particle stack common block \c STACK. Note that the stack size \c MXSTACK is defined in a file @@ -925,4 +925,3 @@ extern __extc__ void egsAusgab(EGS_I32 *iarg); extern __extc__ void egsStartParticle(void); #endif - diff --git a/HEN_HOUSE/interface/egs_interface2.h b/HEN_HOUSE/interface/egs_interface2.h index 9abc82172..80e70e9bf 100644 --- a/HEN_HOUSE/interface/egs_interface2.h +++ b/HEN_HOUSE/interface/egs_interface2.h @@ -98,7 +98,7 @@ functions */ #define MXAUS 35 /* there are 35 different calls to ausgab */ -/*! \brief A structure corresponding to the the EGSnrc particle stack +/*! \brief A structure corresponding to the EGSnrc particle stack common block \c STACK. Note that the stack size \c MXSTACK is defined in a file diff --git a/HEN_HOUSE/omega/beamnrc/CMs/DYNVMLC_macros.mortran b/HEN_HOUSE/omega/beamnrc/CMs/DYNVMLC_macros.mortran index 698fc8b13..2a26463af 100644 --- a/HEN_HOUSE/omega/beamnrc/CMs/DYNVMLC_macros.mortran +++ b/HEN_HOUSE/omega/beamnrc/CMs/DYNVMLC_macros.mortran @@ -226,7 +226,7 @@ REPLACE{;COMIN/CM_$DYNVMLC/;} WITH { "V>COMMON/USERDYNVMLC/ "V> -"V> the following variables are required in the the main beam code +"V> the following variables are required in the main beam code "V> to set leaf positions during the simulation when dynamic and step-and-shoot "V> (MODE_$DYNVMLC=1,2) options are used. This common block is part of "V> the larger USER common block. It is defined as {;} in diff --git a/HEN_HOUSE/omega/beamnrc/CMs/SLABS_cm.mortran b/HEN_HOUSE/omega/beamnrc/CMs/SLABS_cm.mortran index f78a88a0d..2b950ee5f 100644 --- a/HEN_HOUSE/omega/beamnrc/CMs/SLABS_cm.mortran +++ b/HEN_HOUSE/omega/beamnrc/CMs/SLABS_cm.mortran @@ -921,7 +921,7 @@ END; "End of subroutine WHERE_AM_I_SLABS" " ************************* " " Returns min. distance to nearest region boundary. Used to be a macro, but -" now the the macro calls this subroutine. +" now the macro calls this subroutine. " "***************************************************************************** diff --git a/HEN_HOUSE/omega/beamnrc/CMs/SYNCHDMLC_macros.mortran b/HEN_HOUSE/omega/beamnrc/CMs/SYNCHDMLC_macros.mortran index 29b61423a..53786e39e 100644 --- a/HEN_HOUSE/omega/beamnrc/CMs/SYNCHDMLC_macros.mortran +++ b/HEN_HOUSE/omega/beamnrc/CMs/SYNCHDMLC_macros.mortran @@ -246,7 +246,7 @@ REPLACE{;COMIN/CM_$SYNCHDMLC/;} WITH { "V>COMMON/USERSYNCHDMLC/ "V> -"V> the following variables are required in the the main beam code +"V> the following variables are required in the main beam code "V> to set leaf positions during the simulation when dynamic and step-and-shoot "V> (MODE_$SYNCHDMLC=1,2) options are used. This common block is part of "V> the larger USER common block. It is defined as {;} in diff --git a/HEN_HOUSE/omega/beamnrc/CMs/SYNCVMLC_macros.mortran b/HEN_HOUSE/omega/beamnrc/CMs/SYNCVMLC_macros.mortran index ea164c471..4d1f4c15d 100644 --- a/HEN_HOUSE/omega/beamnrc/CMs/SYNCVMLC_macros.mortran +++ b/HEN_HOUSE/omega/beamnrc/CMs/SYNCVMLC_macros.mortran @@ -194,7 +194,7 @@ REPLACE{;COMIN/CM_$SYNCVMLC/;} WITH { "V>COMMON/USERSYNCVMLC/ "V> -"V> the following variables are required in the the main beam code +"V> the following variables are required in the main beam code "V> to set leaf positions during the simulation when dynamic and step-and-shoot "V> (MODE_$SYNCVMLC=1,2) options are used. This common block is part of "V> the larger USER common block. It is defined as {;} in diff --git a/HEN_HOUSE/omega/beamnrc/CMs/XTUBE_cm.mortran b/HEN_HOUSE/omega/beamnrc/CMs/XTUBE_cm.mortran index 35581d641..850cbc1bf 100644 --- a/HEN_HOUSE/omega/beamnrc/CMs/XTUBE_cm.mortran +++ b/HEN_HOUSE/omega/beamnrc/CMs/XTUBE_cm.mortran @@ -1128,7 +1128,7 @@ IF(N_$XTUBE > 1)[ "outermost target layer, if any IF(I_XTRA_$XTUBE=1)[ OUTPUT N_$XTUBE; - (/' Now input for the the extra central region in the last'/ + (/' Now input for the extra central region in the last'/ ' (outermost) target layer (layer no. ',I4,'):'); IRA = IRSTART_$XTUBE+N_$XTUBE+2; OUTPUT;(/' width, height of central region (cm):'); diff --git a/HEN_HOUSE/omega/beamnrc/beamnrc.mortran b/HEN_HOUSE/omega/beamnrc/beamnrc.mortran index c99874829..b34bc97c4 100644 --- a/HEN_HOUSE/omega/beamnrc/beamnrc.mortran +++ b/HEN_HOUSE/omega/beamnrc/beamnrc.mortran @@ -1307,7 +1307,7 @@ WITH {,' ',} "I> [ pair_nrc ] "I> Photoelectron angular sampling= Off or On (Default is On) "I> If Off, photo-electrons get the direction of the -"I> `mother' photon, with On, Sauter's furmula is +"I> `mother' photon, with On, Sauter's formula is "I> used (which is, strictly speaking, valid only for "I> K-shell photo-absorption). "I> If the user has a better approach, replace the macro @@ -6223,7 +6223,7 @@ IF (IARG = 5) ["Particle step just taken" "as 1." NFTIME(NP)=NFTIME(NP)+1; - "increment the the number of interactions in the" + "increment the number of interactions in the" "forcing CMs" $RANDOMSET RNNO35;IF(RNNO35 = 0.0)RNNO35=1.E-30; ;$SELECT-PHOTON-MFP-FOR-FORCING(DPMFP); diff --git a/HEN_HOUSE/omega/progs/gui/beamnrc/beamnrc_params.tcl b/HEN_HOUSE/omega/progs/gui/beamnrc/beamnrc_params.tcl index 78be06be3..8124ad21e 100644 --- a/HEN_HOUSE/omega/progs/gui/beamnrc/beamnrc_params.tcl +++ b/HEN_HOUSE/omega/progs/gui/beamnrc/beamnrc_params.tcl @@ -1227,7 +1227,7 @@ Maximum fractional energy loss/step, ESTEPE: Note that this is a global option only, no\ region-by-region setting is possible. If missing,\ - the defualt is 0.25 (25%). + the default is 0.25 (25%). } set ximax {} @@ -1292,7 +1292,7 @@ If Boundary crossing algorithm= PRESTA-I\ Skin depth for BCA large, you will get default EGS4\ behaviour (no PRESTA).\ -Note that the above defaults have been choosen as a compromise\ +Note that the above defaults have been chosen as a compromise\ between accuracy (EXACT BCA) and efficiency (PRESTA-I BCA).\ Note that the new transport\ mechanics of EGSnrc are maintained away from boundaries. @@ -3203,4 +3203,3 @@ The user can think of the inputs of the CHAMBER CM\ input file and so must be reselected by the user each time\ the GUI is used. } - diff --git a/HEN_HOUSE/omega/progs/gui/dosxyznrc/define_phantom_egsnrc.tcl b/HEN_HOUSE/omega/progs/gui/dosxyznrc/define_phantom_egsnrc.tcl index 3fee7deac..489fce58a 100644 --- a/HEN_HOUSE/omega/progs/gui/dosxyznrc/define_phantom_egsnrc.tcl +++ b/HEN_HOUSE/omega/progs/gui/dosxyznrc/define_phantom_egsnrc.tcl @@ -601,7 +601,7 @@ proc define_izscan {} { if [string compare $izrow ""]==0 { set izrow 1 } message $w.message -text "Define a group of voxels by entering\ - the voxel indices, then set the direction of the the scan\ + the voxel indices, then set the direction of the scan\ per page. Unless declared here, the default is no output. \ Click 'Add a group' to define a new group." \ -width 500 -font $helvfont @@ -701,4 +701,3 @@ proc remove_scan_group { w } { } incr izrow -1 } - diff --git a/HEN_HOUSE/omega/progs/gui/dosxyznrc/xyznrc_parameters.tcl b/HEN_HOUSE/omega/progs/gui/dosxyznrc/xyznrc_parameters.tcl index 3b7c6c8a8..e82c5e1e6 100644 --- a/HEN_HOUSE/omega/progs/gui/dosxyznrc/xyznrc_parameters.tcl +++ b/HEN_HOUSE/omega/progs/gui/dosxyznrc/xyznrc_parameters.tcl @@ -830,7 +830,7 @@ Maximum fractional energy loss/step, ESTEPE: Note that this is a global option only, no\ region-by-region setting is possible. If missing,\ - the defualt is 0.25 (25%). + the default is 0.25 (25%). } set ximax {} @@ -898,7 +898,7 @@ If Boundary crossing algorithm= PRESTA-I (default)\ Skin depth for BCA large, you will get default EGS4\ behaviour (no PRESTA).\ -Note that the above defaults have been choosen as a compromise\ +Note that the above defaults have been chosen as a compromise\ between accuracy (EXACT BCA) and efficiency (PRESTA-I BCA)\ since the PRESTA-I BCA algorithm has proven to generally\ produce satisfactory results under conditions of charged particle diff --git a/HEN_HOUSE/src/egsnrc.macros b/HEN_HOUSE/src/egsnrc.macros index 1a9f3b3e8..0a74ae1df 100644 --- a/HEN_HOUSE/src/egsnrc.macros +++ b/HEN_HOUSE/src/egsnrc.macros @@ -2365,7 +2365,7 @@ REPLACE {$SET-SKINDEPTH(#,#);} WITH "This macro calculates the elastic scattering MFP" "If spin_effects is .false., the screened Rutherford cross section" -"is used, else the the elastic MFP is based on PWA cross sections" +"is used, else the elastic MFP is based on PWA cross sections" REPLACE {$CALCULATE-ELASTIC-SCATTERING-MFP(#,#,#);} WITH " ======================================= " @@ -3647,7 +3647,7 @@ REPLACE {;COMIN/EGS-IO/;} WITH {; }; "The following macro sets the EGS_HOME directory " -"The defualt implementation is to use the environment variable " +"The default implementation is to use the environment variable " "EGS_HOME. But at the NRC EGS_HOME is set using the macro " "$EGS_HOME defined in machine.macros. " REPLACE {$set_egs_home;} WITH {; diff --git a/HEN_HOUSE/src/egsnrc.mortran b/HEN_HOUSE/src/egsnrc.mortran index 4beb359ff..93a04508c 100644 --- a/HEN_HOUSE/src/egsnrc.mortran +++ b/HEN_HOUSE/src/egsnrc.mortran @@ -8311,7 +8311,7 @@ IF (iraylm(medium)=0)[return;]"Rayleigh option not requested" Figure out if custom ff needed for medium: check that medium is in the list iray_ff_media, else the default atomic ff used. This used to be done in subroutine get_transport_parameter - but was moved here, since it is up to the the user-code to + but was moved here, since it is up to the user-code to read in the information and it is not ensured that the media information will be read before getting the transport parameters. ****************************************************************/ diff --git a/HEN_HOUSE/src/get_inputs.mortran b/HEN_HOUSE/src/get_inputs.mortran index 4095808e5..5ea71e493 100644 --- a/HEN_HOUSE/src/get_inputs.mortran +++ b/HEN_HOUSE/src/get_inputs.mortran @@ -847,7 +847,7 @@ subroutine get_transport_parameter(ounit); " All input associated with selection of various transport parameter " is not crucial for the execution as there are default values set. " Therefore, if some of the input options in this section are -" missing/misspelled, this will be ignored and defualt parameter assumed +" missing/misspelled, this will be ignored and default parameter assumed " As the transport parameter input routine uses get_inputs, a lot " of error/warning messages may be produced on UNIT 15, though. " If you don't have the intention of changing default settings, @@ -865,14 +865,14 @@ subroutine get_transport_parameter(ounit); " in your input file. " " Currently, the following options are available (case does not matter and -" the internal variables are shown in [ ] brackets): +" the internal variables are shown in [ ] brackets): " " Global ECUT= Global (in all regions) electron transport cut -" off energy (in MeV). If this imput is missing, +" off energy (in MeV). If this input is missing, " AE(medium) will be used. " [ ECUT ] " Global PCUT= Global (in all regions) photon transport cut -" off energy (in MeV). If this imput is missing, +" off energy (in MeV). If this input is missing, " AP(medium) will be used. " [ PCUT ] " Global SMAX= Global (in all regions) maximum step-size @@ -887,14 +887,14 @@ subroutine get_transport_parameter(ounit); " ESTEPE= Maximum fractional energy loss per step. " Note that this is a global option only, no " region-by-region setting is possible. If missing, -" the defualt is 0.25 (25%). +" the default is 0.25 (25%). " [ ESTEPE ] " XImax= Maximum first elastic scattering moment per step. " Default is 0.5, NEVER use value greater than 1 as " this is beyond the range of MS data available. " [ XIMAX ] -" Boundary crossing algorithm= -" There are two selections possible: EXACT, means +" Boundary crossing algorithm= EXACT (default), PRESTA-I +" There are two selections possible: EXACT means " the algorithm will cross boundaries in a single " scattering (SS) mode, the distance from a boundary " at which the transition to SS mode is made is @@ -908,25 +908,23 @@ subroutine get_transport_parameter(ounit); " Determines the distance from a boundary (in elastic " MFP) at which the algorithm will go into single " scattering mode (if EXACT boundary crossing) or -" swith off lateral correlations (if PRESTA-I boundary +" switch off lateral correlations (if PRESTA-I boundary " crossing). Default value is 3 for EXACT or " exp(BLCMIN)/BLCMIN for PRESTA-I (see the PRESTA paper " for a definition of BLCMIN). Note that if you choose " EXACT boundary crossing and set Skin depth for BCA " to a very large number (e.g. 1e10), the entire -" calculation will be in SS mode. If you choose -" PRESTA-I boundary crossing and make Skin depth for BCA -" large, you will get default EGS4 behavious (no PRESTA) +" calculation will be in single-scattering mode. If you +" choose PRESTA-I boundary crossing and make Skin depth +" for BCA large, you will get default EGS4 behaviour +" (no PRESTA). " [ skindepth_for_bca ] -" Electron-step algorithm= -" PRESTA-II (the default), the name is -" used for historical reasons -" or PRESTA-I +" Electron-step algorithm= PRESTA-II (default), PRESTA-I (legacy) " Determines the algorithm used to take into account " lateral and longitudinal correlations in a " condensed history step. " [ transport_algorithm ] -" Spin effects= Off, On, default is On +" Spin effects= Off, On (default) " Turns off/on spin effects for electron elastic " scattering. Spin On is ABSOLUTELY necessary for " good backscattering calculations. Will make a @@ -934,7 +932,7 @@ subroutine get_transport_parameter(ounit); " (e.g. depth dose curves for RTP energy range " electrons). " [ spin_effects ] -" Brems angular sampling= Simple, KM, default is KM +" Brems angular sampling= Simple, KM (default) " If Simple, use only the leading term of the Koch-Motz " distribution to determine the emission angle of " bremsstrahlung photons. If KM, complete @@ -942,7 +940,7 @@ subroutine get_transport_parameter(ounit); " concern proper handling of kinematics at low energies, " makes 2BS almost the same as 2BN at low energies). " [ IBRDST ] -" Brems cross sections= BH, NIST, NRC default is BH +" Brems cross sections= BH (default), NIST, NRC " If BH is selected, the Bethe-Heitler bremsstrahlung " cross sections (Coulomb corrected above 50 MeV) " will be used. If NIST is selected, the NIST brems @@ -956,6 +954,7 @@ subroutine get_transport_parameter(ounit); " (corrections to the NIST data is typically only " significant for low values of the atomic number Z " and for k/T < 0.005). +" [ ibr_nist ] " Triplet production= On or Off (default). Turns on/off simulation " of triplet production. If On, then Borsellino's " first Born approximation is used to sample triplet @@ -970,10 +969,10 @@ subroutine get_transport_parameter(ounit); " broadenning). With norej the actual total bound " Compton cross section is used and there are no " rejections at run time. -" Make sure to use for low energy applications, +" Make sure to turn on for low energy applications, " not necessary above, say, 1 MeV. " [ IBCMP ] -" Radiative Compton corrections= On or Off (default). If on, then +" Radiative Compton corrections= On or Off (default). If On, then " include radiative corrections for Compton scattering. " Equations are based on original Brown & Feynman " equations (Phys. Rev. 85, p 231--1952). Requires @@ -983,23 +982,26 @@ subroutine get_transport_parameter(ounit); " $(EGS_SOURCEDIR)get_inputs.mortran). " [ radc_flag ] " Electron Impact Ionization= Off (default), On, casnati, kolbenstvedt, -" gryzinski, penelope. If set to On or ik, then use -" Kawrakow's theory to derive EII cross-sections. -" If set to casnati, then -" use the cross-sections of Casnati (contained in the -" file ($HEN_HOUSE/data/eii_casnati.data). Similar for -" kolbenstvedt, gryzinski and penelope. This is only of -" interest in kV X-ray calculations. -" Case-sensitive except for Off, On or ik options. -" [ eii_flag ] -" Pair angular sampling= Off, Simple, KM. +" gryzinski or penelope. If set to On or ik, then +" use Kawrakow's theory to derive EII cross-sections. +" If set to casnati, then use the cross-sections of +" Casnati (from file $HEN_HOUSE/data/eii_casnati.data). +" Similar for kolbenstvedt, gryzinski and penelope. +" This is only of interest in kV X-ray calculations. +" Note that the user can supply their own EII +" cross-section data as well. The requirement is that +" the file eii_suffix.data exists in the $HEN_HOUSE/data +" directory, where suffix is the name specified. +" Entry is case-sensitive except for Off, On or ik. +" [ eii_flag, eii_xfile ] +" Pair angular sampling= Off, Simple (default), KM. " If off, pairs are set in motion at an angle m/E " relative to the photon direction (m is electron rest " energy, E the photon energy). Simple turns on " the leading term of the angular distribution " (this is sufficient for most applications), " KM (comes from Koch and Motz) turns on using 2BS -" from the article by Koch and Motz. Uniform +" from the article by Koch and Motz. " Default is Simple, make sure you always use " Simple or KM " [ IPRDST ] @@ -1008,12 +1010,12 @@ subroutine get_transport_parameter(ounit); " to NRC, then use NRC pair production cross-sections " (in file $HEN_HOUSE/data/pair_nrc1.data). Only " of interest at low energies, where the NRC cross- -" sections take into account the assymmetry in the +" sections take into account the asymmetry in the " positron-electron energy distribution. " [ pair_nrc ] " Photon cross sections= Photon cross-section data. Current options are " si (Storm-Israel), epdl (Evaluated Photon Data -" Library), xcom (the default), pegs4, mcdf-xcom and +" Library), xcom (default), pegs4, mcdf-xcom and " mcdf-epdl: " Allows the use of photon cross-sections other than " from the PEGS4 file (unless the pegs4 option is @@ -1029,8 +1031,7 @@ subroutine get_transport_parameter(ounit); " photon_xsections_triplet.data, and " photon_xsections_rayleigh.data exist in the " $HEN_HOUSE/data directory, where photon_xsections -" is the name specified. -" Hence this entry is case-sensitive. +" is the name specified. This entry is case-sensitive. " [ photon_xsections ] " Photon cross-sections output= Off (default) or On. If On, then " a file $EGS_HOME/user_code/inputfile.xsections is @@ -1045,13 +1046,13 @@ subroutine get_transport_parameter(ounit); " (see below). The default file (ie in the absence " of any user-supplied data) is compton_sigma.data. " [ comp_xsections ] -" Rayleigh scattering= Off, On, custom -" If On, turn on coherent (Rayleigh) scattering. +" Rayleigh scattering= Off, On (default), custom +" If On, turns on coherent (Rayleigh) scattering. " Default is On. Should be turned on for low energy -" applications. -" If custom, user must provide media names and form -" factor files for each desired medium. For the rest -" of the media, default atomic FF are used. +" applications. If custom, user must provide media names +" and form factor files for each desired medium. The +" rest of the media use the default atomic form factors. +" A PEGS4 data set is not required anymore. " [ IRAYLR ] " ff media names = A list of media names (must match media found in " PEGS4 data file) for which the user is going to @@ -1081,22 +1082,20 @@ subroutine get_transport_parameter(ounit); " is set to 'default', the default file is " iaea_photonuc.data. " [ photonuc_xsections ] -" Photoelectron angular sampling= Off or On +" Photoelectron angular sampling= Off or On (default) " If Off, photo-electrons get the direction of the -" `mother' photon, with On, Sauter's furmula is -" used (which is, striktly speaking, valid only for +" `mother' photon, with On, Sauter's formula is +" used (which is, strictly speaking, valid only for " K-shell photo-absorption). " If the user has a better approach, replace the macro " $SELECT-PHOTOELECTRON-DIRECTION; -" The only application that -" I encountered until now where this option made a -" small difference was a big ion chamber (cavity size -" comparable with electron range) with high-Z walls -" in a low energy photon beam. -" Default is On +" The only application encountered where this option +" made a small difference was a big ion chamber +" (cavity size comparable with electron range) +" with high-Z walls in a low energy photon beam. " [ IPHTER ] -" Atomic relaxations= Off, On, eadl, simple -" Default is eadl. On defaults to eadl. +" Atomic relaxations= Off, On, eadl (default), simple +" On defaults to eadl. " When simulating atomic relaxations: " - In photo-electric absorption events, the element " (if material is mixture) and the shell the photon @@ -1106,27 +1105,26 @@ subroutine get_transport_parameter(ounit); " compton and electron impact ionization events " are relaxed via emission of fluorescent X-Rays, " Auger and Koster-Cronig electrons. -" The eadl option features a more accurate treatment -" of relaxation events and uses binding energies -" consistent with those in of the photon cross sections -" used in the simulation. If using mcdf-xcom or -" mcdf-epdl photon cross sections, you cannot use -" the simple option and this will automatically get -" reset to eadl. -" Make sure to use eadl or simple for low energy -" applications. -" [ IEDGFL ] +" The eadl option features a more accurate treatment +" of relaxation events and uses binding energies +" consistent with those in of the photon cross sections +" used in the simulation. If using mcdf-xcom or +" mcdf-epdl photon cross sections, you cannot use +" the simple option and this will automatically get +" reset to eadl. Make sure to use eadl or simple for +" low energy applications. +" [ IEDGFL ] " -" Atomic relaxations, Rayleigh scattering, -" Photoelectron angular sampling and Bound Compton scattering -" and photonuclear effect(Ali:photonuc) -" can also be turned On/Off on a region-by-region -" basis. To do so, put e.g. +" Atomic relaxations, Rayleigh scattering, Photoelectron angular sampling, +" Bound Compton scattering and photonuclear effect (Ali:photonuc) +" can also be turned On/Off on a region-by-region basis. An example for +" Atomic relaxations on a region-by-region basis is: " " Atomic relaxations= On in Regions or " Atomic relaxations= Off in regions " -" in your input file. Then use +" Then define the regions in which you want +" the feature to be turned on: " " Bound Compton start region= " Bound Compton stop region= @@ -1143,16 +1141,18 @@ subroutine get_transport_parameter(ounit); " Photonuclear start region= " Photonuclear stop region= " -" each followed by a lost of of one or more +" each followed by a list of one or more " start and stop regions separated by commas. " Example: +" " Atomic relaxations= On in Regions " Relaxations start region= 1, 40 " Relaxations stop region= 10, 99 +" " will first turn off relaxations everywhere and " then turn on in regions 1-10 and 40-99. -" Note that input is checked against min. and max. -" region number and ignored if +" Note that the input is checked against minimum +" and maximum region numbers and ignored if " start region < 1 or stop_region > $MXREG or " start region > stop region. " diff --git a/HEN_HOUSE/src/get_media_inputs.mortran b/HEN_HOUSE/src/get_media_inputs.mortran index 477f8d433..8a6631e27 100644 --- a/HEN_HOUSE/src/get_media_inputs.mortran +++ b/HEN_HOUSE/src/get_media_inputs.mortran @@ -24,6 +24,7 @@ " Authors: Blake Walters, 2013 " " " " Contributors: Reid Townson " +" Frederic Tessier " " " "#############################################################################" @@ -913,7 +914,7 @@ DO i=1,NMED[ sterncid_tmp=medium_name; gasp_tmp=0.0; iunrst_tmp=0; - iaprim_tmp=0; + iaprim_tmp=1; epstfl_tmp=0; density_file=' '; diff --git a/HEN_HOUSE/src/pegs4_routines.mortran b/HEN_HOUSE/src/pegs4_routines.mortran index 7cec059e0..f160d0367 100644 --- a/HEN_HOUSE/src/pegs4_routines.mortran +++ b/HEN_HOUSE/src/pegs4_routines.mortran @@ -23,7 +23,7 @@ " " " Authors: Blake Walters, 2013 " " " -" Contributors: " +" Contributors: Frederic Tessier " " " "#############################################################################" " " @@ -654,8 +654,8 @@ $REAL4 FUNCTION APRIM(Z,E); " EMPIRICAL CORRECTION FACTOR TO BREMS CROSS SECTION " " This version can be switched to use different values: " -" IAPRIM = 0 equivalent to old PEGS4 (default) " -" 1 reads in values from unit 22 " +" IAPRIM = 0 equivalent to old PEGS4 " +" 1 reads in values from unit 22 (default) " " 2 sets APRIM to 1.0 " " Future changes can be accommodated by reading in " " different data on unit 22 and if necessary changing the array sizes: " diff --git a/HEN_HOUSE/user_codes/cavrznrc/cavrznrc.mortran b/HEN_HOUSE/user_codes/cavrznrc/cavrznrc.mortran index c94d43ca5..a0bc1a458 100644 --- a/HEN_HOUSE/user_codes/cavrznrc/cavrznrc.mortran +++ b/HEN_HOUSE/user_codes/cavrznrc/cavrznrc.mortran @@ -31,6 +31,7 @@ " Leslie Buckley " " Blake Walters " " Reid Townson " +" Frederic Tessier " " " "#############################################################################" " " @@ -890,7 +891,7 @@ REPLACE {$MXMDSH} WITH {200} " All input associated with selection of various transport parameter " is not crucial for the execution as there are default values set. " Therefore, if some of the input options in this section are -" missing/misspelled, this will be ignored and defualt parameter assumed +" missing/misspelled, this will be ignored and default parameter assumed " As the transport parameter input routine uses get_inputs, a lot " of error/warning messages may be produced on UNIT 15, though. " If you don't have the intention of changing default settings, @@ -907,37 +908,37 @@ REPLACE {$MXMDSH} WITH {200} " " in your input file. " -" Currently, the following options are available (except for a few entries, -" case does not matter): +" Currently, the following options are available (case does not matter and +" the internal variables are shown in [ ] brackets): " -" Global ECUT= Set a global (in all regions) electron transport -" cut off energy (in MeV). If this imput is missing, +" Global ECUT= Global (in all regions) electron transport cut +" off energy (in MeV). If this input is missing, " AE(medium) will be used. " [ ECUT ] -" Global PCUT= Set a global (in all regions) photon transport -" cut off energy (in MeV). If this imput is missing, +" Global PCUT= Global (in all regions) photon transport cut +" off energy (in MeV). If this input is missing, " AP(medium) will be used. " [ PCUT ] -" Global SMAX= Set a global (in all regions) maximum step-size +" Global SMAX= Global (in all regions) maximum step-size " restriction for electron transport (in cm). -" If missing, no geometrical step-size restrictions will -" be employed. Note that if you use the default +" If missing, no geometrical step-size restrictions +" will be employed. Note that if you use the default " EGSnrc electron-step algorithm, no SMAX-restriction " is necessary. Option is useful for transport in low " density materials (air) when PRESTA behaviour is " turned on (see below) " [ SMAXIR ] -" ESTEPE= Set the maximum fractional energy loss per step. +" ESTEPE= Maximum fractional energy loss per step. " Note that this is a global option only, no " region-by-region setting is possible. If missing, -" the defualt is 0.25 (25%) +" the default is 0.25 (25%). " [ ESTEPE ] " XImax= Maximum first elastic scattering moment per step. " Default is 0.5, NEVER use value greater than 1 as " this is beyond the range of MS data available. " [ XIMAX ] -" Boundary crossing algorithm= -" There are two selections possible: EXACT, means +" Boundary crossing algorithm= EXACT (default), PRESTA-I +" There are two selections possible: EXACT means " the algorithm will cross boundaries in a single " scattering (SS) mode, the distance from a boundary " at which the transition to SS mode is made is @@ -951,52 +952,84 @@ REPLACE {$MXMDSH} WITH {200} " Determines the distance from a boundary (in elastic " MFP) at which the algorithm will go into single " scattering mode (if EXACT boundary crossing) or -" swith off lateral correlations (if PRESTA-I boundary +" switch off lateral correlations (if PRESTA-I boundary " crossing). Default value is 3 for EXACT or " exp(BLCMIN)/BLCMIN for PRESTA-I (see the PRESTA paper " for a definition of BLCMIN). Note that if you choose " EXACT boundary crossing and set Skin depth for BCA " to a very large number (e.g. 1e10), the entire -" calculation will be in SS mode. If you choose -" PRESTA-I boundary crossing and make Skin depth for BCA -" large, you will get default EGS4 behavious (no PRESTA) +" calculation will be in single-scattering mode. If you +" choose PRESTA-I boundary crossing and make Skin depth +" for BCA large, you will get default EGS4 behaviour +" (no PRESTA). " [ skindepth_for_bca ] -" Electron-step algorithm= -" PRESTA-II (the default), the name is -" used for historical reasons -" or PRESTA-I +" Electron-step algorithm= PRESTA-II (default), PRESTA-I (legacy) " Determines the algorithm used to take into account " lateral and longitudinal correlations in a " condensed history step. " [ transport_algorithm ] -" Spin effects= Off, On, default is On +" Spin effects= Off, On (default) " Turns off/on spin effects for electron elastic " scattering. Spin On is ABSOLUTELY necessary for " good backscattering calculations. Will make a -" even in `well conditioned' situations (e.g. depth -" dose curves for RTP energy range electrons). +" difference even in `well conditioned' situations +" (e.g. depth dose curves for RTP energy range +" electrons). " [ spin_effects ] -" Brems angular sampling= Simple, KM, default is KM +" Brems angular sampling= Simple, KM (default) " If Simple, use only the leading term of the Koch-Motz " distribution to determine the emission angle of -" bremsstrahlung photons. If On, complete +" bremsstrahlung photons. If KM, complete " modified Koch-Motz 2BS is used (modifications " concern proper handling of kinematics at low energies, " makes 2BS almost the same as 2BN at low energies). " [ IBRDST ] -" Brems cross sections= BH, NIST, default is BH +" Brems cross sections= BH (default), NIST, NRC " If BH is selected, the Bethe-Heitler bremsstrahlung " cross sections (Coulomb corrected above 50 MeV) " will be used. If NIST is selected, the NIST brems " cross section data base (which is the basis for " the ICRU radiative stopping powers) will be employed. " Differences are negligible for E > ,say, 10 MeV, -" but signifficant in the keV energy range. +" but significant in the keV energy range. If NRC is +" selected, the NRC brems cross-section data base will +" be used, which is a version of the NIST data base +" with corrected electron-electron brems contributions +" (corrections to the NIST data is typically only +" significant for low values of the atomic number Z +" and for k/T < 0.005). +" [ ibr_nist ] +" Triplet production= On or Off (default). Turns on/off simulation +" of triplet production. If On, then Borsellino's +" first Born approximation is used to sample triplet +" events based on the triplet cross-section data. +" [ itriplet ] +" Bound Compton scattering= On, Off, Simple or norej (default) +" If Off, Compton scattering will be treated with +" Klein-Nishina, with On Compton scattering is +" treated in the Impulse approximation. +" With Simple, the impulse approximation incoherent +" scattering function will be used (i.e., no Doppler +" broadenning). With norej the actual total bound +" Compton cross section is used and there are no +" rejections at run time. +" Make sure to turn on for low energy applications, +" not necessary above, say, 1 MeV. +" [ IBCMP ] +" Radiative Compton corrections= On or Off (default). If On, then +" include radiative corrections for Compton scattering. +" Equations are based on original Brown & Feynman +" equations (Phys. Rev. 85, p 231--1952). Requires +" a change to the user codes Makefile to include +" $(EGS_SOURCEDIR)rad_compton1.mortran in the +" SOURCES (just before +" $(EGS_SOURCEDIR)get_inputs.mortran). +" [ radc_flag ] " Electron Impact Ionization= Off (default), On, casnati, kolbenstvedt, " gryzinski or penelope. If set to On or ik, then " use Kawrakow's theory to derive EII cross-sections. " If set to casnati, then use the cross-sections of -" Casnati (from file ($HEN_HOUSE/data/eii_casnati.data). +" Casnati (from file $HEN_HOUSE/data/eii_casnati.data). " Similar for kolbenstvedt, gryzinski and penelope. " This is only of interest in kV X-ray calculations. " Note that the user can supply their own EII @@ -1004,20 +1037,8 @@ REPLACE {$MXMDSH} WITH {200} " the file eii_suffix.data exists in the $HEN_HOUSE/data " directory, where suffix is the name specified. " Entry is case-sensitive except for Off, On or ik. -" [ eii_flag ] -" Bound Compton scattering= On, Off, Simple or norej -" If Off, Compton scattering will be treated with -" Klein-Nishina, with On Compton scattering is -" treated in the Impuls approximation. Default is On. -" With Simple, the impulse approximation incoherent -" scattering function will be used (i.e., no Doppler -" broadenning). With norej the actual total bound -" Compton cross section is used and there are no -" rejections at run time. -" Make sure to turn on for low energy applications, -" not necessary above, say, 1 MeV. -" [ IBCMP ] -" Pair angular sampling= Off, Simple or KM +" [ eii_flag, eii_xfile ] +" Pair angular sampling= Off, Simple (default), KM. " If off, pairs are set in motion at an angle m/E " relative to the photon direction (m is electron rest " energy, E the photon energy). Simple turns on @@ -1025,22 +1046,28 @@ REPLACE {$MXMDSH} WITH {200} " (this is sufficient for most applications), " KM (comes from Koch and Motz) turns on using 2BS " from the article by Koch and Motz. -" Default is Simple, make sure you always use Simple or -" KM +" Default is Simple, make sure you always use +" Simple or KM " [ IPRDST ] " Pair cross sections= BH (default) or NRC. If set to BH, then use " Bethe-Heitler pair production cross-sections. If set " to NRC, then use NRC pair production cross-sections " (in file $HEN_HOUSE/data/pair_nrc1.data). Only " of interest at low energies, where the NRC cross- -" sections take into account the assymmetry in the +" sections take into account the asymmetry in the " positron-electron energy distribution. " [ pair_nrc ] " Photon cross sections= Photon cross-section data. Current options are -" si (Storm-Israel--the default), epdl (Evaluated Photon -" Data Library), xcom and pegs4. Allows the use of -" photon cross-sections other than from the PEGS4 file -" unless the pegs4 option is specified. +" si (Storm-Israel), epdl (Evaluated Photon Data +" Library), xcom (default), pegs4, mcdf-xcom and +" mcdf-epdl: +" Allows the use of photon cross-sections other than +" from the PEGS4 file (unless the pegs4 option is +" specified). Options mcdf-xcom and mcdf-epdl use +" Sabbatucci and Salvat's renormalized photoelectric +" cross sections with either xcom or epdl for all other +" cross sections. These are more accurate but can +" increase CPU time by up to 6 %. " Note that the user can supply their own cross-section " data as well. The requirement is that the files " photon_xsections_photo.data, @@ -1048,8 +1075,7 @@ REPLACE {$MXMDSH} WITH {200} " photon_xsections_triplet.data, and " photon_xsections_rayleigh.data exist in the " $HEN_HOUSE/data directory, where photon_xsections -" is the name specified. -" Hence this entry is case-sensitive. +" is the name specified. This entry is case-sensitive. " [ photon_xsections ] " Photon cross-sections output= Off (default) or On. If On, then " a file $EGS_HOME/user_code/inputfile.xsections is @@ -1064,26 +1090,13 @@ REPLACE {$MXMDSH} WITH {200} " (see below). The default file (ie in the absence " of any user-supplied data) is compton_sigma.data. " [ comp_xsections ] -" Photoelectron angular sampling= Off or On -" If Off, photo-electrons get the direction of the -" `mother' photon, with On, Sauter's furmula is -" used (which is, striktly speaking, valid only for -" K-shell photo-absorption). -" If the user has a better approach, replace the macro -" $SELECT-PHOTOELECTRON-DIRECTION; -" The only application that -" I encountered until now where this option made a -" small difference was a big ion chamber (cavity size -" comparable with electron range) with high-Z walls -" in a low energy photon beam. -" Default is On -" [ IPHTER ] -" Rayleigh scattering= Off, On, custom -" If On, turn on coherent (Rayleigh) scattering, -" even if no Rayleigh data in PEGS4 file. -" Default is Off. Should be turned on for low energy +" Rayleigh scattering= Off, On (default), custom +" If On, turns on coherent (Rayleigh) scattering. +" Default is On. Should be turned on for low energy " applications. If custom, user must provide media names -" and form factor files for each medium. +" and form factor files for each desired medium. The +" rest of the media use the default atomic form factors. +" A PEGS4 data set is not required anymore. " [ IRAYLR ] " ff media names = A list of media names (must match media found in " PEGS4 data file) for which the user is going to @@ -1098,28 +1111,63 @@ REPLACE {$MXMDSH} WITH {200} " example files, see the directory " $HEN_HOUSE/data/molecular_form_factors. " [ iray_ff_file($MXMED) ] -" Atomic relaxations= Off, On -" Default is On. The effect of using On is twofold: +" Photonuclear attenuation= Off (default) or On +" If On, models the photonuclear effect. Current +" implementation is crude. Available on a +" region-by-region basis (see below) +" [ IPHOTONUCR ] +" Photonuclear cross sections= Total photonuclear cross sections. User- +" supplied total photonuclear cross-sections in +" $HEN_HOUSE/data/photonuc_xsections_photonuc.data, +" where photonuc_xsections is the name supplied for +" this input (case sensitive). In the absence of +" any user-supplied data, or if photonuc_xsections +" is set to 'default', the default file is +" iaea_photonuc.data. +" [ photonuc_xsections ] +" Photoelectron angular sampling= Off or On (default) +" If Off, photo-electrons get the direction of the +" `mother' photon, with On, Sauter's formula is +" used (which is, strictly speaking, valid only for +" K-shell photo-absorption). +" If the user has a better approach, replace the macro +" $SELECT-PHOTOELECTRON-DIRECTION; +" The only application encountered where this option +" made a small difference was a big ion chamber +" (cavity size comparable with electron range) +" with high-Z walls in a low energy photon beam. +" [ IPHTER ] +" Atomic relaxations= Off, On, eadl (default), simple +" On defaults to eadl. +" When simulating atomic relaxations: " - In photo-electric absorption events, the element " (if material is mixture) and the shell the photon " is interacting with are sampled from the appropriate -" cross seections -" - Shell vacancies created in photo-absorption events +" cross sections +" - Shell vacancies created in photoelectric, +" compton and electron impact ionization events " are relaxed via emission of fluorescent X-Rays, " Auger and Koster-Cronig electrons. -" Make sure to turn this option on for low energy -" applications. -" [ IEDGFL ] -" -" Atomic relaxations, Rayleigh scattering, -" Photoelectron angular sampling and Bound Compton scattering -" can also be turned On/Off on a region-by-region -" basis. To do so, put e.g. +" The eadl option features a more accurate treatment +" of relaxation events and uses binding energies +" consistent with those in of the photon cross sections +" used in the simulation. If using mcdf-xcom or +" mcdf-epdl photon cross sections, you cannot use +" the simple option and this will automatically get +" reset to eadl. Make sure to use eadl or simple for +" low energy applications. +" [ IEDGFL ] +" +" Atomic relaxations, Rayleigh scattering, Photoelectron angular sampling, +" Bound Compton scattering and photonuclear effect +" can also be turned On/Off on a region-by-region basis. An example for +" Atomic relaxations on a region-by-region basis is: " " Atomic relaxations= On in Regions or " Atomic relaxations= Off in regions " -" in your input file. Then use +" Then define the regions in which you want +" the feature to be turned on: " " Bound Compton start region= " Bound Compton stop region= @@ -1132,17 +1180,22 @@ REPLACE {$MXMDSH} WITH {200} " or " PE sampling start region= " PE sampling stop region= +" or +" Photonuclear start region= +" Photonuclear stop region= " -" each followed by a lost of of one or more +" each followed by a list of one or more " start and stop regions separated by commas. " Example: +" " Atomic relaxations= On in Regions " Relaxations start region= 1, 40 " Relaxations stop region= 10, 99 +" " will first turn off relaxations everywhere and -" then turn off in regions 1-10 and 40-99. -" Note that input is checked against min. and max. -" region number and ignored if +" then turn on in regions 1-10 and 40-99. +" Note that the input is checked against minimum +" and maximum region numbers and ignored if " start region < 1 or stop_region > $MXREG or " start region > stop region. " diff --git a/HEN_HOUSE/user_codes/cavsphnrc/cavsphnrc.mortran b/HEN_HOUSE/user_codes/cavsphnrc/cavsphnrc.mortran index bf6eb7c5c..57d1d3ab3 100644 --- a/HEN_HOUSE/user_codes/cavsphnrc/cavsphnrc.mortran +++ b/HEN_HOUSE/user_codes/cavsphnrc/cavsphnrc.mortran @@ -381,37 +381,37 @@ REPLACE {$MXMDSH} WITH {200}; " " in your input file. " -" Currently, the following options are available (except for a few entries, -" case does not matter): +" Currently, the following options are available (case does not matter and +" the internal variables are shown in [ ] brackets): " -" Global ECUT= Set a global (in all regions) electron transport -" cut off energy (in MeV). If this imput is missing, +" Global ECUT= Global (in all regions) electron transport cut +" off energy (in MeV). If this input is missing, " AE(medium) will be used. " [ ECUT ] -" Global PCUT= Set a global (in all regions) photon transport -" cut off energy (in MeV). If this imput is missing, +" Global PCUT= Global (in all regions) photon transport cut +" off energy (in MeV). If this input is missing, " AP(medium) will be used. " [ PCUT ] -" Global SMAX= Set a global (in all regions) maximum step-size +" Global SMAX= Global (in all regions) maximum step-size " restriction for electron transport (in cm). -" If missing, no geometrical step-size restrictions will -" be employed. Note that if you use the default +" If missing, no geometrical step-size restrictions +" will be employed. Note that if you use the default " EGSnrc electron-step algorithm, no SMAX-restriction " is necessary. Option is useful for transport in low " density materials (air) when PRESTA behaviour is " turned on (see below) " [ SMAXIR ] -" ESTEPE= Set the maximum fractional energy loss per step. +" ESTEPE= Maximum fractional energy loss per step. " Note that this is a global option only, no " region-by-region setting is possible. If missing, -" the defualt is 0.25 (25%) +" the default is 0.25 (25%). " [ ESTEPE ] " XImax= Maximum first elastic scattering moment per step. " Default is 0.5, NEVER use value greater than 1 as " this is beyond the range of MS data available. " [ XIMAX ] -" Boundary crossing algorithm= -" There are two selections possible: EXACT, means +" Boundary crossing algorithm= EXACT (default), PRESTA-I +" There are two selections possible: EXACT means " the algorithm will cross boundaries in a single " scattering (SS) mode, the distance from a boundary " at which the transition to SS mode is made is @@ -425,64 +425,62 @@ REPLACE {$MXMDSH} WITH {200}; " Determines the distance from a boundary (in elastic " MFP) at which the algorithm will go into single " scattering mode (if EXACT boundary crossing) or -" swith off lateral correlations (if PRESTA-I boundary +" switch off lateral correlations (if PRESTA-I boundary " crossing). Default value is 3 for EXACT or " exp(BLCMIN)/BLCMIN for PRESTA-I (see the PRESTA paper " for a definition of BLCMIN). Note that if you choose " EXACT boundary crossing and set Skin depth for BCA " to a very large number (e.g. 1e10), the entire -" calculation will be in SS mode. If you choose -" PRESTA-I boundary crossing and make Skin depth for BCA -" large, you will get default EGS4 behavious (no PRESTA) +" calculation will be in single-scattering mode. If you +" choose PRESTA-I boundary crossing and make Skin depth +" for BCA large, you will get default EGS4 behaviour +" (no PRESTA). " [ skindepth_for_bca ] -" Electron-step algorithm= -" PRESTA-II (the default), the name is -" used for historical reasons -" or PRESTA-I +" Electron-step algorithm= PRESTA-II (default), PRESTA-I (legacy) " Determines the algorithm used to take into account " lateral and longitudinal correlations in a " condensed history step. " [ transport_algorithm ] -" Spin effects= Off, On, default is On +" Spin effects= Off, On (default) " Turns off/on spin effects for electron elastic " scattering. Spin On is ABSOLUTELY necessary for " good backscattering calculations. Will make a -" even in `well conditioned' situations (e.g. depth -" dose curves for RTP energy range electrons). +" difference even in `well conditioned' situations +" (e.g. depth dose curves for RTP energy range +" electrons). " [ spin_effects ] -" Brems angular sampling= Simple, KM, default is KM +" Brems angular sampling= Simple, KM (default) " If Simple, use only the leading term of the Koch-Motz " distribution to determine the emission angle of -" bremsstrahlung photons. If On, complete +" bremsstrahlung photons. If KM, complete " modified Koch-Motz 2BS is used (modifications " concern proper handling of kinematics at low energies, " makes 2BS almost the same as 2BN at low energies). " [ IBRDST ] -" Brems cross sections= BH, NIST, default is BH +" Brems cross sections= BH (default), NIST, NRC " If BH is selected, the Bethe-Heitler bremsstrahlung " cross sections (Coulomb corrected above 50 MeV) " will be used. If NIST is selected, the NIST brems " cross section data base (which is the basis for " the ICRU radiative stopping powers) will be employed. " Differences are negligible for E > ,say, 10 MeV, -" but signifficant in the keV energy range. -" Electron Impact Ionization= Off (default), On, casnati, kolbenstvedt, -" gryzinski or penelope. If set to On or ik, then -" use Kawrakow's theory to derive EII cross-sections. -" If set to casnati, then use the cross-sections of -" Casnati (from file ($HEN_HOUSE/data/eii_casnati.data). -" Similar for kolbenstvedt, gryzinski and penelope. -" This is only of interest in kV X-ray calculations. -" Note that the user can supply their own EII -" cross-section data as well. The requirement is that -" the file eii_suffix.data exists in the $HEN_HOUSE/data -" directory, where suffix is the name specified. -" Entry case-sensitive except for Off, On or ik. -" [ eii_flag ] -" Bound Compton scattering= On, Off, Simple or norej +" but significant in the keV energy range. If NRC is +" selected, the NRC brems cross-section data base will +" be used, which is a version of the NIST data base +" with corrected electron-electron brems contributions +" (corrections to the NIST data is typically only +" significant for low values of the atomic number Z +" and for k/T < 0.005). +" [ ibr_nist ] +" Triplet production= On or Off (default). Turns on/off simulation +" of triplet production. If On, then Borsellino's +" first Born approximation is used to sample triplet +" events based on the triplet cross-section data. +" [ itriplet ] +" Bound Compton scattering= On, Off, Simple or norej (default) " If Off, Compton scattering will be treated with " Klein-Nishina, with On Compton scattering is -" treated in the Impuls approximation. Default is On. +" treated in the Impulse approximation. " With Simple, the impulse approximation incoherent " scattering function will be used (i.e., no Doppler " broadenning). With norej the actual total bound @@ -491,7 +489,29 @@ REPLACE {$MXMDSH} WITH {200}; " Make sure to turn on for low energy applications, " not necessary above, say, 1 MeV. " [ IBCMP ] -" Pair angular sampling= Off, Simple or KM +" Radiative Compton corrections= On or Off (default). If On, then +" include radiative corrections for Compton scattering. +" Equations are based on original Brown & Feynman +" equations (Phys. Rev. 85, p 231--1952). Requires +" a change to the user codes Makefile to include +" $(EGS_SOURCEDIR)rad_compton1.mortran in the +" SOURCES (just before +" $(EGS_SOURCEDIR)get_inputs.mortran). +" [ radc_flag ] +" Electron Impact Ionization= Off (default), On, casnati, kolbenstvedt, +" gryzinski or penelope. If set to On or ik, then +" use Kawrakow's theory to derive EII cross-sections. +" If set to casnati, then use the cross-sections of +" Casnati (from file $HEN_HOUSE/data/eii_casnati.data). +" Similar for kolbenstvedt, gryzinski and penelope. +" This is only of interest in kV X-ray calculations. +" Note that the user can supply their own EII +" cross-section data as well. The requirement is that +" the file eii_suffix.data exists in the $HEN_HOUSE/data +" directory, where suffix is the name specified. +" Entry is case-sensitive except for Off, On or ik. +" [ eii_flag, eii_xfile ] +" Pair angular sampling= Off, Simple (default), KM. " If off, pairs are set in motion at an angle m/E " relative to the photon direction (m is electron rest " energy, E the photon energy). Simple turns on @@ -499,22 +519,28 @@ REPLACE {$MXMDSH} WITH {200}; " (this is sufficient for most applications), " KM (comes from Koch and Motz) turns on using 2BS " from the article by Koch and Motz. -" Default is Simple, make sure you always use Simple or -" KM +" Default is Simple, make sure you always use +" Simple or KM " [ IPRDST ] " Pair cross sections= BH (default) or NRC. If set to BH, then use " Bethe-Heitler pair production cross-sections. If set " to NRC, then use NRC pair production cross-sections " (in file $HEN_HOUSE/data/pair_nrc1.data). Only " of interest at low energies, where the NRC cross- -" sections take into account the assymmetry in the +" sections take into account the asymmetry in the " positron-electron energy distribution. " [ pair_nrc ] " Photon cross sections= Photon cross-section data. Current options are -" si (Storm-Israel--the default), epdl (Evaluated Photon -" Data Library), xcom and pegs4. Allows the use of -" photon cross-sections other than from the PEGS4 file -" unless the pegs4 option is specified. +" si (Storm-Israel), epdl (Evaluated Photon Data +" Library), xcom (default), pegs4, mcdf-xcom and +" mcdf-epdl: +" Allows the use of photon cross-sections other than +" from the PEGS4 file (unless the pegs4 option is +" specified). Options mcdf-xcom and mcdf-epdl use +" Sabbatucci and Salvat's renormalized photoelectric +" cross sections with either xcom or epdl for all other +" cross sections. These are more accurate but can +" increase CPU time by up to 6 %. " Note that the user can supply their own cross-section " data as well. The requirement is that the files " photon_xsections_photo.data, @@ -522,8 +548,7 @@ REPLACE {$MXMDSH} WITH {200}; " photon_xsections_triplet.data, and " photon_xsections_rayleigh.data exist in the " $HEN_HOUSE/data directory, where photon_xsections -" is the name specified. -" Hence this entry is case-sensitive. +" is the name specified. This entry is case-sensitive. " [ photon_xsections ] " Photon cross-sections output= Off (default) or On. If On, then " a file $EGS_HOME/user_code/inputfile.xsections is @@ -538,26 +563,13 @@ REPLACE {$MXMDSH} WITH {200}; " (see below). The default file (ie in the absence " of any user-supplied data) is compton_sigma.data. " [ comp_xsections ] -" Photoelectron angular sampling= Off or On -" If Off, photo-electrons get the direction of the -" `mother' photon, with On, Sauter's furmula is -" used (which is, striktly speaking, valid only for -" K-shell photo-absorption). -" If the user has a better approach, replace the macro -" $SELECT-PHOTOELECTRON-DIRECTION; -" The only application that -" I encountered until now where this option made a -" small difference was a big ion chamber (cavity size -" comparable with electron range) with high-Z walls -" in a low energy photon beam. -" Default is On -" [ IPHTER ] -" Rayleigh scattering= Off, On, custom -" If On, turn on coherent (Rayleigh) scattering, -" even if no Rayleigh data in PEGS4 file. -" Default is Off. Should be turned on for low energy +" Rayleigh scattering= Off, On (default), custom +" If On, turns on coherent (Rayleigh) scattering. +" Default is On. Should be turned on for low energy " applications. If custom, user must provide media names -" and form factor files for each medium. +" and form factor files for each desired medium. The +" rest of the media use the default atomic form factors. +" A PEGS4 data set is not required anymore. " [ IRAYLR ] " ff media names = A list of media names (must match media found in " PEGS4 data file) for which the user is going to @@ -572,28 +584,63 @@ REPLACE {$MXMDSH} WITH {200}; " example files, see the directory " $HEN_HOUSE/data/molecular_form_factors. " [ iray_ff_file($MXMED) ] -" Atomic relaxations= Off, On -" Default is On. The effect of using On is twofold: +" Photonuclear attenuation= Off (default) or On +" If On, models the photonuclear effect. Current +" implementation is crude. Available on a +" region-by-region basis (see below) +" [ IPHOTONUCR ] +" Photonuclear cross sections= Total photonuclear cross sections. User- +" supplied total photonuclear cross-sections in +" $HEN_HOUSE/data/photonuc_xsections_photonuc.data, +" where photonuc_xsections is the name supplied for +" this input (case sensitive). In the absence of +" any user-supplied data, or if photonuc_xsections +" is set to 'default', the default file is +" iaea_photonuc.data. +" [ photonuc_xsections ] +" Photoelectron angular sampling= Off or On (default) +" If Off, photo-electrons get the direction of the +" `mother' photon, with On, Sauter's formula is +" used (which is, strictly speaking, valid only for +" K-shell photo-absorption). +" If the user has a better approach, replace the macro +" $SELECT-PHOTOELECTRON-DIRECTION; +" The only application encountered where this option +" made a small difference was a big ion chamber +" (cavity size comparable with electron range) +" with high-Z walls in a low energy photon beam. +" [ IPHTER ] +" Atomic relaxations= Off, On, eadl (default), simple +" On defaults to eadl. +" When simulating atomic relaxations: " - In photo-electric absorption events, the element " (if material is mixture) and the shell the photon " is interacting with are sampled from the appropriate -" cross seections -" - Shell vacancies created in photo-absorption events +" cross sections +" - Shell vacancies created in photoelectric, +" compton and electron impact ionization events " are relaxed via emission of fluorescent X-Rays, " Auger and Koster-Cronig electrons. -" Make sure to turn this option on for low energy -" applications. -" [ IEDGFL ] -" -" Atomic relaxations, Rayleigh scattering, -" Photoelectron angular sampling and Bound Compton scattering -" can also be turned On/Off on a region-by-region -" basis. To do so, put e.g. +" The eadl option features a more accurate treatment +" of relaxation events and uses binding energies +" consistent with those in of the photon cross sections +" used in the simulation. If using mcdf-xcom or +" mcdf-epdl photon cross sections, you cannot use +" the simple option and this will automatically get +" reset to eadl. Make sure to use eadl or simple for +" low energy applications. +" [ IEDGFL ] +" +" Atomic relaxations, Rayleigh scattering, Photoelectron angular sampling, +" Bound Compton scattering and photonuclear effect +" can also be turned On/Off on a region-by-region basis. An example for +" Atomic relaxations on a region-by-region basis is: " " Atomic relaxations= On in Regions or " Atomic relaxations= Off in regions " -" in your input file. Then use +" Then define the regions in which you want +" the feature to be turned on: " " Bound Compton start region= " Bound Compton stop region= @@ -606,17 +653,22 @@ REPLACE {$MXMDSH} WITH {200}; " or " PE sampling start region= " PE sampling stop region= +" or +" Photonuclear start region= +" Photonuclear stop region= " -" each followed by a lost of of one or more +" each followed by a list of one or more " start and stop regions separated by commas. " Example: +" " Atomic relaxations= On in Regions " Relaxations start region= 1, 40 " Relaxations stop region= 10, 99 +" " will first turn off relaxations everywhere and -" then turn off in regions 1-10 and 40-99. -" Note that input is checked against min. and max. -" region number and ignored if +" then turn on in regions 1-10 and 40-99. +" Note that the input is checked against minimum +" and maximum region numbers and ignored if " start region < 1 or stop_region > $MXREG or " start region > stop region. " diff --git a/HEN_HOUSE/user_codes/dosrznrc/dosrznrc.mortran b/HEN_HOUSE/user_codes/dosrznrc/dosrznrc.mortran index 7c602596b..2a20aa15b 100644 --- a/HEN_HOUSE/user_codes/dosrznrc/dosrznrc.mortran +++ b/HEN_HOUSE/user_codes/dosrznrc/dosrznrc.mortran @@ -34,6 +34,7 @@ " Blake Walters " " Ernesto Mainegra-Hing " " Reid Townson " +" Frederic Tessier " " " "#############################################################################" " " @@ -1055,7 +1056,7 @@ REPLACE {$VERSION} WITH { " All input associated with selection of various transport parameter " is not crucial for the execution as there are default values set. " Therefore, if some of the input options in this section are -" missing/misspelled, this will be ignored and defualt parameter assumed +" missing/misspelled, this will be ignored and default parameter assumed " As the transport parameter input routine uses get_inputs, a lot " of error/warning messages may be produced on UNIT 15, though. " If you don't have the intention of changing default settings, @@ -1066,37 +1067,37 @@ REPLACE {$VERSION} WITH { " :start mc transport parameter: " :stop mc transport parameter: " -" Currently, the following options are available (except for a few entries, -" case does not matter): +" Currently, the following options are available (case does not matter and +" the internal variables are shown in [ ] brackets): " -" Global ECUT= Set a global (in all regions) electron transport -" cut off energy (in MeV). If this imput is missing, +" Global ECUT= Global (in all regions) electron transport cut +" off energy (in MeV). If this input is missing, " AE(medium) will be used. " [ ECUT ] -" Global PCUT= Set a global (in all regions) photon transport -" cut off energy (in MeV). If this imput is missing, +" Global PCUT= Global (in all regions) photon transport cut +" off energy (in MeV). If this input is missing, " AP(medium) will be used. " [ PCUT ] -" Global SMAX= Set a global (in all regions) maximum step-size +" Global SMAX= Global (in all regions) maximum step-size " restriction for electron transport (in cm). -" If missing, no geometrical step-size restrictions will -" be employed. Note that if you use the default +" If missing, no geometrical step-size restrictions +" will be employed. Note that if you use the default " EGSnrc electron-step algorithm, no SMAX-restriction " is necessary. Option is useful for transport in low " density materials (air) when PRESTA behaviour is " turned on (see below) " [ SMAXIR ] -" ESTEPE= Set the maximum fractional energy loss per step. +" ESTEPE= Maximum fractional energy loss per step. " Note that this is a global option only, no " region-by-region setting is possible. If missing, -" the defualt is 0.25 (25%) +" the default is 0.25 (25%). " [ ESTEPE ] " XImax= Maximum first elastic scattering moment per step. " Default is 0.5, NEVER use value greater than 1 as " this is beyond the range of MS data available. " [ XIMAX ] -" Boundary crossing algorithm= -" There are two selections possible: EXACT, means +" Boundary crossing algorithm= EXACT (default), PRESTA-I +" There are two selections possible: EXACT means " the algorithm will cross boundaries in a single " scattering (SS) mode, the distance from a boundary " at which the transition to SS mode is made is @@ -1110,52 +1111,84 @@ REPLACE {$VERSION} WITH { " Determines the distance from a boundary (in elastic " MFP) at which the algorithm will go into single " scattering mode (if EXACT boundary crossing) or -" swith off lateral correlations (if PRESTA-I boundary +" switch off lateral correlations (if PRESTA-I boundary " crossing). Default value is 3 for EXACT or " exp(BLCMIN)/BLCMIN for PRESTA-I (see the PRESTA paper " for a definition of BLCMIN). Note that if you choose " EXACT boundary crossing and set Skin depth for BCA " to a very large number (e.g. 1e10), the entire -" calculation will be in SS mode. If you choose -" PRESTA-I boundary crossing and make Skin depth for BCA -" large, you will get default EGS4 behavious (no PRESTA) +" calculation will be in single-scattering mode. If you +" choose PRESTA-I boundary crossing and make Skin depth +" for BCA large, you will get default EGS4 behaviour +" (no PRESTA). " [ skindepth_for_bca ] -" Electron-step algorithm= -" PRESTA-II (the default), the name is -" used for historical reasons -" or PRESTA-I +" Electron-step algorithm= PRESTA-II (default), PRESTA-I (legacy) " Determines the algorithm used to take into account " lateral and longitudinal correlations in a " condensed history step. " [ transport_algorithm ] -" Spin effects= Off, On, default is Off +" Spin effects= Off, On (default) " Turns off/on spin effects for electron elastic " scattering. Spin On is ABSOLUTELY necessary for " good backscattering calculations. Will make a -" even in `well conditioned' situations (e.g. depth -" dose curves for RTP energy range electrons). +" difference even in `well conditioned' situations +" (e.g. depth dose curves for RTP energy range +" electrons). " [ spin_effects ] -" Brems angular sampling= Simple, KM, default is KM +" Brems angular sampling= Simple, KM (default) " If Simple, use only the leading term of the Koch-Motz " distribution to determine the emission angle of -" bremsstrahlung photons. If On, complete +" bremsstrahlung photons. If KM, complete " modified Koch-Motz 2BS is used (modifications " concern proper handling of kinematics at low energies, " makes 2BS almost the same as 2BN at low energies). " [ IBRDST ] -" Brems cross sections= BH, NIST, default is BH +" Brems cross sections= BH (default), NIST, NRC " If BH is selected, the Bethe-Heitler bremsstrahlung " cross sections (Coulomb corrected above 50 MeV) " will be used. If NIST is selected, the NIST brems " cross section data base (which is the basis for " the ICRU radiative stopping powers) will be employed. " Differences are negligible for E > ,say, 10 MeV, -" but signifficant in the keV energy range. +" but significant in the keV energy range. If NRC is +" selected, the NRC brems cross-section data base will +" be used, which is a version of the NIST data base +" with corrected electron-electron brems contributions +" (corrections to the NIST data is typically only +" significant for low values of the atomic number Z +" and for k/T < 0.005). +" [ ibr_nist ] +" Triplet production= On or Off (default). Turns on/off simulation +" of triplet production. If On, then Borsellino's +" first Born approximation is used to sample triplet +" events based on the triplet cross-section data. +" [ itriplet ] +" Bound Compton scattering= On, Off, Simple or norej (default) +" If Off, Compton scattering will be treated with +" Klein-Nishina, with On Compton scattering is +" treated in the Impulse approximation. +" With Simple, the impulse approximation incoherent +" scattering function will be used (i.e., no Doppler +" broadenning). With norej the actual total bound +" Compton cross section is used and there are no +" rejections at run time. +" Make sure to turn on for low energy applications, +" not necessary above, say, 1 MeV. +" [ IBCMP ] +" Radiative Compton corrections= On or Off (default). If On, then +" include radiative corrections for Compton scattering. +" Equations are based on original Brown & Feynman +" equations (Phys. Rev. 85, p 231--1952). Requires +" a change to the user codes Makefile to include +" $(EGS_SOURCEDIR)rad_compton1.mortran in the +" SOURCES (just before +" $(EGS_SOURCEDIR)get_inputs.mortran). +" [ radc_flag ] " Electron Impact Ionization= Off (default), On, casnati, kolbenstvedt, " gryzinski or penelope. If set to On or ik, then " use Kawrakow's theory to derive EII cross-sections. " If set to casnati, then use the cross-sections of -" Casnati (from file ($HEN_HOUSE/data/eii_casnati.data). +" Casnati (from file $HEN_HOUSE/data/eii_casnati.data). " Similar for kolbenstvedt, gryzinski and penelope. " This is only of interest in kV X-ray calculations. " Note that the user can supply their own EII @@ -1163,20 +1196,8 @@ REPLACE {$VERSION} WITH { " the file eii_suffix.data exists in the $HEN_HOUSE/data " directory, where suffix is the name specified. " Entry is case-sensitive except for Off, On or ik. -" [ eii_flag ] -" Bound Compton scattering= On, Off, Simple or norej -" If Off, Compton scattering will be treated with -" Klein-Nishina, with On Compton scattering is -" treated in the Impuls approximation. Default is On. -" With Simple, the impulse approximation incoherent -" scattering function will be used (i.e., no Doppler -" broadenning). With norej the actual total bound -" Compton cross section is used and there are no -" rejections at run time. -" Make sure to turn on for low energy applications, -" not necessary above, say, 1 MeV. -" [ IBCMP ] -" Pair angular sampling= Off, Simple or KM +" [ eii_flag, eii_xfile ] +" Pair angular sampling= Off, Simple (default), KM. " If off, pairs are set in motion at an angle m/E " relative to the photon direction (m is electron rest " energy, E the photon energy). Simple turns on @@ -1184,22 +1205,28 @@ REPLACE {$VERSION} WITH { " (this is sufficient for most applications), " KM (comes from Koch and Motz) turns on using 2BS " from the article by Koch and Motz. -" Default is Simple, make sure you always use Simple or -" KM +" Default is Simple, make sure you always use +" Simple or KM " [ IPRDST ] " Pair cross sections= BH (default) or NRC. If set to BH, then use " Bethe-Heitler pair production cross-sections. If set " to NRC, then use NRC pair production cross-sections " (in file $HEN_HOUSE/data/pair_nrc1.data). Only " of interest at low energies, where the NRC cross- -" sections take into account the assymmetry in the +" sections take into account the asymmetry in the " positron-electron energy distribution. " [ pair_nrc ] " Photon cross sections= Photon cross-section data. Current options are -" si (Storm-Israel--the default), epdl (Evaluated Photon -" Data Library), xcom and pegs4. Allows the use of -" photon cross-sections other than from the PEGS4 file -" unless the pegs4 option is specified. +" si (Storm-Israel), epdl (Evaluated Photon Data +" Library), xcom (default), pegs4, mcdf-xcom and +" mcdf-epdl: +" Allows the use of photon cross-sections other than +" from the PEGS4 file (unless the pegs4 option is +" specified). Options mcdf-xcom and mcdf-epdl use +" Sabbatucci and Salvat's renormalized photoelectric +" cross sections with either xcom or epdl for all other +" cross sections. These are more accurate but can +" increase CPU time by up to 6 %. " Note that the user can supply their own cross-section " data as well. The requirement is that the files " photon_xsections_photo.data, @@ -1207,8 +1234,7 @@ REPLACE {$VERSION} WITH { " photon_xsections_triplet.data, and " photon_xsections_rayleigh.data exist in the " $HEN_HOUSE/data directory, where photon_xsections -" is the name specified. -" Hence this entry is case-sensitive. +" is the name specified. This entry is case-sensitive. " [ photon_xsections ] " Photon cross-sections output= Off (default) or On. If On, then " a file $EGS_HOME/user_code/inputfile.xsections is @@ -1223,26 +1249,13 @@ REPLACE {$VERSION} WITH { " (see below). The default file (ie in the absence " of any user-supplied data) is compton_sigma.data. " [ comp_xsections ] -" Photoelectron angular sampling= Off or On -" If Off, photo-electrons get the direction of the -" `mother' photon, with On, Sauter's furmula is -" used (which is, striktly speaking, valid only for -" K-shell photo-absorption). -" If the user has a better approach, replace the macro -" $SELECT-PHOTOELECTRON-DIRECTION; -" The only application that -" I encountered until now where this option made a -" small difference was a big ion chamber (cavity size -" comparable with electron range) with high-Z walls -" in a low energy photon beam. -" Default is Off -" [ IPHTER ] -" Rayleigh scattering= Off, On, custom -" If On, turn on coherent (Rayleigh) scattering, -" even if no Rayleigh data in PEGS4 file. -" Default is Off. Should be turned on for low energy +" Rayleigh scattering= Off, On (default), custom +" If On, turns on coherent (Rayleigh) scattering. +" Default is On. Should be turned on for low energy " applications. If custom, user must provide media names -" and form factor files for each medium. +" and form factor files for each desired medium. The +" rest of the media use the default atomic form factors. +" A PEGS4 data set is not required anymore. " [ IRAYLR ] " ff media names = A list of media names (must match media found in " PEGS4 data file) for which the user is going to @@ -1257,28 +1270,63 @@ REPLACE {$VERSION} WITH { " example files, see the directory " $HEN_HOUSE/data/molecular_form_factors. " [ iray_ff_file($MXMED) ] -" Atomic relaxations= Off, On -" Default is Off. The effect of using On is twofold: +" Photonuclear attenuation= Off (default) or On +" If On, models the photonuclear effect. Current +" implementation is crude. Available on a +" region-by-region basis (see below) +" [ IPHOTONUCR ] +" Photonuclear cross sections= Total photonuclear cross sections. User- +" supplied total photonuclear cross-sections in +" $HEN_HOUSE/data/photonuc_xsections_photonuc.data, +" where photonuc_xsections is the name supplied for +" this input (case sensitive). In the absence of +" any user-supplied data, or if photonuc_xsections +" is set to 'default', the default file is +" iaea_photonuc.data. +" [ photonuc_xsections ] +" Photoelectron angular sampling= Off or On (default) +" If Off, photo-electrons get the direction of the +" `mother' photon, with On, Sauter's formula is +" used (which is, strictly speaking, valid only for +" K-shell photo-absorption). +" If the user has a better approach, replace the macro +" $SELECT-PHOTOELECTRON-DIRECTION; +" The only application encountered where this option +" made a small difference was a big ion chamber +" (cavity size comparable with electron range) +" with high-Z walls in a low energy photon beam. +" [ IPHTER ] +" Atomic relaxations= Off, On, eadl (default), simple +" On defaults to eadl. +" When simulating atomic relaxations: " - In photo-electric absorption events, the element " (if material is mixture) and the shell the photon " is interacting with are sampled from the appropriate -" cross seections -" - Shell vacancies created in photo-absorption events +" cross sections +" - Shell vacancies created in photoelectric, +" compton and electron impact ionization events " are relaxed via emission of fluorescent X-Rays, " Auger and Koster-Cronig electrons. -" Make sure to turn this option on for low energy -" applications. -" [ IEDGFL ] -" -" Atomic relaxations, Rayleigh scattering, -" Photoelectron angular sampling and Bound Compton scattering -" can also be turned On/Off on a region-by-region -" basis. To do so, put e.g. +" The eadl option features a more accurate treatment +" of relaxation events and uses binding energies +" consistent with those in of the photon cross sections +" used in the simulation. If using mcdf-xcom or +" mcdf-epdl photon cross sections, you cannot use +" the simple option and this will automatically get +" reset to eadl. Make sure to use eadl or simple for +" low energy applications. +" [ IEDGFL ] +" +" Atomic relaxations, Rayleigh scattering, Photoelectron angular sampling, +" Bound Compton scattering and photonuclear effect +" can also be turned On/Off on a region-by-region basis. An example for +" Atomic relaxations on a region-by-region basis is: " " Atomic relaxations= On in Regions or " Atomic relaxations= Off in regions " -" in your input file. Then use +" Then define the regions in which you want +" the feature to be turned on: " " Bound Compton start region= " Bound Compton stop region= @@ -1291,17 +1339,22 @@ REPLACE {$VERSION} WITH { " or " PE sampling start region= " PE sampling stop region= +" or +" Photonuclear start region= +" Photonuclear stop region= " -" each followed by a lost of of one or more +" each followed by a list of one or more " start and stop regions separated by commas. " Example: +" " Atomic relaxations= On in Regions " Relaxations start region= 1, 40 " Relaxations stop region= 10, 99 +" " will first turn off relaxations everywhere and " then turn on in regions 1-10 and 40-99. -" Note that input is checked against min. and max. -" region number and ignored if +" Note that the input is checked against minimum +" and maximum region numbers and ignored if " start region < 1 or stop_region > $MXREG or " start region > stop region. " @@ -1726,7 +1779,7 @@ ELSE[ " input cs_enhance and iefl(irl) to increase the photon " interaction density in regions of interest (where iefl(irl) is set to 1) " cs_enhance means desired average number of interactions per -" g/cm**2. If cs_enhance*rho(medium) > 1/gmfp (1/gmfp is the the actual +" g/cm**2. If cs_enhance*rho(medium) > 1/gmfp (1/gmfp is the actual " number of interactions per unit length), cs_enhance*rho(medium) is " used to sample interaction distances in these regions. " Scattered and unscattered photon fractions are then killed via Russian diff --git a/HEN_HOUSE/user_codes/dosxyznrc/dosxyznrc.mortran b/HEN_HOUSE/user_codes/dosxyznrc/dosxyznrc.mortran index 18de166c9..0831da9ca 100644 --- a/HEN_HOUSE/user_codes/dosxyznrc/dosxyznrc.mortran +++ b/HEN_HOUSE/user_codes/dosxyznrc/dosxyznrc.mortran @@ -477,7 +477,7 @@ " All input associated with selection of EGSnrc transport parameter " is not crucial for the execution as there are default values set. " Therefore, if some of the input options in this section are -" missing/misspelled, this will be ignored and defualt parameter assumed +" missing/misspelled, this will be ignored and default parameter assumed " As the transport parameter input routine uses get_inputs, a lot " of error/warning messages may be produced on UNIT 15, though. " If you don't have the intention of changing default settings, @@ -489,19 +489,19 @@ " :stop mc transport parameter: " " Currently, the following options are available (case does not matter and -" the internal variables are shown in [ ] brackets): +" the internal variables are shown in [ ] brackets): " " Global ECUT= Global (in all regions) electron transport cut -" off energy (in MeV). If this imput is missing, +" off energy (in MeV). If this input is missing, " or is < ECUTIN from the main DOSXYZnrc inputs " (See above) then ECUTIN is used for global ECUT. -" ECUT defaults to AE(medium). +" If this input is missing, AE(medium) will be used. " [ ECUT ] " Global PCUT= Global (in all regions) photon transport cut -" off energy (in MeV). If this imput is missing, +" off energy (in MeV). If this input is missing, " or is < PCUTIN from the main DOSXYZnrc inputs " (See above) then PCUTIN is used for global PCUT. -" PCUT defaults to AP(medium). +" If this input is missing, AP(medium) will be used. " [ PCUT ] " Global SMAX= Global (in all regions) maximum step-size " restriction for electron transport (in cm). @@ -511,30 +511,28 @@ " will default to 1e10. However, if either " Electron-step algorithm= PRESTA-I " or -" Boundary crossing algorithm= PRESTA-I (the default), -" then a step-size restriction is necessary, and -" SMAX will default to 5 cm. +" Boundary crossing algorithm= PRESTA-I (the default in +" DOSXYZnrc), then a step-size restriction is necessary, +" and SMAX will default to 5 cm. " [ SMAXIR ] " ESTEPE= Maximum fractional energy loss per step. " Note that this is a global option only, no " region-by-region setting is possible. If missing, -" the defualt is 0.25 (25%). +" the default is 0.25 (25%). " [ ESTEPE ] " XImax= Maximum first elastic scattering moment per step. " Default is 0.5, NEVER use value greater than 1 as " this is beyond the range of MS data available. " [ XIMAX ] -" Boundary crossing algorithm= -" There are two selections possible: EXACT and -" PRESTA-I. PRESTA-I means that boundaries will -" be crossed a la PRESTA. That is, with lateral -" correlations turned off at a distance given by -" `Skin depth for BCA' (see below) from the boundary -" and MS forced at the boundary. EXACT means +" Boundary crossing algorithm= EXACT, PRESTA-I (default in DOSXYZnrc) +" There are two selections possible: EXACT means " the algorithm will cross boundaries in a single " scattering (SS) mode, the distance from a boundary " at which the transition to SS mode is made is -" determined by `Skin depth for BCA' (see below). +" determined by 'Skin depth for BCA' (see below). +" The second option is PRESTA-I, if selected boundaries +" will be crossed a la PRESTA, i.e. with lateral +" correlations turned off and MS forced at boundaries. " Default is PRESTA-I for efficiency reasons. This " is known not to be exactly correct, and when charged " particle equilibrium does not hold or when there is @@ -544,25 +542,22 @@ " cases, swich to EXACT BCA. " [ bca_algorithm, exact_bca ] " Skin depth for BCA= -" If Boundary crossing algorithm= PRESTA-I (default) -" then this is the distance from the boundary (in -" elastic MFP) at which lateral correlations will be -" switched off. The default in this case is to -" calculate a value based on the scattering power at -" ECUT (same as PRESTA in EGS4). If -" Boundary crossing algorithm= EXACT then this is -" the distance from the boundary (in elastic +" Determines the distance from a boundary (in elastic " MFP) at which the algorithm will go into single -" scattering mode and defaults to 3 mfp. -" Note that if you choose EXACT boundary crossing and -" set Skin depth for BCA to a very large number (e.g. -" 1e10), the entire calculation will be in SS mode. -" If you choose PRESTA-I boundary crossing and make -" Skin depth for BCA large, you will get default EGS4 -" behaviour (no PRESTA). +" scattering mode (if EXACT boundary crossing) or +" switch off lateral correlations (if PRESTA-I boundary +" crossing). Default value is 3 for EXACT or +" exp(BLCMIN)/BLCMIN for PRESTA-I (see the PRESTA paper +" for a definition of BLCMIN). Note that if you choose +" EXACT boundary crossing and set Skin depth for BCA +" to a very large number (e.g. 1e10), the entire +" calculation will be in single-scattering mode. +" If you choose PRESTA-I boundary crossing (default +" in DOSXYZnrc) and make Skin depth for BCA large, +" you will get default EGS4 behaviour (no PRESTA). " [ skindepth_for_bca ] " -" Note that the above defaults have been choosen as a compromise +" Note that the above defaults have been chosen as a compromise " between accuracy (EXACT BCA) and efficiency (PRESTA-I BCA) " since the PRESTA-I BCA algorithm has proven to generally " produce satisfactory results. Note that the new transport @@ -570,15 +565,12 @@ " that one always has the option of verifying the accuracy " by doing a long run with the EXACT BCA. " -" Electron-step algorithm= -" PRESTA-II (the default), the name is -" used for historical reasons -" or PRESTA-I +" Electron-step algorithm= PRESTA-II (default), PRESTA-I (legacy) " Determines the algorithm used to take into account " lateral and longitudinal correlations in a " condensed history step. " [ transport_algorithm ] -" Spin effects= Off, On, default is On +" Spin effects= Off, On (default) " Turns off/on spin effects for electron elastic " scattering. Spin On is ABSOLUTELY necessary for " good backscattering calculations. Will make a @@ -586,47 +578,47 @@ " (e.g. depth dose curves for RTP energy range " electrons). " [ spin_effects ] -" Brems angular sampling= Simple, KM, default is Simple +" Brems angular sampling= Simple, KM (default) " If Simple, use only the leading term of the Koch-Motz " distribution to determine the emission angle of " bremsstrahlung photons. If KM, complete " modified Koch-Motz 2BS is used (modifications -" concern proper handling of kinematics at low -" energies, makes 2BS almost the same as 2BN at low -" energies). +" concern proper handling of kinematics at low energies, +" makes 2BS almost the same as 2BN at low energies). " [ IBRDST ] -" Brems cross sections= BH, NIST, NRC, default is BH +" Brems cross sections= BH (default), NIST, NRC " If BH is selected, the Bethe-Heitler bremsstrahlung " cross sections (Coulomb corrected above 50 MeV) " will be used. If NIST is selected, the NIST brems " cross section data base (which is the basis for " the ICRU radiative stopping powers) will be employed. " Differences are negligible for E > ,say, 10 MeV, -" but signifficant in the keV energy range. If NRC is -" selected, NIST data including corrections for -" electron-electron brems will be used (typically only +" but significant in the keV energy range. If NRC is +" selected, the NRC brems cross-section data base will +" be used, which is a version of the NIST data base +" with corrected electron-electron brems contributions +" (corrections to the NIST data is typically only " significant for low values of the atomic number Z " and for k/T < 0.005). -" Bound Compton scattering= On, Off or Norej (Default is On) +" [ ibr_nist ] +" Triplet production= On or Off (default). Turns on/off simulation +" of triplet production. If On, then Borsellino's +" first Born approximation is used to sample triplet +" events based on the triplet cross-section data. +" [ itriplet ] +" Bound Compton scattering= On, Off, Simple or norej (default) " If Off, Compton scattering will be treated with " Klein-Nishina, with On Compton scattering is " treated in the Impulse approximation. +" With Simple, the impulse approximation incoherent +" scattering function will be used (i.e., no Doppler +" broadenning). With norej the actual total bound +" Compton cross section is used and there are no +" rejections at run time. " Make sure to turn on for low energy applications, -" not necessary above, say, 1 MeV. Option Norej -" uses full bound Compton cross section data -" supplied in input below and does not reject -" interactions. +" not necessary above, say, 1 MeV. " [ IBCMP ] -" Compton cross sections= Bound Compton cross-section data. User- -" supplied bound Compton cross-sections in the file -" $HEN_HOUSE/data/comp_xsections_compton.data, where -" comp_xsections is the name supplied for this input. -" This is only used if Bound Compton scattering= Simple -" and is not available on a region-by-region basis -" (see below). The default file (ie in the absence -" of any user-supplied data) is compton_sigma.data. -" [ comp_xsections ] -" Radiative Compton corrections= On or Off (default). If on, then +" Radiative Compton corrections= On or Off (default). If On, then " include radiative corrections for Compton scattering. " Equations are based on original Brown & Feynman " equations (Phys. Rev. 85, p 231--1952). Requires @@ -635,7 +627,20 @@ " SOURCES (just before " $(EGS_SOURCEDIR)get_inputs.mortran). " [ radc_flag ] -" Pair angular sampling= Off, Simple or KM +" Electron Impact Ionization= Off (default), On, casnati, kolbenstvedt, +" gryzinski or penelope. If set to On or ik, then +" use Kawrakow's theory to derive EII cross-sections. +" If set to casnati, then use the cross-sections of +" Casnati (from file $HEN_HOUSE/data/eii_casnati.data). +" Similar for kolbenstvedt, gryzinski and penelope. +" This is only of interest in kV X-ray calculations. +" Note that the user can supply their own EII +" cross-section data as well. The requirement is that +" the file eii_suffix.data exists in the $HEN_HOUSE/data +" directory, where suffix is the name specified. +" Entry is case-sensitive except for Off, On or ik. +" [ eii_flag, eii_xfile ] +" Pair angular sampling= Off, Simple (default), KM. " If off, pairs are set in motion at an angle m/E " relative to the photon direction (m is electron rest " energy, E the photon energy). Simple turns on @@ -651,83 +656,120 @@ " to NRC, then use NRC pair production cross-sections " (in file $HEN_HOUSE/data/pair_nrc1.data). Only " of interest at low energies, where the NRC cross- -" sections take into account the assymmetry in the +" sections take into account the asymmetry in the " positron-electron energy distribution. " [ pair_nrc ] -" Photoelectron angular sampling= Off or On +" Photon cross sections= Photon cross-section data. Current options are +" si (Storm-Israel), epdl (Evaluated Photon Data +" Library), xcom (default), pegs4, mcdf-xcom and +" mcdf-epdl: +" Allows the use of photon cross-sections other than +" from the PEGS4 file (unless the pegs4 option is +" specified). Options mcdf-xcom and mcdf-epdl use +" Sabbatucci and Salvat's renormalized photoelectric +" cross sections with either xcom or epdl for all other +" cross sections. These are more accurate but can +" increase CPU time by up to 6 %. +" Note that the user can supply their own cross-section +" data as well. The requirement is that the files +" photon_xsections_photo.data, +" photon_xsections_pair.data, +" photon_xsections_triplet.data, and +" photon_xsections_rayleigh.data exist in the +" $HEN_HOUSE/data directory, where photon_xsections +" is the name specified. This entry is case-sensitive. +" [ photon_xsections ] +" Photon cross-sections output= Off (default) or On. If On, then +" a file $EGS_HOME/user_code/inputfile.xsections is +" output containing photon cross-section data used. +" [ xsec_out ] +" Compton cross sections= Bound Compton cross-section data. User- +" supplied bound Compton cross-sections in the file +" $HEN_HOUSE/data/comp_xsections_compton.data, where +" comp_xsections is the name supplied for this input. +" This is only used if Bound Compton scattering= Simple +" and is not available on a region-by-region basis +" (see below). The default file (ie in the absence +" of any user-supplied data) is compton_sigma.data. +" [ comp_xsections ] +" Rayleigh scattering= Off, On (default), custom +" If On, turns on coherent (Rayleigh) scattering. +" Default is On. Should be turned on for low energy +" applications. If custom, user must provide media names +" and form factor files for each desired medium. The +" rest of the media use the default atomic form factors. +" A PEGS4 data set is not required anymore. +" [ IRAYLR ] +" ff media names = A list of media names (must match media found in +" PEGS4 data file) for which the user is going to +" provide custom Rayleigh form factor data. +" [ iray_ff_media($MXMED) ] +" ff file names = A list of names of files containing the Rayleigh +" form factor data for the media specified by +" the ff media names = input above. Full directory +" paths must be given for all files, and for each medium +" specified, iray_ff_media(i), there must be a +" corresponding file name, iray_ff_file(i). For +" example files, see the directory +" $HEN_HOUSE/data/molecular_form_factors. +" [ iray_ff_file($MXMED) ] +" Photonuclear attenuation= Off (default) or On +" If On, models the photonuclear effect. Current +" implementation is crude. Available on a +" region-by-region basis (see below) +" [ IPHOTONUCR ] +" Photonuclear cross sections= Total photonuclear cross sections. User- +" supplied total photonuclear cross-sections in +" $HEN_HOUSE/data/photonuc_xsections_photonuc.data, +" where photonuc_xsections is the name supplied for +" this input (case sensitive). In the absence of +" any user-supplied data, or if photonuc_xsections +" is set to 'default', the default file is +" iaea_photonuc.data. +" [ photonuc_xsections ] +" Photoelectron angular sampling= Off or On (default) " If Off, photo-electrons get the direction of the -" `mother' photon, with On, Sauter's furmula is -" used (which is, striktly speaking, valid only for +" `mother' photon, with On, Sauter's formula is +" used (which is, strictly speaking, valid only for " K-shell photo-absorption). " If the user has a better approach, replace the macro " $SELECT-PHOTOELECTRON-DIRECTION; -" The only application that -" I encountered until now where this option made a -" small difference was a big ion chamber (cavity size -" comparable with electron range) with high-Z walls -" in a low energy photon beam. -" Default is Off +" The only application encountered where this option +" made a small difference was a big ion chamber +" (cavity size comparable with electron range) +" with high-Z walls in a low energy photon beam. " [ IPHTER ] -" Rayleigh scattering= Off, On, custom -" If On, turned on coherent (Rayleigh) scattering. -" Default is Off. Should be turned on for low energy -" applications. Not set to On by default because -" On requires a special PEGS4 data set. If set to -" custom, then media for which custom form factors -" are to be specified are listed in the input: -" ff media names= -" and the corresponding files containing custom data -" are listed in: -" ff file names= -" [ IRAYLR ] -" Atomic relaxations= Off, On -" Default is Off. The effect of using On is twofold: +" Atomic relaxations= Off, On, eadl (default), simple +" On defaults to eadl. +" When simulating atomic relaxations: " - In photo-electric absorption events, the element " (if material is mixture) and the shell the photon -" is interacting with are sampled from the -" appropriate cross seections -" - Shell vacancies created in photo-absorption events +" is interacting with are sampled from the appropriate +" cross sections +" - Shell vacancies created in photoelectric, +" compton and electron impact ionization events " are relaxed via emission of fluorescent X-Rays, " Auger and Koster-Cronig electrons. -" Make sure to turn this option on for low energy -" applications. -" [ IEDGFL ] -" Electron impact ionization= Off, On, Casnati, Kolbenstvedt, Gryzinski -" (Default is Off) -" Determines which, if any, theory is used to model -" electron impact ionization. If set to 'On' then the -" theory of Kawrakow is used. Other settings use the -" theory associated with the name given. See future -" editions of the EGSnrc Manual (PIRS-701) for more -" details. This is only of interest in keV X-Ray -" simulations. Otherwise, leave it Off. -" [ eii_flag ] -" Photon cross sections= epdl, xcom, customized (Default is Storm-Israel -" cross-sections from PEGS4) -" The name of the cross-section data for photon -" interactions. This input line must be left out -" to access the default Storm-Israel cross-sections -" from PEGS4. 'edpl' uses cross-sections from the -" evaluated photon data library (EPDL) from Lawrence -" Livermore. 'xcom' will use the XCOM cross-sections -" from Burger and Hubbell. The user also has the -" option of using their own customized cross-section -" data. See the BEAMnrc manual for more details. -" [ photon_xsections ] -" Photon cross-sections output= Off (default) or On. If On, then -" a file $EGS_HOME/user_code/inputfile.xsections is -" output containing photon cross-section data used. -" [ xsec_out ] +" The eadl option features a more accurate treatment +" of relaxation events and uses binding energies +" consistent with those in of the photon cross sections +" used in the simulation. If using mcdf-xcom or +" mcdf-epdl photon cross sections, you cannot use +" the simple option and this will automatically get +" reset to eadl. Make sure to use eadl or simple for +" low energy applications. +" [ IEDGFL ] " -" Atomic relaxations, Rayleigh scattering, -" Photoelectron angular sampling and Bound Compton scattering -" can also be turned On/Off on a region-by-region -" basis. To do so, put e.g. +" Atomic relaxations, Rayleigh scattering, Photoelectron angular sampling, +" Bound Compton scattering and photonuclear effect +" can also be turned On/Off on a region-by-region basis. An example for +" Atomic relaxations on a region-by-region basis is: " " Atomic relaxations= On in Regions or " Atomic relaxations= Off in regions " -" in your input file. Then use +" Then define the regions in which you want +" the feature to be turned on: " " Bound Compton start region= " Bound Compton stop region= @@ -740,20 +782,37 @@ " or " PE sampling start region= " PE sampling stop region= +" or +" Photonuclear start region= +" Photonuclear stop region= " -" each followed by a lost of of one or more +" each followed by a list of one or more " start and stop regions separated by commas. " Example: +" " Atomic relaxations= On in Regions " Relaxations start region= 1, 40 " Relaxations stop region= 10, 99 +" " will first turn off relaxations everywhere and " then turn on in regions 1-10 and 40-99. -" Note that input is checked against min. and max. -" region number and ignored if +" Note that the input is checked against minimum +" and maximum region numbers and ignored if " start region < 1 or stop_region > $MXREG or " start region > stop region. " +" ECUT, PCUT and SMAX can also be set on a +" region-by-region basis. To do so, iclude +" in your input file +" +" Set XXXX= f_value1, f_value2, ... +" Set XXXX start region= i_value1, i_value2, ... +" Set XXXX stop region= j_value1, j_value2, ... +" +" where XXXX is ECUT, PCUT or SMAX , +" f_value1, f_value2,... are the desired values for XXXX +" and i_value_i and j_value_i are the start and +" stop regions. ; "Step 1 User overrides and declarations ""toc: diff --git a/HEN_HOUSE/user_codes/edknrc/edknrc.mortran b/HEN_HOUSE/user_codes/edknrc/edknrc.mortran index f954a78bf..6e6c5f501 100644 --- a/HEN_HOUSE/user_codes/edknrc/edknrc.mortran +++ b/HEN_HOUSE/user_codes/edknrc/edknrc.mortran @@ -26,6 +26,7 @@ " Contributors: Alex Bielajew " " Iwan Kawrakow " " Blake Walters " +" Frederic Tessier " " " "#############################################################################" " " @@ -309,37 +310,37 @@ " " in your input file. " -" Currently, the following options are available (except for a few entries, -" case does not matter): +" Currently, the following options are available (case does not matter and +" the internal variables are shown in [ ] brackets): " -" Global ECUT= Set a global (in all regions) electron transport -" cut off energy (in MeV). If this imput is missing, +" Global ECUT= Global (in all regions) electron transport cut +" off energy (in MeV). If this input is missing, " AE(medium) will be used. " [ ECUT ] -" Global PCUT= Set a global (in all regions) photon transport -" cut off energy (in MeV). If this imput is missing, +" Global PCUT= Global (in all regions) photon transport cut +" off energy (in MeV). If this input is missing, " AP(medium) will be used. " [ PCUT ] -" Global SMAX= Set a global (in all regions) maximum step-size +" Global SMAX= Global (in all regions) maximum step-size " restriction for electron transport (in cm). -" If missing, no geometrical step-size restrictions will -" be employed. Note that if you use the default +" If missing, no geometrical step-size restrictions +" will be employed. Note that if you use the default " EGSnrc electron-step algorithm, no SMAX-restriction " is necessary. Option is useful for transport in low " density materials (air) when PRESTA behaviour is " turned on (see below) " [ SMAXIR ] -" ESTEPE= Set the maximum fractional energy loss per step. +" ESTEPE= Maximum fractional energy loss per step. " Note that this is a global option only, no " region-by-region setting is possible. If missing, -" the defualt is 0.25 (25%) +" the default is 0.25 (25%). " [ ESTEPE ] " XImax= Maximum first elastic scattering moment per step. " Default is 0.5, NEVER use value greater than 1 as " this is beyond the range of MS data available. " [ XIMAX ] -" Boundary crossing algorithm= -" There are two selections possible: EXACT, means +" Boundary crossing algorithm= EXACT (default), PRESTA-I +" There are two selections possible: EXACT means " the algorithm will cross boundaries in a single " scattering (SS) mode, the distance from a boundary " at which the transition to SS mode is made is @@ -353,64 +354,62 @@ " Determines the distance from a boundary (in elastic " MFP) at which the algorithm will go into single " scattering mode (if EXACT boundary crossing) or -" swith off lateral correlations (if PRESTA-I boundary +" switch off lateral correlations (if PRESTA-I boundary " crossing). Default value is 3 for EXACT or " exp(BLCMIN)/BLCMIN for PRESTA-I (see the PRESTA paper " for a definition of BLCMIN). Note that if you choose " EXACT boundary crossing and set Skin depth for BCA " to a very large number (e.g. 1e10), the entire -" calculation will be in SS mode. If you choose -" PRESTA-I boundary crossing and make Skin depth for BCA -" large, you will get default EGS4 behavious (no PRESTA) +" calculation will be in single-scattering mode. If you +" choose PRESTA-I boundary crossing and make Skin depth +" for BCA large, you will get default EGS4 behaviour +" (no PRESTA). " [ skindepth_for_bca ] -" Electron-step algorithm= -" PRESTA-II (the default), the name is -" used for historical reasons -" or PRESTA-I +" Electron-step algorithm= PRESTA-II (default), PRESTA-I (legacy) " Determines the algorithm used to take into account " lateral and longitudinal correlations in a " condensed history step. " [ transport_algorithm ] -" Spin effects= Off, On, default is On +" Spin effects= Off, On (default) " Turns off/on spin effects for electron elastic " scattering. Spin On is ABSOLUTELY necessary for " good backscattering calculations. Will make a -" even in `well conditioned' situations (e.g. depth -" dose curves for RTP energy range electrons). +" difference even in `well conditioned' situations +" (e.g. depth dose curves for RTP energy range +" electrons). " [ spin_effects ] -" Brems angular sampling= Simple, KM, default is KM +" Brems angular sampling= Simple, KM (default) " If Simple, use only the leading term of the Koch-Motz " distribution to determine the emission angle of -" bremsstrahlung photons. If On, complete +" bremsstrahlung photons. If KM, complete " modified Koch-Motz 2BS is used (modifications " concern proper handling of kinematics at low energies, " makes 2BS almost the same as 2BN at low energies). " [ IBRDST ] -" Brems cross sections= BH, NIST, default is BH +" Brems cross sections= BH (default), NIST, NRC " If BH is selected, the Bethe-Heitler bremsstrahlung " cross sections (Coulomb corrected above 50 MeV) " will be used. If NIST is selected, the NIST brems " cross section data base (which is the basis for " the ICRU radiative stopping powers) will be employed. " Differences are negligible for E > ,say, 10 MeV, -" but signifficant in the keV energy range. -" Electron Impact Ionization= Off (default), On, casnati, kolbenstvedt, -" gryzinski or penelope. If set to On or ik, then -" use Kawrakow's theory to derive EII cross-sections. -" If set to casnati, then use the cross-sections of -" Casnati (from file ($HEN_HOUSE/data/eii_casnati.data). -" Similar for kolbenstvedt, gryzinski and penelope. -" This is only of interest in kV X-ray calculations. -" Note that the user can supply their own EII -" cross-section data as well. The requirement is that -" the file eii_suffix.data exists in the $HEN_HOUSE/data -" directory, where suffix is the name specified. -" Entry case-sensitive except for Off, On or ik. -" [ eii_flag ] -" Bound Compton scattering= On, Off, Simple or norej +" but significant in the keV energy range. If NRC is +" selected, the NRC brems cross-section data base will +" be used, which is a version of the NIST data base +" with corrected electron-electron brems contributions +" (corrections to the NIST data is typically only +" significant for low values of the atomic number Z +" and for k/T < 0.005). +" [ ibr_nist ] +" Triplet production= On or Off (default). Turns on/off simulation +" of triplet production. If On, then Borsellino's +" first Born approximation is used to sample triplet +" events based on the triplet cross-section data. +" [ itriplet ] +" Bound Compton scattering= On, Off, Simple or norej (default) " If Off, Compton scattering will be treated with " Klein-Nishina, with On Compton scattering is -" treated in the Impuls approximation. Default is On. +" treated in the Impulse approximation. " With Simple, the impulse approximation incoherent " scattering function will be used (i.e., no Doppler " broadenning). With norej the actual total bound @@ -419,7 +418,29 @@ " Make sure to turn on for low energy applications, " not necessary above, say, 1 MeV. " [ IBCMP ] -" Pair angular sampling= Off, Simple or KM +" Radiative Compton corrections= On or Off (default). If On, then +" include radiative corrections for Compton scattering. +" Equations are based on original Brown & Feynman +" equations (Phys. Rev. 85, p 231--1952). Requires +" a change to the user codes Makefile to include +" $(EGS_SOURCEDIR)rad_compton1.mortran in the +" SOURCES (just before +" $(EGS_SOURCEDIR)get_inputs.mortran). +" [ radc_flag ] +" Electron Impact Ionization= Off (default), On, casnati, kolbenstvedt, +" gryzinski or penelope. If set to On or ik, then +" use Kawrakow's theory to derive EII cross-sections. +" If set to casnati, then use the cross-sections of +" Casnati (from file $HEN_HOUSE/data/eii_casnati.data). +" Similar for kolbenstvedt, gryzinski and penelope. +" This is only of interest in kV X-ray calculations. +" Note that the user can supply their own EII +" cross-section data as well. The requirement is that +" the file eii_suffix.data exists in the $HEN_HOUSE/data +" directory, where suffix is the name specified. +" Entry is case-sensitive except for Off, On or ik. +" [ eii_flag, eii_xfile ] +" Pair angular sampling= Off, Simple (default), KM. " If off, pairs are set in motion at an angle m/E " relative to the photon direction (m is electron rest " energy, E the photon energy). Simple turns on @@ -427,22 +448,28 @@ " (this is sufficient for most applications), " KM (comes from Koch and Motz) turns on using 2BS " from the article by Koch and Motz. -" Default is Simple, make sure you always use Simple or -" KM +" Default is Simple, make sure you always use +" Simple or KM " [ IPRDST ] " Pair cross sections= BH (default) or NRC. If set to BH, then use " Bethe-Heitler pair production cross-sections. If set " to NRC, then use NRC pair production cross-sections " (in file $HEN_HOUSE/data/pair_nrc1.data). Only " of interest at low energies, where the NRC cross- -" sections take into account the assymmetry in the +" sections take into account the asymmetry in the " positron-electron energy distribution. " [ pair_nrc ] " Photon cross sections= Photon cross-section data. Current options are -" si (Storm-Israel--the default), epdl (Evaluated Photon -" Data Library), xcom and pegs4. Allows the use of -" photon cross-sections other than from the PEGS4 file -" unless the pegs4 option is specified. +" si (Storm-Israel), epdl (Evaluated Photon Data +" Library), xcom (default), pegs4, mcdf-xcom and +" mcdf-epdl: +" Allows the use of photon cross-sections other than +" from the PEGS4 file (unless the pegs4 option is +" specified). Options mcdf-xcom and mcdf-epdl use +" Sabbatucci and Salvat's renormalized photoelectric +" cross sections with either xcom or epdl for all other +" cross sections. These are more accurate but can +" increase CPU time by up to 6 %. " Note that the user can supply their own cross-section " data as well. The requirement is that the files " photon_xsections_photo.data, @@ -450,8 +477,7 @@ " photon_xsections_triplet.data, and " photon_xsections_rayleigh.data exist in the " $HEN_HOUSE/data directory, where photon_xsections -" is the name specified. -" Hence this entry is case-sensitive. +" is the name specified. This entry is case-sensitive. " [ photon_xsections ] " Photon cross-sections output= Off (default) or On. If On, then " a file $EGS_HOME/user_code/inputfile.xsections is @@ -466,26 +492,13 @@ " (see below). The default file (ie in the absence " of any user-supplied data) is compton_sigma.data. " [ comp_xsections ] -" Photoelectron angular sampling= Off or On -" If Off, photo-electrons get the direction of the -" `mother' photon, with On, Sauter's furmula is -" used (which is, striktly speaking, valid only for -" K-shell photo-absorption). -" If the user has a better approach, replace the macro -" $SELECT-PHOTOELECTRON-DIRECTION; -" The only application that -" I encountered until now where this option made a -" small difference was a big ion chamber (cavity size -" comparable with electron range) with high-Z walls -" in a low energy photon beam. -" Default is On -" [ IPHTER ] -" Rayleigh scattering= Off, On, custom -" If On, turn on coherent (Rayleigh) scattering, -" even if no Rayleigh data in PEGS4 file. -" Default is Off. Should be turned on for low energy +" Rayleigh scattering= Off, On (default), custom +" If On, turns on coherent (Rayleigh) scattering. +" Default is On. Should be turned on for low energy " applications. If custom, user must provide media names -" and form factor files for each medium. +" and form factor files for each desired medium. The +" rest of the media use the default atomic form factors. +" A PEGS4 data set is not required anymore. " [ IRAYLR ] " ff media names = A list of media names (must match media found in " PEGS4 data file) for which the user is going to @@ -500,28 +513,63 @@ " example files, see the directory " $HEN_HOUSE/data/molecular_form_factors. " [ iray_ff_file($MXMED) ] -" Atomic relaxations= Off, On -" Default is On. The effect of using On is twofold: +" Photonuclear attenuation= Off (default) or On +" If On, models the photonuclear effect. Current +" implementation is crude. Available on a +" region-by-region basis (see below) +" [ IPHOTONUCR ] +" Photonuclear cross sections= Total photonuclear cross sections. User- +" supplied total photonuclear cross-sections in +" $HEN_HOUSE/data/photonuc_xsections_photonuc.data, +" where photonuc_xsections is the name supplied for +" this input (case sensitive). In the absence of +" any user-supplied data, or if photonuc_xsections +" is set to 'default', the default file is +" iaea_photonuc.data. +" [ photonuc_xsections ] +" Photoelectron angular sampling= Off or On (default) +" If Off, photo-electrons get the direction of the +" `mother' photon, with On, Sauter's formula is +" used (which is, strictly speaking, valid only for +" K-shell photo-absorption). +" If the user has a better approach, replace the macro +" $SELECT-PHOTOELECTRON-DIRECTION; +" The only application encountered where this option +" made a small difference was a big ion chamber +" (cavity size comparable with electron range) +" with high-Z walls in a low energy photon beam. +" [ IPHTER ] +" Atomic relaxations= Off, On, eadl (default), simple +" On defaults to eadl. +" When simulating atomic relaxations: " - In photo-electric absorption events, the element " (if material is mixture) and the shell the photon " is interacting with are sampled from the appropriate -" cross seections -" - Shell vacancies created in photo-absorption events +" cross sections +" - Shell vacancies created in photoelectric, +" compton and electron impact ionization events " are relaxed via emission of fluorescent X-Rays, " Auger and Koster-Cronig electrons. -" Make sure to turn this option on for low energy -" applications. -" [ IEDGFL ] -" -" Atomic relaxations, Rayleigh scattering, -" Photoelectron angular sampling and Bound Compton scattering -" can also be turned On/Off on a region-by-region -" basis. To do so, put e.g. +" The eadl option features a more accurate treatment +" of relaxation events and uses binding energies +" consistent with those in of the photon cross sections +" used in the simulation. If using mcdf-xcom or +" mcdf-epdl photon cross sections, you cannot use +" the simple option and this will automatically get +" reset to eadl. Make sure to use eadl or simple for +" low energy applications. +" [ IEDGFL ] +" +" Atomic relaxations, Rayleigh scattering, Photoelectron angular sampling, +" Bound Compton scattering and photonuclear effect +" can also be turned On/Off on a region-by-region basis. An example for +" Atomic relaxations on a region-by-region basis is: " " Atomic relaxations= On in Regions or " Atomic relaxations= Off in regions " -" in your input file. Then use +" Then define the regions in which you want +" the feature to be turned on: " " Bound Compton start region= " Bound Compton stop region= @@ -534,17 +582,22 @@ " or " PE sampling start region= " PE sampling stop region= +" or +" Photonuclear start region= +" Photonuclear stop region= " -" each followed by a lost of of one or more +" each followed by a list of one or more " start and stop regions separated by commas. " Example: +" " Atomic relaxations= On in Regions " Relaxations start region= 1, 40 " Relaxations stop region= 10, 99 +" " will first turn off relaxations everywhere and -" then turn off in regions 1-10 and 40-99. -" Note that input is checked against min. and max. -" region number and ignored if +" then turn on in regions 1-10 and 40-99. +" Note that the input is checked against minimum +" and maximum region numbers and ignored if " start region < 1 or stop_region > $MXREG or " start region > stop region. " diff --git a/HEN_HOUSE/user_codes/flurznrc/flurznrc.mortran b/HEN_HOUSE/user_codes/flurznrc/flurznrc.mortran index 4f69e5952..d286d0526 100644 --- a/HEN_HOUSE/user_codes/flurznrc/flurznrc.mortran +++ b/HEN_HOUSE/user_codes/flurznrc/flurznrc.mortran @@ -32,6 +32,7 @@ " Iwan Kawrakow " " Ernesto Mainegra-Hing " " Reid Townson " +" Frederic Tessier " " " "#############################################################################" " " @@ -926,7 +927,7 @@ REPLACE {$VERSION} WITH { " All input associated with selection of various transport parameter " is not crucial for the execution as there are default values set. " Therefore, if some of the input options in this section are -" missing/misspelled, this will be ignored and defualt parameter assumed +" missing/misspelled, this will be ignored and default parameter assumed " As the transport parameter input routine uses get_inputs, a lot " of error/warning messages may be produced on UNIT 15, though. " If you don't have the intention of changing default settings, @@ -937,37 +938,37 @@ REPLACE {$VERSION} WITH { " :start mc transport parameter: " :stop mc transport parameter: " -" Currently, the following options are available (except for a few entries, -" case does not matter): +" Currently, the following options are available (case does not matter and +" the internal variables are shown in [ ] brackets): " -" Global ECUT= Set a global (in all regions) electron transport -" cut off energy (in MeV). If this imput is missing, +" Global ECUT= Global (in all regions) electron transport cut +" off energy (in MeV). If this input is missing, " AE(medium) will be used. " [ ECUT ] -" Global PCUT= Set a global (in all regions) photon transport -" cut off energy (in MeV). If this imput is missing, +" Global PCUT= Global (in all regions) photon transport cut +" off energy (in MeV). If this input is missing, " AP(medium) will be used. " [ PCUT ] -" Global SMAX= Set a global (in all regions) maximum step-size +" Global SMAX= Global (in all regions) maximum step-size " restriction for electron transport (in cm). -" If missing, no geometrical step-size restrictions will -" be employed. Note that if you use the default +" If missing, no geometrical step-size restrictions +" will be employed. Note that if you use the default " EGSnrc electron-step algorithm, no SMAX-restriction " is necessary. Option is useful for transport in low " density materials (air) when PRESTA behaviour is " turned on (see below) " [ SMAXIR ] -" ESTEPE= Set the maximum fractional energy loss per step. +" ESTEPE= Maximum fractional energy loss per step. " Note that this is a global option only, no " region-by-region setting is possible. If missing, -" the defualt is 0.25 (25%) +" the default is 0.25 (25%). " [ ESTEPE ] " XImax= Maximum first elastic scattering moment per step. " Default is 0.5, NEVER use value greater than 1 as " this is beyond the range of MS data available. " [ XIMAX ] -" Boundary crossing algorithm= -" There are two selections possible: EXACT, means +" Boundary crossing algorithm= EXACT (default), PRESTA-I +" There are two selections possible: EXACT means " the algorithm will cross boundaries in a single " scattering (SS) mode, the distance from a boundary " at which the transition to SS mode is made is @@ -981,64 +982,62 @@ REPLACE {$VERSION} WITH { " Determines the distance from a boundary (in elastic " MFP) at which the algorithm will go into single " scattering mode (if EXACT boundary crossing) or -" swith off lateral correlations (if PRESTA-I boundary +" switch off lateral correlations (if PRESTA-I boundary " crossing). Default value is 3 for EXACT or " exp(BLCMIN)/BLCMIN for PRESTA-I (see the PRESTA paper " for a definition of BLCMIN). Note that if you choose " EXACT boundary crossing and set Skin depth for BCA " to a very large number (e.g. 1e10), the entire -" calculation will be in SS mode. If you choose -" PRESTA-I boundary crossing and make Skin depth for BCA -" large, you will get default EGS4 behavious (no PRESTA) +" calculation will be in single-scattering mode. If you +" choose PRESTA-I boundary crossing and make Skin depth +" for BCA large, you will get default EGS4 behaviour +" (no PRESTA). " [ skindepth_for_bca ] -" Electron-step algorithm= -" PRESTA-II (the default), the name is -" used for historical reasons -" or PRESTA-I +" Electron-step algorithm= PRESTA-II (default), PRESTA-I (legacy) " Determines the algorithm used to take into account " lateral and longitudinal correlations in a " condensed history step. " [ transport_algorithm ] -" Spin effects= Off, On, default is On +" Spin effects= Off, On (default) " Turns off/on spin effects for electron elastic " scattering. Spin On is ABSOLUTELY necessary for " good backscattering calculations. Will make a -" even in `well conditioned' situations (e.g. depth -" dose curves for RTP energy range electrons). +" difference even in `well conditioned' situations +" (e.g. depth dose curves for RTP energy range +" electrons). " [ spin_effects ] -" Brems angular sampling= Simple, KM, default is KM +" Brems angular sampling= Simple, KM (default) " If Simple, use only the leading term of the Koch-Motz " distribution to determine the emission angle of -" bremsstrahlung photons. If On, complete +" bremsstrahlung photons. If KM, complete " modified Koch-Motz 2BS is used (modifications " concern proper handling of kinematics at low energies, " makes 2BS almost the same as 2BN at low energies). " [ IBRDST ] -" Brems cross sections= BH, NIST, default is BH +" Brems cross sections= BH (default), NIST, NRC " If BH is selected, the Bethe-Heitler bremsstrahlung " cross sections (Coulomb corrected above 50 MeV) " will be used. If NIST is selected, the NIST brems " cross section data base (which is the basis for " the ICRU radiative stopping powers) will be employed. " Differences are negligible for E > ,say, 10 MeV, -" but signifficant in the keV energy range. -" Electron Impact Ionization= Off (default), On, casnati, kolbenstvedt, -" gryzinski or penelope. If set to On or ik, then -" use Kawrakow's theory to derive EII cross-sections. -" If set to casnati, then use the cross-sections of -" Casnati (from file ($HEN_HOUSE/data/eii_casnati.data). -" Similar for kolbenstvedt, gryzinski and penelope. -" This is only of interest in kV X-ray calculations. -" Note that the user can supply their own EII -" cross-section data as well. The requirement is that -" the file eii_suffix.data exists in the $HEN_HOUSE/data -" directory, where suffix is the name specified. -" Entry case-sensitive except for Off, On or ik. -" [ eii_flag ] -" Bound Compton scattering= On, Off, Simple or norej +" but significant in the keV energy range. If NRC is +" selected, the NRC brems cross-section data base will +" be used, which is a version of the NIST data base +" with corrected electron-electron brems contributions +" (corrections to the NIST data is typically only +" significant for low values of the atomic number Z +" and for k/T < 0.005). +" [ ibr_nist ] +" Triplet production= On or Off (default). Turns on/off simulation +" of triplet production. If On, then Borsellino's +" first Born approximation is used to sample triplet +" events based on the triplet cross-section data. +" [ itriplet ] +" Bound Compton scattering= On, Off, Simple or norej (default) " If Off, Compton scattering will be treated with " Klein-Nishina, with On Compton scattering is -" treated in the Impuls approximation. Default is On. +" treated in the Impulse approximation. " With Simple, the impulse approximation incoherent " scattering function will be used (i.e., no Doppler " broadenning). With norej the actual total bound @@ -1047,7 +1046,29 @@ REPLACE {$VERSION} WITH { " Make sure to turn on for low energy applications, " not necessary above, say, 1 MeV. " [ IBCMP ] -" Pair angular sampling= Off, Simple or KM +" Radiative Compton corrections= On or Off (default). If On, then +" include radiative corrections for Compton scattering. +" Equations are based on original Brown & Feynman +" equations (Phys. Rev. 85, p 231--1952). Requires +" a change to the user codes Makefile to include +" $(EGS_SOURCEDIR)rad_compton1.mortran in the +" SOURCES (just before +" $(EGS_SOURCEDIR)get_inputs.mortran). +" [ radc_flag ] +" Electron Impact Ionization= Off (default), On, casnati, kolbenstvedt, +" gryzinski or penelope. If set to On or ik, then +" use Kawrakow's theory to derive EII cross-sections. +" If set to casnati, then use the cross-sections of +" Casnati (from file $HEN_HOUSE/data/eii_casnati.data). +" Similar for kolbenstvedt, gryzinski and penelope. +" This is only of interest in kV X-ray calculations. +" Note that the user can supply their own EII +" cross-section data as well. The requirement is that +" the file eii_suffix.data exists in the $HEN_HOUSE/data +" directory, where suffix is the name specified. +" Entry is case-sensitive except for Off, On or ik. +" [ eii_flag, eii_xfile ] +" Pair angular sampling= Off, Simple (default), KM. " If off, pairs are set in motion at an angle m/E " relative to the photon direction (m is electron rest " energy, E the photon energy). Simple turns on @@ -1055,22 +1076,28 @@ REPLACE {$VERSION} WITH { " (this is sufficient for most applications), " KM (comes from Koch and Motz) turns on using 2BS " from the article by Koch and Motz. -" Default is Simple, make sure you always use Simple or -" KM +" Default is Simple, make sure you always use +" Simple or KM " [ IPRDST ] " Pair cross sections= BH (default) or NRC. If set to BH, then use " Bethe-Heitler pair production cross-sections. If set " to NRC, then use NRC pair production cross-sections " (in file $HEN_HOUSE/data/pair_nrc1.data). Only " of interest at low energies, where the NRC cross- -" sections take into account the assymmetry in the +" sections take into account the asymmetry in the " positron-electron energy distribution. " [ pair_nrc ] " Photon cross sections= Photon cross-section data. Current options are -" si (Storm-Israel--the default), epdl (Evaluated Photon -" Data Library), xcom and pegs4. Allows the use of -" photon cross-sections other than from the PEGS4 file -" unless the pegs4 option is specified. +" si (Storm-Israel), epdl (Evaluated Photon Data +" Library), xcom (default), pegs4, mcdf-xcom and +" mcdf-epdl: +" Allows the use of photon cross-sections other than +" from the PEGS4 file (unless the pegs4 option is +" specified). Options mcdf-xcom and mcdf-epdl use +" Sabbatucci and Salvat's renormalized photoelectric +" cross sections with either xcom or epdl for all other +" cross sections. These are more accurate but can +" increase CPU time by up to 6 %. " Note that the user can supply their own cross-section " data as well. The requirement is that the files " photon_xsections_photo.data, @@ -1078,8 +1105,7 @@ REPLACE {$VERSION} WITH { " photon_xsections_triplet.data, and " photon_xsections_rayleigh.data exist in the " $HEN_HOUSE/data directory, where photon_xsections -" is the name specified. -" Hence this entry is case-sensitive. +" is the name specified. This entry is case-sensitive. " [ photon_xsections ] " Photon cross-sections output= Off (default) or On. If On, then " a file $EGS_HOME/user_code/inputfile.xsections is @@ -1094,26 +1120,13 @@ REPLACE {$VERSION} WITH { " (see below). The default file (ie in the absence " of any user-supplied data) is compton_sigma.data. " [ comp_xsections ] -" Photoelectron angular sampling= Off or On -" If Off, photo-electrons get the direction of the -" `mother' photon, with On, Sauter's furmula is -" used (which is, striktly speaking, valid only for -" K-shell photo-absorption). -" If the user has a better approach, replace the macro -" $SELECT-PHOTOELECTRON-DIRECTION; -" The only application that -" I encountered until now where this option made a -" small difference was a big ion chamber (cavity size -" comparable with electron range) with high-Z walls -" in a low energy photon beam. -" Default is On -" [ IPHTER ] -" Rayleigh scattering= Off, On, custom -" If On, turn on coherent (Rayleigh) scattering, -" even if no Rayleigh data in PEGS4 file. -" Default is Off. Should be turned on for low energy +" Rayleigh scattering= Off, On (default), custom +" If On, turns on coherent (Rayleigh) scattering. +" Default is On. Should be turned on for low energy " applications. If custom, user must provide media names -" and form factor files for each medium. +" and form factor files for each desired medium. The +" rest of the media use the default atomic form factors. +" A PEGS4 data set is not required anymore. " [ IRAYLR ] " ff media names = A list of media names (must match media found in " PEGS4 data file) for which the user is going to @@ -1128,29 +1141,64 @@ REPLACE {$VERSION} WITH { " example files, see the directory " $HEN_HOUSE/data/molecular_form_factors. " [ iray_ff_file($MXMED) ] -" Atomic relaxations= Off, On -" Default is On. The effect of using On is twofold: +" Photonuclear attenuation= Off (default) or On +" If On, models the photonuclear effect. Current +" implementation is crude. Available on a +" region-by-region basis (see below) +" [ IPHOTONUCR ] +" Photonuclear cross sections= Total photonuclear cross sections. User- +" supplied total photonuclear cross-sections in +" $HEN_HOUSE/data/photonuc_xsections_photonuc.data, +" where photonuc_xsections is the name supplied for +" this input (case sensitive). In the absence of +" any user-supplied data, or if photonuc_xsections +" is set to 'default', the default file is +" iaea_photonuc.data. +" [ photonuc_xsections ] +" Photoelectron angular sampling= Off or On (default) +" If Off, photo-electrons get the direction of the +" `mother' photon, with On, Sauter's formula is +" used (which is, strictly speaking, valid only for +" K-shell photo-absorption). +" If the user has a better approach, replace the macro +" $SELECT-PHOTOELECTRON-DIRECTION; +" The only application encountered where this option +" made a small difference was a big ion chamber +" (cavity size comparable with electron range) +" with high-Z walls in a low energy photon beam. +" [ IPHTER ] +" Atomic relaxations= Off, On, eadl (default), simple +" On defaults to eadl. +" When simulating atomic relaxations: " - In photo-electric absorption events, the element " (if material is mixture) and the shell the photon " is interacting with are sampled from the appropriate -" cross seections -" - Shell vacancies created in photo-absorption events +" cross sections +" - Shell vacancies created in photoelectric, +" compton and electron impact ionization events " are relaxed via emission of fluorescent X-Rays, " Auger and Koster-Cronig electrons. -" Make sure to turn this option on for low energy -" applications. -" [ IEDGFL ] -" -" Atomic relaxations, Rayleigh scattering, -" Photoelectron angular sampling and Bound Compton scattering -" can also be turned On/Off on a region-by-region -" basis. To do so, put e.g. +" The eadl option features a more accurate treatment +" of relaxation events and uses binding energies +" consistent with those in of the photon cross sections +" used in the simulation. If using mcdf-xcom or +" mcdf-epdl photon cross sections, you cannot use +" the simple option and this will automatically get +" reset to eadl. Make sure to use eadl or simple for +" low energy applications. +" [ IEDGFL ] +" +" Atomic relaxations, Rayleigh scattering, Photoelectron angular sampling, +" Bound Compton scattering and photonuclear effect +" can also be turned On/Off on a region-by-region basis. An example for +" Atomic relaxations on a region-by-region basis is: " " Atomic relaxations= On in Regions or " Atomic relaxations= Off in regions " -" in your input file. Then use - +" Then define the regions in which you want +" the feature to be turned on: +" " Bound Compton start region= " Bound Compton stop region= " or @@ -1162,17 +1210,22 @@ REPLACE {$VERSION} WITH { " or " PE sampling start region= " PE sampling stop region= +" or +" Photonuclear start region= +" Photonuclear stop region= " -" each followed by a lost of of one or more +" each followed by a list of one or more " start and stop regions separated by commas. " Example: +" " Atomic relaxations= On in Regions " Relaxations start region= 1, 40 " Relaxations stop region= 10, 99 +" " will first turn off relaxations everywhere and " then turn on in regions 1-10 and 40-99. -" Note that input is checked against min. and max. -" region number and ignored if +" Note that the input is checked against minimum +" and maximum region numbers and ignored if " start region < 1 or stop_region > $MXREG or " start region > stop region. " diff --git a/HEN_HOUSE/user_codes/sprrznrc/sprrznrc.mortran b/HEN_HOUSE/user_codes/sprrznrc/sprrznrc.mortran index e44bbaa8b..0f93820f3 100644 --- a/HEN_HOUSE/user_codes/sprrznrc/sprrznrc.mortran +++ b/HEN_HOUSE/user_codes/sprrznrc/sprrznrc.mortran @@ -30,6 +30,7 @@ " Iwan Kawrakow " " Ernesto Mainegra-Hing " " Reid Townson " +" Frederic Tessier " " " "#############################################################################" " " @@ -918,7 +919,7 @@ REPLACE {$VERSION} WITH { " All input associated with selection of various transport parameter " is not crucial for the execution as there are default values set. " Therefore, if some of the input options in this section are -" missing/misspelled, this will be ignored and defualt parameter assumed +" missing/misspelled, this will be ignored and default parameter assumed " As the transport parameter input routine uses get_inputs, a lot " of error/warning messages may be produced on UNIT 15, though. " If you don't have the intention of changing default settings, @@ -935,37 +936,37 @@ REPLACE {$VERSION} WITH { " " in your input file. " -" Currently, the following options are available (except for a few entries, -" case does not matter): +" Currently, the following options are available (case does not matter and +" the internal variables are shown in [ ] brackets): " -" Global ECUT= Set a global (in all regions) electron transport -" cut off energy (in MeV). If this imput is missing, +" Global ECUT= Global (in all regions) electron transport cut +" off energy (in MeV). If this input is missing, " AE(medium) will be used. " [ ECUT ] -" Global PCUT= Set a global (in all regions) photon transport -" cut off energy (in MeV). If this imput is missing, +" Global PCUT= Global (in all regions) photon transport cut +" off energy (in MeV). If this input is missing, " AP(medium) will be used. " [ PCUT ] -" Global SMAX= Set a global (in all regions) maximum step-size +" Global SMAX= Global (in all regions) maximum step-size " restriction for electron transport (in cm). -" If missing, no geometrical step-size restrictions will -" be employed. Note that if you use the default +" If missing, no geometrical step-size restrictions +" will be employed. Note that if you use the default " EGSnrc electron-step algorithm, no SMAX-restriction " is necessary. Option is useful for transport in low " density materials (air) when PRESTA behaviour is " turned on (see below) " [ SMAXIR ] -" ESTEPE= Set the maximum fractional energy loss per step. +" ESTEPE= Maximum fractional energy loss per step. " Note that this is a global option only, no " region-by-region setting is possible. If missing, -" the defualt is 0.25 (25%) +" the default is 0.25 (25%). " [ ESTEPE ] " XImax= Maximum first elastic scattering moment per step. " Default is 0.5, NEVER use value greater than 1 as " this is beyond the range of MS data available. " [ XIMAX ] -" Boundary crossing algorithm= -" There are two selections possible: EXACT, means +" Boundary crossing algorithm= EXACT (default), PRESTA-I +" There are two selections possible: EXACT means " the algorithm will cross boundaries in a single " scattering (SS) mode, the distance from a boundary " at which the transition to SS mode is made is @@ -979,64 +980,62 @@ REPLACE {$VERSION} WITH { " Determines the distance from a boundary (in elastic " MFP) at which the algorithm will go into single " scattering mode (if EXACT boundary crossing) or -" swith off lateral correlations (if PRESTA-I boundary +" switch off lateral correlations (if PRESTA-I boundary " crossing). Default value is 3 for EXACT or " exp(BLCMIN)/BLCMIN for PRESTA-I (see the PRESTA paper " for a definition of BLCMIN). Note that if you choose " EXACT boundary crossing and set Skin depth for BCA " to a very large number (e.g. 1e10), the entire -" calculation will be in SS mode. If you choose -" PRESTA-I boundary crossing and make Skin depth for BCA -" large, you will get default EGS4 behavious (no PRESTA) +" calculation will be in single-scattering mode. If you +" choose PRESTA-I boundary crossing and make Skin depth +" for BCA large, you will get default EGS4 behaviour +" (no PRESTA). " [ skindepth_for_bca ] -" Electron-step algorithm= -" PRESTA-II (the default), the name is -" used for historical reasons -" or PRESTA-I +" Electron-step algorithm= PRESTA-II (default), PRESTA-I (legacy) " Determines the algorithm used to take into account " lateral and longitudinal correlations in a " condensed history step. " [ transport_algorithm ] -" Spin effects= Off, On, default is On +" Spin effects= Off, On (default) " Turns off/on spin effects for electron elastic " scattering. Spin On is ABSOLUTELY necessary for " good backscattering calculations. Will make a -" even in `well conditioned' situations (e.g. depth -" dose curves for RTP energy range electrons). +" difference even in `well conditioned' situations +" (e.g. depth dose curves for RTP energy range +" electrons). " [ spin_effects ] -" Brems angular sampling= Simple, KM, default is KM +" Brems angular sampling= Simple, KM (default) " If Simple, use only the leading term of the Koch-Motz " distribution to determine the emission angle of -" bremsstrahlung photons. If On, complete +" bremsstrahlung photons. If KM, complete " modified Koch-Motz 2BS is used (modifications " concern proper handling of kinematics at low energies, " makes 2BS almost the same as 2BN at low energies). " [ IBRDST ] -" Brems cross sections= BH, NIST, default is BH +" Brems cross sections= BH (default), NIST, NRC " If BH is selected, the Bethe-Heitler bremsstrahlung " cross sections (Coulomb corrected above 50 MeV) " will be used. If NIST is selected, the NIST brems " cross section data base (which is the basis for " the ICRU radiative stopping powers) will be employed. " Differences are negligible for E > ,say, 10 MeV, -" but signifficant in the keV energy range. -" Electron Impact Ionization= Off (default), On, casnati, kolbenstvedt, -" gryzinski or penelope. If set to On or ik, then -" use Kawrakow's theory to derive EII cross-sections. -" If set to casnati, then use the cross-sections of -" Casnati (from file ($HEN_HOUSE/data/eii_casnati.data). -" Similar for kolbenstvedt, gryzinski and penelope. -" This is only of interest in kV X-ray calculations. -" Note that the user can supply their own EII -" cross-section data as well. The requirement is that -" the file eii_suffix.data exists in the $HEN_HOUSE/data -" directory, where suffix is the name specified. -" Entry case-sensitive except for Off, On or ik. -" [ eii_flag ] -" Bound Compton scattering= On, Off, Simple or norej +" but significant in the keV energy range. If NRC is +" selected, the NRC brems cross-section data base will +" be used, which is a version of the NIST data base +" with corrected electron-electron brems contributions +" (corrections to the NIST data is typically only +" significant for low values of the atomic number Z +" and for k/T < 0.005). +" [ ibr_nist ] +" Triplet production= On or Off (default). Turns on/off simulation +" of triplet production. If On, then Borsellino's +" first Born approximation is used to sample triplet +" events based on the triplet cross-section data. +" [ itriplet ] +" Bound Compton scattering= On, Off, Simple or norej (default) " If Off, Compton scattering will be treated with " Klein-Nishina, with On Compton scattering is -" treated in the Impuls approximation. Default is On. +" treated in the Impulse approximation. " With Simple, the impulse approximation incoherent " scattering function will be used (i.e., no Doppler " broadenning). With norej the actual total bound @@ -1045,7 +1044,29 @@ REPLACE {$VERSION} WITH { " Make sure to turn on for low energy applications, " not necessary above, say, 1 MeV. " [ IBCMP ] -" Pair angular sampling= Off, Simple or KM +" Radiative Compton corrections= On or Off (default). If On, then +" include radiative corrections for Compton scattering. +" Equations are based on original Brown & Feynman +" equations (Phys. Rev. 85, p 231--1952). Requires +" a change to the user codes Makefile to include +" $(EGS_SOURCEDIR)rad_compton1.mortran in the +" SOURCES (just before +" $(EGS_SOURCEDIR)get_inputs.mortran). +" [ radc_flag ] +" Electron Impact Ionization= Off (default), On, casnati, kolbenstvedt, +" gryzinski or penelope. If set to On or ik, then +" use Kawrakow's theory to derive EII cross-sections. +" If set to casnati, then use the cross-sections of +" Casnati (from file $HEN_HOUSE/data/eii_casnati.data). +" Similar for kolbenstvedt, gryzinski and penelope. +" This is only of interest in kV X-ray calculations. +" Note that the user can supply their own EII +" cross-section data as well. The requirement is that +" the file eii_suffix.data exists in the $HEN_HOUSE/data +" directory, where suffix is the name specified. +" Entry is case-sensitive except for Off, On or ik. +" [ eii_flag, eii_xfile ] +" Pair angular sampling= Off, Simple (default), KM. " If off, pairs are set in motion at an angle m/E " relative to the photon direction (m is electron rest " energy, E the photon energy). Simple turns on @@ -1053,22 +1074,28 @@ REPLACE {$VERSION} WITH { " (this is sufficient for most applications), " KM (comes from Koch and Motz) turns on using 2BS " from the article by Koch and Motz. -" Default is Simple, make sure you always use Simple or -" KM +" Default is Simple, make sure you always use +" Simple or KM " [ IPRDST ] " Pair cross sections= BH (default) or NRC. If set to BH, then use " Bethe-Heitler pair production cross-sections. If set " to NRC, then use NRC pair production cross-sections " (in file $HEN_HOUSE/data/pair_nrc1.data). Only " of interest at low energies, where the NRC cross- -" sections take into account the assymmetry in the +" sections take into account the asymmetry in the " positron-electron energy distribution. " [ pair_nrc ] " Photon cross sections= Photon cross-section data. Current options are -" si (Storm-Israel--the default), epdl (Evaluated Photon -" Data Library), xcom and pegs4. Allows the use of -" photon cross-sections other than from the PEGS4 file -" unless the pegs4 option is specified. +" si (Storm-Israel), epdl (Evaluated Photon Data +" Library), xcom (default), pegs4, mcdf-xcom and +" mcdf-epdl: +" Allows the use of photon cross-sections other than +" from the PEGS4 file (unless the pegs4 option is +" specified). Options mcdf-xcom and mcdf-epdl use +" Sabbatucci and Salvat's renormalized photoelectric +" cross sections with either xcom or epdl for all other +" cross sections. These are more accurate but can +" increase CPU time by up to 6 %. " Note that the user can supply their own cross-section " data as well. The requirement is that the files " photon_xsections_photo.data, @@ -1076,8 +1103,7 @@ REPLACE {$VERSION} WITH { " photon_xsections_triplet.data, and " photon_xsections_rayleigh.data exist in the " $HEN_HOUSE/data directory, where photon_xsections -" is the name specified. -" Hence this entry is case-sensitive. +" is the name specified. This entry is case-sensitive. " [ photon_xsections ] " Photon cross-sections output= Off (default) or On. If On, then " a file $EGS_HOME/user_code/inputfile.xsections is @@ -1092,26 +1118,13 @@ REPLACE {$VERSION} WITH { " (see below). The default file (ie in the absence " of any user-supplied data) is compton_sigma.data. " [ comp_xsections ] -" Photoelectron angular sampling= Off or On -" If Off, photo-electrons get the direction of the -" `mother' photon, with On, Sauter's furmula is -" used (which is, striktly speaking, valid only for -" K-shell photo-absorption). -" If the user has a better approach, replace the macro -" $SELECT-PHOTOELECTRON-DIRECTION; -" The only application that -" I encountered until now where this option made a -" small difference was a big ion chamber (cavity size -" comparable with electron range) with high-Z walls -" in a low energy photon beam. -" Default is On -" [ IPHTER ] -" Rayleigh scattering= Off, On, custom -" If On, turn on coherent (Rayleigh) scattering, -" even if no Rayleigh data in PEGS4 file. -" Default is Off. Should be turned on for low energy +" Rayleigh scattering= Off, On (default), custom +" If On, turns on coherent (Rayleigh) scattering. +" Default is On. Should be turned on for low energy " applications. If custom, user must provide media names -" and form factor files for each medium. +" and form factor files for each desired medium. The +" rest of the media use the default atomic form factors. +" A PEGS4 data set is not required anymore. " [ IRAYLR ] " ff media names = A list of media names (must match media found in " PEGS4 data file) for which the user is going to @@ -1126,28 +1139,63 @@ REPLACE {$VERSION} WITH { " example files, see the directory " $HEN_HOUSE/data/molecular_form_factors. " [ iray_ff_file($MXMED) ] -" Atomic relaxations= Off, On -" Default is On. The effect of using On is twofold: +" Photonuclear attenuation= Off (default) or On +" If On, models the photonuclear effect. Current +" implementation is crude. Available on a +" region-by-region basis (see below) +" [ IPHOTONUCR ] +" Photonuclear cross sections= Total photonuclear cross sections. User- +" supplied total photonuclear cross-sections in +" $HEN_HOUSE/data/photonuc_xsections_photonuc.data, +" where photonuc_xsections is the name supplied for +" this input (case sensitive). In the absence of +" any user-supplied data, or if photonuc_xsections +" is set to 'default', the default file is +" iaea_photonuc.data. +" [ photonuc_xsections ] +" Photoelectron angular sampling= Off or On (default) +" If Off, photo-electrons get the direction of the +" `mother' photon, with On, Sauter's formula is +" used (which is, strictly speaking, valid only for +" K-shell photo-absorption). +" If the user has a better approach, replace the macro +" $SELECT-PHOTOELECTRON-DIRECTION; +" The only application encountered where this option +" made a small difference was a big ion chamber +" (cavity size comparable with electron range) +" with high-Z walls in a low energy photon beam. +" [ IPHTER ] +" Atomic relaxations= Off, On, eadl (default), simple +" On defaults to eadl. +" When simulating atomic relaxations: " - In photo-electric absorption events, the element " (if material is mixture) and the shell the photon " is interacting with are sampled from the appropriate -" cross seections -" - Shell vacancies created in photo-absorption events +" cross sections +" - Shell vacancies created in photoelectric, +" compton and electron impact ionization events " are relaxed via emission of fluorescent X-Rays, " Auger and Koster-Cronig electrons. -" Make sure to turn this option on for low energy -" applications. -" [ IEDGFL ] -; -" Atomic relaxations, Rayleigh scattering, -" Photoelectron angular sampling and Bound Compton scattering -" can also be turned On/Off on a region-by-region -" basis. To do so, put e.g. +" The eadl option features a more accurate treatment +" of relaxation events and uses binding energies +" consistent with those in of the photon cross sections +" used in the simulation. If using mcdf-xcom or +" mcdf-epdl photon cross sections, you cannot use +" the simple option and this will automatically get +" reset to eadl. Make sure to use eadl or simple for +" low energy applications. +" [ IEDGFL ] +" +" Atomic relaxations, Rayleigh scattering, Photoelectron angular sampling, +" Bound Compton scattering and photonuclear effect +" can also be turned On/Off on a region-by-region basis. An example for +" Atomic relaxations on a region-by-region basis is: " " Atomic relaxations= On in Regions or " Atomic relaxations= Off in regions " -" in your input file. Then use +" Then define the regions in which you want +" the feature to be turned on: " " Bound Compton start region= " Bound Compton stop region= @@ -1160,17 +1208,22 @@ REPLACE {$VERSION} WITH { " or " PE sampling start region= " PE sampling stop region= +" or +" Photonuclear start region= +" Photonuclear stop region= " -" each followed by a lost of of one or more +" each followed by a list of one or more " start and stop regions separated by commas. " Example: +" " Atomic relaxations= On in Regions " Relaxations start region= 1, 40 " Relaxations stop region= 10, 99 +" " will first turn off relaxations everywhere and -" then turn off in regions 1-10 and 40-99. -" Note that input is checked against min. and max. -" region number and ignored if +" then turn on in regions 1-10 and 40-99. +" Note that the input is checked against minimum +" and maximum region numbers and ignored if " start region < 1 or stop_region > $MXREG or " start region > stop region. "