Merge pull request #3 from paulromano/newhex-clockwise

Change order of x-oriented hex lattice universes to clockwise

Author: dryuri92

openmc/lattice.py

@@ -1241,8 +1241,8 @@ def get_universe_index(self, idx):
             else:
                 i_within = 5*g - z
 
-        if (self._orientation == 'x') and (i_within > 0):
-            i_within = 6*(self._num_rings - i_ring - 1) - i_within_
+        if self._orientation == 'x' and g > 0:
+            i_within = (i_within + 5*g) % (6*g)
 
         if self.num_axial is None:
             return (i_ring, i_within)
@@ -1376,6 +1376,7 @@ def from_xml_element(cls, elem, get_universe):
         lat = cls(lat_id, name)
         lat.center = [float(i) for i in get_text(elem, 'center').split()]
         lat.pitch = [float(i) for i in get_text(elem, 'pitch').split()]
+        lat.orientation = get_text(elem, 'orientation', 'y')
         outer = get_text(elem, 'outer')
         if outer is not None:
             lat.outer = get_universe(int(outer))
@@ -1390,7 +1391,7 @@ def from_xml_element(cls, elem, get_universe):
         if n_axial > 1:
             univs = [deepcopy(univs) for i in range(n_axial)]
 
-        # Get flat array of universes numbers
+        # Get flat array of universes
         uarray = np.array([get_universe(int(i)) for i in
                            get_text(elem, 'universes').split()])
 
@@ -1400,28 +1401,53 @@ def from_xml_element(cls, elem, get_universe):
             # Get list for a single axial level
             axial_level = univs[z] if n_axial > 1 else univs
 
-            # Start iterating from top
-            x, alpha = 0, n_rings - 1
-            while True:
-                # Set entry in list based on (x,alpha,z) coordinates
-                _, i_ring, i_within = lat.get_universe_index((x, alpha, z))
-                axial_level[i_ring][i_within] = uarray[j]
-
-                # Move to the right
-                x += 2
-                alpha -= 1
-                if not lat.is_valid_index((x, alpha, z)):
-                    # Move down in y direction
-                    alpha += x - 1
-                    x = 1 - x
+            if lat.orientation == 'y':
+                # Start iterating from top
+                x, alpha = 0, n_rings - 1
+                while True:
+                    # Set entry in list based on (x,alpha,z) coordinates
+                    _, i_ring, i_within = lat.get_universe_index((x, alpha, z))
+                    axial_level[i_ring][i_within] = uarray[j]
+
+                    # Move to the right
+                    x += 2
+                    alpha -= 1
                     if not lat.is_valid_index((x, alpha, z)):
-                        # Move to the right
-                        x += 2
-                        alpha -= 1
+                        # Move down in y direction
+                        alpha += x - 1
+                        x = 1 - x
                         if not lat.is_valid_index((x, alpha, z)):
-                            # Reached the bottom
+                            # Move to the right
+                            x += 2
+                            alpha -= 1
+                            if not lat.is_valid_index((x, alpha, z)):
+                                # Reached the bottom
+                                break
+                    j += 1
+            else:
+                # Start iterating from top
+                alpha, y = 1 - n_rings, n_rings - 1
+                while True:
+                    # Set entry in list based on (alpha,y,z) coordinates
+                    _, i_ring, i_within = lat.get_universe_index((alpha, y, z))
+                    axial_level[i_ring][i_within] = uarray[j]
+
+                    # Move to the right
+                    alpha += 1
+                    if not lat.is_valid_index((alpha, y, z)):
+                        # Move down to next row
+                        alpha = 1 - n_rings
+                        y -= 1
+
+                        # Check if we've reached the bottom
+                        if y == -n_rings:
                             break
-                j += 1
+
+                        while not lat.is_valid_index((alpha, y, z)):
+                            # Move to the right
+                            alpha += 1
+                    j += 1
+
         lat.universes = univs
         return lat
 
@@ -1469,7 +1495,7 @@ def _repr_axial_slice_x(self, universes):
             theta = 0
             y = middle
 
-            # Climb up the top-right.
+            # Climb down the bottom-right
             for i in range(r):
                 # Add the universe.
                 universe = universes[r_prime][theta]
@@ -1479,7 +1505,7 @@ def _repr_axial_slice_x(self, universes):
                 y += 1
                 theta += 1
 
-            # Climb left the top-left.
+            # Climb left across the bottom
             for i in range(r):
                 # Add the universe.
                 universe = universes[r_prime][theta]
@@ -1488,7 +1514,7 @@ def _repr_axial_slice_x(self, universes):
                 # Translate the indices.
                 theta += 1
 
-            # Climb down the middle left.
+            # Climb up the bottom-left
             for i in range(r):
                 # Add the universe.
                 universe = universes[r_prime][theta]
@@ -1498,7 +1524,7 @@ def _repr_axial_slice_x(self, universes):
                 y -= 1
                 theta += 1
 
-            # Climb down the down left.
+            # Climb up the top-left
             for i in range(r):
                 # Add the universe.
                 universe = universes[r_prime][theta]
@@ -1508,7 +1534,7 @@ def _repr_axial_slice_x(self, universes):
                 y -= 1
                 theta += 1
 
-            # Climb right the down right.
+            # Climb right across the top
             for i in range(r):
                 # Add the universe.
                 universe = universes[r_prime][theta]
@@ -1517,7 +1543,7 @@ def _repr_axial_slice_x(self, universes):
                 # Translate the indices.
                 theta += 1
 
-            # Climb up the middle-right.
+            # Climb down the top-right
             for i in range(r):
                 # Add the universe.
                 universe = universes[r_prime][theta]
@@ -1528,7 +1554,7 @@ def _repr_axial_slice_x(self, universes):
                 theta += 1
 
         # Flip the rows and join each row into a single string.
-        rows = [pad.join(x) for x in rows[::-1]]
+        rows = [pad.join(x) for x in rows]
 
         # Pad the beginning of the rows so they line up properly.
         for y in range(self._num_rings - 1):
@@ -1806,41 +1832,41 @@ def _show_indices_x(num_rings):
             y = middle
 
             for i in range(r):
-                # Climb up the top-right.
+                # Climb down the bottom-right
                 rows[y].append(str_form.format(r_prime, theta))
                 y += 1
                 theta += 1
 
             for i in range(r):
-                # Climb left the top-left.
+                # Climb left across the bottom
                 rows[y].insert(0, str_form.format(r_prime, theta))
                 theta += 1
 
             for i in range(r):
-                # Climb down the middle left.
+                # Climb up the bottom-left
                 rows[y].insert(0, str_form.format(r_prime, theta))
                 y -= 1
                 theta += 1
 
             for i in range(r):
-                # Climb down the down left.
+                # Climb up the top-left
                 rows[y].insert(0, str_form.format(r_prime, theta))
                 y -= 1
                 theta += 1
 
             for i in range(r):
-                # Climb right the down right.
+                # Climb right across the top
                 rows[y].append(str_form.format(r_prime, theta))
                 theta += 1
 
             for i in range(r):
-                # Climb up the middle-right.
+                # Climb down the top-right
                 rows[y].append(str_form.format(r_prime, theta))
                 y += 1
                 theta += 1
 
         # Flip the rows and join each row into a single string.
-        rows = [pad.join(x) for x in rows[::-1]]
+        rows = [pad.join(x) for x in rows]
 
         # Pad the beginning of the rows so they line up properly.
         for y in range(num_rings - 1):

tests/regression_tests/lattice_hex_x/test.py

@@ -161,9 +161,9 @@ def _build_inputs(self):
                 arr.append(fuel_ch_univ)
             universes.append(arr)
         universes[-1] = [tube_ch_univ]
-        channels = [(7, 16), (7, 13), (7, 10), (7, 7), (7, 4), (7, 1), (5, 0),
-                    (4, 33), (5, 25), (4, 27), (5, 20), (4, 21), (5, 15),
-                    (4, 15), (5, 10), (4, 9), (5, 5), (4, 3)]
+        channels = [(7, 2), (7, 5), (7, 8), (7, 11), (7, 14), (7, 17), (5, 0),
+                    (4, 3), (5, 5), (4, 9), (5, 10), (4, 15), (5, 15),
+                    (4, 21), (5, 20), (4, 27), (5, 25), (4, 33)]
         for i, j in channels:
             universes[i][j] = abs_ch_univ
         lattice = openmc.HexLattice(name="regular fuel assembly")