from_values method for FourierRZCoil and FourierPlanarCoil

desc/coils.py

@@ -354,7 +354,7 @@
     Parameters
     ----------
     current : float
-        current through coil, in Amperes
+        Current through the coil, in Amperes.
     R_n, Z_n: array-like
         fourier coefficients for R, Z
     modes_R : array-like
@@ -415,14 +415,58 @@
     ):
         super().__init__(current, R_n, Z_n, modes_R, modes_Z, NFP, sym, name)
 
+    @classmethod
+    def from_values(cls, current, coords, N=10, NFP=1, basis="rpz", sym=False, name=""):
+        """Fit coordinates to FourierRZCoil representation.
+
+        Parameters
+        ----------
+        current : float
+            Current through the coil, in Amperes.
+        coords: ndarray, shape (num_coords,3)
+            coordinates to fit a FourierRZCurve object with each column
+            corresponding to xyz or rpz depending on the basis argument.
+        N : int
+            Fourier resolution of the new R,Z representation.
+        NFP : int
+            Number of field periods, the curve will have a discrete toroidal symmetry
+            according to NFP.
+        basis : {"rpz", "xyz"}
+            basis for input coordinates. Defaults to "rpz"
+        sym : bool
+            Whether to enforce stellarator symmetry.
+        name : str
+            name for this coil
+
+
+        Returns
+        -------
+        coil : FourierRZCoil
+            New representation of the coil parameterized by Fourier series for R,Z.
+
+        """
+        curve = super().from_values(
+            coords=coords, N=N, NFP=NFP, basis=basis, sym=sym, name=name
+        )
+        return cls(
+            current=current,
+            R_n=curve.R_n,
+            Z_n=curve.Z_n,
+            modes_R=curve.R_basis.modes[:, 2],
+            modes_Z=curve.Z_basis.modes[:, 2],
+            NFP=NFP,
+            sym=curve.sym,
+            name=name,
+        )
+
 
 class FourierXYZCoil(_Coil, FourierXYZCurve):
     """Coil parameterized by fourier series for X,Y,Z in terms of arbitrary angle s.
 
     Parameters
     ----------
     current : float
-        current through coil, in Amperes
+        Current through the coil, in Amperes.
     X_n, Y_n, Z_n: array-like
         fourier coefficients for X, Y, Z
     modes : array-like
@@ -485,7 +529,7 @@
         Parameters
         ----------
         current : float
-            Current through the coil, in Amps.
+            Current through the coil, in Amperes.
         coords: ndarray
             Coordinates to fit a FourierXYZCoil object with.
         N : int
@@ -504,12 +548,13 @@
             New representation of the coil parameterized by Fourier series for X,Y,Z.
 
         """
-        curve = super().from_values(coords, N, s, basis)
+        curve = super().from_values(coords=coords, N=N, s=s, basis=basis, name=name)
         return cls(
-            current,
+            current=current,
             X_n=curve.X_n,
             Y_n=curve.Y_n,
             Z_n=curve.Z_n,
+            modes=curve.X_basis.modes[:, 2],
             name=name,
         )
 
@@ -587,14 +632,49 @@
     ):
         super().__init__(current, center, normal, r_n, modes, basis, name)
 
+    @classmethod
+    def from_values(cls, current, coords, N=10, basis="xyz", name=""):
+        """Fit coordinates to FourierPlanarCoil representation.
+
+        Parameters
+        ----------
+        current : float
+            Current through the coil, in Amperes.
+        coords: ndarray, shape (num_coords,3)
+            Coordinates to fit a FourierPlanarCurve object with each column
+            corresponding to xyz or rpz depending on the basis argument.
+        N : int
+            Fourier resolution of the new r representation.
+        basis : {"rpz", "xyz"}
+            Basis for input coordinates. Defaults to "xyz".
+        name : str
+            Name for this curve.
+
+        Returns
+        -------
+        curve : FourierPlanarCoil
+            New representation of the coil parameterized by a Fourier series for r.
+
+        """
+        curve = super().from_values(coords=coords, N=N, basis=basis, name=name)
+        return cls(
+            current=current,
+            center=curve.center,
+            normal=curve.normal,
+            r_n=curve.r_n,
+            modes=curve.r_basis.modes[:, 2],
+            basis="xyz",
+            name=name,
+        )
+
 
 class SplineXYZCoil(_Coil, SplineXYZCurve):
     """Coil parameterized by spline points in X,Y,Z.
 
     Parameters
     ----------
     current : float
-        current through coil, in Amperes
+        Current through the coil, in Amperes.
     X, Y, Z: array-like
         Points for X, Y, Z describing the curve. If the endpoint is included
         (ie, X[0] == X[-1]), then the final point will be dropped.
@@ -706,7 +786,7 @@
         Parameters
         ----------
         current : float
-            Current through the coil, in Amps.
+            Current through the coil, in Amperes.
         coords: ndarray
             Points for X, Y, Z describing the curve. If the endpoint is included
             (ie, X[0] == X[-1]), then the final point will be dropped.
@@ -738,9 +818,11 @@
             New representation of the coil parameterized by splines in X,Y,Z.
 
         """
-        curve = super().from_values(coords, knots, method, basis=basis)
+        curve = super().from_values(
+            coords=coords, knots=knots, method=method, basis=basis, name=name
+        )
         return cls(
-            current,
+            current=current,
             X=curve.X,
             Y=curve.Y,
             Z=curve.Z,