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

Fix documentation for source site attributes

Browse source
This commit is contained in:
Paul Romano 2020-10-14 15:10:03 -05:00
parent c5f66a3af5
commit 4f7617e90c
3 changed files with 13 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/source/io_formats/source.rst
View file

@ -15,7 +15,7 @@ is that documented here.
:Datasets:
- **source_bank** (Compound type) -- Source bank information for each
particle. The compound type has fields ``wgt``, ``xyz``, ``uvw``,
``E``, ``delayed_group``, and ``particle``, which represent the
weight, position, direction, energy, energy group, delayed group,
and type of the source particle, respectively.
particle. The compound type has fields ``r``, ``u``, ``E``,
``wgt``, ``delayed_group``, and ``particle``, which represent the
position, direction, energy, weight, delayed group, and particle
type (0=neutron, 1=photon, 2=electron, 3=positron), respectively.

10
docs/source/io_formats/statepoint.rst
View file

@ -51,11 +51,11 @@ The current version of the statepoint file format is 17.0.
- **global_tallies** (*double[][2]*) -- Accumulated sum and
sum-of-squares for each global tally.
- **source_bank** (Compound type) -- Source bank information for each
particle. The compound type has fields ``wgt``, ``xyz``, ``uvw``,
``E``, ``g``, and ``delayed_group``, which represent the weight,
position, direction, energy, energy group, and delayed_group of the
source particle, respectively. Only present when `run_mode` is
'eigenvalue'.
particle. The compound type has fields ``r``, ``u``, ``E``,
``wgt``, ``delayed_group``, and ``particle``, which represent the
position, direction, energy, weight, delayed group, and particle
type (0=neutron, 1=photon, 2=electron, 3=positron), respectively.
Only present when `run_mode` is 'eigenvalue'.
**/tallies/**

7
openmc/statepoint.py
View file

@ -93,9 +93,10 @@ class StatePoint:
seed : int
Pseudorandom number generator seed
source : numpy.ndarray of compound datatype
Array of source sites. The compound datatype has fields 'wgt', 'xyz',
'uvw', and 'E' corresponding to the weight, position, direction, and
energy of the source site.
Array of source sites. The compound datatype has fields 'r', 'u',
'E', 'wgt', 'delayed_group', and 'particle', corresponding to the
position, direction, energy, weight, delayed group, and particle type
of the source site, respectively.
source_present : bool
Indicate whether source sites are present
sparse : bool