rompy.swan.subcomponents.numerics.CTHETA#

pydantic model rompy.swan.subcomponents.numerics.CTHETA[source]#

Prevents excessive directional turning.

CTheta [cfl]

This option prevents an excessive directional turning at a single grid point or vertex due to a very coarse bathymetry or current locally. This option limits the directional turning rate cθ based on the CFL restriction. (See Eq. 3.41 of Scientific/Technical documentation). 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 [289]: from rompy.swan.subcomponents.numerics import CTHETA

In [290]: ctheta = CTHETA()

In [291]: print(ctheta.render())
CTHETA

In [292]: ctheta = CTHETA(cfl=0.9)

In [293]: print(ctheta.render())
CTHETA cfl=0.9

Fields:

cfl (float | None)
model_type (Literal['ctheta', 'CTHETA'])

field cfl: float | None = None#: Upper limit for the CFL restriction for ctheta. A suggestion for this parameter is cfl = 0.9 (SWAN default: 0.9 when CTHETA is activated)

field model_type: Literal['ctheta', 'CTHETA'] = 'ctheta'#: Model type discriminator

cmd() → str[source]#: Command file string for this component.

Table of Contents

rompy.swan.subcomponents.numerics.CTHETA#