timflow.steady.linesink.River#

class timflow.steady.linesink.River(model, x1=-1, y1=0, x2=1, y2=0, hls=1.0, res=0, wh=1, order=0, layers=0, dely=0, label=None, name='River', addtomodel=True)#

Bases: LineSinkHoBase, timflow.steady.equation.HeadEquation

Head-specified line-sink which may optionally have a width and resistance.

Parameters:

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

  • x1 (scalar) – x-coordinate of fist point of line-sink

  • y1 (scalar) – y-coordinate of fist point of line-sink

  • x2 (scalar) – x-coordinate of second point of line-sink

  • y2 (scalar) – y-coordinate of second point of line-sink

  • hls (scalar, array or list) – head along line-sink if scalar: head is the same everywhere along line-sink if list or array of length 2: head at beginning and end of line-sink if list or array with length order + 1: heads at control points

  • res (scalar (default is 0)) – resistance of line-sink

  • wh (scalar or str) –

    distance over which water enters line-sink * if ‘H’: (default) distance is equal to the thickness of the aquifer layer

    (when flow comes mainly from one side)

    • if ‘2H’: distance is twice the thickness of the aquifer layer (when flow comes from both sides)

    • if scalar: the width of the stream that partially penetrates the aquifer layer

  • order (int (default is 0)) – polynomial order or inflow along line-sink

  • layers (scalar, list or array) – layer(s) in which element is placed if scalar: element is placed in this layer if list or array: element is placed in all these layers

  • dely (float (default is 0)) – distance between control points and line

  • label (str or None) – label of element

See also

RiverString

Methods#

potinf(x, y[, aq])

Can be called with only one x,y value.

disvecinf(x, y[, aq])

Can be called with only one x,y value.

potinflayers(x, y, layers[, aq])

Returns array of size (len(layers),nparam).

potentiallayers(x, y, layers[, aq])

Returns array of size len(layers) only used in building equations.

disvec(x, y[, aq])

Returns array of size (2, nparam, naq).

disvecinflayers(x, y, layers[, aq])

Returns two arrays of size (len(layers),nparam).

disveclayers(x, y, layers[, aq])

Returns two arrays of size len(layers) only used in building equations.

equation()

Mix-in class that returns matrix rows for head-specified conditions.