timflow.steady.trace.timtraceline#

timflow.steady.trace.timtraceline(ml, xstart, ystart, zstart, hstepmax, vstepfrac=0.2, tmax=1000000000000.0, nstepmax=100, win=None, silent=False, returnlayers=False, *, metadata=False)#

Function to trace one pathline.

Parameters:

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

  • xstart (scalar) – x-coordinate of starting location

  • ystart (scalar) – y-coordinate of starting location

  • zstart (scalar) – z-coordinate of starting location

  • 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

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

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

  • returnlayers (boolean) – if True, return layers numbers

  • metadata (boolean) – if False, return xyzt array or xyzt array plus layer array if True, return list of result dictionaries with three entries: - “trace”: np.array(xyzt) - “message”: termination message - “complete”: True if terminated correctly