Skip to content

Commit

Permalink
Remove vertical coordinate notebook from index
Browse files Browse the repository at this point in the history
  • Loading branch information
NoraLoose committed Aug 21, 2024
1 parent 030b084 commit b1d6e82
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 2 deletions.
1 change: 0 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ This python package is strongly inspired by the `UCLA MATLAB tools <https://gith
Creating a grid <grid>
Creating tidal forcing <tides>
Creating surface forcing <surface_forcing>
Creating a vertical coordinate <vertical_coordinate>
Creating initial conditions <initial_conditions>
Creating boundary forcing <boundary_forcing>

Expand Down
2 changes: 1 addition & 1 deletion docs/methods.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The :meth:`roms_tools.Grid.add_topography_and_mask` method completes five steps:
1. The mask is defined using a dealiased version of the interpolated topography from step 0. In this step, the topography is evaluated at each grid point: values smaller than 0.11 meters are classified as land, and values larger than 0.11 meters are classified as ocean.
2. The interpolated topography from step 0 is smoothed over the entire domain with a smoothing factor of 8. This step ensures that the topography is smooth at the grid scale, a prerequisite for avoiding grid-scale instabilities at runtime.
3. The mask is modified by filling enclosed basins with land.
4. Regions where the ocean depth is shallower than ``hmin`` are set to ``hmin``. The topography is then smoothed locally in such a way that the maximum slope parameter ``r_max`` is smaller than 0.2. The maximum slope parameter is given by
4. Regions where the ocean depth is shallower than ``hmin`` are set to ``hmin``. The topography is then smoothed locally in such a way that the maximum slope parameter ``r`` is smaller than 0.2. The maximum slope parameter is given by

.. math::
r = \max \left( \frac{|\Delta_x h|}{2h}, \frac{|\Delta_y h|}{2h} \right).
Expand Down

0 comments on commit b1d6e82

Please sign in to comment.