rompy.swan.components.startup.MODE

pydantic model rompy.swan.components.startup.MODE

SWAN Mode.

MODE ->STATIONARY|NONSTATIONARY ->TWODIMENSIONAL|ONEDIMENSIONAL

With this optional command the user indicates that the run will be either stationary or nonstationary and one-dimensional (1D-mode) or two-dimensional (2D-mode). Nonstationary means either (see command COMPUTE):

• 1. one nonstationary computations or

• 2. a sequence of stationary computations or

• 3. a mix of (a) and (b)

Examples

In [220]: from rompy.swan.components.startup import MODE

In [221]: mode = MODE()

In [222]: print(mode.render())
MODE STATIONARY TWODIMENSIONAL

In [223]: mode = MODE(kind="nonstationary", dim="twodimensional")

In [224]: print(mode.render())
MODE NONSTATIONARY TWODIMENSIONAL

Fields:

• dim (Literal['onedimensional', 'twodimensional'])

• kind (Literal['stationary', 'nonstationary'])

• model_type (Literal['mode', 'MODE'])

field dim: Literal['onedimensional', 'twodimensional'] = 'twodimensional'

Indicates that the run will be either one-dimensional (1D-mode) or two-dimensional (2D-mode)

field kind: Literal['stationary', 'nonstationary'] = 'stationary'

Indicates if run will be stationary or nonstationary

field model_type: Literal['mode', 'MODE'] = 'mode'

Model type discriminator.

cmd() → str

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