Skip to content

Allow zero bins in tally triggers #2928

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paulromano merged 14 commits into from
May 2, 2024
Merged

Allow zero bins in tally triggers #2928

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
cc9e960
Add allow_zero option to Triggers
tjlaboss Mar 17, 2024
932f016
Add 'allow_zero' functionality to Trigger in Python API
tjlaboss Mar 18, 2024
44c2d7c
Test tally trigger with zeros allowed
tjlaboss Mar 19, 2024
65490e7
Ignore tallies with no contributions upon request.
tjlaboss Mar 19, 2024
29b0782
Do not check tally triggers until one active interval has run.
tjlaboss Mar 19, 2024
b629b6e
Run clang-format
tjlaboss Mar 19, 2024
4663858
Document tally trigger allow_zero
tjlaboss Mar 19, 2024
d388ec5
Make more similar to bools in settings.py
tjlaboss Mar 28, 2024
c407954
Needs more paticles with NNDC data?
tjlaboss Mar 28, 2024
96a96c6
Add ".. versionadded:: 0.14.1" to Trigger docstring
tjlaboss Apr 11, 2024
f821d7e
Revert "Do not check tally triggers until one active interval has run."
tjlaboss Apr 30, 2024
5adb9e1
Rename 'allow_zero' -> 'ignore_zeros'
tjlaboss Apr 30, 2024
41fb799
Add documentation informing the user of a possible pitfall
tjlaboss Apr 30, 2024
cc6498f
Small fixes
paulromano May 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add documentation informing the user of a possible pitfall
  • Loading branch information
@tjlaboss
tjlaboss committed Apr 30, 2024
commit 41fb79966c8574725ce5a16946d960d4129cf29c
5 changes: 5 additions & 0 deletions docs/source/io_formats/tallies.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,11 @@ The ``<tally>`` element accepts the following sub-elements:
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:
Expand Down
4 changes: 3 additions & 1 deletion openmc/trigger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ class Trigger(EqualityMixin):
threshold : float
The threshold for the trigger type.
ignore_zeros : bool
Whether to allow zero tally bins to be ignored.
Whether to allow zero tally bins to be ignored. Note that this option
can cause the trigger to fire prematurely if there are zero scores in
any bin at the first evaluation.

.. versionadded:: 0.14.1

Expand Down