sequence.sea_level module#

Components that adjust sea level.

This module contains Landlab components used for adjusting a grid’s sea level.

class sequence.sea_level.SeaLevelTimeSeries(*args, **kwds)[source]#

Modify sea level through a time series.

__init__(grid: SequenceModelGrid, filepath: str | PathLike[str], kind: str = 'linear', start: float = 0.0)[source]#

Generate sea level values.

Parameters:

grid (SequenceModelGrid) – A landlab grid.
filepath (str) – Name of csv-formatted sea-level file.
kind (str, optional) – Kind of interpolation as a string (one of ‘linear’, ‘nearest’, ‘zero’, ‘slinear’, ‘quadratic’, ‘cubic’). Default is ‘linear’.
start (float, optional) – Set the initial time for the component.

property filepath: str | PathLike[str]#: Return the path to the sea-level file.

run_one_step(dt: float) → None[source]#

Update the component by a time step.

class sequence.sea_level.SinusoidalSeaLevel(*args, **kwds)[source]#

Adjust a grid’s sea level using a sine curve.

__init__(grid: SequenceModelGrid, wave_length: float = 1.0, amplitude: float = 1.0, phase: float = 0.0, mean: float = 0.0, start: float = 0.0, linear: float = 0.0)[source]#

Generate sea level values.

Parameters:

grid (SequenceModelGrid) – A landlab grid.
wave_length (float, optional) – The wave length of the sea-level curve in [y].
amplitude (float, optional) – The amplitude of the sea-level curve.
phase (float, optional) – The phase shift of the sea-level curve [y].
mean (float, optional) – Mean sea-level (disregarding any trend with time).
start (float, optional) – The time of the component [y].
linear (float, optional) – Linear trend of the sea-level curve with time [m / y].