timflow.steady.trace.timtraceline
=================================

.. py:function:: 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.

   :param ml: model to which the element is added
   :type ml: Model object
   :param xstart: x-coordinate of starting location
   :type xstart: scalar
   :param ystart: y-coordinate of starting location
   :type ystart: scalar
   :param zstart: z-coordinate of starting location
   :type zstart: scalar
   :param hstepmax: maximum horizontal step size [L]
   :type hstepmax: scalar
   :param vstepfrac: maximum vertical step as fraction of layer thickness
   :type vstepfrac: scalar
   :param tmax: maximum travel time
   :type tmax: scalar
   :param nstepmax: maximum number of steps
   :type nstepmax: int
   :param win: list with [xmin, xmax, ymin, ymax]
   :type win: list
   :param silent: if '.', prints dot upon completion of each traceline
   :type silent: string
   :param returnlayers: if True, return layers numbers
   :type returnlayers: boolean
   :param metadata: 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
   :type metadata: boolean















   ..
       !! processed by numpydoc !!