freegs.filament\_coil.FilamentCoil
==================================

.. currentmodule:: freegs.filament_coil

.. autoclass:: FilamentCoil
   :members:
   :undoc-members:
   :show-inheritance:

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~FilamentCoil.Br
      ~FilamentCoil.Bz
      ~FilamentCoil.__init__
      ~FilamentCoil.calcPsiFromGreens
      ~FilamentCoil.controlBr
      ~FilamentCoil.controlBz
      ~FilamentCoil.controlPsi
      ~FilamentCoil.createPsiGreens
      ~FilamentCoil.from_numpy_array
      ~FilamentCoil.getForces
      ~FilamentCoil.inShape
      ~FilamentCoil.plot
      ~FilamentCoil.psi
      ~FilamentCoil.to_numpy_array
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~FilamentCoil.R
      ~FilamentCoil.Z
      ~FilamentCoil.area
      ~FilamentCoil.dtype