rompy.swan.components.output.POINTS#

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

Isolated output locations.

POINTS 'sname' < [xp] [yp] >

With this optional command the user defines a set of individual output point locations.

Note

All coordinates and distances should be given in m when Cartesian coordinates are used or degrees when Spherical coordinates are used (see command COORD).

Examples

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

In [2]: loc = POINTS(sname="outpts", xp=[172.3, 172.4], yp=[-39, -39])

In [3]: print(loc.render())
POINTS sname='outpts' &
    xp=172.3 yp=-39.0 &
    xp=172.4 yp=-39.0

Show JSON schema
{
   "title": "POINTS",
   "description": "Isolated output locations.\n\n.. code-block:: text\n\n    POINTS 'sname' < [xp] [yp] >\n\nWith this optional command the user defines a set of individual output point\nlocations.\n\nNote\n----\nAll coordinates and distances should be given in m when Cartesian coordinates are\nused or degrees when Spherical coordinates are used (see command COORD).\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.output import POINTS\n    loc = POINTS(sname=\"outpts\", xp=[172.3, 172.4], yp=[-39, -39])\n    print(loc.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "points",
         "description": "Model type discriminator",
         "enum": [
            "points",
            "POINTS"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "sname": {
         "description": "Name of the set of output locations defined by this command",
         "maxLength": 8,
         "title": "Sname",
         "type": "string"
      },
      "xp": {
         "anyOf": [
            {
               "items": {
                  "type": "number"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "description": "problem coordinates of the points in the x-direction",
         "title": "Xp"
      },
      "yp": {
         "anyOf": [
            {
               "items": {
                  "type": "number"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "description": "problem coordinates of the points in the y-direction",
         "title": "Yp"
      }
   },
   "additionalProperties": false,
   "required": [
      "sname",
      "xp",
      "yp"
   ]
}

Fields:
Validators:
field model_type: Literal['points', 'POINTS'] = 'points'#

Model type discriminator

Validated by:
field xp: list[float] | None [Required]#

problem coordinates of the points in the x-direction

Constraints:

  • min_length = 1

Validated by:
field yp: list[float] | None [Required]#

problem coordinates of the points in the y-direction

Constraints:

  • min_length = 1

Validated by:
cmd() → str[source]#

Command file string for this component.

validator ensure_equal_size  »  all fields[source]#