mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-28 06:05:58 -04:00
added docstring for extract_results method
This commit is contained in:
parent
8737ce22dc
commit
8a784331c1
1 changed files with 12 additions and 0 deletions
|
|
@ -441,6 +441,18 @@ class StatePoint(object):
|
|||
return t.results[filter_index, score_index]
|
||||
|
||||
def extract_results(self, tally_id, score_str):
|
||||
"""Returns a tally results dictionary given a tally_id and score string.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
tally_id : int
|
||||
Index for the tally in StatePoint.tallies list
|
||||
|
||||
score_str : string
|
||||
Corresponds to the string entered for a score in tallies.xml.
|
||||
For a flux score extraction it would be 'score'
|
||||
|
||||
"""
|
||||
|
||||
# get tally
|
||||
try:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue