Remove cecm function for deplete.CECMIntegrator

The cecm function has been removed from the python api.
In order to use the cecm integration scheme,
the following class based approach is now expected:

>>> from openmc.deplete import CECMIntegrator
>>> cecm = CECMIntegrator(operator, timesteps, power)
>>> cecm.integrate()

if the integrator is not needed, this above expression can be
one-lined with

>>> CECMIntegrator(operator, timesteps, power).integrate()

Unit tests have been updated to no longer use the cecm function,
and cecm has been removed from documentation.
The CECMIntegrator has been added to documentation.
This commit is contained in:
Andrew Johnson 2019-07-16 11:04:50 -05:00
parent cd444510cf
commit f432be0c05
No known key found for this signature in database
GPG key ID: 253418E91B7F6FEB
6 changed files with 22 additions and 28 deletions

View file

@ -17,7 +17,6 @@ transport-depletion coupling algorithms <http://hdl.handle.net/1721.1/113721>`_.
:template: myfunction.rst
integrator.predictor
integrator.cecm
integrator.celi
integrator.leqi
integrator.cf4
@ -25,6 +24,13 @@ transport-depletion coupling algorithms <http://hdl.handle.net/1721.1/113721>`_.
integrator.si_celi
integrator.si_leqi
.. autosummary::
:toctree: generated
:nosignatures:
:template: myclassinherit.rst
integrator.CECMIntegrator
Each of these functions expects a "transport operator" to be passed. An operator
specific to OpenMC is available using the following class: