Skip to content

eulerjs API / @eulerjs/marine / WavePatch

WavePatch ​

Defined in: packages/marine/src/waves/spectralFields.ts:8

The waves of one patch: for each wavenumber on its grid, the initial amplitude h₀(k) and its partner's conjugate h₀*(-k), and how fast the wave turns, ω = √(g|k|). Zero outside the patch's band of wavenumbers.

Properties ​

PropertyModifierTypeDescriptionDefined in
amplitudesreadonlyFloat32ArrayFour numbers a wavenumber, row by row: h₀(k) real and imaginary, then h₀*(-k)'s.packages/marine/src/waves/spectralFields.ts:15
angularFrequenciesreadonlyFloat64ArrayEach a whole number of turns in the sea's loop period, if it has one, so the sea repeats exactly.packages/marine/src/waves/spectralFields.ts:17
highestWaveNumberreadonlynumber-packages/marine/src/waves/spectralFields.ts:13
lowestWaveNumberreadonlynumberThe band of |k| the patch holds, in rad/m: from lowestWaveNumber up to, not including, highestWaveNumber.packages/marine/src/waves/spectralFields.ts:12
resolutionreadonlynumber-packages/marine/src/waves/spectralFields.ts:10
sizereadonlynumber-packages/marine/src/waves/spectralFields.ts:9

Released under the MIT License.