timflow.steady.well.HeadWell.plotcapzone#

timflow.steady.well.HeadWell.plotcapzone(nt=10, zstart=None, hstepmax=20, vstepfrac=0.2, tmax=365, nstepmax=100, silent='.', color=None, orientation='hor', win=None, ax=None, figsize=None, *, return_traces=False, metadata=False)#

Plot a capture zone.

Parameters:

  • nt (int) – number of path lines

  • zstart (scalar) – starting elevation of the path lines

  • hstepmax (scalar) – maximum step in horizontal space

  • vstepfrac (float) – maximum fraction of aquifer layer thickness during one step

  • tmax (scalar) – maximum time

  • nstepmax (scalar(int)) – maximum number of steps

  • silent (boolean or string) – True (no messages), False (all messages), or ‘.’ (print dot for each path line)

  • color (color)

  • orientation (string) – ‘hor’ for horizontal, ‘ver’ for vertical, or ‘both’ for both

  • win (array_like (length 4)) – [xmin, xmax, ymin, ymax]

  • axes (matplotlib.Axes, tuple of 2 matplotlib.Axes, or None) – axes to plot on, default is None which creates a new figure

  • figsize (tuple of integers, optional, default: None) – width, height in inches.

  • return_traces (boolean (default False)) – return the traces instead of plotting

  • metadata (boolean (default False)) – return metadata along with traces

Returns:

  • ax (matplotlib.Axes) – axes with plot

  • traces (list of arrays of x, y, z, and t values) – only if return_traces is True