elasticipy 3.0.0__py3-none-any.whl → 4.1.0__py3-none-any.whl

Elasticipy/{Plasticity.py → plasticity.py}

@@ -1,11 +1,14 @@
 import numpy as np
-from Elasticipy.StressStrainTensors import StrainTensor, StressTensor
+from Elasticipy.tensors.stress_strain import StrainTensor, StressTensor
 
 
 class IsotropicHardening:
     """
     Template class for isotropic hardening plasticity models
     """
+    type = "Isotropic"
+    name = 'Generic'
+
     def __init__(self, criterion='von Mises'):
         """
         Create an instance of a plastic model, assuming isotropic hardening
@@ -27,6 +30,12 @@ class IsotropicHardening:
             self.criterion = criterion
         self.plastic_strain = 0.0
 
+    def __repr__(self):
+        return (('{} plasticity model\n'.format(self.name) +
+                ' type: {}\n'.format(self.type)) +
+                ' criterion: {}\n'.format(self.criterion.name) +
+                ' current strain: {}'.format(self.plastic_strain))
+
     def flow_stress(self, strain, **kwargs):
         pass
 
@@ -67,9 +76,14 @@ class IsotropicHardening:
 
 
 class JohnsonCook(IsotropicHardening):
+    """
+    Special case of isotropic hardening with an underlying Johnson Cook hardening evolution rule
+    """
+    name = "Johnson-Cook"
+
     def __init__(self, A, B, n, C=None, eps_dot_ref=1.0, m=None, T0=25, Tm=None, criterion='von Mises'):
         """
-        Constructor for a Jonhson-Cook (JC) model.
+        Constructor for a Johnson-Cook (JC) model.
 
         The JC model is an exponential-law strain hardening model, which can take into account strain-rate sensibility
         and temperature-dependence (although they are not mandatory). See notes for details.
@@ -235,6 +249,11 @@ class JohnsonCook(IsotropicHardening):
 
 
 class PlasticityCriterion:
+    """
+    Template class for plasticity criteria
+    """
+    name = 'generic'
+
     @staticmethod
     def eq_stress(stress, **kwargs):
         """
@@ -271,6 +290,10 @@ class PlasticityCriterion:
         pass
 
 class VonMisesPlasticity(PlasticityCriterion):
+    """
+    von Mises plasticity criterion, with associated normality rule
+    """
+    name = 'von Mises'
     @staticmethod
     def eq_stress(stress, **kwargs):
         return stress.vonMises()
@@ -283,6 +306,11 @@ class VonMisesPlasticity(PlasticityCriterion):
         return StrainTensor(3 / 2 * gradient_tensor.matrix)
 
 class TrescaPlasticity(PlasticityCriterion):
+    """
+    Tresca plasticity criterion, with associated normality rule
+    """
+    name = 'Tresca'
+
     @staticmethod
     def eq_stress(stress, **kwargs):
         return stress.Tresca()
@@ -305,6 +333,11 @@ class TrescaPlasticity(PlasticityCriterion):
         return strain / strain.eq_strain()
 
 class DruckerPrager(PlasticityCriterion):
+    """
+    Drucker-Prager pressure-dependent plasticity criterion, with associated normality rule
+    """
+    name = 'Drucker-Prager'
+
     def __init__(self, alpha):
         """
         Create a Drucker-Prager (DG) plasticity criterion.

Elasticipy/{PoleFigure.py → polefigure.py}

@@ -101,6 +101,27 @@ class LambertScale(mscale.ScaleBase):
 mscale.register_scale(LambertScale)
 
 def add_polefigure(fig, *args, projection='stereographic', **kwargs):
+    """
+    Add a pole figure to the figure object.
+
+    Parameters
+    ----------
+    fig : matplotlib.figure.Figure
+        Handle to an existing figure
+    args : list
+        Positional arguments to pass to the subplot constructor
+    projection : str, optional
+        Projection to use. I can be 'stereographic' (default), 'equal area' or 'lambert' (which is equivalent to equal
+        area).
+
+    kwargs : dict
+        Keyword arguments to pass to the subplot constructor
+
+    Returns
+    -------
+    matplotlib.axes._subplots.AxesSubplot
+        Handle to the added axes
+    """
     if projection.lower() == 'equal area':
         projection = 'lambert'
     ax = fig.add_subplot(*args, projection='polar', **kwargs)

Elasticipy/{SphericalFunction.py → spherical_function.py}

@@ -4,7 +4,7 @@ from matplotlib.colors import Normalize
 from numpy import cos, sin
 from scipy import integrate as integrate
 from scipy import optimize
-from Elasticipy.PoleFigure import add_polefigure
+from Elasticipy.polefigure import add_polefigure
 
 
 def sph2cart(*args):
@@ -541,8 +541,6 @@ class SphericalFunction:
         u, evals = self.evaluate_on_spherical_grid((n_phi, n_theta), return_in_spherical=False, use_symmetry=False)
         ax = _plot3D(new_fig, u, evals, **kwargs)
         ax.axis('equal')
-        if fig is None:
-            plt.show()
         return new_fig, ax
 
     def plot_xyz_sections(self, n_theta=500, fig=None, axs=None, **kwargs):
@@ -590,12 +588,10 @@ class SphericalFunction:
             r = self.eval_spherical(angles)
             ax.plot(theta_polar, r, **kwargs)
             axs_new.append(ax)
-        if fig is None:
-            new_fig.show()
         return new_fig, axs_new
 
     def plot_as_pole_figure(self, n_theta=50, n_phi=200, projection='lambert',
-                            fig=None, plot_type='imshow', show=True, title=None,
+                            fig=None, plot_type='imshow', title=None,
                             subplot_args=(), subplot_kwargs=None, **kwargs):
         """
         Plots a pole figure visualization of spherical data using specified parameters and plot types.
@@ -617,7 +613,7 @@ class SphericalFunction:
         plot_type : str, optional
             The type of plot to generate: 'imshow', 'contourf', or 'contour', by default 'imshow'.
         title : str, optional
-            Title to add to the current axis. Defaut is None.
+            Title to add to the current axis. Default is None.
         subplot_args : tuple
             List of arguments to pass to the subplot function, by default ()
         subplot_kwargs : dict
@@ -656,8 +652,6 @@ class SphericalFunction:
         ax.set_rlim(*self.domain[1])
         ax.set_title(title)
         new_fig.colorbar(sc)
-        if show:
-            plt.show()
         return new_fig, ax
 
 
@@ -886,8 +880,6 @@ class HyperSphericalFunction(SphericalFunction):
         else:
             r_grid = np.mean(values, axis=2)
         ax = _plot3D(new_fig, u[:, :, 0, :], r_grid, **kwargs)
-        if fig is None:
-            plt.show()
         return new_fig, ax
 
     def plot_xyz_sections(self, n_theta=500, n_psi=100, color_minmax='blue', alpha_minmax=0.2, color_mean='red',
@@ -950,8 +942,6 @@ class HyperSphericalFunction(SphericalFunction):
         handles.extend([line, area])
         labels.extend([line.get_label(), area.get_label()])
         new_fig.legend(handles, labels, loc='upper center', ncol=2, bbox_to_anchor=(0.5, 0.95))
-        if fig is None:
-            new_fig.show()
         return new_fig, axs
 
     def plot_as_pole_figure(self, n_theta=50, n_phi=200, n_psi=50, which='mean', projection='lambert', fig=None,
@@ -1033,6 +1023,4 @@ class HyperSphericalFunction(SphericalFunction):
         ax.set_rlim(*self.domain[1])
         ax.set_title(title)
         fig.colorbar(sc)
-        if show:
-            plt.show()
         return fig, ax