crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-26 21:25:36 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix IO format documentation for surf_source_read/write

Browse source
This commit is contained in:
Paul Romano 2022-04-29 06:48:55 -05:00
parent 9395c656dc
commit f8f788352f
1 changed files with 11 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/source/io_formats/settings.rst
View file

@ -731,27 +731,26 @@ attributes/sub-elements:
*Default*: false
---------------------------
``<surf_src_read>`` Element
---------------------------
------------------------------
``<surf_source_read>`` Element
------------------------------
The ``<surf_src_read>`` element specifies a surface source file for OpenMC to
read source bank for initializing histories.
This element has the following attributes/sub-elements:
The ``<surf_source_read>`` element specifies a surface source file for OpenMC to
read source bank for initializing histories. 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
----------------------------
``<surf_src_write>`` Element
----------------------------
-------------------------------
``<surf_source_write>`` Element
-------------------------------
The ``<surf_src_write>`` element triggers OpenMC to bank particles crossing
The ``<surf_source_write>`` 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:
``surface_source.h5``. This element has the following attributes/sub-elements:
:surface_ids:
A list of integers separated by spaces indicating the unique IDs of surfaces