rompy.swan.components.physics.LIMITER

pydantic model rompy.swan.components.physics.LIMITER

Physics limiter.

LIMITER [ursell] [qb]

With this command the user can de-activate permanently the quadruplets when the actual Ursell number exceeds ursell. Moreover, as soon as the actual fraction of breaking waves exceeds qb then the action limiter will not be used in case of decreasing action density.

Examples

In [76]: from rompy.swan.components.physics import LIMITER

In [77]: limiter = LIMITER()

In [78]: print(limiter.render())
LIMITER

In [79]: limiter = LIMITER(ursell=10.0, qb=1.0)

In [80]: print(limiter.render())
LIMITER ursell=10.0 qb=1.0

Fields:

• model_type (Literal['limiter', 'LIMITER'])

• qb (float | None)

• ursell (float | None)

field model_type: Literal['limiter', 'LIMITER'] = 'limiter'

Model type discriminator

field qb: float | None = None

The threshold for fraction of breaking waves (SWAN default: 1.0)

field ursell: float | None = None

The upper threshold for Ursell number (SWAN default: 10.0)

cmd() → str

Command file string for this component.