mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-27 21:55:41 -04:00
Add documentation of chain.REACTIONS module variable
This commit is contained in:
parent
5b84c940f7
commit
3d35cd3f0f
2 changed files with 13 additions and 2 deletions
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue