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

Fix examples in FissionYield[Distribution] docstring

Browse source 
Clarify that inputs to FissionYield should be sorted. Otherwise
the __contains__ and __getitem__ methods will fail.

Removed the call to FissionYield.copy() and re-structured
the final ``dict(new)`` call to work with doc testing,
as dictionaries are not guaranteed to be ordered. Also
fixed the FissionYieldDistribution example
This commit is contained in:
Andrew Johnson 2019-12-09 14:26:24 -05:00
parent 23e4d3ced2
commit b6678f3fa1
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
openmc/deplete/nuclide.py
View file

@ -352,7 +352,7 @@ class FissionYieldDistribution(Mapping):
Can be used as a dictionary mapping energies and products to fission
yields::
>>> fydist = FissionYieldDistribution{
>>> fydist = FissionYieldDistribution(
... {0.0253: {"Xe135": 0.021}})
>>> fydist[0.0253]["Xe135"]
0.021
@ -477,7 +477,7 @@ class FissionYield(Mapping):
Parameters
----------
products : tuple of str
Products for this specific distribution
Sorted products for this specific distribution
yields : numpy.ndarray
Fission product yields for each product in ``products``
@ -492,11 +492,11 @@ class FissionYield(Mapping):
--------
>>> import numpy
>>> fy_vector = FissionYield(
... ("Xe135", "I129", "Sm149"),
... numpy.array((0.002, 0.001, 0.0003)))
... ("I129", "Sm149", "Xe135"),
... numpy.array((0.001, 0.0003, 0.002)))
>>> fy_vector["Xe135"]
0.002
>>> new = fy_vector.copy()
>>> new = FissionYield(fy_vector.products, fy_vector.yields.copy())
>>> fy_vector *= 2
>>> fy_vector["Xe135"]
0.004
@ -504,8 +504,8 @@ class FissionYield(Mapping):
0.002
>>> (new + fy_vector)["Sm149"]
0.0009
>>> dict(new)
{"Xe135": 0.002, "I129": 0.001, "Sm149": 0.0003}
>>> dict(new) == {"Xe135": 0.002, "I129": 0.001, "Sm149": 0.0003}
True
"""
def __init__(self, products, yields):