From fb5597a88f453ed5726033e4f12edb8432717b24 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Fri, 20 May 2022 12:59:50 -0500 Subject: [PATCH] Mention multiple track files when run with MPI in documentation --- docs/source/usersguide/scripts.rst | 4 +++- docs/source/usersguide/settings.rst | 10 ++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/source/usersguide/scripts.rst b/docs/source/usersguide/scripts.rst index f38e1fd168..50d51a5b38 100644 --- a/docs/source/usersguide/scripts.rst +++ b/docs/source/usersguide/scripts.rst @@ -112,7 +112,7 @@ otherwise. tallies. The path to the statepoint file can be provided as an optional arugment (if omitted, a file dialog will be presented). -.. _scripts_track: +.. _scripts_track_combine: ------------------------ ``openmc-track-combine`` @@ -125,6 +125,8 @@ filename can also be changed with the ``-o`` flag: -o OUT, --out OUT Output HDF5 particle track file +.. _scripts_track: + ----------------------- ``openmc-track-to-vtk`` ----------------------- diff --git a/docs/source/usersguide/settings.rst b/docs/source/usersguide/settings.rst index 9802a93e3f..db06d8a0eb 100644 --- a/docs/source/usersguide/settings.rst +++ b/docs/source/usersguide/settings.rst @@ -589,3 +589,13 @@ The full list of fields is as follows: :wgt: Weight :cell_id: Cell ID :material_id: Material ID + +.. note:: If you are using an MPI-enabled install of OpenMC and run a simulation + with more than one process, a separate track file will be written for + each MPI process with the filename ``tracks_p#.h5`` where # is the + rank of the corresponding process. Multiple track files can be + combined with the :ref:`scripts_track_combine` script: + + .. code-block:: sh + + openmc-track-combine tracks_p*.h5 --out tracks.h5