rompy.schism.boundary_conditions.create_river_boundary_config#

rompy.schism.boundary_conditions.create_river_boundary_config(river_boundary_index: int = 0, river_flow: float = -100.0, other_boundaries: Literal['tidal', 'hybrid', 'none'] = 'tidal', constituents: str | List[str] = 'major', tidal_database: str | Path | None = None, tidal_model: str | None = 'FES2014', nodal_corrections: bool = True, tidal_potential: bool = True, cutoff_depth: float = 50.0, tide_interpolation_method: str = 'bilinear')[source]#

Create a configuration with a designated river boundary and optional tidal boundaries.

Parameters:

  • river_boundary_index (int) – Index of the river boundary

  • river_flow (float) – Flow rate (negative for inflow)

  • other_boundaries (str) – How to treat other boundaries (“tidal”, “hybrid”, or “none”)

  • constituents (str or list, optional) – Tidal constituents to include, by default “major”

  • tidal_database (str or Path, optional) – Path to tidal database for pyTMD, by default None

  • tidal_model (str, optional) – Tidal model to use, by default ‘FES2014’

  • nodal_corrections (bool, optional) – Whether to apply nodal corrections, by default True

  • tidal_potential (bool, optional) – Whether to include tidal potential, by default True

  • cutoff_depth (float, optional) – Depth threshold for tidal potential, by default 50.0

  • tide_interpolation_method (str, optional) – Method for tide interpolation, by default “bilinear”

Returns:

Configured boundary conditions

Return type:

SCHISMDataBoundaryConditions