timflow.transient.trace.timtrace
================================

.. py:function:: timflow.transient.trace.timtrace(ml, xstart, ystart, zstart, tstartend, tstartoffset, tstep, nstepmax=100, hstepmax=10, silent=False, correctionstep=True)

   
   Compute a pathline by numerical integration of the velocity vector.

   Pathline is broken up in sections for which starting times are provided.
   Pathline is computed from first starting time + offset until second
   starting time, then continued from second starting time + offset until
   third starting time, etc.

   :param model: model
   :type model: Model object
   :param xstart: x-coordinate of starting location of pathline
   :type xstart: float
   :param ystart: y-coordinate of starting location of pathline
   :type ystart: float
   :param zstart: z-coordinate of starting location of pathline
   :type zstart: float
   :param tstartend: list of starting times of pathline. last entry is the ending time.
   :type tstartend: list
   :param tstartoffset: time after starting time when pathline is started. value or list. if
                        this value is smaller than tmin it may cause problems after change in
                        boundary conditions
   :type tstartoffset: float or list
   :param tstep: maximum time step for each step along pathline. Either one value for
                 all sections, or list with values for each section.
   :type tstep: scalar or list
   :param nstepmax: maximum number of steps per section
   :type nstepmax: integer
   :param hstepmax: maximum length of horizontal step
   :type hstepmax: float or integer
   :param silent: parameter to indicate if message should be printed to the screen for
                  each section of the pathline
   :type silent: boolean
   :param correctionstep: parameter to indicate if a correction step (Euler's method) should
                          be taken. Taking a correction step is more accurate, especially for
                          curved pathlines.
   :type correctionstep: boolean

   :returns: **result** --

             * xyzt : 2D array with four columns: x, y, z, t along pathline
             * message : list with text messages of each section of the pathline
             * status : numerical indication of the result. Negative is likely
               undesirable.
                 * -2 : reached maximum number of steps before reaching maximum time
                 * -1 : starting z value not inside aquifer
                 * +1 : reached maximum time
                 * +2 : reached element
                 * +3 : flows out of top of aquifer
   :rtype: dictionary with three items















   ..
       !! processed by numpydoc !!