mom_wave_interface module reference

Interface for surface waves.

Data Types

wave_parameters_cs

Container for all surface wave related parameters.

Functions/Subroutines

`mom_wave_interface_init()`	Initializes parameters related to MOM_wave_interface.
`set_lf17_wave_params()`	Set the parameters that are used to determine the averaged Stokes drift and Langmuir numbers.
`query_wave_properties()`	This interface provides the caller with information from the waves control structure.
`update_surface_waves()`	Subroutine that handles updating of surface wave/Stokes drift related properties.
`update_stokes_drift()`	Constructs the Stokes Drift profile on the model grid based on desired coupling options.
`one_minus_exp_x()`	Return the value of (1 - exp(-x))/x [nondim], using an accurate expression for small values of x.
`one_minus_exp()`	Return the value of (1 - exp(-x)) [nondim], using an accurate expression for small values of x.
`surface_bands_by_data_override()`	A subroutine to fill the Stokes drift from a NetCDF file using the data_override procedures.
`get_langmuir_number()`	Interface to get Langmuir number based on options stored in wave structure.
`get_wave_method()`	function to return the wave method string set in the param file
`get_stokessl_lifoxkemper()`	Get SL averaged Stokes drift from Li/FK 17 method.
`get_sl_average_prof()`	Get SL Averaged Stokes drift from a Stokes drift Profile.
`get_sl_average_band()`	Get SL averaged Stokes drift from the banded Spectrum method.
`dhh85_mid()`	Compute the Stokes drift at a given depth.
`stokesmixing()`	Explicit solver for Stokes mixing.
`coriolisstokes()`	Solver to add Coriolis-Stokes to model Still in development and not meant for general use.
`stokes_pgf()`	Computes tendency due to Stokes pressure gradient force anomaly including analytical integration of Stokes shear using multiple-exponential decay Stokes drift profile and vertical integration of the resulting pressure anomaly to the total pressure gradient force.
`ust_2_u10_coare3p5()`	Computes wind speed from ustar_air based on COARE 3.5 Cd relationship Probably doesn't belong in this module, but it is used here to estimate wind speed for wind-wave relationships.
`waves_end()`	Clear pointers, deallocate memory.
`waves_register_restarts()`	Register wave restart fields.

Detailed Description

This module should be moved as wave coupling progresses and likely will should mirror the iceberg or sea-ice model set-up.

This module is meant to contain the routines to read in and interpret surface wave data for MOM6. In its original form, the capabilities include setting the Stokes drift in the model (from a variety of sources including prescribed, empirical, and input files). In short order, the plan is to also amend the subroutine to accept Stokes drift information from an external coupler. Eventually, it will be necessary to break this file apart so that general wave information may be stored in the control structure and the Stokes drift effect can be isolated from processes such as sea-state dependent momentum fluxes, gas fluxes, and other wave related air-sea interaction and boundary layer phenomenon.

The Stokes drift are stored on the C-grid with the conventional protocol to interpolate to the h-grid to compute Langmuir number, the primary quantity needed for Langmuir turbulence parameterizations in both the ePBL and KPP approach. This module also computes full 3d Stokes drift profiles, which will be useful if second-order type boundary layer parameterizations are implemented (perhaps via GOTM, work in progress).

Type Documentation

type mom_wave_interface/wave_parameters_cs