DifferentialStreamPowerChannel

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

Stream-Power channel (differential) erosion.

Channel incision coefficient may vary depending on whether the topographic surface is bare rock or covered by a soil (sediment) layer.

erosion

Channel erosion and/or deposition

Variable properties:

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

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

k_coef_bedrock

Bedrock channel incision coefficient

Variable properties:

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

Type:: attr.Attribute

k_coef_soil

Soil (sediment) channel incision coefficient

Variable properties:

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

Type:: attr.Attribute

k_coef

Differential channel incision coefficient

Variable properties:

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

Type:: attr.Attribute

active_layer_thickness

Sediment layer thickness

Variable properties:

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

Type:: attr.Attribute

Methods

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

Output of process info:

In [1]: import xsimlab as xs

In [2]: from fastscape.processes import DifferentialStreamPowerChannel

In [3]: xs.process_info(DifferentialStreamPowerChannel)
<DifferentialStreamPowerChannel  (xsimlab process)>
Variables:
    erosion                   [out] ('y', 'x') channel erosion and/...
    area_exp                   [in] drainage area exponent
    slope_exp                  [in] slope exponent
    tol_rel                    [in] relative tolerance (Gauss-Siede...
    tol_abs                    [in] absolute tolerance (Gauss-Siede...
    max_iter                   [in] max nb. of iterations (Gauss-Si...
    shape                      [in] <--- UniformRectilinearGrid2D.s...
    elevation                  [in] <--- FlowRouter.elevation
    receivers                  [in] <--- FlowRouter.receivers
    flowacc                    [in] <--- FlowAccumulator.flowacc
    fs_context                 [in] <--- FastscapelibContext.context
    chi                       [out] ('y', 'x') integrated drainage ...
    k_coef_bedrock             [in] () or ('y', 'x') bedrock channe...
    k_coef_soil                [in] () or ('y', 'x') soil (sediment...
    k_coef                    [out] ('y', 'x') differential channel...
    active_layer_thickness     [in] <--- UniformSedimentLayer.thick...
Simulation stages:
    run_step