Skip to content

Commit

Permalink
Merge pull request #457 from PlasmaControl/docs
Browse files Browse the repository at this point in the history
Add missing classes to API docs
  • Loading branch information
f0uriest authored Mar 16, 2023
2 parents df15db5 + cee8148 commit 498f4f8
Showing 1 changed file with 26 additions and 9 deletions.
35 changes: 26 additions & 9 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Examples
:recursive:

desc.examples.get
desc.examples.listall


Geometry
Expand Down Expand Up @@ -109,20 +110,33 @@ Objective Functions
:template: class.rst

desc.objectives.AspectRatio
desc.objectives.BootstrapRedlConsistency
desc.objectives.CurrentDensity
desc.objectives.Elongation
desc.objectives.Energy
desc.objectives.FixBoundaryR
desc.objectives.FixBoundaryZ
desc.objectives.FixCurrent
desc.objectives.FixIota
desc.objectives.FixLambdaGauge
desc.objectives.FixPressure
desc.objectives.FixPsi
desc.objectives.FixAtomicNumber,
desc.objectives.FixAxisR,
desc.objectives.FixAxisZ,
desc.objectives.FixBoundaryR,
desc.objectives.FixBoundaryZ,
desc.objectives.FixCurrent,
desc.objectives.FixElectronDensity,
desc.objectives.FixElectronTemperature,
desc.objectives.FixIonTemperature,
desc.objectives.FixIota,
desc.objectives.FixModeR,
desc.objectives.FixModeZ,
desc.objectives.FixPressure,
desc.objectives.FixPsi,
desc.objectives.FixSumModesR,
desc.objectives.FixSumModesZ,
desc.objectives.FixThetaSFL,
desc.objectives.ForceBalance
desc.objectives.GenericObjective
desc.objectives.get_fixed_boundary_constraints
desc.objectives.get_equilibrium_objective
desc.objectives.get_equilibrium_objective,
desc.objectives.get_fixed_axis_constraints,
desc.objectives.get_fixed_boundary_constraints,
desc.objectives.get_NAE_constraints,
desc.objectives.HelicalForceBalance
desc.objectives.MagneticWell
desc.objectives.MeanCurvature
Expand Down Expand Up @@ -199,6 +213,9 @@ Profiles
desc.profiles.PowerSeriesProfile
desc.profiles.SplineProfile
desc.profiles.MTanhProfile
desc.profiles.ScaledProfile
desc.profiles.SumProfile
desc.profiles.ProductProfile

Transform
*********
Expand Down

0 comments on commit 498f4f8

Please sign in to comment.