ocmw.core.waveSpectra module

Functions for generating 1D and 2D wave spectra from parameters, modelled or observed data. Functions for calculating integrated wave parameters from modelled or observed wave data.

pierson_moskowitz

Generate Pierson-Moskowitz 1-D wave spectra

jonswap

Generate Jonswap 1-D wave spectra

dsfunc1d

Generate 1-D wave directional spreading function

significant_wave_height

Integrated Wave Parameter: Significant wave height

mean_wave_period

Integrated Wave Parameter: Mean wave period

zero_crossing_period

Integrated Wave Parameter: Zero crossing period

wave_energy_period

Integrated Wave Parameter: Wave energy period

spectral_period

Integrated Wave Parameter: Peak spectral period

wave_steepness

Integrated Wave Parameter: Wave steepness

spectral_width

Integrated Wave Parameter: Spectral width

spectral_narrowness

Integrated Wave Parameter: Spectral narrowness

spectralMoment

Calculate wave spectral moment

getSpectralMoments

Get a set wave spectra moments.

getSpectralParameters

Get wave spectra parameters for a set of moments.

wavehgtvar

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

dsfuncnorm

Normalised 2-D directional spreading function

spec2dnorm

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

dsfunc

Directional spreading function

spec2d

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

spec2dparam

Generate 2-D directional spectrum from parameters.

Functions for generating 1D and 2D wave spectra from parameters, modelled or observed data.

ocmw.core.waveSpectra.pierson_moskowitz(f, Tp, Hs)[source]

Generate Pierson-Moskowitz 1-D wave spectra

ocmw.core.waveSpectra.jonswap(f, Tp, Hs, gamma=None)[source]

Generate Jonswap 1-D wave spectra

ocmw.core.waveSpectra.dsfunc1d(theta, thetap, dspr=None)[source]

Generate 1-D wave directional spreading function

ocmw.core.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.

ocmw.core.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.

ocmw.core.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.

ocmw.core.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.

ocmw.core.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.

ocmw.core.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.

ocmw.core.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.

ocmw.core.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.

ocmw.core.waveSpectra.spectralMoment(f, df, S, moment)[source]

Calculate wave spectral moment

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

ocmw.core.waveSpectra.getSpectralMoments(f, df, S)[source]

Get a set wave spectra moments.

ocmw.core.waveSpectra.getSpectralParameters(moments)[source]

Get wave spectra parameters for a set of moments.

ocmw.core.waveSpectra.wavehgtvar(freq, df, dt, spec2D)[source]

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

ocmw.core.waveSpectra.dsfuncnorm(freq, df, th1, sth1, ntheta)[source]

Normalised 2-D directional spreading function

Based on description given on NOAA NDBC web site.

ocmw.core.waveSpectra.spec2dnorm(freq, sf, df, th1, sth1, ntheta)[source]

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

ocmw.core.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

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

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

ocmw.core.waveSpectra.spec2dparam(freq, theta, thetap, Tp, Hs, gamma=None, dspr=None)[source]

Generate 2-D directional spectrum from parameters.