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

TransportOperator->DepletionOperator

Browse source
This commit is contained in:
yardasol 2022-07-30 18:37:51 -05:00
parent 467ae6b9fb
commit 3e81a86915
10 changed files with 70 additions and 65 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -12,20 +12,20 @@ Primary API
The two primary requirements to perform depletion with :mod:`openmc.deplete`
are:
1) A reaction rate operator
1) A depletion operator
2) A time-integration scheme
The former is responsible for obtaining transmuation reaction rates. The latter
is responsible for projecting reaction rates and compositions forward in
calendar time across some step size :math:`\Delta t`, and obtaining new
compositions given a power or power density. The :class:`CoupledOperator` class
is provided to obtain reaction rates via tallies through OpenMC's transport
solver, and the :class:`IndependentOperator` class is provided to obtain
reaction rates from cross-section data. Several classes are provided that
implement different time-integration algorithms for depletion calculations,
which are described in detail in Colin Josey's thesis, `Development and
analysis of high order neutron transport-depletion coupling algorithms
<http://hdl.handle.net/1721.1/113721>`_.
The former is responsible for calcuating retaining important information required for depletion. The most common examples are reaction rates and power
normalization data. The latter is responsible for projecting reaction rates and
compositions forward in calendar time across some step size :math:`\Delta t`,
and obtaining new compositions given a power or power density. The
:class:`CoupledOperator` class is provided to obtain reaction rates via tallies
through OpenMC's transport solver, and the :class:`IndependentOperator` class is
provided to obtain reaction rates from cross-section data. Several classes are
provided that implement different time-integration algorithms for depletion
calculations, which are described in detail in Colin Josey's thesis,
`Development and analysis of high order neutron transport-depletion coupling
algorithms <http://hdl.handle.net/1721.1/113721>`_.
.. autosummary::
:toctree: generated
@ -41,8 +41,8 @@ analysis of high order neutron transport-depletion coupling algorithms
SICELIIntegrator
SILEQIIntegrator
Each of these classes expects a "reaction rate operator" to be passed. Operators
provided by OpenMC are available using the following classes:
Each of these classes expects a "depletion operator" to be passed. OpenMC
provides The following classes implementing depletion operators:
.. autosummary::
:toctree: generated
@ -214,7 +214,7 @@ are stored in :class:`helpers.TalliedFissionYieldHelper`
helpers.TalliedFissionYieldHelper
Methods common to OpenMC-specific implementations of :class:`TransportOperator`
Methods common to OpenMC-specific implementations of :class:`DepletionOperator`
are stored in :class:`openmc_operator.OpenMCOperator`
.. autosummary::
@ -230,19 +230,21 @@ Abstract Base Classes
A good starting point for extending capabilities in :mod:`openmc.deplete` is
to examine the following abstract base classes. Custom classes can
inherit from :class:`abc.TransportOperator` to implement alternative
schemes for collecting reaction rates and other data from a transport code
prior to depleting materials
inherit from :class:`abc.DepletionOperator` to implement alternative
schemes for collecting reaction rates and other data prior to depleting
materials
.. autosummary::
:toctree: generated
:nosignatures:
:template: mycallable.rst
abc.TransportOperator
abc.DepletionOperator
The following classes are abstract classes used to pass information from
OpenMC simulations back on to the :class:`abc.TransportOperator`
transport simulations (in the case of transport-coupled depletion) or to
simply calculate these quantities directly (in the case of
transport-independent depletion) back on to the :class:`abc.DepletionOperator`
.. autosummary::
:toctree: generated