#355 Feedback naming ModulusHorizontalSubgrade

Author: johan-tuls-bam

blueprints/codes/cur/cur_228/formula_2_21.py

@@ -7,15 +7,15 @@
 from blueprints.validations import raise_if_negative
 
 
-class Form2Dot21MenardStiffness(Formula):
+class Form2Dot21ModulusHorizontalSubgrade(Formula):
     """Representation of equation 2.21 CUR 228."""
 
     source_document = CUR_228
     label = "2.21"
     r_0: M = 0.3
 
     def __init__(self, r: M, e_p: KPA, alpha: float) -> None:
-        """Calculates the Menard stiffness (k_h) for r >= 0.3 m.
+        """Calculates the modulus of horizontal subgrade reaction (k_h) using Menard stiffness for r >= 0.3 m.
 
         Parameters
         ----------
@@ -40,26 +40,12 @@ def __init__(self, r: M, e_p: KPA, alpha: float) -> None:
     @staticmethod
     def _evaluate(r: M, e_p: KPA, alpha: float) -> KN_M3:
         """Evaluates the formula, for more information see the __init__ method."""
-        r_0 = Form2Dot21MenardStiffness.r_0
+        r_0 = Form2Dot21ModulusHorizontalSubgrade.r_0
         raise_if_negative(r=r, e_p=e_p, alpha=alpha)
 
         if r >= r_0:
             return 3 * e_p / (1.3 * r_0 * (2.65 * r / r_0) ** alpha + alpha * r)
-        msg = "Radius is smaller than 0.3m, use: Eq2Dot21MenardStiffness"
-        raise ValueError(msg)
-
-    @property
-    def result(self) -> KN_M3:
-        """Return the Menard stiffness k_h when r >= 0.3 m [kN/m3].
-
-        Returns
-        -------
-        KN_M3
-            The Menard stiffness k_h [kN/m3]
-        """
-        if self.r >= self.r_0:
-            return 3 * self.e_p / (1.3 * self.r_0 * (2.65 * self.r / self.r_0) ** self.alpha + self.alpha * self.r)
-        msg = "Radius is smaller than 0.3m, use: Eq2Dot21MenardStiffness"
+        msg = "Radius is smaller than 0.3m, use: Eq2Dot21ModulusHorizontalSubgrade"
         raise ValueError(msg)
 
     def latex(self, n_decimals: int = 2) -> LatexFormula:
@@ -88,6 +74,6 @@ def latex(self, n_decimals: int = 2) -> LatexFormula:
             rf"\left[1.3 \cdot {self.r_0 :.{n}} "
             rf"\left( 2.65 \cdot \frac{{{self.r :.{n}}}}{{{self.r_0 :.{n}}}}\right)^{{{self.alpha :.{n}f}}}"
             rf"+ {self.alpha :.{n}} \cdot {self.r :.{n}}\right]",
-            result=f"{self.result :.{n_decimals}f}",
+            result=f"{self :.{n_decimals}f}",
             unit="kN/m^3",
         )

blueprints/codes/cur/cur_228/formula_2_22.py

@@ -6,14 +6,14 @@
 from blueprints.type_alias import KN_M3, KPA, M
 
 
-class Form2Dot22MenardStiffness(Formula):
+class Form2Dot22ModulusHorizontalSubgrade(Formula):
     """Representation of equation 2.22 CUR 228."""
 
     source_document = CUR_228
     label = "2.22"
 
     def __init__(self, r: M, e_p: KPA, alpha: float) -> None:
-        """Calculates the Menard stiffness (k_h) for r < 0.3 m.
+        """Calculates the modulus of horizontal subgrade reaction (k_h) using Menard stiffness for r < 0.3 m.
 
         Parameters
         ----------
@@ -40,7 +40,7 @@ def _evaluate(r: M, e_p: KPA, alpha: float) -> KN_M3:
         """Return the Menard stiffness k_h when r >= 0.3 m [kN/m3]."""
         if r < 0.3:
             return e_p / 2 / r / ((4 * 2.65**alpha + 3 * alpha) / 18)
-        msg = "Radius is equal to- or larger than 0.3m, use: Eq2Dot21MenardStiffness"
+        msg = "Radius is equal to- or larger than 0.3m, use: Eq2Dot21ModulusHorizontalSubgrade"
         raise ValueError(msg)
 
     def latex(self, n_decimals: int = 2) -> LatexFormula:

tests/codes/cur/cur_228/test_formula_2_21.py

@@ -2,10 +2,10 @@
 
 import pytest
 
-from blueprints.codes.cur.cur_228.formula_2_21 import Form2Dot21MenardStiffness
+from blueprints.codes.cur.cur_228.formula_2_21 import Form2Dot21ModulusHorizontalSubgrade
 
 
-class TestForm2Dot21MenardStiffness:
+class TestForm2Dot21ModulusHorizontalSubgrade:
     """Validation for formula 2.21 from CUR 228."""
 
     def test_evaluation(self) -> None:
@@ -14,7 +14,7 @@ def test_evaluation(self) -> None:
         r = 0.5  # m
         e_p = 2.47  # kN/m²
         alpha = 1 / 3  # -
-        form_2_21 = Form2Dot21MenardStiffness(r=r, e_p=e_p, alpha=alpha)
+        form_2_21 = Form2Dot21ModulusHorizontalSubgrade(r=r, e_p=e_p, alpha=alpha)
 
         # Expected result, manually calculated
         manually_calculated_result = 9.187357198
@@ -29,14 +29,14 @@ def test_raise_error_when_r_is_lower_then_0_3(self) -> None:
         alpha = 1 / 3  # -
 
         with pytest.raises(ValueError):
-            Form2Dot21MenardStiffness(r=r, e_p=e_p, alpha=alpha)
+            Form2Dot21ModulusHorizontalSubgrade(r=r, e_p=e_p, alpha=alpha)
 
     def test_latex_method(self) -> None:
         """Test the latex method."""
         r = 0.5  # m
         e_p = 2.47  # kN/m²
         alpha = 1 / 3  # -
-        form_2_21 = Form2Dot21MenardStiffness(r=r, e_p=e_p, alpha=alpha)
+        form_2_21 = Form2Dot21ModulusHorizontalSubgrade(r=r, e_p=e_p, alpha=alpha)
 
         # Test the full LaTeX representation
         assert isinstance(form_2_21.latex(2).complete, str)

tests/codes/cur/cur_228/test_formula_2_22.py

@@ -2,10 +2,10 @@
 
 import pytest
 
-from blueprints.codes.cur.cur_228.formula_2_22 import Form2Dot22MenardStiffness
+from blueprints.codes.cur.cur_228.formula_2_22 import Form2Dot22ModulusHorizontalSubgrade
 
 
-class TestForm2Dot22MenardStiffness:
+class TestForm2Dot22ModulusHorizontalSubgrade:
     """Validation for formula 2.22 from CUR 228."""
 
     def test_evaluation(self) -> None:
@@ -14,7 +14,7 @@ def test_evaluation(self) -> None:
         r = 0.2  # m
         e_p = 2.47  # kN/m²
         alpha = 1 / 3  # -
-        form_2_22 = Form2Dot22MenardStiffness(r=r, e_p=e_p, alpha=alpha)
+        form_2_22 = Form2Dot22ModulusHorizontalSubgrade(r=r, e_p=e_p, alpha=alpha)
 
         # Expected result, manually calculated
         manually_calculated_result = 17.00760939
@@ -29,14 +29,14 @@ def test_raise_error_when_r_is_higher_then_0_3(self) -> None:
         alpha = 1 / 3  # -
 
         with pytest.raises(ValueError):
-            Form2Dot22MenardStiffness(r=r, e_p=e_p, alpha=alpha)
+            Form2Dot22ModulusHorizontalSubgrade(r=r, e_p=e_p, alpha=alpha)
 
     def test_latex_method(self) -> None:
         """Test the latex method."""
         r = 0.2  # m
         e_p = 2.47  # kN/m²
         alpha = 1 / 3  # -
-        form_2_22 = Form2Dot22MenardStiffness(r=r, e_p=e_p, alpha=alpha)
+        form_2_22 = Form2Dot22ModulusHorizontalSubgrade(r=r, e_p=e_p, alpha=alpha)
 
         # Test the full LaTeX representation
         assert isinstance(form_2_22.latex(2).complete, str)