crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-27 21:55:41 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

revert DepletionOperator to TransportOperator; doc updates

Browse source
This commit is contained in:
yardasol 2022-08-01 12:44:28 -05:00
parent 78e4e0aedf
commit 89d79310bb
10 changed files with 48 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -12,7 +12,7 @@ Primary API
The two primary requirements to perform depletion with :mod:`openmc.deplete`
are:
1) A depletion operator
1) A transpor operator
2) A time-integration scheme
The former is responsible for calcuating and retaining important information required for depletion. The most common examples are reaction rates and power
@ -41,8 +41,8 @@ algorithms <http://hdl.handle.net/1721.1/113721>`_.
SICELIIntegrator
SILEQIIntegrator
Each of these classes expects a "depletion operator" to be passed. OpenMC
provides The following classes implementing depletion operators:
Each of these classes expects a "transport operator" to be passed. OpenMC
provides The following classes implementing transpor operators:
.. autosummary::
:toctree: generated
@ -214,7 +214,7 @@ are stored in :class:`helpers.TalliedFissionYieldHelper`
helpers.TalliedFissionYieldHelper
Methods common to OpenMC-specific implementations of :class:`DepletionOperator`
Methods common to OpenMC-specific implementations of :class:`TransportOperator`
are stored in :class:`openmc_operator.OpenMCOperator`
.. autosummary::
@ -230,7 +230,7 @@ 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.DepletionOperator` to implement alternative
inherit from :class:`abc.TransportOperator` to implement alternative
schemes for collecting reaction rates and other data prior to depleting
materials
@ -239,12 +239,12 @@ materials
:nosignatures:
:template: mycallable.rst
abc.DepletionOperator
abc.TransportOperator
The following classes are abstract classes used to pass information from
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`
transport-independent depletion) back on to the :class:`abc.TransportOperator`
.. autosummary::
:toctree: generated

8
docs/source/usersguide/depletion.rst
View file

@ -13,14 +13,14 @@ updated reaction rates, and the process is repeated for as many timesteps as
are requested.
The depletion module is designed such that the reaction rate solution (the
depletion "operator") is completely isolated from the solution of the transmutation
equations and the method used for advancing time.
transport "operator") is completely isolated from the solution of the
transmutation equations and the method used for advancing time.
:mod:`openmc.deplete` supports multiple time-integration methods for determining
material compositions over time. Each method appears as a different class.
For example, :class:`openmc.deplete.CECMIntegrator` runs a depletion calculation
using the CE/CM algorithm (deplete over a timestep using the middle-of-step
reaction rates). An instance of :class:`~openmc.deplete.abc.DepletionOperator`
reaction rates). An instance of :class:`~openmc.deplete.abc.TransportOperator`
is passed to one of these functions along with the timesteps and power level::
power = 1200.0e6 # watts
@ -37,7 +37,7 @@ time::
time, keff = results.get_keff()
Note that the coupling between the reaction rate solver and the transmutation
solver happens in-memory rather than by reading/writing files on disk. OpenMC has two categories of depletion operators for obtaining transmutation reaction
solver happens in-memory rather than by reading/writing files on disk. OpenMC has two categories of transport operators for obtaining transmutation reaction
rates.
.. _coupled-depletion: