.. superscreen

.. _api-sources:


*************
Field Sources
*************

The ``superscreen.sources`` module provides factory functions for a few convenient
:class:`superscreen.parameter.Parameter` classes used to define applied magnetic fields. 

.. contents::
    :depth: 2

ConstantField
-------------

.. autofunction:: superscreen.sources.ConstantField

MonopoleField
-------------

.. autofunction:: superscreen.sources.MonopoleField

PearlVortexField
----------------

.. autofunction:: superscreen.sources.PearlVortexField

DipoleField
-----------

.. autofunction:: superscreen.sources.DipoleField

.. autofunction:: superscreen.sources.dipole_field

.. autofunction:: superscreen.sources.dipole_distribution

SheetCurrentField
-----------------

.. autofunction:: superscreen.sources.SheetCurrentField

.. autofunction:: superscreen.sources.biot_savart_2d