Magnets
=======

Common Interface
----------------
All magnet types in PyMagba share a common interface for computing magnetic
fields and geometric properties.

.. include:: _common_pose.rst
.. include:: _common_source.rst

Available Magnets
-----------------

CylinderMagnet
~~~~~~~~~~~~~~
.. autoclass:: pymagba.magnets.CylinderMagnet
   :members:

CuboidMagnet
~~~~~~~~~~~~
.. autoclass:: pymagba.magnets.CuboidMagnet
   :members:

Dipole
~~~~~~
.. autoclass:: pymagba.magnets.Dipole
   :members:

SourceCollection
~~~~~~~~~~~~~~~~
.. autoclass:: pymagba.magnets.SourceCollection
   :members: