Actual source code: matrix.c

petsc-master 2019-10-20
Report Typos and Errors
  1: /*
  2:    This is where the abstract matrix operations are defined
  3: */

  5:  #include <petsc/private/matimpl.h>
  6:  #include <petsc/private/isimpl.h>
  7:  #include <petsc/private/vecimpl.h>

  9: /* Logging support */
 10: PetscClassId MAT_CLASSID;
 11: PetscClassId MAT_COLORING_CLASSID;
 12: PetscClassId MAT_FDCOLORING_CLASSID;
 13: PetscClassId MAT_TRANSPOSECOLORING_CLASSID;

 15: PetscLogEvent MAT_Mult, MAT_Mults, MAT_MultConstrained, MAT_MultAdd, MAT_MultTranspose;
 16: PetscLogEvent MAT_MultTransposeConstrained, MAT_MultTransposeAdd, MAT_Solve, MAT_Solves, MAT_SolveAdd, MAT_SolveTranspose, MAT_MatSolve,MAT_MatTrSolve;
 17: PetscLogEvent MAT_SolveTransposeAdd, MAT_SOR, MAT_ForwardSolve, MAT_BackwardSolve, MAT_LUFactor, MAT_LUFactorSymbolic;
 18: PetscLogEvent MAT_LUFactorNumeric, MAT_CholeskyFactor, MAT_CholeskyFactorSymbolic, MAT_CholeskyFactorNumeric, MAT_ILUFactor;
 19: PetscLogEvent MAT_ILUFactorSymbolic, MAT_ICCFactorSymbolic, MAT_Copy, MAT_Convert, MAT_Scale, MAT_AssemblyBegin;
 20: PetscLogEvent MAT_AssemblyEnd, MAT_SetValues, MAT_GetValues, MAT_GetRow, MAT_GetRowIJ, MAT_CreateSubMats, MAT_GetOrdering, MAT_RedundantMat, MAT_GetSeqNonzeroStructure;
 21: PetscLogEvent MAT_IncreaseOverlap, MAT_Partitioning, MAT_PartitioningND, MAT_Coarsen, MAT_ZeroEntries, MAT_Load, MAT_View, MAT_AXPY, MAT_FDColoringCreate;
 22: PetscLogEvent MAT_FDColoringSetUp, MAT_FDColoringApply,MAT_Transpose,MAT_FDColoringFunction, MAT_CreateSubMat;
 23: PetscLogEvent MAT_TransposeColoringCreate;
 24: PetscLogEvent MAT_MatMult, MAT_MatMultSymbolic, MAT_MatMultNumeric;
 25: PetscLogEvent MAT_PtAP, MAT_PtAPSymbolic, MAT_PtAPNumeric,MAT_RARt, MAT_RARtSymbolic, MAT_RARtNumeric;
 26: PetscLogEvent MAT_MatTransposeMult, MAT_MatTransposeMultSymbolic, MAT_MatTransposeMultNumeric;
 27: PetscLogEvent MAT_TransposeMatMult, MAT_TransposeMatMultSymbolic, MAT_TransposeMatMultNumeric;
 28: PetscLogEvent MAT_MatMatMult, MAT_MatMatMultSymbolic, MAT_MatMatMultNumeric;
 29: PetscLogEvent MAT_MultHermitianTranspose,MAT_MultHermitianTransposeAdd;
 30: PetscLogEvent MAT_Getsymtranspose, MAT_Getsymtransreduced, MAT_GetBrowsOfAcols;
 31: PetscLogEvent MAT_GetBrowsOfAocols, MAT_Getlocalmat, MAT_Getlocalmatcondensed, MAT_Seqstompi, MAT_Seqstompinum, MAT_Seqstompisym;
 32: PetscLogEvent MAT_Applypapt, MAT_Applypapt_numeric, MAT_Applypapt_symbolic, MAT_GetSequentialNonzeroStructure;
 33: PetscLogEvent MAT_GetMultiProcBlock;
 34: PetscLogEvent MAT_CUSPARSECopyToGPU, MAT_SetValuesBatch;
 35: PetscLogEvent MAT_ViennaCLCopyToGPU;
 36: PetscLogEvent MAT_DenseCopyToGPU, MAT_DenseCopyFromGPU;
 37: PetscLogEvent MAT_Merge,MAT_Residual,MAT_SetRandom;
 38: PetscLogEvent MAT_FactorFactS,MAT_FactorInvS;
 39: PetscLogEvent MATCOLORING_Apply,MATCOLORING_Comm,MATCOLORING_Local,MATCOLORING_ISCreate,MATCOLORING_SetUp,MATCOLORING_Weights;

 41: const char *const MatFactorTypes[] = {"NONE","LU","CHOLESKY","ILU","ICC","ILUDT","MatFactorType","MAT_FACTOR_",0};

 43: /*@
 44:    MatSetRandom - Sets all components of a matrix to random numbers. For sparse matrices that have been preallocated but not been assembled it randomly selects appropriate locations,
 45:                   for sparse matrices that already have locations it fills the locations with random numbers

 47:    Logically Collective on Mat

 49:    Input Parameters:
 50: +  x  - the matrix
 51: -  rctx - the random number context, formed by PetscRandomCreate(), or NULL and
 52:           it will create one internally.

 54:    Output Parameter:
 55: .  x  - the matrix

 57:    Example of Usage:
 58: .vb
 59:      PetscRandomCreate(PETSC_COMM_WORLD,&rctx);
 60:      MatSetRandom(x,rctx);
 61:      PetscRandomDestroy(rctx);
 62: .ve

 64:    Level: intermediate


 67: .seealso: MatZeroEntries(), MatSetValues(), PetscRandomCreate(), PetscRandomDestroy()
 68: @*/
 69: PetscErrorCode MatSetRandom(Mat x,PetscRandom rctx)
 70: {
 72:   PetscRandom    randObj = NULL;


 79:   if (!x->ops->setrandom) SETERRQ1(PetscObjectComm((PetscObject)x),PETSC_ERR_SUP,"Mat type %s",((PetscObject)x)->type_name);

 81:   if (!rctx) {
 82:     MPI_Comm comm;
 83:     PetscObjectGetComm((PetscObject)x,&comm);
 84:     PetscRandomCreate(comm,&randObj);
 85:     PetscRandomSetFromOptions(randObj);
 86:     rctx = randObj;
 87:   }

 89:   PetscLogEventBegin(MAT_SetRandom,x,rctx,0,0);
 90:   (*x->ops->setrandom)(x,rctx);
 91:   PetscLogEventEnd(MAT_SetRandom,x,rctx,0,0);

 93:   MatAssemblyBegin(x, MAT_FINAL_ASSEMBLY);
 94:   MatAssemblyEnd(x, MAT_FINAL_ASSEMBLY);
 95:   PetscRandomDestroy(&randObj);
 96:   return(0);
 97: }

 99: /*@
100:    MatFactorGetErrorZeroPivot - returns the pivot value that was determined to be zero and the row it occurred in

102:    Logically Collective on Mat

104:    Input Parameters:
105: .  mat - the factored matrix

107:    Output Parameter:
108: +  pivot - the pivot value computed
109: -  row - the row that the zero pivot occurred. Note that this row must be interpreted carefully due to row reorderings and which processes
110:          the share the matrix

112:    Level: advanced

114:    Notes:
115:     This routine does not work for factorizations done with external packages.
116:    This routine should only be called if MatGetFactorError() returns a value of MAT_FACTOR_NUMERIC_ZEROPIVOT

118:    This can be called on non-factored matrices that come from, for example, matrices used in SOR.

120: .seealso: MatZeroEntries(), MatFactor(), MatGetFactor(), MatFactorSymbolic(), MatFactorClearError(), MatFactorGetErrorZeroPivot()
121: @*/
122: PetscErrorCode MatFactorGetErrorZeroPivot(Mat mat,PetscReal *pivot,PetscInt *row)
123: {
126:   *pivot = mat->factorerror_zeropivot_value;
127:   *row   = mat->factorerror_zeropivot_row;
128:   return(0);
129: }

131: /*@
132:    MatFactorGetError - gets the error code from a factorization

134:    Logically Collective on Mat

136:    Input Parameters:
137: .  mat - the factored matrix

139:    Output Parameter:
140: .  err  - the error code

142:    Level: advanced

144:    Notes:
145:     This can be called on non-factored matrices that come from, for example, matrices used in SOR.

147: .seealso: MatZeroEntries(), MatFactor(), MatGetFactor(), MatFactorSymbolic(), MatFactorClearError(), MatFactorGetErrorZeroPivot()
148: @*/
149: PetscErrorCode MatFactorGetError(Mat mat,MatFactorError *err)
150: {
153:   *err = mat->factorerrortype;
154:   return(0);
155: }

157: /*@
158:    MatFactorClearError - clears the error code in a factorization

160:    Logically Collective on Mat

162:    Input Parameter:
163: .  mat - the factored matrix

165:    Level: developer

167:    Notes:
168:     This can be called on non-factored matrices that come from, for example, matrices used in SOR.

170: .seealso: MatZeroEntries(), MatFactor(), MatGetFactor(), MatFactorSymbolic(), MatFactorGetError(), MatFactorGetErrorZeroPivot()
171: @*/
172: PetscErrorCode MatFactorClearError(Mat mat)
173: {
176:   mat->factorerrortype             = MAT_FACTOR_NOERROR;
177:   mat->factorerror_zeropivot_value = 0.0;
178:   mat->factorerror_zeropivot_row   = 0;
179:   return(0);
180: }

182: PETSC_INTERN PetscErrorCode MatFindNonzeroRowsOrCols_Basic(Mat mat,PetscBool cols,PetscReal tol,IS *nonzero)
183: {
184:   PetscErrorCode    ierr;
185:   Vec               r,l;
186:   const PetscScalar *al;
187:   PetscInt          i,nz,gnz,N,n;

190:   MatCreateVecs(mat,&r,&l);
191:   if (!cols) { /* nonzero rows */
192:     MatGetSize(mat,&N,NULL);
193:     MatGetLocalSize(mat,&n,NULL);
194:     VecSet(l,0.0);
195:     VecSetRandom(r,NULL);
196:     MatMult(mat,r,l);
197:     VecGetArrayRead(l,&al);
198:   } else { /* nonzero columns */
199:     MatGetSize(mat,NULL,&N);
200:     MatGetLocalSize(mat,NULL,&n);
201:     VecSet(r,0.0);
202:     VecSetRandom(l,NULL);
203:     MatMultTranspose(mat,l,r);
204:     VecGetArrayRead(r,&al);
205:   }
206:   if (tol <= 0.0) { for (i=0,nz=0;i<n;i++) if (al[i] != 0.0) nz++; }
207:   else { for (i=0,nz=0;i<n;i++) if (PetscAbsScalar(al[i]) > tol) nz++; }
208:   MPIU_Allreduce(&nz,&gnz,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)mat));
209:   if (gnz != N) {
210:     PetscInt *nzr;
211:     PetscMalloc1(nz,&nzr);
212:     if (nz) {
213:       if (tol < 0) { for (i=0,nz=0;i<n;i++) if (al[i] != 0.0) nzr[nz++] = i; }
214:       else { for (i=0,nz=0;i<n;i++) if (PetscAbsScalar(al[i]) > tol) nzr[nz++] = i; }
215:     }
216:     ISCreateGeneral(PetscObjectComm((PetscObject)mat),nz,nzr,PETSC_OWN_POINTER,nonzero);
217:   } else *nonzero = NULL;
218:   if (!cols) { /* nonzero rows */
219:     VecRestoreArrayRead(l,&al);
220:   } else {
221:     VecRestoreArrayRead(r,&al);
222:   }
223:   VecDestroy(&l);
224:   VecDestroy(&r);
225:   return(0);
226: }

228: /*@
229:       MatFindNonzeroRows - Locate all rows that are not completely zero in the matrix

231:   Input Parameter:
232: .    A  - the matrix

234:   Output Parameter:
235: .    keptrows - the rows that are not completely zero

237:   Notes:
238:     keptrows is set to NULL if all rows are nonzero.

240:   Level: intermediate

242:  @*/
243: PetscErrorCode MatFindNonzeroRows(Mat mat,IS *keptrows)
244: {

251:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
252:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
253:   if (!mat->ops->findnonzerorows) {
254:     MatFindNonzeroRowsOrCols_Basic(mat,PETSC_FALSE,0.0,keptrows);
255:   } else {
256:     (*mat->ops->findnonzerorows)(mat,keptrows);
257:   }
258:   return(0);
259: }

261: /*@
262:       MatFindZeroRows - Locate all rows that are completely zero in the matrix

264:   Input Parameter:
265: .    A  - the matrix

267:   Output Parameter:
268: .    zerorows - the rows that are completely zero

270:   Notes:
271:     zerorows is set to NULL if no rows are zero.

273:   Level: intermediate

275:  @*/
276: PetscErrorCode MatFindZeroRows(Mat mat,IS *zerorows)
277: {
279:   IS keptrows;
280:   PetscInt m, n;


285:   MatFindNonzeroRows(mat, &keptrows);
286:   /* MatFindNonzeroRows sets keptrows to NULL if there are no zero rows.
287:      In keeping with this convention, we set zerorows to NULL if there are no zero
288:      rows. */
289:   if (keptrows == NULL) {
290:     *zerorows = NULL;
291:   } else {
292:     MatGetOwnershipRange(mat,&m,&n);
293:     ISComplement(keptrows,m,n,zerorows);
294:     ISDestroy(&keptrows);
295:   }
296:   return(0);
297: }

299: /*@
300:    MatGetDiagonalBlock - Returns the part of the matrix associated with the on-process coupling

302:    Not Collective

304:    Input Parameters:
305: .   A - the matrix

307:    Output Parameters:
308: .   a - the diagonal part (which is a SEQUENTIAL matrix)

310:    Notes:
311:     see the manual page for MatCreateAIJ() for more information on the "diagonal part" of the matrix.
312:           Use caution, as the reference count on the returned matrix is not incremented and it is used as
313:           part of the containing MPI Mat's normal operation.

315:    Level: advanced

317: @*/
318: PetscErrorCode MatGetDiagonalBlock(Mat A,Mat *a)
319: {

326:   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
327:   if (!A->ops->getdiagonalblock) {
328:     PetscMPIInt size;
329:     MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);
330:     if (size == 1) {
331:       *a = A;
332:       return(0);
333:     } else SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Not coded for this matrix type");
334:   }
335:   (*A->ops->getdiagonalblock)(A,a);
336:   return(0);
337: }

339: /*@
340:    MatGetTrace - Gets the trace of a matrix. The sum of the diagonal entries.

342:    Collective on Mat

344:    Input Parameters:
345: .  mat - the matrix

347:    Output Parameter:
348: .   trace - the sum of the diagonal entries

350:    Level: advanced

352: @*/
353: PetscErrorCode MatGetTrace(Mat mat,PetscScalar *trace)
354: {
356:   Vec            diag;

359:   MatCreateVecs(mat,&diag,NULL);
360:   MatGetDiagonal(mat,diag);
361:   VecSum(diag,trace);
362:   VecDestroy(&diag);
363:   return(0);
364: }

366: /*@
367:    MatRealPart - Zeros out the imaginary part of the matrix

369:    Logically Collective on Mat

371:    Input Parameters:
372: .  mat - the matrix

374:    Level: advanced


377: .seealso: MatImaginaryPart()
378: @*/
379: PetscErrorCode MatRealPart(Mat mat)
380: {

386:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
387:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
388:   if (!mat->ops->realpart) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
389:   MatCheckPreallocated(mat,1);
390:   (*mat->ops->realpart)(mat);
391:   return(0);
392: }

394: /*@C
395:    MatGetGhosts - Get the global index of all ghost nodes defined by the sparse matrix

397:    Collective on Mat

399:    Input Parameter:
400: .  mat - the matrix

402:    Output Parameters:
403: +   nghosts - number of ghosts (note for BAIJ matrices there is one ghost for each block)
404: -   ghosts - the global indices of the ghost points

406:    Notes:
407:     the nghosts and ghosts are suitable to pass into VecCreateGhost()

409:    Level: advanced

411: @*/
412: PetscErrorCode MatGetGhosts(Mat mat,PetscInt *nghosts,const PetscInt *ghosts[])
413: {

419:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
420:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
421:   if (!mat->ops->getghosts) {
422:     if (nghosts) *nghosts = 0;
423:     if (ghosts) *ghosts = 0;
424:   } else {
425:     (*mat->ops->getghosts)(mat,nghosts,ghosts);
426:   }
427:   return(0);
428: }


431: /*@
432:    MatImaginaryPart - Moves the imaginary part of the matrix to the real part and zeros the imaginary part

434:    Logically Collective on Mat

436:    Input Parameters:
437: .  mat - the matrix

439:    Level: advanced


442: .seealso: MatRealPart()
443: @*/
444: PetscErrorCode MatImaginaryPart(Mat mat)
445: {

451:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
452:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
453:   if (!mat->ops->imaginarypart) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
454:   MatCheckPreallocated(mat,1);
455:   (*mat->ops->imaginarypart)(mat);
456:   return(0);
457: }

459: /*@
460:    MatMissingDiagonal - Determine if sparse matrix is missing a diagonal entry (or block entry for BAIJ matrices)

462:    Not Collective

464:    Input Parameter:
465: .  mat - the matrix

467:    Output Parameters:
468: +  missing - is any diagonal missing
469: -  dd - first diagonal entry that is missing (optional) on this process

471:    Level: advanced


474: .seealso: MatRealPart()
475: @*/
476: PetscErrorCode MatMissingDiagonal(Mat mat,PetscBool *missing,PetscInt *dd)
477: {

483:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
484:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
485:   if (!mat->ops->missingdiagonal) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
486:   (*mat->ops->missingdiagonal)(mat,missing,dd);
487:   return(0);
488: }

490: /*@C
491:    MatGetRow - Gets a row of a matrix.  You MUST call MatRestoreRow()
492:    for each row that you get to ensure that your application does
493:    not bleed memory.

495:    Not Collective

497:    Input Parameters:
498: +  mat - the matrix
499: -  row - the row to get

501:    Output Parameters:
502: +  ncols -  if not NULL, the number of nonzeros in the row
503: .  cols - if not NULL, the column numbers
504: -  vals - if not NULL, the values

506:    Notes:
507:    This routine is provided for people who need to have direct access
508:    to the structure of a matrix.  We hope that we provide enough
509:    high-level matrix routines that few users will need it.

511:    MatGetRow() always returns 0-based column indices, regardless of
512:    whether the internal representation is 0-based (default) or 1-based.

514:    For better efficiency, set cols and/or vals to NULL if you do
515:    not wish to extract these quantities.

517:    The user can only examine the values extracted with MatGetRow();
518:    the values cannot be altered.  To change the matrix entries, one
519:    must use MatSetValues().

521:    You can only have one call to MatGetRow() outstanding for a particular
522:    matrix at a time, per processor. MatGetRow() can only obtain rows
523:    associated with the given processor, it cannot get rows from the
524:    other processors; for that we suggest using MatCreateSubMatrices(), then
525:    MatGetRow() on the submatrix. The row index passed to MatGetRow()
526:    is in the global number of rows.

528:    Fortran Notes:
529:    The calling sequence from Fortran is
530: .vb
531:    MatGetRow(matrix,row,ncols,cols,values,ierr)
532:          Mat     matrix (input)
533:          integer row    (input)
534:          integer ncols  (output)
535:          integer cols(maxcols) (output)
536:          double precision (or double complex) values(maxcols) output
537: .ve
538:    where maxcols >= maximum nonzeros in any row of the matrix.


541:    Caution:
542:    Do not try to change the contents of the output arrays (cols and vals).
543:    In some cases, this may corrupt the matrix.

545:    Level: advanced

547: .seealso: MatRestoreRow(), MatSetValues(), MatGetValues(), MatCreateSubMatrices(), MatGetDiagonal()
548: @*/
549: PetscErrorCode MatGetRow(Mat mat,PetscInt row,PetscInt *ncols,const PetscInt *cols[],const PetscScalar *vals[])
550: {
552:   PetscInt       incols;

557:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
558:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
559:   if (!mat->ops->getrow) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
560:   MatCheckPreallocated(mat,1);
561:   PetscLogEventBegin(MAT_GetRow,mat,0,0,0);
562:   (*mat->ops->getrow)(mat,row,&incols,(PetscInt**)cols,(PetscScalar**)vals);
563:   if (ncols) *ncols = incols;
564:   PetscLogEventEnd(MAT_GetRow,mat,0,0,0);
565:   return(0);
566: }

568: /*@
569:    MatConjugate - replaces the matrix values with their complex conjugates

571:    Logically Collective on Mat

573:    Input Parameters:
574: .  mat - the matrix

576:    Level: advanced

578: .seealso:  VecConjugate()
579: @*/
580: PetscErrorCode MatConjugate(Mat mat)
581: {
582: #if defined(PETSC_USE_COMPLEX)

587:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
588:   if (!mat->ops->conjugate) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Not provided for this matrix format, send email to petsc-maint@mcs.anl.gov");
589:   (*mat->ops->conjugate)(mat);
590: #else
592: #endif
593:   return(0);
594: }

596: /*@C
597:    MatRestoreRow - Frees any temporary space allocated by MatGetRow().

599:    Not Collective

601:    Input Parameters:
602: +  mat - the matrix
603: .  row - the row to get
604: .  ncols, cols - the number of nonzeros and their columns
605: -  vals - if nonzero the column values

607:    Notes:
608:    This routine should be called after you have finished examining the entries.

610:    This routine zeros out ncols, cols, and vals. This is to prevent accidental
611:    us of the array after it has been restored. If you pass NULL, it will
612:    not zero the pointers.  Use of cols or vals after MatRestoreRow is invalid.

614:    Fortran Notes:
615:    The calling sequence from Fortran is
616: .vb
617:    MatRestoreRow(matrix,row,ncols,cols,values,ierr)
618:       Mat     matrix (input)
619:       integer row    (input)
620:       integer ncols  (output)
621:       integer cols(maxcols) (output)
622:       double precision (or double complex) values(maxcols) output
623: .ve
624:    Where maxcols >= maximum nonzeros in any row of the matrix.

626:    In Fortran MatRestoreRow() MUST be called after MatGetRow()
627:    before another call to MatGetRow() can be made.

629:    Level: advanced

631: .seealso:  MatGetRow()
632: @*/
633: PetscErrorCode MatRestoreRow(Mat mat,PetscInt row,PetscInt *ncols,const PetscInt *cols[],const PetscScalar *vals[])
634: {

640:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
641:   if (!mat->ops->restorerow) return(0);
642:   (*mat->ops->restorerow)(mat,row,ncols,(PetscInt **)cols,(PetscScalar **)vals);
643:   if (ncols) *ncols = 0;
644:   if (cols)  *cols = NULL;
645:   if (vals)  *vals = NULL;
646:   return(0);
647: }

649: /*@
650:    MatGetRowUpperTriangular - Sets a flag to enable calls to MatGetRow() for matrix in MATSBAIJ format.
651:    You should call MatRestoreRowUpperTriangular() after calling MatGetRow/MatRestoreRow() to disable the flag.

653:    Not Collective

655:    Input Parameters:
656: .  mat - the matrix

658:    Notes:
659:    The flag is to ensure that users are aware of MatGetRow() only provides the upper triangular part of the row for the matrices in MATSBAIJ format.

661:    Level: advanced

663: .seealso: MatRestoreRowUpperTriangular()
664: @*/
665: PetscErrorCode MatGetRowUpperTriangular(Mat mat)
666: {

672:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
673:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
674:   MatCheckPreallocated(mat,1);
675:   if (!mat->ops->getrowuppertriangular) return(0);
676:   (*mat->ops->getrowuppertriangular)(mat);
677:   return(0);
678: }

680: /*@
681:    MatRestoreRowUpperTriangular - Disable calls to MatGetRow() for matrix in MATSBAIJ format.

683:    Not Collective

685:    Input Parameters:
686: .  mat - the matrix

688:    Notes:
689:    This routine should be called after you have finished MatGetRow/MatRestoreRow().


692:    Level: advanced

694: .seealso:  MatGetRowUpperTriangular()
695: @*/
696: PetscErrorCode MatRestoreRowUpperTriangular(Mat mat)
697: {

703:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
704:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
705:   MatCheckPreallocated(mat,1);
706:   if (!mat->ops->restorerowuppertriangular) return(0);
707:   (*mat->ops->restorerowuppertriangular)(mat);
708:   return(0);
709: }

711: /*@C
712:    MatSetOptionsPrefix - Sets the prefix used for searching for all
713:    Mat options in the database.

715:    Logically Collective on Mat

717:    Input Parameter:
718: +  A - the Mat context
719: -  prefix - the prefix to prepend to all option names

721:    Notes:
722:    A hyphen (-) must NOT be given at the beginning of the prefix name.
723:    The first character of all runtime options is AUTOMATICALLY the hyphen.

725:    Level: advanced

727: .seealso: MatSetFromOptions()
728: @*/
729: PetscErrorCode MatSetOptionsPrefix(Mat A,const char prefix[])
730: {

735:   PetscObjectSetOptionsPrefix((PetscObject)A,prefix);
736:   return(0);
737: }

739: /*@C
740:    MatAppendOptionsPrefix - Appends to the prefix used for searching for all
741:    Mat options in the database.

743:    Logically Collective on Mat

745:    Input Parameters:
746: +  A - the Mat context
747: -  prefix - the prefix to prepend to all option names

749:    Notes:
750:    A hyphen (-) must NOT be given at the beginning of the prefix name.
751:    The first character of all runtime options is AUTOMATICALLY the hyphen.

753:    Level: advanced

755: .seealso: MatGetOptionsPrefix()
756: @*/
757: PetscErrorCode MatAppendOptionsPrefix(Mat A,const char prefix[])
758: {

763:   PetscObjectAppendOptionsPrefix((PetscObject)A,prefix);
764:   return(0);
765: }

767: /*@C
768:    MatGetOptionsPrefix - Sets the prefix used for searching for all
769:    Mat options in the database.

771:    Not Collective

773:    Input Parameter:
774: .  A - the Mat context

776:    Output Parameter:
777: .  prefix - pointer to the prefix string used

779:    Notes:
780:     On the fortran side, the user should pass in a string 'prefix' of
781:    sufficient length to hold the prefix.

783:    Level: advanced

785: .seealso: MatAppendOptionsPrefix()
786: @*/
787: PetscErrorCode MatGetOptionsPrefix(Mat A,const char *prefix[])
788: {

793:   PetscObjectGetOptionsPrefix((PetscObject)A,prefix);
794:   return(0);
795: }

797: /*@
798:    MatResetPreallocation - Reset mat to use the original nonzero pattern provided by users.

800:    Collective on Mat

802:    Input Parameters:
803: .  A - the Mat context

805:    Notes:
806:    The allocated memory will be shrunk after calling MatAssembly with MAT_FINAL_ASSEMBLY. Users can reset the preallocation to access the original memory.
807:    Currently support MPIAIJ and SEQAIJ.

809:    Level: beginner

811: .seealso: MatSeqAIJSetPreallocation(), MatMPIAIJSetPreallocation(), MatXAIJSetPreallocation()
812: @*/
813: PetscErrorCode MatResetPreallocation(Mat A)
814: {

820:   PetscUseMethod(A,"MatResetPreallocation_C",(Mat),(A));
821:   return(0);
822: }


825: /*@
826:    MatSetUp - Sets up the internal matrix data structures for the later use.

828:    Collective on Mat

830:    Input Parameters:
831: .  A - the Mat context

833:    Notes:
834:    If the user has not set preallocation for this matrix then a default preallocation that is likely to be inefficient is used.

836:    If a suitable preallocation routine is used, this function does not need to be called.

838:    See the Performance chapter of the PETSc users manual for how to preallocate matrices

840:    Level: beginner

842: .seealso: MatCreate(), MatDestroy()
843: @*/
844: PetscErrorCode MatSetUp(Mat A)
845: {
846:   PetscMPIInt    size;

851:   if (!((PetscObject)A)->type_name) {
852:     MPI_Comm_size(PetscObjectComm((PetscObject)A), &size);
853:     if (size == 1) {
854:       MatSetType(A, MATSEQAIJ);
855:     } else {
856:       MatSetType(A, MATMPIAIJ);
857:     }
858:   }
859:   if (!A->preallocated && A->ops->setup) {
860:     PetscInfo(A,"Warning not preallocating matrix storage\n");
861:     (*A->ops->setup)(A);
862:   }
863:   PetscLayoutSetUp(A->rmap);
864:   PetscLayoutSetUp(A->cmap);
865:   A->preallocated = PETSC_TRUE;
866:   return(0);
867: }

869: #if defined(PETSC_HAVE_SAWS)
870:  #include <petscviewersaws.h>
871: #endif
872: /*@C
873:    MatView - Visualizes a matrix object.

875:    Collective on Mat

877:    Input Parameters:
878: +  mat - the matrix
879: -  viewer - visualization context

881:   Notes:
882:   The available visualization contexts include
883: +    PETSC_VIEWER_STDOUT_SELF - for sequential matrices
884: .    PETSC_VIEWER_STDOUT_WORLD - for parallel matrices created on PETSC_COMM_WORLD
885: .    PETSC_VIEWER_STDOUT_(comm) - for matrices created on MPI communicator comm
886: -     PETSC_VIEWER_DRAW_WORLD - graphical display of nonzero structure

888:    The user can open alternative visualization contexts with
889: +    PetscViewerASCIIOpen() - Outputs matrix to a specified file
890: .    PetscViewerBinaryOpen() - Outputs matrix in binary to a
891:          specified file; corresponding input uses MatLoad()
892: .    PetscViewerDrawOpen() - Outputs nonzero matrix structure to
893:          an X window display
894: -    PetscViewerSocketOpen() - Outputs matrix to Socket viewer.
895:          Currently only the sequential dense and AIJ
896:          matrix types support the Socket viewer.

898:    The user can call PetscViewerPushFormat() to specify the output
899:    format of ASCII printed objects (when using PETSC_VIEWER_STDOUT_SELF,
900:    PETSC_VIEWER_STDOUT_WORLD and PetscViewerASCIIOpen).  Available formats include
901: +    PETSC_VIEWER_DEFAULT - default, prints matrix contents
902: .    PETSC_VIEWER_ASCII_MATLAB - prints matrix contents in Matlab format
903: .    PETSC_VIEWER_ASCII_DENSE - prints entire matrix including zeros
904: .    PETSC_VIEWER_ASCII_COMMON - prints matrix contents, using a sparse
905:          format common among all matrix types
906: .    PETSC_VIEWER_ASCII_IMPL - prints matrix contents, using an implementation-specific
907:          format (which is in many cases the same as the default)
908: .    PETSC_VIEWER_ASCII_INFO - prints basic information about the matrix
909:          size and structure (not the matrix entries)
910: -    PETSC_VIEWER_ASCII_INFO_DETAIL - prints more detailed information about
911:          the matrix structure

913:    Options Database Keys:
914: +  -mat_view ::ascii_info - Prints info on matrix at conclusion of MatAssemblyEnd()
915: .  -mat_view ::ascii_info_detail - Prints more detailed info
916: .  -mat_view - Prints matrix in ASCII format
917: .  -mat_view ::ascii_matlab - Prints matrix in Matlab format
918: .  -mat_view draw - PetscDraws nonzero structure of matrix, using MatView() and PetscDrawOpenX().
919: .  -display <name> - Sets display name (default is host)
920: .  -draw_pause <sec> - Sets number of seconds to pause after display
921: .  -mat_view socket - Sends matrix to socket, can be accessed from Matlab (see Users-Manual: Chapter 12 Using MATLAB with PETSc for details)
922: .  -viewer_socket_machine <machine> -
923: .  -viewer_socket_port <port> -
924: .  -mat_view binary - save matrix to file in binary format
925: -  -viewer_binary_filename <name> -
926:    Level: beginner

928:    Notes:
929:     The ASCII viewers are only recommended for small matrices on at most a moderate number of processes,
930:     the program will seemingly hang and take hours for larger matrices, for larger matrices one should use the binary format.

932:     See the manual page for MatLoad() for the exact format of the binary file when the binary
933:       viewer is used.

935:       See share/petsc/matlab/PetscBinaryRead.m for a Matlab code that can read in the binary file when the binary
936:       viewer is used.

938:       One can use '-mat_view draw -draw_pause -1' to pause the graphical display of matrix nonzero structure,
939:       and then use the following mouse functions.
940: + left mouse: zoom in
941: . middle mouse: zoom out
942: - right mouse: continue with the simulation

944: .seealso: PetscViewerPushFormat(), PetscViewerASCIIOpen(), PetscViewerDrawOpen(),
945:           PetscViewerSocketOpen(), PetscViewerBinaryOpen(), MatLoad()
946: @*/
947: PetscErrorCode MatView(Mat mat,PetscViewer viewer)
948: {
949:   PetscErrorCode    ierr;
950:   PetscInt          rows,cols,rbs,cbs;
951:   PetscBool         iascii,ibinary,isstring;
952:   PetscViewerFormat format;
953:   PetscMPIInt       size;
954: #if defined(PETSC_HAVE_SAWS)
955:   PetscBool         issaws;
956: #endif

961:   if (!viewer) {
962:     PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)mat),&viewer);
963:   }
966:   MatCheckPreallocated(mat,1);
967:   PetscViewerGetFormat(viewer,&format);
968:   MPI_Comm_size(PetscObjectComm((PetscObject)mat),&size);
969:   if (size == 1 && format == PETSC_VIEWER_LOAD_BALANCE) return(0);
970:   PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);
971:   PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);
972:   if (ibinary) {
973:     PetscBool mpiio;
974:     PetscViewerBinaryGetUseMPIIO(viewer,&mpiio);
975:     if (mpiio) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"PETSc matrix viewers do not support using MPI-IO, turn off that flag");
976:   }

978:   PetscLogEventBegin(MAT_View,mat,viewer,0,0);
979:   PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);
980:   if ((!iascii || (format != PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL)) && mat->factortype) {
981:     SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"No viewers for factored matrix except ASCII info or info_detailed");
982:   }

984: #if defined(PETSC_HAVE_SAWS)
985:   PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);
986: #endif
987:   if (iascii) {
988:     if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ORDER,"Must call MatAssemblyBegin/End() before viewing matrix");
989:     PetscObjectPrintClassNamePrefixType((PetscObject)mat,viewer);
990:     if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
991:       MatNullSpace nullsp,transnullsp;

993:       PetscViewerASCIIPushTab(viewer);
994:       MatGetSize(mat,&rows,&cols);
995:       MatGetBlockSizes(mat,&rbs,&cbs);
996:       if (rbs != 1 || cbs != 1) {
997:         if (rbs != cbs) {PetscViewerASCIIPrintf(viewer,"rows=%D, cols=%D, rbs=%D, cbs = %D\n",rows,cols,rbs,cbs);}
998:         else            {PetscViewerASCIIPrintf(viewer,"rows=%D, cols=%D, bs=%D\n",rows,cols,rbs);}
999:       } else {
1000:         PetscViewerASCIIPrintf(viewer,"rows=%D, cols=%D\n",rows,cols);
1001:       }
1002:       if (mat->factortype) {
1003:         MatSolverType solver;
1004:         MatFactorGetSolverType(mat,&solver);
1005:         PetscViewerASCIIPrintf(viewer,"package used to perform factorization: %s\n",solver);
1006:       }
1007:       if (mat->ops->getinfo) {
1008:         MatInfo info;
1009:         MatGetInfo(mat,MAT_GLOBAL_SUM,&info);
1010:         PetscViewerASCIIPrintf(viewer,"total: nonzeros=%.f, allocated nonzeros=%.f\n",info.nz_used,info.nz_allocated);
1011:         PetscViewerASCIIPrintf(viewer,"total number of mallocs used during MatSetValues calls =%D\n",(PetscInt)info.mallocs);
1012:       }
1013:       MatGetNullSpace(mat,&nullsp);
1014:       MatGetTransposeNullSpace(mat,&transnullsp);
1015:       if (nullsp) {PetscViewerASCIIPrintf(viewer,"  has attached null space\n");}
1016:       if (transnullsp && transnullsp != nullsp) {PetscViewerASCIIPrintf(viewer,"  has attached transposed null space\n");}
1017:       MatGetNearNullSpace(mat,&nullsp);
1018:       if (nullsp) {PetscViewerASCIIPrintf(viewer,"  has attached near null space\n");}
1019:     }
1020: #if defined(PETSC_HAVE_SAWS)
1021:   } else if (issaws) {
1022:     PetscMPIInt rank;

1024:     PetscObjectName((PetscObject)mat);
1025:     MPI_Comm_rank(PETSC_COMM_WORLD,&rank);
1026:     if (!((PetscObject)mat)->amsmem && !rank) {
1027:       PetscObjectViewSAWs((PetscObject)mat,viewer);
1028:     }
1029: #endif
1030:   } else if (isstring) {
1031:     const char *type;
1032:     MatGetType(mat,&type);
1033:     PetscViewerStringSPrintf(viewer," MatType: %-7.7s",type);
1034:     if (mat->ops->view) {(*mat->ops->view)(mat,viewer);}
1035:   }
1036:   if ((format == PETSC_VIEWER_NATIVE || format == PETSC_VIEWER_LOAD_BALANCE) && mat->ops->viewnative) {
1037:     PetscViewerASCIIPushTab(viewer);
1038:     (*mat->ops->viewnative)(mat,viewer);
1039:     PetscViewerASCIIPopTab(viewer);
1040:   } else if (mat->ops->view) {
1041:     PetscViewerASCIIPushTab(viewer);
1042:     (*mat->ops->view)(mat,viewer);
1043:     PetscViewerASCIIPopTab(viewer);
1044:   }
1045:   if (iascii) {
1046:     PetscViewerGetFormat(viewer,&format);
1047:     if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
1048:       PetscViewerASCIIPopTab(viewer);
1049:     }
1050:   }
1051:   PetscLogEventEnd(MAT_View,mat,viewer,0,0);
1052:   return(0);
1053: }

1055: #if defined(PETSC_USE_DEBUG)
1056: #include <../src/sys/totalview/tv_data_display.h>
1057: PETSC_UNUSED static int TV_display_type(const struct _p_Mat *mat)
1058: {
1059:   TV_add_row("Local rows", "int", &mat->rmap->n);
1060:   TV_add_row("Local columns", "int", &mat->cmap->n);
1061:   TV_add_row("Global rows", "int", &mat->rmap->N);
1062:   TV_add_row("Global columns", "int", &mat->cmap->N);
1063:   TV_add_row("Typename", TV_ascii_string_type, ((PetscObject)mat)->type_name);
1064:   return TV_format_OK;
1065: }
1066: #endif

1068: /*@C
1069:    MatLoad - Loads a matrix that has been stored in binary/HDF5 format
1070:    with MatView().  The matrix format is determined from the options database.
1071:    Generates a parallel MPI matrix if the communicator has more than one
1072:    processor.  The default matrix type is AIJ.

1074:    Collective on PetscViewer

1076:    Input Parameters:
1077: +  newmat - the newly loaded matrix, this needs to have been created with MatCreate()
1078:             or some related function before a call to MatLoad()
1079: -  viewer - binary/HDF5 file viewer

1081:    Options Database Keys:
1082:    Used with block matrix formats (MATSEQBAIJ,  ...) to specify
1083:    block size
1084: .    -matload_block_size <bs>

1086:    Level: beginner

1088:    Notes:
1089:    If the Mat type has not yet been given then MATAIJ is used, call MatSetFromOptions() on the
1090:    Mat before calling this routine if you wish to set it from the options database.

1092:    MatLoad() automatically loads into the options database any options
1093:    given in the file filename.info where filename is the name of the file
1094:    that was passed to the PetscViewerBinaryOpen(). The options in the info
1095:    file will be ignored if you use the -viewer_binary_skip_info option.

1097:    If the type or size of newmat is not set before a call to MatLoad, PETSc
1098:    sets the default matrix type AIJ and sets the local and global sizes.
1099:    If type and/or size is already set, then the same are used.

1101:    In parallel, each processor can load a subset of rows (or the
1102:    entire matrix).  This routine is especially useful when a large
1103:    matrix is stored on disk and only part of it is desired on each
1104:    processor.  For example, a parallel solver may access only some of
1105:    the rows from each processor.  The algorithm used here reads
1106:    relatively small blocks of data rather than reading the entire
1107:    matrix and then subsetting it.

1109:    Viewer's PetscViewerType must be either PETSCVIEWERBINARY or PETSCVIEWERHDF5.
1110:    Such viewer can be created using PetscViewerBinaryOpen()/PetscViewerHDF5Open(),
1111:    or the sequence like
1112: $    PetscViewer v;
1113: $    PetscViewerCreate(PETSC_COMM_WORLD,&v);
1114: $    PetscViewerSetType(v,PETSCVIEWERBINARY);
1115: $    PetscViewerSetFromOptions(v);
1116: $    PetscViewerFileSetMode(v,FILE_MODE_READ);
1117: $    PetscViewerFileSetName(v,"datafile");
1118:    The optional PetscViewerSetFromOptions() call allows to override PetscViewerSetType() using option
1119: $ -viewer_type {binary,hdf5}

1121:    See the example src/ksp/ksp/examples/tutorials/ex27.c with the first approach,
1122:    and src/mat/examples/tutorials/ex10.c with the second approach.

1124:    Notes about the PETSc binary format:
1125:    In case of PETSCVIEWERBINARY, a native PETSc binary format is used. Each of the blocks
1126:    is read onto rank 0 and then shipped to its destination rank, one after another.
1127:    Multiple objects, both matrices and vectors, can be stored within the same file.
1128:    Their PetscObject name is ignored; they are loaded in the order of their storage.

1130:    Most users should not need to know the details of the binary storage
1131:    format, since MatLoad() and MatView() completely hide these details.
1132:    But for anyone who's interested, the standard binary matrix storage
1133:    format is

1135: $    PetscInt    MAT_FILE_CLASSID
1136: $    PetscInt    number of rows
1137: $    PetscInt    number of columns
1138: $    PetscInt    total number of nonzeros
1139: $    PetscInt    *number nonzeros in each row
1140: $    PetscInt    *column indices of all nonzeros (starting index is zero)
1141: $    PetscScalar *values of all nonzeros

1143:    PETSc automatically does the byte swapping for
1144: machines that store the bytes reversed, e.g.  DEC alpha, freebsd,
1145: linux, Windows and the paragon; thus if you write your own binary
1146: read/write routines you have to swap the bytes; see PetscBinaryRead()
1147: and PetscBinaryWrite() to see how this may be done.

1149:    Notes about the HDF5 (MATLAB MAT-File Version 7.3) format:
1150:    In case of PETSCVIEWERHDF5, a parallel HDF5 reader is used.
1151:    Each processor's chunk is loaded independently by its owning rank.
1152:    Multiple objects, both matrices and vectors, can be stored within the same file.
1153:    They are looked up by their PetscObject name.

1155:    As the MATLAB MAT-File Version 7.3 format is also a HDF5 flavor, we decided to use
1156:    by default the same structure and naming of the AIJ arrays and column count
1157:    within the HDF5 file. This means that a MAT file saved with -v7.3 flag, e.g.
1158: $    save example.mat A b -v7.3
1159:    can be directly read by this routine (see Reference 1 for details).
1160:    Note that depending on your MATLAB version, this format might be a default,
1161:    otherwise you can set it as default in Preferences.

1163:    Unless -nocompression flag is used to save the file in MATLAB,
1164:    PETSc must be configured with ZLIB package.

1166:    See also examples src/mat/examples/tutorials/ex10.c and src/ksp/ksp/examples/tutorials/ex27.c

1168:    Current HDF5 (MAT-File) limitations:
1169:    This reader currently supports only real MATSEQAIJ, MATMPIAIJ, MATSEQDENSE and MATMPIDENSE matrices.

1171:    Corresponding MatView() is not yet implemented.

1173:    The loaded matrix is actually a transpose of the original one in MATLAB,
1174:    unless you push PETSC_VIEWER_HDF5_MAT format (see examples above).
1175:    With this format, matrix is automatically transposed by PETSc,
1176:    unless the matrix is marked as SPD or symmetric
1177:    (see MatSetOption(), MAT_SPD, MAT_SYMMETRIC).

1179:    References:
1180: 1. MATLAB(R) Documentation, manual page of save(), https://www.mathworks.com/help/matlab/ref/save.html#btox10b-1-version

1182: .seealso: PetscViewerBinaryOpen(), PetscViewerSetType(), MatView(), VecLoad()

1184:  @*/
1185: PetscErrorCode MatLoad(Mat newmat,PetscViewer viewer)
1186: {
1188:   PetscBool      flg;


1194:   if (!((PetscObject)newmat)->type_name) {
1195:     MatSetType(newmat,MATAIJ);
1196:   }

1198:   flg  = PETSC_FALSE;
1199:   PetscOptionsGetBool(((PetscObject)newmat)->options,((PetscObject)newmat)->prefix,"-matload_symmetric",&flg,NULL);
1200:   if (flg) {
1201:     MatSetOption(newmat,MAT_SYMMETRIC,PETSC_TRUE);
1202:     MatSetOption(newmat,MAT_SYMMETRY_ETERNAL,PETSC_TRUE);
1203:   }
1204:   flg  = PETSC_FALSE;
1205:   PetscOptionsGetBool(((PetscObject)newmat)->options,((PetscObject)newmat)->prefix,"-matload_spd",&flg,NULL);
1206:   if (flg) {
1207:     MatSetOption(newmat,MAT_SPD,PETSC_TRUE);
1208:   }

1210:   if (!newmat->ops->load) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"MatLoad is not supported for type");
1211:   PetscLogEventBegin(MAT_Load,viewer,0,0,0);
1212:   (*newmat->ops->load)(newmat,viewer);
1213:   PetscLogEventEnd(MAT_Load,viewer,0,0,0);
1214:   return(0);
1215: }

1217: PetscErrorCode MatDestroy_Redundant(Mat_Redundant **redundant)
1218: {
1220:   Mat_Redundant  *redund = *redundant;
1221:   PetscInt       i;

1224:   if (redund){
1225:     if (redund->matseq) { /* via MatCreateSubMatrices()  */
1226:       ISDestroy(&redund->isrow);
1227:       ISDestroy(&redund->iscol);
1228:       MatDestroySubMatrices(1,&redund->matseq);
1229:     } else {
1230:       PetscFree2(redund->send_rank,redund->recv_rank);
1231:       PetscFree(redund->sbuf_j);
1232:       PetscFree(redund->sbuf_a);
1233:       for (i=0; i<redund->nrecvs; i++) {
1234:         PetscFree(redund->rbuf_j[i]);
1235:         PetscFree(redund->rbuf_a[i]);
1236:       }
1237:       PetscFree4(redund->sbuf_nz,redund->rbuf_nz,redund->rbuf_j,redund->rbuf_a);
1238:     }

1240:     if (redund->subcomm) {
1241:       PetscCommDestroy(&redund->subcomm);
1242:     }
1243:     PetscFree(redund);
1244:   }
1245:   return(0);
1246: }

1248: /*@
1249:    MatDestroy - Frees space taken by a matrix.

1251:    Collective on Mat

1253:    Input Parameter:
1254: .  A - the matrix

1256:    Level: beginner

1258: @*/
1259: PetscErrorCode MatDestroy(Mat *A)
1260: {

1264:   if (!*A) return(0);
1266:   if (--((PetscObject)(*A))->refct > 0) {*A = NULL; return(0);}

1268:   /* if memory was published with SAWs then destroy it */
1269:   PetscObjectSAWsViewOff((PetscObject)*A);
1270:   if ((*A)->ops->destroy) {
1271:     (*(*A)->ops->destroy)(*A);
1272:   }

1274:   PetscFree((*A)->defaultvectype);
1275:   PetscFree((*A)->bsizes);
1276:   PetscFree((*A)->solvertype);
1277:   MatDestroy_Redundant(&(*A)->redundant);
1278:   MatNullSpaceDestroy(&(*A)->nullsp);
1279:   MatNullSpaceDestroy(&(*A)->transnullsp);
1280:   MatNullSpaceDestroy(&(*A)->nearnullsp);
1281:   MatDestroy(&(*A)->schur);
1282:   PetscLayoutDestroy(&(*A)->rmap);
1283:   PetscLayoutDestroy(&(*A)->cmap);
1284:   PetscHeaderDestroy(A);
1285:   return(0);
1286: }

1288: /*@C
1289:    MatSetValues - Inserts or adds a block of values into a matrix.
1290:    These values may be cached, so MatAssemblyBegin() and MatAssemblyEnd()
1291:    MUST be called after all calls to MatSetValues() have been completed.

1293:    Not Collective

1295:    Input Parameters:
1296: +  mat - the matrix
1297: .  v - a logically two-dimensional array of values
1298: .  m, idxm - the number of rows and their global indices
1299: .  n, idxn - the number of columns and their global indices
1300: -  addv - either ADD_VALUES or INSERT_VALUES, where
1301:    ADD_VALUES adds values to any existing entries, and
1302:    INSERT_VALUES replaces existing entries with new values

1304:    Notes:
1305:    If you create the matrix yourself (that is not with a call to DMCreateMatrix()) then you MUST call MatXXXXSetPreallocation() or
1306:       MatSetUp() before using this routine

1308:    By default the values, v, are row-oriented. See MatSetOption() for other options.

1310:    Calls to MatSetValues() with the INSERT_VALUES and ADD_VALUES
1311:    options cannot be mixed without intervening calls to the assembly
1312:    routines.

1314:    MatSetValues() uses 0-based row and column numbers in Fortran
1315:    as well as in C.

1317:    Negative indices may be passed in idxm and idxn, these rows and columns are
1318:    simply ignored. This allows easily inserting element stiffness matrices
1319:    with homogeneous Dirchlet boundary conditions that you don't want represented
1320:    in the matrix.

1322:    Efficiency Alert:
1323:    The routine MatSetValuesBlocked() may offer much better efficiency
1324:    for users of block sparse formats (MATSEQBAIJ and MATMPIBAIJ).

1326:    Level: beginner

1328:    Developer Notes:
1329:     This is labeled with C so does not automatically generate Fortran stubs and interfaces
1330:                     because it requires multiple Fortran interfaces depending on which arguments are scalar or arrays.

1332: .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
1333:           InsertMode, INSERT_VALUES, ADD_VALUES
1334: @*/
1335: PetscErrorCode MatSetValues(Mat mat,PetscInt m,const PetscInt idxm[],PetscInt n,const PetscInt idxn[],const PetscScalar v[],InsertMode addv)
1336: {
1338: #if defined(PETSC_USE_DEBUG)
1339:   PetscInt       i,j;
1340: #endif

1345:   if (!m || !n) return(0); /* no values to insert */
1348:   MatCheckPreallocated(mat,1);

1350:   if (mat->insertmode == NOT_SET_VALUES) {
1351:     mat->insertmode = addv;
1352:   }
1353: #if defined(PETSC_USE_DEBUG)
1354:   else if (mat->insertmode != addv) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
1355:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1356:   if (!mat->ops->setvalues) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);

1358:   for (i=0; i<m; i++) {
1359:     for (j=0; j<n; j++) {
1360:       if (mat->erroriffailure && PetscIsInfOrNanScalar(v[i*n+j]))
1361: #if defined(PETSC_USE_COMPLEX)
1362:         SETERRQ4(PETSC_COMM_SELF,PETSC_ERR_FP,"Inserting %g+ig at matrix entry (%D,%D)",(double)PetscRealPart(v[i*n+j]),(double)PetscImaginaryPart(v[i*n+j]),idxm[i],idxn[j]);
1363: #else
1364:         SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_FP,"Inserting %g at matrix entry (%D,%D)",(double)v[i*n+j],idxm[i],idxn[j]);
1365: #endif
1366:     }
1367:   }
1368: #endif

1370:   if (mat->assembled) {
1371:     mat->was_assembled = PETSC_TRUE;
1372:     mat->assembled     = PETSC_FALSE;
1373:   }
1374:   PetscLogEventBegin(MAT_SetValues,mat,0,0,0);
1375:   (*mat->ops->setvalues)(mat,m,idxm,n,idxn,v,addv);
1376:   PetscLogEventEnd(MAT_SetValues,mat,0,0,0);
1377:   return(0);
1378: }


1381: /*@
1382:    MatSetValuesRowLocal - Inserts a row (block row for BAIJ matrices) of nonzero
1383:         values into a matrix

1385:    Not Collective

1387:    Input Parameters:
1388: +  mat - the matrix
1389: .  row - the (block) row to set
1390: -  v - a logically two-dimensional array of values

1392:    Notes:
1393:    By the values, v, are column-oriented (for the block version) and sorted

1395:    All the nonzeros in the row must be provided

1397:    The matrix must have previously had its column indices set

1399:    The row must belong to this process

1401:    Level: intermediate

1403: .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
1404:           InsertMode, INSERT_VALUES, ADD_VALUES, MatSetValues(), MatSetValuesRow(), MatSetLocalToGlobalMapping()
1405: @*/
1406: PetscErrorCode MatSetValuesRowLocal(Mat mat,PetscInt row,const PetscScalar v[])
1407: {
1409:   PetscInt       globalrow;

1415:   ISLocalToGlobalMappingApply(mat->rmap->mapping,1,&row,&globalrow);
1416:   MatSetValuesRow(mat,globalrow,v);
1417:   return(0);
1418: }

1420: /*@
1421:    MatSetValuesRow - Inserts a row (block row for BAIJ matrices) of nonzero
1422:         values into a matrix

1424:    Not Collective

1426:    Input Parameters:
1427: +  mat - the matrix
1428: .  row - the (block) row to set
1429: -  v - a logically two-dimensional (column major) array of values for  block matrices with blocksize larger than one, otherwise a one dimensional array of values

1431:    Notes:
1432:    The values, v, are column-oriented for the block version.

1434:    All the nonzeros in the row must be provided

1436:    THE MATRIX MUST HAVE PREVIOUSLY HAD ITS COLUMN INDICES SET. IT IS RARE THAT THIS ROUTINE IS USED, usually MatSetValues() is used.

1438:    The row must belong to this process

1440:    Level: advanced

1442: .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
1443:           InsertMode, INSERT_VALUES, ADD_VALUES, MatSetValues()
1444: @*/
1445: PetscErrorCode MatSetValuesRow(Mat mat,PetscInt row,const PetscScalar v[])
1446: {

1452:   MatCheckPreallocated(mat,1);
1454: #if defined(PETSC_USE_DEBUG)
1455:   if (mat->insertmode == ADD_VALUES) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add and insert values");
1456:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1457: #endif
1458:   mat->insertmode = INSERT_VALUES;

1460:   if (mat->assembled) {
1461:     mat->was_assembled = PETSC_TRUE;
1462:     mat->assembled     = PETSC_FALSE;
1463:   }
1464:   PetscLogEventBegin(MAT_SetValues,mat,0,0,0);
1465:   if (!mat->ops->setvaluesrow) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
1466:   (*mat->ops->setvaluesrow)(mat,row,v);
1467:   PetscLogEventEnd(MAT_SetValues,mat,0,0,0);
1468:   return(0);
1469: }

1471: /*@
1472:    MatSetValuesStencil - Inserts or adds a block of values into a matrix.
1473:      Using structured grid indexing

1475:    Not Collective

1477:    Input Parameters:
1478: +  mat - the matrix
1479: .  m - number of rows being entered
1480: .  idxm - grid coordinates (and component number when dof > 1) for matrix rows being entered
1481: .  n - number of columns being entered
1482: .  idxn - grid coordinates (and component number when dof > 1) for matrix columns being entered
1483: .  v - a logically two-dimensional array of values
1484: -  addv - either ADD_VALUES or INSERT_VALUES, where
1485:    ADD_VALUES adds values to any existing entries, and
1486:    INSERT_VALUES replaces existing entries with new values

1488:    Notes:
1489:    By default the values, v, are row-oriented.  See MatSetOption() for other options.

1491:    Calls to MatSetValuesStencil() with the INSERT_VALUES and ADD_VALUES
1492:    options cannot be mixed without intervening calls to the assembly
1493:    routines.

1495:    The grid coordinates are across the entire grid, not just the local portion

1497:    MatSetValuesStencil() uses 0-based row and column numbers in Fortran
1498:    as well as in C.

1500:    For setting/accessing vector values via array coordinates you can use the DMDAVecGetArray() routine

1502:    In order to use this routine you must either obtain the matrix with DMCreateMatrix()
1503:    or call MatSetLocalToGlobalMapping() and MatSetStencil() first.

1505:    The columns and rows in the stencil passed in MUST be contained within the
1506:    ghost region of the given process as set with DMDACreateXXX() or MatSetStencil(). For example,
1507:    if you create a DMDA with an overlap of one grid level and on a particular process its first
1508:    local nonghost x logical coordinate is 6 (so its first ghost x logical coordinate is 5) the
1509:    first i index you can use in your column and row indices in MatSetStencil() is 5.

1511:    In Fortran idxm and idxn should be declared as
1512: $     MatStencil idxm(4,m),idxn(4,n)
1513:    and the values inserted using
1514: $    idxm(MatStencil_i,1) = i
1515: $    idxm(MatStencil_j,1) = j
1516: $    idxm(MatStencil_k,1) = k
1517: $    idxm(MatStencil_c,1) = c
1518:    etc

1520:    For periodic boundary conditions use negative indices for values to the left (below 0; that are to be
1521:    obtained by wrapping values from right edge). For values to the right of the last entry using that index plus one
1522:    etc to obtain values that obtained by wrapping the values from the left edge. This does not work for anything but the
1523:    DM_BOUNDARY_PERIODIC boundary type.

1525:    For indices that don't mean anything for your case (like the k index when working in 2d) or the c index when you have
1526:    a single value per point) you can skip filling those indices.

1528:    Inspired by the structured grid interface to the HYPRE package
1529:    (https://computation.llnl.gov/projects/hypre-scalable-linear-solvers-multigrid-methods)

1531:    Efficiency Alert:
1532:    The routine MatSetValuesBlockedStencil() may offer much better efficiency
1533:    for users of block sparse formats (MATSEQBAIJ and MATMPIBAIJ).

1535:    Level: beginner

1537: .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal()
1538:           MatSetValues(), MatSetValuesBlockedStencil(), MatSetStencil(), DMCreateMatrix(), DMDAVecGetArray(), MatStencil
1539: @*/
1540: PetscErrorCode MatSetValuesStencil(Mat mat,PetscInt m,const MatStencil idxm[],PetscInt n,const MatStencil idxn[],const PetscScalar v[],InsertMode addv)
1541: {
1543:   PetscInt       buf[8192],*bufm=0,*bufn=0,*jdxm,*jdxn;
1544:   PetscInt       j,i,dim = mat->stencil.dim,*dims = mat->stencil.dims+1,tmp;
1545:   PetscInt       *starts = mat->stencil.starts,*dxm = (PetscInt*)idxm,*dxn = (PetscInt*)idxn,sdim = dim - (1 - (PetscInt)mat->stencil.noc);

1548:   if (!m || !n) return(0); /* no values to insert */

1554:   if ((m+n) <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
1555:     jdxm = buf; jdxn = buf+m;
1556:   } else {
1557:     PetscMalloc2(m,&bufm,n,&bufn);
1558:     jdxm = bufm; jdxn = bufn;
1559:   }
1560:   for (i=0; i<m; i++) {
1561:     for (j=0; j<3-sdim; j++) dxm++;
1562:     tmp = *dxm++ - starts[0];
1563:     for (j=0; j<dim-1; j++) {
1564:       if ((*dxm++ - starts[j+1]) < 0 || tmp < 0) tmp = -1;
1565:       else                                       tmp = tmp*dims[j] + *(dxm-1) - starts[j+1];
1566:     }
1567:     if (mat->stencil.noc) dxm++;
1568:     jdxm[i] = tmp;
1569:   }
1570:   for (i=0; i<n; i++) {
1571:     for (j=0; j<3-sdim; j++) dxn++;
1572:     tmp = *dxn++ - starts[0];
1573:     for (j=0; j<dim-1; j++) {
1574:       if ((*dxn++ - starts[j+1]) < 0 || tmp < 0) tmp = -1;
1575:       else                                       tmp = tmp*dims[j] + *(dxn-1) - starts[j+1];
1576:     }
1577:     if (mat->stencil.noc) dxn++;
1578:     jdxn[i] = tmp;
1579:   }
1580:   MatSetValuesLocal(mat,m,jdxm,n,jdxn,v,addv);
1581:   PetscFree2(bufm,bufn);
1582:   return(0);
1583: }

1585: /*@
1586:    MatSetValuesBlockedStencil - Inserts or adds a block of values into a matrix.
1587:      Using structured grid indexing

1589:    Not Collective

1591:    Input Parameters:
1592: +  mat - the matrix
1593: .  m - number of rows being entered
1594: .  idxm - grid coordinates for matrix rows being entered
1595: .  n - number of columns being entered
1596: .  idxn - grid coordinates for matrix columns being entered
1597: .  v - a logically two-dimensional array of values
1598: -  addv - either ADD_VALUES or INSERT_VALUES, where
1599:    ADD_VALUES adds values to any existing entries, and
1600:    INSERT_VALUES replaces existing entries with new values

1602:    Notes:
1603:    By default the values, v, are row-oriented and unsorted.
1604:    See MatSetOption() for other options.

1606:    Calls to MatSetValuesBlockedStencil() with the INSERT_VALUES and ADD_VALUES
1607:    options cannot be mixed without intervening calls to the assembly
1608:    routines.

1610:    The grid coordinates are across the entire grid, not just the local portion

1612:    MatSetValuesBlockedStencil() uses 0-based row and column numbers in Fortran
1613:    as well as in C.

1615:    For setting/accessing vector values via array coordinates you can use the DMDAVecGetArray() routine

1617:    In order to use this routine you must either obtain the matrix with DMCreateMatrix()
1618:    or call MatSetBlockSize(), MatSetLocalToGlobalMapping() and MatSetStencil() first.

1620:    The columns and rows in the stencil passed in MUST be contained within the
1621:    ghost region of the given process as set with DMDACreateXXX() or MatSetStencil(). For example,
1622:    if you create a DMDA with an overlap of one grid level and on a particular process its first
1623:    local nonghost x logical coordinate is 6 (so its first ghost x logical coordinate is 5) the
1624:    first i index you can use in your column and row indices in MatSetStencil() is 5.

1626:    In Fortran idxm and idxn should be declared as
1627: $     MatStencil idxm(4,m),idxn(4,n)
1628:    and the values inserted using
1629: $    idxm(MatStencil_i,1) = i
1630: $    idxm(MatStencil_j,1) = j
1631: $    idxm(MatStencil_k,1) = k
1632:    etc

1634:    Negative indices may be passed in idxm and idxn, these rows and columns are
1635:    simply ignored. This allows easily inserting element stiffness matrices
1636:    with homogeneous Dirchlet boundary conditions that you don't want represented
1637:    in the matrix.

1639:    Inspired by the structured grid interface to the HYPRE package
1640:    (https://computation.llnl.gov/projects/hypre-scalable-linear-solvers-multigrid-methods)

1642:    Level: beginner

1644: .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal()
1645:           MatSetValues(), MatSetValuesStencil(), MatSetStencil(), DMCreateMatrix(), DMDAVecGetArray(), MatStencil,
1646:           MatSetBlockSize(), MatSetLocalToGlobalMapping()
1647: @*/
1648: PetscErrorCode MatSetValuesBlockedStencil(Mat mat,PetscInt m,const MatStencil idxm[],PetscInt n,const MatStencil idxn[],const PetscScalar v[],InsertMode addv)
1649: {
1651:   PetscInt       buf[8192],*bufm=0,*bufn=0,*jdxm,*jdxn;
1652:   PetscInt       j,i,dim = mat->stencil.dim,*dims = mat->stencil.dims+1,tmp;
1653:   PetscInt       *starts = mat->stencil.starts,*dxm = (PetscInt*)idxm,*dxn = (PetscInt*)idxn,sdim = dim - (1 - (PetscInt)mat->stencil.noc);

1656:   if (!m || !n) return(0); /* no values to insert */

1663:   if ((m+n) <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
1664:     jdxm = buf; jdxn = buf+m;
1665:   } else {
1666:     PetscMalloc2(m,&bufm,n,&bufn);
1667:     jdxm = bufm; jdxn = bufn;
1668:   }
1669:   for (i=0; i<m; i++) {
1670:     for (j=0; j<3-sdim; j++) dxm++;
1671:     tmp = *dxm++ - starts[0];
1672:     for (j=0; j<sdim-1; j++) {
1673:       if ((*dxm++ - starts[j+1]) < 0 || tmp < 0) tmp = -1;
1674:       else                                       tmp = tmp*dims[j] + *(dxm-1) - starts[j+1];
1675:     }
1676:     dxm++;
1677:     jdxm[i] = tmp;
1678:   }
1679:   for (i=0; i<n; i++) {
1680:     for (j=0; j<3-sdim; j++) dxn++;
1681:     tmp = *dxn++ - starts[0];
1682:     for (j=0; j<sdim-1; j++) {
1683:       if ((*dxn++ - starts[j+1]) < 0 || tmp < 0) tmp = -1;
1684:       else                                       tmp = tmp*dims[j] + *(dxn-1) - starts[j+1];
1685:     }
1686:     dxn++;
1687:     jdxn[i] = tmp;
1688:   }
1689:   MatSetValuesBlockedLocal(mat,m,jdxm,n,jdxn,v,addv);
1690:   PetscFree2(bufm,bufn);
1691:   return(0);
1692: }

1694: /*@
1695:    MatSetStencil - Sets the grid information for setting values into a matrix via
1696:         MatSetValuesStencil()

1698:    Not Collective

1700:    Input Parameters:
1701: +  mat - the matrix
1702: .  dim - dimension of the grid 1, 2, or 3
1703: .  dims - number of grid points in x, y, and z direction, including ghost points on your processor
1704: .  starts - starting point of ghost nodes on your processor in x, y, and z direction
1705: -  dof - number of degrees of freedom per node


1708:    Inspired by the structured grid interface to the HYPRE package
1709:    (www.llnl.gov/CASC/hyper)

1711:    For matrices generated with DMCreateMatrix() this routine is automatically called and so not needed by the
1712:    user.

1714:    Level: beginner

1716: .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal()
1717:           MatSetValues(), MatSetValuesBlockedStencil(), MatSetValuesStencil()
1718: @*/
1719: PetscErrorCode MatSetStencil(Mat mat,PetscInt dim,const PetscInt dims[],const PetscInt starts[],PetscInt dof)
1720: {
1721:   PetscInt i;


1728:   mat->stencil.dim = dim + (dof > 1);
1729:   for (i=0; i<dim; i++) {
1730:     mat->stencil.dims[i]   = dims[dim-i-1];      /* copy the values in backwards */
1731:     mat->stencil.starts[i] = starts[dim-i-1];
1732:   }
1733:   mat->stencil.dims[dim]   = dof;
1734:   mat->stencil.starts[dim] = 0;
1735:   mat->stencil.noc         = (PetscBool)(dof == 1);
1736:   return(0);
1737: }

1739: /*@C
1740:    MatSetValuesBlocked - Inserts or adds a block of values into a matrix.

1742:    Not Collective

1744:    Input Parameters:
1745: +  mat - the matrix
1746: .  v - a logically two-dimensional array of values
1747: .  m, idxm - the number of block rows and their global block indices
1748: .  n, idxn - the number of block columns and their global block indices
1749: -  addv - either ADD_VALUES or INSERT_VALUES, where
1750:    ADD_VALUES adds values to any existing entries, and
1751:    INSERT_VALUES replaces existing entries with new values

1753:    Notes:
1754:    If you create the matrix yourself (that is not with a call to DMCreateMatrix()) then you MUST call
1755:    MatXXXXSetPreallocation() or MatSetUp() before using this routine.

1757:    The m and n count the NUMBER of blocks in the row direction and column direction,
1758:    NOT the total number of rows/columns; for example, if the block size is 2 and
1759:    you are passing in values for rows 2,3,4,5  then m would be 2 (not 4).
1760:    The values in idxm would be 1 2; that is the first index for each block divided by
1761:    the block size.

1763:    Note that you must call MatSetBlockSize() when constructing this matrix (before
1764:    preallocating it).

1766:    By default the values, v, are row-oriented, so the layout of
1767:    v is the same as for MatSetValues(). See MatSetOption() for other options.

1769:    Calls to MatSetValuesBlocked() with the INSERT_VALUES and ADD_VALUES
1770:    options cannot be mixed without intervening calls to the assembly
1771:    routines.

1773:    MatSetValuesBlocked() uses 0-based row and column numbers in Fortran
1774:    as well as in C.

1776:    Negative indices may be passed in idxm and idxn, these rows and columns are
1777:    simply ignored. This allows easily inserting element stiffness matrices
1778:    with homogeneous Dirchlet boundary conditions that you don't want represented
1779:    in the matrix.

1781:    Each time an entry is set within a sparse matrix via MatSetValues(),
1782:    internal searching must be done to determine where to place the
1783:    data in the matrix storage space.  By instead inserting blocks of
1784:    entries via MatSetValuesBlocked(), the overhead of matrix assembly is
1785:    reduced.

1787:    Example:
1788: $   Suppose m=n=2 and block size(bs) = 2 The array is
1789: $
1790: $   1  2  | 3  4
1791: $   5  6  | 7  8
1792: $   - - - | - - -
1793: $   9  10 | 11 12
1794: $   13 14 | 15 16
1795: $
1796: $   v[] should be passed in like
1797: $   v[] = [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16]
1798: $
1799: $  If you are not using row oriented storage of v (that is you called MatSetOption(mat,MAT_ROW_ORIENTED,PETSC_FALSE)) then
1800: $   v[] = [1,5,9,13,2,6,10,14,3,7,11,15,4,8,12,16]

1802:    Level: intermediate

1804: .seealso: MatSetBlockSize(), MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValues(), MatSetValuesBlockedLocal()
1805: @*/
1806: PetscErrorCode MatSetValuesBlocked(Mat mat,PetscInt m,const PetscInt idxm[],PetscInt n,const PetscInt idxn[],const PetscScalar v[],InsertMode addv)
1807: {

1813:   if (!m || !n) return(0); /* no values to insert */
1817:   MatCheckPreallocated(mat,1);
1818:   if (mat->insertmode == NOT_SET_VALUES) {
1819:     mat->insertmode = addv;
1820:   }
1821: #if defined(PETSC_USE_DEBUG)
1822:   else if (mat->insertmode != addv) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
1823:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1824:   if (!mat->ops->setvaluesblocked && !mat->ops->setvalues) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
1825: #endif

1827:   if (mat->assembled) {
1828:     mat->was_assembled = PETSC_TRUE;
1829:     mat->assembled     = PETSC_FALSE;
1830:   }
1831:   PetscLogEventBegin(MAT_SetValues,mat,0,0,0);
1832:   if (mat->ops->setvaluesblocked) {
1833:     (*mat->ops->setvaluesblocked)(mat,m,idxm,n,idxn,v,addv);
1834:   } else {
1835:     PetscInt buf[8192],*bufr=0,*bufc=0,*iidxm,*iidxn;
1836:     PetscInt i,j,bs,cbs;
1837:     MatGetBlockSizes(mat,&bs,&cbs);
1838:     if (m*bs+n*cbs <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
1839:       iidxm = buf; iidxn = buf + m*bs;
1840:     } else {
1841:       PetscMalloc2(m*bs,&bufr,n*cbs,&bufc);
1842:       iidxm = bufr; iidxn = bufc;
1843:     }
1844:     for (i=0; i<m; i++) {
1845:       for (j=0; j<bs; j++) {
1846:         iidxm[i*bs+j] = bs*idxm[i] + j;
1847:       }
1848:     }
1849:     for (i=0; i<n; i++) {
1850:       for (j=0; j<cbs; j++) {
1851:         iidxn[i*cbs+j] = cbs*idxn[i] + j;
1852:       }
1853:     }
1854:     MatSetValues(mat,m*bs,iidxm,n*cbs,iidxn,v,addv);
1855:     PetscFree2(bufr,bufc);
1856:   }
1857:   PetscLogEventEnd(MAT_SetValues,mat,0,0,0);
1858:   return(0);
1859: }

1861: /*@
1862:    MatGetValues - Gets a block of values from a matrix.

1864:    Not Collective; currently only returns a local block

1866:    Input Parameters:
1867: +  mat - the matrix
1868: .  v - a logically two-dimensional array for storing the values
1869: .  m, idxm - the number of rows and their global indices
1870: -  n, idxn - the number of columns and their global indices

1872:    Notes:
1873:    The user must allocate space (m*n PetscScalars) for the values, v.
1874:    The values, v, are then returned in a row-oriented format,
1875:    analogous to that used by default in MatSetValues().

1877:    MatGetValues() uses 0-based row and column numbers in
1878:    Fortran as well as in C.

1880:    MatGetValues() requires that the matrix has been assembled
1881:    with MatAssemblyBegin()/MatAssemblyEnd().  Thus, calls to
1882:    MatSetValues() and MatGetValues() CANNOT be made in succession
1883:    without intermediate matrix assembly.

1885:    Negative row or column indices will be ignored and those locations in v[] will be
1886:    left unchanged.

1888:    Level: advanced

1890: .seealso: MatGetRow(), MatCreateSubMatrices(), MatSetValues()
1891: @*/
1892: PetscErrorCode MatGetValues(Mat mat,PetscInt m,const PetscInt idxm[],PetscInt n,const PetscInt idxn[],PetscScalar v[])
1893: {

1899:   if (!m || !n) return(0);
1903:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
1904:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1905:   if (!mat->ops->getvalues) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
1906:   MatCheckPreallocated(mat,1);

1908:   PetscLogEventBegin(MAT_GetValues,mat,0,0,0);
1909:   (*mat->ops->getvalues)(mat,m,idxm,n,idxn,v);
1910:   PetscLogEventEnd(MAT_GetValues,mat,0,0,0);
1911:   return(0);
1912: }

1914: /*@
1915:   MatSetValuesBatch - Adds (ADD_VALUES) many blocks of values into a matrix at once. The blocks must all be square and
1916:   the same size. Currently, this can only be called once and creates the given matrix.

1918:   Not Collective

1920:   Input Parameters:
1921: + mat - the matrix
1922: . nb - the number of blocks
1923: . bs - the number of rows (and columns) in each block
1924: . rows - a concatenation of the rows for each block
1925: - v - a concatenation of logically two-dimensional arrays of values

1927:   Notes:
1928:   In the future, we will extend this routine to handle rectangular blocks, and to allow multiple calls for a given matrix.

1930:   Level: advanced

1932: .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
1933:           InsertMode, INSERT_VALUES, ADD_VALUES, MatSetValues()
1934: @*/
1935: PetscErrorCode MatSetValuesBatch(Mat mat, PetscInt nb, PetscInt bs, PetscInt rows[], const PetscScalar v[])
1936: {

1944: #if defined(PETSC_USE_DEBUG)
1945:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1946: #endif

1948:   PetscLogEventBegin(MAT_SetValuesBatch,mat,0,0,0);
1949:   if (mat->ops->setvaluesbatch) {
1950:     (*mat->ops->setvaluesbatch)(mat,nb,bs,rows,v);
1951:   } else {
1952:     PetscInt b;
1953:     for (b = 0; b < nb; ++b) {
1954:       MatSetValues(mat, bs, &rows[b*bs], bs, &rows[b*bs], &v[b*bs*bs], ADD_VALUES);
1955:     }
1956:   }
1957:   PetscLogEventEnd(MAT_SetValuesBatch,mat,0,0,0);
1958:   return(0);
1959: }

1961: /*@
1962:    MatSetLocalToGlobalMapping - Sets a local-to-global numbering for use by
1963:    the routine MatSetValuesLocal() to allow users to insert matrix entries
1964:    using a local (per-processor) numbering.

1966:    Not Collective

1968:    Input Parameters:
1969: +  x - the matrix
1970: .  rmapping - row mapping created with ISLocalToGlobalMappingCreate()   or ISLocalToGlobalMappingCreateIS()
1971: - cmapping - column mapping

1973:    Level: intermediate


1976: .seealso:  MatAssemblyBegin(), MatAssemblyEnd(), MatSetValues(), MatSetValuesLocal()
1977: @*/
1978: PetscErrorCode MatSetLocalToGlobalMapping(Mat x,ISLocalToGlobalMapping rmapping,ISLocalToGlobalMapping cmapping)
1979: {


1988:   if (x->ops->setlocaltoglobalmapping) {
1989:     (*x->ops->setlocaltoglobalmapping)(x,rmapping,cmapping);
1990:   } else {
1991:     PetscLayoutSetISLocalToGlobalMapping(x->rmap,rmapping);
1992:     PetscLayoutSetISLocalToGlobalMapping(x->cmap,cmapping);
1993:   }
1994:   return(0);
1995: }


1998: /*@
1999:    MatGetLocalToGlobalMapping - Gets the local-to-global numbering set by MatSetLocalToGlobalMapping()

2001:    Not Collective

2003:    Input Parameters:
2004: .  A - the matrix

2006:    Output Parameters:
2007: + rmapping - row mapping
2008: - cmapping - column mapping

2010:    Level: advanced


2013: .seealso:  MatSetValuesLocal()
2014: @*/
2015: PetscErrorCode MatGetLocalToGlobalMapping(Mat A,ISLocalToGlobalMapping *rmapping,ISLocalToGlobalMapping *cmapping)
2016: {
2022:   if (rmapping) *rmapping = A->rmap->mapping;
2023:   if (cmapping) *cmapping = A->cmap->mapping;
2024:   return(0);
2025: }

2027: /*@
2028:    MatGetLayouts - Gets the PetscLayout objects for rows and columns

2030:    Not Collective

2032:    Input Parameters:
2033: .  A - the matrix

2035:    Output Parameters:
2036: + rmap - row layout
2037: - cmap - column layout

2039:    Level: advanced

2041: .seealso:  MatCreateVecs(), MatGetLocalToGlobalMapping()
2042: @*/
2043: PetscErrorCode MatGetLayouts(Mat A,PetscLayout *rmap,PetscLayout *cmap)
2044: {
2050:   if (rmap) *rmap = A->rmap;
2051:   if (cmap) *cmap = A->cmap;
2052:   return(0);
2053: }

2055: /*@C
2056:    MatSetValuesLocal - Inserts or adds values into certain locations of a matrix,
2057:    using a local ordering of the nodes.

2059:    Not Collective

2061:    Input Parameters:
2062: +  mat - the matrix
2063: .  nrow, irow - number of rows and their local indices
2064: .  ncol, icol - number of columns and their local indices
2065: .  y -  a logically two-dimensional array of values
2066: -  addv - either INSERT_VALUES or ADD_VALUES, where
2067:    ADD_VALUES adds values to any existing entries, and
2068:    INSERT_VALUES replaces existing entries with new values

2070:    Notes:
2071:    If you create the matrix yourself (that is not with a call to DMCreateMatrix()) then you MUST call MatXXXXSetPreallocation() or
2072:       MatSetUp() before using this routine

2074:    If you create the matrix yourself (that is not with a call to DMCreateMatrix()) then you MUST call MatSetLocalToGlobalMapping() before using this routine

2076:    Calls to MatSetValuesLocal() with the INSERT_VALUES and ADD_VALUES
2077:    options cannot be mixed without intervening calls to the assembly
2078:    routines.

2080:    These values may be cached, so MatAssemblyBegin() and MatAssemblyEnd()
2081:    MUST be called after all calls to MatSetValuesLocal() have been completed.

2083:    Level: intermediate

2085:    Developer Notes:
2086:     This is labeled with C so does not automatically generate Fortran stubs and interfaces
2087:                     because it requires multiple Fortran interfaces depending on which arguments are scalar or arrays.

2089: .seealso:  MatAssemblyBegin(), MatAssemblyEnd(), MatSetValues(), MatSetLocalToGlobalMapping(),
2090:            MatSetValueLocal()
2091: @*/
2092: PetscErrorCode MatSetValuesLocal(Mat mat,PetscInt nrow,const PetscInt irow[],PetscInt ncol,const PetscInt icol[],const PetscScalar y[],InsertMode addv)
2093: {

2099:   MatCheckPreallocated(mat,1);
2100:   if (!nrow || !ncol) return(0); /* no values to insert */
2103:   if (mat->insertmode == NOT_SET_VALUES) {
2104:     mat->insertmode = addv;
2105:   }
2106: #if defined(PETSC_USE_DEBUG)
2107:   else if (mat->insertmode != addv) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
2108:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2109:   if (!mat->ops->setvalueslocal && !mat->ops->setvalues) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2110: #endif

2112:   if (mat->assembled) {
2113:     mat->was_assembled = PETSC_TRUE;
2114:     mat->assembled     = PETSC_FALSE;
2115:   }
2116:   PetscLogEventBegin(MAT_SetValues,mat,0,0,0);
2117:   if (mat->ops->setvalueslocal) {
2118:     (*mat->ops->setvalueslocal)(mat,nrow,irow,ncol,icol,y,addv);
2119:   } else {
2120:     PetscInt buf[8192],*bufr=0,*bufc=0,*irowm,*icolm;
2121:     if ((nrow+ncol) <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
2122:       irowm = buf; icolm = buf+nrow;
2123:     } else {
2124:       PetscMalloc2(nrow,&bufr,ncol,&bufc);
2125:       irowm = bufr; icolm = bufc;
2126:     }
2127:     ISLocalToGlobalMappingApply(mat->rmap->mapping,nrow,irow,irowm);
2128:     ISLocalToGlobalMappingApply(mat->cmap->mapping,ncol,icol,icolm);
2129:     MatSetValues(mat,nrow,irowm,ncol,icolm,y,addv);
2130:     PetscFree2(bufr,bufc);
2131:   }
2132:   PetscLogEventEnd(MAT_SetValues,mat,0,0,0);
2133:   return(0);
2134: }

2136: /*@C
2137:    MatSetValuesBlockedLocal - Inserts or adds values into certain locations of a matrix,
2138:    using a local ordering of the nodes a block at a time.

2140:    Not Collective

2142:    Input Parameters:
2143: +  x - the matrix
2144: .  nrow, irow - number of rows and their local indices
2145: .  ncol, icol - number of columns and their local indices
2146: .  y -  a logically two-dimensional array of values
2147: -  addv - either INSERT_VALUES or ADD_VALUES, where
2148:    ADD_VALUES adds values to any existing entries, and
2149:    INSERT_VALUES replaces existing entries with new values

2151:    Notes:
2152:    If you create the matrix yourself (that is not with a call to DMCreateMatrix()) then you MUST call MatXXXXSetPreallocation() or
2153:       MatSetUp() before using this routine

2155:    If you create the matrix yourself (that is not with a call to DMCreateMatrix()) then you MUST call MatSetBlockSize() and MatSetLocalToGlobalMapping()
2156:       before using this routineBefore calling MatSetValuesLocal(), the user must first set the

2158:    Calls to MatSetValuesBlockedLocal() with the INSERT_VALUES and ADD_VALUES
2159:    options cannot be mixed without intervening calls to the assembly
2160:    routines.

2162:    These values may be cached, so MatAssemblyBegin() and MatAssemblyEnd()
2163:    MUST be called after all calls to MatSetValuesBlockedLocal() have been completed.

2165:    Level: intermediate

2167:    Developer Notes:
2168:     This is labeled with C so does not automatically generate Fortran stubs and interfaces
2169:                     because it requires multiple Fortran interfaces depending on which arguments are scalar or arrays.

2171: .seealso:  MatSetBlockSize(), MatSetLocalToGlobalMapping(), MatAssemblyBegin(), MatAssemblyEnd(),
2172:            MatSetValuesLocal(),  MatSetValuesBlocked()
2173: @*/
2174: PetscErrorCode MatSetValuesBlockedLocal(Mat mat,PetscInt nrow,const PetscInt irow[],PetscInt ncol,const PetscInt icol[],const PetscScalar y[],InsertMode addv)
2175: {

2181:   MatCheckPreallocated(mat,1);
2182:   if (!nrow || !ncol) return(0); /* no values to insert */
2186:   if (mat->insertmode == NOT_SET_VALUES) {
2187:     mat->insertmode = addv;
2188:   }
2189: #if defined(PETSC_USE_DEBUG)
2190:   else if (mat->insertmode != addv) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
2191:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2192:   if (!mat->ops->setvaluesblockedlocal && !mat->ops->setvaluesblocked && !mat->ops->setvalueslocal && !mat->ops->setvalues) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2193: #endif

2195:   if (mat->assembled) {
2196:     mat->was_assembled = PETSC_TRUE;
2197:     mat->assembled     = PETSC_FALSE;
2198:   }
2199: #if defined(PETSC_USE_DEBUG)
2200:   /* Condition on the mapping existing, because MatSetValuesBlockedLocal_IS does not require it to be set. */
2201:   if (mat->rmap->mapping) {
2202:     PetscInt irbs, rbs;
2203:     MatGetBlockSizes(mat, &rbs, NULL);
2204:     ISLocalToGlobalMappingGetBlockSize(mat->rmap->mapping,&irbs);
2205:     if (rbs != irbs) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Different row block sizes! mat %D, row l2g map %D",rbs,irbs);
2206:   }
2207:   if (mat->cmap->mapping) {
2208:     PetscInt icbs, cbs;
2209:     MatGetBlockSizes(mat,NULL,&cbs);
2210:     ISLocalToGlobalMappingGetBlockSize(mat->cmap->mapping,&icbs);
2211:     if (cbs != icbs) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Different col block sizes! mat %D, col l2g map %D",cbs,icbs);
2212:   }
2213: #endif
2214:   PetscLogEventBegin(MAT_SetValues,mat,0,0,0);
2215:   if (mat->ops->setvaluesblockedlocal) {
2216:     (*mat->ops->setvaluesblockedlocal)(mat,nrow,irow,ncol,icol,y,addv);
2217:   } else {
2218:     PetscInt buf[8192],*bufr=0,*bufc=0,*irowm,*icolm;
2219:     if ((nrow+ncol) <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
2220:       irowm = buf; icolm = buf + nrow;
2221:     } else {
2222:       PetscMalloc2(nrow,&bufr,ncol,&bufc);
2223:       irowm = bufr; icolm = bufc;
2224:     }
2225:     ISLocalToGlobalMappingApplyBlock(mat->rmap->mapping,nrow,irow,irowm);
2226:     ISLocalToGlobalMappingApplyBlock(mat->cmap->mapping,ncol,icol,icolm);
2227:     MatSetValuesBlocked(mat,nrow,irowm,ncol,icolm,y,addv);
2228:     PetscFree2(bufr,bufc);
2229:   }
2230:   PetscLogEventEnd(MAT_SetValues,mat,0,0,0);
2231:   return(0);
2232: }

2234: /*@
2235:    MatMultDiagonalBlock - Computes the matrix-vector product, y = Dx. Where D is defined by the inode or block structure of the diagonal

2237:    Collective on Mat

2239:    Input Parameters:
2240: +  mat - the matrix
2241: -  x   - the vector to be multiplied

2243:    Output Parameters:
2244: .  y - the result

2246:    Notes:
2247:    The vectors x and y cannot be the same.  I.e., one cannot
2248:    call MatMult(A,y,y).

2250:    Level: developer

2252: .seealso: MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
2253: @*/
2254: PetscErrorCode MatMultDiagonalBlock(Mat mat,Vec x,Vec y)
2255: {


2264:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2265:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2266:   if (x == y) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2267:   MatCheckPreallocated(mat,1);

2269:   if (!mat->ops->multdiagonalblock) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"This matrix type does not have a multiply defined");
2270:   (*mat->ops->multdiagonalblock)(mat,x,y);
2271:   PetscObjectStateIncrease((PetscObject)y);
2272:   return(0);
2273: }

2275: /* --------------------------------------------------------*/
2276: /*@
2277:    MatMult - Computes the matrix-vector product, y = Ax.

2279:    Neighbor-wise Collective on Mat

2281:    Input Parameters:
2282: +  mat - the matrix
2283: -  x   - the vector to be multiplied

2285:    Output Parameters:
2286: .  y - the result

2288:    Notes:
2289:    The vectors x and y cannot be the same.  I.e., one cannot
2290:    call MatMult(A,y,y).

2292:    Level: beginner

2294: .seealso: MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
2295: @*/
2296: PetscErrorCode MatMult(Mat mat,Vec x,Vec y)
2297: {

2305:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2306:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2307:   if (x == y) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2308: #if !defined(PETSC_HAVE_CONSTRAINTS)
2309:   if (mat->cmap->N != x->map->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap->N,x->map->N);
2310:   if (mat->rmap->N != y->map->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: global dim %D %D",mat->rmap->N,y->map->N);
2311:   if (mat->rmap->n != y->map->n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: local dim %D %D",mat->rmap->n,y->map->n);
2312: #endif
2313:   VecSetErrorIfLocked(y,3);
2314:   if (mat->erroriffailure) {VecValidValues(x,2,PETSC_TRUE);}
2315:   MatCheckPreallocated(mat,1);

2317:   VecLockReadPush(x);
2318:   if (!mat->ops->mult) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"This matrix type does not have a multiply defined");
2319:   PetscLogEventBegin(MAT_Mult,mat,x,y,0);
2320:   (*mat->ops->mult)(mat,x,y);
2321:   PetscLogEventEnd(MAT_Mult,mat,x,y,0);
2322:   if (mat->erroriffailure) {VecValidValues(y,3,PETSC_FALSE);}
2323:   VecLockReadPop(x);
2324:   return(0);
2325: }

2327: /*@
2328:    MatMultTranspose - Computes matrix transpose times a vector y = A^T * x.

2330:    Neighbor-wise Collective on Mat

2332:    Input Parameters:
2333: +  mat - the matrix
2334: -  x   - the vector to be multiplied

2336:    Output Parameters:
2337: .  y - the result

2339:    Notes:
2340:    The vectors x and y cannot be the same.  I.e., one cannot
2341:    call MatMultTranspose(A,y,y).

2343:    For complex numbers this does NOT compute the Hermitian (complex conjugate) transpose multiple,
2344:    use MatMultHermitianTranspose()

2346:    Level: beginner

2348: .seealso: MatMult(), MatMultAdd(), MatMultTransposeAdd(), MatMultHermitianTranspose(), MatTranspose()
2349: @*/
2350: PetscErrorCode MatMultTranspose(Mat mat,Vec x,Vec y)
2351: {


2360:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2361:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2362:   if (x == y) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2363: #if !defined(PETSC_HAVE_CONSTRAINTS)
2364:   if (mat->rmap->N != x->map->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->rmap->N,x->map->N);
2365:   if (mat->cmap->N != y->map->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: global dim %D %D",mat->cmap->N,y->map->N);
2366: #endif
2367:   if (mat->erroriffailure) {VecValidValues(x,2,PETSC_TRUE);}
2368:   MatCheckPreallocated(mat,1);

2370:   if (!mat->ops->multtranspose) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"This matrix type does not have a multiply transpose defined");
2371:   PetscLogEventBegin(MAT_MultTranspose,mat,x,y,0);
2372:   VecLockReadPush(x);
2373:   (*mat->ops->multtranspose)(mat,x,y);
2374:   VecLockReadPop(x);
2375:   PetscLogEventEnd(MAT_MultTranspose,mat,x,y,0);
2376:   PetscObjectStateIncrease((PetscObject)y);
2377:   if (mat->erroriffailure) {VecValidValues(y,3,PETSC_FALSE);}
2378:   return(0);
2379: }

2381: /*@
2382:    MatMultHermitianTranspose - Computes matrix Hermitian transpose times a vector.

2384:    Neighbor-wise Collective on Mat

2386:    Input Parameters:
2387: +  mat - the matrix
2388: -  x   - the vector to be multilplied

2390:    Output Parameters:
2391: .  y - the result

2393:    Notes:
2394:    The vectors x and y cannot be the same.  I.e., one cannot
2395:    call MatMultHermitianTranspose(A,y,y).

2397:    Also called the conjugate transpose, complex conjugate transpose, or adjoint.

2399:    For real numbers MatMultTranspose() and MatMultHermitianTranspose() are identical.

2401:    Level: beginner

2403: .seealso: MatMult(), MatMultAdd(), MatMultHermitianTransposeAdd(), MatMultTranspose()
2404: @*/
2405: PetscErrorCode MatMultHermitianTranspose(Mat mat,Vec x,Vec y)
2406: {
2408:   Vec            w;


2416:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2417:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2418:   if (x == y) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2419: #if !defined(PETSC_HAVE_CONSTRAINTS)
2420:   if (mat->rmap->N != x->map->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->rmap->N,x->map->N);
2421:   if (mat->cmap->N != y->map->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: global dim %D %D",mat->cmap->N,y->map->N);
2422: #endif
2423:   MatCheckPreallocated(mat,1);

2425:   PetscLogEventBegin(MAT_MultHermitianTranspose,mat,x,y,0);
2426:   if (mat->ops->multhermitiantranspose) {
2427:     VecLockReadPush(x);
2428:     (*mat->ops->multhermitiantranspose)(mat,x,y);
2429:     VecLockReadPop(x);
2430:   } else {
2431:     VecDuplicate(x,&w);
2432:     VecCopy(x,w);
2433:     VecConjugate(w);
2434:     MatMultTranspose(mat,w,y);
2435:     VecDestroy(&w);
2436:     VecConjugate(y);
2437:   }
2438:   PetscLogEventEnd(MAT_MultHermitianTranspose,mat,x,y,0);
2439:   PetscObjectStateIncrease((PetscObject)y);
2440:   return(0);
2441: }

2443: /*@
2444:     MatMultAdd -  Computes v3 = v2 + A * v1.

2446:     Neighbor-wise Collective on Mat

2448:     Input Parameters:
2449: +   mat - the matrix
2450: -   v1, v2 - the vectors

2452:     Output Parameters:
2453: .   v3 - the result

2455:     Notes:
2456:     The vectors v1 and v3 cannot be the same.  I.e., one cannot
2457:     call MatMultAdd(A,v1,v2,v1).

2459:     Level: beginner

2461: .seealso: MatMultTranspose(), MatMult(), MatMultTransposeAdd()
2462: @*/
2463: PetscErrorCode MatMultAdd(Mat mat,Vec v1,Vec v2,Vec v3)
2464: {


2474:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2475:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2476:   if (mat->cmap->N != v1->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec v1: global dim %D %D",mat->cmap->N,v1->map->N);
2477:   /* if (mat->rmap->N != v2->map->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec v2: global dim %D %D",mat->rmap->N,v2->map->N);
2478:      if (mat->rmap->N != v3->map->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec v3: global dim %D %D",mat->rmap->N,v3->map->N); */
2479:   if (mat->rmap->n != v3->map->n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec v3: local dim %D %D",mat->rmap->n,v3->map->n);
2480:   if (mat->rmap->n != v2->map->n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec v2: local dim %D %D",mat->rmap->n,v2->map->n);
2481:   if (v1 == v3) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"v1 and v3 must be different vectors");
2482:   MatCheckPreallocated(mat,1);

2484:   if (!mat->ops->multadd) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"No MatMultAdd() for matrix type '%s'",((PetscObject)mat)->type_name);
2485:   PetscLogEventBegin(MAT_MultAdd,mat,v1,v2,v3);
2486:   VecLockReadPush(v1);
2487:   (*mat->ops->multadd)(mat,v1,v2,v3);
2488:   VecLockReadPop(v1);
2489:   PetscLogEventEnd(MAT_MultAdd,mat,v1,v2,v3);
2490:   PetscObjectStateIncrease((PetscObject)v3);
2491:   return(0);
2492: }

2494: /*@
2495:    MatMultTransposeAdd - Computes v3 = v2 + A' * v1.

2497:    Neighbor-wise Collective on Mat

2499:    Input Parameters:
2500: +  mat - the matrix
2501: -  v1, v2 - the vectors

2503:    Output Parameters:
2504: .  v3 - the result

2506:    Notes:
2507:    The vectors v1 and v3 cannot be the same.  I.e., one cannot
2508:    call MatMultTransposeAdd(A,v1,v2,v1).

2510:    Level: beginner

2512: .seealso: MatMultTranspose(), MatMultAdd(), MatMult()
2513: @*/
2514: PetscErrorCode MatMultTransposeAdd(Mat mat,Vec v1,Vec v2,Vec v3)
2515: {


2525:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2526:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2527:   if (!mat->ops->multtransposeadd) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2528:   if (v1 == v3) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"v1 and v3 must be different vectors");
2529:   if (mat->rmap->N != v1->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec v1: global dim %D %D",mat->rmap->N,v1->map->N);
2530:   if (mat->cmap->N != v2->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec v2: global dim %D %D",mat->cmap->N,v2->map->N);
2531:   if (mat->cmap->N != v3->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec v3: global dim %D %D",mat->cmap->N,v3->map->N);
2532:   MatCheckPreallocated(mat,1);

2534:   PetscLogEventBegin(MAT_MultTransposeAdd,mat,v1,v2,v3);
2535:   VecLockReadPush(v1);
2536:   (*mat->ops->multtransposeadd)(mat,v1,v2,v3);
2537:   VecLockReadPop(v1);
2538:   PetscLogEventEnd(MAT_MultTransposeAdd,mat,v1,v2,v3);
2539:   PetscObjectStateIncrease((PetscObject)v3);
2540:   return(0);
2541: }

2543: /*@
2544:    MatMultHermitianTransposeAdd - Computes v3 = v2 + A^H * v1.

2546:    Neighbor-wise Collective on Mat

2548:    Input Parameters:
2549: +  mat - the matrix
2550: -  v1, v2 - the vectors

2552:    Output Parameters:
2553: .  v3 - the result

2555:    Notes:
2556:    The vectors v1 and v3 cannot be the same.  I.e., one cannot
2557:    call MatMultHermitianTransposeAdd(A,v1,v2,v1).

2559:    Level: beginner

2561: .seealso: MatMultHermitianTranspose(), MatMultTranspose(), MatMultAdd(), MatMult()
2562: @*/
2563: PetscErrorCode MatMultHermitianTransposeAdd(Mat mat,Vec v1,Vec v2,Vec v3)
2564: {


2574:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2575:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2576:   if (v1 == v3) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"v1 and v3 must be different vectors");
2577:   if (mat->rmap->N != v1->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec v1: global dim %D %D",mat->rmap->N,v1->map->N);
2578:   if (mat->cmap->N != v2->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec v2: global dim %D %D",mat->cmap->N,v2->map->N);
2579:   if (mat->cmap->N != v3->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec v3: global dim %D %D",mat->cmap->N,v3->map->N);
2580:   MatCheckPreallocated(mat,1);

2582:   PetscLogEventBegin(MAT_MultHermitianTransposeAdd,mat,v1,v2,v3);
2583:   VecLockReadPush(v1);
2584:   if (mat->ops->multhermitiantransposeadd) {
2585:     (*mat->ops->multhermitiantransposeadd)(mat,v1,v2,v3);
2586:   } else {
2587:     Vec w,z;
2588:     VecDuplicate(v1,&w);
2589:     VecCopy(v1,w);
2590:     VecConjugate(w);
2591:     VecDuplicate(v3,&z);
2592:     MatMultTranspose(mat,w,z);
2593:     VecDestroy(&w);
2594:     VecConjugate(z);
2595:     if (v2 != v3) {
2596:       VecWAXPY(v3,1.0,v2,z);
2597:     } else {
2598:       VecAXPY(v3,1.0,z);
2599:     }
2600:     VecDestroy(&z);
2601:   }
2602:   VecLockReadPop(v1);
2603:   PetscLogEventEnd(MAT_MultHermitianTransposeAdd,mat,v1,v2,v3);
2604:   PetscObjectStateIncrease((PetscObject)v3);
2605:   return(0);
2606: }

2608: /*@
2609:    MatMultConstrained - The inner multiplication routine for a
2610:    constrained matrix P^T A P.

2612:    Neighbor-wise Collective on Mat

2614:    Input Parameters:
2615: +  mat - the matrix
2616: -  x   - the vector to be multilplied

2618:    Output Parameters:
2619: .  y - the result

2621:    Notes:
2622:    The vectors x and y cannot be the same.  I.e., one cannot
2623:    call MatMult(A,y,y).

2625:    Level: beginner

2627: .seealso: MatMult(), MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
2628: @*/
2629: PetscErrorCode MatMultConstrained(Mat mat,Vec x,Vec y)
2630: {

2637:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2638:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2639:   if (x == y) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2640:   if (mat->cmap->N != x->map->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap->N,x->map->N);
2641:   if (mat->rmap->N != y->map->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: global dim %D %D",mat->rmap->N,y->map->N);
2642:   if (mat->rmap->n != y->map->n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: local dim %D %D",mat->rmap->n,y->map->n);

2644:   PetscLogEventBegin(MAT_MultConstrained,mat,x,y,0);
2645:   VecLockReadPush(x);
2646:   (*mat->ops->multconstrained)(mat,x,y);
2647:   VecLockReadPop(x);
2648:   PetscLogEventEnd(MAT_MultConstrained,mat,x,y,0);
2649:   PetscObjectStateIncrease((PetscObject)y);
2650:   return(0);
2651: }

2653: /*@
2654:    MatMultTransposeConstrained - The inner multiplication routine for a
2655:    constrained matrix P^T A^T P.

2657:    Neighbor-wise Collective on Mat

2659:    Input Parameters:
2660: +  mat - the matrix
2661: -  x   - the vector to be multilplied

2663:    Output Parameters:
2664: .  y - the result

2666:    Notes:
2667:    The vectors x and y cannot be the same.  I.e., one cannot
2668:    call MatMult(A,y,y).

2670:    Level: beginner

2672: .seealso: MatMult(), MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
2673: @*/
2674: PetscErrorCode MatMultTransposeConstrained(Mat mat,Vec x,Vec y)
2675: {

2682:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2683:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2684:   if (x == y) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2685:   if (mat->rmap->N != x->map->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap->N,x->map->N);
2686:   if (mat->cmap->N != y->map->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: global dim %D %D",mat->rmap->N,y->map->N);

2688:   PetscLogEventBegin(MAT_MultConstrained,mat,x,y,0);
2689:   (*mat->ops->multtransposeconstrained)(mat,x,y);
2690:   PetscLogEventEnd(MAT_MultConstrained,mat,x,y,0);
2691:   PetscObjectStateIncrease((PetscObject)y);
2692:   return(0);
2693: }

2695: /*@C
2696:    MatGetFactorType - gets the type of factorization it is

2698:    Not Collective

2700:    Input Parameters:
2701: .  mat - the matrix

2703:    Output Parameters:
2704: .  t - the type, one of MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT

2706:    Level: intermediate

2708: .seealso: MatFactorType, MatGetFactor(), MatSetFactorType()
2709: @*/
2710: PetscErrorCode MatGetFactorType(Mat mat,MatFactorType *t)
2711: {
2716:   *t = mat->factortype;
2717:   return(0);
2718: }

2720: /*@C
2721:    MatSetFactorType - sets the type of factorization it is

2723:    Logically Collective on Mat

2725:    Input Parameters:
2726: +  mat - the matrix
2727: -  t - the type, one of MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT

2729:    Level: intermediate

2731: .seealso: MatFactorType, MatGetFactor(), MatGetFactorType()
2732: @*/
2733: PetscErrorCode MatSetFactorType(Mat mat, MatFactorType t)
2734: {
2738:   mat->factortype = t;
2739:   return(0);
2740: }

2742: /* ------------------------------------------------------------*/
2743: /*@C
2744:    MatGetInfo - Returns information about matrix storage (number of
2745:    nonzeros, memory, etc.).

2747:    Collective on Mat if MAT_GLOBAL_MAX or MAT_GLOBAL_SUM is used as the flag

2749:    Input Parameters:
2750: .  mat - the matrix

2752:    Output Parameters:
2753: +  flag - flag indicating the type of parameters to be returned
2754:    (MAT_LOCAL - local matrix, MAT_GLOBAL_MAX - maximum over all processors,
2755:    MAT_GLOBAL_SUM - sum over all processors)
2756: -  info - matrix information context

2758:    Notes:
2759:    The MatInfo context contains a variety of matrix data, including
2760:    number of nonzeros allocated and used, number of mallocs during
2761:    matrix assembly, etc.  Additional information for factored matrices
2762:    is provided (such as the fill ratio, number of mallocs during
2763:    factorization, etc.).  Much of this info is printed to PETSC_STDOUT
2764:    when using the runtime options
2765: $       -info -mat_view ::ascii_info

2767:    Example for C/C++ Users:
2768:    See the file ${PETSC_DIR}/include/petscmat.h for a complete list of
2769:    data within the MatInfo context.  For example,
2770: .vb
2771:       MatInfo info;
2772:       Mat     A;
2773:       double  mal, nz_a, nz_u;

2775:       MatGetInfo(A,MAT_LOCAL,&info);
2776:       mal  = info.mallocs;
2777:       nz_a = info.nz_allocated;
2778: .ve

2780:    Example for Fortran Users:
2781:    Fortran users should declare info as a double precision
2782:    array of dimension MAT_INFO_SIZE, and then extract the parameters
2783:    of interest.  See the file ${PETSC_DIR}/include/petsc/finclude/petscmat.h
2784:    a complete list of parameter names.
2785: .vb
2786:       double  precision info(MAT_INFO_SIZE)
2787:       double  precision mal, nz_a
2788:       Mat     A
2789:       integer ierr

2791:       call MatGetInfo(A,MAT_LOCAL,info,ierr)
2792:       mal = info(MAT_INFO_MALLOCS)
2793:       nz_a = info(MAT_INFO_NZ_ALLOCATED)
2794: .ve

2796:     Level: intermediate

2798:     Developer Note: fortran interface is not autogenerated as the f90
2799:     interface defintion cannot be generated correctly [due to MatInfo]

2801: .seealso: MatStashGetInfo()

2803: @*/
2804: PetscErrorCode MatGetInfo(Mat mat,MatInfoType flag,MatInfo *info)
2805: {

2812:   if (!mat->ops->getinfo) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2813:   MatCheckPreallocated(mat,1);
2814:   (*mat->ops->getinfo)(mat,flag,info);
2815:   return(0);
2816: }

2818: /*
2819:    This is used by external packages where it is not easy to get the info from the actual
2820:    matrix factorization.
2821: */
2822: PetscErrorCode MatGetInfo_External(Mat A,MatInfoType flag,MatInfo *info)
2823: {

2827:   PetscMemzero(info,sizeof(MatInfo));
2828:   return(0);
2829: }

2831: /* ----------------------------------------------------------*/

2833: /*@C
2834:    MatLUFactor - Performs in-place LU factorization of matrix.

2836:    Collective on Mat

2838:    Input Parameters:
2839: +  mat - the matrix
2840: .  row - row permutation
2841: .  col - column permutation
2842: -  info - options for factorization, includes
2843: $          fill - expected fill as ratio of original fill.
2844: $          dtcol - pivot tolerance (0 no pivot, 1 full column pivoting)
2845: $                   Run with the option -info to determine an optimal value to use

2847:    Notes:
2848:    Most users should employ the simplified KSP interface for linear solvers
2849:    instead of working directly with matrix algebra routines such as this.
2850:    See, e.g., KSPCreate().

2852:    This changes the state of the matrix to a factored matrix; it cannot be used
2853:    for example with MatSetValues() unless one first calls MatSetUnfactored().

2855:    Level: developer

2857: .seealso: MatLUFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor(),
2858:           MatGetOrdering(), MatSetUnfactored(), MatFactorInfo, MatGetFactor()

2860:     Developer Note: fortran interface is not autogenerated as the f90
2861:     interface defintion cannot be generated correctly [due to MatFactorInfo]

2863: @*/
2864: PetscErrorCode MatLUFactor(Mat mat,IS row,IS col,const MatFactorInfo *info)
2865: {
2867:   MatFactorInfo  tinfo;

2875:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2876:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2877:   if (!mat->ops->lufactor) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2878:   MatCheckPreallocated(mat,1);
2879:   if (!info) {
2880:     MatFactorInfoInitialize(&tinfo);
2881:     info = &tinfo;
2882:   }

2884:   PetscLogEventBegin(MAT_LUFactor,mat,row,col,0);
2885:   (*mat->ops->lufactor)(mat,row,col,info);
2886:   PetscLogEventEnd(MAT_LUFactor,mat,row,col,0);
2887:   PetscObjectStateIncrease((PetscObject)mat);
2888:   return(0);
2889: }

2891: /*@C
2892:    MatILUFactor - Performs in-place ILU factorization of matrix.

2894:    Collective on Mat

2896:    Input Parameters:
2897: +  mat - the matrix
2898: .  row - row permutation
2899: .  col - column permutation
2900: -  info - structure containing
2901: $      levels - number of levels of fill.
2902: $      expected fill - as ratio of original fill.
2903: $      1 or 0 - indicating force fill on diagonal (improves robustness for matrices
2904:                 missing diagonal entries)

2906:    Notes:
2907:    Probably really in-place only when level of fill is zero, otherwise allocates
2908:    new space to store factored matrix and deletes previous memory.

2910:    Most users should employ the simplified KSP interface for linear solvers
2911:    instead of working directly with matrix algebra routines such as this.
2912:    See, e.g., KSPCreate().

2914:    Level: developer

2916: .seealso: MatILUFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor(), MatFactorInfo

2918:     Developer Note: fortran interface is not autogenerated as the f90
2919:     interface defintion cannot be generated correctly [due to MatFactorInfo]

2921: @*/
2922: PetscErrorCode MatILUFactor(Mat mat,IS row,IS col,const MatFactorInfo *info)
2923: {

2932:   if (mat->rmap->N != mat->cmap->N) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONG,"matrix must be square");
2933:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2934:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2935:   if (!mat->ops->ilufactor) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2936:   MatCheckPreallocated(mat,1);

2938:   PetscLogEventBegin(MAT_ILUFactor,mat,row,col,0);
2939:   (*mat->ops->ilufactor)(mat,row,col,info);
2940:   PetscLogEventEnd(MAT_ILUFactor,mat,row,col,0);
2941:   PetscObjectStateIncrease((PetscObject)mat);
2942:   return(0);
2943: }

2945: /*@C
2946:    MatLUFactorSymbolic - Performs symbolic LU factorization of matrix.
2947:    Call this routine before calling MatLUFactorNumeric().

2949:    Collective on Mat

2951:    Input Parameters:
2952: +  fact - the factor matrix obtained with MatGetFactor()
2953: .  mat - the matrix
2954: .  row, col - row and column permutations
2955: -  info - options for factorization, includes
2956: $          fill - expected fill as ratio of original fill.
2957: $          dtcol - pivot tolerance (0 no pivot, 1 full column pivoting)
2958: $                   Run with the option -info to determine an optimal value to use


2961:    Notes:
2962:     See Users-Manual: ch_mat for additional information about choosing the fill factor for better efficiency.

2964:    Most users should employ the simplified KSP interface for linear solvers
2965:    instead of working directly with matrix algebra routines such as this.
2966:    See, e.g., KSPCreate().

2968:    Level: developer

2970: .seealso: MatLUFactor(), MatLUFactorNumeric(), MatCholeskyFactor(), MatFactorInfo, MatFactorInfoInitialize()

2972:     Developer Note: fortran interface is not autogenerated as the f90
2973:     interface defintion cannot be generated correctly [due to MatFactorInfo]

2975: @*/
2976: PetscErrorCode MatLUFactorSymbolic(Mat fact,Mat mat,IS row,IS col,const MatFactorInfo *info)
2977: {
2979:   MatFactorInfo  tinfo;

2988:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2989:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2990:   if (!(fact)->ops->lufactorsymbolic) {
2991:     MatSolverType spackage;
2992:     MatFactorGetSolverType(fact,&spackage);
2993:     SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s symbolic LU using solver package %s",((PetscObject)mat)->type_name,spackage);
2994:   }
2995:   MatCheckPreallocated(mat,2);
2996:   if (!info) {
2997:     MatFactorInfoInitialize(&tinfo);
2998:     info = &tinfo;
2999:   }

3001:   PetscLogEventBegin(MAT_LUFactorSymbolic,mat,row,col,0);
3002:   (fact->ops->lufactorsymbolic)(fact,mat,row,col,info);
3003:   PetscLogEventEnd(MAT_LUFactorSymbolic,mat,row,col,0);
3004:   PetscObjectStateIncrease((PetscObject)fact);
3005:   return(0);
3006: }

3008: /*@C
3009:    MatLUFactorNumeric - Performs numeric LU factorization of a matrix.
3010:    Call this routine after first calling MatLUFactorSymbolic().

3012:    Collective on Mat

3014:    Input Parameters:
3015: +  fact - the factor matrix obtained with MatGetFactor()
3016: .  mat - the matrix
3017: -  info - options for factorization

3019:    Notes:
3020:    See MatLUFactor() for in-place factorization.  See
3021:    MatCholeskyFactorNumeric() for the symmetric, positive definite case.

3023:    Most users should employ the simplified KSP interface for linear solvers
3024:    instead of working directly with matrix algebra routines such as this.
3025:    See, e.g., KSPCreate().

3027:    Level: developer

3029: .seealso: MatLUFactorSymbolic(), MatLUFactor(), MatCholeskyFactor()

3031:     Developer Note: fortran interface is not autogenerated as the f90
3032:     interface defintion cannot be generated correctly [due to MatFactorInfo]

3034: @*/
3035: PetscErrorCode MatLUFactorNumeric(Mat fact,Mat mat,const MatFactorInfo *info)
3036: {
3037:   MatFactorInfo  tinfo;

3045:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3046:   if (mat->rmap->N != (fact)->rmap->N || mat->cmap->N != (fact)->cmap->N) SETERRQ4(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Mat fact: global dimensions are different %D should = %D %D should = %D",mat->rmap->N,(fact)->rmap->N,mat->cmap->N,(fact)->cmap->N);

3048:   if (!(fact)->ops->lufactornumeric) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s numeric LU",((PetscObject)mat)->type_name);
3049:   MatCheckPreallocated(mat,2);
3050:   if (!info) {
3051:     MatFactorInfoInitialize(&tinfo);
3052:     info = &tinfo;
3053:   }

3055:   PetscLogEventBegin(MAT_LUFactorNumeric,mat,fact,0,0);
3056:   (fact->ops->lufactornumeric)(fact,mat,info);
3057:   PetscLogEventEnd(MAT_LUFactorNumeric,mat,fact,0,0);
3058:   MatViewFromOptions(fact,NULL,"-mat_factor_view");
3059:   PetscObjectStateIncrease((PetscObject)fact);
3060:   return(0);
3061: }

3063: /*@C
3064:    MatCholeskyFactor - Performs in-place Cholesky factorization of a
3065:    symmetric matrix.

3067:    Collective on Mat

3069:    Input Parameters:
3070: +  mat - the matrix
3071: .  perm - row and column permutations
3072: -  f - expected fill as ratio of original fill

3074:    Notes:
3075:    See MatLUFactor() for the nonsymmetric case.  See also
3076:    MatCholeskyFactorSymbolic(), and MatCholeskyFactorNumeric().

3078:    Most users should employ the simplified KSP interface for linear solvers
3079:    instead of working directly with matrix algebra routines such as this.
3080:    See, e.g., KSPCreate().

3082:    Level: developer

3084: .seealso: MatLUFactor(), MatCholeskyFactorSymbolic(), MatCholeskyFactorNumeric()
3085:           MatGetOrdering()

3087:     Developer Note: fortran interface is not autogenerated as the f90
3088:     interface defintion cannot be generated correctly [due to MatFactorInfo]

3090: @*/
3091: PetscErrorCode MatCholeskyFactor(Mat mat,IS perm,const MatFactorInfo *info)
3092: {
3094:   MatFactorInfo  tinfo;

3101:   if (mat->rmap->N != mat->cmap->N) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONG,"Matrix must be square");
3102:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3103:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3104:   if (!mat->ops->choleskyfactor) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"In-place factorization for Mat type %s is not supported, try out-of-place factorization. See MatCholeskyFactorSymbolic/Numeric",((PetscObject)mat)->type_name);
3105:   MatCheckPreallocated(mat,1);
3106:   if (!info) {
3107:     MatFactorInfoInitialize(&tinfo);
3108:     info = &tinfo;
3109:   }

3111:   PetscLogEventBegin(MAT_CholeskyFactor,mat,perm,0,0);
3112:   (*mat->ops->choleskyfactor)(mat,perm,info);
3113:   PetscLogEventEnd(MAT_CholeskyFactor,mat,perm,0,0);
3114:   PetscObjectStateIncrease((PetscObject)mat);
3115:   return(0);
3116: }

3118: /*@C
3119:    MatCholeskyFactorSymbolic - Performs symbolic Cholesky factorization
3120:    of a symmetric matrix.

3122:    Collective on Mat

3124:    Input Parameters:
3125: +  fact - the factor matrix obtained with MatGetFactor()
3126: .  mat - the matrix
3127: .  perm - row and column permutations
3128: -  info - options for factorization, includes
3129: $          fill - expected fill as ratio of original fill.
3130: $          dtcol - pivot tolerance (0 no pivot, 1 full column pivoting)
3131: $                   Run with the option -info to determine an optimal value to use

3133:    Notes:
3134:    See MatLUFactorSymbolic() for the nonsymmetric case.  See also
3135:    MatCholeskyFactor() and MatCholeskyFactorNumeric().

3137:    Most users should employ the simplified KSP interface for linear solvers
3138:    instead of working directly with matrix algebra routines such as this.
3139:    See, e.g., KSPCreate().

3141:    Level: developer

3143: .seealso: MatLUFactorSymbolic(), MatCholeskyFactor(), MatCholeskyFactorNumeric()
3144:           MatGetOrdering()

3146:     Developer Note: fortran interface is not autogenerated as the f90
3147:     interface defintion cannot be generated correctly [due to MatFactorInfo]

3149: @*/
3150: PetscErrorCode MatCholeskyFactorSymbolic(Mat fact,Mat mat,IS perm,const MatFactorInfo *info)
3151: {
3153:   MatFactorInfo  tinfo;

3161:   if (mat->rmap->N != mat->cmap->N) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONG,"Matrix must be square");
3162:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3163:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3164:   if (!(fact)->ops->choleskyfactorsymbolic) {
3165:     MatSolverType spackage;
3166:     MatFactorGetSolverType(fact,&spackage);
3167:     SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s symbolic factor Cholesky using solver package %s",((PetscObject)mat)->type_name,spackage);
3168:   }
3169:   MatCheckPreallocated(mat,2);
3170:   if (!info) {
3171:     MatFactorInfoInitialize(&tinfo);
3172:     info = &tinfo;
3173:   }

3175:   PetscLogEventBegin(MAT_CholeskyFactorSymbolic,mat,perm,0,0);
3176:   (fact->ops->choleskyfactorsymbolic)(fact,mat,perm,info);
3177:   PetscLogEventEnd(MAT_CholeskyFactorSymbolic,mat,perm,0,0);
3178:   PetscObjectStateIncrease((PetscObject)fact);
3179:   return(0);
3180: }

3182: /*@C
3183:    MatCholeskyFactorNumeric - Performs numeric Cholesky factorization
3184:    of a symmetric matrix. Call this routine after first calling
3185:    MatCholeskyFactorSymbolic().

3187:    Collective on Mat

3189:    Input Parameters:
3190: +  fact - the factor matrix obtained with MatGetFactor()
3191: .  mat - the initial matrix
3192: .  info - options for factorization
3193: -  fact - the symbolic factor of mat


3196:    Notes:
3197:    Most users should employ the simplified KSP interface for linear solvers
3198:    instead of working directly with matrix algebra routines such as this.
3199:    See, e.g., KSPCreate().

3201:    Level: developer

3203: .seealso: MatCholeskyFactorSymbolic(), MatCholeskyFactor(), MatLUFactorNumeric()

3205:     Developer Note: fortran interface is not autogenerated as the f90
3206:     interface defintion cannot be generated correctly [due to MatFactorInfo]

3208: @*/
3209: PetscErrorCode MatCholeskyFactorNumeric(Mat fact,Mat mat,const MatFactorInfo *info)
3210: {
3211:   MatFactorInfo  tinfo;

3219:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3220:   if (!(fact)->ops->choleskyfactornumeric) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s numeric factor Cholesky",((PetscObject)mat)->type_name);
3221:   if (mat->rmap->N != (fact)->rmap->N || mat->cmap->N != (fact)->cmap->N) SETERRQ4(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Mat fact: global dim %D should = %D %D should = %D",mat->rmap->N,(fact)->rmap->N,mat->cmap->N,(fact)->cmap->N);
3222:   MatCheckPreallocated(mat,2);
3223:   if (!info) {
3224:     MatFactorInfoInitialize(&tinfo);
3225:     info = &tinfo;
3226:   }

3228:   PetscLogEventBegin(MAT_CholeskyFactorNumeric,mat,fact,0,0);
3229:   (fact->ops->choleskyfactornumeric)(fact,mat,info);
3230:   PetscLogEventEnd(MAT_CholeskyFactorNumeric,mat,fact,0,0);
3231:   MatViewFromOptions(fact,NULL,"-mat_factor_view");
3232:   PetscObjectStateIncrease((PetscObject)fact);
3233:   return(0);
3234: }

3236: /* ----------------------------------------------------------------*/
3237: /*@
3238:    MatSolve - Solves A x = b, given a factored matrix.

3240:    Neighbor-wise Collective on Mat

3242:    Input Parameters:
3243: +  mat - the factored matrix
3244: -  b - the right-hand-side vector

3246:    Output Parameter:
3247: .  x - the result vector

3249:    Notes:
3250:    The vectors b and x cannot be the same.  I.e., one cannot
3251:    call MatSolve(A,x,x).

3253:    Notes:
3254:    Most users should employ the simplified KSP interface for linear solvers
3255:    instead of working directly with matrix algebra routines such as this.
3256:    See, e.g., KSPCreate().

3258:    Level: developer

3260: .seealso: MatSolveAdd(), MatSolveTranspose(), MatSolveTransposeAdd()
3261: @*/
3262: PetscErrorCode MatSolve(Mat mat,Vec b,Vec x)
3263: {

3273:   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3274:   if (mat->cmap->N != x->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap->N,x->map->N);
3275:   if (mat->rmap->N != b->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: global dim %D %D",mat->rmap->N,b->map->N);
3276:   if (mat->rmap->n != b->map->n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: local dim %D %D",mat->rmap->n,b->map->n);
3277:   if (!mat->rmap->N && !mat->cmap->N) return(0);
3278:   if (!mat->ops->solve) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3279:   MatCheckPreallocated(mat,1);

3281:   PetscLogEventBegin(MAT_Solve,mat,b,x,0);
3282:   if (mat->factorerrortype) {
3283:     PetscInfo1(mat,"MatFactorError %D\n",mat->factorerrortype);
3284:     VecSetInf(x);
3285:   } else {
3286:     if (!mat->ops->solve) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3287:     (*mat->ops->solve)(mat,b,x);
3288:   }
3289:   PetscLogEventEnd(MAT_Solve,mat,b,x,0);
3290:   PetscObjectStateIncrease((PetscObject)x);
3291:   return(0);
3292: }

3294: static PetscErrorCode MatMatSolve_Basic(Mat A,Mat B,Mat X,PetscBool trans)
3295: {
3297:   Vec            b,x;
3298:   PetscInt       m,N,i;
3299:   PetscScalar    *bb,*xx;

3302:   MatDenseGetArrayRead(B,(const PetscScalar**)&bb);
3303:   MatDenseGetArray(X,&xx);
3304:   MatGetLocalSize(B,&m,NULL);  /* number local rows */
3305:   MatGetSize(B,NULL,&N);       /* total columns in dense matrix */
3306:   MatCreateVecs(A,&x,&b);
3307:   for (i=0; i<N; i++) {
3308:     VecPlaceArray(b,bb + i*m);
3309:     VecPlaceArray(x,xx + i*m);
3310:     if (trans) {
3311:       MatSolveTranspose(A,b,x);
3312:     } else {
3313:       MatSolve(A,b,x);
3314:     }
3315:     VecResetArray(x);
3316:     VecResetArray(b);
3317:   }
3318:   VecDestroy(&b);
3319:   VecDestroy(&x);
3320:   MatDenseRestoreArrayRead(B,(const PetscScalar**)&bb);
3321:   MatDenseRestoreArray(X,&xx);
3322:   return(0);
3323: }

3325: /*@
3326:    MatMatSolve - Solves A X = B, given a factored matrix.

3328:    Neighbor-wise Collective on Mat

3330:    Input Parameters:
3331: +  A - the factored matrix
3332: -  B - the right-hand-side matrix MATDENSE (or sparse -- when using MUMPS)

3334:    Output Parameter:
3335: .  X - the result matrix (dense matrix)

3337:    Notes:
3338:    If B is a MATDENSE matrix then one can call MatMatSolve(A,B,B);
3339:    otherwise, B and X cannot be the same.

3341:    Notes:
3342:    Most users should usually employ the simplified KSP interface for linear solvers
3343:    instead of working directly with matrix algebra routines such as this.
3344:    See, e.g., KSPCreate(). However KSP can only solve for one vector (column of X)
3345:    at a time.

3347:    Level: developer

3349: .seealso: MatMatSolveTranspose(), MatLUFactor(), MatCholeskyFactor()
3350: @*/
3351: PetscErrorCode MatMatSolve(Mat A,Mat B,Mat X)
3352: {

3362:   if (A->cmap->N != X->rmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Mat A,Mat X: global dim %D %D",A->cmap->N,X->rmap->N);
3363:   if (A->rmap->N != B->rmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Mat A,Mat B: global dim %D %D",A->rmap->N,B->rmap->N);
3364:   if (X->cmap->N != B->cmap->N) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Solution matrix must have same number of columns as rhs matrix");
3365:   if (!A->rmap->N && !A->cmap->N) return(0);
3366:   if (!A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3367:   MatCheckPreallocated(A,1);

3369:   PetscLogEventBegin(MAT_MatSolve,A,B,X,0);
3370:   if (!A->ops->matsolve) {
3371:     PetscInfo1(A,"Mat type %s using basic MatMatSolve\n",((PetscObject)A)->type_name);
3372:     MatMatSolve_Basic(A,B,X,PETSC_FALSE);
3373:   } else {
3374:     (*A->ops->matsolve)(A,B,X);
3375:   }
3376:   PetscLogEventEnd(MAT_MatSolve,A,B,X,0);
3377:   PetscObjectStateIncrease((PetscObject)X);
3378:   return(0);
3379: }

3381: /*@
3382:    MatMatSolveTranspose - Solves A^T X = B, given a factored matrix.

3384:    Neighbor-wise Collective on Mat

3386:    Input Parameters:
3387: +  A - the factored matrix
3388: -  B - the right-hand-side matrix  (dense matrix)

3390:    Output Parameter:
3391: .  X - the result matrix (dense matrix)

3393:    Notes:
3394:    The matrices B and X cannot be the same.  I.e., one cannot
3395:    call MatMatSolveTranspose(A,X,X).

3397:    Notes:
3398:    Most users should usually employ the simplified KSP interface for linear solvers
3399:    instead of working directly with matrix algebra routines such as this.
3400:    See, e.g., KSPCreate(). However KSP can only solve for one vector (column of X)
3401:    at a time.

3403:    When using SuperLU_Dist or MUMPS as a parallel solver, PETSc will use their functionality to solve multiple right hand sides simultaneously.

3405:    Level: developer

3407: .seealso: MatMatSolve(), MatLUFactor(), MatCholeskyFactor()
3408: @*/
3409: PetscErrorCode MatMatSolveTranspose(Mat A,Mat B,Mat X)
3410: {

3420:   if (X == B) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_IDN,"X and B must be different matrices");
3421:   if (A->cmap->N != X->rmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Mat A,Mat X: global dim %D %D",A->cmap->N,X->rmap->N);
3422:   if (A->rmap->N != B->rmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Mat A,Mat B: global dim %D %D",A->rmap->N,B->rmap->N);
3423:   if (A->rmap->n != B->rmap->n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat A,Mat B: local dim %D %D",A->rmap->n,B->rmap->n);
3424:   if (X->cmap->N < B->cmap->N) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Solution matrix must have same number of columns as rhs matrix");
3425:   if (!A->rmap->N && !A->cmap->N) return(0);
3426:   if (!A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3427:   MatCheckPreallocated(A,1);

3429:   PetscLogEventBegin(MAT_MatSolve,A,B,X,0);
3430:   if (!A->ops->matsolvetranspose) {
3431:     PetscInfo1(A,"Mat type %s using basic MatMatSolveTranspose\n",((PetscObject)A)->type_name);
3432:     MatMatSolve_Basic(A,B,X,PETSC_TRUE);
3433:   } else {
3434:     (*A->ops->matsolvetranspose)(A,B,X);
3435:   }
3436:   PetscLogEventEnd(MAT_MatSolve,A,B,X,0);
3437:   PetscObjectStateIncrease((PetscObject)X);
3438:   return(0);
3439: }

3441: /*@
3442:    MatMatTransposeSolve - Solves A X = B^T, given a factored matrix.

3444:    Neighbor-wise Collective on Mat

3446:    Input Parameters:
3447: +  A - the factored matrix
3448: -  Bt - the transpose of right-hand-side matrix

3450:    Output Parameter:
3451: .  X - the result matrix (dense matrix)

3453:    Notes:
3454:    Most users should usually employ the simplified KSP interface for linear solvers
3455:    instead of working directly with matrix algebra routines such as this.
3456:    See, e.g., KSPCreate(). However KSP can only solve for one vector (column of X)
3457:    at a time.

3459:    For MUMPS, it only supports centralized sparse compressed column format on the host processor for right hand side matrix. User must create B^T in sparse compressed row format on the host processor and call MatMatTransposeSolve() to implement MUMPS' MatMatSolve().

3461:    Level: developer

3463: .seealso: MatMatSolve(), MatMatSolveTranspose(), MatLUFactor(), MatCholeskyFactor()
3464: @*/
3465: PetscErrorCode MatMatTransposeSolve(Mat A,Mat Bt,Mat X)
3466: {


3477:   if (X == Bt) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_IDN,"X and B must be different matrices");
3478:   if (A->cmap->N != X->rmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Mat A,Mat X: global dim %D %D",A->cmap->N,X->rmap->N);
3479:   if (A->rmap->N != Bt->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Mat A,Mat Bt: global dim %D %D",A->rmap->N,Bt->cmap->N);
3480:   if (X->cmap->N < Bt->rmap->N) SETERRQ(PetscObjectComm((PetscObject)X),PETSC_ERR_ARG_SIZ,"Solution matrix must have same number of columns as row number of the rhs matrix");
3481:   if (!A->rmap->N && !A->cmap->N) return(0);
3482:   if (!A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3483:   MatCheckPreallocated(A,1);

3485:   if (!A->ops->mattransposesolve) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Mat type %s",((PetscObject)A)->type_name);
3486:   PetscLogEventBegin(MAT_MatTrSolve,A,Bt,X,0);
3487:   (*A->ops->mattransposesolve)(A,Bt,X);
3488:   PetscLogEventEnd(MAT_MatTrSolve,A,Bt,X,0);
3489:   PetscObjectStateIncrease((PetscObject)X);
3490:   return(0);
3491: }

3493: /*@
3494:    MatForwardSolve - Solves L x = b, given a factored matrix, A = LU, or
3495:                             U^T*D^(1/2) x = b, given a factored symmetric matrix, A = U^T*D*U,

3497:    Neighbor-wise Collective on Mat

3499:    Input Parameters:
3500: +  mat - the factored matrix
3501: -  b - the right-hand-side vector

3503:    Output Parameter:
3504: .  x - the result vector

3506:    Notes:
3507:    MatSolve() should be used for most applications, as it performs
3508:    a forward solve followed by a backward solve.

3510:    The vectors b and x cannot be the same,  i.e., one cannot
3511:    call MatForwardSolve(A,x,x).

3513:    For matrix in seqsbaij format with block size larger than 1,
3514:    the diagonal blocks are not implemented as D = D^(1/2) * D^(1/2) yet.
3515:    MatForwardSolve() solves U^T*D y = b, and
3516:    MatBackwardSolve() solves U x = y.
3517:    Thus they do not provide a symmetric preconditioner.

3519:    Most users should employ the simplified KSP interface for linear solvers
3520:    instead of working directly with matrix algebra routines such as this.
3521:    See, e.g., KSPCreate().

3523:    Level: developer

3525: .seealso: MatSolve(), MatBackwardSolve()
3526: @*/
3527: PetscErrorCode MatForwardSolve(Mat mat,Vec b,Vec x)
3528: {

3538:   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3539:   if (mat->cmap->N != x->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap->N,x->map->N);
3540:   if (mat->rmap->N != b->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: global dim %D %D",mat->rmap->N,b->map->N);
3541:   if (mat->rmap->n != b->map->n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: local dim %D %D",mat->rmap->n,b->map->n);
3542:   if (!mat->rmap->N && !mat->cmap->N) return(0);
3543:   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3544:   MatCheckPreallocated(mat,1);

3546:   if (!mat->ops->forwardsolve) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3547:   PetscLogEventBegin(MAT_ForwardSolve,mat,b,x,0);
3548:   (*mat->ops->forwardsolve)(mat,b,x);
3549:   PetscLogEventEnd(MAT_ForwardSolve,mat,b,x,0);
3550:   PetscObjectStateIncrease((PetscObject)x);
3551:   return(0);
3552: }

3554: /*@
3555:    MatBackwardSolve - Solves U x = b, given a factored matrix, A = LU.
3556:                              D^(1/2) U x = b, given a factored symmetric matrix, A = U^T*D*U,

3558:    Neighbor-wise Collective on Mat

3560:    Input Parameters:
3561: +  mat - the factored matrix
3562: -  b - the right-hand-side vector

3564:    Output Parameter:
3565: .  x - the result vector

3567:    Notes:
3568:    MatSolve() should be used for most applications, as it performs
3569:    a forward solve followed by a backward solve.

3571:    The vectors b and x cannot be the same.  I.e., one cannot
3572:    call MatBackwardSolve(A,x,x).

3574:    For matrix in seqsbaij format with block size larger than 1,
3575:    the diagonal blocks are not implemented as D = D^(1/2) * D^(1/2) yet.
3576:    MatForwardSolve() solves U^T*D y = b, and
3577:    MatBackwardSolve() solves U x = y.
3578:    Thus they do not provide a symmetric preconditioner.

3580:    Most users should employ the simplified KSP interface for linear solvers
3581:    instead of working directly with matrix algebra routines such as this.
3582:    See, e.g., KSPCreate().

3584:    Level: developer

3586: .seealso: MatSolve(), MatForwardSolve()
3587: @*/
3588: PetscErrorCode MatBackwardSolve(Mat mat,Vec b,Vec x)
3589: {

3599:   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3600:   if (mat->cmap->N != x->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap->N,x->map->N);
3601:   if (mat->rmap->N != b->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: global dim %D %D",mat->rmap->N,b->map->N);
3602:   if (mat->rmap->n != b->map->n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: local dim %D %D",mat->rmap->n,b->map->n);
3603:   if (!mat->rmap->N && !mat->cmap->N) return(0);
3604:   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3605:   MatCheckPreallocated(mat,1);

3607:   if (!mat->ops->backwardsolve) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3608:   PetscLogEventBegin(MAT_BackwardSolve,mat,b,x,0);
3609:   (*mat->ops->backwardsolve)(mat,b,x);
3610:   PetscLogEventEnd(MAT_BackwardSolve,mat,b,x,0);
3611:   PetscObjectStateIncrease((PetscObject)x);
3612:   return(0);
3613: }

3615: /*@
3616:    MatSolveAdd - Computes x = y + inv(A)*b, given a factored matrix.

3618:    Neighbor-wise Collective on Mat

3620:    Input Parameters:
3621: +  mat - the factored matrix
3622: .  b - the right-hand-side vector
3623: -  y - the vector to be added to

3625:    Output Parameter:
3626: .  x - the result vector

3628:    Notes:
3629:    The vectors b and x cannot be the same.  I.e., one cannot
3630:    call MatSolveAdd(A,x,y,x).

3632:    Most users should employ the simplified KSP interface for linear solvers
3633:    instead of working directly with matrix algebra routines such as this.
3634:    See, e.g., KSPCreate().

3636:    Level: developer

3638: .seealso: MatSolve(), MatSolveTranspose(), MatSolveTransposeAdd()
3639: @*/
3640: PetscErrorCode MatSolveAdd(Mat mat,Vec b,Vec y,Vec x)
3641: {
3642:   PetscScalar    one = 1.0;
3643:   Vec            tmp;

3655:   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3656:   if (mat->cmap->N != x->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap->N,x->map->N);
3657:   if (mat->rmap->N != b->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: global dim %D %D",mat->rmap->N,b->map->N);
3658:   if (mat->rmap->N != y->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: global dim %D %D",mat->rmap->N,y->map->N);
3659:   if (mat->rmap->n != b->map->n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: local dim %D %D",mat->rmap->n,b->map->n);
3660:   if (x->map->n != y->map->n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Vec x,Vec y: local dim %D %D",x->map->n,y->map->n);
3661:   if (!mat->rmap->N && !mat->cmap->N) return(0);
3662:   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3663:   MatCheckPreallocated(mat,1);

3665:   PetscLogEventBegin(MAT_SolveAdd,mat,b,x,y);
3666:   if (mat->ops->solveadd) {
3667:     (*mat->ops->solveadd)(mat,b,y,x);
3668:   } else {
3669:     /* do the solve then the add manually */
3670:     if (x != y) {
3671:       MatSolve(mat,b,x);
3672:       VecAXPY(x,one,y);
3673:     } else {
3674:       VecDuplicate(x,&tmp);
3675:       PetscLogObjectParent((PetscObject)mat,(PetscObject)tmp);
3676:       VecCopy(x,tmp);
3677:       MatSolve(mat,b,x);
3678:       VecAXPY(x,one,tmp);
3679:       VecDestroy(&tmp);
3680:     }
3681:   }
3682:   PetscLogEventEnd(MAT_SolveAdd,mat,b,x,y);
3683:   PetscObjectStateIncrease((PetscObject)x);
3684:   return(0);
3685: }

3687: /*@
3688:    MatSolveTranspose - Solves A' x = b, given a factored matrix.

3690:    Neighbor-wise Collective on Mat

3692:    Input Parameters:
3693: +  mat - the factored matrix
3694: -  b - the right-hand-side vector

3696:    Output Parameter:
3697: .  x - the result vector

3699:    Notes:
3700:    The vectors b and x cannot be the same.  I.e., one cannot
3701:    call MatSolveTranspose(A,x,x).

3703:    Most users should employ the simplified KSP interface for linear solvers
3704:    instead of working directly with matrix algebra routines such as this.
3705:    See, e.g., KSPCreate().

3707:    Level: developer

3709: .seealso: MatSolve(), MatSolveAdd(), MatSolveTransposeAdd()
3710: @*/
3711: PetscErrorCode MatSolveTranspose(Mat mat,Vec b,Vec x)
3712: {

3722:   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3723:   if (mat->rmap->N != x->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->rmap->N,x->map->N);
3724:   if (mat->cmap->N != b->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: global dim %D %D",mat->cmap->N,b->map->N);
3725:   if (!mat->rmap->N && !mat->cmap->N) return(0);
3726:   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3727:   MatCheckPreallocated(mat,1);
3728:   PetscLogEventBegin(MAT_SolveTranspose,mat,b,x,0);
3729:   if (mat->factorerrortype) {
3730:     PetscInfo1(mat,"MatFactorError %D\n",mat->factorerrortype);
3731:     VecSetInf(x);
3732:   } else {
3733:     if (!mat->ops->solvetranspose) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s",((PetscObject)mat)->type_name);
3734:     (*mat->ops->solvetranspose)(mat,b,x);
3735:   }
3736:   PetscLogEventEnd(MAT_SolveTranspose,mat,b,x,0);
3737:   PetscObjectStateIncrease((PetscObject)x);
3738:   return(0);
3739: }

3741: /*@
3742:    MatSolveTransposeAdd - Computes x = y + inv(Transpose(A)) b, given a
3743:                       factored matrix.

3745:    Neighbor-wise Collective on Mat

3747:    Input Parameters:
3748: +  mat - the factored matrix
3749: .  b - the right-hand-side vector
3750: -  y - the vector to be added to

3752:    Output Parameter:
3753: .  x - the result vector

3755:    Notes:
3756:    The vectors b and x cannot be the same.  I.e., one cannot
3757:    call MatSolveTransposeAdd(A,x,y,x).

3759:    Most users should employ the simplified KSP interface for linear solvers
3760:    instead of working directly with matrix algebra routines such as this.
3761:    See, e.g., KSPCreate().

3763:    Level: developer

3765: .seealso: MatSolve(), MatSolveAdd(), MatSolveTranspose()
3766: @*/
3767: PetscErrorCode MatSolveTransposeAdd(Mat mat,Vec b,Vec y,Vec x)
3768: {
3769:   PetscScalar    one = 1.0;
3771:   Vec            tmp;

3782:   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3783:   if (mat->rmap->N != x->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->rmap->N,x->map->N);
3784:   if (mat->cmap->N != b->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: global dim %D %D",mat->cmap->N,b->map->N);
3785:   if (mat->cmap->N != y->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: global dim %D %D",mat->cmap->N,y->map->N);
3786:   if (x->map->n != y->map->n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Vec x,Vec y: local dim %D %D",x->map->n,y->map->n);
3787:   if (!mat->rmap->N && !mat->cmap->N) return(0);
3788:   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3789:   MatCheckPreallocated(mat,1);

3791:   PetscLogEventBegin(MAT_SolveTransposeAdd,mat,b,x,y);
3792:   if (mat->ops->solvetransposeadd) {
3793:     if (mat->factorerrortype) {
3794:       PetscInfo1(mat,"MatFactorError %D\n",mat->factorerrortype);
3795:       VecSetInf(x);
3796:     } else {
3797:       (*mat->ops->solvetransposeadd)(mat,b,y,x);
3798:     }
3799:   } else {
3800:     /* do the solve then the add manually */
3801:     if (x != y) {
3802:       MatSolveTranspose(mat,b,x);
3803:       VecAXPY(x,one,y);
3804:     } else {
3805:       VecDuplicate(x,&tmp);
3806:       PetscLogObjectParent((PetscObject)mat,(PetscObject)tmp);
3807:       VecCopy(x,tmp);
3808:       MatSolveTranspose(mat,b,x);
3809:       VecAXPY(x,one,tmp);
3810:       VecDestroy(&tmp);
3811:     }
3812:   }
3813:   PetscLogEventEnd(MAT_SolveTransposeAdd,mat,b,x,y);
3814:   PetscObjectStateIncrease((PetscObject)x);
3815:   return(0);
3816: }
3817: /* ----------------------------------------------------------------*/

3819: /*@
3820:    MatSOR - Computes relaxation (SOR, Gauss-Seidel) sweeps.

3822:    Neighbor-wise Collective on Mat

3824:    Input Parameters:
3825: +  mat - the matrix
3826: .  b - the right hand side
3827: .  omega - the relaxation factor
3828: .  flag - flag indicating the type of SOR (see below)
3829: .  shift -  diagonal shift
3830: .  its - the number of iterations
3831: -  lits - the number of local iterations

3833:    Output Parameters:
3834: .  x - the solution (can contain an initial guess, use option SOR_ZERO_INITIAL_GUESS to indicate no guess)

3836:    SOR Flags:
3837: +     SOR_FORWARD_SWEEP - forward SOR
3838: .     SOR_BACKWARD_SWEEP - backward SOR
3839: .     SOR_SYMMETRIC_SWEEP - SSOR (symmetric SOR)
3840: .     SOR_LOCAL_FORWARD_SWEEP - local forward SOR
3841: .     SOR_LOCAL_BACKWARD_SWEEP - local forward SOR
3842: .     SOR_LOCAL_SYMMETRIC_SWEEP - local SSOR
3843: .     SOR_APPLY_UPPER, SOR_APPLY_LOWER - applies
3844:          upper/lower triangular part of matrix to
3845:          vector (with omega)
3846: -     SOR_ZERO_INITIAL_GUESS - zero initial guess

3848:    Notes:
3849:    SOR_LOCAL_FORWARD_SWEEP, SOR_LOCAL_BACKWARD_SWEEP, and
3850:    SOR_LOCAL_SYMMETRIC_SWEEP perform separate independent smoothings
3851:    on each processor.

3853:    Application programmers will not generally use MatSOR() directly,
3854:    but instead will employ the KSP/PC interface.

3856:    Notes:
3857:     for BAIJ, SBAIJ, and AIJ matrices with Inodes this does a block SOR smoothing, otherwise it does a pointwise smoothing

3859:    Notes for Advanced Users:
3860:    The flags are implemented as bitwise inclusive or operations.
3861:    For example, use (SOR_ZERO_INITIAL_GUESS | SOR_SYMMETRIC_SWEEP)
3862:    to specify a zero initial guess for SSOR.

3864:    Most users should employ the simplified KSP interface for linear solvers
3865:    instead of working directly with matrix algebra routines such as this.
3866:    See, e.g., KSPCreate().

3868:    Vectors x and b CANNOT be the same

3870:    Developer Note: We should add block SOR support for AIJ matrices with block size set to great than one and no inodes

3872:    Level: developer

3874: @*/
3875: PetscErrorCode MatSOR(Mat mat,Vec b,PetscReal omega,MatSORType flag,PetscReal shift,PetscInt its,PetscInt lits,Vec x)
3876: {

3886:   if (!mat->ops->sor) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3887:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3888:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3889:   if (mat->cmap->N != x->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap->N,x->map->N);
3890:   if (mat->rmap->N != b->map->N) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: global dim %D %D",mat->rmap->N,b->map->N);
3891:   if (mat->rmap->n != b->map->n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: local dim %D %D",mat->rmap->n,b->map->n);
3892:   if (its <= 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Relaxation requires global its %D positive",its);
3893:   if (lits <= 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Relaxation requires local its %D positive",lits);
3894:   if (b == x) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"b and x vector cannot be the same");

3896:   MatCheckPreallocated(mat,1);
3897:   PetscLogEventBegin(MAT_SOR,mat,b,x,0);
3898:   ierr =(*mat->ops->sor)(mat,b,omega,flag,shift,its,lits,x);
3899:   PetscLogEventEnd(MAT_SOR,mat,b,x,0);
3900:   PetscObjectStateIncrease((PetscObject)x);
3901:   return(0);
3902: }

3904: /*
3905:       Default matrix copy routine.
3906: */
3907: PetscErrorCode MatCopy_Basic(Mat A,Mat B,MatStructure str)
3908: {
3909:   PetscErrorCode    ierr;
3910:   PetscInt          i,rstart = 0,rend = 0,nz;
3911:   const PetscInt    *cwork;
3912:   const PetscScalar *vwork;

3915:   if (B->assembled) {
3916:     MatZeroEntries(B);
3917:   }
3918:   if (str == SAME_NONZERO_PATTERN) {
3919:     MatGetOwnershipRange(A,&rstart,&rend);
3920:     for (i=rstart; i<rend; i++) {
3921:       MatGetRow(A,i,&nz,&cwork,&vwork);
3922:       MatSetValues(B,1,&i,nz,cwork,vwork,INSERT_VALUES);
3923:       MatRestoreRow(A,i,&nz,&cwork,&vwork);
3924:     }
3925:   } else {
3926:     MatAYPX(B,0.0,A,str);
3927:   }
3928:   MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);
3929:   MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);
3930:   return(0);
3931: }

3933: /*@
3934:    MatCopy - Copies a matrix to another matrix.

3936:    Collective on Mat

3938:    Input Parameters:
3939: +  A - the matrix
3940: -  str - SAME_NONZERO_PATTERN or DIFFERENT_NONZERO_PATTERN

3942:    Output Parameter:
3943: .  B - where the copy is put

3945:    Notes:
3946:    If you use SAME_NONZERO_PATTERN then the two matrices had better have the
3947:    same nonzero pattern or the routine will crash.

3949:    MatCopy() copies the matrix entries of a matrix to another existing
3950:    matrix (after first zeroing the second matrix).  A related routine is
3951:    MatConvert(), which first creates a new matrix and then copies the data.

3953:    Level: intermediate

3955: .seealso: MatConvert(), MatDuplicate()

3957: @*/
3958: PetscErrorCode MatCopy(Mat A,Mat B,MatStructure str)
3959: {
3961:   PetscInt       i;

3969:   MatCheckPreallocated(B,2);
3970:   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3971:   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3972:   if (A->rmap->N != B->rmap->N || A->cmap->N != B->cmap->N) SETERRQ4(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Mat A,Mat B: global dim (%D,%D) (%D,%D)",A->rmap->N,B->rmap->N,A->cmap->N,B->cmap->N);
3973:   MatCheckPreallocated(A,1);
3974:   if (A == B) return(0);

3976:   PetscLogEventBegin(MAT_Copy,A,B,0,0);
3977:   if (A->ops->copy) {
3978:     (*A->ops->copy)(A,B,str);
3979:   } else { /* generic conversion */
3980:     MatCopy_Basic(A,B,str);
3981:   }

3983:   B->stencil.dim = A->stencil.dim;
3984:   B->stencil.noc = A->stencil.noc;
3985:   for (i=0; i<=A->stencil.dim; i++) {
3986:     B->stencil.dims[i]   = A->stencil.dims[i];
3987:     B->stencil.starts[i] = A->stencil.starts[i];
3988:   }

3990:   PetscLogEventEnd(MAT_Copy,A,B,0,0);
3991:   PetscObjectStateIncrease((PetscObject)B);
3992:   return(0);
3993: }

3995: /*@C
3996:    MatConvert - Converts a matrix to another matrix, either of the same
3997:    or different type.

3999:    Collective on Mat

4001:    Input Parameters:
4002: +  mat - the matrix
4003: .  newtype - new matrix type.  Use MATSAME to create a new matrix of the
4004:    same type as the original matrix.
4005: -  reuse - denotes if the destination matrix is to be created or reused.
4006:    Use MAT_INPLACE_MATRIX for inplace conversion (that is when you want the input mat to be changed to contain the matrix in the new format), otherwise use
4007:    MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX (can only be used after the first call was made with MAT_INITIAL_MATRIX, causes the matrix space in M to be reused).

4009:    Output Parameter:
4010: .  M - pointer to place new matrix

4012:    Notes:
4013:    MatConvert() first creates a new matrix and then copies the data from
4014:    the first matrix.  A related routine is MatCopy(), which copies the matrix
4015:    entries of one matrix to another already existing matrix context.

4017:    Cannot be used to convert a sequential matrix to parallel or parallel to sequential,
4018:    the MPI communicator of the generated matrix is always the same as the communicator
4019:    of the input matrix.

4021:    Level: intermediate

4023: .seealso: MatCopy(), MatDuplicate()
4024: @*/
4025: PetscErrorCode MatConvert(Mat mat, MatType newtype,MatReuse reuse,Mat *M)
4026: {
4028:   PetscBool      sametype,issame,flg;
4029:   char           convname[256],mtype[256];
4030:   Mat            B;

4036:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4037:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4038:   MatCheckPreallocated(mat,1);

4040:   PetscOptionsGetString(((PetscObject)mat)->options,((PetscObject)mat)->prefix,"-matconvert_type",mtype,256,&flg);
4041:   if (flg) newtype = mtype;

4043:   PetscObjectTypeCompare((PetscObject)mat,newtype,&sametype);
4044:   PetscStrcmp(newtype,"same",&issame);
4045:   if ((reuse == MAT_INPLACE_MATRIX) && (mat != *M)) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"MAT_INPLACE_MATRIX requires same input and output matrix");
4046:   if ((reuse == MAT_REUSE_MATRIX) && (mat == *M)) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"MAT_REUSE_MATRIX means reuse matrix in final argument, perhaps you mean MAT_INPLACE_MATRIX");

4048:   if ((reuse == MAT_INPLACE_MATRIX) && (issame || sametype)) {
4049:     PetscInfo3(mat,"Early return for inplace %s %d %d\n",((PetscObject)mat)->type_name,sametype,issame);
4050:     return(0);
4051:   }

4053:   if ((sametype || issame) && (reuse==MAT_INITIAL_MATRIX) && mat->ops->duplicate) {
4054:     PetscInfo3(mat,"Calling duplicate for initial matrix %s %d %d\n",((PetscObject)mat)->type_name,sametype,issame);
4055:     (*mat->ops->duplicate)(mat,MAT_COPY_VALUES,M);
4056:   } else {
4057:     PetscErrorCode (*conv)(Mat, MatType,MatReuse,Mat*)=NULL;
4058:     const char     *prefix[3] = {"seq","mpi",""};
4059:     PetscInt       i;
4060:     /*
4061:        Order of precedence:
4062:        0) See if newtype is a superclass of the current matrix.
4063:        1) See if a specialized converter is known to the current matrix.
4064:        2) See if a specialized converter is known to the desired matrix class.
4065:        3) See if a good general converter is registered for the desired class
4066:           (as of 6/27/03 only MATMPIADJ falls into this category).
4067:        4) See if a good general converter is known for the current matrix.
4068:        5) Use a really basic converter.
4069:     */

4071:     /* 0) See if newtype is a superclass of the current matrix.
4072:           i.e mat is mpiaij and newtype is aij */
4073:     for (i=0; i<2; i++) {
4074:       PetscStrncpy(convname,prefix[i],sizeof(convname));
4075:       PetscStrlcat(convname,newtype,sizeof(convname));
4076:       PetscStrcmp(convname,((PetscObject)mat)->type_name,&flg);
4077:       PetscInfo3(mat,"Check superclass %s %s -> %d\n",convname,((PetscObject)mat)->type_name,flg);
4078:       if (flg) {
4079:         if (reuse == MAT_INPLACE_MATRIX) {
4080:           return(0);
4081:         } else if (reuse == MAT_INITIAL_MATRIX && mat->ops->duplicate) {
4082:           (*mat->ops->duplicate)(mat,MAT_COPY_VALUES,M);
4083:           return(0);
4084:         } else if (reuse == MAT_REUSE_MATRIX && mat->ops->copy) {
4085:           MatCopy(mat,*M,SAME_NONZERO_PATTERN);
4086:           return(0);
4087:         }
4088:       }
4089:     }
4090:     /* 1) See if a specialized converter is known to the current matrix and the desired class */
4091:     for (i=0; i<3; i++) {
4092:       PetscStrncpy(convname,"MatConvert_",sizeof(convname));
4093:       PetscStrlcat(convname,((PetscObject)mat)->type_name,sizeof(convname));
4094:       PetscStrlcat(convname,"_",sizeof(convname));
4095:       PetscStrlcat(convname,prefix[i],sizeof(convname));
4096:       PetscStrlcat(convname,issame ? ((PetscObject)mat)->type_name : newtype,sizeof(convname));
4097:       PetscStrlcat(convname,"_C",sizeof(convname));
4098:       PetscObjectQueryFunction((PetscObject)mat,convname,&conv);
4099:       PetscInfo3(mat,"Check specialized (1) %s (%s) -> %d\n",convname,((PetscObject)mat)->type_name,!!conv);
4100:       if (conv) goto foundconv;
4101:     }

4103:     /* 2)  See if a specialized converter is known to the desired matrix class. */
4104:     MatCreate(PetscObjectComm((PetscObject)mat),&B);
4105:     MatSetSizes(B,mat->rmap->n,mat->cmap->n,mat->rmap->N,mat->cmap->N);
4106:     MatSetType(B,newtype);
4107:     for (i=0; i<3; i++) {
4108:       PetscStrncpy(convname,"MatConvert_",sizeof(convname));
4109:       PetscStrlcat(convname,((PetscObject)mat)->type_name,sizeof(convname));
4110:       PetscStrlcat(convname,"_",sizeof(convname));
4111:       PetscStrlcat(convname,prefix[i],sizeof(convname));
4112:       PetscStrlcat(convname,newtype,sizeof(convname));
4113:       PetscStrlcat(convname,"_C",sizeof(convname));
4114:       PetscObjectQueryFunction((PetscObject)B,convname,&conv);
4115:       PetscInfo3(mat,"Check specialized (2) %s (%s) -> %d\n",convname,((PetscObject)B)->type_name,!!conv);
4116:       if (conv) {
4117:         MatDestroy(&B);
4118:         goto foundconv;
4119:       }
4120:     }

4122:     /* 3) See if a good general converter is registered for the desired class */
4123:     conv = B->ops->convertfrom;
4124:     PetscInfo2(mat,"Check convertfrom (%s) -> %d\n",((PetscObject)B)->type_name,!!conv);
4125:     MatDestroy(&B);
4126:     if (conv) goto foundconv;

4128:     /* 4) See if a good general converter is known for the current matrix */
4129:     if (mat->ops->convert) {
4130:       conv = mat->ops->convert;
4131:     }
4132:     PetscInfo2(mat,"Check general convert (%s) -> %d\n",((PetscObject)mat)->type_name,!!conv);
4133:     if (conv) goto foundconv;

4135:     /* 5) Use a really basic converter. */
4136:     PetscInfo(mat,"Using MatConvert_Basic\n");
4137:     conv = MatConvert_Basic;

4139: foundconv:
4140:     PetscLogEventBegin(MAT_Convert,mat,0,0,0);
4141:     (*conv)(mat,newtype,reuse,M);
4142:     if (mat->rmap->mapping && mat->cmap->mapping && !(*M)->rmap->mapping && !(*M)->cmap->mapping) {
4143:       /* the block sizes must be same if the mappings are copied over */
4144:       (*M)->rmap->bs = mat->rmap->bs;
4145:       (*M)->cmap->bs = mat->cmap->bs;
4146:       PetscObjectReference((PetscObject)mat->rmap->mapping);
4147:       PetscObjectReference((PetscObject)mat->cmap->mapping);
4148:       (*M)->rmap->mapping = mat->rmap->mapping;
4149:       (*M)->cmap->mapping = mat->cmap->mapping;
4150:     }
4151:     (*M)->stencil.dim = mat->stencil.dim;
4152:     (*M)->stencil.noc = mat->stencil.noc;
4153:     for (i=0; i<=mat->stencil.dim; i++) {
4154:       (*M)->stencil.dims[i]   = mat->stencil.dims[i];
4155:       (*M)->stencil.starts[i] = mat->stencil.starts[i];
4156:     }
4157:     PetscLogEventEnd(MAT_Convert,mat,0,0,0);
4158:   }
4159:   PetscObjectStateIncrease((PetscObject)*M);

4161:   /* Copy Mat options */
4162:   if (mat->symmetric) {MatSetOption(*M,MAT_SYMMETRIC,PETSC_TRUE);}
4163:   if (mat->hermitian) {MatSetOption(*M,MAT_HERMITIAN,PETSC_TRUE);}
4164:   return(0);
4165: }

4167: /*@C
4168:    MatFactorGetSolverType - Returns name of the package providing the factorization routines

4170:    Not Collective

4172:    Input Parameter:
4173: .  mat - the matrix, must be a factored matrix

4175:    Output Parameter:
4176: .   type - the string name of the package (do not free this string)

4178:    Notes:
4179:       In Fortran you pass in a empty string and the package name will be copied into it.
4180:     (Make sure the string is long enough)

4182:    Level: intermediate

4184: .seealso: MatCopy(), MatDuplicate(), MatGetFactorAvailable(), MatGetFactor()
4185: @*/
4186: PetscErrorCode MatFactorGetSolverType(Mat mat, MatSolverType *type)
4187: {
4188:   PetscErrorCode ierr, (*conv)(Mat,MatSolverType*);

4193:   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Only for factored matrix");
4194:   PetscObjectQueryFunction((PetscObject)mat,"MatFactorGetSolverType_C",&conv);
4195:   if (!conv) {
4196:     *type = MATSOLVERPETSC;
4197:   } else {
4198:     (*conv)(mat,type);
4199:   }
4200:   return(0);
4201: }

4203: typedef struct _MatSolverTypeForSpecifcType* MatSolverTypeForSpecifcType;
4204: struct _MatSolverTypeForSpecifcType {
4205:   MatType                        mtype;
4206:   PetscErrorCode                 (*getfactor[4])(Mat,MatFactorType,Mat*);
4207:   MatSolverTypeForSpecifcType next;
4208: };

4210: typedef struct _MatSolverTypeHolder* MatSolverTypeHolder;
4211: struct _MatSolverTypeHolder {
4212:   char                           *name;
4213:   MatSolverTypeForSpecifcType handlers;
4214:   MatSolverTypeHolder         next;
4215: };

4217: static MatSolverTypeHolder MatSolverTypeHolders = NULL;

4219: /*@C
4220:    MatSolvePackageRegister - Registers a MatSolverType that works for a particular matrix type

4222:    Input Parameters:
4223: +    package - name of the package, for example petsc or superlu
4224: .    mtype - the matrix type that works with this package
4225: .    ftype - the type of factorization supported by the package
4226: -    getfactor - routine that will create the factored matrix ready to be used

4228:     Level: intermediate

4230: .seealso: MatCopy(), MatDuplicate(), MatGetFactorAvailable()
4231: @*/
4232: PetscErrorCode MatSolverTypeRegister(MatSolverType package,MatType mtype,MatFactorType ftype,PetscErrorCode (*getfactor)(Mat,MatFactorType,Mat*))
4233: {
4234:   PetscErrorCode              ierr;
4235:   MatSolverTypeHolder         next = MatSolverTypeHolders,prev = NULL;
4236:   PetscBool                   flg;
4237:   MatSolverTypeForSpecifcType inext,iprev = NULL;

4240:   MatInitializePackage();
4241:   if (!next) {
4242:     PetscNew(&MatSolverTypeHolders);
4243:     PetscStrallocpy(package,&MatSolverTypeHolders->name);
4244:     PetscNew(&MatSolverTypeHolders->handlers);
4245:     PetscStrallocpy(mtype,(char **)&MatSolverTypeHolders->handlers->mtype);
4246:     MatSolverTypeHolders->handlers->getfactor[(int)ftype-1] = getfactor;
4247:     return(0);
4248:   }
4249:   while (next) {
4250:     PetscStrcasecmp(package,next->name,&flg);
4251:     if (flg) {
4252:       if (!next->handlers) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"MatSolverTypeHolder is missing handlers");
4253:       inext = next->handlers;
4254:       while (inext) {
4255:         PetscStrcasecmp(mtype,inext->mtype,&flg);
4256:         if (flg) {
4257:           inext->getfactor[(int)ftype-1] = getfactor;
4258:           return(0);
4259:         }
4260:         iprev = inext;
4261:         inext = inext->next;
4262:       }
4263:       PetscNew(&iprev->next);
4264:       PetscStrallocpy(mtype,(char **)&iprev->next->mtype);
4265:       iprev->next->getfactor[(int)ftype-1] = getfactor;
4266:       return(0);
4267:     }
4268:     prev = next;
4269:     next = next->next;
4270:   }
4271:   PetscNew(&prev->next);
4272:   PetscStrallocpy(package,&prev->next->name);
4273:   PetscNew(&prev->next->handlers);
4274:   PetscStrallocpy(mtype,(char **)&prev->next->handlers->mtype);
4275:   prev->next->handlers->getfactor[(int)ftype-1] = getfactor;
4276:   return(0);
4277: }

4279: /*@C
4280:    MatSolvePackageGet - Get's the function that creates the factor matrix if it exist

4282:    Input Parameters:
4283: +    package - name of the package, for example petsc or superlu
4284: .    ftype - the type of factorization supported by the package
4285: -    mtype - the matrix type that works with this package

4287:    Output Parameters:
4288: +   foundpackage - PETSC_TRUE if the package was registered
4289: .   foundmtype - PETSC_TRUE if the package supports the requested mtype
4290: -   getfactor - routine that will create the factored matrix ready to be used or NULL if not found

4292:     Level: intermediate

4294: .seealso: MatCopy(), MatDuplicate(), MatGetFactorAvailable()
4295: @*/
4296: PetscErrorCode MatSolverTypeGet(MatSolverType package,MatType mtype,MatFactorType ftype,PetscBool *foundpackage,PetscBool *foundmtype,PetscErrorCode (**getfactor)(Mat,MatFactorType,Mat*))
4297: {
4298:   PetscErrorCode                 ierr;
4299:   MatSolverTypeHolder         next = MatSolverTypeHolders;
4300:   PetscBool                      flg;
4301:   MatSolverTypeForSpecifcType inext;

4304:   if (foundpackage) *foundpackage = PETSC_FALSE;
4305:   if (foundmtype)   *foundmtype   = PETSC_FALSE;
4306:   if (getfactor)    *getfactor    = NULL;

4308:   if (package) {
4309:     while (next) {
4310:       PetscStrcasecmp(package,next->name,&flg);
4311:       if (flg) {
4312:         if (foundpackage) *foundpackage = PETSC_TRUE;
4313:         inext = next->handlers;
4314:         while (inext) {
4315:           PetscStrbeginswith(mtype,inext->mtype,&flg);
4316:           if (flg) {
4317:             if (foundmtype) *foundmtype = PETSC_TRUE;
4318:             if (getfactor)  *getfactor  = inext->getfactor[(int)ftype-1];
4319:             return(0);
4320:           }
4321:           inext = inext->next;
4322:         }
4323:       }
4324:       next = next->next;
4325:     }
4326:   } else {
4327:     while (next) {
4328:       inext = next->handlers;
4329:       while (inext) {
4330:         PetscStrbeginswith(mtype,inext->mtype,&flg);
4331:         if (flg && inext->getfactor[(int)ftype-1]) {
4332:           if (foundpackage) *foundpackage = PETSC_TRUE;
4333:           if (foundmtype)   *foundmtype   = PETSC_TRUE;
4334:           if (getfactor)    *getfactor    = inext->getfactor[(int)ftype-1];
4335:           return(0);
4336:         }
4337:         inext = inext->next;
4338:       }
4339:       next = next->next;
4340:     }
4341:   }
4342:   return(0);
4343: }

4345: PetscErrorCode MatSolverTypeDestroy(void)
4346: {
4347:   PetscErrorCode              ierr;
4348:   MatSolverTypeHolder         next = MatSolverTypeHolders,prev;
4349:   MatSolverTypeForSpecifcType inext,iprev;

4352:   while (next) {
4353:     PetscFree(next->name);
4354:     inext = next->handlers;
4355:     while (inext) {
4356:       PetscFree(inext->mtype);
4357:       iprev = inext;
4358:       inext = inext->next;
4359:       PetscFree(iprev);
4360:     }
4361:     prev = next;
4362:     next = next->next;
4363:     PetscFree(prev);
4364:   }
4365:   MatSolverTypeHolders = NULL;
4366:   return(0);
4367: }

4369: /*@C
4370:    MatGetFactor - Returns a matrix suitable to calls to MatXXFactorSymbolic()

4372:    Collective on Mat

4374:    Input Parameters:
4375: +  mat - the matrix
4376: .  type - name of solver type, for example, superlu, petsc (to use PETSc's default)
4377: -  ftype - factor type, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ICC, MAT_FACTOR_ILU,

4379:    Output Parameters:
4380: .  f - the factor matrix used with MatXXFactorSymbolic() calls

4382:    Notes:
4383:       Some PETSc matrix formats have alternative solvers available that are contained in alternative packages
4384:      such as pastix, superlu, mumps etc.

4386:       PETSc must have been ./configure to use the external solver, using the option --download-package

4388:    Level: intermediate

4390: .seealso: MatCopy(), MatDuplicate(), MatGetFactorAvailable()
4391: @*/
4392: PetscErrorCode MatGetFactor(Mat mat, MatSolverType type,MatFactorType ftype,Mat *f)
4393: {
4394:   PetscErrorCode ierr,(*conv)(Mat,MatFactorType,Mat*);
4395:   PetscBool      foundpackage,foundmtype;


4401:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4402:   MatCheckPreallocated(mat,1);

4404:   MatSolverTypeGet(type,((PetscObject)mat)->type_name,ftype,&foundpackage,&foundmtype,&conv);
4405:   if (!foundpackage) {
4406:     if (type) {
4407:       SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_MISSING_FACTOR,"Could not locate solver package %s. Perhaps you must ./configure with --download-%s",type,type);
4408:     } else {
4409:       SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_MISSING_FACTOR,"Could not locate a solver package. Perhaps you must ./configure with --download-<package>");
4410:     }
4411:   }

4413:   if (!foundmtype) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_MISSING_FACTOR,"MatSolverType %s does not support matrix type %s",type,((PetscObject)mat)->type_name);
4414:   if (!conv) SETERRQ3(PetscObjectComm((PetscObject)mat),PETSC_ERR_MISSING_FACTOR,"MatSolverType %s does not support factorization type %s for  matrix type %s",type,MatFactorTypes[ftype],((PetscObject)mat)->type_name);

4416: #if defined(PETSC_USE_COMPLEX)
4417:   if (mat->hermitian && !mat->symmetric && (ftype == MAT_FACTOR_CHOLESKY||ftype == MAT_FACTOR_ICC)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Hermitian CHOLESKY or ICC Factor is not supported");
4418: #endif

4420:   (*conv)(mat,ftype,f);
4421:   return(0);
4422: }

4424: /*@C
4425:    MatGetFactorAvailable - Returns a a flag if matrix supports particular package and factor type

4427:    Not Collective

4429:    Input Parameters:
4430: +  mat - the matrix
4431: .  type - name of solver type, for example, superlu, petsc (to use PETSc's default)
4432: -  ftype - factor type, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ICC, MAT_FACTOR_ILU,

4434:    Output Parameter:
4435: .    flg - PETSC_TRUE if the factorization is available

4437:    Notes:
4438:       Some PETSc matrix formats have alternative solvers available that are contained in alternative packages
4439:      such as pastix, superlu, mumps etc.

4441:       PETSc must have been ./configure to use the external solver, using the option --download-package

4443:    Level: intermediate

4445: .seealso: MatCopy(), MatDuplicate(), MatGetFactor()
4446: @*/
4447: PetscErrorCode MatGetFactorAvailable(Mat mat, MatSolverType type,MatFactorType ftype,PetscBool  *flg)
4448: {
4449:   PetscErrorCode ierr, (*gconv)(Mat,MatFactorType,Mat*);


4455:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4456:   MatCheckPreallocated(mat,1);

4458:   *flg = PETSC_FALSE;
4459:   MatSolverTypeGet(type,((PetscObject)mat)->type_name,ftype,NULL,NULL,&gconv);
4460:   if (gconv) {
4461:     *flg = PETSC_TRUE;
4462:   }
4463:   return(0);
4464: }

4466:  #include <petscdmtypes.h>

4468: /*@
4469:    MatDuplicate - Duplicates a matrix including the non-zero structure.

4471:    Collective on Mat

4473:    Input Parameters:
4474: +  mat - the matrix
4475: -  op - One of MAT_DO_NOT_COPY_VALUES, MAT_COPY_VALUES, or MAT_SHARE_NONZERO_PATTERN.
4476:         See the manual page for MatDuplicateOption for an explanation of these options.

4478:    Output Parameter:
4479: .  M - pointer to place new matrix

4481:    Level: intermediate

4483:    Notes:
4484:     You cannot change the nonzero pattern for the parent or child matrix if you use MAT_SHARE_NONZERO_PATTERN.
4485:     When original mat is a product of matrix operation, e.g., an output of MatMatMult() or MatCreateSubMatrix(), only the simple matrix data structure of mat is duplicated and the internal data structures created for the reuse of previous matrix operations are not duplicated. User should not use MatDuplicate() to create new matrix M if M is intended to be reused as the product of matrix operation.

4487: .seealso: MatCopy(), MatConvert(), MatDuplicateOption
4488: @*/
4489: PetscErrorCode MatDuplicate(Mat mat,MatDuplicateOption op,Mat *M)
4490: {
4492:   Mat            B;
4493:   PetscInt       i;
4494:   DM             dm;
4495:   void           (*viewf)(void);

4501:   if (op == MAT_COPY_VALUES && !mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"MAT_COPY_VALUES not allowed for unassembled matrix");
4502:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4503:   MatCheckPreallocated(mat,1);

4505:   *M = 0;
4506:   if (!mat->ops->duplicate) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Not written for this matrix type");
4507:   PetscLogEventBegin(MAT_Convert,mat,0,0,0);
4508:   (*mat->ops->duplicate)(mat,op,M);
4509:   B    = *M;

4511:   MatGetOperation(mat,MATOP_VIEW,&viewf);
4512:   if (viewf) {
4513:     MatSetOperation(B,MATOP_VIEW,viewf);
4514:   }

4516:   B->stencil.dim = mat->stencil.dim;
4517:   B->stencil.noc = mat->stencil.noc;
4518:   for (i=0; i<=mat->stencil.dim; i++) {
4519:     B->stencil.dims[i]   = mat->stencil.dims[i];
4520:     B->stencil.starts[i] = mat->stencil.starts[i];
4521:   }

4523:   B->nooffproczerorows = mat->nooffproczerorows;
4524:   B->nooffprocentries  = mat->nooffprocentries;

4526:   PetscObjectQuery((PetscObject) mat, "__PETSc_dm", (PetscObject*) &dm);
4527:   if (dm) {
4528:     PetscObjectCompose((PetscObject) B, "__PETSc_dm", (PetscObject) dm);
4529:   }
4530:   PetscLogEventEnd(MAT_Convert,mat,0,0,0);
4531:   PetscObjectStateIncrease((PetscObject)B);
4532:   return(0);
4533: }

4535: /*@
4536:    MatGetDiagonal - Gets the diagonal of a matrix.

4538:    Logically Collective on Mat

4540:    Input Parameters:
4541: +  mat - the matrix
4542: -  v - the vector for storing the diagonal

4544:    Output Parameter:
4545: .  v - the diagonal of the matrix

4547:    Level: intermediate

4549:    Note:
4550:    Currently only correct in parallel for square matrices.

4552: .seealso: MatGetRow(), MatCreateSubMatrices(), MatCreateSubMatrix(), MatGetRowMaxAbs()
4553: @*/
4554: PetscErrorCode MatGetDiagonal(Mat mat,Vec v)
4555: {

4562:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4563:   if (!mat->ops->getdiagonal) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4564:   MatCheckPreallocated(mat,1);

4566:   (*mat->ops->getdiagonal)(mat,v);
4567:   PetscObjectStateIncrease((PetscObject)v);
4568:   return(0);
4569: }

4571: /*@C
4572:    MatGetRowMin - Gets the minimum value (of the real part) of each
4573:         row of the matrix

4575:    Logically Collective on Mat

4577:    Input Parameters:
4578: .  mat - the matrix

4580:    Output Parameter:
4581: +  v - the vector for storing the maximums
4582: -  idx - the indices of the column found for each row (optional)

4584:    Level: intermediate

4586:    Notes:
4587:     The result of this call are the same as if one converted the matrix to dense format
4588:       and found the minimum value in each row (i.e. the implicit zeros are counted as zeros).

4590:     This code is only implemented for a couple of matrix formats.

4592: .seealso: MatGetDiagonal(), MatCreateSubMatrices(), MatCreateSubMatrix(), MatGetRowMaxAbs(),
4593:           MatGetRowMax()
4594: @*/
4595: PetscErrorCode MatGetRowMin(Mat mat,Vec v,PetscInt idx[])
4596: {

4603:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4604:   if (!mat->ops->getrowmax) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4605:   MatCheckPreallocated(mat,1);

4607:   (*mat->ops->getrowmin)(mat,v,idx);
4608:   PetscObjectStateIncrease((PetscObject)v);
4609:   return(0);
4610: }

4612: /*@C
4613:    MatGetRowMinAbs - Gets the minimum value (in absolute value) of each
4614:         row of the matrix

4616:    Logically Collective on Mat

4618:    Input Parameters:
4619: .  mat - the matrix

4621:    Output Parameter:
4622: +  v - the vector for storing the minimums
4623: -  idx - the indices of the column found for each row (or NULL if not needed)

4625:    Level: intermediate

4627:    Notes:
4628:     if a row is completely empty or has only 0.0 values then the idx[] value for that
4629:     row is 0 (the first column).

4631:     This code is only implemented for a couple of matrix formats.

4633: .seealso: MatGetDiagonal(), MatCreateSubMatrices(), MatCreateSubMatrix(), MatGetRowMax(), MatGetRowMaxAbs(), MatGetRowMin()
4634: @*/
4635: PetscErrorCode MatGetRowMinAbs(Mat mat,Vec v,PetscInt idx[])
4636: {

4643:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4644:   if (!mat->ops->getrowminabs) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4645:   MatCheckPreallocated(mat,1);
4646:   if (idx) {PetscArrayzero(idx,mat->rmap->n);}

4648:   (*mat->ops->getrowminabs)(mat,v,idx);
4649:   PetscObjectStateIncrease((PetscObject)v);
4650:   return(0);
4651: }

4653: /*@C
4654:    MatGetRowMax - Gets the maximum value (of the real part) of each
4655:         row of the matrix

4657:    Logically Collective on Mat

4659:    Input Parameters:
4660: .  mat - the matrix

4662:    Output Parameter:
4663: +  v - the vector for storing the maximums
4664: -  idx - the indices of the column found for each row (optional)

4666:    Level: intermediate

4668:    Notes:
4669:     The result of this call are the same as if one converted the matrix to dense format
4670:       and found the minimum value in each row (i.e. the implicit zeros are counted as zeros).

4672:     This code is only implemented for a couple of matrix formats.

4674: .seealso: MatGetDiagonal(), MatCreateSubMatrices(), MatCreateSubMatrix(), MatGetRowMaxAbs(), MatGetRowMin()
4675: @*/
4676: PetscErrorCode MatGetRowMax(Mat mat,Vec v,PetscInt idx[])
4677: {

4684:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4685:   if (!mat->ops->getrowmax) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4686:   MatCheckPreallocated(mat,1);

4688:   (*mat->ops->getrowmax)(mat,v,idx);
4689:   PetscObjectStateIncrease((PetscObject)v);
4690:   return(0);
4691: }

4693: /*@C
4694:    MatGetRowMaxAbs - Gets the maximum value (in absolute value) of each
4695:         row of the matrix

4697:    Logically Collective on Mat

4699:    Input Parameters:
4700: .  mat - the matrix

4702:    Output Parameter:
4703: +  v - the vector for storing the maximums
4704: -  idx - the indices of the column found for each row (or NULL if not needed)

4706:    Level: intermediate

4708:    Notes:
4709:     if a row is completely empty or has only 0.0 values then the idx[] value for that
4710:     row is 0 (the first column).

4712:     This code is only implemented for a couple of matrix formats.

4714: .seealso: MatGetDiagonal(), MatCreateSubMatrices(), MatCreateSubMatrix(), MatGetRowMax(), MatGetRowMin()
4715: @*/
4716: PetscErrorCode MatGetRowMaxAbs(Mat mat,Vec v,PetscInt idx[])
4717: {

4724:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4725:   if (!mat->ops->getrowmaxabs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4726:   MatCheckPreallocated(mat,1);
4727:   if (idx) {PetscArrayzero(idx,mat->rmap->n);}

4729:   (*mat->ops->getrowmaxabs)(mat,v,idx);
4730:   PetscObjectStateIncrease((PetscObject)v);
4731:   return(0);
4732: }

4734: /*@
4735:    MatGetRowSum - Gets the sum of each row of the matrix

4737:    Logically or Neighborhood Collective on Mat

4739:    Input Parameters:
4740: .  mat - the matrix

4742:    Output Parameter:
4743: .  v - the vector for storing the sum of rows

4745:    Level: intermediate

4747:    Notes:
4748:     This code is slow since it is not currently specialized for different formats

4750: .seealso: MatGetDiagonal(), MatCreateSubMatrices(), MatCreateSubMatrix(), MatGetRowMax(), MatGetRowMin()
4751: @*/
4752: PetscErrorCode MatGetRowSum(Mat mat, Vec v)
4753: {
4754:   Vec            ones;

4761:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4762:   MatCheckPreallocated(mat,1);
4763:   MatCreateVecs(mat,&ones,NULL);
4764:   VecSet(ones,1.);
4765:   MatMult(mat,ones,v);
4766:   VecDestroy(&ones);
4767:   return(0);
4768: }

4770: /*@
4771:    MatTranspose - Computes an in-place or out-of-place transpose of a matrix.

4773:    Collective on Mat

4775:    Input Parameter:
4776: +  mat - the matrix to transpose
4777: -  reuse - either MAT_INITIAL_MATRIX, MAT_REUSE_MATRIX, or MAT_INPLACE_MATRIX

4779:    Output Parameters:
4780: .  B - the transpose

4782:    Notes:
4783:      If you use MAT_INPLACE_MATRIX then you must pass in &mat for B

4785:      MAT_REUSE_MATRIX causes the B matrix from a previous call to this function with MAT_INITIAL_MATRIX to be used

4787:      Consider using MatCreateTranspose() instead if you only need a matrix that behaves like the transpose, but don't need the storage to be changed.

4789:    Level: intermediate

4791: .seealso: MatMultTranspose(), MatMultTransposeAdd(), MatIsTranspose(), MatReuse
4792: @*/
4793: PetscErrorCode MatTranspose(Mat mat,MatReuse reuse,Mat *B)
4794: {

4800:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4801:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4802:   if (!mat->ops->transpose) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4803:   if (reuse == MAT_INPLACE_MATRIX && mat != *B) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"MAT_INPLACE_MATRIX requires last matrix to match first");
4804:   if (reuse == MAT_REUSE_MATRIX && mat == *B) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Perhaps you mean MAT_INPLACE_MATRIX");
4805:   MatCheckPreallocated(mat,1);

4807:   PetscLogEventBegin(MAT_Transpose,mat,0,0,0);
4808:   (*mat->ops->transpose)(mat,reuse,B);
4809:   PetscLogEventEnd(MAT_Transpose,mat,0,0,0);
4810:   if (B) {PetscObjectStateIncrease((PetscObject)*B);}
4811:   return(0);
4812: }

4814: /*@
4815:    MatIsTranspose - Test whether a matrix is another one's transpose,
4816:         or its own, in which case it tests symmetry.

4818:    Collective on Mat

4820:    Input Parameter:
4821: +  A - the matrix to test
4822: -  B - the matrix to test against, this can equal the first parameter

4824:    Output Parameters:
4825: .  flg - the result

4827:    Notes:
4828:    Only available for SeqAIJ/MPIAIJ matrices. The sequential algorithm
4829:    has a running time of the order of the number of nonzeros; the parallel
4830:    test involves parallel copies of the block-offdiagonal parts of the matrix.

4832:    Level: intermediate

4834: .seealso: MatTranspose(), MatIsSymmetric(), MatIsHermitian()
4835: @*/
4836: PetscErrorCode MatIsTranspose(Mat A,Mat B,PetscReal tol,PetscBool  *flg)
4837: {
4838:   PetscErrorCode ierr,(*f)(Mat,Mat,PetscReal,PetscBool*),(*g)(Mat,Mat,PetscReal,PetscBool*);

4844:   PetscObjectQueryFunction((PetscObject)A,"MatIsTranspose_C",&f);
4845:   PetscObjectQueryFunction((PetscObject)B,"MatIsTranspose_C",&g);
4846:   *flg = PETSC_FALSE;
4847:   if (f && g) {
4848:     if (f == g) {
4849:       (*f)(A,B,tol,flg);
4850:     } else SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_NOTSAMETYPE,"Matrices do not have the same comparator for symmetry test");
4851:   } else {
4852:     MatType mattype;
4853:     if (!f) {
4854:       MatGetType(A,&mattype);
4855:     } else {
4856:       MatGetType(B,&mattype);
4857:     }
4858:     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Matrix of type <%s> does not support checking for transpose",mattype);
4859:   }
4860:   return(0);
4861: }

4863: /*@
4864:    MatHermitianTranspose - Computes an in-place or out-of-place transpose of a matrix in complex conjugate.

4866:    Collective on Mat

4868:    Input Parameter:
4869: +  mat - the matrix to transpose and complex conjugate
4870: -  reuse - MAT_INITIAL_MATRIX to create a new matrix, MAT_INPLACE_MATRIX to reuse the first argument to store the transpose

4872:    Output Parameters:
4873: .  B - the Hermitian

4875:    Level: intermediate

4877: .seealso: MatTranspose(), MatMultTranspose(), MatMultTransposeAdd(), MatIsTranspose(), MatReuse
4878: @*/
4879: PetscErrorCode MatHermitianTranspose(Mat mat,MatReuse reuse,Mat *B)
4880: {

4884:   MatTranspose(mat,reuse,B);
4885: #if defined(PETSC_USE_COMPLEX)
4886:   MatConjugate(*B);
4887: #endif
4888:   return(0);
4889: }

4891: /*@
4892:    MatIsHermitianTranspose - Test whether a matrix is another one's Hermitian transpose,

4894:    Collective on Mat

4896:    Input Parameter:
4897: +  A - the matrix to test
4898: -  B - the matrix to test against, this can equal the first parameter

4900:    Output Parameters:
4901: .  flg - the result

4903:    Notes:
4904:    Only available for SeqAIJ/MPIAIJ matrices. The sequential algorithm
4905:    has a running time of the order of the number of nonzeros; the parallel
4906:    test involves parallel copies of the block-offdiagonal parts of the matrix.

4908:    Level: intermediate

4910: .seealso: MatTranspose(), MatIsSymmetric(), MatIsHermitian(), MatIsTranspose()
4911: @*/
4912: PetscErrorCode MatIsHermitianTranspose(Mat A,Mat B,PetscReal tol,PetscBool  *flg)
4913: {
4914:   PetscErrorCode ierr,(*f)(Mat,Mat,PetscReal,PetscBool*),(*g)(Mat,Mat,PetscReal,PetscBool*);

4920:   PetscObjectQueryFunction((PetscObject)A,"MatIsHermitianTranspose_C",&f);
4921:   PetscObjectQueryFunction((PetscObject)B,"MatIsHermitianTranspose_C",&g);
4922:   if (f && g) {
4923:     if (f==g) {
4924:       (*f)(A,B,tol,flg);
4925:     } else SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_NOTSAMETYPE,"Matrices do not have the same comparator for Hermitian test");
4926:   }
4927:   return(0);
4928: }

4930: /*@
4931:    MatPermute - Creates a new matrix with rows and columns permuted from the
4932:    original.

4934:    Collective on Mat

4936:    Input Parameters:
4937: +  mat - the matrix to permute
4938: .  row - row permutation, each processor supplies only the permutation for its rows
4939: -  col - column permutation, each processor supplies only the permutation for its columns

4941:    Output Parameters:
4942: .  B - the permuted matrix

4944:    Level: advanced

4946:    Note:
4947:    The index sets map from row/col of permuted matrix to row/col of original matrix.
4948:    The index sets should be on the same communicator as Mat and have the same local sizes.

4950: .seealso: MatGetOrdering(), ISAllGather()

4952: @*/
4953: PetscErrorCode MatPermute(Mat mat,IS row,IS col,Mat *B)
4954: {

4963:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4964:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4965:   if (!mat->ops->permute) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"MatPermute not available for Mat type %s",((PetscObject)mat)->type_name);
4966:   MatCheckPreallocated(mat,1);

4968:   (*mat->ops->permute)(mat,row,col,B);
4969:   PetscObjectStateIncrease((PetscObject)*B);
4970:   return(0);
4971: }

4973: /*@
4974:    MatEqual - Compares two matrices.

4976:    Collective on Mat

4978:    Input Parameters:
4979: +  A - the first matrix
4980: -  B - the second matrix

4982:    Output Parameter:
4983: .  flg - PETSC_TRUE if the matrices are equal; PETSC_FALSE otherwise.

4985:    Level: intermediate

4987: @*/
4988: PetscErrorCode MatEqual(Mat A,Mat B,PetscBool  *flg)
4989: {

4999:   MatCheckPreallocated(B,2);
5000:   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5001:   if (!B->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5002:   if (A->rmap->N != B->rmap->N || A->cmap->N != B->cmap->N) SETERRQ4(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Mat A,Mat B: global dim %D %D %D %D",A->rmap->N,B->rmap->N,A->cmap->N,B->cmap->N);
5003:   if (!A->ops->equal) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Mat type %s",((PetscObject)A)->type_name);
5004:   if (!B->ops->equal) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Mat type %s",((PetscObject)B)->type_name);
5005:   if (A->ops->equal != B->ops->equal) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_INCOMP,"A is type: %s\nB is type: %s",((PetscObject)A)->type_name,((PetscObject)B)->type_name);
5006:   MatCheckPreallocated(A,1);

5008:   (*A->ops->equal)(A,B,flg);
5009:   return(0);
5010: }

5012: /*@
5013:    MatDiagonalScale - Scales a matrix on the left and right by diagonal
5014:    matrices that are stored as vectors.  Either of the two scaling
5015:    matrices can be NULL.

5017:    Collective on Mat

5019:    Input Parameters:
5020: +  mat - the matrix to be scaled
5021: .  l - the left scaling vector (or NULL)
5022: -  r - the right scaling vector (or NULL)

5024:    Notes:
5025:    MatDiagonalScale() computes A = LAR, where
5026:    L = a diagonal matrix (stored as a vector), R = a diagonal matrix (stored as a vector)
5027:    The L scales the rows of the matrix, the R scales the columns of the matrix.

5029:    Level: intermediate


5032: .seealso: MatScale(), MatShift(), MatDiagonalSet()
5033: @*/
5034: PetscErrorCode MatDiagonalScale(Mat mat,Vec l,Vec r)
5035: {

5041:   if (!mat->ops->diagonalscale) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5044:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5045:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5046:   MatCheckPreallocated(mat,1);

5048:   PetscLogEventBegin(MAT_Scale,mat,0,0,0);
5049:   (*mat->ops->diagonalscale)(mat,l,r);
5050:   PetscLogEventEnd(MAT_Scale,mat,0,0,0);
5051:   PetscObjectStateIncrease((PetscObject)mat);
5052:   return(0);
5053: }

5055: /*@
5056:     MatScale - Scales all elements of a matrix by a given number.

5058:     Logically Collective on Mat

5060:     Input Parameters:
5061: +   mat - the matrix to be scaled
5062: -   a  - the scaling value

5064:     Output Parameter:
5065: .   mat - the scaled matrix

5067:     Level: intermediate

5069: .seealso: MatDiagonalScale()
5070: @*/
5071: PetscErrorCode MatScale(Mat mat,PetscScalar a)
5072: {

5078:   if (a != (PetscScalar)1.0 && !mat->ops->scale) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5079:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5080:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5082:   MatCheckPreallocated(mat,1);

5084:   PetscLogEventBegin(MAT_Scale,mat,0,0,0);
5085:   if (a != (PetscScalar)1.0) {
5086:     (*mat->ops->scale)(mat,a);
5087:     PetscObjectStateIncrease((PetscObject)mat);
5088:   }
5089:   PetscLogEventEnd(MAT_Scale,mat,0,0,0);
5090:   return(0);
5091: }

5093: /*@
5094:    MatNorm - Calculates various norms of a matrix.

5096:    Collective on Mat

5098:    Input Parameters:
5099: +  mat - the matrix
5100: -  type - the type of norm, NORM_1, NORM_FROBENIUS, NORM_INFINITY

5102:    Output Parameters:
5103: .  nrm - the resulting norm

5105:    Level: intermediate

5107: @*/
5108: PetscErrorCode MatNorm(Mat mat,NormType type,PetscReal *nrm)
5109: {


5117:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5118:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5119:   if (!mat->ops->norm) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5120:   MatCheckPreallocated(mat,1);

5122:   (*mat->ops->norm)(mat,type,nrm);
5123:   return(0);
5124: }

5126: /*
5127:      This variable is used to prevent counting of MatAssemblyBegin() that
5128:    are called from within a MatAssemblyEnd().
5129: */
5130: static PetscInt MatAssemblyEnd_InUse = 0;
5131: /*@
5132:    MatAssemblyBegin - Begins assembling the matrix.  This routine should
5133:    be called after completing all calls to MatSetValues().

5135:    Collective on Mat

5137:    Input Parameters:
5138: +  mat - the matrix
5139: -  type - type of assembly, either MAT_FLUSH_ASSEMBLY or MAT_FINAL_ASSEMBLY

5141:    Notes:
5142:    MatSetValues() generally caches the values.  The matrix is ready to
5143:    use only after MatAssemblyBegin() and MatAssemblyEnd() have been called.
5144:    Use MAT_FLUSH_ASSEMBLY when switching between ADD_VALUES and INSERT_VALUES
5145:    in MatSetValues(); use MAT_FINAL_ASSEMBLY for the final assembly before
5146:    using the matrix.

5148:    ALL processes that share a matrix MUST call MatAssemblyBegin() and MatAssemblyEnd() the SAME NUMBER of times, and each time with the
5149:    same flag of MAT_FLUSH_ASSEMBLY or MAT_FINAL_ASSEMBLY for all processes. Thus you CANNOT locally change from ADD_VALUES to INSERT_VALUES, that is
5150:    a global collective operation requring all processes that share the matrix.

5152:    Space for preallocated nonzeros that is not filled by a call to MatSetValues() or a related routine are compressed
5153:    out by assembly. If you intend to use that extra space on a subsequent assembly, be sure to insert explicit zeros
5154:    before MAT_FINAL_ASSEMBLY so the space is not compressed out.

5156:    Level: beginner

5158: .seealso: MatAssemblyEnd(), MatSetValues(), MatAssembled()
5159: @*/
5160: PetscErrorCode MatAssemblyBegin(Mat mat,MatAssemblyType type)
5161: {

5167:   MatCheckPreallocated(mat,1);
5168:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix.\nDid you forget to call MatSetUnfactored()?");
5169:   if (mat->assembled) {
5170:     mat->was_assembled = PETSC_TRUE;
5171:     mat->assembled     = PETSC_FALSE;
5172:   }

5174:   if (!MatAssemblyEnd_InUse) {
5175:     PetscLogEventBegin(MAT_AssemblyBegin,mat,0,0,0);
5176:     if (mat->ops->assemblybegin) {(*mat->ops->assemblybegin)(mat,type);}
5177:     PetscLogEventEnd(MAT_AssemblyBegin,mat,0,0,0);
5178:   } else if (mat->ops->assemblybegin) {
5179:     (*mat->ops->assemblybegin)(mat,type);
5180:   }
5181:   return(0);
5182: }

5184: /*@
5185:    MatAssembled - Indicates if a matrix has been assembled and is ready for
5186:      use; for example, in matrix-vector product.

5188:    Not Collective

5190:    Input Parameter:
5191: .  mat - the matrix

5193:    Output Parameter:
5194: .  assembled - PETSC_TRUE or PETSC_FALSE

5196:    Level: advanced

5198: .seealso: MatAssemblyEnd(), MatSetValues(), MatAssemblyBegin()
5199: @*/
5200: PetscErrorCode MatAssembled(Mat mat,PetscBool  *assembled)
5201: {
5205:   *assembled = mat->assembled;
5206:   return(0);
5207: }

5209: /*@
5210:    MatAssemblyEnd - Completes assembling the matrix.  This routine should
5211:    be called after MatAssemblyBegin().

5213:    Collective on Mat

5215:    Input Parameters:
5216: +  mat - the matrix
5217: -  type - type of assembly, either MAT_FLUSH_ASSEMBLY or MAT_FINAL_ASSEMBLY

5219:    Options Database Keys:
5220: +  -mat_view ::ascii_info - Prints info on matrix at conclusion of MatEndAssembly()
5221: .  -mat_view ::ascii_info_detail - Prints more detailed info
5222: .  -mat_view - Prints matrix in ASCII format
5223: .  -mat_view ::ascii_matlab - Prints matrix in Matlab format
5224: .  -mat_view draw - PetscDraws nonzero structure of matrix, using MatView() and PetscDrawOpenX().
5225: .  -display <name> - Sets display name (default is host)
5226: .  -draw_pause <sec> - Sets number of seconds to pause after display
5227: .  -mat_view socket - Sends matrix to socket, can be accessed from Matlab (See Users-Manual: Chapter 12 Using MATLAB with PETSc )
5228: .  -viewer_socket_machine <machine> - Machine to use for socket
5229: .  -viewer_socket_port <port> - Port number to use for socket
5230: -  -mat_view binary:filename[:append] - Save matrix to file in binary format

5232:    Notes:
5233:    MatSetValues() generally caches the values.  The matrix is ready to
5234:    use only after MatAssemblyBegin() and MatAssemblyEnd() have been called.
5235:    Use MAT_FLUSH_ASSEMBLY when switching between ADD_VALUES and INSERT_VALUES
5236:    in MatSetValues(); use MAT_FINAL_ASSEMBLY for the final assembly before
5237:    using the matrix.

5239:    Space for preallocated nonzeros that is not filled by a call to MatSetValues() or a related routine are compressed
5240:    out by assembly. If you intend to use that extra space on a subsequent assembly, be sure to insert explicit zeros
5241:    before MAT_FINAL_ASSEMBLY so the space is not compressed out.

5243:    Level: beginner

5245: .seealso: MatAssemblyBegin(), MatSetValues(), PetscDrawOpenX(), PetscDrawCreate(), MatView(), MatAssembled(), PetscViewerSocketOpen()
5246: @*/
5247: PetscErrorCode MatAssemblyEnd(Mat mat,MatAssemblyType type)
5248: {
5249:   PetscErrorCode  ierr;
5250:   static PetscInt inassm = 0;
5251:   PetscBool       flg    = PETSC_FALSE;


5257:   inassm++;
5258:   MatAssemblyEnd_InUse++;
5259:   if (MatAssemblyEnd_InUse == 1) { /* Do the logging only the first time through */
5260:     PetscLogEventBegin(MAT_AssemblyEnd,mat,0,0,0);
5261:     if (mat->ops->assemblyend) {
5262:       (*mat->ops->assemblyend)(mat,type);
5263:     }
5264:     PetscLogEventEnd(MAT_AssemblyEnd,mat,0,0,0);
5265:   } else if (mat->ops->assemblyend) {
5266:     (*mat->ops->assemblyend)(mat,type);
5267:   }

5269:   /* Flush assembly is not a true assembly */
5270:   if (type != MAT_FLUSH_ASSEMBLY) {
5271:     mat->num_ass++;
5272:     mat->assembled        = PETSC_TRUE;
5273:     mat->ass_nonzerostate = mat->nonzerostate;
5274:   }

5276:   mat->insertmode = NOT_SET_VALUES;
5277:   MatAssemblyEnd_InUse--;
5278:   PetscObjectStateIncrease((PetscObject)mat);
5279:   if (!mat->symmetric_eternal) {
5280:     mat->symmetric_set              = PETSC_FALSE;
5281:     mat->hermitian_set              = PETSC_FALSE;
5282:     mat->structurally_symmetric_set = PETSC_FALSE;
5283:   }
5284:   if (inassm == 1 && type != MAT_FLUSH_ASSEMBLY) {
5285:     MatViewFromOptions(mat,NULL,"-mat_view");

5287:     if (mat->checksymmetryonassembly) {
5288:       MatIsSymmetric(mat,mat->checksymmetrytol,&flg);
5289:       if (flg) {
5290:         PetscPrintf(PetscObjectComm((PetscObject)mat),"Matrix is symmetric (tolerance %g)\n",(double)mat->checksymmetrytol);
5291:       } else {
5292:         PetscPrintf(PetscObjectComm((PetscObject)mat),"Matrix is not symmetric (tolerance %g)\n",(double)mat->checksymmetrytol);
5293:       }
5294:     }
5295:     if (mat->nullsp && mat->checknullspaceonassembly) {
5296:       MatNullSpaceTest(mat->nullsp,mat,NULL);
5297:     }
5298:   }
5299:   inassm--;
5300:   return(0);
5301: }

5303: /*@
5304:    MatSetOption - Sets a parameter option for a matrix. Some options
5305:    may be specific to certain storage formats.  Some options
5306:    determine how values will be inserted (or added). Sorted,
5307:    row-oriented input will generally assemble the fastest. The default
5308:    is row-oriented.

5310:    Logically Collective on Mat for certain operations, such as MAT_SPD, not collective for MAT_ROW_ORIENTED, see MatOption

5312:    Input Parameters:
5313: +  mat - the matrix
5314: .  option - the option, one of those listed below (and possibly others),
5315: -  flg - turn the option on (PETSC_TRUE) or off (PETSC_FALSE)

5317:   Options Describing Matrix Structure:
5318: +    MAT_SPD - symmetric positive definite
5319: .    MAT_SYMMETRIC - symmetric in terms of both structure and value
5320: .    MAT_HERMITIAN - transpose is the complex conjugation
5321: .    MAT_STRUCTURALLY_SYMMETRIC - symmetric nonzero structure
5322: -    MAT_SYMMETRY_ETERNAL - if you would like the symmetry/Hermitian flag
5323:                             you set to be kept with all future use of the matrix
5324:                             including after MatAssemblyBegin/End() which could
5325:                             potentially change the symmetry structure, i.e. you
5326:                             KNOW the matrix will ALWAYS have the property you set.


5329:    Options For Use with MatSetValues():
5330:    Insert a logically dense subblock, which can be
5331: .    MAT_ROW_ORIENTED - row-oriented (default)

5333:    Note these options reflect the data you pass in with MatSetValues(); it has
5334:    nothing to do with how the data is stored internally in the matrix
5335:    data structure.

5337:    When (re)assembling a matrix, we can restrict the input for
5338:    efficiency/debugging purposes.  These options include:
5339: +    MAT_NEW_NONZERO_LOCATIONS - additional insertions will be allowed if they generate a new nonzero (slow)
5340: .    MAT_NEW_DIAGONALS - new diagonals will be allowed (for block diagonal format only)
5341: .    MAT_IGNORE_OFF_PROC_ENTRIES - drops off-processor entries
5342: .    MAT_NEW_NONZERO_LOCATION_ERR - generates an error for new matrix entry
5343: .    MAT_USE_HASH_TABLE - uses a hash table to speed up matrix assembly
5344: .    MAT_NO_OFF_PROC_ENTRIES - you know each process will only set values for its own rows, will generate an error if
5345:         any process sets values for another process. This avoids all reductions in the MatAssembly routines and thus improves
5346:         performance for very large process counts.
5347: -    MAT_SUBSET_OFF_PROC_ENTRIES - you know that the first assembly after setting this flag will set a superset
5348:         of the off-process entries required for all subsequent assemblies. This avoids a rendezvous step in the MatAssembly
5349:         functions, instead sending only neighbor messages.

5351:    Notes:
5352:    Except for MAT_UNUSED_NONZERO_LOCATION_ERR and  MAT_ROW_ORIENTED all processes that share the matrix must pass the same value in flg!

5354:    Some options are relevant only for particular matrix types and
5355:    are thus ignored by others.  Other options are not supported by
5356:    certain matrix types and will generate an error message if set.

5358:    If using a Fortran 77 module to compute a matrix, one may need to
5359:    use the column-oriented option (or convert to the row-oriented
5360:    format).

5362:    MAT_NEW_NONZERO_LOCATIONS set to PETSC_FALSE indicates that any add or insertion
5363:    that would generate a new entry in the nonzero structure is instead
5364:    ignored.  Thus, if memory has not alredy been allocated for this particular
5365:    data, then the insertion is ignored. For dense matrices, in which
5366:    the entire array is allocated, no entries are ever ignored.
5367:    Set after the first MatAssemblyEnd(). If this option is set then the MatAssemblyBegin/End() processes has one less global reduction

5369:    MAT_NEW_NONZERO_LOCATION_ERR set to PETSC_TRUE indicates that any add or insertion
5370:    that would generate a new entry in the nonzero structure instead produces
5371:    an error. (Currently supported for AIJ and BAIJ formats only.) If this option is set then the MatAssemblyBegin/End() processes has one less global reduction

5373:    MAT_NEW_NONZERO_ALLOCATION_ERR set to PETSC_TRUE indicates that any add or insertion
5374:    that would generate a new entry that has not been preallocated will
5375:    instead produce an error. (Currently supported for AIJ and BAIJ formats
5376:    only.) This is a useful flag when debugging matrix memory preallocation.
5377:    If this option is set then the MatAssemblyBegin/End() processes has one less global reduction

5379:    MAT_IGNORE_OFF_PROC_ENTRIES set to PETSC_TRUE indicates entries destined for
5380:    other processors should be dropped, rather than stashed.
5381:    This is useful if you know that the "owning" processor is also
5382:    always generating the correct matrix entries, so that PETSc need
5383:    not transfer duplicate entries generated on another processor.

5385:    MAT_USE_HASH_TABLE indicates that a hash table be used to improve the
5386:    searches during matrix assembly. When this flag is set, the hash table
5387:    is created during the first Matrix Assembly. This hash table is
5388:    used the next time through, during MatSetVaules()/MatSetVaulesBlocked()
5389:    to improve the searching of indices. MAT_NEW_NONZERO_LOCATIONS flag
5390:    should be used with MAT_USE_HASH_TABLE flag. This option is currently
5391:    supported by MATMPIBAIJ format only.

5393:    MAT_KEEP_NONZERO_PATTERN indicates when MatZeroRows() is called the zeroed entries
5394:    are kept in the nonzero structure

5396:    MAT_IGNORE_ZERO_ENTRIES - for AIJ/IS matrices this will stop zero values from creating
5397:    a zero location in the matrix

5399:    MAT_USE_INODES - indicates using inode version of the code - works with AIJ matrix types

5401:    MAT_NO_OFF_PROC_ZERO_ROWS - you know each process will only zero its own rows. This avoids all reductions in the
5402:         zero row routines and thus improves performance for very large process counts.

5404:    MAT_IGNORE_LOWER_TRIANGULAR - For SBAIJ matrices will ignore any insertions you make in the lower triangular
5405:         part of the matrix (since they should match the upper triangular part).

5407:    MAT_SORTED_FULL - each process provides exactly its local rows; all column indices for a given row are passed in a
5408:                      single call to MatSetValues(), preallocation is perfect, row oriented, INSERT_VALUES is used. Common
5409:                      with finite difference schemes with non-periodic boundary conditions.
5410:    Notes:
5411:     Can only be called after MatSetSizes() and MatSetType() have been set.

5413:    Level: intermediate

5415: .seealso:  MatOption, Mat

5417: @*/
5418: PetscErrorCode MatSetOption(Mat mat,MatOption op,PetscBool flg)
5419: {

5425:   if (op > 0) {
5428:   }

5430:   if (((int) op) <= MAT_OPTION_MIN || ((int) op) >= MAT_OPTION_MAX) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Options %d is out of range",(int)op);
5431:   if (!((PetscObject)mat)->type_name) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_TYPENOTSET,"Cannot set options until type and size have been set, see MatSetType() and MatSetSizes()");

5433:   switch (op) {
5434:   case MAT_NO_OFF_PROC_ENTRIES:
5435:     mat->nooffprocentries = flg;
5436:     return(0);
5437:     break;
5438:   case MAT_SUBSET_OFF_PROC_ENTRIES:
5439:     mat->assembly_subset = flg;
5440:     if (!mat->assembly_subset) { /* See the same logic in VecAssembly wrt VEC_SUBSET_OFF_PROC_ENTRIES */
5441: #if !defined(PETSC_HAVE_MPIUNI)
5442:       MatStashScatterDestroy_BTS(&mat->stash);
5443: #endif
5444:       mat->stash.first_assembly_done = PETSC_FALSE;
5445:     }
5446:     return(0);
5447:   case MAT_NO_OFF_PROC_ZERO_ROWS:
5448:     mat->nooffproczerorows = flg;
5449:     return(0);
5450:     break;
5451:   case MAT_SPD:
5452:     mat->spd_set = PETSC_TRUE;
5453:     mat->spd     = flg;
5454:     if (flg) {
5455:       mat->symmetric                  = PETSC_TRUE;
5456:       mat->structurally_symmetric     = PETSC_TRUE;
5457:       mat->symmetric_set              = PETSC_TRUE;
5458:       mat->structurally_symmetric_set = PETSC_TRUE;
5459:     }
5460:     break;
5461:   case MAT_SYMMETRIC:
5462:     mat->symmetric = flg;
5463:     if (flg) mat->structurally_symmetric = PETSC_TRUE;
5464:     mat->symmetric_set              = PETSC_TRUE;
5465:     mat->structurally_symmetric_set = flg;
5466: #if !defined(PETSC_USE_COMPLEX)
5467:     mat->hermitian     = flg;
5468:     mat->hermitian_set = PETSC_TRUE;
5469: #endif
5470:     break;
5471:   case MAT_HERMITIAN:
5472:     mat->hermitian = flg;
5473:     if (flg) mat->structurally_symmetric = PETSC_TRUE;
5474:     mat->hermitian_set              = PETSC_TRUE;
5475:     mat->structurally_symmetric_set = flg;
5476: #if !defined(PETSC_USE_COMPLEX)
5477:     mat->symmetric     = flg;
5478:     mat->symmetric_set = PETSC_TRUE;
5479: #endif
5480:     break;
5481:   case MAT_STRUCTURALLY_SYMMETRIC:
5482:     mat->structurally_symmetric     = flg;
5483:     mat->structurally_symmetric_set = PETSC_TRUE;
5484:     break;
5485:   case MAT_SYMMETRY_ETERNAL:
5486:     mat->symmetric_eternal = flg;
5487:     break;
5488:   case MAT_STRUCTURE_ONLY:
5489:     mat->structure_only = flg;
5490:     break;
5491:   case MAT_SORTED_FULL:
5492:     mat->sortedfull = flg;
5493:     break;
5494:   default:
5495:     break;
5496:   }
5497:   if (mat->ops->setoption) {
5498:     (*mat->ops->setoption)(mat,op,flg);
5499:   }
5500:   return(0);
5501: }

5503: /*@
5504:    MatGetOption - Gets a parameter option that has been set for a matrix.

5506:    Logically Collective on Mat for certain operations, such as MAT_SPD, not collective for MAT_ROW_ORIENTED, see MatOption

5508:    Input Parameters:
5509: +  mat - the matrix
5510: -  option - the option, this only responds to certain options, check the code for which ones

5512:    Output Parameter:
5513: .  flg - turn the option on (PETSC_TRUE) or off (PETSC_FALSE)

5515:     Notes:
5516:     Can only be called after MatSetSizes() and MatSetType() have been set.

5518:    Level: intermediate

5520: .seealso:  MatOption, MatSetOption()

5522: @*/
5523: PetscErrorCode MatGetOption(Mat mat,MatOption op,PetscBool *flg)
5524: {

5529:   if (((int) op) <= MAT_OPTION_MIN || ((int) op) >= MAT_OPTION_MAX) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Options %d is out of range",(int)op);
5530:   if (!((PetscObject)mat)->type_name) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_TYPENOTSET,"Cannot get options until type and size have been set, see MatSetType() and MatSetSizes()");

5532:   switch (op) {
5533:   case MAT_NO_OFF_PROC_ENTRIES:
5534:     *flg = mat->nooffprocentries;
5535:     break;
5536:   case MAT_NO_OFF_PROC_ZERO_ROWS:
5537:     *flg = mat->nooffproczerorows;
5538:     break;
5539:   case MAT_SYMMETRIC:
5540:     *flg = mat->symmetric;
5541:     break;
5542:   case MAT_HERMITIAN:
5543:     *flg = mat->hermitian;
5544:     break;
5545:   case MAT_STRUCTURALLY_SYMMETRIC:
5546:     *flg = mat->structurally_symmetric;
5547:     break;
5548:   case MAT_SYMMETRY_ETERNAL:
5549:     *flg = mat->symmetric_eternal;
5550:     break;
5551:   case MAT_SPD:
5552:     *flg = mat->spd;
5553:     break;
5554:   default:
5555:     break;
5556:   }
5557:   return(0);
5558: }

5560: /*@
5561:    MatZeroEntries - Zeros all entries of a matrix.  For sparse matrices
5562:    this routine retains the old nonzero structure.

5564:    Logically Collective on Mat

5566:    Input Parameters:
5567: .  mat - the matrix

5569:    Level: intermediate

5571:    Notes:
5572:     If the matrix was not preallocated then a default, likely poor preallocation will be set in the matrix, so this should be called after the preallocation phase.
5573:    See the Performance chapter of the users manual for information on preallocating matrices.

5575: .seealso: MatZeroRows()
5576: @*/
5577: PetscErrorCode MatZeroEntries(Mat mat)
5578: {

5584:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5585:   if (mat->insertmode != NOT_SET_VALUES) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for matrices where you have set values but not yet assembled");
5586:   if (!mat->ops->zeroentries) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5587:   MatCheckPreallocated(mat,1);

5589:   PetscLogEventBegin(MAT_ZeroEntries,mat,0,0,0);
5590:   (*mat->ops->zeroentries)(mat);
5591:   PetscLogEventEnd(MAT_ZeroEntries,mat,0,0,0);
5592:   PetscObjectStateIncrease((PetscObject)mat);
5593:   return(0);
5594: }

5596: /*@
5597:    MatZeroRowsColumns - Zeros all entries (except possibly the main diagonal)
5598:    of a set of rows and columns of a matrix.

5600:    Collective on Mat

5602:    Input Parameters:
5603: +  mat - the matrix
5604: .  numRows - the number of rows to remove
5605: .  rows - the global row indices
5606: .  diag - value put in all diagonals of eliminated rows (0.0 will even eliminate diagonal entry)
5607: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
5608: -  b - optional vector of right hand side, that will be adjusted by provided solution

5610:    Notes:
5611:    This does not change the nonzero structure of the matrix, it merely zeros those entries in the matrix.

5613:    The user can set a value in the diagonal entry (or for the AIJ and
5614:    row formats can optionally remove the main diagonal entry from the
5615:    nonzero structure as well, by passing 0.0 as the final argument).

5617:    For the parallel case, all processes that share the matrix (i.e.,
5618:    those in the communicator used for matrix creation) MUST call this
5619:    routine, regardless of whether any rows being zeroed are owned by
5620:    them.

5622:    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
5623:    list only rows local to itself).

5625:    The option MAT_NO_OFF_PROC_ZERO_ROWS does not apply to this routine.

5627:    Level: intermediate

5629: .seealso: MatZeroRowsIS(), MatZeroRows(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
5630:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
5631: @*/
5632: PetscErrorCode MatZeroRowsColumns(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag,Vec x,Vec b)
5633: {

5640:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5641:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5642:   if (!mat->ops->zerorowscolumns) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5643:   MatCheckPreallocated(mat,1);

5645:   (*mat->ops->zerorowscolumns)(mat,numRows,rows,diag,x,b);
5646:   MatViewFromOptions(mat,NULL,"-mat_view");
5647:   PetscObjectStateIncrease((PetscObject)mat);
5648:   return(0);
5649: }

5651: /*@
5652:    MatZeroRowsColumnsIS - Zeros all entries (except possibly the main diagonal)
5653:    of a set of rows and columns of a matrix.

5655:    Collective on Mat

5657:    Input Parameters:
5658: +  mat - the matrix
5659: .  is - the rows to zero
5660: .  diag - value put in all diagonals of eliminated rows (0.0 will even eliminate diagonal entry)
5661: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
5662: -  b - optional vector of right hand side, that will be adjusted by provided solution

5664:    Notes:
5665:    This does not change the nonzero structure of the matrix, it merely zeros those entries in the matrix.

5667:    The user can set a value in the diagonal entry (or for the AIJ and
5668:    row formats can optionally remove the main diagonal entry from the
5669:    nonzero structure as well, by passing 0.0 as the final argument).

5671:    For the parallel case, all processes that share the matrix (i.e.,
5672:    those in the communicator used for matrix creation) MUST call this
5673:    routine, regardless of whether any rows being zeroed are owned by
5674:    them.

5676:    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
5677:    list only rows local to itself).

5679:    The option MAT_NO_OFF_PROC_ZERO_ROWS does not apply to this routine.

5681:    Level: intermediate

5683: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
5684:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRows(), MatZeroRowsColumnsStencil()
5685: @*/
5686: PetscErrorCode MatZeroRowsColumnsIS(Mat mat,IS is,PetscScalar diag,Vec x,Vec b)
5687: {
5689:   PetscInt       numRows;
5690:   const PetscInt *rows;

5697:   ISGetLocalSize(is,&numRows);
5698:   ISGetIndices(is,&rows);
5699:   MatZeroRowsColumns(mat,numRows,rows,diag,x,b);
5700:   ISRestoreIndices(is,&rows);
5701:   return(0);
5702: }

5704: /*@
5705:    MatZeroRows - Zeros all entries (except possibly the main diagonal)
5706:    of a set of rows of a matrix.

5708:    Collective on Mat

5710:    Input Parameters:
5711: +  mat - the matrix
5712: .  numRows - the number of rows to remove
5713: .  rows - the global row indices
5714: .  diag - value put in all diagonals of eliminated rows (0.0 will even eliminate diagonal entry)
5715: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
5716: -  b - optional vector of right hand side, that will be adjusted by provided solution

5718:    Notes:
5719:    For the AIJ and BAIJ matrix formats this removes the old nonzero structure,
5720:    but does not release memory.  For the dense and block diagonal
5721:    formats this does not alter the nonzero structure.

5723:    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
5724:    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
5725:    merely zeroed.

5727:    The user can set a value in the diagonal entry (or for the AIJ and
5728:    row formats can optionally remove the main diagonal entry from the
5729:    nonzero structure as well, by passing 0.0 as the final argument).

5731:    For the parallel case, all processes that share the matrix (i.e.,
5732:    those in the communicator used for matrix creation) MUST call this
5733:    routine, regardless of whether any rows being zeroed are owned by
5734:    them.

5736:    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
5737:    list only rows local to itself).

5739:    You can call MatSetOption(mat,MAT_NO_OFF_PROC_ZERO_ROWS,PETSC_TRUE) if each process indicates only rows it
5740:    owns that are to be zeroed. This saves a global synchronization in the implementation.

5742:    Level: intermediate

5744: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
5745:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
5746: @*/
5747: PetscErrorCode MatZeroRows(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag,Vec x,Vec b)
5748: {

5755:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5756:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5757:   if (!mat->ops->zerorows) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5758:   MatCheckPreallocated(mat,1);

5760:   (*mat->ops->zerorows)(mat,numRows,rows,diag,x,b);
5761:   MatViewFromOptions(mat,NULL,"-mat_view");
5762:   PetscObjectStateIncrease((PetscObject)mat);
5763:   return(0);
5764: }

5766: /*@
5767:    MatZeroRowsIS - Zeros all entries (except possibly the main diagonal)
5768:    of a set of rows of a matrix.

5770:    Collective on Mat

5772:    Input Parameters:
5773: +  mat - the matrix
5774: .  is - index set of rows to remove
5775: .  diag - value put in all diagonals of eliminated rows
5776: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
5777: -  b - optional vector of right hand side, that will be adjusted by provided solution

5779:    Notes:
5780:    For the AIJ and BAIJ matrix formats this removes the old nonzero structure,
5781:    but does not release memory.  For the dense and block diagonal
5782:    formats this does not alter the nonzero structure.

5784:    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
5785:    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
5786:    merely zeroed.

5788:    The user can set a value in the diagonal entry (or for the AIJ and
5789:    row formats can optionally remove the main diagonal entry from the
5790:    nonzero structure as well, by passing 0.0 as the final argument).

5792:    For the parallel case, all processes that share the matrix (i.e.,
5793:    those in the communicator used for matrix creation) MUST call this
5794:    routine, regardless of whether any rows being zeroed are owned by
5795:    them.

5797:    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
5798:    list only rows local to itself).

5800:    You can call MatSetOption(mat,MAT_NO_OFF_PROC_ZERO_ROWS,PETSC_TRUE) if each process indicates only rows it
5801:    owns that are to be zeroed. This saves a global synchronization in the implementation.

5803:    Level: intermediate

5805: .seealso: MatZeroRows(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
5806:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
5807: @*/
5808: PetscErrorCode MatZeroRowsIS(Mat mat,IS is,PetscScalar diag,Vec x,Vec b)
5809: {
5810:   PetscInt       numRows;
5811:   const PetscInt *rows;

5818:   ISGetLocalSize(is,&numRows);
5819:   ISGetIndices(is,&rows);
5820:   MatZeroRows(mat,numRows,rows,diag,x,b);
5821:   ISRestoreIndices(is,&rows);
5822:   return(0);
5823: }

5825: /*@
5826:    MatZeroRowsStencil - Zeros all entries (except possibly the main diagonal)
5827:    of a set of rows of a matrix. These rows must be local to the process.

5829:    Collective on Mat

5831:    Input Parameters:
5832: +  mat - the matrix
5833: .  numRows - the number of rows to remove
5834: .  rows - the grid coordinates (and component number when dof > 1) for matrix rows
5835: .  diag - value put in all diagonals of eliminated rows (0.0 will even eliminate diagonal entry)
5836: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
5837: -  b - optional vector of right hand side, that will be adjusted by provided solution

5839:    Notes:
5840:    For the AIJ and BAIJ matrix formats this removes the old nonzero structure,
5841:    but does not release memory.  For the dense and block diagonal
5842:    formats this does not alter the nonzero structure.

5844:    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
5845:    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
5846:    merely zeroed.

5848:    The user can set a value in the diagonal entry (or for the AIJ and
5849:    row formats can optionally remove the main diagonal entry from the
5850:    nonzero structure as well, by passing 0.0 as the final argument).

5852:    For the parallel case, all processes that share the matrix (i.e.,
5853:    those in the communicator used for matrix creation) MUST call this
5854:    routine, regardless of whether any rows being zeroed are owned by
5855:    them.

5857:    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
5858:    list only rows local to itself).

5860:    The grid coordinates are across the entire grid, not just the local portion

5862:    In Fortran idxm and idxn should be declared as
5863: $     MatStencil idxm(4,m)
5864:    and the values inserted using
5865: $    idxm(MatStencil_i,1) = i
5866: $    idxm(MatStencil_j,1) = j
5867: $    idxm(MatStencil_k,1) = k
5868: $    idxm(MatStencil_c,1) = c
5869:    etc

5871:    For periodic boundary conditions use negative indices for values to the left (below 0; that are to be
5872:    obtained by wrapping values from right edge). For values to the right of the last entry using that index plus one
5873:    etc to obtain values that obtained by wrapping the values from the left edge. This does not work for anything but the
5874:    DM_BOUNDARY_PERIODIC boundary type.

5876:    For indices that don't mean anything for your case (like the k index when working in 2d) or the c index when you have
5877:    a single value per point) you can skip filling those indices.

5879:    Level: intermediate

5881: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsl(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
5882:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
5883: @*/
5884: PetscErrorCode MatZeroRowsStencil(Mat mat,PetscInt numRows,const MatStencil rows[],PetscScalar diag,Vec x,Vec b)
5885: {
5886:   PetscInt       dim     = mat->stencil.dim;
5887:   PetscInt       sdim    = dim - (1 - (PetscInt) mat->stencil.noc);
5888:   PetscInt       *dims   = mat->stencil.dims+1;
5889:   PetscInt       *starts = mat->stencil.starts;
5890:   PetscInt       *dxm    = (PetscInt*) rows;
5891:   PetscInt       *jdxm, i, j, tmp, numNewRows = 0;


5899:   PetscMalloc1(numRows, &jdxm);
5900:   for (i = 0; i < numRows; ++i) {
5901:     /* Skip unused dimensions (they are ordered k, j, i, c) */
5902:     for (j = 0; j < 3-sdim; ++j) dxm++;
5903:     /* Local index in X dir */
5904:     tmp = *dxm++ - starts[0];
5905:     /* Loop over remaining dimensions */
5906:     for (j = 0; j < dim-1; ++j) {
5907:       /* If nonlocal, set index to be negative */
5908:       if ((*dxm++ - starts[j+1]) < 0 || tmp < 0) tmp = PETSC_MIN_INT;
5909:       /* Update local index */
5910:       else tmp = tmp*dims[j] + *(dxm-1) - starts[j+1];
5911:     }
5912:     /* Skip component slot if necessary */
5913:     if (mat->stencil.noc) dxm++;
5914:     /* Local row number */
5915:     if (tmp >= 0) {
5916:       jdxm[numNewRows++] = tmp;
5917:     }
5918:   }
5919:   MatZeroRowsLocal(mat,numNewRows,jdxm,diag,x,b);
5920:   PetscFree(jdxm);
5921:   return(0);
5922: }

5924: /*@
5925:    MatZeroRowsColumnsStencil - Zeros all row and column entries (except possibly the main diagonal)
5926:    of a set of rows and columns of a matrix.

5928:    Collective on Mat

5930:    Input Parameters:
5931: +  mat - the matrix
5932: .  numRows - the number of rows/columns to remove
5933: .  rows - the grid coordinates (and component number when dof > 1) for matrix rows
5934: .  diag - value put in all diagonals of eliminated rows (0.0 will even eliminate diagonal entry)
5935: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
5936: -  b - optional vector of right hand side, that will be adjusted by provided solution

5938:    Notes:
5939:    For the AIJ and BAIJ matrix formats this removes the old nonzero structure,
5940:    but does not release memory.  For the dense and block diagonal
5941:    formats this does not alter the nonzero structure.

5943:    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
5944:    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
5945:    merely zeroed.

5947:    The user can set a value in the diagonal entry (or for the AIJ and
5948:    row formats can optionally remove the main diagonal entry from the
5949:    nonzero structure as well, by passing 0.0 as the final argument).

5951:    For the parallel case, all processes that share the matrix (i.e.,
5952:    those in the communicator used for matrix creation) MUST call this
5953:    routine, regardless of whether any rows being zeroed are owned by
5954:    them.

5956:    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
5957:    list only rows local to itself, but the row/column numbers are given in local numbering).

5959:    The grid coordinates are across the entire grid, not just the local portion

5961:    In Fortran idxm and idxn should be declared as
5962: $     MatStencil idxm(4,m)
5963:    and the values inserted using
5964: $    idxm(MatStencil_i,1) = i
5965: $    idxm(MatStencil_j,1) = j
5966: $    idxm(MatStencil_k,1) = k
5967: $    idxm(MatStencil_c,1) = c
5968:    etc

5970:    For periodic boundary conditions use negative indices for values to the left (below 0; that are to be
5971:    obtained by wrapping values from right edge). For values to the right of the last entry using that index plus one
5972:    etc to obtain values that obtained by wrapping the values from the left edge. This does not work for anything but the
5973:    DM_BOUNDARY_PERIODIC boundary type.

5975:    For indices that don't mean anything for your case (like the k index when working in 2d) or the c index when you have
5976:    a single value per point) you can skip filling those indices.

5978:    Level: intermediate

5980: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
5981:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRows()
5982: @*/
5983: PetscErrorCode MatZeroRowsColumnsStencil(Mat mat,PetscInt numRows,const MatStencil rows[],PetscScalar diag,Vec x,Vec b)
5984: {
5985:   PetscInt       dim     = mat->stencil.dim;
5986:   PetscInt       sdim    = dim - (1 - (PetscInt) mat->stencil.noc);
5987:   PetscInt       *dims   = mat->stencil.dims+1;
5988:   PetscInt       *starts = mat->stencil.starts;
5989:   PetscInt       *dxm    = (PetscInt*) rows;
5990:   PetscInt       *jdxm, i, j, tmp, numNewRows = 0;


5998:   PetscMalloc1(numRows, &jdxm);
5999:   for (i = 0; i < numRows; ++i) {
6000:     /* Skip unused dimensions (they are ordered k, j, i, c) */
6001:     for (j = 0; j < 3-sdim; ++j) dxm++;
6002:     /* Local index in X dir */
6003:     tmp = *dxm++ - starts[0];
6004:     /* Loop over remaining dimensions */
6005:     for (j = 0; j < dim-1; ++j) {
6006:       /* If nonlocal, set index to be negative */
6007:       if ((*dxm++ - starts[j+1]) < 0 || tmp < 0) tmp = PETSC_MIN_INT;
6008:       /* Update local index */
6009:       else tmp = tmp*dims[j] + *(dxm-1) - starts[j+1];
6010:     }
6011:     /* Skip component slot if necessary */
6012:     if (mat->stencil.noc) dxm++;
6013:     /* Local row number */
6014:     if (tmp >= 0) {
6015:       jdxm[numNewRows++] = tmp;
6016:     }
6017:   }
6018:   MatZeroRowsColumnsLocal(mat,numNewRows,jdxm,diag,x,b);
6019:   PetscFree(jdxm);
6020:   return(0);
6021: }

6023: /*@C
6024:    MatZeroRowsLocal - Zeros all entries (except possibly the main diagonal)
6025:    of a set of rows of a matrix; using local numbering of rows.

6027:    Collective on Mat

6029:    Input Parameters:
6030: +  mat - the matrix
6031: .  numRows - the number of rows to remove
6032: .  rows - the global row indices
6033: .  diag - value put in all diagonals of eliminated rows
6034: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
6035: -  b - optional vector of right hand side, that will be adjusted by provided solution

6037:    Notes:
6038:    Before calling MatZeroRowsLocal(), the user must first set the
6039:    local-to-global mapping by calling MatSetLocalToGlobalMapping().

6041:    For the AIJ matrix formats this removes the old nonzero structure,
6042:    but does not release memory.  For the dense and block diagonal
6043:    formats this does not alter the nonzero structure.

6045:    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
6046:    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
6047:    merely zeroed.

6049:    The user can set a value in the diagonal entry (or for the AIJ and
6050:    row formats can optionally remove the main diagonal entry from the
6051:    nonzero structure as well, by passing 0.0 as the final argument).

6053:    You can call MatSetOption(mat,MAT_NO_OFF_PROC_ZERO_ROWS,PETSC_TRUE) if each process indicates only rows it
6054:    owns that are to be zeroed. This saves a global synchronization in the implementation.

6056:    Level: intermediate

6058: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRows(), MatSetOption(),
6059:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
6060: @*/
6061: PetscErrorCode MatZeroRowsLocal(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag,Vec x,Vec b)
6062: {

6069:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6070:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6071:   MatCheckPreallocated(mat,1);

6073:   if (mat->ops->zerorowslocal) {
6074:     (*mat->ops->zerorowslocal)(mat,numRows,rows,diag,x,b);
6075:   } else {
6076:     IS             is, newis;
6077:     const PetscInt *newRows;

6079:     if (!mat->rmap->mapping) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Need to provide local to global mapping to matrix first");
6080:     ISCreateGeneral(PETSC_COMM_SELF,numRows,rows,PETSC_COPY_VALUES,&is);
6081:     ISLocalToGlobalMappingApplyIS(mat->rmap->mapping,is,&newis);
6082:     ISGetIndices(newis,&newRows);
6083:     (*mat->ops->zerorows)(mat,numRows,newRows,diag,x,b);
6084:     ISRestoreIndices(newis,&newRows);
6085:     ISDestroy(&newis);
6086:     ISDestroy(&is);
6087:   }
6088:   PetscObjectStateIncrease((PetscObject)mat);
6089:   return(0);
6090: }

6092: /*@
6093:    MatZeroRowsLocalIS - Zeros all entries (except possibly the main diagonal)
6094:    of a set of rows of a matrix; using local numbering of rows.

6096:    Collective on Mat

6098:    Input Parameters:
6099: +  mat - the matrix
6100: .  is - index set of rows to remove
6101: .  diag - value put in all diagonals of eliminated rows
6102: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
6103: -  b - optional vector of right hand side, that will be adjusted by provided solution

6105:    Notes:
6106:    Before calling MatZeroRowsLocalIS(), the user must first set the
6107:    local-to-global mapping by calling MatSetLocalToGlobalMapping().

6109:    For the AIJ matrix formats this removes the old nonzero structure,
6110:    but does not release memory.  For the dense and block diagonal
6111:    formats this does not alter the nonzero structure.

6113:    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
6114:    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
6115:    merely zeroed.

6117:    The user can set a value in the diagonal entry (or for the AIJ and
6118:    row formats can optionally remove the main diagonal entry from the
6119:    nonzero structure as well, by passing 0.0 as the final argument).

6121:    You can call MatSetOption(mat,MAT_NO_OFF_PROC_ZERO_ROWS,PETSC_TRUE) if each process indicates only rows it
6122:    owns that are to be zeroed. This saves a global synchronization in the implementation.

6124:    Level: intermediate

6126: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRows(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
6127:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
6128: @*/
6129: PetscErrorCode MatZeroRowsLocalIS(Mat mat,IS is,PetscScalar diag,Vec x,Vec b)
6130: {
6132:   PetscInt       numRows;
6133:   const PetscInt *rows;

6139:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6140:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6141:   MatCheckPreallocated(mat,1);

6143:   ISGetLocalSize(is,&numRows);
6144:   ISGetIndices(is,&rows);
6145:   MatZeroRowsLocal(mat,numRows,rows,diag,x,b);
6146:   ISRestoreIndices(is,&rows);
6147:   return(0);
6148: }

6150: /*@
6151:    MatZeroRowsColumnsLocal - Zeros all entries (except possibly the main diagonal)
6152:    of a set of rows and columns of a matrix; using local numbering of rows.

6154:    Collective on Mat

6156:    Input Parameters:
6157: +  mat - the matrix
6158: .  numRows - the number of rows to remove
6159: .  rows - the global row indices
6160: .  diag - value put in all diagonals of eliminated rows
6161: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
6162: -  b - optional vector of right hand side, that will be adjusted by provided solution

6164:    Notes:
6165:    Before calling MatZeroRowsColumnsLocal(), the user must first set the
6166:    local-to-global mapping by calling MatSetLocalToGlobalMapping().

6168:    The user can set a value in the diagonal entry (or for the AIJ and
6169:    row formats can optionally remove the main diagonal entry from the
6170:    nonzero structure as well, by passing 0.0 as the final argument).

6172:    Level: intermediate

6174: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
6175:           MatZeroRows(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
6176: @*/
6177: PetscErrorCode MatZeroRowsColumnsLocal(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag,Vec x,Vec b)
6178: {
6180:   IS             is, newis;
6181:   const PetscInt *newRows;

6187:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6188:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6189:   MatCheckPreallocated(mat,1);

6191:   if (!mat->cmap->mapping) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Need to provide local to global mapping to matrix first");
6192:   ISCreateGeneral(PETSC_COMM_SELF,numRows,rows,PETSC_COPY_VALUES,&is);
6193:   ISLocalToGlobalMappingApplyIS(mat->cmap->mapping,is,&newis);
6194:   ISGetIndices(newis,&newRows);
6195:   (*mat->ops->zerorowscolumns)(mat,numRows,newRows,diag,x,b);
6196:   ISRestoreIndices(newis,&newRows);
6197:   ISDestroy(&newis);
6198:   ISDestroy(&is);
6199:   PetscObjectStateIncrease((PetscObject)mat);
6200:   return(0);
6201: }

6203: /*@
6204:    MatZeroRowsColumnsLocalIS - Zeros all entries (except possibly the main diagonal)
6205:    of a set of rows and columns of a matrix; using local numbering of rows.

6207:    Collective on Mat

6209:    Input Parameters:
6210: +  mat - the matrix
6211: .  is - index set of rows to remove
6212: .  diag - value put in all diagonals of eliminated rows
6213: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
6214: -  b - optional vector of right hand side, that will be adjusted by provided solution

6216:    Notes:
6217:    Before calling MatZeroRowsColumnsLocalIS(), the user must first set the
6218:    local-to-global mapping by calling MatSetLocalToGlobalMapping().

6220:    The user can set a value in the diagonal entry (or for the AIJ and
6221:    row formats can optionally remove the main diagonal entry from the
6222:    nonzero structure as well, by passing 0.0 as the final argument).

6224:    Level: intermediate

6226: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
6227:           MatZeroRowsColumnsLocal(), MatZeroRows(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
6228: @*/
6229: PetscErrorCode MatZeroRowsColumnsLocalIS(Mat mat,IS is,PetscScalar diag,Vec x,Vec b)
6230: {
6232:   PetscInt       numRows;
6233:   const PetscInt *rows;

6239:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6240:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6241:   MatCheckPreallocated(mat,1);

6243:   ISGetLocalSize(is,&numRows);
6244:   ISGetIndices(is,&rows);
6245:   MatZeroRowsColumnsLocal(mat,numRows,rows,diag,x,b);
6246:   ISRestoreIndices(is,&rows);
6247:   return(0);
6248: }

6250: /*@C
6251:    MatGetSize - Returns the numbers of rows and columns in a matrix.

6253:    Not Collective

6255:    Input Parameter:
6256: .  mat - the matrix

6258:    Output Parameters:
6259: +  m - the number of global rows
6260: -  n - the number of global columns

6262:    Note: both output parameters can be NULL on input.

6264:    Level: beginner

6266: .seealso: MatGetLocalSize()
6267: @*/
6268: PetscErrorCode MatGetSize(Mat mat,PetscInt *m,PetscInt *n)
6269: {
6272:   if (m) *m = mat->rmap->N;
6273:   if (n) *n = mat->cmap->N;
6274:   return(0);
6275: }

6277: /*@C
6278:    MatGetLocalSize - Returns the number of rows and columns in a matrix
6279:    stored locally.  This information may be implementation dependent, so
6280:    use with care.

6282:    Not Collective

6284:    Input Parameters:
6285: .  mat - the matrix

6287:    Output Parameters:
6288: +  m - the number of local rows
6289: -  n - the number of local columns

6291:    Note: both output parameters can be NULL on input.

6293:    Level: beginner

6295: .seealso: MatGetSize()
6296: @*/
6297: PetscErrorCode MatGetLocalSize(Mat mat,PetscInt *m,PetscInt *n)
6298: {
6303:   if (m) *m = mat->rmap->n;
6304:   if (n) *n = mat->cmap->n;
6305:   return(0);
6306: }

6308: /*@C
6309:    MatGetOwnershipRangeColumn - Returns the range of matrix columns associated with rows of a vector one multiplies by that owned by
6310:    this processor. (The columns of the "diagonal block")

6312:    Not Collective, unless matrix has not been allocated, then collective on Mat

6314:    Input Parameters:
6315: .  mat - the matrix

6317:    Output Parameters:
6318: +  m - the global index of the first local column
6319: -  n - one more than the global index of the last local column

6321:    Notes:
6322:     both output parameters can be NULL on input.

6324:    Level: developer

6326: .seealso:  MatGetOwnershipRange(), MatGetOwnershipRanges(), MatGetOwnershipRangesColumn()

6328: @*/
6329: PetscErrorCode MatGetOwnershipRangeColumn(Mat mat,PetscInt *m,PetscInt *n)
6330: {
6336:   MatCheckPreallocated(mat,1);
6337:   if (m) *m = mat->cmap->rstart;
6338:   if (n) *n = mat->cmap->rend;
6339:   return(0);
6340: }

6342: /*@C
6343:    MatGetOwnershipRange - Returns the range of matrix rows owned by
6344:    this processor, assuming that the matrix is laid out with the first
6345:    n1 rows on the first processor, the next n2 rows on the second, etc.
6346:    For certain parallel layouts this range may not be well defined.

6348:    Not Collective

6350:    Input Parameters:
6351: .  mat - the matrix

6353:    Output Parameters:
6354: +  m - the global index of the first local row
6355: -  n - one more than the global index of the last local row

6357:    Note: Both output parameters can be NULL on input.
6358: $  This function requires that the matrix be preallocated. If you have not preallocated, consider using
6359: $    PetscSplitOwnership(MPI_Comm comm, PetscInt *n, PetscInt *N)
6360: $  and then MPI_Scan() to calculate prefix sums of the local sizes.

6362:    Level: beginner

6364: .seealso:   MatGetOwnershipRanges(), MatGetOwnershipRangeColumn(), MatGetOwnershipRangesColumn(), PetscSplitOwnership(), PetscSplitOwnershipBlock()

6366: @*/
6367: PetscErrorCode MatGetOwnershipRange(Mat mat,PetscInt *m,PetscInt *n)
6368: {
6374:   MatCheckPreallocated(mat,1);
6375:   if (m) *m = mat->rmap->rstart;
6376:   if (n) *n = mat->rmap->rend;
6377:   return(0);
6378: }

6380: /*@C
6381:    MatGetOwnershipRanges - Returns the range of matrix rows owned by
6382:    each process

6384:    Not Collective, unless matrix has not been allocated, then collective on Mat

6386:    Input Parameters:
6387: .  mat - the matrix

6389:    Output Parameters:
6390: .  ranges - start of each processors portion plus one more than the total length at the end

6392:    Level: beginner

6394: .seealso:   MatGetOwnershipRange(), MatGetOwnershipRangeColumn(), MatGetOwnershipRangesColumn()

6396: @*/
6397: PetscErrorCode MatGetOwnershipRanges(Mat mat,const PetscInt **ranges)
6398: {

6404:   MatCheckPreallocated(mat,1);
6405:   PetscLayoutGetRanges(mat->rmap,ranges);
6406:   return(0);
6407: }

6409: /*@C
6410:    MatGetOwnershipRangesColumn - Returns the range of matrix columns associated with rows of a vector one multiplies by that owned by
6411:    this processor. (The columns of the "diagonal blocks" for each process)

6413:    Not Collective, unless matrix has not been allocated, then collective on Mat

6415:    Input Parameters:
6416: .  mat - the matrix

6418:    Output Parameters:
6419: .  ranges - start of each processors portion plus one more then the total length at the end

6421:    Level: beginner

6423: .seealso:   MatGetOwnershipRange(), MatGetOwnershipRangeColumn(), MatGetOwnershipRanges()

6425: @*/
6426: PetscErrorCode MatGetOwnershipRangesColumn(Mat mat,const PetscInt **ranges)
6427: {

6433:   MatCheckPreallocated(mat,1);
6434:   PetscLayoutGetRanges(mat->cmap,ranges);
6435:   return(0);
6436: }

6438: /*@C
6439:    MatGetOwnershipIS - Get row and column ownership as index sets

6441:    Not Collective

6443:    Input Arguments:
6444: .  A - matrix of type Elemental

6446:    Output Arguments:
6447: +  rows - rows in which this process owns elements
6448: -  cols - columns in which this process owns elements

6450:    Level: intermediate

6452: .seealso: MatGetOwnershipRange(), MatGetOwnershipRangeColumn(), MatSetValues(), MATELEMENTAL
6453: @*/
6454: PetscErrorCode MatGetOwnershipIS(Mat A,IS *rows,IS *cols)
6455: {
6456:   PetscErrorCode ierr,(*f)(Mat,IS*,IS*);

6459:   MatCheckPreallocated(A,1);
6460:   PetscObjectQueryFunction((PetscObject)A,"MatGetOwnershipIS_C",&f);
6461:   if (f) {
6462:     (*f)(A,rows,cols);
6463:   } else {   /* Create a standard row-based partition, each process is responsible for ALL columns in their row block */
6464:     if (rows) {ISCreateStride(PETSC_COMM_SELF,A->rmap->n,A->rmap->rstart,1,rows);}
6465:     if (cols) {ISCreateStride(PETSC_COMM_SELF,A->cmap->N,0,1,cols);}
6466:   }
6467:   return(0);
6468: }

6470: /*@C
6471:    MatILUFactorSymbolic - Performs symbolic ILU factorization of a matrix.
6472:    Uses levels of fill only, not drop tolerance. Use MatLUFactorNumeric()
6473:    to complete the factorization.

6475:    Collective on Mat

6477:    Input Parameters:
6478: +  mat - the matrix
6479: .  row - row permutation
6480: .  column - column permutation
6481: -  info - structure containing
6482: $      levels - number of levels of fill.
6483: $      expected fill - as ratio of original fill.
6484: $      1 or 0 - indicating force fill on diagonal (improves robustness for matrices
6485:                 missing diagonal entries)

6487:    Output Parameters:
6488: .  fact - new matrix that has been symbolically factored

6490:    Notes:
6491:     See Users-Manual: ch_mat for additional information about choosing the fill factor for better efficiency.

6493:    Most users should employ the simplified KSP interface for linear solvers
6494:    instead of working directly with matrix algebra routines such as this.
6495:    See, e.g., KSPCreate().

6497:    Level: developer

6499: .seealso: MatLUFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor()
6500:           MatGetOrdering(), MatFactorInfo

6502:     Note: this uses the definition of level of fill as in Y. Saad, 2003

6504:     Developer Note: fortran interface is not autogenerated as the f90
6505:     interface defintion cannot be generated correctly [due to MatFactorInfo]

6507:    References:
6508:      Y. Saad, Iterative methods for sparse linear systems Philadelphia: Society for Industrial and Applied Mathematics, 2003
6509: @*/
6510: PetscErrorCode MatILUFactorSymbolic(Mat fact,Mat mat,IS row,IS col,const MatFactorInfo *info)
6511: {

6521:   if (info->levels < 0) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Levels of fill negative %D",(PetscInt)info->levels);
6522:   if (info->fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Expected fill less than 1.0 %g",(double)info->fill);
6523:   if (!(fact)->ops->ilufactorsymbolic) {
6524:     MatSolverType spackage;
6525:     MatFactorGetSolverType(fact,&spackage);
6526:     SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s symbolic ILU using solver package %s",((PetscObject)mat)->type_name,spackage);
6527:   }
6528:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6529:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6530:   MatCheckPreallocated(mat,2);

6532:   PetscLogEventBegin(MAT_ILUFactorSymbolic,mat,row,col,0);
6533:   (fact->ops->ilufactorsymbolic)(fact,mat,row,col,info);
6534:   PetscLogEventEnd(MAT_ILUFactorSymbolic,mat,row,col,0);
6535:   return(0);
6536: }

6538: /*@C
6539:    MatICCFactorSymbolic - Performs symbolic incomplete
6540:    Cholesky factorization for a symmetric matrix.  Use
6541:    MatCholeskyFactorNumeric() to complete the factorization.

6543:    Collective on Mat

6545:    Input Parameters:
6546: +  mat - the matrix
6547: .  perm - row and column permutation
6548: -  info - structure containing
6549: $      levels - number of levels of fill.
6550: $      expected fill - as ratio of original fill.

6552:    Output Parameter:
6553: .  fact - the factored matrix

6555:    Notes:
6556:    Most users should employ the KSP interface for linear solvers
6557:    instead of working directly with matrix algebra routines such as this.
6558:    See, e.g., KSPCreate().

6560:    Level: developer

6562: .seealso: MatCholeskyFactorNumeric(), MatCholeskyFactor(), MatFactorInfo

6564:     Note: this uses the definition of level of fill as in Y. Saad, 2003

6566:     Developer Note: fortran interface is not autogenerated as the f90
6567:     interface defintion cannot be generated correctly [due to MatFactorInfo]

6569:    References:
6570:      Y. Saad, Iterative methods for sparse linear systems Philadelphia: Society for Industrial and Applied Mathematics, 2003
6571: @*/
6572: PetscErrorCode MatICCFactorSymbolic(Mat fact,Mat mat,IS perm,const MatFactorInfo *info)
6573: {

6582:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6583:   if (info->levels < 0) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Levels negative %D",(PetscInt) info->levels);
6584:   if (info->fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Expected fill less than 1.0 %g",(double)info->fill);
6585:   if (!(fact)->ops->iccfactorsymbolic) {
6586:     MatSolverType spackage;
6587:     MatFactorGetSolverType(fact,&spackage);
6588:     SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s symbolic ICC using solver package %s",((PetscObject)mat)->type_name,spackage);
6589:   }
6590:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6591:   MatCheckPreallocated(mat,2);

6593:   PetscLogEventBegin(MAT_ICCFactorSymbolic,mat,perm,0,0);
6594:   (fact->ops->iccfactorsymbolic)(fact,mat,perm,info);
6595:   PetscLogEventEnd(MAT_ICCFactorSymbolic,mat,perm,0,0);
6596:   return(0);
6597: }

6599: /*@C
6600:    MatCreateSubMatrices - Extracts several submatrices from a matrix. If submat
6601:    points to an array of valid matrices, they may be reused to store the new
6602:    submatrices.

6604:    Collective on Mat

6606:    Input Parameters:
6607: +  mat - the matrix
6608: .  n   - the number of submatrixes to be extracted (on this processor, may be zero)
6609: .  irow, icol - index sets of rows and columns to extract
6610: -  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX

6612:    Output Parameter:
6613: .  submat - the array of submatrices

6615:    Notes:
6616:    MatCreateSubMatrices() can extract ONLY sequential submatrices
6617:    (from both sequential and parallel matrices). Use MatCreateSubMatrix()
6618:    to extract a parallel submatrix.

6620:    Some matrix types place restrictions on the row and column
6621:    indices, such as that they be sorted or that they be equal to each other.

6623:    The index sets may not have duplicate entries.

6625:    When extracting submatrices from a parallel matrix, each processor can
6626:    form a different submatrix by setting the rows and columns of its
6627:    individual index sets according to the local submatrix desired.

6629:    When finished using the submatrices, the user should destroy
6630:    them with MatDestroySubMatrices().

6632:    MAT_REUSE_MATRIX can only be used when the nonzero structure of the
6633:    original matrix has not changed from that last call to MatCreateSubMatrices().

6635:    This routine creates the matrices in submat; you should NOT create them before
6636:    calling it. It also allocates the array of matrix pointers submat.

6638:    For BAIJ matrices the index sets must respect the block structure, that is if they
6639:    request one row/column in a block, they must request all rows/columns that are in
6640:    that block. For example, if the block size is 2 you cannot request just row 0 and
6641:    column 0.

6643:    Fortran Note:
6644:    The Fortran interface is slightly different from that given below; it
6645:    requires one to pass in  as submat a Mat (integer) array of size at least n+1.

6647:    Level: advanced


6650: .seealso: MatDestroySubMatrices(), MatCreateSubMatrix(), MatGetRow(), MatGetDiagonal(), MatReuse
6651: @*/
6652: PetscErrorCode MatCreateSubMatrices(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[])
6653: {
6655:   PetscInt       i;
6656:   PetscBool      eq;

6661:   if (n) {
6666:   }
6668:   if (n && scall == MAT_REUSE_MATRIX) {
6671:   }
6672:   if (!mat->ops->createsubmatrices) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
6673:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6674:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6675:   MatCheckPreallocated(mat,1);

6677:   PetscLogEventBegin(MAT_CreateSubMats,mat,0,0,0);
6678:   (*mat->ops->createsubmatrices)(mat,n,irow,icol,scall,submat);
6679:   PetscLogEventEnd(MAT_CreateSubMats,mat,0,0,0);
6680:   for (i=0; i<n; i++) {
6681:     (*submat)[i]->factortype = MAT_FACTOR_NONE;  /* in case in place factorization was previously done on submatrix */
6682:     if (mat->symmetric || mat->structurally_symmetric || mat->hermitian) {
6683:       ISEqual(irow[i],icol[i],&eq);
6684:       if (eq) {
6685:         if (mat->symmetric) {
6686:           MatSetOption((*submat)[i],MAT_SYMMETRIC,PETSC_TRUE);
6687:         } else if (mat->hermitian) {
6688:           MatSetOption((*submat)[i],MAT_HERMITIAN,PETSC_TRUE);
6689:         } else if (mat->structurally_symmetric) {
6690:           MatSetOption((*submat)[i],MAT_STRUCTURALLY_SYMMETRIC,PETSC_TRUE);
6691:         }
6692:       }
6693:     }
6694:   }
6695:   return(0);
6696: }

6698: /*@C
6699:    MatCreateSubMatricesMPI - Extracts MPI submatrices across a sub communicator of mat (by pairs of IS that may live on subcomms).

6701:    Collective on Mat

6703:    Input Parameters:
6704: +  mat - the matrix
6705: .  n   - the number of submatrixes to be extracted
6706: .  irow, icol - index sets of rows and columns to extract
6707: -  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX

6709:    Output Parameter:
6710: .  submat - the array of submatrices

6712:    Level: advanced


6715: .seealso: MatCreateSubMatrices(), MatCreateSubMatrix(), MatGetRow(), MatGetDiagonal(), MatReuse
6716: @*/
6717: PetscErrorCode MatCreateSubMatricesMPI(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[])
6718: {
6720:   PetscInt       i;
6721:   PetscBool      eq;

6726:   if (n) {
6731:   }
6733:   if (n && scall == MAT_REUSE_MATRIX) {
6736:   }
6737:   if (!mat->ops->createsubmatricesmpi) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
6738:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6739:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6740:   MatCheckPreallocated(mat,1);

6742:   PetscLogEventBegin(MAT_CreateSubMats,mat,0,0,0);
6743:   (*mat->ops->createsubmatricesmpi)(mat,n,irow,icol,scall,submat);
6744:   PetscLogEventEnd(MAT_CreateSubMats,mat,0,0,0);
6745:   for (i=0; i<n; i++) {
6746:     if (mat->symmetric || mat->structurally_symmetric || mat->hermitian) {
6747:       ISEqual(irow[i],icol[i],&eq);
6748:       if (eq) {
6749:         if (mat->symmetric) {
6750:           MatSetOption((*submat)[i],MAT_SYMMETRIC,PETSC_TRUE);
6751:         } else if (mat->hermitian) {
6752:           MatSetOption((*submat)[i],MAT_HERMITIAN,PETSC_TRUE);
6753:         } else if (mat->structurally_symmetric) {
6754:           MatSetOption((*submat)[i],MAT_STRUCTURALLY_SYMMETRIC,PETSC_TRUE);
6755:         }
6756:       }
6757:     }
6758:   }
6759:   return(0);
6760: }

6762: /*@C
6763:    MatDestroyMatrices - Destroys an array of matrices.

6765:    Collective on Mat

6767:    Input Parameters:
6768: +  n - the number of local matrices
6769: -  mat - the matrices (note that this is a pointer to the array of matrices)

6771:    Level: advanced

6773:     Notes:
6774:     Frees not only the matrices, but also the array that contains the matrices
6775:            In Fortran will not free the array.

6777: .seealso: MatCreateSubMatrices() MatDestroySubMatrices()
6778: @*/
6779: PetscErrorCode MatDestroyMatrices(PetscInt n,Mat *mat[])
6780: {
6782:   PetscInt       i;

6785:   if (!*mat) return(0);
6786:   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to destroy negative number of matrices %D",n);

6789:   for (i=0; i<n; i++) {
6790:     MatDestroy(&(*mat)[i]);
6791:   }

6793:   /* memory is allocated even if n = 0 */
6794:   PetscFree(*mat);
6795:   return(0);
6796: }

6798: /*@C
6799:    MatDestroySubMatrices - Destroys a set of matrices obtained with MatCreateSubMatrices().

6801:    Collective on Mat

6803:    Input Parameters:
6804: +  n - the number of local matrices
6805: -  mat - the matrices (note that this is a pointer to the array of matrices, just to match the calling
6806:                        sequence of MatCreateSubMatrices())

6808:    Level: advanced

6810:     Notes:
6811:     Frees not only the matrices, but also the array that contains the matrices
6812:            In Fortran will not free the array.

6814: .seealso: MatCreateSubMatrices()
6815: @*/
6816: PetscErrorCode MatDestroySubMatrices(PetscInt n,Mat *mat[])
6817: {
6819:   Mat            mat0;

6822:   if (!*mat) return(0);
6823:   /* mat[] is an array of length n+1, see MatCreateSubMatrices_xxx() */
6824:   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to destroy negative number of matrices %D",n);

6827:   mat0 = (*mat)[0];
6828:   if (mat0 && mat0->ops->destroysubmatrices) {
6829:     (mat0->ops->destroysubmatrices)(n,mat);
6830:   } else {
6831:     MatDestroyMatrices(n,mat);
6832:   }
6833:   return(0);
6834: }

6836: /*@C
6837:    MatGetSeqNonzeroStructure - Extracts the sequential nonzero structure from a matrix.

6839:    Collective on Mat

6841:    Input Parameters:
6842: .  mat - the matrix

6844:    Output Parameter:
6845: .  matstruct - the sequential matrix with the nonzero structure of mat

6847:   Level: intermediate

6849: .seealso: MatDestroySeqNonzeroStructure(), MatCreateSubMatrices(), MatDestroyMatrices()
6850: @*/
6851: PetscErrorCode MatGetSeqNonzeroStructure(Mat mat,Mat *matstruct)
6852: {


6860:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6861:   MatCheckPreallocated(mat,1);

6863:   if (!mat->ops->getseqnonzerostructure) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Not for matrix type %s\n",((PetscObject)mat)->type_name);
6864:   PetscLogEventBegin(MAT_GetSeqNonzeroStructure,mat,0,0,0);
6865:   (*mat->ops->getseqnonzerostructure)(mat,matstruct);
6866:   PetscLogEventEnd(MAT_GetSeqNonzeroStructure,mat,0,0,0);
6867:   return(0);
6868: }

6870: /*@C
6871:    MatDestroySeqNonzeroStructure - Destroys matrix obtained with MatGetSeqNonzeroStructure().

6873:    Collective on Mat

6875:    Input Parameters:
6876: .  mat - the matrix (note that this is a pointer to the array of matrices, just to match the calling
6877:                        sequence of MatGetSequentialNonzeroStructure())

6879:    Level: advanced

6881:     Notes:
6882:     Frees not only the matrices, but also the array that contains the matrices

6884: .seealso: MatGetSeqNonzeroStructure()
6885: @*/
6886: PetscErrorCode MatDestroySeqNonzeroStructure(Mat *mat)
6887: {

6892:   MatDestroy(mat);
6893:   return(0);
6894: }

6896: /*@
6897:    MatIncreaseOverlap - Given a set of submatrices indicated by index sets,
6898:    replaces the index sets by larger ones that represent submatrices with
6899:    additional overlap.

6901:    Collective on Mat

6903:    Input Parameters:
6904: +  mat - the matrix
6905: .  n   - the number of index sets
6906: .  is  - the array of index sets (these index sets will changed during the call)
6907: -  ov  - the additional overlap requested

6909:    Options Database:
6910: .  -mat_increase_overlap_scalable - use a scalable algorithm to compute the overlap (supported by MPIAIJ matrix)

6912:    Level: developer


6915: .seealso: MatCreateSubMatrices()
6916: @*/
6917: PetscErrorCode MatIncreaseOverlap(Mat mat,PetscInt n,IS is[],PetscInt ov)
6918: {

6924:   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Must have one or more domains, you have %D",n);
6925:   if (n) {
6928:   }
6929:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6930:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6931:   MatCheckPreallocated(mat,1);

6933:   if (!ov) return(0);
6934:   if (!mat->ops->increaseoverlap) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
6935:   PetscLogEventBegin(MAT_IncreaseOverlap,mat,0,0,0);
6936:   (*mat->ops->increaseoverlap)(mat,n,is,ov);
6937:   PetscLogEventEnd(MAT_IncreaseOverlap,mat,0,0,0);
6938:   return(0);
6939: }


6942: PetscErrorCode MatIncreaseOverlapSplit_Single(Mat,IS*,PetscInt);

6944: /*@
6945:    MatIncreaseOverlapSplit - Given a set of submatrices indicated by index sets across
6946:    a sub communicator, replaces the index sets by larger ones that represent submatrices with
6947:    additional overlap.

6949:    Collective on Mat

6951:    Input Parameters:
6952: +  mat - the matrix
6953: .  n   - the number of index sets
6954: .  is  - the array of index sets (these index sets will changed during the call)
6955: -  ov  - the additional overlap requested

6957:    Options Database:
6958: .  -mat_increase_overlap_scalable - use a scalable algorithm to compute the overlap (supported by MPIAIJ matrix)

6960:    Level: developer


6963: .seealso: MatCreateSubMatrices()
6964: @*/
6965: PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov)
6966: {
6967:   PetscInt       i;

6973:   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Must have one or more domains, you have %D",n);
6974:   if (n) {
6977:   }
6978:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6979:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6980:   MatCheckPreallocated(mat,1);
6981:   if (!ov) return(0);
6982:   PetscLogEventBegin(MAT_IncreaseOverlap,mat,0,0,0);
6983:   for(i=0; i<n; i++){
6984:          MatIncreaseOverlapSplit_Single(mat,&is[i],ov);
6985:   }
6986:   PetscLogEventEnd(MAT_IncreaseOverlap,mat,0,0,0);
6987:   return(0);
6988: }




6993: /*@
6994:    MatGetBlockSize - Returns the matrix block size.

6996:    Not Collective

6998:    Input Parameter:
6999: .  mat - the matrix

7001:    Output Parameter:
7002: .  bs - block size

7004:    Notes:
7005:     Block row formats are MATSEQBAIJ, MATMPIBAIJ, MATSEQSBAIJ, MATMPISBAIJ. These formats ALWAYS have square block storage in the matrix.

7007:    If the block size has not been set yet this routine returns 1.

7009:    Level: intermediate

7011: .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSizes()
7012: @*/
7013: PetscErrorCode MatGetBlockSize(Mat mat,PetscInt *bs)
7014: {
7018:   *bs = PetscAbs(mat->rmap->bs);
7019:   return(0);
7020: }

7022: /*@
7023:    MatGetBlockSizes - Returns the matrix block row and column sizes.

7025:    Not Collective

7027:    Input Parameter:
7028: .  mat - the matrix

7030:    Output Parameter:
7031: +  rbs - row block size
7032: -  cbs - column block size

7034:    Notes:
7035:     Block row formats are MATSEQBAIJ, MATMPIBAIJ, MATSEQSBAIJ, MATMPISBAIJ. These formats ALWAYS have square block storage in the matrix.
7036:     If you pass a different block size for the columns than the rows, the row block size determines the square block storage.

7038:    If a block size has not been set yet this routine returns 1.

7040:    Level: intermediate

7042: .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSize(), MatSetBlockSizes()
7043: @*/
7044: PetscErrorCode MatGetBlockSizes(Mat mat,PetscInt *rbs, PetscInt *cbs)
7045: {
7050:   if (rbs) *rbs = PetscAbs(mat->rmap->bs);
7051:   if (cbs) *cbs = PetscAbs(mat->cmap->bs);
7052:   return(0);
7053: }

7055: /*@
7056:    MatSetBlockSize - Sets the matrix block size.

7058:    Logically Collective on Mat

7060:    Input Parameters:
7061: +  mat - the matrix
7062: -  bs - block size

7064:    Notes:
7065:     Block row formats are MATSEQBAIJ, MATMPIBAIJ, MATSEQSBAIJ, MATMPISBAIJ. These formats ALWAYS have square block storage in the matrix.
7066:     This must be called before MatSetUp() or MatXXXSetPreallocation() (or will default to 1) and the block size cannot be changed later.

7068:     For MATMPIAIJ and MATSEQAIJ matrix formats, this function can be called at a later stage, provided that the specified block size
7069:     is compatible with the matrix local sizes.

7071:    Level: intermediate

7073: .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSizes(), MatGetBlockSizes()
7074: @*/
7075: PetscErrorCode MatSetBlockSize(Mat mat,PetscInt bs)
7076: {

7082:   MatSetBlockSizes(mat,bs,bs);
7083:   return(0);
7084: }

7086: /*@
7087:    MatSetVariableBlockSizes - Sets a diagonal blocks of the matrix that need not be of the same size

7089:    Logically Collective on Mat

7091:    Input Parameters:
7092: +  mat - the matrix
7093: .  nblocks - the number of blocks on this process
7094: -  bsizes - the block sizes

7096:    Notes:
7097:     Currently used by PCVPBJACOBI for SeqAIJ matrices

7099:    Level: intermediate

7101: .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSizes(), MatGetBlockSizes(), MatGetVariableBlockSizes()
7102: @*/
7103: PetscErrorCode MatSetVariableBlockSizes(Mat mat,PetscInt nblocks,PetscInt *bsizes)
7104: {
7106:   PetscInt       i,ncnt = 0, nlocal;

7110:   if (nblocks < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Number of local blocks must be great than or equal to zero");
7111:   MatGetLocalSize(mat,&nlocal,NULL);
7112:   for (i=0; i<nblocks; i++) ncnt += bsizes[i];
7113:   if (ncnt != nlocal) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Sum of local block sizes %D does not equal local size of matrix %D",ncnt,nlocal);
7114:   PetscFree(mat->bsizes);
7115:   mat->nblocks = nblocks;
7116:   PetscMalloc1(nblocks,&mat->bsizes);
7117:   PetscArraycpy(mat->bsizes,bsizes,nblocks);
7118:   return(0);
7119: }

7121: /*@C
7122:    MatGetVariableBlockSizes - Gets a diagonal blocks of the matrix that need not be of the same size

7124:    Logically Collective on Mat

7126:    Input Parameters:
7127: .  mat - the matrix

7129:    Output Parameters:
7130: +  nblocks - the number of blocks on this process
7131: -  bsizes - the block sizes

7133:    Notes: Currently not supported from Fortran

7135:    Level: intermediate

7137: .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSizes(), MatGetBlockSizes(), MatSetVariableBlockSizes()
7138: @*/
7139: PetscErrorCode MatGetVariableBlockSizes(Mat mat,PetscInt *nblocks,const PetscInt **bsizes)
7140: {
7143:   *nblocks = mat->nblocks;
7144:   *bsizes  = mat->bsizes;
7145:   return(0);
7146: }

7148: /*@
7149:    MatSetBlockSizes - Sets the matrix block row and column sizes.

7151:    Logically Collective on Mat

7153:    Input Parameters:
7154: +  mat - the matrix
7155: -  rbs - row block size
7156: -  cbs - column block size

7158:    Notes:
7159:     Block row formats are MATSEQBAIJ, MATMPIBAIJ, MATSEQSBAIJ, MATMPISBAIJ. These formats ALWAYS have square block storage in the matrix.
7160:     If you pass a different block size for the columns than the rows, the row block size determines the square block storage.
7161:     This must be called before MatSetUp() or MatXXXSetPreallocation() (or will default to 1) and the block size cannot be changed later

7163:     For MATMPIAIJ and MATSEQAIJ matrix formats, this function can be called at a later stage, provided that the specified block sizes
7164:     are compatible with the matrix local sizes.

7166:     The row and column block size determine the blocksize of the "row" and "column" vectors returned by MatCreateVecs().

7168:    Level: intermediate

7170: .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSize(), MatGetBlockSizes()
7171: @*/
7172: PetscErrorCode MatSetBlockSizes(Mat mat,PetscInt rbs,PetscInt cbs)
7173: {

7180:   if (mat->ops->setblocksizes) {
7181:     (*mat->ops->setblocksizes)(mat,rbs,cbs);
7182:   }
7183:   if (mat->rmap->refcnt) {
7184:     ISLocalToGlobalMapping l2g = NULL;
7185:     PetscLayout            nmap = NULL;

7187:     PetscLayoutDuplicate(mat->rmap,&nmap);
7188:     if (mat->rmap->mapping) {
7189:       ISLocalToGlobalMappingDuplicate(mat->rmap->mapping,&l2g);
7190:     }
7191:     PetscLayoutDestroy(&mat->rmap);
7192:     mat->rmap = nmap;
7193:     mat->rmap->mapping = l2g;
7194:   }
7195:   if (mat->cmap->refcnt) {
7196:     ISLocalToGlobalMapping l2g = NULL;
7197:     PetscLayout            nmap = NULL;

7199:     PetscLayoutDuplicate(mat->cmap,&nmap);
7200:     if (mat->cmap->mapping) {
7201:       ISLocalToGlobalMappingDuplicate(mat->cmap->mapping,&l2g);
7202:     }
7203:     PetscLayoutDestroy(&mat->cmap);
7204:     mat->cmap = nmap;
7205:     mat->cmap->mapping = l2g;
7206:   }
7207:   PetscLayoutSetBlockSize(mat->rmap,rbs);
7208:   PetscLayoutSetBlockSize(mat->cmap,cbs);
7209:   return(0);
7210: }

7212: /*@
7213:    MatSetBlockSizesFromMats - Sets the matrix block row and column sizes to match a pair of matrices

7215:    Logically Collective on Mat

7217:    Input Parameters:
7218: +  mat - the matrix
7219: .  fromRow - matrix from which to copy row block size
7220: -  fromCol - matrix from which to copy column block size (can be same as fromRow)

7222:    Level: developer

7224: .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSizes()
7225: @*/
7226: PetscErrorCode MatSetBlockSizesFromMats(Mat mat,Mat fromRow,Mat fromCol)
7227: {

7234:   if (fromRow->rmap->bs > 0) {PetscLayoutSetBlockSize(mat->rmap,fromRow->rmap->bs);}
7235:   if (fromCol->cmap->bs > 0) {PetscLayoutSetBlockSize(mat->cmap,fromCol->cmap->bs);}
7236:   return(0);
7237: }

7239: /*@
7240:    MatResidual - Default routine to calculate the residual.

7242:    Collective on Mat

7244:    Input Parameters:
7245: +  mat - the matrix
7246: .  b   - the right-hand-side
7247: -  x   - the approximate solution

7249:    Output Parameter:
7250: .  r - location to store the residual

7252:    Level: developer

7254: .seealso: PCMGSetResidual()
7255: @*/
7256: PetscErrorCode MatResidual(Mat mat,Vec b,Vec x,Vec r)
7257: {

7266:   MatCheckPreallocated(mat,1);
7267:   PetscLogEventBegin(MAT_Residual,mat,0,0,0);
7268:   if (!mat->ops->residual) {
7269:     MatMult(mat,x,r);
7270:     VecAYPX(r,-1.0,b);
7271:   } else {
7272:     (*mat->ops->residual)(mat,b,x,r);
7273:   }
7274:   PetscLogEventEnd(MAT_Residual,mat,0,0,0);
7275:   return(0);
7276: }

7278: /*@C
7279:     MatGetRowIJ - Returns the compressed row storage i and j indices for sequential matrices.

7281:    Collective on Mat

7283:     Input Parameters:
7284: +   mat - the matrix
7285: .   shift -  0 or 1 indicating we want the indices starting at 0 or 1
7286: .   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be   symmetrized
7287: -   inodecompressed - PETSC_TRUE or PETSC_FALSE  indicating if the nonzero structure of the
7288:                  inodes or the nonzero elements is wanted. For BAIJ matrices the compressed version is
7289:                  always used.

7291:     Output Parameters:
7292: +   n - number of rows in the (possibly compressed) matrix
7293: .   ia - the row pointers; that is ia[0] = 0, ia[row] = ia[row-1] + number of elements in that row of the matrix
7294: .   ja - the column indices
7295: -   done - indicates if the routine actually worked and returned appropriate ia[] and ja[] arrays; callers
7296:            are responsible for handling the case when done == PETSC_FALSE and ia and ja are not set

7298:     Level: developer

7300:     Notes:
7301:     You CANNOT change any of the ia[] or ja[] values.

7303:     Use MatRestoreRowIJ() when you are finished accessing the ia[] and ja[] values.

7305:     Fortran Notes:
7306:     In Fortran use
7307: $
7308: $      PetscInt ia(1), ja(1)
7309: $      PetscOffset iia, jja
7310: $      call MatGetRowIJ(mat,shift,symmetric,inodecompressed,n,ia,iia,ja,jja,done,ierr)
7311: $      ! Access the ith and jth entries via ia(iia + i) and ja(jja + j)

7313:      or
7314: $
7315: $    PetscInt, pointer :: ia(:),ja(:)
7316: $    call MatGetRowIJF90(mat,shift,symmetric,inodecompressed,n,ia,ja,done,ierr)
7317: $    ! Access the ith and jth entries via ia(i) and ja(j)

7319: .seealso: MatGetColumnIJ(), MatRestoreRowIJ(), MatSeqAIJGetArray()
7320: @*/
7321: PetscErrorCode MatGetRowIJ(Mat mat,PetscInt shift,PetscBool symmetric,PetscBool inodecompressed,PetscInt *n,const PetscInt *ia[],const PetscInt *ja[],PetscBool  *done)
7322: {

7332:   MatCheckPreallocated(mat,1);
7333:   if (!mat->ops->getrowij) *done = PETSC_FALSE;
7334:   else {
7335:     *done = PETSC_TRUE;
7336:     PetscLogEventBegin(MAT_GetRowIJ,mat,0,0,0);
7337:     (*mat->ops->getrowij)(mat,shift,symmetric,inodecompressed,n,ia,ja,done);
7338:     PetscLogEventEnd(MAT_GetRowIJ,mat,0,0,0);
7339:   }
7340:   return(0);
7341: }

7343: /*@C
7344:     MatGetColumnIJ - Returns the compressed column storage i and j indices for sequential matrices.

7346:     Collective on Mat

7348:     Input Parameters:
7349: +   mat - the matrix
7350: .   shift - 1 or zero indicating we want the indices starting at 0 or 1
7351: .   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
7352:                 symmetrized
7353: .   inodecompressed - PETSC_TRUE or PETSC_FALSE indicating if the nonzero structure of the
7354:                  inodes or the nonzero elements is wanted. For BAIJ matrices the compressed version is
7355:                  always used.
7356: .   n - number of columns in the (possibly compressed) matrix
7357: .   ia - the column pointers; that is ia[0] = 0, ia[col] = i[col-1] + number of elements in that col of the matrix
7358: -   ja - the row indices

7360:     Output Parameters:
7361: .   done - PETSC_TRUE or PETSC_FALSE, indicating whether the values have been returned

7363:     Level: developer

7365: .seealso: MatGetRowIJ(), MatRestoreColumnIJ()
7366: @*/
7367: PetscErrorCode MatGetColumnIJ(Mat mat,PetscInt shift,PetscBool symmetric,PetscBool inodecompressed,PetscInt *n,const PetscInt *ia[],const PetscInt *ja[],PetscBool  *done)
7368: {

7378:   MatCheckPreallocated(mat,1);
7379:   if (!mat->ops->getcolumnij) *done = PETSC_FALSE;
7380:   else {
7381:     *done = PETSC_TRUE;
7382:     (*mat->ops->getcolumnij)(mat,shift,symmetric,inodecompressed,n,ia,ja,done);
7383:   }
7384:   return(0);
7385: }

7387: /*@C
7388:     MatRestoreRowIJ - Call after you are completed with the ia,ja indices obtained with
7389:     MatGetRowIJ().

7391:     Collective on Mat

7393:     Input Parameters:
7394: +   mat - the matrix
7395: .   shift - 1 or zero indicating we want the indices starting at 0 or 1
7396: .   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
7397:                 symmetrized
7398: .   inodecompressed -  PETSC_TRUE or PETSC_FALSE indicating if the nonzero structure of the
7399:                  inodes or the nonzero elements is wanted. For BAIJ matrices the compressed version is
7400:                  always used.
7401: .   n - size of (possibly compressed) matrix
7402: .   ia - the row pointers
7403: -   ja - the column indices

7405:     Output Parameters:
7406: .   done - PETSC_TRUE or PETSC_FALSE indicated that the values have been returned

7408:     Note:
7409:     This routine zeros out n, ia, and ja. This is to prevent accidental
7410:     us of the array after it has been restored. If you pass NULL, it will
7411:     not zero the pointers.  Use of ia or ja after MatRestoreRowIJ() is invalid.

7413:     Level: developer

7415: .seealso: MatGetRowIJ(), MatRestoreColumnIJ()
7416: @*/
7417: PetscErrorCode MatRestoreRowIJ(Mat mat,PetscInt shift,PetscBool symmetric,PetscBool inodecompressed,PetscInt *n,const PetscInt *ia[],const PetscInt *ja[],PetscBool  *done)
7418: {

7427:   MatCheckPreallocated(mat,1);

7429:   if (!mat->ops->restorerowij) *done = PETSC_FALSE;
7430:   else {
7431:     *done = PETSC_TRUE;
7432:     (*mat->ops->restorerowij)(mat,shift,symmetric,inodecompressed,n,ia,ja,done);
7433:     if (n)  *n = 0;
7434:     if (ia) *ia = NULL;
7435:     if (ja) *ja = NULL;
7436:   }
7437:   return(0);
7438: }

7440: /*@C
7441:     MatRestoreColumnIJ - Call after you are completed with the ia,ja indices obtained with
7442:     MatGetColumnIJ().

7444:     Collective on Mat

7446:     Input Parameters:
7447: +   mat - the matrix
7448: .   shift - 1 or zero indicating we want the indices starting at 0 or 1
7449: -   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
7450:                 symmetrized
7451: -   inodecompressed - PETSC_TRUE or PETSC_FALSE indicating if the nonzero structure of the
7452:                  inodes or the nonzero elements is wanted. For BAIJ matrices the compressed version is
7453:                  always used.

7455:     Output Parameters:
7456: +   n - size of (possibly compressed) matrix
7457: .   ia - the column pointers
7458: .   ja - the row indices
7459: -   done - PETSC_TRUE or PETSC_FALSE indicated that the values have been returned

7461:     Level: developer

7463: .seealso: MatGetColumnIJ(), MatRestoreRowIJ()
7464: @*/
7465: PetscErrorCode MatRestoreColumnIJ(Mat mat,PetscInt shift,PetscBool symmetric,PetscBool inodecompressed,PetscInt *n,const PetscInt *ia[],const PetscInt *ja[],PetscBool  *done)
7466: {

7475:   MatCheckPreallocated(mat,1);

7477:   if (!mat->ops->restorecolumnij) *done = PETSC_FALSE;
7478:   else {
7479:     *done = PETSC_TRUE;
7480:     (*mat->ops->restorecolumnij)(mat,shift,symmetric,inodecompressed,n,ia,ja,done);
7481:     if (n)  *n = 0;
7482:     if (ia) *ia = NULL;
7483:     if (ja) *ja = NULL;
7484:   }
7485:   return(0);
7486: }

7488: /*@C
7489:     MatColoringPatch -Used inside matrix coloring routines that
7490:     use MatGetRowIJ() and/or MatGetColumnIJ().

7492:     Collective on Mat

7494:     Input Parameters:
7495: +   mat - the matrix
7496: .   ncolors - max color value
7497: .   n   - number of entries in colorarray
7498: -   colorarray - array indicating color for each column

7500:     Output Parameters:
7501: .   iscoloring - coloring generated using colorarray information

7503:     Level: developer

7505: .seealso: MatGetRowIJ(), MatGetColumnIJ()

7507: @*/
7508: PetscErrorCode MatColoringPatch(Mat mat,PetscInt ncolors,PetscInt n,ISColoringValue colorarray[],ISColoring *iscoloring)
7509: {

7517:   MatCheckPreallocated(mat,1);

7519:   if (!mat->ops->coloringpatch) {
7520:     ISColoringCreate(PetscObjectComm((PetscObject)mat),ncolors,n,colorarray,PETSC_OWN_POINTER,iscoloring);
7521:   } else {
7522:     (*mat->ops->coloringpatch)(mat,ncolors,n,colorarray,iscoloring);
7523:   }
7524:   return(0);
7525: }


7528: /*@
7529:    MatSetUnfactored - Resets a factored matrix to be treated as unfactored.

7531:    Logically Collective on Mat

7533:    Input Parameter:
7534: .  mat - the factored matrix to be reset

7536:    Notes:
7537:    This routine should be used only with factored matrices formed by in-place
7538:    factorization via ILU(0) (or by in-place LU factorization for the MATSEQDENSE
7539:    format).  This option can save memory, for example, when solving nonlinear
7540:    systems with a matrix-free Newton-Krylov method and a matrix-based, in-place
7541:    ILU(0) preconditioner.

7543:    Note that one can specify in-place ILU(0) factorization by calling
7544: .vb
7545:      PCType(pc,PCILU);
7546:      PCFactorSeUseInPlace(pc);
7547: .ve
7548:    or by using the options -pc_type ilu -pc_factor_in_place

7550:    In-place factorization ILU(0) can also be used as a local
7551:    solver for the blocks within the block Jacobi or additive Schwarz
7552:    methods (runtime option: -sub_pc_factor_in_place).  See Users-Manual: ch_pc
7553:    for details on setting local solver options.

7555:    Most users should employ the simplified KSP interface for linear solvers
7556:    instead of working directly with matrix algebra routines such as this.
7557:    See, e.g., KSPCreate().

7559:    Level: developer

7561: .seealso: PCFactorSetUseInPlace(), PCFactorGetUseInPlace()

7563: @*/
7564: PetscErrorCode MatSetUnfactored(Mat mat)
7565: {

7571:   MatCheckPreallocated(mat,1);
7572:   mat->factortype = MAT_FACTOR_NONE;
7573:   if (!mat->ops->setunfactored) return(0);
7574:   (*mat->ops->setunfactored)(mat);
7575:   return(0);
7576: }

7578: /*MC
7579:     MatDenseGetArrayF90 - Accesses a matrix array from Fortran90.

7581:     Synopsis:
7582:     MatDenseGetArrayF90(Mat x,{Scalar, pointer :: xx_v(:,:)},integer ierr)

7584:     Not collective

7586:     Input Parameter:
7587: .   x - matrix

7589:     Output Parameters:
7590: +   xx_v - the Fortran90 pointer to the array
7591: -   ierr - error code

7593:     Example of Usage:
7594: .vb
7595:       PetscScalar, pointer xx_v(:,:)
7596:       ....
7597:       call MatDenseGetArrayF90(x,xx_v,ierr)
7598:       a = xx_v(3)
7599:       call MatDenseRestoreArrayF90(x,xx_v,ierr)
7600: .ve

7602:     Level: advanced

7604: .seealso:  MatDenseRestoreArrayF90(), MatDenseGetArray(), MatDenseRestoreArray(), MatSeqAIJGetArrayF90()

7606: M*/

7608: /*MC
7609:     MatDenseRestoreArrayF90 - Restores a matrix array that has been
7610:     accessed with MatDenseGetArrayF90().

7612:     Synopsis:
7613:     MatDenseRestoreArrayF90(Mat x,{Scalar, pointer :: xx_v(:,:)},integer ierr)

7615:     Not collective

7617:     Input Parameters:
7618: +   x - matrix
7619: -   xx_v - the Fortran90 pointer to the array

7621:     Output Parameter:
7622: .   ierr - error code

7624:     Example of Usage:
7625: .vb
7626:        PetscScalar, pointer xx_v(:,:)
7627:        ....
7628:        call MatDenseGetArrayF90(x,xx_v,ierr)
7629:        a = xx_v(3)
7630:        call MatDenseRestoreArrayF90(x,xx_v,ierr)
7631: .ve

7633:     Level: advanced

7635: .seealso:  MatDenseGetArrayF90(), MatDenseGetArray(), MatDenseRestoreArray(), MatSeqAIJRestoreArrayF90()

7637: M*/


7640: /*MC
7641:     MatSeqAIJGetArrayF90 - Accesses a matrix array from Fortran90.

7643:     Synopsis:
7644:     MatSeqAIJGetArrayF90(Mat x,{Scalar, pointer :: xx_v(:)},integer ierr)

7646:     Not collective

7648:     Input Parameter:
7649: .   x - matrix

7651:     Output Parameters:
7652: +   xx_v - the Fortran90 pointer to the array
7653: -   ierr - error code

7655:     Example of Usage:
7656: .vb
7657:       PetscScalar, pointer xx_v(:)
7658:       ....
7659:       call MatSeqAIJGetArrayF90(x,xx_v,ierr)
7660:       a = xx_v(3)
7661:       call MatSeqAIJRestoreArrayF90(x,xx_v,ierr)
7662: .ve

7664:     Level: advanced

7666: .seealso:  MatSeqAIJRestoreArrayF90(), MatSeqAIJGetArray(), MatSeqAIJRestoreArray(), MatDenseGetArrayF90()

7668: M*/

7670: /*MC
7671:     MatSeqAIJRestoreArrayF90 - Restores a matrix array that has been
7672:     accessed with MatSeqAIJGetArrayF90().

7674:     Synopsis:
7675:     MatSeqAIJRestoreArrayF90(Mat x,{Scalar, pointer :: xx_v(:)},integer ierr)

7677:     Not collective

7679:     Input Parameters:
7680: +   x - matrix
7681: -   xx_v - the Fortran90 pointer to the array

7683:     Output Parameter:
7684: .   ierr - error code

7686:     Example of Usage:
7687: .vb
7688:        PetscScalar, pointer xx_v(:)
7689:        ....
7690:        call MatSeqAIJGetArrayF90(x,xx_v,ierr)
7691:        a = xx_v(3)
7692:        call MatSeqAIJRestoreArrayF90(x,xx_v,ierr)
7693: .ve

7695:     Level: advanced

7697: .seealso:  MatSeqAIJGetArrayF90(), MatSeqAIJGetArray(), MatSeqAIJRestoreArray(), MatDenseRestoreArrayF90()

7699: M*/


7702: /*@
7703:     MatCreateSubMatrix - Gets a single submatrix on the same number of processors
7704:                       as the original matrix.

7706:     Collective on Mat

7708:     Input Parameters:
7709: +   mat - the original matrix
7710: .   isrow - parallel IS containing the rows this processor should obtain
7711: .   iscol - parallel IS containing all columns you wish to keep. Each process should list the columns that will be in IT's "diagonal part" in the new matrix.
7712: -   cll - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX

7714:     Output Parameter:
7715: .   newmat - the new submatrix, of the same type as the old

7717:     Level: advanced

7719:     Notes:
7720:     The submatrix will be able to be multiplied with vectors using the same layout as iscol.

7722:     Some matrix types place restrictions on the row and column indices, such
7723:     as that they be sorted or that they be equal to each other.

7725:     The index sets may not have duplicate entries.

7727:       The first time this is called you should use a cll of MAT_INITIAL_MATRIX,
7728:    the MatCreateSubMatrix() routine will create the newmat for you. Any additional calls
7729:    to this routine with a mat of the same nonzero structure and with a call of MAT_REUSE_MATRIX
7730:    will reuse the matrix generated the first time.  You should call MatDestroy() on newmat when
7731:    you are finished using it.

7733:     The communicator of the newly obtained matrix is ALWAYS the same as the communicator of
7734:     the input matrix.

7736:     If iscol is NULL then all columns are obtained (not supported in Fortran).

7738:    Example usage:
7739:    Consider the following 8x8 matrix with 34 non-zero values, that is
7740:    assembled across 3 processors. Let's assume that proc0 owns 3 rows,
7741:    proc1 owns 3 rows, proc2 owns 2 rows. This division can be shown
7742:    as follows:

7744: .vb
7745:             1  2  0  |  0  3  0  |  0  4
7746:     Proc0   0  5  6  |  7  0  0  |  8  0
7747:             9  0 10  | 11  0  0  | 12  0
7748:     -------------------------------------
7749:            13  0 14  | 15 16 17  |  0  0
7750:     Proc1   0 18  0  | 19 20 21  |  0  0
7751:             0  0  0  | 22 23  0  | 24  0
7752:     -------------------------------------
7753:     Proc2  25 26 27  |  0  0 28  | 29  0
7754:            30  0  0  | 31 32 33  |  0 34
7755: .ve

7757:     Suppose isrow = [0 1 | 4 | 6 7] and iscol = [1 2 | 3 4 5 | 6].  The resulting submatrix is

7759: .vb
7760:             2  0  |  0  3  0  |  0
7761:     Proc0   5  6  |  7  0  0  |  8
7762:     -------------------------------
7763:     Proc1  18  0  | 19 20 21  |  0
7764:     -------------------------------
7765:     Proc2  26 27  |  0  0 28  | 29
7766:             0  0  | 31 32 33  |  0
7767: .ve


7770: .seealso: MatCreateSubMatrices(), MatCreateSubMatricesMPI(), MatCreateSubMatrixVirtual(), MatSubMatrixVirtualUpdate()
7771: @*/
7772: PetscErrorCode MatCreateSubMatrix(Mat mat,IS isrow,IS iscol,MatReuse cll,Mat *newmat)
7773: {
7775:   PetscMPIInt    size;
7776:   Mat            *local;
7777:   IS             iscoltmp;

7786:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
7787:   if (cll == MAT_IGNORE_MATRIX) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Cannot use MAT_IGNORE_MATRIX");

7789:   MatCheckPreallocated(mat,1);
7790:   MPI_Comm_size(PetscObjectComm((PetscObject)mat),&size);

7792:   if (!iscol || isrow == iscol) {
7793:     PetscBool   stride;
7794:     PetscMPIInt grabentirematrix = 0,grab;
7795:     PetscObjectTypeCompare((PetscObject)isrow,ISSTRIDE,&stride);
7796:     if (stride) {
7797:       PetscInt first,step,n,rstart,rend;
7798:       ISStrideGetInfo(isrow,&first,&step);
7799:       if (step == 1) {
7800:         MatGetOwnershipRange(mat,&rstart,&rend);
7801:         if (rstart == first) {
7802:           ISGetLocalSize(isrow,&n);
7803:           if (n == rend-rstart) {
7804:             grabentirematrix = 1;
7805:           }
7806:         }
7807:       }
7808:     }
7809:     MPIU_Allreduce(&grabentirematrix,&grab,1,MPI_INT,MPI_MIN,PetscObjectComm((PetscObject)mat));
7810:     if (grab) {
7811:       PetscInfo(mat,"Getting entire matrix as submatrix\n");
7812:       if (cll == MAT_INITIAL_MATRIX) {
7813:         *newmat = mat;
7814:         PetscObjectReference((PetscObject)mat);
7815:       }
7816:       return(0);
7817:     }
7818:   }

7820:   if (!iscol) {
7821:     ISCreateStride(PetscObjectComm((PetscObject)mat),mat->cmap->n,mat->cmap->rstart,1,&iscoltmp);
7822:   } else {
7823:     iscoltmp = iscol;
7824:   }

7826:   /* if original matrix is on just one processor then use submatrix generated */
7827:   if (mat->ops->createsubmatrices && !mat->ops->createsubmatrix && size == 1 && cll == MAT_REUSE_MATRIX) {
7828:     MatCreateSubMatrices(mat,1,&isrow,&iscoltmp,MAT_REUSE_MATRIX,&newmat);
7829:     goto setproperties;
7830:   } else if (mat->ops->createsubmatrices && !mat->ops->createsubmatrix && size == 1) {
7831:     MatCreateSubMatrices(mat,1,&isrow,&iscoltmp,MAT_INITIAL_MATRIX,&local);
7832:     *newmat = *local;
7833:     PetscFree(local);
7834:     goto setproperties;
7835:   } else if (!mat->ops->createsubmatrix) {
7836:     /* Create a new matrix type that implements the operation using the full matrix */
7837:     PetscLogEventBegin(MAT_CreateSubMat,mat,0,0,0);
7838:     switch (cll) {
7839:     case MAT_INITIAL_MATRIX:
7840:       MatCreateSubMatrixVirtual(mat,isrow,iscoltmp,newmat);
7841:       break;
7842:     case MAT_REUSE_MATRIX:
7843:       MatSubMatrixVirtualUpdate(*newmat,mat,isrow,iscoltmp);
7844:       break;
7845:     default: SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Invalid MatReuse, must be either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX");
7846:     }
7847:     PetscLogEventEnd(MAT_CreateSubMat,mat,0,0,0);
7848:     goto setproperties;
7849:   }

7851:   if (!mat->ops->createsubmatrix) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
7852:   PetscLogEventBegin(MAT_CreateSubMat,mat,0,0,0);
7853:   (*mat->ops->createsubmatrix)(mat,isrow,iscoltmp,cll,newmat);
7854:   PetscLogEventEnd(MAT_CreateSubMat,mat,0,0,0);

7856:   /* Propagate symmetry information for diagonal blocks */
7857: setproperties:
7858:   if (isrow == iscoltmp) {
7859:     if (mat->symmetric_set && mat->symmetric) {
7860:       MatSetOption(*newmat,MAT_SYMMETRIC,PETSC_TRUE);
7861:     }
7862:     if (mat->structurally_symmetric_set && mat->structurally_symmetric) {
7863:       MatSetOption(*newmat,MAT_STRUCTURALLY_SYMMETRIC,PETSC_TRUE);
7864:     }
7865:     if (mat->hermitian_set && mat->hermitian) {
7866:       MatSetOption(*newmat,MAT_HERMITIAN,PETSC_TRUE);
7867:     }
7868:     if (mat->spd_set && mat->spd) {
7869:       MatSetOption(*newmat,MAT_SPD,PETSC_TRUE);
7870:     }
7871:   }

7873:   if (!iscol) {ISDestroy(&iscoltmp);}
7874:   if (*newmat && cll == MAT_INITIAL_MATRIX) {PetscObjectStateIncrease((PetscObject)*newmat);}
7875:   return(0);
7876: }

7878: /*@
7879:    MatStashSetInitialSize - sets the sizes of the matrix stash, that is
7880:    used during the assembly process to store values that belong to
7881:    other processors.

7883:    Not Collective

7885:    Input Parameters:
7886: +  mat   - the matrix
7887: .  size  - the initial size of the stash.
7888: -  bsize - the initial size of the block-stash(if used).

7890:    Options Database Keys:
7891: +   -matstash_initial_size <size> or <size0,size1,...sizep-1>
7892: -   -matstash_block_initial_size <bsize>  or <bsize0,bsize1,...bsizep-1>

7894:    Level: intermediate

7896:    Notes:
7897:      The block-stash is used for values set with MatSetValuesBlocked() while
7898:      the stash is used for values set with MatSetValues()

7900:      Run with the option -info and look for output of the form
7901:      MatAssemblyBegin_MPIXXX:Stash has MM entries, uses nn mallocs.
7902:      to determine the appropriate value, MM, to use for size and
7903:      MatAssemblyBegin_MPIXXX:Block-Stash has BMM entries, uses nn mallocs.
7904:      to determine the value, BMM to use for bsize


7907: .seealso: MatAssemblyBegin(), MatAssemblyEnd(), Mat, MatStashGetInfo()

7909: @*/
7910: PetscErrorCode MatStashSetInitialSize(Mat mat,PetscInt size, PetscInt bsize)
7911: {

7917:   MatStashSetInitialSize_Private(&mat->stash,size);
7918:   MatStashSetInitialSize_Private(&mat->bstash,bsize);
7919:   return(0);
7920: }

7922: /*@
7923:    MatInterpolateAdd - w = y + A*x or A'*x depending on the shape of
7924:      the matrix

7926:    Neighbor-wise Collective on Mat

7928:    Input Parameters:
7929: +  mat   - the matrix
7930: .  x,y - the vectors
7931: -  w - where the result is stored

7933:    Level: intermediate

7935:    Notes:
7936:     w may be the same vector as y.

7938:     This allows one to use either the restriction or interpolation (its transpose)
7939:     matrix to do the interpolation

7941: .seealso: MatMultAdd(), MatMultTransposeAdd(), MatRestrict()

7943: @*/
7944: PetscErrorCode MatInterpolateAdd(Mat A,Vec x,Vec y,Vec w)
7945: {
7947:   PetscInt       M,N,Ny;

7955:   MatCheckPreallocated(A,1);
7956:   MatGetSize(A,&M,&N);
7957:   VecGetSize(y,&Ny);
7958:   if (M == Ny) {
7959:     MatMultAdd(A,x,y,w);
7960:   } else {
7961:     MatMultTransposeAdd(A,x,y,w);
7962:   }
7963:   return(0);
7964: }

7966: /*@
7967:    MatInterpolate - y = A*x or A'*x depending on the shape of
7968:      the matrix

7970:    Neighbor-wise Collective on Mat

7972:    Input Parameters:
7973: +  mat   - the matrix
7974: -  x,y - the vectors

7976:    Level: intermediate

7978:    Notes:
7979:     This allows one to use either the restriction or interpolation (its transpose)
7980:     matrix to do the interpolation

7982: .seealso: MatMultAdd(), MatMultTransposeAdd(), MatRestrict()

7984: @*/
7985: PetscErrorCode MatInterpolate(Mat A,Vec x,Vec y)
7986: {
7988:   PetscInt       M,N,Ny;

7995:   MatCheckPreallocated(A,1);
7996:   MatGetSize(A,&M,&N);
7997:   VecGetSize(y,&Ny);
7998:   if (M == Ny) {
7999:     MatMult(A,x,y);
8000:   } else {
8001:     MatMultTranspose(A,x,y);
8002:   }
8003:   return(0);
8004: }

8006: /*@
8007:    MatRestrict - y = A*x or A'*x

8009:    Neighbor-wise Collective on Mat

8011:    Input Parameters:
8012: +  mat   - the matrix
8013: -  x,y - the vectors

8015:    Level: intermediate

8017:    Notes:
8018:     This allows one to use either the restriction or interpolation (its transpose)
8019:     matrix to do the restriction

8021: .seealso: MatMultAdd(), MatMultTransposeAdd(), MatInterpolate()

8023: @*/
8024: PetscErrorCode MatRestrict(Mat A,Vec x,Vec y)
8025: {
8027:   PetscInt       M,N,Ny;

8034:   MatCheckPreallocated(A,1);

8036:   MatGetSize(A,&M,&N);
8037:   VecGetSize(y,&Ny);
8038:   if (M == Ny) {
8039:     MatMult(A,x,y);
8040:   } else {
8041:     MatMultTranspose(A,x,y);
8042:   }
8043:   return(0);
8044: }

8046: /*@
8047:    MatGetNullSpace - retrieves the null space of a matrix.

8049:    Logically Collective on Mat

8051:    Input Parameters:
8052: +  mat - the matrix
8053: -  nullsp - the null space object

8055:    Level: developer

8057: .seealso: MatCreate(), MatNullSpaceCreate(), MatSetNearNullSpace(), MatSetNullSpace()
8058: @*/
8059: PetscErrorCode MatGetNullSpace(Mat mat, MatNullSpace *nullsp)
8060: {
8064:   *nullsp = (mat->symmetric_set && mat->symmetric && !mat->nullsp) ? mat->transnullsp : mat->nullsp;
8065:   return(0);
8066: }

8068: /*@
8069:    MatSetNullSpace - attaches a null space to a matrix.

8071:    Logically Collective on Mat

8073:    Input Parameters:
8074: +  mat - the matrix
8075: -  nullsp - the null space object

8077:    Level: advanced

8079:    Notes:
8080:       This null space is used by the linear solvers. Overwrites any previous null space that may have been attached

8082:       For inconsistent singular systems (linear systems where the right hand side is not in the range of the operator) you also likely should
8083:       call MatSetTransposeNullSpace(). This allows the linear system to be solved in a least squares sense.

8085:       You can remove the null space by calling this routine with an nullsp of NULL


8088:       The fundamental theorem of linear algebra (Gilbert Strang, Introduction to Applied Mathematics, page 72) states that
8089:    the domain of a matrix A (from R^n to R^m (m rows, n columns) R^n = the direct sum of the null space of A, n(A), + the range of A^T, R(A^T).
8090:    Similarly R^m = direct sum n(A^T) + R(A).  Hence the linear system A x = b has a solution only if b in R(A) (or correspondingly b is orthogonal to
8091:    n(A^T)) and if x is a solution then x + alpha n(A) is a solution for any alpha. The minimum norm solution is orthogonal to n(A). For problems without a solution
8092:    the solution that minimizes the norm of the residual (the least squares solution) can be obtained by solving A x = \hat{b} where \hat{b} is b orthogonalized to the n(A^T).

8094:       Krylov solvers can produce the minimal norm solution to the least squares problem by utilizing MatNullSpaceRemove().

8096:     If the matrix is known to be symmetric because it is an SBAIJ matrix or one as called MatSetOption(mat,MAT_SYMMETRIC or MAT_SYMMETRIC_ETERNAL,PETSC_TRUE); this
8097:     routine also automatically calls MatSetTransposeNullSpace().

8099: .seealso: MatCreate(), MatNullSpaceCreate(), MatSetNearNullSpace(), MatGetNullSpace(), MatSetTransposeNullSpace(), MatGetTransposeNullSpace(), MatNullSpaceRemove()
8100: @*/
8101: PetscErrorCode MatSetNullSpace(Mat mat,MatNullSpace nullsp)
8102: {

8108:   if (nullsp) {PetscObjectReference((PetscObject)nullsp);}
8109:   MatNullSpaceDestroy(&mat->nullsp);
8110:   mat->nullsp = nullsp;
8111:   if (mat->symmetric_set && mat->symmetric) {
8112:     MatSetTransposeNullSpace(mat,nullsp);
8113:   }
8114:   return(0);
8115: }

8117: /*@
8118:    MatGetTransposeNullSpace - retrieves the null space of the transpose of a matrix.

8120:    Logically Collective on Mat

8122:    Input Parameters:
8123: +  mat - the matrix
8124: -  nullsp - the null space object

8126:    Level: developer

8128: .seealso: MatCreate(), MatNullSpaceCreate(), MatSetNearNullSpace(), MatSetTransposeNullSpace(), MatSetNullSpace(), MatGetNullSpace()
8129: @*/
8130: PetscErrorCode MatGetTransposeNullSpace(Mat mat, MatNullSpace *nullsp)
8131: {
8136:   *nullsp = (mat->symmetric_set && mat->symmetric && !mat->transnullsp) ? mat->nullsp : mat->transnullsp;
8137:   return(0);
8138: }

8140: /*@
8141:    MatSetTransposeNullSpace - attaches a null space to a matrix.

8143:    Logically Collective on Mat

8145:    Input Parameters:
8146: +  mat - the matrix
8147: -  nullsp - the null space object

8149:    Level: advanced

8151:    Notes:
8152:       For inconsistent singular systems (linear systems where the right hand side is not in the range of the operator) this allows the linear system to be solved in a least squares sense.
8153:       You must also call MatSetNullSpace()


8156:       The fundamental theorem of linear algebra (Gilbert Strang, Introduction to Applied Mathematics, page 72) states that
8157:    the domain of a matrix A (from R^n to R^m (m rows, n columns) R^n = the direct sum of the null space of A, n(A), + the range of A^T, R(A^T).
8158:    Similarly R^m = direct sum n(A^T) + R(A).  Hence the linear system A x = b has a solution only if b in R(A) (or correspondingly b is orthogonal to
8159:    n(A^T)) and if x is a solution then x + alpha n(A) is a solution for any alpha. The minimum norm solution is orthogonal to n(A). For problems without a solution
8160:    the solution that minimizes the norm of the residual (the least squares solution) can be obtained by solving A x = \hat{b} where \hat{b} is b orthogonalized to the n(A^T).

8162:       Krylov solvers can produce the minimal norm solution to the least squares problem by utilizing MatNullSpaceRemove().

8164: .seealso: MatCreate(), MatNullSpaceCreate(), MatSetNearNullSpace(), MatGetNullSpace(), MatSetNullSpace(), MatGetTransposeNullSpace(), MatNullSpaceRemove()
8165: @*/
8166: PetscErrorCode MatSetTransposeNullSpace(Mat mat,MatNullSpace nullsp)
8167: {

8173:   if (nullsp) {PetscObjectReference((PetscObject)nullsp);}
8174:   MatNullSpaceDestroy(&mat->transnullsp);
8175:   mat->transnullsp = nullsp;
8176:   return(0);
8177: }

8179: /*@
8180:    MatSetNearNullSpace - attaches a null space to a matrix, which is often the null space (rigid body modes) of the operator without boundary conditions
8181:         This null space will be used to provide near null space vectors to a multigrid preconditioner built from this matrix.

8183:    Logically Collective on Mat

8185:    Input Parameters:
8186: +  mat - the matrix
8187: -  nullsp - the null space object

8189:    Level: advanced

8191:    Notes:
8192:       Overwrites any previous near null space that may have been attached

8194:       You can remove the null space by calling this routine with an nullsp of NULL

8196: .seealso: MatCreate(), MatNullSpaceCreate(), MatSetNullSpace(), MatNullSpaceCreateRigidBody(), MatGetNearNullSpace()
8197: @*/
8198: PetscErrorCode MatSetNearNullSpace(Mat mat,MatNullSpace nullsp)
8199: {

8206:   MatCheckPreallocated(mat,1);
8207:   if (nullsp) {PetscObjectReference((PetscObject)nullsp);}
8208:   MatNullSpaceDestroy(&mat->nearnullsp);
8209:   mat->nearnullsp = nullsp;
8210:   return(0);
8211: }

8213: /*@
8214:    MatGetNearNullSpace -Get null space attached with MatSetNearNullSpace()

8216:    Not Collective

8218:    Input Parameters:
8219: .  mat - the matrix

8221:    Output Parameters:
8222: .  nullsp - the null space object, NULL if not set

8224:    Level: developer

8226: .seealso: MatSetNearNullSpace(), MatGetNullSpace(), MatNullSpaceCreate()
8227: @*/
8228: PetscErrorCode MatGetNearNullSpace(Mat mat,MatNullSpace *nullsp)
8229: {
8234:   MatCheckPreallocated(mat,1);
8235:   *nullsp = mat->nearnullsp;
8236:   return(0);
8237: }

8239: /*@C
8240:    MatICCFactor - Performs in-place incomplete Cholesky factorization of matrix.

8242:    Collective on Mat

8244:    Input Parameters:
8245: +  mat - the matrix
8246: .  row - row/column permutation
8247: .  fill - expected fill factor >= 1.0
8248: -  level - level of fill, for ICC(k)

8250:    Notes:
8251:    Probably really in-place only when level of fill is zero, otherwise allocates
8252:    new space to store factored matrix and deletes previous memory.

8254:    Most users should employ the simplified KSP interface for linear solvers
8255:    instead of working directly with matrix algebra routines such as this.
8256:    See, e.g., KSPCreate().

8258:    Level: developer


8261: .seealso: MatICCFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor()

8263:     Developer Note: fortran interface is not autogenerated as the f90
8264:     interface defintion cannot be generated correctly [due to MatFactorInfo]

8266: @*/
8267: PetscErrorCode MatICCFactor(Mat mat,IS row,const MatFactorInfo *info)
8268: {

8276:   if (mat->rmap->N != mat->cmap->N) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONG,"matrix must be square");
8277:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
8278:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8279:   if (!mat->ops->iccfactor) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
8280:   MatCheckPreallocated(mat,1);
8281:   (*mat->ops->iccfactor)(mat,row,info);
8282:   PetscObjectStateIncrease((PetscObject)mat);
8283:   return(0);
8284: }

8286: /*@
8287:    MatDiagonalScaleLocal - Scales columns of a matrix given the scaling values including the
8288:          ghosted ones.

8290:    Not Collective

8292:    Input Parameters:
8293: +  mat - the matrix
8294: -  diag = the diagonal values, including ghost ones

8296:    Level: developer

8298:    Notes:
8299:     Works only for MPIAIJ and MPIBAIJ matrices

8301: .seealso: MatDiagonalScale()
8302: @*/
8303: PetscErrorCode MatDiagonalScaleLocal(Mat mat,Vec diag)
8304: {
8306:   PetscMPIInt    size;


8313:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Matrix must be already assembled");
8314:   PetscLogEventBegin(MAT_Scale,mat,0,0,0);
8315:   MPI_Comm_size(PetscObjectComm((PetscObject)mat),&size);
8316:   if (size == 1) {
8317:     PetscInt n,m;
8318:     VecGetSize(diag,&n);
8319:     MatGetSize(mat,0,&m);
8320:     if (m == n) {
8321:       MatDiagonalScale(mat,0,diag);
8322:     } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Only supported for sequential matrices when no ghost points/periodic conditions");
8323:   } else {
8324:     PetscUseMethod(mat,"MatDiagonalScaleLocal_C",(Mat,Vec),(mat,diag));
8325:   }
8326:   PetscLogEventEnd(MAT_Scale,mat,0,0,0);
8327:   PetscObjectStateIncrease((PetscObject)mat);
8328:   return(0);
8329: }

8331: /*@
8332:    MatGetInertia - Gets the inertia from a factored matrix

8334:    Collective on Mat

8336:    Input Parameter:
8337: .  mat - the matrix

8339:    Output Parameters:
8340: +   nneg - number of negative eigenvalues
8341: .   nzero - number of zero eigenvalues
8342: -   npos - number of positive eigenvalues

8344:    Level: advanced

8346:    Notes:
8347:     Matrix must have been factored by MatCholeskyFactor()


8350: @*/
8351: PetscErrorCode MatGetInertia(Mat mat,PetscInt *nneg,PetscInt *nzero,PetscInt *npos)
8352: {

8358:   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
8359:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Numeric factor mat is not assembled");
8360:   if (!mat->ops->getinertia) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
8361:   (*mat->ops->getinertia)(mat,nneg,nzero,npos);
8362:   return(0);
8363: }

8365: /* ----------------------------------------------------------------*/
8366: /*@C
8367:    MatSolves - Solves A x = b, given a factored matrix, for a collection of vectors

8369:    Neighbor-wise Collective on Mats

8371:    Input Parameters:
8372: +  mat - the factored matrix
8373: -  b - the right-hand-side vectors

8375:    Output Parameter:
8376: .  x - the result vectors

8378:    Notes:
8379:    The vectors b and x cannot be the same.  I.e., one cannot
8380:    call MatSolves(A,x,x).

8382:    Notes:
8383:    Most users should employ the simplified KSP interface for linear solvers
8384:    instead of working directly with matrix algebra routines such as this.
8385:    See, e.g., KSPCreate().

8387:    Level: developer

8389: .seealso: MatSolveAdd(), MatSolveTranspose(), MatSolveTransposeAdd(), MatSolve()
8390: @*/
8391: PetscErrorCode MatSolves(Mat mat,Vecs b,Vecs x)
8392: {

8398:   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
8399:   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
8400:   if (!mat->rmap->N && !mat->cmap->N) return(0);

8402:   if (!mat->ops->solves) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
8403:   MatCheckPreallocated(mat,1);
8404:   PetscLogEventBegin(MAT_Solves,mat,0,0,0);
8405:   (*mat->ops->solves)(mat,b,x);
8406:   PetscLogEventEnd(MAT_Solves,mat,0,0,0);
8407:   return(0);
8408: }

8410: /*@
8411:    MatIsSymmetric - Test whether a matrix is symmetric

8413:    Collective on Mat

8415:    Input Parameter:
8416: +  A - the matrix to test
8417: -  tol - difference between value and its transpose less than this amount counts as equal (use 0.0 for exact transpose)

8419:    Output Parameters:
8420: .  flg - the result

8422:    Notes:
8423:     For real numbers MatIsSymmetric() and MatIsHermitian() return identical results

8425:    Level: intermediate

8427: .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetricKnown()
8428: @*/
8429: PetscErrorCode MatIsSymmetric(Mat A,PetscReal tol,PetscBool  *flg)
8430: {


8437:   if (!A->symmetric_set) {
8438:     if (!A->ops->issymmetric) {
8439:       MatType mattype;
8440:       MatGetType(A,&mattype);
8441:       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Matrix of type <%s> does not support checking for symmetric",mattype);
8442:     }
8443:     (*A->ops->issymmetric)(A,tol,flg);
8444:     if (!tol) {
8445:       A->symmetric_set = PETSC_TRUE;
8446:       A->symmetric     = *flg;
8447:       if (A->symmetric) {
8448:         A->structurally_symmetric_set = PETSC_TRUE;
8449:         A->structurally_symmetric     = PETSC_TRUE;
8450:       }
8451:     }
8452:   } else if (A->symmetric) {
8453:     *flg = PETSC_TRUE;
8454:   } else if (!tol) {
8455:     *flg = PETSC_FALSE;
8456:   } else {
8457:     if (!A->ops->issymmetric) {
8458:       MatType mattype;
8459:       MatGetType(A,&mattype);
8460:       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Matrix of type <%s> does not support checking for symmetric",mattype);
8461:     }
8462:     (*A->ops->issymmetric)(A,tol,flg);
8463:   }
8464:   return(0);
8465: }

8467: /*@
8468:    MatIsHermitian - Test whether a matrix is Hermitian

8470:    Collective on Mat

8472:    Input Parameter:
8473: +  A - the matrix to test
8474: -  tol - difference between value and its transpose less than this amount counts as equal (use 0.0 for exact Hermitian)

8476:    Output Parameters:
8477: .  flg - the result

8479:    Level: intermediate

8481: .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(),
8482:           MatIsSymmetricKnown(), MatIsSymmetric()
8483: @*/
8484: PetscErrorCode MatIsHermitian(Mat A,PetscReal tol,PetscBool  *flg)
8485: {


8492:   if (!A->hermitian_set) {
8493:     if (!A->ops->ishermitian) {
8494:       MatType mattype;
8495:       MatGetType(A,&mattype);
8496:       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Matrix of type <%s> does not support checking for hermitian",mattype);
8497:     }
8498:     (*A->ops->ishermitian)(A,tol,flg);
8499:     if (!tol) {
8500:       A->hermitian_set = PETSC_TRUE;
8501:       A->hermitian     = *flg;
8502:       if (A->hermitian) {
8503:         A->structurally_symmetric_set = PETSC_TRUE;
8504:         A->structurally_symmetric     = PETSC_TRUE;
8505:       }
8506:     }
8507:   } else if (A->hermitian) {
8508:     *flg = PETSC_TRUE;
8509:   } else if (!tol) {
8510:     *flg = PETSC_FALSE;
8511:   } else {
8512:     if (!A->ops->ishermitian) {
8513:       MatType mattype;
8514:       MatGetType(A,&mattype);
8515:       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Matrix of type <%s> does not support checking for hermitian",mattype);
8516:     }
8517:     (*A->ops->ishermitian)(A,tol,flg);
8518:   }
8519:   return(0);
8520: }

8522: /*@
8523:    MatIsSymmetricKnown - Checks the flag on the matrix to see if it is symmetric.

8525:    Not Collective

8527:    Input Parameter:
8528: .  A - the matrix to check

8530:    Output Parameters:
8531: +  set - if the symmetric flag is set (this tells you if the next flag is valid)
8532: -  flg - the result

8534:    Level: advanced

8536:    Note: Does not check the matrix values directly, so this may return unknown (set = PETSC_FALSE). Use MatIsSymmetric()
8537:          if you want it explicitly checked

8539: .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetric()
8540: @*/
8541: PetscErrorCode MatIsSymmetricKnown(Mat A,PetscBool  *set,PetscBool  *flg)
8542: {
8547:   if (A->symmetric_set) {
8548:     *set = PETSC_TRUE;
8549:     *flg = A->symmetric;
8550:   } else {
8551:     *set = PETSC_FALSE;
8552:   }
8553:   return(0);
8554: }

8556: /*@
8557:    MatIsHermitianKnown - Checks the flag on the matrix to see if it is hermitian.

8559:    Not Collective

8561:    Input Parameter:
8562: .  A - the matrix to check

8564:    Output Parameters:
8565: +  set - if the hermitian flag is set (this tells you if the next flag is valid)
8566: -  flg - the result

8568:    Level: advanced

8570:    Note: Does not check the matrix values directly, so this may return unknown (set = PETSC_FALSE). Use MatIsHermitian()
8571:          if you want it explicitly checked

8573: .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetric()
8574: @*/
8575: PetscErrorCode MatIsHermitianKnown(Mat A,PetscBool *set,PetscBool *flg)
8576: {
8581:   if (A->hermitian_set) {
8582:     *set = PETSC_TRUE;
8583:     *flg = A->hermitian;
8584:   } else {
8585:     *set = PETSC_FALSE;
8586:   }
8587:   return(0);
8588: }

8590: /*@
8591:    MatIsStructurallySymmetric - Test whether a matrix is structurally symmetric

8593:    Collective on Mat

8595:    Input Parameter:
8596: .  A - the matrix to test

8598:    Output Parameters:
8599: .  flg - the result

8601:    Level: intermediate

8603: .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsSymmetric(), MatSetOption()
8604: @*/
8605: PetscErrorCode MatIsStructurallySymmetric(Mat A,PetscBool *flg)
8606: {

8612:   if (!A->structurally_symmetric_set) {
8613:     if (!A->ops->isstructurallysymmetric) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Matrix does not support checking for structural symmetric");
8614:     (*A->ops->isstructurallysymmetric)(A,&A->structurally_symmetric);

8616:     A->structurally_symmetric_set = PETSC_TRUE;
8617:   }
8618:   *flg = A->structurally_symmetric;
8619:   return(0);
8620: }

8622: /*@
8623:    MatStashGetInfo - Gets how many values are currently in the matrix stash, i.e. need
8624:        to be communicated to other processors during the MatAssemblyBegin/End() process

8626:     Not collective

8628:    Input Parameter:
8629: .   vec - the vector

8631:    Output Parameters:
8632: +   nstash   - the size of the stash
8633: .   reallocs - the number of additional mallocs incurred.
8634: .   bnstash   - the size of the block stash
8635: -   breallocs - the number of additional mallocs incurred.in the block stash

8637:    Level: advanced

8639: .seealso: MatAssemblyBegin(), MatAssemblyEnd(), Mat, MatStashSetInitialSize()

8641: @*/
8642: PetscErrorCode MatStashGetInfo(Mat mat,PetscInt *nstash,PetscInt *reallocs,PetscInt *bnstash,PetscInt *breallocs)
8643: {

8647:   MatStashGetInfo_Private(&mat->stash,nstash,reallocs);
8648:   MatStashGetInfo_Private(&mat->bstash,bnstash,breallocs);
8649:   return(0);
8650: }

8652: /*@C
8653:    MatCreateVecs - Get vector(s) compatible with the matrix, i.e. with the same
8654:      parallel layout

8656:    Collective on Mat

8658:    Input Parameter:
8659: .  mat - the matrix

8661:    Output Parameter:
8662: +   right - (optional) vector that the matrix can be multiplied against
8663: -   left - (optional) vector that the matrix vector product can be stored in

8665:    Notes:
8666:     The blocksize of the returned vectors is determined by the row and column block sizes set with MatSetBlockSizes() or the single blocksize (same for both) set by MatSetBlockSize().

8668:   Notes:
8669:     These are new vectors which are not owned by the Mat, they should be destroyed in VecDestroy() when no longer needed

8671:   Level: advanced

8673: .seealso: MatCreate(), VecDestroy()
8674: @*/
8675: PetscErrorCode MatCreateVecs(Mat mat,Vec *right,Vec *left)
8676: {

8682:   if (mat->ops->getvecs) {
8683:     (*mat->ops->getvecs)(mat,right,left);
8684:   } else {
8685:     PetscInt rbs,cbs;
8686:     MatGetBlockSizes(mat,&rbs,&cbs);
8687:     if (right) {
8688:       if (mat->cmap->n < 0) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"PetscLayout for columns not yet setup");
8689:       VecCreate(PetscObjectComm((PetscObject)mat),right);
8690:       VecSetSizes(*right,mat->cmap->n,PETSC_DETERMINE);
8691:       VecSetBlockSize(*right,cbs);
8692:       VecSetType(*right,mat->defaultvectype);
8693:       PetscLayoutReference(mat->cmap,&(*right)->map);
8694:     }
8695:     if (left) {
8696:       if (mat->rmap->n < 0) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"PetscLayout for rows not yet setup");
8697:       VecCreate(PetscObjectComm((PetscObject)mat),left);
8698:       VecSetSizes(*left,mat->rmap->n,PETSC_DETERMINE);
8699:       VecSetBlockSize(*left,rbs);
8700:       VecSetType(*left,mat->defaultvectype);
8701:       PetscLayoutReference(mat->rmap,&(*left)->map);
8702:     }
8703:   }
8704:   return(0);
8705: }

8707: /*@C
8708:    MatFactorInfoInitialize - Initializes a MatFactorInfo data structure
8709:      with default values.

8711:    Not Collective

8713:    Input Parameters:
8714: .    info - the MatFactorInfo data structure


8717:    Notes:
8718:     The solvers are generally used through the KSP and PC objects, for example
8719:           PCLU, PCILU, PCCHOLESKY, PCICC

8721:    Level: developer

8723: .seealso: MatFactorInfo

8725:     Developer Note: fortran interface is not autogenerated as the f90
8726:     interface defintion cannot be generated correctly [due to MatFactorInfo]

8728: @*/

8730: PetscErrorCode MatFactorInfoInitialize(MatFactorInfo *info)
8731: {

8735:   PetscMemzero(info,sizeof(MatFactorInfo));
8736:   return(0);
8737: }

8739: /*@
8740:    MatFactorSetSchurIS - Set indices corresponding to the Schur complement you wish to have computed

8742:    Collective on Mat

8744:    Input Parameters:
8745: +  mat - the factored matrix
8746: -  is - the index set defining the Schur indices (0-based)

8748:    Notes:
8749:     Call MatFactorSolveSchurComplement() or MatFactorSolveSchurComplementTranspose() after this call to solve a Schur complement system.

8751:    You can call MatFactorGetSchurComplement() or MatFactorCreateSchurComplement() after this call.

8753:    Level: developer

8755: .seealso: MatGetFactor(), MatFactorGetSchurComplement(), MatFactorRestoreSchurComplement(), MatFactorCreateSchurComplement(), MatFactorSolveSchurComplement(),
8756:           MatFactorSolveSchurComplementTranspose(), MatFactorSolveSchurComplement()

8758: @*/
8759: PetscErrorCode MatFactorSetSchurIS(Mat mat,IS is)
8760: {
8761:   PetscErrorCode ierr,(*f)(Mat,IS);

8769:   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Only for factored matrix");
8770:   PetscObjectQueryFunction((PetscObject)mat,"MatFactorSetSchurIS_C",&f);
8771:   if (!f) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"The selected MatSolverType does not support Schur complement computation. You should use MATSOLVERMUMPS or MATSOLVERMKL_PARDISO");
8772:   MatDestroy(&mat->schur);
8773:   (*f)(mat,is);
8774:   if (!mat->schur) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_PLIB,"Schur complement has not been created");
8775:   return(0);
8776: }

8778: /*@
8779:   MatFactorCreateSchurComplement - Create a Schur complement matrix object using Schur data computed during the factorization step

8781:    Logically Collective on Mat

8783:    Input Parameters:
8784: +  F - the factored matrix obtained by calling MatGetFactor() from PETSc-MUMPS interface
8785: .  S - location where to return the Schur complement, can be NULL
8786: -  status - the status of the Schur complement matrix, can be NULL

8788:    Notes:
8789:    You must call MatFactorSetSchurIS() before calling this routine.

8791:    The routine provides a copy of the Schur matrix stored within the solver data structures.
8792:    The caller must destroy the object when it is no longer needed.
8793:    If MatFactorInvertSchurComplement() has been called, the routine gets back the inverse.

8795:    Use MatFactorGetSchurComplement() to get access to the Schur complement matrix inside the factored matrix instead of making a copy of it (which this function does)

8797:    Developer Notes:
8798:     The reason this routine exists is because the representation of the Schur complement within the factor matrix may be different than a standard PETSc
8799:    matrix representation and we normally do not want to use the time or memory to make a copy as a regular PETSc matrix.

8801:    See MatCreateSchurComplement() or MatGetSchurComplement() for ways to create virtual or approximate Schur complements.

8803:    Level: advanced

8805:    References:

8807: .seealso: MatGetFactor(), MatFactorSetSchurIS(), MatFactorGetSchurComplement(), MatFactorSchurStatus
8808: @*/
8809: PetscErrorCode MatFactorCreateSchurComplement(Mat F,Mat* S,MatFactorSchurStatus* status)
8810: {

8817:   if (S) {
8818:     PetscErrorCode (*f)(Mat,Mat*);

8820:     PetscObjectQueryFunction((PetscObject)F,"MatFactorCreateSchurComplement_C",&f);
8821:     if (f) {
8822:       (*f)(F,S);
8823:     } else {
8824:       MatDuplicate(F->schur,MAT_COPY_VALUES,S);
8825:     }
8826:   }
8827:   if (status) *status = F->schur_status;
8828:   return(0);
8829: }

8831: /*@
8832:   MatFactorGetSchurComplement - Gets access to a Schur complement matrix using the current Schur data within a factored matrix

8834:    Logically Collective on Mat

8836:    Input Parameters:
8837: +  F - the factored matrix obtained by calling MatGetFactor()
8838: .  *S - location where to return the Schur complement, can be NULL
8839: -  status - the status of the Schur complement matrix, can be NULL

8841:    Notes:
8842:    You must call MatFactorSetSchurIS() before calling this routine.

8844:    Schur complement mode is currently implemented for sequential matrices.
8845:    The routine returns a the Schur Complement stored within the data strutures of the solver.
8846:    If MatFactorInvertSchurComplement() has previously been called, the returned matrix is actually the inverse of the Schur complement.
8847:    The returned matrix should not be destroyed; the caller should call MatFactorRestoreSchurComplement() when the object is no longer needed.

8849:    Use MatFactorCreateSchurComplement() to create a copy of the Schur complement matrix that is within a factored matrix

8851:    See MatCreateSchurComplement() or MatGetSchurComplement() for ways to create virtual or approximate Schur complements.

8853:    Level: advanced

8855:    References:

8857: .seealso: MatGetFactor(), MatFactorSetSchurIS(), MatFactorRestoreSchurComplement(), MatFactorCreateSchurComplement(), MatFactorSchurStatus
8858: @*/
8859: PetscErrorCode MatFactorGetSchurComplement(Mat F,Mat* S,MatFactorSchurStatus* status)
8860: {
8865:   if (S) *S = F->schur;
8866:   if (status) *status = F->schur_status;
8867:   return(0);
8868: }

8870: /*@
8871:   MatFactorRestoreSchurComplement - Restore the Schur complement matrix object obtained from a call to MatFactorGetSchurComplement

8873:    Logically Collective on Mat

8875:    Input Parameters:
8876: +  F - the factored matrix obtained by calling MatGetFactor()
8877: .  *S - location where the Schur complement is stored
8878: -  status - the status of the Schur complement matrix (see MatFactorSchurStatus)

8880:    Notes:

8882:    Level: advanced

8884:    References:

8886: .seealso: MatGetFactor(), MatFactorSetSchurIS(), MatFactorRestoreSchurComplement(), MatFactorCreateSchurComplement(), MatFactorSchurStatus
8887: @*/
8888: PetscErrorCode MatFactorRestoreSchurComplement(Mat F,Mat* S,MatFactorSchurStatus status)
8889: {

8894:   if (S) {
8896:     *S = NULL;
8897:   }
8898:   F->schur_status = status;
8899:   MatFactorUpdateSchurStatus_Private(F);
8900:   return(0);
8901: }

8903: /*@
8904:   MatFactorSolveSchurComplementTranspose - Solve the transpose of the Schur complement system computed during the factorization step

8906:    Logically Collective on Mat

8908:    Input Parameters:
8909: +  F - the factored matrix obtained by calling MatGetFactor()
8910: .  rhs - location where the right hand side of the Schur complement system is stored
8911: -  sol - location where the solution of the Schur complement system has to be returned

8913:    Notes:
8914:    The sizes of the vectors should match the size of the Schur complement

8916:    Must be called after MatFactorSetSchurIS()

8918:    Level: advanced

8920:    References:

8922: .seealso: MatGetFactor(), MatFactorSetSchurIS(), MatFactorSolveSchurComplement()
8923: @*/
8924: PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat F, Vec rhs, Vec sol)
8925: {

8937:   MatFactorFactorizeSchurComplement(F);
8938:   switch (F->schur_status) {
8939:   case MAT_FACTOR_SCHUR_FACTORED:
8940:     MatSolveTranspose(F->schur,rhs,sol);
8941:     break;
8942:   case MAT_FACTOR_SCHUR_INVERTED:
8943:     MatMultTranspose(F->schur,rhs,sol);
8944:     break;
8945:   default:
8946:     SETERRQ1(PetscObjectComm((PetscObject)F),PETSC_ERR_SUP,"Unhandled MatFactorSchurStatus %D",F->schur_status);
8947:     break;
8948:   }
8949:   return(0);
8950: }

8952: /*@
8953:   MatFactorSolveSchurComplement - Solve the Schur complement system computed during the factorization step

8955:    Logically Collective on Mat

8957:    Input Parameters:
8958: +  F - the factored matrix obtained by calling MatGetFactor()
8959: .  rhs - location where the right hand side of the Schur complement system is stored
8960: -  sol - location where the solution of the Schur complement system has to be returned

8962:    Notes:
8963:    The sizes of the vectors should match the size of the Schur complement

8965:    Must be called after MatFactorSetSchurIS()

8967:    Level: advanced

8969:    References:

8971: .seealso: MatGetFactor(), MatFactorSetSchurIS(), MatFactorSolveSchurComplementTranspose()
8972: @*/
8973: PetscErrorCode MatFactorSolveSchurComplement(Mat F, Vec rhs, Vec sol)
8974: {

8986:   MatFactorFactorizeSchurComplement(F);
8987:   switch (F->schur_status) {
8988:   case MAT_FACTOR_SCHUR_FACTORED:
8989:     MatSolve(F->schur,rhs,sol);
8990:     break;
8991:   case MAT_FACTOR_SCHUR_INVERTED:
8992:     MatMult(F->schur,rhs,sol);
8993:     break;
8994:   default:
8995:     SETERRQ1(PetscObjectComm((PetscObject)F),PETSC_ERR_SUP,"Unhandled MatFactorSchurStatus %D",F->schur_status);
8996:     break;
8997:   }
8998:   return(0);
8999: }

9001: /*@
9002:   MatFactorInvertSchurComplement - Invert the Schur complement matrix computed during the factorization step

9004:    Logically Collective on Mat

9006:    Input Parameters:
9007: .  F - the factored matrix obtained by calling MatGetFactor()

9009:    Notes:
9010:     Must be called after MatFactorSetSchurIS().

9012:    Call MatFactorGetSchurComplement() or  MatFactorCreateSchurComplement() AFTER this call to actually compute the inverse and get access to it.

9014:    Level: advanced

9016:    References:

9018: .seealso: MatGetFactor(), MatFactorSetSchurIS(), MatFactorGetSchurComplement(), MatFactorCreateSchurComplement()
9019: @*/
9020: PetscErrorCode MatFactorInvertSchurComplement(Mat F)
9021: {

9027:   if (F->schur_status == MAT_FACTOR_SCHUR_INVERTED) return(0);
9028:   MatFactorFactorizeSchurComplement(F);
9029:   MatFactorInvertSchurComplement_Private(F);
9030:   F->schur_status = MAT_FACTOR_SCHUR_INVERTED;
9031:   return(0);
9032: }

9034: /*@
9035:   MatFactorFactorizeSchurComplement - Factorize the Schur complement matrix computed during the factorization step

9037:    Logically Collective on Mat

9039:    Input Parameters:
9040: .  F - the factored matrix obtained by calling MatGetFactor()

9042:    Notes:
9043:     Must be called after MatFactorSetSchurIS().

9045:    Level: advanced

9047:    References:

9049: .seealso: MatGetFactor(), MatFactorSetSchurIS(), MatFactorInvertSchurComplement()
9050: @*/
9051: PetscErrorCode MatFactorFactorizeSchurComplement(Mat F)
9052: {

9058:   if (F->schur_status == MAT_FACTOR_SCHUR_INVERTED || F->schur_status == MAT_FACTOR_SCHUR_FACTORED) return(0);
9059:   MatFactorFactorizeSchurComplement_Private(F);
9060:   F->schur_status = MAT_FACTOR_SCHUR_FACTORED;
9061:   return(0);
9062: }

9064: PetscErrorCode MatPtAP_Basic(Mat A,Mat P,MatReuse scall,PetscReal fill,Mat *C)
9065: {
9066:   Mat            AP;

9070:   PetscInfo2(A,"Mat types %s and %s using basic PtAP\n",((PetscObject)A)->type_name,((PetscObject)P)->type_name);
9071:   MatMatMult(A,P,MAT_INITIAL_MATRIX,PETSC_DEFAULT,&AP);
9072:   MatTransposeMatMult(P,AP,scall,fill,C);
9073:   MatDestroy(&AP);
9074:   return(0);
9075: }

9077: /*@
9078:    MatPtAP - Creates the matrix product C = P^T * A * P

9080:    Neighbor-wise Collective on Mat

9082:    Input Parameters:
9083: +  A - the matrix
9084: .  P - the projection matrix
9085: .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
9086: -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(P)), use PETSC_DEFAULT if you do not have a good estimate
9087:           if the result is a dense matrix this is irrelevent

9089:    Output Parameters:
9090: .  C - the product matrix

9092:    Notes:
9093:    C will be created and must be destroyed by the user with MatDestroy().

9095:    For matrix types without special implementation the function fallbacks to MatMatMult() followed by MatTransposeMatMult().

9097:    Level: intermediate

9099: .seealso: MatPtAPSymbolic(), MatPtAPNumeric(), MatMatMult(), MatRARt()
9100: @*/
9101: PetscErrorCode MatPtAP(Mat A,Mat P,MatReuse scall,PetscReal fill,Mat *C)
9102: {
9104:   PetscErrorCode (*fA)(Mat,Mat,MatReuse,PetscReal,Mat*);
9105:   PetscErrorCode (*fP)(Mat,Mat,MatReuse,PetscReal,Mat*);
9106:   PetscErrorCode (*ptap)(Mat,Mat,MatReuse,PetscReal,Mat*)=NULL;
9107:   PetscBool      sametype;

9112:   MatCheckPreallocated(A,1);
9113:   if (scall == MAT_INPLACE_MATRIX) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Inplace product not supported");
9114:   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9115:   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9118:   MatCheckPreallocated(P,2);
9119:   if (!P->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9120:   if (P->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");

9122:   if (A->rmap->N != A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix A must be square, %D != %D",A->rmap->N,A->cmap->N);
9123:   if (P->rmap->N != A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->rmap->N,A->cmap->N);
9124:   if (fill == PETSC_DEFAULT || fill == PETSC_DECIDE) fill = 2.0;
9125:   if (fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Expected fill=%g must be >= 1.0",(double)fill);

9127:   if (scall == MAT_REUSE_MATRIX) {

9131:     PetscLogEventBegin(MAT_PtAP,A,P,0,0);
9132:     PetscLogEventBegin(MAT_PtAPNumeric,A,P,0,0);
9133:     if ((*C)->ops->ptapnumeric) {
9134:       (*(*C)->ops->ptapnumeric)(A,P,*C);
9135:     } else {
9136:       MatPtAP_Basic(A,P,scall,fill,C);
9137:     }
9138:     PetscLogEventEnd(MAT_PtAPNumeric,A,P,0,0);
9139:     PetscLogEventEnd(MAT_PtAP,A,P,0,0);
9140:     return(0);
9141:   }

9143:   if (fill == PETSC_DEFAULT || fill == PETSC_DECIDE) fill = 2.0;
9144:   if (fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Expected fill=%g must be >= 1.0",(double)fill);

9146:   fA = A->ops->ptap;
9147:   fP = P->ops->ptap;
9148:   PetscStrcmp(((PetscObject)A)->type_name,((PetscObject)P)->type_name,&sametype);
9149:   if (fP == fA && sametype) {
9150:     ptap = fA;
9151:   } else {
9152:     /* dispatch based on the type of A and P from their PetscObject's PetscFunctionLists. */
9153:     char ptapname[256];
9154:     PetscStrncpy(ptapname,"MatPtAP_",sizeof(ptapname));
9155:     PetscStrlcat(ptapname,((PetscObject)A)->type_name,sizeof(ptapname));
9156:     PetscStrlcat(ptapname,"_",sizeof(ptapname));
9157:     PetscStrlcat(ptapname,((PetscObject)P)->type_name,sizeof(ptapname));
9158:     PetscStrlcat(ptapname,"_C",sizeof(ptapname)); /* e.g., ptapname = "MatPtAP_seqdense_seqaij_C" */
9159:     PetscObjectQueryFunction((PetscObject)P,ptapname,&ptap);
9160:   }

9162:   if (!ptap) ptap = MatPtAP_Basic;
9163:   PetscLogEventBegin(MAT_PtAP,A,P,0,0);
9164:   (*ptap)(A,P,scall,fill,C);
9165:   PetscLogEventEnd(MAT_PtAP,A,P,0,0);
9166:   if (A->symmetric_set && A->symmetric) {
9167:     MatSetOption(*C,MAT_SYMMETRIC,PETSC_TRUE);
9168:   }
9169:   return(0);
9170: }

9172: /*@
9173:    MatPtAPNumeric - Computes the matrix product C = P^T * A * P

9175:    Neighbor-wise Collective on Mat

9177:    Input Parameters:
9178: +  A - the matrix
9179: -  P - the projection matrix

9181:    Output Parameters:
9182: .  C - the product matrix

9184:    Notes:
9185:    C must have been created by calling MatPtAPSymbolic and must be destroyed by
9186:    the user using MatDeatroy().

9188:    This routine is currently only implemented for pairs of AIJ matrices and classes
9189:    which inherit from AIJ.  C will be of type MATAIJ.

9191:    Level: intermediate

9193: .seealso: MatPtAP(), MatPtAPSymbolic(), MatMatMultNumeric()
9194: @*/
9195: PetscErrorCode MatPtAPNumeric(Mat A,Mat P,Mat C)
9196: {

9202:   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9203:   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9206:   MatCheckPreallocated(P,2);
9207:   if (!P->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9208:   if (P->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9211:   MatCheckPreallocated(C,3);
9212:   if (C->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9213:   if (P->cmap->N!=C->rmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->cmap->N,C->rmap->N);
9214:   if (P->rmap->N!=A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->rmap->N,A->cmap->N);
9215:   if (A->rmap->N!=A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix 'A' must be square, %D != %D",A->rmap->N,A->cmap->N);
9216:   if (P->cmap->N!=C->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->cmap->N,C->cmap->N);
9217:   MatCheckPreallocated(A,1);

9219:   if (!C->ops->ptapnumeric) SETERRQ(PetscObjectComm((PetscObject)C),PETSC_ERR_ARG_WRONGSTATE,"MatPtAPNumeric implementation is missing. You should call MatPtAPSymbolic first");
9220:   PetscLogEventBegin(MAT_PtAPNumeric,A,P,0,0);
9221:   (*C->ops->ptapnumeric)(A,P,C);
9222:   PetscLogEventEnd(MAT_PtAPNumeric,A,P,0,0);
9223:   return(0);
9224: }

9226: /*@
9227:    MatPtAPSymbolic - Creates the (i,j) structure of the matrix product C = P^T * A * P

9229:    Neighbor-wise Collective on Mat

9231:    Input Parameters:
9232: +  A - the matrix
9233: -  P - the projection matrix

9235:    Output Parameters:
9236: .  C - the (i,j) structure of the product matrix

9238:    Notes:
9239:    C will be created and must be destroyed by the user with MatDestroy().

9241:    This routine is currently only implemented for pairs of SeqAIJ matrices and classes
9242:    which inherit from SeqAIJ.  C will be of type MATSEQAIJ.  The product is computed using
9243:    this (i,j) structure by calling MatPtAPNumeric().

9245:    Level: intermediate

9247: .seealso: MatPtAP(), MatPtAPNumeric(), MatMatMultSymbolic()
9248: @*/
9249: PetscErrorCode MatPtAPSymbolic(Mat A,Mat P,PetscReal fill,Mat *C)
9250: {

9256:   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9257:   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9258:   if (fill <1.0) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Expected fill=%g must be >= 1.0",(double)fill);
9261:   MatCheckPreallocated(P,2);
9262:   if (!P->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9263:   if (P->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");

9266:   if (P->rmap->N!=A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->rmap->N,A->cmap->N);
9267:   if (A->rmap->N!=A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix 'A' must be square, %D != %D",A->rmap->N,A->cmap->N);
9268:   MatCheckPreallocated(A,1);

9270:   if (!A->ops->ptapsymbolic) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"MatType %s",((PetscObject)A)->type_name);
9271:   PetscLogEventBegin(MAT_PtAPSymbolic,A,P,0,0);
9272:   (*A->ops->ptapsymbolic)(A,P,fill,C);
9273:   PetscLogEventEnd(MAT_PtAPSymbolic,A,P,0,0);

9275:   /* MatSetBlockSize(*C,A->rmap->bs); NO! this is not always true -ma */
9276:   return(0);
9277: }

9279: /*@
9280:    MatRARt - Creates the matrix product C = R * A * R^T

9282:    Neighbor-wise Collective on Mat

9284:    Input Parameters:
9285: +  A - the m