Skip to content

Commit 0f7f7d5

Browse files
committed
Adding note on use of nuclide list and consequences for electron/positron interactions
1 parent 7e65a1e commit 0f7f7d5

2 files changed

Lines changed: 11 additions & 0 deletions

File tree

docs/source/io_formats/settings.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,11 @@ sub-elements:
9898
A list of strings representing the nuclide, to define specific
9999
define specific target nuclide collisions to be banked.
100100

101+
.. note::
102+
Electron and positron collision-track events are not associated with a
103+
specific nuclide. If a ``nuclides`` filter is specified, these events
104+
do not match the filter and are omitted.
105+
101106
*Default*: None
102107

103108
:reactions:

docs/source/usersguide/settings.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -792,6 +792,12 @@ collision_track.h5 file at the end of the simulation. The file contains
792792
300 recorded collisions that occurred in materials with IDs 1 or 2, involving
793793
fission or (n,2n) reactions on the nuclides U-238 or O-16, within cells
794794
with IDs 5 and 12.
795+
796+
.. note::
797+
Electron and positron collision-track events are not associated with a
798+
specific nuclide. If a ``nuclides`` filter is specified, these events do not
799+
match the filter and are omitted.
800+
795801
The file can be read using :func:`openmc.read_collision_track_file`.
796802
The example below shows how to extract the data from the collision_track
797803
feature and displays the fields stored in the file:

0 commit comments

Comments
 (0)