source/solifluction.py is updated and the other functions are revised to consider type hint

modified:   source/derivatives_discretization.py
modified:   source/io_data_process.py
modified:   source/layer.py
modified:   source/solifluction.py

Author: saeb-faraji-gargari

source/derivatives_discretization.py

@@ -1,4 +1,6 @@
 # Discretize the derivatives
+from typing import Any
+
 import lue.framework as lfr
 import numpy as np
 
@@ -144,12 +146,12 @@ def dz_upwind(phi, dz, uz):
 
 # Second derivatives with non-uniform layer distance in y
 def second_derivatives_in_y(
-    layer_variable_center,
-    layer_variable_up,
-    layer_variable_down,
-    dy_layers_up,
-    dy_layers_down,
-):
+    layer_variable_center: Any,
+    layer_variable_up: Any,
+    layer_variable_down: Any,
+    dy_layers_up: Any,
+    dy_layers_down: Any,
+) -> Any:
     """
     Calculate second derivatives for a discretization of non-uniform layer
     distances in y.

source/io_data_process.py

@@ -148,36 +148,36 @@ def default_boundary_type(
     return boundary_type_numpy_default, boundary_loc_numpy
 
 
-def read_run_setup(file_path: str) -> dict:
-    variables: dict = {}
-
-    # Check if file exists
-    if not os.path.exists(file_path):
-        raise FileNotFoundError(f"Configuration file {file_path} not found.")
-
-    with open(file_path, "r") as file:
-        for line in file:
-            line = line.strip()  # Remove leading/trailing whitespace
-
-            # Ignore empty lines or comments
-            if not line or line.startswith("#"):
-                continue
-
-            # Split the line at '=' and handle assignment
-            if "=" in line:
-                key, value = line.split("=", 1)
-                key = key.strip()  # Remove any extra whitespace around the key
-                value = value.strip()  # Remove extra whitespace around value
-
-                # Handle known types
-                if key == "dt":
-                    variables[key] = float(value)  # Convert dt to float
-                elif key == "u_xfile":
-                    variables[key] = value  # File path remains as string
-                # Add more type checks here if needed
-
-                # Add any default handling for other variables as needed.
-                else:
-                    variables[key] = value  # Store as string by default
-
-    return variables
+# def read_run_setup(file_path: str) -> dict:
+#     variables: dict = {}
+
+#     # Check if file exists
+#     if not os.path.exists(file_path):
+#         raise FileNotFoundError(f"Configuration file {file_path} not found.")
+
+#     with open(file_path, "r") as file:
+#         for line in file:
+#             line = line.strip()  # Remove leading/trailing whitespace
+
+#             # Ignore empty lines or comments
+#             if not line or line.startswith("#"):
+#                 continue
+
+#             # Split the line at '=' and handle assignment
+#             if "=" in line:
+#                 key, value = line.split("=", 1)
+#                 key = key.strip()  # Remove any extra whitespace around the key
+#                 value = value.strip()  # Remove extra whitespace around value
+
+#                 # Handle known types
+#                 if key == "dt":
+#                     variables[key] = float(value)  # Convert dt to float
+#                 elif key == "u_xfile":
+#                     variables[key] = value  # File path remains as string
+#                 # Add more type checks here if needed
+
+#                 # Add any default handling for other variables as needed.
+#                 else:
+#                     variables[key] = value  # Store as string by default
+
+#     return variables

source/layer.py

@@ -1,24 +1,28 @@
+from typing import Any
+
+
 class Layer:
     def __init__(
         self,
-        u_x,
-        u_z,
-        T,
-        h_mesh,
-        mu_soil,
-        density_soil,
-        phase_state,
-        k_conductivity_heat,
-        rho_c_heat,
-        vegetation_vol_fraction,
-    ):
+        u_x: Any,
+        u_z: Any,
+        T: Any,
+        h_mesh: Any,
+        mu_soil: Any,
+        density_soil: Any,
+        phase_state: Any,
+        k_conductivity_heat: Any,
+        rho_c_heat: Any,
+        vegetation_vol_fraction: Any,
+    ) -> None:
 
         self.u_x = u_x  # Velocity in x direction
-        self.u_z = u_z  # Velocity in z direction  (y is almost in the gravity direction normal to the bed rock, x and z are layer coordinate parallel to bed rock)
+        self.u_z = u_z  # Velocity in z direction - y is almost in the gravity
+        # direction normal to bed rock, x and z are layer coordinate parallel to bed rock
         self.T = T  # Temperature
         self.h_mesh = h_mesh  # soil layer thickness in mesh
         self.mu_soil = mu_soil  # soil viscosity
-        self.gama_soil = density_soil  #  soil density
+        self.density_soil = density_soil  #  soil density
         self.phase_state = phase_state  # Phase state (fluid, solid (ice), vegetation)
         self.k_conductivity_heat = k_conductivity_heat
         self.rho_c_heat = rho_c_heat