rompy.swan.subcomponents.boundary.SIDE#

pydantic model rompy.swan.subcomponents.boundary.SIDE[source]#

Boundary over one side of computational domain.

SIDE NORTH|NW|WEST|SW|SOUTH|SE|E|NE CCW|CLOCKWISE

The boundary is one full side of the computational grid (in 1D cases either of the two ends of the 1D-grid).

Note

Should not be used in case of CURVILINEAR grids.

Examples

In [264]: from rompy.swan.subcomponents.boundary import SIDE

In [265]: side = SIDE(side="west", direction="ccw")

In [266]: print(side.render())
SIDE WEST CCW

Show JSON schema
{
   "title": "SIDE",
   "description": "Boundary over one side of computational domain.\n\n.. code-block:: text\n\n    SIDE NORTH|NW|WEST|SW|SOUTH|SE|E|NE CCW|CLOCKWISE\n\nThe boundary is one full side of the computational grid (in 1D cases either of the\ntwo ends of the 1D-grid).\n\nNote\n----\nShould not be used in case of CURVILINEAR grids.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.subcomponents.boundary import SIDE\n    side = SIDE(side=\"west\", direction=\"ccw\")\n    print(side.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "side",
         "description": "Model type discriminator",
         "enum": [
            "side",
            "SIDE"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "side": {
         "description": "The side of the grid to apply the boundary to",
         "enum": [
            "north",
            "nw",
            "west",
            "sw",
            "south",
            "se",
            "east",
            "ne"
         ],
         "title": "Side",
         "type": "string"
      },
      "direction": {
         "default": "ccw",
         "description": "The direction to apply the boundary in",
         "enum": [
            "ccw",
            "clockwise"
         ],
         "title": "Direction",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "side"
   ]
}

Fields:
field direction: Literal['ccw', 'clockwise'] = 'ccw'#

The direction to apply the boundary in

field model_type: Literal['side', 'SIDE'] = 'side'#

Model type discriminator

field side: Literal['north', 'nw', 'west', 'sw', 'south', 'se', 'east', 'ne'] [Required]#

The side of the grid to apply the boundary to

cmd() → str[source]#