rompy.swan.components.physics.FRICTION_RIPPLES#

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

Smith et al. (2011) Ripples friction.

FRICTION RIPPLES [S] [D]

Indicates that the expression of Smith et al. (2011) should be activated. Here friction depends on the formation of bottom ripples and sediment size.

References

Smith, G.A., Babanin, A.V., Riedel, P., Young, I.R., Oliver, S. and Hubbert, G., 2011. Introduction of a new friction routine into the SWAN model that evaluates roughness due to bedform and sediment size changes. Coastal Engineering, 58(4), pp.317-326.

Examples

In [53]: from rompy.swan.components.physics import FRICTION_RIPPLES

In [54]: friction = FRICTION_RIPPLES()

In [55]: print(friction.render())
FRICTION RIPPLES

In [56]: friction = FRICTION_RIPPLES(s=2.65, d=0.0001)

In [57]: print(friction.render())
FRICTION RIPPLES S=2.65 D=0.0001

Show JSON schema
{
   "title": "FRICTION_RIPPLES",
   "description": "Smith et al. (2011) Ripples friction.\n\n.. code-block:: text\n\n    FRICTION RIPPLES [S] [D]\n\nIndicates that the expression of Smith et al. (2011) should be activated. Here\nfriction depends on the formation of bottom ripples and sediment size.\n\nReferences\n----------\nSmith, G.A., Babanin, A.V., Riedel, P., Young, I.R., Oliver, S. and Hubbert, G.,\n2011. Introduction of a new friction routine into the SWAN model that evaluates\nroughness due to bedform and sediment size changes. Coastal Engineering, 58(4),\npp.317-326.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import FRICTION_RIPPLES\n    friction = FRICTION_RIPPLES()\n    print(friction.render())\n    friction = FRICTION_RIPPLES(s=2.65, d=0.0001)\n    print(friction.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "ripples",
         "description": "Model type discriminator",
         "enum": [
            "ripples",
            "RIPPLES"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "s": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The specific gravity of the sediment (SWAN default: 2.65)",
         "title": "S"
      },
      "d": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The sediment diameter (in m) (SWAN default: 0.0001)",
         "title": "D"
      }
   },
   "additionalProperties": false
}

Fields:
field d: float | None = None#

The sediment diameter (in m) (SWAN default: 0.0001)

field model_type: Literal['ripples', 'RIPPLES'] = 'ripples'#

Model type discriminator

field s: float | None = None#

The specific gravity of the sediment (SWAN default: 2.65)

cmd() → str[source]#

Command file string for this component.