diff --git a/docs/source/io_formats/settings.rst b/docs/source/io_formats/settings.rst index 588b58b478..47985938ba 100644 --- a/docs/source/io_formats/settings.rst +++ b/docs/source/io_formats/settings.rst @@ -723,6 +723,42 @@ attributes/sub-elements: *Default*: false +--------------------------- +```` Element +--------------------------- + +The ```` element specifies a surface source file for OpenMC to +read source bank for initializing batches. +This element has the following attributes/sub-elements: + + :path: + Absolute or relative path to a surface source file to read in source bank. + + *Default*: ``surface_source.h5`` in current working directory + +---------------------------- +```` Element +---------------------------- + +The ```` element triggers OpenMC to bank particles crossing +certain surfaces and write out the source bank in a separate file called +``surface_source.h5``. +This element has the following attributes/sub-elements: + + :surf_ids: + A list of integers separated by spaces indicating the unique IDs of surfaces + for which crossing particles will be banked. + + *Default*: None + + :max_surf_banks: + An integer indicating the maximum number of particles to be banked on + specified surfaces per processor. The size of source bank in + ``surface_source.h5`` is limited to this value times the number of + processors. + + *Default*: None + ------------------------------ ```` Element ------------------------------