rompy.swan.components.physics.SSWELL_ZIEGER#

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

Nonbreaking dissipation of Zieger et al. (2015).

SSWELL ZIEGER [b1]

Swell dissipation of Young et al. (2013) updated by Zieger et al. (2015). The Zieger option is intended for use with negative wind input via the NEGATINP command. Zieger non-breaking dissipation follows the method used in WAVEWATCH III version 4 and does not include the steepness-dependent swell coefficient introduced in WAVEWATCH III version 5.

References

Zieger, S., Babanin, A.V., Rogers, W.E. and Young, I.R., 2015. Observation-based source terms in the third-generation wave model WAVEWATCH. Ocean Modelling, 96, pp.2-25.

Young, I.R., Babanin, A.V. and Zieger, S., 2013. The decay rate of ocean swell observed by altimeter. Journal of physical oceanography, 43(11), pp.2322-2333.

Examples

In [165]: from rompy.swan.components.physics import SSWELL_ZIEGER

In [166]: sswell = SSWELL_ZIEGER()

In [167]: print(sswell.render())
SSWELL ZIEGER

In [168]: sswell = SSWELL_ZIEGER(b1=0.00025)

In [169]: print(sswell.render())
SSWELL ZIEGER b1=0.00025

Show JSON schema
{
   "title": "SSWELL_ZIEGER",
   "description": "Nonbreaking dissipation of Zieger et al. (2015).\n\n.. code-block:: text\n\n    SSWELL ZIEGER [b1]\n\nSwell dissipation of Young et al. (2013) updated by Zieger et al. (2015). The\nZieger option is intended for use with negative wind input via the NEGATINP\ncommand. Zieger non-breaking dissipation follows the method used in WAVEWATCH III\nversion 4 and does not include the steepness-dependent swell coefficient introduced\nin WAVEWATCH III version 5.\n\nReferences\n----------\nZieger, S., Babanin, A.V., Rogers, W.E. and Young, I.R., 2015. Observation-based\nsource terms in the third-generation wave model WAVEWATCH. Ocean Modelling, 96,\npp.2-25.\n\nYoung, I.R., Babanin, A.V. and Zieger, S., 2013. The decay rate of ocean swell\nobserved by altimeter. Journal of physical oceanography, 43(11), pp.2322-2333.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import SSWELL_ZIEGER\n    sswell = SSWELL_ZIEGER()\n    print(sswell.render())\n    sswell = SSWELL_ZIEGER(b1=0.00025)\n    print(sswell.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "zieger",
         "description": "Model type discriminator",
         "enum": [
            "zieger",
            "ZIEGER"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "b1": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Non-dimensional proportionality coefficient (SWAN default: 0.00025)",
         "title": "B1"
      }
   },
   "additionalProperties": false
}

Fields:
field b1: float | None = None#

Non-dimensional proportionality coefficient (SWAN default: 0.00025)

field model_type: Literal['zieger', 'ZIEGER'] = 'zieger'#

Model type discriminator

cmd() → str[source]#

Command file string for this component.