rompy.swan.subcomponents.boundary.SIDE

pydantic model rompy.swan.subcomponents.boundary.SIDE

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 

Fields:

• direction (Literal['ccw', 'clockwise'])

• model_type (Literal['side', 'SIDE'])

• side (Literal['north', 'nw', 'west', 'sw', 'south', 'se', 'east', 'ne'])

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