MarineSedimentTransport

class fastscape.processes.MarineSedimentTransport(*, ss_ratio_land, porosity_sand, porosity_silt, e_depth_sand, e_depth_silt, diffusivity_sand, diffusivity_silt, layer_depth, shape, fs_context, elevation, sediment_source, sea_level)

Marine sediment transport, deposition and compaction.

The source of sediment used for marine transport originates from channel erosion and/or transport, which, integrated over the whole continental area, provides a volume of sediment yielded through the shoreline.

A uniform, user-defined ratio of silt/sand is considered for this sediment yield. Each of these grain size category has its own properties like porosity, the exponential decreasing of porosity with depth and the transport coefficient (diffusivity).

ss_ratio_land

Silt fraction of continental sediment source

Variable properties:

  • type : variable

  • intent : in

  • dimensions : ()

Type:

attr.Attribute

ss_ratio_sea

Silt fraction of marine sediment layer

Variable properties:

  • type : variable

  • intent : out

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

Type:

attr.Attribute

porosity_sand

Surface (reference) porosity of sand

Variable properties:

  • type : variable

  • intent : in

  • dimensions : ()

Type:

attr.Attribute

porosity_silt

Surface (reference) porosity of silt

Variable properties:

  • type : variable

  • intent : in

  • dimensions : ()

Type:

attr.Attribute

e_depth_sand

E-folding depth of exp. porosity curve for sand

Variable properties:

  • type : variable

  • intent : in

  • dimensions : ()

Type:

attr.Attribute

e_depth_silt

E-folding depth of exp. porosity curve for silt

Variable properties:

  • type : variable

  • intent : in

  • dimensions : ()

Type:

attr.Attribute

diffusivity_sand

Diffusivity (transport coefficient) for sand

Variable properties:

  • type : variable

  • intent : in

  • dimensions : ()

Type:

attr.Attribute

diffusivity_silt

Diffusivity (transport coefficient) for silt

Variable properties:

  • type : variable

  • intent : in

  • dimensions : ()

Type:

attr.Attribute

layer_depth

Mean depth (thickness) of marine active layer

Variable properties:

  • type : variable

  • intent : in

  • dimensions : ()

Type:

attr.Attribute

shape

Nb. of grid nodes in (y, x)

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

elevation

Surface elevation before erosion

Variable properties:

Type:

attr.Attribute

sediment_source

Channel erosion and/or deposition

Variable properties:

Type:

attr.Attribute

sea_level

Sea level (elevation)

Variable properties:

  • type : foreign

  • reference variable : Sea.level

  • intent : in

  • dimensions : ()

Type:

attr.Attribute

erosion

Marine erosion or deposition of sand/silt

Variable properties:

  • type : variable

  • intent : out

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

  • groups : erosion

Type:

attr.Attribute

Methods

__init__(*, ss_ratio_land, porosity_sand, ...)

Method generated by attrs for class MarineSedimentTransport.

initialize()

run_step()

Output of process info:

In [1]: import xsimlab as xs

In [2]: from fastscape.processes import MarineSedimentTransport

In [3]: xs.process_info(MarineSedimentTransport)
<MarineSedimentTransport  (xsimlab process)>
Variables:
    ss_ratio_land        [in] silt fraction of continental sediment...
    ss_ratio_sea        [out] ('y', 'x') silt fraction of marine se...
    porosity_sand        [in] surface (reference) porosity of sand
    porosity_silt        [in] surface (reference) porosity of silt
    e_depth_sand         [in] e-folding depth of exp. porosity curv...
    e_depth_silt         [in] e-folding depth of exp. porosity curv...
    diffusivity_sand     [in] diffusivity (transport coefficient) f...
    diffusivity_silt     [in] diffusivity (transport coefficient) f...
    layer_depth          [in] mean depth (thickness) of marine acti...
    shape                [in] <--- UniformRectilinearGrid2D.shape
    fs_context           [in] <--- FastscapelibContext.context
    elevation            [in] <--- SurfaceToErode.elevation
    sediment_source      [in] <--- ChannelErosion.erosion
    sea_level            [in] <--- Sea.level
    erosion             [out] ('y', 'x') marine erosion or depositi...
Simulation stages:
    initialize
    run_step