rompy.swan.components.physics.BREAKING_CONSTANT#

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

Constant wave breaking index.

BREAKING CONSTANT [alpha] [gamma]

Indicates that a constant breaker index is to be used.

Examples

In [28]: from rompy.swan.components.physics import BREAKING_CONSTANT

In [29]: breaking = BREAKING_CONSTANT()

In [30]: print(breaking.render())
BREAKING CONSTANT

In [31]: breaking = BREAKING_CONSTANT(alpha=1.0, gamma=0.73)

In [32]: print(breaking.render())
BREAKING CONSTANT alpha=1.0 gamma=0.73

Show JSON schema
{
   "title": "BREAKING_CONSTANT",
   "description": "Constant wave breaking index.\n\n.. code-block:: text\n\n    BREAKING CONSTANT [alpha] [gamma]\n\nIndicates that a constant breaker index is to be used.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import BREAKING_CONSTANT\n    breaking = BREAKING_CONSTANT()\n    print(breaking.render())\n    breaking = BREAKING_CONSTANT(alpha=1.0, gamma=0.73)\n    print(breaking.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "constant",
         "description": "Model type discriminator",
         "enum": [
            "constant",
            "CONSTANT"
         ],
         "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"
      },
      "gamma": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The breaker index, i.e. the ratio of maximum individual wave height over depth (SWAN default: 0.73)",
         "title": "Gamma"
      }
   },
   "additionalProperties": false
}

Fields:
field alpha: float | None = None#

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

field gamma: float | None = None#

The breaker index, i.e. the ratio of maximum individual wave height over depth (SWAN default: 0.73)

field model_type: Literal['constant', 'CONSTANT'] = 'constant'#

Model type discriminator

cmd() → str[source]#

Command file string for this component.