rompy.swan.subcomponents.physics.REFL#

pydantic model rompy.swan.subcomponents.physics.REFL[source]#

Obstacle reflections.

REFL [reflc]

Examples

In [45]: from rompy.swan.subcomponents.physics import REFL

In [46]: refl = REFL()

In [47]: print(refl.render())
REFL

In [48]: refl = REFL(reflc=0.5)

In [49]: print(refl.render())
REFL reflc=0.5

Show JSON schema
{
   "title": "REFL",
   "description": "Obstacle reflections.\n\n.. code-block:: text\n\n    REFL [reflc]\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.subcomponents.physics import REFL\n    refl = REFL()\n    print(refl.render())\n    refl = REFL(reflc=0.5)\n    print(refl.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "refl",
         "description": "Model type discriminator",
         "enum": [
            "refl",
            "REFL"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "reflc": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Constant reflection coefficient (ratio of reflected over incoming significant wave height) (SWAN default: 1.0)",
         "title": "Reflc"
      }
   },
   "additionalProperties": false
}

Fields:
field model_type: Literal['refl', 'REFL'] = 'refl'#

Model type discriminator

field reflc: float | None = None#

Constant reflection coefficient (ratio of reflected over incoming significant wave height) (SWAN default: 1.0)

cmd() → str[source]#

Command file string for this subcomponent.