timflow.transient.element.Element#

class timflow.transient.element.Element(model, nparam=1, nunknowns=0, layers=0, tsandbc=[(0, 0)], type='z', name='', label=None, inhomelement=False)#

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Methods#

initialize()

Initialize the element.

potinf(x, y[, aq])

Returns complex array of size (nparam, naq, npval).

potential(x, y[, aq])

Returns complex array of size (ngvbc, naq, npval).

unitpotential(x, y[, aq])

Returns complex array of size (naq, npval).

unitpotentialone(x, y, jtime[, aq])

Returns complex array of size (naq, npval).

disvecinf(x, y[, aq])

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

disvec(x, y[, aq])

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

unitdisvec(x, y[, aq])

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

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

Layers can be scalar, list, or array.

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

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

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

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

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

Layers can be scalar, list, or array.

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

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

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

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

discharge(t[, derivative])

The discharge in each layer.

dischargeold(t[, derivative])

The discharge in each layer.

run_after_solve()

Function to run after a solution is completed.

plot([ax])

Plot the element.