rompy.swan.subcomponents.physics.WESTHUYSEN#

pydantic model rompy.swan.subcomponents.physics.WESTHUYSEN[source]#

Westhuysen source terms subcomponent.

WESTHUYSEN [cds2] [br] (AGROW [a])

Nonlinear saturation-based whitecapping combined with wind input of Yan (1987).

Notes

The two arguments are specified in the Appendix C of the User manual but not in the command description for WESTH in Section 4.5.4. They are also options in the WCAPPING command. It is not entirely clear if they should/could be specified here.

References

van der Westhuysen, A.J., Zijlema, M. and Battjes, J.A., 2007. Nonlinear saturation-based whitecapping dissipation in SWAN for deep and shallow water. Coastal Engineering, 54(2), pp.151-170.

Examples

In [86]: from rompy.swan.subcomponents.physics import WESTHUYSEN

In [87]: westhuysen = WESTHUYSEN()

In [88]: print(westhuysen.render())
WESTHUYSEN DRAG WU

In [89]: westhuysen = WESTHUYSEN(cds2=5.0e-5, br=1.75e-3)

In [90]: print(westhuysen.render())
WESTHUYSEN cds2=5e-05 br=0.00175 DRAG WU

Show JSON schema
{
   "title": "WESTHUYSEN",
   "description": "Westhuysen source terms subcomponent.\n\n.. code-block:: text\n\n    WESTHUYSEN [cds2] [br] (AGROW [a])\n\nNonlinear saturation-based whitecapping combined with wind input of Yan (1987).\n\nNotes\n-----\nThe two arguments are specified in the Appendix C of the User manual but not in the\ncommand description for WESTH in Section 4.5.4. They are also options in the\nWCAPPING command. It is not entirely clear if they should/could be specified here.\n\nReferences\n----------\nvan der Westhuysen, A.J., Zijlema, M. and Battjes, J.A., 2007. Nonlinear\nsaturation-based whitecapping dissipation in SWAN for deep and shallow water.\nCoastal Engineering, 54(2), pp.151-170.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.subcomponents.physics import WESTHUYSEN\n    westhuysen = WESTHUYSEN()\n    print(westhuysen.render())\n    westhuysen = WESTHUYSEN(cds2=5.0e-5, br=1.75e-3)\n    print(westhuysen.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "westhuysen",
         "description": "Model type discriminator",
         "enum": [
            "westhuysen",
            "WESTHUYSEN"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "wind_drag": {
         "default": "wu",
         "description": "Indicates the wind drag formulation",
         "enum": [
            "wu",
            "fit"
         ],
         "title": "Wind Drag",
         "type": "string"
      },
      "agrow": {
         "default": false,
         "description": "Activate the Cavaleri and Malanotte (1981) wave growth term",
         "title": "Agrow",
         "type": "boolean"
      },
      "a": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Proportionality coefficient when activating the Cavaleri and Malanotte (1981) wave growth term (SWAN default: 0.0015)",
         "title": "A"
      },
      "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"
      }
   },
   "additionalProperties": false
}

Fields:
field a: float | None = None#

Proportionality coefficient when activating the Cavaleri and Malanotte (1981) wave growth term (SWAN default: 0.0015)

field agrow: bool = False#

Activate the Cavaleri and Malanotte (1981) wave growth term

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 model_type: Literal['westhuysen', 'WESTHUYSEN'] = 'westhuysen'#

Model type discriminator

field wind_drag: Literal['wu', 'fit'] = 'wu'#

Indicates the wind drag formulation

cmd() → str[source]#