HeadLineSinkString#

class timflow.transient.linesink.HeadLineSinkString(*args, **kwargs)#

Bases: RiverString

Deprecated alias for RiverString.

Deprecated since version Use: RiverString instead. This alias will be removed in a future version.

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

potinf(x, y, aq=None)#: Returns array (nunknowns, Nperiods).

disvecinf(x, y, aq=None)#: Returns array (nunknowns,Nperiods).

headinside(t, derivative=0)#

The head inside the line-sink string.

Parameters:: t (array or float) – time(s) for whih head is computed
Returns:: Head inside the line-sink for each line-sink, each layer that the line-sink is screened in, and each time
Return type:: array size nline-sinks, nlayers, ntimes

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

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.

discharge_list(t, derivative=0)#

The discharge of each line-sink in the string.

Parameters:: t (array or float) – time(s) for whih discharge is computed
Returns:: Discharge for each line-sink, each layer that the line-sink is screened in, and each time
Return type:: array size nline-sinks, nlayers, ntimes

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))

equation()#

Matrix rows for head-specified conditions.

Really written as constant potential element. Works for nunknowns = 1 Returns matrix part nunknowns,neq,npval, complex.

Returns rhs part nunknowns,nvbc,npval, complex Phi_out - c*T*q_s = Phi_in Well: q_s = Q / (2*pi*r_w*H) LineSink: q_s = sigma / H = Q / (L*H)