From 7fea70650f576674f7663fbbbdee2f543956293b Mon Sep 17 00:00:00 2001 From: Sterling Harper Date: Sun, 3 Jan 2016 13:44:42 -0500 Subject: [PATCH] Improve geometry.get_cell_instance docstring --- openmc/geometry.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/openmc/geometry.py b/openmc/geometry.py index baadfce3c..eb2b9db55 100644 --- a/openmc/geometry.py +++ b/openmc/geometry.py @@ -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 """