LineSink1D#

class timflow.transient.linesink1d.LineSink1D(model, xls=0, tsandq=[(0, 1)], res=0, wh='H', vres=0.0, wv=1.0, layers=0, label=None)#

Bases: LineSink1DBase, timflow.transient.equation.MscreenEquation

Linesink1D with a specified discharge.

Parameters:

model (Model object) – model to which the element is added
x (float) – x-coordinate of the linesink
tsandq (list of tuples) – tuples of starting time and specific discharge after starting time
res (float) – resistance of the linesink
layers (int, array or list) – layer (int) or layers (list or array) in which linesink is located
label (string or None (default: None)) – label of the linesink

Examples

Example of an infinitely long linesink that pumps with a specific discharge of 100 between times 10 and 50, with a specific discharge of 20 between times 50 and 200, and zero specific discharge after time 200.

>>> LineSink1D(ml, tsandq=[(10, 100), (50, 20), (200, 0)])

initialize()#

Initialize the element.

Initialization of terms that cannot be initialized before other elements or the aquifer is defined.

As we don’t want to require a certain order of entering elements, these terms are initialized when Model.solve is called The initialization class needs to be overloaded by all derived classes

setflowcoef()#: Separate function so that this can be overloaded for other types.

potinf(x, y=0, aq=None)#: Can be called with only one x value.

disvecinf(x, y=0, aq=None)#: Can be called with only one x,y value.

plot(ax=None)#: Plot the element.

potential(x, y, aq=None)#: Returns complex array of size (ngvbc, naq, npval).

unitpotential(x, y, aq=None)#

Returns complex array of size (naq, npval).

Can be more efficient for given elements.

unitpotentialone(x, y, jtime, aq=None)#

Returns complex array of size (naq, npval).

Can be more efficient for given elements.

disvec(x, y, aq=None)#: Returns 2 complex arrays of size (ngvbc, naq, npval).

unitdisvec(x, y, aq=None)#

Returns 2 complex arrays of size (naq, npval).

Can be more efficient for given elements.

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

Layers can be scalar, list, or array.

returns array of size (len(layers),nparam,npval) only used in building equations

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

Returns complex array of size (ngvbc, len(layers),npval).

Only used in building equations.

unitpotentiallayers(x, y, layers=0, aq=None)#

Returns complex array of size (len(layers), npval).

Only used in building equations.

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

Layers can be scalar, list, or array.

returns 2 arrays of size (len(layers),nparam,npval) only used in building equations

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

Returns 2 complex array of size (ngvbc, len(layers), npval).

Only used in building equations.

unitdisveclayers(x, y, layers=0, aq=None)#

Returns complex array of size (len(layers), npval).

Only used in building equations.

discharge(t, derivative=0)#

The discharge in each layer.

Parameters:

t (scalar, list or array) – times at which discharge is computed. t must be ordered and tmin <= t <= tmax
derivative (when derivative=0, returns discharge (default)) – when derivative=1, returns derivative of the discharge when derivative=-1, returns integrated discharge

Returns:

Discharge in each screen with zeros for layers that are not screened

Return type:

array of discharges (nlayers,len(t))

dischargeold(t, derivative=0)#

The discharge in each layer.

Parameters:: t (scalar, list or array) – times at which discharge is computed. t must be ordered and tmin <= t <= tmax
Returns:: Discharge in each screen with zeros for layers that are not screened
Return type:: array of discharges (nlayers,len(t))

run_after_solve()#

Function to run after a solution is completed.

For most elements nothing needs to be done, but for strings of elements some arrays may need to be filled.

equation()#

Matrix rows for multi-screen conditions where total discharge is specified.

Mix-in class that returns matrix rows for multi-screen conditions where total discharge is specified. Works for nunknowns = 1 Returns matrix part nunknowns, neq, npval, complex.

Returns rhs part nunknowns, nvbc, npval, complex head_out - c * q_s = h_in Set h_i - h_(i + 1) = 0 and Sum Q_i = Q