rompy.schism.data.SCHISMDataTides#

pydantic model rompy.schism.data.SCHISMDataTides[source]#

This class is used to define the tidal forcing for SCHISM.

Show JSON schema

{
   "title": "SCHISMDataTides",
   "description": "This class is used to define the tidal forcing for SCHISM.",
   "type": "object",
   "properties": {
      "data_type": {
         "const": "tides",
         "default": "tide",
         "description": "Model type discriminator",
         "title": "Data Type",
         "type": "string"
      },
      "tidal_data": {
         "$ref": "#/$defs/TidalDataset",
         "description": "tidal dataset"
      },
      "cutoff_depth": {
         "default": 50.0,
         "description": "cutoff depth for tides",
         "title": "Cutoff Depth",
         "type": "number"
      },
      "flags": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            [
               5,
               3,
               0,
               0
            ]
         ],
         "description": "nested list of bctypes",
         "title": "Flags"
      },
      "constituents": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "items": {},
               "type": "array"
            }
         ],
         "default": "major",
         "description": "constituents",
         "title": "Constituents"
      },
      "database": {
         "choices": [
            "tpxo",
            "fes2014"
         ],
         "default": "tpxo",
         "description": "database",
         "title": "Database",
         "type": "string"
      },
      "add_earth_tidal": {
         "default": true,
         "description": "add_earth_tidal",
         "title": "Add Earth Tidal",
         "type": "boolean"
      },
      "ethconst": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [],
         "description": "constant elevation value for each open boundary",
         "title": "Ethconst"
      },
      "vthconst": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [],
         "description": "constant discharge value for each open boundary",
         "title": "Vthconst"
      },
      "tthconst": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [],
         "description": "constant temperature value for each open boundary",
         "title": "Tthconst"
      },
      "sthconst": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [],
         "description": "constant salinity value for each open boundary",
         "title": "Sthconst"
      },
      "tobc": {
         "anyOf": [
            {
               "items": {
                  "type": "number"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            1
         ],
         "description": "nuding factor of temperature for each open boundary",
         "title": "Tobc"
      },
      "sobc": {
         "anyOf": [
            {
               "items": {
                  "type": "number"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            1
         ],
         "description": "nuding factor of salinity for each open boundary",
         "title": "Sobc"
      },
      "relax": {
         "anyOf": [
            {
               "items": {
                  "type": "number"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [],
         "description": "relaxation constants for inflow and outflow",
         "title": "Relax"
      }
   },
   "$defs": {
      "TidalDataset": {
         "additionalProperties": false,
         "description": "This class is used to define the tidal dataset",
         "properties": {
            "data_type": {
               "const": "tidal_dataset",
               "default": "tidal_dataset",
               "description": "Model type discriminator",
               "title": "Data Type",
               "type": "string"
            },
            "elevations": {
               "description": "Path to elevations file",
               "title": "Elevations"
            },
            "velocities": {
               "description": "Path to currents file",
               "title": "Velocities"
            }
         },
         "required": [
            "elevations",
            "velocities"
         ],
         "title": "TidalDataset",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "tidal_data"
   ]
}

Fields:

add_earth_tidal (bool)
constituents (str | list)
cutoff_depth (float)
data_type (Literal['tides'])
database (str)
ethconst (list | None)
flags (list | None)
relax (list[float] | None)
sobc (list[float] | None)
sthconst (list | None)
tidal_data (rompy.schism.data.TidalDataset)
tobc (list[float] | None)
tthconst (list | None)
vthconst (list | None)

field add_earth_tidal: bool = True#: add_earth_tidal

field constituents: str | list = 'major'#: constituents

field cutoff_depth: float = 50.0#: cutoff depth for tides

field data_type: Literal['tides'] = 'tide'#: Model type discriminator

field database: str = 'tpxo'#: database

field ethconst: list | None = []#: constant elevation value for each open boundary

field flags: list | None = [[5, 3, 0, 0]]#: nested list of bctypes

field relax: list[float] | None = []#: relaxation constants for inflow and outflow

field sobc: list[float] | None = [1]#: nuding factor of salinity for each open boundary

field sthconst: list | None = []#: constant salinity value for each open boundary

field tidal_data: TidalDataset [Required]#: tidal dataset

field tobc: list[float] | None = [1]#: nuding factor of temperature for each open boundary

field tthconst: list | None = []#: constant temperature value for each open boundary

field vthconst: list | None = []#: constant discharge value for each open boundary

get(destdir: str | Path, grid: SCHISMGrid, time: TimeRange) → str[source]#

Write all inputs to netcdf files. :param destdir: Destination directory for the netcdf file. :type destdir: str | Path :param grid: Grid instance to use for selecting the boundary points. :type grid: SCHISMGrid :param time: The times to filter the data to, only used if self.crop_data is True. :type time: TimeRange, optional

Returns:: outfile – Path to the netcdf file.
Return type:: Path

Table of Contents

rompy.schism.data.SCHISMDataTides#

This Page