Skip to content

Base

Sub-commands to support the output components

XY

Bases: BaseSubComponent

Points in problem coordinates.

.. code-block:: text

< [x] [y] >

Note

Coordinates should be given in m when Cartesian coordinates are used or degrees when Spherical coordinates are used (see command COORD).

Examples

.. ipython:: python :okwarning:

from rompy_swan.subcomponents.base import XY
points = XY(
    x=[172, 172, 172, 172.5, 173],
    y=[-41, -40.5, -40, -40, -40],
    fmt="0.2f",
)
print(points.render())
Source code in src/rompy_swan/subcomponents/base.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class XY(BaseSubComponent):
    """Points in problem coordinates.

    .. code-block:: text

        < [x] [y] >

    Note
    ----
    Coordinates should be given in m when Cartesian coordinates are used or degrees
    when Spherical coordinates are used (see command `COORD`).

    Examples
    --------

    .. ipython:: python
        :okwarning:

        from rompy_swan.subcomponents.base import XY
        points = XY(
            x=[172, 172, 172, 172.5, 173],
            y=[-41, -40.5, -40, -40, -40],
            fmt="0.2f",
        )
        print(points.render())

    """

    model_type: Literal["xy", "XY"] = Field(
        default="xy",
        description="Model type discriminator",
    )
    x: list[float] = Field(description="Problem x-coordinate values")
    y: list[float] = Field(description="Problem y-coordinate values")
    fmt: str = Field(
        default="0.8f",
        description="The format to render floats values",
    )

    @model_validator(mode="after")
    def validate_size(self) -> "XY":
        if len(self.x) != len(self.y):
            raise ValueError("x and y must be the same size")
        return self

    @property
    def size(self):
        return len(self.x)

    def cmd(self) -> str:
        repr = ""
        for x, y in zip(self.x, self.y):
            repr += f"\n{x:{self.fmt}} {y:{self.fmt}}"
        return repr + "\n"

Attributes

model_type class-attribute instance-attribute 

model_type: Literal['xy', 'XY'] = Field(default='xy', description='Model type discriminator')

x class-attribute instance-attribute 

x: list[float] = Field(description='Problem x-coordinate values')

y class-attribute instance-attribute 

y: list[float] = Field(description='Problem y-coordinate values')

fmt class-attribute instance-attribute 

fmt: str = Field(default='0.8f', description='The format to render floats values')

size property 

size

Functions

validate_size 

validate_size() -> XY
Source code in src/rompy_swan/subcomponents/base.py 
79
80
81
82
83
@model_validator(mode="after")
def validate_size(self) -> "XY":
    if len(self.x) != len(self.y):
        raise ValueError("x and y must be the same size")
    return self

cmd 

cmd() -> str
Source code in src/rompy_swan/subcomponents/base.py 
89
90
91
92
93
def cmd(self) -> str:
    repr = ""
    for x, y in zip(self.x, self.y):
        repr += f"\n{x:{self.fmt}} {y:{self.fmt}}"
    return repr + "\n"

IJ

Bases: BaseSubComponent

Points in grid indices coordinates.

.. code-block:: text

< [x] [y] >

Note

Coordinates should be given in m when Cartesian coordinates are used or degrees when Spherical coordinates are used (see command COORD).

Examples

.. ipython:: python :okwarning:

from rompy_swan.subcomponents.base import IJ
points = IJ(i=[0, 0, 5], j=[0, 19, 19])
print(points.render())
Source code in src/rompy_swan/subcomponents/base.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
class IJ(BaseSubComponent):
    """Points in grid indices coordinates.

    .. code-block:: text

        < [x] [y] >

    Note
    ----
    Coordinates should be given in m when Cartesian coordinates are used or degrees
    when Spherical coordinates are used (see command `COORD`).

    Examples
    --------

    .. ipython:: python
        :okwarning:

        from rompy_swan.subcomponents.base import IJ
        points = IJ(i=[0, 0, 5], j=[0, 19, 19])
        print(points.render())

    """

    model_type: Literal["ij", "IJ"] = Field(
        default="ij",
        description="Model type discriminator",
    )
    i: list[int] = Field(description="i-index values")
    j: list[int] = Field(description="j-index values")

    @model_validator(mode="after")
    def validate_size(self) -> "IJ":
        if len(self.i) != len(self.j):
            raise ValueError("i and j must be the same size")
        return self

    @property
    def size(self):
        return len(self.i)

    def cmd(self) -> str:
        repr = ""
        for i, j in zip(self.i, self.j):
            repr += f"\ni={i} j={j}"
        return repr + "\n"

Attributes

model_type class-attribute instance-attribute 

model_type: Literal['ij', 'IJ'] = Field(default='ij', description='Model type discriminator')

i class-attribute instance-attribute 

i: list[int] = Field(description='i-index values')

j class-attribute instance-attribute 

j: list[int] = Field(description='j-index values')

size property 

size

Functions

validate_size 

validate_size() -> IJ
Source code in src/rompy_swan/subcomponents/base.py 
127
128
129
130
131
@model_validator(mode="after")
def validate_size(self) -> "IJ":
    if len(self.i) != len(self.j):
        raise ValueError("i and j must be the same size")
    return self

cmd 

cmd() -> str
Source code in src/rompy_swan/subcomponents/base.py 
137
138
139
140
141
def cmd(self) -> str:
    repr = ""
    for i, j in zip(self.i, self.j):
        repr += f"\ni={i} j={j}"
    return repr + "\n"