New option to automatically create a SciPy Array + Fix for Float Spar… (#568)

* New option to automatically create a SciPy Array + Fix for Float Sparse Matrices

* Update ansys/mapdl/core/math.py

Co-authored-by: Alex Kaszynski <[email protected]>

* Update ansys/mapdl/core/math.py

Co-authored-by: Alex Kaszynski <[email protected]>

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Alex Kaszynski <[email protected]>

Author: FredAns

ansys/mapdl/core/math.py

@@ -19,7 +19,7 @@
 
 MYCTYPE = {np.int32: 'I',
            np.int64: 'L',
-           np.single: 'S',
+           np.single: 'F',
            np.double: 'D',
            np.complex64: 'C',
            np.complex128: 'Z'}
@@ -410,7 +410,7 @@ def matrix(self, matrix, name=None, triu=False):
             return AnsDenseMat(name, self._mapdl)
 
     def load_matrix_from_file(self, dtype=np.double, fname="file.full",
-                              mat_id="STIFF"):
+                              mat_id="STIFF", asarray=False):
         """Import a matrix from an existing FULL file.
 
         Parameters
@@ -436,16 +436,21 @@ def load_matrix_from_file(self, dtype=np.double, fname="file.full",
             * ``"K"``_RE - Real part of the stiffness matrix
             * ``"K"``_IM - Imaginary part of the stiffness matrix
 
+        asarray : bool, optional
+            Return a `scipy` array rather than an APDLMath matrix.
 
         """
         name = id_generator()
         self._mapdl._log.info("Calling MAPDL to extract the %s matrix from %s",
                               mat_id, fname)
         self._mapdl.run(f"*SMAT,{name},{MYCTYPE[dtype]},IMPORT,FULL,{fname},{mat_id}",
                         mute=True)
-        return AnsSparseMat(name, self._mapdl)
+        ans_sparse_mat = AnsSparseMat(name, self._mapdl)
+        if asarray:
+            return self._mapdl._mat_data(ans_sparse_mat.id)
+        return ans_sparse_mat
 
-    def stiff(self, dtype=np.double, fname="file.full"):
+    def stiff(self, dtype=np.double, fname="file.full", asarray=False):
         """Load the stiffness matrix from a full file.
 
         Parameters
@@ -456,6 +461,9 @@ def stiff(self, dtype=np.double, fname="file.full"):
         fname : str, optional
             Filename to read the matrix from.
 
+        asarray : bool, optional
+            Return a `scipy` array rather than an APDLMath matrix.
+
         Examples
         --------
         >>> k = mapdl.math.stiff()
@@ -468,9 +476,9 @@ def stiff(self, dtype=np.double, fname="file.full"):
         <60x60 sparse matrix of type '<class 'numpy.float64'>'
             with 1734 stored elements in Compressed Sparse Row format>
         """
-        return self.load_matrix_from_file(dtype, fname, "STIFF")
+        return self.load_matrix_from_file(dtype, fname, "STIFF", asarray)
 
-    def mass(self, dtype=np.double, fname="file.full"):
+    def mass(self, dtype=np.double, fname="file.full", asarray=False):
         """Load the mass matrix from a full file.
 
         Parameters
@@ -481,6 +489,9 @@ def mass(self, dtype=np.double, fname="file.full"):
         fname : str, optional
             Filename to read the matrix from.
 
+        asarray : bool, optional
+            Return a `scipy` array rather than an APDLMath matrix.
+
         Examples
         --------
         >>> m = mapdl.math.mass()
@@ -494,9 +505,9 @@ def mass(self, dtype=np.double, fname="file.full"):
         <60x60 sparse matrix of type '<class 'numpy.float64'>'
             with 1734 stored elements in Compressed Sparse Row format>
         """
-        return self.load_matrix_from_file(dtype, fname, "MASS")
+        return self.load_matrix_from_file(dtype, fname, "MASS", asarray)
 
-    def damp(self, dtype=np.double, fname="file.full"):
+    def damp(self, dtype=np.double, fname="file.full", asarray=False):
         """Load the damping matrix from the full file
 
         Parameters
@@ -507,6 +518,9 @@ def damp(self, dtype=np.double, fname="file.full"):
         fname : str, optional
             Filename to read the matrix from.
 
+        asarray : bool, optional
+            Return a `scipy` array rather than an APDLMath matrix.
+
         Examples
         --------
         >>> m = mapdl.math.damp()
@@ -521,9 +535,9 @@ def damp(self, dtype=np.double, fname="file.full"):
             with 1734 stored elements in Compressed Sparse Row format>
 
         """
-        return self.load_matrix_from_file(dtype, fname, "DAMP")
+        return self.load_matrix_from_file(dtype, fname, "DAMP", asarray)
 
-    def get_vec(self, dtype=np.double, fname="file.full", mat_id="RHS"):
+    def get_vec(self, dtype=np.double, fname="file.full", mat_id="RHS", asarray=False):
         """Load a vector from a file.
 
         Parameters
@@ -543,6 +557,9 @@ def get_vec(self, dtype=np.double, fname="file.full", mat_id="RHS"):
             * ``"BACK"`` - nodal mapping vector (internal to user)
             * ``"FORWARD"`` - nodal mapping vector (user to internal)
 
+        asarray : bool, optional
+            Return a `scipy` array rather than an APDLMath matrix.
+
         Returns
         --------
         ansys.mapdl.math.AnsVec
@@ -560,7 +577,10 @@ def get_vec(self, dtype=np.double, fname="file.full", mat_id="RHS"):
                               mat_id, fname)
         self._mapdl.run(f"*VEC,{name},{MYCTYPE[dtype]},IMPORT,FULL,{fname},{mat_id}",
                         mute=True)
-        return AnsVec(name, self._mapdl)
+        ans_vec = AnsVec(name, self._mapdl)
+        if asarray:
+            return self._mapdl._vec_data(ans_vec.id)
+        return ans_vec
 
     def set_vec(self, data, name=None):
         """Push a numpy array or Python list to the MAPDL Memory
@@ -593,7 +613,7 @@ def set_vec(self, data, name=None):
         self._set_vec(name, data)
         return AnsVec(name, self._mapdl)
 
-    def rhs(self, dtype=np.double, fname="file.full"):
+    def rhs(self, dtype=np.double, fname="file.full", asarray=False):
         """Return the load vector from a full file.
 
         Parameters
@@ -604,6 +624,9 @@ def rhs(self, dtype=np.double, fname="file.full"):
         fname : str, optional
             Filename to read the vector from.  Defaults to ``"file.full"``.
 
+        asarray : bool, optional
+            Return a `scipy` array rather than an APDLMath matrix.
+
         Returns
         -------
         ansys.mapdl.math.AnsVec
@@ -615,7 +638,7 @@ def rhs(self, dtype=np.double, fname="file.full"):
         APDLMath Vector Size 126
 
         """
-        return self.get_vec(dtype, fname, "RHS")
+        return self.get_vec(dtype, fname, "RHS", asarray)
 
     def svd(self, mat, thresh='', sig='', v='', **kwargs):
         """Apply an SVD Algorithm on a matrix.
@@ -993,7 +1016,10 @@ def _send_sparse(self, mname, arr, sym, dtype, chunk_size):
 
         # data vector
         dataname = f'{mname}_DATA'
-        self.set_vec(arr.data, dataname)
+        ans_vec = self.set_vec(arr.data, dataname)
+        if dtype is None:
+            info = self._mapdl._data_info(ans_vec.id)
+            dtype = ANSYS_VALUE_TYPE[info.stype]
 
         # indptr vector
         indptrname = f'{mname}_IND'
@@ -1006,10 +1032,9 @@ def _send_sparse(self, mname, arr, sym, dtype, chunk_size):
         self.set_vec(idx, indxname)
 
         flagsym = 'TRUE' if sym else 'FALSE'
-        self._mapdl.run(f'*SMAT,{mname},D,ALLOC,CSR,{indptrname},{indxname},'
+        self._mapdl.run(f'*SMAT,{mname},{MYCTYPE[dtype]},ALLOC,CSR,{indptrname},{indxname},'
                         f'{dataname},{flagsym}')
 
-
 class ApdlMathObj:
     """Common class for MAPDL Math objects"""