Adding more crumbs

terrapower · Nov 22, 2023 · 4a269e4 · 4a269e4
1 parent c13885a
commit 4a269e4
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/armi/reactor/grids/structuredgrid.py b/armi/reactor/grids/structuredgrid.py
@@ -290,7 +290,12 @@ def restoreBackup(self):
         self._unitSteps, self._bounds, self._offset = self._backup
 
     def getCoordinates(self, indices, nativeCoords=False) -> numpy.ndarray:
-        """Return the coordinates of the center of the mesh cell at the given given indices in cm."""
+        """Return the coordinates of the center of the mesh cell at the given given indices in cm.
+
+        .. test:: Get the coordinates from a location in a grid.
+            :id: T_ARMI_GRID_GLOBAL_POS
+            :tests: R_ARMI_GRID_GLOBAL_POS
+        """
         indices = numpy.array(indices)
         return self._evaluateMesh(
             indices, self._centroidBySteps, self._centroidByBounds

diff --git a/armi/reactor/grids/tests/test_grids.py b/armi/reactor/grids/tests/test_grids.py
@@ -436,6 +436,10 @@ def test_adjustPitch(self):
         .. test:: Construct a hexagonal lattice with three rings.
             :id: T_ARMI_GRID_HEX
             :tests: R_ARMI_GRID_HEX
+
+        .. test:: Return the grid coordinates of different locations.
+            :id: T_ARMI_GRID_GLOBAL_POS0
+            :tests: R_ARMI_GRID_GLOBAL_POS
         """
         grid = grids.HexGrid.fromPitch(1.0, numRings=3)
         v1 = grid.getCoordinates((1, 0, 0))