rompy.swan.components.physics.BREAKING_BKD#

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

Variable wave breaking index.

BREAKING BKD [alpha] [gamma0] [a1] [a2] [a3]

Indicates that the breaker index scales with both the bottom slope (beta) and the dimensionless depth (kd).

Examples

In [23]: from rompy.swan.components.physics import BREAKING_BKD

In [24]: breaking = BREAKING_BKD()

In [25]: print(breaking.render())
BREAKING BKD

In [26]: breaking = BREAKING_BKD(alpha=1.0, gamma0=0.54, a1=7.59, a2=-8.06, a3=8.09)

In [27]: print(breaking.render())
BREAKING BKD alpha=1.0 gamma0=0.54 a1=7.59 a2=-8.06 a3=8.09

Show JSON schema
{
   "title": "BREAKING_BKD",
   "description": "Variable wave breaking index.\n\n.. code-block:: text\n\n    BREAKING BKD [alpha] [gamma0] [a1] [a2] [a3]\n\nIndicates that the breaker index scales with both the bottom slope (`beta`)\nand the dimensionless depth (kd).\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import BREAKING_BKD\n    breaking = BREAKING_BKD()\n    print(breaking.render())\n    breaking = BREAKING_BKD(alpha=1.0, gamma0=0.54, a1=7.59, a2=-8.06, a3=8.09)\n    print(breaking.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "bkd",
         "description": "Model type discriminator",
         "enum": [
            "bkd",
            "BKD"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "alpha": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Proportionality coefficient of the rate of dissipation (SWAN default: 1.0)",
         "title": "Alpha"
      },
      "gamma0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The reference $gamma$ for horizontal slopes (SWAN default: 0.54)",
         "title": "Gamma0"
      },
      "a1": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "First tunable coefficient for the breaker index (SWAN default: 7.59)",
         "title": "A1"
      },
      "a2": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Second tunable coefficient for the breaker index (SWAN default: -8.06)",
         "title": "A2"
      },
      "a3": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Third tunable coefficient for the breaker index (SWAN default: 8.09)",
         "title": "A3"
      }
   },
   "additionalProperties": false
}

Fields:
field a1: float | None = None#

First tunable coefficient for the breaker index (SWAN default: 7.59)

field a2: float | None = None#

Second tunable coefficient for the breaker index (SWAN default: -8.06)

field a3: float | None = None#

Third tunable coefficient for the breaker index (SWAN default: 8.09)

field alpha: float | None = None#

Proportionality coefficient of the rate of dissipation (SWAN default: 1.0)

field gamma0: float | None = None#

The reference $gamma$ for horizontal slopes (SWAN default: 0.54)

field model_type: Literal['bkd', 'BKD'] = 'bkd'#

Model type discriminator

cmd() → str[source]#

Command file string for this component.