rompy.swan.components.output.ISOLINE#

pydantic model rompy.swan.components.output.ISOLINE[source]#

Output locations along a depth contour.

ISOLINE 'sname' 'rname' DEPTH|BOTTOM [dep]

With this optional command the user defines a set of output locations along one depth or bottom level contour line (in combination with command RAY).

Note

Cannot be used in 1D-mode.

Examples

In [1]: from rompy.swan.components.output import ISOLINE

In [2]: loc = ISOLINE(sname="outcurve", rname="outray", dep_type="depth", dep=12.0)

In [3]: print(loc.render())
ISOLINE sname='outcurve' rname='outray' DEPTH dep=12.0

Show JSON schema

{
   "title": "ISOLINE",
   "description": "Output locations along a depth contour.\n\n.. code-block:: text\n\n    ISOLINE 'sname' 'rname' DEPTH|BOTTOM [dep]\n\nWith this optional command the user defines a set of output locations along one\ndepth or bottom level contour line (in combination with command RAY).\n\nNote\n----\nCannot be used in 1D-mode.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.output import ISOLINE\n    loc = ISOLINE(sname=\"outcurve\", rname=\"outray\", dep_type=\"depth\", dep=12.0)\n    print(loc.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "isoline",
         "description": "Model type discriminator",
         "enum": [
            "isoline",
            "ISOLINE"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "sname": {
         "description": "Name of the set of output locations defined by this command",
         "maxLength": 8,
         "title": "Sname",
         "type": "string"
      },
      "rname": {
         "description": "Name of the set of rays defined by this command",
         "maxLength": 8,
         "title": "Rname",
         "type": "string"
      },
      "dep": {
         "description": "The depth (in m) of the depth contour line along which output locations are generated by SWAN.",
         "title": "Dep",
         "type": "number"
      },
      "dep_type": {
         "anyOf": [
            {
               "enum": [
                  "depth",
                  "bottom"
               ],
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Define if the depth contour is extracted from the DEPTH output (the stationary water depth) or from the BOTTOM output (the depth relative to the datum level with the water level ignored) (SWAN default: DEPTH)",
         "title": "Dep Type"
      }
   },
   "additionalProperties": false,
   "required": [
      "sname",
      "rname",
      "dep"
   ]
}

Fields:

dep (float)
dep_type (Literal['depth', 'bottom'] | None)
model_type (Literal['isoline', 'ISOLINE'])
rname (str)

Validators:

field dep: float [Required]#: The depth (in m) of the depth contour line along which output locations are generated by SWAN.

field dep_type: Literal['depth', 'bottom'] | None = None#: Define if the depth contour is extracted from the DEPTH output (the stationary water depth) or from the BOTTOM output (the depth relative to the datum level with the water level ignored) (SWAN default: DEPTH)

field model_type: Literal['isoline', 'ISOLINE'] = 'isoline'#: Model type discriminator

field rname: str [Required]#

Name of the set of rays defined by this command

Constraints:

max_length = 8

cmd() → str[source]#: Command file string for this component.

Table of Contents

rompy.swan.components.output.ISOLINE#

This Page