rompy.swan.components.cgrid.UNSTRUCTURED

pydantic model rompy.swan.components.cgrid.UNSTRUCTURED

SWAN unstructured computational grid.

CGRID UNSTRUCTURED CIRCLE|SECTOR [mdc] [flow] [fhigh] [msc]
READGRID UNSTRUCTURED [grid_type] ('fname')

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

Examples

In [27]: from rompy.swan.components.cgrid import UNSTRUCTURED

In [28]: cgrid = UNSTRUCTURED(
   ....:     grid_type="adcirc",
   ....:     spectrum=dict(mdc=36, flow=0.04, fhigh=1.0),
   ....: )
   ....: 

In [29]: print(cgrid.render())
CGRID UNSTRUCTURED CIRCLE mdc=36 flow=0.04 fhigh=1.0
READGRID UNSTRUCTURED ADCIRC

Fields:

• fname (str | None)

• grid_type (Literal['adcirc', 'triangle', 'easymesh'])

• model_type (Literal['unstructured'])

• spectrum (SPECTRUM)

Validators:

• check_fname_required » all fields

field fname: str | None = None

Name of the file containing the unstructured grid

Constraints:

• max_length = 36

Validated by:

• check_fname_required

field grid_type: Literal['adcirc', 'triangle', 'easymesh'] = 'adcirc'

Unstructured grid type

Validated by:

• check_fname_required

field model_type: Literal['unstructured'] = 'unstructured'

Model type discriminator

Validated by:

• check_fname_required

field spectrum: SPECTRUM [Required]

Spectrum subcomponent

Validated by:

• check_fname_required

validator check_fname_required  »  all fields

Check that fname needs to be provided.

cmd() → str

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