timflow.steady.plots.PlotSteady.tracelines#

timflow.steady.plots.PlotSteady.tracelines(xstart, ystart, zstart, hstepmax, vstepfrac=0.2, tmax=1000000000000.0, nstepmax=100, silent='.', color=None, orientation: Literal['hor', 'ver', 'both'] = 'hor', win=None, ax=None, figsize=None, *, return_traces=False, metadata=False)#

Function to trace multiple pathlines.

Parameters:

  • ml (Model object) – model to which the element is added

  • xstart (array) – x-coordinates of starting locations

  • ystart (array) – y-coordinates of starting locations

  • zstart (array) – z-coordinates of starting locations

  • hstepmax (scalar) – maximum horizontal step size [L]

  • vstepfrac (scalar) – maximum vertical step as fraction of layer thickness

  • tmax (scalar) – maximum travel time

  • nstepmax (int) – maximum number of steps

  • silent (string) – if ‘.’, prints dot upon completion of each traceline

  • color (string) – matplotlib color of traceline

  • orientation (('hor', 'ver', 'both')) – ‘hor’ for horizontal, ‘ver’ for vertical ‘both’ for horizontal above vertical

  • win (list) – list with [xmin, xmax, ymin, ymax]

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

  • return_traces (boolean) – return traces if True

  • metadata (boolean) – if False, return list of xyzt arrays if True, return list of result dictionaries

Returns:

  • ax (matplotlib.Axes or list of Axes) – axes with plot

  • traces (result) – only if return_traces = True