==================== Alphabetical Listing ==================== Basis ***** .. autosummary:: :toctree: _api/basis/ :recursive: :template: class.rst desc.basis.ChebyshevPolynomial desc.basis.ChebyshevDoubleFourierBasis desc.basis.DoubleFourierSeries desc.basis.FourierSeries desc.basis.FourierZernikeBasis desc.basis.PowerSeries desc.basis.ZernikePolynomial Coils ***** .. autosummary:: :toctree: _api/coils/ :recursive: :template: class.rst desc.coils.CoilSet desc.coils.FourierPlanarCoil desc.coils.FourierRZCoil desc.coils.FourierXYCoil desc.coils.FourierXYZCoil desc.coils.MixedCoilSet desc.coils.SplineXYZCoil desc.coils.initialize_helical_coils desc.coils.initialize_modular_coils desc.coils.initialize_saddle_coils Compatibility ************* .. autosummary:: :toctree: _api/compat :recursive: desc.compat.contract_equilibrium desc.compat.ensure_positive_jacobian desc.compat.flip_helicity desc.compat.flip_theta desc.compat.rescale desc.compat.rotate_zeta Continuation ************ .. autosummary:: :toctree: _api/continuation :recursive: desc.continuation.solve_continuation desc.continuation.solve_continuation_automatic Derivatives *********** Note that the ``derivative`` module also exposes the ``Derivative`` class, which is an alias for ``AutoDiffDerivative``. .. autosummary:: :toctree: _api/derivatives :recursive: :template: class.rst desc.derivatives.AutoDiffDerivative Equilibrium *********** .. autosummary:: :toctree: _api/equilibrium :recursive: :template: class.rst desc.equilibrium.Equilibrium desc.equilibrium.EquilibriaFamily Examples ******** .. autosummary:: :toctree: _api/examples :recursive: desc.examples.get desc.examples.listall External ******** Note that these objectives and utility functions are not regularly tested and maybe incompatible with newer version of the external code. Please see the README of the `desc.external` for more details. .. autosummary:: :toctree: _api/external :recursive: desc.external.paraview.export_coils_to_paraview desc.external.paraview.export_surface_to_paraview desc.external.paraview.export_volume_to_paraview desc.external.terpsichore.TERPSICHORE Geometry ******** .. autosummary:: :toctree: _api/geometry/ :recursive: :template: class.rst desc.geometry.FourierPlanarCurve desc.geometry.FourierRZCurve desc.geometry.FourierRZToroidalSurface desc.geometry.FourierXYCurve desc.geometry.FourierXYZCurve desc.geometry.SplineXYZCurve desc.geometry.ZernikeRZToroidalSection Grid **** .. autosummary:: :toctree: _api/grid/ :recursive: :template: class.rst desc.grid.ConcentricGrid desc.grid.Grid desc.grid.LinearGrid desc.grid.QuadratureGrid desc.grid.find_least_rational_surfaces desc.grid.find_most_rational_surfaces Integrals ********* .. autosummary:: :toctree: _api/integrals :recursive: :template: class.rst desc.integrals.Bounce2D desc.integrals.Bounce1D IO *** .. autosummary:: :toctree: _api/io/ :recursive: :template: class.rst desc.io.load Magnetic Fields *************** .. autosummary:: :toctree: _api/magnetic_fields :recursive: :template: class.rst desc.magnetic_fields.CurrentPotentialField desc.magnetic_fields.FourierCurrentPotentialField desc.magnetic_fields.DommaschkPotentialField desc.magnetic_fields.MagneticFieldFromUser desc.magnetic_fields.OmnigenousField desc.magnetic_fields.PoloidalMagneticField desc.magnetic_fields.ScalarPotentialField desc.magnetic_fields.ScaledMagneticField desc.magnetic_fields.SplineMagneticField desc.magnetic_fields.SumMagneticField desc.magnetic_fields.ToroidalMagneticField desc.magnetic_fields.VectorPotentialField desc.magnetic_fields.VerticalMagneticField desc.magnetic_fields.field_line_integrate desc.magnetic_fields.read_BNORM_file desc.magnetic_fields.solve_regularized_surface_current Objective Functions ******************* .. autosummary:: :toctree: _api/objectives :recursive: :template: class.rst desc.objectives.AspectRatio desc.objectives.BallooningStability desc.objectives.BootstrapRedlConsistency desc.objectives.BoundaryError desc.objectives.BScaleLength desc.objectives.CoilArclengthVariance desc.objectives.CoilCurrentLength desc.objectives.CoilCurvature desc.objectives.CoilIntegratedCurvature desc.objectives.CoilLength desc.objectives.CoilSetLinkingNumber desc.objectives.CoilSetMinDistance desc.objectives.CoilTorsion desc.objectives.CurrentDensity desc.objectives.EffectiveRipple desc.objectives.Elongation desc.objectives.Energy desc.objectives.ExternalObjective desc.objectives.FixAnisotropy desc.objectives.FixAtomicNumber desc.objectives.FixAxisR desc.objectives.FixAxisZ desc.objectives.FixBoundaryR desc.objectives.FixBoundaryZ desc.objectives.FixCoilCurrent desc.objectives.FixCurrent desc.objectives.FixElectronDensity desc.objectives.FixElectronTemperature desc.objectives.FixIonTemperature desc.objectives.FixIota desc.objectives.FixModeR desc.objectives.FixModeZ desc.objectives.FixNearAxisR desc.objectives.FixNearAxisZ desc.objectives.FixNearAxisLambda desc.objectives.FixOmniBmax desc.objectives.FixOmniMap desc.objectives.FixOmniWell desc.objectives.FixParameters desc.objectives.FixPressure desc.objectives.FixPsi desc.objectives.FixSumCoilCurrent desc.objectives.FixSumModesLambda desc.objectives.FixSumModesR desc.objectives.FixSumModesZ desc.objectives.FixThetaSFL desc.objectives.ForceBalance desc.objectives.ForceBalanceAnisotropic desc.objectives.FusionPower desc.objectives.GammaC desc.objectives.GenericObjective desc.objectives.get_equilibrium_objective desc.objectives.get_fixed_axis_constraints desc.objectives.get_fixed_boundary_constraints desc.objectives.get_NAE_constraints desc.objectives.GoodCoordinates desc.objectives.HeatingPowerISS04 desc.objectives.HelicalForceBalance desc.objectives.Isodynamicity desc.objectives.LinearObjectiveFromUser desc.objectives.LinkingCurrentConsistency desc.objectives.MagneticWell desc.objectives.MeanCurvature desc.objectives.MercierStability desc.objectives.MirrorRatio desc.objectives.ObjectiveFromUser desc.objectives.ObjectiveFunction desc.objectives.Omnigenity desc.objectives.PlasmaCoilSetDistanceBound desc.objectives.PlasmaCoilSetMinDistance desc.objectives.PlasmaVesselDistance desc.objectives.Pressure desc.objectives.PrincipalCurvature desc.objectives.QuadraticFlux desc.objectives.QuasisymmetryBoozer desc.objectives.QuasisymmetryTripleProduct desc.objectives.QuasisymmetryTwoTerm desc.objectives.RadialForceBalance desc.objectives.RotationalTransform desc.objectives.ShareParameters desc.objectives.Shear desc.objectives.SurfaceCurrentRegularization desc.objectives.SurfaceQuadraticFlux desc.objectives.ToroidalCurrent desc.objectives.ToroidalFlux desc.objectives.VacuumBoundaryError desc.objectives.Volume Optimize ******** .. autosummary:: :toctree: _api/optimize :recursive: :template: class.rst desc.optimize.Optimizer desc.optimize.fmin_auglag desc.optimize.fmintr desc.optimize.lsq_auglag desc.optimize.lsqtr desc.optimize.register_optimizer desc.optimize.sgd Particles ********* .. autosummary:: :toctree: _api/particles :recursive: :template: class.rst desc.particles.CurveParticleInitializer desc.particles.ManualParticleInitializerFlux desc.particles.ManualParticleInitializerLab desc.particles.SurfaceParticleInitializer desc.particles.VacuumGuidingCenterTrajectory desc.particles.trace_particles Perturbations ************* .. autosummary:: :toctree: _api/perturbations :recursive: desc.perturbations.get_deltas desc.perturbations.perturb desc.perturbations.optimal_perturb Plotting ******** .. autosummary:: :toctree: _api/plotting :recursive: desc.plotting.plot_1d desc.plotting.plot_2d desc.plotting.plot_3d desc.plotting.plot_basis desc.plotting.plot_boozer_modes desc.plotting.plot_boozer_surface desc.plotting.plot_boundaries desc.plotting.plot_boundary desc.plotting.plot_coefficients desc.plotting.plot_coils desc.plotting.plot_comparison desc.plotting.plot_field_lines desc.plotting.plot_fsa desc.plotting.plot_gammac desc.plotting.plot_grid desc.plotting.plot_logo desc.plotting.plot_particle_trajectories desc.plotting.plot_qs_error desc.plotting.plot_section desc.plotting.plot_surfaces desc.plotting.poincare_plot Profiles ******** .. autosummary:: :toctree: _api/profiles :recursive: :template: class.rst desc.profiles.FourierZernikeProfile desc.profiles.HermiteSplineProfile desc.profiles.MTanhProfile desc.profiles.PowerProfile desc.profiles.PowerSeriesProfile desc.profiles.ProductProfile desc.profiles.ScaledProfile desc.profiles.SplineProfile desc.profiles.SumProfile desc.profiles.TwoPowerProfile Transform ********* .. autosummary:: :toctree: _api/transform/ :recursive: :template: class.rst desc.transform.Transform VMEC and Other Codes ******************** .. autosummary:: :toctree: _api/vmec/ :recursive: :template: class.rst desc.vmec.VMECIO desc.vmec_utils.make_boozmn_output