roms_tools.BoundaryForcingSource.plot

roms_tools.BoundaryForcingSource.plot#

BoundaryForcingSource.plot(var_name, time=0, layer_contours=False, ax=None) → None#

Plot the boundary forcing field for a given time-slice.

Parameters:

  • var_name (str) –

    The name of the boundary forcing field to plot. Format:

    ”{base_var_name}_{direction}” ,

    where {base_var_name} is a physical, BGC, or other boundary tracer name, and {direction} is one of [“south”, “east”, “north”, “west”].

  • time (int, optional) – The time index to plot. Default is 0.

  • layer_contours (bool, optional) – If True, contour lines representing the boundaries between vertical layers will be added to the plot. For clarity, the number of layer contours displayed is limited to a maximum of 10. Default is False.

  • ax (matplotlib.axes.Axes, optional) – The axes to plot on. If None, a new figure is created.

Returns:

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

Raises:

ValueError – If the specified var_name is not one of the valid options.