rompy.swan.components.cgrid.REGULAR

pydantic model rompy.swan.components.cgrid.REGULAR

SWAN regular computational grid.

CGRID REGULAR [xpc] [ypc] [alpc] [xlenc] [ylenc] [mxc] [myc] &
    ->CIRCLE|SECTOR [mdc] [flow] [fhigh] [msc]

This is a group component that includes a CGRID and a READGRID component.

Note

In 1D-mode, alpc should be equal to the direction alpinp.

Examples

In [24]: from rompy.swan.components.cgrid import REGULAR

In [25]: cgrid = REGULAR(
   ....:     grid=dict(xp=0, yp=0, alp=0, xlen=2000, ylen=1300, mx=100, my=100),
   ....:     spectrum=dict(mdc=36, flow=0.04, fhigh=1.0),
   ....: )
   ....: 

In [26]: print(cgrid.render())
CGRID REGULAR xpc=0.0 ypc=0.0 alpc=0.0 xlenc=2000.0 ylenc=1300.0 mxc=100 myc=100 CIRCLE mdc=36 flow=0.04 fhigh=1.0

Fields:

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

• model_type (Literal['regular', 'REGULAR'])

• spectrum (SPECTRUM)

Validators:

• grid_suffix » all fields

field grid: GRIDREGULAR [Required]

Computational grid definition

Validated by:

• grid_suffix

field model_type: Literal['regular', 'REGULAR'] = 'regular'

Model type discriminator

Validated by:

• grid_suffix

field spectrum: SPECTRUM [Required]

Spectrum subcomponent

Validated by:

• grid_suffix

cmd() → str

Return the string or list of strings to render the component to the CMD.

validator grid_suffix  »  all fields

Set expected grid suffix.