bluemath_tk.topo_bathy package

Submodules

bluemath_tk.topo_bathy.profiles module

bluemath_tk.topo_bathy.profiles.biparabolic(h0, hsig, omega_surf_list, TR)[source]

Biparabolic profile (Bernabeu et al. 2013)

h0: offshore water level (m) hsig: significant wave height (m) omega_surf: intertidal dimensionless fall velocity (1 <= omega_surf <= 5) TR: tidal range (m)

bluemath_tk.topo_bathy.profiles.custom_profile(dx, emsl, xs, ys)[source]

custom N points profile

dx: bathymetry mesh resolution at x axes (m) xs: x values array ys: y values array emsl: mean sea level (m)

bluemath_tk.topo_bathy.profiles.linear(dx, h0, bCrest, m, Wfore)[source]

simple linear profile (y = m * x + n)

dx: bathymetry mesh resolution at x axes (m) h0: offshore depth (m) bCrest: beach heigh (m) m: profile slope Wfore: flume length before slope toe (m)

return depth data values

bluemath_tk.topo_bathy.profiles.parabolic(dx, h0, A, xBeach, bCrest)[source]

Parabolic profile (y = A * x^(2/3))

dx: bathymetry mesh resolution at x axes (m) h0: offshore depth (m) A: parabola coefficient xBeach: beach length(m) bCrest: beach heigh (m)

bluemath_tk.topo_bathy.profiles.reef(dx, h0, Slope1, Slope2, Wreef, Wfore, bCrest, emsl)[source]

Reef morphologic profile (Pearson et al. 2017)

dx: bathymetry mesh resolution at x axes (m) h0: offshore depth (m) Slope1: fore shore slope Slope2: inner shore slope Wreef: reef bed width (m) Wfore: flume length before fore toe (m) bCrest: beach heigh (m) emsl: mean sea level (m)

return depth data values

bluemath_tk.topo_bathy.swan_grid module

bluemath_tk.topo_bathy.swan_grid.generate_grid_parameters(bathy_data: DataArray) → dict[source]

Generate the grid parameters for the SWAN model.

Parameters:

bathy_data (xr.DataArray) – Bathymetry data. Must have the following dimensions: - lon: longitude - lat: latitude

Returns:

dict – Grid parameters for the SWAN model.
Contact @bellidog on GitHub for more information.

Module contents

Project: BlueMath_tk Sub-Module: topo_bathy Author: GeoOcean Research Group, Universidad de Cantabria Creation Date: 19 April 2025 Repository: https://github.com/GeoOcean/BlueMath_tk.git Status: Under development (Working)