imod.visualize.streamfunction#

imod.visualize.streamfunction(da, ax, n_streamlines=10, kwargs_contour={})[source]#

Wraps matplotlib.contour to draw stream lines. Function can be used to draw stream lines on top of a cross-section.

Parameters:

  • da (xr.DataArray) –

    Two dimensional DataArray containing data of the cross section. One dimension must be “layer”, and the second dimension will be used as the x-axis for the cross-section.

    Coordinates “top” and “bottom” must be present, and must have at least the “layer” dimension (voxels) or both the “layer” and x-coordinate dimension.

    Use imod.evaluate.streamfunction_line() or streamfunction_linestring() to obtain the required DataArray.

  • ax (matplotlib Axes instance) – Axes to write plot to.

  • n_streamlines (int or array_like) –

    Determines the number and positions of the contour lines / regions.

    If an int n, use n data intervals; i.e. draw n+1 contour lines. The level heights are automatically chosen.

    If array-like, draw contour lines at the specified levels. The values must be in increasing order.

  • kwargs_contour (dict) – Other optional keyword arguments for matplotlib.contour.

Returns:

The drawn contour lines.

Return type:

matplotlib.contour.QuadContourSet