syntax corrections

Author: lewisgross1296

include/openmc/boundary_condition.h

@@ -143,14 +143,14 @@ class TranslationalPeriodicBC : public PeriodicBC {
 
 class RotationalPeriodicBC : public PeriodicBC {
 public:
-  RotationalPeriodicBC(int i_surf, int j_surf);
+  enum PeriodicAxis { x, y, z };
+  RotationalPeriodicBC(int i_surf, int j_surf, PeriodicAxis axis = z);
   float compute_periodic_rotation(float rise_1, float run_1, float rise_2, float run_2) const;
   void handle_particle(Particle& p, const Surface& surf) const override;
 
 protected:
   //! Angle about the axis by which particle coordinates will be rotated
   double angle_;
-  enum PeriodicAxis {x, y, z};
   //! Ensure that choice of axes is right handed. axis_1_idx_ corresponds to the independent axis and axis_2_idx_ corresponds to the dependent axis in the 2D plane  perpendicular to the planes' axis of rotation
   int zero_axis_idx;
   int axis_1_idx_; 

openmc/surface.py

@@ -123,9 +123,8 @@ class Surface(IDManagerMixin, ABC):
     boundary_type : {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}, optional
         Boundary condition that defines the behavior for particles hitting the
         surface. Defaults to transmissive boundary condition where particles
-        freely pass through the surface. Note that periodic boundary conditions
-        can only be applied to x-, y-, and z-planes, and only axis-aligned
-        periodicity is supported.
+        freely pass through the surface. Note that only axis-aligned
+        periodicity is supported periodic around the o x-, y-, and z-axes.
     albedo : float, optional
         Albedo of the surfaces as a ratio of particle weight after interaction
         with the surface to the initial weight. Values must be positive. Only

src/boundary_condition.cpp

@@ -182,7 +182,8 @@ RotationalPeriodicBC::RotationalPeriodicBC(int i_surf, int j_surf, PeriodicAxis
       axis_2_idx_ = 1;   // y component dependent
       break;
     default:
-      throw std::invalid_argument(fmt::format("You've specified an axis {} that is not x, y, or z."),axis)
+      throw std::invalid_argument(
+        fmt::format("You've specified an axis that is not x, y, or z."));
   }
 
 
@@ -221,7 +222,8 @@ RotationalPeriodicBC::RotationalPeriodicBC(int i_surf, int j_surf, PeriodicAxis
       surf2.id_));
   }
 
-  angle_ = compute_periodic_rotation(norm1[axis_2_idx_], norm1[axis_1_idx_], norm2[axis_2_idx_], norm2[axis_1_idx_])
+  angle_ = compute_periodic_rotation(norm1[axis_2_idx_], norm1[axis_1_idx_],
+    norm2[axis_2_idx_], norm2[axis_1_idx_]);
 
   // Warn the user if the angle does not evenly divide a circle
   double rem = std::abs(std::remainder((2 * PI / angle_), 1.0));