rompy.swan.components.physics.BREAKING_CONSTANT

pydantic model rompy.swan.components.physics.BREAKING_CONSTANT

Constant wave breaking index.

BREAKING CONSTANT [alpha] [gamma]

Indicates that a constant breaker index is to be used.

Examples

In [28]: from rompy.swan.components.physics import BREAKING_CONSTANT

In [29]: breaking = BREAKING_CONSTANT()

In [30]: print(breaking.render())
BREAKING CONSTANT

In [31]: breaking = BREAKING_CONSTANT(alpha=1.0, gamma=0.73)

In [32]: print(breaking.render())
BREAKING CONSTANT alpha=1.0 gamma=0.73

Fields:

• alpha (float | None)

• gamma (float | None)

• model_type (Literal['constant', 'CONSTANT'])

field alpha: float | None = None

Proportionality coefficient of the rate of dissipation (SWAN default: 1.0)

field gamma: float | None = None

The breaker index, i.e. the ratio of maximum individual wave height over depth (SWAN default: 0.73)

field model_type: Literal['constant', 'CONSTANT'] = 'constant'

Model type discriminator

cmd() → str

Command file string for this component.