Actual source code: sbaij.c

  1: #define PETSCMAT_DLL

  3: /*
  4:     Defines the basic matrix operations for the SBAIJ (compressed row)
  5:   matrix storage format.
  6: */
 7:  #include src/mat/impls/baij/seq/baij.h
 8:  #include src/inline/spops.h
 9:  #include src/mat/impls/sbaij/seq/sbaij.h

 11: #define CHUNKSIZE  10

 13: /*
 14:      Checks for missing diagonals
 15: */
 18: PetscErrorCode MatMissingDiagonal_SeqSBAIJ(Mat A)
 19: {
 20:   Mat_SeqSBAIJ   *a = (Mat_SeqSBAIJ*)A->data;
 22:   PetscInt       *diag,*jj = a->j,i;

 25:   MatMarkDiagonal_SeqSBAIJ(A);
 26:   diag = a->diag;
 27:   for (i=0; i<a->mbs; i++) {
 28:     if (jj[diag[i]] != i) SETERRQ1(PETSC_ERR_ARG_CORRUPT,"Matrix is missing diagonal number %D",i);
 29:   }
 30:   return(0);
 31: }

 35: PetscErrorCode MatMarkDiagonal_SeqSBAIJ(Mat A)
 36: {
 37:   Mat_SeqSBAIJ   *a = (Mat_SeqSBAIJ*)A->data;
 39:   PetscInt       i;

 42:   if (!a->diag) {
 43:     PetscMalloc(a->mbs*sizeof(PetscInt),&a->diag);
 44:   }
 45:   for (i=0; i<a->mbs; i++) a->diag[i] = a->i[i];
 46:   return(0);
 47: }

 51: static PetscErrorCode MatGetRowIJ_SeqSBAIJ(Mat A,PetscInt oshift,PetscTruth symmetric,PetscTruth blockcompressed,PetscInt *nn,PetscInt *ia[],PetscInt *ja[],PetscTruth *done)
 52: {
 53:   Mat_SeqSBAIJ *a = (Mat_SeqSBAIJ*)A->data;
 54:   PetscInt     i,j,n = a->mbs,nz = a->i[n],bs = A->rmap.bs;

 58:   *nn = n;
 59:   if (!ia) return(0);
 60:   if (!blockcompressed) {
 61:     /* malloc & create the natural set of indices */
 62:     PetscMalloc2((n+1)*bs,PetscInt,ia,nz*bs,PetscInt,ja);
 63:     for (i=0; i<n+1; i++) {
 64:       for (j=0; j<bs; j++) {
 65:         *ia[i*bs+j] = a->i[i]*bs+j+oshift;
 66:       }
 67:     }
 68:     for (i=0; i<nz; i++) {
 69:       for (j=0; j<bs; j++) {
 70:         *ja[i*bs+j] = a->j[i]*bs+j+oshift;
 71:       }
 72:     }
 73:   } else { /* blockcompressed */
 74:     if (oshift == 1) {
 75:       /* temporarily add 1 to i and j indices */
 76:       for (i=0; i<nz; i++) a->j[i]++;
 77:       for (i=0; i<n+1; i++) a->i[i]++;
 78:     }
 79:     *ia = a->i; *ja = a->j;
 80:   }

 82:   return(0);
 83: }

 87: static PetscErrorCode MatRestoreRowIJ_SeqSBAIJ(Mat A,PetscInt oshift,PetscTruth symmetric,PetscTruth blockcompressed,PetscInt *nn,PetscInt *ia[],PetscInt *ja[],PetscTruth *done)
 88: {
 89:   Mat_SeqSBAIJ *a = (Mat_SeqSBAIJ*)A->data;
 90:   PetscInt     i,n = a->mbs,nz = a->i[n];

 94:   if (!ia) return(0);

 96:   if (!blockcompressed) {
 97:     PetscFree2(*ia,*ja);
 98:   } else if (oshift == 1) { /* blockcompressed */
 99:     for (i=0; i<nz; i++) a->j[i]--;
100:     for (i=0; i<n+1; i++) a->i[i]--;
101:   }

103:   return(0);
104: }

108: PetscErrorCode MatDestroy_SeqSBAIJ(Mat A)
109: {
110:   Mat_SeqSBAIJ   *a = (Mat_SeqSBAIJ*)A->data;

114: #if defined(PETSC_USE_LOG)
115:   PetscLogObjectState((PetscObject)A,"Rows=%D, NZ=%D",A->rmap.N,a->nz);
116: #endif
117:   MatSeqXAIJFreeAIJ(A,&a->a,&a->j,&a->i);
118:   if (a->row) {ISDestroy(a->row);}
119:   if (a->col){ISDestroy(a->col);}
120:   if (a->icol) {ISDestroy(a->icol);}
121:   PetscFree(a->diag);
122:   PetscFree2(a->imax,a->ilen);
123:   PetscFree(a->solve_work);
124:   PetscFree(a->relax_work);
125:   PetscFree(a->solves_work);
126:   PetscFree(a->mult_work);
127:   PetscFree(a->saved_values);
128:   PetscFree(a->xtoy);

130:   PetscFree(a->inew);
131:   PetscFree(a);

133:   PetscObjectChangeTypeName((PetscObject)A,0);
134:   PetscObjectComposeFunction((PetscObject)A,"MatStoreValues_C","",PETSC_NULL);
135:   PetscObjectComposeFunction((PetscObject)A,"MatRetrieveValues_C","",PETSC_NULL);
136:   PetscObjectComposeFunction((PetscObject)A,"MatSeqSBAIJSetColumnIndices_C","",PETSC_NULL);
137:   PetscObjectComposeFunction((PetscObject)A,"MatConvert_seqsbaij_seqaij_C","",PETSC_NULL);
138:   PetscObjectComposeFunction((PetscObject)A,"MatConvert_seqsbaij_seqbaij_C","",PETSC_NULL);
139:   PetscObjectComposeFunction((PetscObject)A,"MatSeqSBAIJSetPreallocation_C","",PETSC_NULL);
140:   return(0);
141: }

145: PetscErrorCode MatSetOption_SeqSBAIJ(Mat A,MatOption op)
146: {
147:   Mat_SeqSBAIJ   *a = (Mat_SeqSBAIJ*)A->data;

151:   switch (op) {
152:   case MAT_ROW_ORIENTED:
153:     a->roworiented = PETSC_TRUE;
154:     break;
155:   case MAT_COLUMN_ORIENTED:
156:     a->roworiented = PETSC_FALSE;
157:     break;
158:   case MAT_COLUMNS_SORTED:
159:     a->sorted = PETSC_TRUE;
160:     break;
161:   case MAT_COLUMNS_UNSORTED:
162:     a->sorted = PETSC_FALSE;
163:     break;
164:   case MAT_KEEP_ZEROED_ROWS:
165:     a->keepzeroedrows = PETSC_TRUE;
166:     break;
167:   case MAT_NO_NEW_NONZERO_LOCATIONS:
168:     a->nonew = 1;
169:     break;
170:   case MAT_NEW_NONZERO_LOCATION_ERR:
171:     a->nonew = -1;
172:     break;
173:   case MAT_NEW_NONZERO_ALLOCATION_ERR:
174:     a->nonew = -2;
175:     break;
176:   case MAT_YES_NEW_NONZERO_LOCATIONS:
177:     a->nonew = 0;
178:     break;
179:   case MAT_ROWS_SORTED:
180:   case MAT_ROWS_UNSORTED:
181:   case MAT_YES_NEW_DIAGONALS:
182:   case MAT_IGNORE_OFF_PROC_ENTRIES:
183:   case MAT_USE_HASH_TABLE:
184:     PetscInfo1(A,"Option %s ignored\n",MatOptions[op]);
185:     break;
186:   case MAT_NO_NEW_DIAGONALS:
187:     SETERRQ(PETSC_ERR_SUP,"MAT_NO_NEW_DIAGONALS");
188:   case MAT_NOT_SYMMETRIC:
189:   case MAT_NOT_STRUCTURALLY_SYMMETRIC:
190:   case MAT_HERMITIAN:
191:     SETERRQ(PETSC_ERR_SUP,"Matrix must be symmetric");
192:   case MAT_SYMMETRIC:
193:   case MAT_STRUCTURALLY_SYMMETRIC:
194:   case MAT_NOT_HERMITIAN:
195:   case MAT_SYMMETRY_ETERNAL:
196:   case MAT_NOT_SYMMETRY_ETERNAL:
197:     PetscInfo1(A,"Option %s not relevent\n",MatOptions[op]);
198:     break;
199:   case MAT_IGNORE_LOWER_TRIANGULAR:
200:     a->ignore_ltriangular = PETSC_TRUE;
201:     break;
202:   case MAT_ERROR_LOWER_TRIANGULAR:
203:     a->ignore_ltriangular = PETSC_FALSE;
204:     break;
205:   case MAT_GETROW_UPPERTRIANGULAR:
206:     a->getrow_utriangular = PETSC_TRUE;
207:     break;
208:   default:
209:     SETERRQ1(PETSC_ERR_SUP,"unknown option %d",op);
210:   }
211:   return(0);
212: }

216: PetscErrorCode MatGetRow_SeqSBAIJ(Mat A,PetscInt row,PetscInt *ncols,PetscInt **cols,PetscScalar **v)
217: {
218:   Mat_SeqSBAIJ   *a = (Mat_SeqSBAIJ*)A->data;
220:   PetscInt       itmp,i,j,k,M,*ai,*aj,bs,bn,bp,*cols_i,bs2;
221:   MatScalar      *aa,*aa_i;
222:   PetscScalar    *v_i;

225:   if (A && !a->getrow_utriangular) SETERRQ(PETSC_ERR_SUP,"MatGetRow is not supported for SBAIJ matrix format. Getting the upper triangular part of row, run with -mat_getrow_uppertriangular, call MatSetOption(mat,MAT_GETROW_UPPERTRIANGULAR) or MatGetRowUpperTriangular()");
226:   /* Get the upper triangular part of the row */
227:   bs  = A->rmap.bs;
228:   ai  = a->i;
229:   aj  = a->j;
230:   aa  = a->a;
231:   bs2 = a->bs2;
232: 
233:   if (row < 0 || row >= A->rmap.N) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE, "Row %D out of range", row);
234: 
235:   bn  = row/bs;   /* Block number */
236:   bp  = row % bs; /* Block position */
237:   M   = ai[bn+1] - ai[bn];
238:   *ncols = bs*M;
239: 
240:   if (v) {
241:     *v = 0;
242:     if (*ncols) {
243:       PetscMalloc((*ncols+row)*sizeof(PetscScalar),v);
244:       for (i=0; i<M; i++) { /* for each block in the block row */
245:         v_i  = *v + i*bs;
246:         aa_i = aa + bs2*(ai[bn] + i);
247:         for (j=bp,k=0; j<bs2; j+=bs,k++) {v_i[k] = aa_i[j];}
248:       }
249:     }
250:   }
251: 
252:   if (cols) {
253:     *cols = 0;
254:     if (*ncols) {
255:       PetscMalloc((*ncols+row)*sizeof(PetscInt),cols);
256:       for (i=0; i<M; i++) { /* for each block in the block row */
257:         cols_i = *cols + i*bs;
258:         itmp  = bs*aj[ai[bn] + i];
259:         for (j=0; j<bs; j++) {cols_i[j] = itmp++;}
260:       }
261:     }
262:   }
263: 
264:   /*search column A(0:row-1,row) (=A(row,0:row-1)). Could be expensive! */
265:   /* this segment is currently removed, so only entries in the upper triangle are obtained */
266: #ifdef column_search
267:   v_i    = *v    + M*bs;
268:   cols_i = *cols + M*bs;
269:   for (i=0; i<bn; i++){ /* for each block row */
270:     M = ai[i+1] - ai[i];
271:     for (j=0; j<M; j++){
272:       itmp = aj[ai[i] + j];    /* block column value */
273:       if (itmp == bn){
274:         aa_i   = aa    + bs2*(ai[i] + j) + bs*bp;
275:         for (k=0; k<bs; k++) {
276:           *cols_i++ = i*bs+k;
277:           *v_i++    = aa_i[k];
278:         }
279:         *ncols += bs;
280:         break;
281:       }
282:     }
283:   }
284: #endif
285:   return(0);
286: }

290: PetscErrorCode MatRestoreRow_SeqSBAIJ(Mat A,PetscInt row,PetscInt *nz,PetscInt **idx,PetscScalar **v)
291: {
293: 
295:   if (idx) {PetscFree(*idx);}
296:   if (v)   {PetscFree(*v);}
297:   return(0);
298: }

302: PetscErrorCode MatGetRowUpperTriangular_SeqSBAIJ(Mat A)
303: {
304:   Mat_SeqSBAIJ   *a = (Mat_SeqSBAIJ*)A->data;

307:   a->getrow_utriangular = PETSC_TRUE;
308:   return(0);
309: }
312: PetscErrorCode MatRestoreRowUpperTriangular_SeqSBAIJ(Mat A)
313: {
314:   Mat_SeqSBAIJ   *a = (Mat_SeqSBAIJ*)A->data;

317:   a->getrow_utriangular = PETSC_FALSE;
318:   return(0);
319: }

323: PetscErrorCode MatTranspose_SeqSBAIJ(Mat A,Mat *B)
324: {
327:   MatDuplicate(A,MAT_COPY_VALUES,B);
328:   return(0);
329: }

333: static PetscErrorCode MatView_SeqSBAIJ_ASCII(Mat A,PetscViewer viewer)
334: {
335:   Mat_SeqSBAIJ      *a = (Mat_SeqSBAIJ*)A->data;
336:   PetscErrorCode    ierr;
337:   PetscInt          i,j,bs = A->rmap.bs,k,l,bs2=a->bs2;
338:   const char        *name;
339:   PetscViewerFormat format;
340: 
342:   PetscObjectGetName((PetscObject)A,&name);
343:   PetscViewerGetFormat(viewer,&format);
344:   if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
345:     PetscViewerASCIIPrintf(viewer,"  block size is %D\n",bs);
346:   } else if (format == PETSC_VIEWER_ASCII_MATLAB) {
347:     SETERRQ(PETSC_ERR_SUP,"Matlab format not supported");
348:   } else if (format == PETSC_VIEWER_ASCII_COMMON) {
349:     PetscViewerASCIIUseTabs(viewer,PETSC_NO);
350:     for (i=0; i<a->mbs; i++) {
351:       for (j=0; j<bs; j++) {
352:         PetscViewerASCIIPrintf(viewer,"row %D:",i*bs+j);
353:         for (k=a->i[i]; k<a->i[i+1]; k++) {
354:           for (l=0; l<bs; l++) {
355: #if defined(PETSC_USE_COMPLEX)
356:             if (PetscImaginaryPart(a->a[bs2*k + l*bs + j]) > 0.0 && PetscRealPart(a->a[bs2*k + l*bs + j]) != 0.0) {
357:               PetscViewerASCIIPrintf(viewer," (%D, %G + %G i) ",bs*a->j[k]+l,
358:                                             PetscRealPart(a->a[bs2*k + l*bs + j]),PetscImaginaryPart(a->a[bs2*k + l*bs + j]));
359:             } else if (PetscImaginaryPart(a->a[bs2*k + l*bs + j]) < 0.0 && PetscRealPart(a->a[bs2*k + l*bs + j]) != 0.0) {
360:               PetscViewerASCIIPrintf(viewer," (%D, %G - %G i) ",bs*a->j[k]+l,
361:                                             PetscRealPart(a->a[bs2*k + l*bs + j]),-PetscImaginaryPart(a->a[bs2*k + l*bs + j]));
362:             } else if (PetscRealPart(a->a[bs2*k + l*bs + j]) != 0.0) {
363:               PetscViewerASCIIPrintf(viewer," (%D, %G) ",bs*a->j[k]+l,PetscRealPart(a->a[bs2*k + l*bs + j]));
364:             }
365: #else
366:             if (a->a[bs2*k + l*bs + j] != 0.0) {
367:               PetscViewerASCIIPrintf(viewer," (%D, %G) ",bs*a->j[k]+l,a->a[bs2*k + l*bs + j]);
368:             }
369: #endif
370:           }
371:         }
372:         PetscViewerASCIIPrintf(viewer,"\n");
373:       }
374:     }
375:     PetscViewerASCIIUseTabs(viewer,PETSC_YES);
376:   } else if (format == PETSC_VIEWER_ASCII_FACTOR_INFO) {
377:      return(0);
378:   } else {
379:     if (A->factor && bs>1){
380:       PetscPrintf(PETSC_COMM_SELF,"Warning: matrix is factored. MatView_SeqSBAIJ_ASCII() may not display complete or logically correct entries!\n");
381:     }
382:     PetscViewerASCIIUseTabs(viewer,PETSC_NO);
383:     for (i=0; i<a->mbs; i++) {
384:       for (j=0; j<bs; j++) {
385:         PetscViewerASCIIPrintf(viewer,"row %D:",i*bs+j);
386:         for (k=a->i[i]; k<a->i[i+1]; k++) {
387:           for (l=0; l<bs; l++) {
388: #if defined(PETSC_USE_COMPLEX)
389:             if (PetscImaginaryPart(a->a[bs2*k + l*bs + j]) > 0.0) {
390:               PetscViewerASCIIPrintf(viewer," (%D, %G + %G i) ",bs*a->j[k]+l,
391:                                             PetscRealPart(a->a[bs2*k + l*bs + j]),PetscImaginaryPart(a->a[bs2*k + l*bs + j]));
392:             } else if (PetscImaginaryPart(a->a[bs2*k + l*bs + j]) < 0.0) {
393:               PetscViewerASCIIPrintf(viewer," (%D, %G - %G i) ",bs*a->j[k]+l,
394:                                             PetscRealPart(a->a[bs2*k + l*bs + j]),-PetscImaginaryPart(a->a[bs2*k + l*bs + j]));
395:             } else {
396:               PetscViewerASCIIPrintf(viewer," (%D, %G) ",bs*a->j[k]+l,PetscRealPart(a->a[bs2*k + l*bs + j]));
397:             }
398: #else
399:             PetscViewerASCIIPrintf(viewer," (%D, %G) ",bs*a->j[k]+l,a->a[bs2*k + l*bs + j]);
400: #endif
401:           }
402:         }
403:         PetscViewerASCIIPrintf(viewer,"\n");
404:       }
405:     }
406:     PetscViewerASCIIUseTabs(viewer,PETSC_YES);
407:   }
408:   PetscViewerFlush(viewer);
409:   return(0);
410: }

414: static PetscErrorCode MatView_SeqSBAIJ_Draw_Zoom(PetscDraw draw,void *Aa)
415: {
416:   Mat            A = (Mat) Aa;
417:   Mat_SeqSBAIJ   *a=(Mat_SeqSBAIJ*)A->data;
419:   PetscInt       row,i,j,k,l,mbs=a->mbs,color,bs=A->rmap.bs,bs2=a->bs2;
420:   PetscMPIInt    rank;
421:   PetscReal      xl,yl,xr,yr,x_l,x_r,y_l,y_r;
422:   MatScalar      *aa;
423:   MPI_Comm       comm;
424:   PetscViewer    viewer;
425: 
427:   /*
428:     This is nasty. If this is called from an originally parallel matrix
429:     then all processes call this,but only the first has the matrix so the
430:     rest should return immediately.
431:   */
432:   PetscObjectGetComm((PetscObject)draw,&comm);
433:   MPI_Comm_rank(comm,&rank);
434:   if (rank) return(0);
435: 
436:   PetscObjectQuery((PetscObject)A,"Zoomviewer",(PetscObject*)&viewer);
437: 
438:   PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);
439:   PetscDrawString(draw, .3*(xl+xr), .3*(yl+yr), PETSC_DRAW_BLACK, "symmetric");
440: 
441:   /* loop over matrix elements drawing boxes */
442:   color = PETSC_DRAW_BLUE;
443:   for (i=0,row=0; i<mbs; i++,row+=bs) {
444:     for (j=a->i[i]; j<a->i[i+1]; j++) {
445:       y_l = A->rmap.N - row - 1.0; y_r = y_l + 1.0;
446:       x_l = a->j[j]*bs; x_r = x_l + 1.0;
447:       aa = a->a + j*bs2;
448:       for (k=0; k<bs; k++) {
449:         for (l=0; l<bs; l++) {
450:           if (PetscRealPart(*aa++) >=  0.) continue;
451:           PetscDrawRectangle(draw,x_l+k,y_l-l,x_r+k,y_r-l,color,color,color,color);
452:         }
453:       }
454:     }
455:   }
456:   color = PETSC_DRAW_CYAN;
457:   for (i=0,row=0; i<mbs; i++,row+=bs) {
458:     for (j=a->i[i]; j<a->i[i+1]; j++) {
459:       y_l = A->rmap.N - row - 1.0; y_r = y_l + 1.0;
460:       x_l = a->j[j]*bs; x_r = x_l + 1.0;
461:       aa = a->a + j*bs2;
462:       for (k=0; k<bs; k++) {
463:         for (l=0; l<bs; l++) {
464:           if (PetscRealPart(*aa++) != 0.) continue;
465:           PetscDrawRectangle(draw,x_l+k,y_l-l,x_r+k,y_r-l,color,color,color,color);
466:         }
467:       }
468:     }
469:   }
470: 
471:   color = PETSC_DRAW_RED;
472:   for (i=0,row=0; i<mbs; i++,row+=bs) {
473:     for (j=a->i[i]; j<a->i[i+1]; j++) {
474:       y_l = A->rmap.N - row - 1.0; y_r = y_l + 1.0;
475:       x_l = a->j[j]*bs; x_r = x_l + 1.0;
476:       aa = a->a + j*bs2;
477:       for (k=0; k<bs; k++) {
478:         for (l=0; l<bs; l++) {
479:           if (PetscRealPart(*aa++) <= 0.) continue;
480:           PetscDrawRectangle(draw,x_l+k,y_l-l,x_r+k,y_r-l,color,color,color,color);
481:         }
482:       }
483:     }
484:   }
485:   return(0);
486: }

490: static PetscErrorCode MatView_SeqSBAIJ_Draw(Mat A,PetscViewer viewer)
491: {
493:   PetscReal      xl,yl,xr,yr,w,h;
494:   PetscDraw      draw;
495:   PetscTruth     isnull;
496: 
498:   PetscViewerDrawGetDraw(viewer,0,&draw);
499:   PetscDrawIsNull(draw,&isnull); if (isnull) return(0);
500: 
501:   PetscObjectCompose((PetscObject)A,"Zoomviewer",(PetscObject)viewer);
502:   xr  = A->rmap.N; yr = A->rmap.N; h = yr/10.0; w = xr/10.0;
503:   xr += w;    yr += h;  xl = -w;     yl = -h;
504:   PetscDrawSetCoordinates(draw,xl,yl,xr,yr);
505:   PetscDrawZoom(draw,MatView_SeqSBAIJ_Draw_Zoom,A);
506:   PetscObjectCompose((PetscObject)A,"Zoomviewer",PETSC_NULL);
507:   return(0);
508: }

512: PetscErrorCode MatView_SeqSBAIJ(Mat A,PetscViewer viewer)
513: {
515:   PetscTruth     iascii,isdraw;
516: 
518:   PetscTypeCompare((PetscObject)viewer,PETSC_VIEWER_ASCII,&iascii);
519:   PetscTypeCompare((PetscObject)viewer,PETSC_VIEWER_DRAW,&isdraw);
520:   if (iascii){
521:     MatView_SeqSBAIJ_ASCII(A,viewer);
522:   } else if (isdraw) {
523:     MatView_SeqSBAIJ_Draw(A,viewer);
524:   } else {
525:     Mat B;
526:     MatConvert(A,MATSEQAIJ,MAT_INITIAL_MATRIX,&B);
527:     MatView(B,viewer);
528:     MatDestroy(B);
529:   }
530:   return(0);
531: }


536: PetscErrorCode MatGetValues_SeqSBAIJ(Mat A,PetscInt m,const PetscInt im[],PetscInt n,const PetscInt in[],PetscScalar v[])
537: {
538:   Mat_SeqSBAIJ *a = (Mat_SeqSBAIJ*)A->data;
539:   PetscInt     *rp,k,low,high,t,row,nrow,i,col,l,*aj = a->j;
540:   PetscInt     *ai = a->i,*ailen = a->ilen;
541:   PetscInt     brow,bcol,ridx,cidx,bs=A->rmap.bs,bs2=a->bs2;
542:   MatScalar    *ap,*aa = a->a,zero = 0.0;
543: 
545:   for (k=0; k<m; k++) { /* loop over rows */
546:     row  = im[k]; brow = row/bs;
547:     if (row < 0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Negative row: %D",row);
548:     if (row >= A->rmap.N) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Row too large: row %D max %D",row,A->rmap.N-1);
549:     rp   = aj + ai[brow] ; ap = aa + bs2*ai[brow] ;
550:     nrow = ailen[brow];
551:     for (l=0; l<n; l++) { /* loop over columns */
552:       if (in[l] < 0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Negative column: %D",in[l]);
553:       if (in[l] >= A->cmap.n) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Column too large: col %D max %D",in[l],A->cmap.n-1);
554:       col  = in[l] ;
555:       bcol = col/bs;
556:       cidx = col%bs;
557:       ridx = row%bs;
558:       high = nrow;
559:       low  = 0; /* assume unsorted */
560:       while (high-low > 5) {
561:         t = (low+high)/2;
562:         if (rp[t] > bcol) high = t;
563:         else             low  = t;
564:       }
565:       for (i=low; i<high; i++) {
566:         if (rp[i] > bcol) break;
567:         if (rp[i] == bcol) {
568:           *v++ = ap[bs2*i+bs*cidx+ridx];
569:           goto finished;
570:         }
571:       }
572:       *v++ = zero;
573:        finished:;
574:     }
575:   }
576:   return(0);
577: }


582: PetscErrorCode MatSetValuesBlocked_SeqSBAIJ(Mat A,PetscInt m,const PetscInt im[],PetscInt n,const PetscInt in[],const PetscScalar v[],InsertMode is)
583: {
584:   Mat_SeqSBAIJ    *a = (Mat_SeqSBAIJ*)A->data;
585:   PetscErrorCode  ierr;
586:   PetscInt        *rp,k,low,high,t,ii,jj,row,nrow,i,col,l,rmax,N,lastcol = -1;
587:   PetscInt        *imax=a->imax,*ai=a->i,*ailen=a->ilen;
588:   PetscInt        *aj=a->j,nonew=a->nonew,bs2=a->bs2,bs=A->rmap.bs,stepval;
589:   PetscTruth      roworiented=a->roworiented;
590:   const MatScalar *value = v;
591:   MatScalar       *ap,*aa = a->a,*bap;
592: 
594:   if (roworiented) {
595:     stepval = (n-1)*bs;
596:   } else {
597:     stepval = (m-1)*bs;
598:   }
599:   for (k=0; k<m; k++) { /* loop over added rows */
600:     row  = im[k];
601:     if (row < 0) continue;
602: #if defined(PETSC_USE_DEBUG)  
603:     if (row >= a->mbs) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Row too large: row %D max %D",row,a->mbs-1);
604: #endif
605:     rp   = aj + ai[row];
606:     ap   = aa + bs2*ai[row];
607:     rmax = imax[row];
608:     nrow = ailen[row];
609:     low  = 0;
610:     high = nrow;
611:     for (l=0; l<n; l++) { /* loop over added columns */
612:       if (in[l] < 0) continue;
613:       col = in[l];
614: #if defined(PETSC_USE_DEBUG)  
615:       if (col >= a->nbs) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Column too large: col %D max %D",col,a->nbs-1);
616: #endif
617:       if (col < row) continue; /* ignore lower triangular block */
618:       if (roworiented) {
619:         value = v + k*(stepval+bs)*bs + l*bs;
620:       } else {
621:         value = v + l*(stepval+bs)*bs + k*bs;
622:       }
623:       if (col <= lastcol) low = 0; else high = nrow;
624:       lastcol = col;
625:       while (high-low > 7) {
626:         t = (low+high)/2;
627:         if (rp[t] > col) high = t;
628:         else             low  = t;
629:       }
630:       for (i=low; i<high; i++) {
631:         if (rp[i] > col) break;
632:         if (rp[i] == col) {
633:           bap  = ap +  bs2*i;
634:           if (roworiented) {
635:             if (is == ADD_VALUES) {
636:               for (ii=0; ii<bs; ii++,value+=stepval) {
637:                 for (jj=ii; jj<bs2; jj+=bs) {
638:                   bap[jj] += *value++;
639:                 }
640:               }
641:             } else {
642:               for (ii=0; ii<bs; ii++,value+=stepval) {
643:                 for (jj=ii; jj<bs2; jj+=bs) {
644:                   bap[jj] = *value++;
645:                 }
646:                }
647:             }
648:           } else {
649:             if (is == ADD_VALUES) {
650:               for (ii=0; ii<bs; ii++,value+=stepval) {
651:                 for (jj=0; jj<bs; jj++) {
652:                   *bap++ += *value++;
653:                 }
654:               }
655:             } else {
656:               for (ii=0; ii<bs; ii++,value+=stepval) {
657:                 for (jj=0; jj<bs; jj++) {
658:                   *bap++  = *value++;
659:                 }
660:               }
661:             }
662:           }
663:           goto noinsert2;
664:         }
665:       }
666:       if (nonew == 1) goto noinsert2;
667:       if (nonew == -1) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Inserting a new nonzero (%D, %D) in the matrix", row, col);
668:       MatSeqXAIJReallocateAIJ(A,a->mbs,bs2,nrow,row,col,rmax,aa,ai,aj,rp,ap,imax,nonew,MatScalar);
669:       N = nrow++ - 1; high++;
670:       /* shift up all the later entries in this row */
671:       for (ii=N; ii>=i; ii--) {
672:         rp[ii+1] = rp[ii];
673:         PetscMemcpy(ap+bs2*(ii+1),ap+bs2*(ii),bs2*sizeof(MatScalar));
674:       }
675:       if (N >= i) {
676:         PetscMemzero(ap+bs2*i,bs2*sizeof(MatScalar));
677:       }
678:       rp[i] = col;
679:       bap   = ap +  bs2*i;
680:       if (roworiented) {
681:         for (ii=0; ii<bs; ii++,value+=stepval) {
682:           for (jj=ii; jj<bs2; jj+=bs) {
683:             bap[jj] = *value++;
684:           }
685:         }
686:       } else {
687:         for (ii=0; ii<bs; ii++,value+=stepval) {
688:           for (jj=0; jj<bs; jj++) {
689:             *bap++  = *value++;
690:           }
691:         }
692:        }
693:     noinsert2:;
694:       low = i;
695:     }
696:     ailen[row] = nrow;
697:   }
698:    return(0);
699: }

703: PetscErrorCode MatAssemblyEnd_SeqSBAIJ(Mat A,MatAssemblyType mode)
704: {
705:   Mat_SeqSBAIJ   *a = (Mat_SeqSBAIJ*)A->data;
707:   PetscInt       fshift = 0,i,j,*ai = a->i,*aj = a->j,*imax = a->imax;
708:   PetscInt       m = A->rmap.N,*ip,N,*ailen = a->ilen;
709:   PetscInt       mbs = a->mbs,bs2 = a->bs2,rmax = 0;
710:   MatScalar      *aa = a->a,*ap;
711: 
713:   if (mode == MAT_FLUSH_ASSEMBLY) return(0);
714: 
715:   if (m) rmax = ailen[0];
716:   for (i=1; i<mbs; i++) {
717:     /* move each row back by the amount of empty slots (fshift) before it*/
718:     fshift += imax[i-1] - ailen[i-1];
719:      rmax   = PetscMax(rmax,ailen[i]);
720:      if (fshift) {
721:        ip = aj + ai[i]; ap = aa + bs2*ai[i];
722:        N = ailen[i];
723:        for (j=0; j<N; j++) {
724:          ip[j-fshift] = ip[j];
725:          PetscMemcpy(ap+(j-fshift)*bs2,ap+j*bs2,bs2*sizeof(MatScalar));
726:        }
727:      }
728:      ai[i] = ai[i-1] + ailen[i-1];
729:   }
730:   if (mbs) {
731:     fshift += imax[mbs-1] - ailen[mbs-1];
732:      ai[mbs] = ai[mbs-1] + ailen[mbs-1];
733:   }
734:   /* reset ilen and imax for each row */
735:   for (i=0; i<mbs; i++) {
736:     ailen[i] = imax[i] = ai[i+1] - ai[i];
737:   }
738:   a->nz = ai[mbs];
739: 
740:   /* diagonals may have moved, reset it */
741:   if (a->diag) {
742:     PetscMemcpy(a->diag,ai,(mbs+1)*sizeof(PetscInt));
743:   }
744:   PetscInfo5(A,"Matrix size: %D X %D, block size %D; storage space: %D unneeded, %D used\n",m,A->rmap.N,A->rmap.bs,fshift*bs2,a->nz*bs2);
745:   PetscInfo1(A,"Number of mallocs during MatSetValues is %D\n",a->reallocs);
746:   PetscInfo1(A,"Most nonzeros blocks in any row is %D\n",rmax);
747:   a->reallocs          = 0;
748:   A->info.nz_unneeded  = (PetscReal)fshift*bs2;
749:   return(0);
750: }

752: /* 
753:    This function returns an array of flags which indicate the locations of contiguous
754:    blocks that should be zeroed. for eg: if bs = 3  and is = [0,1,2,3,5,6,7,8,9]
755:    then the resulting sizes = [3,1,1,3,1] correspondig to sets [(0,1,2),(3),(5),(6,7,8),(9)]
756:    Assume: sizes should be long enough to hold all the values.
757: */
760: PetscErrorCode MatZeroRows_SeqSBAIJ_Check_Blocks(PetscInt idx[],PetscInt n,PetscInt bs,PetscInt sizes[], PetscInt *bs_max)
761: {
762:   PetscInt   i,j,k,row;
763:   PetscTruth flg;
764: 
766:    for (i=0,j=0; i<n; j++) {
767:      row = idx[i];
768:      if (row%bs!=0) { /* Not the begining of a block */
769:        sizes[j] = 1;
770:        i++;
771:      } else if (i+bs > n) { /* Beginning of a block, but complete block doesn't exist (at idx end) */
772:        sizes[j] = 1;         /* Also makes sure atleast 'bs' values exist for next else */
773:        i++;
774:      } else { /* Begining of the block, so check if the complete block exists */
775:        flg = PETSC_TRUE;
776:        for (k=1; k<bs; k++) {
777:          if (row+k != idx[i+k]) { /* break in the block */
778:            flg = PETSC_FALSE;
779:            break;
780:          }
781:        }
782:        if (flg) { /* No break in the bs */
783:          sizes[j] = bs;
784:          i+= bs;
785:        } else {
786:          sizes[j] = 1;
787:          i++;
788:        }
789:      }
790:    }
791:    *bs_max = j;
792:    return(0);
793: }


796: /* Only add/insert a(i,j) with i<=j (blocks). 
797:    Any a(i,j) with i>j input by user is ingored. 
798: */

802: PetscErrorCode MatSetValues_SeqSBAIJ(Mat A,PetscInt m,const PetscInt im[],PetscInt n,const PetscInt in[],const PetscScalar v[],InsertMode is)
803: {
804:   Mat_SeqSBAIJ   *a = (Mat_SeqSBAIJ*)A->data;
806:   PetscInt       *rp,k,low,high,t,ii,row,nrow,i,col,l,rmax,N,lastcol = -1;
807:   PetscInt       *imax=a->imax,*ai=a->i,*ailen=a->ilen,roworiented=a->roworiented;
808:   PetscInt       *aj=a->j,nonew=a->nonew,bs=A->rmap.bs,brow,bcol;
809:   PetscInt       ridx,cidx,bs2=a->bs2;
810:   MatScalar      *ap,value,*aa=a->a,*bap;
811: 
813:   for (k=0; k<m; k++) { /* loop over added rows */
814:     row  = im[k];       /* row number */
815:     brow = row/bs;      /* block row number */
816:     if (row < 0) continue;
817: #if defined(PETSC_USE_DEBUG)  
818:     if (row >= A->rmap.N) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Row too large: row %D max %D",row,A->rmap.N-1);
819: #endif
820:     rp   = aj + ai[brow]; /*ptr to beginning of column value of the row block*/
821:     ap   = aa + bs2*ai[brow]; /*ptr to beginning of element value of the row block*/
822:     rmax = imax[brow];  /* maximum space allocated for this row */
823:     nrow = ailen[brow]; /* actual length of this row */
824:     low  = 0;
825: 
826:     for (l=0; l<n; l++) { /* loop over added columns */
827:       if (in[l] < 0) continue;
828: #if defined(PETSC_USE_DEBUG)  
829:       if (in[l] >= A->rmap.N) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Column too large: col %D max %D",in[l],A->rmap.N-1);
830: #endif
831:       col = in[l];
832:       bcol = col/bs;              /* block col number */
833: 
834:       if (brow > bcol) {
835:         if (a->ignore_ltriangular){
836:           continue; /* ignore lower triangular values */
837:         } else {
838:           SETERRQ(PETSC_ERR_USER,"Lower triangular value cannot be set for sbaij format. Ignoring these values, run with -mat_ignore_lower_triangular or call MatSetOption(mat,MAT_IGNORE_LOWER_TRIANGULAR)");
839:         }
840:       }
841: 
842:       ridx = row % bs; cidx = col % bs; /*row and col index inside the block */
843:       if ((brow==bcol && ridx<=cidx) || (brow<bcol)){
844:         /* element value a(k,l) */
845:         if (roworiented) {
846:           value = v[l + k*n];
847:         } else {
848:           value = v[k + l*m];
849:         }
850: 
851:         /* move pointer bap to a(k,l) quickly and add/insert value */
852:         if (col <= lastcol) low = 0; high = nrow;
853:         lastcol = col;
854:         while (high-low > 7) {
855:           t = (low+high)/2;
856:           if (rp[t] > bcol) high = t;
857:           else              low  = t;
858:         }
859:         for (i=low; i<high; i++) {
860:           if (rp[i] > bcol) break;
861:           if (rp[i] == bcol) {
862:             bap  = ap +  bs2*i + bs*cidx + ridx;
863:             if (is == ADD_VALUES) *bap += value;
864:             else                  *bap  = value;
865:             /* for diag block, add/insert its symmetric element a(cidx,ridx) */
866:             if (brow == bcol && ridx < cidx){
867:               bap  = ap +  bs2*i + bs*ridx + cidx;
868:               if (is == ADD_VALUES) *bap += value;
869:               else                  *bap  = value;
870:             }
871:             goto noinsert1;
872:           }
873:         }
874: 
875:         if (nonew == 1) goto noinsert1;
876:         if (nonew == -1) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Inserting a new nonzero (%D, %D) in the matrix", row, col);
877:         MatSeqXAIJReallocateAIJ(A,a->mbs,bs2,nrow,brow,bcol,rmax,aa,ai,aj,rp,ap,imax,nonew,MatScalar);
878: 
879:         N = nrow++ - 1; high++;
880:         /* shift up all the later entries in this row */
881:         for (ii=N; ii>=i; ii--) {
882:           rp[ii+1] = rp[ii];
883:           PetscMemcpy(ap+bs2*(ii+1),ap+bs2*(ii),bs2*sizeof(MatScalar));
884:         }
885:         if (N>=i) {
886:           PetscMemzero(ap+bs2*i,bs2*sizeof(MatScalar));
887:         }
888:         rp[i]                      = bcol;
889:         ap[bs2*i + bs*cidx + ridx] = value;
890:       noinsert1:;
891:         low = i;
892:       }
893:     }   /* end of loop over added columns */
894:     ailen[brow] = nrow;
895:   }   /* end of loop over added rows */
896:   return(0);
897: }

901: PetscErrorCode MatICCFactor_SeqSBAIJ(Mat inA,IS row,MatFactorInfo *info)
902: {
903:   Mat_SeqSBAIJ   *a = (Mat_SeqSBAIJ*)inA->data;
904:   Mat            outA;
906:   PetscTruth     row_identity;
907: 
909:   if (info->levels != 0) SETERRQ(PETSC_ERR_SUP,"Only levels=0 is supported for in-place icc");
910:   ISIdentity(row,&row_identity);
911:   if (!row_identity) SETERRQ(PETSC_ERR_SUP,"Matrix reordering is not supported");
912:   if (inA->rmap.bs != 1) SETERRQ1(PETSC_ERR_SUP,"Matrix block size %D is not supported",inA->rmap.bs); /* Need to replace MatCholeskyFactorSymbolic_SeqSBAIJ_MSR()! */

914:   outA        = inA;
915:   inA->factor = FACTOR_CHOLESKY;
916: 
917:   MatMarkDiagonal_SeqSBAIJ(inA);
918:   /*
919:     Blocksize < 8 have a special faster factorization/solver 
920:     for ICC(0) factorization with natural ordering
921:   */
922:   switch (inA->rmap.bs){ /* Note: row_identity = PETSC_TRUE! */
923:   case 1:
924:     inA->ops->choleskyfactornumeric = MatCholeskyFactorNumeric_SeqSBAIJ_1_NaturalOrdering;
925:     inA->ops->solve            = MatSolve_SeqSBAIJ_1_NaturalOrdering;
926:     inA->ops->solvetranspose   = MatSolve_SeqSBAIJ_1_NaturalOrdering;
927:     inA->ops->solves           = MatSolves_SeqSBAIJ_1;
928:     inA->ops->forwardsolve     = MatForwardSolve_SeqSBAIJ_1_NaturalOrdering;
929:     inA->ops->backwardsolve    = MatBackwardSolve_SeqSBAIJ_1_NaturalOrdering;
930:     PetscInfo(inA,"Using special in-place natural ordering solvetrans BS=1\n");
931:     break;
932:   case 2:
933:     inA->ops->choleskyfactornumeric = MatCholeskyFactorNumeric_SeqSBAIJ_2_NaturalOrdering;
934:     inA->ops->solve           = MatSolve_SeqSBAIJ_2_NaturalOrdering;
935:     inA->ops->solvetranspose  = MatSolve_SeqSBAIJ_2_NaturalOrdering;
936:     inA->ops->forwardsolve     = MatForwardSolve_SeqSBAIJ_2_NaturalOrdering;
937:     inA->ops->backwardsolve    = MatBackwardSolve_SeqSBAIJ_2_NaturalOrdering;
938:     PetscInfo(inA,"Using special in-place natural ordering factor and solve BS=2\n");
939:     break;
940:   case 3:
941:      inA->ops->choleskyfactornumeric = MatCholeskyFactorNumeric_SeqSBAIJ_3_NaturalOrdering;
942:      inA->ops->solve           = MatSolve_SeqSBAIJ_3_NaturalOrdering;
943:      inA->ops->solvetranspose  = MatSolve_SeqSBAIJ_3_NaturalOrdering;
944:      inA->ops->forwardsolve    = MatForwardSolve_SeqSBAIJ_3_NaturalOrdering;
945:      inA->ops->backwardsolve   = MatBackwardSolve_SeqSBAIJ_3_NaturalOrdering;
946:      PetscInfo(inA,"Using special in-place natural ordering factor and solve BS=3\n");
947:      break;
948:   case 4:
949:     inA->ops->choleskyfactornumeric = MatCholeskyFactorNumeric_SeqSBAIJ_4_NaturalOrdering;
950:     inA->ops->solve           = MatSolve_SeqSBAIJ_4_NaturalOrdering;
951:     inA->ops->solvetranspose  = MatSolve_SeqSBAIJ_4_NaturalOrdering;
952:     inA->ops->forwardsolve    = MatForwardSolve_SeqSBAIJ_4_NaturalOrdering;
953:     inA->ops->backwardsolve   = MatBackwardSolve_SeqSBAIJ_4_NaturalOrdering;
954:     PetscInfo(inA,"Using special in-place natural ordering factor and solve BS=4\n");
955:     break;
956:   case 5:
957:     inA->ops->choleskyfactornumeric = MatCholeskyFactorNumeric_SeqSBAIJ_5_NaturalOrdering;
958:     inA->ops->solve           = MatSolve_SeqSBAIJ_5_NaturalOrdering;
959:     inA->ops->solvetranspose  = MatSolve_SeqSBAIJ_5_NaturalOrdering;
960:     inA->ops->forwardsolve    = MatForwardSolve_SeqSBAIJ_5_NaturalOrdering;
961:     inA->ops->backwardsolve   = MatBackwardSolve_SeqSBAIJ_5_NaturalOrdering;
962:     PetscInfo(inA,"Using special in-place natural ordering factor and solve BS=5\n");
963:     break;
964:   case 6:
965:     inA->ops->choleskyfactornumeric = MatCholeskyFactorNumeric_SeqSBAIJ_6_NaturalOrdering;
966:     inA->ops->solve           = MatSolve_SeqSBAIJ_6_NaturalOrdering;
967:     inA->ops->solvetranspose  = MatSolve_SeqSBAIJ_6_NaturalOrdering;
968:     inA->ops->forwardsolve    = MatForwardSolve_SeqSBAIJ_6_NaturalOrdering;
969:     inA->ops->backwardsolve   = MatBackwardSolve_SeqSBAIJ_6_NaturalOrdering;
970:     PetscInfo(inA,"Using special in-place natural ordering factor and solve BS=6\n");
971:     break;
972:   case 7:
973:     inA->ops->choleskyfactornumeric = MatCholeskyFactorNumeric_SeqSBAIJ_7_NaturalOrdering;
974:     inA->ops->solvetranspose  = MatSolve_SeqSBAIJ_7_NaturalOrdering;
975:     inA->ops->solve           = MatSolve_SeqSBAIJ_7_NaturalOrdering;
976:     inA->ops->forwardsolve    = MatForwardSolve_SeqSBAIJ_7_NaturalOrdering;
977:     inA->ops->backwardsolve   = MatBackwardSolve_SeqSBAIJ_7_NaturalOrdering;
978:     PetscInfo(inA,"Using special in-place natural ordering factor and solve BS=7\n");
979:     break;
980:   default:
981:     inA->ops->choleskyfactornumeric = MatCholeskyFactorNumeric_SeqSBAIJ_N_NaturalOrdering;
982:     inA->ops->solvetranspose  = MatSolve_SeqSBAIJ_N_NaturalOrdering;
983:     inA->ops->solve           = MatSolve_SeqSBAIJ_N_NaturalOrdering;
984:     inA->ops->forwardsolve    = MatForwardSolve_SeqSBAIJ_N_NaturalOrdering;
985:     inA->ops->backwardsolve   = MatBackwardSolve_SeqSBAIJ_N_NaturalOrdering;
986:     break;
987:   }
988: 
989:   PetscObjectReference((PetscObject)row);
990:   if (a->row) { ISDestroy(a->row); }
991:   a->row = row;
992:   PetscObjectReference((PetscObject)row);
993:   if (a->col) { ISDestroy(a->col); }
994:   a->col = row;
995: 
996:   /* Create the invert permutation so that it can be used in MatCholeskyFactorNumeric() */
997:   if (a->icol) {ISInvertPermutation(row,PETSC_DECIDE, &a->icol);}
998:   PetscLogObjectParent(inA,a->icol);
999: 
1000:   if (!a->solve_work) {
1001:     PetscMalloc((inA->rmap.N+inA->rmap.bs)*sizeof(PetscScalar),&a->solve_work);
1002:     PetscLogObjectMemory(inA,(inA->rmap.N+inA->rmap.bs)*sizeof(PetscScalar));
1003:   }
1004: 
1005:   MatCholeskyFactorNumeric(inA,info,&outA);
1006:   return(0);
1007: }

1012: PetscErrorCode  MatSeqSBAIJSetColumnIndices_SeqSBAIJ(Mat mat,PetscInt *indices)
1013: {
1014:   Mat_SeqSBAIJ *baij = (Mat_SeqSBAIJ *)mat->data;
1015:   PetscInt     i,nz,n;
1016: 
1018:   nz = baij->maxnz;
1019:   n  = mat->cmap.n;
1020:   for (i=0; i<nz; i++) {
1021:     baij->j[i] = indices[i];
1022:   }
1023:    baij->nz = nz;
1024:    for (i=0; i<n; i++) {
1025:      baij->ilen[i] = baij->imax[i];
1026:    }
1027:    return(0);
1028: }

1033: /*@
1034:   MatSeqSBAIJSetColumnIndices - Set the column indices for all the rows
1035:   in the matrix.
1036:   
1037:   Input Parameters:
1038:   +  mat     - the SeqSBAIJ matrix
1039:   -  indices - the column indices
1040:   
1041:   Level: advanced
1042:   
1043:   Notes:
1044:   This can be called if you have precomputed the nonzero structure of the 
1045:   matrix and want to provide it to the matrix object to improve the performance
1046:   of the MatSetValues() operation.
1047:   
1048:   You MUST have set the correct numbers of nonzeros per row in the call to 
1049:   MatCreateSeqSBAIJ(), and the columns indices MUST be sorted.
1050:   
1051:   MUST be called before any calls to MatSetValues()
1052:   
1053:   .seealso: MatCreateSeqSBAIJ
1054: @*/
1055: PetscErrorCode  MatSeqSBAIJSetColumnIndices(Mat mat,PetscInt *indices)
1056: {
1057:   PetscErrorCode ierr,(*f)(Mat,PetscInt *);
1058: 
1062:   PetscObjectQueryFunction((PetscObject)mat,"MatSeqSBAIJSetColumnIndices_C",(void (**)(void))&f);
1063:   if (f) {
1064:     (*f)(mat,indices);
1065:   } else {
1066:     SETERRQ(PETSC_ERR_SUP,"Wrong type of matrix to set column indices");
1067:   }
1068:   return(0);
1069: }

1073: PetscErrorCode MatCopy_SeqSBAIJ(Mat A,Mat B,MatStructure str)
1074: {

1078:   /* If the two matrices have the same copy implementation, use fast copy. */
1079:   if (str == SAME_NONZERO_PATTERN && (A->ops->copy == B->ops->copy)) {
1080:     Mat_SeqSBAIJ *a = (Mat_SeqSBAIJ*)A->data;
1081:     Mat_SeqSBAIJ *b = (Mat_SeqSBAIJ*)B->data;

1083:     if (a->i[A->rmap.N] != b->i[B->rmap.N]) {
1084:       SETERRQ(PETSC_ERR_ARG_INCOMP,"Number of nonzeros in two matrices are different");
1085:     }
1086:     PetscMemcpy(b->a,a->a,(a->i[A->rmap.N])*sizeof(PetscScalar));
1087:   } else {
1088:     MatGetRowUpperTriangular(A);
1089:     MatCopy_Basic(A,B,str);
1090:     MatRestoreRowUpperTriangular(A);
1091:   }
1092:   return(0);
1093: }

1097: PetscErrorCode MatSetUpPreallocation_SeqSBAIJ(Mat A)
1098: {
1100: 
1102:    MatSeqSBAIJSetPreallocation_SeqSBAIJ(A,PetscMax(A->rmap.bs,1),PETSC_DEFAULT,0);
1103:   return(0);
1104: }

1108: PetscErrorCode MatGetArray_SeqSBAIJ(Mat A,PetscScalar *array[])
1109: {
1110:   Mat_SeqSBAIJ *a = (Mat_SeqSBAIJ*)A->data;
1112:   *array = a->a;
1113:   return(0);
1114: }

1118: PetscErrorCode MatRestoreArray_SeqSBAIJ(Mat A,PetscScalar *array[])
1119: {
1121:   return(0);
1122:  }

1124:  #include petscblaslapack.h
1127: PetscErrorCode MatAXPY_SeqSBAIJ(Mat Y,PetscScalar a,Mat X,MatStructure str)
1128: {
1129:   Mat_SeqSBAIJ   *x=(Mat_SeqSBAIJ *)X->data, *y=(Mat_SeqSBAIJ *)Y->data;
1131:   PetscInt       i,bs=Y->rmap.bs,bs2,j;
1132:   PetscBLASInt   bnz = (PetscBLASInt)x->nz,one = 1;
1133: 
1135:   if (str == SAME_NONZERO_PATTERN) {
1136:     PetscScalar alpha = a;
1137:     BLASaxpy_(&bnz,&alpha,x->a,&one,y->a,&one);
1138:   } else if (str == SUBSET_NONZERO_PATTERN) { /* nonzeros of X is a subset of Y's */
1139:     if (y->xtoy && y->XtoY != X) {
1140:       PetscFree(y->xtoy);
1141:       MatDestroy(y->XtoY);
1142:     }
1143:     if (!y->xtoy) { /* get xtoy */
1144:       MatAXPYGetxtoy_Private(x->mbs,x->i,x->j,PETSC_NULL, y->i,y->j,PETSC_NULL, &y->xtoy);
1145:       y->XtoY = X;
1146:     }
1147:     bs2 = bs*bs;
1148:     for (i=0; i<x->nz; i++) {
1149:       j = 0;
1150:       while (j < bs2){
1151:         y->a[bs2*y->xtoy[i]+j] += a*(x->a[bs2*i+j]);
1152:         j++;
1153:       }
1154:     }
1155:     PetscInfo3(0,"ratio of nnz_s(X)/nnz_s(Y): %D/%D = %G\n",bs2*x->nz,bs2*y->nz,(PetscReal)(bs2*x->nz)/(bs2*y->nz));
1156:   } else {
1157:     MatGetRowUpperTriangular(X);
1158:     MatAXPY_Basic(Y,a,X,str);
1159:     MatRestoreRowUpperTriangular(X);
1160:   }
1161:   return(0);
1162: }

1166: PetscErrorCode MatIsSymmetric_SeqSBAIJ(Mat A,PetscReal tol,PetscTruth *flg)
1167: {
1169:   *flg = PETSC_TRUE;
1170:   return(0);
1171: }

1175: PetscErrorCode MatIsStructurallySymmetric_SeqSBAIJ(Mat A,PetscTruth *flg)
1176: {
1178:    *flg = PETSC_TRUE;
1179:    return(0);
1180: }

1184: PetscErrorCode MatIsHermitian_SeqSBAIJ(Mat A,PetscTruth *flg)
1185:  {
1187:    *flg = PETSC_FALSE;
1188:    return(0);
1189:  }

1193: PetscErrorCode MatRealPart_SeqSBAIJ(Mat A)
1194: {
1195:   Mat_SeqSBAIJ   *a = (Mat_SeqSBAIJ*)A->data;
1196:   PetscInt       i,nz = a->bs2*a->i[a->mbs];
1197:   PetscScalar    *aa = a->a;

1200:   for (i=0; i<nz; i++) aa[i] = PetscRealPart(aa[i]);
1201:   return(0);
1202: }

1206: PetscErrorCode MatImaginaryPart_SeqSBAIJ(Mat A)
1207: {
1208:   Mat_SeqSBAIJ   *a = (Mat_SeqSBAIJ*)A->data;
1209:   PetscInt       i,nz = a->bs2*a->i[a->mbs];
1210:   PetscScalar    *aa = a->a;

1213:   for (i=0; i<nz; i++) aa[i] = PetscImaginaryPart(aa[i]);
1214:   return(0);
1215: }

1217: /* -------------------------------------------------------------------*/
1218: static struct _MatOps MatOps_Values = {MatSetValues_SeqSBAIJ,
1219:        MatGetRow_SeqSBAIJ,
1220:        MatRestoreRow_SeqSBAIJ,
1221:        MatMult_SeqSBAIJ_N,
1222: /* 4*/ MatMultAdd_SeqSBAIJ_N,
1223:        MatMult_SeqSBAIJ_N,       /* transpose versions are same as non-transpose versions */
1224:        MatMultAdd_SeqSBAIJ_N,
1225:        MatSolve_SeqSBAIJ_N,
1226:        0,
1227:        0,
1228: /*10*/ 0,
1229:        0,
1230:        MatCholeskyFactor_SeqSBAIJ,
1231:        MatRelax_SeqSBAIJ,
1232:        MatTranspose_SeqSBAIJ,
1233: /*15*/ MatGetInfo_SeqSBAIJ,
1234:        MatEqual_SeqSBAIJ,
1235:        MatGetDiagonal_SeqSBAIJ,
1236:        MatDiagonalScale_SeqSBAIJ,
1237:        MatNorm_SeqSBAIJ,
1238: /*20*/ 0,
1239:        MatAssemblyEnd_SeqSBAIJ,
1240:        0,
1241:        MatSetOption_SeqSBAIJ,
1242:        MatZeroEntries_SeqSBAIJ,
1243: /*25*/ 0,
1244:        0,
1245:        0,
1246:        MatCholeskyFactorSymbolic_SeqSBAIJ,
1247:        MatCholeskyFactorNumeric_SeqSBAIJ_N,
1248: /*30*/ MatSetUpPreallocation_SeqSBAIJ,
1249:        0,
1250:        MatICCFactorSymbolic_SeqSBAIJ,
1251:        MatGetArray_SeqSBAIJ,
1252:        MatRestoreArray_SeqSBAIJ,
1253: /*35*/ MatDuplicate_SeqSBAIJ,
1254:        MatForwardSolve_SeqSBAIJ_N,
1255:        MatBackwardSolve_SeqSBAIJ_N,
1256:        0,
1257:        MatICCFactor_SeqSBAIJ,
1258: /*40*/ MatAXPY_SeqSBAIJ,
1259:        MatGetSubMatrices_SeqSBAIJ,
1260:        MatIncreaseOverlap_SeqSBAIJ,
1261:        MatGetValues_SeqSBAIJ,
1262:        MatCopy_SeqSBAIJ,
1263: /*45*/ 0,
1264:        MatScale_SeqSBAIJ,
1265:        0,
1266:        0,
1267:        0,
1268: /*50*/ 0,
1269:        MatGetRowIJ_SeqSBAIJ,
1270:        MatRestoreRowIJ_SeqSBAIJ,
1271:        0,
1272:        0,
1273: /*55*/ 0,
1274:        0,
1275:        0,
1276:        0,
1277:        MatSetValuesBlocked_SeqSBAIJ,
1278: /*60*/ MatGetSubMatrix_SeqSBAIJ,
1279:        0,
1280:        0,
1281:        0,
1282:        0,
1283: /*65*/ 0,
1284:        0,
1285:        0,
1286:        0,
1287:        0,
1288: /*70*/ MatGetRowMaxAbs_SeqSBAIJ,
1289:        0,
1290:        0,
1291:        0,
1292:        0,
1293: /*75*/ 0,
1294:        0,
1295:        0,
1296:        0,
1297:        0,
1298: /*80*/ 0,
1299:        0,
1300:        0,
1301: #if !defined(PETSC_USE_COMPLEX)
1302:        MatGetInertia_SeqSBAIJ,
1303: #else
1304:        0,
1305: #endif
1306:        MatLoad_SeqSBAIJ,
1307: /*85*/ MatIsSymmetric_SeqSBAIJ,
1308:        MatIsHermitian_SeqSBAIJ,
1309:        MatIsStructurallySymmetric_SeqSBAIJ,
1310:        0,
1311:        0,
1312: /*90*/ 0,
1313:        0,
1314:        0,
1315:        0,
1316:        0,
1317: /*95*/ 0,
1318:        0,
1319:        0,
1320:        0,
1321:        0,
1322: /*100*/0,
1323:        0,
1324:        0,
1325:        0,
1326:        0,
1327: /*105*/0,
1328:        MatRealPart_SeqSBAIJ,
1329:        MatImaginaryPart_SeqSBAIJ,
1330:        MatGetRowUpperTriangular_SeqSBAIJ,
1331:        MatRestoreRowUpperTriangular_SeqSBAIJ
1332: };

1337: PetscErrorCode  MatStoreValues_SeqSBAIJ(Mat mat)
1338: {
1339:   Mat_SeqSBAIJ   *aij = (Mat_SeqSBAIJ *)mat->data;
1340:   PetscInt       nz = aij->i[mat->rmap.N]*mat->rmap.bs*aij->bs2;
1342: 
1344:   if (aij->nonew != 1) {
1345:     SETERRQ(PETSC_ERR_ORDER,"Must call MatSetOption(A,MAT_NO_NEW_NONZERO_LOCATIONS);first");
1346:   }
1347: 
1348:   /* allocate space for values if not already there */
1349:   if (!aij->saved_values) {
1350:     PetscMalloc((nz+1)*sizeof(PetscScalar),&aij->saved_values);
1351:   }
1352: 
1353:   /* copy values over */
1354:   PetscMemcpy(aij->saved_values,aij->a,nz*sizeof(PetscScalar));
1355:   return(0);
1356: }

1362: PetscErrorCode  MatRetrieveValues_SeqSBAIJ(Mat mat)
1363: {
1364:   Mat_SeqSBAIJ   *aij = (Mat_SeqSBAIJ *)mat->data;
1366:   PetscInt       nz = aij->i[mat->rmap.N]*mat->rmap.bs*aij->bs2;
1367: 
1369:   if (aij->nonew != 1) {
1370:     SETERRQ(PETSC_ERR_ORDER,"Must call MatSetOption(A,MAT_NO_NEW_NONZERO_LOCATIONS);first");
1371:   }
1372:   if (!aij->saved_values) {
1373:     SETERRQ(PETSC_ERR_ORDER,"Must call MatStoreValues(A);first");
1374:   }
1375: 
1376:   /* copy values over */
1377:   PetscMemcpy(aij->a,aij->saved_values,nz*sizeof(PetscScalar));
1378:   return(0);
1379: }

1385: PetscErrorCode  MatSeqSBAIJSetPreallocation_SeqSBAIJ(Mat B,PetscInt bs,PetscInt nz,PetscInt *nnz)
1386: {
1387:   Mat_SeqSBAIJ   *b = (Mat_SeqSBAIJ*)B->data;
1389:   PetscInt       i,mbs,bs2;
1390:   PetscTruth     skipallocation = PETSC_FALSE,flg;
1391: 
1393:   B->preallocated = PETSC_TRUE;
1394:   PetscOptionsGetInt(B->prefix,"-mat_block_size",&bs,PETSC_NULL);
1395:   B->rmap.bs = B->cmap.bs = bs;
1396:   PetscMapSetUp(&B->rmap);
1397:   PetscMapSetUp(&B->cmap);

1399:   mbs  = B->rmap.N/bs;
1400:   bs2  = bs*bs;
1401: 
1402:   if (mbs*bs != B->rmap.N) {
1403:     SETERRQ(PETSC_ERR_ARG_SIZ,"Number rows, cols must be divisible by blocksize");
1404:   }
1405: 
1406:   if (nz == MAT_SKIP_ALLOCATION) {
1407:     skipallocation = PETSC_TRUE;
1408:     nz             = 0;
1409:   }

1411:   if (nz == PETSC_DEFAULT || nz == PETSC_DECIDE) nz = 3;
1412:   if (nz < 0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"nz cannot be less than 0: value %D",nz);
1413:   if (nnz) {
1414:     for (i=0; i<mbs; i++) {
1415:       if (nnz[i] < 0) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"nnz cannot be less than 0: local row %D value %D",i,nnz[i]);
1416:       if (nnz[i] > mbs) SETERRQ3(PETSC_ERR_ARG_OUTOFRANGE,"nnz cannot be greater than block row length: local row %D value %D rowlength %D",i,nnz[i],mbs);
1417:     }
1418:   }
1419: 
1420:   PetscOptionsHasName(B->prefix,"-mat_no_unroll",&flg);
1421: