2018-02-19 22:51:53 -06:00
|
|
|
.. _pythonapi_deplete:
|
|
|
|
|
|
|
|
|
|
----------------------------------
|
|
|
|
|
:mod:`openmc.deplete` -- Depletion
|
|
|
|
|
----------------------------------
|
|
|
|
|
|
2018-02-20 14:43:26 -06:00
|
|
|
.. module:: openmc.deplete
|
|
|
|
|
|
|
|
|
|
Two functions are provided that implement different time-integration algorithms
|
|
|
|
|
for depletion calculations.
|
2018-02-19 22:51:53 -06:00
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: generated
|
|
|
|
|
:nosignatures:
|
|
|
|
|
:template: myfunction.rst
|
|
|
|
|
|
2018-02-20 14:43:26 -06:00
|
|
|
integrator.predictor
|
|
|
|
|
integrator.cecm
|
2018-02-19 22:51:53 -06:00
|
|
|
|
2018-02-20 14:43:26 -06:00
|
|
|
Each of these functions expects a "transport operator" to be passed. An operator
|
|
|
|
|
specific to OpenMC is available using the following class:
|
2018-02-19 22:51:53 -06:00
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: generated
|
|
|
|
|
:nosignatures:
|
2018-02-20 14:43:26 -06:00
|
|
|
:template: myclass.rst
|
|
|
|
|
|
|
|
|
|
Operator
|
2018-02-19 22:51:53 -06:00
|
|
|
|
2018-02-27 07:22:27 -06:00
|
|
|
When running in parallel using `mpi4py <http://mpi4py.scipy.org>`_, the MPI
|
|
|
|
|
intercommunicator used can be changed by modifying the following module
|
|
|
|
|
variable. If it is not explicitly modified, it defaults to
|
|
|
|
|
``mpi4py.MPI.COMM_WORLD``.
|
|
|
|
|
|
|
|
|
|
.. data:: comm
|
|
|
|
|
|
|
|
|
|
MPI intercommunicator used to call OpenMC library
|
|
|
|
|
|
|
|
|
|
:type: mpi4py.MPI.Comm
|
|
|
|
|
|
2018-02-20 14:43:26 -06:00
|
|
|
Internal Classes and Functions
|
|
|
|
|
------------------------------
|
2018-02-19 22:51:53 -06:00
|
|
|
|
2018-02-20 14:43:26 -06:00
|
|
|
During a depletion calculation, the depletion chain, reaction rates, and number
|
|
|
|
|
densities are managed through a series of internal classes that are not normally
|
|
|
|
|
visible to a user. However, should you find yourself wondering about these
|
|
|
|
|
classes (e.g., if you want to know what decay modes or reactions are present in
|
|
|
|
|
a depletion chain), they are documented here. The following classes store data
|
|
|
|
|
for a depletion chain:
|
2018-02-19 22:51:53 -06:00
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: generated
|
|
|
|
|
:nosignatures:
|
|
|
|
|
:template: myclass.rst
|
|
|
|
|
|
2018-02-20 14:43:26 -06:00
|
|
|
Chain
|
|
|
|
|
DecayTuple
|
|
|
|
|
Nuclide
|
|
|
|
|
ReactionTuple
|
2018-02-19 22:51:53 -06:00
|
|
|
|
2018-02-20 14:43:26 -06:00
|
|
|
The following classes are used during a depletion simulation and store auxiliary
|
|
|
|
|
data, such as number densities and reaction rates for each material.
|
2018-02-19 22:51:53 -06:00
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: generated
|
|
|
|
|
:nosignatures:
|
|
|
|
|
:template: myclass.rst
|
|
|
|
|
|
2018-02-20 14:43:26 -06:00
|
|
|
AtomNumber
|
|
|
|
|
OperatorResult
|
|
|
|
|
ReactionRates
|
|
|
|
|
Results
|
2018-02-21 15:36:27 -06:00
|
|
|
ResultsList
|
2018-02-20 14:43:26 -06:00
|
|
|
TransportOperator
|
|
|
|
|
|
|
|
|
|
Each of the integrator functions also relies on a number of "helper" functions
|
|
|
|
|
as follows:
|
2018-02-19 22:51:53 -06:00
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: generated
|
|
|
|
|
:nosignatures:
|
2018-02-20 14:43:26 -06:00
|
|
|
:template: myfunction.rst
|
2018-02-19 22:51:53 -06:00
|
|
|
|
2018-02-20 14:43:26 -06:00
|
|
|
integrator.CRAM16
|
|
|
|
|
integrator.CRAM48
|
