rompy.swan.components.physics.FRICTION_COLLINS#

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

Collins (1972) friction.

FRICTION COLLINS [cfw]

Note that cfw 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 cfw in this command is then not required (it will be ignored).

References

Collins, J.I., 1972. Prediction of shallow-water spectra. Journal of Geophysical Research, 77(15), pp.2693-2707.

Examples

In [38]: from rompy.swan.components.physics import FRICTION_COLLINS

In [39]: friction = FRICTION_COLLINS()

In [40]: print(friction.render())
FRICTION COLLINS

In [41]: friction = FRICTION_COLLINS(cfw=0.038)

In [42]: print(friction.render())
FRICTION COLLINS cfw=0.038

Show JSON schema
{
   "title": "FRICTION_COLLINS",
   "description": "Collins (1972) friction.\n\n.. code-block:: text\n\n    FRICTION COLLINS [cfw]\n\nNote that `cfw` 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 `cfw` in this command is then not required (it will be\nignored).\n\nReferences\n----------\nCollins, J.I., 1972. Prediction of shallow-water spectra. Journal of Geophysical\nResearch, 77(15), pp.2693-2707.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import FRICTION_COLLINS\n    friction = FRICTION_COLLINS()\n    print(friction.render())\n    friction = FRICTION_COLLINS(cfw=0.038)\n    print(friction.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "collins",
         "description": "Model type discriminator",
         "enum": [
            "collins",
            "COLLINS"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "cfw": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Collins bottom friction coefficient (SWAN default: 0.015)",
         "title": "Cfw"
      }
   },
   "additionalProperties": false
}

Fields:
field cfw: float | None = None#

Collins bottom friction coefficient (SWAN default: 0.015)

field model_type: Literal['collins', 'COLLINS'] = 'collins'#

Model type discriminator

cmd() → str[source]#

Command file string for this component.