TwoBlocksUplift

class fastscape.processes.TwoBlocksUplift(*, x_position, rate_left, rate_right, shape, x)

Set two blocks separated by a clip plane, with different uplift rates.

x_position

Position of the clip plane along the x-axis

Variable properties:

type : variable
intent : in
dimensions : ()
static : True

Type:: attr.Attribute

rate_left

Uplift rate of the left block

Variable properties:

type : variable
intent : in
dimensions : ()

Type:: attr.Attribute

rate_right

Uplift rate of the right block

Variable properties:

type : variable
intent : in
dimensions : ()

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

x

Grid x coordinate

Variable properties:

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

Type:: attr.Attribute

uplift

Imposed vertical uplift

Variable properties:

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

Type:: attr.Attribute

Methods

`__init__`(*, x_position, rate_left, ...)	Method generated by attrs for class TwoBlocksUplift.
`initialize`()
`run_step`(dt)

Output of process info:

In [1]: import xsimlab as xs

In [2]: from fastscape.processes import TwoBlocksUplift

In [3]: xs.process_info(TwoBlocksUplift)
<TwoBlocksUplift  (xsimlab process)>
Variables:
    x_position     [in] position of the clip plane along the x-axis
    rate_left      [in] uplift rate of the left block
    rate_right     [in] uplift rate of the right block
    shape          [in] <--- UniformRectilinearGrid2D.shape
    x              [in] <--- UniformRectilinearGrid2D.x
    uplift        [out] () or ('y', 'x') imposed vertical uplift
Simulation stages:
    initialize
    run_step