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

Update documentation for FissionYieldDistribution

Browse source
This commit is contained in:
Andrew Johnson 2019-08-22 15:23:45 -05:00
parent 91c08ef323
commit 61232248df
No known key found for this signature in database
GPG key ID: 253418E91B7F6FEB
1 changed files with 11 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

21
openmc/deplete/nuclide.py
View file

@ -355,16 +355,12 @@ class FissionYieldDistribution(Mapping):
Parameters
----------
energies : iterable of float
Energies for which fission yield data exist. Must be ordered
by increasing energy
products : iterable of str
Fission products produced by this parent at all energies.
Must be ordered alphabetically
yield_matrix : numpy.ndarray or iterable of iterable of float
Array of shape ``(n_energy, n_products)`` where
``yield_matrix[g][j]`` is the yield of
``ordered_products[j]`` due to a fission in energy region ``g``.
fission_yields : dict
Dictionary of energies and fission product yields for that energy.
Expected to be of the form ``{float: {str: float}}``. The first
float is the energy, typically in eV, that represents this
distribution. The underlying dictionary maps fission products
to their respective yields.
Attributes
----------
@ -416,6 +412,11 @@ class FissionYieldDistribution(Mapping):
def __iter__(self):
return iter(self.energies)
def __repr__(self):
return "<{} with {} products at {} energies>".format(
self.__class__.__name__, self.yield_matrix.shape[1],
len(self.energies))
@classmethod
def from_xml_element(cls, element):
"""Construct a distribution from a depletion chain xml file