HorizontalAdvection

class fastscape.processes.HorizontalAdvection(*, u, v, shape, fs_context, bedrock_elevation, surface_elevation)

Horizontal rock advection imposed by a velocity field.

u

Velocity field component in x-direction

Variable properties:

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

Type:: attr.Attribute

v

Velocity field component in y-direction

Variable properties:

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

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

fs_context

Accessor to fastscapelib-fortran internal variables

Variable properties:

type : foreign
reference variable : FastscapelibContext.context
intent : in

Type:: attr.Attribute

bedrock_elevation

Bedrock elevation

Variable properties:

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

Type:: attr.Attribute

surface_elevation

Surface topography elevation

Variable properties:

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

Type:: attr.Attribute

bedrock_veffect

Vertical effect of advection on bedrock surface

Variable properties:

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

Type:: attr.Attribute

surface_veffect

Vertical effect of advection on topographic surface

Variable properties:

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

Type:: attr.Attribute

Methods

`__init__`(*, u, v, shape, fs_context, ...)	Method generated by attrs for class HorizontalAdvection.
`run_step`()

Output of process info:

In [1]: import xsimlab as xs

In [2]: from fastscape.processes import HorizontalAdvection

In [3]: xs.process_info(HorizontalAdvection)
<HorizontalAdvection  (xsimlab process)>
Variables:
    u                     [in] () or ('y', 'x') velocity field comp...
    v                     [in] () or ('y', 'x') velocity field comp...
    shape                 [in] <--- UniformRectilinearGrid2D.shape
    fs_context            [in] <--- FastscapelibContext.context
    bedrock_elevation     [in] <--- Bedrock.elevation
    surface_elevation     [in] <--- SurfaceTopography.elevation
    bedrock_veffect      [out] ('y', 'x') vertical effect of advect...
    surface_veffect      [out] ('y', 'x') vertical effect of advect...
Simulation stages:
    run_step