Contents
Tutorials
API reference
Derivative
Float
Integer
ObjectiveFailure
OneofIntegers
OneofStrings
Optimizable
OptimizableSum
PositiveFloat
PositiveInteger
ScaledOptimizable
String
load()
make_optimizable()
save()
get_giuliani_data()
get_hsx_data()
get_ncsx_data()
get_w7x_data()
BiotSavart
BoozerAnalytic
BoozerMagneticField
BoozerRadialInterpolant
CircularCoil
Coil
Current
DipoleField
Dommaschk
InterpolatedBoozerField
InterpolatedField
IterationStoppingCriterion
LevelsetStoppingCriterion
MGrid
MagneticField
MagneticFieldMultiply
MagneticFieldSum
MaxRStoppingCriterion
MaxToroidalFluxStoppingCriterion
MaxZStoppingCriterion
MinRStoppingCriterion
MinToroidalFluxStoppingCriterion
MinZStoppingCriterion
MirrorModel
NormalField
PoloidalField
Reiman
ScalarPotentialRZMagneticField
SurfaceClassifier
ToroidalField
ToroidalTransitStoppingCriterion
apply_symmetries_to_currents()
apply_symmetries_to_curves()
coils_to_focus()
coils_to_makegrid()
coils_via_symmetries()
compute_fieldlines()
compute_poloidal_transits()
compute_resonances()
compute_toroidal_transits()
load_coils_from_makegrid_file()
particles_to_vtk()
plot_poincare_data()
trace_particles()
trace_particles_boozer()
trace_particles_starting_on_curve()
trace_particles_starting_on_surface()
ArclengthVariation
Area
BoozerSurface
CoilStrain
Curve
CurveCurveDistance
CurveFilament
CurveHelical
CurveLength
CurvePerturbed
CurvePlanarFourier
CurveRZFourier
CurveSurfaceDistance
CurveXYZFourier
FrameRotation
FramedCurve
FramedCurveCentroid
FramedCurveFrenet
GaussianSampler
Iotas
JaxCurveXYZFourier
LPBinormalCurvatureStrainPenalty
LPTorsionalStrainPenalty
LinkingNumber
LpCurveCurvature
LpCurveTorsion
MajorRadius
MeanSquaredCurvature
NonQuasiSymmetricRatio
PermanentMagnetGrid
PerturbationSample
PrincipalCurvature
QfmResidual
QfmSurface
RotatedCurve
Surface
SurfaceGarabedian
SurfaceHenneberg
SurfaceRZFourier
SurfaceRZPseudospectral
SurfaceScaled
SurfaceXYZFourier
SurfaceXYZTensorFourier
ToroidalFlux
Volume
ZeroRotation
best_nphi_over_ntheta()
boozer_surface_residual()
create_equally_spaced_curves()
create_equally_spaced_planar_curves()
create_multifilament_grid()
curves_to_vtk()
fix_matplotlib_3d()
plot()
signed_distance_from_surface()
Boozer
IotaTargetMetric
IotaWeighted
Profile
ProfilePolynomial
ProfilePressure
ProfileScaled
ProfileSpec
ProfileSpline
Quasisymmetry
QuasisymmetryRatioResidual
RedlGeomBoozer
RedlGeomVmec
Residue
Spec
VirtualCasing
Vmec
VmecRedlBootstrapMismatch
WellWeighted
compute_trapped_fraction()
j_dot_B_Redl()
vmec_compute_geometry()
vmec_fieldlines()
vmec_splines()
ConstrainedProblem
LeastSquaresProblem
MPIObjective
QuadraticPenalty
SquaredFlux
Weight
forward_backward()
GPMO()
constrained_mpi_solve()
constrained_serial_solve()
least_squares_mpi_solve()
least_squares_serial_solve()
relax_and_split()
serial_solve()
FocusData
FocusPlasmaBnormal
calculate_on_axis_B()
coil_optimization()
discretize_polarizations()
edge_triplet()
face_triplet()
initialize_coils()
initialize_default_kwargs()
initialize_logging()
log()
make_Bnormal_plots()
make_optimization_plots()
make_qfm()
orientation_phi()
polarization_axes()
proc0_print()
read_focus_coils()
run_Poincare_plots()
stell_point_transform()
stell_vector_transform()
trace_fieldlines()
ChebyshevInterpolationRule
CurrentBase
DommaschkB()
DommaschkdB()
GPMO_ArbVec()
GPMO_ArbVec_backtracking()
GPMO_backtracking()
GPMO_baseline()
GPMO_multi()
InterpolationRule
MwPGP_algorithm()
RegularGridInterpolant3D
ReimanB()
ReimandB()
StoppingCriterion
UniformInterpolationRule
biot_savart()
biot_savart_B()
biot_savart_vector_potential_vjp_graph()
biot_savart_vjp()
biot_savart_vjp_graph()
boozer_dresidual_dc()
compute_kmnc_kmns()
compute_kmns()
define_a_uniform_cartesian_grid_between_two_toroidal_surfaces()
dipole_field_A()
dipole_field_B()
dipole_field_Bn()
dipole_field_dA()
dipole_field_dB()
fieldline_tracing()
fourier_transform_even()
fourier_transform_odd()
get_phi()
get_pointclouds_closer_than_threshold_between_two_collections()
get_pointclouds_closer_than_threshold_within_collection()
integral_BdotN()
inverse_fourier_transform_even()
inverse_fourier_transform_odd()
linkNumber()
matmult()
particle_fullorbit_tracing()
particle_guiding_center_boozer_tracing()
particle_guiding_center_tracing()
vjp()