Update Results and ResultsList doc on proc_time

Process time that is stored in the dataset is the
average time spent depleting a material across
all materials and processes.
This commit is contained in:
Andrew Johnson 2019-06-26 17:50:40 -05:00
parent 875ba94825
commit 8deda73647
No known key found for this signature in database
GPG key ID: 253418E91B7F6FEB
2 changed files with 6 additions and 3 deletions

View file

@ -48,7 +48,8 @@ class Results(object):
data : numpy.ndarray
Atom quantity, stored by stage, mat, then by nuclide.
proc_time: int
Amount of process time spent depleting materials
Average time spent depleting a material across all
materials and processes
"""
def __init__(self):
@ -416,7 +417,9 @@ class Results(object):
step_ind : int
Step index.
proc_time : float or None
time spent depleting materials.
Total process time spent depleting materials. This may
be process-dependent and will be reduced across MPI
processes.
"""
# Get indexing terms

View file

@ -105,7 +105,7 @@ class ResultsList(list):
return time, eigenvalue
def get_depletion_time(self):
"""Return an array of time spent depleting materials
"""Return an array of the average time to deplete a material
..note::