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

Elasticipy/StressStrainTensors.py

@@ -29,13 +29,14 @@ class StrainTensor(SymmetricSecondOrderTensor):
 
         Returns
         -------
-        np.array or float
+        numpy.ndarray or float
             Volumetric change
         """
         return self.I1
 
     def eq_strain(self):
-        return np.sqrt(3/2 * self.J2)
+        """von Mises equivalent strain"""
+        return np.sqrt(2/3 * self.ddot(self))
 
     def elastic_energy(self, stress):
         """
@@ -101,9 +102,9 @@ class StressTensor(SymmetricSecondOrderTensor):
         vonMises : von Mises equivalent stress
         """
         ps = self.principal_stresses()
-        return ps[...,-1] - ps[...,0]
+        return ps[...,0] - ps[...,-1]
 
-    def hydrostaticPressure(self):
+    def hydrostatic_pressure(self):
         """
         Hydrostatic pressure
 
@@ -117,17 +118,21 @@ class StressTensor(SymmetricSecondOrderTensor):
         """
         return -self.I1/3
 
-    def elastic_energy(self, strain):
+    def elastic_energy(self, strain, mode='pair'):
         """
         Compute the elastic energy.
 
         Parameters
         ----------
         strain : StrainTensor
-            Corresponding strain tensor
+            Corresponding elastic strain tensor
+        mode : str, optional
+            If 'pair' (default), the elastic energies are computed element-wise. Broadcasting rule applies.
+            If 'cross', each cross-combination of stress and strain are considered.
 
         Returns
         -------
-        Volumetric elastic energy
+        numpy.ndarray
+            Volumetric elastic energy
         """
-        return 0.5 * self.ddot(strain)
+        return 0.5 * self.ddot(strain, mode=mode)

Elasticipy/ThermalExpansion.py

@@ -1,4 +1,6 @@
-from Elasticipy.SecondOrderTensor import SymmetricSecondOrderTensor
+import warnings
+
+from Elasticipy.SecondOrderTensor import SymmetricSecondOrderTensor, ALPHABET, is_orix_rotation
 from Elasticipy.StressStrainTensors import StrainTensor
 import numpy as np
 from scipy.spatial.transform import Rotation
@@ -7,7 +9,7 @@ class ThermalExpansionTensor(SymmetricSecondOrderTensor):
     name = 'Thermal expansion tensor'
 
     def __mul__(self, other):
-        if isinstance(other, Rotation):
+        if isinstance(other, Rotation) or is_orix_rotation(other):
             return super().__mul__(other)
         else:
             other = np.asarray(other)
@@ -16,36 +18,105 @@ class ThermalExpansionTensor(SymmetricSecondOrderTensor):
             new_mat = self.matrix * other_with_eye
             return StrainTensor(new_mat)
 
+    def apply_temperature(self, temperature, mode='pair'):
+        """
+        Apply temperature increase to the thermal expansion tensor, or to the array.
+
+        Application can be made pair-wise, or considering all cross-combinations (see below).
+
+        Parameters
+        ----------
+        temperature : float or numpy.ndarray
+        mode : str, optional
+            If "pair" (default), the temperatures are applied pair-wise on the tensor array. Broadcasting rule applies
+            If "cross", all cross combinations are considered. Therefore, if ``C=A.apply_temperature(T, mode="cross")``,
+            then ``C.shape=A.shape + T.shape``.
+
+        Returns
+        -------
+        StrainTensor
+            Strain corresponding to the applied temperature increase(s).
+
+        Examples
+        --------
+        Let consider a transverse isotropic case (e.g. carbon fibers):
+        >>> from Elasticipy.ThermalExpansion import ThermalExpansionTensor as ThEx
+        >>> alpha = ThEx.transverse_isotropic(alpha_11=5.6e-6, alpha_33=-0.4e-6)
+
+        Now apply temperature increases:
+        >>> T = [0, 1, 2]
+        >>> eps = alpha.apply_temperature(T)
+
+        We get a strain tensor of the same shape as the applied temperatures:
+        >>> eps
+        Strain tensor
+        Shape=(3,)
+        >>> eps[-1]
+        Strain tensor
+        [[ 1.12e-05  0.00e+00  0.00e+00]
+         [ 0.00e+00  1.12e-05  0.00e+00]
+         [ 0.00e+00  0.00e+00 -8.00e-07]]
+
+         Now let's rotate the thermal expansions:
+         >>> from scipy.spatial.transform import Rotation
+         >>> rot = Rotation.random(3) # Set of 3 random 3D rotations
+         >>> alpha_rotated = alpha * rot
+
+         If we want to combine each rotated thermal expansion with the corresponding temperature increase:
+         >>> eps_rotated_pair = alpha_rotated * T # Equivalent to alpha_rotated.apply_temperature(T)
+         >>> eps_rotated_pair
+         Strain tensor
+         Shape=(3,)
+
+         Conversely, if we want to evaluate all cross-combinations of thermal expansions and temperature increases:
+
+         >>> eps_rotated_cross = alpha_rotated.apply_temperature(T, mode='cross')
+         >>> eps_rotated_cross
+         Strain tensor
+         Shape=(3, 3)
+
+        """
+        temperature = np.asarray(temperature)
+        if mode == 'pair':
+            matrix = self.matrix*temperature[...,np.newaxis,np.newaxis]
+        elif mode == 'cross':
+            indices_self = ALPHABET[:self.ndim]
+            indices_temp = ALPHABET[:len(temperature.shape)].upper()
+            ein_str = indices_self + 'ij,' + indices_temp + '->' + indices_self + indices_temp + 'ij'
+            matrix = np.einsum(ein_str, self.matrix, temperature)
+        else:
+            raise ValueError('Invalid mode. It could be either "pair" or "cross".')
+        return StrainTensor(matrix)
+
+
     def matmul(self, other):
         """
-        Matrix like product with array of Rotations, resulting either in rotated ThermalExpansionTensor or StrainTensor.
+        Matrix like product with array of float, resulting either in StrainTensor.
 
-        Compute the product between the tensor and an array of Rotations or a numpy array in a "matrix-product" way,*
+        Compute the product between the tensor and a numpy array in a "matrix-product" way,*
         that is by computing each of the products. If T.shape=(m,n,o,...) and other.shape=(p,q,r,...), then::
 
             T.matmul(other).shape = (m,n,o,...,p,q,r,...)
 
         Parameters
         ----------
-        other : np.ndarray or Rotation
+        other : np.ndarray
             Value to multiply by.
         Returns
         -------
-        ThermalExpansionTensor or StrainTensor
-            If other is a Rotation, the tensor is just rotated, thus returning a ThermalExpansionTensor.
-            If other is an array, it is assumed that it corresponds to the temperature increase, thus returning a
-            StrainTensor.
+        StrainTensor
+            Array fo strain tensors corresponding to all cross-combinations between Thermal expansions and temperature
+            increases.
         """
-        if isinstance(other, Rotation):
+        warnings.warn(
+            'matmul() is deprecated and will be removed in a future version. Use dot(tensor,mode="cross") or '
+            'rotate(rotation,mode="cross") instead.',
+            DeprecationWarning,
+            stacklevel=2)
+        if isinstance(other, Rotation) or is_orix_rotation(other):
             return super().matmul(other)
         else:
-            other = np.asarray(other)
-            leading_shape = self.shape
-            leading_other_shape = other.shape
-            matrix_expanded = self.matrix.reshape(leading_shape + (1, 1, 3, 3))  # (m, n, 1, 1, 3, 3)
-            other_expanded = other.reshape((1, 1) + leading_other_shape + (1, 1))  # (1, 1, o, p, 1, 1)
-            new_mat = matrix_expanded * other_expanded
-            return StrainTensor(np.squeeze(new_mat))
+            return self.apply_temperature(other, mode='cross')
 
 
     @classmethod

{elasticipy-2.8.10.dist-info → elasticipy-3.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: elasticipy
-Version: 2.8.10
+Version: 3.0.0
 Summary: A Python library for elasticity tensor computations
 Author-email: Dorian Depriester <dorian.dep@gmail.com>
 License: MIT
@@ -36,6 +36,7 @@ Requires-Dist: mp_api; extra == "dev"
 [![DOI](https://zenodo.org/badge/876162900.svg)](https://doi.org/10.5281/zenodo.14501849)
 [![codecov](https://codecov.io/gh/DorianDepriester/Elasticipy/graph/badge.svg?token=VUZPEUPBH1)](https://codecov.io/gh/DorianDepriester/Elasticipy)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/Elasticipy)
+[![status](https://joss.theoj.org/papers/8cce91b782f17f52e9ee30916cd86ad5/status.svg)](https://joss.theoj.org/papers/8cce91b782f17f52e9ee30916cd86ad5)
 
 
 

elasticipy-3.0.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+Elasticipy/CrystalSymmetries.py,sha256=DAX-XPgYqI2nFvf6anCVvZ5fLM0CNSDJ7r2h15l3Hoc,3958
+Elasticipy/FourthOrderTensor.py,sha256=slRB4WL5JZKA8YP7jXMaQs9PRkhi1-RWDGhVNL2VuYA,63944
+Elasticipy/Plasticity.py,sha256=vfL4Ckpk-GgpxXjGXEd4dTSIZJDr28wh_Za5S7PM3WI,11375
+Elasticipy/PoleFigure.py,sha256=G3Sz7ssX2KKY96g3XEvcaOYFmEat9JUCdb2A91XbA6w,3531
+Elasticipy/SecondOrderTensor.py,sha256=USsX2Jg_H8t67P10csPFVxmXJ40PPH7D94Kod_pdD7Y,52261
+Elasticipy/SphericalFunction.py,sha256=X6hrjwCiZkLjiUQ8WO2W4vLNOlbQ4jLWsloOg33IlL4,41244
+Elasticipy/StressStrainTensors.py,sha256=gEPo69Bnu4qBEeyYc4Rn-T213E-fTmTh_QNwAdVCX_U,3261
+Elasticipy/ThermalExpansion.py,sha256=pXAa6CJ7_Yr02ZfUNcjFL7l6o0Bc-O1E3IjEM7yfYy4,8629
+Elasticipy/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+Elasticipy/gui.py,sha256=zyVnvp6IIi3FDR5hWfIJrOP28Y7XkP4wc71XXMyGpeo,11247
+elasticipy-3.0.0.dist-info/LICENSE,sha256=qNthTMSjVkIDM1_BREgVFQHdn1wVNQi9pwWVfTIazMA,1074
+elasticipy-3.0.0.dist-info/METADATA,sha256=-aOaNihsY1m4e1NANFp-EMtTWgQ63vPNS0AlbWRAkLk,3961
+elasticipy-3.0.0.dist-info/WHEEL,sha256=nn6H5-ilmfVryoAQl3ZQ2l8SH5imPWFpm1A5FgEuFV4,91
+elasticipy-3.0.0.dist-info/top_level.txt,sha256=k4zSQzJR5P4vzlHlhWUaxNgvgloq4KIp8oca2X8gQOw,11
+elasticipy-3.0.0.dist-info/RECORD,,

{elasticipy-2.8.10.dist-info → elasticipy-3.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (75.8.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

elasticipy-2.8.10.dist-info/RECORD

@@ -1,15 +0,0 @@
-Elasticipy/CrystalSymmetries.py,sha256=DAX-XPgYqI2nFvf6anCVvZ5fLM0CNSDJ7r2h15l3Hoc,3958
-Elasticipy/FourthOrderTensor.py,sha256=LuqLxcWeonumxgVCjTIvcIjCkAqMK4ZNBlpGLvXGPeA,54105
-Elasticipy/Plasticity.py,sha256=V-jSEf1lKhxKh4yeQs9msZThdT-m_O9KPKVreLk4AvY,4299
-Elasticipy/PoleFigure.py,sha256=G3Sz7ssX2KKY96g3XEvcaOYFmEat9JUCdb2A91XbA6w,3531
-Elasticipy/SecondOrderTensor.py,sha256=P1zPuqfmsPc8HP8izmfDcE80Zbq-UpOs0V1PiEoSmBs,43797
-Elasticipy/SphericalFunction.py,sha256=X6hrjwCiZkLjiUQ8WO2W4vLNOlbQ4jLWsloOg33IlL4,41244
-Elasticipy/StressStrainTensors.py,sha256=nZO6kEePOApdt6Y5anGl47RUhrDkHYtX50jtfKmB0jc,2926
-Elasticipy/ThermalExpansion.py,sha256=nfPTXuqI4fJe14YLzYn8zfSjpYaep8URRYawj8xzjfo,6012
-Elasticipy/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-Elasticipy/gui.py,sha256=zyVnvp6IIi3FDR5hWfIJrOP28Y7XkP4wc71XXMyGpeo,11247
-elasticipy-2.8.10.dist-info/LICENSE,sha256=qNthTMSjVkIDM1_BREgVFQHdn1wVNQi9pwWVfTIazMA,1074
-elasticipy-2.8.10.dist-info/METADATA,sha256=XpTe1cDSCEFNlJ4OlwpNrYqrskP49DFahVnRurWrMxA,3811
-elasticipy-2.8.10.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-elasticipy-2.8.10.dist-info/top_level.txt,sha256=k4zSQzJR5P4vzlHlhWUaxNgvgloq4KIp8oca2X8gQOw,11
-elasticipy-2.8.10.dist-info/RECORD,,