rompy.swan.components.physics.BREAKING_BKD#
- pydantic model rompy.swan.components.physics.BREAKING_BKD[source]#
Variable wave breaking index.
BREAKING BKD [alpha] [gamma0] [a1] [a2] [a3]
Indicates that the breaker index scales with both the bottom slope (beta) and the dimensionless depth (kd).
Examples
In [23]: from rompy.swan.components.physics import BREAKING_BKD In [24]: breaking = BREAKING_BKD() In [25]: print(breaking.render()) BREAKING BKD In [26]: breaking = BREAKING_BKD(alpha=1.0, gamma0=0.54, a1=7.59, a2=-8.06, a3=8.09) In [27]: print(breaking.render()) BREAKING BKD alpha=1.0 gamma0=0.54 a1=7.59 a2=-8.06 a3=8.09
- Fields:
- field a1: float | None = None#
First tunable coefficient for the breaker index (SWAN default: 7.59)
- field a2: float | None = None#
Second tunable coefficient for the breaker index (SWAN default: -8.06)
- field a3: float | None = None#
Third tunable coefficient for the breaker index (SWAN default: 8.09)
- field alpha: float | None = None#
Proportionality coefficient of the rate of dissipation (SWAN default: 1.0)
- field gamma0: float | None = None#
The reference $gamma$ for horizontal slopes (SWAN default: 0.54)
- field model_type: Literal['bkd', 'BKD'] = 'bkd'#
Model type discriminator