Skip to content

Commit 77ebda9

Browse files
enh: set default JONSWAP peak enhancement factor to 3.3 (#44)
1 parent 28cb2a4 commit 77ebda9

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

docs/user_guide/standardized_spectra.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ JONSWAP spectrum given three parameters (i.e., :math:`H_s`, :math:`T_p` and :mat
9494
9595
hs = 3.5
9696
tp = 10.0
97-
freq, vals = spectrum(hs, tp, gamma=2)
97+
freq, vals = spectrum(hs, tp, gamma=3.3)
9898
9999
.. note::
100100

src/waveresponse/_standardized1d.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ class JONSWAP(ModifiedPiersonMoskowitz):
244244
OchiHubble : Ochi-Hubble (three-parameter) wave spectrum.
245245
"""
246246

247-
def __call__(self, hs, tp, gamma=1, freq_hz=None):
247+
def __call__(self, hs, tp, gamma=3.3, freq_hz=None):
248248
"""
249249
Generate wave spectrum.
250250
@@ -255,7 +255,7 @@ def __call__(self, hs, tp, gamma=1, freq_hz=None):
255255
tp : float
256256
Peak period, Tp.
257257
gamma : float
258-
Peak enhancement factor.
258+
Peak enhancement factor. Default value is 3.3.
259259
freq_hz : bool, optional
260260
Whether to return the frequencies and spectrum in terms of Hz (`True`)
261261
or rad/s (`False`). If `None` (default), the original units of `freq` is

0 commit comments

Comments
 (0)