MultipleFlowRouter

class fastscape.processes.MultipleFlowRouter(*, shape, elevation, fs_context, slope_exp=0.0)

Multiple direction (convergent/divergent) flow router with uniform slope exponent.

By default, the slope exponent equals zero, i.e., the amount of flow is distributed evenly among the flow receivers.

shape

Nb. of grid nodes in (y, x)

Variable properties:

type : foreign
reference variable : UniformRectilinearGrid2D.shape
intent : in
dimensions : (‘shape_yx’,)

Type:: attr.Attribute

elevation

Surface elevation before erosion

Variable properties:

type : foreign
reference variable : SurfaceToErode.elevation
intent : in
dimensions : (‘y’, ‘x’)

Type:: attr.Attribute

fs_context

Accessor to fastscapelib-fortran internal variables

Variable properties:

type : foreign
reference variable : FastscapelibContext.context
intent : in

Type:: attr.Attribute

stack

Dfs ordered grid node indices

Variable properties:

type : variable
intent : out
dimensions : (‘node’,)

Type:: attr.Attribute

nb_receivers

Number of flow receivers

Variable properties:

type : variable
intent : out
dimensions : (‘node’,)

Type:: attr.Attribute

receivers

Flow receiver node indices

Variable properties:

type : variable
intent : out
dimensions : (‘node’,) or (‘node’, ‘nb_rec_max’)

Type:: attr.Attribute

lengths

Out flow path length

Variable properties:

type : variable
intent : out
dimensions : (‘node’,) or (‘node’, ‘nb_rec_max’)

Type:: attr.Attribute

weights

Flow partition weights

Variable properties:

type : variable
intent : out
dimensions : (‘node’,) or (‘node’, ‘nb_rec_max’)

Type:: attr.Attribute

nb_donors

Number of flow donors

Variable properties:

type : variable
intent : out
dimensions : (‘node’,)

Type:: attr.Attribute

donors

Flow donors node indices

Variable properties:

type : variable
intent : out
dimensions : (‘node’, ‘nb_don_max’)

Type:: attr.Attribute

basin

River catchments

Variable properties:

type : on_demand
intent : out
dimensions : (‘y’, ‘x’)

Type:: attr.Attribute

lake_depth

Lake depth

Variable properties:

type : on_demand
intent : out
dimensions : (‘y’, ‘x’)

Type:: attr.Attribute

slope_exp

Mfd partioner slope exponent

Variable properties:

type : variable
intent : in
dimensions : () or (‘y’, ‘x’)
default value : 0.0
static : True

Type:: attr.Attribute

Methods

`__init__`(*, shape, elevation, fs_context[, ...])	Method generated by attrs for class MultipleFlowRouter.
`initialize`()
`route_flow`()
`run_step`()

Output of process info:

In [1]: import xsimlab as xs

In [2]: from fastscape.processes import MultipleFlowRouter

In [3]: xs.process_info(MultipleFlowRouter)
<MultipleFlowRouter  (xsimlab process)>
Variables:
    shape            [in] <--- UniformRectilinearGrid2D.shape
    elevation        [in] <--- SurfaceToErode.elevation
    fs_context       [in] <--- FastscapelibContext.context
    stack           [out] ('node',) DFS ordered grid node indices
    nb_receivers    [out] ('node',) number of flow receivers
    receivers       [out] ('node',) or ('node', 'nb_rec_max') flow ...
    lengths         [out] ('node',) or ('node', 'nb_rec_max') out f...
    weights         [out] ('node',) or ('node', 'nb_rec_max') flow ...
    nb_donors       [out] ('node',) number of flow donors
    donors          [out] ('node', 'nb_don_max') flow donors node i...
    basin           [out] ('y', 'x') river catchments
    lake_depth      [out] ('y', 'x') lake depth
    slope_exp        [in] () or ('y', 'x') MFD partioner slope expo...
Simulation stages:
    initialize
    run_step