crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-25 12:35:29 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Add documentation of chain.REACTIONS module variable

Browse source
This commit is contained in:
Paul Romano 2020-07-29 06:41:10 -05:00
parent 5b84c940f7
commit 3d35cd3f0f
2 changed files with 13 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/source/pythonapi/deplete.rst
View file

@ -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.