WaveSpectra

This module contains functions for calculating intergated wave parameters and reconstructing 2-D wave spectra from spectral parameters.

Dependencies [External]:

numpy

Dependencies [Internal]:

WaveSpectra.dsfunc(freq, df, th1, th2, sth1, sth2, ntheta)[source]

Directional spreading function

Based on description of MEDS buoy data format given on the IFREMER Wiki pages.

Parameters:
  • freq

  • df

  • th1

  • th2

  • sth1

  • sth2

  • ntheta

Returns:

dsFnc

WaveSpectra.dsfunc1d(theta, thetap, dspr=None)[source]
WaveSpectra.dsfuncnorm(freq, df, th1, sth1, ntheta)[source]

Normalised 2-D directional spreading function

Based on description given on NOAA NDBC web site.

WaveSpectra.getSpectralMoments(f, df, S)[source]
WaveSpectra.getSpectralParameters(moments)[source]
WaveSpectra.jonswap(f, Tp, Hs, gamma=None)[source]
WaveSpectra.mean_wave_period(moments)[source]

Integrated Wave Parameter: Mean wave period

Parameters:

moments – Spectral moments calculated from the wave energy spectrum using WaveVal.WaveSpectra.spectralMoment().

Returns:

Tm01.

WaveSpectra.pierson_moskowitz(f, Tp, Hs)[source]
WaveSpectra.significant_wave_height(moments)[source]

Integrated Wave Parameter: Significant wave height

Parameters:

moments – Spectral moments calculated from the wave energy spectrum using WaveVal.WaveSpectra.spectralMoment().

Returns:

Hm0.

WaveSpectra.spec2d(freq, sf, df, th1, th2, sth1, sth2, ntheta)[source]

Generate 2-D directional spectrum from standard parameters retrieve from a wavebuoy.

WaveSpectra.spec2dnorm(freq, sf, df, th1, sth1, ntheta)[source]

Generate normlaised 2-D directional spectrum from standard parameters retrieve from a wavebuoy.

WaveSpectra.spec2dparam(freq, theta, thetap, Tp, Hs, gamma=None, dspr=None)[source]
WaveSpectra.spectralMoment(f, df, S, moment)[source]
Parameters:
  • f – frequency bin centre values

  • df – frequency bin widths

  • S – spectral energy density in frquency bins

  • moment – interger representing moment to be calculated

Returns:

specMom

WaveSpectra.spectral_narrowness(moments)[source]

Integrated Wave Parameter: Spectral narrowness

Parameters:

moments – Spectral moments calculated from the wave energy spectrum using WaveVal.WaveSpectra.spectralMoment().

Returns:

nu.

WaveSpectra.spectral_period(moments)[source]

Integrated Wave Parameter: Peak spectral period

Parameters:

moments – Spectral moments calculated from the wave energy spectrum using WaveVal.WaveSpectra.spectralMoment().

Returns:

Tm02.

WaveSpectra.spectral_width(moments)[source]

Integrated Wave Parameter: Spectral width

Parameters:

moments – Spectral moments calculated from the wave energy spectrum using WaveVal.WaveSpectra.spectralMoment().

Returns:

eps.

WaveSpectra.wave_energy_period(moments)[source]

Integrated Wave Parameter: Wave energy period

Parameters:

moments – Spectral moments calculated from the wave energy spectrum using WaveVal.WaveSpectra.spectralMoment().

Returns:

Tm10.

WaveSpectra.wave_steepness(moments)[source]

Integrated Wave Parameter: Wave steepness

Parameters:

moments – Spectral moments calculated from the wave energy spectrum using WaveVal.WaveSpectra.spectralMoment().

Returns:

Tdw2.

WaveSpectra.wavehgtvar(freq, df, dt, spec2D)[source]

Convert 2-D wave spectrum into wave height variance map in (f,theta) space.

WaveSpectra.zero_crossing_period(moments)[source]

Integrated Wave Parameter: Zero crossing period

Parameters:

moments – Spectral moments calculated from the wave energy spectrum using WaveVal.WaveSpectra.spectralMoment().

Returns:

Tm02.