API reference
=============

This page enumerates every public class, function, and module
femorph-solver ships.  Every symbol referenced from the
:doc:`/reference/index` chapters resolves to one of the entries
below — so a :class:`...` or :mod:`...` cross-reference in
prose links to the right place in the rendered docs.

Model
-----

.. autoclass:: femorph_solver.model.Model
   :members:

Solver orchestration
--------------------

.. automodule:: femorph_solver.solvers.static
   :members:

.. automodule:: femorph_solver.solvers.modal
   :members:

.. automodule:: femorph_solver.solvers.cyclic
   :members:

.. automodule:: femorph_solver.solvers.transient
   :members:

Linear solver backends
----------------------

.. automodule:: femorph_solver.solvers.linear
   :members:

.. automodule:: femorph_solver.solvers.linear._base
   :members:

.. automodule:: femorph_solver.solvers.linear._pardiso
   :members:

.. automodule:: femorph_solver.solvers.linear._mkl_pardiso
   :members:

.. automodule:: femorph_solver.solvers.linear._cholmod
   :members:

.. automodule:: femorph_solver.solvers.linear._mumps
   :members:

.. automodule:: femorph_solver.solvers.linear._umfpack
   :members:

.. automodule:: femorph_solver.solvers.linear._superlu
   :members:

.. automodule:: femorph_solver.solvers.linear._cg
   :members:

.. automodule:: femorph_solver.solvers.linear._gmres
   :members:

.. automodule:: femorph_solver.solvers.linear._pyamg
   :members:

Eigen solver backends
---------------------

.. automodule:: femorph_solver.solvers.eigen
   :members:

.. automodule:: femorph_solver.solvers.eigen._base
   :members:

.. automodule:: femorph_solver.solvers.eigen._arpack
   :members:

.. automodule:: femorph_solver.solvers.eigen._lobpcg
   :members:

.. automodule:: femorph_solver.solvers.eigen._lapack_dense
   :members:

.. automodule:: femorph_solver.solvers.eigen._primme
   :members:

Elements
--------

.. automodule:: femorph_solver.elements
   :members:

.. automodule:: femorph_solver.elements._base
   :members:

.. automodule:: femorph_solver.elements.hex8
   :members:

.. automodule:: femorph_solver.elements.hex20
   :members:

.. automodule:: femorph_solver.elements._wedge15_pyr13
   :members:

.. automodule:: femorph_solver.elements.tet10
   :members:

.. automodule:: femorph_solver.elements.beam2
   :members:

.. automodule:: femorph_solver.elements.quad4_shell
   :members:

.. automodule:: femorph_solver.elements.quad4_plane
   :members:

.. automodule:: femorph_solver.elements.truss2
   :members:

.. automodule:: femorph_solver.elements.spring
   :members:

.. automodule:: femorph_solver.elements.point_mass
   :members:

Post-processing recovery
------------------------

.. automodule:: femorph_solver.recover
   :members:

Validation framework
--------------------

The public surface is re-exported from :mod:`femorph_solver.validation`;
the private ``_benchmark``, ``_convergence``, ``_report`` modules
are not separately autodoc'd to avoid duplicate cross-reference
targets in the rendered docs.

.. automodule:: femorph_solver.validation
   :members:

.. automodule:: femorph_solver.validation.problems
   :members:

Estimators
----------

.. automodule:: femorph_solver.estimators
   :members:

MAPDL compatibility
-------------------

.. automodule:: femorph_solver.mapdl_api
   :members:

.. automodule:: femorph_solver.mapdl_api.cdb
   :members:

Binary IO (MAPDL formats)
^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: femorph_solver.mapdl_api.io.binary
   :members:

.. automodule:: femorph_solver.mapdl_api.io.rst_schema
   :members:

.. automodule:: femorph_solver.mapdl_api.io.full_schema
   :members:

.. automodule:: femorph_solver.mapdl_api.io.emat_schema
   :members: