Review requests

PlasmaControl · Dec 19, 2024 · 8cbbac8 · 8cbbac8
1 parent 432933b
commit 8cbbac8
Show file tree

Hide file tree

Showing 7 changed files with 260 additions and 91 deletions.
diff --git a/desc/compute/_deprecated.py b/desc/compute/_deprecated.py
@@ -235,10 +235,10 @@ def _Gamma_c_1D(params, transforms, profiles, data, **kwargs):
     A 3D stellarator magnetic field admits ripple wells that lead to enhanced
     radial drift of trapped particles. The energetic particle confinement
     metric γ_c quantifies whether the contours of the second adiabatic invariant
-    close on the flux surfaces. In the limit the poloidal drift velocity
+    close on the flux surfaces. In the limit where the poloidal drift velocity
     majorizes the radial drift velocity, the contours lie parallel to flux
     surfaces. The optimization metric Γ_c averages γ_c² over the distribution
-    of trapped articles on each flux surface.
+    of trapped particles on each flux surface.
 
     The radial electric field has a negligible effect, since fast particles
     have high energy with collisionless orbits, so it is assumed to be zero.

diff --git a/desc/compute/_fast_ion.py b/desc/compute/_fast_ion.py
@@ -114,10 +114,10 @@ def _Gamma_c(params, transforms, profiles, data, **kwargs):
     A 3D stellarator magnetic field admits ripple wells that lead to enhanced
     radial drift of trapped particles. The energetic particle confinement
     metric γ_c quantifies whether the contours of the second adiabatic invariant
-    close on the flux surfaces. In the limit the poloidal drift velocity
+    close on the flux surfaces. In the limit where the poloidal drift velocity
     majorizes the radial drift velocity, the contours lie parallel to flux
     surfaces. The optimization metric Γ_c averages γ_c² over the distribution
-    of trapped articles on each flux surface.
+    of trapped particles on each flux surface.
 
     The radial electric field has a negligible effect, since fast particles
     have high energy with collisionless orbits, so it is assumed to be zero.

diff --git a/desc/compute/_neoclassical.py b/desc/compute/_neoclassical.py
@@ -19,7 +19,7 @@
         Use the ``Bounce2D.compute_theta`` method to obtain this.
         """,
     "Y_B": """int :
-        Desired resolution for |B| along field lines to compute bounce points.
+        Desired resolution for algorithm to compute bounce points.
         Default is double ``Y``.
         """,
     "num_transit": """int :

diff --git a/desc/integrals/bounce_integral.py b/desc/integrals/bounce_integral.py
@@ -267,7 +267,7 @@ def __init__(
             ``FourierChebyshevSeries.nodes(X,Y,rho,domain=(0,2*jnp.pi))``.
             Use the ``Bounce2D.compute_theta`` method to obtain this.
         Y_B : int
-            Desired resolution for |B| along field lines to compute bounce points.
+            Desired resolution for algorithm to compute bounce points.
             Default is double ``Y``.
         alpha : float
             Starting field line poloidal label.

diff --git a/desc/objectives/_fast_ion.py b/desc/objectives/_fast_ion.py
@@ -26,10 +26,10 @@ class GammaC(_Objective):
     A 3D stellarator magnetic field admits ripple wells that lead to enhanced
     radial drift of trapped particles. The energetic particle confinement
     metric γ_c quantifies whether the contours of the second adiabatic invariant
-    close on the flux surfaces. In the limit the poloidal drift velocity
+    close on the flux surfaces. In the limit where the poloidal drift velocity
     majorizes the radial drift velocity, the contours lie parallel to flux
     surfaces. The optimization metric Γ_c averages γ_c² over the distribution
-    of trapped articles on each flux surface.
+    of trapped particles on each flux surface.
 
     The radial electric field has a negligible effect, since fast particles
     have high energy with collisionless orbits, so it is assumed to be zero.
@@ -66,7 +66,7 @@ class GammaC(_Objective):
         Desired resolution for algorithm to compute bounce points.
         Default is double ``Y``. Something like 100 is usually sufficient.
         Currently, this is the number of knots per toroidal transit over
-        to approximate |B| with cubic splines to find bounce points.
+        to approximate |B| with cubic splines.
     num_transit : int
         Number of toroidal transits to follow field line.
         For axisymmetric devices, one poloidal transit is sufficient. Otherwise,

diff --git a/desc/objectives/_neoclassical.py b/desc/objectives/_neoclassical.py
@@ -65,7 +65,7 @@ class EffectiveRipple(_Objective):
         Desired resolution for algorithm to compute bounce points.
         Default is double ``Y``. Something like 100 is usually sufficient.
         Currently, this is the number of knots per toroidal transit over
-        to approximate |B| with cubic splines to find bounce points.
+        to approximate |B| with cubic splines.
     num_transit : int
         Number of toroidal transits to follow field line.
         For axisymmetric devices, one poloidal transit is sufficient. Otherwise,

diff --git a/docs/notebooks/tutorials/EffectiveRipple.ipynb b/docs/notebooks/tutorials/EffectiveRipple.ipynb