rompy.swan.components.physics.FRICTION_JONSWAP#

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

Hasselmann et al. (1973) Jonswap friction.

FRICTION JONSWAP CONSTANT [cfjon]

Indicates that the semi-empirical expression derived from the JONSWAP results for bottom friction dissipation (Hasselmann et al., 1973, JONSWAP) should be activated. This option is default.

References

Hasselmann, K., Barnett, T.P., Bouws, E., Carlson, H., Cartwright, D.E., Enke, K., Ewing, J.A., Gienapp, A., Hasselmann, D.E., Kruseman, P. and Meerburg, A., 1973. Measurements of wind-wave growth and swell decay during the Joint North Sea Wave Project (JONSWAP). Deutches Hydrographisches Institut, Hamburg, Germany, Rep. No. 12, 95 pp.

Examples

In [43]: from rompy.swan.components.physics import FRICTION_JONSWAP

In [44]: friction = FRICTION_JONSWAP()

In [45]: print(friction.render())
FRICTION JONSWAP CONSTANT

In [46]: friction = FRICTION_JONSWAP(cfjon=0.038)

In [47]: print(friction.render())
FRICTION JONSWAP CONSTANT cfjon=0.038

TODO: Implement VARIABLE option?

Show JSON schema
{
   "title": "FRICTION_JONSWAP",
   "description": "Hasselmann et al. (1973) Jonswap friction.\n\n.. code-block:: text\n\n    FRICTION JONSWAP CONSTANT [cfjon]\n\nIndicates that the semi-empirical expression derived from the JONSWAP results for\nbottom friction dissipation (Hasselmann et al., 1973, JONSWAP) should be activated.\nThis option is default.\n\nReferences\n----------\nHasselmann, K., Barnett, T.P., Bouws, E., Carlson, H., Cartwright, D.E., Enke, K.,\nEwing, J.A., Gienapp, A., Hasselmann, D.E., Kruseman, P. and Meerburg, A., 1973.\nMeasurements of wind-wave growth and swell decay during the Joint North Sea Wave\nProject (JONSWAP). Deutches Hydrographisches Institut, Hamburg, Germany,\nRep. No. 12, 95 pp.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import FRICTION_JONSWAP\n    friction = FRICTION_JONSWAP()\n    print(friction.render())\n    friction = FRICTION_JONSWAP(cfjon=0.038)\n    print(friction.render())\n\nTODO: Implement VARIABLE option?",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "jonswap",
         "description": "Model type discriminator",
         "enum": [
            "jonswap",
            "JONSWAP"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "cfjon": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Coefficient of the JONSWAP formulation (SWAN default: 0.038)",
         "title": "Cfjon"
      }
   },
   "additionalProperties": false
}

Fields:
field cfjon: float | None = None#

Coefficient of the JONSWAP formulation (SWAN default: 0.038)

field model_type: Literal['jonswap', 'JONSWAP'] = 'jonswap'#

Model type discriminator

cmd() → str[source]#

Command file string for this component.