rompy.swan.components.physics.SSWELL_ROGERS#

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

Nonbreaking dissipation of Rogers et al. (2012).

SSWELL ROGERS [cdsv] [feswell]

References

Rogers, W.E., Babanin, A.V. and Wang, D.W., 2012. Observation-consistent input and whitecapping dissipation in a model for wind-generated surface waves: Description and simple calculations. Journal of Atmospheric and Oceanic Technology, 29(9), pp.1329-1346.

Examples

In [160]: from rompy.swan.components.physics import SSWELL_ROGERS

In [161]: sswell = SSWELL_ROGERS()

In [162]: print(sswell.render())
SSWELL ROGERS

In [163]: sswell = SSWELL_ROGERS(cdsv=1.2, feswell=0.5)

In [164]: print(sswell.render())
SSWELL ROGERS cdsv=1.2 feswell=0.5

Show JSON schema
{
   "title": "SSWELL_ROGERS",
   "description": "Nonbreaking dissipation of Rogers et al. (2012).\n\n.. code-block:: text\n\n    SSWELL ROGERS [cdsv] [feswell]\n\nReferences\n----------\nRogers, W.E., Babanin, A.V. and Wang, D.W., 2012. Observation-consistent input and\nwhitecapping dissipation in a model for wind-generated surface waves: Description\nand simple calculations. Journal of Atmospheric and Oceanic Technology, 29(9),\npp.1329-1346.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import SSWELL_ROGERS\n    sswell = SSWELL_ROGERS()\n    print(sswell.render())\n    sswell = SSWELL_ROGERS(cdsv=1.2, feswell=0.5)\n    print(sswell.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "rogers",
         "description": "Model type discriminator",
         "enum": [
            "rogers",
            "ROGERS"
         ],
         "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"
      },
      "feswell": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Swell dissipation factor",
         "title": "Feswell"
      }
   },
   "additionalProperties": false
}

Fields:
field cdsv: float | None = None#

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

field feswell: float | None = None#

Swell dissipation factor

field model_type: Literal['rogers', 'ROGERS'] = 'rogers'#

Model type discriminator

cmd() → str[source]#

Command file string for this component.