******************
Code documentation
******************

This part of the documentation is generated automatically from the python source using `SPHINX <https://www.sphinx-doc.org/en/master/>`_.

Folders
=======

.. toctree::
   :maxdepth: 2

   scrimp.examples
   scrimp.utils
   scrimp.sandbox

Distributed port-Hamiltonian system
===================================

.. automodule:: scrimp.dphs
   :members:
   :undoc-members:
   :show-inheritance:

Domain
======

.. automodule:: scrimp.domain
   :members:
   :undoc-members:
   :show-inheritance:

Hamiltonian / Term
==================

.. automodule:: scrimp.hamiltonian
   :members:
   :undoc-members:
   :show-inheritance:

Port / Parameter
================

.. automodule:: scrimp.port
   :members:
   :undoc-members:
   :show-inheritance:

State
=====

.. automodule:: scrimp.state
   :members:
   :undoc-members:
   :show-inheritance:

Co-state
========

.. automodule:: scrimp.costate
   :members:
   :undoc-members:
   :show-inheritance:

Control
=======

.. automodule:: scrimp.control
   :members:
   :undoc-members:
   :show-inheritance:

FEM
===

.. automodule:: scrimp.fem
   :members:
   :undoc-members:
   :show-inheritance:

Brick
=====

.. automodule:: scrimp.brick
   :members:
   :undoc-members:
   :show-inheritance: