rompy.swan.subcomponents.physics.ST6C3#

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

Third ST6 calibration in the SWAN user manual.

ST6 2.8e-6 3.5e-5 4.0 4.0 UP HWANG VECTAU U10PROXY 32.0 AGROW

Examples

In [65]: from rompy.swan.subcomponents.physics import ST6C3

In [66]: st6 = ST6C3()

In [67]: print(st6.render())
ST6 a1sds=2.8e-06 a2sds=3.5e-05 p1sds=4.0 p2sds=4.0 UP HWANG VECTAU U10PROXY windscaling=32.0 AGROW

Show JSON schema

{
   "title": "ST6C3",
   "description": "Third ST6 calibration in the SWAN user manual.\n\n.. code-block:: text\n\n    ST6 2.8e-6 3.5e-5 4.0 4.0 UP HWANG VECTAU U10PROXY 32.0 AGROW\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.subcomponents.physics import ST6C3\n    st6 = ST6C3()\n    print(st6.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "const": "st6c3",
         "default": "st6c3",
         "title": "Model Type",
         "type": "string"
      },
      "wind_drag": {
         "default": "hwang",
         "description": "Wind drag formula, `hwang` is the default and is unchanged from RBW12, `fan` is from Fan et al. (2012), `ecmwf` follows WAM Cycle 4 methodology",
         "enum": [
            "hwang",
            "fan",
            "ecmwf"
         ],
         "title": "Wind Drag",
         "type": "string"
      },
      "agrow": {
         "const": true,
         "default": true,
         "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"
      },
      "a1sds": {
         "const": 2.8e-06,
         "default": 2.8e-06,
         "title": "A1Sds",
         "type": "number"
      },
      "a2sds": {
         "const": 3.5e-05,
         "default": 3.5e-05,
         "title": "A2Sds",
         "type": "number"
      },
      "p1sds": {
         "const": 4.0,
         "default": 4.0,
         "title": "P1Sds",
         "type": "number"
      },
      "p2sds": {
         "const": 4.0,
         "default": 4.0,
         "title": "P2Sds",
         "type": "number"
      },
      "normalization": {
         "default": "up",
         "description": "Selection of normalization of exceedance level by ET(f) (`up`) or E(f) (`down`) as in RBW12 (right column, page 1333), `up` is default and strongly recommended",
         "enum": [
            "up",
            "down"
         ],
         "title": "Normalization",
         "type": "string"
      },
      "tau": {
         "default": "vectau",
         "description": "Use vector (vectau) or scalar (scatau) calculation for the wind strerss (Eq. 12 in RBW12), `vectau` is the default and strongly recommended",
         "enum": [
            "vectau",
            "scatau"
         ],
         "title": "Tau",
         "type": "string"
      },
      "u10": {
         "default": "u10proxy",
         "description": "Wind velocity definition",
         "enum": [
            "u10proxy",
            "true10"
         ],
         "title": "U10",
         "type": "string"
      },
      "windscaling": {
         "const": 32.0,
         "default": 32.0,
         "title": "Windscaling",
         "type": "number"
      },
      "cdfac": {
         "anyOf": [
            {
               "exclusiveMinimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Counter bias in the input wind fields by providing a multiplier on the drag coefficient",
         "title": "Cdfac"
      }
   },
   "additionalProperties": false
}

Fields:

a (Optional[float])
a1sds (Literal[2.8e-06])
a2sds (Literal[3.5e-05])
agrow (Literal[True])
cdfac (Optional[float])
model_type (Literal['st6c3'])
normalization (Literal['up', 'down'])
p1sds (Literal[4.0])
p2sds (Literal[4.0])
tau (Literal['vectau', 'scatau'])
u10 (Literal['u10proxy', 'true10'])
wind_drag (Literal['hwang', 'fan', 'ecmwf'])
windscaling (Literal[32.0])

Validators:

field a: float | None = None#

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

Validated by:

debias_only_with_hwang

field a1sds: Literal[2.8e-06] = 2.8e-06#

Validated by:

debias_only_with_hwang

field a2sds: Literal[3.5e-05] = 3.5e-05#

Validated by:

debias_only_with_hwang

field agrow: Literal[True] = True#

Validated by:

debias_only_with_hwang

field cdfac: float | None = None#

Counter bias in the input wind fields by providing a multiplier on the drag coefficient

Constraints:

gt = 0.0

Validated by:

debias_only_with_hwang

field model_type: Literal['st6c3'] = 'st6c3'#

Validated by:

debias_only_with_hwang

field normalization: Literal['up', 'down'] = 'up'#

Selection of normalization of exceedance level by ET(f) (up) or E(f) (down) as in RBW12 (right column, page 1333), up is default and strongly recommended

Validated by: