rompy.swan.components.group.LOCKUP

pydantic model rompy.swan.components.group.LOCKUP

Lockup group component.

COMPUTE ...
HOTFILE ...
COMPUTE ...
HOTFILE ...
...
STOP

This is a group component to specify SWAN “Lockup” commands including multiple COMPUTE commands that may or may not be interleaved with HOTFILE commands, and a final STOP command.

Examples

In [37]: from rompy.swan.components.group import LOCKUP

In [38]: lockup = LOCKUP(
   ....:     compute=dict(
   ....:         model_type="stat",
   ....:         times=dict(
   ....:             model_type="nonstationary",
   ....:             tbeg="1990-01-01T00:00:00",
   ....:             tend="1990-01-01T03:00:00",
   ....:             delt="PT1H",
   ....:             dfmt="hr",
   ....:         ),
   ....:         hotfile=dict(fname="hotfile"),
   ....:         hottimes=[-1],
   ....:     ),
   ....: )
   ....: 

In [39]: print(lockup.render())
COMPUTE STATIONARY time=19900101.000000
COMPUTE STATIONARY time=19900101.010000
COMPUTE STATIONARY time=19900101.020000
COMPUTE STATIONARY time=19900101.030000
HOTFILE fname='hotfile_19900101T030000'
STOP

Fields:

• compute (rompy.swan.components.lockup.COMPUTE_STAT | rompy.swan.components.lockup.COMPUTE_NONSTAT)

• model_type (Literal['lockup', 'LOCKUP'])

field compute: COMPUTE_STAT | COMPUTE_NONSTAT [Required]

Compute components

field model_type: Literal['lockup', 'LOCKUP'] = 'lockup'

Model type discriminator

cmd() → list

Command file strings for this component.