:py:mod:`gnome.utilities.weathering.adios2`
===========================================

.. py:module:: gnome.utilities.weathering.adios2


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   gnome.utilities.weathering.adios2.Adios2




Attributes
~~~~~~~~~~

.. autoapisummary::

   gnome.utilities.weathering.adios2.g


.. py:data:: g

   

.. py:class:: Adios2


   Bases: :py:obj:`object`

   This is for any Adios 2 algorithms for which a scientific reference
   is not documented.

   Note: We should really try to look up the references for these and
         move them to an appropriately referenced class.

   .. py:method:: wave_height(U, fetch)
      :staticmethod:

      compute the wave height

      :param U: wind speed
      :type U: floating point number in m/s units

      :returns Hrms: RMS wave height in meters


   .. py:method:: wind_speed_from_height(H)
      :staticmethod:

      Compute the wind speed to use for the whitecap fraction
      This is the reverse of wave_height()
      - Used if the wave height is specified.
      - Unlimited fetch is assumed:

      :param H: given wave height.


   .. py:method:: mean_wave_period(U, wave_height, fetch)
      :staticmethod:

      Compute the mean wave period

      fixme: check for discontinuity at large fetch..
             Is this s bit low??? 32 m/s -> T=15.7 s


   .. py:method:: dissipative_wave_energy(water_density, H)
      :staticmethod:

      Compute the dissipative wave energy

      units? --  should be: 1/s^3
                 i.e. energy disspiation rate per m^2
                 so water density is in there -- but something else is up
                 does the constant have units?