desc.magnetic\_fields.ToroidalMagneticField
===========================================

.. currentmodule:: desc.magnetic_fields

.. autoclass:: ToroidalMagneticField

   

   
   .. rubric:: Methods

   .. autosummary::
    :toctree: ToroidalMagneticField

   
   
   
      ~ToroidalMagneticField.compute_Bnormal
   
   
      ~ToroidalMagneticField.compute_magnetic_field
   
   
      ~ToroidalMagneticField.compute_magnetic_vector_potential
   
   
      ~ToroidalMagneticField.copy
   
   
      ~ToroidalMagneticField.equiv
   
   
      ~ToroidalMagneticField.load
   
   
      ~ToroidalMagneticField.pack_params
   
   
      ~ToroidalMagneticField.save
   
   
      ~ToroidalMagneticField.save_BNORM_file
   
   
      ~ToroidalMagneticField.save_mgrid
   
   
      ~ToroidalMagneticField.unpack_params
   
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
    :toctree: ToroidalMagneticField

   
      ~ToroidalMagneticField.B0
      ~ToroidalMagneticField.R0
      ~ToroidalMagneticField.dim_x
      ~ToroidalMagneticField.dimensions
      ~ToroidalMagneticField.optimizable_params
      ~ToroidalMagneticField.params_dict
      ~ToroidalMagneticField.x_idx