Simsopt Python API
Subpackages
- simsopt._core package
- Submodules
- simsopt._core.derivative module
- simsopt._core.descriptor module
- simsopt._core.finite_difference module
- simsopt._core.optimizable module
OptimizableOptimizable.__add__()Optimizable.__eq__()Optimizable.__init__()Optimizable.__mul__()Optimizable.__rmul__()Optimizable._abc_implOptimizable._add_child()Optimizable._get_ancestors()Optimizable._idsOptimizable._remove_child()Optimizable._update_full_dof_size_indices()Optimizable.add_parent()Optimizable.add_return_fn()Optimizable.append_parent()Optimizable.as_dict()Optimizable.boundsOptimizable.dof_namesOptimizable.dof_sizeOptimizable.dofsOptimizable.dofs_free_statusOptimizable.fix()Optimizable.fix_all()Optimizable.from_file()Optimizable.from_str()Optimizable.full_boundsOptimizable.full_dof_namesOptimizable.full_dof_sizeOptimizable.full_fix()Optimizable.full_lower_boundsOptimizable.full_unfix()Optimizable.full_upper_boundsOptimizable.full_xOptimizable.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_boundsOptimizable.local_dof_namesOptimizable.local_dof_sizeOptimizable.local_dofs_free_statusOptimizable.local_fix_all()Optimizable.local_full_dof_namesOptimizable.local_full_dof_sizeOptimizable.local_full_lower_boundsOptimizable.local_full_upper_boundsOptimizable.local_full_xOptimizable.local_lower_boundsOptimizable.local_unfix_all()Optimizable.local_upper_boundsOptimizable.local_xOptimizable.lower_boundsOptimizable.parent_return_fns_noOptimizable.plot_graph()Optimizable.pop_parent()Optimizable.recompute_bell()Optimizable.remove_parent()Optimizable.replace_dofs()Optimizable.return_fn_mapOptimizable.save()Optimizable.set()Optimizable.set_lower_bound()Optimizable.set_recompute_flag()Optimizable.set_upper_bound()Optimizable.unfix()Optimizable.unfix_all()Optimizable.unique_dof_lineageOptimizable.update_free_dof_size_indices()Optimizable.upper_boundsOptimizable.xOptimizable.x0
OptimizableSumScaledOptimizableload()make_optimizable()save()
- simsopt._core.util module
- simsopt.configs package
- simsopt.field package
- Submodules
- simsopt.field.biotsavart module
BiotSavartBiotSavart.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()
- simsopt.field.boozermagneticfield module
- simsopt.field.coil module
- simsopt.field.coilset module
CoilSetCoilSet._circlecurves_around_surface()CoilSet.arc_length_variation_penalty()CoilSet.base_coilsCoilSet.cc_distance_penalty()CoilSet.cs_distance_penalty()CoilSet.flux_penalty()CoilSet.for_surface()CoilSet.from_makegrid_file()CoilSet.get_dof_orders()CoilSet.length_penalty()CoilSet.lp_curvature_penalty()CoilSet.meansquared_curvature_penalty()CoilSet.meansquared_curvature_threshold()CoilSet.plot()CoilSet.reduce()CoilSet.surfaceCoilSet.to_makegrid_file()CoilSet.to_vtk()CoilSet.total_lengthCoilSet.total_length_penalty()
ReducedCoilSetReducedCoilSet.__init__()ReducedCoilSet.base_coilsReducedCoilSet.coilsReducedCoilSet.coilsetReducedCoilSet.from_function()ReducedCoilSet.get_dof_orders()ReducedCoilSet.lsvReducedCoilSet.nsvReducedCoilSet.plot_singular_vector()ReducedCoilSet.recalculate_reduced_basis()ReducedCoilSet.rsvReducedCoilSet.set_dofs()ReducedCoilSet.singular_valuesReducedCoilSet.surface
- simsopt.field.force module
B2EnergyLpCurveForceLpCurveTorqueNetFluxesSquaredMeanForceSquaredMeanTorque_B_at_point_from_coil_set_pure()_check_downsample()_check_quadpoints_consistency()_coil_coil_inductances_inv_pure()_coil_coil_inductances_pure()_induced_currents_pure()_lorentz_force_density_pure()_mutual_B_field_at_point_pure()_net_fluxes_pure()_prepare_regularized_target_source_inputs_pure()_prepare_target_source_inputs_pure()
- simsopt.field.magnetic_axis_helpers module
- simsopt.field.magneticfield module
- simsopt.field.magneticfieldclasses module
- simsopt.field.mgrid module
- simsopt.field.normal_field module
CoilNormalFieldCoilNormalField.change_resolution()CoilNormalField.coilsetCoilNormalField.fixed_range()CoilNormalField.from_spec()CoilNormalField.from_spec_object()CoilNormalField.get_dofs()CoilNormalField.get_index_in_array()CoilNormalField.get_index_in_dofs()CoilNormalField.get_vnc()CoilNormalField.get_vnc_asarray()CoilNormalField.get_vns()CoilNormalField.get_vns_asarray()CoilNormalField.get_vns_vnc_asarray()CoilNormalField.optimize_coils()CoilNormalField.recompute_bell()CoilNormalField.reduce_coilset()CoilNormalField.set_vnc()CoilNormalField.set_vnc_asarray()CoilNormalField.set_vns()CoilNormalField.set_vns_asarray()CoilNormalField.set_vns_vnc_asarray()CoilNormalField.surfaceCoilNormalField.vncCoilNormalField.vns
NormalFieldNormalField._make_names()NormalField.change_resolution()NormalField.check_mn()NormalField.fixed_range()NormalField.from_spec()NormalField.from_spec_object()NormalField.get_dofs()NormalField.get_index_in_array()NormalField.get_index_in_dofs()NormalField.get_real_space_field()NormalField.get_vnc()NormalField.get_vnc_asarray()NormalField.get_vns()NormalField.get_vns_asarray()NormalField.get_vns_vnc_asarray()NormalField.set_vnc()NormalField.set_vnc_asarray()NormalField.set_vns()NormalField.set_vns_asarray()NormalField.set_vns_vnc_asarray()NormalField.vncNormalField.vns
- simsopt.field.sampling module
- simsopt.field.selffield module
- simsopt.field.tracing module
IterationStoppingCriterionLevelsetStoppingCriterionMaxRStoppingCriterionMaxToroidalFluxStoppingCriterionMaxZStoppingCriterionMinRStoppingCriterionMinToroidalFluxStoppingCriterionMinZStoppingCriterionSurfaceClassifierToroidalTransitStoppingCriterioncompute_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()
- simsopt.field.wireframefield module
- simsopt.geo package
- Submodules
- simsopt.geo.boozersurface module
BoozerSurfaceBoozerSurface.__init__()BoozerSurface._get_residual_vector_and_jacobian()BoozerSurface.boozer_exact_constraints()BoozerSurface.boozer_penalty_constraints_vectorized()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.run_code()BoozerSurface.solve_residual_equation_exactly_newton()
- simsopt.geo.config module
- simsopt.geo.curve module
CurveCurve.centroid()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()
JaxCurveJaxCurve.dgamma_by_dcoeff_impl()JaxCurve.dgamma_by_dcoeff_vjp_impl()JaxCurve.dgammadash_by_dcoeff_impl()JaxCurve.dgammadash_by_dcoeff_vjp_impl()JaxCurve.dgammadashdash_by_dcoeff_impl()JaxCurve.dgammadashdash_by_dcoeff_vjp_impl()JaxCurve.dgammadashdashdash_by_dcoeff_impl()JaxCurve.dgammadashdashdash_by_dcoeff_vjp_impl()JaxCurve.dkappa_by_dcoeff_vjp()JaxCurve.dtorsion_by_dcoeff_vjp()JaxCurve.gamma_impl()JaxCurve.gammadash_impl()JaxCurve.gammadashdash_impl()JaxCurve.gammadashdashdash_impl()JaxCurve.incremental_arclength_impl()JaxCurve.set_dofs()
RotatedCurveRotatedCurve.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.flipRotatedCurve.gamma_impl()RotatedCurve.gammadash_impl()RotatedCurve.gammadashdash_impl()RotatedCurve.gammadashdashdash_impl()RotatedCurve.get_dofs()RotatedCurve.num_dofs()RotatedCurve.set_dofs_impl()
_setup_uniform_grid_in_bounding_box()create_equally_spaced_curves()create_equally_spaced_planar_curves()create_planar_curves_between_two_toroidal_surfaces()curves_to_vtk()
- simsopt.geo.curvehelical module
- simsopt.geo.curveobjectives module
- simsopt.geo.curveperturbed module
CurvePerturbedCurvePerturbed.__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()
GaussianSamplerPerturbationSample
- simsopt.geo.curveplanarfourier module
- simsopt.geo.curverzfourier module
- simsopt.geo.curvexyzfourier module
- simsopt.geo.curvexyzfouriersymmetries module
- simsopt.geo.finitebuild module
- simsopt.geo.framedcurve module
FrameRotationFramedCurveFramedCurveCentroidFramedCurveCentroid.dframe_binormal_curvature_by_dcoeff_vjp()FramedCurveCentroid.dframe_torsion_by_dcoeff_vjp()FramedCurveCentroid.frame_binormal_curvature()FramedCurveCentroid.frame_torsion()FramedCurveCentroid.rotated_frame()FramedCurveCentroid.rotated_frame_dash()FramedCurveCentroid.rotated_frame_dash_dcoeff_vjp()FramedCurveCentroid.rotated_frame_dcoeff_vjp()
FramedCurveFrenetFramedCurveFrenet.dframe_binormal_curvature_by_dcoeff_vjp()FramedCurveFrenet.dframe_torsion_by_dcoeff_vjp()FramedCurveFrenet.frame_binormal_curvature()FramedCurveFrenet.frame_torsion()FramedCurveFrenet.rotated_frame()FramedCurveFrenet.rotated_frame_dash()FramedCurveFrenet.rotated_frame_dash_dcoeff_vjp()FramedCurveFrenet.rotated_frame_dcoeff_vjp()
ZeroRotation
- simsopt.geo.jit module
- simsopt.geo.permanent_magnet_grid module
- simsopt.geo.plotting module
- simsopt.geo.ports module
- simsopt.geo.qfmsurface module
- simsopt.geo.strain_optimization module
- simsopt.geo.surface module
SurfaceSurface.RANGE_FIELD_PERIODSurface.RANGE_FULL_TORUSSurface.RANGE_HALF_PERIODSurface.arclength_poloidal_angle()Surface.aspect_ratio()Surface.cross_section()Surface.d2aspect_ratio_by_dcoeff_dcoeff()Surface.d2major_radius_by_dcoeff_dcoeff()Surface.d2mean_cross_sectional_area_by_dcoeff_dcoeff()Surface.d2minor_radius_by_dcoeff_dcoeff()Surface.daspect_ratio_by_dcoeff()Surface.deduced_rangeSurface.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.is_self_intersecting()Surface.major_radius()Surface.make_theta_uniform_arclength()Surface.mean_cross_sectional_area()Surface.minor_radius()Surface.plot()Surface.to_RZFourier()Surface.to_vtk()
SurfaceClassifierSurfaceScaledbest_nphi_over_ntheta()signed_distance_from_surface()
- simsopt.geo.surfacegarabedian module
SurfaceGarabedianSurfaceGarabedian.DeltaSurfaceGarabedian.area()SurfaceGarabedian.area_volume()SurfaceGarabedian.fix_range()SurfaceGarabedian.from_RZFourier()SurfaceGarabedian.get_Delta()SurfaceGarabedian.get_dofs()SurfaceGarabedian.mmaxSurfaceGarabedian.mminSurfaceGarabedian.nfpSurfaceGarabedian.nmaxSurfaceGarabedian.nminSurfaceGarabedian.return_fn_mapSurfaceGarabedian.set_Delta()SurfaceGarabedian.set_dofs()SurfaceGarabedian.to_RZFourier()SurfaceGarabedian.volume()
- simsopt.geo.surfacehenneberg module
SurfaceHennebergSurfaceHenneberg._validate_mn()SurfaceHenneberg.allocate()SurfaceHenneberg.alpha_facSurfaceHenneberg.fixed_range()SurfaceHenneberg.from_RZFourier()SurfaceHenneberg.gamma_impl()SurfaceHenneberg.gamma_lin()SurfaceHenneberg.gammadash1_impl()SurfaceHenneberg.gammadash2_impl()SurfaceHenneberg.get_dofs()SurfaceHenneberg.get_rhomn()SurfaceHenneberg.mmaxSurfaceHenneberg.nfpSurfaceHenneberg.nmaxSurfaceHenneberg.num_dofs()SurfaceHenneberg.set_dofs()SurfaceHenneberg.set_dofs_impl()SurfaceHenneberg.set_rhomn()SurfaceHenneberg.to_RZFourier()
- simsopt.geo.surfaceobjectives module
- simsopt.geo.surfacerzfourier module
SurfaceRZFourierSurfaceRZFourier._make_mn()SurfaceRZFourier._make_names()SurfaceRZFourier._validate_mn()SurfaceRZFourier.change_resolution()SurfaceRZFourier.condense_spectrum()SurfaceRZFourier.copy()SurfaceRZFourier.darea()SurfaceRZFourier.dvolume()SurfaceRZFourier.extend_via_normal()SurfaceRZFourier.fixed_range()SurfaceRZFourier.flip_phi()SurfaceRZFourier.flip_theta()SurfaceRZFourier.flip_z()SurfaceRZFourier.fourier_transform_scalar()SurfaceRZFourier.from_focus()SurfaceRZFourier.from_nescoil_input()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.inverse_fourier_transform_scalar()SurfaceRZFourier.make_rotating_ellipse()SurfaceRZFourier.recompute_bell()SurfaceRZFourier.return_fn_mapSurfaceRZFourier.rotate_half_field_period()SurfaceRZFourier.set_dofs()SurfaceRZFourier.set_rc()SurfaceRZFourier.set_rs()SurfaceRZFourier.set_zc()SurfaceRZFourier.set_zs()SurfaceRZFourier.shift_theta_by_half()SurfaceRZFourier.spectral_width()SurfaceRZFourier.to_RZFourier()SurfaceRZFourier.write_nml()
SurfaceRZPseudospectralplot_spectral_condensation()
- simsopt.geo.surfacexyzfourier module
- simsopt.geo.surfacexyztensorfourier module
SurfaceXYZTensorFourierSurfaceXYZTensorFourier._make_names()SurfaceXYZTensorFourier._make_names_helper()SurfaceXYZTensorFourier.extend_via_normal()SurfaceXYZTensorFourier.get_dofs()SurfaceXYZTensorFourier.get_stellsym_mask()SurfaceXYZTensorFourier.recompute_bell()SurfaceXYZTensorFourier.set_dofs()SurfaceXYZTensorFourier.skip()SurfaceXYZTensorFourier.to_RZFourier()
- simsopt.geo.wireframe_toroidal module
ToroidalWireframeToroidalWireframe.add_constraint()ToroidalWireframe.add_continuity_constraint()ToroidalWireframe.add_continuity_constraints()ToroidalWireframe.add_poloidal_current_constraint()ToroidalWireframe.add_segment_constraints()ToroidalWireframe.add_tfcoil_currents()ToroidalWireframe.add_toroidal_current_constraint()ToroidalWireframe.check_constraints()ToroidalWireframe.constrain_colliding_segments()ToroidalWireframe.constrained_segments()ToroidalWireframe.constraint_matrices()ToroidalWireframe.determine_connected_segments()ToroidalWireframe.find_inactive_nodes()ToroidalWireframe.free_all_segments()ToroidalWireframe.get_cell_key()ToroidalWireframe.get_cell_neighbors()ToroidalWireframe.get_free_cells()ToroidalWireframe.initialize_constraints()ToroidalWireframe.make_plot_2d()ToroidalWireframe.make_plot_3d()ToroidalWireframe.plot_cells_2d()ToroidalWireframe.remove_constraint()ToroidalWireframe.remove_poloidal_current_constraint()ToroidalWireframe.remove_segment_constraints()ToroidalWireframe.remove_toroidal_current_constraint()ToroidalWireframe.set_poloidal_current()ToroidalWireframe.set_segments_constrained()ToroidalWireframe.set_segments_free()ToroidalWireframe.set_toroidal_breaks()ToroidalWireframe.set_toroidal_current()ToroidalWireframe.set_up_cell_key()ToroidalWireframe.to_vtk()ToroidalWireframe.unconstrained_segments()ToroidalWireframe.update_implicit_constraints()
windowpane_wireframe()
- simsopt.mhd package
- Submodules
- simsopt.mhd.bootstrap module
- simsopt.mhd.boozer module
- simsopt.mhd.profiles module
- simsopt.mhd.spec module
ResidueSpecSpec.SpecFourierArraySpec._clear_f90wrap_array_caches()Spec._init_fortran_state()Spec._read_initial_guess()Spec._set_spec_initial_guess()Spec.activate_profile()Spec.array_translator()Spec.boundarySpec.computational_boundarySpec.default_fixedboundary()Spec.default_freeboundary()Spec.get_dofs()Spec.get_profile()Spec.helicity_profileSpec.interface_current_profileSpec.iota()Spec.iota_profileSpec.mu_profileSpec.normal_fieldSpec.oita_profileSpec.pflux_profileSpec.poloidal_current_amperesSpec.pressure_profileSpec.recompute_bell()Spec.run()Spec.set_dofs()Spec.set_profile()Spec.tflux_profileSpec.volume()Spec.volume_current_profile
- simsopt.mhd.virtual_casing module
- simsopt.mhd.vmec module
VmecVmec.iterVmec.s_full_gridVmec.s_half_gridVmec.dsVmec.__repr__()Vmec.aspect()Vmec.boundaryVmec.current_profileVmec.external_current()Vmec.get_dofs()Vmec.get_input()Vmec.get_max_mn()Vmec.iota_axis()Vmec.iota_edge()Vmec.iota_profileVmec.load_wout()Vmec.mean_iota()Vmec.mean_shear()Vmec.pressure_profileVmec.recompute_bell()Vmec.return_fn_mapVmec.run()Vmec.set_dofs()Vmec.set_indata()Vmec.set_profile()Vmec.update_mpi()Vmec.vacuum_well()Vmec.volume()Vmec.write_input()
- simsopt.mhd.vmec_diagnostics module
IotaTargetMetricIotaWeightedQuasisymmetryRatioResidualVmecGeometryResultsVmecGeometryResults.B_XVmecGeometryResults.B_YVmecGeometryResults.B_ZVmecGeometryResults.B_cross_grad_B_dot_grad_alphaVmecGeometryResults.B_cross_grad_B_dot_grad_alpha_alternateVmecGeometryResults.B_cross_grad_B_dot_grad_psiVmecGeometryResults.B_cross_grad_s_dot_grad_alphaVmecGeometryResults.B_cross_grad_s_dot_grad_alpha_alternateVmecGeometryResults.B_cross_kappa_dot_grad_alphaVmecGeometryResults.B_cross_kappa_dot_grad_psiVmecGeometryResults.B_referenceVmecGeometryResults.B_sub_phiVmecGeometryResults.B_sub_sVmecGeometryResults.B_sub_theta_vmecVmecGeometryResults.B_sup_phiVmecGeometryResults.B_sup_theta_pestVmecGeometryResults.B_sup_theta_vmecVmecGeometryResults.L_grad_BVmecGeometryResults.L_referenceVmecGeometryResults.RVmecGeometryResults.XVmecGeometryResults.YVmecGeometryResults.ZVmecGeometryResults.alphaVmecGeometryResults.bmagVmecGeometryResults.cosphiVmecGeometryResults.cvdriftVmecGeometryResults.cvdrift0VmecGeometryResults.d2_R_d_phi2VmecGeometryResults.d2_R_d_s_d_phiVmecGeometryResults.d2_R_d_s_d_theta_vmecVmecGeometryResults.d2_R_d_theta_vmec2VmecGeometryResults.d2_R_d_theta_vmec_d_phiVmecGeometryResults.d2_Z_d_phi2VmecGeometryResults.d2_Z_d_s_d_phiVmecGeometryResults.d2_Z_d_s_d_theta_vmecVmecGeometryResults.d2_Z_d_theta_vmec2VmecGeometryResults.d2_Z_d_theta_vmec_d_phiVmecGeometryResults.d_B_d_phiVmecGeometryResults.d_B_d_sVmecGeometryResults.d_B_d_theta_vmecVmecGeometryResults.d_B_sup_phi_d_phiVmecGeometryResults.d_B_sup_phi_d_sVmecGeometryResults.d_B_sup_phi_d_theta_vmecVmecGeometryResults.d_B_sup_theta_vmec_d_phiVmecGeometryResults.d_B_sup_theta_vmec_d_sVmecGeometryResults.d_B_sup_theta_vmec_d_theta_vmecVmecGeometryResults.d_R_d_phiVmecGeometryResults.d_R_d_sVmecGeometryResults.d_R_d_theta_vmecVmecGeometryResults.d_X_d_phiVmecGeometryResults.d_X_d_sVmecGeometryResults.d_X_d_theta_vmecVmecGeometryResults.d_Y_d_phiVmecGeometryResults.d_Y_d_sVmecGeometryResults.d_Y_d_theta_vmecVmecGeometryResults.d_Z_d_phiVmecGeometryResults.d_Z_d_sVmecGeometryResults.d_Z_d_theta_vmecVmecGeometryResults.d_iota_d_sVmecGeometryResults.d_lambda_d_phiVmecGeometryResults.d_lambda_d_sVmecGeometryResults.d_lambda_d_theta_vmecVmecGeometryResults.d_pressure_d_sVmecGeometryResults.edge_toroidal_flux_over_2piVmecGeometryResults.gbdriftVmecGeometryResults.gbdrift0VmecGeometryResults.gds2VmecGeometryResults.gds21VmecGeometryResults.gds22VmecGeometryResults.grad_B_XVmecGeometryResults.grad_B_YVmecGeometryResults.grad_B_ZVmecGeometryResults.grad_B__XXVmecGeometryResults.grad_B__XYVmecGeometryResults.grad_B__XZVmecGeometryResults.grad_B__YXVmecGeometryResults.grad_B__YYVmecGeometryResults.grad_B__YZVmecGeometryResults.grad_B__ZXVmecGeometryResults.grad_B__ZYVmecGeometryResults.grad_B__ZZVmecGeometryResults.grad_B_double_dot_grad_BVmecGeometryResults.grad_alpha_XVmecGeometryResults.grad_alpha_YVmecGeometryResults.grad_alpha_ZVmecGeometryResults.grad_alpha_dot_grad_alphaVmecGeometryResults.grad_alpha_dot_grad_psiVmecGeometryResults.grad_phi_XVmecGeometryResults.grad_phi_YVmecGeometryResults.grad_phi_ZVmecGeometryResults.grad_psi_XVmecGeometryResults.grad_psi_YVmecGeometryResults.grad_psi_ZVmecGeometryResults.grad_psi_dot_grad_psiVmecGeometryResults.grad_s_XVmecGeometryResults.grad_s_YVmecGeometryResults.grad_s_ZVmecGeometryResults.grad_s_dot_grad_sVmecGeometryResults.grad_theta_vmec_XVmecGeometryResults.grad_theta_vmec_YVmecGeometryResults.grad_theta_vmec_ZVmecGeometryResults.gradpar_phiVmecGeometryResults.gradpar_theta_pestVmecGeometryResults.iotaVmecGeometryResults.modBVmecGeometryResults.nalphaVmecGeometryResults.nlVmecGeometryResults.norm_grad_BVmecGeometryResults.nphiVmecGeometryResults.nsVmecGeometryResults.nthetaVmecGeometryResults.phiVmecGeometryResults.phi1dVmecGeometryResults.sVmecGeometryResults.shatVmecGeometryResults.sinphiVmecGeometryResults.sqrt_g_vmecVmecGeometryResults.sqrt_g_vmec_altVmecGeometryResults.theta1dVmecGeometryResults.theta_pestVmecGeometryResults.theta_vmecVmecGeometryResults.toroidal_flux_sign
WellWeightedvmec_compute_geometry()vmec_fieldlines()vmec_splines()
- simsopt.objectives package
- Submodules
- simsopt.objectives.constrained module
- simsopt.objectives.fluxobjective module
- simsopt.objectives.functions module
- simsopt.objectives.least_squares module
- simsopt.objectives.utilities module
- simsopt.solve package
- simsopt.util package
- Submodules
- simsopt.util.constants module
- simsopt.util.famus_helpers module
- simsopt.util.fourier_interpolation module
- simsopt.util.logger module
- simsopt.util.mpi module
- simsopt.util.mpi_logger module
- simsopt.util.permanent_magnet_helper_functions module
- simsopt.util.polarization_project module
- simsoptpp package
BiotSavartBiotSavart.A()BiotSavart.A_cyl()BiotSavart.A_cyl_ref()BiotSavart.A_ref()BiotSavart.AbsB()BiotSavart.AbsB_ref()BiotSavart.B()BiotSavart.B_cyl()BiotSavart.B_cyl_ref()BiotSavart.B_ref()BiotSavart.GradAbsB()BiotSavart.GradAbsB_cyl()BiotSavart.GradAbsB_ref()BiotSavart.coilsBiotSavart.compute()BiotSavart.d2A_by_dXdX()BiotSavart.d2A_by_dXdX_ref()BiotSavart.d2B_by_dXdX()BiotSavart.d2B_by_dXdX_ref()BiotSavart.dA_by_dX()BiotSavart.dA_by_dX_ref()BiotSavart.dB_by_dX()BiotSavart.dB_by_dX_ref()BiotSavart.fieldcache_get_or_create()BiotSavart.fieldcache_get_status()BiotSavart.get_points_cart()BiotSavart.get_points_cart_ref()BiotSavart.get_points_cyl()BiotSavart.get_points_cyl_ref()BiotSavart.invalidate_cache()BiotSavart.set_points()BiotSavart.set_points_cart()BiotSavart.set_points_cyl()
BoozerMagneticFieldBoozerMagneticField.G()BoozerMagneticField.G_ref()BoozerMagneticField.I()BoozerMagneticField.I_ref()BoozerMagneticField.K()BoozerMagneticField.K_derivs()BoozerMagneticField.K_derivs_ref()BoozerMagneticField.K_ref()BoozerMagneticField.R()BoozerMagneticField.R_derivs()BoozerMagneticField.R_derivs_ref()BoozerMagneticField.R_ref()BoozerMagneticField.Z()BoozerMagneticField.Z_derivs()BoozerMagneticField.Z_derivs_ref()BoozerMagneticField.Z_ref()BoozerMagneticField.d2modBdtheta2()BoozerMagneticField.d2modBdtheta2_ref()BoozerMagneticField.d2modBdthetadzeta()BoozerMagneticField.d2modBdthetadzeta_ref()BoozerMagneticField.d2modBdzeta2()BoozerMagneticField.d2modBdzeta2_ref()BoozerMagneticField.dGds()BoozerMagneticField.dGds_ref()BoozerMagneticField.dIds()BoozerMagneticField.dIds_ref()BoozerMagneticField.dKdtheta()BoozerMagneticField.dKdtheta_ref()BoozerMagneticField.dKdzeta()BoozerMagneticField.dKdzeta_ref()BoozerMagneticField.dRds()BoozerMagneticField.dRds_ref()BoozerMagneticField.dRdtheta()BoozerMagneticField.dRdtheta_ref()BoozerMagneticField.dRdzeta()BoozerMagneticField.dRdzeta_ref()BoozerMagneticField.dZds()BoozerMagneticField.dZds_ref()BoozerMagneticField.dZdtheta()BoozerMagneticField.dZdtheta_ref()BoozerMagneticField.dZdzeta()BoozerMagneticField.dZdzeta_ref()BoozerMagneticField.diotads()BoozerMagneticField.diotads_ref()BoozerMagneticField.dmodBds()BoozerMagneticField.dmodBds_ref()BoozerMagneticField.dmodBdtheta()BoozerMagneticField.dmodBdtheta_ref()BoozerMagneticField.dmodBdzeta()BoozerMagneticField.dmodBdzeta_ref()BoozerMagneticField.dnuds()BoozerMagneticField.dnuds_ref()BoozerMagneticField.dnudtheta()BoozerMagneticField.dnudtheta_ref()BoozerMagneticField.dnudzeta()BoozerMagneticField.dnudzeta_ref()BoozerMagneticField.get_points()BoozerMagneticField.get_points_ref()BoozerMagneticField.invalidate_cache()BoozerMagneticField.iota()BoozerMagneticField.iota_ref()BoozerMagneticField.modB()BoozerMagneticField.modB_derivs()BoozerMagneticField.modB_derivs_ref()BoozerMagneticField.modB_ref()BoozerMagneticField.nu()BoozerMagneticField.nu_derivs()BoozerMagneticField.nu_derivs_ref()BoozerMagneticField.nu_ref()BoozerMagneticField.psip()BoozerMagneticField.psip_ref()BoozerMagneticField.set_points()
ChebyshevInterpolationRuleCoilCurrentCurrentBaseCurveCurve.dgamma_by_dcoeff()Curve.dgamma_by_dcoeff_vjp_impl()Curve.dgammadash_by_dcoeff()Curve.dgammadash_by_dcoeff_vjp_impl()Curve.dgammadashdash_by_dcoeff()Curve.dgammadashdash_by_dcoeff_vjp_impl()Curve.dgammadashdashdash_by_dcoeff()Curve.dgammadashdashdash_by_dcoeff_vjp_impl()Curve.dincremental_arclength_by_dcoeff()Curve.dkappa_by_dcoeff()Curve.dtorsion_by_dcoeff()Curve.gamma()Curve.gamma_impl()Curve.gammadash()Curve.gammadashdash()Curve.gammadashdashdash()Curve.get_dofs()Curve.incremental_arclength()Curve.invalidate_cache()Curve.kappa()Curve.least_squares_fit()Curve.num_dofs()Curve.quadpointsCurve.set_dofs()Curve.set_dofs_impl()Curve.torsion()
CurvePlanarFourierCurvePlanarFourier.centerCurvePlanarFourier.dgamma_by_dcoeff()CurvePlanarFourier.dgamma_by_dcoeff_vjp_impl()CurvePlanarFourier.dgammadash_by_dcoeff()CurvePlanarFourier.dgammadash_by_dcoeff_vjp_impl()CurvePlanarFourier.dgammadashdash_by_dcoeff()CurvePlanarFourier.dgammadashdash_by_dcoeff_vjp_impl()CurvePlanarFourier.dgammadashdashdash_by_dcoeff()CurvePlanarFourier.dgammadashdashdash_by_dcoeff_vjp_impl()CurvePlanarFourier.dincremental_arclength_by_dcoeff()CurvePlanarFourier.dkappa_by_dcoeff()CurvePlanarFourier.dtorsion_by_dcoeff()CurvePlanarFourier.gamma()CurvePlanarFourier.gamma_impl()CurvePlanarFourier.gammadash()CurvePlanarFourier.gammadashdash()CurvePlanarFourier.gammadashdashdash()CurvePlanarFourier.get_dofs()CurvePlanarFourier.incremental_arclength()CurvePlanarFourier.invalidate_cache()CurvePlanarFourier.kappa()CurvePlanarFourier.least_squares_fit()CurvePlanarFourier.num_dofs()CurvePlanarFourier.orderCurvePlanarFourier.qCurvePlanarFourier.quadpointsCurvePlanarFourier.rcCurvePlanarFourier.rsCurvePlanarFourier.set_dofs()CurvePlanarFourier.set_dofs_impl()CurvePlanarFourier.torsion()
CurveRZFourierCurveRZFourier.dgamma_by_dcoeff()CurveRZFourier.dgamma_by_dcoeff_vjp_impl()CurveRZFourier.dgammadash_by_dcoeff()CurveRZFourier.dgammadash_by_dcoeff_vjp_impl()CurveRZFourier.dgammadashdash_by_dcoeff()CurveRZFourier.dgammadashdash_by_dcoeff_vjp_impl()CurveRZFourier.dgammadashdashdash_by_dcoeff()CurveRZFourier.dgammadashdashdash_by_dcoeff_vjp_impl()CurveRZFourier.dincremental_arclength_by_dcoeff()CurveRZFourier.dkappa_by_dcoeff()CurveRZFourier.dtorsion_by_dcoeff()CurveRZFourier.gamma()CurveRZFourier.gamma_impl()CurveRZFourier.gammadash()CurveRZFourier.gammadashdash()CurveRZFourier.gammadashdashdash()CurveRZFourier.get_dofs()CurveRZFourier.incremental_arclength()CurveRZFourier.invalidate_cache()CurveRZFourier.kappa()CurveRZFourier.least_squares_fit()CurveRZFourier.nfpCurveRZFourier.num_dofs()CurveRZFourier.orderCurveRZFourier.quadpointsCurveRZFourier.rcCurveRZFourier.rsCurveRZFourier.set_dofs()CurveRZFourier.set_dofs_impl()CurveRZFourier.stellsymCurveRZFourier.torsion()CurveRZFourier.zcCurveRZFourier.zs
CurveXYZFourierCurveXYZFourier.dgamma_by_dcoeff()CurveXYZFourier.dgamma_by_dcoeff_vjp_impl()CurveXYZFourier.dgammadash_by_dcoeff()CurveXYZFourier.dgammadash_by_dcoeff_vjp_impl()CurveXYZFourier.dgammadashdash_by_dcoeff()CurveXYZFourier.dgammadashdash_by_dcoeff_vjp_impl()CurveXYZFourier.dgammadashdashdash_by_dcoeff()CurveXYZFourier.dgammadashdashdash_by_dcoeff_vjp_impl()CurveXYZFourier.dincremental_arclength_by_dcoeff()CurveXYZFourier.dkappa_by_dcoeff()CurveXYZFourier.dofs_matrixCurveXYZFourier.dtorsion_by_dcoeff()CurveXYZFourier.gamma()CurveXYZFourier.gamma_impl()CurveXYZFourier.gammadash()CurveXYZFourier.gammadashdash()CurveXYZFourier.gammadashdashdash()CurveXYZFourier.get_dofs()CurveXYZFourier.incremental_arclength()CurveXYZFourier.invalidate_cache()CurveXYZFourier.kappa()CurveXYZFourier.least_squares_fit()CurveXYZFourier.num_dofs()CurveXYZFourier.orderCurveXYZFourier.quadpointsCurveXYZFourier.set_dofs()CurveXYZFourier.set_dofs_impl()CurveXYZFourier.torsion()
DommaschkB()DommaschkdB()GPMO_ArbVec()GPMO_ArbVec_backtracking()GPMO_backtracking()GPMO_baseline()GPMO_multi()GSCO()InterpolatedBoozerFieldInterpolatedBoozerField.estimate_error_G()InterpolatedBoozerField.estimate_error_I()InterpolatedBoozerField.estimate_error_K()InterpolatedBoozerField.estimate_error_R()InterpolatedBoozerField.estimate_error_Z()InterpolatedBoozerField.estimate_error_iota()InterpolatedBoozerField.estimate_error_modB()InterpolatedBoozerField.estimate_error_nu()InterpolatedBoozerField.ruleInterpolatedBoozerField.s_rangeInterpolatedBoozerField.theta_rangeInterpolatedBoozerField.zeta_range
InterpolatedFieldInterpolationRuleIterationStoppingCriterionLevelsetStoppingCriterionMagneticFieldMagneticField.A()MagneticField.A_cyl()MagneticField.A_cyl_ref()MagneticField.A_ref()MagneticField.AbsB()MagneticField.AbsB_ref()MagneticField.B()MagneticField.B_cyl()MagneticField.B_cyl_ref()MagneticField.B_ref()MagneticField.GradAbsB()MagneticField.GradAbsB_cyl()MagneticField.GradAbsB_ref()MagneticField.d2A_by_dXdX()MagneticField.d2A_by_dXdX_ref()MagneticField.d2B_by_dXdX()MagneticField.d2B_by_dXdX_ref()MagneticField.dA_by_dX()MagneticField.dA_by_dX_ref()MagneticField.dB_by_dX()MagneticField.dB_by_dX_ref()MagneticField.get_points_cart()MagneticField.get_points_cart_ref()MagneticField.get_points_cyl()MagneticField.get_points_cyl_ref()MagneticField.invalidate_cache()MagneticField.set_points()MagneticField.set_points_cart()MagneticField.set_points_cyl()
MaxRStoppingCriterionMaxToroidalFluxStoppingCriterionMaxZStoppingCriterionMinRStoppingCriterionMinToroidalFluxStoppingCriterionMinZStoppingCriterionMwPGP_algorithm()RegularGridInterpolant3DReimanB()ReimandB()StoppingCriterionSurfaceSurface.area()Surface.d2area_by_dcoeffdcoeff()Surface.d2normal_by_dcoeffdcoeff()Surface.d2volume_by_dcoeffdcoeff()Surface.darea()Surface.darea_by_dcoeff()Surface.dfirst_fund_form_by_dcoeff()Surface.dgamma_by_dcoeff()Surface.dgamma_by_dcoeff_vjp()Surface.dgammadash1_by_dcoeff()Surface.dgammadash1_by_dcoeff_vjp()Surface.dgammadash1dash1_by_dcoeff()Surface.dgammadash1dash2_by_dcoeff()Surface.dgammadash2_by_dcoeff()Surface.dgammadash2_by_dcoeff_vjp()Surface.dgammadash2dash2_by_dcoeff()Surface.dnormal_by_dcoeff()Surface.dnormal_by_dcoeff_vjp()Surface.dsecond_fund_form_by_dcoeff()Surface.dsurface_curvatures_by_dcoeff()Surface.dunitnormal_by_dcoeff()Surface.dvolume()Surface.dvolume_by_dcoeff()Surface.extend_via_projected_normal()Surface.first_fund_form()Surface.fit_to_curve()Surface.gamma()Surface.gamma_lin()Surface.gammadash1()Surface.gammadash1dash1()Surface.gammadash1dash2()Surface.gammadash2()Surface.gammadash2dash2()Surface.get_dofs()Surface.invalidate_cache()Surface.least_squares_fit()Surface.normal()Surface.quadpoints_phiSurface.quadpoints_thetaSurface.scale()Surface.second_fund_form()Surface.set_dofs()Surface.set_dofs_impl()Surface.surface_curvatures()Surface.unitnormal()Surface.volume()
SurfaceRZFourierSurfaceXYZFourierSurfaceXYZTensorFourierToroidalTransitStoppingCriterionUniformInterpolationRuleWireframeFieldWireframeField.A()WireframeField.A_cyl()WireframeField.A_cyl_ref()WireframeField.A_ref()WireframeField.AbsB()WireframeField.AbsB_ref()WireframeField.B()WireframeField.B_cyl()WireframeField.B_cyl_ref()WireframeField.B_ref()WireframeField.GradAbsB()WireframeField.GradAbsB_cyl()WireframeField.GradAbsB_ref()WireframeField.compute()WireframeField.d2A_by_dXdX()WireframeField.d2A_by_dXdX_ref()WireframeField.d2B_by_dXdX()WireframeField.d2B_by_dXdX_ref()WireframeField.dA_by_dX()WireframeField.dA_by_dX_ref()WireframeField.dB_by_dX()WireframeField.dB_by_dX_ref()WireframeField.fieldcache_get_or_create()WireframeField.fieldcache_get_status()WireframeField.get_points_cart()WireframeField.get_points_cart_ref()WireframeField.get_points_cyl()WireframeField.get_points_cyl_ref()WireframeField.invalidate_cache()WireframeField.set_points()WireframeField.set_points_cart()WireframeField.set_points_cyl()
biot_savart()biot_savart_B()biot_savart_vector_potential_vjp_graph()biot_savart_vjp()biot_savart_vjp_graph()boozer_dresidual_dc()boozer_residual()boozer_residual_ds()boozer_residual_ds2()compute_kmnc_kmns()compute_kmns()compute_linking_number()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()matmult()particle_fullorbit_tracing()particle_guiding_center_boozer_tracing()particle_guiding_center_tracing()vjp()