RiverString#

class timflow.steady.linesink.RiverString(model, xy=None, hls=0, res=0, wh=1, order=0, layers=0, dely=0, label=None, name='RiverString')#

Bases: LineSinkStringBase2

String of head-specified line-sinks with optional width and resistance.

Parameters:

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

  • xy (array or list) – list or array of (x,y) pairs of coordinates of end-points of line-sinks in string

  • hls (scalar, array or list) – head along string if scalar: head is the same everywhere along the string if list or array of length 2: head at beginning and end of string if list or array with same length as xy: heads at nodes, which may contain nans, except for first and last point

  • 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)) – order of all line-sinks in string

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

  • 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

  • label (str or None)

See also

River

potinf(x, y, aq=None)#

Compute unit potential influence of element.

Returns:

linesink 0, order 0, layer[0]

order 0, layer[1] … order 1, layer[0] order 1, layer[1] …

linesink 1, order 0, layer[0]

order 0, layer[1] … order 1, layer[0] order 1, layer[1] …

Return type:

array

disvecinf(x, y, aq=None)#

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

discharge_per_linesink()#

Discharge of the linesinks in each layer.

Returns:

rv – array of shape (nlay, nlinesinks)

Return type:

np.array

discharge()#

Discharge of the element in each layer.

potinflayers(x, y, layers, aq=None)#

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

Only used in building equations.

potentiallayers(x, y, layers, aq=None)#

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

disvec(x, y, aq=None)#

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

disvecinflayers(x, y, layers, aq=None)#

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

Only used in building equations.

disveclayers(x, y, layers, aq=None)#

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