grids.mixins.core.GridPlotMixin.plot_chunk_lines#

GridPlotMixin.plot_chunk_lines(grid_axes: Sequence[str] | None = None, ax: Axes | None = None, include_ghosts: bool = False, **kwargs)[source]#

Plot chunk boundaries along the specified 2D projection of the domain.

Parameters:

  • grid_axes (list of str, optional) – The two coordinate axes to display in the plot. If not specified, the first two axes of the coordinate system are selected.

  • ax (Axes, optional) – Matplotlib axis object to draw into. If None, a new figure is created.

  • include_ghosts (bool, default False) – Whether to include ghost zones in the plotting extent and chunk structure.

  • **kwargs – Additional keyword arguments passed to matplotlib.pyplot.hlines() and matplotlib.pyplot.vlines() (e.g., linewidth, linestyle, etc).

Returns:

The matplotlib axis object used for plotting.

Return type:

matplotlib.axes.Axes

Raises:

  • ValueError – If the coordinate system is 1D or if an invalid number of axes is specified.

  • RuntimeError – If chunking is not supported by this grid.