rompy.swan.components.startup.COORDINATES#

pydantic model rompy.swan.components.startup.COORDINATES[source]#

SWAN Coordinates.

COORDINATES ->CARTESIAN|SPHERICAL REPEATING

Command to choose between Cartesian and spherical coordinates (see Section 2.5). A nested SWAN run must use the same coordinate system as the coarse grid SWAN run.

Examples

In [215]: from rompy.swan.components.startup import COORDINATES

In [216]: coords = COORDINATES()

In [217]: print(coords.render())
COORDINATES CARTESIAN

In [218]: coords = COORDINATES(
   .....:     kind=dict(model_type="spherical", projection="ccm"),
   .....:     reapeating=True,
   .....: )
   .....: 

In [219]: print(coords.render())
COORDINATES SPHERICAL CCM REPEATING
Fields:
field kind: CARTESIAN | SPHERICAL [Optional]#

Coordinates kind

field model_type: Literal['coordinates', 'COORDINATES'] = 'coordinates'#

Model type discriminator

field reapeating: bool = False#

This option is only for academic cases. It means that wave energy leaving at one end of the domain (in computational x-direction) enter at the other side; it is as if the wave field repeats itself in x-direction with the length of the domain in x-direction. This option cannot be used in combination with computation of set-up (see command SETUP). This option is available only with regular grids

cmd() → str[source]#

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

On this page
Show Source