crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-27 21:55:41 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Added docstring to StatePoint.link_with_summary(...) routine

Browse source
This commit is contained in:
Will Boyd 2015-05-25 10:15:01 -04:00
parent 4532067d8c
commit 05bd905462
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
src/utils/openmc/statepoint.py
View file

@ -669,6 +669,18 @@ class StatePoint(object):
def link_with_summary(self, summary):
"""Links Tallies and Filters with Summary model information.
This routine retrieves model information (materials, geometry) from a
Summary object populated with an HDF5 'summary.h5' file and inserts
it into the Tally objects. This can be helpful when ciewing and
manipulating large scale Tally data.
Parameters
----------
summary : Summary
A Summary object
"""
if not isinstance(summary, openmc.summary.Summary):
msg = 'Unable to link statepoint with {0} which ' \