Added water loading component (#72)

* add WaterFlexure to subside due to water loading

* add a ParameterMismatchError exception

* add the WaterFlexure component, calculate change in water loading

* additionally calculate change in sea level

* update logging styles

* add news fragment

news/72.feature

@@ -0,0 +1,3 @@
+
+Added a new component, :class:`~sequence.sediment_flexure.WaterFlexure`, that
+calculates deflections based on changes in water loading.

sequence/errors.py

@@ -38,3 +38,15 @@ def __init__(self, name: str):
     def __str_(self) -> str:
         """Return an error message in human-readable form, including the name of the missing variable."""
         return f"{self._name!r}"
+
+
+class ParameterMismatchError(SequenceError):
+    """Raise this error if two configurations have different values for the same parameter."""
+
+    def __init__(self, keys):
+        self.keys = tuple(keys)
+
+    def __str__(self):
+        """Return an error message with the offending keys."""
+        params = ", ".join([repr(key) for key in self.keys])
+        return f"mismatch in parameter{'s' if len(self.keys) > 1 else ''}: {params}"

sequence/logging.py

@@ -10,9 +10,9 @@
 
 LOG_LEVEL_STYLES: dict[str, dict[str, Any]] = {
     "DEBUG": {"bold": True, "dim": True},
-    "INFO": {"bold": True, "dim": True},
+    "INFO": {"bold": True, "dim": True, "fg": "green"},
     "WARNING": {"bold": True, "fg": "bright_yellow"},
-    "ERROR": {"bold": True, "fg": "red"},
+    "ERROR": {"bold": True, "fg": "bright_red"},
     "CRITICAL": {"bold": True, "fg": "bright_red"},
 }
 

sequence/sea_level.py

@@ -31,7 +31,15 @@ class SeaLevelTimeSeries(Component):
             "units": "m",
             "mapping": "grid",
             "doc": "Sea level elevation",
-        }
+        },
+        "sea_level__increment_of_elevation": {
+            "dtype": "float",
+            "intent": "out",
+            "optional": False,
+            "units": "m",
+            "mapping": "grid",
+            "doc": "Change in sea level elevation",
+        },
     }
 
     def __init__(
@@ -109,7 +117,12 @@ def run_one_step(self, dt: float) -> None:
             The time step.
         """
         self._time += dt
-        self.grid.at_grid["sea_level__elevation"] = self._sea_level(self.time)
+        old_sea_level = self.grid.at_grid["sea_level__elevation"]
+        new_sea_level = self._sea_level(self.time)
+        self.grid.at_grid["sea_level__elevation"] = new_sea_level
+        self.grid.at_grid["sea_level__increment_of_elevation"] = (
+            new_sea_level - old_sea_level
+        )
 
 
 class SinusoidalSeaLevel(SeaLevelTimeSeries):