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

Documentation fixes for configurable CRAM solver

Browse source 
Recommendations and typos found through review with
@paulromano
This commit is contained in:
Andrew Johnson 2020-05-14 08:11:01 -04:00
parent a253bcccb1
commit 7fdfe0ec0b
No known key found for this signature in database
GPG key ID: 253418E91B7F6FEB
3 changed files with 52 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

16
openmc/deplete/abc.py
View file

@ -626,7 +626,7 @@ class Integrator(ABC):
that the values are given in burnup (MW-d of energy deposited per
kilogram of initial heavy metal).
solver : str or callable, optional
If a string, must be the tame of the solver responsible for
If a string, must be the name of the solver responsible for
solving the Bateman equations. Current options are:
* ``cram16`` - 16th order IPF CRAM
@ -649,9 +649,9 @@ class Integrator(ABC):
Power of the reactor in [W] for each interval in :attr:`timesteps`
solver : callable
Function that will solve the Bateman equations
:math:`\vec{n}_{i+1} = A_i\vec{n}_i` with a step size :math:`t_i`. Can
be configured using the ``solver`` argument. User-supplied functions
are expected to have the following signature:
:math:`\frac{\partial}{\partial t}\vec{n} = A_i\vec{n}_i` with a step
size :math:`t_i`. Can be configured using the ``solver`` argument.
User-supplied functions are expected to have the following signature:
``solver(A, n0, t) -> n1`` where
* ``A`` is a :class:`scipy.sparse.csr_matrix` making up the
@ -925,7 +925,7 @@ class SIIntegrator(Integrator):
Number of stochastic iterations per depletion interval.
Must be greater than zero. Default : 10
solver : str or callable, optional
If a string, must be the tame of the solver responsible for
If a string, must be the name of the solver responsible for
solving the Bateman equations. Current options are:
* ``cram16`` - 16th order IPF CRAM
@ -950,9 +950,9 @@ class SIIntegrator(Integrator):
Number of stochastic iterations per depletion interval
solver : callable
Function that will solve the Bateman equations
:math:`\vec{n}_{i+1} = A_i\vec{n}_i` with a step size :math:`t_i`. Can
be configured using the ``solver`` argument. User-supplied functions
are expected to have the following signature:
:math:`\frac{\partial}{\partial t}\vec{n} = A_i\vec{n}_i` with a step
size :math:`t_i`. Can be configured using the ``solver`` argument.
User-supplied functions are expected to have the following signature:
``solver(A, n0, t) -> n1`` where
* ``A`` is a :class:`scipy.sparse.csr_matrix` making up the

76
openmc/deplete/integrators.py
View file

@ -55,7 +55,7 @@ class PredictorIntegrator(Integrator):
.. versionadded:: 0.12
solver : str or callable, optional
If a string, must be the tame of the solver responsible for
If a string, must be the name of the solver responsible for
solving the Bateman equations. Current options are:
* ``cram16`` - 16th order IPF CRAM
@ -78,9 +78,9 @@ class PredictorIntegrator(Integrator):
Power of the reactor in [W] for each interval in :attr:`timesteps`
solver : callable
Function that will solve the Bateman equations
:math:`\vec{n}_{i+1} = A_i\vec{n}_i` with a step size :math:`t_i`. Can
be configured using the ``solver`` argument. User-supplied functions
are expected to have the following signature:
:math:`\frac{\partial}{\partial t}\vec{n} = A_i\vec{n}_i` with a step
size :math:`t_i`. Can be configured using the ``solver`` argument.
User-supplied functions are expected to have the following signature:
``solver(A, n0, t) -> n1`` where
* ``A`` is a :class:`scipy.sparse.csr_matrix` making up the
@ -174,7 +174,7 @@ class CECMIntegrator(Integrator):
.. versionadded:: 0.12
solver : str or callable, optional
If a string, must be the tame of the solver responsible for
If a string, must be the name of the solver responsible for
solving the Bateman equations. Current options are:
* ``cram16`` - 16th order IPF CRAM
@ -197,9 +197,9 @@ class CECMIntegrator(Integrator):
Power of the reactor in [W] for each interval in :attr:`timesteps`
solver : callable
Function that will solve the Bateman equations
:math:`\vec{n}_{i+1} = A_i\vec{n}_i` with a step size :math:`t_i`. Can
be configured using the ``solver`` argument. User-supplied functions
are expected to have the following signature:
:math:`\frac{\partial}{\partial t}\vec{n} = A_i\vec{n}_i` with a step
size :math:`t_i`. Can be configured using the ``solver`` argument.
User-supplied functions are expected to have the following signature:
``solver(A, n0, t) -> n1`` where
* ``A`` is a :class:`scipy.sparse.csr_matrix` making up the
@ -301,7 +301,7 @@ class CF4Integrator(Integrator):
.. versionadded:: 0.12
solver : str or callable, optional
If a string, must be the tame of the solver responsible for
If a string, must be the name of the solver responsible for
solving the Bateman equations. Current options are:
* ``cram16`` - 16th order IPF CRAM
@ -324,9 +324,9 @@ class CF4Integrator(Integrator):
Power of the reactor in [W] for each interval in :attr:`timesteps`
solver : callable
Function that will solve the Bateman equations
:math:`\vec{n}_{i+1} = A_i\vec{n}_i` with a step size :math:`t_i`. Can
be configured using the ``solver`` argument. User-supplied functions
are expected to have the following signature:
:math:`\frac{\partial}{\partial t}\vec{n} = A_i\vec{n}_i` with a step
size :math:`t_i`. Can be configured using the ``solver`` argument.
User-supplied functions are expected to have the following signature:
``solver(A, n0, t) -> n1`` where
* ``A`` is a :class:`scipy.sparse.csr_matrix` making up the
@ -445,7 +445,7 @@ class CELIIntegrator(Integrator):
.. versionadded:: 0.12
solver : str or callable, optional
If a string, must be the tame of the solver responsible for
If a string, must be the name of the solver responsible for
solving the Bateman equations. Current options are:
* ``cram16`` - 16th order IPF CRAM
@ -468,9 +468,9 @@ class CELIIntegrator(Integrator):
Power of the reactor in [W] for each interval in :attr:`timesteps`
solver : callable
Function that will solve the Bateman equations
:math:`\vec{n}_{i+1} = A_i\vec{n}_i` with a step size :math:`t_i`. Can
be configured using the ``solver`` argument. User-supplied functions
are expected to have the following signature:
:math:`\frac{\partial}{\partial t}\vec{n} = A_i\vec{n}_i` with a step
size :math:`t_i`. Can be configured using the ``solver`` argument.
User-supplied functions are expected to have the following signature:
``solver(A, n0, t) -> n1`` where
* ``A`` is a :class:`scipy.sparse.csr_matrix` making up the
@ -576,7 +576,7 @@ class EPCRK4Integrator(Integrator):
.. versionadded:: 0.12
solver : str or callable, optional
If a string, must be the tame of the solver responsible for
If a string, must be the name of the solver responsible for
solving the Bateman equations. Current options are:
* ``cram16`` - 16th order IPF CRAM
@ -598,7 +598,7 @@ class EPCRK4Integrator(Integrator):
power : iterable of float
Power of the reactor in [W] for each interval in :attr:`timesteps`
solver : str or callable, optional
If a string, must be the tame of the solver responsible for
If a string, must be the name of the solver responsible for
solving the Bateman equations. Current options are:
* ``cram16`` - 16th order IPF CRAM
@ -721,7 +721,7 @@ class LEQIIntegrator(Integrator):
.. versionadded:: 0.12
solver : str or callable, optional
If a string, must be the tame of the solver responsible for
If a string, must be the name of the solver responsible for
solving the Bateman equations. Current options are:
* ``cram16`` - 16th order IPF CRAM
@ -744,9 +744,9 @@ class LEQIIntegrator(Integrator):
Power of the reactor in [W] for each interval in :attr:`timesteps`
solver : callable
Function that will solve the Bateman equations
:math:`\vec{n}_{i+1} = A_i\vec{n}_i` with a step size :math:`t_i`. Can
be configured using the ``solver`` argument. User-supplied functions
are expected to have the following signature:
:math:`\frac{\partial}{\partial t}\vec{n} = A_i\vec{n}_i` with a step
size :math:`t_i`. Can be configured using the ``solver`` argument.
User-supplied functions are expected to have the following signature:
``solver(A, n0, t) -> n1`` where
* ``A`` is a :class:`scipy.sparse.csr_matrix` making up the
@ -872,7 +872,7 @@ class SICELIIntegrator(SIIntegrator):
Number of stochastic iterations per depletion interval.
Must be greater than zero. Default : 10
solver : str or callable, optional
If a string, must be the tame of the solver responsible for
If a string, must be the name of the solver responsible for
solving the Bateman equations. Current options are:
* ``cram16`` - 16th order IPF CRAM
@ -897,9 +897,9 @@ class SICELIIntegrator(SIIntegrator):
Number of stochastic iterations per depletion interval
solver : callable
Function that will solve the Bateman equations
:math:`\vec{n}_{i+1} = A_i\vec{n}_i` with a step size :math:`t_i`. Can
be configured using the ``solver`` argument. User-supplied functions
are expected to have the following signature:
:math:`\frac{\partial}{\partial t}\vec{n} = A_i\vec{n}_i` with a step
size :math:`t_i`. Can be configured using the ``solver`` argument.
User-supplied functions are expected to have the following signature:
``solver(A, n0, t) -> n1`` where
* ``A`` is a :class:`scipy.sparse.csr_matrix` making up the
@ -1009,7 +1009,7 @@ class SILEQIIntegrator(SIIntegrator):
Number of stochastic iterations per depletion interval.
Must be greater than zero. Default : 10
solver : str or callable, optional
If a string, must be the tame of the solver responsible for
If a string, must be the name of the solver responsible for
solving the Bateman equations. Current options are:
* ``cram16`` - 16th order IPF CRAM
@ -1032,18 +1032,24 @@ class SILEQIIntegrator(SIIntegrator):
Power of the reactor in [W] for each interval in :attr:`timesteps`
n_steps : int
Number of stochastic iterations per depletion interval
solver : str or callable, optional
If a string, must be the tame of the solver responsible for
solving the Bateman equations. Current options are:
solver : callable
Function that will solve the Bateman equations
:math:`\frac{\partial}{\partial t}\vec{n} = A_i\vec{n}_i` with a step
size :math:`t_i`. Can be configured using the ``solver`` argument.
User-supplied functions are expected to have the following signature:
``solver(A, n0, t) -> n1`` where
* ``cram16`` - 16th order IPF CRAM
* ``cram48`` - 48th order IPF CRAM [default]
If a function or other callable, must adhere to the requirements in
:attr:`solver`.
* ``A`` is a :class:`scipy.sparse.csr_matrix` making up the
depletion matrix
* ``n0`` is a 1-D :class:`numpy.ndarray` of initial compositions
for a given material in atoms/cm3
* ``t`` is a float of the time step size in seconds, and
* ``n1`` is a :class:`numpy.ndarray` of compositions at the
next time step. Expected to be of the same shape as ``n0``
.. versionadded:: 0.12
"""
_num_stages = 2

5
openmc/deplete/pool.py
View file

@ -22,17 +22,18 @@ def deplete(func, chain, x, rates, dt, matrix_func=None):
Reaction rates (from transport operator)
dt : float
Time in [s] to deplete for
maxtrix_func : Callable, optional
maxtrix_func : callable, optional
Function to form the depletion matrix after calling
``matrix_func(chain, rates, fission_yields)``, where
``fission_yields = {parent: {product: yield_frac}}``
Expected to return the depletion matrix required by
:func:`CRAM48`.
``func``
Returns
-------
x_result : list of numpy.ndarray
Updated atom number vectors for each material
"""
fission_yields = chain.fission_yields