.. _api:

***
API
***

WecOptTool
----------

.. mat:autoclass:: +WecOptTool.AutoFolder
    :members:

.. mat:autoclass:: +WecOptTool.Hydrodynamics
    :members:

.. mat:autoclass:: +WecOptTool.SeaState
    :members:

.. mat:autofunction:: +WecOptTool.mesh

.. mat:autofunction:: +WecOptTool.solver

WecOptTool.geometry
-------------------

The geometry package provides predefined geometry generation functions.

.. mat:automodule:: +WecOptTool.+geometry
    :members:

WecOptTool.plot
---------------

.. mat:automodule:: +WecOptTool.+plot
    :members:

WecOptTool.math
---------------

.. mat:automodule:: +WecOptTool.+math
    :members:

WecOptTool.mesh
---------------

The mesh subpackage provides mesh generation classes, that provide the standard method ``makeMesh``.

.. mat:automodule:: +WecOptTool.+mesh
    :members:

WecOptTool.solver
-----------------

The solver subpackage provides hydrodynamic solver classes, that provide the standard method ``getHydro``.

.. mat:automodule:: +WecOptTool.+solver
    :members:

WecOptTool.base
---------------

The base subpackage provides base classes used in other classes.

.. mat:automodule:: +WecOptTool.+base
    :members: