rompy.swan.components.physics.QUADRUPL#

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

Nonlinear quadruplet wave interactions.

QUADRUPL [iquad] [lambda] [cnl4] [Csh1] [Csh2] [Csh3]

With this option the user can influence the computation of nonlinear quadruplet wave interactions which are usually included in the computations. Can be de-activated with command OFF QUAD. Note that the DIA approximation of the quadruplet interactions is a poor approximation for long-crested waves and frequency resolutions that are deviating much more than 10% (see command CGRID). Note that DIA is usually updated per sweep, either semi-implicit (iquad = 1) or explicit (iquad = 2). However, when ambient current is included, the bounds of the directional sector within a sweep may be different for each frequency bin (particularly the higher frequencies are modified by the current). So there may be some overlap of frequency bins between the sweeps, implying non-conservation of wave energy. To prevent this the user is advised to choose the integration of DIA per iteration instead of per sweep, i.e. iquad = 3. If you want to speed up your computation a bit more, than the choice iquad = 8 is a good choice.

Examples

In [113]: from rompy.swan.components.physics import QUADRUPL

In [114]: quadrupl = QUADRUPL()

In [115]: print(quadrupl.render())
QUADRUPL

In [116]: kwargs = dict(
   .....:     iquad=3, lambd=0.25, cnl4=3.0e7, csh1=5.5, csh2=0.833333, csh3=-1.25
   .....: )
   .....: 

In [117]: quadrupl = QUADRUPL(**kwargs)

In [118]: print(quadrupl.render())
QUADRUPL iquad=3 lambda=0.25 cnl4=30000000.0 csh1=5.5 csh2=0.833333 csh3=-1.25

Fields:

cnl4 (float | None)
csh1 (float | None)
csh2 (float | None)
csh3 (float | None)
iquad (Literal[1, 2, 3, 8, 4, 51, 52, 53] | None)
lambd (float | None)
model_type (Literal['quadrupl', 'QUADRUPL'])

field cnl4: float | None = None#: Proportionality coefficient for quadruplet interactions in case of DIA (SWAN default: 3.0e7

field csh1: float | None = None#: Coefficient for shallow water scaling in case of DIA (SWAN default: 5.5)

field csh2: float | None = None#: Coefficient for shallow water scaling in case of DIA (SWAN default: 0.833333)

field csh3: float | None = None#: Coefficient for shallow water scaling in case of DIA (SWAN default: -1.25)

field iquad: Literal[1, 2, 3, 8, 4, 51, 52, 53] | None = None#: Numerical procedures for integrating the quadruplets: 1 = semi-implicit per sweep, 2 = explicit per sweep, 3 = explicit per iteration, 8 = explicit per iteration, but with a more efficient implementation, 4 = multiple DIA, 51 = XNL (deep water transfer), 52 = XNL (deep water transfer with WAM depth scaling), 53 XNL (finite depth transfer) (SWAN default: 2)

field lambd: float | None = None#: Coefficient for quadruplet configuration in case of DIA (SWAN default: 0.25)

field model_type: Literal['quadrupl', 'QUADRUPL'] = 'quadrupl'#: Model type discriminator

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

Table of Contents

rompy.swan.components.physics.QUADRUPL#