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

Improve geometry.get_cell_instance docstring

Browse source
This commit is contained in:
Sterling Harper 2016-01-03 13:44:42 -05:00
parent 33375dfa30
commit 7fea70650f
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
openmc/geometry.py
View file

@ -43,9 +43,9 @@ class Geometry(object):
self._root_universe = root_universe
def get_cell_instance(self, path):
"""Returns the corresponding location in the results array for a given path and
filter number. This is primarily intended to post-processing result when
a distribcell filter is used.
"""Return the instance number for the final cell in a geometry path.
The instance is an index into tally distribcell filter arrays.
Parameters
----------
@ -58,8 +58,8 @@ class Geometry(object):
Returns
-------
offset : int
Location in the results array for the path and filter
instance : int
Index in tally results array for distribcell filters
"""