eulerjs API / @eulerjs/marine / SwellWave
SwellWave
Defined in: packages/marine/src/waves/SpectralWaves.ts:504
One of the swell's long waves: running along (directionX, directionZ), a unit vector.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
amplitude | public | number | In metres: set for the sea's swell height. | packages/marine/src/waves/SpectralWaves.ts:513 |
angularFrequency | readonly | number | - | packages/marine/src/waves/SpectralWaves.ts:509 |
directionX | readonly | number | - | packages/marine/src/waves/SpectralWaves.ts:505 |
directionZ | readonly | number | - | packages/marine/src/waves/SpectralWaves.ts:506 |
phase | readonly | number | Its own phase, at time 0. | packages/marine/src/waves/SpectralWaves.ts:511 |
waveNumber | readonly | number | In rad/m. | packages/marine/src/waves/SpectralWaves.ts:508 |