Skip to content

Commit bb642a7

Browse files
authored
Merge pull request #2048 from paulromano/surfsrc-docfix
Fix IO format documentation for surf_source_read/write
2 parents 6a8a870 + f8f7883 commit bb642a7

1 file changed

Lines changed: 11 additions & 12 deletions

File tree

‎docs/source/io_formats/settings.rst‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -731,27 +731,26 @@ attributes/sub-elements:
731731

732732
*Default*: false
733733

734-
---------------------------
735-
``<surf_src_read>`` Element
736-
---------------------------
734+
------------------------------
735+
``<surf_source_read>`` Element
736+
------------------------------
737737

738-
The ``<surf_src_read>`` element specifies a surface source file for OpenMC to
739-
read source bank for initializing histories.
740-
This element has the following attributes/sub-elements:
738+
The ``<surf_source_read>`` element specifies a surface source file for OpenMC to
739+
read source bank for initializing histories. This element has the following
740+
attributes/sub-elements:
741741

742742
:path:
743743
Absolute or relative path to a surface source file to read in source bank.
744744

745745
*Default*: ``surface_source.h5`` in current working directory
746746

747-
----------------------------
748-
``<surf_src_write>`` Element
749-
----------------------------
747+
-------------------------------
748+
``<surf_source_write>`` Element
749+
-------------------------------
750750

751-
The ``<surf_src_write>`` element triggers OpenMC to bank particles crossing
751+
The ``<surf_source_write>`` element triggers OpenMC to bank particles crossing
752752
certain surfaces and write out the source bank in a separate file called
753-
``surface_source.h5``.
754-
This element has the following attributes/sub-elements:
753+
``surface_source.h5``. This element has the following attributes/sub-elements:
755754

756755
:surface_ids:
757756
A list of integers separated by spaces indicating the unique IDs of surfaces

0 commit comments

Comments
 (0)