rompy.swan.subcomponents.numerics.CSIGMA

pydantic model rompy.swan.subcomponents.numerics.CSIGMA

Prevents excessive directional turning.

CSigma [cfl]

This option prevents an excessive frequency shifting at a single grid point or vertex due to a very coarse bathymetry or current locally. This option limits the frequency shifting rate csigma based on the CFL restriction. See also the final remark in Section 2.6.3. Note that if this command is not specified, then the limiter is not activated.

Examples

In [284]: from rompy.swan.subcomponents.numerics import CSIGMA

In [285]: csigma = CSIGMA()

In [286]: print(csigma.render())
CSIGMA

In [287]: csigma = CSIGMA(cfl=0.9)

In [288]: print(csigma.render())
CSIGMA cfl=0.9

Fields:

• cfl (float | None)

• model_type (Literal['ctheta', 'CTHETA'])

field cfl: float | None = None

Upper limit for the CFL restriction for csigma. A suggestion for this parameter is cfl = 0.9 (SWAN default: 0.9 when CSIGMA is activated)

field model_type: Literal['ctheta', 'CTHETA'] = 'ctheta'

Model type discriminator

cmd() → str

Command file string for this component.