rompy.swan.components.physics.WCAPPING_AB#

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

Whitecapping according to Alves and Banner (2003).

WCAPPING AB [cds2] [br] CURRENT [cds3]

References

Alves, J.H.G. and Banner, M.L., 2003. Performance of a saturation-based dissipation-rate source term in modeling the fetch-limited evolution of wind waves. Journal of Physical Oceanography, 33(6), pp.1274-1298.

Examples

In [205]: from rompy.swan.components.physics import WCAPPING_AB

In [206]: wcapping = WCAPPING_AB()

In [207]: print(wcapping.render())
WCAPPING AB

In [208]: wcapping = WCAPPING_AB(cds2=5.0e-5, br=1.75e-3, current=True, cds3=0.8)

In [209]: print(wcapping.render())
WCAPPING AB cds2=5e-05 br=0.00175 CURRENT cds3=0.8

Show JSON schema
{
   "title": "WCAPPING_AB",
   "description": "Whitecapping according to Alves and Banner (2003).\n\n.. code-block:: text\n\n    WCAPPING AB [cds2] [br] CURRENT [cds3]\n\nReferences\n----------\nAlves, J.H.G. and Banner, M.L., 2003. Performance of a saturation-based\ndissipation-rate source term in modeling the fetch-limited evolution of wind waves.\nJournal of Physical Oceanography, 33(6), pp.1274-1298.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import WCAPPING_AB\n    wcapping = WCAPPING_AB()\n    print(wcapping.render())\n    wcapping = WCAPPING_AB(cds2=5.0e-5, br=1.75e-3, current=True, cds3=0.8)\n    print(wcapping.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "ab",
         "description": "Model type discriminator",
         "enum": [
            "ab",
            "AB"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "cds2": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "proportionality coefficient due to Alves and Banner (2003) (SWAN default: 5.0e-5)",
         "title": "Cds2"
      },
      "br": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Threshold saturation level\t(SWAN default: 1.75e-3)",
         "title": "Br"
      },
      "current": {
         "default": false,
         "description": "Indicates that enhanced current-induced dissipation as proposed by Van der Westhuysen (2012) is to be added",
         "title": "Current",
         "type": "boolean"
      },
      "cds3": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Proportionality coefficient (SWAN default: 0.8)",
         "title": "Cds3"
      }
   },
   "additionalProperties": false
}

Fields:
field br: float | None = None#

Threshold saturation level (SWAN default: 1.75e-3)

field cds2: float | None = None#

proportionality coefficient due to Alves and Banner (2003) (SWAN default: 5.0e-5)

field cds3: float | None = None#

Proportionality coefficient (SWAN default: 0.8)

field current: bool = False#

Indicates that enhanced current-induced dissipation as proposed by Van der Westhuysen (2012) is to be added

field model_type: Literal['ab', 'AB'] = 'ab'#

Model type discriminator

cmd() → str[source]#

Command file string for this component.