timflow.transient.trace.timtrace#
- 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.
- Parameters:
model (Model object) – model
xstart (float) – x-coordinate of starting location of pathline
ystart (float) – y-coordinate of starting location of pathline
zstart (float) – z-coordinate of starting location of pathline
tstartend (list) – list of starting times of pathline. last entry is the ending time.
tstartoffset (float or list) – 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
tstep (scalar or list) – maximum time step for each step along pathline. Either one value for all sections, or list with values for each section.
nstepmax (integer) – maximum number of steps per section
hstepmax (float or integer) – maximum length of horizontal step
silent (boolean) – parameter to indicate if message should be printed to the screen for each section of the pathline
correctionstep (boolean) – parameter to indicate if a correction step (Euler’s method) should be taken. Taking a correction step is more accurate, especially for curved pathlines.
- 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
- Return type:
dictionary with three items