rompy.swan.components.output.QUANTITIES

pydantic model rompy.swan.components.output.QUANTITIES

Define output settings for multiple output.

QUANTITY < output > ...
QUANTITY < output > ...
..

This component can be used to prescribe and render multiple QUANTITY components.

Examples

In [1]: from rompy.swan.components.output import QUANTITY, QUANTITIES

In [2]: q1 = QUANTITY(output=["xp"], hexp=100)

In [3]: q2 = QUANTITY(output=["hsign", "tm01", "rtmm10"], excv=-9)

In [4]: q3 = QUANTITY(output=["hsign", "tm02", "fspr"], fmin=0.03, fmax=0.5)

In [5]: q4 = QUANTITY(output=["hsign"], fswell=0.08)

In [6]: q5 = QUANTITY(output=["per"], short="Tm-1,0", power=0)

In [7]: q6 = QUANTITY(output=["transp", "force"], coord="frame")

In [8]: quantities = QUANTITIES(quantities=[q1, q2, q3, q4, q5, q6])

In [9]: print(quantities.render())
QUANTITY XP hexp=100.0
QUANTITY HSIGN TM01 RTMM10 excv=-9.0
QUANTITY HSIGN TM02 FSPR fmin=0.03 fmax=0.5
QUANTITY HSIGN fswell=0.08
QUANTITY PER short='Tm-1,0' power=0.0
QUANTITY TRANSP FORCE FRAME

Fields:

• model_type (Literal['quantities', 'QUANTITIES'])

• quantities (list[rompy.swan.components.output.QUANTITY])

field model_type: Literal['quantities', 'QUANTITIES'] = 'quantities'

Model type discriminator

field quantities: list[QUANTITY] [Required]

QUANTITY components

cmd() → list

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