Skip to content

Commit 1dacf4f

Browse files
pshriwisepaulromanoaprilnovak
authored
Add missing documentation on <source> in depletion chain file format (#3590)
Co-authored-by: Paul Romano <paul.k.romano@gmail.com> Co-authored-by: April Novak <novak@berkeley.edu>
1 parent 3ac64d9 commit 1dacf4f

2 files changed

Lines changed: 22 additions & 1 deletion

File tree

docs/source/io_formats/depletion_chain.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,27 @@ attributes:
5656

5757
.. _io_chain_reaction:
5858

59+
--------------------
60+
``<source>`` Element
61+
--------------------
62+
63+
The ``<source>`` element represents photon and electron sources associated with
64+
the decay of a nuclide and contains information to construct an
65+
:class:`openmc.stats.Univariate` object that represents this emission as an
66+
energy distribution. This element has the following attributes:
67+
68+
:type:
69+
The type of :class:`openmc.stats.Univariate` source term.
70+
71+
:particle:
72+
The type of particle emitted, e.g., 'photon' or 'electron'
73+
74+
:parameters:
75+
The parameters of the source term, e.g., for a
76+
:class:`openmc.stats.Discrete` source, the energies (in [eV]) at which the
77+
particles are emitted and their relative intensities in [Bq/atom] (in other
78+
words, decay constants).
79+
5980
----------------------
6081
``<reaction>`` Element
6182
----------------------

openmc/data/decay.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -591,7 +591,7 @@ def decay_photon_energy(nuclide: str) -> Univariate | None:
591591
openmc.stats.Univariate or None
592592
Distribution of energies in [eV] of photons emitted from decay, or None
593593
if no photon source exists. Note that the probabilities represent
594-
intensities, given as [Bq].
594+
intensities, given as [Bq/atom] (in other words, decay constants).
595595
"""
596596
if not _DECAY_PHOTON_ENERGY:
597597
chain_file = openmc.config.get('chain_file')

0 commit comments

Comments
 (0)