desc.magnetic\_fields.SumMagneticField
======================================

.. currentmodule:: desc.magnetic_fields

.. autoclass:: SumMagneticField

   

   
   .. rubric:: Methods

   .. autosummary::
    :toctree: SumMagneticField

   
   
   
      ~SumMagneticField.append
   
   
      ~SumMagneticField.clear
   
   
      ~SumMagneticField.compute_Bnormal
   
   
      ~SumMagneticField.compute_magnetic_field
   
   
      ~SumMagneticField.compute_magnetic_vector_potential
   
   
      ~SumMagneticField.copy
   
   
      ~SumMagneticField.count
   
   
      ~SumMagneticField.equiv
   
   
      ~SumMagneticField.extend
   
   
      ~SumMagneticField.index
   
   
      ~SumMagneticField.insert
   
   
      ~SumMagneticField.load
   
   
      ~SumMagneticField.pack_params
   
   
      ~SumMagneticField.pop
   
   
      ~SumMagneticField.remove
   
   
      ~SumMagneticField.reverse
   
   
      ~SumMagneticField.save
   
   
      ~SumMagneticField.save_BNORM_file
   
   
      ~SumMagneticField.save_mgrid
   
   
      ~SumMagneticField.unpack_params
   
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
    :toctree: SumMagneticField

   
      ~SumMagneticField.dim_x
      ~SumMagneticField.dimensions
      ~SumMagneticField.optimizable_params
      ~SumMagneticField.params_dict
      ~SumMagneticField.x_idx