rompy.swan.components.startup.MODE#

pydantic model rompy.swan.components.startup.MODE[source]#

SWAN Mode.

MODE ->STATIONARY|NONSTATIONARY ->TWODIMENSIONAL|ONEDIMENSIONAL

With this optional command the user indicates that the run will be either stationary or nonstationary and one-dimensional (1D-mode) or two-dimensional (2D-mode). Nonstationary means either (see command COMPUTE):

    1. one nonstationary computations or

    1. a sequence of stationary computations or

    1. a mix of (a) and (b)

Examples

In [220]: from rompy.swan.components.startup import MODE

In [221]: mode = MODE()

In [222]: print(mode.render())
MODE STATIONARY TWODIMENSIONAL

In [223]: mode = MODE(kind="nonstationary", dim="twodimensional")

In [224]: print(mode.render())
MODE NONSTATIONARY TWODIMENSIONAL

Show JSON schema
{
   "title": "MODE",
   "description": "SWAN Mode.\n\n.. code-block:: text\n\n    MODE ->STATIONARY|NONSTATIONARY ->TWODIMENSIONAL|ONEDIMENSIONAL\n\nWith this optional command the user indicates that the run will be either\nstationary or nonstationary and one-dimensional (1D-mode) or two-dimensional\n(2D-mode). Nonstationary means either (see command COMPUTE):\n\n* (a) one nonstationary computations or\n* (b) a sequence of stationary computations or\n* (c) a mix of (a) and (b)\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.startup import MODE\n    mode = MODE()\n    print(mode.render())\n    mode = MODE(kind=\"nonstationary\", dim=\"twodimensional\")\n    print(mode.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "mode",
         "description": "Model type discriminator.",
         "enum": [
            "mode",
            "MODE"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "kind": {
         "default": "stationary",
         "description": "Indicates if run will be stationary or nonstationary",
         "enum": [
            "stationary",
            "nonstationary"
         ],
         "title": "Kind",
         "type": "string"
      },
      "dim": {
         "default": "twodimensional",
         "description": "Indicates that the run will be either one-dimensional (1D-mode) or two-dimensional (2D-mode)",
         "enum": [
            "onedimensional",
            "twodimensional"
         ],
         "title": "Dim",
         "type": "string"
      }
   },
   "additionalProperties": false
}

Fields:
field dim: Literal['onedimensional', 'twodimensional'] = 'twodimensional'#

Indicates that the run will be either one-dimensional (1D-mode) or two-dimensional (2D-mode)

field kind: Literal['stationary', 'nonstationary'] = 'stationary'#

Indicates if run will be stationary or nonstationary

field model_type: Literal['mode', 'MODE'] = 'mode'#

Model type discriminator.

cmd() → str[source]#

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