.. highlight:: shell

====================================================
Deltares Coastal Structures Toolbox package contents
====================================================


Hydraulic
=========

Wave Overtopping
~~~~~~~~~~~~~~~~

TAW (2002)
----------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_overtopping.taw2002
   :members:
   :undoc-members:
   :show-inheritance:

Van Gent (2002)
----------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_overtopping.vangent2002_velocity
   :members:
   :undoc-members:
   :show-inheritance:

Van Gent et al. (2007)
----------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_overtopping.vangent2007
   :members:
   :undoc-members:
   :show-inheritance:

EurOtop (2007)
--------------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_overtopping.eurotop2007
   :members:
   :undoc-members:
   :show-inheritance:

EurOtop (2018)
--------------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_overtopping.eurotop2018
   :members:
   :undoc-members:
   :show-inheritance:
   
Den Bieman et al. (2021)
------------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_overtopping.denbieman2021
   :members:
   :undoc-members:
   :show-inheritance:

Van Gent (2021)
---------------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_overtopping.vangent2021_caisson
   :members:
   :undoc-members:
   :show-inheritance:


De Ridder et al. (2024)
------------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_overtopping.deridder2024
   :members:
   :undoc-members:
   :show-inheritance:

Van Gent et al. (2025)
----------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_overtopping.vangent2025
   :members:
   :undoc-members:
   :show-inheritance:


Wave Runup
~~~~~~~~~~

Van Gent (2001)
---------------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_runup.vangent2001
   :members:
   :undoc-members:
   :show-inheritance:
   

TAW (2002)
----------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_runup.taw2002
   :members:
   :undoc-members:
   :show-inheritance:

EurOtop (2018)
--------------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_runup.eurotop2018
   :members:
   :undoc-members:
   :show-inheritance:

Wave Transmission
~~~~~~~~~~~~~~~~~

Goda et al. (1967)
------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_transmission.goda1967_caisson
   :members:
   :undoc-members:
   :show-inheritance:

D'Angremond et al. (1996)
-------------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_transmission.dangremond1996
   :members:
   :undoc-members:
   :show-inheritance:

Briganti et al. (2003)
----------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_transmission.briganti2003
   :members:
   :undoc-members:
   :show-inheritance:

Van Gent et al. (2023)
----------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_transmission.vangent2023
   :members:
   :undoc-members:
   :show-inheritance:

Van Gent (2024)
---------------

.. automodule:: deltares_coastal_structures_toolbox.functions.hydraulic.wave_transmission.vangent2024_setup
   :members:
   :undoc-members:
   :show-inheritance:

Structural
==========


Forces Caisson
~~~~~~~~~~~~~~

Goda (1985)
-----------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.forces_caisson.goda1985
   :members:
   :undoc-members:
   :show-inheritance:

Forces Crest Wall
~~~~~~~~~~~~~~~~~

Van Gent & Van der Werf (2019)
------------------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.forces_crestwall.vangentvanderwerf2019
   :members:
   :undoc-members:
   :show-inheritance:


Stability Concrete Armour
~~~~~~~~~~~~~~~~~~~~~~~~~

Cubes (double layer) Hudson (1959)
---------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_concrete_armour.cubes_double_layer_hudson1959
   :members:
   :undoc-members:
   :show-inheritance:

Cubes (double layer) Van der Meer (1988)
---------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_concrete_armour.cubes_double_layer_vandermeer1988
   :members:
   :undoc-members:
   :show-inheritance:

Cubes (single layer) Van Gent (2002)
---------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_concrete_armour.cubes_single_layer_vangent2002
   :members:
   :undoc-members:
   :show-inheritance:

Accropode
---------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_concrete_armour.accropode_hudson1959
   :members:
   :undoc-members:
   :show-inheritance:

Accropode II
------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_concrete_armour.accropode2_hudson1959
   :members:
   :undoc-members:
   :show-inheritance:

Core Loc
--------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_concrete_armour.core_loc_hudson1959
   :members:
   :undoc-members:
   :show-inheritance:

Cubipod
-------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_concrete_armour.cubipod_hudson1959
   :members:
   :undoc-members:
   :show-inheritance:

Tetrapod
--------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_concrete_armour.tetrapod_hudson1959
   :members:
   :undoc-members:
   :show-inheritance:

Xbloc
-----

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_concrete_armour.xbloc
   :members:
   :undoc-members:
   :show-inheritance:

XblocPlus
---------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_concrete_armour.xblocplus
   :members:
   :undoc-members:
   :show-inheritance:


Stability Rock Armour
~~~~~~~~~~~~~~~~~~~~~

Hudson (1959)
-------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_rock_armour.hudson1959
   :members:
   :undoc-members:
   :show-inheritance:

Van der Meer (1988)
-------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_rock_armour.vandermeer1988
   :members:
   :undoc-members:
   :show-inheritance:

modified Van der Meer (Van Gent et al., 2003)
---------------------------------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_rock_armour.vandermeer1988_modified
   :members:
   :undoc-members:
   :show-inheritance:

Kramer & Burcharth (2004)
-------------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_rock_armour.kramerburcharth2004_lowcrested
   :members:
   :undoc-members:
   :show-inheritance:

Etemad-Shahidi et al. (2020)
----------------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_rock_armour.etemadshahidi2020
   :members:
   :undoc-members:
   :show-inheritance:

Van der Meer (2021)
-------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_rock_armour.vandermeer2021
   :members:
   :undoc-members:
   :show-inheritance:

Scaravaglione et al. (2025)
---------------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_rock_armour.scaravaglione2025
   :members:
   :undoc-members:
   :show-inheritance:


Stability Rock Rear
~~~~~~~~~~~~~~~~~~~

Van Gent & Pozueta (2004)
-------------------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_rock_rear.vangentpozueta2004
   :members:
   :undoc-members:
   :show-inheritance:

Van Gent (2007)
---------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_rock_rear.vangent2007
   :members:
   :undoc-members:
   :show-inheritance:

Stability Toe Berm
~~~~~~~~~~~~~~~~~~

Takahashi et al. (1990)
-------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_toe_berm.takahashi1990_caisson
   :members:
   :undoc-members:
   :show-inheritance:

Gerding (1993)
-------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_toe_berm.gerding1993
   :members:
   :undoc-members:
   :show-inheritance:

Van der Meer (1998)
-------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_toe_berm.vandermeer1998
   :members:
   :undoc-members:
   :show-inheritance:

Van Gent & Van der Werf (2014)
-------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_toe_berm.vangentvanderwerf2014
   :members:
   :undoc-members:
   :show-inheritance:

Etemad-Shahidi et al. (2021)
-------------

.. automodule:: deltares_coastal_structures_toolbox.functions.structural.stability_toe_berm.etemadshahidi2021
   :members:
   :undoc-members:
   :show-inheritance:

General functions
=================

Physics module
--------------

.. automodule:: deltares_coastal_structures_toolbox.functions.core_physics
   :members:
   :undoc-members:
   :show-inheritance:
   
Utility module
--------------

.. automodule:: deltares_coastal_structures_toolbox.functions.core_utility
   :members:
   :undoc-members:
   :show-inheritance: