core.forcing.Hold

core.forcing.Hold(dt=None, value=None, duration=None, tf=None, plot_kwargs=None)

Constant-valued segment.

Parameters

value : float = None: The constant forcing value throughout the segment.
duration : float = None: Length of the segment. Alias: dt. Exactly one of duration, dt, or tf must be provided.
dt : float = None: Alias for duration.
tf : float = None: Absolute end time (used instead of duration when the end time is known but the start time is not yet fixed).

Examples

import matplotlib.pyplot as plt
import climatecritters as cc

h = cc.forcing.Hold(duration=50, value=280.0)
fig, ax = h.plot()
plt.savefig('docs/reference/figures/Hold_example.png',
            dpi=150, bbox_inches='tight')