.. default-domain:: py

.. _S4Utils-label:

S4Utils functions references
=============================

.. automodule:: S4Utils.S4Utils

Basic Utility functions
------------------------

.. autofunction:: totuple

.. autofunction:: UpdateMaterials


.. _S4Utils-Simulations:

Simulation Functions
---------------------

2D Slicing functions
~~~~~~~~~~~~~~~~~~~~

.. autofunction:: GetField_xy

.. autofunction:: GetField_xz

.. autofunction:: GetField_yz

.. autofunction:: GetSlice

3D Volume functions
~~~~~~~~~~~~~~~~~~~

.. autofunction:: GetFieldVolume

.. autofunction:: GetEpsilonVolume


.. _S4Utils-Plotting:

S4Utils Plotting Utilities
--------------------------

The SlicePlot class
~~~~~~~~~~~~~~~~~~~

.. autoclass:: SlicePlot
    :members:
    :member-order: bysource

The GUISlicePlot class
~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: GUISlicePlot
    :members:
    :member-order: bysource

3D Plotting Function
~~~~~~~~~~~~~~~~~~~~
.. autofunction:: Plot3DSlices