Skip to content

Commit 830f075

Browse files
authored
Update documentation describing HexLattice orientation (#3709)
1 parent 7dceb1d commit 830f075

File tree

3 files changed

+14
-10
lines changed

3 files changed

+14
-10
lines changed

docs/source/io_formats/geometry.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -316,9 +316,10 @@ the following attributes or sub-elements:
316316
*Default*: None
317317

318318
:orientation:
319-
The orientation of the hexagonal lattice. The string "x" indicates that two
320-
sides of the lattice are parallel to the x-axis, whereas the string "y"
321-
indicates that two sides are parallel to the y-axis.
319+
The orientation of the hexagonal lattice. The string "x" indicates that each
320+
lattice element has two faces that are perpendicular to the x-axis, whereas
321+
the string "y" indicates that each lattice element has two faces that are
322+
perpendicular to the y-axis.
322323

323324
*Default*: "y"
324325

docs/source/usersguide/geometry.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -415,11 +415,11 @@ to help figure out how to place universes::
415415

416416

417417
Note that by default, hexagonal lattices are positioned such that each lattice
418-
element has two faces that are parallel to the :math:`y` axis. As one example,
419-
to create a three-ring lattice centered at the origin with a pitch of 10 cm
420-
where all the lattice elements centered along the :math:`y` axis are filled with
421-
universe ``u`` and the remainder are filled with universe ``q``, the following
422-
code would work::
418+
element has two faces that are perpendicular to the :math:`y` axis. As one
419+
example, to create a three-ring lattice centered at the origin with a pitch of
420+
10 cm where all the lattice elements centered along the :math:`y` axis are
421+
filled with universe ``u`` and the remainder are filled with universe ``q``, the
422+
following code would work::
423423

424424
hexlat = openmc.HexLattice()
425425
hexlat.center = (0, 0)

openmc/lattice.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1083,8 +1083,11 @@ class HexLattice(Lattice):
10831083
from the outermost ring), and i is the index with a ring starting from
10841084
the top and proceeding clockwise.
10851085
orientation : {'x', 'y'}
1086-
str by default 'y' orientation of main lattice diagonal another option
1087-
- 'x'
1086+
The orientation of the lattice. The 'x' orientation means that each
1087+
lattice element has two faces that are perpendicular to the x-axis,
1088+
while the 'y' orientation means that each lattice element has two faces
1089+
that are perpendicular to the y-axis. By default, the orientation is
1090+
'y'.
10881091
num_rings : int
10891092
Number of radial ring positions in the xy-plane
10901093
num_axial : int

0 commit comments

Comments
 (0)