Use consistent naming 'n' -> 'num'

Ceyron · Mar 12, 2024 · 6594f69 · 6594f69
1 parent 2628f8e
commit 6594f69
Show file tree

Hide file tree

Showing 19 changed files with 57 additions and 57 deletions.
diff --git a/exponax/_base_stepper.py b/exponax/_base_stepper.py
@@ -31,7 +31,7 @@ def __init__(
         *,
         num_channels: int,
         order: int,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         self.num_spatial_dims = num_spatial_dims
@@ -71,31 +71,31 @@ def __init__(
                 dt,
                 linear_operator,
                 nonlinear_fun,
-                n_circle_points=n_circle_points,
+                num_circle_points=num_circle_points,
                 circle_radius=circle_radius,
             )
         elif order == 2:
             self._integrator = ETDRK2(
                 dt,
                 linear_operator,
                 nonlinear_fun,
-                n_circle_points=n_circle_points,
+                num_circle_points=num_circle_points,
                 circle_radius=circle_radius,
             )
         elif order == 3:
             self._integrator = ETDRK3(
                 dt,
                 linear_operator,
                 nonlinear_fun,
-                n_circle_points=n_circle_points,
+                num_circle_points=num_circle_points,
                 circle_radius=circle_radius,
             )
         elif order == 4:
             self._integrator = ETDRK4(
                 dt,
                 linear_operator,
                 nonlinear_fun,
-                n_circle_points=n_circle_points,
+                num_circle_points=num_circle_points,
                 circle_radius=circle_radius,
             )
         else:

diff --git a/exponax/etdrk/_etdrk_1.py b/exponax/etdrk/_etdrk_1.py
@@ -16,14 +16,14 @@ def __init__(
         linear_operator: Complex[Array, "E ... (N//2)+1"],
         nonlinear_fun: BaseNonlinearFun,
         *,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         super().__init__(dt, linear_operator)
         self._nonlinear_fun = nonlinear_fun
 
         LR = (
-            circle_radius * roots_of_unity(n_circle_points)
+            circle_radius * roots_of_unity(num_circle_points)
             + linear_operator[..., jnp.newaxis] * dt
         )
 

diff --git a/exponax/etdrk/_etdrk_2.py b/exponax/etdrk/_etdrk_2.py
@@ -17,14 +17,14 @@ def __init__(
         linear_operator: Complex[Array, "E ... (N//2)+1"],
         nonlinear_fun: BaseNonlinearFun,
         *,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         super().__init__(dt, linear_operator)
         self._nonlinear_fun = nonlinear_fun
 
         LR = (
-            circle_radius * roots_of_unity(n_circle_points)
+            circle_radius * roots_of_unity(num_circle_points)
             + linear_operator[..., jnp.newaxis] * dt
         )
 

diff --git a/exponax/etdrk/_etdrk_3.py b/exponax/etdrk/_etdrk_3.py
@@ -21,15 +21,15 @@ def __init__(
         linear_operator: Complex[Array, "E ... (N//2)+1"],
         nonlinear_fun: BaseNonlinearFun,
         *,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         super().__init__(dt, linear_operator)
         self._nonlinear_fun = nonlinear_fun
         self._half_exp_term = jnp.exp(0.5 * dt * linear_operator)
 
         LR = (
-            circle_radius * roots_of_unity(n_circle_points)
+            circle_radius * roots_of_unity(num_circle_points)
             + linear_operator[..., jnp.newaxis] * dt
         )
 

diff --git a/exponax/etdrk/_etdrk_4.py b/exponax/etdrk/_etdrk_4.py
@@ -22,15 +22,15 @@ def __init__(
         linear_operator: Complex[Array, "E ... (N//2)+1"],
         nonlinear_fun: BaseNonlinearFun,
         *,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         super().__init__(dt, linear_operator)
         self._nonlinear_fun = nonlinear_fun
         self._half_exp_term = jnp.exp(0.5 * dt * linear_operator)
 
         LR = (
-            circle_radius * roots_of_unity(n_circle_points)
+            circle_radius * roots_of_unity(num_circle_points)
             + linear_operator[..., jnp.newaxis] * dt
         )
 

diff --git a/exponax/normalized/_convection.py b/exponax/normalized/_convection.py
@@ -19,7 +19,7 @@ def __init__(
         normalized_convection_scale: float = 1.0 * 0.1,
         order: int = 2,
         dealiasing_fraction: float = 2 / 3,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         """
@@ -40,7 +40,7 @@ def __init__(
             dt=1.0,
             num_channels=num_spatial_dims,
             order=order,
-            n_circle_points=n_circle_points,
+            num_circle_points=num_circle_points,
             circle_radius=circle_radius,
         )
 

diff --git a/exponax/normalized/_general_nonlinear.py b/exponax/normalized/_general_nonlinear.py
@@ -19,7 +19,7 @@ def __init__(
         normalized_coefficients_nonlinear: list[float] = [0.0, -1.0 * 0.1, 0.0],
         order=2,
         dealiasing_fraction: float = 2 / 3,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         """
@@ -45,7 +45,7 @@ def __init__(
             dt=1.0,
             num_channels=1,
             order=order,
-            n_circle_points=n_circle_points,
+            num_circle_points=num_circle_points,
             circle_radius=circle_radius,
         )
 

diff --git a/exponax/normalized/_gradient_norm.py b/exponax/normalized/_gradient_norm.py
@@ -25,7 +25,7 @@ def __init__(
         normalized_gradient_norm_scale: float = 1.0 * 0.1 / (60.0**2),
         order: int = 2,
         dealiasing_fraction: float = 2 / 3,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         """
@@ -45,7 +45,7 @@ def __init__(
             dt=1.0,
             num_channels=1,
             order=order,
-            n_circle_points=n_circle_points,
+            num_circle_points=num_circle_points,
             circle_radius=circle_radius,
         )
 

diff --git a/exponax/normalized/_polynomial.py b/exponax/normalized/_polynomial.py
@@ -27,7 +27,7 @@ def __init__(
         ],
         order: int = 2,
         dealiasing_fraction: float = 2 / 3,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         """
@@ -44,7 +44,7 @@ def __init__(
             dt=1.0,
             num_channels=1,
             order=order,
-            n_circle_points=n_circle_points,
+            num_circle_points=num_circle_points,
             circle_radius=circle_radius,
         )
 

diff --git a/exponax/stepper/_burgers.py b/exponax/stepper/_burgers.py
@@ -21,7 +21,7 @@ def __init__(
         convection_scale: float = 1.0,
         order=2,
         dealiasing_fraction: float = 2 / 3,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         """
@@ -72,7 +72,7 @@ def __init__(
             dt=dt,
             num_channels=num_spatial_dims,  # Number of channels grows with dimension
             order=order,
-            n_circle_points=n_circle_points,
+            num_circle_points=num_circle_points,
             circle_radius=circle_radius,
         )
 

diff --git a/exponax/stepper/_convection.py b/exponax/stepper/_convection.py
@@ -21,7 +21,7 @@ def __init__(
         convection_scale: float = 1.0,
         order=2,
         dealiasing_fraction: float = 2 / 3,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         """
@@ -40,7 +40,7 @@ def __init__(
             dt=dt,
             num_channels=num_spatial_dims,
             order=order,
-            n_circle_points=n_circle_points,
+            num_circle_points=num_circle_points,
             circle_radius=circle_radius,
         )
 

diff --git a/exponax/stepper/_general_nonlinear.py b/exponax/stepper/_general_nonlinear.py
@@ -21,7 +21,7 @@ def __init__(
         coefficients_nonlinear: list[float] = [0.0, -1.0, 0.0],
         order=2,
         dealiasing_fraction: float = 2 / 3,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         """
@@ -46,7 +46,7 @@ def __init__(
             dt=dt,
             num_channels=1,
             order=order,
-            n_circle_points=n_circle_points,
+            num_circle_points=num_circle_points,
             circle_radius=circle_radius,
         )
 

diff --git a/exponax/stepper/_gradient_norm.py b/exponax/stepper/_gradient_norm.py
@@ -21,7 +21,7 @@ def __init__(
         gradient_norm_scale: float = 1.0,
         order=2,
         dealiasing_fraction: float = 2 / 3,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         """
@@ -40,7 +40,7 @@ def __init__(
             dt=dt,
             num_channels=1,
             order=order,
-            n_circle_points=n_circle_points,
+            num_circle_points=num_circle_points,
             circle_radius=circle_radius,
         )
 

diff --git a/exponax/stepper/_korteweg_de_vries.py b/exponax/stepper/_korteweg_de_vries.py
@@ -30,7 +30,7 @@ def __init__(
         diffusivity: float = 0.0,
         order: int = 2,
         dealiasing_fraction: float = 2 / 3,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         self.convection_scale = convection_scale
@@ -51,7 +51,7 @@ def __init__(
             dt=dt,
             num_channels=num_spatial_dims,
             order=order,
-            n_circle_points=n_circle_points,
+            num_circle_points=num_circle_points,
             circle_radius=circle_radius,
         )
 

diff --git a/exponax/stepper/_kuramoto_sivashinsky.py b/exponax/stepper/_kuramoto_sivashinsky.py
@@ -23,7 +23,7 @@ def __init__(
         fourth_order_diffusivity: float = 1.0,
         dealiasing_fraction: float = 2 / 3,
         order: int = 2,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         """
@@ -43,7 +43,7 @@ def __init__(
             dt=dt,
             num_channels=1,
             order=order,
-            n_circle_points=n_circle_points,
+            num_circle_points=num_circle_points,
             circle_radius=circle_radius,
         )
 
@@ -91,7 +91,7 @@ def __init__(
         fourth_order_diffusivity: float = 1.0,
         dealiasing_fraction: float = 2 / 3,
         order: int = 2,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         """
@@ -110,7 +110,7 @@ def __init__(
             dt=dt,
             num_channels=num_spatial_dims,
             order=order,
-            n_circle_points=n_circle_points,
+            num_circle_points=num_circle_points,
             circle_radius=circle_radius,
         )
 

diff --git a/exponax/stepper/_navier_stokes.py b/exponax/stepper/_navier_stokes.py
@@ -21,7 +21,7 @@ def __init__(
         drag: float = 0.0,
         order: int = 2,
         dealiasing_fraction: float = 2 / 3,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         self.diffusivity = diffusivity
@@ -34,7 +34,7 @@ def __init__(
             dt=dt,
             num_channels=1,
             order=order,
-            n_circle_points=n_circle_points,
+            num_circle_points=num_circle_points,
             circle_radius=circle_radius,
         )
 
@@ -79,7 +79,7 @@ def __init__(
         injection_scale: float = 1.0,
         order: int = 2,
         dealiasing_fraction: float = 2 / 3,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         self.diffusivity = diffusivity
@@ -94,7 +94,7 @@ def __init__(
             dt=dt,
             num_channels=1,
             order=order,
-            n_circle_points=n_circle_points,
+            num_circle_points=num_circle_points,
             circle_radius=circle_radius,
         )
 

diff --git a/exponax/stepper/_nikolaevskiy.py b/exponax/stepper/_nikolaevskiy.py
@@ -25,7 +25,7 @@ def __init__(
         sixth_order_diffusivity: float = 1.0,
         dealiasing_fraction: float = 2 / 3,
         order: int = 2,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         self.gradient_norm_scale = gradient_norm_scale
@@ -40,7 +40,7 @@ def __init__(
             dt=dt,
             num_channels=1,
             order=order,
-            n_circle_points=n_circle_points,
+            num_circle_points=num_circle_points,
             circle_radius=circle_radius,
         )
 
@@ -93,7 +93,7 @@ def __init__(
         sixth_order_diffusivity: float = 1.0,
         dealiasing_fraction: float = 2 / 3,
         order: int = 2,
-        n_circle_points: int = 16,
+        num_circle_points: int = 16,
         circle_radius: float = 1.0,
     ):
         self.convection_scale = convection_scale
@@ -108,7 +108,7 @@ def __init__(
             dt=dt,
             num_channels=num_spatial_dims,
             order=order,
-            n_circle_points=n_circle_points,
+            num_circle_points=num_circle_points,
             circle_radius=circle_radius,
         )