xref: /petsc/src/mat/impls/aij/mpi/pastix/pastix.c (revision b09c0905e0400a6d0e50b04b96aaa5afc8b9512d)
1 #define PETSCMAT_DLL
2 
3 /*
4     Provides an interface to the PaStiX sparse solver
5 */
6 #include "../src/mat/impls/aij/seq/aij.h"
7 #include "../src/mat/impls/aij/mpi/mpiaij.h"
8 #include "../src/mat/impls/sbaij/seq/sbaij.h"
9 #include "../src/mat/impls/sbaij/mpi/mpisbaij.h"
10 
11 #if defined(PETSC_HAVE_STDLIB_H)
12 #include <stdlib.h>
13 #endif
14 #if defined(PETSC_HAVE_STRING_H)
15 #include <string.h>
16 #endif
17 
18 EXTERN_C_BEGIN
19 #include "pastix.h"
20 EXTERN_C_END
21 
22 typedef struct Mat_Pastix_ {
23   pastix_data_t *pastix_data;              /* Pastix data storage structure                        */
24   MatStructure   matstruc;
25   PetscInt       n;                        /* Number of columns in the matrix                      */
26   PetscInt       *colptr;                  /* Index of first element of each column in row and val */
27   PetscInt       *row;                     /* Row of each element of the matrix                    */
28   PetscScalar    *val;                     /* Value of each element of the matrix                  */
29   PetscInt       *perm;                    /* Permutation tabular                                  */
30   PetscInt       *invp;                    /* Reverse permutation tabular                          */
31   PetscScalar    *rhs;                     /* Rhight-hand-side member                              */
32   PetscInt       rhsnbr;                   /* Rhight-hand-side number (must be 1)                  */
33   PetscInt       iparm[64];                /* Integer parameters                                   */
34   double         dparm[64];                /* Floating point parameters                            */
35   MPI_Comm       pastix_comm;              /* PaStiX MPI communicator                              */
36   PetscMPIInt    commRank;                 /* MPI rank                                             */
37   PetscMPIInt    commSize;                 /* MPI communicator size                                */
38   PetscTruth     CleanUpPastix;            /* Boolean indicating if we call PaStiX clean step      */
39   VecScatter     scat_rhs;
40   VecScatter     scat_sol;
41   Vec            b_seq;
42   PetscTruth     isAIJ;
43   PetscErrorCode (*MatDestroy)(Mat);
44 } Mat_Pastix;
45 
46 EXTERN PetscErrorCode MatDuplicate_Pastix(Mat,MatDuplicateOption,Mat*);
47 
48 #undef __FUNCT__
49 #define __FUNCT__ "MatConvertToCSC"
50 /*
51    convert Petsc seqaij matrix to CSC: colptr[n], row[nz], val[nz]
52 
53   input:
54     A       - matrix in seqaij or mpisbaij (bs=1) format
55     valOnly - FALSE: spaces are allocated and values are set for the CSC
56               TRUE:  Only fill values
57   output:
58     n       - Size of the matrix
59     colptr  - Index of first element of each column in row and val
60     row     - Row of each element of the matrix
61     values  - Value of each element of the matrix
62  */
63 PetscErrorCode MatConvertToCSC(Mat A,PetscTruth valOnly,PetscInt *n,PetscInt **colptr,PetscInt **row,PetscScalar **values)
64 {
65   Mat_SeqAIJ     *aa      = (Mat_SeqAIJ*)A->data;
66   PetscInt       *rowptr  = aa->i;
67   PetscInt       *col     = aa->j;
68   PetscScalar    *rvalues = aa->a;
69   PetscInt        m       = A->rmap->N;
70   PetscInt        nnz;
71   PetscInt        i,j, k;
72   PetscInt        base = 1;
73   PetscInt        idx;
74   PetscErrorCode  ierr;
75   PetscInt        colidx;
76   PetscInt       *colcount;
77   PetscTruth      isSBAIJ;
78   PetscTruth      isSeqSBAIJ;
79   PetscTruth      isMpiSBAIJ;
80   PetscTruth      isSym;
81 
82   PetscFunctionBegin;
83   ierr = MatIsSymmetric(A,0.0,&isSym);CHKERRQ(ierr);
84   ierr = PetscTypeCompare((PetscObject)A,MATSBAIJ,&isSBAIJ);CHKERRQ(ierr);
85   ierr = PetscTypeCompare((PetscObject)A,MATSEQSBAIJ,&isSeqSBAIJ);CHKERRQ(ierr);
86   ierr = PetscTypeCompare((PetscObject)A,MATMPISBAIJ,&isMpiSBAIJ);CHKERRQ(ierr);
87 
88   *n = A->cmap->N;
89 
90   /* PaStiX only needs triangular matrix if matrix is symmetric
91    */
92   if (isSym && !(isSBAIJ || isSeqSBAIJ || isMpiSBAIJ)) {
93     nnz = (aa->nz - *n)/2 + *n;
94   }
95   else {
96     nnz     = aa->nz;
97   }
98 
99   if (!valOnly){
100     ierr = PetscMalloc(((*n)+1) *sizeof(PetscInt)   ,colptr );CHKERRQ(ierr);
101     ierr = PetscMalloc( nnz     *sizeof(PetscInt)   ,row);CHKERRQ(ierr);
102     ierr = PetscMalloc( nnz     *sizeof(PetscScalar),values);CHKERRQ(ierr);
103 
104     if (isSBAIJ || isSeqSBAIJ || isMpiSBAIJ) {
105 	ierr = PetscMemcpy (*colptr, rowptr, ((*n)+1)*sizeof(PetscInt));CHKERRQ(ierr);
106 	for (i = 0; i < *n+1; i++)
107 	  (*colptr)[i] += base;
108 	ierr = PetscMemcpy (*row, col, (nnz)*sizeof(PetscInt));CHKERRQ(ierr);
109 	for (i = 0; i < nnz; i++)
110 	  (*row)[i] += base;
111 	ierr = PetscMemcpy (*values, rvalues, (nnz)*sizeof(PetscScalar));CHKERRQ(ierr);
112     } else {
113       ierr = PetscMalloc((*n)*sizeof(PetscInt)   ,&colcount);CHKERRQ(ierr);
114 
115       for (i = 0; i < m; i++) colcount[i] = 0;
116       /* Fill-in colptr */
117       for (i = 0; i < m; i++) {
118 	for (j = rowptr[i]; j < rowptr[i+1]; j++) {
119 	  if (!isSym || col[j] <= i)  colcount[col[j]]++;
120         }
121       }
122 
123       (*colptr)[0] = base;
124       for (j = 0; j < *n; j++) {
125 	(*colptr)[j+1] = (*colptr)[j] + colcount[j];
126 	/* in next loop we fill starting from (*colptr)[colidx] - base */
127 	colcount[j] = -base;
128       }
129 
130       /* Fill-in rows and values */
131       for (i = 0; i < m; i++) {
132 	for (j = rowptr[i]; j < rowptr[i+1]; j++) {
133 	  if (!isSym || col[j] <= i) {
134 	    colidx = col[j];
135 	    idx    = (*colptr)[colidx] + colcount[colidx];
136 	    (*row)[idx]    = i + base;
137 	    (*values)[idx] = rvalues[j];
138 	    colcount[colidx]++;
139 	  }
140 	}
141       }
142       ierr = PetscFree(colcount);CHKERRQ(ierr);
143     }
144   } else {
145     /* Fill-in only values */
146     for (i = 0; i < m; i++) {
147       for (j = rowptr[i]; j < rowptr[i+1]; j++) {
148 	colidx = col[j];
149 	if ((isSBAIJ || isSeqSBAIJ || isMpiSBAIJ) ||!isSym || col[j] <= i)
150 	  {
151 	    /* look for the value to fill */
152 	    for (k = (*colptr)[colidx] - base; k < (*colptr)[colidx + 1] - base; k++) {
153 	      if (((*row)[k]-base) == i) {
154 		(*values)[k] = rvalues[j];
155 		break;
156 	      }
157 	    }
158 	    /* data structure of sparse matrix has changed */
159 	    if (k == (*colptr)[colidx + 1] - base) SETERRQ1(PETSC_ERR_PLIB,"overflow on k %D",k);
160 	  }
161       }
162     }
163   }
164   {
165     PetscScalar *tmpvalues;
166     PetscInt    *tmprows,*tmpcolptr;
167     tmpvalues = malloc(nnz*sizeof(PetscScalar)); if (!tmpvalues) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Unable to allocate memory");
168     tmprows   = malloc(nnz*sizeof(PetscInt));if (!tmprows) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Unable to allocate memory");
169     tmpcolptr = malloc((*n+1)*sizeof(PetscInt));if (!tmpcolptr) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Unable to allocate memory");
170 
171     ierr = PetscMalloc3(nnz,PetscScalar,&tmpvalues,nnz,PetscInt,&tmprows,(*n+1),PetscInt,&tmpcolptr);CHKERRQ(ierr);
172     if (sizeof(PetscScalar) != sizeof(pastix_float_t)) {
173       SETERRQ2(PETSC_ERR_SUP,"sizeof(PetscScalar) %d != sizeof(pastix_float_t) %d",sizeof(PetscScalar),sizeof(pastix_float_t));
174     }
175     if (sizeof(PetscInt) != sizeof(pastix_int_t)) {
176       SETERRQ2(PETSC_ERR_SUP,"sizeof(PetscInt) %d != sizeof(pastix_int_t) %d",sizeof(PetscInt),sizeof(pastix_int_t));
177     }
178 
179     ierr = PetscMemcpy(tmpcolptr,*colptr,(*n+1)*sizeof(PetscInt));CHKERRQ(ierr);
180     ierr = PetscMemcpy(tmprows,*row,nnz*sizeof(PetscInt));CHKERRQ(ierr);
181     ierr = PetscMemcpy(tmpvalues,*values,nnz*sizeof(PetscScalar));CHKERRQ(ierr);
182     ierr = PetscFree(*row);CHKERRQ(ierr);
183     ierr = PetscFree(*values);CHKERRQ(ierr);
184 
185     pastix_checkMatrix(MPI_COMM_WORLD,API_VERBOSE_NO,((isSym != 0) ? API_SYM_YES : API_SYM_NO),API_YES,*n,&tmpcolptr,&tmprows,&tmpvalues,NULL,1);
186 
187     ierr = PetscMemcpy(*colptr,tmpcolptr,(*n+1)*sizeof(PetscInt));CHKERRQ(ierr);
188     ierr = PetscMalloc(((*colptr)[*n]-1)*sizeof(PetscInt),row);CHKERRQ(ierr);
189     ierr = PetscMemcpy(*row,tmprows,((*colptr)[*n]-1)*sizeof(PetscInt));CHKERRQ(ierr);
190     ierr = PetscMalloc(((*colptr)[*n]-1)*sizeof(PetscScalar),values);CHKERRQ(ierr);
191     ierr = PetscMemcpy(*values,tmpvalues,((*colptr)[*n]-1)*sizeof(PetscScalar));CHKERRQ(ierr);
192     free(tmpvalues);
193     free(tmprows);
194     free(tmpcolptr);
195   }
196   PetscFunctionReturn(0);
197 }
198 
199 
200 
201 #undef __FUNCT__
202 #define __FUNCT__ "MatDestroy_Pastix"
203 /*
204   Call clean step of PaStiX if lu->CleanUpPastix == true.
205   Free the CSC matrix.
206  */
207 PetscErrorCode MatDestroy_Pastix(Mat A)
208 {
209   Mat_Pastix      *lu=(Mat_Pastix*)A->spptr;
210   PetscErrorCode   ierr;
211   PetscMPIInt      size=lu->commSize;
212 
213   PetscFunctionBegin;
214   if (lu->CleanUpPastix) {
215     /* Terminate instance, deallocate memories */
216     if (size > 1){
217       ierr = VecScatterDestroy(lu->scat_rhs);CHKERRQ(ierr);
218       ierr = VecDestroy(lu->b_seq);CHKERRQ(ierr);
219       ierr = VecScatterDestroy(lu->scat_sol);CHKERRQ(ierr);
220     }
221 
222     lu->iparm[IPARM_START_TASK]=API_TASK_CLEAN;
223     lu->iparm[IPARM_END_TASK]=API_TASK_CLEAN;
224 
225     pastix((pastix_data_t **)&(lu->pastix_data),
226 	                      lu->pastix_comm,
227 	   (pastix_int_t)     lu->n,
228 	   (pastix_int_t*)    lu->colptr,
229 	   (pastix_int_t*)    lu->row,
230 	   (pastix_float_t*)  lu->val,
231 	   (pastix_int_t*)    lu->perm,
232 	   (pastix_int_t*)    lu->invp,
233 	   (pastix_float_t*)  lu->rhs,
234 	   (pastix_int_t)     lu->rhsnbr,
235 	   (pastix_int_t*)    lu->iparm,
236 	                      lu->dparm);
237 
238     ierr = PetscFree(lu->colptr);CHKERRQ(ierr);
239     ierr = PetscFree(lu->row);  CHKERRQ(ierr);
240     ierr = PetscFree(lu->val);  CHKERRQ(ierr);
241     ierr = PetscFree(lu->perm); CHKERRQ(ierr);
242     ierr = PetscFree(lu->invp); CHKERRQ(ierr);
243     ierr = MPI_Comm_free(&(lu->pastix_comm));CHKERRQ(ierr);
244   }
245   ierr = (lu->MatDestroy)(A);CHKERRQ(ierr);
246   PetscFunctionReturn(0);
247 }
248 
249 #undef __FUNCT__
250 #define __FUNCT__ "MatSolve_PaStiX"
251 /*
252   Gather right-hand-side.
253   Call for Solve step.
254   Scatter solution.
255  */
256 PetscErrorCode MatSolve_PaStiX(Mat A,Vec b,Vec x)
257 {
258   Mat_Pastix     *lu=(Mat_Pastix*)A->spptr;
259   PetscScalar    *array;
260   Vec             x_seq;
261   PetscErrorCode  ierr;
262 
263   PetscFunctionBegin;
264   lu->rhsnbr = 1;
265   x_seq = lu->b_seq;
266   if (lu->commSize > 1){
267     /* PaStiX only supports centralized rhs. Scatter b into a seqential rhs vector */
268     ierr = VecScatterBegin(lu->scat_rhs,b,x_seq,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
269     ierr = VecScatterEnd(lu->scat_rhs,b,x_seq,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
270     ierr = VecGetArray(x_seq,&array);CHKERRQ(ierr);
271   } else {  /* size == 1 */
272     ierr = VecCopy(b,x);CHKERRQ(ierr);
273     ierr = VecGetArray(x,&array);CHKERRQ(ierr);
274   }
275   lu->rhs = array;
276   if (lu->commSize == 1){
277     ierr = VecRestoreArray(x,&array);CHKERRQ(ierr);
278   } else {
279     ierr = VecRestoreArray(x_seq,&array);CHKERRQ(ierr);
280   }
281 
282   /* solve phase */
283   /*-------------*/
284   lu->iparm[IPARM_START_TASK] = API_TASK_SOLVE;
285   lu->iparm[IPARM_END_TASK]   = API_TASK_REFINE;
286   lu->iparm[IPARM_RHS_MAKING] = API_RHS_B;
287 
288   pastix((pastix_data_t **)&(lu->pastix_data),
289 	 (MPI_Comm)         lu->pastix_comm,
290 	 (pastix_int_t)     lu->n,
291 	 (pastix_int_t*)    lu->colptr,
292 	 (pastix_int_t*)    lu->row,
293 	 (pastix_float_t*)  lu->val,
294 	 (pastix_int_t*)    lu->perm,
295 	 (pastix_int_t*)    lu->invp,
296 	 (pastix_float_t*)  lu->rhs,
297 	 (pastix_int_t)     lu->rhsnbr,
298 	 (pastix_int_t*)    lu->iparm,
299 	 (double*)          lu->dparm);
300 
301   if (lu->iparm[IPARM_ERROR_NUMBER] < 0) {
302     SETERRQ1(PETSC_ERR_LIB,"Error reported by PaStiX in solve phase: lu->iparm[IPARM_ERROR_NUMBER] = %d\n",lu->iparm[IPARM_ERROR_NUMBER] );
303   }
304 
305   if (lu->commSize == 1){
306     ierr = VecRestoreArray(x,&(lu->rhs));CHKERRQ(ierr);
307   } else {
308     ierr = VecRestoreArray(x_seq,&(lu->rhs));CHKERRQ(ierr);
309   }
310 
311   if (lu->commSize > 1) { /* convert PaStiX centralized solution to petsc mpi x */
312     ierr = VecScatterBegin(lu->scat_sol,x_seq,x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
313     ierr = VecScatterEnd(lu->scat_sol,x_seq,x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
314   }
315   PetscFunctionReturn(0);
316 }
317 
318 /*
319   Numeric factorisation using PaStiX solver.
320 
321  */
322 #undef __FUNCT__
323 #define __FUNCT__ "MatFactorNumeric_PASTIX"
324 PetscErrorCode MatFactorNumeric_PaStiX(Mat F,Mat A,const MatFactorInfo *info)
325 {
326   Mat_Pastix    *lu =(Mat_Pastix*)(F)->spptr;
327   Mat           *tseq;
328   PetscErrorCode ierr = 0;
329   PetscInt       icntl;
330   PetscInt       M=A->rmap->N;
331   PetscTruth     valOnly,flg, isSym;
332   Mat            F_diag;
333   IS             is_iden;
334   Vec            b;
335   IS             isrow;
336   PetscTruth     isSeqAIJ,isSeqSBAIJ;
337 
338   PetscFunctionBegin;
339 
340   ierr = PetscTypeCompare((PetscObject)A,MATSEQAIJ,&isSeqAIJ);CHKERRQ(ierr);
341   ierr = PetscTypeCompare((PetscObject)A,MATSEQSBAIJ,&isSeqSBAIJ);CHKERRQ(ierr);
342   if (lu->matstruc == DIFFERENT_NONZERO_PATTERN){
343     (F)->ops->solve   = MatSolve_PaStiX;
344 
345     /* Initialize a PASTIX instance */
346     ierr = MPI_Comm_dup(((PetscObject)A)->comm,&(lu->pastix_comm));CHKERRQ(ierr);
347     ierr = MPI_Comm_rank(lu->pastix_comm, &lu->commRank);         CHKERRQ(ierr);
348     ierr = MPI_Comm_size(lu->pastix_comm, &lu->commSize);         CHKERRQ(ierr);
349 
350     /* Set pastix options */
351     lu->iparm[IPARM_MODIFY_PARAMETER] = API_NO;
352     lu->iparm[IPARM_START_TASK]       = API_TASK_INIT;
353     lu->iparm[IPARM_END_TASK]         = API_TASK_INIT;
354     lu->rhsnbr = 1;
355 
356     /* Call to set default pastix options */
357     pastix((pastix_data_t **)&(lu->pastix_data),
358 	   (MPI_Comm)         lu->pastix_comm,
359 	   (pastix_int_t)     lu->n,
360 	   (pastix_int_t*)    lu->colptr,
361 	   (pastix_int_t*)    lu->row,
362 	   (pastix_float_t*)  lu->val,
363 	   (pastix_int_t*)    lu->perm,
364 	   (pastix_int_t*)    lu->invp,
365 	   (pastix_float_t*)  lu->rhs,
366 	   (pastix_int_t)     lu->rhsnbr,
367 	   (pastix_int_t*)    lu->iparm,
368 	   (double*)          lu->dparm);
369 
370     ierr = PetscOptionsBegin(((PetscObject)A)->comm,((PetscObject)A)->prefix,"PaStiX Options","Mat");CHKERRQ(ierr);
371 
372     icntl=-1;
373     lu->iparm[IPARM_VERBOSE] = API_VERBOSE_NOT;
374     ierr = PetscOptionsInt("-mat_pastix_verbose","iparm[IPARM_VERBOSE] : level of printing (0 to 2)","None",lu->iparm[IPARM_VERBOSE],&icntl,&flg);CHKERRQ(ierr);
375     if ((flg && icntl > 0) || PetscLogPrintInfo) {
376       lu->iparm[IPARM_VERBOSE] =  icntl;
377     }
378     icntl=-1;
379     ierr = PetscOptionsInt("-mat_pastix_threadnbr","iparm[IPARM_THREAD_NBR] : Number of thread by MPI node","None",lu->iparm[IPARM_THREAD_NBR],&icntl,PETSC_NULL);CHKERRQ(ierr);
380     if ((flg && icntl > 0)) {
381       lu->iparm[IPARM_THREAD_NBR] = icntl;
382     }
383     PetscOptionsEnd();
384     valOnly = PETSC_FALSE;
385   }  else {
386     valOnly = PETSC_TRUE;
387   }
388 
389   lu->iparm[IPARM_MATRIX_VERIFICATION] = API_YES;
390 
391   /* convert mpi A to seq mat A */
392   ierr = ISCreateStride(PETSC_COMM_SELF,M,0,1,&isrow);CHKERRQ(ierr);
393   ierr = MatGetSubMatrices(A,1,&isrow,&isrow,MAT_INITIAL_MATRIX,&tseq);CHKERRQ(ierr);
394   ierr = ISDestroy(isrow);CHKERRQ(ierr);
395 
396   ierr = MatConvertToCSC(*tseq,valOnly, &lu->n, &lu->colptr, &lu->row, &lu->val);CHKERRQ(ierr);
397   ierr = MatIsSymmetric(*tseq,0.0,&isSym);CHKERRQ(ierr);
398   ierr = MatDestroyMatrices(1,&tseq);CHKERRQ(ierr);
399 
400   ierr = PetscMalloc((lu->n)*sizeof(PetscInt)   ,&(lu->perm));CHKERRQ(ierr);
401   ierr = PetscMalloc((lu->n)*sizeof(PetscInt)   ,&(lu->invp));CHKERRQ(ierr);
402 
403   if (isSym) {
404     /* On symmetric matrix, LLT */
405     lu->iparm[IPARM_SYM] = API_SYM_YES;
406     lu->iparm[IPARM_FACTORIZATION] = API_FACT_LDLT;
407   } else {
408     /* On unsymmetric matrix, LU */
409     lu->iparm[IPARM_SYM] = API_SYM_NO;
410     lu->iparm[IPARM_FACTORIZATION] = API_FACT_LU;
411   }
412 
413   /*----------------*/
414   if (lu->matstruc == DIFFERENT_NONZERO_PATTERN){
415     if (!(isSeqAIJ || isSeqSBAIJ)) {
416       /* PaStiX only supports centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
417 	ierr = VecCreateSeq(PETSC_COMM_SELF,A->cmap->N,&lu->b_seq);CHKERRQ(ierr);
418 	ierr = ISCreateStride(PETSC_COMM_SELF,A->cmap->N,0,1,&is_iden);CHKERRQ(ierr);
419 	ierr = VecCreate(((PetscObject)A)->comm,&b);CHKERRQ(ierr);
420 	ierr = VecSetSizes(b,A->rmap->n,PETSC_DECIDE);CHKERRQ(ierr);
421 	ierr = VecSetFromOptions(b);CHKERRQ(ierr);
422 
423 	ierr = VecScatterCreate(b,is_iden,lu->b_seq,is_iden,&lu->scat_rhs);CHKERRQ(ierr);
424 	ierr = VecScatterCreate(lu->b_seq,is_iden,b,is_iden,&lu->scat_sol);CHKERRQ(ierr);
425 	ierr = ISDestroy(is_iden);CHKERRQ(ierr);
426 	ierr = VecDestroy(b);CHKERRQ(ierr);
427     }
428     lu->iparm[IPARM_START_TASK] = API_TASK_ORDERING;
429     lu->iparm[IPARM_END_TASK]   = API_TASK_NUMFACT;
430 
431     pastix((pastix_data_t **)&(lu->pastix_data),
432 	   (MPI_Comm)         lu->pastix_comm,
433 	   (pastix_int_t)     lu->n,
434 	   (pastix_int_t*)    lu->colptr,
435 	   (pastix_int_t*)    lu->row,
436 	   (pastix_float_t*)  lu->val,
437 	   (pastix_int_t*)    lu->perm,
438 	   (pastix_int_t*)    lu->invp,
439 	   (pastix_float_t*)  lu->rhs,
440 	   (pastix_int_t)     lu->rhsnbr,
441 	   (pastix_int_t*)    lu->iparm,
442 	   (double*)          lu->dparm);
443     if (lu->iparm[IPARM_ERROR_NUMBER] < 0) {
444       SETERRQ1(PETSC_ERR_LIB,"Error reported by PaStiX in analysis phase: iparm(IPARM_ERROR_NUMBER)=%d\n",lu->iparm[IPARM_ERROR_NUMBER]);
445     }
446   } else {
447     lu->iparm[IPARM_START_TASK] = API_TASK_NUMFACT;
448     lu->iparm[IPARM_END_TASK]   = API_TASK_NUMFACT;
449     pastix((pastix_data_t **)&(lu->pastix_data),
450 	   (MPI_Comm)         lu->pastix_comm,
451 	   (pastix_int_t)     lu->n,
452 	   (pastix_int_t*)    lu->colptr,
453 	   (pastix_int_t*)    lu->row,
454 	   (pastix_float_t*)  lu->val,
455 	   (pastix_int_t*)    lu->perm,
456 	   (pastix_int_t*)    lu->invp,
457 	   (pastix_float_t*)  lu->rhs,
458 	   (pastix_int_t)     lu->rhsnbr,
459 	   (pastix_int_t*)    lu->iparm,
460 	   (double*)          lu->dparm);
461 
462     if (lu->iparm[IPARM_ERROR_NUMBER] < 0) {
463       SETERRQ1(PETSC_ERR_LIB,"Error reported by PaStiX in analysis phase: iparm(IPARM_ERROR_NUMBER)=%d\n",lu->iparm[IPARM_ERROR_NUMBER]);
464     }
465   }
466 
467   if (lu->commSize > 1){
468     if ((F)->factor == MAT_FACTOR_LU){
469       F_diag = ((Mat_MPIAIJ *)(F)->data)->A;
470     } else {
471       F_diag = ((Mat_MPISBAIJ *)(F)->data)->A;
472     }
473     F_diag->assembled = PETSC_TRUE;
474   }
475   (F)->assembled     = PETSC_TRUE;
476   lu->matstruc       = SAME_NONZERO_PATTERN;
477   lu->CleanUpPastix  = PETSC_TRUE;
478   PetscFunctionReturn(0);
479 }
480 
481 /* Note the Petsc r and c permutations are ignored */
482 #undef __FUNCT__
483 #define __FUNCT__ "MatLUFactorSymbolic_AIJPASTIX"
484 PetscErrorCode MatLUFactorSymbolic_AIJPASTIX(Mat F,Mat A,IS r,IS c,const MatFactorInfo *info)
485 {
486   Mat_Pastix      *lu = (Mat_Pastix*)F->spptr;
487 
488   PetscFunctionBegin;
489   lu->iparm[IPARM_FACTORIZATION] = API_FACT_LU;
490   lu->iparm[IPARM_SYM]           = API_SYM_YES;
491   lu->matstruc                   = DIFFERENT_NONZERO_PATTERN;
492   F->ops->lufactornumeric        = MatFactorNumeric_PaStiX;
493   PetscFunctionReturn(0);
494 }
495 
496 
497 /* Note the Petsc r permutation is ignored */
498 #undef __FUNCT__
499 #define __FUNCT__ "MatCholeskyFactorSymbolic_SBAIJPASTIX"
500 PetscErrorCode MatCholeskyFactorSymbolic_SBAIJPASTIX(Mat F,Mat A,IS r,const MatFactorInfo *info)
501 {
502   Mat_Pastix      *lu = (Mat_Pastix*)(F)->spptr;
503 
504   PetscFunctionBegin;
505   lu->iparm[IPARM_FACTORIZATION]  = API_FACT_LLT;
506   lu->iparm[IPARM_SYM]            = API_SYM_NO;
507   lu->matstruc                    = DIFFERENT_NONZERO_PATTERN;
508   (F)->ops->choleskyfactornumeric = MatFactorNumeric_PaStiX;
509   PetscFunctionReturn(0);
510 }
511 
512 #undef __FUNCT__
513 #define __FUNCT__ "MatView_PaStiX"
514 PetscErrorCode MatView_PaStiX(Mat A,PetscViewer viewer)
515 {
516   PetscErrorCode    ierr;
517   PetscTruth        iascii;
518   PetscViewerFormat format;
519 
520   PetscFunctionBegin;
521   ierr = PetscTypeCompare((PetscObject)viewer,PETSC_VIEWER_ASCII,&iascii);CHKERRQ(ierr);
522   if (iascii) {
523     ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr);
524     if (format == PETSC_VIEWER_ASCII_INFO){
525       Mat_Pastix      *lu=(Mat_Pastix*)A->spptr;
526 
527       ierr = PetscViewerASCIIPrintf(viewer,"PaStiX run parameters:\n");CHKERRQ(ierr);
528       ierr = PetscViewerASCIIPrintf(viewer,"  Matrix type :                      %s \n",((lu->iparm[IPARM_SYM] == API_SYM_YES)?"Symmetric":"Unsymmetric"));CHKERRQ(ierr);
529       ierr = PetscViewerASCIIPrintf(viewer,"  Level of printing (0,1,2):         %d \n",lu->iparm[IPARM_VERBOSE]);CHKERRQ(ierr);
530       ierr = PetscViewerASCIIPrintf(viewer,"  Number of refinements iterations : %d \n",lu->iparm[IPARM_NBITER]);CHKERRQ(ierr);
531       ierr = PetscPrintf(PETSC_COMM_SELF,"  Error :                        %g \n",lu->dparm[DPARM_RELATIVE_ERROR]);CHKERRQ(ierr);
532     }
533   }
534   PetscFunctionReturn(0);
535 }
536 
537 
538 /*MC
539      MAT_SOLVER_PASTIX  - A solver package providing direct solvers (LU) for distributed
540   and sequential matrices via the external package PaStiX.
541 
542   Use config/configure.py --download-pastix to have PETSc installed with PaStiX
543 
544   Options Database Keys:
545 + -mat_pastix_verbose   <0,1,2>   - print level
546 - -mat_pastix_threadnbr <integer> - Set the thread number by MPI task.
547 
548   Level: beginner
549 
550 .seealso: PCFactorSetMatSolverPackage(), MatSolverPackage
551 
552 M*/
553 
554 
555 #undef __FUNCT__
556 #define __FUNCT__ "MatGetInfo_PaStiX"
557 PetscErrorCode MatGetInfo_PaStiX(Mat A,MatInfoType flag,MatInfo *info)
558 {
559     Mat_Pastix  *lu =(Mat_Pastix*)A->spptr;
560 
561     PetscFunctionBegin;
562     info->block_size        = 1.0;
563     info->nz_allocated      = lu->iparm[IPARM_NNZEROS];
564     info->nz_used           = lu->iparm[IPARM_NNZEROS];
565     info->nz_unneeded       = 0.0;
566     info->assemblies        = 0.0;
567     info->mallocs           = 0.0;
568     info->memory            = 0.0;
569     info->fill_ratio_given  = 0;
570     info->fill_ratio_needed = 0;
571     info->factor_mallocs    = 0;
572     PetscFunctionReturn(0);
573 }
574 
575 EXTERN_C_BEGIN
576 #undef __FUNCT__
577 #define __FUNCT__ "MatFactorGetSolverPackage_pastix"
578 PetscErrorCode MatFactorGetSolverPackage_pastix(Mat A,const MatSolverPackage *type)
579 {
580   PetscFunctionBegin;
581   *type = MAT_SOLVER_PASTIX;
582   PetscFunctionReturn(0);
583 }
584 EXTERN_C_END
585 
586 EXTERN_C_BEGIN
587 /*
588     The seq and mpi versions of this function are the same
589 */
590 #undef __FUNCT__
591 #define __FUNCT__ "MatGetFactor_seqaij_pastix"
592 PetscErrorCode MatGetFactor_seqaij_pastix(Mat A,MatFactorType ftype,Mat *F)
593 {
594   Mat            B;
595   PetscErrorCode ierr;
596   Mat_Pastix    *pastix;
597 
598   PetscFunctionBegin;
599   if (ftype != MAT_FACTOR_LU) {
600     SETERRQ(PETSC_ERR_SUP,"Cannot use PETSc AIJ matrices with PaStiX Cholesky, use SBAIJ matrix");
601   }
602   /* Create the factorization matrix */
603   ierr = MatCreate(((PetscObject)A)->comm,&B);CHKERRQ(ierr);
604   ierr = MatSetSizes(B,A->rmap->n,A->cmap->n,A->rmap->N,A->cmap->N);CHKERRQ(ierr);
605   ierr = MatSetType(B,((PetscObject)A)->type_name);CHKERRQ(ierr);
606   ierr = MatSeqAIJSetPreallocation(B,0,PETSC_NULL);CHKERRQ(ierr);
607 
608   B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJPASTIX;
609   B->ops->view             = MatView_PaStiX;
610   B->ops->getinfo          = MatGetInfo_PaStiX;
611   ierr = PetscObjectComposeFunctionDynamic((PetscObject)B,"MatFactorGetSolverPackage_C","MatFactorGetSolverPackage_pastix", MatFactorGetSolverPackage_pastix);CHKERRQ(ierr);
612   B->factor                = MAT_FACTOR_LU;
613 
614   ierr = PetscNewLog(B,Mat_Pastix,&pastix);CHKERRQ(ierr);
615   pastix->CleanUpPastix             = PETSC_FALSE;
616   pastix->isAIJ                     = PETSC_TRUE;
617   pastix->scat_rhs                  = PETSC_NULL;
618   pastix->scat_sol                  = PETSC_NULL;
619   pastix->MatDestroy                = B->ops->destroy;
620   B->ops->destroy                   = MatDestroy_Pastix;
621   B->spptr                          = (void*)pastix;
622 
623   *F = B;
624   PetscFunctionReturn(0);
625 }
626 EXTERN_C_END
627 
628 
629 EXTERN_C_BEGIN
630 #undef __FUNCT__
631 #define __FUNCT__ "MatGetFactor_mpiaij_pastix"
632 PetscErrorCode MatGetFactor_mpiaij_pastix(Mat A,MatFactorType ftype,Mat *F)
633 {
634   Mat            B;
635   PetscErrorCode ierr;
636   Mat_Pastix    *pastix;
637 
638   PetscFunctionBegin;
639   if (ftype != MAT_FACTOR_LU) SETERRQ(PETSC_ERR_SUP,"Cannot use PETSc AIJ matrices with PaStiX Cholesky, use SBAIJ matrix");
640   /* Create the factorization matrix */
641   ierr = MatCreate(((PetscObject)A)->comm,&B);CHKERRQ(ierr);
642   ierr = MatSetSizes(B,A->rmap->n,A->cmap->n,A->rmap->N,A->cmap->N);CHKERRQ(ierr);
643   ierr = MatSetType(B,((PetscObject)A)->type_name);CHKERRQ(ierr);
644   ierr = MatSeqAIJSetPreallocation(B,0,PETSC_NULL);CHKERRQ(ierr);
645   ierr = MatMPIAIJSetPreallocation(B,0,PETSC_NULL,0,PETSC_NULL);CHKERRQ(ierr);
646 
647   B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJPASTIX;
648   B->ops->view             = MatView_PaStiX;
649   ierr = PetscObjectComposeFunctionDynamic((PetscObject)B,"MatFactorGetSolverPackage_C","MatFactorGetSolverPackage_pastix",MatFactorGetSolverPackage_pastix);CHKERRQ(ierr);
650   B->factor                = MAT_FACTOR_LU;
651 
652   ierr = PetscNewLog(B,Mat_Pastix,&pastix);CHKERRQ(ierr);
653   pastix->CleanUpPastix             = PETSC_FALSE;
654   pastix->isAIJ                     = PETSC_TRUE;
655   pastix->scat_rhs                  = PETSC_NULL;
656   pastix->scat_sol                  = PETSC_NULL;
657   pastix->MatDestroy                = B->ops->destroy;
658   B->ops->destroy                  = MatDestroy_Pastix;
659   B->spptr                         = (void*)pastix;
660 
661   *F = B;
662   PetscFunctionReturn(0);
663 }
664 EXTERN_C_END
665 
666 EXTERN_C_BEGIN
667 #undef __FUNCT__
668 #define __FUNCT__ "MatGetFactor_seqsbaij_pastix"
669 PetscErrorCode MatGetFactor_seqsbaij_pastix(Mat A,MatFactorType ftype,Mat *F)
670 {
671   Mat            B;
672   PetscErrorCode ierr;
673   Mat_Pastix    *pastix;
674 
675   PetscFunctionBegin;
676   if (ftype != MAT_FACTOR_CHOLESKY) {
677     SETERRQ(PETSC_ERR_SUP,"Cannot use PETSc SBAIJ matrices with PaStiX LU, use AIJ matrix");
678   }
679   /* Create the factorization matrix */
680   ierr = MatCreate(((PetscObject)A)->comm,&B);CHKERRQ(ierr);
681   ierr = MatSetSizes(B,A->rmap->n,A->cmap->n,A->rmap->N,A->cmap->N);CHKERRQ(ierr);
682   ierr = MatSetType(B,((PetscObject)A)->type_name);CHKERRQ(ierr);
683   ierr = MatSeqSBAIJSetPreallocation(B,1,0,PETSC_NULL);CHKERRQ(ierr);
684   ierr = MatMPISBAIJSetPreallocation(B,1,0,PETSC_NULL,0,PETSC_NULL);CHKERRQ(ierr);
685 
686   B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_SBAIJPASTIX;
687   B->ops->view                   = MatView_PaStiX;
688   ierr = PetscObjectComposeFunctionDynamic((PetscObject)B,"MatFactorGetSolverPackage_C","MatFactorGetSolverPackage_pastix",MatFactorGetSolverPackage_pastix);CHKERRQ(ierr);
689 
690   B->factor                      = MAT_FACTOR_CHOLESKY;
691 
692   ierr = PetscNewLog(B,Mat_Pastix,&pastix);CHKERRQ(ierr);
693   pastix->CleanUpPastix             = PETSC_FALSE;
694   pastix->isAIJ                     = PETSC_TRUE;
695   pastix->scat_rhs                  = PETSC_NULL;
696   pastix->scat_sol                  = PETSC_NULL;
697   pastix->MatDestroy                = B->ops->destroy;
698   B->ops->destroy                  = MatDestroy_Pastix;
699   B->spptr                         = (void*)pastix;
700 
701   *F = B;
702   PetscFunctionReturn(0);
703 }
704 EXTERN_C_END
705 
706 EXTERN_C_BEGIN
707 #undef __FUNCT__
708 #define __FUNCT__ "MatGetFactor_mpisbaij_pastix"
709 PetscErrorCode MatGetFactor_mpisbaij_pastix(Mat A,MatFactorType ftype,Mat *F)
710 {
711   Mat            B;
712   PetscErrorCode ierr;
713   Mat_Pastix    *pastix;
714 
715   PetscFunctionBegin;
716   if (ftype != MAT_FACTOR_CHOLESKY) SETERRQ(PETSC_ERR_SUP,"Cannot use PETSc SBAIJ matrices with PaStiX LU, use AIJ matrix");
717 
718   /* Create the factorization matrix */
719   ierr = MatCreate(((PetscObject)A)->comm,&B);CHKERRQ(ierr);
720   ierr = MatSetSizes(B,A->rmap->n,A->cmap->n,A->rmap->N,A->cmap->N);CHKERRQ(ierr);
721   ierr = MatSetType(B,((PetscObject)A)->type_name);CHKERRQ(ierr);
722   ierr = MatSeqSBAIJSetPreallocation(B,1,0,PETSC_NULL);CHKERRQ(ierr);
723   ierr = MatMPISBAIJSetPreallocation(B,1,0,PETSC_NULL,0,PETSC_NULL);CHKERRQ(ierr);
724 
725   B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_SBAIJPASTIX;
726   B->ops->view                   = MatView_PaStiX;
727   ierr = PetscObjectComposeFunctionDynamic((PetscObject)B,"MatFactorGetSolverPackage_C","MatFactorGetSolverPackage_pastix",MatFactorGetSolverPackage_pastix);CHKERRQ(ierr);
728   B->factor                      = MAT_FACTOR_CHOLESKY;
729 
730   ierr = PetscNewLog(B,Mat_Pastix,&pastix);CHKERRQ(ierr);
731   pastix->CleanUpPastix             = PETSC_FALSE;
732   pastix->isAIJ                     = PETSC_TRUE;
733   pastix->scat_rhs                  = PETSC_NULL;
734   pastix->scat_sol                  = PETSC_NULL;
735   pastix->MatDestroy                = B->ops->destroy;
736   B->ops->destroy                   = MatDestroy_Pastix;
737   B->spptr                          = (void*)pastix;
738 
739   *F = B;
740   PetscFunctionReturn(0);
741 }
742 EXTERN_C_END
743