.. superscreen

.. _api-visualization:


*************
Visualization
*************

The ``superscreen.visualization`` module contains functions used to visualize
the results contained in a :class:`superscreen.Solution`.

.. contents::
    :depth: 2

Fields
------

.. autofunction:: superscreen.visualization.plot_fields

.. autofunction:: superscreen.visualization.plot_field_at_positions

Currents
--------

.. autofunction:: superscreen.visualization.plot_currents

Stream Functions
----------------

.. autofunction:: superscreen.visualization.plot_streams

Miscellaneous
-------------

.. autofunction:: superscreen.visualization.plot_mutual_inductance

.. autofunction:: superscreen.visualization.plot_polygon_flux


Supporting Functions
--------------------

.. autofunction:: superscreen.visualization.auto_range_iqr

.. autofunction:: superscreen.visualization.auto_grid

.. autofunction:: superscreen.visualization.grids_to_vecs

.. autofunction:: superscreen.visualization.setup_color_limits

.. autofunction:: superscreen.visualization.cross_section