rompy.swan.subcomponents.numerics.GSE

pydantic model rompy.swan.subcomponents.numerics.GSE

Garden-sprinkler effect.

GSE [waveage] Sec|MIn|HR|DAy

Garden-sprinkler effect is to be counteracted in the S&L propagation scheme (default for nonstationary regular grid computations) or in the propagation scheme for unstructured grids by adding a diffusion term to the basic equation. This may affect the numerical stability of SWAN.

Examples

In [299]: from rompy.swan.subcomponents.numerics import GSE

In [300]: scheme = GSE(waveage=dict(delt=86400, dfmt="day"))

In [301]: print(scheme.render())
GSE waveage=1.0 DAY

Fields:

• model_type (Literal['gse', 'GSE'])

• waveage (rompy.swan.subcomponents.time.Delt | None)

field model_type: Literal['gse', 'GSE'] = 'gse'

Model type discriminator

field waveage: Delt | None = None

The time interval used to determine the diffusion which counteracts the so-called garden-sprinkler effect. The default value of waveage is zero, i.e. no added diffusion. The value of waveage should correspond to the travel time of the waves over the computational region.

cmd() → str

Command file string for this component.