crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-24 20:15:26 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Document concrete and abstract depletion solvers

Browse source
This commit is contained in:
Andrew Johnson 2019-09-19 16:51:38 -05:00
parent 07d3207d88
commit df387e87dc
No known key found for this signature in database
GPG key ID: 253418E91B7F6FEB
1 changed files with 16 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -139,6 +139,18 @@ The following functions are used to solve the depletion equations, with
cram.deplete
cram.timed_deplete
:func:`cram.CRAM16` and :func:`cram.CRAM48` are aliases to the ``__call__``
methods for the following classes
.. autosummary::
:toctree: generated
:nosignatures:
:template: mycallable.rst
cram.Cram16Solver
cram.Cram48Solver
The following classes are used to help the :class:`openmc.deplete.Operator`
compute quantities like effective fission yields, reaction rates, and
total system energy.
@ -185,8 +197,8 @@ OpenMC simulations back on to the :class:`abc.TransportOperator`
abc.ReactionRateHelper
abc.TalliedFissionYieldHelper
Custom integrators can be developed by subclassing from the following abstract
base classes:
Custom integrators or depletion solvers can be developed by subclassing from
the following abstract base classes:
.. autosummary::
:toctree: generated
@ -195,3 +207,5 @@ base classes:
abc.Integrator
abc.SIIntegrator
abc.DepSystemSolver
abc.IPFCramSolver