DrainageArea

class fastscape.processes.DrainageArea(*, shape, cell_area, stack, nb_receivers, receivers, weights)

Upstream contributing area.

shape

Nb. of grid nodes in (y, x)

Variable properties:

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

Type:: attr.Attribute

cell_area

Fixed grid cell area

Variable properties:

type : foreign
reference variable : UniformRectilinearGrid2D.cell_area
intent : in
dimensions : ()

Type:: attr.Attribute

stack

Dfs ordered grid node indices

Variable properties:

type : foreign
reference variable : FlowRouter.stack
intent : in
dimensions : (‘node’,)

Type:: attr.Attribute

nb_receivers

Number of flow receivers

Variable properties:

type : foreign
reference variable : FlowRouter.nb_receivers
intent : in
dimensions : (‘node’,)

Type:: attr.Attribute

receivers

Flow receiver node indices

Variable properties:

type : foreign
reference variable : FlowRouter.receivers
intent : in
dimensions : (‘node’,) or (‘node’, ‘nb_rec_max’)

Type:: attr.Attribute

weights

Flow partition weights

Variable properties:

type : foreign
reference variable : FlowRouter.weights
intent : in
dimensions : (‘node’,) or (‘node’, ‘nb_rec_max’)

Type:: attr.Attribute

flowacc

Flow accumulation from up to downstream

Variable properties:

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

Type:: attr.Attribute

runoff

No description given

Variable properties:

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

Type:: attr.Attribute

area

Drainage area

Variable properties:

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

Type:: attr.Attribute

Methods

`__init__`(*, shape, cell_area, stack, ...)	Method generated by attrs for class DrainageArea.
`initialize`()
`run_step`()

Output of process info:

In [1]: import xsimlab as xs

In [2]: from fastscape.processes import DrainageArea

In [3]: xs.process_info(DrainageArea)
<DrainageArea  (xsimlab process)>
Variables:
    shape            [in] <--- UniformRectilinearGrid2D.shape
    cell_area        [in] <--- UniformRectilinearGrid2D.cell_area
    stack            [in] <--- FlowRouter.stack
    nb_receivers     [in] <--- FlowRouter.nb_receivers
    receivers        [in] <--- FlowRouter.receivers
    weights          [in] <--- FlowRouter.weights
    flowacc         [out] ('y', 'x') flow accumulation from up to d...
    runoff          [out] () or ('y', 'x') 
    area            [out] ('y', 'x') drainage area
Simulation stages:
    initialize
    run_step