roms_tools.Grid.plot_vertical_coordinate

roms_tools.Grid.plot_vertical_coordinate#

Grid.plot_vertical_coordinate(s: int | None = None, eta: int | None = None, xi: int | None = None, max_nr_layer_contours: int | None = None, ax: Axes | None = None) → None#

Plot the layer depth for a given eta-, xi-, or s-slice.

Parameters:

  • s (int, optional) – The s-index to plot. Default is None.

  • eta (int, optional) – The eta-index to plot. Default is None.

  • xi (int, optional) – The xi-index to plot. Default is None.

  • max_nr_layer_contours (int, optional) – Number of layer contours displayed. Only relevant when plotting a vertical section. Default is all.

  • ax (matplotlib.axes.Axes, optional) – The axes to plot on. If None, a new figure is created. Note that this argument is ignored for 2D horizontal plots.

Returns:

None – This method does not return any value. It generates and displays a plot.

Raises:

ValueError – If not exactly one of s, eta, xi is specified.