From 3d35cd3f0ffb6f6b99a133b17072a4ce28d18429 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Wed, 29 Jul 2020 06:41:10 -0500 Subject: [PATCH] Add documentation of chain.REACTIONS module variable --- docs/source/pythonapi/deplete.rst | 10 ++++++++++ openmc/deplete/chain.py | 5 +++-- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/source/pythonapi/deplete.rst b/docs/source/pythonapi/deplete.rst index 27f3efe39..f74c4524a 100644 --- a/docs/source/pythonapi/deplete.rst +++ b/docs/source/pythonapi/deplete.rst @@ -112,6 +112,16 @@ for a depletion chain: FissionYieldDistribution FissionYield +The :class:`Chain` class uses information from the following module variable: + +.. data:: chain.REACTIONS + + Dictionary that maps transmutation reaction names to information needed when + a chain is being generated: MT values, the change in atomic/mass numbers + resulting from the reaction, and what secondaries are produced. + + :type: dict + The following classes are used during a depletion simulation and store auxiliary data, such as number densities and reaction rates for each material. diff --git a/openmc/deplete/chain.py b/openmc/deplete/chain.py index e0c84a118..8293273d4 100644 --- a/openmc/deplete/chain.py +++ b/openmc/deplete/chain.py @@ -124,7 +124,7 @@ REACTIONS = { '(n,5n2p)': ReactionInfo({200}, (-6, -2), ('H1', 'H1')), } -__all__ = ["Chain"] +__all__ = ["Chain", "REACTIONS"] def replace_missing(product, decay_data): @@ -307,7 +307,8 @@ class Chain: reactions : iterable of str, optional Transmutation reactions to include in the depletion chain, e.g., `["(n,2n)", "(n,gamma)"]`. Note that fission is always included if - it is present. + it is present. A complete listing of transmutation reactions can be + found in :data:`openmc.deplete.chain.REACTIONS`. progress : bool, optional Flag to print status messages during processing. Does not effect warning messages