Contents
Tutorials
API reference
Derivative
ObjectiveFailure
Optimizable
OptimizableSum
ScaledOptimizable
load()
make_optimizable()
save()
get_giuliani_data()
get_hsx_data()
get_ncsx_data()
BiotSavart
BoozerAnalytic
BoozerMagneticField
BoozerRadialInterpolant
CircularCoil
Coil
Current
Dommaschk
InterpolatedBoozerField
InterpolatedField
IterationStoppingCriterion
LevelsetStoppingCriterion
MagneticField
MagneticFieldMultiply
MagneticFieldSum
MaxToroidalFluxStoppingCriterion
MinToroidalFluxStoppingCriterion
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()
particles_to_vtk()
plot_poincare_data()
trace_particles()
trace_particles_boozer()
trace_particles_starting_on_curve()
trace_particles_starting_on_surface()
ArclengthVariation
Area
BoozerSurface
Curve
CurveCurveDistance
CurveFilament
CurveHelical
CurveLength
CurvePerturbed
CurveRZFourier
CurveSurfaceDistance
CurveXYZFourier
FilamentRotation
GaussianSampler
JaxCurveXYZFourier
LinkingNumber
LpCurveCurvature
LpCurveTorsion
MeanSquaredCurvature
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_multifilament_grid()
curves_to_vtk()
fix_matplotlib_3d()
plot()
signed_distance_from_surface()
Boozer
IotaTargetMetric
IotaWeighted
Profile
ProfilePolynomial
ProfilePressure
ProfileScaled
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()
LeastSquaresProblem
MPIObjective
QuadraticPenalty
SquaredFlux
Weight
least_squares_mpi_solve()
least_squares_serial_solve()
serial_solve()
initialize_logging()
log()
ChebyshevInterpolationRule
CurrentBase
DommaschkB()
DommaschkdB()
InterpolationRule
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()
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()
The source code for simsopt can be found at https://github.com/hiddenSymmetries/simsopt.
simsopt