rompy.swan.components.physics.TRIAD_LTA#

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

Triad interactions with the LTA method of Eldeberky (1996).

TRIAD LTA [trfac] [cutfr] BIPHHASE ELDEBERKY|DEWIT

References

Eldeberky, Y., Polnikov, V. and Battjes, J.A., 1996. A statistical approach for modeling triad interactions in dispersive waves. In Coastal Engineering 1996 (pp. 1088-1101).

Note

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

Examples

In [185]: from rompy.swan.components.physics import TRIAD_LTA

In [186]: triad = TRIAD_LTA()

In [187]: print(triad.render())
TRIAD LTA

In [188]: triad = TRIAD_LTA(
   .....:     trfac=0.8,
   .....:     cutfr=2.5,
   .....:     biphase={"model_type": "eldeberky", "urcrit": 0.63},
   .....: )
   .....: 

In [189]: print(triad.render())
TRIAD LTA trfac=0.8 cutfr=2.5 BIPHASE ELDEBERKY urcrit=0.63

Fields:

biphase (rompy.swan.subcomponents.physics.ELDEBERKY | rompy.swan.subcomponents.physics.DEWIT | None)
cutfr (float | None)
model_type (Literal['lta', 'LTA'])
trfac (float | None)

field biphase: ELDEBERKY | DEWIT | None = None#: Defines the parameterization of biphase (self-self interaction) (SWAN default: ELDEBERKY)

field cutfr: float | None = None#: Controls the maximum frequency that is considered in the LTA computation. The value of cutfr is the ratio of this maximum frequency over the mean frequency (SWAN default: 2.5)

field model_type: Literal['lta', 'LTA'] = 'lta'#: Model type discriminator

field trfac: float | None = None#: Scaling factor that controls the intensity of the triad interaction due to LTA (SWAN default: 0.8)

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

Table of Contents

rompy.swan.components.physics.TRIAD_LTA#