change list into sets

Author: paloma-martinez

geos-geomechanics/src/geos/geomechanics/model/MohrCircle.py

@@ -3,16 +3,15 @@
 # SPDX-FileContributor: Alexandre Benedicto, Martin Lemay
 import numpy as np
 import numpy.typing as npt
-from typing_extensions import Self
+from typing_extensions import Self, Any
 
 from geos.geomechanics.processing.geomechanicsCalculatorFunctions import (
     computeStressPrincipalComponentsFromStressVector, )
 
 __doc__ = """
 MohrCircle module define the Mohr's circle parameters.
 
-Inputs are a 6 component stress vector, a circle id, and the mechanical
-convention used for compression.
+Inputs are a 6 component stress vector, and a circle id.
 The class computes principal components from stress vector during initialization.
 Accessors get access to these 3 principal components as well as circle center
 and radius.
@@ -23,21 +22,21 @@
 
     from processing.MohrCircle import MohrCircle
 
-    # create the object
-    stressVector :npt.NDArray[np.float64]
-    circleId :str
-    mohrCircle :MohrCircle = MohrCircle(circleId)
+    # Create the object
+    stressVector: npt.NDArray[np.float64]
+    circleId: str
+    mohrCircle: MohrCircle = MohrCircle(circleId)
 
-    # either directly set principal components (p3 <= p2 <= p1)
+    # Either directly set principal components (p3 <= p2 <= p1)
     mohrCircle.SetPrincipalComponents(p3, p2, p1)
-    # or compute them from stress vector
+    # Or compute them from stress vector
     mohrCircle.computePrincipalComponents(stressVector)
 
-    # access to members
-    id :str = mohrCircle.getCircleId()
-    p1, p2, p3 :float = mohrCircle.getPrincipalComponents()
-    radius :float = mohrCircle.getCircleRadius()
-    center :float = mohrCircle.getCircleCenter()
+    # Access to members
+    id: str = mohrCircle.getCircleId()
+    p1, p2, p3: float = mohrCircle.getPrincipalComponents()
+    radius: float = mohrCircle.getCircleRadius()
+    center: float = mohrCircle.getCircleCenter()
 """
 
 
@@ -49,60 +48,86 @@ def __init__( self: Self, circleId: str ) -> None:
         Args:
             circleId (str): Mohr's circle id.
         """
-        self.m_circleId: str = circleId
+        self.circleId: str = circleId
 
-        self.m_p1: float = 0.0
-        self.m_p2: float = 0.0
-        self.m_p3: float = 0.0
+        self.p1: float = 0.0
+        self.p2: float = 0.0
+        self.p3: float = 0.0
 
     def __str__( self: Self ) -> str:
         """Overload of __str__ method."""
-        return self.m_circleId
+        return self.circleId
 
     def __repr__( self: Self ) -> str:
         """Overload of __repr__ method."""
-        return self.m_circleId
+        return self.circleId
+
+    def __eq__( self: Self, other: Any ) -> bool:
+        """Overload of __eq__ method."""
+        if not isinstance( other, MohrCircle ):
+            return NotImplemented
+        return self.circleId == other.circleId
+
+    def __hash__( self: Self ) -> int:
+        """Overload of hash method."""
+        return hash( self.circleId )
 
     def setCircleId( self: Self, circleId: str ) -> None:
         """Set circle Id variable.
 
         Args:
-            circleId (str): circle Id.
+            circleId (str): Circle Id.
         """
-        self.m_circleId = circleId
+        self.circleId = circleId
 
     def getCircleId( self: Self ) -> str:
         """Access the Id of the Mohr circle.
 
         Returns:
             str: Id of the Mohr circle
         """
-        return self.m_circleId
+        return self.circleId
 
     def getCircleRadius( self: Self ) -> float:
-        """Compute and return Mohr's circle radius from principal components."""
-        return ( self.m_p1 - self.m_p3 ) / 2.0
+        """Compute and return Mohr's circle radius from principal components.
+
+        Returns:
+            float: Mohr circle radius.
+        """
+        return ( self.p1 - self.p3 ) / 2.0
 
     def getCircleCenter( self: Self ) -> float:
-        """Compute and return Mohr's circle center from principal components."""
-        return ( self.m_p1 + self.m_p3 ) / 2.0
+        """Compute and return Mohr's circle center from principal components.
+
+        Returns:
+            float: Mohr circle center.
+        """
+        return ( self.p1 + self.p3 ) / 2.0
 
     def getPrincipalComponents( self: Self ) -> tuple[ float, float, float ]:
-        """Get Moh's circle principal components."""
-        return ( self.m_p3, self.m_p2, self.m_p1 )
+        """Get Moh's circle principal components.
+
+        Returns:
+            tuple[float, float, float]: Mohr circle principal components.
+        """
+        return ( self.p3, self.p2, self.p1 )
 
     def setPrincipalComponents( self: Self, p3: float, p2: float, p1: float ) -> None:
         """Set principal components.
 
         Args:
-            p3 (float): first component. Must be the lowest.
-            p2 (float): second component.
-            p1 (float): third component. Must be the greatest.
+            p3 (float): First component. Must be the lowest.
+            p2 (float): Second component.
+            p1 (float): Third component. Must be the greatest.
+
+        Raises:
+            ValueError: Expected p3 <= p2 <= p1.
         """
-        assert ( p3 <= p2 ) and ( p2 <= p1 ), "Component order is wrong."
-        self.m_p3 = p3
-        self.m_p2 = p2
-        self.m_p1 = p1
+        if ( p3 <= p2 ) and ( p2 <= p1 ):
+            raise ValueError( "Component order is wrong. Expected p3 <= p2 <= p1." )
+        self.p3 = p3
+        self.p2 = p2
+        self.p1 = p1
 
     def computePrincipalComponents( self: Self, stressVector: npt.NDArray[ np.float64 ] ) -> None:
         """Calculate principal components.
@@ -111,5 +136,5 @@ def computePrincipalComponents( self: Self, stressVector: npt.NDArray[ np.float6
             stressVector (npt.NDArray[np.float64]): 6 components stress vector
                 Stress vector must follow GEOS convention (XX, YY, ZZ, YZ, XZ, XY)
         """
-        # get stress principal components
-        self.m_p3, self.m_p2, self.m_p1 = ( computeStressPrincipalComponentsFromStressVector( stressVector ) )
+        # Get stress principal components
+        self.p3, self.p2, self.p1 = ( computeStressPrincipalComponentsFromStressVector( stressVector ) )

geos-pv/src/geos/pv/utils/mohrCircles/functionsMohrCircle.py

@@ -19,17 +19,17 @@
 circles and Mohr-Coulomb failure envelope.
 """
 
+
 class StressConventionEnum( Enum ):
     """Utility Enum to define the effective stress convention used for compression.
 
     The usual convention considers the compression as positive.
     With GEOS convention, the compression is considered negative.
     """
-    GEOS_STRESS_CONVENTION = - 1.0
+    GEOS_STRESS_CONVENTION = -1.0
     COMMON_STRESS_CONVENTION = 1.0
 
 
-
 def buildPythonViewScript(
     dir_path: str,
     mohrCircles: list[ MohrCircle ],
@@ -73,11 +73,11 @@ def findAnnotateTuples( mohrCircle: MohrCircle, ) -> tuple[ str, str, tuple[ flo
     """Get the values and location of min and max normal stress or Mohr's circle.
 
     Args:
-        mohrCircle (MohrCircle): input Mohr's circle
-        maxTau (float): max shear stress
+        mohrCircle (MohrCircle): Mohr's circle to consider.
+        maxTau (float): Max shear stress
 
     Returns:
-        tuple[str, str, tuple[float, float], tuple[float, float]]: labels and
+        tuple[str, str, tuple[float, float], tuple[float, float]]: Labels and
         location of labels.
     """
     p3, _, p1 = mohrCircle.getPrincipalComponents()
@@ -93,9 +93,8 @@ def getMohrCircleId( cellId: str, timeStep: str ) -> str:
     """Get Mohr's circle ID from cell id and time step.
 
     Args:
-        cellId (str): cell ID
-
-        timeStep (str): time step.
+        cellId (str): Cell ID
+        timeStep (str): Time step.
 
     Returns:
         str: Mohr's circle ID
@@ -108,30 +107,32 @@ def createMohrCircleAtTimeStep(
     cellIds: list[ str ],
     timeStep: str,
     convention: StressConventionEnum,
-) -> list[ MohrCircle ]:
+) -> set[ MohrCircle ]:
     """Create MohrCircle object(s) at a given time step for all cell ids.
 
     Args:
-        stressArray (npt.NDArray[np.float64]): stress numpy array
-
-        cellIds (list[str]): list of cell ids
-
-        timeStep (str): time step
+        stressArray (npt.NDArray[np.float64]): Stress numpy array
+        cellIds (list[str]): List of cell ids
+        timeStep (str): Time step
+        convention (StressConventionEnum): Convention used for compression.
 
-        convention (bool): convention used for compression.
-        * False is Geos convention (compression is negative)
-        * True is usual convention (compression is positive)
+    Raises:
+        ValueError: Stress array must consists of 6 components.
 
     Returns:
-        list[MohrCircle]: list of MohrCircle objects.
+        set[MohrCircle]: Set of MohrCircle objects.
     """
-    assert stressArray.shape[ 1 ] == 6, "Stress vector must be of size 6."
-    mohrCircles: list[ MohrCircle ] = []
+    if stressArray.shape[ 1 ] == 6:
+        raise ValueError( "Expected 6 components for stress array, not {stressArray.shape[ 1 ]}.\n \
+        Cannot proceed with the creation of Mohr circles." )
+
+    mohrCircles: set[ MohrCircle ] = set()
     for i, cellId in enumerate( cellIds ):
         ide: str = getMohrCircleId( cellId, timeStep )
         mohrCircle: MohrCircle = MohrCircle( ide )
         mohrCircle.computePrincipalComponents( stressArray[ i ] * convention.value )
-        mohrCircles.append( mohrCircle )
+        mohrCircles.add( mohrCircle )
+
     return mohrCircles
 
 
@@ -140,11 +141,10 @@ def createMohrCirclesFromPrincipalComponents(
     """Create Mohr's circle objects from principal components.
 
     Args:
-        mohrCircleParams (list[tuple[str, float, float, float]]): list of Mohr's
-        circle parameters
+        mohrCircleParams (list[tuple[str, float, float, float]]): List of Mohr's circle parameters
 
     Returns:
-        list[MohrCircle]: list of Mohr's circle objects.
+        list[MohrCircle]: List of Mohr's circle objects.
     """
     mohrCircles: list[ MohrCircle ] = []
     for circleId, p3, p2, p1 in mohrCircleParams:
@@ -158,9 +158,8 @@ def createMohrCoulombEnvelope( rockCohesion: float, frictionAngle: float ) -> Mo
     """Create MohrCoulomb object from user parameters.
 
     Args:
-        rockCohesion (float): rock cohesion (Pa).
-
-        frictionAngle (float): friction angle in radian.
+        rockCohesion (float): Rock cohesion (Pa).
+        frictionAngle (float): Friction angle in radian.
 
     Returns:
         MohrCoulomb: MohrCoulomb object.

geos-pv/src/geos/pv/utils/mohrCircles/mainMohrCircles.py

@@ -30,9 +30,11 @@
     )
 
     def setup_data( view ) -> None:  # noqa
+        """Setup data."""
         pass
 
     def render( view, width: int, height: int ):  # noqa
+        """Render method."""
         fig.set_size_inches( float( width ) / 100.0, float( height ) / 100.0 )
         return python_view.figure_to_image( fig )