rompy.swan.components.physics.TRIAD#

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

Wave triad interactions.

TRIAD [itriad] [trfac] [cutfr] [a] [b] [urcrit] [urslim]

With this command the user can activate the triad wave-wave interactions. If this command is not used, SWAN will not account for triads.

Note

This is the TRIAD specification in SWAN < 41.45.

Examples

In [175]: from rompy.swan.components.physics import TRIAD

In [176]: triad = TRIAD()

In [177]: print(triad.render())
TRIAD

In [178]: triad = TRIAD(
   .....:     itriad=1,
   .....:     trfac=0.8,
   .....:     cutfr=2.5,
   .....:     a=0.95,
   .....:     b=-0.75,
   .....:     ucrit=0.2,
   .....:     urslim=0.01,
   .....: )
   .....: 

In [179]: print(triad.render())
TRIAD itriad=1 trfac=0.8 cutfr=2.5 a=0.95 b=-0.75 urcrit=0.2 urslim=0.01

Show JSON schema
{
   "title": "TRIAD",
   "description": "Wave triad interactions.\n\n.. code-block:: text\n\n    TRIAD [itriad] [trfac] [cutfr] [a] [b] [urcrit] [urslim]\n\nWith this command the user can activate the triad wave-wave interactions. If this\ncommand is not used, SWAN will not account for triads.\n\nNote\n----\nThis is the TRIAD specification in SWAN < 41.45.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import TRIAD\n    triad = TRIAD()\n    print(triad.render())\n    triad = TRIAD(\n        itriad=1,\n        trfac=0.8,\n        cutfr=2.5,\n        a=0.95,\n        b=-0.75,\n        ucrit=0.2,\n        urslim=0.01,\n    )\n    print(triad.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "triad",
         "description": "Model type discriminator",
         "enum": [
            "triad",
            "TRIAD"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "itriad": {
         "anyOf": [
            {
               "enum": [
                  1,
                  2
               ],
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Approximation method for the triad computation: \n\n* 1: the LTA method of Eldeberky (1996) \n* 2: the SPB method of Becq-Girard et al. (1999) (SWAN default: 1)",
         "title": "Itriad"
      },
      "trfac": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Proportionality coefficient (SWAN default: 0.8 in case of LTA method, 0.9 in case of SPB method)",
         "title": "Trfac"
      },
      "cutfr": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "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)",
         "title": "Cutfr"
      },
      "a": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "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 (SWAN default: 0.95)",
         "title": "A"
      },
      "b": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "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 (SWAN default: -0.75 for 1D, 0.0 for 2D",
         "title": "B"
      },
      "ucrit": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The critical Ursell number appearing in the expression for the biphase (SWAN default: 0.2)",
         "title": "Ucrit"
      },
      "urslim": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The lower threshold for Ursell number, if the actual Ursell number is below this value triad interactions are be computed (SWAN default: 0.01)",
         "title": "Urslim"
      }
   },
   "additionalProperties": false
}

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 (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 (SWAN default: -0.75 for 1D, 0.0 for 2D

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 itriad: Literal[1, 2] | None = None#

Approximation method for the triad computation:

  • 1: the LTA method of Eldeberky (1996)

  • 2: the SPB method of Becq-Girard et al. (1999) (SWAN default: 1)

field model_type: Literal['triad', 'TRIAD'] = 'triad'#

Model type discriminator

field trfac: float | None = None#

Proportionality coefficient (SWAN default: 0.8 in case of LTA method, 0.9 in case of SPB method)

field ucrit: float | None = None#

The critical Ursell number appearing in the expression for the biphase (SWAN default: 0.2)

field urslim: float | None = None#

The lower threshold for Ursell number, if the actual Ursell number is below this value triad interactions are be computed (SWAN default: 0.01)

cmd() → str[source]#

Command file string for this component.