rompy.swan.components.inpgrid.WIND#

pydantic model rompy.swan.components.inpgrid.WIND[source]#

Constant wind input field.

WIND [vel] [dir]

With this optional command, the user indicates that the wind field is constant.

Examples

In [77]: from rompy.swan.components.inpgrid import WIND

In [78]: wind = WIND(vel=10.0, dir=270.0)

In [79]: print(wind.render())
WIND vel=10.0 dir=270.0

Show JSON schema
{
   "title": "WIND",
   "description": "Constant wind input field.\n\n.. code-block:: text\n\n    WIND [vel] [dir]\n\nWith this optional command, the user indicates that the wind field is constant.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.inpgrid import WIND\n    wind = WIND(vel=10.0, dir=270.0)\n    print(wind.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "wind",
         "description": "Model type discriminator",
         "enum": [
            "wind",
            "WIND"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "vel": {
         "description": "Wind velocity at 10 m elevation (m/s)",
         "minimum": 0.0,
         "title": "Vel",
         "type": "number"
      },
      "dir": {
         "description": "Wind direction at 10 m elevation (in degrees, Cartesian or Nautical convention, see command SET)",
         "maximum": 360.0,
         "minimum": -180.0,
         "title": "Dir",
         "type": "number"
      }
   },
   "additionalProperties": false,
   "required": [
      "vel",
      "dir"
   ]
}

Fields:
field dir: float [Required]#

Wind direction at 10 m elevation (in degrees, Cartesian or Nautical convention, see command SET)

Constraints:

  • ge = -180.0

  • le = 360.0

field model_type: Literal['wind', 'WIND'] = 'wind'#

Model type discriminator

field vel: float [Required]#

Wind velocity at 10 m elevation (m/s)

Constraints:

  • ge = 0.0

cmd()[source]#

Return the string or list of strings to render the component to the CMD.