BlockUplift

class fastscape.processes.BlockUplift(*, rate, shape, status, fs_context)

Vertical tectonic block uplift.

Automatically resets uplift to zero at grid borders where ‘fixed_value’ boundary conditions are set.

rate

Uplift rate

Variable properties:

  • type : variable

  • intent : in

  • dimensions : () or (‘y’, ‘x’)

Type:

attr.Attribute

shape

Nb. of grid nodes in (y, x)

Variable properties:

Type:

attr.Attribute

status

Node status at the 4-border boundaries

Variable properties:

Type:

attr.Attribute

fs_context

Accessor to fastscapelib-fortran internal variables

Variable properties:

  • type : foreign

  • reference variable : FastscapelibContext.context

  • intent : in

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__(*, rate, shape, status, fs_context)

Method generated by attrs for class BlockUplift.

initialize()

run_step(dt)

Output of process info:

In [1]: import xsimlab as xs

In [2]: from fastscape.processes import BlockUplift

In [3]: xs.process_info(BlockUplift)
<BlockUplift  (xsimlab process)>
Variables:
    rate           [in] () or ('y', 'x') uplift rate
    shape          [in] <--- UniformRectilinearGrid2D.shape
    status         [in] <--- BorderBoundary.border_status
    fs_context     [in] <--- FastscapelibContext.context
    uplift        [out] () or ('y', 'x') imposed vertical uplift
Simulation stages:
    initialize
    run_step