API Reference
=============

System
------

.. automodule:: openferro.system
   :members:
   :undoc-members:
   :show-inheritance:

Fields
------

.. automodule:: openferro.field
   :members:
   :undoc-members:
   :show-inheritance:

Lattice
-------

.. automodule:: openferro.lattice
   :members:
   :undoc-members:
   :show-inheritance:

Hamiltonian
--------------------------

Elastic
^^^^^^^

.. automodule:: openferro.engine.elastic
   :members:
   :undoc-members:
   :show-inheritance:

Ferroelectric
^^^^^^^^^^^^^

.. automodule:: openferro.engine.ferroelectric
   :members:
   :undoc-members:
   :show-inheritance:

Magnetic
^^^^^^^^

.. automodule:: openferro.engine.magnetic
   :members:
   :undoc-members:
   :show-inheritance:

Ewald
^^^^^

.. automodule:: openferro.engine.ewald
   :members:
   :undoc-members:
   :show-inheritance:


Integrators
-----------

Base
^^^^

.. automodule:: openferro.integrator.base
   :members:
   :undoc-members:
   :show-inheritance:

Molecular Dynamics
^^^^^^^^^^^^^^^^^^

.. automodule:: openferro.integrator.md
   :members:
   :undoc-members:
   :show-inheritance:

Landau-Lifshitz-Gilbert
^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: openferro.integrator.llg
   :members:
   :undoc-members:
   :show-inheritance:

Simulation
----------

.. automodule:: openferro.simulation
   :members:
   :undoc-members:
   :show-inheritance:

Interaction (Abstract)
----------------------

.. automodule:: openferro.interaction
   :members:
   :undoc-members:
   :show-inheritance:

Utilities
---------

Reporters
^^^^^^^^^

.. automodule:: openferro.reporter
   :members:
   :undoc-members:
   :show-inheritance:

Units
^^^^^

.. automodule:: openferro.units
   :members:
   :undoc-members:
   :show-inheritance:

Helper Functions
^^^^^^^^^^^^^^^^

.. automodule:: openferro.utilities
   :members:
   :undoc-members:
   :show-inheritance:

Parallelism
^^^^^^^^^^^

.. automodule:: openferro.parallelism
   :members:
   :undoc-members:
   :show-inheritance: