xref: /petsc/src/mat/impls/aij/seq/aijmkl/aijmkl.c (revision 372ec6bb001e6b08705183b828315227b22bfdfd)
14a2a386eSRichard Tran Mills /*
24a2a386eSRichard Tran Mills   Defines basic operations for the MATSEQAIJMKL matrix class.
34a2a386eSRichard Tran Mills   This class is derived from the MATSEQAIJ class and retains the
44a2a386eSRichard Tran Mills   compressed row storage (aka Yale sparse matrix format) but uses
54a2a386eSRichard Tran Mills   sparse BLAS operations from the Intel Math Kernel Library (MKL)
64a2a386eSRichard Tran Mills   wherever possible.
74a2a386eSRichard Tran Mills */
84a2a386eSRichard Tran Mills 
94a2a386eSRichard Tran Mills #include <../src/mat/impls/aij/seq/aij.h>
104a2a386eSRichard Tran Mills #include <../src/mat/impls/aij/seq/aijmkl/aijmkl.h>
114a2a386eSRichard Tran Mills 
124a2a386eSRichard Tran Mills /* MKL include files. */
134a2a386eSRichard Tran Mills #include <mkl_spblas.h>  /* Sparse BLAS */
144a2a386eSRichard Tran Mills 
154a2a386eSRichard Tran Mills typedef struct {
16c9d46305SRichard Tran Mills   PetscBool no_SpMV2;  /* If PETSC_TRUE, then don't use the MKL SpMV2 inspector-executor routines. */
175b49642aSRichard Tran Mills   PetscBool eager_inspection; /* If PETSC_TRUE, then call mkl_sparse_optimize() in MatDuplicate()/MatAssemblyEnd(). */
184abfa3b3SRichard Tran Mills   PetscBool sparse_optimized; /* If PETSC_TRUE, then mkl_sparse_optimize() has been called. */
19b8cbc1fbSRichard Tran Mills #ifdef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
20df555b71SRichard Tran Mills   sparse_matrix_t csrA; /* "Handle" used by SpMV2 inspector-executor routines. */
21df555b71SRichard Tran Mills   struct matrix_descr descr;
22b8cbc1fbSRichard Tran Mills #endif
234a2a386eSRichard Tran Mills } Mat_SeqAIJMKL;
244a2a386eSRichard Tran Mills 
254a2a386eSRichard Tran Mills extern PetscErrorCode MatAssemblyEnd_SeqAIJ(Mat,MatAssemblyType);
264a2a386eSRichard Tran Mills 
274a2a386eSRichard Tran Mills PETSC_INTERN PetscErrorCode MatConvert_SeqAIJMKL_SeqAIJ(Mat A,MatType type,MatReuse reuse,Mat *newmat)
284a2a386eSRichard Tran Mills {
294a2a386eSRichard Tran Mills   /* This routine is only called to convert a MATAIJMKL to its base PETSc type, */
304a2a386eSRichard Tran Mills   /* so we will ignore 'MatType type'. */
314a2a386eSRichard Tran Mills   PetscErrorCode ierr;
324a2a386eSRichard Tran Mills   Mat            B       = *newmat;
33a8327b06SKarl Rupp #ifdef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
344a2a386eSRichard Tran Mills   Mat_SeqAIJMKL  *aijmkl=(Mat_SeqAIJMKL*)A->spptr;
35a8327b06SKarl Rupp #endif
364a2a386eSRichard Tran Mills 
374a2a386eSRichard Tran Mills   PetscFunctionBegin;
384a2a386eSRichard Tran Mills   if (reuse == MAT_INITIAL_MATRIX) {
394a2a386eSRichard Tran Mills     ierr = MatDuplicate(A,MAT_COPY_VALUES,&B);CHKERRQ(ierr);
404a2a386eSRichard Tran Mills   }
414a2a386eSRichard Tran Mills 
424a2a386eSRichard Tran Mills   /* Reset the original function pointers. */
4354871a98SRichard Tran Mills   B->ops->duplicate        = MatDuplicate_SeqAIJ;
444a2a386eSRichard Tran Mills   B->ops->assemblyend      = MatAssemblyEnd_SeqAIJ;
454a2a386eSRichard Tran Mills   B->ops->destroy          = MatDestroy_SeqAIJ;
4654871a98SRichard Tran Mills   B->ops->mult             = MatMult_SeqAIJ;
47ff03dc53SRichard Tran Mills   B->ops->multtranspose    = MatMultTranspose_SeqAIJ;
4854871a98SRichard Tran Mills   B->ops->multadd          = MatMultAdd_SeqAIJ;
49ff03dc53SRichard Tran Mills   B->ops->multtransposeadd = MatMultTransposeAdd_SeqAIJ;
5045fbe478SRichard Tran Mills   B->ops->matmult          = MatMatMult_SeqAIJ_SeqAIJ;
51*372ec6bbSRichard Tran Mills   B->ops->transposematmult = MatTransposeMatMult_SeqAIJ_SeqAIJ;
5287c2a1d7SRichard Tran Mills   B->ops->scale            = MatScale_SeqAIJ;
5387c2a1d7SRichard Tran Mills   B->ops->diagonalscale    = MatDiagonalScale_SeqAIJ;
5487c2a1d7SRichard Tran Mills   B->ops->diagonalset      = MatDiagonalSet_SeqAIJ;
5587c2a1d7SRichard Tran Mills   B->ops->axpy             = MatAXPY_SeqAIJ;
564a2a386eSRichard Tran Mills 
57e9c94282SRichard Tran Mills   ierr = PetscObjectComposeFunction((PetscObject)B,"MatConvert_seqaijmkl_seqaij_C",NULL);CHKERRQ(ierr);
58e9c94282SRichard Tran Mills   ierr = PetscObjectComposeFunction((PetscObject)B,"MatMatMult_seqdense_seqaijmkl_C",NULL);CHKERRQ(ierr);
59e9c94282SRichard Tran Mills   ierr = PetscObjectComposeFunction((PetscObject)B,"MatMatMultSymbolic_seqdense_seqaijmkl_C",NULL);CHKERRQ(ierr);
60e9c94282SRichard Tran Mills   ierr = PetscObjectComposeFunction((PetscObject)B,"MatMatMultNumeric_seqdense_seqaijmkl_C",NULL);CHKERRQ(ierr);
6145fbe478SRichard Tran Mills   if(!aijmkl->no_SpMV2) {
6245fbe478SRichard Tran Mills #ifdef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
6345fbe478SRichard Tran Mills     ierr = PetscObjectComposeFunction((PetscObject)B,"MatMatMult_seqaijmkl_seqaijmkl_C",NULL);CHKERRQ(ierr);
64*372ec6bbSRichard Tran Mills     ierr = PetscObjectComposeFunction((PetscObject)B,"MatTransposeMatMult_seqaijmkl_seqaijmkl_C",NULL);CHKERRQ(ierr);
6545fbe478SRichard Tran Mills #endif
6645fbe478SRichard Tran Mills   }
67e9c94282SRichard Tran Mills 
684abfa3b3SRichard Tran Mills   /* Free everything in the Mat_SeqAIJMKL data structure. Currently, this
69e9c94282SRichard Tran Mills    * simply involves destroying the MKL sparse matrix handle and then freeing
70e9c94282SRichard Tran Mills    * the spptr pointer. */
714abfa3b3SRichard Tran Mills #ifdef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
72a8327b06SKarl Rupp   if (reuse == MAT_INITIAL_MATRIX) aijmkl = (Mat_SeqAIJMKL*)B->spptr;
73a8327b06SKarl Rupp 
744abfa3b3SRichard Tran Mills   if (aijmkl->sparse_optimized) {
750632b357SRichard Tran Mills     sparse_status_t stat;
764abfa3b3SRichard Tran Mills     stat = mkl_sparse_destroy(aijmkl->csrA);
774abfa3b3SRichard Tran Mills     if (stat != SPARSE_STATUS_SUCCESS) {
784abfa3b3SRichard Tran Mills       PetscFunctionReturn(PETSC_ERR_LIB);
794abfa3b3SRichard Tran Mills     }
804abfa3b3SRichard Tran Mills   }
814abfa3b3SRichard Tran Mills #endif /* PETSC_HAVE_MKL_SPARSE_OPTIMIZE */
82e9c94282SRichard Tran Mills   ierr = PetscFree(B->spptr);CHKERRQ(ierr);
834a2a386eSRichard Tran Mills 
844a2a386eSRichard Tran Mills   /* Change the type of B to MATSEQAIJ. */
854a2a386eSRichard Tran Mills   ierr = PetscObjectChangeTypeName((PetscObject)B, MATSEQAIJ);CHKERRQ(ierr);
864a2a386eSRichard Tran Mills 
874a2a386eSRichard Tran Mills   *newmat = B;
884a2a386eSRichard Tran Mills   PetscFunctionReturn(0);
894a2a386eSRichard Tran Mills }
904a2a386eSRichard Tran Mills 
914a2a386eSRichard Tran Mills PetscErrorCode MatDestroy_SeqAIJMKL(Mat A)
924a2a386eSRichard Tran Mills {
934a2a386eSRichard Tran Mills   PetscErrorCode ierr;
944a2a386eSRichard Tran Mills   Mat_SeqAIJMKL *aijmkl = (Mat_SeqAIJMKL*) A->spptr;
954a2a386eSRichard Tran Mills 
964a2a386eSRichard Tran Mills   PetscFunctionBegin;
97e9c94282SRichard Tran Mills 
98e9c94282SRichard Tran Mills   /* If MatHeaderMerge() was used, then this SeqAIJMKL matrix will not have an
99e9c94282SRichard Tran Mills    * spptr pointer. */
100e9c94282SRichard Tran Mills   if (aijmkl) {
1014a2a386eSRichard Tran Mills     /* Clean up everything in the Mat_SeqAIJMKL data structure, then free A->spptr. */
1024abfa3b3SRichard Tran Mills #ifdef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
1034abfa3b3SRichard Tran Mills     if (aijmkl->sparse_optimized) {
1044abfa3b3SRichard Tran Mills       sparse_status_t stat = SPARSE_STATUS_SUCCESS;
1054abfa3b3SRichard Tran Mills       stat = mkl_sparse_destroy(aijmkl->csrA);
1064abfa3b3SRichard Tran Mills       if (stat != SPARSE_STATUS_SUCCESS) {
1074abfa3b3SRichard Tran Mills         PetscFunctionReturn(PETSC_ERR_LIB);
1084abfa3b3SRichard Tran Mills       }
1094abfa3b3SRichard Tran Mills     }
1104abfa3b3SRichard Tran Mills #endif /* PETSC_HAVE_MKL_SPARSE_OPTIMIZE */
1114a2a386eSRichard Tran Mills     ierr = PetscFree(A->spptr);CHKERRQ(ierr);
112e9c94282SRichard Tran Mills   }
1134a2a386eSRichard Tran Mills 
1144a2a386eSRichard Tran Mills   /* Change the type of A back to SEQAIJ and use MatDestroy_SeqAIJ()
1154a2a386eSRichard Tran Mills    * to destroy everything that remains. */
1164a2a386eSRichard Tran Mills   ierr = PetscObjectChangeTypeName((PetscObject)A, MATSEQAIJ);CHKERRQ(ierr);
1174a2a386eSRichard Tran Mills   /* Note that I don't call MatSetType().  I believe this is because that
1184a2a386eSRichard Tran Mills    * is only to be called when *building* a matrix.  I could be wrong, but
1194a2a386eSRichard Tran Mills    * that is how things work for the SuperLU matrix class. */
1204a2a386eSRichard Tran Mills   ierr = MatDestroy_SeqAIJ(A);CHKERRQ(ierr);
1214a2a386eSRichard Tran Mills   PetscFunctionReturn(0);
1224a2a386eSRichard Tran Mills }
1234a2a386eSRichard Tran Mills 
1245b49642aSRichard Tran Mills /* MatSeqAIJKL_create_mkl_handle(), if called with an AIJMKL matrix that has not had mkl_sparse_optimize() called for it,
1255b49642aSRichard Tran Mills  * creates an MKL sparse matrix handle from the AIJ arrays and calls mkl_sparse_optimize().
1265b49642aSRichard Tran Mills  * If called with an AIJMKL matrix for which aijmkl->sparse_optimized == PETSC_TRUE, then it destroys the old matrix
1275b49642aSRichard Tran Mills  * handle, creates a new one, and then calls mkl_sparse_optimize().
1285b49642aSRichard Tran Mills  * Although in normal MKL usage it is possible to have a valid matrix handle on which mkl_sparse_optimize() has not been
1295b49642aSRichard Tran Mills  * called, for AIJMKL the handle creation and optimization step always occur together, so we don't handle the case of
1305b49642aSRichard Tran Mills  * an unoptimized matrix handle here. */
1316e369cd5SRichard Tran Mills PETSC_INTERN PetscErrorCode MatSeqAIJMKL_create_mkl_handle(Mat A)
1324a2a386eSRichard Tran Mills {
1336e369cd5SRichard Tran Mills #ifndef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
1346e369cd5SRichard Tran Mills   /* If the MKL library does not have mkl_sparse_optimize(), then this routine
1356e369cd5SRichard Tran Mills    * does nothing. We make it callable anyway in this case because it cuts
1366e369cd5SRichard Tran Mills    * down on littering the code with #ifdefs. */
13745fbe478SRichard Tran Mills   PetscFunctionBegin;
1386e369cd5SRichard Tran Mills   PetscFunctionReturn(0);
1396e369cd5SRichard Tran Mills #else
140a8327b06SKarl Rupp   Mat_SeqAIJ      *a = (Mat_SeqAIJ*)A->data;
141a8327b06SKarl Rupp   Mat_SeqAIJMKL   *aijmkl = (Mat_SeqAIJMKL*)A->spptr;
142a8327b06SKarl Rupp   PetscInt        m,n;
143a8327b06SKarl Rupp   MatScalar       *aa;
144a8327b06SKarl Rupp   PetscInt        *aj,*ai;
1456e369cd5SRichard Tran Mills   sparse_status_t stat;
1464a2a386eSRichard Tran Mills 
147a8327b06SKarl Rupp   PetscFunctionBegin;
1486e369cd5SRichard Tran Mills   if (aijmkl->no_SpMV2) PetscFunctionReturn(0);
1496e369cd5SRichard Tran Mills 
1500632b357SRichard Tran Mills   if (aijmkl->sparse_optimized) {
1510632b357SRichard Tran Mills     /* Matrix has been previously assembled and optimized. Must destroy old
1520632b357SRichard Tran Mills      * matrix handle before running the optimization step again. */
1530632b357SRichard Tran Mills     stat = mkl_sparse_destroy(aijmkl->csrA);
1540632b357SRichard Tran Mills     if (stat != SPARSE_STATUS_SUCCESS) {
1550632b357SRichard Tran Mills       PetscFunctionReturn(PETSC_ERR_LIB);
1560632b357SRichard Tran Mills     }
1570632b357SRichard Tran Mills   }
1588d3fe1b0SRichard Tran Mills   aijmkl->sparse_optimized = PETSC_FALSE;
1596e369cd5SRichard Tran Mills 
160c9d46305SRichard Tran Mills   /* Now perform the SpMV2 setup and matrix optimization. */
161df555b71SRichard Tran Mills   aijmkl->descr.type        = SPARSE_MATRIX_TYPE_GENERAL;
162df555b71SRichard Tran Mills   aijmkl->descr.mode        = SPARSE_FILL_MODE_LOWER;
163df555b71SRichard Tran Mills   aijmkl->descr.diag        = SPARSE_DIAG_NON_UNIT;
16458678438SRichard Tran Mills   m = A->rmap->n;
16558678438SRichard Tran Mills   n = A->cmap->n;
166df555b71SRichard Tran Mills   aj   = a->j;  /* aj[k] gives column index for element aa[k]. */
167df555b71SRichard Tran Mills   aa   = a->a;  /* Nonzero elements stored row-by-row. */
168df555b71SRichard Tran Mills   ai   = a->i;  /* ai[k] is the position in aa and aj where row k starts. */
16980095d54SIrina Sokolova   if ((a->nz!=0) & !(A->structure_only)) {
1708d3fe1b0SRichard Tran Mills     /* Create a new, optimized sparse matrix handle only if the matrix has nonzero entries.
1718d3fe1b0SRichard Tran Mills      * The MKL sparse-inspector executor routines don't like being passed an empty matrix. */
17258678438SRichard Tran Mills     stat = mkl_sparse_x_create_csr(&aijmkl->csrA,SPARSE_INDEX_BASE_ZERO,m,n,ai,ai+1,aj,aa);
173df555b71SRichard Tran Mills     stat = mkl_sparse_set_mv_hint(aijmkl->csrA,SPARSE_OPERATION_NON_TRANSPOSE,aijmkl->descr,1000);
174df555b71SRichard Tran Mills     stat = mkl_sparse_set_memory_hint(aijmkl->csrA,SPARSE_MEMORY_AGGRESSIVE);
175df555b71SRichard Tran Mills     stat = mkl_sparse_optimize(aijmkl->csrA);
176df555b71SRichard Tran Mills     if (stat != SPARSE_STATUS_SUCCESS) {
177f68ad4bdSRichard Tran Mills       SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"Intel MKL error: unable to create matrix handle/complete mkl_sparse_optimize");
178df555b71SRichard Tran Mills       PetscFunctionReturn(PETSC_ERR_LIB);
179df555b71SRichard Tran Mills     }
1804abfa3b3SRichard Tran Mills     aijmkl->sparse_optimized = PETSC_TRUE;
181c9d46305SRichard Tran Mills   }
1826e369cd5SRichard Tran Mills 
1836e369cd5SRichard Tran Mills   PetscFunctionReturn(0);
184d995685eSRichard Tran Mills #endif
1856e369cd5SRichard Tran Mills }
1866e369cd5SRichard Tran Mills 
18719afcda9SRichard Tran Mills /* MatSeqAIJMKL_create_from_mkl_handle() creates a sequential AIJMKL matrix from an MKL sparse matrix handle.
18819afcda9SRichard Tran Mills  * We need this to implement MatMatMult() using the MKL inspector-executor routines, which return an (unoptimized)
1896c87cf42SRichard Tran Mills  * matrix handle.
1906c87cf42SRichard Tran Mills  * Note: This routine supports replacing the numerical values in an existing matrix that has the same sparsity
1916c87cf42SRichard Tran Mills  * structure as in the MKL handle. However, this code currently doesn't actually get used when MatMatMult()
1926c87cf42SRichard Tran Mills  * is called with MAT_REUSE_MATRIX, because the MatMatMult() interface code calls MatMatMultNumeric() in this case.
1936c87cf42SRichard Tran Mills  * MKL has no notion of separately callable symbolic vs. numeric phases of sparse matrix-matrix multiply, so in the
1946c87cf42SRichard Tran Mills  * MAT_REUSE_MATRIX case, the SeqAIJ routines end up being used. Even though this means that the (hopefully more
1956c87cf42SRichard Tran Mills  * optimized) MKL routines do not get used, this probably is best because the MKL routines would waste time re-computing
1966c87cf42SRichard Tran Mills  * the symbolic portion, whereas the native PETSc SeqAIJ routines will avoid this. */
19719afcda9SRichard Tran Mills #ifdef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
1986c87cf42SRichard Tran Mills PETSC_INTERN PetscErrorCode MatSeqAIJMKL_create_from_mkl_handle(MPI_Comm comm,sparse_matrix_t csrA,MatReuse reuse,Mat *mat)
19919afcda9SRichard Tran Mills {
20019afcda9SRichard Tran Mills   PetscErrorCode ierr;
20119afcda9SRichard Tran Mills   sparse_status_t stat;
20219afcda9SRichard Tran Mills   sparse_index_base_t indexing;
20319afcda9SRichard Tran Mills   PetscInt nrows, ncols;
20445fbe478SRichard Tran Mills   PetscInt *aj,*ai,*dummy;
20519afcda9SRichard Tran Mills   MatScalar *aa;
20619afcda9SRichard Tran Mills   Mat A;
2076c87cf42SRichard Tran Mills   Mat_SeqAIJ *a;
20819afcda9SRichard Tran Mills   Mat_SeqAIJMKL *aijmkl;
20919afcda9SRichard Tran Mills 
21045fbe478SRichard Tran Mills   /* Note: Must pass in &dummy below since MKL can't accept NULL for this output array we don't actually want. */
21145fbe478SRichard Tran Mills   stat = mkl_sparse_x_export_csr(csrA,&indexing,&nrows,&ncols,&ai,&dummy,&aj,&aa);
21219afcda9SRichard Tran Mills   if (stat != SPARSE_STATUS_SUCCESS) {
21319afcda9SRichard Tran Mills     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"Intel MKL error: unable to complete mkl_sparse_x_export_csr()");
21419afcda9SRichard Tran Mills     PetscFunctionReturn(PETSC_ERR_LIB);
21519afcda9SRichard Tran Mills   }
2166c87cf42SRichard Tran Mills 
2176c87cf42SRichard Tran Mills   if (reuse == MAT_INITIAL_MATRIX) {
21819afcda9SRichard Tran Mills     ierr = MatCreate(comm,&A);CHKERRQ(ierr);
21919afcda9SRichard Tran Mills     ierr = MatSetType(A,MATSEQAIJ);CHKERRQ(ierr);
22045fbe478SRichard Tran Mills     ierr = MatSetSizes(A,PETSC_DECIDE,PETSC_DECIDE,nrows,ncols);CHKERRQ(ierr);
22119afcda9SRichard Tran Mills     ierr = MatSeqAIJSetPreallocationCSR(A,ai,aj,aa);CHKERRQ(ierr);
22219afcda9SRichard Tran Mills 
22319afcda9SRichard Tran Mills     /* We now have an assembled sequential AIJ matrix created from copies of the exported arrays from the MKL matrix handle.
22419afcda9SRichard Tran Mills      * Now turn it into a MATSEQAIJMKL. */
22519afcda9SRichard Tran Mills     ierr = MatConvert_SeqAIJ_SeqAIJMKL(A,MATSEQAIJMKL,MAT_INPLACE_MATRIX,&A);CHKERRQ(ierr);
2266c87cf42SRichard Tran Mills   } else {
2276c87cf42SRichard Tran Mills     A = *mat;
2286c87cf42SRichard Tran Mills   }
2296c87cf42SRichard Tran Mills 
2306c87cf42SRichard Tran Mills   a = (Mat_SeqAIJ*)A->data;
23119afcda9SRichard Tran Mills   aijmkl = (Mat_SeqAIJMKL*) A->spptr;
2326c87cf42SRichard Tran Mills 
2336c87cf42SRichard Tran Mills   if (reuse == MAT_REUSE_MATRIX) {
2346c87cf42SRichard Tran Mills     /* Need to destroy old MKL handle. */
2356c87cf42SRichard Tran Mills     stat = mkl_sparse_destroy(aijmkl->csrA);
2366c87cf42SRichard Tran Mills     if (stat != SPARSE_STATUS_SUCCESS) {
2376c87cf42SRichard Tran Mills       PetscFunctionReturn(PETSC_ERR_LIB);
2386c87cf42SRichard Tran Mills     }
2396c87cf42SRichard Tran Mills 
2406c87cf42SRichard Tran Mills     /* The new matrix is supposed to have the same sparsity pattern, so copy only the array of numerical values. */
2416c87cf42SRichard Tran Mills     ierr = PetscMemcpy(a->a,aa,sizeof(MatScalar)*a->nz);CHKERRQ(ierr);
2426c87cf42SRichard Tran Mills   }
24319afcda9SRichard Tran Mills   aijmkl->csrA = csrA;
2446c87cf42SRichard Tran Mills 
24519afcda9SRichard Tran Mills   /* The below code duplicates much of what is in MatSeqAIJKL_create_mkl_handle(). I dislike this code duplication, but
24619afcda9SRichard Tran Mills    * MatSeqAIJMKL_create_mkl_handle() cannot be used because we don't need to create a handle -- we've already got one,
24719afcda9SRichard Tran Mills    * and just need to be able to run the MKL optimization step. */
24819afcda9SRichard Tran Mills   stat = mkl_sparse_set_mv_hint(aijmkl->csrA,SPARSE_OPERATION_NON_TRANSPOSE,aijmkl->descr,1000);
24919afcda9SRichard Tran Mills   stat = mkl_sparse_set_memory_hint(aijmkl->csrA,SPARSE_MEMORY_AGGRESSIVE);
25019afcda9SRichard Tran Mills   stat = mkl_sparse_optimize(aijmkl->csrA);
25119afcda9SRichard Tran Mills   if (stat != SPARSE_STATUS_SUCCESS) {
25219afcda9SRichard Tran Mills     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"Intel MKL error: unable to set hints/complete mkl_sparse_optimize");
25319afcda9SRichard Tran Mills     PetscFunctionReturn(PETSC_ERR_LIB);
25419afcda9SRichard Tran Mills   }
25519afcda9SRichard Tran Mills   aijmkl->sparse_optimized = PETSC_TRUE;
25619afcda9SRichard Tran Mills 
25719afcda9SRichard Tran Mills   *mat = A;
25819afcda9SRichard Tran Mills   PetscFunctionReturn(0);
25919afcda9SRichard Tran Mills }
26019afcda9SRichard Tran Mills #endif /* PETSC_HAVE_MKL_SPARSE_OPTIMIZE */
26119afcda9SRichard Tran Mills 
2626e369cd5SRichard Tran Mills PetscErrorCode MatDuplicate_SeqAIJMKL(Mat A, MatDuplicateOption op, Mat *M)
2636e369cd5SRichard Tran Mills {
2646e369cd5SRichard Tran Mills   PetscErrorCode ierr;
2656e369cd5SRichard Tran Mills   Mat_SeqAIJMKL *aijmkl;
2666e369cd5SRichard Tran Mills   Mat_SeqAIJMKL *aijmkl_dest;
2676e369cd5SRichard Tran Mills 
2686e369cd5SRichard Tran Mills   PetscFunctionBegin;
2696e369cd5SRichard Tran Mills   ierr = MatDuplicate_SeqAIJ(A,op,M);CHKERRQ(ierr);
2706e369cd5SRichard Tran Mills   aijmkl      = (Mat_SeqAIJMKL*) A->spptr;
2716e369cd5SRichard Tran Mills   aijmkl_dest = (Mat_SeqAIJMKL*) (*M)->spptr;
2726e369cd5SRichard Tran Mills   ierr = PetscMemcpy(aijmkl_dest,aijmkl,sizeof(Mat_SeqAIJMKL));CHKERRQ(ierr);
2736e369cd5SRichard Tran Mills   aijmkl_dest->sparse_optimized = PETSC_FALSE;
2745b49642aSRichard Tran Mills   if (aijmkl->eager_inspection) {
2756e369cd5SRichard Tran Mills     ierr = MatSeqAIJMKL_create_mkl_handle(A);CHKERRQ(ierr);
2765b49642aSRichard Tran Mills   }
2776e369cd5SRichard Tran Mills   PetscFunctionReturn(0);
2786e369cd5SRichard Tran Mills }
2796e369cd5SRichard Tran Mills 
2806e369cd5SRichard Tran Mills PetscErrorCode MatAssemblyEnd_SeqAIJMKL(Mat A, MatAssemblyType mode)
2816e369cd5SRichard Tran Mills {
2826e369cd5SRichard Tran Mills   PetscErrorCode  ierr;
2836e369cd5SRichard Tran Mills   Mat_SeqAIJ      *a = (Mat_SeqAIJ*)A->data;
2845b49642aSRichard Tran Mills   Mat_SeqAIJMKL *aijmkl;
2856e369cd5SRichard Tran Mills 
2866e369cd5SRichard Tran Mills   PetscFunctionBegin;
2876e369cd5SRichard Tran Mills   if (mode == MAT_FLUSH_ASSEMBLY) PetscFunctionReturn(0);
2886e369cd5SRichard Tran Mills 
2896e369cd5SRichard Tran Mills   /* Since a MATSEQAIJMKL matrix is really just a MATSEQAIJ with some
2906e369cd5SRichard Tran Mills    * extra information and some different methods, call the AssemblyEnd
2916e369cd5SRichard Tran Mills    * routine for a MATSEQAIJ.
2926e369cd5SRichard Tran Mills    * I'm not sure if this is the best way to do this, but it avoids
293d96e85feSRichard Tran Mills    * a lot of code duplication. */
2946e369cd5SRichard Tran Mills   a->inode.use = PETSC_FALSE;  /* Must disable: otherwise the MKL routines won't get used. */
2956e369cd5SRichard Tran Mills   ierr = MatAssemblyEnd_SeqAIJ(A, mode);CHKERRQ(ierr);
2966e369cd5SRichard Tran Mills 
2975b49642aSRichard Tran Mills   /* If the user has requested "eager" inspection, create the optimized MKL sparse handle (if needed; the function checks).
2985b49642aSRichard Tran Mills    * (The default is to do "lazy" inspection, deferring this until something like MatMult() is called.) */
2995b49642aSRichard Tran Mills   aijmkl = (Mat_SeqAIJMKL*) A->spptr;
3005b49642aSRichard Tran Mills   if (aijmkl->eager_inspection) {
3016e369cd5SRichard Tran Mills     ierr = MatSeqAIJMKL_create_mkl_handle(A);CHKERRQ(ierr);
3025b49642aSRichard Tran Mills   }
303df555b71SRichard Tran Mills 
3044a2a386eSRichard Tran Mills   PetscFunctionReturn(0);
3054a2a386eSRichard Tran Mills }
3064a2a386eSRichard Tran Mills 
3074a2a386eSRichard Tran Mills PetscErrorCode MatMult_SeqAIJMKL(Mat A,Vec xx,Vec yy)
3084a2a386eSRichard Tran Mills {
3094a2a386eSRichard Tran Mills   Mat_SeqAIJ        *a = (Mat_SeqAIJ*)A->data;
3104a2a386eSRichard Tran Mills   const PetscScalar *x;
3114a2a386eSRichard Tran Mills   PetscScalar       *y;
3124a2a386eSRichard Tran Mills   const MatScalar   *aa;
3134a2a386eSRichard Tran Mills   PetscErrorCode    ierr;
3144a2a386eSRichard Tran Mills   PetscInt          m=A->rmap->n;
315db63039fSRichard Tran Mills   PetscInt          n=A->cmap->n;
316db63039fSRichard Tran Mills   PetscScalar       alpha = 1.0;
317db63039fSRichard Tran Mills   PetscScalar       beta = 0.0;
3184a2a386eSRichard Tran Mills   const PetscInt    *aj,*ai;
319db63039fSRichard Tran Mills   char              matdescra[6];
320db63039fSRichard Tran Mills 
3214a2a386eSRichard Tran Mills 
3224a2a386eSRichard Tran Mills   /* Variables not in MatMult_SeqAIJ. */
323ff03dc53SRichard Tran Mills   char transa = 'n';  /* Used to indicate to MKL that we are not computing the transpose product. */
324ff03dc53SRichard Tran Mills 
325ff03dc53SRichard Tran Mills   PetscFunctionBegin;
326db63039fSRichard Tran Mills   matdescra[0] = 'g';  /* Indicates to MKL that we using a general CSR matrix. */
327db63039fSRichard Tran Mills   matdescra[3] = 'c';  /* Indicates to MKL that we use C-style (0-based) indexing. */
328ff03dc53SRichard Tran Mills   ierr = VecGetArrayRead(xx,&x);CHKERRQ(ierr);
329ff03dc53SRichard Tran Mills   ierr = VecGetArray(yy,&y);CHKERRQ(ierr);
330ff03dc53SRichard Tran Mills   aj   = a->j;  /* aj[k] gives column index for element aa[k]. */
331ff03dc53SRichard Tran Mills   aa   = a->a;  /* Nonzero elements stored row-by-row. */
332ff03dc53SRichard Tran Mills   ai   = a->i;  /* ai[k] is the position in aa and aj where row k starts. */
333ff03dc53SRichard Tran Mills 
334ff03dc53SRichard Tran Mills   /* Call MKL sparse BLAS routine to do the MatMult. */
335db63039fSRichard Tran Mills   mkl_xcsrmv(&transa,&m,&n,&alpha,matdescra,aa,aj,ai,ai+1,x,&beta,y);
336ff03dc53SRichard Tran Mills 
337ff03dc53SRichard Tran Mills   ierr = PetscLogFlops(2.0*a->nz - a->nonzerorowcnt);CHKERRQ(ierr);
338ff03dc53SRichard Tran Mills   ierr = VecRestoreArrayRead(xx,&x);CHKERRQ(ierr);
339ff03dc53SRichard Tran Mills   ierr = VecRestoreArray(yy,&y);CHKERRQ(ierr);
340ff03dc53SRichard Tran Mills   PetscFunctionReturn(0);
341ff03dc53SRichard Tran Mills }
342ff03dc53SRichard Tran Mills 
343d995685eSRichard Tran Mills #ifdef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
344df555b71SRichard Tran Mills PetscErrorCode MatMult_SeqAIJMKL_SpMV2(Mat A,Vec xx,Vec yy)
345df555b71SRichard Tran Mills {
346df555b71SRichard Tran Mills   Mat_SeqAIJ        *a = (Mat_SeqAIJ*)A->data;
347df555b71SRichard Tran Mills   Mat_SeqAIJMKL     *aijmkl=(Mat_SeqAIJMKL*)A->spptr;
348df555b71SRichard Tran Mills   const PetscScalar *x;
349df555b71SRichard Tran Mills   PetscScalar       *y;
350df555b71SRichard Tran Mills   PetscErrorCode    ierr;
351df555b71SRichard Tran Mills   sparse_status_t stat = SPARSE_STATUS_SUCCESS;
352df555b71SRichard Tran Mills 
353df555b71SRichard Tran Mills   PetscFunctionBegin;
354df555b71SRichard Tran Mills 
35538987b35SRichard Tran Mills   /* If there are no nonzero entries, zero yy and return immediately. */
35638987b35SRichard Tran Mills   if(!a->nz) {
35738987b35SRichard Tran Mills     PetscInt i;
35838987b35SRichard Tran Mills     PetscInt m=A->rmap->n;
35938987b35SRichard Tran Mills     ierr = VecGetArray(yy,&y);CHKERRQ(ierr);
36038987b35SRichard Tran Mills     for (i=0; i<m; i++) {
36138987b35SRichard Tran Mills       y[i] = 0.0;
36238987b35SRichard Tran Mills     }
36338987b35SRichard Tran Mills     ierr = VecRestoreArray(yy,&y);CHKERRQ(ierr);
36438987b35SRichard Tran Mills     PetscFunctionReturn(0);
36538987b35SRichard Tran Mills   }
366f36dfe3fSRichard Tran Mills 
367df555b71SRichard Tran Mills   ierr = VecGetArrayRead(xx,&x);CHKERRQ(ierr);
368df555b71SRichard Tran Mills   ierr = VecGetArray(yy,&y);CHKERRQ(ierr);
369df555b71SRichard Tran Mills 
3703fa15762SRichard Tran Mills   /* In some cases, we get to this point without mkl_sparse_optimize() having been called, so we check and then call
3713fa15762SRichard Tran Mills    * it if needed. Eventually, when everything in PETSc is properly updating the matrix state, we should probably
3723fa15762SRichard Tran Mills    * take a "lazy" approach to creation/updating of the MKL matrix handle and plan to always do it here (when needed). */
3733fa15762SRichard Tran Mills   if (!aijmkl->sparse_optimized) {
3743fa15762SRichard Tran Mills     MatSeqAIJMKL_create_mkl_handle(A);
3753fa15762SRichard Tran Mills   }
3763fa15762SRichard Tran Mills 
377df555b71SRichard Tran Mills   /* Call MKL SpMV2 executor routine to do the MatMult. */
378df555b71SRichard Tran Mills   stat = mkl_sparse_x_mv(SPARSE_OPERATION_NON_TRANSPOSE,1.0,aijmkl->csrA,aijmkl->descr,x,0.0,y);
379df555b71SRichard Tran Mills 
380df555b71SRichard Tran Mills   ierr = PetscLogFlops(2.0*a->nz - a->nonzerorowcnt);CHKERRQ(ierr);
381df555b71SRichard Tran Mills   ierr = VecRestoreArrayRead(xx,&x);CHKERRQ(ierr);
382df555b71SRichard Tran Mills   ierr = VecRestoreArray(yy,&y);CHKERRQ(ierr);
383df555b71SRichard Tran Mills   if (stat != SPARSE_STATUS_SUCCESS) {
384df555b71SRichard Tran Mills     PetscFunctionReturn(PETSC_ERR_LIB);
385df555b71SRichard Tran Mills   }
386df555b71SRichard Tran Mills   PetscFunctionReturn(0);
387df555b71SRichard Tran Mills }
388d995685eSRichard Tran Mills #endif /* PETSC_HAVE_MKL_SPARSE_OPTIMIZE */
389df555b71SRichard Tran Mills 
390ff03dc53SRichard Tran Mills PetscErrorCode MatMultTranspose_SeqAIJMKL(Mat A,Vec xx,Vec yy)
391ff03dc53SRichard Tran Mills {
392ff03dc53SRichard Tran Mills   Mat_SeqAIJ        *a = (Mat_SeqAIJ*)A->data;
393ff03dc53SRichard Tran Mills   const PetscScalar *x;
394ff03dc53SRichard Tran Mills   PetscScalar       *y;
395ff03dc53SRichard Tran Mills   const MatScalar   *aa;
396ff03dc53SRichard Tran Mills   PetscErrorCode    ierr;
397ff03dc53SRichard Tran Mills   PetscInt          m=A->rmap->n;
398db63039fSRichard Tran Mills   PetscInt          n=A->cmap->n;
399db63039fSRichard Tran Mills   PetscScalar       alpha = 1.0;
400db63039fSRichard Tran Mills   PetscScalar       beta = 0.0;
401ff03dc53SRichard Tran Mills   const PetscInt    *aj,*ai;
402db63039fSRichard Tran Mills   char              matdescra[6];
403ff03dc53SRichard Tran Mills 
404ff03dc53SRichard Tran Mills   /* Variables not in MatMultTranspose_SeqAIJ. */
405ff03dc53SRichard Tran Mills   char transa = 't';  /* Used to indicate to MKL that we are computing the transpose product. */
4064a2a386eSRichard Tran Mills 
4074a2a386eSRichard Tran Mills   PetscFunctionBegin;
408969800c5SRichard Tran Mills   matdescra[0] = 'g';  /* Indicates to MKL that we using a general CSR matrix. */
409969800c5SRichard Tran Mills   matdescra[3] = 'c';  /* Indicates to MKL that we use C-style (0-based) indexing. */
4104a2a386eSRichard Tran Mills   ierr = VecGetArrayRead(xx,&x);CHKERRQ(ierr);
4114a2a386eSRichard Tran Mills   ierr = VecGetArray(yy,&y);CHKERRQ(ierr);
4124a2a386eSRichard Tran Mills   aj   = a->j;  /* aj[k] gives column index for element aa[k]. */
4134a2a386eSRichard Tran Mills   aa   = a->a;  /* Nonzero elements stored row-by-row. */
4144a2a386eSRichard Tran Mills   ai   = a->i;  /* ai[k] is the position in aa and aj where row k starts. */
4154a2a386eSRichard Tran Mills 
4164a2a386eSRichard Tran Mills   /* Call MKL sparse BLAS routine to do the MatMult. */
417db63039fSRichard Tran Mills   mkl_xcsrmv(&transa,&m,&n,&alpha,matdescra,aa,aj,ai,ai+1,x,&beta,y);
4184a2a386eSRichard Tran Mills 
4194a2a386eSRichard Tran Mills   ierr = PetscLogFlops(2.0*a->nz - a->nonzerorowcnt);CHKERRQ(ierr);
4204a2a386eSRichard Tran Mills   ierr = VecRestoreArrayRead(xx,&x);CHKERRQ(ierr);
4214a2a386eSRichard Tran Mills   ierr = VecRestoreArray(yy,&y);CHKERRQ(ierr);
4224a2a386eSRichard Tran Mills   PetscFunctionReturn(0);
4234a2a386eSRichard Tran Mills }
4244a2a386eSRichard Tran Mills 
425d995685eSRichard Tran Mills #ifdef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
426df555b71SRichard Tran Mills PetscErrorCode MatMultTranspose_SeqAIJMKL_SpMV2(Mat A,Vec xx,Vec yy)
427df555b71SRichard Tran Mills {
428df555b71SRichard Tran Mills   Mat_SeqAIJ        *a = (Mat_SeqAIJ*)A->data;
429df555b71SRichard Tran Mills   Mat_SeqAIJMKL     *aijmkl=(Mat_SeqAIJMKL*)A->spptr;
430df555b71SRichard Tran Mills   const PetscScalar *x;
431df555b71SRichard Tran Mills   PetscScalar       *y;
432df555b71SRichard Tran Mills   PetscErrorCode    ierr;
4330632b357SRichard Tran Mills   sparse_status_t   stat;
434df555b71SRichard Tran Mills 
435df555b71SRichard Tran Mills   PetscFunctionBegin;
436df555b71SRichard Tran Mills 
43738987b35SRichard Tran Mills   /* If there are no nonzero entries, zero yy and return immediately. */
43838987b35SRichard Tran Mills   if(!a->nz) {
43938987b35SRichard Tran Mills     PetscInt i;
44038987b35SRichard Tran Mills     PetscInt n=A->cmap->n;
44138987b35SRichard Tran Mills     ierr = VecGetArray(yy,&y);CHKERRQ(ierr);
44238987b35SRichard Tran Mills     for (i=0; i<n; i++) {
44338987b35SRichard Tran Mills       y[i] = 0.0;
44438987b35SRichard Tran Mills     }
44538987b35SRichard Tran Mills     ierr = VecRestoreArray(yy,&y);CHKERRQ(ierr);
44638987b35SRichard Tran Mills     PetscFunctionReturn(0);
44738987b35SRichard Tran Mills   }
448f36dfe3fSRichard Tran Mills 
449df555b71SRichard Tran Mills   ierr = VecGetArrayRead(xx,&x);CHKERRQ(ierr);
450df555b71SRichard Tran Mills   ierr = VecGetArray(yy,&y);CHKERRQ(ierr);
451df555b71SRichard Tran Mills 
4523fa15762SRichard Tran Mills   /* In some cases, we get to this point without mkl_sparse_optimize() having been called, so we check and then call
4533fa15762SRichard Tran Mills    * it if needed. Eventually, when everything in PETSc is properly updating the matrix state, we should probably
4543fa15762SRichard Tran Mills    * take a "lazy" approach to creation/updating of the MKL matrix handle and plan to always do it here (when needed). */
4553fa15762SRichard Tran Mills   if (!aijmkl->sparse_optimized) {
4563fa15762SRichard Tran Mills     MatSeqAIJMKL_create_mkl_handle(A);
4573fa15762SRichard Tran Mills   }
4583fa15762SRichard Tran Mills 
459df555b71SRichard Tran Mills   /* Call MKL SpMV2 executor routine to do the MatMultTranspose. */
460df555b71SRichard Tran Mills   stat = mkl_sparse_x_mv(SPARSE_OPERATION_TRANSPOSE,1.0,aijmkl->csrA,aijmkl->descr,x,0.0,y);
461df555b71SRichard Tran Mills 
462df555b71SRichard Tran Mills   ierr = PetscLogFlops(2.0*a->nz - a->nonzerorowcnt);CHKERRQ(ierr);
463df555b71SRichard Tran Mills   ierr = VecRestoreArrayRead(xx,&x);CHKERRQ(ierr);
464df555b71SRichard Tran Mills   ierr = VecRestoreArray(yy,&y);CHKERRQ(ierr);
465df555b71SRichard Tran Mills   if (stat != SPARSE_STATUS_SUCCESS) {
466df555b71SRichard Tran Mills     PetscFunctionReturn(PETSC_ERR_LIB);
467df555b71SRichard Tran Mills   }
468df555b71SRichard Tran Mills   PetscFunctionReturn(0);
469df555b71SRichard Tran Mills }
470d995685eSRichard Tran Mills #endif /* PETSC_HAVE_MKL_SPARSE_OPTIMIZE */
471df555b71SRichard Tran Mills 
4724a2a386eSRichard Tran Mills PetscErrorCode MatMultAdd_SeqAIJMKL(Mat A,Vec xx,Vec yy,Vec zz)
4734a2a386eSRichard Tran Mills {
4744a2a386eSRichard Tran Mills   Mat_SeqAIJ        *a = (Mat_SeqAIJ*)A->data;
4754a2a386eSRichard Tran Mills   const PetscScalar *x;
4764a2a386eSRichard Tran Mills   PetscScalar       *y,*z;
4774a2a386eSRichard Tran Mills   const MatScalar   *aa;
4784a2a386eSRichard Tran Mills   PetscErrorCode    ierr;
4794a2a386eSRichard Tran Mills   PetscInt          m=A->rmap->n;
480db63039fSRichard Tran Mills   PetscInt          n=A->cmap->n;
4814a2a386eSRichard Tran Mills   const PetscInt    *aj,*ai;
4824a2a386eSRichard Tran Mills   PetscInt          i;
4834a2a386eSRichard Tran Mills 
484ff03dc53SRichard Tran Mills   /* Variables not in MatMultAdd_SeqAIJ. */
485ff03dc53SRichard Tran Mills   char transa = 'n';  /* Used to indicate to MKL that we are not computing the transpose product. */
486a84739b8SRichard Tran Mills   PetscScalar       alpha = 1.0;
487db63039fSRichard Tran Mills   PetscScalar       beta;
488a84739b8SRichard Tran Mills   char              matdescra[6];
489ff03dc53SRichard Tran Mills 
490ff03dc53SRichard Tran Mills   PetscFunctionBegin;
491a84739b8SRichard Tran Mills   matdescra[0] = 'g';  /* Indicates to MKL that we using a general CSR matrix. */
492a84739b8SRichard Tran Mills   matdescra[3] = 'c';  /* Indicates to MKL that we use C-style (0-based) indexing. */
493a84739b8SRichard Tran Mills 
494ff03dc53SRichard Tran Mills   ierr = VecGetArrayRead(xx,&x);CHKERRQ(ierr);
495ff03dc53SRichard Tran Mills   ierr = VecGetArrayPair(yy,zz,&y,&z);CHKERRQ(ierr);
496ff03dc53SRichard Tran Mills   aj   = a->j;  /* aj[k] gives column index for element aa[k]. */
497ff03dc53SRichard Tran Mills   aa   = a->a;  /* Nonzero elements stored row-by-row. */
498ff03dc53SRichard Tran Mills   ai   = a->i;  /* ai[k] is the position in aa and aj where row k starts. */
499ff03dc53SRichard Tran Mills 
500ff03dc53SRichard Tran Mills   /* Call MKL sparse BLAS routine to do the MatMult. */
501a84739b8SRichard Tran Mills   if (zz == yy) {
502a84739b8SRichard Tran Mills     /* If zz and yy are the same vector, we can use MKL's mkl_xcsrmv(), which calculates y = alpha*A*x + beta*y. */
503db63039fSRichard Tran Mills     beta = 1.0;
504db63039fSRichard Tran Mills     mkl_xcsrmv(&transa,&m,&n,&alpha,matdescra,aa,aj,ai,ai+1,x,&beta,z);
505a84739b8SRichard Tran Mills   } else {
506db63039fSRichard Tran Mills     /* zz and yy are different vectors, so call MKL's mkl_xcsrmv() with beta=0, then add the result to z.
507db63039fSRichard Tran Mills      * MKL sparse BLAS does not have a MatMultAdd equivalent. */
508db63039fSRichard Tran Mills     beta = 0.0;
509db63039fSRichard Tran Mills     mkl_xcsrmv(&transa,&m,&n,&alpha,matdescra,aa,aj,ai,ai+1,x,&beta,z);
510ff03dc53SRichard Tran Mills     for (i=0; i<m; i++) {
511ff03dc53SRichard Tran Mills       z[i] += y[i];
512ff03dc53SRichard Tran Mills     }
513a84739b8SRichard Tran Mills   }
514ff03dc53SRichard Tran Mills 
515ff03dc53SRichard Tran Mills   ierr = PetscLogFlops(2.0*a->nz);CHKERRQ(ierr);
516ff03dc53SRichard Tran Mills   ierr = VecRestoreArrayRead(xx,&x);CHKERRQ(ierr);
517ff03dc53SRichard Tran Mills   ierr = VecRestoreArrayPair(yy,zz,&y,&z);CHKERRQ(ierr);
518ff03dc53SRichard Tran Mills   PetscFunctionReturn(0);
519ff03dc53SRichard Tran Mills }
520ff03dc53SRichard Tran Mills 
521d995685eSRichard Tran Mills #ifdef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
522df555b71SRichard Tran Mills PetscErrorCode MatMultAdd_SeqAIJMKL_SpMV2(Mat A,Vec xx,Vec yy,Vec zz)
523df555b71SRichard Tran Mills {
524df555b71SRichard Tran Mills   Mat_SeqAIJ        *a = (Mat_SeqAIJ*)A->data;
525df555b71SRichard Tran Mills   Mat_SeqAIJMKL     *aijmkl=(Mat_SeqAIJMKL*)A->spptr;
526df555b71SRichard Tran Mills   const PetscScalar *x;
527df555b71SRichard Tran Mills   PetscScalar       *y,*z;
528df555b71SRichard Tran Mills   PetscErrorCode    ierr;
529df555b71SRichard Tran Mills   PetscInt          m=A->rmap->n;
530df555b71SRichard Tran Mills   PetscInt          i;
531df555b71SRichard Tran Mills 
532df555b71SRichard Tran Mills   /* Variables not in MatMultAdd_SeqAIJ. */
533df555b71SRichard Tran Mills   sparse_status_t stat = SPARSE_STATUS_SUCCESS;
534df555b71SRichard Tran Mills 
535df555b71SRichard Tran Mills   PetscFunctionBegin;
536df555b71SRichard Tran Mills 
53738987b35SRichard Tran Mills   /* If there are no nonzero entries, set zz = yy and return immediately. */
53838987b35SRichard Tran Mills   if(!a->nz) {
53938987b35SRichard Tran Mills     PetscInt i;
54038987b35SRichard Tran Mills     ierr = VecGetArrayPair(yy,zz,&y,&z);CHKERRQ(ierr);
54138987b35SRichard Tran Mills     for (i=0; i<m; i++) {
54238987b35SRichard Tran Mills       z[i] = y[i];
54338987b35SRichard Tran Mills     }
54438987b35SRichard Tran Mills     ierr = VecRestoreArrayPair(yy,zz,&y,&z);CHKERRQ(ierr);
54538987b35SRichard Tran Mills     PetscFunctionReturn(0);
54638987b35SRichard Tran Mills   }
547df555b71SRichard Tran Mills 
548df555b71SRichard Tran Mills   ierr = VecGetArrayRead(xx,&x);CHKERRQ(ierr);
549df555b71SRichard Tran Mills   ierr = VecGetArrayPair(yy,zz,&y,&z);CHKERRQ(ierr);
550df555b71SRichard Tran Mills 
5513fa15762SRichard Tran Mills   /* In some cases, we get to this point without mkl_sparse_optimize() having been called, so we check and then call
5523fa15762SRichard Tran Mills    * it if needed. Eventually, when everything in PETSc is properly updating the matrix state, we should probably
5533fa15762SRichard Tran Mills    * take a "lazy" approach to creation/updating of the MKL matrix handle and plan to always do it here (when needed). */
5543fa15762SRichard Tran Mills   if (!aijmkl->sparse_optimized) {
5553fa15762SRichard Tran Mills     MatSeqAIJMKL_create_mkl_handle(A);
5563fa15762SRichard Tran Mills   }
5573fa15762SRichard Tran Mills 
558df555b71SRichard Tran Mills   /* Call MKL sparse BLAS routine to do the MatMult. */
559df555b71SRichard Tran Mills   if (zz == yy) {
560df555b71SRichard Tran Mills     /* If zz and yy are the same vector, we can use mkl_sparse_x_mv, which calculates y = alpha*A*x + beta*y,
561df555b71SRichard Tran Mills      * with alpha and beta both set to 1.0. */
562db63039fSRichard Tran Mills     stat = mkl_sparse_x_mv(SPARSE_OPERATION_NON_TRANSPOSE,1.0,aijmkl->csrA,aijmkl->descr,x,1.0,z);
563df555b71SRichard Tran Mills   } else {
564df555b71SRichard Tran Mills     /* zz and yy are different vectors, so we call mkl_sparse_x_mv with alpha=1.0 and beta=0.0, and then
565df555b71SRichard Tran Mills      * we add the contents of vector yy to the result; MKL sparse BLAS does not have a MatMultAdd equivalent. */
566db63039fSRichard Tran Mills     stat = mkl_sparse_x_mv(SPARSE_OPERATION_NON_TRANSPOSE,1.0,aijmkl->csrA,aijmkl->descr,x,0.0,z);
567df555b71SRichard Tran Mills     for (i=0; i<m; i++) {
568df555b71SRichard Tran Mills       z[i] += y[i];
569df555b71SRichard Tran Mills     }
570df555b71SRichard Tran Mills   }
571df555b71SRichard Tran Mills 
572df555b71SRichard Tran Mills   ierr = PetscLogFlops(2.0*a->nz);CHKERRQ(ierr);
573df555b71SRichard Tran Mills   ierr = VecRestoreArrayRead(xx,&x);CHKERRQ(ierr);
574df555b71SRichard Tran Mills   ierr = VecRestoreArrayPair(yy,zz,&y,&z);CHKERRQ(ierr);
575df555b71SRichard Tran Mills   if (stat != SPARSE_STATUS_SUCCESS) {
576df555b71SRichard Tran Mills     PetscFunctionReturn(PETSC_ERR_LIB);
577df555b71SRichard Tran Mills   }
578df555b71SRichard Tran Mills   PetscFunctionReturn(0);
579df555b71SRichard Tran Mills }
580d995685eSRichard Tran Mills #endif /* PETSC_HAVE_MKL_SPARSE_OPTIMIZE */
581df555b71SRichard Tran Mills 
582ff03dc53SRichard Tran Mills PetscErrorCode MatMultTransposeAdd_SeqAIJMKL(Mat A,Vec xx,Vec yy,Vec zz)
583ff03dc53SRichard Tran Mills {
584ff03dc53SRichard Tran Mills   Mat_SeqAIJ        *a = (Mat_SeqAIJ*)A->data;
585ff03dc53SRichard Tran Mills   const PetscScalar *x;
586ff03dc53SRichard Tran Mills   PetscScalar       *y,*z;
587ff03dc53SRichard Tran Mills   const MatScalar   *aa;
588ff03dc53SRichard Tran Mills   PetscErrorCode    ierr;
589ff03dc53SRichard Tran Mills   PetscInt          m=A->rmap->n;
590db63039fSRichard Tran Mills   PetscInt          n=A->cmap->n;
591ff03dc53SRichard Tran Mills   const PetscInt    *aj,*ai;
592ff03dc53SRichard Tran Mills   PetscInt          i;
593ff03dc53SRichard Tran Mills 
594ff03dc53SRichard Tran Mills   /* Variables not in MatMultTransposeAdd_SeqAIJ. */
595ff03dc53SRichard Tran Mills   char transa = 't';  /* Used to indicate to MKL that we are computing the transpose product. */
596a84739b8SRichard Tran Mills   PetscScalar       alpha = 1.0;
597db63039fSRichard Tran Mills   PetscScalar       beta;
598a84739b8SRichard Tran Mills   char              matdescra[6];
5994a2a386eSRichard Tran Mills 
6004a2a386eSRichard Tran Mills   PetscFunctionBegin;
601a84739b8SRichard Tran Mills   matdescra[0] = 'g';  /* Indicates to MKL that we using a general CSR matrix. */
602a84739b8SRichard Tran Mills   matdescra[3] = 'c';  /* Indicates to MKL that we use C-style (0-based) indexing. */
603a84739b8SRichard Tran Mills 
6044a2a386eSRichard Tran Mills   ierr = VecGetArrayRead(xx,&x);CHKERRQ(ierr);
6054a2a386eSRichard Tran Mills   ierr = VecGetArrayPair(yy,zz,&y,&z);CHKERRQ(ierr);
6064a2a386eSRichard Tran Mills   aj   = a->j;  /* aj[k] gives column index for element aa[k]. */
6074a2a386eSRichard Tran Mills   aa   = a->a;  /* Nonzero elements stored row-by-row. */
6084a2a386eSRichard Tran Mills   ai   = a->i;  /* ai[k] is the position in aa and aj where row k starts. */
6094a2a386eSRichard Tran Mills 
6104a2a386eSRichard Tran Mills   /* Call MKL sparse BLAS routine to do the MatMult. */
611a84739b8SRichard Tran Mills   if (zz == yy) {
612a84739b8SRichard Tran Mills     /* If zz and yy are the same vector, we can use MKL's mkl_xcsrmv(), which calculates y = alpha*A*x + beta*y. */
613db63039fSRichard Tran Mills     beta = 1.0;
614969800c5SRichard Tran Mills     mkl_xcsrmv(&transa,&m,&n,&alpha,matdescra,aa,aj,ai,ai+1,x,&beta,z);
615a84739b8SRichard Tran Mills   } else {
616db63039fSRichard Tran Mills     /* zz and yy are different vectors, so call MKL's mkl_xcsrmv() with beta=0, then add the result to z.
617db63039fSRichard Tran Mills      * MKL sparse BLAS does not have a MatMultAdd equivalent. */
618db63039fSRichard Tran Mills     beta = 0.0;
619db63039fSRichard Tran Mills     mkl_xcsrmv(&transa,&m,&n,&alpha,matdescra,aa,aj,ai,ai+1,x,&beta,z);
620969800c5SRichard Tran Mills     for (i=0; i<n; i++) {
6214a2a386eSRichard Tran Mills       z[i] += y[i];
6224a2a386eSRichard Tran Mills     }
623a84739b8SRichard Tran Mills   }
6244a2a386eSRichard Tran Mills 
6254a2a386eSRichard Tran Mills   ierr = PetscLogFlops(2.0*a->nz);CHKERRQ(ierr);
6264a2a386eSRichard Tran Mills   ierr = VecRestoreArrayRead(xx,&x);CHKERRQ(ierr);
6274a2a386eSRichard Tran Mills   ierr = VecRestoreArrayPair(yy,zz,&y,&z);CHKERRQ(ierr);
6284a2a386eSRichard Tran Mills   PetscFunctionReturn(0);
6294a2a386eSRichard Tran Mills }
6304a2a386eSRichard Tran Mills 
631d995685eSRichard Tran Mills #ifdef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
632df555b71SRichard Tran Mills PetscErrorCode MatMultTransposeAdd_SeqAIJMKL_SpMV2(Mat A,Vec xx,Vec yy,Vec zz)
633df555b71SRichard Tran Mills {
634df555b71SRichard Tran Mills   Mat_SeqAIJ        *a = (Mat_SeqAIJ*)A->data;
635df555b71SRichard Tran Mills   Mat_SeqAIJMKL     *aijmkl=(Mat_SeqAIJMKL*)A->spptr;
636df555b71SRichard Tran Mills   const PetscScalar *x;
637df555b71SRichard Tran Mills   PetscScalar       *y,*z;
638df555b71SRichard Tran Mills   PetscErrorCode    ierr;
639969800c5SRichard Tran Mills   PetscInt          n=A->cmap->n;
640df555b71SRichard Tran Mills   PetscInt          i;
641df555b71SRichard Tran Mills 
642df555b71SRichard Tran Mills   /* Variables not in MatMultTransposeAdd_SeqAIJ. */
643df555b71SRichard Tran Mills   sparse_status_t stat = SPARSE_STATUS_SUCCESS;
644df555b71SRichard Tran Mills 
645df555b71SRichard Tran Mills   PetscFunctionBegin;
646df555b71SRichard Tran Mills 
64738987b35SRichard Tran Mills   /* If there are no nonzero entries, set zz = yy and return immediately. */
64838987b35SRichard Tran Mills   if(!a->nz) {
64938987b35SRichard Tran Mills     PetscInt i;
65038987b35SRichard Tran Mills     ierr = VecGetArrayPair(yy,zz,&y,&z);CHKERRQ(ierr);
65138987b35SRichard Tran Mills     for (i=0; i<n; i++) {
65238987b35SRichard Tran Mills       z[i] = y[i];
65338987b35SRichard Tran Mills     }
65438987b35SRichard Tran Mills     ierr = VecRestoreArrayPair(yy,zz,&y,&z);CHKERRQ(ierr);
65538987b35SRichard Tran Mills     PetscFunctionReturn(0);
65638987b35SRichard Tran Mills   }
657f36dfe3fSRichard Tran Mills 
658df555b71SRichard Tran Mills   ierr = VecGetArrayRead(xx,&x);CHKERRQ(ierr);
659df555b71SRichard Tran Mills   ierr = VecGetArrayPair(yy,zz,&y,&z);CHKERRQ(ierr);
660df555b71SRichard Tran Mills 
6613fa15762SRichard Tran Mills   /* In some cases, we get to this point without mkl_sparse_optimize() having been called, so we check and then call
6623fa15762SRichard Tran Mills    * it if needed. Eventually, when everything in PETSc is properly updating the matrix state, we should probably
6633fa15762SRichard Tran Mills    * take a "lazy" approach to creation/updating of the MKL matrix handle and plan to always do it here (when needed). */
6643fa15762SRichard Tran Mills   if (!aijmkl->sparse_optimized) {
6653fa15762SRichard Tran Mills     MatSeqAIJMKL_create_mkl_handle(A);
6663fa15762SRichard Tran Mills   }
6673fa15762SRichard Tran Mills 
668df555b71SRichard Tran Mills   /* Call MKL sparse BLAS routine to do the MatMult. */
669df555b71SRichard Tran Mills   if (zz == yy) {
670df555b71SRichard Tran Mills     /* If zz and yy are the same vector, we can use mkl_sparse_x_mv, which calculates y = alpha*A*x + beta*y,
671df555b71SRichard Tran Mills      * with alpha and beta both set to 1.0. */
672db63039fSRichard Tran Mills     stat = mkl_sparse_x_mv(SPARSE_OPERATION_TRANSPOSE,1.0,aijmkl->csrA,aijmkl->descr,x,1.0,z);
673df555b71SRichard Tran Mills   } else {
674df555b71SRichard Tran Mills     /* zz and yy are different vectors, so we call mkl_sparse_x_mv with alpha=1.0 and beta=0.0, and then
675df555b71SRichard Tran Mills      * we add the contents of vector yy to the result; MKL sparse BLAS does not have a MatMultAdd equivalent. */
676db63039fSRichard Tran Mills     stat = mkl_sparse_x_mv(SPARSE_OPERATION_TRANSPOSE,1.0,aijmkl->csrA,aijmkl->descr,x,0.0,z);
677969800c5SRichard Tran Mills     for (i=0; i<n; i++) {
678df555b71SRichard Tran Mills       z[i] += y[i];
679df555b71SRichard Tran Mills     }
680df555b71SRichard Tran Mills   }
681df555b71SRichard Tran Mills 
682df555b71SRichard Tran Mills   ierr = PetscLogFlops(2.0*a->nz);CHKERRQ(ierr);
683df555b71SRichard Tran Mills   ierr = VecRestoreArrayRead(xx,&x);CHKERRQ(ierr);
684df555b71SRichard Tran Mills   ierr = VecRestoreArrayPair(yy,zz,&y,&z);CHKERRQ(ierr);
685df555b71SRichard Tran Mills   if (stat != SPARSE_STATUS_SUCCESS) {
686df555b71SRichard Tran Mills     PetscFunctionReturn(PETSC_ERR_LIB);
687df555b71SRichard Tran Mills   }
688df555b71SRichard Tran Mills   PetscFunctionReturn(0);
689df555b71SRichard Tran Mills }
690d995685eSRichard Tran Mills #endif /* PETSC_HAVE_MKL_SPARSE_OPTIMIZE */
691df555b71SRichard Tran Mills 
69245fbe478SRichard Tran Mills #ifdef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
69345fbe478SRichard Tran Mills PetscErrorCode MatMatMult_SeqAIJMKL_SeqAIJMKL_SpMV2(Mat A,Mat B,MatReuse scall,PetscReal fill,Mat*C)
69445fbe478SRichard Tran Mills {
69545fbe478SRichard Tran Mills   Mat_SeqAIJMKL *a, *b;
69645fbe478SRichard Tran Mills   sparse_matrix_t csrA, csrB, csrC;
69745fbe478SRichard Tran Mills   PetscErrorCode ierr;
69845fbe478SRichard Tran Mills   sparse_status_t stat = SPARSE_STATUS_SUCCESS;
69945fbe478SRichard Tran Mills 
70045fbe478SRichard Tran Mills   PetscFunctionBegin;
70145fbe478SRichard Tran Mills   a = (Mat_SeqAIJMKL*)A->spptr;
70245fbe478SRichard Tran Mills   b = (Mat_SeqAIJMKL*)B->spptr;
70345fbe478SRichard Tran Mills   if (!a->sparse_optimized) {
70445fbe478SRichard Tran Mills     MatSeqAIJMKL_create_mkl_handle(A);
70545fbe478SRichard Tran Mills   }
70645fbe478SRichard Tran Mills   if (!b->sparse_optimized) {
70745fbe478SRichard Tran Mills     MatSeqAIJMKL_create_mkl_handle(B);
70845fbe478SRichard Tran Mills   }
70945fbe478SRichard Tran Mills   csrA = a->csrA;
71045fbe478SRichard Tran Mills   csrB = b->csrA;
71145fbe478SRichard Tran Mills 
71245fbe478SRichard Tran Mills   stat = mkl_sparse_spmm(SPARSE_OPERATION_NON_TRANSPOSE,csrA,csrB,&csrC);
71345fbe478SRichard Tran Mills   if (stat != SPARSE_STATUS_SUCCESS) {
71445fbe478SRichard Tran Mills     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"Intel MKL error: unable to complete sparse matrix-matrix multiply");
71545fbe478SRichard Tran Mills     PetscFunctionReturn(PETSC_ERR_LIB);
71645fbe478SRichard Tran Mills   }
71745fbe478SRichard Tran Mills 
7186c87cf42SRichard Tran Mills   ierr = MatSeqAIJMKL_create_from_mkl_handle(PETSC_COMM_SELF,csrC,scall,C);CHKERRQ(ierr);
71945fbe478SRichard Tran Mills 
72045fbe478SRichard Tran Mills   PetscFunctionReturn(0);
72145fbe478SRichard Tran Mills }
72245fbe478SRichard Tran Mills #endif /* PETSC_HAVE_MKL_SPARSE_OPTIMIZE */
72345fbe478SRichard Tran Mills 
724*372ec6bbSRichard Tran Mills #ifdef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
725*372ec6bbSRichard Tran Mills PetscErrorCode MatTransposeMatMult_SeqAIJMKL_SeqAIJMKL_SpMV2(Mat A,Mat B,MatReuse scall,PetscReal fill,Mat*C)
726*372ec6bbSRichard Tran Mills {
727*372ec6bbSRichard Tran Mills   Mat_SeqAIJMKL *a, *b;
728*372ec6bbSRichard Tran Mills   sparse_matrix_t csrA, csrB, csrC;
729*372ec6bbSRichard Tran Mills   PetscErrorCode ierr;
730*372ec6bbSRichard Tran Mills   sparse_status_t stat = SPARSE_STATUS_SUCCESS;
731*372ec6bbSRichard Tran Mills 
732*372ec6bbSRichard Tran Mills   PetscFunctionBegin;
733*372ec6bbSRichard Tran Mills   a = (Mat_SeqAIJMKL*)A->spptr;
734*372ec6bbSRichard Tran Mills   b = (Mat_SeqAIJMKL*)B->spptr;
735*372ec6bbSRichard Tran Mills   if (!a->sparse_optimized) {
736*372ec6bbSRichard Tran Mills     MatSeqAIJMKL_create_mkl_handle(A);
737*372ec6bbSRichard Tran Mills   }
738*372ec6bbSRichard Tran Mills   if (!b->sparse_optimized) {
739*372ec6bbSRichard Tran Mills     MatSeqAIJMKL_create_mkl_handle(B);
740*372ec6bbSRichard Tran Mills   }
741*372ec6bbSRichard Tran Mills   csrA = a->csrA;
742*372ec6bbSRichard Tran Mills   csrB = b->csrA;
743*372ec6bbSRichard Tran Mills 
744*372ec6bbSRichard Tran Mills   stat = mkl_sparse_spmm(SPARSE_OPERATION_TRANSPOSE,csrA,csrB,&csrC);
745*372ec6bbSRichard Tran Mills   if (stat != SPARSE_STATUS_SUCCESS) {
746*372ec6bbSRichard Tran Mills     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"Intel MKL error: unable to complete sparse matrix-matrix multiply");
747*372ec6bbSRichard Tran Mills     PetscFunctionReturn(PETSC_ERR_LIB);
748*372ec6bbSRichard Tran Mills   }
749*372ec6bbSRichard Tran Mills 
750*372ec6bbSRichard Tran Mills   ierr = MatSeqAIJMKL_create_from_mkl_handle(PETSC_COMM_SELF,csrC,scall,C);CHKERRQ(ierr);
751*372ec6bbSRichard Tran Mills 
752*372ec6bbSRichard Tran Mills   PetscFunctionReturn(0);
753*372ec6bbSRichard Tran Mills }
754*372ec6bbSRichard Tran Mills #endif /* PETSC_HAVE_MKL_SPARSE_OPTIMIZE */
755*372ec6bbSRichard Tran Mills 
75687c2a1d7SRichard Tran Mills PetscErrorCode MatScale_SeqAIJMKL(Mat inA,PetscScalar alpha)
757db63039fSRichard Tran Mills {
758db63039fSRichard Tran Mills   PetscErrorCode ierr;
759db63039fSRichard Tran Mills 
76087c2a1d7SRichard Tran Mills   PetscFunctionBegin;
761db63039fSRichard Tran Mills   ierr = MatScale_SeqAIJ(inA,alpha);CHKERRQ(ierr);
762db63039fSRichard Tran Mills   ierr = MatSeqAIJMKL_create_mkl_handle(inA);CHKERRQ(ierr);
763db63039fSRichard Tran Mills   PetscFunctionReturn(0);
764db63039fSRichard Tran Mills }
765df555b71SRichard Tran Mills 
76687c2a1d7SRichard Tran Mills PetscErrorCode MatDiagonalScale_SeqAIJMKL(Mat A,Vec ll,Vec rr)
76787c2a1d7SRichard Tran Mills {
76887c2a1d7SRichard Tran Mills   PetscErrorCode ierr;
76987c2a1d7SRichard Tran Mills 
77087c2a1d7SRichard Tran Mills   PetscFunctionBegin;
77187c2a1d7SRichard Tran Mills   ierr = MatDiagonalScale_SeqAIJ(A,ll,rr);CHKERRQ(ierr);
77287c2a1d7SRichard Tran Mills   ierr = MatSeqAIJMKL_create_mkl_handle(A);CHKERRQ(ierr);
77387c2a1d7SRichard Tran Mills   PetscFunctionReturn(0);
77487c2a1d7SRichard Tran Mills }
77587c2a1d7SRichard Tran Mills 
77687c2a1d7SRichard Tran Mills PetscErrorCode MatDiagonalSet_SeqAIJMKL(Mat Y,Vec D,InsertMode is)
77787c2a1d7SRichard Tran Mills {
77887c2a1d7SRichard Tran Mills   PetscErrorCode ierr;
77987c2a1d7SRichard Tran Mills 
78087c2a1d7SRichard Tran Mills   PetscFunctionBegin;
78187c2a1d7SRichard Tran Mills   ierr = MatDiagonalSet_SeqAIJ(Y,D,is);CHKERRQ(ierr);
78287c2a1d7SRichard Tran Mills   ierr = MatSeqAIJMKL_create_mkl_handle(Y);CHKERRQ(ierr);
78387c2a1d7SRichard Tran Mills   PetscFunctionReturn(0);
78487c2a1d7SRichard Tran Mills }
78587c2a1d7SRichard Tran Mills 
78687c2a1d7SRichard Tran Mills PetscErrorCode MatAXPY_SeqAIJMKL(Mat Y,PetscScalar a,Mat X,MatStructure str)
78787c2a1d7SRichard Tran Mills {
78887c2a1d7SRichard Tran Mills   PetscErrorCode ierr;
78987c2a1d7SRichard Tran Mills 
79087c2a1d7SRichard Tran Mills   PetscFunctionBegin;
79187c2a1d7SRichard Tran Mills   ierr = MatAXPY_SeqAIJ(Y,a,X,str);CHKERRQ(ierr);
79287c2a1d7SRichard Tran Mills   if (str == SAME_NONZERO_PATTERN) {
79387c2a1d7SRichard Tran Mills     /* MatAssemblyEnd() is not called if SAME_NONZERO_PATTERN, so we need to force update of the MKL matrix handle. */
79487c2a1d7SRichard Tran Mills     ierr = MatSeqAIJMKL_create_mkl_handle(Y);CHKERRQ(ierr);
79587c2a1d7SRichard Tran Mills   }
79687c2a1d7SRichard Tran Mills   PetscFunctionReturn(0);
79787c2a1d7SRichard Tran Mills }
79887c2a1d7SRichard Tran Mills 
7994a2a386eSRichard Tran Mills /* MatConvert_SeqAIJ_SeqAIJMKL converts a SeqAIJ matrix into a
8004a2a386eSRichard Tran Mills  * SeqAIJMKL matrix.  This routine is called by the MatCreate_SeqMKLAIJ()
8014a2a386eSRichard Tran Mills  * routine, but can also be used to convert an assembled SeqAIJ matrix
8024a2a386eSRichard Tran Mills  * into a SeqAIJMKL one. */
8034a2a386eSRichard Tran Mills PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJMKL(Mat A,MatType type,MatReuse reuse,Mat *newmat)
8044a2a386eSRichard Tran Mills {
8054a2a386eSRichard Tran Mills   PetscErrorCode ierr;
8064a2a386eSRichard Tran Mills   Mat            B = *newmat;
8074a2a386eSRichard Tran Mills   Mat_SeqAIJMKL  *aijmkl;
808c9d46305SRichard Tran Mills   PetscBool      set;
809e9c94282SRichard Tran Mills   PetscBool      sametype;
8104a2a386eSRichard Tran Mills 
8114a2a386eSRichard Tran Mills   PetscFunctionBegin;
8124a2a386eSRichard Tran Mills   if (reuse == MAT_INITIAL_MATRIX) {
8134a2a386eSRichard Tran Mills     ierr = MatDuplicate(A,MAT_COPY_VALUES,&B);CHKERRQ(ierr);
8144a2a386eSRichard Tran Mills   }
8154a2a386eSRichard Tran Mills 
816e9c94282SRichard Tran Mills   ierr = PetscObjectTypeCompare((PetscObject)A,type,&sametype);CHKERRQ(ierr);
817e9c94282SRichard Tran Mills   if (sametype) PetscFunctionReturn(0);
818e9c94282SRichard Tran Mills 
8194a2a386eSRichard Tran Mills   ierr     = PetscNewLog(B,&aijmkl);CHKERRQ(ierr);
8204a2a386eSRichard Tran Mills   B->spptr = (void*) aijmkl;
8214a2a386eSRichard Tran Mills 
822df555b71SRichard Tran Mills   /* Set function pointers for methods that we inherit from AIJ but override.
823969800c5SRichard Tran Mills    * We also parse some command line options below, since those determine some of the methods we point to. */
8244a2a386eSRichard Tran Mills   B->ops->duplicate        = MatDuplicate_SeqAIJMKL;
8254a2a386eSRichard Tran Mills   B->ops->assemblyend      = MatAssemblyEnd_SeqAIJMKL;
8264a2a386eSRichard Tran Mills   B->ops->destroy          = MatDestroy_SeqAIJMKL;
827c9d46305SRichard Tran Mills 
8284abfa3b3SRichard Tran Mills   aijmkl->sparse_optimized = PETSC_FALSE;
829d995685eSRichard Tran Mills #ifdef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
830d995685eSRichard Tran Mills   aijmkl->no_SpMV2 = PETSC_FALSE;  /* Default to using the SpMV2 routines if our MKL supports them. */
831a8327b06SKarl Rupp #else
832d995685eSRichard Tran Mills   aijmkl->no_SpMV2 = PETSC_TRUE;
833d995685eSRichard Tran Mills #endif
8345b49642aSRichard Tran Mills   aijmkl->eager_inspection = PETSC_FALSE;
8354abfa3b3SRichard Tran Mills 
8364abfa3b3SRichard Tran Mills   /* Parse command line options. */
837c9d46305SRichard Tran Mills   ierr = PetscOptionsBegin(PetscObjectComm((PetscObject)A),((PetscObject)A)->prefix,"AIJMKL Options","Mat");CHKERRQ(ierr);
838c9d46305SRichard Tran Mills   ierr = PetscOptionsBool("-mat_aijmkl_no_spmv2","NoSPMV2","None",(PetscBool)aijmkl->no_SpMV2,(PetscBool*)&aijmkl->no_SpMV2,&set);CHKERRQ(ierr);
8395b49642aSRichard Tran Mills   ierr = PetscOptionsBool("-mat_aijmkl_eager_inspection","Eager Inspection","None",(PetscBool)aijmkl->eager_inspection,(PetscBool*)&aijmkl->eager_inspection,&set);CHKERRQ(ierr);
840c9d46305SRichard Tran Mills   ierr = PetscOptionsEnd();CHKERRQ(ierr);
841d995685eSRichard Tran Mills #ifndef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
842d995685eSRichard Tran Mills   if(!aijmkl->no_SpMV2) {
843d995685eSRichard Tran Mills     ierr = PetscInfo(B,"User requested use of MKL SpMV2 routines, but MKL version does not support mkl_sparse_optimize();  defaulting to non-SpMV2 routines.\n");
844d995685eSRichard Tran Mills     aijmkl->no_SpMV2 = PETSC_TRUE;
845d995685eSRichard Tran Mills   }
846d995685eSRichard Tran Mills #endif
847c9d46305SRichard Tran Mills 
848c9d46305SRichard Tran Mills   if(!aijmkl->no_SpMV2) {
849d995685eSRichard Tran Mills #ifdef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
850df555b71SRichard Tran Mills     B->ops->mult             = MatMult_SeqAIJMKL_SpMV2;
851969800c5SRichard Tran Mills     B->ops->multtranspose    = MatMultTranspose_SeqAIJMKL_SpMV2;
852df555b71SRichard Tran Mills     B->ops->multadd          = MatMultAdd_SeqAIJMKL_SpMV2;
853969800c5SRichard Tran Mills     B->ops->multtransposeadd = MatMultTransposeAdd_SeqAIJMKL_SpMV2;
85445fbe478SRichard Tran Mills     B->ops->matmult          = MatMatMult_SeqAIJMKL_SeqAIJMKL_SpMV2;
855*372ec6bbSRichard Tran Mills     B->ops->mattransposemult = MatTransposeMatMult_SeqAIJMKL_SeqAIJMKL_SpMV2;
856d995685eSRichard Tran Mills #endif
857c9d46305SRichard Tran Mills   } else {
8584a2a386eSRichard Tran Mills     B->ops->mult             = MatMult_SeqAIJMKL;
859969800c5SRichard Tran Mills     B->ops->multtranspose    = MatMultTranspose_SeqAIJMKL;
8604a2a386eSRichard Tran Mills     B->ops->multadd          = MatMultAdd_SeqAIJMKL;
861969800c5SRichard Tran Mills     B->ops->multtransposeadd = MatMultTransposeAdd_SeqAIJMKL;
862c9d46305SRichard Tran Mills   }
8634a2a386eSRichard Tran Mills 
864db63039fSRichard Tran Mills   B->ops->scale              = MatScale_SeqAIJMKL;
86587c2a1d7SRichard Tran Mills   B->ops->diagonalscale      = MatDiagonalScale_SeqAIJMKL;
86687c2a1d7SRichard Tran Mills   B->ops->diagonalset        = MatDiagonalSet_SeqAIJMKL;
86787c2a1d7SRichard Tran Mills   B->ops->axpy               = MatAXPY_SeqAIJMKL;
868db63039fSRichard Tran Mills 
869db63039fSRichard Tran Mills   ierr = PetscObjectComposeFunction((PetscObject)B,"MatScale_SeqAIJMKL_C",MatScale_SeqAIJMKL);CHKERRQ(ierr);
8704a2a386eSRichard Tran Mills   ierr = PetscObjectComposeFunction((PetscObject)B,"MatConvert_seqaijmkl_seqaij_C",MatConvert_SeqAIJMKL_SeqAIJ);CHKERRQ(ierr);
871e9c94282SRichard Tran Mills   ierr = PetscObjectComposeFunction((PetscObject)B,"MatMatMult_seqdense_seqaijmkl_C",MatMatMult_SeqDense_SeqAIJ);CHKERRQ(ierr);
872e9c94282SRichard Tran Mills   ierr = PetscObjectComposeFunction((PetscObject)B,"MatMatMultSymbolic_seqdense_seqaijmkl_C",MatMatMultSymbolic_SeqDense_SeqAIJ);CHKERRQ(ierr);
873e9c94282SRichard Tran Mills   ierr = PetscObjectComposeFunction((PetscObject)B,"MatMatMultNumeric_seqdense_seqaijmkl_C",MatMatMultNumeric_SeqDense_SeqAIJ);CHKERRQ(ierr);
87445fbe478SRichard Tran Mills   if(!aijmkl->no_SpMV2) {
87545fbe478SRichard Tran Mills #ifdef PETSC_HAVE_MKL_SPARSE_OPTIMIZE
87645fbe478SRichard Tran Mills     ierr = PetscObjectComposeFunction((PetscObject)B,"MatMatMult_seqaijmkl_seqaijmkl_C",MatMatMult_SeqAIJMKL_SeqAIJMKL_SpMV2);CHKERRQ(ierr);
877*372ec6bbSRichard Tran Mills     ierr = PetscObjectComposeFunction((PetscObject)B,"MatTransposeMatMult_seqaijmkl_seqaijmkl_C",MatTransposeMatMult_SeqAIJMKL_SeqAIJMKL_SpMV2);CHKERRQ(ierr);
87845fbe478SRichard Tran Mills #endif
87945fbe478SRichard Tran Mills   }
8804a2a386eSRichard Tran Mills 
8814a2a386eSRichard Tran Mills   ierr    = PetscObjectChangeTypeName((PetscObject)B,MATSEQAIJMKL);CHKERRQ(ierr);
8824a2a386eSRichard Tran Mills   *newmat = B;
8834a2a386eSRichard Tran Mills   PetscFunctionReturn(0);
8844a2a386eSRichard Tran Mills }
8854a2a386eSRichard Tran Mills 
8864a2a386eSRichard Tran Mills /*@C
8874a2a386eSRichard Tran Mills    MatCreateSeqAIJMKL - Creates a sparse matrix of type SEQAIJMKL.
8884a2a386eSRichard Tran Mills    This type inherits from AIJ and is largely identical, but uses sparse BLAS
8894a2a386eSRichard Tran Mills    routines from Intel MKL whenever possible.
89090147e49SRichard Tran Mills    MatMult, MatMultAdd, MatMultTranspose, and MatMultTransposeAdd
89190147e49SRichard Tran Mills    operations are currently supported.
89290147e49SRichard Tran Mills    If the installed version of MKL supports the "SpMV2" sparse
89390147e49SRichard Tran Mills    inspector-executor routines, then those are used by default.
89490147e49SRichard Tran Mills 
8954a2a386eSRichard Tran Mills    Collective on MPI_Comm
8964a2a386eSRichard Tran Mills 
8974a2a386eSRichard Tran Mills    Input Parameters:
8984a2a386eSRichard Tran Mills +  comm - MPI communicator, set to PETSC_COMM_SELF
8994a2a386eSRichard Tran Mills .  m - number of rows
9004a2a386eSRichard Tran Mills .  n - number of columns
9014a2a386eSRichard Tran Mills .  nz - number of nonzeros per row (same for all rows)
9024a2a386eSRichard Tran Mills -  nnz - array containing the number of nonzeros in the various rows
9034a2a386eSRichard Tran Mills          (possibly different for each row) or NULL
9044a2a386eSRichard Tran Mills 
9054a2a386eSRichard Tran Mills    Output Parameter:
9064a2a386eSRichard Tran Mills .  A - the matrix
9074a2a386eSRichard Tran Mills 
90890147e49SRichard Tran Mills    Options Database Keys:
90990147e49SRichard Tran Mills .  -mat_aijmkl_no_spmv2 - disables use of the SpMV2 inspector-executor routines
91090147e49SRichard Tran Mills 
9114a2a386eSRichard Tran Mills    Notes:
9124a2a386eSRichard Tran Mills    If nnz is given then nz is ignored
9134a2a386eSRichard Tran Mills 
9144a2a386eSRichard Tran Mills    Level: intermediate
9154a2a386eSRichard Tran Mills 
91690147e49SRichard Tran Mills .keywords: matrix, MKL, sparse, parallel
9174a2a386eSRichard Tran Mills 
9184a2a386eSRichard Tran Mills .seealso: MatCreate(), MatCreateMPIAIJMKL(), MatSetValues()
9194a2a386eSRichard Tran Mills @*/
9204a2a386eSRichard Tran Mills PetscErrorCode  MatCreateSeqAIJMKL(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[],Mat *A)
9214a2a386eSRichard Tran Mills {
9224a2a386eSRichard Tran Mills   PetscErrorCode ierr;
9234a2a386eSRichard Tran Mills 
9244a2a386eSRichard Tran Mills   PetscFunctionBegin;
9254a2a386eSRichard Tran Mills   ierr = MatCreate(comm,A);CHKERRQ(ierr);
9264a2a386eSRichard Tran Mills   ierr = MatSetSizes(*A,m,n,m,n);CHKERRQ(ierr);
9274a2a386eSRichard Tran Mills   ierr = MatSetType(*A,MATSEQAIJMKL);CHKERRQ(ierr);
9284a2a386eSRichard Tran Mills   ierr = MatSeqAIJSetPreallocation_SeqAIJ(*A,nz,nnz);CHKERRQ(ierr);
9294a2a386eSRichard Tran Mills   PetscFunctionReturn(0);
9304a2a386eSRichard Tran Mills }
9314a2a386eSRichard Tran Mills 
9324a2a386eSRichard Tran Mills PETSC_EXTERN PetscErrorCode MatCreate_SeqAIJMKL(Mat A)
9334a2a386eSRichard Tran Mills {
9344a2a386eSRichard Tran Mills   PetscErrorCode ierr;
9354a2a386eSRichard Tran Mills 
9364a2a386eSRichard Tran Mills   PetscFunctionBegin;
9374a2a386eSRichard Tran Mills   ierr = MatSetType(A,MATSEQAIJ);CHKERRQ(ierr);
9384a2a386eSRichard Tran Mills   ierr = MatConvert_SeqAIJ_SeqAIJMKL(A,MATSEQAIJMKL,MAT_INPLACE_MATRIX,&A);CHKERRQ(ierr);
9394a2a386eSRichard Tran Mills   PetscFunctionReturn(0);
9404a2a386eSRichard Tran Mills }
941