rompy.swan.components.physics.SSWELL_ARDHUIN#

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

Nonbreaking dissipation of Ardhuin et al. (2010).

SSWELL ARDHUIN [cdsv]

References

Ardhuin, F., Rogers, E., Babanin, A.V., Filipot, J.F., Magne, R., Roland, A., Van Der Westhuysen, A., Queffeulou, P., Lefevre, J.M., Aouf, L. and Collard, F., 2010. Semiempirical dissipation source functions for ocean waves. Part I: Definition, calibration, and validation. Journal of Physical Oceanography, 40(9), pp.1917-1941.

Examples

In [155]: from rompy.swan.components.physics import SSWELL_ARDHUIN

In [156]: sswell = SSWELL_ARDHUIN()

In [157]: print(sswell.render())
SSWELL ARDHUIN

In [158]: sswell = SSWELL_ARDHUIN(cdsv=1.2)

In [159]: print(sswell.render())
SSWELL ARDHUIN cdsv=1.2

Show JSON schema
{
   "title": "SSWELL_ARDHUIN",
   "description": "Nonbreaking dissipation of Ardhuin et al. (2010).\n\n.. code-block:: text\n\n    SSWELL ARDHUIN [cdsv]\n\nReferences\n----------\nArdhuin, F., Rogers, E., Babanin, A.V., Filipot, J.F., Magne, R., Roland, A.,\nVan Der Westhuysen, A., Queffeulou, P., Lefevre, J.M., Aouf, L. and Collard, F.,\n2010. Semiempirical dissipation source functions for ocean waves. Part I:\nDefinition, calibration, and validation. Journal of Physical Oceanography, 40(9),\npp.1917-1941.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import SSWELL_ARDHUIN\n    sswell = SSWELL_ARDHUIN()\n    print(sswell.render())\n    sswell = SSWELL_ARDHUIN(cdsv=1.2)\n    print(sswell.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "ardhuin",
         "description": "Model type discriminator",
         "enum": [
            "ardhuin",
            "ARDHUIN"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "cdsv": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Coefficient related to laminar atmospheric boundary layer (SWAN default: 1.2)",
         "title": "Cdsv"
      }
   },
   "additionalProperties": false
}

Fields:
field cdsv: float | None = None#

Coefficient related to laminar atmospheric boundary layer (SWAN default: 1.2)

field model_type: Literal['ardhuin', 'ARDHUIN'] = 'ardhuin'#

Model type discriminator

cmd() → str[source]#

Command file string for this component.