desc.geometry.FourierRZCurve

class desc.geometry.FourierRZCurve(R_n=10, Z_n=0, modes_R=None, modes_Z=None, NFP=1, sym='auto', name='')Source

Curve parameterized by Fourier series for R,Z in terms of toroidal angle phi.

Parameters:

  • R_n (array-like) – Fourier coefficients for R, Z.

  • Z_n (array-like) – Fourier coefficients for R, Z.

  • modes_R (array-like, optional) – Mode numbers associated with R_n. If not given defaults to [-n:n].

  • modes_Z (array-like, optional) – Mode numbers associated with Z_n, If not given defaults to [-n:n]].

  • NFP (int) – Number of field periods.

  • sym (bool) – Whether to enforce stellarator symmetry.

  • name (str) – Name for this curve.

Methods

change_resolution([N, NFP, sym])

Change the maximum toroidal resolution.

compute(names[, grid, params, transforms, ...])

Compute the quantity given by name on grid.

copy([deepcopy])

Return a (deep)copy of this object.

eq(other)

Compare equivalence between DESC objects.

flip(normal)

Flip the curve about the plane with specified normal.

from_input_file(path)

Create a axis curve from Fourier coefficients in a DESC or VMEC input file.

get_coeffs(n)

Get Fourier coefficients for given mode number(s).

load(load_from[, file_format])

Initialize from file.

rotate([axis, angle])

Rotate the curve by a fixed angle about axis in xyz coordinates.

save(file_name[, file_format, file_mode])

Save the object.

set_coeffs(n[, R, Z])

Set specific Fourier coefficients.

to_FourierXYZ([N, grid, s, name])

Convert Curve to FourierXYZCurve representation.

to_SplineXYZ([knots, grid, method, name])

Convert Curve to SplineXYZCurve.

translate([displacement])

Translate the curve by a rigid displacement in x, y, z.

Attributes

N

Maximum mode number.

NFP

Number of field periods.

R_basis

Spectral basis for R_Fourier series.

R_n

Spectral coefficients for R.

Z_basis

Spectral basis for Z_Fourier series.

Z_n

Spectral coefficients for Z.

name

Name of the curve.

sym

Whether this curve has stellarator symmetry.