Allow zero bins in tally triggers (#2928)

Co-authored-by: Paul Romano <paul.k.romano@gmail.com>
This commit is contained in:
Travis L 2024-05-02 10:00:22 -04:00 committed by GitHub
parent d1366c0545
commit c976653abf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 90 additions and 7 deletions

View file

@ -100,6 +100,18 @@ The ``<tally>`` element accepts the following sub-elements:
*Default*: None
:ignore_zeros:
Whether to allow zero tally bins to be ignored when assessing the
convergece of the precision trigger. If True, only nonzero tally scores
will be compared to the trigger's threshold.
.. note:: The ``ignore_zeros`` option can cause the tally trigger to fire
prematurely if there are no hits in any bins at the first
evalulation. It is the user's responsibility to specify enough
particles per batch to get a nonzero score in at least one bin.
*Default*: False
:scores:
The score(s) in this tally to which the trigger should be applied.