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

Improve documentation for FissionYieldHelpers

Browse source 
Add a separate section in the documentation describing
the helpers.

Reword purpose of mat_indexes in generate_tallies
This commit is contained in:
Andrew Johnson 2019-08-14 18:02:27 -05:00
parent 454e6cc6b6
commit aa86aa5262
No known key found for this signature in database
GPG key ID: 253418E91B7F6FEB
5 changed files with 44 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -77,16 +77,25 @@ data, such as number densities and reaction rates for each material.
:template: myclass.rst
AtomNumber
AveragedFissionYieldHelper
ChainFissionHelper
ConstantFissionYieldHelper
DirectReactionRateHelper
FissionYieldCutoffHelper
OperatorResult
ReactionRates
Results
ResultsList
The following classes are used to help the :class:`openmc.deplete.Operator`
compute quantities like effective fission yields, reaction rates, and
total system energy.
.. autosummary::
:toctree: generated
:nosignatures:
:template: myclass.rst
helpers.AveragedFissionYieldHelper
helpers.ChainFissionHelper
helpers.ConstantFissionYieldHelper
helpers.DirectReactionRateHelper
helpers.FissionYieldCutoffHelper
The following classes are abstract classes that can be used to extend the
:mod:`openmc.deplete` capabilities: