From 9cbbc6e6b9ab405c473c3c6b756dafab76485222 Mon Sep 17 00:00:00 2001 From: Andrew Johnson Date: Fri, 5 Jul 2019 13:37:12 -0500 Subject: [PATCH] Document abstract and concrete operator helpers --- docs/source/pythonapi/deplete.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/source/pythonapi/deplete.rst b/docs/source/pythonapi/deplete.rst index 532e06655..091b25da7 100644 --- a/docs/source/pythonapi/deplete.rst +++ b/docs/source/pythonapi/deplete.rst @@ -75,10 +75,24 @@ data, such as number densities and reaction rates for each material. :template: myclass.rst AtomNumber + ChainFissHelper + DirectRxnRateHelper OperatorResult ReactionRates Results ResultsList + + +The following classes are abstract classes that can be used to extend the +:mod:`openmc.deplete` capabilities: + +.. autosummary:: + :toctree:generated + :nosignatures: + :template: myclass.rst + + ReactionRateHelper + FissionEnergyHelper TransportOperator Each of the integrator functions also relies on a number of "helper" functions