StratigraphicHorizons

class fastscape.processes.StratigraphicHorizons(*, freeze_time, surf_elevation, elevation_motion, bedrock_motion)

Generate a fixed number of stratigraphic horizons.

A horizon is active, i.e., it tracks the evolution of the land/submarine topographic surface until it is “frozen” at a given time. Beyond this freezing (or deactivation) time, the horizon will only be affected by tectonic deformation and/or erosion.

To compute diagnostics on those horizons, you can create a subclass where you can add “on_demand” variables.

freeze_time

Horizon freezing (deactivation) time

Variable properties:

type : variable
intent : in
dimensions : (‘horizon’,)
static : True

Type:: attr.Attribute

horizon

Horizon number

Variable properties:

type : index
intent : out
dimensions : (‘horizon’,)

Type:: attr.Attribute

active

Whether the horizon is active or not

Variable properties:

type : variable
intent : out
dimensions : (‘horizon’,)

Type:: attr.Attribute

surf_elevation

Surface topography elevation

Variable properties:

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

Type:: attr.Attribute

elevation_motion

Topographic surface motion in upward direction

Variable properties:

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

Type:: attr.Attribute

bedrock_motion

Bedrock motion in upward direction

Variable properties:

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

Type:: attr.Attribute

elevation

Elevation of horizon surfaces

Variable properties:

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

Type:: attr.Attribute

Methods

`__init__`(*, freeze_time, surf_elevation, ...)	Method generated by attrs for class StratigraphicHorizons.
`finalize_step`()
`initialize`(start_time)
`run_step`(current_time)

Output of process info:

In [1]: import xsimlab as xs

In [2]: from fastscape.processes import StratigraphicHorizons

In [3]: xs.process_info(StratigraphicHorizons)
<StratigraphicHorizons  (xsimlab process)>
Variables:
    freeze_time          [in] ('horizon',) horizon freezing (deacti...
    horizon             [out] ('horizon',) horizon number
    active              [out] ('horizon',) whether the horizon is a...
    surf_elevation       [in] <--- SurfaceTopography.elevation
    elevation_motion     [in] <--- TotalVerticalMotion.surface_upward
    bedrock_motion       [in] <--- TotalVerticalMotion.bedrock_upward
    elevation           [out] ('horizon', 'y', 'x') elevation of ho...
Simulation stages:
    initialize
    run_step
    finalize_step