pyDeltaRCM 2.2.0__tar.gz → 2.2.1a0__tar.gz

{pydeltarcm-2.2.0/pyDeltaRCM.egg-info → pydeltarcm-2.2.1a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyDeltaRCM
-Version: 2.2.0
+Version: 2.2.1a0
 Summary: Python version of original Matlab DeltaRCM.
 Author-email: Andrew Moodie <amoodie@tamu.edu>
 Maintainer-email: Andrew Moodie <amoodie@tamu.edu>

{pydeltarcm-2.2.0 → pydeltarcm-2.2.1a0}/docs/source/reference/model/model_hooks.rst

@@ -61,4 +61,5 @@ A complete list of behavior-modifying arrays in the model follows:
     `mod_water_weight`, modifies the neighbor-weighting of water parcels during routing according to ``(depth * mod_water_weight)**theta_water``, 1
     `mod_sed_weight`, modifies the neighbor-weighting of the sediment parcel routing according to ``(depth * mod_sed_weight)**theta_sed``, 1
     `mod_erosion`, linearly modifies the "erodibility" of cells according to ``mod_erosion * Vp_sed * (U_loc**beta - U_ero**beta) / U_ero**beta``, 1
+    `mod_stable_weight`, linearly modifies the maximum change in volume of a cell during erosion and deposition (default = 1 / 4) according to ``mod_stable_weight * depth / 4 * (dx * dx)``, 1
 

{pydeltarcm-2.2.0 → pydeltarcm-2.2.1a0}/pyDeltaRCM/_version.py

@@ -3,4 +3,4 @@ def __version__() -> str:
     Private version declaration, gets assigned to pyDeltaRCM.__version__
     during import
     """
-    return "2.2.0"
+    return "2.2.1a"

{pydeltarcm-2.2.0 → pydeltarcm-2.2.1a0}/pyDeltaRCM/init_tools.py

@@ -530,6 +530,8 @@ class init_tools(abc.ABC):
         self.mod_water_weight = np.ones_like(self.depth)
         self.mod_sed_weight = np.ones_like(self.depth)
         self.mod_erosion = np.ones_like(self.depth)
+        #add array of ones to make stability parameter weighting mutable
+        self.mod_stable_weight = np.ones_like(self.depth)
 
         # ---- domain ----
         cell_land = -2
@@ -578,6 +580,10 @@ class init_tools(abc.ABC):
         self.inlet = np.array(np.unique(np.where(self.cell_type == 1)[1]))
         self.eta[:] = self.stage - self.depth
 
+        # update eta trackers with initial bed elevation
+        self.eta0[:] = self.eta[:]
+        self.eta_init[:] = self.eta[:]
+
     def init_sediment_routers(self) -> None:
         """Initialize the sediment router object here.
 

{pydeltarcm-2.2.0 → pydeltarcm-2.2.1a0}/pyDeltaRCM/sed_tools.py

@@ -142,6 +142,7 @@ class sed_tools(abc.ABC):
             self.qy,
             self.qs,
             self.mod_sed_weight,
+            self.mod_stable_weight,
         )
 
         # These are the variables updated at the end of the `SandRouter`. If
@@ -209,6 +210,7 @@ class sed_tools(abc.ABC):
             self.qx,
             self.qy,
             self.mod_sed_weight,
+            self.mod_stable_weight,
         )
 
         # These are the variables updated at the end of the `MudRouter`. If
@@ -356,6 +358,7 @@ r_spec = [
     ("mod_erosion", float32[:, :]),
     ("mod_sed_weight", float32[:, :]),
     ("pad_mod_sed_weight", float32[:, :]),
+    ("mod_stable_weight", float32[:, :]),
 ]
 
 
@@ -540,7 +543,8 @@ class BaseRouter:
         """
         return mod_erosion * Vp_sed * (U_loc**beta - U_ero**beta) / U_ero**beta
 
-    def _limit_Vp_change(self, Vp, stage, eta, dx: float, dep_ero: int):
+    def _limit_Vp_change(self, Vp, stage, eta, dx: float, dep_ero: int, 
+                         mod_stable_weight: float):
         """Limit change in volume to 1/4 of a cell volume.
 
         Function is used by multiple pathways in `mud_dep_ero` and `sand_dep_ero`
@@ -553,10 +557,10 @@ class BaseRouter:
             if dep_ero == 0:
                 return 0
             else:
-                fourth = np.abs(depth) / 4 * (dx * dx)
+                fourth = mod_stable_weight * np.abs(depth) / 4 * (dx * dx)
                 return np.minimum(Vp, fourth)
         else:
-            fourth = depth / 4 * (dx * dx)
+            fourth = mod_stable_weight * depth / 4 * (dx * dx)
             return np.minimum(Vp, fourth)
 
 
@@ -642,6 +646,7 @@ class SandRouter(BaseRouter):
         qy,
         qs,
         mod_sed_weight,
+        mod_stable_weight,
     ) -> None:
         """The main function to route and deposit/erode sand parcels.
 
@@ -684,6 +689,7 @@ class SandRouter(BaseRouter):
         self.pad_depth = shared_tools.custom_pad(depth)
         self.pad_cell_type = shared_tools.custom_pad(cell_type)
         self.pad_mod_sed_weight = shared_tools.custom_pad(mod_sed_weight)
+        self.mod_stable_weight = mod_stable_weight
         self.Vp_dep_mud = Vp_dep_mud
         self.Vp_dep_sand = Vp_dep_sand
         self.qw = qw
@@ -790,7 +796,8 @@ class SandRouter(BaseRouter):
             #     transport capacity of the cell (`qs_cap`), sediment needs to
             #     deposit on the bed.
             Vp_change = self._limit_Vp_change(
-                self.Vp_res, self.stage[px, py], self.eta[px, py], self._dx, 0
+                self.Vp_res, self.stage[px, py], self.eta[px, py], self._dx, 0, 
+                self.mod_stable_weight[px, py]
             )
 
         elif (U_loc > self.U_ero_sand) and (qs_loc < qs_cap):
@@ -802,7 +809,8 @@ class SandRouter(BaseRouter):
                 self.Vp_sed, U_loc, self.U_ero_sand, self._beta, ero_mod_loc
             )
             Vp_change = self._limit_Vp_change(
-                Vp_change, self.stage[px, py], self.eta[px, py], self._dx, 1
+                Vp_change, self.stage[px, py], self.eta[px, py], self._dx, 1, 
+                self.mod_stable_weight[px, py]
             )
             Vp_change = Vp_change * -1
 
@@ -893,6 +901,7 @@ class MudRouter(BaseRouter):
         qx,
         qy,
         mod_sed_weight,
+        mod_stable_weight,
     ) -> None:
         """The main function to route and deposit/erode mud parcels."""
 
@@ -907,6 +916,7 @@ class MudRouter(BaseRouter):
         self.pad_depth = shared_tools.custom_pad(depth)
         self.pad_cell_type = shared_tools.custom_pad(cell_type)
         self.pad_mod_sed_weight = shared_tools.custom_pad(mod_sed_weight)
+        self.mod_stable_weight = mod_stable_weight
         self.Vp_dep_mud = Vp_dep_mud
         self.Vp_dep_sand = Vp_dep_sand
         self.qw = qw
@@ -962,7 +972,8 @@ class MudRouter(BaseRouter):
                 / (self.U_dep_mud**self._beta)
             )
             Vp_change = self._limit_Vp_change(
-                Vp_change, self.stage[px, py], self.eta[px, py], self._dx, 0
+                Vp_change, self.stage[px, py], self.eta[px, py], self._dx, 0, 
+                self.mod_stable_weight[px, py]
             )
 
         if U_loc > self.U_ero_mud:
@@ -970,7 +981,8 @@ class MudRouter(BaseRouter):
                 self.Vp_sed, U_loc, self.U_ero_mud, self._beta, ero_mod_loc
             )
             Vp_change = self._limit_Vp_change(
-                Vp_change, self.stage[px, py], self.eta[px, py], self._dx, 1
+                Vp_change, self.stage[px, py], self.eta[px, py], self._dx, 1, 
+                self.mod_stable_weight[px, py]
             )
             Vp_change = Vp_change * -1
 

{pydeltarcm-2.2.0 → pydeltarcm-2.2.1a0/pyDeltaRCM.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyDeltaRCM
-Version: 2.2.0
+Version: 2.2.1a0
 Summary: Python version of original Matlab DeltaRCM.
 Author-email: Andrew Moodie <amoodie@tamu.edu>
 Maintainer-email: Andrew Moodie <amoodie@tamu.edu>

{pydeltarcm-2.2.0 → pydeltarcm-2.2.1a0}/tests/test_init_tools.py

@@ -150,6 +150,16 @@ class TestModelDomainSetup:
         delta = DeltaModel(input_file=p)
         assert np.any(delta.sfc_sum) == 0
 
+    def test_eta_init(self, tmp_path: Path) -> None:
+        p = utilities.yaml_from_dict(tmp_path, "input.yaml")
+        delta = DeltaModel(input_file=p)
+        assert np.all(delta.eta_init == delta.eta)
+
+    def test_eta0(self, tmp_path: Path) -> None:
+        p = utilities.yaml_from_dict(tmp_path, "input.yaml")
+        delta = DeltaModel(input_file=p)
+        assert np.all(delta.eta0 == delta.eta)
+
 
 class TestCreateBoundaryConditions:
     # base case during init is covered by tests elsewhere!