rompy.swan.components.output.FRAME

pydantic model rompy.swan.components.output.FRAME

Output locations on a regular grid.

FRAME 'sname' [xpfr] [ypfr] [alpfr] [xlenfr] [ylenfr] [mxfr] [myfr]

With this optional command the user defines output on a rectangular, uniform grid in a regular frame.

If the set of output locations is identical to a part of the computational grid, then the user can use the alternative command GROUP.

Note

Cannot be used in 1D-mode.

Examples

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

In [2]: loc = FRAME(
   ...:     sname="outgrid",
   ...:     grid=dict(xp=173, yp=-40, xlen=2, ylen=2, mx=19, my=19),
   ...: )
   ...: 

In [3]: print(loc.render())
FRAME sname='outgrid' xpfr=173.0 ypfr=-40.0 alpfr=0.0 xlenfr=2.0 ylenfr=2.0 mxfr=19 myfr=19

Fields:

• grid (rompy.swan.subcomponents.readgrid.GRIDREGULAR)

• model_type (Literal['frame', 'FRAME'])

Validators:

• grid_suffix » grid

field grid: GRIDREGULAR [Required]

Frame grid definition

Validated by:

• grid_suffix

field model_type: Literal['frame', 'FRAME'] = 'frame'

Model type discriminator

cmd() → str

Command file string for this component.

validator grid_suffix  »  grid