crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-23 19:45:34 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

move intermediate classes to their own section in the api docs

Browse source
This commit is contained in:
yardasol 2022-07-14 15:14:35 -05:00
parent 7b04111420
commit 80fbcdcdf3
1 changed files with 28 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

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

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