TotalErosion

class fastscape.processes.TotalErosion(*, erosion_vars=(), cumulative_height, grid_area)

Sum up all erosion processes.

erosion_vars

Iterable of all variables that belong to group ‘erosion’

Variable properties:

type : group
intent : in
default value : ()

Type:: attr.Attribute

cumulative_height

Erosion height accumulated over time

Variable properties:

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

Type:: attr.Attribute

height

Total erosion height at current step

Variable properties:

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

Type:: attr.Attribute

rate

Total erosion rate at current step

Variable properties:

type : on_demand
intent : out
dimensions : () or (‘y’, ‘x’)

Type:: attr.Attribute

grid_area

Total grid area

Variable properties:

type : foreign
reference variable : UniformRectilinearGrid2D.area
intent : in
dimensions : ()

Type:: attr.Attribute

domain_rate

Domain-integrated volumetric erosion rate

Variable properties:

type : on_demand
intent : out
dimensions : ()

Type:: attr.Attribute

Methods

`__init__`(*[, erosion_vars])	Method generated by attrs for class TotalErosion.
`run_step`(dt)

Output of process info:

In [1]: import xsimlab as xs

In [2]: from fastscape.processes import TotalErosion

In [3]: xs.process_info(TotalErosion)
<TotalErosion  (xsimlab process)>
Variables:
    erosion_vars          [in] <--- group 'erosion'
    cumulative_height  [inout] () or ('y', 'x') erosion height accu...
    height               [out] () or ('y', 'x') total erosion heigh...
    rate                 [out] () or ('y', 'x') total erosion rate ...
    grid_area             [in] <--- UniformRectilinearGrid2D.area
    domain_rate          [out] domain-integrated volumetric erosion...
Simulation stages:
    run_step