rompy.swan.components.inpgrid.ICE#

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

Constant wind input field.

ICE [aice] [hice]

With this optional command, the user indicates that one or more ice fields are constant.

Examples

In [66]: from rompy.swan.components.inpgrid import ICE

In [67]: ice = ICE(aice=0.1, hice=0.1)

In [68]: print(ice.render())
ICE aice=0.1 hice=0.1

Show JSON schema
{
   "title": "ICE",
   "description": "Constant wind input field.\n\n.. code-block:: text\n\n    ICE [aice] [hice]\n\nWith this optional command, the user indicates that one or more ice fields are\nconstant.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.inpgrid import ICE\n    ice = ICE(aice=0.1, hice=0.1)\n    print(ice.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "ice",
         "description": "Model type discriminator",
         "enum": [
            "ice",
            "ICE"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "aice": {
         "description": "Areal ice fraction, a number from 0 to 1",
         "maximum": 1.0,
         "minimum": 0.0,
         "title": "Aice",
         "type": "number"
      },
      "hice": {
         "description": "Ice thickness (m)",
         "minimum": 0.0,
         "title": "Hice",
         "type": "number"
      }
   },
   "additionalProperties": false,
   "required": [
      "aice",
      "hice"
   ]
}

Fields:
field aice: float [Required]#

Areal ice fraction, a number from 0 to 1

Constraints:

  • ge = 0.0

  • le = 1.0

field hice: float [Required]#

Ice thickness (m)

Constraints:

  • ge = 0.0

field model_type: Literal['ice', 'ICE'] = 'ice'#

Model type discriminator

cmd()[source]#

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