OceanWaveLayer
Since 0.6
One layer of the sea: a fully developed wind sea or a swell train, with a direction and a spread.
The sea is the sum of its layers.
Fields
| Field | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
kind | OceanLayerKind | yes | wind, swell | "wind": a wind sea from windSpeedMps and fetchKm. "swell": a narrow-band train of heightM and periodS. Wind fields on a swell layer, or the reverse, are ocean-layer-field-mismatch. | |
windSpeedMps | number | no | wind only: wind speed 10 m above the sea, m/s, 0..60. Above 60 is clamped (ocean-wind-out-of-range). | ||
fetchKm | number | no | 300 | wind only: open-water fetch, km, 1..2000. Default 300. Outside is clamped (ocean-wind-out-of-range). | |
heightM | number | no | swell only: significant wave height, metres, 0..40. | ||
periodS | number | no | swell only, required for swell: peak period, seconds, 2..30 (ocean-swell-without-period). | ||
directionRad | number | no | 0 | Compass bearing the waves travel toward, radians, as sky.clouds.windDirectionRad: 0 toward -Z, increasing toward +X. Default 0. | |
spread | number | no | Directional spread: 0 is the natural spread of a wind sea; larger is longer-crested (swell 20..80). Default 0 for wind, 40 for swell. |