rompy.swan.components.physics.WCAPPING_KOMEN#

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

Whitecapping according to Komen (1984).

WCAPPING KOMEN [cds2] [stpm] [powst] [delta] [powk]

Notes

The SWAN default for delta has been changed since version 40.91A. The setting delta = 1 will improve the prediction of the wave energy at low frequencies, and hence the mean wave period. The original default was delta = 0, which corresponds to WAM Cycle 3. See the Scientific/Technical documentation for further details.

References

Komen, G.J., Hasselmann, S. and Hasselmann, K., 1984. On the existence of a fully developed wind-sea spectrum. Journal of physical oceanography, 14(8), pp.1271-1285.

Examples

In [210]: from rompy.swan.components.physics import WCAPPING_KOMEN

In [211]: wcapping = WCAPPING_KOMEN()

In [212]: print(wcapping.render())
WCAPPING KOMEN

In [213]: wcapping = WCAPPING_KOMEN(cds2=2.36e-5, stpm=3.02e-3, powst=2, delta=1, powk=2)

In [214]: print(wcapping.render())
WCAPPING KOMEN cds2=2.36e-05 stpm=0.00302 powst=2.0 delta=1.0 powk=2.0

Show JSON schema

{
   "title": "WCAPPING_KOMEN",
   "description": "Whitecapping according to Komen (1984).\n\n.. code-block:: text\n\n    WCAPPING KOMEN [cds2] [stpm] [powst] [delta] [powk]\n\nNotes\n-----\nThe SWAN default for `delta` has been changed since version 40.91A. The setting\n`delta = 1` will improve the prediction of the wave energy at low frequencies, and\nhence the mean wave period. The original default was `delta = 0`, which corresponds\nto WAM Cycle 3. See the Scientific/Technical documentation for further details.\n\nReferences\n----------\nKomen, G.J., Hasselmann, S. and Hasselmann, K., 1984. On the existence of a fully\ndeveloped wind-sea spectrum. Journal of physical oceanography, 14(8), pp.1271-1285.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import WCAPPING_KOMEN\n    wcapping = WCAPPING_KOMEN()\n    print(wcapping.render())\n    wcapping = WCAPPING_KOMEN(cds2=2.36e-5, stpm=3.02e-3, powst=2, delta=1, powk=2)\n    print(wcapping.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "komen",
         "description": "Model type discriminator",
         "enum": [
            "komen",
            "KOMEN"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "cds2": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Coefficient for determining the rate of whitecapping dissipation ($Cds$) (SWAN default: 2.36e-5)",
         "title": "Cds2"
      },
      "stpm": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Value of the wave steepness for a Pierson-Moskowitz spectrum ($s^2_{PM}$) (SWAN default: 3.02e-3)",
         "title": "Stpm"
      },
      "powst": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Power of steepness normalized with the wave steepness of a Pierson-Moskowitz spectrum (SWAN default: 2)",
         "title": "Powst"
      },
      "delta": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Coefficient which determines the dependency of the whitecapping on wave number (SWAN default: 1)",
         "title": "Delta"
      },
      "powk": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "power of wave number normalized with the mean wave number (SWAN default: 1)",
         "title": "Powk"
      }
   },
   "additionalProperties": false
}

Fields:

cds2 (float | None)
delta (float | None)
model_type (Literal['komen', 'KOMEN'])
powk (float | None)
powst (float | None)
stpm (float | None)

field cds2: float | None = None#: Coefficient for determining the rate of whitecapping dissipation ($Cds$) (SWAN default: 2.36e-5)

field delta: float | None = None#: Coefficient which determines the dependency of the whitecapping on wave number (SWAN default: 1)

field model_type: Literal['komen', 'KOMEN'] = 'komen'#: Model type discriminator

field powk: float | None = None#: power of wave number normalized with the mean wave number (SWAN default: 1)

field powst: float | None = None#: Power of steepness normalized with the wave steepness of a Pierson-Moskowitz spectrum (SWAN default: 2)

field stpm: float | None = None#: Value of the wave steepness for a Pierson-Moskowitz spectrum ($s^2_{PM}$) (SWAN default: 3.02e-3)

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

Table of Contents

rompy.swan.components.physics.WCAPPING_KOMEN#

This Page