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

This section provides the API documentation for the core modules in the `ggp` framework.

.. toctree::
   :maxdepth: 2

Problem Specification
---------------------
.. automodule:: ggp.problem.spec
   :members:
   :undoc-members:
   :show-inheritance:

Geometry I/O & Parsers
----------------------
.. automodule:: ggp.geometry.io.registry
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: ggp.geometry.io.fenics_reader
   :members:
   :undoc-members:
   :show-inheritance:

Discretisation
--------------
.. automodule:: ggp.discretisation.fem
   :members:
   :undoc-members:
   :show-inheritance:

Projection Mappers
------------------
.. automodule:: ggp.projection.registry
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: ggp.projection.free_2d
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: ggp.projection.alm_2d
   :members:
   :undoc-members:
   :show-inheritance:

Optimization Pipeline
---------------------
.. automodule:: ggp.optimization.pipeline
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: ggp.optimization.results
   :members:
   :undoc-members:
   :show-inheritance:

GEMSEO Wrappers
---------------
.. automodule:: ggp.gemseo_wrappers.geometry_discipline
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: ggp.gemseo_wrappers.physics_discipline
   :members:
   :undoc-members:
   :show-inheritance:

Physics Solvers
---------------
.. automodule:: ggp.physics.amjax_solver
   :members:
   :undoc-members:
   :show-inheritance: