From 7b041114209c6073793ad8c33d87db7e07afda6b Mon Sep 17 00:00:00 2001 From: yardasol Date: Thu, 14 Jul 2022 14:23:11 -0500 Subject: [PATCH] add small blurb about OpenMCOperator; move TalliedFissionYieldHelper to different section --- docs/source/pythonapi/deplete.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/source/pythonapi/deplete.rst b/docs/source/pythonapi/deplete.rst index 11062cd87..d09a665d8 100644 --- a/docs/source/pythonapi/deplete.rst +++ b/docs/source/pythonapi/deplete.rst @@ -188,6 +188,7 @@ total system energy. helpers.EnergyScoreHelper helpers.FissionYieldCutoffHelper helpers.FluxCollapseHelper + helpers.TalliedFissionYieldHelper Abstract Base Classes --------------------- @@ -204,7 +205,16 @@ prior to depleting materials :template: mycallable.rst abc.TransportOperator - openmc_operator.OpenMCOperator + +Methods common to OpenMC-specific implementations are stored in :class:`openmc_operator.OpenMCOperator` + +.. autosummary:: + :toctree: generated + :nosignatures: + :template: mycallable.rst + + abc.TransportOperator + The following classes are abstract classes used to pass information from OpenMC simulations back on to the :class:`abc.TransportOperator` @@ -217,7 +227,6 @@ OpenMC simulations back on to the :class:`abc.TransportOperator` abc.NormalizationHelper abc.FissionYieldHelper abc.ReactionRateHelper - helpers.TalliedFissionYieldHelper Custom integrators or depletion solvers can be developed by subclassing from the following abstract base classes: