rompy.schism.boundary_conditions.create_nested_boundary_config#

rompy.schism.boundary_conditions.create_nested_boundary_config(with_tides: bool = True, inflow_relax: float = 0.8, outflow_relax: float = 0.2, elev_source: Any | None = None, vel_source: Any | None = None, temp_source: Any | None = None, salt_source: Any | None = None, 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 for nested model boundaries with external data.

Parameters:

  • with_tides (bool) – Include tidal components

  • inflow_relax (float) – Relaxation parameter for inflow (0-1)

  • outflow_relax (float) – Relaxation parameter for outflow (0-1)

  • elev_source (Union[DataBlob, SCHISMDataBoundary], optional) – Data source for elevation

  • vel_source (Union[DataBlob, SCHISMDataBoundary], optional) – Data source for velocity

  • temp_source (Union[DataBlob, SCHISMDataBoundary], optional) – Data source for temperature

  • salt_source (Union[DataBlob, SCHISMDataBoundary], optional) – Data source for salinity

  • 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