rompy.swan.components.physics.TURBULENCE#

pydantic model rompy.swan.components.physics.TURBULENCE[source]#

Turbulent viscosity.

TURBULENCE [ctb] (CURRENT [tbcur])

With this optional command the user can activate turbulent viscosity. This physical effect is also activated by reading values of the turbulent viscosity using the READGRID TURB command, but then with the default value of ctb. The command READGRID TURB is necessary if this command TURB is used since the value of the viscosity is assumed to vary over space.

Examples

In [195]: from rompy.swan.components.physics import TURBULENCE

In [196]: turbulence = TURBULENCE(current=False)

In [197]: print(turbulence.render())
TURBULENCE

In [198]: turbulence = TURBULENCE(ctb=0.01, current=True, tbcur=0.004)

In [199]: print(turbulence.render())
TURBULENCE ctb=0.01 CURRENT tbcur=0.004
Fields:
Validators:
field ctb: float | None = None#

The value of the proportionality coefficient appearing in the energy dissipation term (SWAN default: 0.01)

Validated by:
field current: bool | None = True#

If this keyword is present the turbulent viscosity will be derived from the product of the depth and the absolute value of the current velocity. If the command READGRID TURB is used, this option is ignored; the values read from file will prevail

Validated by:
field model_type: Literal['turbulence', 'TURBULENCE'] = 'turbulence'#

Model type discriminator

Validated by:
field tbcur: float | None = None#

The factor by which depth x current velocity is multiplied in order to get the turbulent viscosity (SWAN default: 0.004)

Validated by:
cmd() → str[source]#

Command file string for this component.

validator tbcur_only_with_current  »  all fields[source]#
On this page
Show Source