From 986c9b1c563952e4d0665029889c1d59ee921a08 Mon Sep 17 00:00:00 2001
From: Willem van Verseveld <willem.vanverseveld@gmail.com>
Date: Tue, 26 Nov 2024 14:39:59 +0100
Subject: [PATCH] Rename variables in initialization of `sbm` and `sbm_gwf`
 Model components river flow, overland flow and groundwater flow.

---
 src/sbm_gwf_model.jl | 29 ++++++++++++++++-------------
 src/sbm_model.jl     | 12 ++++++------
 2 files changed, 22 insertions(+), 19 deletions(-)

diff --git a/src/sbm_gwf_model.jl b/src/sbm_gwf_model.jl
index 22cc1a6a8..ca0d102fc 100644
--- a/src/sbm_gwf_model.jl
+++ b/src/sbm_gwf_model.jl
@@ -159,7 +159,7 @@ function initialize_sbm_gwf_model(config::Config)
     end
 
     if land_routing == "kinematic-wave"
-        olf = SurfaceFlowLand(
+        overland_flow = SurfaceFlowLand(
             dataset,
             config,
             indices;
@@ -169,7 +169,7 @@ function initialize_sbm_gwf_model(config::Config)
         )
     elseif land_routing == "local-inertial"
         inds_river_map2land = reverse_inds_river[indices] # not filtered (with zeros)
-        olf, staggered_indices = ShallowWaterLand(
+        overland_flow, staggered_indices = ShallowWaterLand(
             dataset,
             config,
             indices;
@@ -193,7 +193,7 @@ function initialize_sbm_gwf_model(config::Config)
     minimum(river_width) > 0 || error("river width must be positive on river cells")
 
     if river_routing == "kinematic-wave"
-        rf = SurfaceFlowRiver(
+        river_flow = SurfaceFlowRiver(
             dataset,
             config,
             inds_river;
@@ -203,7 +203,7 @@ function initialize_sbm_gwf_model(config::Config)
             lake = lake,
         )
     elseif river_routing == "local-inertial"
-        rf, nodes_at_link = ShallowWaterRiver(
+        river_flow, nodes_at_link = ShallowWaterRiver(
             dataset,
             config,
             inds_river;
@@ -294,7 +294,7 @@ function initialize_sbm_gwf_model(config::Config)
         drain = ()
     end
 
-    gwf = GroundwaterFlow{Float}(;
+    groundwater_flow = GroundwaterFlow{Float}(;
         aquifer,
         connectivity,
         constanthead = constant_head,
@@ -304,14 +304,17 @@ function initialize_sbm_gwf_model(config::Config)
     # map GroundwaterFlow and its boundaries
     if do_drains
         subsurface_map = (
-            flow = gwf,
-            recharge = gwf.boundaries[1],
-            river = gwf.boundaries[2],
-            drain = gwf.boundaries[3],
+            flow = groundwater_flow,
+            recharge = groundwater_flow.boundaries[1],
+            river = groundwater_flow.boundaries[2],
+            drain = groundwater_flow.boundaries[3],
         )
     else
-        subsurface_map =
-            (flow = gwf, recharge = gwf.boundaries[1], river = gwf.boundaries[2])
+        subsurface_map = (
+            flow = groundwater_flow,
+            recharge = groundwater_flow.boundaries[1],
+            river = groundwater_flow.boundaries[2],
+        )
     end
 
     # setup subdomains for the land and river kinematic wave domain, if nthreads = 1
@@ -348,7 +351,7 @@ function initialize_sbm_gwf_model(config::Config)
 
     modelmap = (
         vertical = land_hydrology,
-        lateral = (subsurface = subsurface_map, land = olf, river = rf),
+        lateral = (subsurface = subsurface_map, land = overland_flow, river = river_flow),
     )
     indices_reverse = (
         land = reverse_indices,
@@ -476,7 +479,7 @@ function initialize_sbm_gwf_model(config::Config)
     model = Model(
         config,
         (; land, river, reservoir = reservoir_network, lake = lake_network, drain),
-        (subsurface = subsurface_map, land = olf, river = rf),
+        (subsurface = subsurface_map, land = overland_flow, river = river_flow),
         land_hydrology,
         clock,
         reader,
diff --git a/src/sbm_model.jl b/src/sbm_model.jl
index ffab73162..335bd534d 100644
--- a/src/sbm_model.jl
+++ b/src/sbm_model.jl
@@ -194,7 +194,7 @@ function initialize_sbm_model(config::Config)
     end
 
     if land_routing == "kinematic-wave"
-        olf = SurfaceFlowLand(
+        overland_flow = SurfaceFlowLand(
             dataset,
             config,
             indices;
@@ -204,7 +204,7 @@ function initialize_sbm_model(config::Config)
         )
     elseif land_routing == "local-inertial"
         inds_river_map2land = reverse_inds_river[indices] # not filtered (with zeros)
-        olf, staggered_indices = ShallowWaterLand(
+        overland_flow, staggered_indices = ShallowWaterLand(
             dataset,
             config,
             indices;
@@ -226,7 +226,7 @@ function initialize_sbm_model(config::Config)
     minimum(river_length) > 0 || error("river length must be positive on river cells")
     minimum(river_width) > 0 || error("river width must be positive on river cells")
     if river_routing == "kinematic-wave"
-        rf = SurfaceFlowRiver(
+        river_flow = SurfaceFlowRiver(
             dataset,
             config,
             inds_river;
@@ -236,7 +236,7 @@ function initialize_sbm_model(config::Config)
             lake = lake,
         )
     elseif river_routing == "local-inertial"
-        rf, nodes_at_link = ShallowWaterRiver(
+        river_flow, nodes_at_link = ShallowWaterRiver(
             dataset,
             config,
             inds_river;
@@ -300,7 +300,7 @@ function initialize_sbm_model(config::Config)
 
     modelmap = (
         vertical = land_hydrology,
-        lateral = (subsurface = subsurface_flow, land = olf, river = rf),
+        lateral = (subsurface = subsurface_flow, land = overland_flow, river = river_flow),
     )
     indices_reverse = (
         land = reverse_indices,
@@ -410,7 +410,7 @@ function initialize_sbm_model(config::Config)
     model = Model(
         config,
         (; land, river, reservoir = reservoir_network, lake = lake_network),
-        (subsurface = subsurface_flow, land = olf, river = rf),
+        (subsurface = subsurface_flow, land = overland_flow, river = river_flow),
         land_hydrology,
         clock,
         reader,