rompy.swan.components.output.ISOLINE#

pydantic model rompy.swan.components.output.ISOLINE[source]#

Output locations along a depth contour.

ISOLINE 'sname' 'rname' DEPTH|BOTTOM [dep]

With this optional command the user defines a set of output locations along one depth or bottom level contour line (in combination with command RAY).

Note

Cannot be used in 1D-mode.

Examples

In [1]: from rompy.swan.components.output import ISOLINE

In [2]: loc = ISOLINE(sname="outcurve", rname="outray", dep_type="depth", dep=12.0)

In [3]: print(loc.render())
ISOLINE sname='outcurve' rname='outray' DEPTH dep=12.0

Fields:

dep (float)
dep_type (Literal['depth', 'bottom'] | None)
model_type (Literal['isoline', 'ISOLINE'])
rname (str)

Validators:

field dep: float [Required]#: The depth (in m) of the depth contour line along which output locations are generated by SWAN.

field dep_type: Literal['depth', 'bottom'] | None = None#: Define if the depth contour is extracted from the DEPTH output (the stationary water depth) or from the BOTTOM output (the depth relative to the datum level with the water level ignored) (SWAN default: DEPTH)

field model_type: Literal['isoline', 'ISOLINE'] = 'isoline'#: Model type discriminator

field rname: str [Required]#

Name of the set of rays defined by this command

Constraints:

max_length = 8

cmd() → str[source]#: Command file string for this component.

Table of Contents

rompy.swan.components.output.ISOLINE#