rompy.schism.data.SCHISMDataTides#
- pydantic model rompy.schism.data.SCHISMDataTides[source]#
This class is used to define the tidal forcing for SCHISM.
- Fields:
- 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