Skip to content

Commit 65e19c1

Browse files
GuyStenpaulromano
andauthored
Fix settings io_format documentation. (#3718)
Co-authored-by: Paul Romano <paul.k.romano@gmail.com>
1 parent 84a413b commit 65e19c1

File tree

1 file changed

+65
-1
lines changed

1 file changed

+65
-1
lines changed

docs/source/io_formats/settings.rst

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,15 @@ ignored for all run modes other than "eigenvalue".
277277

278278
*Default*: 1
279279

280+
------------------------------
281+
``<ifp_n_generation>`` Element
282+
------------------------------
283+
284+
The ``<ifp_n_generation>`` element indicates the number of generations to
285+
consider for the Iterated Fission Probability method.
286+
287+
*Default*: 10
288+
280289
----------------------
281290
``<inactive>`` Element
282291
----------------------
@@ -402,7 +411,25 @@ then, OpenMC will only use up to the :math:`P_1` data.
402411
``<max_history_splits>`` Element
403412
--------------------------------
404413

405-
The ``<max_history_splits>`` element indicates the number of times a particle can split during a history.
414+
The ``<max_history_splits>`` element indicates the number of times a particle
415+
can split during a history.
416+
417+
*Default*: 1000
418+
419+
-----------------------------
420+
``<max_secondaries>`` Element
421+
-----------------------------
422+
423+
The ``<max_secondaries>`` element indicates the maximum secondary bank size.
424+
425+
*Default*: 10000
426+
427+
------------------------
428+
``<max_tracks>`` Element
429+
------------------------
430+
431+
The ``<max_tracks>`` element indicates the maximum number of tracks written to a
432+
track file (per MPI process).
406433

407434
*Default*: 1000
408435

@@ -1378,6 +1405,15 @@ has the following attributes/sub-elements:
13781405
for fixed source and small criticality calculations, but is very
13791406
optimistic for highly coupled full-core reactor problems.
13801407

1408+
-------------------------------------
1409+
``<uniform_source_sampling>`` Element
1410+
-------------------------------------
1411+
1412+
The ``<uniform_source_sampling>`` element indicates whether to sample among
1413+
multiple sources uniformly, applying their strengths as weights to sampled
1414+
particles.
1415+
1416+
*Default*: False
13811417

13821418
------------------------
13831419
``<ufs_mesh>`` Element
@@ -1390,6 +1426,16 @@ Agency Monte Carlo Performance Benchmark Problem," Proceedings of *Physor 2012*,
13901426
Knoxville, TN (2012). The mesh should cover all possible fissionable materials
13911427
in the problem and is specified using a :ref:`mesh_element`.
13921428

1429+
-------------------------------
1430+
``<use_decay_photons>`` Element
1431+
-------------------------------
1432+
1433+
The ``<use_decay_photons>`` element indicates whether to produce decay photons
1434+
from neutron reactions instead of prompt photons. This is used in conjunction
1435+
with the direct 1-step method for shutdown dose rate calculations.
1436+
1437+
*Default*: False
1438+
13931439
.. _verbosity:
13941440

13951441
-----------------------
@@ -1620,3 +1666,21 @@ following sub-elements/attributes:
16201666

16211667
The ``weight_windows_file`` element has no attributes and contains the path to
16221668
a weight windows HDF5 file to load during simulation initialization.
1669+
1670+
-------------------------------
1671+
``<weight_windows_on>`` Element
1672+
-------------------------------
1673+
1674+
The ``weight_windows_on`` element indicates whether weight windows are
1675+
enabled.
1676+
1677+
*Default*: False
1678+
1679+
----------------------------------
1680+
``<write_initial_source>`` Element
1681+
----------------------------------
1682+
1683+
The ``write_initial_source`` element indicates whether to write the initial
1684+
source distribution to file.
1685+
1686+
*Default*: False

0 commit comments

Comments
 (0)