rompy.swan.components.physics.FRICTION_MADSEN#

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

Madsen et al (1988) friction.

FRICTION MADSEN [kn]

Note that kn is allowed to vary over the computational region; in that case use the commands INPGRID FRICTION and READINP FRICTION to define and read the friction data. This command FRICTION is still required to define the type of friction expression. The value of kn in this command is then not required (it will be ignored).

References

Madsen, O.S., Poon, Y.K. and Graber, H.C., 1988. Spectral wave attenuation by bottom friction: Theory. In Coastal engineering 1988 (pp. 492-504).

Madsen, O.S. and Rosengaus, M.M., 1988. Spectral wave attenuation by bottom friction: Experiments. In Coastal Engineering 1988 (pp. 849-857).

Examples

In [48]: from rompy.swan.components.physics import FRICTION_MADSEN

In [49]: friction = FRICTION_MADSEN()

In [50]: print(friction.render())
FRICTION MADSEN

In [51]: friction = FRICTION_MADSEN(kn=0.038)

In [52]: print(friction.render())
FRICTION MADSEN kn=0.038

Show JSON schema
{
   "title": "FRICTION_MADSEN",
   "description": "Madsen et al (1988) friction.\n\n.. code-block:: text\n\n    FRICTION MADSEN [kn]\n\nNote that `kn` is allowed to vary over the computational region; in that case use\nthe commands INPGRID FRICTION and READINP FRICTION to define and read the friction\ndata. This command FRICTION is still required to define the type of friction\nexpression. The value of `kn` in this command is then not required (it will be\nignored).\n\nReferences\n----------\nMadsen, O.S., Poon, Y.K. and Graber, H.C., 1988. Spectral wave attenuation by\nbottom friction: Theory. In Coastal engineering 1988 (pp. 492-504).\n\nMadsen, O.S. and Rosengaus, M.M., 1988. Spectral wave attenuation by bottom\nfriction: Experiments. In Coastal Engineering 1988 (pp. 849-857).\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import FRICTION_MADSEN\n    friction = FRICTION_MADSEN()\n    print(friction.render())\n    friction = FRICTION_MADSEN(kn=0.038)\n    print(friction.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "madsen",
         "description": "Model type discriminator",
         "enum": [
            "madsen",
            "MADSEN"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "kn": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "equivalent roughness length scale of the bottom (in m) (SWAN default: 0.05)",
         "title": "Kn"
      }
   },
   "additionalProperties": false
}

Fields:
field kn: float | None = None#

equivalent roughness length scale of the bottom (in m) (SWAN default: 0.05)

field model_type: Literal['madsen', 'MADSEN'] = 'madsen'#

Model type discriminator

cmd() → str[source]#

Command file string for this component.