Skip to content

Fix IO format documentation for surf_source_read/write #2048

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paulromano merged 1 commit into from
May 2, 2022
Merged

Fix IO format documentation for surf_source_read/write #2048

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Fix IO format documentation for surf_source_read/write
  • Loading branch information
@paulromano
paulromano committed Apr 29, 2022
commit f8f788352f51b4d454792b4610eee209bc87de9a
23 changes: 11 additions & 12 deletions docs/source/io_formats/settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down