StreamPowerChannel

class fastscape.processes.StreamPowerChannel(*, k_coef, area_exp=0.4, slope_exp=1, tol_rel=0.0001, tol_abs=0.0001, max_iter=100, shape, elevation, receivers, flowacc, fs_context)

Stream-Power channel erosion.

erosion

Channel erosion and/or deposition

Variable properties:

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

Type:: attr.Attribute

k_coef

Bedrock channel incision coefficient

Variable properties:

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

Type:: attr.Attribute

area_exp

Drainage area exponent

Variable properties:

type : variable
intent : in
dimensions : ()
default value : 0.4

Type:: attr.Attribute

slope_exp

Slope exponent

Variable properties:

type : variable
intent : in
dimensions : ()
default value : 1

Type:: attr.Attribute

tol_rel

Relative tolerance (gauss-siedel convergence)

Variable properties:

type : variable
intent : in
dimensions : ()
default value : 0.0001

Type:: attr.Attribute

tol_abs

Absolute tolerance (gauss-siedel convergence)

Variable properties:

type : variable
intent : in
dimensions : ()
default value : 0.0001

Type:: attr.Attribute

max_iter

Max nb. of iterations (gauss-siedel convergence)

Variable properties:

type : variable
intent : in
dimensions : ()
default value : 100

Type:: attr.Attribute

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 : FlowRouter.elevation
intent : in
dimensions : (‘y’, ‘x’)

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

flowacc

Flow accumulation from up to downstream

Variable properties:

type : foreign
reference variable : FlowAccumulator.flowacc
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

chi

Integrated drainage area (chi)

Variable properties:

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

Type:: attr.Attribute

Methods

`__init__`(*, k_coef[, area_exp, slope_exp, ...])	Method generated by attrs for class StreamPowerChannel.
`run_step`()

Output of process info:

In [1]: import xsimlab as xs

In [2]: from fastscape.processes import StreamPowerChannel

In [3]: xs.process_info(StreamPowerChannel)
<StreamPowerChannel  (xsimlab process)>
Variables:
    erosion       [out] ('y', 'x') channel erosion and/or deposition
    k_coef         [in] () or ('y', 'x') bedrock channel incision c...
    area_exp       [in] drainage area exponent
    slope_exp      [in] slope exponent
    tol_rel        [in] relative tolerance (Gauss-Siedel convergence)
    tol_abs        [in] absolute tolerance (Gauss-Siedel convergence)
    max_iter       [in] max nb. of iterations (Gauss-Siedel converg...
    shape          [in] <--- UniformRectilinearGrid2D.shape
    elevation      [in] <--- FlowRouter.elevation
    receivers      [in] <--- FlowRouter.receivers
    flowacc        [in] <--- FlowAccumulator.flowacc
    fs_context     [in] <--- FastscapelibContext.context
    chi           [out] ('y', 'x') integrated drainage area (chi)
Simulation stages:
    run_step