desc.objectives.MagneticWell
============================

.. currentmodule:: desc.objectives

.. autoclass:: MagneticWell

   

   
   .. rubric:: Methods

   .. autosummary::
    :toctree: MagneticWell

   
   
   
      ~MagneticWell.build
   
   
      ~MagneticWell.compute
   
   
      ~MagneticWell.compute_scalar
   
   
      ~MagneticWell.compute_scaled
   
   
      ~MagneticWell.compute_scaled_error
   
   
      ~MagneticWell.compute_unscaled
   
   
      ~MagneticWell.copy
   
   
      ~MagneticWell.equiv
   
   
      ~MagneticWell.grad
   
   
      ~MagneticWell.hess
   
   
      ~MagneticWell.jac_scaled
   
   
      ~MagneticWell.jac_scaled_error
   
   
      ~MagneticWell.jac_unscaled
   
   
      ~MagneticWell.jvp_scaled
   
   
      ~MagneticWell.jvp_scaled_error
   
   
      ~MagneticWell.jvp_unscaled
   
   
      ~MagneticWell.load
   
   
      ~MagneticWell.print_value
   
   
      ~MagneticWell.save
   
   
      ~MagneticWell.xs
   
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
    :toctree: MagneticWell

   
      ~MagneticWell.bounds
      ~MagneticWell.built
      ~MagneticWell.constants
      ~MagneticWell.dim_f
      ~MagneticWell.fixed
      ~MagneticWell.linear
      ~MagneticWell.name
      ~MagneticWell.normalization
      ~MagneticWell.scalar
      ~MagneticWell.target
      ~MagneticWell.things
      ~MagneticWell.weight