fastscapelib.MultiFlowRouter

class fastscapelib.MultiFlowRouter

Multiple direction flow router operator.

This flow operator partitions the flow passing through a grid node among its downslope neighbor nodes. Flow partitioning is proportional to the local slope between a node and its neighbors (power relationship with a fixed exponent parameter).

The fraction \(f_{i,j}\) of flow routed from node \(i\) to its neighbor \(j\) is given by

\[f_{i,j} = \frac{\max (0, S_{i, j}^p)}{\sum_{k \in N} \max (0, S_{i, k}^p)}\]

where \(p\) is the slope exponent parameter, \(S_{i, j}\) is the slope between \(i\), \(j\) and \(N\) is the set of all neighbors of \(i\).

Depending on the value of the slope exponent parameter, this is equivalent to the methods described in Quinn et al. [QBCP91] or Holmgren [Hol94].

__init__(self, slope_exp: float = 1.0) → None

MultiFlowRouter initializer.

Parameters:

slope_exp (float) – Flow partition slope exponent.

Methods

__init__(self[, slope_exp])

MultiFlowRouter initializer.

Attributes

elevation_updated
graph_updated
in_flowdir
name	Flow operator's name.
out_flowdir
slope_exp	Flow partition slope exponent.

property slope_exp

Flow partition slope exponent.