From 80fbcdcdf380e583c346d140f0fa8724b526cfa9 Mon Sep 17 00:00:00 2001 From: yardasol Date: Thu, 14 Jul 2022 15:14:35 -0500 Subject: [PATCH] move intermediate classes to their own section in the api docs --- docs/source/pythonapi/deplete.rst | 38 +++++++++++++++++++++++-------- 1 file changed, 28 insertions(+), 10 deletions(-) diff --git a/docs/source/pythonapi/deplete.rst b/docs/source/pythonapi/deplete.rst index d09a665d8..e275f38f2 100644 --- a/docs/source/pythonapi/deplete.rst +++ b/docs/source/pythonapi/deplete.rst @@ -188,8 +188,36 @@ total system energy. helpers.EnergyScoreHelper helpers.FissionYieldCutoffHelper helpers.FluxCollapseHelper + + +Intermediate Classes +-------------------- + +Specific implementations of abstract base classes may utilize some of +the same methods and data structures. These methods and data are stored +in intermediate classes. + +Methods common to tally-based implementation of :class:`FissionYieldHelper` +are stored in :class:`helpers.TalliedFissionYieldHelper` + +.. autosummary:: + :toctree: generated + :nosignatures: + :template: myclass.rst + helpers.TalliedFissionYieldHelper +Methods common to OpenMC-specific implementations of :class:`TransportOperator` +are stored in :class:`openmc_operator.OpenMCOperator` + +.. autosummary:: + :toctree: generated + :nosignatures: + :template: mycallable.rst + + openmc_operator.OpenMCOperator + + Abstract Base Classes --------------------- @@ -206,16 +234,6 @@ prior to depleting materials abc.TransportOperator -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`