desc.objectives.ToroidalCurrent
===============================

.. currentmodule:: desc.objectives

.. autoclass:: ToroidalCurrent

   

   
   .. rubric:: Methods

   .. autosummary::
    :toctree: ToroidalCurrent

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

   
   
   .. rubric:: Attributes

   .. autosummary::
    :toctree: ToroidalCurrent

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