modified names of some classes to make them more intuitive

Author: patrickboateng

docs/user_guide/allowable-bearing-capacity.md

@@ -12,7 +12,7 @@ Calculating the allowable bearing capacity of soil for pad foundations using
 ...                                              width=1.2,
 ...                                              shape="square",
 ...                                              foundation_type="pad",
-...                                              abc_type="bowles")
+...                                              abc_method="bowles")
 >>> bowles_abc.allowable_bearing_capacity()
 341.1
 

docs/user_guide/ultimate-bearing-capacity.md

@@ -12,7 +12,7 @@ correlation:
 ...                                     depth=1.5,
 ...                                     width=2.0,
 ...                                     shape="square",
-...                                     ubc_type="vesic")
+...                                     ubc_method="vesic")
 >>> hansen_ubc.ultimate_bearing_capacity()
 893.2
 

geolysis/bearing_capacity/abc/__init__.py

@@ -1,5 +1,5 @@
 from ._cohl import (
-    ABCType,
+    ABCMethod,
     BowlesABC4MatFoundation,
     BowlesABC4PadFoundation,
     MeyerhofABC4MatFoundation,
@@ -16,6 +16,6 @@
     "MeyerhofABC4MatFoundation",
     "TerzaghiABC4PadFoundation",
     "TerzaghiABC4MatFoundation",
-    "ABCType",
+    "ABCMethod",
     "create_abc_4_cohesionless_soils",
 ]

geolysis/bearing_capacity/abc/_cohl/__init__.py

@@ -12,7 +12,7 @@
 from .terzaghi_abc import TerzaghiABC4MatFoundation, TerzaghiABC4PadFoundation
 
 
-class ABCType(AbstractStrEnum):
+class ABCMethod(AbstractStrEnum):
     """Enumeration of allowable bearing capacity calculation methods.
 
     Each member represents a different method for determining
@@ -30,15 +30,15 @@ class ABCType(AbstractStrEnum):
 
 
 abc_classes = {
-    ABCType.BOWLES: {
+    ABCMethod.BOWLES: {
         FoundationType.PAD: BowlesABC4PadFoundation,
         FoundationType.MAT: BowlesABC4MatFoundation,
     },
-    ABCType.MEYERHOF: {
+    ABCMethod.MEYERHOF: {
         FoundationType.PAD: MeyerhofABC4PadFoundation,
         FoundationType.MAT: MeyerhofABC4MatFoundation,
     },
-    ABCType.TERZAGHI: {
+    ABCMethod.TERZAGHI: {
         FoundationType.PAD: TerzaghiABC4PadFoundation,
         FoundationType.MAT: TerzaghiABC4MatFoundation,
     },
@@ -56,7 +56,7 @@ def create_abc_4_cohesionless_soils(
     ground_water_level: float = inf,
     shape: Shape | str = "square",
     foundation_type: FoundationType | str = "pad",
-    abc_type: Annotated[ABCType | str, MustBeMemberOf(ABCType)] = "bowles",
+    abc_method: Annotated[ABCMethod | str, MustBeMemberOf(ABCMethod)] = "bowles",
 ) -> AllowableBearingCapacity:
     r"""A factory function that encapsulate the creation of  allowable
      bearing capacities.
@@ -71,10 +71,10 @@ def create_abc_4_cohesionless_soils(
     :param ground_water_level: Depth of water below ground level (m).
     :param shape: Shape of foundation footing
     :param foundation_type: Type of foundation.
-    :param abc_type: Type of allowable bearing capacity calculation to
+    :param abc_method: Type of allowable bearing capacity calculation to
                      apply.
     """
-    abc_type = ABCType(abc_type)
+    abc_method = ABCMethod(abc_method)
     foundation_type = FoundationType(foundation_type)
 
     # exception from create_foundation will automaatically propagate
@@ -88,7 +88,7 @@ def create_abc_4_cohesionless_soils(
         foundation_type=foundation_type,
         shape=shape,
     )
-    abc_class = abc_classes[abc_type][foundation_type]
+    abc_class = abc_classes[abc_method][foundation_type]
 
     return abc_class(
         corrected_spt_n_value=corrected_spt_n_value,

geolysis/bearing_capacity/ubc/__init__.py

@@ -21,12 +21,12 @@
     "TerzaghiUBC4RectangularFooting",
     "TerzaghiUBC4SquareFooting",
     "VesicUltimateBearingCapacity",
-    "UBCType",
+    "UBCMethod",
     "create_ubc_4_all_soils",
 ]
 
 
-class UBCType(AbstractStrEnum):
+class UBCMethod(AbstractStrEnum):
     """Enumeration of available ultimate bearing capacity methods.
 
     Each member represents a different method for determining
@@ -41,13 +41,13 @@ class UBCType(AbstractStrEnum):
 
 
 ubc_classes = {
-    UBCType.TERZAGHI: {
+    UBCMethod.TERZAGHI: {
         Shape.STRIP: TerzaghiUBC4StripFooting,
         Shape.CIRCLE: TerzaghiUBC4CircularFooting,
         Shape.SQUARE: TerzaghiUBC4SquareFooting,
         Shape.RECTANGLE: TerzaghiUBC4RectangularFooting,
     },
-    UBCType.VESIC: VesicUltimateBearingCapacity,
+    UBCMethod.VESIC: VesicUltimateBearingCapacity,
 }
 
 
@@ -66,7 +66,7 @@ def create_ubc_4_all_soils(
     load_angle: float = 0.0,
     apply_local_shear: bool = False,
     shape: Shape | str = "square",
-    ubc_type: Annotated[UBCType | str, MustBeMemberOf(UBCType)] = "vesic",
+    ubc_method: Annotated[UBCMethod | str, MustBeMemberOf(UBCMethod)] = "vesic",
 ) -> UltimateBearingCapacity:
     r"""A factory function that encapsulate the creation of ultimate
     bearing capacity.
@@ -89,7 +89,7 @@ def create_ubc_4_all_soils(
     :param apply_local_shear: Indicate whether bearing capacity failure
                               is general or local shear failure.
     :param shape: Shape of foundation footing.
-    :param ubc_type: Type of allowable bearing capacity calculation to
+    :param ubc_method: Type of allowable bearing capacity calculation to
                      apply.
 
     :raises ValidationError: Raised if ubc_type is not supported.
@@ -99,7 +99,7 @@ def create_ubc_4_all_soils(
                              rectangular footing.
     """
 
-    ubc_type = UBCType(ubc_type)
+    ubc_method = UBCMethod(ubc_method)
 
     # exception from create_foundation will automatically propagate
     # no need to catch and handle it.
@@ -112,10 +112,10 @@ def create_ubc_4_all_soils(
         ground_water_level=ground_water_level,
         shape=shape,
     )
-    ubc_class = ubc_classes[ubc_type]
+    ubc_class = ubc_classes[ubc_method]
 
-    if ubc_type == UBCType.TERZAGHI:
-        ubc_class = ubc_classes[ubc_type][fnd_size.footing_shape]
+    if ubc_method == UBCMethod.TERZAGHI:
+        ubc_class = ubc_classes[ubc_method][fnd_size.footing_shape]
 
     return ubc_class(
         friction_angle=friction_angle,

tests/test_bearing_capacity/test_abc_4_soils/test_abc.py

@@ -12,7 +12,7 @@ def test_create_allowable_bearing_capacity_errors():
             tol_settlement=20,
             depth=1.5,
             width=1.2,
-            abc_type="HANSEN",
+            abc_method="HANSEN",
         )
 
     # Invalid foundation_type provided
@@ -22,6 +22,6 @@ def test_create_allowable_bearing_capacity_errors():
             tol_settlement=20,
             depth=1.5,
             width=1.2,
-            abc_type="BOWLES",
+            abc_method="BOWLES",
             foundation_type="COMBINED",
         )

tests/test_bearing_capacity/test_abc_4_soils/test_bowles_abc.py

@@ -36,7 +36,7 @@ def test_bowles_abc_4_pad_foundation(
             width=width,
             shape=footing_shape,
             foundation_type=foundation_type,
-            abc_type="bowles",
+            abc_method="bowles",
         )
         exp_abc, exp_load = expected
         assert bowles.allowable_bearing_capacity() == pytest.approx(exp_abc,
@@ -73,7 +73,7 @@ def test_bowles_abc_4_mat_foundation(
             width=width,
             shape=footing_shape,
             foundation_type=foundation_type,
-            abc_type="bowles",
+            abc_method="bowles",
         )
         assert bowles.allowable_bearing_capacity() == pytest.approx(
             expected=expected, rel=0.01

tests/test_bearing_capacity/test_abc_4_soils/test_meyerhof_abc.py

@@ -36,7 +36,7 @@ def test_meyerhof_abc_4_pad_foundation(
             width=width,
             shape=footing_shape,
             foundation_type=foundation_type,
-            abc_type="meyerhof",
+            abc_method="meyerhof",
         )
         assert meyerhof.allowable_bearing_capacity() == pytest.approx(
             expected=expected, rel=0.01
@@ -71,7 +71,7 @@ def test_meyerhof_abc_4_mat_foundation(
             width=width,
             shape=footing_shape,
             foundation_type=foundation_type,
-            abc_type="meyerhof",
+            abc_method="meyerhof",
         )
         assert meyerhof.allowable_bearing_capacity() == pytest.approx(
             expected=expected, rel=0.01

tests/test_bearing_capacity/test_abc_4_soils/test_terzaghi_abc.py

@@ -42,7 +42,7 @@ def test_terzaghi_abc_4_pad_foundation(
             ground_water_level=ground_water_level,
             shape=footing_shape,
             foundation_type=foundation_type,
-            abc_type="terzaghi",
+            abc_method="terzaghi",
         )
 
         assert terzaghi.allowable_bearing_capacity() == pytest.approx(
@@ -81,7 +81,7 @@ def test_terzaghi_abc_4_mat_foundation(
             ground_water_level=ground_water_level,
             shape=footing_shape,
             foundation_type=foundation_type,
-            abc_type="terzaghi",
+            abc_method="terzaghi",
         )
 
         assert terzaghi.allowable_bearing_capacity() == pytest.approx(

tests/test_bearing_capacity/test_ubc_4_soils/test_terzaghi_ubc.py

@@ -80,7 +80,7 @@ def test_bearing_capacity(
             ground_water_level=water_level,
             shape="square",
             apply_local_shear=apply_loc_shear,
-            ubc_type="terzaghi",
+            ubc_method="terzaghi",
         )
         actual = ubc.ultimate_bearing_capacity()
         assert actual == pytest.approx(expected, 0.01)
@@ -121,7 +121,7 @@ def test_bearing_capacity(
             ground_water_level=water_level,
             shape="circle",
             apply_local_shear=apply_loc_shear,
-            ubc_type="terzaghi",
+            ubc_method="terzaghi",
         )
         actual = ubc.ultimate_bearing_capacity()
         assert actual == pytest.approx(expected, 0.01)
@@ -165,7 +165,7 @@ def test_bearing_capacity(
             ground_water_level=water_level,
             shape="rectangle",
             apply_local_shear=apply_loc_shear,
-            ubc_type="terzaghi",
+            ubc_method="terzaghi",
         )
         actual = ubc.ultimate_bearing_capacity()
         assert actual == pytest.approx(expected, 0.01)