class TwoLithologyErosionModel

Two Lithology Erosion Model

Base class for common functions of terrainbento models with two lithologies.

The TwoLithologyErosionModel is a base class that contains all of the functionality shared by the terrainbento models that have two lithologies.

class TwoLithologyErosionModel(clock, grid, m_sp=0.5, n_sp=1.0, water_erodibility_lower=0.0001, water_erodibility_upper=0.001, regolith_transport_parameter=0.1, contact_zone__width=1.0, **kwargs)[source]

Bases: terrainbento.base_class.erosion_model.ErosionModel

Base class for two lithology terrainbento models.

A TwoLithologyErosionModel inherits from ErosionModel and provides functionality needed by all models with two lithologies.

This is a base class that handles setting up common parameters and the contact zone elevation.

The following at-node fields must be specified in the grid:
  • topographic__elevation

  • lithology_contact__elevation

__init__(clock, grid, m_sp=0.5, n_sp=1.0, water_erodibility_lower=0.0001, water_erodibility_upper=0.001, regolith_transport_parameter=0.1, contact_zone__width=1.0, **kwargs)[source]
Parameters
  • clock (terrainbento Clock instance) –

  • grid (landlab model grid instance) – The grid must have all required fields.

  • **kwargs – Keyword arguments to pass to ErosionModel. Importantly these arguments specify the precipitator and the runoff generator that control the generation of surface water discharge (\(Q\)).

Returns

TwoLithologyErosionModel

Return type

object

Examples

This model is a base class and is not designed to be run on its own. We recommend that you look at the terrainbento tutorials for examples of usage.