rompy.swan.components.inpgrid.UNSTRUCTURED

pydantic model rompy.swan.components.inpgrid.UNSTRUCTURED

SWAN unstructured input grid.

INPGRID [grid_type] UNSTRUCTURED EXCEPTION [excval]) &
    (NONSTATIONARY [tbeginp] [deltinp] ->SEC|MIN|HR|DAY [tendinp])
READGRID [grid_type] [fac] 'fname1' [idla] [nhedf] ([nhedt]) ([nhedvec]) &
    ->FREE|FORMAT|UNFORMATTED ('form'|[idfm])

This is a group component that includes an INPGRID and a READGRID component.

Examples

In [74]: from rompy.swan.components.inpgrid import UNSTRUCTURED

In [75]: inpgrid = UNSTRUCTURED(
   ....:     grid_type="bottom",
   ....:     excval=-99.0,
   ....:     readinp=dict(fname1="bottom.txt"),
   ....:     nonstationary=dict(
   ....:         tbeg="2019-01-01T00:00:00",
   ....:         tend="2019-01-07 00:00:00",
   ....:         delt=3600,
   ....:         dfmt="hr",
   ....:     ),
   ....: )
   ....: 

In [76]: print(inpgrid.render())
INPGRID BOTTOM UNSTRUCTURED EXCEPTION excval=-99.0 NONSTATIONARY tbeginp=20190101.000000 deltinp=1.0 HR tendinp=20190107.000000
READINP BOTTOM fac=1.0 fname1='bottom.txt' idla=1 nhedf=0 nhedt=0 nhedvec=0 FREE

Fields:

• excval (Optional[float])

• grid_type (GridOptions)

• model_type (Literal['unstructured', 'UNSTRUCTURED'])

• nonstationary (Optional[NONSTATIONARY])

• readinp (READINP)

Validators:

field excval: float | None = None

Exception value to allow identifying and ignoring certain point inside the given grid during the computation. If fac != 1, excval must be given as fac times the exception value

Validated by:

• set_nonstat_suffix

field grid_type: GridOptions [Required]

Type of the swan input grid, e.g, ‘bottom’, ‘wind’, etc

Validated by:

• set_nonstat_suffix

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

Model type discriminator

Validated by:

• set_nonstat_suffix

field nonstationary: NONSTATIONARY | None = None

Nonstationary time specification

Validated by:

• set_nonstat_suffix

field readinp: READINP [Required]

SWAN input grid file reader specification

Validated by:

• set_nonstat_suffix

cmd() → str

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