Actual source code: mhypre.c

petsc-3.13.6 2020-09-29
Report Typos and Errors

  2: /*
  3:     Creates hypre ijmatrix from PETSc matrix
  4: */

  6: #include <petscpkg_version.h>
  7:  #include <petsc/private/petschypre.h>
  8:  #include <petscmathypre.h>
  9:  #include <petsc/private/matimpl.h>
 10:  #include <../src/mat/impls/hypre/mhypre.h>
 11:  #include <../src/mat/impls/aij/mpi/mpiaij.h>
 12:  #include <../src/vec/vec/impls/hypre/vhyp.h>
 13: #include <HYPRE.h>
 14: #include <HYPRE_utilities.h>
 15: #include <_hypre_parcsr_ls.h>
 16: #include <_hypre_sstruct_ls.h>

 18: #if PETSC_PKG_HYPRE_VERSION_LT(2,18,0)
 19: #define  hypre_ParCSRMatrixClone(A,B) hypre_ParCSRMatrixCompleteClone(A)
 20: #endif

 22: static PetscErrorCode MatHYPRE_CreateFromMat(Mat,Mat_HYPRE*);
 23: static PetscErrorCode MatHYPRE_IJMatrixPreallocate(Mat,Mat,HYPRE_IJMatrix);
 24: static PetscErrorCode MatHYPRE_IJMatrixFastCopy_MPIAIJ(Mat,HYPRE_IJMatrix);
 25: static PetscErrorCode MatHYPRE_IJMatrixFastCopy_SeqAIJ(Mat,HYPRE_IJMatrix);
 26: static PetscErrorCode MatHYPRE_MultKernel_Private(Mat,HYPRE_Complex,Vec,HYPRE_Complex,Vec,PetscBool);
 27: static PetscErrorCode hypre_array_destroy(void*);
 28: PetscErrorCode MatSetValues_HYPRE(Mat, PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode ins);

 30: static PetscErrorCode MatHYPRE_IJMatrixPreallocate(Mat A_d, Mat A_o, HYPRE_IJMatrix ij)
 31: {
 33:   PetscInt       i,n_d,n_o;
 34:   const PetscInt *ia_d,*ia_o;
 35:   PetscBool      done_d=PETSC_FALSE,done_o=PETSC_FALSE;
 36:   HYPRE_Int      *nnz_d=NULL,*nnz_o=NULL;

 39:   if (A_d) { /* determine number of nonzero entries in local diagonal part */
 40:     MatGetRowIJ(A_d,0,PETSC_FALSE,PETSC_FALSE,&n_d,&ia_d,NULL,&done_d);
 41:     if (done_d) {
 42:       PetscMalloc1(n_d,&nnz_d);
 43:       for (i=0; i<n_d; i++) {
 44:         nnz_d[i] = ia_d[i+1] - ia_d[i];
 45:       }
 46:     }
 47:     MatRestoreRowIJ(A_d,0,PETSC_FALSE,PETSC_FALSE,NULL,&ia_d,NULL,&done_d);
 48:   }
 49:   if (A_o) { /* determine number of nonzero entries in local off-diagonal part */
 50:     MatGetRowIJ(A_o,0,PETSC_FALSE,PETSC_FALSE,&n_o,&ia_o,NULL,&done_o);
 51:     if (done_o) {
 52:       PetscMalloc1(n_o,&nnz_o);
 53:       for (i=0; i<n_o; i++) {
 54:         nnz_o[i] = ia_o[i+1] - ia_o[i];
 55:       }
 56:     }
 57:     MatRestoreRowIJ(A_o,0,PETSC_FALSE,PETSC_FALSE,&n_o,&ia_o,NULL,&done_o);
 58:   }
 59:   if (done_d) {    /* set number of nonzeros in HYPRE IJ matrix */
 60:     if (!done_o) { /* only diagonal part */
 61:       PetscMalloc1(n_d,&nnz_o);
 62:       for (i=0; i<n_d; i++) {
 63:         nnz_o[i] = 0;
 64:       }
 65:     }
 66: #if PETSC_PKG_HYPRE_VERSION_GE(2,16,0)
 67:     { /* If we don't do this, the columns of the matrix will be all zeros! */
 68:       hypre_AuxParCSRMatrix *aux_matrix;
 69:       aux_matrix = (hypre_AuxParCSRMatrix*)hypre_IJMatrixTranslator(ij);
 70:       hypre_AuxParCSRMatrixDestroy(aux_matrix);
 71:       hypre_IJMatrixTranslator(ij) = NULL;
 72:       PetscStackCallStandard(HYPRE_IJMatrixSetDiagOffdSizes,(ij,nnz_d,nnz_o));
 73:       aux_matrix = (hypre_AuxParCSRMatrix*)hypre_IJMatrixTranslator(ij);
 74:       hypre_AuxParCSRMatrixNeedAux(aux_matrix) = 1;
 75:     }
 76: #else
 77:     PetscStackCallStandard(HYPRE_IJMatrixSetDiagOffdSizes,(ij,nnz_d,nnz_o));
 78: #endif
 79:     PetscFree(nnz_d);
 80:     PetscFree(nnz_o);
 81:   }
 82:   return(0);
 83: }

 85: static PetscErrorCode MatHYPRE_CreateFromMat(Mat A, Mat_HYPRE *hA)
 86: {
 88:   PetscInt       rstart,rend,cstart,cend;

 91:   PetscLayoutSetUp(A->rmap);
 92:   PetscLayoutSetUp(A->cmap);
 93:   rstart = A->rmap->rstart;
 94:   rend   = A->rmap->rend;
 95:   cstart = A->cmap->rstart;
 96:   cend   = A->cmap->rend;
 97:   PetscStackCallStandard(HYPRE_IJMatrixCreate,(hA->comm,rstart,rend-1,cstart,cend-1,&hA->ij));
 98:   PetscStackCallStandard(HYPRE_IJMatrixSetObjectType,(hA->ij,HYPRE_PARCSR));
 99:   {
100:     PetscBool      same;
101:     Mat            A_d,A_o;
102:     const PetscInt *colmap;
103:     PetscObjectBaseTypeCompare((PetscObject)A,MATMPIAIJ,&same);
104:     if (same) {
105:       MatMPIAIJGetSeqAIJ(A,&A_d,&A_o,&colmap);
106:       MatHYPRE_IJMatrixPreallocate(A_d,A_o,hA->ij);
107:       return(0);
108:     }
109:     PetscObjectBaseTypeCompare((PetscObject)A,MATMPIBAIJ,&same);
110:     if (same) {
111:       MatMPIBAIJGetSeqBAIJ(A,&A_d,&A_o,&colmap);
112:       MatHYPRE_IJMatrixPreallocate(A_d,A_o,hA->ij);
113:       return(0);
114:     }
115:     PetscObjectBaseTypeCompare((PetscObject)A,MATSEQAIJ,&same);
116:     if (same) {
117:       MatHYPRE_IJMatrixPreallocate(A,NULL,hA->ij);
118:       return(0);
119:     }
120:     PetscObjectBaseTypeCompare((PetscObject)A,MATSEQBAIJ,&same);
121:     if (same) {
122:       MatHYPRE_IJMatrixPreallocate(A,NULL,hA->ij);
123:       return(0);
124:     }
125:   }
126:   return(0);
127: }

129: static PetscErrorCode MatHYPRE_IJMatrixCopy(Mat A, HYPRE_IJMatrix ij)
130: {
131:   PetscErrorCode    ierr;
132:   PetscInt          i,rstart,rend,ncols,nr,nc;
133:   const PetscScalar *values;
134:   const PetscInt    *cols;
135:   PetscBool         flg;

138:   PetscObjectBaseTypeCompare((PetscObject)A,MATMPIAIJ,&flg);
139:   MatGetSize(A,&nr,&nc);
140:   if (flg && nr == nc) {
141:     MatHYPRE_IJMatrixFastCopy_MPIAIJ(A,ij);
142:     return(0);
143:   }
144:   PetscObjectBaseTypeCompare((PetscObject)A,MATSEQAIJ,&flg);
145:   if (flg) {
146:     MatHYPRE_IJMatrixFastCopy_SeqAIJ(A,ij);
147:     return(0);
148:   }

150:   PetscStackCallStandard(HYPRE_IJMatrixInitialize,(ij));
151:   MatGetOwnershipRange(A,&rstart,&rend);
152:   for (i=rstart; i<rend; i++) {
153:     MatGetRow(A,i,&ncols,&cols,&values);
154:     if (ncols) {
155:       HYPRE_Int nc = (HYPRE_Int)ncols;

157:       if ((PetscInt)nc != ncols) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_SUP,"Hypre overflow! number of columns %D for row %D",ncols,i);
158:       PetscStackCallStandard(HYPRE_IJMatrixSetValues,(ij,1,&nc,(HYPRE_BigInt *)&i,(HYPRE_BigInt *)cols,(HYPRE_Complex *)values));
159:     }
160:     MatRestoreRow(A,i,&ncols,&cols,&values);
161:   }
162:   return(0);
163: }

165: static PetscErrorCode MatHYPRE_IJMatrixFastCopy_SeqAIJ(Mat A, HYPRE_IJMatrix ij)
166: {
167:   PetscErrorCode        ierr;
168:   Mat_SeqAIJ            *pdiag = (Mat_SeqAIJ*)A->data;
169:   HYPRE_Int             type;
170:   hypre_ParCSRMatrix    *par_matrix;
171:   hypre_AuxParCSRMatrix *aux_matrix;
172:   hypre_CSRMatrix       *hdiag;
173:   PetscBool             sameint = (PetscBool)(sizeof(PetscInt) == sizeof(HYPRE_Int));

176:   PetscStackCallStandard(HYPRE_IJMatrixInitialize,(ij));
177:   PetscStackCallStandard(HYPRE_IJMatrixGetObjectType,(ij,&type));
178:   if (type != HYPRE_PARCSR) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Only HYPRE_PARCSR is supported");
179:   PetscStackCallStandard(HYPRE_IJMatrixGetObject,(ij,(void**)&par_matrix));
180:   hdiag = hypre_ParCSRMatrixDiag(par_matrix);
181:   /*
182:        this is the Hack part where we monkey directly with the hypre datastructures
183:   */
184:   if (sameint) {
185:     PetscArraycpy(hdiag->i,pdiag->i,A->rmap->n + 1);
186:     PetscArraycpy(hdiag->j,pdiag->j,pdiag->nz);
187:   } else {
188:     PetscInt i;

190:     for (i=0;i<A->rmap->n + 1;i++) hdiag->i[i] = (HYPRE_Int)pdiag->i[i];
191:     for (i=0;i<pdiag->nz;i++)      hdiag->j[i] = (HYPRE_Int)pdiag->j[i];
192:   }
193:   PetscArraycpy(hdiag->data,pdiag->a,pdiag->nz);

195:   aux_matrix = (hypre_AuxParCSRMatrix*)hypre_IJMatrixTranslator(ij);
196:   hypre_AuxParCSRMatrixNeedAux(aux_matrix) = 0;
197:   return(0);
198: }

200: static PetscErrorCode MatHYPRE_IJMatrixFastCopy_MPIAIJ(Mat A, HYPRE_IJMatrix ij)
201: {
202:   PetscErrorCode        ierr;
203:   Mat_MPIAIJ            *pA = (Mat_MPIAIJ*)A->data;
204:   Mat_SeqAIJ            *pdiag,*poffd;
205:   PetscInt              i,*garray = pA->garray,*jj,cstart,*pjj;
206:   HYPRE_Int             *hjj,type;
207:   hypre_ParCSRMatrix    *par_matrix;
208:   hypre_AuxParCSRMatrix *aux_matrix;
209:   hypre_CSRMatrix       *hdiag,*hoffd;
210:   PetscBool             sameint = (PetscBool)(sizeof(PetscInt) == sizeof(HYPRE_Int));

213:   pdiag = (Mat_SeqAIJ*) pA->A->data;
214:   poffd = (Mat_SeqAIJ*) pA->B->data;
215:   /* cstart is only valid for square MPIAIJ layed out in the usual way */
216:   MatGetOwnershipRange(A,&cstart,NULL);

218:   PetscStackCallStandard(HYPRE_IJMatrixInitialize,(ij));
219:   PetscStackCallStandard(HYPRE_IJMatrixGetObjectType,(ij,&type));
220:   if (type != HYPRE_PARCSR) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Only HYPRE_PARCSR is supported");
221:   PetscStackCallStandard(HYPRE_IJMatrixGetObject,(ij,(void**)&par_matrix));
222:   hdiag = hypre_ParCSRMatrixDiag(par_matrix);
223:   hoffd = hypre_ParCSRMatrixOffd(par_matrix);

225:   /*
226:        this is the Hack part where we monkey directly with the hypre datastructures
227:   */
228:   if (sameint) {
229:     PetscArraycpy(hdiag->i,pdiag->i,pA->A->rmap->n + 1);
230:   } else {
231:     for (i=0; i<pA->A->rmap->n + 1; i++) hdiag->i[i] = (HYPRE_Int)(pdiag->i[i]);
232:   }
233:   /* need to shift the diag column indices (hdiag->j) back to global numbering since hypre is expecting this */
234:   hjj = hdiag->j;
235:   pjj = pdiag->j;
236: #if PETSC_PKG_HYPRE_VERSION_GE(2,16,0)
237:   for (i=0; i<pdiag->nz; i++) hjj[i] = pjj[i];
238: #else
239:   for (i=0; i<pdiag->nz; i++) hjj[i] = cstart + pjj[i];
240: #endif
241:   PetscArraycpy(hdiag->data,pdiag->a,pdiag->nz);
242:   if (sameint) {
243:     PetscArraycpy(hoffd->i,poffd->i,pA->A->rmap->n + 1);
244:   } else {
245:     for (i=0; i<pA->A->rmap->n + 1; i++) hoffd->i[i] = (HYPRE_Int)(poffd->i[i]);
246:   }

248:   /* need to move the offd column indices (hoffd->j) back to global numbering since hypre is expecting this
249:      If we hacked a hypre a bit more we might be able to avoid this step */
250: #if PETSC_PKG_HYPRE_VERSION_GE(2,16,0)
251:   PetscStackCallStandard(hypre_CSRMatrixBigInitialize,(hoffd));
252:   jj  = (PetscInt*) hoffd->big_j;
253: #else
254:   jj  = (PetscInt*) hoffd->j;
255: #endif
256:   pjj = poffd->j;
257:   for (i=0; i<poffd->nz; i++) jj[i] = garray[pjj[i]];

259:   PetscArraycpy(hoffd->data,poffd->a,poffd->nz);

261:   aux_matrix = (hypre_AuxParCSRMatrix*)hypre_IJMatrixTranslator(ij);
262:   hypre_AuxParCSRMatrixNeedAux(aux_matrix) = 0;
263:   return(0);
264: }

266: static PetscErrorCode MatConvert_HYPRE_IS(Mat A, MatType mtype, MatReuse reuse, Mat* B)
267: {
268:   Mat_HYPRE*             mhA = (Mat_HYPRE*)(A->data);
269:   Mat                    lA;
270:   ISLocalToGlobalMapping rl2g,cl2g;
271:   IS                     is;
272:   hypre_ParCSRMatrix     *hA;
273:   hypre_CSRMatrix        *hdiag,*hoffd;
274:   MPI_Comm               comm;
275:   HYPRE_Complex          *hdd,*hod,*aa;
276:   PetscScalar            *data;
277:   HYPRE_BigInt           *col_map_offd;
278:   HYPRE_Int              *hdi,*hdj,*hoi,*hoj;
279:   PetscInt               *ii,*jj,*iptr,*jptr;
280:   PetscInt               cum,dr,dc,oc,str,stc,nnz,i,jd,jo,M,N;
281:   HYPRE_Int              type;
282:   PetscErrorCode         ierr;

285:   comm = PetscObjectComm((PetscObject)A);
286:   PetscStackCallStandard(HYPRE_IJMatrixGetObjectType,(mhA->ij,&type));
287:   if (type != HYPRE_PARCSR) SETERRQ(comm,PETSC_ERR_SUP,"Only HYPRE_PARCSR is supported");
288:   PetscStackCallStandard(HYPRE_IJMatrixGetObject,(mhA->ij,(void**)&hA));
289:   M     = hypre_ParCSRMatrixGlobalNumRows(hA);
290:   N     = hypre_ParCSRMatrixGlobalNumCols(hA);
291:   str   = hypre_ParCSRMatrixFirstRowIndex(hA);
292:   stc   = hypre_ParCSRMatrixFirstColDiag(hA);
293:   hdiag = hypre_ParCSRMatrixDiag(hA);
294:   hoffd = hypre_ParCSRMatrixOffd(hA);
295:   dr    = hypre_CSRMatrixNumRows(hdiag);
296:   dc    = hypre_CSRMatrixNumCols(hdiag);
297:   nnz   = hypre_CSRMatrixNumNonzeros(hdiag);
298:   hdi   = hypre_CSRMatrixI(hdiag);
299:   hdj   = hypre_CSRMatrixJ(hdiag);
300:   hdd   = hypre_CSRMatrixData(hdiag);
301:   oc    = hypre_CSRMatrixNumCols(hoffd);
302:   nnz  += hypre_CSRMatrixNumNonzeros(hoffd);
303:   hoi   = hypre_CSRMatrixI(hoffd);
304:   hoj   = hypre_CSRMatrixJ(hoffd);
305:   hod   = hypre_CSRMatrixData(hoffd);
306:   if (reuse != MAT_REUSE_MATRIX) {
307:     PetscInt *aux;

309:     /* generate l2g maps for rows and cols */
310:     ISCreateStride(comm,dr,str,1,&is);
311:     ISLocalToGlobalMappingCreateIS(is,&rl2g);
312:     ISDestroy(&is);
313:     col_map_offd = hypre_ParCSRMatrixColMapOffd(hA);
314:     PetscMalloc1(dc+oc,&aux);
315:     for (i=0; i<dc; i++) aux[i] = i+stc;
316:     for (i=0; i<oc; i++) aux[i+dc] = col_map_offd[i];
317:     ISCreateGeneral(comm,dc+oc,aux,PETSC_OWN_POINTER,&is);
318:     ISLocalToGlobalMappingCreateIS(is,&cl2g);
319:     ISDestroy(&is);
320:     /* create MATIS object */
321:     MatCreate(comm,B);
322:     MatSetSizes(*B,dr,dc,M,N);
323:     MatSetType(*B,MATIS);
324:     MatSetLocalToGlobalMapping(*B,rl2g,cl2g);
325:     ISLocalToGlobalMappingDestroy(&rl2g);
326:     ISLocalToGlobalMappingDestroy(&cl2g);

328:     /* allocate CSR for local matrix */
329:     PetscMalloc1(dr+1,&iptr);
330:     PetscMalloc1(nnz,&jptr);
331:     PetscMalloc1(nnz,&data);
332:   } else {
333:     PetscInt  nr;
334:     PetscBool done;
335:     MatISGetLocalMat(*B,&lA);
336:     MatGetRowIJ(lA,0,PETSC_FALSE,PETSC_FALSE,&nr,(const PetscInt**)&iptr,(const PetscInt**)&jptr,&done);
337:     if (nr != dr) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot reuse mat: invalid number of rows in local mat! %D != %D",nr,dr);
338:     if (iptr[nr] < nnz) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot reuse mat: invalid number of nonzeros in local mat! reuse %D requested %D",iptr[nr],nnz);
339:     MatSeqAIJGetArray(lA,&data);
340:   }
341:   /* merge local matrices */
342:   ii  = iptr;
343:   jj  = jptr;
344:   aa  = (HYPRE_Complex*)data; /* this cast fixes the clang error when doing the assignments below: implicit conversion from 'HYPRE_Complex' (aka '_Complex double') to 'double' is not permitted in C++ */
345:   *ii = *(hdi++) + *(hoi++);
346:   for (jd=0,jo=0,cum=0; *ii<nnz; cum++) {
347:     PetscScalar *aold = (PetscScalar*)aa;
348:     PetscInt    *jold = jj,nc = jd+jo;
349:     for (; jd<*hdi; jd++) { *jj++ = *hdj++;      *aa++ = *hdd++; }
350:     for (; jo<*hoi; jo++) { *jj++ = *hoj++ + dc; *aa++ = *hod++; }
351:     *(++ii) = *(hdi++) + *(hoi++);
352:     PetscSortIntWithScalarArray(jd+jo-nc,jold,aold);
353:   }
354:   for (; cum<dr; cum++) *(++ii) = nnz;
355:   if (reuse != MAT_REUSE_MATRIX) {
356:     Mat_SeqAIJ* a;

358:     MatCreateSeqAIJWithArrays(PETSC_COMM_SELF,dr,dc+oc,iptr,jptr,data,&lA);
359:     MatISSetLocalMat(*B,lA);
360:     /* hack SeqAIJ */
361:     a          = (Mat_SeqAIJ*)(lA->data);
362:     a->free_a  = PETSC_TRUE;
363:     a->free_ij = PETSC_TRUE;
364:     MatDestroy(&lA);
365:   }
366:   MatAssemblyBegin(*B,MAT_FINAL_ASSEMBLY);
367:   MatAssemblyEnd(*B,MAT_FINAL_ASSEMBLY);
368:   if (reuse == MAT_INPLACE_MATRIX) {
369:     MatHeaderReplace(A,B);
370:   }
371:   return(0);
372: }

374: PETSC_INTERN PetscErrorCode MatConvert_AIJ_HYPRE(Mat A, MatType type, MatReuse reuse, Mat *B)
375: {
376:   Mat            M = NULL;
377:   Mat_HYPRE      *hB;
378:   MPI_Comm       comm = PetscObjectComm((PetscObject)A);

382:   if (reuse == MAT_REUSE_MATRIX) {
383:     /* always destroy the old matrix and create a new memory;
384:        hope this does not churn the memory too much. The problem
385:        is I do not know if it is possible to put the matrix back to
386:        its initial state so that we can directly copy the values
387:        the second time through. */
388:     hB = (Mat_HYPRE*)((*B)->data);
389:     PetscStackCallStandard(HYPRE_IJMatrixDestroy,(hB->ij));
390:   } else {
391:     MatCreate(comm,&M);
392:     MatSetType(M,MATHYPRE);
393:     MatSetSizes(M,A->rmap->n,A->cmap->n,A->rmap->N,A->cmap->N);
394:     hB   = (Mat_HYPRE*)(M->data);
395:     if (reuse == MAT_INITIAL_MATRIX) *B = M;
396:   }
397:   MatSetOption(*B,MAT_SORTED_FULL,PETSC_TRUE); /* "perfect" preallocation, so no need for hypre_AuxParCSRMatrixNeedAux */
398:   MatHYPRE_CreateFromMat(A,hB);
399:   MatHYPRE_IJMatrixCopy(A,hB->ij);
400:   if (reuse == MAT_INPLACE_MATRIX) {
401:     MatHeaderReplace(A,&M);
402:   }
403:   (*B)->preallocated = PETSC_TRUE;
404:   MatAssemblyBegin(*B,MAT_FINAL_ASSEMBLY);
405:   MatAssemblyEnd(*B,MAT_FINAL_ASSEMBLY);
406:   return(0);
407: }

409: static PetscErrorCode MatConvert_HYPRE_AIJ(Mat A, MatType mtype, MatReuse reuse, Mat *B)
410: {
411:   Mat_HYPRE          *hA = (Mat_HYPRE*)A->data;
412:   hypre_ParCSRMatrix *parcsr;
413:   hypre_CSRMatrix    *hdiag,*hoffd;
414:   MPI_Comm           comm;
415:   PetscScalar        *da,*oa,*aptr;
416:   PetscInt           *dii,*djj,*oii,*ojj,*iptr;
417:   PetscInt           i,dnnz,onnz,m,n;
418:   HYPRE_Int          type;
419:   PetscMPIInt        size;
420:   PetscBool          sameint = (PetscBool)(sizeof(PetscInt) == sizeof(HYPRE_Int));
421:   PetscErrorCode     ierr;

424:   comm = PetscObjectComm((PetscObject)A);
425:   PetscStackCallStandard(HYPRE_IJMatrixGetObjectType,(hA->ij,&type));
426:   if (type != HYPRE_PARCSR) SETERRQ(comm,PETSC_ERR_SUP,"Only HYPRE_PARCSR is supported");
427:   if (reuse == MAT_REUSE_MATRIX) {
428:     PetscBool ismpiaij,isseqaij;
429:     PetscObjectBaseTypeCompare((PetscObject)*B,MATMPIAIJ,&ismpiaij);
430:     PetscObjectBaseTypeCompare((PetscObject)*B,MATSEQAIJ,&isseqaij);
431:     if (!ismpiaij && !isseqaij) SETERRQ(comm,PETSC_ERR_SUP,"Only MATMPIAIJ or MATSEQAIJ are supported");
432:   }
433:   MPI_Comm_size(comm,&size);

435:   PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hA->ij,(void**)&parcsr));
436:   hdiag = hypre_ParCSRMatrixDiag(parcsr);
437:   hoffd = hypre_ParCSRMatrixOffd(parcsr);
438:   m     = hypre_CSRMatrixNumRows(hdiag);
439:   n     = hypre_CSRMatrixNumCols(hdiag);
440:   dnnz  = hypre_CSRMatrixNumNonzeros(hdiag);
441:   onnz  = hypre_CSRMatrixNumNonzeros(hoffd);
442:   if (reuse == MAT_INITIAL_MATRIX) {
443:     PetscMalloc1(m+1,&dii);
444:     PetscMalloc1(dnnz,&djj);
445:     PetscMalloc1(dnnz,&da);
446:   } else if (reuse == MAT_REUSE_MATRIX) {
447:     PetscInt  nr;
448:     PetscBool done;
449:     if (size > 1) {
450:       Mat_MPIAIJ *b = (Mat_MPIAIJ*)((*B)->data);

452:       MatGetRowIJ(b->A,0,PETSC_FALSE,PETSC_FALSE,&nr,(const PetscInt**)&dii,(const PetscInt**)&djj,&done);
453:       if (nr != m) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot reuse mat: invalid number of local rows in diag part! %D != %D",nr,m);
454:       if (dii[nr] < dnnz) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot reuse mat: invalid number of nonzeros in diag part! reuse %D hypre %D",dii[nr],dnnz);
455:       MatSeqAIJGetArray(b->A,&da);
456:     } else {
457:       MatGetRowIJ(*B,0,PETSC_FALSE,PETSC_FALSE,&nr,(const PetscInt**)&dii,(const PetscInt**)&djj,&done);
458:       if (nr != m) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot reuse mat: invalid number of local rows! %D != %D",nr,m);
459:       if (dii[nr] < dnnz) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot reuse mat: invalid number of nonzeros! reuse %D hypre %D",dii[nr],dnnz);
460:       MatSeqAIJGetArray(*B,&da);
461:     }
462:   } else { /* MAT_INPLACE_MATRIX */
463:     if (!sameint) {
464:       PetscMalloc1(m+1,&dii);
465:       PetscMalloc1(dnnz,&djj);
466:     } else {
467:       dii = (PetscInt*)hypre_CSRMatrixI(hdiag);
468:       djj = (PetscInt*)hypre_CSRMatrixJ(hdiag);
469:     }
470:     da = (PetscScalar*)hypre_CSRMatrixData(hdiag);
471:   }

473:   if (!sameint) {
474:     for (i=0;i<m+1;i++)  dii[i] = (PetscInt)(hypre_CSRMatrixI(hdiag)[i]);
475:     for (i=0;i<dnnz;i++) djj[i] = (PetscInt)(hypre_CSRMatrixJ(hdiag)[i]);
476:   } else {
477:     PetscArraycpy(dii,hypre_CSRMatrixI(hdiag),m+1);
478:     PetscArraycpy(djj,hypre_CSRMatrixJ(hdiag),dnnz);
479:   }
480:   PetscArraycpy(da,hypre_CSRMatrixData(hdiag),dnnz);
481:   iptr = djj;
482:   aptr = da;
483:   for (i=0; i<m; i++) {
484:     PetscInt nc = dii[i+1]-dii[i];
485:     PetscSortIntWithScalarArray(nc,iptr,aptr);
486:     iptr += nc;
487:     aptr += nc;
488:   }
489:   if (size > 1) {
490:     HYPRE_BigInt *coffd;
491:     HYPRE_Int    *offdj;

493:     if (reuse == MAT_INITIAL_MATRIX) {
494:       PetscMalloc1(m+1,&oii);
495:       PetscMalloc1(onnz,&ojj);
496:       PetscMalloc1(onnz,&oa);
497:     } else if (reuse == MAT_REUSE_MATRIX) {
498:       Mat_MPIAIJ *b = (Mat_MPIAIJ*)((*B)->data);
499:       PetscInt   nr,hr = hypre_CSRMatrixNumRows(hoffd);
500:       PetscBool  done;

502:       MatGetRowIJ(b->B,0,PETSC_FALSE,PETSC_FALSE,&nr,(const PetscInt**)&oii,(const PetscInt**)&ojj,&done);
503:       if (nr != hr) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot reuse mat: invalid number of local rows in offdiag part! %D != %D",nr,hr);
504:       if (oii[nr] < onnz) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot reuse mat: invalid number of nonzeros in offdiag part! reuse %D hypre %D",oii[nr],onnz);
505:       MatSeqAIJGetArray(b->B,&oa);
506:     } else { /* MAT_INPLACE_MATRIX */
507:       if (!sameint) {
508:         PetscMalloc1(m+1,&oii);
509:         PetscMalloc1(onnz,&ojj);
510:       } else {
511:         oii = (PetscInt*)hypre_CSRMatrixI(hoffd);
512:         ojj = (PetscInt*)hypre_CSRMatrixJ(hoffd);
513:       }
514:       oa = (PetscScalar*)hypre_CSRMatrixData(hoffd);
515:     }
516:     if (!sameint) {
517:       for (i=0;i<m+1;i++) oii[i] = (PetscInt)(hypre_CSRMatrixI(hoffd)[i]);
518:     } else {
519:       PetscArraycpy(oii,hypre_CSRMatrixI(hoffd),m+1);
520:     }
521:     offdj = hypre_CSRMatrixJ(hoffd);
522:     coffd = hypre_ParCSRMatrixColMapOffd(parcsr);
523:     for (i=0; i<onnz; i++) ojj[i] = coffd[offdj[i]];
524:     PetscArraycpy(oa,hypre_CSRMatrixData(hoffd),onnz);
525:     iptr = ojj;
526:     aptr = oa;
527:     for (i=0; i<m; i++) {
528:        PetscInt nc = oii[i+1]-oii[i];
529:        PetscSortIntWithScalarArray(nc,iptr,aptr);
530:        iptr += nc;
531:        aptr += nc;
532:     }
533:     if (reuse == MAT_INITIAL_MATRIX) {
534:       Mat_MPIAIJ *b;
535:       Mat_SeqAIJ *d,*o;

537:       MatCreateMPIAIJWithSplitArrays(comm,m,n,PETSC_DECIDE,PETSC_DECIDE,dii,djj,da,oii,ojj,oa,B);
538:       /* hack MPIAIJ */
539:       b          = (Mat_MPIAIJ*)((*B)->data);
540:       d          = (Mat_SeqAIJ*)b->A->data;
541:       o          = (Mat_SeqAIJ*)b->B->data;
542:       d->free_a  = PETSC_TRUE;
543:       d->free_ij = PETSC_TRUE;
544:       o->free_a  = PETSC_TRUE;
545:       o->free_ij = PETSC_TRUE;
546:     } else if (reuse == MAT_INPLACE_MATRIX) {
547:       Mat T;

549:       MatCreateMPIAIJWithSplitArrays(comm,m,n,PETSC_DECIDE,PETSC_DECIDE,dii,djj,da,oii,ojj,oa,&T);
550:       if (sameint) { /* ownership of CSR pointers is transferred to PETSc */
551:         hypre_CSRMatrixI(hdiag) = NULL;
552:         hypre_CSRMatrixJ(hdiag) = NULL;
553:         hypre_CSRMatrixI(hoffd) = NULL;
554:         hypre_CSRMatrixJ(hoffd) = NULL;
555:       } else { /* Hack MPIAIJ -> free ij but not a */
556:         Mat_MPIAIJ *b = (Mat_MPIAIJ*)(T->data);
557:         Mat_SeqAIJ *d = (Mat_SeqAIJ*)(b->A->data);
558:         Mat_SeqAIJ *o = (Mat_SeqAIJ*)(b->B->data);

560:         d->free_ij = PETSC_TRUE;
561:         o->free_ij = PETSC_TRUE;
562:       }
563:       hypre_CSRMatrixData(hdiag) = NULL;
564:       hypre_CSRMatrixData(hoffd) = NULL;
565:       MatHeaderReplace(A,&T);
566:     }
567:   } else {
568:     oii  = NULL;
569:     ojj  = NULL;
570:     oa   = NULL;
571:     if (reuse == MAT_INITIAL_MATRIX) {
572:       Mat_SeqAIJ* b;

574:       MatCreateSeqAIJWithArrays(comm,m,n,dii,djj,da,B);
575:       /* hack SeqAIJ */
576:       b          = (Mat_SeqAIJ*)((*B)->data);
577:       b->free_a  = PETSC_TRUE;
578:       b->free_ij = PETSC_TRUE;
579:     } else if (reuse == MAT_INPLACE_MATRIX) {
580:       Mat T;

582:       MatCreateSeqAIJWithArrays(comm,m,n,dii,djj,da,&T);
583:       if (sameint) { /* ownership of CSR pointers is transferred to PETSc */
584:         hypre_CSRMatrixI(hdiag) = NULL;
585:         hypre_CSRMatrixJ(hdiag) = NULL;
586:       } else { /* free ij but not a */
587:         Mat_SeqAIJ* b = (Mat_SeqAIJ*)(T->data);

589:         b->free_ij = PETSC_TRUE;
590:       }
591:       hypre_CSRMatrixData(hdiag) = NULL;
592:       MatHeaderReplace(A,&T);
593:     }
594:   }

596:   /* we have to use hypre_Tfree to free the HYPRE arrays
597:      that PETSc now onws */
598:   if (reuse == MAT_INPLACE_MATRIX) {
599:     PetscInt nh;
600:     void *ptrs[6] = {da,oa,dii,djj,oii,ojj};
601:     const char *names[6] = {"_hypre_csr_da",
602:                             "_hypre_csr_oa",
603:                             "_hypre_csr_dii",
604:                             "_hypre_csr_djj",
605:                             "_hypre_csr_oii",
606:                             "_hypre_csr_ojj"};
607:     nh = sameint ? 6 : 2;
608:     for (i=0; i<nh; i++) {
609:       PetscContainer c;

611:       PetscContainerCreate(comm,&c);
612:       PetscContainerSetPointer(c,ptrs[i]);
613:       PetscContainerSetUserDestroy(c,hypre_array_destroy);
614:       PetscObjectCompose((PetscObject)(*B),names[i],(PetscObject)c);
615:       PetscContainerDestroy(&c);
616:     }
617:   }
618:   return(0);
619: }

621: static PetscErrorCode MatAIJGetParCSR_Private(Mat A, hypre_ParCSRMatrix **hA)
622: {
623:   hypre_ParCSRMatrix *tA;
624:   hypre_CSRMatrix    *hdiag,*hoffd;
625:   Mat_SeqAIJ         *diag,*offd;
626:   PetscInt           *garray,i,noffd,dnnz,onnz,*row_starts,*col_starts;
627:   MPI_Comm           comm = PetscObjectComm((PetscObject)A);
628:   PetscBool          ismpiaij,isseqaij;
629:   PetscBool          sameint = (PetscBool)(sizeof(PetscInt) == sizeof(HYPRE_Int));
630:   PetscErrorCode     ierr;

633:   PetscObjectBaseTypeCompare((PetscObject)A,MATMPIAIJ,&ismpiaij);
634:   PetscObjectBaseTypeCompare((PetscObject)A,MATSEQAIJ,&isseqaij);
635:   if (!ismpiaij && !isseqaij) SETERRQ1(comm,PETSC_ERR_SUP,"Unsupported type %s",((PetscObject)A)->type_name);
636:   if (ismpiaij) {
637:     Mat_MPIAIJ *a = (Mat_MPIAIJ*)(A->data);

639:     diag   = (Mat_SeqAIJ*)a->A->data;
640:     offd   = (Mat_SeqAIJ*)a->B->data;
641:     garray = a->garray;
642:     noffd  = a->B->cmap->N;
643:     dnnz   = diag->nz;
644:     onnz   = offd->nz;
645:   } else {
646:     diag   = (Mat_SeqAIJ*)A->data;
647:     offd   = NULL;
648:     garray = NULL;
649:     noffd  = 0;
650:     dnnz   = diag->nz;
651:     onnz   = 0;
652:   }

654:   /* create a temporary ParCSR */
655:   if (HYPRE_AssumedPartitionCheck()) {
656:     PetscMPIInt myid;

658:     MPI_Comm_rank(comm,&myid);
659:     row_starts = A->rmap->range + myid;
660:     col_starts = A->cmap->range + myid;
661:   } else {
662:     row_starts = A->rmap->range;
663:     col_starts = A->cmap->range;
664:   }
665:   tA = hypre_ParCSRMatrixCreate(comm,A->rmap->N,A->cmap->N,(HYPRE_BigInt*)row_starts,(HYPRE_BigInt*)col_starts,noffd,dnnz,onnz);
666:   hypre_ParCSRMatrixSetRowStartsOwner(tA,0);
667:   hypre_ParCSRMatrixSetColStartsOwner(tA,0);

669:   /* set diagonal part */
670:   hdiag = hypre_ParCSRMatrixDiag(tA);
671:   if (sameint) { /* reuse CSR pointers */
672:     hypre_CSRMatrixI(hdiag) = (HYPRE_Int*)diag->i;
673:     hypre_CSRMatrixJ(hdiag) = (HYPRE_Int*)diag->j;
674:   } else { /* malloc CSR pointers */
675:     HYPRE_Int *hi,*hj;

677:     PetscMalloc2(A->rmap->n+1,&hi,dnnz,&hj);
678:     for (i = 0; i < A->rmap->n+1; i++) hi[i] = (HYPRE_Int)(diag->i[i]);
679:     for (i = 0; i < dnnz; i++)         hj[i] = (HYPRE_Int)(diag->j[i]);
680:     hypre_CSRMatrixI(hdiag) = hi;
681:     hypre_CSRMatrixJ(hdiag) = hj;
682:   }
683:   hypre_CSRMatrixData(hdiag)        = (HYPRE_Complex*)diag->a;
684:   hypre_CSRMatrixNumNonzeros(hdiag) = diag->nz;
685:   hypre_CSRMatrixSetRownnz(hdiag);
686:   hypre_CSRMatrixSetDataOwner(hdiag,0);

688:   /* set offdiagonal part */
689:   hoffd = hypre_ParCSRMatrixOffd(tA);
690:   if (offd) {
691:     if (sameint) { /* reuse CSR pointers */
692:       hypre_CSRMatrixI(hoffd) = (HYPRE_Int*)offd->i;
693:       hypre_CSRMatrixJ(hoffd) = (HYPRE_Int*)offd->j;
694:     } else { /* malloc CSR pointers */
695:       HYPRE_Int *hi,*hj;

697:       PetscMalloc2(A->rmap->n+1,&hi,onnz,&hj);
698:       for (i = 0; i < A->rmap->n+1; i++) hi[i] = (HYPRE_Int)(offd->i[i]);
699:       for (i = 0; i < onnz; i++)         hj[i] = (HYPRE_Int)(offd->j[i]);
700:       hypre_CSRMatrixI(hoffd) = hi;
701:       hypre_CSRMatrixJ(hoffd) = hj;
702:     }
703:     hypre_CSRMatrixData(hoffd)        = (HYPRE_Complex*)offd->a;
704:     hypre_CSRMatrixNumNonzeros(hoffd) = offd->nz;
705:     hypre_CSRMatrixSetRownnz(hoffd);
706:     hypre_CSRMatrixSetDataOwner(hoffd,0);
707:     hypre_ParCSRMatrixSetNumNonzeros(tA);
708:     hypre_ParCSRMatrixColMapOffd(tA) = (HYPRE_BigInt*)garray;
709:   }
710:   *hA = tA;
711:   return(0);
712: }

714: static PetscErrorCode MatAIJRestoreParCSR_Private(Mat A, hypre_ParCSRMatrix **hA)
715: {
716:   hypre_CSRMatrix *hdiag,*hoffd;
717:   PetscBool       sameint = (PetscBool)(sizeof(PetscInt) == sizeof(HYPRE_Int));
718:   PetscErrorCode  ierr;

721:   hdiag = hypre_ParCSRMatrixDiag(*hA);
722:   hoffd = hypre_ParCSRMatrixOffd(*hA);
723:   /* free temporary memory allocated by PETSc */
724:   if (!sameint) {
725:     HYPRE_Int *hi,*hj;

727:     hi = hypre_CSRMatrixI(hdiag);
728:     hj = hypre_CSRMatrixJ(hdiag);
729:     PetscFree2(hi,hj);
730:     if (hoffd) {
731:       hi = hypre_CSRMatrixI(hoffd);
732:       hj = hypre_CSRMatrixJ(hoffd);
733:       PetscFree2(hi,hj);
734:     }
735:   }
736:   /* set pointers to NULL before destroying tA */
737:   hypre_CSRMatrixI(hdiag)           = NULL;
738:   hypre_CSRMatrixJ(hdiag)           = NULL;
739:   hypre_CSRMatrixData(hdiag)        = NULL;
740:   hypre_CSRMatrixI(hoffd)           = NULL;
741:   hypre_CSRMatrixJ(hoffd)           = NULL;
742:   hypre_CSRMatrixData(hoffd)        = NULL;
743:   hypre_ParCSRMatrixColMapOffd(*hA) = NULL;
744:   hypre_ParCSRMatrixDestroy(*hA);
745:   *hA = NULL;
746:   return(0);
747: }

749: /* calls RAP from BoomerAMG:
750:    the resulting ParCSR will not own the column and row starts
751:    It looks like we don't need to have the diagonal entries
752:    ordered first in the rows of the diagonal part
753:    for boomerAMGBuildCoarseOperator to work */
754: static PetscErrorCode MatHYPRE_ParCSR_RAP(hypre_ParCSRMatrix *hR, hypre_ParCSRMatrix *hA,hypre_ParCSRMatrix *hP, hypre_ParCSRMatrix **hRAP)
755: {
756:   HYPRE_Int P_owns_col_starts,R_owns_row_starts;

759:   P_owns_col_starts = hypre_ParCSRMatrixOwnsColStarts(hP);
760:   R_owns_row_starts = hypre_ParCSRMatrixOwnsRowStarts(hR);
761:   PetscStackCallStandard(hypre_BoomerAMGBuildCoarseOperator,(hR,hA,hP,hRAP));
762:   PetscStackCallStandard(hypre_ParCSRMatrixSetNumNonzeros,(*hRAP));
763:   /* hypre_BoomerAMGBuildCoarseOperator steals the col_starts from P and the row_starts from R */
764:   hypre_ParCSRMatrixSetRowStartsOwner(*hRAP,0);
765:   hypre_ParCSRMatrixSetColStartsOwner(*hRAP,0);
766:   if (P_owns_col_starts) hypre_ParCSRMatrixSetColStartsOwner(hP,1);
767:   if (R_owns_row_starts) hypre_ParCSRMatrixSetRowStartsOwner(hR,1);
768:   return(0);
769: }

771: static PetscErrorCode MatPtAPNumeric_AIJ_AIJ_wHYPRE(Mat A,Mat P,Mat C)
772: {
773:   Mat                B;
774:   hypre_ParCSRMatrix *hA,*hP,*hPtAP;
775:   PetscErrorCode     ierr;
776:   Mat_Product        *product=C->product;

779:   MatAIJGetParCSR_Private(A,&hA);
780:   MatAIJGetParCSR_Private(P,&hP);
781:   MatHYPRE_ParCSR_RAP(hP,hA,hP,&hPtAP);
782:   MatCreateFromParCSR(hPtAP,MATAIJ,PETSC_OWN_POINTER,&B);

784:   MatHeaderMerge(C,&B);
785:   C->product = product;

787:   MatAIJRestoreParCSR_Private(A,&hA);
788:   MatAIJRestoreParCSR_Private(P,&hP);
789:   return(0);
790: }

792: PETSC_INTERN PetscErrorCode MatPtAPSymbolic_AIJ_AIJ_wHYPRE(Mat A,Mat P,PetscReal fill,Mat C)
793: {

797:   MatSetType(C,MATAIJ);
798:   C->ops->ptapnumeric    = MatPtAPNumeric_AIJ_AIJ_wHYPRE;
799:   C->ops->productnumeric = MatProductNumeric_PtAP;
800:   return(0);
801: }

803: static PetscErrorCode MatPtAPNumeric_AIJ_HYPRE(Mat A,Mat P,Mat C)
804: {
805:   Mat                B;
806:   Mat_HYPRE          *hP;
807:   hypre_ParCSRMatrix *hA = NULL,*Pparcsr,*ptapparcsr;
808:   HYPRE_Int          type;
809:   MPI_Comm           comm = PetscObjectComm((PetscObject)A);
810:   PetscBool          ishypre;
811:   PetscErrorCode     ierr;

814:   PetscObjectTypeCompare((PetscObject)P,MATHYPRE,&ishypre);
815:   if (!ishypre) SETERRQ1(comm,PETSC_ERR_USER,"P should be of type %s",MATHYPRE);
816:   hP = (Mat_HYPRE*)P->data;
817:   PetscStackCallStandard(HYPRE_IJMatrixGetObjectType,(hP->ij,&type));
818:   if (type != HYPRE_PARCSR) SETERRQ(comm,PETSC_ERR_SUP,"Only HYPRE_PARCSR is supported");
819:   PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hP->ij,(void**)&Pparcsr));

821:   MatAIJGetParCSR_Private(A,&hA);
822:   MatHYPRE_ParCSR_RAP(Pparcsr,hA,Pparcsr,&ptapparcsr);
823:   MatAIJRestoreParCSR_Private(A,&hA);

825:   /* create temporary matrix and merge to C */
826:   MatCreateFromParCSR(ptapparcsr,((PetscObject)C)->type_name,PETSC_OWN_POINTER,&B);
827:   MatHeaderMerge(C,&B);
828:   return(0);
829: }

831: static PetscErrorCode MatPtAPNumeric_HYPRE_HYPRE(Mat A,Mat P,Mat C)
832: {
833:   Mat                B;
834:   hypre_ParCSRMatrix *Aparcsr,*Pparcsr,*ptapparcsr;
835:   Mat_HYPRE          *hA,*hP;
836:   PetscBool          ishypre;
837:   HYPRE_Int          type;
838:   PetscErrorCode     ierr;

841:   PetscObjectTypeCompare((PetscObject)P,MATHYPRE,&ishypre);
842:   if (!ishypre) SETERRQ1(PetscObjectComm((PetscObject)P),PETSC_ERR_USER,"P should be of type %s",MATHYPRE);
843:   PetscObjectTypeCompare((PetscObject)A,MATHYPRE,&ishypre);
844:   if (!ishypre) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_USER,"A should be of type %s",MATHYPRE);
845:   hA = (Mat_HYPRE*)A->data;
846:   hP = (Mat_HYPRE*)P->data;
847:   PetscStackCallStandard(HYPRE_IJMatrixGetObjectType,(hA->ij,&type));
848:   if (type != HYPRE_PARCSR) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Only HYPRE_PARCSR is supported");
849:   PetscStackCallStandard(HYPRE_IJMatrixGetObjectType,(hP->ij,&type));
850:   if (type != HYPRE_PARCSR) SETERRQ(PetscObjectComm((PetscObject)P),PETSC_ERR_SUP,"Only HYPRE_PARCSR is supported");
851:   PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hA->ij,(void**)&Aparcsr));
852:   PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hP->ij,(void**)&Pparcsr));
853:   MatHYPRE_ParCSR_RAP(Pparcsr,Aparcsr,Pparcsr,&ptapparcsr);
854:   MatCreateFromParCSR(ptapparcsr,MATHYPRE,PETSC_OWN_POINTER,&B);
855:   MatHeaderMerge(C,&B);
856:   return(0);
857: }

859: /* calls hypre_ParMatmul
860:    hypre_ParMatMul uses hypre_ParMatrixCreate with the communicator of hA
861:    hypre_ParMatrixCreate does not duplicate the communicator
862:    It looks like we don't need to have the diagonal entries
863:    ordered first in the rows of the diagonal part
864:    for boomerAMGBuildCoarseOperator to work */
865: static PetscErrorCode MatHYPRE_ParCSR_MatMatMult(hypre_ParCSRMatrix *hA, hypre_ParCSRMatrix *hB, hypre_ParCSRMatrix **hAB)
866: {
868:   PetscStackPush("hypre_ParMatmul");
869:   *hAB = hypre_ParMatmul(hA,hB);
870:   PetscStackPop;
871:   return(0);
872: }

874: static PetscErrorCode MatMatMultNumeric_AIJ_AIJ_wHYPRE(Mat A,Mat B,Mat C)
875: {
876:   Mat                D;
877:   hypre_ParCSRMatrix *hA,*hB,*hAB = NULL;
878:   PetscErrorCode     ierr;
879:   Mat_Product        *product=C->product;

882:   MatAIJGetParCSR_Private(A,&hA);
883:   MatAIJGetParCSR_Private(B,&hB);
884:   MatHYPRE_ParCSR_MatMatMult(hA,hB,&hAB);
885:   MatCreateFromParCSR(hAB,MATAIJ,PETSC_OWN_POINTER,&D);

887:   MatHeaderMerge(C,&D);
888:   C->product = product;

890:   MatAIJRestoreParCSR_Private(A,&hA);
891:   MatAIJRestoreParCSR_Private(B,&hB);
892:   return(0);
893: }

895: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_AIJ_AIJ_wHYPRE(Mat A,Mat B,PetscReal fill,Mat C)
896: {

900:   MatSetType(C,MATAIJ);
901:   C->ops->matmultnumeric = MatMatMultNumeric_AIJ_AIJ_wHYPRE;
902:   C->ops->productnumeric = MatProductNumeric_AB;
903:   return(0);
904: }

906: static PetscErrorCode MatMatMultNumeric_HYPRE_HYPRE(Mat A,Mat B,Mat C)
907: {
908:   Mat                D;
909:   hypre_ParCSRMatrix *Aparcsr,*Bparcsr,*ABparcsr = NULL;
910:   Mat_HYPRE          *hA,*hB;
911:   PetscBool          ishypre;
912:   HYPRE_Int          type;
913:   PetscErrorCode     ierr;
914:   Mat_Product        *product;

917:   PetscObjectTypeCompare((PetscObject)B,MATHYPRE,&ishypre);
918:   if (!ishypre) SETERRQ1(PetscObjectComm((PetscObject)B),PETSC_ERR_USER,"B should be of type %s",MATHYPRE);
919:   PetscObjectTypeCompare((PetscObject)A,MATHYPRE,&ishypre);
920:   if (!ishypre) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_USER,"A should be of type %s",MATHYPRE);
921:   hA = (Mat_HYPRE*)A->data;
922:   hB = (Mat_HYPRE*)B->data;
923:   PetscStackCallStandard(HYPRE_IJMatrixGetObjectType,(hA->ij,&type));
924:   if (type != HYPRE_PARCSR) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Only HYPRE_PARCSR is supported");
925:   PetscStackCallStandard(HYPRE_IJMatrixGetObjectType,(hB->ij,&type));
926:   if (type != HYPRE_PARCSR) SETERRQ(PetscObjectComm((PetscObject)B),PETSC_ERR_SUP,"Only HYPRE_PARCSR is supported");
927:   PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hA->ij,(void**)&Aparcsr));
928:   PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hB->ij,(void**)&Bparcsr));
929:   MatHYPRE_ParCSR_MatMatMult(Aparcsr,Bparcsr,&ABparcsr);
930:   MatCreateFromParCSR(ABparcsr,MATHYPRE,PETSC_OWN_POINTER,&D);

932:   /* need to use HeaderReplace because HeaderMerge messes up with the communicator */
933:   product    = C->product;  /* save it from MatHeaderReplace() */
934:   C->product = NULL;
935:   MatHeaderReplace(C,&D);
936:   C->product = product;
937:   C->ops->matmultnumeric = MatMatMultNumeric_HYPRE_HYPRE;
938:   C->ops->productnumeric = MatProductNumeric_AB;
939:   return(0);
940: }

942: PETSC_INTERN PetscErrorCode MatTransposeMatMatMultNumeric_AIJ_AIJ_AIJ_wHYPRE(Mat A,Mat B,Mat C,Mat D)
943: {
944:   Mat                E;
945:   hypre_ParCSRMatrix *hA,*hB,*hC,*hABC;
946:   PetscErrorCode     ierr;

949:   MatAIJGetParCSR_Private(A,&hA);
950:   MatAIJGetParCSR_Private(B,&hB);
951:   MatAIJGetParCSR_Private(C,&hC);
952:   MatHYPRE_ParCSR_RAP(hA,hB,hC,&hABC);
953:   MatCreateFromParCSR(hABC,MATAIJ,PETSC_OWN_POINTER,&E);
954:   MatHeaderMerge(D,&E);
955:   MatAIJRestoreParCSR_Private(A,&hA);
956:   MatAIJRestoreParCSR_Private(B,&hB);
957:   MatAIJRestoreParCSR_Private(C,&hC);
958:   return(0);
959: }

961: PETSC_INTERN PetscErrorCode MatTransposeMatMatMultSymbolic_AIJ_AIJ_AIJ_wHYPRE(Mat A,Mat B,Mat C,PetscReal fill,Mat D)
962: {

966:   MatSetType(D,MATAIJ);
967:   return(0);
968: }

970: /* ---------------------------------------------------- */
971: static PetscErrorCode MatProductSymbolic_AB_HYPRE(Mat C)
972: {
974:   C->ops->productnumeric = MatProductNumeric_AB;
975:   return(0);
976: }

978: static PetscErrorCode MatProductSetFromOptions_HYPRE_AB(Mat C)
979: {
981:   Mat_Product    *product = C->product;
982:   PetscBool      Ahypre;

985:   PetscObjectTypeCompare((PetscObject)product->A,MATHYPRE,&Ahypre);
986:   if (Ahypre) { /* A is a Hypre matrix */
987:     MatSetType(C,MATHYPRE);
988:     C->ops->productsymbolic = MatProductSymbolic_AB_HYPRE;
989:     C->ops->matmultnumeric  = MatMatMultNumeric_HYPRE_HYPRE;
990:     return(0);
991:   } else SETERRQ(PetscObjectComm((PetscObject)C),PETSC_ERR_SUP,"A must be Hyper type");
992:   return(0);
993: }

995: static PetscErrorCode MatProductSymbolic_PtAP_HYPRE(Mat C)
996: {
998:   C->ops->productnumeric = MatProductNumeric_PtAP;
999:   return(0);
1000: }

1002: static PetscErrorCode MatProductSetFromOptions_HYPRE_PtAP(Mat C)
1003: {
1005:   Mat_Product    *product = C->product;
1006:   PetscBool      flg;
1007:   PetscInt       type = 0;
1008:   const char     *outTypes[4] = {"aij","seqaij","mpiaij","hypre"};
1009:   PetscInt       ntype = 4;
1010:   Mat            A = product->A;
1011:   PetscBool      Ahypre;

1014:   PetscObjectTypeCompare((PetscObject)A,MATHYPRE,&Ahypre);
1015:   if (Ahypre) { /* A is a Hypre matrix */
1016:     MatSetType(C,MATHYPRE);
1017:     C->ops->productsymbolic = MatProductSymbolic_PtAP_HYPRE;
1018:     C->ops->ptapnumeric     = MatPtAPNumeric_HYPRE_HYPRE;
1019:     return(0);
1020:   }

1022:   /* A is AIJ, P is Hypre, C = PtAP can be either AIJ or Hypre format */
1023:   /* Get runtime option */
1024:   if (product->api_user) {
1025:     PetscOptionsBegin(PetscObjectComm((PetscObject)C),((PetscObject)C)->prefix,"MatPtAP_HYPRE","Mat");
1026:     PetscOptionsEList("-matptap_hypre_outtype","MatPtAP outtype","MatPtAP outtype",outTypes,ntype,outTypes[type],&type,&flg);
1027:     PetscOptionsEnd();
1028:   } else {
1029:     PetscOptionsBegin(PetscObjectComm((PetscObject)C),((PetscObject)C)->prefix,"MatProduct_PtAP_HYPRE","Mat");
1030:     PetscOptionsEList("-matproduct_ptap_hypre_outtype","MatProduct_PtAP outtype","MatProduct_PtAP",outTypes,ntype,outTypes[type],&type,&flg);
1031:     PetscOptionsEnd();
1032:   }

1034:   if (type == 0 || type == 1 || type == 2) {
1035:     MatSetType(C,MATAIJ);
1036:   } else if (type == 3) {
1037:     MatSetType(C,MATHYPRE);
1038:   } else SETERRQ(PetscObjectComm((PetscObject)C),PETSC_ERR_SUP,"MatPtAP outtype is not supported");
1039:   C->ops->productsymbolic = MatProductSymbolic_PtAP_HYPRE;
1040:   C->ops->ptapnumeric     = MatPtAPNumeric_AIJ_HYPRE;
1041:   return(0);
1042: }

1044: static PetscErrorCode MatProductSetFromOptions_HYPRE(Mat C)
1045: {
1047:   Mat_Product    *product = C->product;

1050:   switch (product->type) {
1051:   case MATPRODUCT_AB:
1052:     MatProductSetFromOptions_HYPRE_AB(C);
1053:     break;
1054:   case MATPRODUCT_PtAP:
1055:     MatProductSetFromOptions_HYPRE_PtAP(C);
1056:     break;
1057:   default: SETERRQ1(PetscObjectComm((PetscObject)C),PETSC_ERR_SUP,"Mat Product type %s is not supported for HYPRE and HYPRE matrices",MatProductTypes[product->type]);
1058:   }
1059:   return(0);
1060: }

1062: /* -------------------------------------------------------- */

1064: static PetscErrorCode MatMultTranspose_HYPRE(Mat A, Vec x, Vec y)
1065: {

1069:   MatHYPRE_MultKernel_Private(A,1.0,x,0.0,y,PETSC_TRUE);
1070:   return(0);
1071: }

1073: static PetscErrorCode MatMult_HYPRE(Mat A, Vec x, Vec y)
1074: {

1078:   MatHYPRE_MultKernel_Private(A,1.0,x,0.0,y,PETSC_FALSE);
1079:   return(0);
1080: }

1082: static PetscErrorCode MatMultAdd_HYPRE(Mat A, Vec x, Vec y, Vec z)
1083: {

1087:   if (y != z) {
1088:     VecCopy(y,z);
1089:   }
1090:   MatHYPRE_MultKernel_Private(A,1.0,x,1.0,z,PETSC_FALSE);
1091:   return(0);
1092: }

1094: static PetscErrorCode MatMultTransposeAdd_HYPRE(Mat A, Vec x, Vec y, Vec z)
1095: {

1099:   if (y != z) {
1100:     VecCopy(y,z);
1101:   }
1102:   MatHYPRE_MultKernel_Private(A,1.0,x,1.0,z,PETSC_TRUE);
1103:   return(0);
1104: }

1106: /* y = a * A * x + b * y or y = a * A^t * x + b * y depending on trans */
1107: static PetscErrorCode MatHYPRE_MultKernel_Private(Mat A, HYPRE_Complex a, Vec x, HYPRE_Complex b, Vec y, PetscBool trans)
1108: {
1109:   Mat_HYPRE          *hA = (Mat_HYPRE*)A->data;
1110:   hypre_ParCSRMatrix *parcsr;
1111:   hypre_ParVector    *hx,*hy;
1112:   HYPRE_Complex      *ax,*ay,*sax,*say;
1113:   PetscErrorCode     ierr;

1116:   PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hA->ij,(void**)&parcsr));
1117:   PetscStackCallStandard(HYPRE_IJVectorGetObject,(hA->x,(void**)&hx));
1118:   PetscStackCallStandard(HYPRE_IJVectorGetObject,(hA->b,(void**)&hy));
1119:   VecGetArrayRead(x,(const PetscScalar**)&ax);
1120:   VecGetArray(y,(PetscScalar**)&ay);
1121:   if (trans) {
1122:     VecHYPRE_ParVectorReplacePointer(hA->x,ay,say);
1123:     VecHYPRE_ParVectorReplacePointer(hA->b,ax,sax);
1124:     hypre_ParCSRMatrixMatvecT(a,parcsr,hy,b,hx);
1125:     VecHYPRE_ParVectorReplacePointer(hA->x,say,ay);
1126:     VecHYPRE_ParVectorReplacePointer(hA->b,sax,ax);
1127:   } else {
1128:     VecHYPRE_ParVectorReplacePointer(hA->x,ax,sax);
1129:     VecHYPRE_ParVectorReplacePointer(hA->b,ay,say);
1130:     hypre_ParCSRMatrixMatvec(a,parcsr,hx,b,hy);
1131:     VecHYPRE_ParVectorReplacePointer(hA->x,sax,ax);
1132:     VecHYPRE_ParVectorReplacePointer(hA->b,say,ay);
1133:   }
1134:   VecRestoreArrayRead(x,(const PetscScalar**)&ax);
1135:   VecRestoreArray(y,(PetscScalar**)&ay);
1136:   return(0);
1137: }

1139: static PetscErrorCode MatDestroy_HYPRE(Mat A)
1140: {
1141:   Mat_HYPRE      *hA = (Mat_HYPRE*)A->data;

1145:   if (hA->x) PetscStackCallStandard(HYPRE_IJVectorDestroy,(hA->x));
1146:   if (hA->b) PetscStackCallStandard(HYPRE_IJVectorDestroy,(hA->b));
1147:   if (hA->ij) {
1148:     if (!hA->inner_free) hypre_IJMatrixObject(hA->ij) = NULL;
1149:     PetscStackCallStandard(HYPRE_IJMatrixDestroy,(hA->ij));
1150:   }
1151:   if (hA->comm) { MPI_Comm_free(&hA->comm); }

1153:   MatStashDestroy_Private(&A->stash);

1155:   PetscFree(hA->array);

1157:   PetscObjectComposeFunction((PetscObject)A,"MatConvert_hypre_aij_C",NULL);
1158:   PetscObjectComposeFunction((PetscObject)A,"MatConvert_hypre_is_C",NULL);
1159:   PetscObjectComposeFunction((PetscObject)A,"MatProductSetFromOptions_seqaij_hypre_C",NULL);
1160:   PetscObjectComposeFunction((PetscObject)A,"MatProductSetFromOptions_mpiaij_hypre_C",NULL);
1161:   PetscObjectComposeFunction((PetscObject)A,"MatHYPRESetPreallocation_C",NULL);
1162:   PetscObjectComposeFunction((PetscObject)A,"MatHYPREGetParCSR_C",NULL);
1163:   PetscFree(A->data);
1164:   return(0);
1165: }

1167: static PetscErrorCode MatSetUp_HYPRE(Mat A)
1168: {

1172:   MatHYPRESetPreallocation(A,PETSC_DEFAULT,NULL,PETSC_DEFAULT,NULL);
1173:   return(0);
1174: }

1176: static PetscErrorCode MatAssemblyEnd_HYPRE(Mat A, MatAssemblyType mode)
1177: {
1178:   Mat_HYPRE          *hA = (Mat_HYPRE*)A->data;
1179:   Vec                x,b;
1180:   PetscMPIInt        n;
1181:   PetscInt           i,j,rstart,ncols,flg;
1182:   PetscInt           *row,*col;
1183:   PetscScalar        *val;
1184:   PetscErrorCode     ierr;

1187:   if (mode == MAT_FLUSH_ASSEMBLY) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"MAT_FLUSH_ASSEMBLY currently not supported with MATHYPRE");

1189:   if (!A->nooffprocentries) {
1190:     while (1) {
1191:       MatStashScatterGetMesg_Private(&A->stash,&n,&row,&col,&val,&flg);
1192:       if (!flg) break;

1194:       for (i=0; i<n; ) {
1195:         /* Now identify the consecutive vals belonging to the same row */
1196:         for (j=i,rstart=row[j]; j<n; j++) {
1197:           if (row[j] != rstart) break;
1198:         }
1199:         if (j < n) ncols = j-i;
1200:         else       ncols = n-i;
1201:         /* Now assemble all these values with a single function call */
1202:         MatSetValues_HYPRE(A,1,row+i,ncols,col+i,val+i,A->insertmode);

1204:         i = j;
1205:       }
1206:     }
1207:     MatStashScatterEnd_Private(&A->stash);
1208:   }

1210:   PetscStackCallStandard(HYPRE_IJMatrixAssemble,(hA->ij));
1211:   /* The assembly routine destroys the aux_matrix, we recreate it here by calling HYPRE_IJMatrixInitialize */
1212:   /* If the option MAT_SORTED_FULL is set to true, the indices and values can be passed to hypre directly, so we don't need the aux_matrix */
1213:   if(!hA->sorted_full) {
1214:     hypre_AuxParCSRMatrix *aux_matrix;

1216:     /* call destroy just to make sure we do not leak anything */
1217:     aux_matrix = (hypre_AuxParCSRMatrix*)hypre_IJMatrixTranslator(hA->ij);
1218:     PetscStackCallStandard(hypre_AuxParCSRMatrixDestroy,(aux_matrix));
1219:     hypre_IJMatrixTranslator(hA->ij) = NULL;

1221:     /* Initialize with assembled flag -> it only recreates the aux_par_matrix */
1222:     PetscStackCallStandard(HYPRE_IJMatrixInitialize,(hA->ij));
1223:     aux_matrix = (hypre_AuxParCSRMatrix*)hypre_IJMatrixTranslator(hA->ij);
1224:     hypre_AuxParCSRMatrixNeedAux(aux_matrix) = 1; /* see comment in MatHYPRESetPreallocation_HYPRE */
1225:     PetscStackCallStandard(hypre_AuxParCSRMatrixInitialize,(aux_matrix));
1226:   }
1227:   if (hA->x) return(0);
1228:   PetscLayoutSetUp(A->rmap);
1229:   PetscLayoutSetUp(A->cmap);
1230:   VecCreateMPIWithArray(PetscObjectComm((PetscObject)A),1,A->cmap->n,A->cmap->N,NULL,&x);
1231:   VecCreateMPIWithArray(PetscObjectComm((PetscObject)A),1,A->rmap->n,A->rmap->N,NULL,&b);
1232:   VecHYPRE_IJVectorCreate(x,&hA->x);
1233:   VecHYPRE_IJVectorCreate(b,&hA->b);
1234:   VecDestroy(&x);
1235:   VecDestroy(&b);
1236:   return(0);
1237: }

1239: static PetscErrorCode MatGetArray_HYPRE(Mat A, PetscInt size, void **array)
1240: {
1241:   Mat_HYPRE          *hA = (Mat_HYPRE*)A->data;
1242:   PetscErrorCode     ierr;

1245:   if (!hA->available) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Temporary space is in use");

1247:   if (hA->size >= size) {
1248:     *array = hA->array;
1249:   } else {
1250:     PetscFree(hA->array);
1251:     hA->size = size;
1252:     PetscMalloc(hA->size,&hA->array);
1253:     *array = hA->array;
1254:   }

1256:   hA->available = PETSC_FALSE;
1257:   return(0);
1258: }

1260: static PetscErrorCode MatRestoreArray_HYPRE(Mat A, void **array)
1261: {
1262:   Mat_HYPRE          *hA = (Mat_HYPRE*)A->data;

1265:   *array = NULL;
1266:   hA->available = PETSC_TRUE;
1267:   return(0);
1268: }

1270: PetscErrorCode MatSetValues_HYPRE(Mat A, PetscInt nr, const PetscInt rows[], PetscInt nc, const PetscInt cols[], const PetscScalar v[], InsertMode ins)
1271: {
1272:   Mat_HYPRE          *hA = (Mat_HYPRE*)A->data;
1273:   PetscScalar        *vals = (PetscScalar *)v;
1274:   HYPRE_Complex      *sscr;
1275:   PetscInt           *cscr[2];
1276:   PetscInt           i,nzc;
1277:   void               *array = NULL;
1278:   PetscErrorCode     ierr;

1281:   MatGetArray_HYPRE(A,sizeof(PetscInt)*(2*nc)+sizeof(HYPRE_Complex)*nc*nr,&array);
1282:   cscr[0] = (PetscInt*)array;
1283:   cscr[1] = ((PetscInt*)array)+nc;
1284:   sscr = (HYPRE_Complex*)(((PetscInt*)array)+nc*2);
1285:   for (i=0,nzc=0;i<nc;i++) {
1286:     if (cols[i] >= 0) {
1287:       cscr[0][nzc  ] = cols[i];
1288:       cscr[1][nzc++] = i;
1289:     }
1290:   }
1291:   if (!nzc) {
1292:     MatRestoreArray_HYPRE(A,&array);
1293:     return(0);
1294:   }

1296:   if (ins == ADD_VALUES) {
1297:     for (i=0;i<nr;i++) {
1298:       if (rows[i] >= 0 && nzc) {
1299:         PetscInt  j;
1300:         HYPRE_Int hnc = (HYPRE_Int)nzc;

1302:         if ((PetscInt)hnc != nzc) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_SUP,"Hypre overflow! number of columns %D for row %D",nzc,rows[i]);
1303:         for (j=0;j<nzc;j++) { PetscHYPREScalarCast(vals[cscr[1][j]],&sscr[j]); }
1304:         PetscStackCallStandard(HYPRE_IJMatrixAddToValues,(hA->ij,1,&hnc,(HYPRE_BigInt*)(rows+i),(HYPRE_BigInt*)cscr[0],sscr));
1305:       }
1306:       vals += nc;
1307:     }
1308:   } else { /* INSERT_VALUES */
1309:     PetscInt rst,ren;

1311:     MatGetOwnershipRange(A,&rst,&ren);
1312:     for (i=0;i<nr;i++) {
1313:       if (rows[i] >= 0 && nzc) {
1314:         PetscInt  j;
1315:         HYPRE_Int hnc = (HYPRE_Int)nzc;

1317:         if ((PetscInt)hnc != nzc) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_SUP,"Hypre overflow! number of columns %D for row %D",nzc,rows[i]);
1318:         for (j=0;j<nzc;j++) { PetscHYPREScalarCast(vals[cscr[1][j]],&sscr[j]); }
1319:         /* nonlocal values */
1320:         if (rows[i] < rst || rows[i] >= ren) { MatStashValuesRow_Private(&A->stash,rows[i],nzc,cscr[0],(PetscScalar*)sscr,PETSC_FALSE); }
1321:         /* local values */
1322:         else PetscStackCallStandard(HYPRE_IJMatrixSetValues,(hA->ij,1,&hnc,(HYPRE_BigInt*)(rows+i),(HYPRE_BigInt*)cscr[0],sscr));
1323:       }
1324:       vals += nc;
1325:     }
1326:   }

1328:   MatRestoreArray_HYPRE(A,&array);
1329:   return(0);
1330: }

1332: static PetscErrorCode MatHYPRESetPreallocation_HYPRE(Mat A, PetscInt dnz, const PetscInt dnnz[], PetscInt onz, const PetscInt onnz[])
1333: {
1334:   Mat_HYPRE      *hA = (Mat_HYPRE*)A->data;
1335:   HYPRE_Int      *hdnnz,*honnz;
1336:   PetscInt       i,rs,re,cs,ce,bs;
1337:   PetscMPIInt    size;

1341:   MatGetBlockSize(A,&bs);
1342:   PetscLayoutSetUp(A->rmap);
1343:   PetscLayoutSetUp(A->cmap);
1344:   rs   = A->rmap->rstart;
1345:   re   = A->rmap->rend;
1346:   cs   = A->cmap->rstart;
1347:   ce   = A->cmap->rend;
1348:   if (!hA->ij) {
1349:     PetscStackCallStandard(HYPRE_IJMatrixCreate,(hA->comm,rs,re-1,cs,ce-1,&hA->ij));
1350:     PetscStackCallStandard(HYPRE_IJMatrixSetObjectType,(hA->ij,HYPRE_PARCSR));
1351:   } else {
1352:     HYPRE_BigInt hrs,hre,hcs,hce;
1353:     PetscStackCallStandard(HYPRE_IJMatrixGetLocalRange,(hA->ij,&hrs,&hre,&hcs,&hce));
1354:     if (hre-hrs+1 != re -rs) SETERRQ4(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Inconsistent local rows: IJMatrix [%D,%D), PETSc [%D,%D)",hrs,hre+1,rs,re);
1355:     if (hce-hcs+1 != ce -cs) SETERRQ4(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Inconsistent local cols: IJMatrix [%D,%D), PETSc [%D,%D)",hcs,hce+1,cs,ce);
1356:   }
1357:   if (dnz == PETSC_DEFAULT || dnz == PETSC_DECIDE) dnz = 10*bs;
1358:   if (onz == PETSC_DEFAULT || onz == PETSC_DECIDE) onz = 10*bs;

1360:   if (!dnnz) {
1361:     PetscMalloc1(A->rmap->n,&hdnnz);
1362:     for (i=0;i<A->rmap->n;i++) hdnnz[i] = dnz;
1363:   } else {
1364:     hdnnz = (HYPRE_Int*)dnnz;
1365:   }
1366:   MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);
1367:   if (size > 1) {
1368:     hypre_AuxParCSRMatrix *aux_matrix;
1369:     if (!onnz) {
1370:       PetscMalloc1(A->rmap->n,&honnz);
1371:       for (i=0;i<A->rmap->n;i++) honnz[i] = onz;
1372:     } else {
1373:       honnz = (HYPRE_Int*)onnz;
1374:     }
1375:     /* SetDiagOffdSizes sets hypre_AuxParCSRMatrixNeedAux(aux_matrix) = 0, since it seems
1376:        they assume the user will input the entire row values, properly sorted
1377:        In PETSc, we don't make such an assumption and set this flag to 1,
1378:        unless the option MAT_SORTED_FULL is set to true.
1379:        Also, to avoid possible memory leaks, we destroy and recreate the translator
1380:        This has to be done here, as HYPRE_IJMatrixInitialize will properly initialize
1381:        the IJ matrix for us */
1382:     aux_matrix = (hypre_AuxParCSRMatrix*)hypre_IJMatrixTranslator(hA->ij);
1383:     hypre_AuxParCSRMatrixDestroy(aux_matrix);
1384:     hypre_IJMatrixTranslator(hA->ij) = NULL;
1385:     PetscStackCallStandard(HYPRE_IJMatrixSetDiagOffdSizes,(hA->ij,hdnnz,honnz));
1386:     aux_matrix = (hypre_AuxParCSRMatrix*)hypre_IJMatrixTranslator(hA->ij);
1387:     hypre_AuxParCSRMatrixNeedAux(aux_matrix) = !hA->sorted_full;
1388:   } else {
1389:     honnz = NULL;
1390:     PetscStackCallStandard(HYPRE_IJMatrixSetRowSizes,(hA->ij,hdnnz));
1391:   }

1393:   /* reset assembled flag and call the initialize method */
1394:   hypre_IJMatrixAssembleFlag(hA->ij) = 0;
1395:   PetscStackCallStandard(HYPRE_IJMatrixInitialize,(hA->ij));
1396:   if (!dnnz) {
1397:     PetscFree(hdnnz);
1398:   }
1399:   if (!onnz && honnz) {
1400:     PetscFree(honnz);
1401:   }

1403:   /* Match AIJ logic */
1404:   A->preallocated = PETSC_TRUE;
1405:   A->assembled    = PETSC_FALSE;
1406:   return(0);
1407: }

1409: /*@C
1410:    MatHYPRESetPreallocation - Preallocates memory for a sparse parallel matrix in HYPRE IJ format

1412:    Collective on Mat

1414:    Input Parameters:
1415: +  A - the matrix
1416: .  dnz  - number of nonzeros per row in DIAGONAL portion of local submatrix
1417:           (same value is used for all local rows)
1418: .  dnnz - array containing the number of nonzeros in the various rows of the
1419:           DIAGONAL portion of the local submatrix (possibly different for each row)
1420:           or NULL (PETSC_NULL_INTEGER in Fortran), if d_nz is used to specify the nonzero structure.
1421:           The size of this array is equal to the number of local rows, i.e 'm'.
1422:           For matrices that will be factored, you must leave room for (and set)
1423:           the diagonal entry even if it is zero.
1424: .  onz  - number of nonzeros per row in the OFF-DIAGONAL portion of local
1425:           submatrix (same value is used for all local rows).
1426: -  onnz - array containing the number of nonzeros in the various rows of the
1427:           OFF-DIAGONAL portion of the local submatrix (possibly different for
1428:           each row) or NULL (PETSC_NULL_INTEGER in Fortran), if o_nz is used to specify the nonzero
1429:           structure. The size of this array is equal to the number
1430:           of local rows, i.e 'm'.

1432:    Notes:
1433:     If the *nnz parameter is given then the *nz parameter is ignored; for sequential matrices, onz and onnz are ignored.

1435:    Level: intermediate

1437: .seealso: MatCreate(), MatMPIAIJSetPreallocation(), MATHYPRE
1438: @*/
1439: PetscErrorCode MatHYPRESetPreallocation(Mat A, PetscInt dnz, const PetscInt dnnz[], PetscInt onz, const PetscInt onnz[])
1440: {

1446:   PetscTryMethod(A,"MatHYPRESetPreallocation_C",(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]),(A,dnz,dnnz,onz,onnz));
1447:   return(0);
1448: }

1450: /*
1451:    MatCreateFromParCSR - Creates a matrix from a hypre_ParCSRMatrix

1453:    Collective

1455:    Input Parameters:
1456: +  parcsr   - the pointer to the hypre_ParCSRMatrix
1457: .  mtype    - matrix type to be created. Currently MATAIJ, MATIS and MATHYPRE are supported.
1458: -  copymode - PETSc copying options

1460:    Output Parameter:
1461: .  A  - the matrix

1463:    Level: intermediate

1465: .seealso: MatHYPRE, PetscCopyMode
1466: */
1467: PETSC_EXTERN PetscErrorCode MatCreateFromParCSR(hypre_ParCSRMatrix *parcsr, MatType mtype, PetscCopyMode copymode, Mat* A)
1468: {
1469:   Mat                   T;
1470:   Mat_HYPRE             *hA;
1471:   MPI_Comm              comm;
1472:   PetscInt              rstart,rend,cstart,cend,M,N;
1473:   PetscBool             isseqaij,isseqaijmkl,ismpiaij,isaij,ishyp,isis;
1474:   PetscErrorCode        ierr;

1477:   comm   = hypre_ParCSRMatrixComm(parcsr);
1478:   PetscStrcmp(mtype,MATSEQAIJ,&isseqaij);
1479:   PetscStrcmp(mtype,MATSEQAIJMKL,&isseqaijmkl);
1480:   PetscStrcmp(mtype,MATMPIAIJ,&ismpiaij);
1481:   PetscStrcmp(mtype,MATAIJ,&isaij);
1482:   PetscStrcmp(mtype,MATHYPRE,&ishyp);
1483:   PetscStrcmp(mtype,MATIS,&isis);
1484:   isaij  = (PetscBool)(isseqaij || isseqaijmkl || ismpiaij || isaij);
1485:   if (!isaij && !ishyp && !isis) SETERRQ7(comm,PETSC_ERR_SUP,"Unsupported MatType %s! Supported types are %s, %s, %s, %s, %s, and %s",mtype,MATAIJ,MATSEQAIJ,MATSEQAIJMKL,MATMPIAIJ,MATIS,MATHYPRE);
1486:   /* access ParCSRMatrix */
1487:   rstart = hypre_ParCSRMatrixFirstRowIndex(parcsr);
1488:   rend   = hypre_ParCSRMatrixLastRowIndex(parcsr);
1489:   cstart = hypre_ParCSRMatrixFirstColDiag(parcsr);
1490:   cend   = hypre_ParCSRMatrixLastColDiag(parcsr);
1491:   M      = hypre_ParCSRMatrixGlobalNumRows(parcsr);
1492:   N      = hypre_ParCSRMatrixGlobalNumCols(parcsr);

1494:   /* fix for empty local rows/columns */
1495:   if (rend < rstart) rend = rstart;
1496:   if (cend < cstart) cend = cstart;

1498:   /* PETSc convention */
1499:   rend++;
1500:   cend++;
1501:   rend = PetscMin(rend,M);
1502:   cend = PetscMin(cend,N);

1504:   /* create PETSc matrix with MatHYPRE */
1505:   MatCreate(comm,&T);
1506:   MatSetSizes(T,rend-rstart,cend-cstart,M,N);
1507:   MatSetType(T,MATHYPRE);
1508:   hA   = (Mat_HYPRE*)(T->data);

1510:   /* create HYPRE_IJMatrix */
1511:   PetscStackCallStandard(HYPRE_IJMatrixCreate,(hA->comm,rstart,rend-1,cstart,cend-1,&hA->ij));
1512:   PetscStackCallStandard(HYPRE_IJMatrixSetObjectType,(hA->ij,HYPRE_PARCSR));

1514:   /* create new ParCSR object if needed */
1515:   if (ishyp && copymode == PETSC_COPY_VALUES) {
1516:     hypre_ParCSRMatrix *new_parcsr;
1517:     hypre_CSRMatrix    *hdiag,*hoffd,*ndiag,*noffd;

1519:     new_parcsr = hypre_ParCSRMatrixClone(parcsr,0);
1520:     hdiag      = hypre_ParCSRMatrixDiag(parcsr);
1521:     hoffd      = hypre_ParCSRMatrixOffd(parcsr);
1522:     ndiag      = hypre_ParCSRMatrixDiag(new_parcsr);
1523:     noffd      = hypre_ParCSRMatrixOffd(new_parcsr);
1524:     PetscArraycpy(hypre_CSRMatrixData(ndiag),hypre_CSRMatrixData(hdiag),hypre_CSRMatrixNumNonzeros(hdiag));
1525:     PetscArraycpy(hypre_CSRMatrixData(noffd),hypre_CSRMatrixData(hoffd),hypre_CSRMatrixNumNonzeros(hoffd));
1526:     parcsr     = new_parcsr;
1527:     copymode   = PETSC_OWN_POINTER;
1528:   }

1530:   /* set ParCSR object */
1531:   hypre_IJMatrixObject(hA->ij) = parcsr;
1532:   T->preallocated = PETSC_TRUE;

1534:   /* set assembled flag */
1535:   hypre_IJMatrixAssembleFlag(hA->ij) = 1;
1536:   PetscStackCallStandard(HYPRE_IJMatrixInitialize,(hA->ij));
1537:   if (ishyp) {
1538:     PetscMPIInt myid = 0;

1540:     /* make sure we always have row_starts and col_starts available */
1541:     if (HYPRE_AssumedPartitionCheck()) {
1542:       MPI_Comm_rank(comm,&myid);
1543:     }
1544:     if (!hypre_ParCSRMatrixOwnsColStarts(parcsr)) {
1545:       PetscLayout map;

1547:       MatGetLayouts(T,NULL,&map);
1548:       PetscLayoutSetUp(map);
1549:       hypre_ParCSRMatrixColStarts(parcsr) = (HYPRE_BigInt*)(map->range + myid);
1550:     }
1551:     if (!hypre_ParCSRMatrixOwnsRowStarts(parcsr)) {
1552:       PetscLayout map;

1554:       MatGetLayouts(T,&map,NULL);
1555:       PetscLayoutSetUp(map);
1556:       hypre_ParCSRMatrixRowStarts(parcsr) = (HYPRE_BigInt*)(map->range + myid);
1557:     }
1558:     /* prevent from freeing the pointer */
1559:     if (copymode == PETSC_USE_POINTER) hA->inner_free = PETSC_FALSE;
1560:     *A   = T;
1561:     MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);
1562:     MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);
1563:   } else if (isaij) {
1564:     if (copymode != PETSC_OWN_POINTER) {
1565:       /* prevent from freeing the pointer */
1566:       hA->inner_free = PETSC_FALSE;
1567:       MatConvert_HYPRE_AIJ(T,MATAIJ,MAT_INITIAL_MATRIX,A);
1568:       MatDestroy(&T);
1569:     } else { /* AIJ return type with PETSC_OWN_POINTER */
1570:       MatConvert_HYPRE_AIJ(T,MATAIJ,MAT_INPLACE_MATRIX,&T);
1571:       *A   = T;
1572:     }
1573:   } else if (isis) {
1574:     MatConvert_HYPRE_IS(T,MATIS,MAT_INITIAL_MATRIX,A);
1575:     if (copymode != PETSC_OWN_POINTER) hA->inner_free = PETSC_FALSE;
1576:     MatDestroy(&T);
1577:   }
1578:   return(0);
1579: }

1581: static PetscErrorCode MatHYPREGetParCSR_HYPRE(Mat A, hypre_ParCSRMatrix **parcsr)
1582: {
1583:   Mat_HYPRE *hA = (Mat_HYPRE*)A->data;
1584:   HYPRE_Int type;

1587:   if (!hA->ij) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_PLIB,"HYPRE_IJMatrix not present");
1588:   PetscStackCallStandard(HYPRE_IJMatrixGetObjectType,(hA->ij,&type));
1589:   if (type != HYPRE_PARCSR) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"HYPRE_IJMatrix is not of type HYPRE_PARCSR");
1590:   PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hA->ij,(void**)parcsr));
1591:   return(0);
1592: }

1594: /*
1595:    MatHYPREGetParCSR - Gets the pointer to the ParCSR matrix

1597:    Not collective

1599:    Input Parameters:
1600: +  A  - the MATHYPRE object

1602:    Output Parameter:
1603: .  parcsr  - the pointer to the hypre_ParCSRMatrix

1605:    Level: intermediate

1607: .seealso: MatHYPRE, PetscCopyMode
1608: */
1609: PetscErrorCode MatHYPREGetParCSR(Mat A, hypre_ParCSRMatrix **parcsr)
1610: {

1616:   PetscUseMethod(A,"MatHYPREGetParCSR_C",(Mat,hypre_ParCSRMatrix**),(A,parcsr));
1617:   return(0);
1618: }

1620: static PetscErrorCode MatMissingDiagonal_HYPRE(Mat A, PetscBool *missing, PetscInt *dd)
1621: {
1622:   hypre_ParCSRMatrix *parcsr;
1623:   hypre_CSRMatrix    *ha;
1624:   PetscInt           rst;
1625:   PetscErrorCode     ierr;

1628:   if (A->rmap->n != A->cmap->n) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Not implemented with non-square diagonal blocks");
1629:   MatGetOwnershipRange(A,&rst,NULL);
1630:   MatHYPREGetParCSR_HYPRE(A,&parcsr);
1631:   if (missing) *missing = PETSC_FALSE;
1632:   if (dd) *dd = -1;
1633:   ha = hypre_ParCSRMatrixDiag(parcsr);
1634:   if (ha) {
1635:     PetscInt  size,i;
1636:     HYPRE_Int *ii,*jj;

1638:     size = hypre_CSRMatrixNumRows(ha);
1639:     ii   = hypre_CSRMatrixI(ha);
1640:     jj   = hypre_CSRMatrixJ(ha);
1641:     for (i = 0; i < size; i++) {
1642:       PetscInt  j;
1643:       PetscBool found = PETSC_FALSE;

1645:       for (j = ii[i]; j < ii[i+1] && !found; j++)
1646:         found = (jj[j] == i) ? PETSC_TRUE : PETSC_FALSE;

1648:       if (!found) {
1649:         PetscInfo1(A,"Matrix is missing local diagonal entry %D\n",i);
1650:         if (missing) *missing = PETSC_TRUE;
1651:         if (dd) *dd = i+rst;
1652:         return(0);
1653:       }
1654:     }
1655:     if (!size) {
1656:       PetscInfo(A,"Matrix has no diagonal entries therefore is missing diagonal\n");
1657:       if (missing) *missing = PETSC_TRUE;
1658:       if (dd) *dd = rst;
1659:     }
1660:   } else {
1661:     PetscInfo(A,"Matrix has no diagonal entries therefore is missing diagonal\n");
1662:     if (missing) *missing = PETSC_TRUE;
1663:     if (dd) *dd = rst;
1664:   }
1665:   return(0);
1666: }

1668: static PetscErrorCode MatScale_HYPRE(Mat A, PetscScalar s)
1669: {
1670:   hypre_ParCSRMatrix *parcsr;
1671:   hypre_CSRMatrix    *ha;
1672:   PetscErrorCode     ierr;
1673:   HYPRE_Complex      hs;

1676:   PetscHYPREScalarCast(s,&hs);
1677:   MatHYPREGetParCSR_HYPRE(A,&parcsr);
1678:   /* diagonal part */
1679:   ha = hypre_ParCSRMatrixDiag(parcsr);
1680:   if (ha) {
1681:     PetscInt      size,i;
1682:     HYPRE_Int     *ii;
1683:     HYPRE_Complex *a;

1685:     size = hypre_CSRMatrixNumRows(ha);
1686:     a    = hypre_CSRMatrixData(ha);
1687:     ii   = hypre_CSRMatrixI(ha);
1688:     for (i = 0; i < ii[size]; i++) a[i] *= hs;
1689:   }
1690:   /* offdiagonal part */
1691:   ha = hypre_ParCSRMatrixOffd(parcsr);
1692:   if (ha) {
1693:     PetscInt      size,i;
1694:     HYPRE_Int     *ii;
1695:     HYPRE_Complex *a;

1697:     size = hypre_CSRMatrixNumRows(ha);
1698:     a    = hypre_CSRMatrixData(ha);
1699:     ii   = hypre_CSRMatrixI(ha);
1700:     for (i = 0; i < ii[size]; i++) a[i] *= hs;
1701:   }
1702:   return(0);
1703: }

1705: static PetscErrorCode MatZeroRowsColumns_HYPRE(Mat A, PetscInt numRows, const PetscInt rows[], PetscScalar diag, Vec x, Vec b)
1706: {
1707:   hypre_ParCSRMatrix *parcsr;
1708:   HYPRE_Int          *lrows;
1709:   PetscInt           rst,ren,i;
1710:   PetscErrorCode     ierr;

1713:   if (x || b) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"To be implemented");
1714:   MatHYPREGetParCSR_HYPRE(A,&parcsr);
1715:   PetscMalloc1(numRows,&lrows);
1716:   MatGetOwnershipRange(A,&rst,&ren);
1717:   for (i=0;i<numRows;i++) {
1718:     if (rows[i] < rst || rows[i] >= ren)
1719:       SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Non-local rows not yet supported");
1720:     lrows[i] = rows[i] - rst;
1721:   }
1722:   PetscStackCallStandard(hypre_ParCSRMatrixEliminateRowsCols,(parcsr,numRows,lrows));
1723:   PetscFree(lrows);
1724:   return(0);
1725: }

1727: static PetscErrorCode MatZeroEntries_HYPRE_CSRMatrix(hypre_CSRMatrix *ha)
1728: {
1729:   PetscErrorCode      ierr;

1732:   if (ha) {
1733:     HYPRE_Int     *ii, size;
1734:     HYPRE_Complex *a;

1736:     size = hypre_CSRMatrixNumRows(ha);
1737:     a    = hypre_CSRMatrixData(ha);
1738:     ii   = hypre_CSRMatrixI(ha);

1740:     if (a) {PetscArrayzero(a,ii[size]);}
1741:   }
1742:   return(0);
1743: }

1745: PetscErrorCode MatZeroEntries_HYPRE(Mat A)
1746: {
1747:   hypre_ParCSRMatrix  *parcsr;
1748:   PetscErrorCode      ierr;

1751:   MatHYPREGetParCSR_HYPRE(A,&parcsr);
1752:   /* diagonal part */
1753:   MatZeroEntries_HYPRE_CSRMatrix(hypre_ParCSRMatrixDiag(parcsr));
1754:   /* off-diagonal part */
1755:   MatZeroEntries_HYPRE_CSRMatrix(hypre_ParCSRMatrixOffd(parcsr));
1756:   return(0);
1757: }

1759: static PetscErrorCode MatZeroRows_HYPRE_CSRMatrix(hypre_CSRMatrix *hA,PetscInt N,const PetscInt rows[],HYPRE_Complex diag)
1760: {
1761:   PetscInt        ii;
1762:   HYPRE_Int       *i, *j;
1763:   HYPRE_Complex   *a;

1766:   if (!hA) return(0);

1768:   i = hypre_CSRMatrixI(hA);
1769:   j = hypre_CSRMatrixJ(hA);
1770:   a = hypre_CSRMatrixData(hA);

1772:   for (ii = 0; ii < N; ii++) {
1773:     HYPRE_Int jj, ibeg, iend, irow;

1775:     irow = rows[ii];
1776:     ibeg = i[irow];
1777:     iend = i[irow+1];
1778:     for (jj = ibeg; jj < iend; jj++)
1779:       if (j[jj] == irow) a[jj] = diag;
1780:       else a[jj] = 0.0;
1781:    }
1782:    return(0);
1783: }

1785: static PetscErrorCode MatZeroRows_HYPRE(Mat A,PetscInt N,const PetscInt rows[],PetscScalar diag,Vec x,Vec b)
1786: {
1787:   hypre_ParCSRMatrix  *parcsr;
1788:   PetscInt            *lrows,len;
1789:   HYPRE_Complex       hdiag;
1790:   PetscErrorCode      ierr;

1793:   if (x || b) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Does not support to modify the solution and the right hand size");
1794:   PetscHYPREScalarCast(diag,&hdiag);
1795:   /* retrieve the internal matrix */
1796:   MatHYPREGetParCSR_HYPRE(A,&parcsr);
1797:   /* get locally owned rows */
1798:   MatZeroRowsMapLocal_Private(A,N,rows,&len,&lrows);
1799:   /* zero diagonal part */
1800:   MatZeroRows_HYPRE_CSRMatrix(hypre_ParCSRMatrixDiag(parcsr),len,lrows,hdiag);
1801:   /* zero off-diagonal part */
1802:   MatZeroRows_HYPRE_CSRMatrix(hypre_ParCSRMatrixOffd(parcsr),len,lrows,0.0);

1804:   PetscFree(lrows);
1805:   return(0);
1806: }

1808: static PetscErrorCode MatAssemblyBegin_HYPRE(Mat mat,MatAssemblyType mode)
1809: {

1813:   if (mat->nooffprocentries) return(0);

1815:   MatStashScatterBegin_Private(mat,&mat->stash,mat->rmap->range);
1816:   return(0);
1817: }

1819: static PetscErrorCode MatGetRow_HYPRE(Mat A,PetscInt row,PetscInt *nz,PetscInt **idx,PetscScalar **v)
1820: {
1821:   hypre_ParCSRMatrix  *parcsr;
1822:   HYPRE_Int           hnz;
1823:   PetscErrorCode      ierr;

1826:   /* retrieve the internal matrix */
1827:   MatHYPREGetParCSR_HYPRE(A,&parcsr);
1828:   /* call HYPRE API */
1829:   PetscStackCallStandard(HYPRE_ParCSRMatrixGetRow,(parcsr,row,&hnz,(HYPRE_BigInt**)idx,(HYPRE_Complex**)v));
1830:   if (nz) *nz = (PetscInt)hnz;
1831:   return(0);
1832: }

1834: static PetscErrorCode MatRestoreRow_HYPRE(Mat A,PetscInt row,PetscInt *nz,PetscInt **idx,PetscScalar **v)
1835: {
1836:   hypre_ParCSRMatrix  *parcsr;
1837:   HYPRE_Int           hnz;
1838:   PetscErrorCode      ierr;

1841:   /* retrieve the internal matrix */
1842:   MatHYPREGetParCSR_HYPRE(A,&parcsr);
1843:   /* call HYPRE API */
1844:   hnz = nz ? (HYPRE_Int)(*nz) : 0;
1845:   PetscStackCallStandard(HYPRE_ParCSRMatrixRestoreRow,(parcsr,row,&hnz,(HYPRE_BigInt**)idx,(HYPRE_Complex**)v));
1846:   return(0);
1847: }

1849: static PetscErrorCode MatGetValues_HYPRE(Mat A,PetscInt m,const PetscInt idxm[],PetscInt n,const PetscInt idxn[],PetscScalar v[])
1850: {
1851:   Mat_HYPRE *hA = (Mat_HYPRE*)A->data;
1852:   PetscInt  i;

1855:   if (!m || !n) return(0);
1856:   /* Ignore negative row indices
1857:    * And negative column indices should be automatically ignored in hypre
1858:    * */
1859:   for (i=0; i<m; i++) {
1860:     if (idxm[i] >= 0) {
1861:       HYPRE_Int hn = (HYPRE_Int)n;
1862:       PetscStackCallStandard(HYPRE_IJMatrixGetValues,(hA->ij,1,&hn,(HYPRE_BigInt*)&idxm[i],(HYPRE_BigInt*)idxn,(HYPRE_Complex*)(v + i*n)));
1863:     }
1864:   }
1865:   return(0);
1866: }

1868: static PetscErrorCode MatSetOption_HYPRE(Mat A,MatOption op,PetscBool flg)
1869: {
1870:   Mat_HYPRE *hA = (Mat_HYPRE*)A->data;

1873:   switch (op) {
1874:   case MAT_NO_OFF_PROC_ENTRIES:
1875:     if (flg) {
1876:       PetscStackCallStandard(HYPRE_IJMatrixSetMaxOffProcElmts,(hA->ij,0));
1877:     }
1878:     break;
1879:   case MAT_SORTED_FULL:
1880:     hA->sorted_full = flg;
1881:     break;
1882:   default:
1883:     break;
1884:   }
1885:   return(0);
1886: }

1888: static PetscErrorCode MatView_HYPRE(Mat A, PetscViewer view)
1889: {
1890:   hypre_ParCSRMatrix *parcsr;
1891:   PetscErrorCode     ierr;
1892:   Mat                B;
1893:   PetscViewerFormat  format;
1894:   PetscErrorCode     (*mview)(Mat,PetscViewer) = NULL;

1897:   PetscViewerGetFormat(view,&format);
1898:   if (format != PETSC_VIEWER_NATIVE) {
1899:     MatHYPREGetParCSR_HYPRE(A,&parcsr);
1900:     MatCreateFromParCSR(parcsr,MATAIJ,PETSC_USE_POINTER,&B);
1901:     MatGetOperation(B,MATOP_VIEW,(void(**)(void))&mview);
1902:     if (!mview) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_PLIB,"Missing view operation");
1903:     (*mview)(B,view);
1904:     MatDestroy(&B);
1905:   } else {
1906:     Mat_HYPRE  *hA = (Mat_HYPRE*)A->data;
1907:     PetscMPIInt size;
1908:     PetscBool   isascii;
1909:     const char *filename;

1911:     /* HYPRE uses only text files */
1912:     PetscObjectTypeCompare((PetscObject)view,PETSCVIEWERASCII,&isascii);
1913:     if (!isascii) SETERRQ1(PetscObjectComm((PetscObject)view),PETSC_ERR_SUP,"PetscViewerType %s: native HYPRE format needs PETSCVIEWERASCII",((PetscObject)view)->type_name);
1914:     PetscViewerFileGetName(view,&filename);
1915:     PetscStackCallStandard(HYPRE_IJMatrixPrint,(hA->ij,filename));
1916:     MPI_Comm_size(hA->comm,&size);
1917:     if (size > 1) {
1918:       PetscViewerASCIIPrintf(view,"Matrix files: %s.%05d ... %s.%05d\n",filename,0,filename,size-1);
1919:     } else {
1920:       PetscViewerASCIIPrintf(view,"Matrix file: %s.%05d\n",filename,0);
1921:     }
1922:   }
1923:   return(0);
1924: }

1926: static PetscErrorCode MatDuplicate_HYPRE(Mat A,MatDuplicateOption op, Mat *B)
1927: {
1928:   hypre_ParCSRMatrix *parcsr;
1929:   PetscErrorCode     ierr;
1930:   PetscCopyMode      cpmode;

1933:   MatHYPREGetParCSR_HYPRE(A,&parcsr);
1934:   if (op == MAT_DO_NOT_COPY_VALUES || op == MAT_SHARE_NONZERO_PATTERN) {
1935:     parcsr = hypre_ParCSRMatrixClone(parcsr,0);
1936:     cpmode = PETSC_OWN_POINTER;
1937:   } else {
1938:     cpmode = PETSC_COPY_VALUES;
1939:   }
1940:   MatCreateFromParCSR(parcsr,MATHYPRE,cpmode,B);
1941:   return(0);
1942: }

1944: static PetscErrorCode MatCopy_HYPRE(Mat A, Mat B, MatStructure str)
1945: {
1946:   hypre_ParCSRMatrix *acsr,*bcsr;
1947:   PetscErrorCode     ierr;

1950:   if (str == SAME_NONZERO_PATTERN && A->ops->copy == B->ops->copy) {
1951:     MatHYPREGetParCSR_HYPRE(A,&acsr);
1952:     MatHYPREGetParCSR_HYPRE(B,&bcsr);
1953:     PetscStackCallStandard(hypre_ParCSRMatrixCopy,(acsr,bcsr,1));
1954:     MatSetOption(B,MAT_SORTED_FULL,PETSC_TRUE); /* "perfect" preallocation, so no need for hypre_AuxParCSRMatrixNeedAux */
1955:     MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);
1956:     MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);
1957:   } else {
1958:     MatCopy_Basic(A,B,str);
1959:   }
1960:   return(0);
1961: }

1963: static PetscErrorCode MatGetDiagonal_HYPRE(Mat A, Vec d)
1964: {
1965:   hypre_ParCSRMatrix *parcsr;
1966:   hypre_CSRMatrix    *dmat;
1967:   HYPRE_Complex      *a;
1968:   HYPRE_Complex      *data = NULL;
1969:   HYPRE_Int          *diag = NULL;
1970:   PetscInt           i;
1971:   PetscBool          cong;
1972:   PetscErrorCode     ierr;

1975:   MatHasCongruentLayouts(A,&cong);
1976:   if (!cong) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Only for square matrices with same local distributions of rows and columns");
1977: #if defined(PETSC_USE_DEBUG)
1978:   {
1979:     PetscBool miss;
1980:     MatMissingDiagonal(A,&miss,NULL);
1981:     if (miss && A->rmap->n) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Not implemented when diagonal entries are missing");
1982:   }
1983: #endif
1984:   MatHYPREGetParCSR_HYPRE(A,&parcsr);
1985:   dmat = hypre_ParCSRMatrixDiag(parcsr);
1986:   if (dmat) {
1987:     /* this cast fixes the clang error: implicit conversion from 'HYPRE_Complex' (aka '_Complex double') to 'double' is not permitted in C++ */
1988:     VecGetArray(d,(PetscScalar**)&a);
1989:     diag = hypre_CSRMatrixI(dmat);
1990:     data = hypre_CSRMatrixData(dmat);
1991:     for (i=0;i<A->rmap->n;i++) a[i] = data[diag[i]];
1992:     VecRestoreArray(d,(PetscScalar**)&a);
1993:   }
1994:   return(0);
1995: }

1997:  #include <petscblaslapack.h>

1999: static PetscErrorCode MatAXPY_HYPRE(Mat Y,PetscScalar a,Mat X,MatStructure str)
2000: {

2004:   if (str == SAME_NONZERO_PATTERN) {
2005:     hypre_ParCSRMatrix *x,*y;
2006:     hypre_CSRMatrix    *xloc,*yloc;
2007:     PetscInt           xnnz,ynnz;
2008:     HYPRE_Complex      *xarr,*yarr;
2009:     PetscBLASInt       one=1,bnz;

2011:     MatHYPREGetParCSR(Y,&y);
2012:     MatHYPREGetParCSR(X,&x);

2014:     /* diagonal block */
2015:     xloc = hypre_ParCSRMatrixDiag(x);
2016:     yloc = hypre_ParCSRMatrixDiag(y);
2017:     xnnz = 0;
2018:     ynnz = 0;
2019:     xarr = NULL;
2020:     yarr = NULL;
2021:     if (xloc) {
2022:       xarr = hypre_CSRMatrixData(xloc);
2023:       xnnz = hypre_CSRMatrixNumNonzeros(xloc);
2024:     }
2025:     if (yloc) {
2026:       yarr = hypre_CSRMatrixData(yloc);
2027:       ynnz = hypre_CSRMatrixNumNonzeros(yloc);
2028:     }
2029:     if (xnnz != ynnz) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Different number of nonzeros in diagonal block %D != %D",xnnz,ynnz);
2030:     PetscBLASIntCast(xnnz,&bnz);
2031:     PetscStackCallBLAS("BLASaxpy",BLASaxpy_(&bnz,&a,(PetscScalar*)xarr,&one,(PetscScalar*)yarr,&one));

2033:     /* off-diagonal block */
2034:     xloc = hypre_ParCSRMatrixOffd(x);
2035:     yloc = hypre_ParCSRMatrixOffd(y);
2036:     xnnz = 0;
2037:     ynnz = 0;
2038:     xarr = NULL;
2039:     yarr = NULL;
2040:     if (xloc) {
2041:       xarr = hypre_CSRMatrixData(xloc);
2042:       xnnz = hypre_CSRMatrixNumNonzeros(xloc);
2043:     }
2044:     if (yloc) {
2045:       yarr = hypre_CSRMatrixData(yloc);
2046:       ynnz = hypre_CSRMatrixNumNonzeros(yloc);
2047:     }
2048:     if (xnnz != ynnz) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Different number of nonzeros in off-diagonal block %D != %D",xnnz,ynnz);
2049:     PetscBLASIntCast(xnnz,&bnz);
2050:     PetscStackCallBLAS("BLASaxpy",BLASaxpy_(&bnz,&a,(PetscScalar*)xarr,&one,(PetscScalar*)yarr,&one));
2051:   } else if (str == SUBSET_NONZERO_PATTERN) {
2052:     MatAXPY_Basic(Y,a,X,str);
2053:   } else {
2054:     Mat B;

2056:     MatAXPY_Basic_Preallocate(Y,X,&B);
2057:     MatAXPY_BasicWithPreallocation(B,Y,a,X,str);
2058:     MatHeaderReplace(Y,&B);
2059:   }
2060:   return(0);
2061: }

2063: /*MC
2064:    MATHYPRE - MATHYPRE = "hypre" - A matrix type to be used for sequential and parallel sparse matrices
2065:           based on the hypre IJ interface.

2067:    Level: intermediate

2069: .seealso: MatCreate()
2070: M*/

2072: PETSC_EXTERN PetscErrorCode MatCreate_HYPRE(Mat B)
2073: {
2074:   Mat_HYPRE      *hB;

2078:   PetscNewLog(B,&hB);
2079:   hB->inner_free = PETSC_TRUE;
2080:   hB->available  = PETSC_TRUE;
2081:   hB->sorted_full= PETSC_FALSE; /* no assumption whether column indices are sorted or not */
2082:   hB->size       = 0;
2083:   hB->array      = NULL;

2085:   B->data       = (void*)hB;
2086:   B->rmap->bs   = 1;
2087:   B->assembled  = PETSC_FALSE;

2089:   PetscMemzero(B->ops,sizeof(struct _MatOps));
2090:   B->ops->mult             = MatMult_HYPRE;
2091:   B->ops->multtranspose    = MatMultTranspose_HYPRE;
2092:   B->ops->multadd          = MatMultAdd_HYPRE;
2093:   B->ops->multtransposeadd = MatMultTransposeAdd_HYPRE;
2094:   B->ops->setup            = MatSetUp_HYPRE;
2095:   B->ops->destroy          = MatDestroy_HYPRE;
2096:   B->ops->assemblyend      = MatAssemblyEnd_HYPRE;
2097:   B->ops->assemblybegin    = MatAssemblyBegin_HYPRE;
2098:   B->ops->setvalues        = MatSetValues_HYPRE;
2099:   B->ops->missingdiagonal  = MatMissingDiagonal_HYPRE;
2100:   B->ops->scale            = MatScale_HYPRE;
2101:   B->ops->zerorowscolumns  = MatZeroRowsColumns_HYPRE;
2102:   B->ops->zeroentries      = MatZeroEntries_HYPRE;
2103:   B->ops->zerorows         = MatZeroRows_HYPRE;
2104:   B->ops->getrow           = MatGetRow_HYPRE;
2105:   B->ops->restorerow       = MatRestoreRow_HYPRE;
2106:   B->ops->getvalues        = MatGetValues_HYPRE;
2107:   B->ops->setoption        = MatSetOption_HYPRE;
2108:   B->ops->duplicate        = MatDuplicate_HYPRE;
2109:   B->ops->copy             = MatCopy_HYPRE;
2110:   B->ops->view             = MatView_HYPRE;
2111:   B->ops->getdiagonal      = MatGetDiagonal_HYPRE;
2112:   B->ops->axpy             = MatAXPY_HYPRE;
2113:   B->ops->productsetfromoptions = MatProductSetFromOptions_HYPRE;

2115:   /* build cache for off array entries formed */
2116:   MatStashCreate_Private(PetscObjectComm((PetscObject)B),1,&B->stash);

2118:   MPI_Comm_dup(PetscObjectComm((PetscObject)B),&hB->comm);
2119:   PetscObjectChangeTypeName((PetscObject)B,MATHYPRE);
2120:   PetscObjectComposeFunction((PetscObject)B,"MatConvert_hypre_aij_C",MatConvert_HYPRE_AIJ);
2121:   PetscObjectComposeFunction((PetscObject)B,"MatConvert_hypre_is_C",MatConvert_HYPRE_IS);
2122:   PetscObjectComposeFunction((PetscObject)B,"MatProductSetFromOptions_seqaij_hypre_C",MatProductSetFromOptions_HYPRE);
2123:   PetscObjectComposeFunction((PetscObject)B,"MatProductSetFromOptions_mpiaij_hypre_C",MatProductSetFromOptions_HYPRE);
2124:   PetscObjectComposeFunction((PetscObject)B,"MatHYPRESetPreallocation_C",MatHYPRESetPreallocation_HYPRE);
2125:   PetscObjectComposeFunction((PetscObject)B,"MatHYPREGetParCSR_C",MatHYPREGetParCSR_HYPRE);
2126:   return(0);
2127: }

2129: static PetscErrorCode hypre_array_destroy(void *ptr)
2130: {
2132:    hypre_TFree(ptr,HYPRE_MEMORY_HOST);
2133:    return(0);
2134: }