rompy.swan.components.physics.TRIAD_SPB#

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

Triad interactions with the SPB method of Becq-Girard et al. (1999).

TRIAD SPB [trfac] [a] [b] BIPHHASE ELDEBERKY|DEWIT

References

Becq-Girard, F., Forget, P. and Benoit, M., 1999. Non-linear propagation of unidirectional wave fields over varying topography. Coastal Engineering, 38(2), pp.91-113.

Note

This method to compute the triad interactions is only supported in SWAN >= 41.45.

Examples

In [190]: from rompy.swan.components.physics import TRIAD_SPB

In [191]: triad = TRIAD_SPB()

In [192]: print(triad.render())
TRIAD SPB

In [193]: triad = TRIAD_SPB(
   .....:     trfac=0.9,
   .....:     a=0.95,
   .....:     b=0.0,
   .....:     biphase={"model_type": "eldeberky", "urcrit": 0.63},
   .....: )
   .....: 

In [194]: print(triad.render())
TRIAD SPB trfac=0.9 a=0.95 b=0.0 BIPHASE ELDEBERKY urcrit=0.63
Fields:
field a: float | None = None#

First calibration parameter for tuning K in Eq. (5.1) of Becq-Girard et al. (1999). This parameter is associated with broadening of the resonance condition. The default value is 0.95 and is calibrated by means of laboratory experiments (SWAN default: 0.95)

field b: float | None = None#

Second calibration parameter for tuning K in Eq. (5.1) of Becq-Girard et al. (1999). This parameter is associated with broadening of the resonance condition. The default value is -0.75 and is calibrated by means of laboratory experiments. However, it may not be appropriate for true 2D field cases as it does not scale with the wave field characteristics. Hence, this parameter is set to zero (SWAN default: 0.0)

field biphase: ELDEBERKY | DEWIT | None = None#

Defines the parameterization of biphase (self-self interaction) (SWAN default: ELDEBERKY)

field model_type: Literal['spb', 'SPB'] = 'spb'#

Model type discriminator

field trfac: float | None = None#

Scaling factor that controls the intensity of the triad interaction due to SPB (SWAN default: 0.9)

cmd() str[source]#

Command file string for this component.