rompy.swan.grid.SwanGrid

pydantic model rompy.swan.grid.SwanGrid

Regular SWAN grid in geographic space.

Show JSON schema

{
   "title": "SwanGrid",
   "description": "Regular SWAN grid in geographic space.",
   "type": "object",
   "properties": {
      "grid_type": {
         "default": "REG",
         "description": "Type of grid (REG=regular, CURV=curvilinear)",
         "enum": [
            "REG",
            "CURV"
         ],
         "title": "Grid Type",
         "type": "string"
      },
      "x0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "X coordinate of the grid origin",
         "title": "X0"
      },
      "y0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Y coordinate of the grid origin",
         "title": "Y0"
      },
      "rot": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Rotation angle of the grid in degrees",
         "title": "Rot"
      },
      "dx": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Spacing between grid points in the x direction",
         "title": "Dx"
      },
      "dy": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Spacing between grid points in the y direction",
         "title": "Dy"
      },
      "nx": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Number of grid points in the x direction",
         "title": "Nx"
      },
      "ny": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Number of grid points in the y direction",
         "title": "Ny"
      },
      "exc": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Missing value",
         "title": "Exc"
      },
      "gridfile": {
         "anyOf": [
            {
               "maxLength": 36,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of grid file to load",
         "title": "Gridfile"
      }
   },
   "additionalProperties": false
}

Fields:

• dx (Optional[float])

• dy (Optional[float])

• exc (float | None)

• grid_type (Literal['REG', 'CURV'])

• gridfile (str | None)

• nx (Optional[int])

• ny (Optional[int])

• rot (Optional[float])

• x0 (Optional[float])

• y0 (Optional[float])

Validators:

• validate_curvilinear_grid » all fields

• validate_grid_type » grid_type

field dx: float | None = None

Spacing between grid points in the x direction

Validated by:

• generate

• validate_curvilinear_grid

field dy: float | None = None

Spacing between grid points in the y direction

Validated by:

• generate

• validate_curvilinear_grid

field exc: float | None = None

Missing value

Validated by:

• generate

• validate_curvilinear_grid

field grid_type: Literal['REG', 'CURV'] = 'REG'

Type of grid (REG=regular, CURV=curvilinear)

Validated by:

• generate

• validate_curvilinear_grid

• validate_grid_type

field gridfile: str | None = None

Name of grid file to load

Constraints:

• max_length = 36

Validated by:

• generate

• validate_curvilinear_grid

field nx: int | None = None

Number of grid points in the x direction

Validated by:

• generate

• validate_curvilinear_grid

field ny: int | None = None

Number of grid points in the y direction

Validated by:

• generate

• validate_curvilinear_grid

field rot: float | None = 0.0

Rotation angle of the grid in degrees

Validated by:

• generate

• validate_curvilinear_grid

field x0: float | None = None

X coordinate of the grid origin

Validated by:

• generate

• validate_curvilinear_grid

field y0: float | None = None

Y coordinate of the grid origin

Validated by:

• generate

• validate_curvilinear_grid

boundary(*args, **kwargs) → tuple

Returns the grid boundary polygon.

Override the parent method to use the actual points from the regular grid boundary instead of the convex hull which is not always the boundary.

classmethod from_component(component: GRIDREGULAR) → SwanGrid

Swan grid from an existing component.

Parameters:

component (GRIDREGULAR) – A GRIDREGULAR SWAN component.

Returns:

A SwanGrid object.

Return type:

SwanGrid

nearby_spectra(ds_spec, dist_thres=0.05, plot=True)

Find points nearby and project to the boundary

Parameters:

• ds_spec (xarray.Dataset) –

  an XArray dataset of wave spectra at a number of points. Dataset variable names standardised using wavespectra.read_* functions.

  See https://wavespectra.readthedocs.io/en/latest/api.html#input-functions

• dist_thres (float, optional [Default: 0.05]) – Maximum distance to translate the input spectra to the grid boundary

• plot (boolean, optional [Default: True]) – Generate a plot that shows the applied projections

Returns:

A subset of ds_spec with lat and lon coordinates projected to the boundary

Return type:

xarray.Dataset

validator validate_curvilinear_grid  »  all fields

validator validate_grid_type  »  grid_type

property cgrid

property cgrid_read

property component

Return the respective SWAN component for this grid.

property inpgrid