geolysis 0.2.0__py3-none-any.whl → 0.4.2__py3-none-any.whl

geolysis/bearing_capacity/abc.py

@@ -1,335 +0,0 @@
-from geolysis.constants import UNITS
-from geolysis.foundation import FoundationSize
-from geolysis.utils import FloatOrInt, round_
-
-__all__ = ["BowlesABC1997", "MeyerhofABC1956", "TerzaghiABC1948"]
-
-
-class AllowableSettlementError(ValueError):
-    """
-    Exception raised when actual settlement exceeds allowable settlement.
-    """
-
-
-def _chk_settlement(
-    tol_settlement: FloatOrInt, max_tol_settlement: FloatOrInt
-):
-    if tol_settlement > max_tol_settlement:
-        errmsg = f"Settlement: {tol_settlement} should be less than or equal \
-                Allowable Settlement: {max_tol_settlement}"
-        raise AllowableSettlementError(errmsg)
-
-
-class BowlesABC1997:
-    """
-    Allowable bearing capacity for cohesionless soils according to ``Bowles
-    (1997)``.
-
-    :param FloatOrInt avg_corrected_spt_val: Statistical average of corrected SPT N-value
-        (55% energy with overburden pressure correction) within the foundation influence
-        zone i.e. :math:`0.5B` to :math:`2B`.
-    :param FloatOrInt tol_settlement: Tolerable settlement. (mm)
-    :param FoundationSize foundation_size: Size of foundation.
-
-    :ivar float f_depth: Depth of footing. (m)
-    :ivar float f_width: Width of footing. (m)
-    """
-
-    MAX_TOL_SETTLEMENT = 25.4
-    unit = UNITS.kilo_pascal
-
-    def __init__(
-        self,
-        avg_corrected_spt_val: FloatOrInt,
-        tol_settlement: FloatOrInt,
-        foundation_size: FoundationSize,
-    ) -> None:
-        self.avg_corrected_spt_val = avg_corrected_spt_val
-        self.tol_settlement = tol_settlement
-        self.f_depth = foundation_size.depth
-        self.f_width = foundation_size.width
-
-        _chk_settlement(self.tol_settlement, self.MAX_TOL_SETTLEMENT)
-
-    @property
-    def fd(self):
-        r"""
-        Return the depth factor.
-
-        .. math::
-
-            f_d = 1 + 0.33 \cdot \frac{D_f}{B} \le 1.33
-        """
-        return min(1 + 0.33 * self.f_depth / self.f_width, 1.33)
-
-    @round_(ndigits=2)
-    def abc_cohl_4_isolated_foundation(self):
-        r"""
-        Return allowable bearing capacity for isolated foundation on
-        cohesionless soils.
-
-        for B :math:`\le` 1.2m:
-
-        .. math::
-
-            q_a(kPa) = 19.16(N_1)_{55} f_d\left(\dfrac{S}{25.4}\right)
-
-        for B :math:`\gt` 1.2m:
-
-        .. math::
-
-            q_a(kPa) = 11.8(N_1)_{55}\left(\dfrac{3.28B + 1}{3.28B} \right)^2 f_d
-            \left(\dfrac{S}{25.4}\right)
-        """
-
-        settlement_ratio = self.tol_settlement / self.MAX_TOL_SETTLEMENT
-
-        if self.f_width <= 1.2:
-            abc = (
-                19.16 * self.avg_corrected_spt_val * self.fd * settlement_ratio
-            )
-
-        else:
-            abc = (
-                11.98
-                * self.avg_corrected_spt_val
-                * ((3.28 * self.f_width + 1) / (3.28 * self.f_width)) ** 2
-                * self.fd
-                * settlement_ratio
-            )
-
-        return abc
-
-    @round_(ndigits=2)
-    def abc_cohl_4_raft_foundation(self):
-        r"""
-        Return allowable bearing capacity for raft foundation on cohesionless
-        soils.
-
-        .. math::
-
-            q_a(kPa) = 11.98(N_1)_{55}f_d\left(\dfrac{S}{25.4}\right)
-        """
-        settlement_ratio = self.tol_settlement / self.MAX_TOL_SETTLEMENT
-        return 11.98 * self.avg_corrected_spt_val * self.fd * settlement_ratio
-
-
-class MeyerhofABC1956:
-    """
-    Allowable bearing capacity for cohesionless soils according to ``Meyerhof
-    (1956)``.
-
-    :param FloatOrInt avg_uncorrected_spt_val: Average uncorrected SPT N-value within the
-        foundation influence zone i.e. :math:`D_f` to :math:`D_f + 2B`. Only water table
-        correction suggested.
-    :param FloatOrInt tol_settlement: Tolerable settlement. (mm)
-    :param FoundationSize foundation_size: Size of foundation.
-
-    :var float f_depth: Depth of footing. (m)
-    :ivar float f_width: Width of footing. (m)
-    """
-
-    MAX_TOL_SETTLEMENT = 25.4
-    unit = UNITS.kilo_pascal
-
-    def __init__(
-        self,
-        avg_uncorrected_spt_val: FloatOrInt,
-        tol_settlement: FloatOrInt,
-        foundation_size: FoundationSize,
-    ) -> None:
-        self.avg_uncorrected_spt_val = avg_uncorrected_spt_val
-        self.tol_settlement = tol_settlement
-        self.f_depth = foundation_size.depth
-        self.f_width = foundation_size.width
-
-        _chk_settlement(self.tol_settlement, self.MAX_TOL_SETTLEMENT)
-
-    @property
-    def fd(self):
-        r"""
-        Return the depth factor.
-
-        .. math::
-
-            f_d = 1 + 0.33 \cdot \frac{D_f}{B} \le 1.33
-        """
-        return min(1 + 0.33 * self.f_depth / self.f_width, 1.33)
-
-    @round_(ndigits=2)
-    def abc_cohl_4_isolated_foundation(self):
-        r"""
-        Return allowable bearing capacity for isolated foundation on
-        cohesionless soils.
-
-        for B :math:`\le` 1.2m:
-
-        .. math::
-
-            q_a(kPa) = 12N f_d\left(\dfrac{S}{25.4}\right)
-
-        for B :math:`\gt` 1.2m:
-
-        .. math::
-
-            q_a(kPa) = 8N\left(\dfrac{3.28B + 1}{3.28B} \right)^2 f_d\left(\dfrac{S}{25.4}\right)
-        """
-        settlement_ratio = self.tol_settlement / self.MAX_TOL_SETTLEMENT
-
-        if self.f_width <= 1.2:
-            abc = (
-                12 * self.avg_uncorrected_spt_val * self.fd * settlement_ratio
-            )
-
-        else:
-            abc = (
-                8
-                * self.avg_uncorrected_spt_val
-                * ((3.28 * self.f_width + 1) / (3.28 * self.f_width)) ** 2
-                * self.fd
-                * settlement_ratio
-            )
-
-        return abc
-
-    @round_(ndigits=2)
-    def abc_cohl_4_raft_foundation(self):
-        r"""
-        Return allowable bearing capacity for raft foundation on cohesionless
-        soils.
-
-        .. math::
-
-            q_a(kPa) = 8 N f_d\left(\dfrac{S}{25.4}\right)
-        """
-        settlement_ratio = self.tol_settlement / self.MAX_TOL_SETTLEMENT
-        return 8 * self.avg_uncorrected_spt_val * self.fd * settlement_ratio
-
-
-class TerzaghiABC1948:
-    """
-    Allowable bearing capacity for cohesionless soils according to ``Terzaghi &
-    Peck (1948)``.
-
-    :param FloatOrInt lowest_uncorrected_spt_val: Lowest (or average) uncorrected SPT
-        N-values within the foundation influence zone. i.e. :math:`D_f` to :math:`D_f + 2B`
-    :param FloatOrInt tol_settlement: Tolerable settlement. (mm)
-    :param FloatOrInt water_depth: Depth of water below ground surface. (m)
-    :param FoundationSize foundation_size: Size of foundation.
-
-    :var float f_depth: Depth of footing. (m)
-    :ivar float f_width: Width of footing. (m)
-    """
-
-    MAX_TOL_SETTLEMENT = 25.4
-    unit = UNITS.kilo_pascal
-
-    def __init__(
-        self,
-        lowest_uncorrected_spt_val: FloatOrInt,
-        tol_settlement: FloatOrInt,
-        water_depth: FloatOrInt,
-        foundation_size: FoundationSize,
-    ) -> None:
-        self.lowest_uncorrected_spt_val = lowest_uncorrected_spt_val
-        self.tol_settlement = tol_settlement
-        self.water_depth = water_depth
-        self.f_depth = foundation_size.depth
-        self.f_width = foundation_size.width
-
-        _chk_settlement(self.tol_settlement, self.MAX_TOL_SETTLEMENT)
-
-    @property
-    def fd(self):
-        r"""
-        Return the depth factor.
-
-        .. math::
-
-            f_d = 1 + 0.25 \cdot \frac{D_f}{B} \le 1.25
-        """
-        return min(1 + 0.25 * self.f_depth / self.f_width, 1.25)
-
-    @property
-    def cw(self):
-        r"""
-        Return the water correction factor.
-
-        for surface footing:
-
-        .. math::
-
-            c_w = 2 - \frac{D_w}{2B} \le 2
-
-        for fully submerged footing :math:`d_w \le D_f`
-
-        .. math::
-
-            c_w = 2 - \frac{D_f}{2B} \le 2
-        """
-        if self.water_depth <= self.f_depth:
-            # for fully submerged footing
-            _cw = 2 - self.f_depth / (2 * self.f_width)
-        else:
-            # for surface footing
-            _cw = 2 - self.water_depth / (2 * self.f_width)
-
-        return min(_cw, 2)
-
-    @round_(ndigits=2)
-    def abc_cohl_4_isolated_foundation(self):
-        r"""
-        Return allowable bearing capacity for isolated foundation on
-        cohesionless soils.
-
-        for B :math:`\le` 1.2m:
-
-        .. math::
-
-            q_a(kPa) = 12N \dfrac{1}{c_w f_d}\left(\dfrac{S}{25.4}\right)
-
-        for B :math:`\gt` 1.2m:
-
-        .. math::
-
-            q_a(kPa) = 8N\left(\dfrac{3.28B + 1}{3.28B} \right)^2\dfrac{1}{c_w f_d}
-            \left(\dfrac{S}{25.4}\right)
-        """
-        settlement_ratio = self.tol_settlement / self.MAX_TOL_SETTLEMENT
-
-        if self.f_width <= 1.2:
-            abc = (
-                12
-                * self.lowest_uncorrected_spt_val
-                * (1 / (self.cw * self.fd))
-                * settlement_ratio
-            )
-        else:
-            abc = (
-                8
-                * self.lowest_uncorrected_spt_val
-                * ((3.28 * self.f_width + 1) / (3.28 * self.f_width)) ** 2
-                * (1 / (self.cw * self.fd))
-                * settlement_ratio
-            )
-
-        return abc
-
-    @round_(ndigits=2)
-    def abc_cohl_4_raft_foundation(self):
-        r"""
-        Return allowable bearing capacity for raft foundation on cohesionless
-        soils.
-
-        .. math::
-
-            q_a(kPa) = 8N\dfrac{1}{c_w f_d}\left(\dfrac{S}{25.4}\right)
-        """
-        settlement_ratio = self.tol_settlement / self.MAX_TOL_SETTLEMENT
-
-        return (
-            8
-            * self.lowest_uncorrected_spt_val
-            * (1 / (self.cw * self.fd))
-            * settlement_ratio
-        )

geolysis/constants.py

@@ -1,19 +0,0 @@
-from dataclasses import dataclass
-
-ERROR_TOL = 0.01
-
-
-@dataclass(frozen=True, slots=True)
-class UNITS:
-    """SI units manager for values returned by various functions.
-
-    .. note::
-
-        These values are compatible with the `pint <https://pint.readthedocs.io/en/stable/index.html>`_
-        library.
-    """
-
-    kilo_pascal = "kPa"
-    kilo_newton_per_cubic_metre = "kN/m**3"
-    degrees = "degrees"
-    unitless = ""

geolysis/estimators.py

@@ -1,255 +0,0 @@
-from geolysis.constants import ERROR_TOL, UNITS
-from geolysis.utils import arctan, isclose, round_
-
-__all__ = [
-    "SoilUnitWeightEst",
-    "CompressionIndexEst",
-    "SoilFrictionAngleEst",
-    "UndrainedShearStrengthEst",
-]
-
-
-class EstimatorError(ValueError):
-    """
-    ValueError for estimators.
-    """
-
-
-class SoilUnitWeightEst:
-    """
-    Estimates the ``moist``, ``saturated`` and ``submerged`` unit weight of soil
-    sample from ``SPT N60``.
-
-    :param float spt_n_60: SPT N-value standardized for field procedures considering
-        60% energy.
-    """
-
-    unit = UNITS.kilo_newton_per_cubic_metre
-
-    def __init__(self, spt_n_60: float):
-        self.spt_n_60 = spt_n_60
-
-    @property
-    @round_(ndigits=2)
-    def moist_wgt(self) -> float:
-        r"""
-        Return the moist unit weight for cohesionless soil. (:math:`kN/m^3`)
-
-        .. math::
-
-            \gamma_{moist} = 16.0 + 0.1 \cdot N_{60}
-        """
-        return 16.0 + 0.1 * self.spt_n_60
-
-    @property
-    @round_(ndigits=2)
-    def saturated_wgt(self) -> float:
-        r"""
-        Return the saturated unit weight for cohesive soil. (:math:`kN/m^3`)
-
-        .. math::
-
-            \gamma_{sat} = 16.8 + 0.15 \cdot N_{60}
-        """
-        return 16.8 + 0.15 * self.spt_n_60
-
-    @property
-    @round_(ndigits=2)
-    def submerged_wgt(self) -> float:
-        r"""
-        Return the submerged unit weight for cohesionless soil. (:math:`kN/m^3`)
-
-        .. math::
-
-            \gamma_{sub} = 8.8 + 0.01 \cdot N_{60}
-        """
-        return 8.8 + 0.01 * self.spt_n_60
-
-
-class CompressionIndexEst:
-    """
-    Estimates the compression index of soil from ``liquid limit`` or ``void ratio``.
-
-    The available estimators are ``Terzaghi et al (1967)``, ``Skempton (1994)``,
-    and ``Hough (1957)``.
-    """
-
-    unit = UNITS.unitless
-
-    @staticmethod
-    @round_(ndigits=3)
-    def terzaghi_et_al_ci_1967(liquid_limit: float) -> float:
-        """
-        Return the compression index of soil from ``Terzaghi's`` correlation.
-
-        :param float liquid_limit: Water content beyond which soils flow under their
-            own weight. (%)
-
-        :return: Compression index of soil.
-        :rtype: float
-
-        .. math::
-
-            C_i = 0.009 (LL - 10)
-        """
-        return 0.009 * (liquid_limit - 10.0)
-
-    @staticmethod
-    @round_(ndigits=3)
-    def skempton_ci_1994(liquid_limit: float) -> float:
-        """
-        Return the compression index of soil from ``Skempton's`` correlation.
-
-        :param float liquid_limit: Water content beyond which soils flows under their
-            own weight. (%)
-
-        :return: Compression index of soil.
-        :rtype: float
-
-        .. math::
-
-            C_i = 0.007 (LL - 10)
-        """
-        return 0.007 * (liquid_limit - 10.0)
-
-    @staticmethod
-    @round_(ndigits=3)
-    def hough_ci_1957(void_ratio: float) -> float:
-        """
-        Return the compression index of soil from ``Hough's`` correlation.
-
-        :param float void_ratio: Ratio of the volume of voids to the volume of solids.
-
-        :return: Compression index of soil.
-        :rtype: float
-
-        .. math::
-
-            C_i = 0.29 (e_o - 0.27)
-        """
-        return 0.29 * (void_ratio - 0.27)
-
-
-class SoilFrictionAngleEst:
-    r"""
-    Estimates the internal angle of friction from ``SPT N60``.
-
-    For cohesionless soils the coefficient of internal friction (:math:`\phi`) is
-    determined from the minimum value between ``Wolf (1989)`` and ``Kullhawy & Mayne (1990)``.
-    """
-
-    unit = UNITS.degrees
-
-    @staticmethod
-    @round_(ndigits=3)
-    def wolff_sfa_1989(spt_n_60: float) -> float:
-        r"""
-        Return the internal angle of friction from ``Wolff's`` correlation for
-        granular soils (degrees).
-
-        :param float spt_n_60: SPT N-value standardized for field procedures considering
-            60% energy.
-
-        :return: Internal angle of friction of soil. (degrees)
-        :rtype: float
-
-        .. math::
-
-            \phi = 27.1 + 0.3 \cdot N_{60} - 0.00054 \cdot (N_{60})^2
-        """
-        return 27.1 + (0.3 * spt_n_60) - (0.00054 * (spt_n_60**2))
-
-    @staticmethod
-    @round_(ndigits=3)
-    def kullhawy_mayne_sfa_1990(
-        spt_n_60: float,
-        eop: float,
-        atm_pressure: float,
-    ) -> float:
-        r"""
-        Return the internal angle of friction from ``Kullhawy & Mayne``
-        correlation for cohesionless soils.
-
-        :param float spt_n_60: SPT N-value standardized for field procedures.
-        :param float eop: Effective overburden pressure, should be in the same unit as
-            ``atm_pressure``.
-        :param float atm_pressure: Atmospheric pressure, should be in the same unit as
-            ``eop``.
-
-        :return: Internal angle of friction of soil. (degrees)
-        :rtype: float
-
-        .. math::
-
-            \phi = \left[tan^{-1}\left(\dfrac{N_{60}}{12.2 + 20.3 \cdot
-                    \frac{\sigma_o}{P_a}}\right)\right]^{0.34}
-        """
-        if isclose(atm_pressure, 0, rel_tol=ERROR_TOL):
-            err_msg = f"atm_pressure cannot be {atm_pressure}"
-            raise EstimatorError(err_msg)
-
-        return arctan(
-            (spt_n_60 / (12.2 + 20.3 * (eop / atm_pressure))) ** 0.34
-        )
-
-
-class UndrainedShearStrengthEst:
-    """
-    Undrained shear strength of soil estimators.
-
-    The available estimators are ``Stroud (1974)`` and ``Skempton (1957)``.
-    """
-
-    unit = UNITS.kilo_pascal
-
-    @staticmethod
-    @round_(ndigits=3)
-    def stroud_uss_1974(spt_n_60: float, k=3.5) -> float:
-        r"""
-        Return the undrained shear strength using ``Stroud's`` correlation.
-
-        :param float spt_n_60: SPT N-value standardized for field procedures.
-        :param float k: stroud constants. defaults to 3.5
-
-        :raises EstimatorError: If ``k`` is not in the specified range.
-
-        :return: Undrained shear strength of soil. (:math:`kN/m^2`)
-        :rtype: float
-
-        .. math::
-
-            C_u = k \cdot N_{60}
-
-        :math:`3.5 \le k \le 6.5`
-        """
-        if 3.5 <= k <= 6.5:
-            return k * spt_n_60
-
-        err_msg = f"k should be in the range 3.5 <= k <= 6.5 not {k}"
-        raise EstimatorError(err_msg)
-
-    @staticmethod
-    @round_(ndigits=3)
-    def skempton_uss_1957(eop: float, plasticity_index: float) -> float:
-        r"""
-        Return the undrained shear strength using ``Skempton's`` correlation.
-
-        :param float eop: Effective overburden pressure. (:math:`kN/m^2`)
-        :param float plasticity_index: Range of water content over which soil remains
-            in plastic condition.
-
-        :return: Undrained shear strength of soil. (:math:`kN/m^2`)
-        :rtype: float
-
-        .. math::
-
-            C_u = \sigma_o (0.11 + 0.0037 \cdot PI)
-
-        .. note::
-
-            The value of the ratio :math:`\frac{C_u}{\sigma_o}` determined in a
-            consolidated-undrained test on undisturbed samples is generally greater
-            than actual value because of anisotropic consolidation in the field.
-            The actual value is best determined by ``in-situ shear vane test``.
-        """
-        return eop * (0.11 + 0.0037 * plasticity_index)