Fix #768: inconsistent documentation for BEAM_SIZE

nrc-cnrc · Sep 5, 2024 · f74802f · f74802f
1 parent 7ff00b0
commit f74802f
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 11 deletions.
diff --git a/HEN_HOUSE/doc/src/pirs794-dosxyznrc/inputs/dosxyznrc.inp b/HEN_HOUSE/doc/src/pirs794-dosxyznrc/inputs/dosxyznrc.inp
@@ -855,9 +855,12 @@ Record SC1-20a and SC1-21a (required for sources 20 and 21)
                       generator, INSEED1 is the luxury level and should
                       have a value >0 and <=4.  Otherwise, a default
                       luxury level of 1 will be used.
-            BEAM_SIZE Beam size for a square field for the dose calculation
-                      This parameter is only used by sources 2,3 and 4
-                      (default to 100 cm for a 100x100 cm square field)
+            BEAM_SIZE Size of maximum square beam field for the dose
+                      calculation.  This parameter is only used by phase
+                      space sources (sources 2, 8, 20), BEAM simulation
+                      sources (sources 9, 10, 21) and the beam model source
+                      (source 4).
+                      (Defaults to 100 cm for a 100x100 cm square field)
             ISMOOTH   =1 re-distribute particles when re-start a ph-sp file
                        and/or recycle an individual particle
                       =0 re-use the ph-sp data once run out (no redistribution)

diff --git a/HEN_HOUSE/doc/src/pirs794-dosxyznrc/pirs794-dosxyznrc.tex b/HEN_HOUSE/doc/src/pirs794-dosxyznrc/pirs794-dosxyznrc.tex
@@ -1563,7 +1563,7 @@ \subsection{isource = 9: BEAM Treatment Head Simulation Incident from Any
 Similar to {\tt isource = 2}, you can select particles from the BEAM simulation
 \indexm{LATCH}
 to use based on their charge and/or {\tt LATCH} values.   You can also
-select the size of the BEAM field considered using the
+select the maximum size of the BEAM field considered using the
 \indexm{BEAM\_SIZE}
 {\tt BEAM\_SIZE} input (discussed in more detail in its own section below).
 
@@ -2985,10 +2985,11 @@ \subsection{{\tt INSEED1, INSEED2}}
 \subsection{{\tt BEAM\_SIZE}}
 \indexm{BEAM\_SIZE}
 
-{\tt BEAM\_SIZE} allows user control of incident beam size for sources 2 and
-8 (phase-space input), 9 and 10 (full BEAM simulation sources) and 4
-(beam model source). {\tt BEAM\_SIZE} is the side of a square field in cm. The default value for {\tt BEAM\_SIZE} is 100 cm. When phase-space particles are read from a
-data file or reconstructed by a multiple-source model, DOSXYZnrc will check their positions and discard those that fall outside of the specified field.
+{\tt BEAM\_SIZE} allows the user to control the maximum beam size for phase space sources (sources 2,
+8, 20), BEAM simulations sources (souces 9, 10, 21) and the beam model source (source 4).
+{\tt BEAM\_SIZE} is the side of a square field in cm. The default value for {\tt BEAM\_SIZE} is 100 cm.
+Particles are discarded immediately if they are outside the
+square defined by {\tt BEAM\_SIZE} centred on the beam axis in the source scoring plane.
 
 One should be careful with the use of this parameter because particles outside
 the specified field (defined by {\tt BEAM\_SIZE)} may have some effects on the dose

diff --git a/HEN_HOUSE/user_codes/dosxyznrc/dosxyznrc.mortran b/HEN_HOUSE/user_codes/dosxyznrc/dosxyznrc.mortran
@@ -304,9 +304,12 @@
 "                      generator, INSEED1 is the luxury level and should
 "                      have a value >0 and <=4.  Otherwise, a default
 "                      luxury level of 1 will be used.
-"            BEAM_SIZE Beam size for a square field for the dose calculation
-"                      This parameter is only used by sources 2,3 and 4
-"                      (default to 100 cm for a 100x100 cm square field)
+"            BEAM_SIZE Size of maximum square beam field for the dose
+"                      calculation.  This parameter is only used by phase
+"                      space sources (sources 2, 8, 20), BEAM simulation
+"                      sources (sources 9, 10, 21) and the beam model source
+"                      (source 4).
+"                      (Defaults to 100 cm for a 100x100 cm square field)
 "            ISMOOTH   =1 re-distribute particles when re-start a ph-sp file
 "                       and/or recycle an individual particle
 "                      =0 re-use the ph-sp data once run out (no redistribution)