dcmri.flux_chain#

dcmri.flux_chain(J, T, D, t=None, dt=1.0, solver='step')[source]#

Indicator flux out of a chain system.

See section Chain for more detail.

Parameters:

  • J (array_like) – the indicator flux entering the system.

  • T (float) – mean transit time of the system. Any non-negative value is allowed, including \(T=0\) and \(T=\infty\), in which case the compartment is a trap.

  • D (float) – dispersion of the system. Values must be between 0 (no dispersion) and 1 (maximal dispersion).

  • t (array_like, optional) – the time points of the indicator flux J, in the same units as T. If t=None, the time points are assumed to be uniformly spaced with spacing dt. Defaults to None.

  • dt (float, optional) – spacing between time points for uniformly spaced time points, in the same units as T. This parameter is ignored if t is explicity provided. Defaults to 1.0.

Returns:

Outflux as a 1D array.

Return type:

numpy.ndarray

See also

res_chain, prop_chain, conc_chain

Example

>>> import dcmri as dc
>>> t = [0,5,15,30,60]
>>> J = [1,2,3,3,2]
>>> dc.flux_chain(J, 5, 0.5, t)
array([0.        , 0.36089409, 1.92047375, 2.63639739, 1.99640464])