[JTH] merge changes from chyswash development branch

Author: tausiaj

bluemath_tk/core/models.py

@@ -10,6 +10,7 @@
 import numpy as np
 import pandas as pd
 import xarray as xr
+from scipy import constants
 from sklearn.metrics import (
     explained_variance_score,
     mean_absolute_error,
@@ -36,6 +37,8 @@ class BlueMathModel(ABC):
     Abstract base class for handling default functionalities across the project.
     """
 
+    gravity = constants.g
+
     @abstractmethod
     def __init__(self) -> None:
         self._logger: logging.Logger = None

bluemath_tk/waves/series.py

@@ -396,7 +396,23 @@ def series_regular_bichromatic(waves):
 
 
 def waves_dispersion(T, h):
-    "Solve the wave dispersion relation"
+    """
+    Solve the wave dispersion relation to calculate the wavelength (L), wave number (k), and phase speed (c).
+    Parameters
+    ----------
+    T : float
+        Wave period in seconds.
+    h : float
+        Water depth in meters.
+    Returns
+    -------
+    L : float
+        Wavelength in meters.
+    k : float
+        Wave number in radians per meter.
+    c : float
+        Phase speed in meters per second.
+    """
 
     L1 = 1
     L2 = ((9.81 * T**2) / 2 * np.pi) * np.tanh(h * 2 * np.pi / L1)

bluemath_tk/wrappers/swash/swash_example.py

@@ -46,7 +46,8 @@ def build_case(
         waves_dict = {
             "H": case_context["Hs"],
             "T": np.sqrt(
-                (case_context["Hs"] * 2 * np.pi) / (9.806 * case_context["Hs_L0"])
+                (case_context["Hs"] * 2 * np.pi)
+                / (self.gravity * case_context["Hs_L0"])
             ),
             "gamma": self.gamma,
             "warmup": self.warmup,
@@ -65,7 +66,7 @@ def build_case(
         _L, _k, c = waves_dispersion(T=waves_dict["T"], h=self.depth_array[0])
         # comp_dx = L1 / np.abs(self.depth[0]) # MAL: Hecho por JAvi y Valva
         dx = L1 / self.n_nodes_per_wavelength
-        deltc = 0.5 * dx / (np.sqrt(9.81 * self.depth_array[0]) + np.abs(c))
+        deltc = 0.5 * dx / (np.sqrt(self.gravity * self.depth_array[0]) + np.abs(c))
         mxc = int(self.xlenc / dx)
 
         # Update the case context
@@ -106,7 +107,8 @@ def build_case(
         waves_dict = {
             "H": case_context["Hs"],
             "T": np.sqrt(
-                (case_context["Hs"] * 2 * np.pi) / (9.806 * case_context["Hs_L0"])
+                (case_context["Hs"] * 2 * np.pi)
+                / (self.gravity * case_context["Hs_L0"])
             ),
             "gamma": self.gamma,
             "warmup": self.warmup,
@@ -130,7 +132,7 @@ def build_case(
         _L, _k, c = waves_dispersion(T=waves_dict["T"], h=self.depth_array[0])
         # comp_dx = L1 / np.abs(self.depth[0]) # MAL: Hecho por JAvi y Valva
         dx = L1 / self.n_nodes_per_wavelength
-        deltc = 0.5 * dx / (np.sqrt(9.81 * self.depth_array[0]) + np.abs(c))
+        deltc = 0.5 * dx / (np.sqrt(self.gravity * self.depth_array[0]) + np.abs(c))
         mxc = int(self.xlenc / dx)
 
         # Update the case context

bluemath_tk/wrappers/swash/swash_wrapper.py

@@ -12,6 +12,8 @@
 from ...waves.statistics import upcrossing
 from .._base_wrappers import BaseModelWrapper
 
+np.random.seed(42)  # TODO: check global behavior.
+
 
 class SwashModelWrapper(BaseModelWrapper):
     """