simsopt package
Subpackages
- _core
Derivative
Float
Integer
ObjectiveFailure
OneofIntegers
OneofStrings
Optimizable
Optimizable.__add__()
Optimizable.__eq__()
Optimizable.__init__()
Optimizable.__mul__()
Optimizable.__rmul__()
Optimizable._abc_impl
Optimizable._add_child()
Optimizable._get_ancestors()
Optimizable._ids
Optimizable._remove_child()
Optimizable._update_full_dof_size_indices()
Optimizable.add_parent()
Optimizable.add_return_fn()
Optimizable.append_parent()
Optimizable.as_dict()
Optimizable.bounds
Optimizable.dof_names
Optimizable.dof_size
Optimizable.dofs
Optimizable.dofs_free_status
Optimizable.fix()
Optimizable.fix_all()
Optimizable.from_file()
Optimizable.from_str()
Optimizable.full_bounds
Optimizable.full_dof_names
Optimizable.full_dof_size
Optimizable.full_fix()
Optimizable.full_lower_bounds
Optimizable.full_unfix()
Optimizable.full_upper_bounds
Optimizable.full_x
Optimizable.get()
Optimizable.get_parent_return_fns_list()
Optimizable.get_return_fn_list()
Optimizable.get_return_fn_names()
Optimizable.get_return_fns()
Optimizable.is_fixed()
Optimizable.is_free()
Optimizable.local_bounds
Optimizable.local_dof_names
Optimizable.local_dof_size
Optimizable.local_dofs_free_status
Optimizable.local_fix_all()
Optimizable.local_full_dof_names
Optimizable.local_full_dof_size
Optimizable.local_full_lower_bounds
Optimizable.local_full_upper_bounds
Optimizable.local_full_x
Optimizable.local_lower_bounds
Optimizable.local_unfix_all()
Optimizable.local_upper_bounds
Optimizable.local_x
Optimizable.lower_bounds
Optimizable.parent_return_fns_no
Optimizable.plot_graph()
Optimizable.pop_parent()
Optimizable.recompute_bell()
Optimizable.remove_parent()
Optimizable.replace_dofs()
Optimizable.return_fn_map
Optimizable.save()
Optimizable.set()
Optimizable.set_lower_bound()
Optimizable.set_recompute_flag()
Optimizable.set_upper_bound()
Optimizable.unfix()
Optimizable.unfix_all()
Optimizable.unique_dof_lineage
Optimizable.update_free_dof_size_indices()
Optimizable.upper_bounds
Optimizable.x
Optimizable.x0
OptimizableSum
PositiveFloat
PositiveInteger
ScaledOptimizable
String
load()
make_optimizable()
save()
- configs
- field
BiotSavart
BiotSavart.A_and_dA_vjp()
BiotSavart.A_vjp()
BiotSavart.B_and_dB_vjp()
BiotSavart.B_vjp()
BiotSavart.as_dict()
BiotSavart.d2A_by_dXdcoilcurrents()
BiotSavart.d2B_by_dXdcoilcurrents()
BiotSavart.d3A_by_dXdXdcoilcurrents()
BiotSavart.d3B_by_dXdXdcoilcurrents()
BiotSavart.dA_by_dcoilcurrents()
BiotSavart.dB_by_dcoilcurrents()
BiotSavart.from_dict()
BoozerAnalytic
BoozerMagneticField
BoozerRadialInterpolant
CircularCoil
Coil
Current
DipoleField
Dommaschk
InterpolatedBoozerField
InterpolatedField
IterationStoppingCriterion
LevelsetStoppingCriterion
MGrid
MagneticField
MagneticFieldMultiply
MagneticFieldSum
MaxToroidalFluxStoppingCriterion
MinToroidalFluxStoppingCriterion
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()
- geo
ArclengthVariation
Area
BoozerSurface
BoozerSurface.boozer_exact_constraints()
BoozerSurface.boozer_penalty_constraints()
BoozerSurface.minimize_boozer_exact_constraints_newton()
BoozerSurface.minimize_boozer_penalty_constraints_LBFGS()
BoozerSurface.minimize_boozer_penalty_constraints_ls()
BoozerSurface.minimize_boozer_penalty_constraints_newton()
BoozerSurface.recompute_bell()
BoozerSurface.solve_residual_equation_exactly_newton()
Curve
Curve.dfrenet_frame_by_dcoeff()
Curve.dgamma_by_dcoeff_vjp()
Curve.dgammadash_by_dcoeff_vjp()
Curve.dgammadashdash_by_dcoeff_vjp()
Curve.dgammadashdashdash_by_dcoeff_vjp()
Curve.dincremental_arclength_by_dcoeff_vjp()
Curve.dkappa_by_dcoeff_impl()
Curve.dkappa_by_dcoeff_vjp()
Curve.dkappadash_by_dcoeff()
Curve.dtorsion_by_dcoeff_impl()
Curve.dtorsion_by_dcoeff_vjp()
Curve.frenet_frame()
Curve.kappa_impl()
Curve.kappadash()
Curve.plot()
Curve.recompute_bell()
Curve.torsion_impl()
CurveCurveDistance
CurveFilament
CurveHelical
CurveLength
CurvePerturbed
CurvePerturbed.__init__()
CurvePerturbed.dgamma_by_dcoeff_vjp()
CurvePerturbed.dgammadash_by_dcoeff_vjp()
CurvePerturbed.dgammadashdash_by_dcoeff_vjp()
CurvePerturbed.dgammadashdashdash_by_dcoeff_vjp()
CurvePerturbed.gamma_impl()
CurvePerturbed.gammadash_impl()
CurvePerturbed.gammadashdash_impl()
CurvePerturbed.gammadashdashdash_impl()
CurvePerturbed.recompute_bell()
CurvePerturbed.resample()
CurveRZFourier
CurveSurfaceDistance
CurveXYZFourier
FilamentRotation
GaussianSampler
Iotas
JaxCurveXYZFourier
LinkingNumber
LpCurveCurvature
LpCurveTorsion
MajorRadius
MeanSquaredCurvature
NonQuasiSymmetricRatio
PermanentMagnetGrid
PerturbationSample
PrincipalCurvature
QfmResidual
QfmSurface
RotatedCurve
RotatedCurve.dgamma_by_dcoeff_impl()
RotatedCurve.dgamma_by_dcoeff_vjp()
RotatedCurve.dgammadash_by_dcoeff_impl()
RotatedCurve.dgammadash_by_dcoeff_vjp()
RotatedCurve.dgammadashdash_by_dcoeff_impl()
RotatedCurve.dgammadashdash_by_dcoeff_vjp()
RotatedCurve.dgammadashdashdash_by_dcoeff_impl()
RotatedCurve.dgammadashdashdash_by_dcoeff_vjp()
RotatedCurve.flip
RotatedCurve.gamma_impl()
RotatedCurve.gammadash_impl()
RotatedCurve.gammadashdash_impl()
RotatedCurve.gammadashdashdash_impl()
RotatedCurve.get_dofs()
RotatedCurve.num_dofs()
RotatedCurve.set_dofs_impl()
Surface
Surface.RANGE_FIELD_PERIOD
Surface.RANGE_FULL_TORUS
Surface.RANGE_HALF_PERIOD
Surface.arclength_poloidal_angle()
Surface.aspect_ratio()
Surface.cross_section()
Surface.daspect_ratio_by_dcoeff()
Surface.dmajor_radius_by_dcoeff()
Surface.dmean_cross_sectional_area_by_dcoeff()
Surface.dminor_radius_by_dcoeff()
Surface.from_nphi_ntheta()
Surface.get_phi_quadpoints()
Surface.get_quadpoints()
Surface.get_theta_quadpoints()
Surface.interpolate_on_arclength_grid()
Surface.major_radius()
Surface.mean_cross_sectional_area()
Surface.minor_radius()
Surface.plot()
Surface.to_RZFourier()
Surface.to_vtk()
SurfaceClassifier
SurfaceGarabedian
SurfaceGarabedian.Delta
SurfaceGarabedian.area()
SurfaceGarabedian.area_volume()
SurfaceGarabedian.fix_range()
SurfaceGarabedian.from_RZFourier()
SurfaceGarabedian.get_Delta()
SurfaceGarabedian.get_dofs()
SurfaceGarabedian.mmax
SurfaceGarabedian.mmin
SurfaceGarabedian.nfp
SurfaceGarabedian.nmax
SurfaceGarabedian.nmin
SurfaceGarabedian.return_fn_map
SurfaceGarabedian.set_Delta()
SurfaceGarabedian.set_dofs()
SurfaceGarabedian.to_RZFourier()
SurfaceGarabedian.volume()
SurfaceHenneberg
SurfaceHenneberg._validate_mn()
SurfaceHenneberg.allocate()
SurfaceHenneberg.alpha_fac
SurfaceHenneberg.fixed_range()
SurfaceHenneberg.from_RZFourier()
SurfaceHenneberg.gamma_impl()
SurfaceHenneberg.gamma_lin()
SurfaceHenneberg.gammadash1_impl()
SurfaceHenneberg.gammadash2_impl()
SurfaceHenneberg.get_dofs()
SurfaceHenneberg.get_rhomn()
SurfaceHenneberg.mmax
SurfaceHenneberg.nfp
SurfaceHenneberg.nmax
SurfaceHenneberg.num_dofs()
SurfaceHenneberg.set_dofs()
SurfaceHenneberg.set_dofs_impl()
SurfaceHenneberg.set_rhomn()
SurfaceHenneberg.to_RZFourier()
SurfaceRZFourier
SurfaceRZFourier._make_mn()
SurfaceRZFourier._make_names()
SurfaceRZFourier._validate_mn()
SurfaceRZFourier.change_resolution()
SurfaceRZFourier.darea()
SurfaceRZFourier.dvolume()
SurfaceRZFourier.fixed_range()
SurfaceRZFourier.from_focus()
SurfaceRZFourier.from_pyQSC()
SurfaceRZFourier.from_vmec_input()
SurfaceRZFourier.from_wout()
SurfaceRZFourier.get_dofs()
SurfaceRZFourier.get_nml()
SurfaceRZFourier.get_rc()
SurfaceRZFourier.get_rs()
SurfaceRZFourier.get_zc()
SurfaceRZFourier.get_zs()
SurfaceRZFourier.recompute_bell()
SurfaceRZFourier.return_fn_map
SurfaceRZFourier.set_dofs()
SurfaceRZFourier.set_rc()
SurfaceRZFourier.set_rs()
SurfaceRZFourier.set_zc()
SurfaceRZFourier.set_zs()
SurfaceRZFourier.to_RZFourier()
SurfaceRZFourier.write_nml()
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()
- mhd
Boozer
IotaTargetMetric
IotaWeighted
Profile
ProfilePolynomial
ProfilePressure
ProfileScaled
ProfileSpec
ProfileSpline
Quasisymmetry
QuasisymmetryRatioResidual
RedlGeomBoozer
RedlGeomVmec
Residue
Spec
Spec.boundary
Spec.get_dofs()
Spec.get_profile()
Spec.helicity_profile
Spec.init()
Spec.interface_current_profile
Spec.iota()
Spec.iota_profile
Spec.mu_profile
Spec.oita_profile
Spec.pflux_profile
Spec.pressure_profile
Spec.recompute_bell()
Spec.run()
Spec.set_dofs()
Spec.set_profile()
Spec.tflux_profile
Spec.volume()
Spec.volume_current_profile
VirtualCasing
Vmec
Vmec.iter
Vmec.s_full_grid
Vmec.s_half_grid
Vmec.ds
Vmec.__repr__()
Vmec.aspect()
Vmec.boundary
Vmec.current_profile
Vmec.external_current()
Vmec.get_dofs()
Vmec.get_input()
Vmec.get_max_mn()
Vmec.iota_axis()
Vmec.iota_edge()
Vmec.iota_profile
Vmec.load_wout()
Vmec.mean_iota()
Vmec.mean_shear()
Vmec.pressure_profile
Vmec.recompute_bell()
Vmec.return_fn_map
Vmec.run()
Vmec.set_dofs()
Vmec.set_indata()
Vmec.set_profile()
Vmec.update_mpi()
Vmec.vacuum_well()
Vmec.volume()
Vmec.write_input()
VmecRedlBootstrapMismatch
WellWeighted
compute_trapped_fraction()
j_dot_B_Redl()
vmec_compute_geometry()
vmec_fieldlines()
vmec_splines()
- objectives
- solve
- util
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()