OpenMC/docs/source/pythonapi
Andrew Johnson d28546bcd6
Add SI_Integrator, SI_CELI_Integrator classes; remove si_celi
The si_celi depletion function has been removed. The
SI-CELI method can be implemented with
    >>> from openmc.deplete import SI_CELI_Integrator
    >>> SI_CELI_Integrator(op, dt, power, stages).integrate()

The stages parameter is optional, and defaults to 10 to
be consistent with the previous default for si_celi.

The SI_CELI_Integrator inherits from the new abstract base class
SI_Integrator. There are a few differences in how the SI-based
methods perform the integration.

- The initial, t=0.0, i=0, no restart transport solution is scaled
  by the number of stages.
- The SI methods also do not perform a new transport solution at
  each successive iteration [t>0, i>0]. Instead, the reaction
  rates are pulled from the last stage of the previous step.
- There is no final transport solution once all the depletion
  steps have been taken. The final reaction rates are saved as
  those from the last stage of the last depletion step.

The si_celi function has been removed from documentation and testing,
and replaced with the SI_CELI_Integrator.
2019-07-26 16:58:51 -05:00
..
base.rst Change Python Mesh class to RegularMesh 2019-06-07 08:51:09 -04:00
capi.rst Fix name of capi.RegularMesh in documentation 2019-06-14 12:13:34 -05:00
data.rst Respond to @nelsonag comments on #1271 2019-07-01 07:09:10 -05:00
deplete.rst Add SI_Integrator, SI_CELI_Integrator classes; remove si_celi 2019-07-26 16:58:51 -05:00
examples.rst Respond to @wbinventor comments on #852 2017-04-10 07:16:17 -05:00
index.rst Improve display of Python API in generated HTML documentation 2019-06-14 14:35:39 -05:00
mgxs.rst Get GROUP_STRUCTURES to show up in documentation 2018-11-07 07:36:08 -06:00
model.rst Remove get_ from get_hexagonal_prism, get_rectangular_prism 2019-06-18 06:17:54 -05:00
openmoc.rst Respond to comments on #850 2017-04-05 11:13:21 -05:00
stats.rst Missing one review comment, and followed style for generic normal distribution from uniform distribuion 2018-12-13 15:37:47 +00:00