desc.objectives.ToroidalFlux
============================

.. currentmodule:: desc.objectives

.. autoclass:: ToroidalFlux

   

   
   .. rubric:: Methods

   .. autosummary::
    :toctree: ToroidalFlux

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

   
   
   .. rubric:: Attributes

   .. autosummary::
    :toctree: ToroidalFlux

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