Actual source code: matrix.c

  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_QRFactorNumeric, MAT_QRFactorSymbolic, MAT_QRFactor;
 21: PetscLogEvent MAT_AssemblyEnd, MAT_SetValues, MAT_GetValues, MAT_GetRow, MAT_GetRowIJ, MAT_CreateSubMats, MAT_GetOrdering, MAT_RedundantMat, MAT_GetSeqNonzeroStructure;
 22: PetscLogEvent MAT_IncreaseOverlap, MAT_Partitioning, MAT_PartitioningND, MAT_Coarsen, MAT_ZeroEntries, MAT_Load, MAT_View, MAT_AXPY, MAT_FDColoringCreate;
 23: PetscLogEvent MAT_FDColoringSetUp, MAT_FDColoringApply,MAT_Transpose,MAT_FDColoringFunction, MAT_CreateSubMat;
 24: PetscLogEvent MAT_TransposeColoringCreate;
 25: PetscLogEvent MAT_MatMult, MAT_MatMultSymbolic, MAT_MatMultNumeric;
 26: PetscLogEvent MAT_PtAP, MAT_PtAPSymbolic, MAT_PtAPNumeric,MAT_RARt, MAT_RARtSymbolic, MAT_RARtNumeric;
 27: PetscLogEvent MAT_MatTransposeMult, MAT_MatTransposeMultSymbolic, MAT_MatTransposeMultNumeric;
 28: PetscLogEvent MAT_TransposeMatMult, MAT_TransposeMatMultSymbolic, MAT_TransposeMatMultNumeric;
 29: PetscLogEvent MAT_MatMatMult, MAT_MatMatMultSymbolic, MAT_MatMatMultNumeric;
 30: PetscLogEvent MAT_MultHermitianTranspose,MAT_MultHermitianTransposeAdd;
 31: PetscLogEvent MAT_Getsymtranspose, MAT_Getsymtransreduced, MAT_GetBrowsOfAcols;
 32: PetscLogEvent MAT_GetBrowsOfAocols, MAT_Getlocalmat, MAT_Getlocalmatcondensed, MAT_Seqstompi, MAT_Seqstompinum, MAT_Seqstompisym;
 33: PetscLogEvent MAT_Applypapt, MAT_Applypapt_numeric, MAT_Applypapt_symbolic, MAT_GetSequentialNonzeroStructure;
 34: PetscLogEvent MAT_GetMultiProcBlock;
 35: PetscLogEvent MAT_CUSPARSECopyToGPU, MAT_CUSPARSECopyFromGPU, MAT_CUSPARSEGenerateTranspose, MAT_CUSPARSESolveAnalysis;
 36: PetscLogEvent MAT_PreallCOO, MAT_SetVCOO;
 37: PetscLogEvent MAT_SetValuesBatch;
 38: PetscLogEvent MAT_ViennaCLCopyToGPU;
 39: PetscLogEvent MAT_DenseCopyToGPU, MAT_DenseCopyFromGPU;
 40: PetscLogEvent MAT_Merge,MAT_Residual,MAT_SetRandom;
 41: PetscLogEvent MAT_FactorFactS,MAT_FactorInvS;
 42: PetscLogEvent MATCOLORING_Apply,MATCOLORING_Comm,MATCOLORING_Local,MATCOLORING_ISCreate,MATCOLORING_SetUp,MATCOLORING_Weights;

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

 46: /*@
 47:    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,
 48:                   for sparse matrices that already have locations it fills the locations with random numbers

 50:    Logically Collective on Mat

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

 57:    Output Parameter:
 58: .  x  - the matrix

 60:    Example of Usage:
 61: .vb
 62:      PetscRandomCreate(PETSC_COMM_WORLD,&rctx);
 63:      MatSetRandom(x,rctx);
 64:      PetscRandomDestroy(rctx);
 65: .ve

 67:    Level: intermediate


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


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

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

 92:   PetscLogEventBegin(MAT_SetRandom,x,rctx,0,0);
 93:   (*x->ops->setrandom)(x,rctx);
 94:   PetscLogEventEnd(MAT_SetRandom,x,rctx,0,0);

 96:   MatAssemblyBegin(x, MAT_FINAL_ASSEMBLY);
 97:   MatAssemblyEnd(x, MAT_FINAL_ASSEMBLY);
 98:   PetscRandomDestroy(&randObj);
 99:   return(0);
100: }

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

105:    Logically Collective on Mat

107:    Input Parameters:
108: .  mat - the factored matrix

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

115:    Level: advanced

117:    Notes:
118:     This routine does not work for factorizations done with external packages.

120:     This routine should only be called if MatGetFactorError() returns a value of MAT_FACTOR_NUMERIC_ZEROPIVOT

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

124: .seealso: MatZeroEntries(), MatFactor(), MatGetFactor(), MatLUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatFactorClearError(), MatFactorGetErrorZeroPivot()
125: @*/
126: PetscErrorCode MatFactorGetErrorZeroPivot(Mat mat,PetscReal *pivot,PetscInt *row)
127: {
130:   *pivot = mat->factorerror_zeropivot_value;
131:   *row   = mat->factorerror_zeropivot_row;
132:   return(0);
133: }

135: /*@
136:    MatFactorGetError - gets the error code from a factorization

138:    Logically Collective on Mat

140:    Input Parameters:
141: .  mat - the factored matrix

143:    Output Parameter:
144: .  err  - the error code

146:    Level: advanced

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

151: .seealso: MatZeroEntries(), MatFactor(), MatGetFactor(), MatLUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatFactorClearError(), MatFactorGetErrorZeroPivot()
152: @*/
153: PetscErrorCode MatFactorGetError(Mat mat,MatFactorError *err)
154: {
157:   *err = mat->factorerrortype;
158:   return(0);
159: }

161: /*@
162:    MatFactorClearError - clears the error code in a factorization

164:    Logically Collective on Mat

166:    Input Parameter:
167: .  mat - the factored matrix

169:    Level: developer

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

174: .seealso: MatZeroEntries(), MatFactor(), MatGetFactor(), MatLUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatFactorGetError(), MatFactorGetErrorZeroPivot()
175: @*/
176: PetscErrorCode MatFactorClearError(Mat mat)
177: {
180:   mat->factorerrortype             = MAT_FACTOR_NOERROR;
181:   mat->factorerror_zeropivot_value = 0.0;
182:   mat->factorerror_zeropivot_row   = 0;
183:   return(0);
184: }

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

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

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

235:   Input Parameter:
236: .    A  - the matrix

238:   Output Parameter:
239: .    keptrows - the rows that are not completely zero

241:   Notes:
242:     keptrows is set to NULL if all rows are nonzero.

244:   Level: intermediate

246:  @*/
247: PetscErrorCode MatFindNonzeroRows(Mat mat,IS *keptrows)
248: {

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

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

268:   Input Parameter:
269: .    A  - the matrix

271:   Output Parameter:
272: .    zerorows - the rows that are completely zero

274:   Notes:
275:     zerorows is set to NULL if no rows are zero.

277:   Level: intermediate

279:  @*/
280: PetscErrorCode MatFindZeroRows(Mat mat,IS *zerorows)
281: {
283:   IS keptrows;
284:   PetscInt m, n;


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

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

306:    Not Collective

308:    Input Parameters:
309: .   A - the matrix

311:    Output Parameters:
312: .   a - the diagonal part (which is a SEQUENTIAL matrix)

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

319:    Level: advanced

321: @*/
322: PetscErrorCode MatGetDiagonalBlock(Mat A,Mat *a)
323: {

330:   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
331:   if (!A->ops->getdiagonalblock) {
332:     PetscMPIInt size;
333:     MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);
334:     if (size == 1) {
335:       *a = A;
336:       return(0);
337:     } else SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Not coded for matrix type %s",((PetscObject)A)->type_name);
338:   }
339:   (*A->ops->getdiagonalblock)(A,a);
340:   return(0);
341: }

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

346:    Collective on Mat

348:    Input Parameters:
349: .  mat - the matrix

351:    Output Parameter:
352: .   trace - the sum of the diagonal entries

354:    Level: advanced

356: @*/
357: PetscErrorCode MatGetTrace(Mat mat,PetscScalar *trace)
358: {
360:   Vec            diag;

363:   MatCreateVecs(mat,&diag,NULL);
364:   MatGetDiagonal(mat,diag);
365:   VecSum(diag,trace);
366:   VecDestroy(&diag);
367:   return(0);
368: }

370: /*@
371:    MatRealPart - Zeros out the imaginary part of the matrix

373:    Logically Collective on Mat

375:    Input Parameters:
376: .  mat - the matrix

378:    Level: advanced


381: .seealso: MatImaginaryPart()
382: @*/
383: PetscErrorCode MatRealPart(Mat mat)
384: {

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

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

401:    Collective on Mat

403:    Input Parameter:
404: .  mat - the matrix

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

410:    Notes:
411:     the nghosts and ghosts are suitable to pass into VecCreateGhost()

413:    Level: advanced

415: @*/
416: PetscErrorCode MatGetGhosts(Mat mat,PetscInt *nghosts,const PetscInt *ghosts[])
417: {

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


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

438:    Logically Collective on Mat

440:    Input Parameters:
441: .  mat - the matrix

443:    Level: advanced


446: .seealso: MatRealPart()
447: @*/
448: PetscErrorCode MatImaginaryPart(Mat mat)
449: {

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

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

466:    Not Collective

468:    Input Parameter:
469: .  mat - the matrix

471:    Output Parameters:
472: +  missing - is any diagonal missing
473: -  dd - first diagonal entry that is missing (optional) on this process

475:    Level: advanced


478: .seealso: MatRealPart()
479: @*/
480: PetscErrorCode MatMissingDiagonal(Mat mat,PetscBool *missing,PetscInt *dd)
481: {

488:   if (!mat->assembled) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix %s",((PetscObject)mat)->type_name);
489:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
490:   if (!mat->ops->missingdiagonal) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
491:   (*mat->ops->missingdiagonal)(mat,missing,dd);
492:   return(0);
493: }

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

500:    Not Collective

502:    Input Parameters:
503: +  mat - the matrix
504: -  row - the row to get

506:    Output Parameters:
507: +  ncols -  if not NULL, the number of nonzeros in the row
508: .  cols - if not NULL, the column numbers
509: -  vals - if not NULL, the values

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

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

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

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

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

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


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

550:    Level: advanced

552: .seealso: MatRestoreRow(), MatSetValues(), MatGetValues(), MatCreateSubMatrices(), MatGetDiagonal()
553: @*/
554: PetscErrorCode MatGetRow(Mat mat,PetscInt row,PetscInt *ncols,const PetscInt *cols[],const PetscScalar *vals[])
555: {
557:   PetscInt       incols;

562:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
563:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
564:   if (!mat->ops->getrow) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
565:   MatCheckPreallocated(mat,1);
566:   if (row < mat->rmap->rstart || row >= mat->rmap->rend) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Only for local rows, %D not in [%D,%D)",row,mat->rmap->rstart,mat->rmap->rend);
567:   PetscLogEventBegin(MAT_GetRow,mat,0,0,0);
568:   (*mat->ops->getrow)(mat,row,&incols,(PetscInt**)cols,(PetscScalar**)vals);
569:   if (ncols) *ncols = incols;
570:   PetscLogEventEnd(MAT_GetRow,mat,0,0,0);
571:   return(0);
572: }

574: /*@
575:    MatConjugate - replaces the matrix values with their complex conjugates

577:    Logically Collective on Mat

579:    Input Parameters:
580: .  mat - the matrix

582:    Level: advanced

584: .seealso:  VecConjugate()
585: @*/
586: PetscErrorCode MatConjugate(Mat mat)
587: {
588: #if defined(PETSC_USE_COMPLEX)

593:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
594:   if (!mat->ops->conjugate) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Not provided for matrix type %s, send email to petsc-maint@mcs.anl.gov",((PetscObject)mat)->type_name);
595:   (*mat->ops->conjugate)(mat);
596: #else
598: #endif
599:   return(0);
600: }

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

605:    Not Collective

607:    Input Parameters:
608: +  mat - the matrix
609: .  row - the row to get
610: .  ncols, cols - the number of nonzeros and their columns
611: -  vals - if nonzero the column values

613:    Notes:
614:    This routine should be called after you have finished examining the entries.

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

620:    Fortran Notes:
621:    The calling sequence from Fortran is
622: .vb
623:    MatRestoreRow(matrix,row,ncols,cols,values,ierr)
624:       Mat     matrix (input)
625:       integer row    (input)
626:       integer ncols  (output)
627:       integer cols(maxcols) (output)
628:       double precision (or double complex) values(maxcols) output
629: .ve
630:    Where maxcols >= maximum nonzeros in any row of the matrix.

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

635:    Level: advanced

637: .seealso:  MatGetRow()
638: @*/
639: PetscErrorCode MatRestoreRow(Mat mat,PetscInt row,PetscInt *ncols,const PetscInt *cols[],const PetscScalar *vals[])
640: {

646:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
647:   if (!mat->ops->restorerow) return(0);
648:   (*mat->ops->restorerow)(mat,row,ncols,(PetscInt **)cols,(PetscScalar **)vals);
649:   if (ncols) *ncols = 0;
650:   if (cols)  *cols = NULL;
651:   if (vals)  *vals = NULL;
652:   return(0);
653: }

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

659:    Not Collective

661:    Input Parameters:
662: .  mat - the matrix

664:    Notes:
665:    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.

667:    Level: advanced

669: .seealso: MatRestoreRowUpperTriangular()
670: @*/
671: PetscErrorCode MatGetRowUpperTriangular(Mat mat)
672: {

678:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
679:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
680:   MatCheckPreallocated(mat,1);
681:   if (!mat->ops->getrowuppertriangular) return(0);
682:   (*mat->ops->getrowuppertriangular)(mat);
683:   return(0);
684: }

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

689:    Not Collective

691:    Input Parameters:
692: .  mat - the matrix

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


698:    Level: advanced

700: .seealso:  MatGetRowUpperTriangular()
701: @*/
702: PetscErrorCode MatRestoreRowUpperTriangular(Mat mat)
703: {

709:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
710:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
711:   MatCheckPreallocated(mat,1);
712:   if (!mat->ops->restorerowuppertriangular) return(0);
713:   (*mat->ops->restorerowuppertriangular)(mat);
714:   return(0);
715: }

717: /*@C
718:    MatSetOptionsPrefix - Sets the prefix used for searching for all
719:    Mat options in the database.

721:    Logically Collective on Mat

723:    Input Parameter:
724: +  A - the Mat context
725: -  prefix - the prefix to prepend to all option names

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

731:    Level: advanced

733: .seealso: MatSetFromOptions()
734: @*/
735: PetscErrorCode MatSetOptionsPrefix(Mat A,const char prefix[])
736: {

741:   PetscObjectSetOptionsPrefix((PetscObject)A,prefix);
742:   return(0);
743: }

745: /*@C
746:    MatAppendOptionsPrefix - Appends to the prefix used for searching for all
747:    Mat options in the database.

749:    Logically Collective on Mat

751:    Input Parameters:
752: +  A - the Mat context
753: -  prefix - the prefix to prepend to all option names

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

759:    Level: advanced

761: .seealso: MatGetOptionsPrefix()
762: @*/
763: PetscErrorCode MatAppendOptionsPrefix(Mat A,const char prefix[])
764: {

769:   PetscObjectAppendOptionsPrefix((PetscObject)A,prefix);
770:   return(0);
771: }

773: /*@C
774:    MatGetOptionsPrefix - Gets the prefix used for searching for all
775:    Mat options in the database.

777:    Not Collective

779:    Input Parameter:
780: .  A - the Mat context

782:    Output Parameter:
783: .  prefix - pointer to the prefix string used

785:    Notes:
786:     On the fortran side, the user should pass in a string 'prefix' of
787:    sufficient length to hold the prefix.

789:    Level: advanced

791: .seealso: MatAppendOptionsPrefix()
792: @*/
793: PetscErrorCode MatGetOptionsPrefix(Mat A,const char *prefix[])
794: {

799:   PetscObjectGetOptionsPrefix((PetscObject)A,prefix);
800:   return(0);
801: }

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

806:    Collective on Mat

808:    Input Parameters:
809: .  A - the Mat context

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

815:    Level: beginner

817: .seealso: MatSeqAIJSetPreallocation(), MatMPIAIJSetPreallocation(), MatXAIJSetPreallocation()
818: @*/
819: PetscErrorCode MatResetPreallocation(Mat A)
820: {

826:   PetscUseMethod(A,"MatResetPreallocation_C",(Mat),(A));
827:   return(0);
828: }


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

834:    Collective on Mat

836:    Input Parameters:
837: .  A - the Mat context

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

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

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

846:    Level: beginner

848: .seealso: MatCreate(), MatDestroy()
849: @*/
850: PetscErrorCode MatSetUp(Mat A)
851: {
852:   PetscMPIInt    size;

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

875: #if defined(PETSC_HAVE_SAWS)
876: #include <petscviewersaws.h>
877: #endif

879: /*@C
880:    MatViewFromOptions - View from Options

882:    Collective on Mat

884:    Input Parameters:
885: +  A - the Mat context
886: .  obj - Optional object
887: -  name - command line option

889:    Level: intermediate
890: .seealso:  Mat, MatView, PetscObjectViewFromOptions(), MatCreate()
891: @*/
892: PetscErrorCode  MatViewFromOptions(Mat A,PetscObject obj,const char name[])
893: {

898:   PetscObjectViewFromOptions((PetscObject)A,obj,name);
899:   return(0);
900: }

902: /*@C
903:    MatView - Visualizes a matrix object.

905:    Collective on Mat

907:    Input Parameters:
908: +  mat - the matrix
909: -  viewer - visualization context

911:   Notes:
912:   The available visualization contexts include
913: +    PETSC_VIEWER_STDOUT_SELF - for sequential matrices
914: .    PETSC_VIEWER_STDOUT_WORLD - for parallel matrices created on PETSC_COMM_WORLD
915: .    PETSC_VIEWER_STDOUT_(comm) - for matrices created on MPI communicator comm
916: -     PETSC_VIEWER_DRAW_WORLD - graphical display of nonzero structure

918:    The user can open alternative visualization contexts with
919: +    PetscViewerASCIIOpen() - Outputs matrix to a specified file
920: .    PetscViewerBinaryOpen() - Outputs matrix in binary to a
921:          specified file; corresponding input uses MatLoad()
922: .    PetscViewerDrawOpen() - Outputs nonzero matrix structure to
923:          an X window display
924: -    PetscViewerSocketOpen() - Outputs matrix to Socket viewer.
925:          Currently only the sequential dense and AIJ
926:          matrix types support the Socket viewer.

928:    The user can call PetscViewerPushFormat() to specify the output
929:    format of ASCII printed objects (when using PETSC_VIEWER_STDOUT_SELF,
930:    PETSC_VIEWER_STDOUT_WORLD and PetscViewerASCIIOpen).  Available formats include
931: +    PETSC_VIEWER_DEFAULT - default, prints matrix contents
932: .    PETSC_VIEWER_ASCII_MATLAB - prints matrix contents in Matlab format
933: .    PETSC_VIEWER_ASCII_DENSE - prints entire matrix including zeros
934: .    PETSC_VIEWER_ASCII_COMMON - prints matrix contents, using a sparse
935:          format common among all matrix types
936: .    PETSC_VIEWER_ASCII_IMPL - prints matrix contents, using an implementation-specific
937:          format (which is in many cases the same as the default)
938: .    PETSC_VIEWER_ASCII_INFO - prints basic information about the matrix
939:          size and structure (not the matrix entries)
940: -    PETSC_VIEWER_ASCII_INFO_DETAIL - prints more detailed information about
941:          the matrix structure

943:    Options Database Keys:
944: +  -mat_view ::ascii_info - Prints info on matrix at conclusion of MatAssemblyEnd()
945: .  -mat_view ::ascii_info_detail - Prints more detailed info
946: .  -mat_view - Prints matrix in ASCII format
947: .  -mat_view ::ascii_matlab - Prints matrix in Matlab format
948: .  -mat_view draw - PetscDraws nonzero structure of matrix, using MatView() and PetscDrawOpenX().
949: .  -display <name> - Sets display name (default is host)
950: .  -draw_pause <sec> - Sets number of seconds to pause after display
951: .  -mat_view socket - Sends matrix to socket, can be accessed from Matlab (see Users-Manual: ch_matlab for details)
952: .  -viewer_socket_machine <machine> -
953: .  -viewer_socket_port <port> -
954: .  -mat_view binary - save matrix to file in binary format
955: -  -viewer_binary_filename <name> -
956:    Level: beginner

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

962:     In the debugger you can do "call MatView(mat,0)" to display the matrix. (The same holds for any PETSc object viewer).

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

967:       See share/petsc/matlab/PetscBinaryRead.m for a Matlab code that can read in the binary file when the binary
968:       viewer is used and lib/petsc/bin/PetscBinaryIO.py for loading them into Python.

970:       One can use '-mat_view draw -draw_pause -1' to pause the graphical display of matrix nonzero structure,
971:       and then use the following mouse functions.
972: + left mouse: zoom in
973: . middle mouse: zoom out
974: - right mouse: continue with the simulation

976: .seealso: PetscViewerPushFormat(), PetscViewerASCIIOpen(), PetscViewerDrawOpen(),
977:           PetscViewerSocketOpen(), PetscViewerBinaryOpen(), MatLoad()
978: @*/
979: PetscErrorCode MatView(Mat mat,PetscViewer viewer)
980: {
981:   PetscErrorCode    ierr;
982:   PetscInt          rows,cols,rbs,cbs;
983:   PetscBool         isascii,isstring,issaws;
984:   PetscViewerFormat format;
985:   PetscMPIInt       size;

990:   if (!viewer) {PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)mat),&viewer);}
993:   MatCheckPreallocated(mat,1);

995:   PetscViewerGetFormat(viewer,&format);
996:   MPI_Comm_size(PetscObjectComm((PetscObject)mat),&size);
997:   if (size == 1 && format == PETSC_VIEWER_LOAD_BALANCE) return(0);

999:   PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);
1000:   PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);
1001:   PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);
1002:   if ((!isascii || (format != PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL)) && mat->factortype) {
1003:     SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"No viewers for factored matrix except ASCII info or info_detail");
1004:   }

1006:   PetscLogEventBegin(MAT_View,mat,viewer,0,0);
1007:   if (isascii) {
1008:     if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ORDER,"Must call MatAssemblyBegin/End() before viewing matrix");
1009:     PetscObjectPrintClassNamePrefixType((PetscObject)mat,viewer);
1010:     if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
1011:       MatNullSpace nullsp,transnullsp;

1013:       PetscViewerASCIIPushTab(viewer);
1014:       MatGetSize(mat,&rows,&cols);
1015:       MatGetBlockSizes(mat,&rbs,&cbs);
1016:       if (rbs != 1 || cbs != 1) {
1017:         if (rbs != cbs) {PetscViewerASCIIPrintf(viewer,"rows=%D, cols=%D, rbs=%D, cbs=%D\n",rows,cols,rbs,cbs);}
1018:         else            {PetscViewerASCIIPrintf(viewer,"rows=%D, cols=%D, bs=%D\n",rows,cols,rbs);}
1019:       } else {
1020:         PetscViewerASCIIPrintf(viewer,"rows=%D, cols=%D\n",rows,cols);
1021:       }
1022:       if (mat->factortype) {
1023:         MatSolverType solver;
1024:         MatFactorGetSolverType(mat,&solver);
1025:         PetscViewerASCIIPrintf(viewer,"package used to perform factorization: %s\n",solver);
1026:       }
1027:       if (mat->ops->getinfo) {
1028:         MatInfo info;
1029:         MatGetInfo(mat,MAT_GLOBAL_SUM,&info);
1030:         PetscViewerASCIIPrintf(viewer,"total: nonzeros=%.f, allocated nonzeros=%.f\n",info.nz_used,info.nz_allocated);
1031:         if (!mat->factortype) {
1032:           PetscViewerASCIIPrintf(viewer,"total number of mallocs used during MatSetValues calls=%D\n",(PetscInt)info.mallocs);
1033:         }
1034:       }
1035:       MatGetNullSpace(mat,&nullsp);
1036:       MatGetTransposeNullSpace(mat,&transnullsp);
1037:       if (nullsp) {PetscViewerASCIIPrintf(viewer,"  has attached null space\n");}
1038:       if (transnullsp && transnullsp != nullsp) {PetscViewerASCIIPrintf(viewer,"  has attached transposed null space\n");}
1039:       MatGetNearNullSpace(mat,&nullsp);
1040:       if (nullsp) {PetscViewerASCIIPrintf(viewer,"  has attached near null space\n");}
1041:       PetscViewerASCIIPushTab(viewer);
1042:       MatProductView(mat,viewer);
1043:       PetscViewerASCIIPopTab(viewer);
1044:     }
1045:   } else if (issaws) {
1046: #if defined(PETSC_HAVE_SAWS)
1047:     PetscMPIInt rank;

1049:     PetscObjectName((PetscObject)mat);
1050:     MPI_Comm_rank(PETSC_COMM_WORLD,&rank);
1051:     if (!((PetscObject)mat)->amsmem && !rank) {
1052:       PetscObjectViewSAWs((PetscObject)mat,viewer);
1053:     }
1054: #endif
1055:   } else if (isstring) {
1056:     const char *type;
1057:     MatGetType(mat,&type);
1058:     PetscViewerStringSPrintf(viewer," MatType: %-7.7s",type);
1059:     if (mat->ops->view) {(*mat->ops->view)(mat,viewer);}
1060:   }
1061:   if ((format == PETSC_VIEWER_NATIVE || format == PETSC_VIEWER_LOAD_BALANCE) && mat->ops->viewnative) {
1062:     PetscViewerASCIIPushTab(viewer);
1063:     (*mat->ops->viewnative)(mat,viewer);
1064:     PetscViewerASCIIPopTab(viewer);
1065:   } else if (mat->ops->view) {
1066:     PetscViewerASCIIPushTab(viewer);
1067:     (*mat->ops->view)(mat,viewer);
1068:     PetscViewerASCIIPopTab(viewer);
1069:   }
1070:   if (isascii) {
1071:     PetscViewerGetFormat(viewer,&format);
1072:     if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
1073:       PetscViewerASCIIPopTab(viewer);
1074:     }
1075:   }
1076:   PetscLogEventEnd(MAT_View,mat,viewer,0,0);
1077:   return(0);
1078: }

1080: #if defined(PETSC_USE_DEBUG)
1081: #include <../src/sys/totalview/tv_data_display.h>
1082: PETSC_UNUSED static int TV_display_type(const struct _p_Mat *mat)
1083: {
1084:   TV_add_row("Local rows", "int", &mat->rmap->n);
1085:   TV_add_row("Local columns", "int", &mat->cmap->n);
1086:   TV_add_row("Global rows", "int", &mat->rmap->N);
1087:   TV_add_row("Global columns", "int", &mat->cmap->N);
1088:   TV_add_row("Typename", TV_ascii_string_type, ((PetscObject)mat)->type_name);
1089:   return TV_format_OK;
1090: }
1091: #endif

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

1099:    Collective on PetscViewer

1101:    Input Parameters:
1102: +  mat - the newly loaded matrix, this needs to have been created with MatCreate()
1103:             or some related function before a call to MatLoad()
1104: -  viewer - binary/HDF5 file viewer

1106:    Options Database Keys:
1107:    Used with block matrix formats (MATSEQBAIJ,  ...) to specify
1108:    block size
1109: .    -matload_block_size <bs>

1111:    Level: beginner

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

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

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

1126:    In parallel, each processor can load a subset of rows (or the
1127:    entire matrix).  This routine is especially useful when a large
1128:    matrix is stored on disk and only part of it is desired on each
1129:    processor.  For example, a parallel solver may access only some of
1130:    the rows from each processor.  The algorithm used here reads
1131:    relatively small blocks of data rather than reading the entire
1132:    matrix and then subsetting it.

1134:    Viewer's PetscViewerType must be either PETSCVIEWERBINARY or PETSCVIEWERHDF5.
1135:    Such viewer can be created using PetscViewerBinaryOpen()/PetscViewerHDF5Open(),
1136:    or the sequence like
1137: $    PetscViewer v;
1138: $    PetscViewerCreate(PETSC_COMM_WORLD,&v);
1139: $    PetscViewerSetType(v,PETSCVIEWERBINARY);
1140: $    PetscViewerSetFromOptions(v);
1141: $    PetscViewerFileSetMode(v,FILE_MODE_READ);
1142: $    PetscViewerFileSetName(v,"datafile");
1143:    The optional PetscViewerSetFromOptions() call allows to override PetscViewerSetType() using option
1144: $ -viewer_type {binary,hdf5}

1146:    See the example src/ksp/ksp/tutorials/ex27.c with the first approach,
1147:    and src/mat/tutorials/ex10.c with the second approach.

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

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

1160: $    PetscInt    MAT_FILE_CLASSID
1161: $    PetscInt    number of rows
1162: $    PetscInt    number of columns
1163: $    PetscInt    total number of nonzeros
1164: $    PetscInt    *number nonzeros in each row
1165: $    PetscInt    *column indices of all nonzeros (starting index is zero)
1166: $    PetscScalar *values of all nonzeros

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

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

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

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

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

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

1196:    Corresponding MatView() is not yet implemented.

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

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

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

1209:  @*/
1210: PetscErrorCode MatLoad(Mat mat,PetscViewer viewer)
1211: {
1213:   PetscBool      flg;


1219:   if (!((PetscObject)mat)->type_name) {
1220:     MatSetType(mat,MATAIJ);
1221:   }

1223:   flg  = PETSC_FALSE;
1224:   PetscOptionsGetBool(((PetscObject)mat)->options,((PetscObject)mat)->prefix,"-matload_symmetric",&flg,NULL);
1225:   if (flg) {
1226:     MatSetOption(mat,MAT_SYMMETRIC,PETSC_TRUE);
1227:     MatSetOption(mat,MAT_SYMMETRY_ETERNAL,PETSC_TRUE);
1228:   }
1229:   flg  = PETSC_FALSE;
1230:   PetscOptionsGetBool(((PetscObject)mat)->options,((PetscObject)mat)->prefix,"-matload_spd",&flg,NULL);
1231:   if (flg) {
1232:     MatSetOption(mat,MAT_SPD,PETSC_TRUE);
1233:   }

1235:   if (!mat->ops->load) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"MatLoad is not supported for type %s",((PetscObject)mat)->type_name);
1236:   PetscLogEventBegin(MAT_Load,mat,viewer,0,0);
1237:   (*mat->ops->load)(mat,viewer);
1238:   PetscLogEventEnd(MAT_Load,mat,viewer,0,0);
1239:   return(0);
1240: }

1242: static PetscErrorCode MatDestroy_Redundant(Mat_Redundant **redundant)
1243: {
1245:   Mat_Redundant  *redund = *redundant;
1246:   PetscInt       i;

1249:   if (redund){
1250:     if (redund->matseq) { /* via MatCreateSubMatrices()  */
1251:       ISDestroy(&redund->isrow);
1252:       ISDestroy(&redund->iscol);
1253:       MatDestroySubMatrices(1,&redund->matseq);
1254:     } else {
1255:       PetscFree2(redund->send_rank,redund->recv_rank);
1256:       PetscFree(redund->sbuf_j);
1257:       PetscFree(redund->sbuf_a);
1258:       for (i=0; i<redund->nrecvs; i++) {
1259:         PetscFree(redund->rbuf_j[i]);
1260:         PetscFree(redund->rbuf_a[i]);
1261:       }
1262:       PetscFree4(redund->sbuf_nz,redund->rbuf_nz,redund->rbuf_j,redund->rbuf_a);
1263:     }

1265:     if (redund->subcomm) {
1266:       PetscCommDestroy(&redund->subcomm);
1267:     }
1268:     PetscFree(redund);
1269:   }
1270:   return(0);
1271: }

1273: /*@C
1274:    MatDestroy - Frees space taken by a matrix.

1276:    Collective on Mat

1278:    Input Parameter:
1279: .  A - the matrix

1281:    Level: beginner

1283: @*/
1284: PetscErrorCode MatDestroy(Mat *A)
1285: {

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

1293:   /* if memory was published with SAWs then destroy it */
1294:   PetscObjectSAWsViewOff((PetscObject)*A);
1295:   if ((*A)->ops->destroy) {
1296:     (*(*A)->ops->destroy)(*A);
1297:   }

1299:   PetscFree((*A)->defaultvectype);
1300:   PetscFree((*A)->bsizes);
1301:   PetscFree((*A)->solvertype);
1302:   MatDestroy_Redundant(&(*A)->redundant);
1303:   MatProductClear(*A);
1304:   MatNullSpaceDestroy(&(*A)->nullsp);
1305:   MatNullSpaceDestroy(&(*A)->transnullsp);
1306:   MatNullSpaceDestroy(&(*A)->nearnullsp);
1307:   MatDestroy(&(*A)->schur);
1308:   PetscLayoutDestroy(&(*A)->rmap);
1309:   PetscLayoutDestroy(&(*A)->cmap);
1310:   PetscHeaderDestroy(A);
1311:   return(0);
1312: }

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

1319:    Not Collective

1321:    Input Parameters:
1322: +  mat - the matrix
1323: .  v - a logically two-dimensional array of values
1324: .  m, idxm - the number of rows and their global indices
1325: .  n, idxn - the number of columns and their global indices
1326: -  addv - either ADD_VALUES or INSERT_VALUES, where
1327:    ADD_VALUES adds values to any existing entries, and
1328:    INSERT_VALUES replaces existing entries with new values

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

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

1336:    Calls to MatSetValues() with the INSERT_VALUES and ADD_VALUES
1337:    options cannot be mixed without intervening calls to the assembly
1338:    routines.

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

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

1348:    Efficiency Alert:
1349:    The routine MatSetValuesBlocked() may offer much better efficiency
1350:    for users of block sparse formats (MATSEQBAIJ and MATMPIBAIJ).

1352:    Level: beginner

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

1358: .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
1359:           InsertMode, INSERT_VALUES, ADD_VALUES
1360: @*/
1361: PetscErrorCode MatSetValues(Mat mat,PetscInt m,const PetscInt idxm[],PetscInt n,const PetscInt idxn[],const PetscScalar v[],InsertMode addv)
1362: {

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

1373:   if (mat->insertmode == NOT_SET_VALUES) {
1374:     mat->insertmode = addv;
1375:   } else if (PetscUnlikely(mat->insertmode != addv)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
1376:   if (PetscDefined(USE_DEBUG)) {
1377:     PetscInt       i,j;

1379:     if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1380:     if (!mat->ops->setvalues) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);

1382:     for (i=0; i<m; i++) {
1383:       for (j=0; j<n; j++) {
1384:         if (mat->erroriffailure && PetscIsInfOrNanScalar(v[i*n+j]))
1385: #if defined(PETSC_USE_COMPLEX)
1386:           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]);
1387: #else
1388:           SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_FP,"Inserting %g at matrix entry (%D,%D)",(double)v[i*n+j],idxm[i],idxn[j]);
1389: #endif
1390:       }
1391:     }
1392:     for (i=0; i<m; i++) if (idxm[i] >= mat->rmap->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Cannot insert in row %D, maximum is %D",idxm[i],mat->rmap->N-1);
1393:     for (i=0; i<n; i++) if (idxn[i] >= mat->cmap->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Cannot insert in column %D, maximum is %D",idxn[i],mat->cmap->N-1);
1394:   }

1396:   if (mat->assembled) {
1397:     mat->was_assembled = PETSC_TRUE;
1398:     mat->assembled     = PETSC_FALSE;
1399:   }
1400:   PetscLogEventBegin(MAT_SetValues,mat,0,0,0);
1401:   (*mat->ops->setvalues)(mat,m,idxm,n,idxn,v,addv);
1402:   PetscLogEventEnd(MAT_SetValues,mat,0,0,0);
1403:   return(0);
1404: }


1407: /*@
1408:    MatSetValuesRowLocal - Inserts a row (block row for BAIJ matrices) of nonzero
1409:         values into a matrix

1411:    Not Collective

1413:    Input Parameters:
1414: +  mat - the matrix
1415: .  row - the (block) row to set
1416: -  v - a logically two-dimensional array of values

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

1421:    All the nonzeros in the row must be provided

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

1425:    The row must belong to this process

1427:    Level: intermediate

1429: .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
1430:           InsertMode, INSERT_VALUES, ADD_VALUES, MatSetValues(), MatSetValuesRow(), MatSetLocalToGlobalMapping()
1431: @*/
1432: PetscErrorCode MatSetValuesRowLocal(Mat mat,PetscInt row,const PetscScalar v[])
1433: {
1435:   PetscInt       globalrow;

1441:   ISLocalToGlobalMappingApply(mat->rmap->mapping,1,&row,&globalrow);
1442:   MatSetValuesRow(mat,globalrow,v);
1443:   return(0);
1444: }

1446: /*@
1447:    MatSetValuesRow - Inserts a row (block row for BAIJ matrices) of nonzero
1448:         values into a matrix

1450:    Not Collective

1452:    Input Parameters:
1453: +  mat - the matrix
1454: .  row - the (block) row to set
1455: -  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

1457:    Notes:
1458:    The values, v, are column-oriented for the block version.

1460:    All the nonzeros in the row must be provided

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

1464:    The row must belong to this process

1466:    Level: advanced

1468: .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
1469:           InsertMode, INSERT_VALUES, ADD_VALUES, MatSetValues()
1470: @*/
1471: PetscErrorCode MatSetValuesRow(Mat mat,PetscInt row,const PetscScalar v[])
1472: {

1478:   MatCheckPreallocated(mat,1);
1480:   if (PetscUnlikely(mat->insertmode == ADD_VALUES)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add and insert values");
1481:   if (PetscUnlikely(mat->factortype)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1482:   mat->insertmode = INSERT_VALUES;

1484:   if (mat->assembled) {
1485:     mat->was_assembled = PETSC_TRUE;
1486:     mat->assembled     = PETSC_FALSE;
1487:   }
1488:   PetscLogEventBegin(MAT_SetValues,mat,0,0,0);
1489:   if (!mat->ops->setvaluesrow) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
1490:   (*mat->ops->setvaluesrow)(mat,row,v);
1491:   PetscLogEventEnd(MAT_SetValues,mat,0,0,0);
1492:   return(0);
1493: }

1495: /*@
1496:    MatSetValuesStencil - Inserts or adds a block of values into a matrix.
1497:      Using structured grid indexing

1499:    Not Collective

1501:    Input Parameters:
1502: +  mat - the matrix
1503: .  m - number of rows being entered
1504: .  idxm - grid coordinates (and component number when dof > 1) for matrix rows being entered
1505: .  n - number of columns being entered
1506: .  idxn - grid coordinates (and component number when dof > 1) for matrix columns being entered
1507: .  v - a logically two-dimensional array of values
1508: -  addv - either ADD_VALUES or INSERT_VALUES, where
1509:    ADD_VALUES adds values to any existing entries, and
1510:    INSERT_VALUES replaces existing entries with new values

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

1515:    Calls to MatSetValuesStencil() with the INSERT_VALUES and ADD_VALUES
1516:    options cannot be mixed without intervening calls to the assembly
1517:    routines.

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

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

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

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

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

1535:    In Fortran idxm and idxn should be declared as
1536: $     MatStencil idxm(4,m),idxn(4,n)
1537:    and the values inserted using
1538: $    idxm(MatStencil_i,1) = i
1539: $    idxm(MatStencil_j,1) = j
1540: $    idxm(MatStencil_k,1) = k
1541: $    idxm(MatStencil_c,1) = c
1542:    etc

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

1549:    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
1550:    a single value per point) you can skip filling those indices.

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

1555:    Efficiency Alert:
1556:    The routine MatSetValuesBlockedStencil() may offer much better efficiency
1557:    for users of block sparse formats (MATSEQBAIJ and MATMPIBAIJ).

1559:    Level: beginner

1561: .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal()
1562:           MatSetValues(), MatSetValuesBlockedStencil(), MatSetStencil(), DMCreateMatrix(), DMDAVecGetArray(), MatStencil
1563: @*/
1564: PetscErrorCode MatSetValuesStencil(Mat mat,PetscInt m,const MatStencil idxm[],PetscInt n,const MatStencil idxn[],const PetscScalar v[],InsertMode addv)
1565: {
1567:   PetscInt       buf[8192],*bufm=NULL,*bufn=NULL,*jdxm,*jdxn;
1568:   PetscInt       j,i,dim = mat->stencil.dim,*dims = mat->stencil.dims+1,tmp;
1569:   PetscInt       *starts = mat->stencil.starts,*dxm = (PetscInt*)idxm,*dxn = (PetscInt*)idxn,sdim = dim - (1 - (PetscInt)mat->stencil.noc);

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

1578:   if ((m+n) <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
1579:     jdxm = buf; jdxn = buf+m;
1580:   } else {
1581:     PetscMalloc2(m,&bufm,n,&bufn);
1582:     jdxm = bufm; jdxn = bufn;
1583:   }
1584:   for (i=0; i<m; i++) {
1585:     for (j=0; j<3-sdim; j++) dxm++;
1586:     tmp = *dxm++ - starts[0];
1587:     for (j=0; j<dim-1; j++) {
1588:       if ((*dxm++ - starts[j+1]) < 0 || tmp < 0) tmp = -1;
1589:       else                                       tmp = tmp*dims[j] + *(dxm-1) - starts[j+1];
1590:     }
1591:     if (mat->stencil.noc) dxm++;
1592:     jdxm[i] = tmp;
1593:   }
1594:   for (i=0; i<n; i++) {
1595:     for (j=0; j<3-sdim; j++) dxn++;
1596:     tmp = *dxn++ - starts[0];
1597:     for (j=0; j<dim-1; j++) {
1598:       if ((*dxn++ - starts[j+1]) < 0 || tmp < 0) tmp = -1;
1599:       else                                       tmp = tmp*dims[j] + *(dxn-1) - starts[j+1];
1600:     }
1601:     if (mat->stencil.noc) dxn++;
1602:     jdxn[i] = tmp;
1603:   }
1604:   MatSetValuesLocal(mat,m,jdxm,n,jdxn,v,addv);
1605:   PetscFree2(bufm,bufn);
1606:   return(0);
1607: }

1609: /*@
1610:    MatSetValuesBlockedStencil - Inserts or adds a block of values into a matrix.
1611:      Using structured grid indexing

1613:    Not Collective

1615:    Input Parameters:
1616: +  mat - the matrix
1617: .  m - number of rows being entered
1618: .  idxm - grid coordinates for matrix rows being entered
1619: .  n - number of columns being entered
1620: .  idxn - grid coordinates for matrix columns being entered
1621: .  v - a logically two-dimensional array of values
1622: -  addv - either ADD_VALUES or INSERT_VALUES, where
1623:    ADD_VALUES adds values to any existing entries, and
1624:    INSERT_VALUES replaces existing entries with new values

1626:    Notes:
1627:    By default the values, v, are row-oriented and unsorted.
1628:    See MatSetOption() for other options.

1630:    Calls to MatSetValuesBlockedStencil() with the INSERT_VALUES and ADD_VALUES
1631:    options cannot be mixed without intervening calls to the assembly
1632:    routines.

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

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

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

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

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

1650:    In Fortran idxm and idxn should be declared as
1651: $     MatStencil idxm(4,m),idxn(4,n)
1652:    and the values inserted using
1653: $    idxm(MatStencil_i,1) = i
1654: $    idxm(MatStencil_j,1) = j
1655: $    idxm(MatStencil_k,1) = k
1656:    etc

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

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

1666:    Level: beginner

1668: .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal()
1669:           MatSetValues(), MatSetValuesStencil(), MatSetStencil(), DMCreateMatrix(), DMDAVecGetArray(), MatStencil,
1670:           MatSetBlockSize(), MatSetLocalToGlobalMapping()
1671: @*/
1672: PetscErrorCode MatSetValuesBlockedStencil(Mat mat,PetscInt m,const MatStencil idxm[],PetscInt n,const MatStencil idxn[],const PetscScalar v[],InsertMode addv)
1673: {
1675:   PetscInt       buf[8192],*bufm=NULL,*bufn=NULL,*jdxm,*jdxn;
1676:   PetscInt       j,i,dim = mat->stencil.dim,*dims = mat->stencil.dims+1,tmp;
1677:   PetscInt       *starts = mat->stencil.starts,*dxm = (PetscInt*)idxm,*dxn = (PetscInt*)idxn,sdim = dim - (1 - (PetscInt)mat->stencil.noc);

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

1687:   if ((m+n) <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
1688:     jdxm = buf; jdxn = buf+m;
1689:   } else {
1690:     PetscMalloc2(m,&bufm,n,&bufn);
1691:     jdxm = bufm; jdxn = bufn;
1692:   }
1693:   for (i=0; i<m; i++) {
1694:     for (j=0; j<3-sdim; j++) dxm++;
1695:     tmp = *dxm++ - starts[0];
1696:     for (j=0; j<sdim-1; j++) {
1697:       if ((*dxm++ - starts[j+1]) < 0 || tmp < 0) tmp = -1;
1698:       else                                       tmp = tmp*dims[j] + *(dxm-1) - starts[j+1];
1699:     }
1700:     dxm++;
1701:     jdxm[i] = tmp;
1702:   }
1703:   for (i=0; i<n; i++) {
1704:     for (j=0; j<3-sdim; j++) dxn++;
1705:     tmp = *dxn++ - starts[0];
1706:     for (j=0; j<sdim-1; j++) {
1707:       if ((*dxn++ - starts[j+1]) < 0 || tmp < 0) tmp = -1;
1708:       else                                       tmp = tmp*dims[j] + *(dxn-1) - starts[j+1];
1709:     }
1710:     dxn++;
1711:     jdxn[i] = tmp;
1712:   }
1713:   MatSetValuesBlockedLocal(mat,m,jdxm,n,jdxn,v,addv);
1714:   PetscFree2(bufm,bufn);
1715:   return(0);
1716: }

1718: /*@
1719:    MatSetStencil - Sets the grid information for setting values into a matrix via
1720:         MatSetValuesStencil()

1722:    Not Collective

1724:    Input Parameters:
1725: +  mat - the matrix
1726: .  dim - dimension of the grid 1, 2, or 3
1727: .  dims - number of grid points in x, y, and z direction, including ghost points on your processor
1728: .  starts - starting point of ghost nodes on your processor in x, y, and z direction
1729: -  dof - number of degrees of freedom per node


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

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

1738:    Level: beginner

1740: .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal()
1741:           MatSetValues(), MatSetValuesBlockedStencil(), MatSetValuesStencil()
1742: @*/
1743: PetscErrorCode MatSetStencil(Mat mat,PetscInt dim,const PetscInt dims[],const PetscInt starts[],PetscInt dof)
1744: {
1745:   PetscInt i;


1752:   mat->stencil.dim = dim + (dof > 1);
1753:   for (i=0; i<dim; i++) {
1754:     mat->stencil.dims[i]   = dims[dim-i-1];      /* copy the values in backwards */
1755:     mat->stencil.starts[i] = starts[dim-i-1];
1756:   }
1757:   mat->stencil.dims[dim]   = dof;
1758:   mat->stencil.starts[dim] = 0;
1759:   mat->stencil.noc         = (PetscBool)(dof == 1);
1760:   return(0);
1761: }

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

1766:    Not Collective

1768:    Input Parameters:
1769: +  mat - the matrix
1770: .  v - a logically two-dimensional array of values
1771: .  m, idxm - the number of block rows and their global block indices
1772: .  n, idxn - the number of block columns and their global block indices
1773: -  addv - either ADD_VALUES or INSERT_VALUES, where
1774:    ADD_VALUES adds values to any existing entries, and
1775:    INSERT_VALUES replaces existing entries with new values

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

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

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

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

1793:    Calls to MatSetValuesBlocked() with the INSERT_VALUES and ADD_VALUES
1794:    options cannot be mixed without intervening calls to the assembly
1795:    routines.

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

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

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

1811:    Example:
1812: $   Suppose m=n=2 and block size(bs) = 2 The array is
1813: $
1814: $   1  2  | 3  4
1815: $   5  6  | 7  8
1816: $   - - - | - - -
1817: $   9  10 | 11 12
1818: $   13 14 | 15 16
1819: $
1820: $   v[] should be passed in like
1821: $   v[] = [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16]
1822: $
1823: $  If you are not using row oriented storage of v (that is you called MatSetOption(mat,MAT_ROW_ORIENTED,PETSC_FALSE)) then
1824: $   v[] = [1,5,9,13,2,6,10,14,3,7,11,15,4,8,12,16]

1826:    Level: intermediate

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

1837:   if (!m || !n) return(0); /* no values to insert */
1841:   MatCheckPreallocated(mat,1);
1842:   if (mat->insertmode == NOT_SET_VALUES) {
1843:     mat->insertmode = addv;
1844:   } else if (PetscUnlikely(mat->insertmode != addv)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
1845:   if (PetscDefined(USE_DEBUG)) {
1846:     if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1847:     if (!mat->ops->setvaluesblocked && !mat->ops->setvalues) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
1848:   }
1849:   if (PetscDefined(USE_DEBUG)) {
1850:     PetscInt rbs,cbs,M,N,i;
1851:     MatGetBlockSizes(mat,&rbs,&cbs);
1852:     MatGetSize(mat,&M,&N);
1853:     for (i=0; i<m; i++) {
1854:       if (idxm[i]*rbs >= M) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Row block index %D (index %D) greater than row length %D",i,idxm[i],M);
1855:     }
1856:     for (i=0; i<n; i++) {
1857:       if (idxn[i]*cbs >= N) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Column block index %D (index %D) great than column length %D",i,idxn[i],N);
1858:     }
1859:   }
1860:   if (mat->assembled) {
1861:     mat->was_assembled = PETSC_TRUE;
1862:     mat->assembled     = PETSC_FALSE;
1863:   }
1864:   PetscLogEventBegin(MAT_SetValues,mat,0,0,0);
1865:   if (mat->ops->setvaluesblocked) {
1866:     (*mat->ops->setvaluesblocked)(mat,m,idxm,n,idxn,v,addv);
1867:   } else {
1868:     PetscInt buf[8192],*bufr=NULL,*bufc=NULL,*iidxm,*iidxn;
1869:     PetscInt i,j,bs,cbs;
1870:     MatGetBlockSizes(mat,&bs,&cbs);
1871:     if (m*bs+n*cbs <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
1872:       iidxm = buf; iidxn = buf + m*bs;
1873:     } else {
1874:       PetscMalloc2(m*bs,&bufr,n*cbs,&bufc);
1875:       iidxm = bufr; iidxn = bufc;
1876:     }
1877:     for (i=0; i<m; i++) {
1878:       for (j=0; j<bs; j++) {
1879:         iidxm[i*bs+j] = bs*idxm[i] + j;
1880:       }
1881:     }
1882:     for (i=0; i<n; i++) {
1883:       for (j=0; j<cbs; j++) {
1884:         iidxn[i*cbs+j] = cbs*idxn[i] + j;
1885:       }
1886:     }
1887:     MatSetValues(mat,m*bs,iidxm,n*cbs,iidxn,v,addv);
1888:     PetscFree2(bufr,bufc);
1889:   }
1890:   PetscLogEventEnd(MAT_SetValues,mat,0,0,0);
1891:   return(0);
1892: }

1894: /*@C
1895:    MatGetValues - Gets a block of values from a matrix.

1897:    Not Collective; can only return values that are owned by the give process

1899:    Input Parameters:
1900: +  mat - the matrix
1901: .  v - a logically two-dimensional array for storing the values
1902: .  m, idxm - the number of rows and their global indices
1903: -  n, idxn - the number of columns and their global indices

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

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

1913:      MatGetValues() requires that the matrix has been assembled
1914:      with MatAssemblyBegin()/MatAssemblyEnd().  Thus, calls to
1915:      MatSetValues() and MatGetValues() CANNOT be made in succession
1916:      without intermediate matrix assembly.

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

1921:      For the standard row-based matrix formats, idxm[] can only contain rows owned by the requesting MPI rank.
1922:      That is, rows with global index greater than or equal to restart and less than rend where restart and rend are obtainable
1923:      from MatGetOwnershipRange(mat,&rstart,&rend).

1925:    Level: advanced

1927: .seealso: MatGetRow(), MatCreateSubMatrices(), MatSetValues(), MatGetOwnershipRange(), MatGetValuesLocal()
1928: @*/
1929: PetscErrorCode MatGetValues(Mat mat,PetscInt m,const PetscInt idxm[],PetscInt n,const PetscInt idxn[],PetscScalar v[])
1930: {

1936:   if (!m || !n) return(0);
1940:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
1941:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1942:   if (!mat->ops->getvalues) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
1943:   MatCheckPreallocated(mat,1);

1945:   PetscLogEventBegin(MAT_GetValues,mat,0,0,0);
1946:   (*mat->ops->getvalues)(mat,m,idxm,n,idxn,v);
1947:   PetscLogEventEnd(MAT_GetValues,mat,0,0,0);
1948:   return(0);
1949: }

1951: /*@C
1952:    MatGetValuesLocal - retrieves values from certain locations in a matrix using the local numbering of the indices
1953:      defined previously by MatSetLocalToGlobalMapping()

1955:    Not Collective

1957:    Input Parameters:
1958: +  mat - the matrix
1959: .  nrow, irow - number of rows and their local indices
1960: -  ncol, icol - number of columns and their local indices

1962:    Output Parameter:
1963: .  y -  a logically two-dimensional array of values

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

1968:      This routine can only return values that are owned by the requesting MPI rank. That is, for standard matrix formats, rows that, in the global numbering,
1969:      are greater than or equal to restart and less than rend where restart and rend are obtainable from MatGetOwnershipRange(mat,&rstart,&rend). One can
1970:      determine if the resulting global row associated with the local row r is owned by the requesting MPI rank by applying the ISLocalToGlobalMapping set
1971:      with MatSetLocalToGlobalMapping().

1973:    Developer Notes:
1974:       This is labelled with C so does not automatically generate Fortran stubs and interfaces
1975:       because it requires multiple Fortran interfaces depending on which arguments are scalar or arrays.

1977:    Level: advanced

1979: .seealso:  MatAssemblyBegin(), MatAssemblyEnd(), MatSetValues(), MatSetLocalToGlobalMapping(),
1980:            MatSetValuesLocal(), MatGetValues()
1981: @*/
1982: PetscErrorCode MatGetValuesLocal(Mat mat,PetscInt nrow,const PetscInt irow[],PetscInt ncol,const PetscInt icol[],PetscScalar y[])
1983: {

1989:   MatCheckPreallocated(mat,1);
1990:   if (!nrow || !ncol) return(0); /* no values to retrieve */
1993:   if (PetscDefined(USE_DEBUG)) {
1994:     if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1995:     if (!mat->ops->getvalueslocal && !mat->ops->getvalues) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
1996:   }
1997:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
1998:   PetscLogEventBegin(MAT_GetValues,mat,0,0,0);
1999:   if (mat->ops->getvalueslocal) {
2000:     (*mat->ops->getvalueslocal)(mat,nrow,irow,ncol,icol,y);
2001:   } else {
2002:     PetscInt buf[8192],*bufr=NULL,*bufc=NULL,*irowm,*icolm;
2003:     if ((nrow+ncol) <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
2004:       irowm = buf; icolm = buf+nrow;
2005:     } else {
2006:       PetscMalloc2(nrow,&bufr,ncol,&bufc);
2007:       irowm = bufr; icolm = bufc;
2008:     }
2009:     if (!mat->rmap->mapping) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"MatGetValuesLocal() cannot proceed without local-to-global row mapping (See MatSetLocalToGlobalMapping()).");
2010:     if (!mat->cmap->mapping) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"MatGetValuesLocal() cannot proceed without local-to-global column mapping (See MatSetLocalToGlobalMapping()).");
2011:     ISLocalToGlobalMappingApply(mat->rmap->mapping,nrow,irow,irowm);
2012:     ISLocalToGlobalMappingApply(mat->cmap->mapping,ncol,icol,icolm);
2013:     MatGetValues(mat,nrow,irowm,ncol,icolm,y);
2014:     PetscFree2(bufr,bufc);
2015:   }
2016:   PetscLogEventEnd(MAT_GetValues,mat,0,0,0);
2017:   return(0);
2018: }

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

2024:   Not Collective

2026:   Input Parameters:
2027: + mat - the matrix
2028: . nb - the number of blocks
2029: . bs - the number of rows (and columns) in each block
2030: . rows - a concatenation of the rows for each block
2031: - v - a concatenation of logically two-dimensional arrays of values

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

2036:   Level: advanced

2038: .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
2039:           InsertMode, INSERT_VALUES, ADD_VALUES, MatSetValues()
2040: @*/
2041: PetscErrorCode MatSetValuesBatch(Mat mat, PetscInt nb, PetscInt bs, PetscInt rows[], const PetscScalar v[])
2042: {

2050:   if (PetscUnlikelyDebug(mat->factortype)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");

2052:   PetscLogEventBegin(MAT_SetValuesBatch,mat,0,0,0);
2053:   if (mat->ops->setvaluesbatch) {
2054:     (*mat->ops->setvaluesbatch)(mat,nb,bs,rows,v);
2055:   } else {
2056:     PetscInt b;
2057:     for (b = 0; b < nb; ++b) {
2058:       MatSetValues(mat, bs, &rows[b*bs], bs, &rows[b*bs], &v[b*bs*bs], ADD_VALUES);
2059:     }
2060:   }
2061:   PetscLogEventEnd(MAT_SetValuesBatch,mat,0,0,0);
2062:   return(0);
2063: }

2065: /*@
2066:    MatSetLocalToGlobalMapping - Sets a local-to-global numbering for use by
2067:    the routine MatSetValuesLocal() to allow users to insert matrix entries
2068:    using a local (per-processor) numbering.

2070:    Not Collective

2072:    Input Parameters:
2073: +  x - the matrix
2074: .  rmapping - row mapping created with ISLocalToGlobalMappingCreate()   or ISLocalToGlobalMappingCreateIS()
2075: - cmapping - column mapping

2077:    Level: intermediate


2080: .seealso:  MatAssemblyBegin(), MatAssemblyEnd(), MatSetValues(), MatSetValuesLocal(), MatGetValuesLocal()
2081: @*/
2082: PetscErrorCode MatSetLocalToGlobalMapping(Mat x,ISLocalToGlobalMapping rmapping,ISLocalToGlobalMapping cmapping)
2083: {


2092:   if (x->ops->setlocaltoglobalmapping) {
2093:     (*x->ops->setlocaltoglobalmapping)(x,rmapping,cmapping);
2094:   } else {
2095:     PetscLayoutSetISLocalToGlobalMapping(x->rmap,rmapping);
2096:     PetscLayoutSetISLocalToGlobalMapping(x->cmap,cmapping);
2097:   }
2098:   return(0);
2099: }


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

2105:    Not Collective

2107:    Input Parameters:
2108: .  A - the matrix

2110:    Output Parameters:
2111: + rmapping - row mapping
2112: - cmapping - column mapping

2114:    Level: advanced


2117: .seealso:  MatSetValuesLocal()
2118: @*/
2119: PetscErrorCode MatGetLocalToGlobalMapping(Mat A,ISLocalToGlobalMapping *rmapping,ISLocalToGlobalMapping *cmapping)
2120: {
2126:   if (rmapping) *rmapping = A->rmap->mapping;
2127:   if (cmapping) *cmapping = A->cmap->mapping;
2128:   return(0);
2129: }

2131: /*@
2132:    MatSetLayouts - Sets the PetscLayout objects for rows and columns of a matrix

2134:    Logically Collective on A

2136:    Input Parameters:
2137: +  A - the matrix
2138: . rmap - row layout
2139: - cmap - column layout

2141:    Level: advanced

2143: .seealso:  MatCreateVecs(), MatGetLocalToGlobalMapping(), MatGetLayouts()
2144: @*/
2145: PetscErrorCode MatSetLayouts(Mat A,PetscLayout rmap,PetscLayout cmap)
2146: {


2152:   PetscLayoutReference(rmap,&A->rmap);
2153:   PetscLayoutReference(cmap,&A->cmap);
2154:   return(0);
2155: }

2157: /*@
2158:    MatGetLayouts - Gets the PetscLayout objects for rows and columns

2160:    Not Collective

2162:    Input Parameters:
2163: .  A - the matrix

2165:    Output Parameters:
2166: + rmap - row layout
2167: - cmap - column layout

2169:    Level: advanced

2171: .seealso:  MatCreateVecs(), MatGetLocalToGlobalMapping(), MatSetLayouts()
2172: @*/
2173: PetscErrorCode MatGetLayouts(Mat A,PetscLayout *rmap,PetscLayout *cmap)
2174: {
2180:   if (rmap) *rmap = A->rmap;
2181:   if (cmap) *cmap = A->cmap;
2182:   return(0);
2183: }

2185: /*@C
2186:    MatSetValuesLocal - Inserts or adds values into certain locations of a matrix,
2187:    using a local numbering of the nodes.

2189:    Not Collective

2191:    Input Parameters:
2192: +  mat - the matrix
2193: .  nrow, irow - number of rows and their local indices
2194: .  ncol, icol - number of columns and their local indices
2195: .  y -  a logically two-dimensional array of values
2196: -  addv - either INSERT_VALUES or ADD_VALUES, where
2197:    ADD_VALUES adds values to any existing entries, and
2198:    INSERT_VALUES replaces existing entries with new values

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

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

2206:    Calls to MatSetValuesLocal() with the INSERT_VALUES and ADD_VALUES
2207:    options cannot be mixed without intervening calls to the assembly
2208:    routines.

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

2213:    Level: intermediate

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

2219: .seealso:  MatAssemblyBegin(), MatAssemblyEnd(), MatSetValues(), MatSetLocalToGlobalMapping(),
2220:            MatSetValueLocal(), MatGetValuesLocal()
2221: @*/
2222: PetscErrorCode MatSetValuesLocal(Mat mat,PetscInt nrow,const PetscInt irow[],PetscInt ncol,const PetscInt icol[],const PetscScalar y[],InsertMode addv)
2223: {

2229:   MatCheckPreallocated(mat,1);
2230:   if (!nrow || !ncol) return(0); /* no values to insert */
2233:   if (mat->insertmode == NOT_SET_VALUES) {
2234:     mat->insertmode = addv;
2235:   }
2236:   else if (PetscUnlikely(mat->insertmode != addv)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
2237:   if (PetscDefined(USE_DEBUG)) {
2238:     if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2239:     if (!mat->ops->setvalueslocal && !mat->ops->setvalues) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2240:   }

2242:   if (mat->assembled) {
2243:     mat->was_assembled = PETSC_TRUE;
2244:     mat->assembled     = PETSC_FALSE;
2245:   }
2246:   PetscLogEventBegin(MAT_SetValues,mat,0,0,0);
2247:   if (mat->ops->setvalueslocal) {
2248:     (*mat->ops->setvalueslocal)(mat,nrow,irow,ncol,icol,y,addv);
2249:   } else {
2250:     PetscInt buf[8192],*bufr=NULL,*bufc=NULL,*irowm,*icolm;
2251:     if ((nrow+ncol) <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
2252:       irowm = buf; icolm = buf+nrow;
2253:     } else {
2254:       PetscMalloc2(nrow,&bufr,ncol,&bufc);
2255:       irowm = bufr; icolm = bufc;
2256:     }
2257:     if (!mat->rmap->mapping) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"MatSetValuesLocal() cannot proceed without local-to-global row mapping (See MatSetLocalToGlobalMapping()).");
2258:     if (!mat->cmap->mapping) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"MatSetValuesLocal() cannot proceed without local-to-global column mapping (See MatSetLocalToGlobalMapping()).");
2259:     ISLocalToGlobalMappingApply(mat->rmap->mapping,nrow,irow,irowm);
2260:     ISLocalToGlobalMappingApply(mat->cmap->mapping,ncol,icol,icolm);
2261:     MatSetValues(mat,nrow,irowm,ncol,icolm,y,addv);
2262:     PetscFree2(bufr,bufc);
2263:   }
2264:   PetscLogEventEnd(MAT_SetValues,mat,0,0,0);
2265:   return(0);
2266: }

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

2272:    Not Collective

2274:    Input Parameters:
2275: +  x - the matrix
2276: .  nrow, irow - number of rows and their local indices
2277: .  ncol, icol - number of columns and their local indices
2278: .  y -  a logically two-dimensional array of values
2279: -  addv - either INSERT_VALUES or ADD_VALUES, where
2280:    ADD_VALUES adds values to any existing entries, and
2281:    INSERT_VALUES replaces existing entries with new values

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

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

2290:    Calls to MatSetValuesBlockedLocal() with the INSERT_VALUES and ADD_VALUES
2291:    options cannot be mixed without intervening calls to the assembly
2292:    routines.

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

2297:    Level: intermediate

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

2303: .seealso:  MatSetBlockSize(), MatSetLocalToGlobalMapping(), MatAssemblyBegin(), MatAssemblyEnd(),
2304:            MatSetValuesLocal(),  MatSetValuesBlocked()
2305: @*/
2306: PetscErrorCode MatSetValuesBlockedLocal(Mat mat,PetscInt nrow,const PetscInt irow[],PetscInt ncol,const PetscInt icol[],const PetscScalar y[],InsertMode addv)
2307: {

2313:   MatCheckPreallocated(mat,1);
2314:   if (!nrow || !ncol) return(0); /* no values to insert */
2318:   if (mat->insertmode == NOT_SET_VALUES) {
2319:     mat->insertmode = addv;
2320:   } else if (PetscUnlikely(mat->insertmode != addv)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
2321:   if (PetscDefined(USE_DEBUG)) {
2322:     if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2323:     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);
2324:   }

2326:   if (mat->assembled) {
2327:     mat->was_assembled = PETSC_TRUE;
2328:     mat->assembled     = PETSC_FALSE;
2329:   }
2330:   if (PetscUnlikelyDebug(mat->rmap->mapping)) { /* Condition on the mapping existing, because MatSetValuesBlockedLocal_IS does not require it to be set. */
2331:     PetscInt irbs, rbs;
2332:     MatGetBlockSizes(mat, &rbs, NULL);
2333:     ISLocalToGlobalMappingGetBlockSize(mat->rmap->mapping,&irbs);
2334:     if (rbs != irbs) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Different row block sizes! mat %D, row l2g map %D",rbs,irbs);
2335:   }
2336:   if (PetscUnlikelyDebug(mat->cmap->mapping)) {
2337:     PetscInt icbs, cbs;
2338:     MatGetBlockSizes(mat,NULL,&cbs);
2339:     ISLocalToGlobalMappingGetBlockSize(mat->cmap->mapping,&icbs);
2340:     if (cbs != icbs) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Different col block sizes! mat %D, col l2g map %D",cbs,icbs);
2341:   }
2342:   PetscLogEventBegin(MAT_SetValues,mat,0,0,0);
2343:   if (mat->ops->setvaluesblockedlocal) {
2344:     (*mat->ops->setvaluesblockedlocal)(mat,nrow,irow,ncol,icol,y,addv);
2345:   } else {
2346:     PetscInt buf[8192],*bufr=NULL,*bufc=NULL,*irowm,*icolm;
2347:     if ((nrow+ncol) <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
2348:       irowm = buf; icolm = buf + nrow;
2349:     } else {
2350:       PetscMalloc2(nrow,&bufr,ncol,&bufc);
2351:       irowm = bufr; icolm = bufc;
2352:     }
2353:     ISLocalToGlobalMappingApplyBlock(mat->rmap->mapping,nrow,irow,irowm);
2354:     ISLocalToGlobalMappingApplyBlock(mat->cmap->mapping,ncol,icol,icolm);
2355:     MatSetValuesBlocked(mat,nrow,irowm,ncol,icolm,y,addv);
2356:     PetscFree2(bufr,bufc);
2357:   }
2358:   PetscLogEventEnd(MAT_SetValues,mat,0,0,0);
2359:   return(0);
2360: }

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

2365:    Collective on Mat

2367:    Input Parameters:
2368: +  mat - the matrix
2369: -  x   - the vector to be multiplied

2371:    Output Parameters:
2372: .  y - the result

2374:    Notes:
2375:    The vectors x and y cannot be the same.  I.e., one cannot
2376:    call MatMult(A,y,y).

2378:    Level: developer

2380: .seealso: MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
2381: @*/
2382: PetscErrorCode MatMultDiagonalBlock(Mat mat,Vec x,Vec y)
2383: {


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

2397:   if (!mat->ops->multdiagonalblock) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s does not have a multiply defined",((PetscObject)mat)->type_name);
2398:   (*mat->ops->multdiagonalblock)(mat,x,y);
2399:   PetscObjectStateIncrease((PetscObject)y);
2400:   return(0);
2401: }

2403: /* --------------------------------------------------------*/
2404: /*@
2405:    MatMult - Computes the matrix-vector product, y = Ax.

2407:    Neighbor-wise Collective on Mat

2409:    Input Parameters:
2410: +  mat - the matrix
2411: -  x   - the vector to be multiplied

2413:    Output Parameters:
2414: .  y - the result

2416:    Notes:
2417:    The vectors x and y cannot be the same.  I.e., one cannot
2418:    call MatMult(A,y,y).

2420:    Level: beginner

2422: .seealso: MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
2423: @*/
2424: PetscErrorCode MatMult(Mat mat,Vec x,Vec y)
2425: {

2433:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2434:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2435:   if (x == y) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2436: #if !defined(PETSC_HAVE_CONSTRAINTS)
2437:   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);
2438:   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);
2439:   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);
2440: #endif
2441:   VecSetErrorIfLocked(y,3);
2442:   if (mat->erroriffailure) {VecValidValues(x,2,PETSC_TRUE);}
2443:   MatCheckPreallocated(mat,1);

2445:   VecLockReadPush(x);
2446:   if (!mat->ops->mult) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s does not have a multiply defined",((PetscObject)mat)->type_name);
2447:   PetscLogEventBegin(MAT_Mult,mat,x,y,0);
2448:   (*mat->ops->mult)(mat,x,y);
2449:   PetscLogEventEnd(MAT_Mult,mat,x,y,0);
2450:   if (mat->erroriffailure) {VecValidValues(y,3,PETSC_FALSE);}
2451:   VecLockReadPop(x);
2452:   return(0);
2453: }

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

2458:    Neighbor-wise Collective on Mat

2460:    Input Parameters:
2461: +  mat - the matrix
2462: -  x   - the vector to be multiplied

2464:    Output Parameters:
2465: .  y - the result

2467:    Notes:
2468:    The vectors x and y cannot be the same.  I.e., one cannot
2469:    call MatMultTranspose(A,y,y).

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

2474:    Level: beginner

2476: .seealso: MatMult(), MatMultAdd(), MatMultTransposeAdd(), MatMultHermitianTranspose(), MatTranspose()
2477: @*/
2478: PetscErrorCode MatMultTranspose(Mat mat,Vec x,Vec y)
2479: {
2480:   PetscErrorCode (*op)(Mat,Vec,Vec)=NULL,ierr;


2488:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2489:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2490:   if (x == y) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2491: #if !defined(PETSC_HAVE_CONSTRAINTS)
2492:   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);
2493:   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);
2494: #endif
2495:   if (mat->erroriffailure) {VecValidValues(x,2,PETSC_TRUE);}
2496:   MatCheckPreallocated(mat,1);

2498:   if (!mat->ops->multtranspose) {
2499:     if (mat->symmetric && mat->ops->mult) op = mat->ops->mult;
2500:     if (!op) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s does not have a multiply transpose defined or is symmetric and does not have a multiply defined",((PetscObject)mat)->type_name);
2501:   } else op = mat->ops->multtranspose;
2502:   PetscLogEventBegin(MAT_MultTranspose,mat,x,y,0);
2503:   VecLockReadPush(x);
2504:   (*op)(mat,x,y);
2505:   VecLockReadPop(x);
2506:   PetscLogEventEnd(MAT_MultTranspose,mat,x,y,0);
2507:   PetscObjectStateIncrease((PetscObject)y);
2508:   if (mat->erroriffailure) {VecValidValues(y,3,PETSC_FALSE);}
2509:   return(0);
2510: }

2512: /*@
2513:    MatMultHermitianTranspose - Computes matrix Hermitian transpose times a vector.

2515:    Neighbor-wise Collective on Mat

2517:    Input Parameters:
2518: +  mat - the matrix
2519: -  x   - the vector to be multilplied

2521:    Output Parameters:
2522: .  y - the result

2524:    Notes:
2525:    The vectors x and y cannot be the same.  I.e., one cannot
2526:    call MatMultHermitianTranspose(A,y,y).

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

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

2532:    Level: beginner

2534: .seealso: MatMult(), MatMultAdd(), MatMultHermitianTransposeAdd(), MatMultTranspose()
2535: @*/
2536: PetscErrorCode MatMultHermitianTranspose(Mat mat,Vec x,Vec y)
2537: {


2546:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2547:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2548:   if (x == y) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2549: #if !defined(PETSC_HAVE_CONSTRAINTS)
2550:   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);
2551:   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);
2552: #endif
2553:   MatCheckPreallocated(mat,1);

2555:   PetscLogEventBegin(MAT_MultHermitianTranspose,mat,x,y,0);
2556: #if defined(PETSC_USE_COMPLEX)
2557:   if (mat->ops->multhermitiantranspose || (mat->hermitian && mat->ops->mult)) {
2558:     VecLockReadPush(x);
2559:     if (mat->ops->multhermitiantranspose) {
2560:       (*mat->ops->multhermitiantranspose)(mat,x,y);
2561:     } else {
2562:       (*mat->ops->mult)(mat,x,y);
2563:     }
2564:     VecLockReadPop(x);
2565:   } else {
2566:     Vec w;
2567:     VecDuplicate(x,&w);
2568:     VecCopy(x,w);
2569:     VecConjugate(w);
2570:     MatMultTranspose(mat,w,y);
2571:     VecDestroy(&w);
2572:     VecConjugate(y);
2573:   }
2574:   PetscObjectStateIncrease((PetscObject)y);
2575: #else
2576:   MatMultTranspose(mat,x,y);
2577: #endif
2578:   PetscLogEventEnd(MAT_MultHermitianTranspose,mat,x,y,0);
2579:   return(0);
2580: }

2582: /*@
2583:     MatMultAdd -  Computes v3 = v2 + A * v1.

2585:     Neighbor-wise Collective on Mat

2587:     Input Parameters:
2588: +   mat - the matrix
2589: -   v1, v2 - the vectors

2591:     Output Parameters:
2592: .   v3 - the result

2594:     Notes:
2595:     The vectors v1 and v3 cannot be the same.  I.e., one cannot
2596:     call MatMultAdd(A,v1,v2,v1).

2598:     Level: beginner

2600: .seealso: MatMultTranspose(), MatMult(), MatMultTransposeAdd()
2601: @*/
2602: PetscErrorCode MatMultAdd(Mat mat,Vec v1,Vec v2,Vec v3)
2603: {


2613:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2614:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2615:   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);
2616:   /* 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);
2617:      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); */
2618:   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);
2619:   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);
2620:   if (v1 == v3) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"v1 and v3 must be different vectors");
2621:   MatCheckPreallocated(mat,1);

2623:   if (!mat->ops->multadd) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"No MatMultAdd() for matrix type %s",((PetscObject)mat)->type_name);
2624:   PetscLogEventBegin(MAT_MultAdd,mat,v1,v2,v3);
2625:   VecLockReadPush(v1);
2626:   (*mat->ops->multadd)(mat,v1,v2,v3);
2627:   VecLockReadPop(v1);
2628:   PetscLogEventEnd(MAT_MultAdd,mat,v1,v2,v3);
2629:   PetscObjectStateIncrease((PetscObject)v3);
2630:   return(0);
2631: }

2633: /*@
2634:    MatMultTransposeAdd - Computes v3 = v2 + A' * v1.

2636:    Neighbor-wise Collective on Mat

2638:    Input Parameters:
2639: +  mat - the matrix
2640: -  v1, v2 - the vectors

2642:    Output Parameters:
2643: .  v3 - the result

2645:    Notes:
2646:    The vectors v1 and v3 cannot be the same.  I.e., one cannot
2647:    call MatMultTransposeAdd(A,v1,v2,v1).

2649:    Level: beginner

2651: .seealso: MatMultTranspose(), MatMultAdd(), MatMult()
2652: @*/
2653: PetscErrorCode MatMultTransposeAdd(Mat mat,Vec v1,Vec v2,Vec v3)
2654: {


2664:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2665:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2666:   if (!mat->ops->multtransposeadd) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2667:   if (v1 == v3) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"v1 and v3 must be different vectors");
2668:   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);
2669:   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);
2670:   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);
2671:   MatCheckPreallocated(mat,1);

2673:   PetscLogEventBegin(MAT_MultTransposeAdd,mat,v1,v2,v3);
2674:   VecLockReadPush(v1);
2675:   (*mat->ops->multtransposeadd)(mat,v1,v2,v3);
2676:   VecLockReadPop(v1);
2677:   PetscLogEventEnd(MAT_MultTransposeAdd,mat,v1,v2,v3);
2678:   PetscObjectStateIncrease((PetscObject)v3);
2679:   return(0);
2680: }

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

2685:    Neighbor-wise Collective on Mat

2687:    Input Parameters:
2688: +  mat - the matrix
2689: -  v1, v2 - the vectors

2691:    Output Parameters:
2692: .  v3 - the result

2694:    Notes:
2695:    The vectors v1 and v3 cannot be the same.  I.e., one cannot
2696:    call MatMultHermitianTransposeAdd(A,v1,v2,v1).

2698:    Level: beginner

2700: .seealso: MatMultHermitianTranspose(), MatMultTranspose(), MatMultAdd(), MatMult()
2701: @*/
2702: PetscErrorCode MatMultHermitianTransposeAdd(Mat mat,Vec v1,Vec v2,Vec v3)
2703: {


2713:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2714:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2715:   if (v1 == v3) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"v1 and v3 must be different vectors");
2716:   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);
2717:   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);
2718:   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);
2719:   MatCheckPreallocated(mat,1);

2721:   PetscLogEventBegin(MAT_MultHermitianTransposeAdd,mat,v1,v2,v3);
2722:   VecLockReadPush(v1);
2723:   if (mat->ops->multhermitiantransposeadd) {
2724:     (*mat->ops->multhermitiantransposeadd)(mat,v1,v2,v3);
2725:   } else {
2726:     Vec w,z;
2727:     VecDuplicate(v1,&w);
2728:     VecCopy(v1,w);
2729:     VecConjugate(w);
2730:     VecDuplicate(v3,&z);
2731:     MatMultTranspose(mat,w,z);
2732:     VecDestroy(&w);
2733:     VecConjugate(z);
2734:     if (v2 != v3) {
2735:       VecWAXPY(v3,1.0,v2,z);
2736:     } else {
2737:       VecAXPY(v3,1.0,z);
2738:     }
2739:     VecDestroy(&z);
2740:   }
2741:   VecLockReadPop(v1);
2742:   PetscLogEventEnd(MAT_MultHermitianTransposeAdd,mat,v1,v2,v3);
2743:   PetscObjectStateIncrease((PetscObject)v3);
2744:   return(0);
2745: }

2747: /*@
2748:    MatMultConstrained - The inner multiplication routine for a
2749:    constrained matrix P^T A P.

2751:    Neighbor-wise Collective on Mat

2753:    Input Parameters:
2754: +  mat - the matrix
2755: -  x   - the vector to be multilplied

2757:    Output Parameters:
2758: .  y - the result

2760:    Notes:
2761:    The vectors x and y cannot be the same.  I.e., one cannot
2762:    call MatMult(A,y,y).

2764:    Level: beginner

2766: .seealso: MatMult(), MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
2767: @*/
2768: PetscErrorCode MatMultConstrained(Mat mat,Vec x,Vec y)
2769: {

2776:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2777:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2778:   if (x == y) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2779:   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);
2780:   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);
2781:   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);

2783:   PetscLogEventBegin(MAT_MultConstrained,mat,x,y,0);
2784:   VecLockReadPush(x);
2785:   (*mat->ops->multconstrained)(mat,x,y);
2786:   VecLockReadPop(x);
2787:   PetscLogEventEnd(MAT_MultConstrained,mat,x,y,0);
2788:   PetscObjectStateIncrease((PetscObject)y);
2789:   return(0);
2790: }

2792: /*@
2793:    MatMultTransposeConstrained - The inner multiplication routine for a
2794:    constrained matrix P^T A^T P.

2796:    Neighbor-wise Collective on Mat

2798:    Input Parameters:
2799: +  mat - the matrix
2800: -  x   - the vector to be multilplied

2802:    Output Parameters:
2803: .  y - the result

2805:    Notes:
2806:    The vectors x and y cannot be the same.  I.e., one cannot
2807:    call MatMult(A,y,y).

2809:    Level: beginner

2811: .seealso: MatMult(), MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
2812: @*/
2813: PetscErrorCode MatMultTransposeConstrained(Mat mat,Vec x,Vec y)
2814: {

2821:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2822:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2823:   if (x == y) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2824:   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);
2825:   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);

2827:   PetscLogEventBegin(MAT_MultConstrained,mat,x,y,0);
2828:   (*mat->ops->multtransposeconstrained)(mat,x,y);
2829:   PetscLogEventEnd(MAT_MultConstrained,mat,x,y,0);
2830:   PetscObjectStateIncrease((PetscObject)y);
2831:   return(0);
2832: }

2834: /*@C
2835:    MatGetFactorType - gets the type of factorization it is

2837:    Not Collective

2839:    Input Parameters:
2840: .  mat - the matrix

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

2845:    Level: intermediate

2847: .seealso: MatFactorType, MatGetFactor(), MatSetFactorType()
2848: @*/
2849: PetscErrorCode MatGetFactorType(Mat mat,MatFactorType *t)
2850: {
2855:   *t = mat->factortype;
2856:   return(0);
2857: }

2859: /*@C
2860:    MatSetFactorType - sets the type of factorization it is

2862:    Logically Collective on Mat

2864:    Input Parameters:
2865: +  mat - the matrix
2866: -  t - the type, one of MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT

2868:    Level: intermediate

2870: .seealso: MatFactorType, MatGetFactor(), MatGetFactorType()
2871: @*/
2872: PetscErrorCode MatSetFactorType(Mat mat, MatFactorType t)
2873: {
2877:   mat->factortype = t;
2878:   return(0);
2879: }

2881: /* ------------------------------------------------------------*/
2882: /*@C
2883:    MatGetInfo - Returns information about matrix storage (number of
2884:    nonzeros, memory, etc.).

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

2888:    Input Parameters:
2889: .  mat - the matrix

2891:    Output Parameters:
2892: +  flag - flag indicating the type of parameters to be returned
2893:    (MAT_LOCAL - local matrix, MAT_GLOBAL_MAX - maximum over all processors,
2894:    MAT_GLOBAL_SUM - sum over all processors)
2895: -  info - matrix information context

2897:    Notes:
2898:    The MatInfo context contains a variety of matrix data, including
2899:    number of nonzeros allocated and used, number of mallocs during
2900:    matrix assembly, etc.  Additional information for factored matrices
2901:    is provided (such as the fill ratio, number of mallocs during
2902:    factorization, etc.).  Much of this info is printed to PETSC_STDOUT
2903:    when using the runtime options
2904: $       -info -mat_view ::ascii_info

2906:    Example for C/C++ Users:
2907:    See the file ${PETSC_DIR}/include/petscmat.h for a complete list of
2908:    data within the MatInfo context.  For example,
2909: .vb
2910:       MatInfo info;
2911:       Mat     A;
2912:       double  mal, nz_a, nz_u;

2914:       MatGetInfo(A,MAT_LOCAL,&info);
2915:       mal  = info.mallocs;
2916:       nz_a = info.nz_allocated;
2917: .ve

2919:    Example for Fortran Users:
2920:    Fortran users should declare info as a double precision
2921:    array of dimension MAT_INFO_SIZE, and then extract the parameters
2922:    of interest.  See the file ${PETSC_DIR}/include/petsc/finclude/petscmat.h
2923:    a complete list of parameter names.
2924: .vb
2925:       double  precision info(MAT_INFO_SIZE)
2926:       double  precision mal, nz_a
2927:       Mat     A
2928:       integer ierr

2930:       call MatGetInfo(A,MAT_LOCAL,info,ierr)
2931:       mal = info(MAT_INFO_MALLOCS)
2932:       nz_a = info(MAT_INFO_NZ_ALLOCATED)
2933: .ve

2935:     Level: intermediate

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

2940: .seealso: MatStashGetInfo()

2942: @*/
2943: PetscErrorCode MatGetInfo(Mat mat,MatInfoType flag,MatInfo *info)
2944: {

2951:   if (!mat->ops->getinfo) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2952:   MatCheckPreallocated(mat,1);
2953:   (*mat->ops->getinfo)(mat,flag,info);
2954:   return(0);
2955: }

2957: /*
2958:    This is used by external packages where it is not easy to get the info from the actual
2959:    matrix factorization.
2960: */
2961: PetscErrorCode MatGetInfo_External(Mat A,MatInfoType flag,MatInfo *info)
2962: {

2966:   PetscMemzero(info,sizeof(MatInfo));
2967:   return(0);
2968: }

2970: /* ----------------------------------------------------------*/

2972: /*@C
2973:    MatLUFactor - Performs in-place LU factorization of matrix.

2975:    Collective on Mat

2977:    Input Parameters:
2978: +  mat - the matrix
2979: .  row - row permutation
2980: .  col - column permutation
2981: -  info - options for factorization, includes
2982: $          fill - expected fill as ratio of original fill.
2983: $          dtcol - pivot tolerance (0 no pivot, 1 full column pivoting)
2984: $                   Run with the option -info to determine an optimal value to use

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

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

2994:    Level: developer

2996: .seealso: MatLUFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor(),
2997:           MatGetOrdering(), MatSetUnfactored(), MatFactorInfo, MatGetFactor()

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

3002: @*/
3003: PetscErrorCode MatLUFactor(Mat mat,IS row,IS col,const MatFactorInfo *info)
3004: {
3006:   MatFactorInfo  tinfo;

3014:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3015:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3016:   if (!mat->ops->lufactor) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3017:   MatCheckPreallocated(mat,1);
3018:   if (!info) {
3019:     MatFactorInfoInitialize(&tinfo);
3020:     info = &tinfo;
3021:   }

3023:   PetscLogEventBegin(MAT_LUFactor,mat,row,col,0);
3024:   (*mat->ops->lufactor)(mat,row,col,info);
3025:   PetscLogEventEnd(MAT_LUFactor,mat,row,col,0);
3026:   PetscObjectStateIncrease((PetscObject)mat);
3027:   return(0);
3028: }

3030: /*@C
3031:    MatILUFactor - Performs in-place ILU factorization of matrix.

3033:    Collective on Mat

3035:    Input Parameters:
3036: +  mat - the matrix
3037: .  row - row permutation
3038: .  col - column permutation
3039: -  info - structure containing
3040: $      levels - number of levels of fill.
3041: $      expected fill - as ratio of original fill.
3042: $      1 or 0 - indicating force fill on diagonal (improves robustness for matrices
3043:                 missing diagonal entries)

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

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

3053:    Level: developer

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

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

3060: @*/
3061: PetscErrorCode MatILUFactor(Mat mat,IS row,IS col,const MatFactorInfo *info)
3062: {

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

3077:   PetscLogEventBegin(MAT_ILUFactor,mat,row,col,0);
3078:   (*mat->ops->ilufactor)(mat,row,col,info);
3079:   PetscLogEventEnd(MAT_ILUFactor,mat,row,col,0);
3080:   PetscObjectStateIncrease((PetscObject)mat);
3081:   return(0);
3082: }

3084: /*@C
3085:    MatLUFactorSymbolic - Performs symbolic LU factorization of matrix.
3086:    Call this routine before calling MatLUFactorNumeric().

3088:    Collective on Mat

3090:    Input Parameters:
3091: +  fact - the factor matrix obtained with MatGetFactor()
3092: .  mat - the matrix
3093: .  row, col - row and column permutations
3094: -  info - options for factorization, includes
3095: $          fill - expected fill as ratio of original fill.
3096: $          dtcol - pivot tolerance (0 no pivot, 1 full column pivoting)
3097: $                   Run with the option -info to determine an optimal value to use


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

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

3107:    Level: developer

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

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

3114: @*/
3115: PetscErrorCode MatLUFactorSymbolic(Mat fact,Mat mat,IS row,IS col,const MatFactorInfo *info)
3116: {
3118:   MatFactorInfo  tinfo;

3127:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3128:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3129:   if (!(fact)->ops->lufactorsymbolic) {
3130:     MatSolverType stype;
3131:     MatFactorGetSolverType(fact,&stype);
3132:     SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s symbolic LU using solver package %s",((PetscObject)mat)->type_name,stype);
3133:   }
3134:   MatCheckPreallocated(mat,2);
3135:   if (!info) {
3136:     MatFactorInfoInitialize(&tinfo);
3137:     info = &tinfo;
3138:   }

3140:   PetscLogEventBegin(MAT_LUFactorSymbolic,mat,row,col,0);
3141:   (fact->ops->lufactorsymbolic)(fact,mat,row,col,info);
3142:   PetscLogEventEnd(MAT_LUFactorSymbolic,mat,row,col,0);
3143:   PetscObjectStateIncrease((PetscObject)fact);
3144:   return(0);
3145: }

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

3151:    Collective on Mat

3153:    Input Parameters:
3154: +  fact - the factor matrix obtained with MatGetFactor()
3155: .  mat - the matrix
3156: -  info - options for factorization

3158:    Notes:
3159:    See MatLUFactor() for in-place factorization.  See
3160:    MatCholeskyFactorNumeric() for the symmetric, positive definite case.

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

3166:    Level: developer

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

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

3173: @*/
3174: PetscErrorCode MatLUFactorNumeric(Mat fact,Mat mat,const MatFactorInfo *info)
3175: {
3176:   MatFactorInfo  tinfo;

3184:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3185:   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);

3187:   if (!(fact)->ops->lufactornumeric) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s numeric LU",((PetscObject)mat)->type_name);
3188:   MatCheckPreallocated(mat,2);
3189:   if (!info) {
3190:     MatFactorInfoInitialize(&tinfo);
3191:     info = &tinfo;
3192:   }

3194:   PetscLogEventBegin(MAT_LUFactorNumeric,mat,fact,0,0);
3195:   (fact->ops->lufactornumeric)(fact,mat,info);
3196:   PetscLogEventEnd(MAT_LUFactorNumeric,mat,fact,0,0);
3197:   MatViewFromOptions(fact,NULL,"-mat_factor_view");
3198:   PetscObjectStateIncrease((PetscObject)fact);
3199:   return(0);
3200: }

3202: /*@C
3203:    MatCholeskyFactor - Performs in-place Cholesky factorization of a
3204:    symmetric matrix.

3206:    Collective on Mat

3208:    Input Parameters:
3209: +  mat - the matrix
3210: .  perm - row and column permutations
3211: -  f - expected fill as ratio of original fill

3213:    Notes:
3214:    See MatLUFactor() for the nonsymmetric case.  See also
3215:    MatCholeskyFactorSymbolic(), and MatCholeskyFactorNumeric().

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

3221:    Level: developer

3223: .seealso: MatLUFactor(), MatCholeskyFactorSymbolic(), MatCholeskyFactorNumeric()
3224:           MatGetOrdering()

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

3229: @*/
3230: PetscErrorCode MatCholeskyFactor(Mat mat,IS perm,const MatFactorInfo *info)
3231: {
3233:   MatFactorInfo  tinfo;

3240:   if (mat->rmap->N != mat->cmap->N) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONG,"Matrix must be square");
3241:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3242:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3243:   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);
3244:   MatCheckPreallocated(mat,1);
3245:   if (!info) {
3246:     MatFactorInfoInitialize(&tinfo);
3247:     info = &tinfo;
3248:   }

3250:   PetscLogEventBegin(MAT_CholeskyFactor,mat,perm,0,0);
3251:   (*mat->ops->choleskyfactor)(mat,perm,info);
3252:   PetscLogEventEnd(MAT_CholeskyFactor,mat,perm,0,0);
3253:   PetscObjectStateIncrease((PetscObject)mat);
3254:   return(0);
3255: }

3257: /*@C
3258:    MatCholeskyFactorSymbolic - Performs symbolic Cholesky factorization
3259:    of a symmetric matrix.

3261:    Collective on Mat

3263:    Input Parameters:
3264: +  fact - the factor matrix obtained with MatGetFactor()
3265: .  mat - the matrix
3266: .  perm - row and column permutations
3267: -  info - options for factorization, includes
3268: $          fill - expected fill as ratio of original fill.
3269: $          dtcol - pivot tolerance (0 no pivot, 1 full column pivoting)
3270: $                   Run with the option -info to determine an optimal value to use

3272:    Notes:
3273:    See MatLUFactorSymbolic() for the nonsymmetric case.  See also
3274:    MatCholeskyFactor() and MatCholeskyFactorNumeric().

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

3280:    Level: developer

3282: .seealso: MatLUFactorSymbolic(), MatCholeskyFactor(), MatCholeskyFactorNumeric()
3283:           MatGetOrdering()

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

3288: @*/
3289: PetscErrorCode MatCholeskyFactorSymbolic(Mat fact,Mat mat,IS perm,const MatFactorInfo *info)
3290: {
3292:   MatFactorInfo  tinfo;

3300:   if (mat->rmap->N != mat->cmap->N) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONG,"Matrix must be square");
3301:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3302:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3303:   if (!(fact)->ops->choleskyfactorsymbolic) {
3304:     MatSolverType stype;
3305:     MatFactorGetSolverType(fact,&stype);
3306:     SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s symbolic factor Cholesky using solver package %s",((PetscObject)mat)->type_name,stype);
3307:   }
3308:   MatCheckPreallocated(mat,2);
3309:   if (!info) {
3310:     MatFactorInfoInitialize(&tinfo);
3311:     info = &tinfo;
3312:   }

3314:   PetscLogEventBegin(MAT_CholeskyFactorSymbolic,mat,perm,0,0);
3315:   (fact->ops->choleskyfactorsymbolic)(fact,mat,perm,info);
3316:   PetscLogEventEnd(MAT_CholeskyFactorSymbolic,mat,perm,0,0);
3317:   PetscObjectStateIncrease((PetscObject)fact);
3318:   return(0);
3319: }

3321: /*@C
3322:    MatCholeskyFactorNumeric - Performs numeric Cholesky factorization
3323:    of a symmetric matrix. Call this routine after first calling
3324:    MatCholeskyFactorSymbolic().

3326:    Collective on Mat

3328:    Input Parameters:
3329: +  fact - the factor matrix obtained with MatGetFactor()
3330: .  mat - the initial matrix
3331: .  info - options for factorization
3332: -  fact - the symbolic factor of mat


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

3340:    Level: developer

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

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

3347: @*/
3348: PetscErrorCode MatCholeskyFactorNumeric(Mat fact,Mat mat,const MatFactorInfo *info)
3349: {
3350:   MatFactorInfo  tinfo;

3358:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3359:   if (!(fact)->ops->choleskyfactornumeric) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s numeric factor Cholesky",((PetscObject)mat)->type_name);
3360:   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);
3361:   MatCheckPreallocated(mat,2);
3362:   if (!info) {
3363:     MatFactorInfoInitialize(&tinfo);
3364:     info = &tinfo;
3365:   }

3367:   PetscLogEventBegin(MAT_CholeskyFactorNumeric,mat,fact,0,0);
3368:   (fact->ops->choleskyfactornumeric)(fact,mat,info);
3369:   PetscLogEventEnd(MAT_CholeskyFactorNumeric,mat,fact,0,0);
3370:   MatViewFromOptions(fact,NULL,"-mat_factor_view");
3371:   PetscObjectStateIncrease((PetscObject)fact);
3372:   return(0);
3373: }

3375: /*@C
3376:    MatQRFactor - Performs in-place QR factorization of matrix.

3378:    Collective on Mat

3380:    Input Parameters:
3381: +  mat - the matrix
3382: .  col - column permutation
3383: -  info - options for factorization, includes
3384: $          fill - expected fill as ratio of original fill.
3385: $          dtcol - pivot tolerance (0 no pivot, 1 full column pivoting)
3386: $                   Run with the option -info to determine an optimal value to use

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

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

3396:    Level: developer

3398: .seealso: MatQRFactorSymbolic(), MatQRFactorNumeric(), MatLUFactor(),
3399:           MatSetUnfactored(), MatFactorInfo, MatGetFactor()

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

3404: @*/
3405: PetscErrorCode MatQRFactor(Mat mat, IS col, const MatFactorInfo *info)
3406: {

3414:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3415:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3416:   MatCheckPreallocated(mat,1);
3417:   PetscLogEventBegin(MAT_QRFactor,mat,col,0,0);
3418:   PetscUseMethod(mat,"MatQRFactor_C", (Mat,IS,const MatFactorInfo*), (mat, col, info));
3419:   PetscLogEventEnd(MAT_QRFactor,mat,col,0,0);
3420:   PetscObjectStateIncrease((PetscObject)mat);
3421:   return(0);
3422: }

3424: /*@C
3425:    MatQRFactorSymbolic - Performs symbolic QR factorization of matrix.
3426:    Call this routine before calling MatQRFactorNumeric().

3428:    Collective on Mat

3430:    Input Parameters:
3431: +  fact - the factor matrix obtained with MatGetFactor()
3432: .  mat - the matrix
3433: .  col - column permutation
3434: -  info - options for factorization, includes
3435: $          fill - expected fill as ratio of original fill.
3436: $          dtcol - pivot tolerance (0 no pivot, 1 full column pivoting)
3437: $                   Run with the option -info to determine an optimal value to use

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

3443:    Level: developer

3445: .seealso: MatQRFactor(), MatQRFactorNumeric(), MatLUFactor(), MatFactorInfo, MatFactorInfoInitialize()

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

3450: @*/
3451: PetscErrorCode MatQRFactorSymbolic(Mat fact,Mat mat,IS col,const MatFactorInfo *info)
3452: {
3454:   MatFactorInfo  tinfo;

3462:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3463:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3464:   MatCheckPreallocated(mat,2);
3465:   if (!info) {
3466:     MatFactorInfoInitialize(&tinfo);
3467:     info = &tinfo;
3468:   }

3470:   PetscLogEventBegin(MAT_QRFactorSymbolic,fact,mat,col,0);
3471:   PetscUseMethod(fact,"MatQRFactorSymbolic_C", (Mat,Mat,IS,const MatFactorInfo*), (fact, mat, col, info));
3472:   PetscLogEventEnd(MAT_QRFactorSymbolic,fact,mat,col,0);
3473:   PetscObjectStateIncrease((PetscObject)fact);
3474:   return(0);
3475: }

3477: /*@C
3478:    MatQRFactorNumeric - Performs numeric QR factorization of a matrix.
3479:    Call this routine after first calling MatQRFactorSymbolic().

3481:    Collective on Mat

3483:    Input Parameters:
3484: +  fact - the factor matrix obtained with MatGetFactor()
3485: .  mat - the matrix
3486: -  info - options for factorization

3488:    Notes:
3489:    See MatQRFactor() for in-place factorization.

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

3495:    Level: developer

3497: .seealso: MatQRFactorSymbolic(), MatLUFactor()

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

3502: @*/
3503: PetscErrorCode MatQRFactorNumeric(Mat fact,Mat mat,const MatFactorInfo *info)
3504: {
3505:   MatFactorInfo  tinfo;

3513:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3514:   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);

3516:   MatCheckPreallocated(mat,2);
3517:   if (!info) {
3518:     MatFactorInfoInitialize(&tinfo);
3519:     info = &tinfo;
3520:   }

3522:   PetscLogEventBegin(MAT_QRFactorNumeric,mat,fact,0,0);
3523:   PetscUseMethod(fact,"MatQRFactorNumeric_C", (Mat,Mat,const MatFactorInfo*), (fact, mat, info));
3524:   PetscLogEventEnd(MAT_QRFactorNumeric,mat,fact,0,0);
3525:   MatViewFromOptions(fact,NULL,"-mat_factor_view");
3526:   PetscObjectStateIncrease((PetscObject)fact);
3527:   return(0);
3528: }

3530: /* ----------------------------------------------------------------*/
3531: /*@
3532:    MatSolve - Solves A x = b, given a factored matrix.

3534:    Neighbor-wise Collective on Mat

3536:    Input Parameters:
3537: +  mat - the factored matrix
3538: -  b - the right-hand-side vector

3540:    Output Parameter:
3541: .  x - the result vector

3543:    Notes:
3544:    The vectors b and x cannot be the same.  I.e., one cannot
3545:    call MatSolve(A,x,x).

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

3552:    Level: developer

3554: .seealso: MatSolveAdd(), MatSolveTranspose(), MatSolveTransposeAdd()
3555: @*/
3556: PetscErrorCode MatSolve(Mat mat,Vec b,Vec x)
3557: {

3567:   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3568:   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);
3569:   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);
3570:   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);
3571:   if (!mat->rmap->N && !mat->cmap->N) return(0);
3572:   MatCheckPreallocated(mat,1);

3574:   PetscLogEventBegin(MAT_Solve,mat,b,x,0);
3575:   if (mat->factorerrortype) {
3576:     PetscInfo1(mat,"MatFactorError %D\n",mat->factorerrortype);
3577:     VecSetInf(x);
3578:   } else {
3579:     if (!mat->ops->solve) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3580:     (*mat->ops->solve)(mat,b,x);
3581:   }
3582:   PetscLogEventEnd(MAT_Solve,mat,b,x,0);
3583:   PetscObjectStateIncrease((PetscObject)x);
3584:   return(0);
3585: }

3587: static PetscErrorCode MatMatSolve_Basic(Mat A,Mat B,Mat X,PetscBool trans)
3588: {
3590:   Vec            b,x;
3591:   PetscInt       m,N,i;
3592:   PetscScalar    *bb,*xx;
3593:   PetscErrorCode (*f)(Mat,Vec,Vec);

3596:   if (A->factorerrortype) {
3597:     PetscInfo1(A,"MatFactorError %D\n",A->factorerrortype);
3598:     MatSetInf(X);
3599:     return(0);
3600:   }
3601:   f = trans ? A->ops->solvetranspose : A->ops->solve;
3602:   if (!f) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Mat type %s",((PetscObject)A)->type_name);

3604:   MatDenseGetArrayRead(B,(const PetscScalar**)&bb);
3605:   MatDenseGetArray(X,&xx);
3606:   MatGetLocalSize(B,&m,NULL);  /* number local rows */
3607:   MatGetSize(B,NULL,&N);       /* total columns in dense matrix */
3608:   MatCreateVecs(A,&x,&b);
3609:   for (i=0; i<N; i++) {
3610:     VecPlaceArray(b,bb + i*m);
3611:     VecPlaceArray(x,xx + i*m);
3612:     (*f)(A,b,x);
3613:     VecResetArray(x);
3614:     VecResetArray(b);
3615:   }
3616:   VecDestroy(&b);
3617:   VecDestroy(&x);
3618:   MatDenseRestoreArrayRead(B,(const PetscScalar**)&bb);
3619:   MatDenseRestoreArray(X,&xx);
3620:   return(0);
3621: }

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

3626:    Neighbor-wise Collective on Mat

3628:    Input Parameters:
3629: +  A - the factored matrix
3630: -  B - the right-hand-side matrix MATDENSE (or sparse -- when using MUMPS)

3632:    Output Parameter:
3633: .  X - the result matrix (dense matrix)

3635:    Notes:
3636:    If B is a MATDENSE matrix then one can call MatMatSolve(A,B,B) except with MKL_CPARDISO;
3637:    otherwise, B and X cannot be the same.

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

3645:    Level: developer

3647: .seealso: MatMatSolveTranspose(), MatLUFactor(), MatCholeskyFactor()
3648: @*/
3649: PetscErrorCode MatMatSolve(Mat A,Mat B,Mat X)
3650: {

3660:   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);
3661:   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);
3662:   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");
3663:   if (!A->rmap->N && !A->cmap->N) return(0);
3664:   if (!A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3665:   MatCheckPreallocated(A,1);

3667:   PetscLogEventBegin(MAT_MatSolve,A,B,X,0);
3668:   if (!A->ops->matsolve) {
3669:     PetscInfo1(A,"Mat type %s using basic MatMatSolve\n",((PetscObject)A)->type_name);
3670:     MatMatSolve_Basic(A,B,X,PETSC_FALSE);
3671:   } else {
3672:     (*A->ops->matsolve)(A,B,X);
3673:   }
3674:   PetscLogEventEnd(MAT_MatSolve,A,B,X,0);
3675:   PetscObjectStateIncrease((PetscObject)X);
3676:   return(0);
3677: }

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

3682:    Neighbor-wise Collective on Mat

3684:    Input Parameters:
3685: +  A - the factored matrix
3686: -  B - the right-hand-side matrix  (dense matrix)

3688:    Output Parameter:
3689: .  X - the result matrix (dense matrix)

3691:    Notes:
3692:    The matrices B and X cannot be the same.  I.e., one cannot
3693:    call MatMatSolveTranspose(A,X,X).

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

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

3703:    Level: developer

3705: .seealso: MatMatSolve(), MatLUFactor(), MatCholeskyFactor()
3706: @*/
3707: PetscErrorCode MatMatSolveTranspose(Mat A,Mat B,Mat X)
3708: {

3718:   if (X == B) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_IDN,"X and B must be different matrices");
3719:   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);
3720:   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);
3721:   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);
3722:   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");
3723:   if (!A->rmap->N && !A->cmap->N) return(0);
3724:   if (!A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3725:   MatCheckPreallocated(A,1);

3727:   PetscLogEventBegin(MAT_MatSolve,A,B,X,0);
3728:   if (!A->ops->matsolvetranspose) {
3729:     PetscInfo1(A,"Mat type %s using basic MatMatSolveTranspose\n",((PetscObject)A)->type_name);
3730:     MatMatSolve_Basic(A,B,X,PETSC_TRUE);
3731:   } else {
3732:     (*A->ops->matsolvetranspose)(A,B,X);
3733:   }
3734:   PetscLogEventEnd(MAT_MatSolve,A,B,X,0);
3735:   PetscObjectStateIncrease((PetscObject)X);
3736:   return(0);
3737: }

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

3742:    Neighbor-wise Collective on Mat

3744:    Input Parameters:
3745: +  A - the factored matrix
3746: -  Bt - the transpose of right-hand-side matrix

3748:    Output Parameter:
3749: .  X - the result matrix (dense matrix)

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

3757:    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().

3759:    Level: developer

3761: .seealso: MatMatSolve(), MatMatSolveTranspose(), MatLUFactor(), MatCholeskyFactor()
3762: @*/
3763: PetscErrorCode MatMatTransposeSolve(Mat A,Mat Bt,Mat X)
3764: {


3775:   if (X == Bt) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_IDN,"X and B must be different matrices");
3776:   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);
3777:   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);
3778:   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");
3779:   if (!A->rmap->N && !A->cmap->N) return(0);
3780:   if (!A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3781:   MatCheckPreallocated(A,1);

3783:   if (!A->ops->mattransposesolve) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Mat type %s",((PetscObject)A)->type_name);
3784:   PetscLogEventBegin(MAT_MatTrSolve,A,Bt,X,0);
3785:   (*A->ops->mattransposesolve)(A,Bt,X);
3786:   PetscLogEventEnd(MAT_MatTrSolve,A,Bt,X,0);
3787:   PetscObjectStateIncrease((PetscObject)X);
3788:   return(0);
3789: }

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

3795:    Neighbor-wise Collective on Mat

3797:    Input Parameters:
3798: +  mat - the factored matrix
3799: -  b - the right-hand-side vector

3801:    Output Parameter:
3802: .  x - the result vector

3804:    Notes:
3805:    MatSolve() should be used for most applications, as it performs
3806:    a forward solve followed by a backward solve.

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

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

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

3821:    Level: developer

3823: .seealso: MatSolve(), MatBackwardSolve()
3824: @*/
3825: PetscErrorCode MatForwardSolve(Mat mat,Vec b,Vec x)
3826: {

3836:   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3837:   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);
3838:   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);
3839:   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);
3840:   if (!mat->rmap->N && !mat->cmap->N) return(0);
3841:   MatCheckPreallocated(mat,1);

3843:   if (!mat->ops->forwardsolve) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3844:   PetscLogEventBegin(MAT_ForwardSolve,mat,b,x,0);
3845:   (*mat->ops->forwardsolve)(mat,b,x);
3846:   PetscLogEventEnd(MAT_ForwardSolve,mat,b,x,0);
3847:   PetscObjectStateIncrease((PetscObject)x);
3848:   return(0);
3849: }

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

3855:    Neighbor-wise Collective on Mat

3857:    Input Parameters:
3858: +  mat - the factored matrix
3859: -  b - the right-hand-side vector

3861:    Output Parameter:
3862: .  x - the result vector

3864:    Notes:
3865:    MatSolve() should be used for most applications, as it performs
3866:    a forward solve followed by a backward solve.

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

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

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

3881:    Level: developer

3883: .seealso: MatSolve(), MatForwardSolve()
3884: @*/
3885: PetscErrorCode MatBackwardSolve(Mat mat,Vec b,Vec x)
3886: {

3896:   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3897:   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);
3898:   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);
3899:   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);
3900:   if (!mat->rmap->N && !mat->cmap->N) return(0);
3901:   MatCheckPreallocated(mat,1);

3903:   if (!mat->ops->backwardsolve) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3904:   PetscLogEventBegin(MAT_BackwardSolve,mat,b,x,0);
3905:   (*mat->ops->backwardsolve)(mat,b,x);
3906:   PetscLogEventEnd(MAT_BackwardSolve,mat,b,x,0);
3907:   PetscObjectStateIncrease((PetscObject)x);
3908:   return(0);
3909: }

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

3914:    Neighbor-wise Collective on Mat

3916:    Input Parameters:
3917: +  mat - the factored matrix
3918: .  b - the right-hand-side vector
3919: -  y - the vector to be added to

3921:    Output Parameter:
3922: .  x - the result vector

3924:    Notes:
3925:    The vectors b and x cannot be the same.  I.e., one cannot
3926:    call MatSolveAdd(A,x,y,x).

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

3932:    Level: developer

3934: .seealso: MatSolve(), MatSolveTranspose(), MatSolveTransposeAdd()
3935: @*/
3936: PetscErrorCode MatSolveAdd(Mat mat,Vec b,Vec y,Vec x)
3937: {
3938:   PetscScalar    one = 1.0;
3939:   Vec            tmp;

3951:   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3952:   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);
3953:   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);
3954:   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);
3955:   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);
3956:   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);
3957:   if (!mat->rmap->N && !mat->cmap->N) return(0);
3958:    MatCheckPreallocated(mat,1);

3960:   PetscLogEventBegin(MAT_SolveAdd,mat,b,x,y);
3961:   if (mat->factorerrortype) {
3962:     PetscInfo1(mat,"MatFactorError %D\n",mat->factorerrortype);
3963:     VecSetInf(x);
3964:   } else if (mat->ops->solveadd) {
3965:     (*mat->ops->solveadd)(mat,b,y,x);
3966:   } else {
3967:     /* do the solve then the add manually */
3968:     if (x != y) {
3969:       MatSolve(mat,b,x);
3970:       VecAXPY(x,one,y);
3971:     } else {
3972:       VecDuplicate(x,&tmp);
3973:       PetscLogObjectParent((PetscObject)mat,(PetscObject)tmp);
3974:       VecCopy(x,tmp);
3975:       MatSolve(mat,b,x);
3976:       VecAXPY(x,one,tmp);
3977:       VecDestroy(&tmp);
3978:     }
3979:   }
3980:   PetscLogEventEnd(MAT_SolveAdd,mat,b,x,y);
3981:   PetscObjectStateIncrease((PetscObject)x);
3982:   return(0);
3983: }

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

3988:    Neighbor-wise Collective on Mat

3990:    Input Parameters:
3991: +  mat - the factored matrix
3992: -  b - the right-hand-side vector

3994:    Output Parameter:
3995: .  x - the result vector

3997:    Notes:
3998:    The vectors b and x cannot be the same.  I.e., one cannot
3999:    call MatSolveTranspose(A,x,x).

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

4005:    Level: developer

4007: .seealso: MatSolve(), MatSolveAdd(), MatSolveTransposeAdd()
4008: @*/
4009: PetscErrorCode MatSolveTranspose(Mat mat,Vec b,Vec x)
4010: {

4020:   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
4021:   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);
4022:   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);
4023:   if (!mat->rmap->N && !mat->cmap->N) return(0);
4024:   MatCheckPreallocated(mat,1);
4025:   PetscLogEventBegin(MAT_SolveTranspose,mat,b,x,0);
4026:   if (mat->factorerrortype) {
4027:     PetscInfo1(mat,"MatFactorError %D\n",mat->factorerrortype);
4028:     VecSetInf(x);
4029:   } else {
4030:     if (!mat->ops->solvetranspose) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s",((PetscObject)mat)->type_name);
4031:     (*mat->ops->solvetranspose)(mat,b,x);
4032:   }
4033:   PetscLogEventEnd(MAT_SolveTranspose,mat,b,x,0);
4034:   PetscObjectStateIncrease((PetscObject)x);
4035:   return(0);
4036: }

4038: /*@
4039:    MatSolveTransposeAdd - Computes x = y + inv(Transpose(A)) b, given a
4040:                       factored matrix.

4042:    Neighbor-wise Collective on Mat

4044:    Input Parameters:
4045: +  mat - the factored matrix
4046: .  b - the right-hand-side vector
4047: -  y - the vector to be added to

4049:    Output Parameter:
4050: .  x - the result vector

4052:    Notes:
4053:    The vectors b and x cannot be the same.  I.e., one cannot
4054:    call MatSolveTransposeAdd(A,x,y,x).

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

4060:    Level: developer

4062: .seealso: MatSolve(), MatSolveAdd(), MatSolveTranspose()
4063: @*/
4064: PetscErrorCode MatSolveTransposeAdd(Mat mat,Vec b,Vec y,Vec x)
4065: {
4066:   PetscScalar    one = 1.0;
4068:   Vec            tmp;

4079:   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
4080:   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);
4081:   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);
4082:   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);
4083:   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);
4084:   if (!mat->rmap->N && !mat->cmap->N) return(0);
4085:    MatCheckPreallocated(mat,1);

4087:   PetscLogEventBegin(MAT_SolveTransposeAdd,mat,b,x,y);
4088:   if (mat->factorerrortype) {
4089:     PetscInfo1(mat,"MatFactorError %D\n",mat->factorerrortype);
4090:     VecSetInf(x);
4091:   } else if (mat->ops->solvetransposeadd){
4092:     (*mat->ops->solvetransposeadd)(mat,b,y,x);
4093:   } else {
4094:     /* do the solve then the add manually */
4095:     if (x != y) {
4096:       MatSolveTranspose(mat,b,x);
4097:       VecAXPY(x,one,y);
4098:     } else {
4099:       VecDuplicate(x,&tmp);
4100:       PetscLogObjectParent((PetscObject)mat,(PetscObject)tmp);
4101:       VecCopy(x,tmp);
4102:       MatSolveTranspose(mat,b,x);
4103:       VecAXPY(x,one,tmp);
4104:       VecDestroy(&tmp);
4105:     }
4106:   }
4107:   PetscLogEventEnd(MAT_SolveTransposeAdd,mat,b,x,y);
4108:   PetscObjectStateIncrease((PetscObject)x);
4109:   return(0);
4110: }
4111: /* ----------------------------------------------------------------*/

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

4116:    Neighbor-wise Collective on Mat

4118:    Input Parameters:
4119: +  mat - the matrix
4120: .  b - the right hand side
4121: .  omega - the relaxation factor
4122: .  flag - flag indicating the type of SOR (see below)
4123: .  shift -  diagonal shift
4124: .  its - the number of iterations
4125: -  lits - the number of local iterations

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

4130:    SOR Flags:
4131: +     SOR_FORWARD_SWEEP - forward SOR
4132: .     SOR_BACKWARD_SWEEP - backward SOR
4133: .     SOR_SYMMETRIC_SWEEP - SSOR (symmetric SOR)
4134: .     SOR_LOCAL_FORWARD_SWEEP - local forward SOR
4135: .     SOR_LOCAL_BACKWARD_SWEEP - local forward SOR
4136: .     SOR_LOCAL_SYMMETRIC_SWEEP - local SSOR
4137: .     SOR_APPLY_UPPER, SOR_APPLY_LOWER - applies
4138:          upper/lower triangular part of matrix to
4139:          vector (with omega)
4140: -     SOR_ZERO_INITIAL_GUESS - zero initial guess

4142:    Notes:
4143:    SOR_LOCAL_FORWARD_SWEEP, SOR_LOCAL_BACKWARD_SWEEP, and
4144:    SOR_LOCAL_SYMMETRIC_SWEEP perform separate independent smoothings
4145:    on each processor.

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

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

4153:    Notes for Advanced Users:
4154:    The flags are implemented as bitwise inclusive or operations.
4155:    For example, use (SOR_ZERO_INITIAL_GUESS | SOR_SYMMETRIC_SWEEP)
4156:    to specify a zero initial guess for SSOR.

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

4162:    Vectors x and b CANNOT be the same

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

4166:    Level: developer

4168: @*/
4169: PetscErrorCode MatSOR(Mat mat,Vec b,PetscReal omega,MatSORType flag,PetscReal shift,PetscInt its,PetscInt lits,Vec x)
4170: {

4180:   if (!mat->ops->sor) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4181:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4182:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4183:   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);
4184:   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);
4185:   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);
4186:   if (its <= 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Relaxation requires global its %D positive",its);
4187:   if (lits <= 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Relaxation requires local its %D positive",lits);
4188:   if (b == x) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"b and x vector cannot be the same");

4190:   MatCheckPreallocated(mat,1);
4191:   PetscLogEventBegin(MAT_SOR,mat,b,x,0);
4192:   ierr =(*mat->ops->sor)(mat,b,omega,flag,shift,its,lits,x);
4193:   PetscLogEventEnd(MAT_SOR,mat,b,x,0);
4194:   PetscObjectStateIncrease((PetscObject)x);
4195:   return(0);
4196: }

4198: /*
4199:       Default matrix copy routine.
4200: */
4201: PetscErrorCode MatCopy_Basic(Mat A,Mat B,MatStructure str)
4202: {
4203:   PetscErrorCode    ierr;
4204:   PetscInt          i,rstart = 0,rend = 0,nz;
4205:   const PetscInt    *cwork;
4206:   const PetscScalar *vwork;

4209:   if (B->assembled) {
4210:     MatZeroEntries(B);
4211:   }
4212:   if (str == SAME_NONZERO_PATTERN) {
4213:     MatGetOwnershipRange(A,&rstart,&rend);
4214:     for (i=rstart; i<rend; i++) {
4215:       MatGetRow(A,i,&nz,&cwork,&vwork);
4216:       MatSetValues(B,1,&i,nz,cwork,vwork,INSERT_VALUES);
4217:       MatRestoreRow(A,i,&nz,&cwork,&vwork);
4218:     }
4219:   } else {
4220:     MatAYPX(B,0.0,A,str);
4221:   }
4222:   MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);
4223:   MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);
4224:   return(0);
4225: }

4227: /*@
4228:    MatCopy - Copies a matrix to another matrix.

4230:    Collective on Mat

4232:    Input Parameters:
4233: +  A - the matrix
4234: -  str - SAME_NONZERO_PATTERN or DIFFERENT_NONZERO_PATTERN

4236:    Output Parameter:
4237: .  B - where the copy is put

4239:    Notes:
4240:    If you use SAME_NONZERO_PATTERN then the two matrices must have the same nonzero pattern or the routine will crash.

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

4246:    Level: intermediate

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

4250: @*/
4251: PetscErrorCode MatCopy(Mat A,Mat B,MatStructure str)
4252: {
4254:   PetscInt       i;

4262:   MatCheckPreallocated(B,2);
4263:   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4264:   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4265:   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);
4266:   MatCheckPreallocated(A,1);
4267:   if (A == B) return(0);

4269:   PetscLogEventBegin(MAT_Copy,A,B,0,0);
4270:   if (A->ops->copy) {
4271:     (*A->ops->copy)(A,B,str);
4272:   } else { /* generic conversion */
4273:     MatCopy_Basic(A,B,str);
4274:   }

4276:   B->stencil.dim = A->stencil.dim;
4277:   B->stencil.noc = A->stencil.noc;
4278:   for (i=0; i<=A->stencil.dim; i++) {
4279:     B->stencil.dims[i]   = A->stencil.dims[i];
4280:     B->stencil.starts[i] = A->stencil.starts[i];
4281:   }

4283:   PetscLogEventEnd(MAT_Copy,A,B,0,0);
4284:   PetscObjectStateIncrease((PetscObject)B);
4285:   return(0);
4286: }

4288: /*@C
4289:    MatConvert - Converts a matrix to another matrix, either of the same
4290:    or different type.

4292:    Collective on Mat

4294:    Input Parameters:
4295: +  mat - the matrix
4296: .  newtype - new matrix type.  Use MATSAME to create a new matrix of the
4297:    same type as the original matrix.
4298: -  reuse - denotes if the destination matrix is to be created or reused.
4299:    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
4300:    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).

4302:    Output Parameter:
4303: .  M - pointer to place new matrix

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

4310:    Cannot be used to convert a sequential matrix to parallel or parallel to sequential,
4311:    the MPI communicator of the generated matrix is always the same as the communicator
4312:    of the input matrix.

4314:    Level: intermediate

4316: .seealso: MatCopy(), MatDuplicate()
4317: @*/
4318: PetscErrorCode MatConvert(Mat mat, MatType newtype,MatReuse reuse,Mat *M)
4319: {
4321:   PetscBool      sametype,issame,flg,issymmetric,ishermitian;
4322:   char           convname[256],mtype[256];
4323:   Mat            B;

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

4333:   PetscOptionsGetString(((PetscObject)mat)->options,((PetscObject)mat)->prefix,"-matconvert_type",mtype,sizeof(mtype),&flg);
4334:   if (flg) newtype = mtype;

4336:   PetscObjectTypeCompare((PetscObject)mat,newtype,&sametype);
4337:   PetscStrcmp(newtype,"same",&issame);
4338:   if ((reuse == MAT_INPLACE_MATRIX) && (mat != *M)) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"MAT_INPLACE_MATRIX requires same input and output matrix");
4339:   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");

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

4346:   /* Cache Mat options because some converter use MatHeaderReplace  */
4347:   issymmetric = mat->symmetric;
4348:   ishermitian = mat->hermitian;

4350:   if ((sametype || issame) && (reuse==MAT_INITIAL_MATRIX) && mat->ops->duplicate) {
4351:     PetscInfo3(mat,"Calling duplicate for initial matrix %s %d %d\n",((PetscObject)mat)->type_name,sametype,issame);
4352:     (*mat->ops->duplicate)(mat,MAT_COPY_VALUES,M);
4353:   } else {
4354:     PetscErrorCode (*conv)(Mat, MatType,MatReuse,Mat*)=NULL;
4355:     const char     *prefix[3] = {"seq","mpi",""};
4356:     PetscInt       i;
4357:     /*
4358:        Order of precedence:
4359:        0) See if newtype is a superclass of the current matrix.
4360:        1) See if a specialized converter is known to the current matrix.
4361:        2) See if a specialized converter is known to the desired matrix class.
4362:        3) See if a good general converter is registered for the desired class
4363:           (as of 6/27/03 only MATMPIADJ falls into this category).
4364:        4) See if a good general converter is known for the current matrix.
4365:        5) Use a really basic converter.
4366:     */

4368:     /* 0) See if newtype is a superclass of the current matrix.
4369:           i.e mat is mpiaij and newtype is aij */
4370:     for (i=0; i<2; i++) {
4371:       PetscStrncpy(convname,prefix[i],sizeof(convname));
4372:       PetscStrlcat(convname,newtype,sizeof(convname));
4373:       PetscStrcmp(convname,((PetscObject)mat)->type_name,&flg);
4374:       PetscInfo3(mat,"Check superclass %s %s -> %d\n",convname,((PetscObject)mat)->type_name,flg);
4375:       if (flg) {
4376:         if (reuse == MAT_INPLACE_MATRIX) {
4377:           PetscInfo(mat,"Early return\n");
4378:           return(0);
4379:         } else if (reuse == MAT_INITIAL_MATRIX && mat->ops->duplicate) {
4380:           PetscInfo(mat,"Calling MatDuplicate\n");
4381:           (*mat->ops->duplicate)(mat,MAT_COPY_VALUES,M);
4382:           return(0);
4383:         } else if (reuse == MAT_REUSE_MATRIX && mat->ops->copy) {
4384:           PetscInfo(mat,"Calling MatCopy\n");
4385:           MatCopy(mat,*M,SAME_NONZERO_PATTERN);
4386:           return(0);
4387:         }
4388:       }
4389:     }
4390:     /* 1) See if a specialized converter is known to the current matrix and the desired class */
4391:     for (i=0; i<3; i++) {
4392:       PetscStrncpy(convname,"MatConvert_",sizeof(convname));
4393:       PetscStrlcat(convname,((PetscObject)mat)->type_name,sizeof(convname));
4394:       PetscStrlcat(convname,"_",sizeof(convname));
4395:       PetscStrlcat(convname,prefix[i],sizeof(convname));
4396:       PetscStrlcat(convname,issame ? ((PetscObject)mat)->type_name : newtype,sizeof(convname));
4397:       PetscStrlcat(convname,"_C",sizeof(convname));
4398:       PetscObjectQueryFunction((PetscObject)mat,convname,&conv);
4399:       PetscInfo3(mat,"Check specialized (1) %s (%s) -> %d\n",convname,((PetscObject)mat)->type_name,!!conv);
4400:       if (conv) goto foundconv;
4401:     }

4403:     /* 2)  See if a specialized converter is known to the desired matrix class. */
4404:     MatCreate(PetscObjectComm((PetscObject)mat),&B);
4405:     MatSetSizes(B,mat->rmap->n,mat->cmap->n,mat->rmap->N,mat->cmap->N);
4406:     MatSetType(B,newtype);
4407:     for (i=0; i<3; i++) {
4408:       PetscStrncpy(convname,"MatConvert_",sizeof(convname));
4409:       PetscStrlcat(convname,((PetscObject)mat)->type_name,sizeof(convname));
4410:       PetscStrlcat(convname,"_",sizeof(convname));
4411:       PetscStrlcat(convname,prefix[i],sizeof(convname));
4412:       PetscStrlcat(convname,newtype,sizeof(convname));
4413:       PetscStrlcat(convname,"_C",sizeof(convname));
4414:       PetscObjectQueryFunction((PetscObject)B,convname,&conv);
4415:       PetscInfo3(mat,"Check specialized (2) %s (%s) -> %d\n",convname,((PetscObject)B)->type_name,!!conv);
4416:       if (conv) {
4417:         MatDestroy(&B);
4418:         goto foundconv;
4419:       }
4420:     }

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

4428:     /* 4) See if a good general converter is known for the current matrix */
4429:     if (mat->ops->convert) conv = mat->ops->convert;

4431:     PetscInfo2(mat,"Check general convert (%s) -> %d\n",((PetscObject)mat)->type_name,!!conv);
4432:     if (conv) goto foundconv;

4434:     /* 5) Use a really basic converter. */
4435:     PetscInfo(mat,"Using MatConvert_Basic\n");
4436:     conv = MatConvert_Basic;

4438: foundconv:
4439:     PetscLogEventBegin(MAT_Convert,mat,0,0,0);
4440:     (*conv)(mat,newtype,reuse,M);
4441:     if (mat->rmap->mapping && mat->cmap->mapping && !(*M)->rmap->mapping && !(*M)->cmap->mapping) {
4442:       /* the block sizes must be same if the mappings are copied over */
4443:       (*M)->rmap->bs = mat->rmap->bs;
4444:       (*M)->cmap->bs = mat->cmap->bs;
4445:       PetscObjectReference((PetscObject)mat->rmap->mapping);
4446:       PetscObjectReference((PetscObject)mat->cmap->mapping);
4447:       (*M)->rmap->mapping = mat->rmap->mapping;
4448:       (*M)->cmap->mapping = mat->cmap->mapping;
4449:     }
4450:     (*M)->stencil.dim = mat->stencil.dim;
4451:     (*M)->stencil.noc = mat->stencil.noc;
4452:     for (i=0; i<=mat->stencil.dim; i++) {
4453:       (*M)->stencil.dims[i]   = mat->stencil.dims[i];
4454:       (*M)->stencil.starts[i] = mat->stencil.starts[i];
4455:     }
4456:     PetscLogEventEnd(MAT_Convert,mat,0,0,0);
4457:   }
4458:   PetscObjectStateIncrease((PetscObject)*M);

4460:   /* Copy Mat options */
4461:   if (issymmetric) {
4462:     MatSetOption(*M,MAT_SYMMETRIC,PETSC_TRUE);
4463:   }
4464:   if (ishermitian) {
4465:     MatSetOption(*M,MAT_HERMITIAN,PETSC_TRUE);
4466:   }
4467:   return(0);
4468: }

4470: /*@C
4471:    MatFactorGetSolverType - Returns name of the package providing the factorization routines

4473:    Not Collective

4475:    Input Parameter:
4476: .  mat - the matrix, must be a factored matrix

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

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

4485:    Level: intermediate

4487: .seealso: MatCopy(), MatDuplicate(), MatGetFactorAvailable(), MatGetFactor()
4488: @*/
4489: PetscErrorCode MatFactorGetSolverType(Mat mat, MatSolverType *type)
4490: {
4491:   PetscErrorCode ierr, (*conv)(Mat,MatSolverType*);

4496:   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Only for factored matrix");
4497:   PetscObjectQueryFunction((PetscObject)mat,"MatFactorGetSolverType_C",&conv);
4498:   if (!conv) {
4499:     *type = MATSOLVERPETSC;
4500:   } else {
4501:     (*conv)(mat,type);
4502:   }
4503:   return(0);
4504: }

4506: typedef struct _MatSolverTypeForSpecifcType* MatSolverTypeForSpecifcType;
4507: struct _MatSolverTypeForSpecifcType {
4508:   MatType                        mtype;
4509:   PetscErrorCode                 (*createfactor[MAT_FACTOR_NUM_TYPES])(Mat,MatFactorType,Mat*);
4510:   MatSolverTypeForSpecifcType next;
4511: };

4513: typedef struct _MatSolverTypeHolder* MatSolverTypeHolder;
4514: struct _MatSolverTypeHolder {
4515:   char                        *name;
4516:   MatSolverTypeForSpecifcType handlers;
4517:   MatSolverTypeHolder         next;
4518: };

4520: static MatSolverTypeHolder MatSolverTypeHolders = NULL;

4522: /*@C
4523:    MatSolverTypeRegister - Registers a MatSolverType that works for a particular matrix type

4525:    Input Parameters:
4526: +    package - name of the package, for example petsc or superlu
4527: .    mtype - the matrix type that works with this package
4528: .    ftype - the type of factorization supported by the package
4529: -    createfactor - routine that will create the factored matrix ready to be used

4531:     Level: intermediate

4533: .seealso: MatCopy(), MatDuplicate(), MatGetFactorAvailable(), MatGetFactor()
4534: @*/
4535: PetscErrorCode MatSolverTypeRegister(MatSolverType package,MatType mtype,MatFactorType ftype,PetscErrorCode (*createfactor)(Mat,MatFactorType,Mat*))
4536: {
4537:   PetscErrorCode              ierr;
4538:   MatSolverTypeHolder         next = MatSolverTypeHolders,prev = NULL;
4539:   PetscBool                   flg;
4540:   MatSolverTypeForSpecifcType inext,iprev = NULL;

4543:   MatInitializePackage();
4544:   if (!next) {
4545:     PetscNew(&MatSolverTypeHolders);
4546:     PetscStrallocpy(package,&MatSolverTypeHolders->name);
4547:     PetscNew(&MatSolverTypeHolders->handlers);
4548:     PetscStrallocpy(mtype,(char **)&MatSolverTypeHolders->handlers->mtype);
4549:     MatSolverTypeHolders->handlers->createfactor[(int)ftype-1] = createfactor;
4550:     return(0);
4551:   }
4552:   while (next) {
4553:     PetscStrcasecmp(package,next->name,&flg);
4554:     if (flg) {
4555:       if (!next->handlers) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"MatSolverTypeHolder is missing handlers");
4556:       inext = next->handlers;
4557:       while (inext) {
4558:         PetscStrcasecmp(mtype,inext->mtype,&flg);
4559:         if (flg) {
4560:           inext->createfactor[(int)ftype-1] = createfactor;
4561:           return(0);
4562:         }
4563:         iprev = inext;
4564:         inext = inext->next;
4565:       }
4566:       PetscNew(&iprev->next);
4567:       PetscStrallocpy(mtype,(char **)&iprev->next->mtype);
4568:       iprev->next->createfactor[(int)ftype-1] = createfactor;
4569:       return(0);
4570:     }
4571:     prev = next;
4572:     next = next->next;
4573:   }
4574:   PetscNew(&prev->next);
4575:   PetscStrallocpy(package,&prev->next->name);
4576:   PetscNew(&prev->next->handlers);
4577:   PetscStrallocpy(mtype,(char **)&prev->next->handlers->mtype);
4578:   prev->next->handlers->createfactor[(int)ftype-1] = createfactor;
4579:   return(0);
4580: }

4582: /*@C
4583:    MatSolveTypeGet - Gets the function that creates the factor matrix if it exist

4585:    Input Parameters:
4586: +    type - name of the package, for example petsc or superlu
4587: .    ftype - the type of factorization supported by the type
4588: -    mtype - the matrix type that works with this type

4590:    Output Parameters:
4591: +   foundtype - PETSC_TRUE if the type was registered
4592: .   foundmtype - PETSC_TRUE if the type supports the requested mtype
4593: -   createfactor - routine that will create the factored matrix ready to be used or NULL if not found

4595:     Level: intermediate

4597: .seealso: MatCopy(), MatDuplicate(), MatGetFactorAvailable(), MatSolverTypeRegister(), MatGetFactor()
4598: @*/
4599: PetscErrorCode MatSolverTypeGet(MatSolverType type,MatType mtype,MatFactorType ftype,PetscBool *foundtype,PetscBool *foundmtype,PetscErrorCode (**createfactor)(Mat,MatFactorType,Mat*))
4600: {
4601:   PetscErrorCode              ierr;
4602:   MatSolverTypeHolder         next = MatSolverTypeHolders;
4603:   PetscBool                   flg;
4604:   MatSolverTypeForSpecifcType inext;

4607:   if (foundtype) *foundtype = PETSC_FALSE;
4608:   if (foundmtype)   *foundmtype   = PETSC_FALSE;
4609:   if (createfactor) *createfactor    = NULL;

4611:   if (type) {
4612:     while (next) {
4613:       PetscStrcasecmp(type,next->name,&flg);
4614:       if (flg) {
4615:         if (foundtype) *foundtype = PETSC_TRUE;
4616:         inext = next->handlers;
4617:         while (inext) {
4618:           PetscStrbeginswith(mtype,inext->mtype,&flg);
4619:           if (flg) {
4620:             if (foundmtype) *foundmtype = PETSC_TRUE;
4621:             if (createfactor)  *createfactor  = inext->createfactor[(int)ftype-1];
4622:             return(0);
4623:           }
4624:           inext = inext->next;
4625:         }
4626:       }
4627:       next = next->next;
4628:     }
4629:   } else {
4630:     while (next) {
4631:       inext = next->handlers;
4632:       while (inext) {
4633:         PetscStrcmp(mtype,inext->mtype,&flg);
4634:         if (flg && inext->createfactor[(int)ftype-1]) {
4635:           if (foundtype) *foundtype = PETSC_TRUE;
4636:           if (foundmtype)   *foundmtype   = PETSC_TRUE;
4637:           if (createfactor) *createfactor = inext->createfactor[(int)ftype-1];
4638:           return(0);
4639:         }
4640:         inext = inext->next;
4641:       }
4642:       next = next->next;
4643:     }
4644:     /* try with base classes inext->mtype */
4645:     next = MatSolverTypeHolders;
4646:     while (next) {
4647:       inext = next->handlers;
4648:       while (inext) {
4649:         PetscStrbeginswith(mtype,inext->mtype,&flg);
4650:         if (flg && inext->createfactor[(int)ftype-1]) {
4651:           if (foundtype) *foundtype = PETSC_TRUE;
4652:           if (foundmtype)   *foundmtype   = PETSC_TRUE;
4653:           if (createfactor) *createfactor = inext->createfactor[(int)ftype-1];
4654:           return(0);
4655:         }
4656:         inext = inext->next;
4657:       }
4658:       next = next->next;
4659:     }
4660:   }
4661:   return(0);
4662: }

4664: PetscErrorCode MatSolverTypeDestroy(void)
4665: {
4666:   PetscErrorCode              ierr;
4667:   MatSolverTypeHolder         next = MatSolverTypeHolders,prev;
4668:   MatSolverTypeForSpecifcType inext,iprev;

4671:   while (next) {
4672:     PetscFree(next->name);
4673:     inext = next->handlers;
4674:     while (inext) {
4675:       PetscFree(inext->mtype);
4676:       iprev = inext;
4677:       inext = inext->next;
4678:       PetscFree(iprev);
4679:     }
4680:     prev = next;
4681:     next = next->next;
4682:     PetscFree(prev);
4683:   }
4684:   MatSolverTypeHolders = NULL;
4685:   return(0);
4686: }

4688: /*@C
4689:    MatFactorGetUseOrdering - Indicates if the factorization uses the ordering provided in MatLUFactorSymbolic(), MatCholeskyFactorSymbolic()

4691:    Logically Collective on Mat

4693:    Input Parameters:
4694: .  mat - the matrix

4696:    Output Parameters:
4697: .  flg - PETSC_TRUE if uses the ordering

4699:    Notes:
4700:       Most internal PETSc factorizations use the ordering past to the factorization routine but external
4701:       packages do no, thus we want to skip the ordering when it is not needed.

4703:    Level: developer

4705: .seealso: MatCopy(), MatDuplicate(), MatGetFactorAvailable(), MatGetFactor(), MatLUFactorSymbolic(), MatCholeskyFactorSymbolic()
4706: @*/
4707: PetscErrorCode MatFactorGetUseOrdering(Mat mat, PetscBool *flg)
4708: {
4710:   *flg = mat->useordering;
4711:   return(0);
4712: }

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

4717:    Collective on Mat

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

4724:    Output Parameters:
4725: .  f - the factor matrix used with MatXXFactorSymbolic() calls

4727:    Notes:
4728:       Some PETSc matrix formats have alternative solvers available that are contained in alternative packages
4729:      such as pastix, superlu, mumps etc.

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

4733:    Developer Notes:
4734:       This should actually be called MatCreateFactor() since it creates a new factor object

4736:    Level: intermediate

4738: .seealso: MatCopy(), MatDuplicate(), MatGetFactorAvailable(), MatFactorGetUseOrdering(), MatSolverTypeRegister()
4739: @*/
4740: PetscErrorCode MatGetFactor(Mat mat, MatSolverType type,MatFactorType ftype,Mat *f)
4741: {
4742:   PetscErrorCode ierr,(*conv)(Mat,MatFactorType,Mat*);
4743:   PetscBool      foundtype,foundmtype;


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

4752:   MatSolverTypeGet(type,((PetscObject)mat)->type_name,ftype,&foundtype,&foundmtype,&conv);
4753:   if (!foundtype) {
4754:     if (type) {
4755:       SETERRQ4(PetscObjectComm((PetscObject)mat),PETSC_ERR_MISSING_FACTOR,"Could not locate solver type %s for factorization type %s and matrix type %s. Perhaps you must ./configure with --download-%s",type,MatFactorTypes[ftype],((PetscObject)mat)->type_name,type);
4756:     } else {
4757:       SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_MISSING_FACTOR,"Could not locate a solver type for factorization type %s and matrix type %s.",MatFactorTypes[ftype],((PetscObject)mat)->type_name);
4758:     }
4759:   }
4760:   if (!foundmtype) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_MISSING_FACTOR,"MatSolverType %s does not support matrix type %s",type,((PetscObject)mat)->type_name);
4761:   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);

4763:   (*conv)(mat,ftype,f);
4764:   return(0);
4765: }

4767: /*@C
4768:    MatGetFactorAvailable - Returns a a flag if matrix supports particular type and factor type

4770:    Not Collective

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

4777:    Output Parameter:
4778: .    flg - PETSC_TRUE if the factorization is available

4780:    Notes:
4781:       Some PETSc matrix formats have alternative solvers available that are contained in alternative packages
4782:      such as pastix, superlu, mumps etc.

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

4786:    Developer Notes:
4787:       This should actually be called MatCreateFactorAvailable() since MatGetFactor() creates a new factor object

4789:    Level: intermediate

4791: .seealso: MatCopy(), MatDuplicate(), MatGetFactor(), MatSolverTypeRegister()
4792: @*/
4793: PetscErrorCode MatGetFactorAvailable(Mat mat, MatSolverType type,MatFactorType ftype,PetscBool  *flg)
4794: {
4795:   PetscErrorCode ierr, (*gconv)(Mat,MatFactorType,Mat*);


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

4804:   *flg = PETSC_FALSE;
4805:   MatSolverTypeGet(type,((PetscObject)mat)->type_name,ftype,NULL,NULL,&gconv);
4806:   if (gconv) {
4807:     *flg = PETSC_TRUE;
4808:   }
4809:   return(0);
4810: }

4812: #include <petscdmtypes.h>

4814: /*@
4815:    MatDuplicate - Duplicates a matrix including the non-zero structure.

4817:    Collective on Mat

4819:    Input Parameters:
4820: +  mat - the matrix
4821: -  op - One of MAT_DO_NOT_COPY_VALUES, MAT_COPY_VALUES, or MAT_SHARE_NONZERO_PATTERN.
4822:         See the manual page for MatDuplicateOption for an explanation of these options.

4824:    Output Parameter:
4825: .  M - pointer to place new matrix

4827:    Level: intermediate

4829:    Notes:
4830:     You cannot change the nonzero pattern for the parent or child matrix if you use MAT_SHARE_NONZERO_PATTERN.
4831:     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.

4833: .seealso: MatCopy(), MatConvert(), MatDuplicateOption
4834: @*/
4835: PetscErrorCode MatDuplicate(Mat mat,MatDuplicateOption op,Mat *M)
4836: {
4838:   Mat            B;
4839:   PetscInt       i;
4840:   DM             dm;
4841:   void           (*viewf)(void);

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

4851:   *M = NULL;
4852:   if (!mat->ops->duplicate) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Not written for matrix type %s\n",((PetscObject)mat)->type_name);
4853:   PetscLogEventBegin(MAT_Convert,mat,0,0,0);
4854:   (*mat->ops->duplicate)(mat,op,M);
4855:   B    = *M;

4857:   MatGetOperation(mat,MATOP_VIEW,&viewf);
4858:   if (viewf) {
4859:     MatSetOperation(B,MATOP_VIEW,viewf);
4860:   }

4862:   B->stencil.dim = mat->stencil.dim;
4863:   B->stencil.noc = mat->stencil.noc;
4864:   for (i=0; i<=mat->stencil.dim; i++) {
4865:     B->stencil.dims[i]   = mat->stencil.dims[i];
4866:     B->stencil.starts[i] = mat->stencil.starts[i];
4867:   }

4869:   B->nooffproczerorows = mat->nooffproczerorows;
4870:   B->nooffprocentries  = mat->nooffprocentries;

4872:   PetscObjectQuery((PetscObject) mat, "__PETSc_dm", (PetscObject*) &dm);
4873:   if (dm) {
4874:     PetscObjectCompose((PetscObject) B, "__PETSc_dm", (PetscObject) dm);
4875:   }
4876:   PetscLogEventEnd(MAT_Convert,mat,0,0,0);
4877:   PetscObjectStateIncrease((PetscObject)B);
4878:   return(0);
4879: }

4881: /*@
4882:    MatGetDiagonal - Gets the diagonal of a matrix.

4884:    Logically Collective on Mat

4886:    Input Parameters:
4887: +  mat - the matrix
4888: -  v - the vector for storing the diagonal

4890:    Output Parameter:
4891: .  v - the diagonal of the matrix

4893:    Level: intermediate

4895:    Note:
4896:    Currently only correct in parallel for square matrices.

4898: .seealso: MatGetRow(), MatCreateSubMatrices(), MatCreateSubMatrix(), MatGetRowMaxAbs()
4899: @*/
4900: PetscErrorCode MatGetDiagonal(Mat mat,Vec v)
4901: {

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

4912:   (*mat->ops->getdiagonal)(mat,v);
4913:   PetscObjectStateIncrease((PetscObject)v);
4914:   return(0);
4915: }

4917: /*@C
4918:    MatGetRowMin - Gets the minimum value (of the real part) of each
4919:         row of the matrix

4921:    Logically Collective on Mat

4923:    Input Parameters:
4924: .  mat - the matrix

4926:    Output Parameter:
4927: +  v - the vector for storing the maximums
4928: -  idx - the indices of the column found for each row (optional)

4930:    Level: intermediate

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

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

4938: .seealso: MatGetDiagonal(), MatCreateSubMatrices(), MatCreateSubMatrix(), MatGetRowMaxAbs(),
4939:           MatGetRowMax()
4940: @*/
4941: PetscErrorCode MatGetRowMin(Mat mat,Vec v,PetscInt idx[])
4942: {

4949:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");

4951:   if (!mat->cmap->N) {
4952:     VecSet(v,PETSC_MAX_REAL);
4953:     if (idx) {
4954:       PetscInt i,m = mat->rmap->n;
4955:       for (i=0; i<m; i++) idx[i] = -1;
4956:     }
4957:   } else {
4958:     if (!mat->ops->getrowmin) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4959:     MatCheckPreallocated(mat,1);
4960:   }
4961:   (*mat->ops->getrowmin)(mat,v,idx);
4962:   PetscObjectStateIncrease((PetscObject)v);
4963:   return(0);
4964: }

4966: /*@C
4967:    MatGetRowMinAbs - Gets the minimum value (in absolute value) of each
4968:         row of the matrix

4970:    Logically Collective on Mat

4972:    Input Parameters:
4973: .  mat - the matrix

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

4979:    Level: intermediate

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

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

4987: .seealso: MatGetDiagonal(), MatCreateSubMatrices(), MatCreateSubMatrix(), MatGetRowMax(), MatGetRowMaxAbs(), MatGetRowMin()
4988: @*/
4989: PetscErrorCode MatGetRowMinAbs(Mat mat,Vec v,PetscInt idx[])
4990: {

4997:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4998:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");

5000:   if (!mat->cmap->N) {
5001:     VecSet(v,0.0);
5002:     if (idx) {
5003:       PetscInt i,m = mat->rmap->n;
5004:       for (i=0; i<m; i++) idx[i] = -1;
5005:     }
5006:   } else {
5007:     if (!mat->ops->getrowminabs) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5008:     MatCheckPreallocated(mat,1);
5009:     if (idx) {PetscArrayzero(idx,mat->rmap->n);}
5010:     (*mat->ops->getrowminabs)(mat,v,idx);
5011:   }
5012:   PetscObjectStateIncrease((PetscObject)v);
5013:   return(0);
5014: }

5016: /*@C
5017:    MatGetRowMax - Gets the maximum value (of the real part) of each
5018:         row of the matrix

5020:    Logically Collective on Mat

5022:    Input Parameters:
5023: .  mat - the matrix

5025:    Output Parameter:
5026: +  v - the vector for storing the maximums
5027: -  idx - the indices of the column found for each row (optional)

5029:    Level: intermediate

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

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

5037: .seealso: MatGetDiagonal(), MatCreateSubMatrices(), MatCreateSubMatrix(), MatGetRowMaxAbs(), MatGetRowMin()
5038: @*/
5039: PetscErrorCode MatGetRowMax(Mat mat,Vec v,PetscInt idx[])
5040: {

5047:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");

5049:   if (!mat->cmap->N) {
5050:     VecSet(v,PETSC_MIN_REAL);
5051:     if (idx) {
5052:       PetscInt i,m = mat->rmap->n;
5053:       for (i=0; i<m; i++) idx[i] = -1;
5054:     }
5055:   } else {
5056:     if (!mat->ops->getrowmax) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5057:     MatCheckPreallocated(mat,1);
5058:     (*mat->ops->getrowmax)(mat,v,idx);
5059:   }
5060:   PetscObjectStateIncrease((PetscObject)v);
5061:   return(0);
5062: }

5064: /*@C
5065:    MatGetRowMaxAbs - Gets the maximum value (in absolute value) of each
5066:         row of the matrix

5068:    Logically Collective on Mat

5070:    Input Parameters:
5071: .  mat - the matrix

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

5077:    Level: intermediate

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

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

5085: .seealso: MatGetDiagonal(), MatCreateSubMatrices(), MatCreateSubMatrix(), MatGetRowMax(), MatGetRowMin()
5086: @*/
5087: PetscErrorCode MatGetRowMaxAbs(Mat mat,Vec v,PetscInt idx[])
5088: {

5095:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");

5097:   if (!mat->cmap->N) {
5098:     VecSet(v,0.0);
5099:     if (idx) {
5100:       PetscInt i,m = mat->rmap->n;
5101:       for (i=0; i<m; i++) idx[i] = -1;
5102:     }
5103:   } else {
5104:     if (!mat->ops->getrowmaxabs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5105:     MatCheckPreallocated(mat,1);
5106:     if (idx) {PetscArrayzero(idx,mat->rmap->n);}
5107:     (*mat->ops->getrowmaxabs)(mat,v,idx);
5108:   }
5109:   PetscObjectStateIncrease((PetscObject)v);
5110:   return(0);
5111: }

5113: /*@
5114:    MatGetRowSum - Gets the sum of each row of the matrix

5116:    Logically or Neighborhood Collective on Mat

5118:    Input Parameters:
5119: .  mat - the matrix

5121:    Output Parameter:
5122: .  v - the vector for storing the sum of rows

5124:    Level: intermediate

5126:    Notes:
5127:     This code is slow since it is not currently specialized for different formats

5129: .seealso: MatGetDiagonal(), MatCreateSubMatrices(), MatCreateSubMatrix(), MatGetRowMax(), MatGetRowMin()
5130: @*/
5131: PetscErrorCode MatGetRowSum(Mat mat, Vec v)
5132: {
5133:   Vec            ones;

5140:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5141:   MatCheckPreallocated(mat,1);
5142:   MatCreateVecs(mat,&ones,NULL);
5143:   VecSet(ones,1.);
5144:   MatMult(mat,ones,v);
5145:   VecDestroy(&ones);
5146:   return(0);
5147: }

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

5152:    Collective on Mat

5154:    Input Parameters:
5155: +  mat - the matrix to transpose
5156: -  reuse - either MAT_INITIAL_MATRIX, MAT_REUSE_MATRIX, or MAT_INPLACE_MATRIX

5158:    Output Parameter:
5159: .  B - the transpose

5161:    Notes:
5162:      If you use MAT_INPLACE_MATRIX then you must pass in &mat for B

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

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

5168:    Level: intermediate

5170: .seealso: MatMultTranspose(), MatMultTransposeAdd(), MatIsTranspose(), MatReuse
5171: @*/
5172: PetscErrorCode MatTranspose(Mat mat,MatReuse reuse,Mat *B)
5173: {

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

5186:   PetscLogEventBegin(MAT_Transpose,mat,0,0,0);
5187:   (*mat->ops->transpose)(mat,reuse,B);
5188:   PetscLogEventEnd(MAT_Transpose,mat,0,0,0);
5189:   if (B) {PetscObjectStateIncrease((PetscObject)*B);}
5190:   return(0);
5191: }

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

5197:    Collective on Mat

5199:    Input Parameter:
5200: +  A - the matrix to test
5201: -  B - the matrix to test against, this can equal the first parameter

5203:    Output Parameters:
5204: .  flg - the result

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

5211:    Level: intermediate

5213: .seealso: MatTranspose(), MatIsSymmetric(), MatIsHermitian()
5214: @*/
5215: PetscErrorCode MatIsTranspose(Mat A,Mat B,PetscReal tol,PetscBool  *flg)
5216: {
5217:   PetscErrorCode ierr,(*f)(Mat,Mat,PetscReal,PetscBool*),(*g)(Mat,Mat,PetscReal,PetscBool*);

5223:   PetscObjectQueryFunction((PetscObject)A,"MatIsTranspose_C",&f);
5224:   PetscObjectQueryFunction((PetscObject)B,"MatIsTranspose_C",&g);
5225:   *flg = PETSC_FALSE;
5226:   if (f && g) {
5227:     if (f == g) {
5228:       (*f)(A,B,tol,flg);
5229:     } else SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_NOTSAMETYPE,"Matrices do not have the same comparator for symmetry test");
5230:   } else {
5231:     MatType mattype;
5232:     if (!f) {
5233:       MatGetType(A,&mattype);
5234:     } else {
5235:       MatGetType(B,&mattype);
5236:     }
5237:     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Matrix of type %s does not support checking for transpose",mattype);
5238:   }
5239:   return(0);
5240: }

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

5245:    Collective on Mat

5247:    Input Parameters:
5248: +  mat - the matrix to transpose and complex conjugate
5249: -  reuse - either MAT_INITIAL_MATRIX, MAT_REUSE_MATRIX, or MAT_INPLACE_MATRIX

5251:    Output Parameter:
5252: .  B - the Hermitian

5254:    Level: intermediate

5256: .seealso: MatTranspose(), MatMultTranspose(), MatMultTransposeAdd(), MatIsTranspose(), MatReuse
5257: @*/
5258: PetscErrorCode MatHermitianTranspose(Mat mat,MatReuse reuse,Mat *B)
5259: {

5263:   MatTranspose(mat,reuse,B);
5264: #if defined(PETSC_USE_COMPLEX)
5265:   MatConjugate(*B);
5266: #endif
5267:   return(0);
5268: }

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

5273:    Collective on Mat

5275:    Input Parameter:
5276: +  A - the matrix to test
5277: -  B - the matrix to test against, this can equal the first parameter

5279:    Output Parameters:
5280: .  flg - the result

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

5287:    Level: intermediate

5289: .seealso: MatTranspose(), MatIsSymmetric(), MatIsHermitian(), MatIsTranspose()
5290: @*/
5291: PetscErrorCode MatIsHermitianTranspose(Mat A,Mat B,PetscReal tol,PetscBool  *flg)
5292: {
5293:   PetscErrorCode ierr,(*f)(Mat,Mat,PetscReal,PetscBool*),(*g)(Mat,Mat,PetscReal,PetscBool*);

5299:   PetscObjectQueryFunction((PetscObject)A,"MatIsHermitianTranspose_C",&f);
5300:   PetscObjectQueryFunction((PetscObject)B,"MatIsHermitianTranspose_C",&g);
5301:   if (f && g) {
5302:     if (f==g) {
5303:       (*f)(A,B,tol,flg);
5304:     } else SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_NOTSAMETYPE,"Matrices do not have the same comparator for Hermitian test");
5305:   }
5306:   return(0);
5307: }

5309: /*@
5310:    MatPermute - Creates a new matrix with rows and columns permuted from the
5311:    original.

5313:    Collective on Mat

5315:    Input Parameters:
5316: +  mat - the matrix to permute
5317: .  row - row permutation, each processor supplies only the permutation for its rows
5318: -  col - column permutation, each processor supplies only the permutation for its columns

5320:    Output Parameters:
5321: .  B - the permuted matrix

5323:    Level: advanced

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

5329:    Developer Note:
5330:      If you want to implement MatPermute for a matrix type, and your approach doesn't
5331:      exploit the fact that row and col are permutations, consider implementing the
5332:      more general MatCreateSubMatrix() instead.

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

5336: @*/
5337: PetscErrorCode MatPermute(Mat mat,IS row,IS col,Mat *B)
5338: {

5349:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5350:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5351:   if (!mat->ops->permute && !mat->ops->createsubmatrix) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"MatPermute not available for Mat type %s",((PetscObject)mat)->type_name);
5352:   MatCheckPreallocated(mat,1);

5354:   if (mat->ops->permute) {
5355:     (*mat->ops->permute)(mat,row,col,B);
5356:     PetscObjectStateIncrease((PetscObject)*B);
5357:   } else {
5358:     MatCreateSubMatrix(mat, row, col, MAT_INITIAL_MATRIX, B);
5359:   }
5360:   return(0);
5361: }

5363: /*@
5364:    MatEqual - Compares two matrices.

5366:    Collective on Mat

5368:    Input Parameters:
5369: +  A - the first matrix
5370: -  B - the second matrix

5372:    Output Parameter:
5373: .  flg - PETSC_TRUE if the matrices are equal; PETSC_FALSE otherwise.

5375:    Level: intermediate

5377: @*/
5378: PetscErrorCode MatEqual(Mat A,Mat B,PetscBool  *flg)
5379: {

5389:   MatCheckPreallocated(B,2);
5390:   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5391:   if (!B->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5392:   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);
5393:   if (!A->ops->equal) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Mat type %s",((PetscObject)A)->type_name);
5394:   if (!B->ops->equal) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Mat type %s",((PetscObject)B)->type_name);
5395:   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);
5396:   MatCheckPreallocated(A,1);

5398:   (*A->ops->equal)(A,B,flg);
5399:   return(0);
5400: }

5402: /*@
5403:    MatDiagonalScale - Scales a matrix on the left and right by diagonal
5404:    matrices that are stored as vectors.  Either of the two scaling
5405:    matrices can be NULL.

5407:    Collective on Mat

5409:    Input Parameters:
5410: +  mat - the matrix to be scaled
5411: .  l - the left scaling vector (or NULL)
5412: -  r - the right scaling vector (or NULL)

5414:    Notes:
5415:    MatDiagonalScale() computes A = LAR, where
5416:    L = a diagonal matrix (stored as a vector), R = a diagonal matrix (stored as a vector)
5417:    The L scales the rows of the matrix, the R scales the columns of the matrix.

5419:    Level: intermediate


5422: .seealso: MatScale(), MatShift(), MatDiagonalSet()
5423: @*/
5424: PetscErrorCode MatDiagonalScale(Mat mat,Vec l,Vec r)
5425: {

5433:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5434:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5435:   MatCheckPreallocated(mat,1);
5436:   if (!l && !r) return(0);

5438:   if (!mat->ops->diagonalscale) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5439:   PetscLogEventBegin(MAT_Scale,mat,0,0,0);
5440:   (*mat->ops->diagonalscale)(mat,l,r);
5441:   PetscLogEventEnd(MAT_Scale,mat,0,0,0);
5442:   PetscObjectStateIncrease((PetscObject)mat);
5443:   return(0);
5444: }

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

5449:     Logically Collective on Mat

5451:     Input Parameters:
5452: +   mat - the matrix to be scaled
5453: -   a  - the scaling value

5455:     Output Parameter:
5456: .   mat - the scaled matrix

5458:     Level: intermediate

5460: .seealso: MatDiagonalScale()
5461: @*/
5462: PetscErrorCode MatScale(Mat mat,PetscScalar a)
5463: {

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

5475:   PetscLogEventBegin(MAT_Scale,mat,0,0,0);
5476:   if (a != (PetscScalar)1.0) {
5477:     (*mat->ops->scale)(mat,a);
5478:     PetscObjectStateIncrease((PetscObject)mat);
5479:   }
5480:   PetscLogEventEnd(MAT_Scale,mat,0,0,0);
5481:   return(0);
5482: }

5484: /*@
5485:    MatNorm - Calculates various norms of a matrix.

5487:    Collective on Mat

5489:    Input Parameters:
5490: +  mat - the matrix
5491: -  type - the type of norm, NORM_1, NORM_FROBENIUS, NORM_INFINITY

5493:    Output Parameters:
5494: .  nrm - the resulting norm

5496:    Level: intermediate

5498: @*/
5499: PetscErrorCode MatNorm(Mat mat,NormType type,PetscReal *nrm)
5500: {


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

5513:   (*mat->ops->norm)(mat,type,nrm);
5514:   return(0);
5515: }

5517: /*
5518:      This variable is used to prevent counting of MatAssemblyBegin() that
5519:    are called from within a MatAssemblyEnd().
5520: */
5521: static PetscInt MatAssemblyEnd_InUse = 0;
5522: /*@
5523:    MatAssemblyBegin - Begins assembling the matrix.  This routine should
5524:    be called after completing all calls to MatSetValues().

5526:    Collective on Mat

5528:    Input Parameters:
5529: +  mat - the matrix
5530: -  type - type of assembly, either MAT_FLUSH_ASSEMBLY or MAT_FINAL_ASSEMBLY

5532:    Notes:
5533:    MatSetValues() generally caches the values.  The matrix is ready to
5534:    use only after MatAssemblyBegin() and MatAssemblyEnd() have been called.
5535:    Use MAT_FLUSH_ASSEMBLY when switching between ADD_VALUES and INSERT_VALUES
5536:    in MatSetValues(); use MAT_FINAL_ASSEMBLY for the final assembly before
5537:    using the matrix.

5539:    ALL processes that share a matrix MUST call MatAssemblyBegin() and MatAssemblyEnd() the SAME NUMBER of times, and each time with the
5540:    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
5541:    a global collective operation requring all processes that share the matrix.

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

5547:    Level: beginner

5549: .seealso: MatAssemblyEnd(), MatSetValues(), MatAssembled()
5550: @*/
5551: PetscErrorCode MatAssemblyBegin(Mat mat,MatAssemblyType type)
5552: {

5558:   MatCheckPreallocated(mat,1);
5559:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix.\nDid you forget to call MatSetUnfactored()?");
5560:   if (mat->assembled) {
5561:     mat->was_assembled = PETSC_TRUE;
5562:     mat->assembled     = PETSC_FALSE;
5563:   }

5565:   if (!MatAssemblyEnd_InUse) {
5566:     PetscLogEventBegin(MAT_AssemblyBegin,mat,0,0,0);
5567:     if (mat->ops->assemblybegin) {(*mat->ops->assemblybegin)(mat,type);}
5568:     PetscLogEventEnd(MAT_AssemblyBegin,mat,0,0,0);
5569:   } else if (mat->ops->assemblybegin) {
5570:     (*mat->ops->assemblybegin)(mat,type);
5571:   }
5572:   return(0);
5573: }

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

5579:    Not Collective

5581:    Input Parameter:
5582: .  mat - the matrix

5584:    Output Parameter:
5585: .  assembled - PETSC_TRUE or PETSC_FALSE

5587:    Level: advanced

5589: .seealso: MatAssemblyEnd(), MatSetValues(), MatAssemblyBegin()
5590: @*/
5591: PetscErrorCode MatAssembled(Mat mat,PetscBool  *assembled)
5592: {
5596:   *assembled = mat->assembled;
5597:   return(0);
5598: }

5600: /*@
5601:    MatAssemblyEnd - Completes assembling the matrix.  This routine should
5602:    be called after MatAssemblyBegin().

5604:    Collective on Mat

5606:    Input Parameters:
5607: +  mat - the matrix
5608: -  type - type of assembly, either MAT_FLUSH_ASSEMBLY or MAT_FINAL_ASSEMBLY

5610:    Options Database Keys:
5611: +  -mat_view ::ascii_info - Prints info on matrix at conclusion of MatEndAssembly()
5612: .  -mat_view ::ascii_info_detail - Prints more detailed info
5613: .  -mat_view - Prints matrix in ASCII format
5614: .  -mat_view ::ascii_matlab - Prints matrix in Matlab format
5615: .  -mat_view draw - PetscDraws nonzero structure of matrix, using MatView() and PetscDrawOpenX().
5616: .  -display <name> - Sets display name (default is host)
5617: .  -draw_pause <sec> - Sets number of seconds to pause after display
5618: .  -mat_view socket - Sends matrix to socket, can be accessed from Matlab (See Users-Manual: ch_matlab)
5619: .  -viewer_socket_machine <machine> - Machine to use for socket
5620: .  -viewer_socket_port <port> - Port number to use for socket
5621: -  -mat_view binary:filename[:append] - Save matrix to file in binary format

5623:    Notes:
5624:    MatSetValues() generally caches the values.  The matrix is ready to
5625:    use only after MatAssemblyBegin() and MatAssemblyEnd() have been called.
5626:    Use MAT_FLUSH_ASSEMBLY when switching between ADD_VALUES and INSERT_VALUES
5627:    in MatSetValues(); use MAT_FINAL_ASSEMBLY for the final assembly before
5628:    using the matrix.

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

5634:    Level: beginner

5636: .seealso: MatAssemblyBegin(), MatSetValues(), PetscDrawOpenX(), PetscDrawCreate(), MatView(), MatAssembled(), PetscViewerSocketOpen()
5637: @*/
5638: PetscErrorCode MatAssemblyEnd(Mat mat,MatAssemblyType type)
5639: {
5640:   PetscErrorCode  ierr;
5641:   static PetscInt inassm = 0;
5642:   PetscBool       flg    = PETSC_FALSE;


5648:   inassm++;
5649:   MatAssemblyEnd_InUse++;
5650:   if (MatAssemblyEnd_InUse == 1) { /* Do the logging only the first time through */
5651:     PetscLogEventBegin(MAT_AssemblyEnd,mat,0,0,0);
5652:     if (mat->ops->assemblyend) {
5653:       (*mat->ops->assemblyend)(mat,type);
5654:     }
5655:     PetscLogEventEnd(MAT_AssemblyEnd,mat,0,0,0);
5656:   } else if (mat->ops->assemblyend) {
5657:     (*mat->ops->assemblyend)(mat,type);
5658:   }

5660:   /* Flush assembly is not a true assembly */
5661:   if (type != MAT_FLUSH_ASSEMBLY) {
5662:     mat->num_ass++;
5663:     mat->assembled        = PETSC_TRUE;
5664:     mat->ass_nonzerostate = mat->nonzerostate;
5665:   }

5667:   mat->insertmode = NOT_SET_VALUES;
5668:   MatAssemblyEnd_InUse--;
5669:   PetscObjectStateIncrease((PetscObject)mat);
5670:   if (!mat->symmetric_eternal) {
5671:     mat->symmetric_set              = PETSC_FALSE;
5672:     mat->hermitian_set              = PETSC_FALSE;
5673:     mat->structurally_symmetric_set = PETSC_FALSE;
5674:   }
5675:   if (inassm == 1 && type != MAT_FLUSH_ASSEMBLY) {
5676:     MatViewFromOptions(mat,NULL,"-mat_view");

5678:     if (mat->checksymmetryonassembly) {
5679:       MatIsSymmetric(mat,mat->checksymmetrytol,&flg);
5680:       if (flg) {
5681:         PetscPrintf(PetscObjectComm((PetscObject)mat),"Matrix is symmetric (tolerance %g)\n",(double)mat->checksymmetrytol);
5682:       } else {
5683:         PetscPrintf(PetscObjectComm((PetscObject)mat),"Matrix is not symmetric (tolerance %g)\n",(double)mat->checksymmetrytol);
5684:       }
5685:     }
5686:     if (mat->nullsp && mat->checknullspaceonassembly) {
5687:       MatNullSpaceTest(mat->nullsp,mat,NULL);
5688:     }
5689:   }
5690:   inassm--;
5691:   return(0);
5692: }

5694: /*@
5695:    MatSetOption - Sets a parameter option for a matrix. Some options
5696:    may be specific to certain storage formats.  Some options
5697:    determine how values will be inserted (or added). Sorted,
5698:    row-oriented input will generally assemble the fastest. The default
5699:    is row-oriented.

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

5703:    Input Parameters:
5704: +  mat - the matrix
5705: .  option - the option, one of those listed below (and possibly others),
5706: -  flg - turn the option on (PETSC_TRUE) or off (PETSC_FALSE)

5708:   Options Describing Matrix Structure:
5709: +    MAT_SPD - symmetric positive definite
5710: .    MAT_SYMMETRIC - symmetric in terms of both structure and value
5711: .    MAT_HERMITIAN - transpose is the complex conjugation
5712: .    MAT_STRUCTURALLY_SYMMETRIC - symmetric nonzero structure
5713: -    MAT_SYMMETRY_ETERNAL - if you would like the symmetry/Hermitian flag
5714:                             you set to be kept with all future use of the matrix
5715:                             including after MatAssemblyBegin/End() which could
5716:                             potentially change the symmetry structure, i.e. you
5717:                             KNOW the matrix will ALWAYS have the property you set.
5718:                             Note that setting this flag alone implies nothing about whether the matrix is symmetric/Hermitian;
5719:                             the relevant flags must be set independently.


5722:    Options For Use with MatSetValues():
5723:    Insert a logically dense subblock, which can be
5724: .    MAT_ROW_ORIENTED - row-oriented (default)

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

5730:    When (re)assembling a matrix, we can restrict the input for
5731:    efficiency/debugging purposes.  These options include:
5732: +    MAT_NEW_NONZERO_LOCATIONS - additional insertions will be allowed if they generate a new nonzero (slow)
5733: .    MAT_FORCE_DIAGONAL_ENTRIES - forces diagonal entries to be allocated
5734: .    MAT_IGNORE_OFF_PROC_ENTRIES - drops off-processor entries
5735: .    MAT_NEW_NONZERO_LOCATION_ERR - generates an error for new matrix entry
5736: .    MAT_USE_HASH_TABLE - uses a hash table to speed up matrix assembly
5737: .    MAT_NO_OFF_PROC_ENTRIES - you know each process will only set values for its own rows, will generate an error if
5738:         any process sets values for another process. This avoids all reductions in the MatAssembly routines and thus improves
5739:         performance for very large process counts.
5740: -    MAT_SUBSET_OFF_PROC_ENTRIES - you know that the first assembly after setting this flag will set a superset
5741:         of the off-process entries required for all subsequent assemblies. This avoids a rendezvous step in the MatAssembly
5742:         functions, instead sending only neighbor messages.

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

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

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

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

5762:    MAT_NEW_NONZERO_LOCATION_ERR set to PETSC_TRUE indicates that any add or insertion
5763:    that would generate a new entry in the nonzero structure instead produces
5764:    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

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

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

5778:    MAT_USE_HASH_TABLE indicates that a hash table be used to improve the
5779:    searches during matrix assembly. When this flag is set, the hash table
5780:    is created during the first Matrix Assembly. This hash table is
5781:    used the next time through, during MatSetVaules()/MatSetVaulesBlocked()
5782:    to improve the searching of indices. MAT_NEW_NONZERO_LOCATIONS flag
5783:    should be used with MAT_USE_HASH_TABLE flag. This option is currently
5784:    supported by MATMPIBAIJ format only.

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

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

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

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

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

5800:    MAT_SORTED_FULL - each process provides exactly its local rows; all column indices for a given row are passed in a
5801:                      single call to MatSetValues(), preallocation is perfect, row oriented, INSERT_VALUES is used. Common
5802:                      with finite difference schemes with non-periodic boundary conditions.

5804:    Level: intermediate

5806: .seealso:  MatOption, Mat

5808: @*/
5809: PetscErrorCode MatSetOption(Mat mat,MatOption op,PetscBool flg)
5810: {

5815:   if (op > 0) {
5818:   }

5820:   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);

5822:   switch (op) {
5823:   case MAT_FORCE_DIAGONAL_ENTRIES:
5824:     mat->force_diagonals = flg;
5825:     return(0);
5826:   case MAT_NO_OFF_PROC_ENTRIES:
5827:     mat->nooffprocentries = flg;
5828:     return(0);
5829:   case MAT_SUBSET_OFF_PROC_ENTRIES:
5830:     mat->assembly_subset = flg;
5831:     if (!mat->assembly_subset) { /* See the same logic in VecAssembly wrt VEC_SUBSET_OFF_PROC_ENTRIES */
5832: #if !defined(PETSC_HAVE_MPIUNI)
5833:       MatStashScatterDestroy_BTS(&mat->stash);
5834: #endif
5835:       mat->stash.first_assembly_done = PETSC_FALSE;
5836:     }
5837:     return(0);
5838:   case MAT_NO_OFF_PROC_ZERO_ROWS:
5839:     mat->nooffproczerorows = flg;
5840:     return(0);
5841:   case MAT_SPD:
5842:     mat->spd_set = PETSC_TRUE;
5843:     mat->spd     = flg;
5844:     if (flg) {
5845:       mat->symmetric                  = PETSC_TRUE;
5846:       mat->structurally_symmetric     = PETSC_TRUE;
5847:       mat->symmetric_set              = PETSC_TRUE;
5848:       mat->structurally_symmetric_set = PETSC_TRUE;
5849:     }
5850:     break;
5851:   case MAT_SYMMETRIC:
5852:     mat->symmetric = flg;
5853:     if (flg) mat->structurally_symmetric = PETSC_TRUE;
5854:     mat->symmetric_set              = PETSC_TRUE;
5855:     mat->structurally_symmetric_set = flg;
5856: #if !defined(PETSC_USE_COMPLEX)
5857:     mat->hermitian     = flg;
5858:     mat->hermitian_set = PETSC_TRUE;
5859: #endif
5860:     break;
5861:   case MAT_HERMITIAN:
5862:     mat->hermitian = flg;
5863:     if (flg) mat->structurally_symmetric = PETSC_TRUE;
5864:     mat->hermitian_set              = PETSC_TRUE;
5865:     mat->structurally_symmetric_set = flg;
5866: #if !defined(PETSC_USE_COMPLEX)
5867:     mat->symmetric     = flg;
5868:     mat->symmetric_set = PETSC_TRUE;
5869: #endif
5870:     break;
5871:   case MAT_STRUCTURALLY_SYMMETRIC:
5872:     mat->structurally_symmetric     = flg;
5873:     mat->structurally_symmetric_set = PETSC_TRUE;
5874:     break;
5875:   case MAT_SYMMETRY_ETERNAL:
5876:     mat->symmetric_eternal = flg;
5877:     break;
5878:   case MAT_STRUCTURE_ONLY:
5879:     mat->structure_only = flg;
5880:     break;
5881:   case MAT_SORTED_FULL:
5882:     mat->sortedfull = flg;
5883:     break;
5884:   default:
5885:     break;
5886:   }
5887:   if (mat->ops->setoption) {
5888:     (*mat->ops->setoption)(mat,op,flg);
5889:   }
5890:   return(0);
5891: }

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

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

5898:    Input Parameters:
5899: +  mat - the matrix
5900: -  option - the option, this only responds to certain options, check the code for which ones

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

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

5908:    Level: intermediate

5910: .seealso:  MatOption, MatSetOption()

5912: @*/
5913: PetscErrorCode MatGetOption(Mat mat,MatOption op,PetscBool *flg)
5914: {

5919:   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);
5920:   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()");

5922:   switch (op) {
5923:   case MAT_NO_OFF_PROC_ENTRIES:
5924:     *flg = mat->nooffprocentries;
5925:     break;
5926:   case MAT_NO_OFF_PROC_ZERO_ROWS:
5927:     *flg = mat->nooffproczerorows;
5928:     break;
5929:   case MAT_SYMMETRIC:
5930:     *flg = mat->symmetric;
5931:     break;
5932:   case MAT_HERMITIAN:
5933:     *flg = mat->hermitian;
5934:     break;
5935:   case MAT_STRUCTURALLY_SYMMETRIC:
5936:     *flg = mat->structurally_symmetric;
5937:     break;
5938:   case MAT_SYMMETRY_ETERNAL:
5939:     *flg = mat->symmetric_eternal;
5940:     break;
5941:   case MAT_SPD:
5942:     *flg = mat->spd;
5943:     break;
5944:   default:
5945:     break;
5946:   }
5947:   return(0);
5948: }

5950: /*@
5951:    MatZeroEntries - Zeros all entries of a matrix.  For sparse matrices
5952:    this routine retains the old nonzero structure.

5954:    Logically Collective on Mat

5956:    Input Parameters:
5957: .  mat - the matrix

5959:    Level: intermediate

5961:    Notes:
5962:     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.
5963:    See the Performance chapter of the users manual for information on preallocating matrices.

5965: .seealso: MatZeroRows()
5966: @*/
5967: PetscErrorCode MatZeroEntries(Mat mat)
5968: {

5974:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5975:   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");
5976:   if (!mat->ops->zeroentries) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5977:   MatCheckPreallocated(mat,1);

5979:   PetscLogEventBegin(MAT_ZeroEntries,mat,0,0,0);
5980:   (*mat->ops->zeroentries)(mat);
5981:   PetscLogEventEnd(MAT_ZeroEntries,mat,0,0,0);
5982:   PetscObjectStateIncrease((PetscObject)mat);
5983:   return(0);
5984: }

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

5990:    Collective on Mat

5992:    Input Parameters:
5993: +  mat - the matrix
5994: .  numRows - the number of rows to remove
5995: .  rows - the global row indices
5996: .  diag - value put in all diagonals of eliminated rows (0.0 will even eliminate diagonal entry)
5997: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
5998: -  b - optional vector of right hand side, that will be adjusted by provided solution

6000:    Notes:
6001:    This does not change the nonzero structure of the matrix, it merely zeros those entries in the matrix.

6003:    The user can set a value in the diagonal entry (or for the AIJ and
6004:    row formats can optionally remove the main diagonal entry from the
6005:    nonzero structure as well, by passing 0.0 as the final argument).

6007:    For the parallel case, all processes that share the matrix (i.e.,
6008:    those in the communicator used for matrix creation) MUST call this
6009:    routine, regardless of whether any rows being zeroed are owned by
6010:    them.

6012:    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
6013:    list only rows local to itself).

6015:    The option MAT_NO_OFF_PROC_ZERO_ROWS does not apply to this routine.

6017:    Level: intermediate

6019: .seealso: MatZeroRowsIS(), MatZeroRows(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
6020:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
6021: @*/
6022: PetscErrorCode MatZeroRowsColumns(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag,Vec x,Vec b)
6023: {

6030:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6031:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6032:   if (!mat->ops->zerorowscolumns) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
6033:   MatCheckPreallocated(mat,1);

6035:   (*mat->ops->zerorowscolumns)(mat,numRows,rows,diag,x,b);
6036:   MatViewFromOptions(mat,NULL,"-mat_view");
6037:   PetscObjectStateIncrease((PetscObject)mat);
6038:   return(0);
6039: }

6041: /*@
6042:    MatZeroRowsColumnsIS - Zeros all entries (except possibly the main diagonal)
6043:    of a set of rows and columns of a matrix.

6045:    Collective on Mat

6047:    Input Parameters:
6048: +  mat - the matrix
6049: .  is - the rows to zero
6050: .  diag - value put in all diagonals of eliminated rows (0.0 will even eliminate diagonal entry)
6051: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
6052: -  b - optional vector of right hand side, that will be adjusted by provided solution

6054:    Notes:
6055:    This does not change the nonzero structure of the matrix, it merely zeros those entries in the matrix.

6057:    The user can set a value in the diagonal entry (or for the AIJ and
6058:    row formats can optionally remove the main diagonal entry from the
6059:    nonzero structure as well, by passing 0.0 as the final argument).

6061:    For the parallel case, all processes that share the matrix (i.e.,
6062:    those in the communicator used for matrix creation) MUST call this
6063:    routine, regardless of whether any rows being zeroed are owned by
6064:    them.

6066:    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
6067:    list only rows local to itself).

6069:    The option MAT_NO_OFF_PROC_ZERO_ROWS does not apply to this routine.

6071:    Level: intermediate

6073: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
6074:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRows(), MatZeroRowsColumnsStencil()
6075: @*/
6076: PetscErrorCode MatZeroRowsColumnsIS(Mat mat,IS is,PetscScalar diag,Vec x,Vec b)
6077: {
6079:   PetscInt       numRows;
6080:   const PetscInt *rows;

6087:   ISGetLocalSize(is,&numRows);
6088:   ISGetIndices(is,&rows);
6089:   MatZeroRowsColumns(mat,numRows,rows,diag,x,b);
6090:   ISRestoreIndices(is,&rows);
6091:   return(0);
6092: }

6094: /*@
6095:    MatZeroRows - Zeros all entries (except possibly the main diagonal)
6096:    of a set of rows of a matrix.

6098:    Collective on Mat

6100:    Input Parameters:
6101: +  mat - the matrix
6102: .  numRows - the number of rows to remove
6103: .  rows - the global row indices
6104: .  diag - value put in all diagonals of eliminated rows (0.0 will even eliminate diagonal entry)
6105: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
6106: -  b - optional vector of right hand side, that will be adjusted by provided solution

6108:    Notes:
6109:    For the AIJ and BAIJ 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:    For the parallel case, all processes that share the matrix (i.e.,
6122:    those in the communicator used for matrix creation) MUST call this
6123:    routine, regardless of whether any rows being zeroed are owned by
6124:    them.

6126:    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
6127:    list only rows local to itself).

6129:    You can call MatSetOption(mat,MAT_NO_OFF_PROC_ZERO_ROWS,PETSC_TRUE) if each process indicates only rows it
6130:    owns that are to be zeroed. This saves a global synchronization in the implementation.

6132:    Level: intermediate

6134: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
6135:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
6136: @*/
6137: PetscErrorCode MatZeroRows(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag,Vec x,Vec b)
6138: {

6145:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6146:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6147:   if (!mat->ops->zerorows) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
6148:   MatCheckPreallocated(mat,1);

6150:   (*mat->ops->zerorows)(mat,numRows,rows,diag,x,b);
6151:   MatViewFromOptions(mat,NULL,"-mat_view");
6152:   PetscObjectStateIncrease((PetscObject)mat);
6153:   return(0);
6154: }

6156: /*@
6157:    MatZeroRowsIS - Zeros all entries (except possibly the main diagonal)
6158:    of a set of rows of a matrix.

6160:    Collective on Mat

6162:    Input Parameters:
6163: +  mat - the matrix
6164: .  is - index set of rows to remove
6165: .  diag - value put in all diagonals of eliminated rows
6166: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
6167: -  b - optional vector of right hand side, that will be adjusted by provided solution

6169:    Notes:
6170:    For the AIJ and BAIJ matrix formats this removes the old nonzero structure,
6171:    but does not release memory.  For the dense and block diagonal
6172:    formats this does not alter the nonzero structure.

6174:    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
6175:    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
6176:    merely zeroed.

6178:    The user can set a value in the diagonal entry (or for the AIJ and
6179:    row formats can optionally remove the main diagonal entry from the
6180:    nonzero structure as well, by passing 0.0 as the final argument).

6182:    For the parallel case, all processes that share the matrix (i.e.,
6183:    those in the communicator used for matrix creation) MUST call this
6184:    routine, regardless of whether any rows being zeroed are owned by
6185:    them.

6187:    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
6188:    list only rows local to itself).

6190:    You can call MatSetOption(mat,MAT_NO_OFF_PROC_ZERO_ROWS,PETSC_TRUE) if each process indicates only rows it
6191:    owns that are to be zeroed. This saves a global synchronization in the implementation.

6193:    Level: intermediate

6195: .seealso: MatZeroRows(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
6196:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
6197: @*/
6198: PetscErrorCode MatZeroRowsIS(Mat mat,IS is,PetscScalar diag,Vec x,Vec b)
6199: {
6200:   PetscInt       numRows;
6201:   const PetscInt *rows;

6208:   ISGetLocalSize(is,&numRows);
6209:   ISGetIndices(is,&rows);
6210:   MatZeroRows(mat,numRows,rows,diag,x,b);
6211:   ISRestoreIndices(is,&rows);
6212:   return(0);
6213: }

6215: /*@
6216:    MatZeroRowsStencil - Zeros all entries (except possibly the main diagonal)
6217:    of a set of rows of a matrix. These rows must be local to the process.

6219:    Collective on Mat

6221:    Input Parameters:
6222: +  mat - the matrix
6223: .  numRows - the number of rows to remove
6224: .  rows - the grid coordinates (and component number when dof > 1) for matrix rows
6225: .  diag - value put in all diagonals of eliminated rows (0.0 will even eliminate diagonal entry)
6226: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
6227: -  b - optional vector of right hand side, that will be adjusted by provided solution

6229:    Notes:
6230:    For the AIJ and BAIJ matrix formats this removes the old nonzero structure,
6231:    but does not release memory.  For the dense and block diagonal
6232:    formats this does not alter the nonzero structure.

6234:    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
6235:    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
6236:    merely zeroed.

6238:    The user can set a value in the diagonal entry (or for the AIJ and
6239:    row formats can optionally remove the main diagonal entry from the
6240:    nonzero structure as well, by passing 0.0 as the final argument).

6242:    For the parallel case, all processes that share the matrix (i.e.,
6243:    those in the communicator used for matrix creation) MUST call this
6244:    routine, regardless of whether any rows being zeroed are owned by
6245:    them.

6247:    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
6248:    list only rows local to itself).

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

6252:    In Fortran idxm and idxn should be declared as
6253: $     MatStencil idxm(4,m)
6254:    and the values inserted using
6255: $    idxm(MatStencil_i,1) = i
6256: $    idxm(MatStencil_j,1) = j
6257: $    idxm(MatStencil_k,1) = k
6258: $    idxm(MatStencil_c,1) = c
6259:    etc

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

6266:    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
6267:    a single value per point) you can skip filling those indices.

6269:    Level: intermediate

6271: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsl(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
6272:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
6273: @*/
6274: PetscErrorCode MatZeroRowsStencil(Mat mat,PetscInt numRows,const MatStencil rows[],PetscScalar diag,Vec x,Vec b)
6275: {
6276:   PetscInt       dim     = mat->stencil.dim;
6277:   PetscInt       sdim    = dim - (1 - (PetscInt) mat->stencil.noc);
6278:   PetscInt       *dims   = mat->stencil.dims+1;
6279:   PetscInt       *starts = mat->stencil.starts;
6280:   PetscInt       *dxm    = (PetscInt*) rows;
6281:   PetscInt       *jdxm, i, j, tmp, numNewRows = 0;


6289:   PetscMalloc1(numRows, &jdxm);
6290:   for (i = 0; i < numRows; ++i) {
6291:     /* Skip unused dimensions (they are ordered k, j, i, c) */
6292:     for (j = 0; j < 3-sdim; ++j) dxm++;
6293:     /* Local index in X dir */
6294:     tmp = *dxm++ - starts[0];
6295:     /* Loop over remaining dimensions */
6296:     for (j = 0; j < dim-1; ++j) {
6297:       /* If nonlocal, set index to be negative */
6298:       if ((*dxm++ - starts[j+1]) < 0 || tmp < 0) tmp = PETSC_MIN_INT;
6299:       /* Update local index */
6300:       else tmp = tmp*dims[j] + *(dxm-1) - starts[j+1];
6301:     }
6302:     /* Skip component slot if necessary */
6303:     if (mat->stencil.noc) dxm++;
6304:     /* Local row number */
6305:     if (tmp >= 0) {
6306:       jdxm[numNewRows++] = tmp;
6307:     }
6308:   }
6309:   MatZeroRowsLocal(mat,numNewRows,jdxm,diag,x,b);
6310:   PetscFree(jdxm);
6311:   return(0);
6312: }

6314: /*@
6315:    MatZeroRowsColumnsStencil - Zeros all row and column entries (except possibly the main diagonal)
6316:    of a set of rows and columns of a matrix.

6318:    Collective on Mat

6320:    Input Parameters:
6321: +  mat - the matrix
6322: .  numRows - the number of rows/columns to remove
6323: .  rows - the grid coordinates (and component number when dof > 1) for matrix rows
6324: .  diag - value put in all diagonals of eliminated rows (0.0 will even eliminate diagonal entry)
6325: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
6326: -  b - optional vector of right hand side, that will be adjusted by provided solution

6328:    Notes:
6329:    For the AIJ and BAIJ matrix formats this removes the old nonzero structure,
6330:    but does not release memory.  For the dense and block diagonal
6331:    formats this does not alter the nonzero structure.

6333:    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
6334:    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
6335:    merely zeroed.

6337:    The user can set a value in the diagonal entry (or for the AIJ and
6338:    row formats can optionally remove the main diagonal entry from the
6339:    nonzero structure as well, by passing 0.0 as the final argument).

6341:    For the parallel case, all processes that share the matrix (i.e.,
6342:    those in the communicator used for matrix creation) MUST call this
6343:    routine, regardless of whether any rows being zeroed are owned by
6344:    them.

6346:    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
6347:    list only rows local to itself, but the row/column numbers are given in local numbering).

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

6351:    In Fortran idxm and idxn should be declared as
6352: $     MatStencil idxm(4,m)
6353:    and the values inserted using
6354: $    idxm(MatStencil_i,1) = i
6355: $    idxm(MatStencil_j,1) = j
6356: $    idxm(MatStencil_k,1) = k
6357: $    idxm(MatStencil_c,1) = c
6358:    etc

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

6365:    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
6366:    a single value per point) you can skip filling those indices.

6368:    Level: intermediate

6370: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
6371:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRows()
6372: @*/
6373: PetscErrorCode MatZeroRowsColumnsStencil(Mat mat,PetscInt numRows,const MatStencil rows[],PetscScalar diag,Vec x,Vec b)
6374: {
6375:   PetscInt       dim     = mat->stencil.dim;
6376:   PetscInt       sdim    = dim - (1 - (PetscInt) mat->stencil.noc);
6377:   PetscInt       *dims   = mat->stencil.dims+1;
6378:   PetscInt       *starts = mat->stencil.starts;
6379:   PetscInt       *dxm    = (PetscInt*) rows;
6380:   PetscInt       *jdxm, i, j, tmp, numNewRows = 0;


6388:   PetscMalloc1(numRows, &jdxm);
6389:   for (i = 0; i < numRows; ++i) {
6390:     /* Skip unused dimensions (they are ordered k, j, i, c) */
6391:     for (j = 0; j < 3-sdim; ++j) dxm++;
6392:     /* Local index in X dir */
6393:     tmp = *dxm++ - starts[0];
6394:     /* Loop over remaining dimensions */
6395:     for (j = 0; j < dim-1; ++j) {
6396:       /* If nonlocal, set index to be negative */
6397:       if ((*dxm++ - starts[j+1]) < 0 || tmp < 0) tmp = PETSC_MIN_INT;
6398:       /* Update local index */
6399:       else tmp = tmp*dims[j] + *(dxm-1) - starts[j+1];
6400:     }
6401:     /* Skip component slot if necessary */
6402:     if (mat->stencil.noc) dxm++;
6403:     /* Local row number */
6404:     if (tmp >= 0) {
6405:       jdxm[numNewRows++] = tmp;
6406:     }
6407:   }
6408:   MatZeroRowsColumnsLocal(mat,numNewRows,jdxm,diag,x,b);
6409:   PetscFree(jdxm);
6410:   return(0);
6411: }

6413: /*@C
6414:    MatZeroRowsLocal - Zeros all entries (except possibly the main diagonal)
6415:    of a set of rows of a matrix; using local numbering of rows.

6417:    Collective on Mat

6419:    Input Parameters:
6420: +  mat - the matrix
6421: .  numRows - the number of rows to remove
6422: .  rows - the global row indices
6423: .  diag - value put in all diagonals of eliminated rows
6424: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
6425: -  b - optional vector of right hand side, that will be adjusted by provided solution

6427:    Notes:
6428:    Before calling MatZeroRowsLocal(), the user must first set the
6429:    local-to-global mapping by calling MatSetLocalToGlobalMapping().

6431:    For the AIJ matrix formats this removes the old nonzero structure,
6432:    but does not release memory.  For the dense and block diagonal
6433:    formats this does not alter the nonzero structure.

6435:    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
6436:    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
6437:    merely zeroed.

6439:    The user can set a value in the diagonal entry (or for the AIJ and
6440:    row formats can optionally remove the main diagonal entry from the
6441:    nonzero structure as well, by passing 0.0 as the final argument).

6443:    You can call MatSetOption(mat,MAT_NO_OFF_PROC_ZERO_ROWS,PETSC_TRUE) if each process indicates only rows it
6444:    owns that are to be zeroed. This saves a global synchronization in the implementation.

6446:    Level: intermediate

6448: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRows(), MatSetOption(),
6449:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
6450: @*/
6451: PetscErrorCode MatZeroRowsLocal(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag,Vec x,Vec b)
6452: {

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

6463:   if (mat->ops->zerorowslocal) {
6464:     (*mat->ops->zerorowslocal)(mat,numRows,rows,diag,x,b);
6465:   } else {
6466:     IS             is, newis;
6467:     const PetscInt *newRows;

6469:     if (!mat->rmap->mapping) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Need to provide local to global mapping to matrix first");
6470:     ISCreateGeneral(PETSC_COMM_SELF,numRows,rows,PETSC_COPY_VALUES,&is);
6471:     ISLocalToGlobalMappingApplyIS(mat->rmap->mapping,is,&newis);
6472:     ISGetIndices(newis,&newRows);
6473:     (*mat->ops->zerorows)(mat,numRows,newRows,diag,x,b);
6474:     ISRestoreIndices(newis,&newRows);
6475:     ISDestroy(&newis);
6476:     ISDestroy(&is);
6477:   }
6478:   PetscObjectStateIncrease((PetscObject)mat);
6479:   return(0);
6480: }

6482: /*@
6483:    MatZeroRowsLocalIS - Zeros all entries (except possibly the main diagonal)
6484:    of a set of rows of a matrix; using local numbering of rows.

6486:    Collective on Mat

6488:    Input Parameters:
6489: +  mat - the matrix
6490: .  is - index set of rows to remove
6491: .  diag - value put in all diagonals of eliminated rows
6492: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
6493: -  b - optional vector of right hand side, that will be adjusted by provided solution

6495:    Notes:
6496:    Before calling MatZeroRowsLocalIS(), the user must first set the
6497:    local-to-global mapping by calling MatSetLocalToGlobalMapping().

6499:    For the AIJ matrix formats this removes the old nonzero structure,
6500:    but does not release memory.  For the dense and block diagonal
6501:    formats this does not alter the nonzero structure.

6503:    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
6504:    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
6505:    merely zeroed.

6507:    The user can set a value in the diagonal entry (or for the AIJ and
6508:    row formats can optionally remove the main diagonal entry from the
6509:    nonzero structure as well, by passing 0.0 as the final argument).

6511:    You can call MatSetOption(mat,MAT_NO_OFF_PROC_ZERO_ROWS,PETSC_TRUE) if each process indicates only rows it
6512:    owns that are to be zeroed. This saves a global synchronization in the implementation.

6514:    Level: intermediate

6516: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRows(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
6517:           MatZeroRowsColumnsLocal(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
6518: @*/
6519: PetscErrorCode MatZeroRowsLocalIS(Mat mat,IS is,PetscScalar diag,Vec x,Vec b)
6520: {
6522:   PetscInt       numRows;
6523:   const PetscInt *rows;

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

6533:   ISGetLocalSize(is,&numRows);
6534:   ISGetIndices(is,&rows);
6535:   MatZeroRowsLocal(mat,numRows,rows,diag,x,b);
6536:   ISRestoreIndices(is,&rows);
6537:   return(0);
6538: }

6540: /*@
6541:    MatZeroRowsColumnsLocal - Zeros all entries (except possibly the main diagonal)
6542:    of a set of rows and columns of a matrix; using local numbering of rows.

6544:    Collective on Mat

6546:    Input Parameters:
6547: +  mat - the matrix
6548: .  numRows - the number of rows to remove
6549: .  rows - the global row indices
6550: .  diag - value put in all diagonals of eliminated rows
6551: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
6552: -  b - optional vector of right hand side, that will be adjusted by provided solution

6554:    Notes:
6555:    Before calling MatZeroRowsColumnsLocal(), the user must first set the
6556:    local-to-global mapping by calling MatSetLocalToGlobalMapping().

6558:    The user can set a value in the diagonal entry (or for the AIJ and
6559:    row formats can optionally remove the main diagonal entry from the
6560:    nonzero structure as well, by passing 0.0 as the final argument).

6562:    Level: intermediate

6564: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
6565:           MatZeroRows(), MatZeroRowsColumnsLocalIS(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
6566: @*/
6567: PetscErrorCode MatZeroRowsColumnsLocal(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag,Vec x,Vec b)
6568: {
6570:   IS             is, newis;
6571:   const PetscInt *newRows;

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

6581:   if (!mat->cmap->mapping) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Need to provide local to global mapping to matrix first");
6582:   ISCreateGeneral(PETSC_COMM_SELF,numRows,rows,PETSC_COPY_VALUES,&is);
6583:   ISLocalToGlobalMappingApplyIS(mat->cmap->mapping,is,&newis);
6584:   ISGetIndices(newis,&newRows);
6585:   (*mat->ops->zerorowscolumns)(mat,numRows,newRows,diag,x,b);
6586:   ISRestoreIndices(newis,&newRows);
6587:   ISDestroy(&newis);
6588:   ISDestroy(&is);
6589:   PetscObjectStateIncrease((PetscObject)mat);
6590:   return(0);
6591: }

6593: /*@
6594:    MatZeroRowsColumnsLocalIS - Zeros all entries (except possibly the main diagonal)
6595:    of a set of rows and columns of a matrix; using local numbering of rows.

6597:    Collective on Mat

6599:    Input Parameters:
6600: +  mat - the matrix
6601: .  is - index set of rows to remove
6602: .  diag - value put in all diagonals of eliminated rows
6603: .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
6604: -  b - optional vector of right hand side, that will be adjusted by provided solution

6606:    Notes:
6607:    Before calling MatZeroRowsColumnsLocalIS(), the user must first set the
6608:    local-to-global mapping by calling MatSetLocalToGlobalMapping().

6610:    The user can set a value in the diagonal entry (or for the AIJ and
6611:    row formats can optionally remove the main diagonal entry from the
6612:    nonzero structure as well, by passing 0.0 as the final argument).

6614:    Level: intermediate

6616: .seealso: MatZeroRowsIS(), MatZeroRowsColumns(), MatZeroRowsLocalIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(),
6617:           MatZeroRowsColumnsLocal(), MatZeroRows(), MatZeroRowsColumnsIS(), MatZeroRowsColumnsStencil()
6618: @*/
6619: PetscErrorCode MatZeroRowsColumnsLocalIS(Mat mat,IS is,PetscScalar diag,Vec x,Vec b)
6620: {
6622:   PetscInt       numRows;
6623:   const PetscInt *rows;

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

6633:   ISGetLocalSize(is,&numRows);
6634:   ISGetIndices(is,&rows);
6635:   MatZeroRowsColumnsLocal(mat,numRows,rows,diag,x,b);
6636:   ISRestoreIndices(is,&rows);
6637:   return(0);
6638: }

6640: /*@C
6641:    MatGetSize - Returns the numbers of rows and columns in a matrix.

6643:    Not Collective

6645:    Input Parameter:
6646: .  mat - the matrix

6648:    Output Parameters:
6649: +  m - the number of global rows
6650: -  n - the number of global columns

6652:    Note: both output parameters can be NULL on input.

6654:    Level: beginner

6656: .seealso: MatGetLocalSize()
6657: @*/
6658: PetscErrorCode MatGetSize(Mat mat,PetscInt *m,PetscInt *n)
6659: {
6662:   if (m) *m = mat->rmap->N;
6663:   if (n) *n = mat->cmap->N;
6664:   return(0);
6665: }

6667: /*@C
6668:    MatGetLocalSize - Returns the number of local rows and local columns
6669:    of a matrix, that is the local size of the left and right vectors as returned by MatCreateVecs().

6671:    Not Collective

6673:    Input Parameters:
6674: .  mat - the matrix

6676:    Output Parameters:
6677: +  m - the number of local rows
6678: -  n - the number of local columns

6680:    Note: both output parameters can be NULL on input.

6682:    Level: beginner

6684: .seealso: MatGetSize()
6685: @*/
6686: PetscErrorCode MatGetLocalSize(Mat mat,PetscInt *m,PetscInt *n)
6687: {
6692:   if (m) *m = mat->rmap->n;
6693:   if (n) *n = mat->cmap->n;
6694:   return(0);
6695: }

6697: /*@C
6698:    MatGetOwnershipRangeColumn - Returns the range of matrix columns associated with rows of a vector one multiplies by that owned by
6699:    this processor. (The columns of the "diagonal block")

6701:    Not Collective, unless matrix has not been allocated, then collective on Mat

6703:    Input Parameters:
6704: .  mat - the matrix

6706:    Output Parameters:
6707: +  m - the global index of the first local column
6708: -  n - one more than the global index of the last local column

6710:    Notes:
6711:     both output parameters can be NULL on input.

6713:    Level: developer

6715: .seealso:  MatGetOwnershipRange(), MatGetOwnershipRanges(), MatGetOwnershipRangesColumn()

6717: @*/
6718: PetscErrorCode MatGetOwnershipRangeColumn(Mat mat,PetscInt *m,PetscInt *n)
6719: {
6725:   MatCheckPreallocated(mat,1);
6726:   if (m) *m = mat->cmap->rstart;
6727:   if (n) *n = mat->cmap->rend;
6728:   return(0);
6729: }

6731: /*@C
6732:    MatGetOwnershipRange - Returns the range of matrix rows owned by
6733:    this processor, assuming that the matrix is laid out with the first
6734:    n1 rows on the first processor, the next n2 rows on the second, etc.
6735:    For certain parallel layouts this range may not be well defined.

6737:    Not Collective

6739:    Input Parameters:
6740: .  mat - the matrix

6742:    Output Parameters:
6743: +  m - the global index of the first local row
6744: -  n - one more than the global index of the last local row

6746:    Note: Both output parameters can be NULL on input.
6747: $  This function requires that the matrix be preallocated. If you have not preallocated, consider using
6748: $    PetscSplitOwnership(MPI_Comm comm, PetscInt *n, PetscInt *N)
6749: $  and then MPI_Scan() to calculate prefix sums of the local sizes.

6751:    Level: beginner

6753: .seealso:   MatGetOwnershipRanges(), MatGetOwnershipRangeColumn(), MatGetOwnershipRangesColumn(), PetscSplitOwnership(), PetscSplitOwnershipBlock()

6755: @*/
6756: PetscErrorCode MatGetOwnershipRange(Mat mat,PetscInt *m,PetscInt *n)
6757: {
6763:   MatCheckPreallocated(mat,1);
6764:   if (m) *m = mat->rmap->rstart;
6765:   if (n) *n = mat->rmap->rend;
6766:   return(0);
6767: }

6769: /*@C
6770:    MatGetOwnershipRanges - Returns the range of matrix rows owned by
6771:    each process

6773:    Not Collective, unless matrix has not been allocated, then collective on Mat

6775:    Input Parameters:
6776: .  mat - the matrix

6778:    Output Parameters:
6779: .  ranges - start of each processors portion plus one more than the total length at the end

6781:    Level: beginner

6783: .seealso:   MatGetOwnershipRange(), MatGetOwnershipRangeColumn(), MatGetOwnershipRangesColumn()

6785: @*/
6786: PetscErrorCode MatGetOwnershipRanges(Mat mat,const PetscInt **ranges)
6787: {

6793:   MatCheckPreallocated(mat,1);
6794:   PetscLayoutGetRanges(mat->rmap,ranges);
6795:   return(0);
6796: }

6798: /*@C
6799:    MatGetOwnershipRangesColumn - Returns the range of matrix columns associated with rows of a vector one multiplies by that owned by
6800:    this processor. (The columns of the "diagonal blocks" for each process)

6802:    Not Collective, unless matrix has not been allocated, then collective on Mat

6804:    Input Parameters:
6805: .  mat - the matrix

6807:    Output Parameters:
6808: .  ranges - start of each processors portion plus one more then the total length at the end

6810:    Level: beginner

6812: .seealso:   MatGetOwnershipRange(), MatGetOwnershipRangeColumn(), MatGetOwnershipRanges()

6814: @*/
6815: PetscErrorCode MatGetOwnershipRangesColumn(Mat mat,const PetscInt **ranges)
6816: {

6822:   MatCheckPreallocated(mat,1);
6823:   PetscLayoutGetRanges(mat->cmap,ranges);
6824:   return(0);
6825: }

6827: /*@C
6828:    MatGetOwnershipIS - Get row and column ownership as index sets

6830:    Not Collective

6832:    Input Arguments:
6833: .  A - matrix of type Elemental or ScaLAPACK

6835:    Output Arguments:
6836: +  rows - rows in which this process owns elements
6837: -  cols - columns in which this process owns elements

6839:    Level: intermediate

6841: .seealso: MatGetOwnershipRange(), MatGetOwnershipRangeColumn(), MatSetValues(), MATELEMENTAL
6842: @*/
6843: PetscErrorCode MatGetOwnershipIS(Mat A,IS *rows,IS *cols)
6844: {
6845:   PetscErrorCode ierr,(*f)(Mat,IS*,IS*);

6848:   MatCheckPreallocated(A,1);
6849:   PetscObjectQueryFunction((PetscObject)A,"MatGetOwnershipIS_C",&f);
6850:   if (f) {
6851:     (*f)(A,rows,cols);
6852:   } else {   /* Create a standard row-based partition, each process is responsible for ALL columns in their row block */
6853:     if (rows) {ISCreateStride(PETSC_COMM_SELF,A->rmap->n,A->rmap->rstart,1,rows);}
6854:     if (cols) {ISCreateStride(PETSC_COMM_SELF,A->cmap->N,0,1,cols);}
6855:   }
6856:   return(0);
6857: }

6859: /*@C
6860:    MatILUFactorSymbolic - Performs symbolic ILU factorization of a matrix.
6861:    Uses levels of fill only, not drop tolerance. Use MatLUFactorNumeric()
6862:    to complete the factorization.

6864:    Collective on Mat

6866:    Input Parameters:
6867: +  mat - the matrix
6868: .  row - row permutation
6869: .  column - column permutation
6870: -  info - structure containing
6871: $      levels - number of levels of fill.
6872: $      expected fill - as ratio of original fill.
6873: $      1 or 0 - indicating force fill on diagonal (improves robustness for matrices
6874:                 missing diagonal entries)

6876:    Output Parameters:
6877: .  fact - new matrix that has been symbolically factored

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

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

6886:    Level: developer

6888: .seealso: MatLUFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor()
6889:           MatGetOrdering(), MatFactorInfo

6891:     Note: this uses the definition of level of fill as in Y. Saad, 2003

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

6896:    References:
6897:      Y. Saad, Iterative methods for sparse linear systems Philadelphia: Society for Industrial and Applied Mathematics, 2003
6898: @*/
6899: PetscErrorCode MatILUFactorSymbolic(Mat fact,Mat mat,IS row,IS col,const MatFactorInfo *info)
6900: {

6910:   if (info->levels < 0) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Levels of fill negative %D",(PetscInt)info->levels);
6911:   if (info->fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Expected fill less than 1.0 %g",(double)info->fill);
6912:   if (!fact->ops->ilufactorsymbolic) {
6913:     MatSolverType stype;
6914:     MatFactorGetSolverType(fact,&stype);
6915:     SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s symbolic ILU using solver type %s",((PetscObject)mat)->type_name,stype);
6916:   }
6917:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6918:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6919:   MatCheckPreallocated(mat,2);

6921:   PetscLogEventBegin(MAT_ILUFactorSymbolic,mat,row,col,0);
6922:   (fact->ops->ilufactorsymbolic)(fact,mat,row,col,info);
6923:   PetscLogEventEnd(MAT_ILUFactorSymbolic,mat,row,col,0);
6924:   return(0);
6925: }

6927: /*@C
6928:    MatICCFactorSymbolic - Performs symbolic incomplete
6929:    Cholesky factorization for a symmetric matrix.  Use
6930:    MatCholeskyFactorNumeric() to complete the factorization.

6932:    Collective on Mat

6934:    Input Parameters:
6935: +  mat - the matrix
6936: .  perm - row and column permutation
6937: -  info - structure containing
6938: $      levels - number of levels of fill.
6939: $      expected fill - as ratio of original fill.

6941:    Output Parameter:
6942: .  fact - the factored matrix

6944:    Notes:
6945:    Most users should employ the KSP interface for linear solvers
6946:    instead of working directly with matrix algebra routines such as this.
6947:    See, e.g., KSPCreate().

6949:    Level: developer

6951: .seealso: MatCholeskyFactorNumeric(), MatCholeskyFactor(), MatFactorInfo

6953:     Note: this uses the definition of level of fill as in Y. Saad, 2003

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

6958:    References:
6959:      Y. Saad, Iterative methods for sparse linear systems Philadelphia: Society for Industrial and Applied Mathematics, 2003
6960: @*/
6961: PetscErrorCode MatICCFactorSymbolic(Mat fact,Mat mat,IS perm,const MatFactorInfo *info)
6962: {

6971:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6972:   if (info->levels < 0) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Levels negative %D",(PetscInt) info->levels);
6973:   if (info->fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Expected fill less than 1.0 %g",(double)info->fill);
6974:   if (!(fact)->ops->iccfactorsymbolic) {
6975:     MatSolverType stype;
6976:     MatFactorGetSolverType(fact,&stype);
6977:     SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s symbolic ICC using solver type %s",((PetscObject)mat)->type_name,stype);
6978:   }
6979:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6980:   MatCheckPreallocated(mat,2);

6982:   PetscLogEventBegin(MAT_ICCFactorSymbolic,mat,perm,0,0);
6983:   (fact->ops->iccfactorsymbolic)(fact,mat,perm,info);
6984:   PetscLogEventEnd(MAT_ICCFactorSymbolic,mat,perm,0,0);
6985:   return(0);
6986: }

6988: /*@C
6989:    MatCreateSubMatrices - Extracts several submatrices from a matrix. If submat
6990:    points to an array of valid matrices, they may be reused to store the new
6991:    submatrices.

6993:    Collective on Mat

6995:    Input Parameters:
6996: +  mat - the matrix
6997: .  n   - the number of submatrixes to be extracted (on this processor, may be zero)
6998: .  irow, icol - index sets of rows and columns to extract
6999: -  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX

7001:    Output Parameter:
7002: .  submat - the array of submatrices

7004:    Notes:
7005:    MatCreateSubMatrices() can extract ONLY sequential submatrices
7006:    (from both sequential and parallel matrices). Use MatCreateSubMatrix()
7007:    to extract a parallel submatrix.

7009:    Some matrix types place restrictions on the row and column
7010:    indices, such as that they be sorted or that they be equal to each other.

7012:    The index sets may not have duplicate entries.

7014:    When extracting submatrices from a parallel matrix, each processor can
7015:    form a different submatrix by setting the rows and columns of its
7016:    individual index sets according to the local submatrix desired.

7018:    When finished using the submatrices, the user should destroy
7019:    them with MatDestroySubMatrices().

7021:    MAT_REUSE_MATRIX can only be used when the nonzero structure of the
7022:    original matrix has not changed from that last call to MatCreateSubMatrices().

7024:    This routine creates the matrices in submat; you should NOT create them before
7025:    calling it. It also allocates the array of matrix pointers submat.

7027:    For BAIJ matrices the index sets must respect the block structure, that is if they
7028:    request one row/column in a block, they must request all rows/columns that are in
7029:    that block. For example, if the block size is 2 you cannot request just row 0 and
7030:    column 0.

7032:    Fortran Note:
7033:    The Fortran interface is slightly different from that given below; it
7034:    requires one to pass in  as submat a Mat (integer) array of size at least n+1.

7036:    Level: advanced


7039: .seealso: MatDestroySubMatrices(), MatCreateSubMatrix(), MatGetRow(), MatGetDiagonal(), MatReuse
7040: @*/
7041: PetscErrorCode MatCreateSubMatrices(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[])
7042: {
7044:   PetscInt       i;
7045:   PetscBool      eq;

7050:   if (n) {
7055:   }
7057:   if (n && scall == MAT_REUSE_MATRIX) {
7060:   }
7061:   if (!mat->ops->createsubmatrices) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
7062:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
7063:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
7064:   MatCheckPreallocated(mat,1);

7066:   PetscLogEventBegin(MAT_CreateSubMats,mat,0,0,0);
7067:   (*mat->ops->createsubmatrices)(mat,n,irow,icol,scall,submat);
7068:   PetscLogEventEnd(MAT_CreateSubMats,mat,0,0,0);
7069:   for (i=0; i<n; i++) {
7070:     (*submat)[i]->factortype = MAT_FACTOR_NONE;  /* in case in place factorization was previously done on submatrix */
7071:     ISEqualUnsorted(irow[i],icol[i],&eq);
7072:     if (eq) {
7073:       MatPropagateSymmetryOptions(mat,(*submat)[i]);
7074:     }
7075:   }
7076:   return(0);
7077: }

7079: /*@C
7080:    MatCreateSubMatricesMPI - Extracts MPI submatrices across a sub communicator of mat (by pairs of IS that may live on subcomms).

7082:    Collective on Mat

7084:    Input Parameters:
7085: +  mat - the matrix
7086: .  n   - the number of submatrixes to be extracted
7087: .  irow, icol - index sets of rows and columns to extract
7088: -  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX

7090:    Output Parameter:
7091: .  submat - the array of submatrices

7093:    Level: advanced


7096: .seealso: MatCreateSubMatrices(), MatCreateSubMatrix(), MatGetRow(), MatGetDiagonal(), MatReuse
7097: @*/
7098: PetscErrorCode MatCreateSubMatricesMPI(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[])
7099: {
7101:   PetscInt       i;
7102:   PetscBool      eq;

7107:   if (n) {
7112:   }
7114:   if (n && scall == MAT_REUSE_MATRIX) {
7117:   }
7118:   if (!mat->ops->createsubmatricesmpi) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
7119:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
7120:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
7121:   MatCheckPreallocated(mat,1);

7123:   PetscLogEventBegin(MAT_CreateSubMats,mat,0,0,0);
7124:   (*mat->ops->createsubmatricesmpi)(mat,n,irow,icol,scall,submat);
7125:   PetscLogEventEnd(MAT_CreateSubMats,mat,0,0,0);
7126:   for (i=0; i<n; i++) {
7127:     ISEqualUnsorted(irow[i],icol[i],&eq);
7128:     if (eq) {
7129:       MatPropagateSymmetryOptions(mat,(*submat)[i]);
7130:     }
7131:   }
7132:   return(0);
7133: }

7135: /*@C
7136:    MatDestroyMatrices - Destroys an array of matrices.

7138:    Collective on Mat

7140:    Input Parameters:
7141: +  n - the number of local matrices
7142: -  mat - the matrices (note that this is a pointer to the array of matrices)

7144:    Level: advanced

7146:     Notes:
7147:     Frees not only the matrices, but also the array that contains the matrices
7148:            In Fortran will not free the array.

7150: .seealso: MatCreateSubMatrices() MatDestroySubMatrices()
7151: @*/
7152: PetscErrorCode MatDestroyMatrices(PetscInt n,Mat *mat[])
7153: {
7155:   PetscInt       i;

7158:   if (!*mat) return(0);
7159:   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to destroy negative number of matrices %D",n);

7162:   for (i=0; i<n; i++) {
7163:     MatDestroy(&(*mat)[i]);
7164:   }

7166:   /* memory is allocated even if n = 0 */
7167:   PetscFree(*mat);
7168:   return(0);
7169: }

7171: /*@C
7172:    MatDestroySubMatrices - Destroys a set of matrices obtained with MatCreateSubMatrices().

7174:    Collective on Mat

7176:    Input Parameters:
7177: +  n - the number of local matrices
7178: -  mat - the matrices (note that this is a pointer to the array of matrices, just to match the calling
7179:                        sequence of MatCreateSubMatrices())

7181:    Level: advanced

7183:     Notes:
7184:     Frees not only the matrices, but also the array that contains the matrices
7185:            In Fortran will not free the array.

7187: .seealso: MatCreateSubMatrices()
7188: @*/
7189: PetscErrorCode MatDestroySubMatrices(PetscInt n,Mat *mat[])
7190: {
7192:   Mat            mat0;

7195:   if (!*mat) return(0);
7196:   /* mat[] is an array of length n+1, see MatCreateSubMatrices_xxx() */
7197:   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to destroy negative number of matrices %D",n);

7200:   mat0 = (*mat)[0];
7201:   if (mat0 && mat0->ops->destroysubmatrices) {
7202:     (mat0->ops->destroysubmatrices)(n,mat);
7203:   } else {
7204:     MatDestroyMatrices(n,mat);
7205:   }
7206:   return(0);
7207: }

7209: /*@C
7210:    MatGetSeqNonzeroStructure - Extracts the sequential nonzero structure from a matrix.

7212:    Collective on Mat

7214:    Input Parameters:
7215: .  mat - the matrix

7217:    Output Parameter:
7218: .  matstruct - the sequential matrix with the nonzero structure of mat

7220:   Level: intermediate

7222: .seealso: MatDestroySeqNonzeroStructure(), MatCreateSubMatrices(), MatDestroyMatrices()
7223: @*/
7224: PetscErrorCode MatGetSeqNonzeroStructure(Mat mat,Mat *matstruct)
7225: {


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

7236:   if (!mat->ops->getseqnonzerostructure) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Not for matrix type %s\n",((PetscObject)mat)->type_name);
7237:   PetscLogEventBegin(MAT_GetSeqNonzeroStructure,mat,0,0,0);
7238:   (*mat->ops->getseqnonzerostructure)(mat,matstruct);
7239:   PetscLogEventEnd(MAT_GetSeqNonzeroStructure,mat,0,0,0);
7240:   return(0);
7241: }

7243: /*@C
7244:    MatDestroySeqNonzeroStructure - Destroys matrix obtained with MatGetSeqNonzeroStructure().

7246:    Collective on Mat

7248:    Input Parameters:
7249: .  mat - the matrix (note that this is a pointer to the array of matrices, just to match the calling
7250:                        sequence of MatGetSequentialNonzeroStructure())

7252:    Level: advanced

7254:     Notes:
7255:     Frees not only the matrices, but also the array that contains the matrices

7257: .seealso: MatGetSeqNonzeroStructure()
7258: @*/
7259: PetscErrorCode MatDestroySeqNonzeroStructure(Mat *mat)
7260: {

7265:   MatDestroy(mat);
7266:   return(0);
7267: }

7269: /*@
7270:    MatIncreaseOverlap - Given a set of submatrices indicated by index sets,
7271:    replaces the index sets by larger ones that represent submatrices with
7272:    additional overlap.

7274:    Collective on Mat

7276:    Input Parameters:
7277: +  mat - the matrix
7278: .  n   - the number of index sets
7279: .  is  - the array of index sets (these index sets will changed during the call)
7280: -  ov  - the additional overlap requested

7282:    Options Database:
7283: .  -mat_increase_overlap_scalable - use a scalable algorithm to compute the overlap (supported by MPIAIJ matrix)

7285:    Level: developer


7288: .seealso: MatCreateSubMatrices()
7289: @*/
7290: PetscErrorCode MatIncreaseOverlap(Mat mat,PetscInt n,IS is[],PetscInt ov)
7291: {

7297:   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Must have one or more domains, you have %D",n);
7298:   if (n) {
7301:   }
7302:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
7303:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
7304:   MatCheckPreallocated(mat,1);

7306:   if (!ov) return(0);
7307:   if (!mat->ops->increaseoverlap) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
7308:   PetscLogEventBegin(MAT_IncreaseOverlap,mat,0,0,0);
7309:   (*mat->ops->increaseoverlap)(mat,n,is,ov);
7310:   PetscLogEventEnd(MAT_IncreaseOverlap,mat,0,0,0);
7311:   return(0);
7312: }


7315: PetscErrorCode MatIncreaseOverlapSplit_Single(Mat,IS*,PetscInt);

7317: /*@
7318:    MatIncreaseOverlapSplit - Given a set of submatrices indicated by index sets across
7319:    a sub communicator, replaces the index sets by larger ones that represent submatrices with
7320:    additional overlap.

7322:    Collective on Mat

7324:    Input Parameters:
7325: +  mat - the matrix
7326: .  n   - the number of index sets
7327: .  is  - the array of index sets (these index sets will changed during the call)
7328: -  ov  - the additional overlap requested

7330:    Options Database:
7331: .  -mat_increase_overlap_scalable - use a scalable algorithm to compute the overlap (supported by MPIAIJ matrix)

7333:    Level: developer


7336: .seealso: MatCreateSubMatrices()
7337: @*/
7338: PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov)
7339: {
7340:   PetscInt       i;

7346:   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Must have one or more domains, you have %D",n);
7347:   if (n) {
7350:   }
7351:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
7352:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
7353:   MatCheckPreallocated(mat,1);
7354:   if (!ov) return(0);
7355:   PetscLogEventBegin(MAT_IncreaseOverlap,mat,0,0,0);
7356:   for (i=0; i<n; i++){
7357:          MatIncreaseOverlapSplit_Single(mat,&is[i],ov);
7358:   }
7359:   PetscLogEventEnd(MAT_IncreaseOverlap,mat,0,0,0);
7360:   return(0);
7361: }




7366: /*@
7367:    MatGetBlockSize - Returns the matrix block size.

7369:    Not Collective

7371:    Input Parameter:
7372: .  mat - the matrix

7374:    Output Parameter:
7375: .  bs - block size

7377:    Notes:
7378:     Block row formats are MATSEQBAIJ, MATMPIBAIJ, MATSEQSBAIJ, MATMPISBAIJ. These formats ALWAYS have square block storage in the matrix.

7380:    If the block size has not been set yet this routine returns 1.

7382:    Level: intermediate

7384: .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSizes()
7385: @*/
7386: PetscErrorCode MatGetBlockSize(Mat mat,PetscInt *bs)
7387: {
7391:   *bs = PetscAbs(mat->rmap->bs);
7392:   return(0);
7393: }

7395: /*@
7396:    MatGetBlockSizes - Returns the matrix block row and column sizes.

7398:    Not Collective

7400:    Input Parameter:
7401: .  mat - the matrix

7403:    Output Parameter:
7404: +  rbs - row block size
7405: -  cbs - column block size

7407:    Notes:
7408:     Block row formats are MATSEQBAIJ, MATMPIBAIJ, MATSEQSBAIJ, MATMPISBAIJ. These formats ALWAYS have square block storage in the matrix.
7409:     If you pass a different block size for the columns than the rows, the row block size determines the square block storage.

7411:    If a block size has not been set yet this routine returns 1.

7413:    Level: intermediate

7415: .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSize(), MatSetBlockSizes()
7416: @*/
7417: PetscErrorCode MatGetBlockSizes(Mat mat,PetscInt *rbs, PetscInt *cbs)
7418: {
7423:   if (rbs) *rbs = PetscAbs(mat->rmap->bs);
7424:   if (cbs) *cbs = PetscAbs(mat->cmap->bs);
7425:   return(0);
7426: }

7428: /*@
7429:    MatSetBlockSize - Sets the matrix block size.

7431:    Logically Collective on Mat

7433:    Input Parameters:
7434: +  mat - the matrix
7435: -  bs - block size

7437:    Notes:
7438:     Block row formats are MATSEQBAIJ, MATMPIBAIJ, MATSEQSBAIJ, MATMPISBAIJ. These formats ALWAYS have square block storage in the matrix.
7439:     This must be called before MatSetUp() or MatXXXSetPreallocation() (or will default to 1) and the block size cannot be changed later.

7441:     For MATMPIAIJ and MATSEQAIJ matrix formats, this function can be called at a later stage, provided that the specified block size
7442:     is compatible with the matrix local sizes.

7444:    Level: intermediate

7446: .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSizes(), MatGetBlockSizes()
7447: @*/
7448: PetscErrorCode MatSetBlockSize(Mat mat,PetscInt bs)
7449: {

7455:   MatSetBlockSizes(mat,bs,bs);
7456:   return(0);
7457: }

7459: /*@
7460:    MatSetVariableBlockSizes - Sets a diagonal blocks of the matrix that need not be of the same size

7462:    Logically Collective on Mat

7464:    Input Parameters:
7465: +  mat - the matrix
7466: .  nblocks - the number of blocks on this process
7467: -  bsizes - the block sizes

7469:    Notes:
7470:     Currently used by PCVPBJACOBI for SeqAIJ matrices

7472:    Level: intermediate

7474: .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSizes(), MatGetBlockSizes(), MatGetVariableBlockSizes()
7475: @*/
7476: PetscErrorCode MatSetVariableBlockSizes(Mat mat,PetscInt nblocks,PetscInt *bsizes)
7477: {
7479:   PetscInt       i,ncnt = 0, nlocal;

7483:   if (nblocks < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Number of local blocks must be great than or equal to zero");
7484:   MatGetLocalSize(mat,&nlocal,NULL);
7485:   for (i=0; i<nblocks; i++) ncnt += bsizes[i];
7486:   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);
7487:   PetscFree(mat->bsizes);
7488:   mat->nblocks = nblocks;
7489:   PetscMalloc1(nblocks,&mat->bsizes);
7490:   PetscArraycpy(mat->bsizes,bsizes,nblocks);
7491:   return(0);
7492: }

7494: /*@C
7495:    MatGetVariableBlockSizes - Gets a diagonal blocks of the matrix that need not be of the same size

7497:    Logically Collective on Mat

7499:    Input Parameters:
7500: .  mat - the matrix

7502:    Output Parameters:
7503: +  nblocks - the number of blocks on this process
7504: -  bsizes - the block sizes

7506:    Notes: Currently not supported from Fortran

7508:    Level: intermediate

7510: .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSizes(), MatGetBlockSizes(), MatSetVariableBlockSizes()
7511: @*/
7512: PetscErrorCode MatGetVariableBlockSizes(Mat mat,PetscInt *nblocks,const PetscInt **bsizes)
7513: {
7516:   *nblocks = mat->nblocks;
7517:   *bsizes  = mat->bsizes;
7518:   return(0);
7519: }

7521: /*@
7522:    MatSetBlockSizes - Sets the matrix block row and column sizes.

7524:    Logically Collective on Mat

7526:    Input Parameters:
7527: +  mat - the matrix
7528: .  rbs - row block size
7529: -  cbs - column block size

7531:    Notes:
7532:     Block row formats are MATSEQBAIJ, MATMPIBAIJ, MATSEQSBAIJ, MATMPISBAIJ. These formats ALWAYS have square block storage in the matrix.
7533:     If you pass a different block size for the columns than the rows, the row block size determines the square block storage.
7534:     This must be called before MatSetUp() or MatXXXSetPreallocation() (or will default to 1) and the block size cannot be changed later.

7536:     For MATMPIAIJ and MATSEQAIJ matrix formats, this function can be called at a later stage, provided that the specified block sizes
7537:     are compatible with the matrix local sizes.

7539:     The row and column block size determine the blocksize of the "row" and "column" vectors returned by MatCreateVecs().

7541:    Level: intermediate

7543: .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSize(), MatGetBlockSizes()
7544: @*/
7545: PetscErrorCode MatSetBlockSizes(Mat mat,PetscInt rbs,PetscInt cbs)
7546: {

7553:   if (mat->ops->setblocksizes) {
7554:     (*mat->ops->setblocksizes)(mat,rbs,cbs);
7555:   }
7556:   if (mat->rmap->refcnt) {
7557:     ISLocalToGlobalMapping l2g = NULL;
7558:     PetscLayout            nmap = NULL;

7560:     PetscLayoutDuplicate(mat->rmap,&nmap);
7561:     if (mat->rmap->mapping) {
7562:       ISLocalToGlobalMappingDuplicate(mat->rmap->mapping,&l2g);
7563:     }
7564:     PetscLayoutDestroy(&mat->rmap);
7565:     mat->rmap = nmap;
7566:     mat->rmap->mapping = l2g;
7567:   }
7568:   if (mat->cmap->refcnt) {
7569:     ISLocalToGlobalMapping l2g = NULL;
7570:     PetscLayout            nmap = NULL;

7572:     PetscLayoutDuplicate(mat->cmap,&nmap);
7573:     if (mat->cmap->mapping) {
7574:       ISLocalToGlobalMappingDuplicate(mat->cmap->mapping,&l2g);
7575:     }
7576:     PetscLayoutDestroy(&mat->cmap);
7577:     mat->cmap = nmap;
7578:     mat->cmap->mapping = l2g;
7579:   }
7580:   PetscLayoutSetBlockSize(mat->rmap,rbs);
7581:   PetscLayoutSetBlockSize(mat->cmap,cbs);
7582:   return(0);
7583: }

7585: /*@
7586:    MatSetBlockSizesFromMats - Sets the matrix block row and column sizes to match a pair of matrices

7588:    Logically Collective on Mat

7590:    Input Parameters:
7591: +  mat - the matrix
7592: .  fromRow - matrix from which to copy row block size
7593: -  fromCol - matrix from which to copy column block size (can be same as fromRow)

7595:    Level: developer

7597: .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSizes()
7598: @*/
7599: PetscErrorCode MatSetBlockSizesFromMats(Mat mat,Mat fromRow,Mat fromCol)
7600: {

7607:   if (fromRow->rmap->bs > 0) {PetscLayoutSetBlockSize(mat->rmap,fromRow->rmap->bs);}
7608:   if (fromCol->cmap->bs > 0) {PetscLayoutSetBlockSize(mat->cmap,fromCol->cmap->bs);}
7609:   return(0);
7610: }

7612: /*@
7613:    MatResidual - Default routine to calculate the residual.

7615:    Collective on Mat

7617:    Input Parameters:
7618: +  mat - the matrix
7619: .  b   - the right-hand-side
7620: -  x   - the approximate solution

7622:    Output Parameter:
7623: .  r - location to store the residual

7625:    Level: developer

7627: .seealso: PCMGSetResidual()
7628: @*/
7629: PetscErrorCode MatResidual(Mat mat,Vec b,Vec x,Vec r)
7630: {

7639:   MatCheckPreallocated(mat,1);
7640:   PetscLogEventBegin(MAT_Residual,mat,0,0,0);
7641:   if (!mat->ops->residual) {
7642:     MatMult(mat,x,r);
7643:     VecAYPX(r,-1.0,b);
7644:   } else {
7645:     (*mat->ops->residual)(mat,b,x,r);
7646:   }
7647:   PetscLogEventEnd(MAT_Residual,mat,0,0,0);
7648:   return(0);
7649: }

7651: /*@C
7652:     MatGetRowIJ - Returns the compressed row storage i and j indices for sequential matrices.

7654:    Collective on Mat

7656:     Input Parameters:
7657: +   mat - the matrix
7658: .   shift -  0 or 1 indicating we want the indices starting at 0 or 1
7659: .   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be   symmetrized
7660: -   inodecompressed - PETSC_TRUE or PETSC_FALSE  indicating if the nonzero structure of the
7661:                  inodes or the nonzero elements is wanted. For BAIJ matrices the compressed version is
7662:                  always used.

7664:     Output Parameters:
7665: +   n - number of rows in the (possibly compressed) matrix
7666: .   ia - the row pointers; that is ia[0] = 0, ia[row] = ia[row-1] + number of elements in that row of the matrix
7667: .   ja - the column indices
7668: -   done - indicates if the routine actually worked and returned appropriate ia[] and ja[] arrays; callers
7669:            are responsible for handling the case when done == PETSC_FALSE and ia and ja are not set

7671:     Level: developer

7673:     Notes:
7674:     You CANNOT change any of the ia[] or ja[] values.

7676:     Use MatRestoreRowIJ() when you are finished accessing the ia[] and ja[] values.

7678:     Fortran Notes:
7679:     In Fortran use
7680: $
7681: $      PetscInt ia(1), ja(1)
7682: $      PetscOffset iia, jja
7683: $      call MatGetRowIJ(mat,shift,symmetric,inodecompressed,n,ia,iia,ja,jja,done,ierr)
7684: $      ! Access the ith and jth entries via ia(iia + i) and ja(jja + j)

7686:      or
7687: $
7688: $    PetscInt, pointer :: ia(:),ja(:)
7689: $    call MatGetRowIJF90(mat,shift,symmetric,inodecompressed,n,ia,ja,done,ierr)
7690: $    ! Access the ith and jth entries via ia(i) and ja(j)

7692: .seealso: MatGetColumnIJ(), MatRestoreRowIJ(), MatSeqAIJGetArray()
7693: @*/
7694: PetscErrorCode MatGetRowIJ(Mat mat,PetscInt shift,PetscBool symmetric,PetscBool inodecompressed,PetscInt *n,const PetscInt *ia[],const PetscInt *ja[],PetscBool  *done)
7695: {

7705:   MatCheckPreallocated(mat,1);
7706:   if (!mat->ops->getrowij) *done = PETSC_FALSE;
7707:   else {
7708:     *done = PETSC_TRUE;
7709:     PetscLogEventBegin(MAT_GetRowIJ,mat,0,0,0);
7710:     (*mat->ops->getrowij)(mat,shift,symmetric,inodecompressed,n,ia,ja,done);
7711:     PetscLogEventEnd(MAT_GetRowIJ,mat,0,0,0);
7712:   }
7713:   return(0);
7714: }

7716: /*@C
7717:     MatGetColumnIJ - Returns the compressed column storage i and j indices for sequential matrices.

7719:     Collective on Mat

7721:     Input Parameters:
7722: +   mat - the matrix
7723: .   shift - 1 or zero indicating we want the indices starting at 0 or 1
7724: .   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
7725:                 symmetrized
7726: .   inodecompressed - PETSC_TRUE or PETSC_FALSE indicating if the nonzero structure of the
7727:                  inodes or the nonzero elements is wanted. For BAIJ matrices the compressed version is
7728:                  always used.
7729: .   n - number of columns in the (possibly compressed) matrix
7730: .   ia - the column pointers; that is ia[0] = 0, ia[col] = i[col-1] + number of elements in that col of the matrix
7731: -   ja - the row indices

7733:     Output Parameters:
7734: .   done - PETSC_TRUE or PETSC_FALSE, indicating whether the values have been returned

7736:     Level: developer

7738: .seealso: MatGetRowIJ(), MatRestoreColumnIJ()
7739: @*/
7740: PetscErrorCode MatGetColumnIJ(Mat mat,PetscInt shift,PetscBool symmetric,PetscBool inodecompressed,PetscInt *n,const PetscInt *ia[],const PetscInt *ja[],PetscBool  *done)
7741: {

7751:   MatCheckPreallocated(mat,1);
7752:   if (!mat->ops->getcolumnij) *done = PETSC_FALSE;
7753:   else {
7754:     *done = PETSC_TRUE;
7755:     (*mat->ops->getcolumnij)(mat,shift,symmetric,inodecompressed,n,ia,ja,done);
7756:   }
7757:   return(0);
7758: }

7760: /*@C
7761:     MatRestoreRowIJ - Call after you are completed with the ia,ja indices obtained with
7762:     MatGetRowIJ().

7764:     Collective on Mat

7766:     Input Parameters:
7767: +   mat - the matrix
7768: .   shift - 1 or zero indicating we want the indices starting at 0 or 1
7769: .   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
7770:                 symmetrized
7771: .   inodecompressed -  PETSC_TRUE or PETSC_FALSE indicating if the nonzero structure of the
7772:                  inodes or the nonzero elements is wanted. For BAIJ matrices the compressed version is
7773:                  always used.
7774: .   n - size of (possibly compressed) matrix
7775: .   ia - the row pointers
7776: -   ja - the column indices

7778:     Output Parameters:
7779: .   done - PETSC_TRUE or PETSC_FALSE indicated that the values have been returned

7781:     Note:
7782:     This routine zeros out n, ia, and ja. This is to prevent accidental
7783:     us of the array after it has been restored. If you pass NULL, it will
7784:     not zero the pointers.  Use of ia or ja after MatRestoreRowIJ() is invalid.

7786:     Level: developer

7788: .seealso: MatGetRowIJ(), MatRestoreColumnIJ()
7789: @*/
7790: PetscErrorCode MatRestoreRowIJ(Mat mat,PetscInt shift,PetscBool symmetric,PetscBool inodecompressed,PetscInt *n,const PetscInt *ia[],const PetscInt *ja[],PetscBool  *done)
7791: {

7800:   MatCheckPreallocated(mat,1);

7802:   if (!mat->ops->restorerowij) *done = PETSC_FALSE;
7803:   else {
7804:     *done = PETSC_TRUE;
7805:     (*mat->ops->restorerowij)(mat,shift,symmetric,inodecompressed,n,ia,ja,done);
7806:     if (n)  *n = 0;
7807:     if (ia) *ia = NULL;
7808:     if (ja) *ja = NULL;
7809:   }
7810:   return(0);
7811: }

7813: /*@C
7814:     MatRestoreColumnIJ - Call after you are completed with the ia,ja indices obtained with
7815:     MatGetColumnIJ().

7817:     Collective on Mat

7819:     Input Parameters:
7820: +   mat - the matrix
7821: .   shift - 1 or zero indicating we want the indices starting at 0 or 1
7822: -   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
7823:                 symmetrized
7824: -   inodecompressed - PETSC_TRUE or PETSC_FALSE indicating if the nonzero structure of the
7825:                  inodes or the nonzero elements is wanted. For BAIJ matrices the compressed version is
7826:                  always used.

7828:     Output Parameters:
7829: +   n - size of (possibly compressed) matrix
7830: .   ia - the column pointers
7831: .   ja - the row indices
7832: -   done - PETSC_TRUE or PETSC_FALSE indicated that the values have been returned

7834:     Level: developer

7836: .seealso: MatGetColumnIJ(), MatRestoreRowIJ()
7837: @*/
7838: PetscErrorCode MatRestoreColumnIJ(Mat mat,PetscInt shift,PetscBool symmetric,PetscBool inodecompressed,PetscInt *n,const PetscInt *ia[],const PetscInt *ja[],PetscBool  *done)
7839: {

7848:   MatCheckPreallocated(mat,1);

7850:   if (!mat->ops->restorecolumnij) *done = PETSC_FALSE;
7851:   else {
7852:     *done = PETSC_TRUE;
7853:     (*mat->ops->restorecolumnij)(mat,shift,symmetric,inodecompressed,n,ia,ja,done);
7854:     if (n)  *n = 0;
7855:     if (ia) *ia = NULL;
7856:     if (ja) *ja = NULL;
7857:   }
7858:   return(0);
7859: }

7861: /*@C
7862:     MatColoringPatch -Used inside matrix coloring routines that
7863:     use MatGetRowIJ() and/or MatGetColumnIJ().

7865:     Collective on Mat

7867:     Input Parameters:
7868: +   mat - the matrix
7869: .   ncolors - max color value
7870: .   n   - number of entries in colorarray
7871: -   colorarray - array indicating color for each column

7873:     Output Parameters:
7874: .   iscoloring - coloring generated using colorarray information

7876:     Level: developer

7878: .seealso: MatGetRowIJ(), MatGetColumnIJ()

7880: @*/
7881: PetscErrorCode MatColoringPatch(Mat mat,PetscInt ncolors,PetscInt n,ISColoringValue colorarray[],ISColoring *iscoloring)
7882: {

7890:   MatCheckPreallocated(mat,1);

7892:   if (!mat->ops->coloringpatch) {
7893:     ISColoringCreate(PetscObjectComm((PetscObject)mat),ncolors,n,colorarray,PETSC_OWN_POINTER,iscoloring);
7894:   } else {
7895:     (*mat->ops->coloringpatch)(mat,ncolors,n,colorarray,iscoloring);
7896:   }
7897:   return(0);
7898: }


7901: /*@
7902:    MatSetUnfactored - Resets a factored matrix to be treated as unfactored.

7904:    Logically Collective on Mat

7906:    Input Parameter:
7907: .  mat - the factored matrix to be reset

7909:    Notes:
7910:    This routine should be used only with factored matrices formed by in-place
7911:    factorization via ILU(0) (or by in-place LU factorization for the MATSEQDENSE
7912:    format).  This option can save memory, for example, when solving nonlinear
7913:    systems with a matrix-free Newton-Krylov method and a matrix-based, in-place
7914:    ILU(0) preconditioner.

7916:    Note that one can specify in-place ILU(0) factorization by calling
7917: .vb
7918:      PCType(pc,PCILU);
7919:      PCFactorSeUseInPlace(pc);
7920: .ve
7921:    or by using the options -pc_type ilu -pc_factor_in_place

7923:    In-place factorization ILU(0) can also be used as a local
7924:    solver for the blocks within the block Jacobi or additive Schwarz
7925:    methods (runtime option: -sub_pc_factor_in_place).  See Users-Manual: ch_pc
7926:    for details on setting local solver options.

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

7932:    Level: developer

7934: .seealso: PCFactorSetUseInPlace(), PCFactorGetUseInPlace()

7936: @*/
7937: PetscErrorCode MatSetUnfactored(Mat mat)
7938: {

7944:   MatCheckPreallocated(mat,1);
7945:   mat->factortype = MAT_FACTOR_NONE;
7946:   if (!mat->ops->setunfactored) return(0);
7947:   (*mat->ops->setunfactored)(mat);
7948:   return(0);
7949: }

7951: /*MC
7952:     MatDenseGetArrayF90 - Accesses a matrix array from Fortran90.

7954:     Synopsis:
7955:     MatDenseGetArrayF90(Mat x,{Scalar, pointer :: xx_v(:,:)},integer ierr)

7957:     Not collective

7959:     Input Parameter:
7960: .   x - matrix

7962:     Output Parameters:
7963: +   xx_v - the Fortran90 pointer to the array
7964: -   ierr - error code

7966:     Example of Usage:
7967: .vb
7968:       PetscScalar, pointer xx_v(:,:)
7969:       ....
7970:       call MatDenseGetArrayF90(x,xx_v,ierr)
7971:       a = xx_v(3)
7972:       call MatDenseRestoreArrayF90(x,xx_v,ierr)
7973: .ve

7975:     Level: advanced

7977: .seealso:  MatDenseRestoreArrayF90(), MatDenseGetArray(), MatDenseRestoreArray(), MatSeqAIJGetArrayF90()

7979: M*/

7981: /*MC
7982:     MatDenseRestoreArrayF90 - Restores a matrix array that has been
7983:     accessed with MatDenseGetArrayF90().

7985:     Synopsis:
7986:     MatDenseRestoreArrayF90(Mat x,{Scalar, pointer :: xx_v(:,:)},integer ierr)

7988:     Not collective

7990:     Input Parameters:
7991: +   x - matrix
7992: -   xx_v - the Fortran90 pointer to the array

7994:     Output Parameter:
7995: .   ierr - error code

7997:     Example of Usage:
7998: .vb
7999:        PetscScalar, pointer xx_v(:,:)
8000:        ....
8001:        call MatDenseGetArrayF90(x,xx_v,ierr)
8002:        a = xx_v(3)
8003:        call MatDenseRestoreArrayF90(x,xx_v,ierr)
8004: .ve

8006:     Level: advanced

8008: .seealso:  MatDenseGetArrayF90(), MatDenseGetArray(), MatDenseRestoreArray(), MatSeqAIJRestoreArrayF90()

8010: M*/


8013: /*MC
8014:     MatSeqAIJGetArrayF90 - Accesses a matrix array from Fortran90.

8016:     Synopsis:
8017:     MatSeqAIJGetArrayF90(Mat x,{Scalar, pointer :: xx_v(:)},integer ierr)

8019:     Not collective

8021:     Input Parameter:
8022: .   x - matrix

8024:     Output Parameters:
8025: +   xx_v - the Fortran90 pointer to the array
8026: -   ierr - error code

8028:     Example of Usage:
8029: .vb
8030:       PetscScalar, pointer xx_v(:)
8031:       ....
8032:       call MatSeqAIJGetArrayF90(x,xx_v,ierr)
8033:       a = xx_v(3)
8034:       call MatSeqAIJRestoreArrayF90(x,xx_v,ierr)
8035: .ve

8037:     Level: advanced

8039: .seealso:  MatSeqAIJRestoreArrayF90(), MatSeqAIJGetArray(), MatSeqAIJRestoreArray(), MatDenseGetArrayF90()

8041: M*/

8043: /*MC
8044:     MatSeqAIJRestoreArrayF90 - Restores a matrix array that has been
8045:     accessed with MatSeqAIJGetArrayF90().

8047:     Synopsis:
8048:     MatSeqAIJRestoreArrayF90(Mat x,{Scalar, pointer :: xx_v(:)},integer ierr)

8050:     Not collective

8052:     Input Parameters:
8053: +   x - matrix
8054: -   xx_v - the Fortran90 pointer to the array

8056:     Output Parameter:
8057: .   ierr - error code

8059:     Example of Usage:
8060: .vb
8061:        PetscScalar, pointer xx_v(:)
8062:        ....
8063:        call MatSeqAIJGetArrayF90(x,xx_v,ierr)
8064:        a = xx_v(3)
8065:        call MatSeqAIJRestoreArrayF90(x,xx_v,ierr)
8066: .ve

8068:     Level: advanced

8070: .seealso:  MatSeqAIJGetArrayF90(), MatSeqAIJGetArray(), MatSeqAIJRestoreArray(), MatDenseRestoreArrayF90()

8072: M*/


8075: /*@
8076:     MatCreateSubMatrix - Gets a single submatrix on the same number of processors
8077:                       as the original matrix.

8079:     Collective on Mat

8081:     Input Parameters:
8082: +   mat - the original matrix
8083: .   isrow - parallel IS containing the rows this processor should obtain
8084: .   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.
8085: -   cll - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX

8087:     Output Parameter:
8088: .   newmat - the new submatrix, of the same type as the old

8090:     Level: advanced

8092:     Notes:
8093:     The submatrix will be able to be multiplied with vectors using the same layout as iscol.

8095:     Some matrix types place restrictions on the row and column indices, such
8096:     as that they be sorted or that they be equal to each other.

8098:     The index sets may not have duplicate entries.

8100:       The first time this is called you should use a cll of MAT_INITIAL_MATRIX,
8101:    the MatCreateSubMatrix() routine will create the newmat for you. Any additional calls
8102:    to this routine with a mat of the same nonzero structure and with a call of MAT_REUSE_MATRIX
8103:    will reuse the matrix generated the first time.  You should call MatDestroy() on newmat when
8104:    you are finished using it.

8106:     The communicator of the newly obtained matrix is ALWAYS the same as the communicator of
8107:     the input matrix.

8109:     If iscol is NULL then all columns are obtained (not supported in Fortran).

8111:    Example usage:
8112:    Consider the following 8x8 matrix with 34 non-zero values, that is
8113:    assembled across 3 processors. Let's assume that proc0 owns 3 rows,
8114:    proc1 owns 3 rows, proc2 owns 2 rows. This division can be shown
8115:    as follows:

8117: .vb
8118:             1  2  0  |  0  3  0  |  0  4
8119:     Proc0   0  5  6  |  7  0  0  |  8  0
8120:             9  0 10  | 11  0  0  | 12  0
8121:     -------------------------------------
8122:            13  0 14  | 15 16 17  |  0  0
8123:     Proc1   0 18  0  | 19 20 21  |  0  0
8124:             0  0  0  | 22 23  0  | 24  0
8125:     -------------------------------------
8126:     Proc2  25 26 27  |  0  0 28  | 29  0
8127:            30  0  0  | 31 32 33  |  0 34
8128: .ve

8130:     Suppose isrow = [0 1 | 4 | 6 7] and iscol = [1 2 | 3 4 5 | 6].  The resulting submatrix is

8132: .vb
8133:             2  0  |  0  3  0  |  0
8134:     Proc0   5  6  |  7  0  0  |  8
8135:     -------------------------------
8136:     Proc1  18  0  | 19 20 21  |  0
8137:     -------------------------------
8138:     Proc2  26 27  |  0  0 28  | 29
8139:             0  0  | 31 32 33  |  0
8140: .ve


8143: .seealso: MatCreateSubMatrices(), MatCreateSubMatricesMPI(), MatCreateSubMatrixVirtual(), MatSubMatrixVirtualUpdate()
8144: @*/
8145: PetscErrorCode MatCreateSubMatrix(Mat mat,IS isrow,IS iscol,MatReuse cll,Mat *newmat)
8146: {
8148:   PetscMPIInt    size;
8149:   Mat            *local;
8150:   IS             iscoltmp;
8151:   PetscBool      flg;

8160:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8161:   if (cll == MAT_IGNORE_MATRIX) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Cannot use MAT_IGNORE_MATRIX");

8163:   MatCheckPreallocated(mat,1);
8164:   MPI_Comm_size(PetscObjectComm((PetscObject)mat),&size);

8166:   if (!iscol || isrow == iscol) {
8167:     PetscBool   stride;
8168:     PetscMPIInt grabentirematrix = 0,grab;
8169:     PetscObjectTypeCompare((PetscObject)isrow,ISSTRIDE,&stride);
8170:     if (stride) {
8171:       PetscInt first,step,n,rstart,rend;
8172:       ISStrideGetInfo(isrow,&first,&step);
8173:       if (step == 1) {
8174:         MatGetOwnershipRange(mat,&rstart,&rend);
8175:         if (rstart == first) {
8176:           ISGetLocalSize(isrow,&n);
8177:           if (n == rend-rstart) {
8178:             grabentirematrix = 1;
8179:           }
8180:         }
8181:       }
8182:     }
8183:     MPIU_Allreduce(&grabentirematrix,&grab,1,MPI_INT,MPI_MIN,PetscObjectComm((PetscObject)mat));
8184:     if (grab) {
8185:       PetscInfo(mat,"Getting entire matrix as submatrix\n");
8186:       if (cll == MAT_INITIAL_MATRIX) {
8187:         *newmat = mat;
8188:         PetscObjectReference((PetscObject)mat);
8189:       }
8190:       return(0);
8191:     }
8192:   }

8194:   if (!iscol) {
8195:     ISCreateStride(PetscObjectComm((PetscObject)mat),mat->cmap->n,mat->cmap->rstart,1,&iscoltmp);
8196:   } else {
8197:     iscoltmp = iscol;
8198:   }

8200:   /* if original matrix is on just one processor then use submatrix generated */
8201:   if (mat->ops->createsubmatrices && !mat->ops->createsubmatrix && size == 1 && cll == MAT_REUSE_MATRIX) {
8202:     MatCreateSubMatrices(mat,1,&isrow,&iscoltmp,MAT_REUSE_MATRIX,&newmat);
8203:     goto setproperties;
8204:   } else if (mat->ops->createsubmatrices && !mat->ops->createsubmatrix && size == 1) {
8205:     MatCreateSubMatrices(mat,1,&isrow,&iscoltmp,MAT_INITIAL_MATRIX,&local);
8206:     *newmat = *local;
8207:     PetscFree(local);
8208:     goto setproperties;
8209:   } else if (!mat->ops->createsubmatrix) {
8210:     /* Create a new matrix type that implements the operation using the full matrix */
8211:     PetscLogEventBegin(MAT_CreateSubMat,mat,0,0,0);
8212:     switch (cll) {
8213:     case MAT_INITIAL_MATRIX:
8214:       MatCreateSubMatrixVirtual(mat,isrow,iscoltmp,newmat);
8215:       break;
8216:     case MAT_REUSE_MATRIX:
8217:       MatSubMatrixVirtualUpdate(*newmat,mat,isrow,iscoltmp);
8218:       break;
8219:     default: SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Invalid MatReuse, must be either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX");
8220:     }
8221:     PetscLogEventEnd(MAT_CreateSubMat,mat,0,0,0);
8222:     goto setproperties;
8223:   }

8225:   if (!mat->ops->createsubmatrix) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
8226:   PetscLogEventBegin(MAT_CreateSubMat,mat,0,0,0);
8227:   (*mat->ops->createsubmatrix)(mat,isrow,iscoltmp,cll,newmat);
8228:   PetscLogEventEnd(MAT_CreateSubMat,mat,0,0,0);

8230: setproperties:
8231:   ISEqualUnsorted(isrow,iscoltmp,&flg);
8232:   if (flg) {
8233:     MatPropagateSymmetryOptions(mat,*newmat);
8234:   }
8235:   if (!iscol) {ISDestroy(&iscoltmp);}
8236:   if (*newmat && cll == MAT_INITIAL_MATRIX) {PetscObjectStateIncrease((PetscObject)*newmat);}
8237:   return(0);
8238: }

8240: /*@
8241:    MatPropagateSymmetryOptions - Propagates symmetry options set on a matrix to another matrix

8243:    Not Collective

8245:    Input Parameters:
8246: +  A - the matrix we wish to propagate options from
8247: -  B - the matrix we wish to propagate options to

8249:    Level: beginner

8251:    Notes: Propagates the options associated to MAT_SYMMETRY_ETERNAL, MAT_STRUCTURALLY_SYMMETRIC, MAT_HERMITIAN, MAT_SPD and MAT_SYMMETRIC

8253: .seealso: MatSetOption()
8254: @*/
8255: PetscErrorCode MatPropagateSymmetryOptions(Mat A, Mat B)
8256: {

8262:   if (A->symmetric_eternal) { /* symmetric_eternal does not have a corresponding *set flag */
8263:     MatSetOption(B,MAT_SYMMETRY_ETERNAL,A->symmetric_eternal);
8264:   }
8265:   if (A->structurally_symmetric_set) {
8266:     MatSetOption(B,MAT_STRUCTURALLY_SYMMETRIC,A->structurally_symmetric);
8267:   }
8268:   if (A->hermitian_set) {
8269:     MatSetOption(B,MAT_HERMITIAN,A->hermitian);
8270:   }
8271:   if (A->spd_set) {
8272:     MatSetOption(B,MAT_SPD,A->spd);
8273:   }
8274:   if (A->symmetric_set) {
8275:     MatSetOption(B,MAT_SYMMETRIC,A->symmetric);
8276:   }
8277:   return(0);
8278: }

8280: /*@
8281:    MatStashSetInitialSize - sets the sizes of the matrix stash, that is
8282:    used during the assembly process to store values that belong to
8283:    other processors.

8285:    Not Collective

8287:    Input Parameters:
8288: +  mat   - the matrix
8289: .  size  - the initial size of the stash.
8290: -  bsize - the initial size of the block-stash(if used).

8292:    Options Database Keys:
8293: +   -matstash_initial_size <size> or <size0,size1,...sizep-1>
8294: -   -matstash_block_initial_size <bsize>  or <bsize0,bsize1,...bsizep-1>

8296:    Level: intermediate

8298:    Notes:
8299:      The block-stash is used for values set with MatSetValuesBlocked() while
8300:      the stash is used for values set with MatSetValues()

8302:      Run with the option -info and look for output of the form
8303:      MatAssemblyBegin_MPIXXX:Stash has MM entries, uses nn mallocs.
8304:      to determine the appropriate value, MM, to use for size and
8305:      MatAssemblyBegin_MPIXXX:Block-Stash has BMM entries, uses nn mallocs.
8306:      to determine the value, BMM to use for bsize


8309: .seealso: MatAssemblyBegin(), MatAssemblyEnd(), Mat, MatStashGetInfo()

8311: @*/
8312: PetscErrorCode MatStashSetInitialSize(Mat mat,PetscInt size, PetscInt bsize)
8313: {

8319:   MatStashSetInitialSize_Private(&mat->stash,size);
8320:   MatStashSetInitialSize_Private(&mat->bstash,bsize);
8321:   return(0);
8322: }

8324: /*@
8325:    MatInterpolateAdd - w = y + A*x or A'*x depending on the shape of
8326:      the matrix

8328:    Neighbor-wise Collective on Mat

8330:    Input Parameters:
8331: +  mat   - the matrix
8332: .  x,y - the vectors
8333: -  w - where the result is stored

8335:    Level: intermediate

8337:    Notes:
8338:     w may be the same vector as y.

8340:     This allows one to use either the restriction or interpolation (its transpose)
8341:     matrix to do the interpolation

8343: .seealso: MatMultAdd(), MatMultTransposeAdd(), MatRestrict()

8345: @*/
8346: PetscErrorCode MatInterpolateAdd(Mat A,Vec x,Vec y,Vec w)
8347: {
8349:   PetscInt       M,N,Ny;

8356:   MatGetSize(A,&M,&N);
8357:   VecGetSize(y,&Ny);
8358:   if (M == Ny) {
8359:     MatMultAdd(A,x,y,w);
8360:   } else {
8361:     MatMultTransposeAdd(A,x,y,w);
8362:   }
8363:   return(0);
8364: }

8366: /*@
8367:    MatInterpolate - y = A*x or A'*x depending on the shape of
8368:      the matrix

8370:    Neighbor-wise Collective on Mat

8372:    Input Parameters:
8373: +  mat   - the matrix
8374: -  x,y - the vectors

8376:    Level: intermediate

8378:    Notes:
8379:     This allows one to use either the restriction or interpolation (its transpose)
8380:     matrix to do the interpolation

8382: .seealso: MatMultAdd(), MatMultTransposeAdd(), MatRestrict()

8384: @*/
8385: PetscErrorCode MatInterpolate(Mat A,Vec x,Vec y)
8386: {
8388:   PetscInt       M,N,Ny;

8394:   MatGetSize(A,&M,&N);
8395:   VecGetSize(y,&Ny);
8396:   if (M == Ny) {
8397:     MatMult(A,x,y);
8398:   } else {
8399:     MatMultTranspose(A,x,y);
8400:   }
8401:   return(0);
8402: }

8404: /*@
8405:    MatRestrict - y = A*x or A'*x

8407:    Neighbor-wise Collective on Mat

8409:    Input Parameters:
8410: +  mat   - the matrix
8411: -  x,y - the vectors

8413:    Level: intermediate

8415:    Notes:
8416:     This allows one to use either the restriction or interpolation (its transpose)
8417:     matrix to do the restriction

8419: .seealso: MatMultAdd(), MatMultTransposeAdd(), MatInterpolate()

8421: @*/
8422: PetscErrorCode MatRestrict(Mat A,Vec x,Vec y)
8423: {
8425:   PetscInt       M,N,Ny;

8431:   MatGetSize(A,&M,&N);
8432:   VecGetSize(y,&Ny);
8433:   if (M == Ny) {
8434:     MatMult(A,x,y);
8435:   } else {
8436:     MatMultTranspose(A,x,y);
8437:   }
8438:   return(0);
8439: }

8441: /*@
8442:    MatMatInterpolateAdd - Y = W + A*X or W + A'*X

8444:    Neighbor-wise Collective on Mat

8446:    Input Parameters:
8447: +  mat   - the matrix
8448: -  w, x - the input dense matrices

8450:    Output Parameters:
8451: .  y - the output dense matrix

8453:    Level: intermediate

8455:    Notes:
8456:     This allows one to use either the restriction or interpolation (its transpose)
8457:     matrix to do the interpolation. y matrix can be reused if already created with the proper sizes,
8458:     otherwise it will be recreated. y must be initialized to NULL if not supplied.

8460: .seealso: MatInterpolateAdd(), MatMatInterpolate(), MatMatRestrict()

8462: @*/
8463: PetscErrorCode MatMatInterpolateAdd(Mat A,Mat x,Mat w,Mat *y)
8464: {
8466:   PetscInt       M,N,Mx,Nx,Mo,My = 0,Ny = 0;
8467:   PetscBool      trans = PETSC_TRUE;
8468:   MatReuse       reuse = MAT_INITIAL_MATRIX;

8476:   MatGetSize(A,&M,&N);
8477:   MatGetSize(x,&Mx,&Nx);
8478:   if (N == Mx) trans = PETSC_FALSE;
8479:   else if (M != Mx) SETERRQ4(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Size mismatch: A %Dx%D, X %Dx%D",M,N,Mx,Nx);
8480:   Mo = trans ? N : M;
8481:   if (*y) {
8482:     MatGetSize(*y,&My,&Ny);
8483:     if (Mo == My && Nx == Ny) { reuse = MAT_REUSE_MATRIX; }
8484:     else {
8485:       if (w && *y == w) SETERRQ6(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Cannot reuse y and w, size mismatch: A %Dx%D, X %Dx%D, Y %Dx%D",M,N,Mx,Nx,My,Ny);
8486:       MatDestroy(y);
8487:     }
8488:   }

8490:   if (w && *y == w) { /* this is to minimize changes in PCMG */
8491:     PetscBool flg;

8493:     PetscObjectQuery((PetscObject)*y,"__MatMatIntAdd_w",(PetscObject*)&w);
8494:     if (w) {
8495:       PetscInt My,Ny,Mw,Nw;

8497:       PetscObjectTypeCompare((PetscObject)*y,((PetscObject)w)->type_name,&flg);
8498:       MatGetSize(*y,&My,&Ny);
8499:       MatGetSize(w,&Mw,&Nw);
8500:       if (!flg || My != Mw || Ny != Nw) w = NULL;
8501:     }
8502:     if (!w) {
8503:       MatDuplicate(*y,MAT_COPY_VALUES,&w);
8504:       PetscObjectCompose((PetscObject)*y,"__MatMatIntAdd_w",(PetscObject)w);
8505:       PetscLogObjectParent((PetscObject)*y,(PetscObject)w);
8506:       PetscObjectDereference((PetscObject)w);
8507:     } else {
8508:       MatCopy(*y,w,UNKNOWN_NONZERO_PATTERN);
8509:     }
8510:   }
8511:   if (!trans) {
8512:     MatMatMult(A,x,reuse,PETSC_DEFAULT,y);
8513:   } else {
8514:     MatTransposeMatMult(A,x,reuse,PETSC_DEFAULT,y);
8515:   }
8516:   if (w) {
8517:     MatAXPY(*y,1.0,w,UNKNOWN_NONZERO_PATTERN);
8518:   }
8519:   return(0);
8520: }

8522: /*@
8523:    MatMatInterpolate - Y = A*X or A'*X

8525:    Neighbor-wise Collective on Mat

8527:    Input Parameters:
8528: +  mat   - the matrix
8529: -  x - the input dense matrix

8531:    Output Parameters:
8532: .  y - the output dense matrix


8535:    Level: intermediate

8537:    Notes:
8538:     This allows one to use either the restriction or interpolation (its transpose)
8539:     matrix to do the interpolation. y matrix can be reused if already created with the proper sizes,
8540:     otherwise it will be recreated. y must be initialized to NULL if not supplied.

8542: .seealso: MatInterpolate(), MatRestrict(), MatMatRestrict()

8544: @*/
8545: PetscErrorCode MatMatInterpolate(Mat A,Mat x,Mat *y)
8546: {

8550:   MatMatInterpolateAdd(A,x,NULL,y);
8551:   return(0);
8552: }

8554: /*@
8555:    MatMatRestrict - Y = A*X or A'*X

8557:    Neighbor-wise Collective on Mat

8559:    Input Parameters:
8560: +  mat   - the matrix
8561: -  x - the input dense matrix

8563:    Output Parameters:
8564: .  y - the output dense matrix


8567:    Level: intermediate

8569:    Notes:
8570:     This allows one to use either the restriction or interpolation (its transpose)
8571:     matrix to do the restriction. y matrix can be reused if already created with the proper sizes,
8572:     otherwise it will be recreated. y must be initialized to NULL if not supplied.

8574: .seealso: MatRestrict(), MatInterpolate(), MatMatInterpolate()
8575: @*/
8576: PetscErrorCode MatMatRestrict(Mat A,Mat x,Mat *y)
8577: {

8581:   MatMatInterpolateAdd(A,x,NULL,y);
8582:   return(0);
8583: }

8585: /*@
8586:    MatGetNullSpace - retrieves the null space of a matrix.

8588:    Logically Collective on Mat

8590:    Input Parameters:
8591: +  mat - the matrix
8592: -  nullsp - the null space object

8594:    Level: developer

8596: .seealso: MatCreate(), MatNullSpaceCreate(), MatSetNearNullSpace(), MatSetNullSpace()
8597: @*/
8598: PetscErrorCode MatGetNullSpace(Mat mat, MatNullSpace *nullsp)
8599: {
8603:   *nullsp = (mat->symmetric_set && mat->symmetric && !mat->nullsp) ? mat->transnullsp : mat->nullsp;
8604:   return(0);
8605: }

8607: /*@
8608:    MatSetNullSpace - attaches a null space to a matrix.

8610:    Logically Collective on Mat

8612:    Input Parameters:
8613: +  mat - the matrix
8614: -  nullsp - the null space object

8616:    Level: advanced

8618:    Notes:
8619:       This null space is used by the linear solvers. Overwrites any previous null space that may have been attached

8621:       For inconsistent singular systems (linear systems where the right hand side is not in the range of the operator) you also likely should
8622:       call MatSetTransposeNullSpace(). This allows the linear system to be solved in a least squares sense.

8624:       You can remove the null space by calling this routine with an nullsp of NULL


8627:       The fundamental theorem of linear algebra (Gilbert Strang, Introduction to Applied Mathematics, page 72) states that
8628:    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).
8629:    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
8630:    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
8631:    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).

8633:       Krylov solvers can produce the minimal norm solution to the least squares problem by utilizing MatNullSpaceRemove().

8635:     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
8636:     routine also automatically calls MatSetTransposeNullSpace().

8638: .seealso: MatCreate(), MatNullSpaceCreate(), MatSetNearNullSpace(), MatGetNullSpace(), MatSetTransposeNullSpace(), MatGetTransposeNullSpace(), MatNullSpaceRemove()
8639: @*/
8640: PetscErrorCode MatSetNullSpace(Mat mat,MatNullSpace nullsp)
8641: {

8647:   if (nullsp) {PetscObjectReference((PetscObject)nullsp);}
8648:   MatNullSpaceDestroy(&mat->nullsp);
8649:   mat->nullsp = nullsp;
8650:   if (mat->symmetric_set && mat->symmetric) {
8651:     MatSetTransposeNullSpace(mat,nullsp);
8652:   }
8653:   return(0);
8654: }

8656: /*@
8657:    MatGetTransposeNullSpace - retrieves the null space of the transpose of a matrix.

8659:    Logically Collective on Mat

8661:    Input Parameters:
8662: +  mat - the matrix
8663: -  nullsp - the null space object

8665:    Level: developer

8667: .seealso: MatCreate(), MatNullSpaceCreate(), MatSetNearNullSpace(), MatSetTransposeNullSpace(), MatSetNullSpace(), MatGetNullSpace()
8668: @*/
8669: PetscErrorCode MatGetTransposeNullSpace(Mat mat, MatNullSpace *nullsp)
8670: {
8675:   *nullsp = (mat->symmetric_set && mat->symmetric && !mat->transnullsp) ? mat->nullsp : mat->transnullsp;
8676:   return(0);
8677: }

8679: /*@
8680:    MatSetTransposeNullSpace - attaches a null space to a matrix.

8682:    Logically Collective on Mat

8684:    Input Parameters:
8685: +  mat - the matrix
8686: -  nullsp - the null space object

8688:    Level: advanced

8690:    Notes:
8691:       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.
8692:       You must also call MatSetNullSpace()


8695:       The fundamental theorem of linear algebra (Gilbert Strang, Introduction to Applied Mathematics, page 72) states that
8696:    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).
8697:    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
8698:    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
8699:    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).

8701:       Krylov solvers can produce the minimal norm solution to the least squares problem by utilizing MatNullSpaceRemove().

8703: .seealso: MatCreate(), MatNullSpaceCreate(), MatSetNearNullSpace(), MatGetNullSpace(), MatSetNullSpace(), MatGetTransposeNullSpace(), MatNullSpaceRemove()
8704: @*/
8705: PetscErrorCode MatSetTransposeNullSpace(Mat mat,MatNullSpace nullsp)
8706: {

8712:   if (nullsp) {PetscObjectReference((PetscObject)nullsp);}
8713:   MatNullSpaceDestroy(&mat->transnullsp);
8714:   mat->transnullsp = nullsp;
8715:   return(0);
8716: }

8718: /*@
8719:    MatSetNearNullSpace - attaches a null space to a matrix, which is often the null space (rigid body modes) of the operator without boundary conditions
8720:         This null space will be used to provide near null space vectors to a multigrid preconditioner built from this matrix.

8722:    Logically Collective on Mat

8724:    Input Parameters:
8725: +  mat - the matrix
8726: -  nullsp - the null space object

8728:    Level: advanced

8730:    Notes:
8731:       Overwrites any previous near null space that may have been attached

8733:       You can remove the null space by calling this routine with an nullsp of NULL

8735: .seealso: MatCreate(), MatNullSpaceCreate(), MatSetNullSpace(), MatNullSpaceCreateRigidBody(), MatGetNearNullSpace()
8736: @*/
8737: PetscErrorCode MatSetNearNullSpace(Mat mat,MatNullSpace nullsp)
8738: {

8745:   MatCheckPreallocated(mat,1);
8746:   if (nullsp) {PetscObjectReference((PetscObject)nullsp);}
8747:   MatNullSpaceDestroy(&mat->nearnullsp);
8748:   mat->nearnullsp = nullsp;
8749:   return(0);
8750: }

8752: /*@
8753:    MatGetNearNullSpace - Get null space attached with MatSetNearNullSpace()

8755:    Not Collective

8757:    Input Parameter:
8758: .  mat - the matrix

8760:    Output Parameter:
8761: .  nullsp - the null space object, NULL if not set

8763:    Level: developer

8765: .seealso: MatSetNearNullSpace(), MatGetNullSpace(), MatNullSpaceCreate()
8766: @*/
8767: PetscErrorCode MatGetNearNullSpace(Mat mat,MatNullSpace *nullsp)
8768: {
8773:   MatCheckPreallocated(mat,1);
8774:   *nullsp = mat->nearnullsp;
8775:   return(0);
8776: }

8778: /*@C
8779:    MatICCFactor - Performs in-place incomplete Cholesky factorization of matrix.

8781:    Collective on Mat

8783:    Input Parameters:
8784: +  mat - the matrix
8785: .  row - row/column permutation
8786: .  fill - expected fill factor >= 1.0
8787: -  level - level of fill, for ICC(k)

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

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

8797:    Level: developer


8800: .seealso: MatICCFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor()

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

8805: @*/
8806: PetscErrorCode MatICCFactor(Mat mat,IS row,const MatFactorInfo *info)
8807: {

8815:   if (mat->rmap->N != mat->cmap->N) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONG,"matrix must be square");
8816:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
8817:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8818:   if (!mat->ops->iccfactor) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
8819:   MatCheckPreallocated(mat,1);
8820:   (*mat->ops->iccfactor)(mat,row,info);
8821:   PetscObjectStateIncrease((PetscObject)mat);
8822:   return(0);
8823: }

8825: /*@
8826:    MatDiagonalScaleLocal - Scales columns of a matrix given the scaling values including the
8827:          ghosted ones.

8829:    Not Collective

8831:    Input Parameters:
8832: +  mat - the matrix
8833: -  diag = the diagonal values, including ghost ones

8835:    Level: developer

8837:    Notes:
8838:     Works only for MPIAIJ and MPIBAIJ matrices

8840: .seealso: MatDiagonalScale()
8841: @*/
8842: PetscErrorCode MatDiagonalScaleLocal(Mat mat,Vec diag)
8843: {
8845:   PetscMPIInt    size;


8852:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Matrix must be already assembled");
8853:   PetscLogEventBegin(MAT_Scale,mat,0,0,0);
8854:   MPI_Comm_size(PetscObjectComm((PetscObject)mat),&size);
8855:   if (size == 1) {
8856:     PetscInt n,m;
8857:     VecGetSize(diag,&n);
8858:     MatGetSize(mat,NULL,&m);
8859:     if (m == n) {
8860:       MatDiagonalScale(mat,NULL,diag);
8861:     } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Only supported for sequential matrices when no ghost points/periodic conditions");
8862:   } else {
8863:     PetscUseMethod(mat,"MatDiagonalScaleLocal_C",(Mat,Vec),(mat,diag));
8864:   }
8865:   PetscLogEventEnd(MAT_Scale,mat,0,0,0);
8866:   PetscObjectStateIncrease((PetscObject)mat);
8867:   return(0);
8868: }

8870: /*@
8871:    MatGetInertia - Gets the inertia from a factored matrix

8873:    Collective on Mat

8875:    Input Parameter:
8876: .  mat - the matrix

8878:    Output Parameters:
8879: +   nneg - number of negative eigenvalues
8880: .   nzero - number of zero eigenvalues
8881: -   npos - number of positive eigenvalues

8883:    Level: advanced

8885:    Notes:
8886:     Matrix must have been factored by MatCholeskyFactor()


8889: @*/
8890: PetscErrorCode MatGetInertia(Mat mat,PetscInt *nneg,PetscInt *nzero,PetscInt *npos)
8891: {

8897:   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
8898:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Numeric factor mat is not assembled");
8899:   if (!mat->ops->getinertia) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
8900:   (*mat->ops->getinertia)(mat,nneg,nzero,npos);
8901:   return(0);
8902: }

8904: /* ----------------------------------------------------------------*/
8905: /*@C
8906:    MatSolves - Solves A x = b, given a factored matrix, for a collection of vectors

8908:    Neighbor-wise Collective on Mats

8910:    Input Parameters:
8911: +  mat - the factored matrix
8912: -  b - the right-hand-side vectors

8914:    Output Parameter:
8915: .  x - the result vectors

8917:    Notes:
8918:    The vectors b and x cannot be the same.  I.e., one cannot
8919:    call MatSolves(A,x,x).

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

8926:    Level: developer

8928: .seealso: MatSolveAdd(), MatSolveTranspose(), MatSolveTransposeAdd(), MatSolve()
8929: @*/
8930: PetscErrorCode MatSolves(Mat mat,Vecs b,Vecs x)
8931: {

8937:   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
8938:   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
8939:   if (!mat->rmap->N && !mat->cmap->N) return(0);

8941:   if (!mat->ops->solves) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
8942:   MatCheckPreallocated(mat,1);
8943:   PetscLogEventBegin(MAT_Solves,mat,0,0,0);
8944:   (*mat->ops->solves)(mat,b,x);
8945:   PetscLogEventEnd(MAT_Solves,mat,0,0,0);
8946:   return(0);
8947: }

8949: /*@
8950:    MatIsSymmetric - Test whether a matrix is symmetric

8952:    Collective on Mat

8954:    Input Parameter:
8955: +  A - the matrix to test
8956: -  tol - difference between value and its transpose less than this amount counts as equal (use 0.0 for exact transpose)

8958:    Output Parameters:
8959: .  flg - the result

8961:    Notes:
8962:     For real numbers MatIsSymmetric() and MatIsHermitian() return identical results

8964:    Level: intermediate

8966: .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetricKnown()
8967: @*/
8968: PetscErrorCode MatIsSymmetric(Mat A,PetscReal tol,PetscBool  *flg)
8969: {


8976:   if (!A->symmetric_set) {
8977:     if (!A->ops->issymmetric) {
8978:       MatType mattype;
8979:       MatGetType(A,&mattype);
8980:       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Matrix of type %s does not support checking for symmetric",mattype);
8981:     }
8982:     (*A->ops->issymmetric)(A,tol,flg);
8983:     if (!tol) {
8984:       MatSetOption(A,MAT_SYMMETRIC,*flg);
8985:     }
8986:   } else if (A->symmetric) {
8987:     *flg = PETSC_TRUE;
8988:   } else if (!tol) {
8989:     *flg = PETSC_FALSE;
8990:   } else {
8991:     if (!A->ops->issymmetric) {
8992:       MatType mattype;
8993:       MatGetType(A,&mattype);
8994:       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Matrix of type %s does not support checking for symmetric",mattype);
8995:     }
8996:     (*A->ops->issymmetric)(A,tol,flg);
8997:   }
8998:   return(0);
8999: }

9001: /*@
9002:    MatIsHermitian - Test whether a matrix is Hermitian

9004:    Collective on Mat

9006:    Input Parameter:
9007: +  A - the matrix to test
9008: -  tol - difference between value and its transpose less than this amount counts as equal (use 0.0 for exact Hermitian)

9010:    Output Parameters:
9011: .  flg - the result

9013:    Level: intermediate

9015: .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(),
9016:           MatIsSymmetricKnown(), MatIsSymmetric()
9017: @*/
9018: PetscErrorCode MatIsHermitian(Mat A,PetscReal tol,PetscBool  *flg)
9019: {


9026:   if (!A->hermitian_set) {
9027:     if (!A->ops->ishermitian) {
9028:       MatType mattype;
9029:       MatGetType(A,&mattype);
9030:       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Matrix of type %s does not support checking for hermitian",mattype);
9031:     }
9032:     (*A->ops->ishermitian)(A,tol,flg);
9033:     if (!tol) {
9034:       MatSetOption(A,MAT_HERMITIAN,*flg);
9035:     }
9036:   } else if (A->hermitian) {
9037:     *flg = PETSC_TRUE;
9038:   } else if (!tol) {
9039:     *flg = PETSC_FALSE;
9040:   } else {
9041:     if (!A->ops->ishermitian) {
9042:       MatType mattype;
9043:       MatGetType(A,&mattype);
9044:       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Matrix of type %s does not support checking for hermitian",mattype);
9045:     }
9046:     (*A->ops->ishermitian)(A,tol,flg);
9047:   }
9048:   return(0);
9049: }

9051: /*@
9052:    MatIsSymmetricKnown - Checks the flag on the matrix to see if it is symmetric.

9054:    Not Collective

9056:    Input Parameter:
9057: .  A - the matrix to check

9059:    Output Parameters:
9060: +  set - if the symmetric flag is set (this tells you if the next flag is valid)
9061: -  flg - the result

9063:    Level: advanced

9065:    Note: Does not check the matrix values directly, so this may return unknown (set = PETSC_FALSE). Use MatIsSymmetric()
9066:          if you want it explicitly checked

9068: .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetric()
9069: @*/
9070: PetscErrorCode MatIsSymmetricKnown(Mat A,PetscBool *set,PetscBool *flg)
9071: {
9076:   if (A->symmetric_set) {
9077:     *set = PETSC_TRUE;
9078:     *flg = A->symmetric;
9079:   } else {
9080:     *set = PETSC_FALSE;
9081:   }
9082:   return(0);
9083: }

9085: /*@
9086:    MatIsHermitianKnown - Checks the flag on the matrix to see if it is hermitian.

9088:    Not Collective

9090:    Input Parameter:
9091: .  A - the matrix to check

9093:    Output Parameters:
9094: +  set - if the hermitian flag is set (this tells you if the next flag is valid)
9095: -  flg - the result

9097:    Level: advanced

9099:    Note: Does not check the matrix values directly, so this may return unknown (set = PETSC_FALSE). Use MatIsHermitian()
9100:          if you want it explicitly checked

9102: .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetric()
9103: @*/
9104: PetscErrorCode MatIsHermitianKnown(Mat A,PetscBool *set,PetscBool *flg)
9105: {
9110:   if (A->hermitian_set) {
9111:     *set = PETSC_TRUE;
9112:     *flg = A->hermitian;
9113:   } else {
9114:     *set = PETSC_FALSE;
9115:   }
9116:   return(0);
9117: }

9119: /*@
9120:    MatIsStructurallySymmetric - Test whether a matrix is structurally symmetric

9122:    Collective on Mat

9124:    Input Parameter:
9125: .  A - the matrix to test

9127:    Output Parameters:
9128: .  flg - the result

9130:    Level: intermediate

9132: .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsSymmetric(), MatSetOption()
9133: @*/
9134: PetscErrorCode MatIsStructurallySymmetric(Mat A,PetscBool *flg)
9135: {

9141:   if (!A->structurally_symmetric_set) {
9142:     if (!A->ops->isstructurallysymmetric) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Matrix of type %s does not support checking for structural symmetric",((PetscObject)A)->type_name);
9143:     (*A->ops->isstructurallysymmetric)(A,flg);
9144:     MatSetOption(A,MAT_STRUCTURALLY_SYMMETRIC,*flg);
9145:   } else *flg = A->structurally_symmetric;
9146:   return(0);
9147: }

9149: /*@
9150:    MatStashGetInfo - Gets how many values are currently in the matrix stash, i.e. need
9151:        to be communicated to other processors during the MatAssemblyBegin/End() process

9153:     Not collective

9155:    Input Parameter:
9156: .   vec - the vector

9158:    Output Parameters:
9159: +   nstash   - the size of the stash
9160: .   reallocs - the number of additional mallocs incurred.
9161: .   bnstash   - the size of the block stash
9162: -   breallocs - the number of additional mallocs incurred.in the block stash

9164:    Level: advanced

9166: .seealso: MatAssemblyBegin(), MatAssemblyEnd(), Mat, MatStashSetInitialSize()

9168: @*/
9169: PetscErrorCode MatStashGetInfo(Mat mat,PetscInt *nstash,PetscInt *reallocs,PetscInt *bnstash,PetscInt *breallocs)
9170: {

9174:   MatStashGetInfo_Private(&mat->stash,nstash,reallocs);
9175:   MatStashGetInfo_Private(&mat->bstash,bnstash,breallocs);
9176:   return(0);
9177: }

9179: /*@C
9180:    MatCreateVecs - Get vector(s) compatible with the matrix, i.e. with the same
9181:      parallel layout

9183:    Collective on Mat

9185:    Input Parameter:
9186: .  mat - the matrix

9188:    Output Parameter:
9189: +   right - (optional) vector that the matrix can be multiplied against
9190: -   left - (optional) vector that the matrix vector product can be stored in

9192:    Notes:
9193:     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().

9195:   Notes:
9196:     These are new vectors which are not owned by the Mat, they should be destroyed in VecDestroy() when no longer needed

9198:   Level: advanced

9200: .seealso: MatCreate(), VecDestroy()
9201: @*/
9202: PetscErrorCode MatCreateVecs(Mat mat,Vec *right,Vec *left)
9203: {

9209:   if (mat->ops->getvecs) {
9210:     (*mat->ops->getvecs)(mat,right,left);
9211:   } else {
9212:     PetscInt rbs,cbs;
9213:     MatGetBlockSizes(mat,&rbs,&cbs);
9214:     if (right) {
9215:       if (mat->cmap->n < 0) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"PetscLayout for columns not yet setup");
9216:       VecCreate(PetscObjectComm((PetscObject)mat),right);
9217:       VecSetSizes(*right,mat->cmap->n,PETSC_DETERMINE);
9218:       VecSetBlockSize(*right,cbs);
9219:       VecSetType(*right,mat->defaultvectype);
9220:       PetscLayoutReference(mat->cmap,&(*right)->map);
9221:     }
9222:     if (left) {
9223:       if (mat->rmap->n < 0) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"PetscLayout for rows not yet setup");
9224:       VecCreate(PetscObjectComm((PetscObject)mat),left);
9225:       VecSetSizes(*left,mat->rmap->n,PETSC_DETERMINE);
9226:       VecSetBlockSize(*left,rbs);
9227:       VecSetType(*left,mat->defaultvectype);
9228:       PetscLayoutReference(mat->rmap,&(*left)->map);
9229:     }
9230:   }
9231:   return(0);
9232: }

9234: /*@C
9235:    MatFactorInfoInitialize - Initializes a MatFactorInfo data structure
9236:      with default values.

9238:    Not Collective

9240:    Input Parameters:
9241: .    info - the MatFactorInfo data structure


9244:    Notes:
9245:     The solvers are generally used through the KSP and PC objects, for example
9246:           PCLU, PCILU, PCCHOLESKY, PCICC

9248:    Level: developer

9250: .seealso: MatFactorInfo

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

9255: @*/

9257: PetscErrorCode MatFactorInfoInitialize(MatFactorInfo *info)
9258: {

9262:   PetscMemzero(info,sizeof(MatFactorInfo));
9263:   return(0);
9264: }

9266: /*@
9267:    MatFactorSetSchurIS - Set indices corresponding to the Schur complement you wish to have computed

9269:    Collective on Mat

9271:    Input Parameters:
9272: +  mat - the factored matrix
9273: -  is - the index set defining the Schur indices (0-based)

9275:    Notes:
9276:     Call MatFactorSolveSchurComplement() or MatFactorSolveSchurComplementTranspose() after this call to solve a Schur complement system.

9278:    You can call MatFactorGetSchurComplement() or MatFactorCreateSchurComplement() after this call.

9280:    Level: developer

9282: .seealso: MatGetFactor(), MatFactorGetSchurComplement(), MatFactorRestoreSchurComplement(), MatFactorCreateSchurComplement(), MatFactorSolveSchurComplement(),
9283:           MatFactorSolveSchurComplementTranspose(), MatFactorSolveSchurComplement()

9285: @*/
9286: PetscErrorCode MatFactorSetSchurIS(Mat mat,IS is)
9287: {
9288:   PetscErrorCode ierr,(*f)(Mat,IS);

9296:   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Only for factored matrix");
9297:   PetscObjectQueryFunction((PetscObject)mat,"MatFactorSetSchurIS_C",&f);
9298:   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");
9299:   MatDestroy(&mat->schur);
9300:   (*f)(mat,is);
9301:   if (!mat->schur) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_PLIB,"Schur complement has not been created");
9302:   return(0);
9303: }

9305: /*@
9306:   MatFactorCreateSchurComplement - Create a Schur complement matrix object using Schur data computed during the factorization step

9308:    Logically Collective on Mat

9310:    Input Parameters:
9311: +  F - the factored matrix obtained by calling MatGetFactor() from PETSc-MUMPS interface
9312: .  S - location where to return the Schur complement, can be NULL
9313: -  status - the status of the Schur complement matrix, can be NULL

9315:    Notes:
9316:    You must call MatFactorSetSchurIS() before calling this routine.

9318:    The routine provides a copy of the Schur matrix stored within the solver data structures.
9319:    The caller must destroy the object when it is no longer needed.
9320:    If MatFactorInvertSchurComplement() has been called, the routine gets back the inverse.

9322:    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)

9324:    Developer Notes:
9325:     The reason this routine exists is because the representation of the Schur complement within the factor matrix may be different than a standard PETSc
9326:    matrix representation and we normally do not want to use the time or memory to make a copy as a regular PETSc matrix.

9328:    See MatCreateSchurComplement() or MatGetSchurComplement() for ways to create virtual or approximate Schur complements.

9330:    Level: advanced

9332:    References:

9334: .seealso: MatGetFactor(), MatFactorSetSchurIS(), MatFactorGetSchurComplement(), MatFactorSchurStatus
9335: @*/
9336: PetscErrorCode MatFactorCreateSchurComplement(Mat F,Mat* S,MatFactorSchurStatus* status)
9337: {

9344:   if (S) {
9345:     PetscErrorCode (*f)(Mat,Mat*);

9347:     PetscObjectQueryFunction((PetscObject)F,"MatFactorCreateSchurComplement_C",&f);
9348:     if (f) {
9349:       (*f)(F,S);
9350:     } else {
9351:       MatDuplicate(F->schur,MAT_COPY_VALUES,S);
9352:     }
9353:   }
9354:   if (status) *status = F->schur_status;
9355:   return(0);
9356: }

9358: /*@
9359:   MatFactorGetSchurComplement - Gets access to a Schur complement matrix using the current Schur data within a factored matrix

9361:    Logically Collective on Mat

9363:    Input Parameters:
9364: +  F - the factored matrix obtained by calling MatGetFactor()
9365: .  *S - location where to return the Schur complement, can be NULL
9366: -  status - the status of the Schur complement matrix, can be NULL

9368:    Notes:
9369:    You must call MatFactorSetSchurIS() before calling this routine.

9371:    Schur complement mode is currently implemented for sequential matrices.
9372:    The routine returns a the Schur Complement stored within the data strutures of the solver.
9373:    If MatFactorInvertSchurComplement() has previously been called, the returned matrix is actually the inverse of the Schur complement.
9374:    The returned matrix should not be destroyed; the caller should call MatFactorRestoreSchurComplement() when the object is no longer needed.

9376:    Use MatFactorCreateSchurComplement() to create a copy of the Schur complement matrix that is within a factored matrix

9378:    See MatCreateSchurComplement() or MatGetSchurComplement() for ways to create virtual or approximate Schur complements.

9380:    Level: advanced

9382:    References:

9384: .seealso: MatGetFactor(), MatFactorSetSchurIS(), MatFactorRestoreSchurComplement(), MatFactorCreateSchurComplement(), MatFactorSchurStatus
9385: @*/
9386: PetscErrorCode MatFactorGetSchurComplement(Mat F,Mat* S,MatFactorSchurStatus* status)
9387: {
9392:   if (S) *S = F->schur;
9393:   if (status) *status = F->schur_status;
9394:   return(0);
9395: }

9397: /*@
9398:   MatFactorRestoreSchurComplement - Restore the Schur complement matrix object obtained from a call to MatFactorGetSchurComplement

9400:    Logically Collective on Mat

9402:    Input Parameters:
9403: +  F - the factored matrix obtained by calling MatGetFactor()
9404: .  *S - location where the Schur complement is stored
9405: -  status - the status of the Schur complement matrix (see MatFactorSchurStatus)

9407:    Notes:

9409:    Level: advanced

9411:    References:

9413: .seealso: MatGetFactor(), MatFactorSetSchurIS(), MatFactorRestoreSchurComplement(), MatFactorCreateSchurComplement(), MatFactorSchurStatus
9414: @*/
9415: PetscErrorCode MatFactorRestoreSchurComplement(Mat F,Mat* S,MatFactorSchurStatus status)
9416: {

9421:   if (S) {
9423:     *S = NULL;
9424:   }
9425:   F->schur_status = status;
9426:   MatFactorUpdateSchurStatus_Private(F);
9427:   return(0);
9428: }

9430: /*@
9431:   MatFactorSolveSchurComplementTranspose - Solve the transpose of the Schur complement system computed during the factorization step

9433:    Logically Collective on Mat

9435:    Input Parameters:
9436: +  F - the factored matrix obtained by calling MatGetFactor()
9437: .  rhs - location where the right hand side of the Schur complement system is stored
9438: -  sol - location where the solution of the Schur complement system has to be returned

9440:    Notes:
9441:    The sizes of the vectors should match the size of the Schur complement

9443:    Must be called after MatFactorSetSchurIS()

9445:    Level: advanced

9447:    References:

9449: .seealso: MatGetFactor(), MatFactorSetSchurIS(), MatFactorSolveSchurComplement()
9450: @*/
9451: PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat F, Vec rhs, Vec sol)
9452: {

9464:   MatFactorFactorizeSchurComplement(F);
9465:   switch (F->schur_status) {
9466:   case MAT_FACTOR_SCHUR_FACTORED:
9467:     MatSolveTranspose(F->schur,rhs,sol);
9468:     break;
9469:   case MAT_FACTOR_SCHUR_INVERTED:
9470:     MatMultTranspose(F->schur,rhs,sol);
9471:     break;
9472:   default:
9473:     SETERRQ1(PetscObjectComm((PetscObject)F),PETSC_ERR_SUP,"Unhandled MatFactorSchurStatus %D",F->schur_status);
9474:   }
9475:   return(0);
9476: }

9478: /*@
9479:   MatFactorSolveSchurComplement - Solve the Schur complement system computed during the factorization step

9481:    Logically Collective on Mat

9483:    Input Parameters:
9484: +  F - the factored matrix obtained by calling MatGetFactor()
9485: .  rhs - location where the right hand side of the Schur complement system is stored
9486: -  sol - location where the solution of the Schur complement system has to be returned

9488:    Notes:
9489:    The sizes of the vectors should match the size of the Schur complement

9491:    Must be called after MatFactorSetSchurIS()

9493:    Level: advanced

9495:    References:

9497: .seealso: MatGetFactor(), MatFactorSetSchurIS(), MatFactorSolveSchurComplementTranspose()
9498: @*/
9499: PetscErrorCode MatFactorSolveSchurComplement(Mat F, Vec rhs, Vec sol)
9500: {

9512:   MatFactorFactorizeSchurComplement(F);
9513:   switch (F->schur_status) {
9514:   case MAT_FACTOR_SCHUR_FACTORED:
9515:     MatSolve(F->schur,rhs,sol);
9516:     break;
9517:   case MAT_FACTOR_SCHUR_INVERTED:
9518:     MatMult(F->schur,rhs,sol);
9519:     break;
9520:   default:
9521:     SETERRQ1(PetscObjectComm((PetscObject)F),PETSC_ERR_SUP,"Unhandled MatFactorSchurStatus %D",F->schur_status);
9522:   }
9523:   return(0);
9524: }

9526: /*@
9527:   MatFactorInvertSchurComplement - Invert the Schur complement matrix computed during the factorization step

9529:    Logically Collective on Mat

9531:    Input Parameters:
9532: .  F - the factored matrix obtained by calling MatGetFactor()

9534:    Notes:
9535:     Must be called after MatFactorSetSchurIS().

9537:    Call MatFactorGetSchurComplement() or  MatFactorCreateSchurComplement() AFTER this call to actually compute the inverse and get access to it.

9539:    Level: advanced

9541:    References:

9543: .seealso: MatGetFactor(), MatFactorSetSchurIS(), MatFactorGetSchurComplement(), MatFactorCreateSchurComplement()
9544: @*/
9545: PetscErrorCode MatFactorInvertSchurComplement(Mat F)
9546: {

9552:   if (F->schur_status == MAT_FACTOR_SCHUR_INVERTED) return(0);
9553:   MatFactorFactorizeSchurComplement(F);
9554:   MatFactorInvertSchurComplement_Private(F);
9555:   F->schur_status = MAT_FACTOR_SCHUR_INVERTED;
9556:   return(0);
9557: }

9559: /*@
9560:   MatFactorFactorizeSchurComplement - Factorize the Schur complement matrix computed during the factorization step

9562:    Logically Collective on Mat

9564:    Input Parameters:
9565: .  F - the factored matrix obtained by calling MatGetFactor()

9567:    Notes:
9568:     Must be called after MatFactorSetSchurIS().

9570:    Level: advanced

9572:    References:

9574: .seealso: MatGetFactor(), MatFactorSetSchurIS(), MatFactorInvertSchurComplement()
9575: @*/
9576: PetscErrorCode MatFactorFactorizeSchurComplement(Mat F)
9577: {

9583:   if (F->schur_status == MAT_FACTOR_SCHUR_INVERTED || F->schur_status == MAT_FACTOR_SCHUR_FACTORED) return(0);
9584:   MatFactorFactorizeSchurComplement_Private(F);
9585:   F->schur_status = MAT_FACTOR_SCHUR_FACTORED;
9586:   return(0);
9587: }

9589: /*@
9590:    MatPtAP - Creates the matrix product C = P^T * A * P

9592:    Neighbor-wise Collective on Mat

9594:    Input Parameters:
9595: +  A - the matrix
9596: .  P - the projection matrix
9597: .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
9598: -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(P)), use PETSC_DEFAULT if you do not have a good estimate
9599:           if the result is a dense matrix this is irrelevent

9601:    Output Parameters:
9602: .  C - the product matrix

9604:    Notes:
9605:    C will be created and must be destroyed by the user with MatDestroy().

9607:    For matrix types without special implementation the function fallbacks to MatMatMult() followed by MatTransposeMatMult().

9609:    Level: intermediate

9611: .seealso: MatMatMult(), MatRARt()
9612: @*/
9613: PetscErrorCode MatPtAP(Mat A,Mat P,MatReuse scall,PetscReal fill,Mat *C)
9614: {

9618:   if (scall == MAT_REUSE_MATRIX) MatCheckProduct(*C,5);
9619:   if (scall == MAT_INPLACE_MATRIX) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Inplace product not supported");

9621:   if (scall == MAT_INITIAL_MATRIX) {
9622:     MatProductCreate(A,P,NULL,C);
9623:     MatProductSetType(*C,MATPRODUCT_PtAP);
9624:     MatProductSetAlgorithm(*C,"default");
9625:     MatProductSetFill(*C,fill);

9627:     (*C)->product->api_user = PETSC_TRUE;
9628:     MatProductSetFromOptions(*C);
9629:     if (!(*C)->ops->productsymbolic) SETERRQ3(PetscObjectComm((PetscObject)(*C)),PETSC_ERR_SUP,"MatProduct %s not supported for A %s and P %s",MatProductTypes[MATPRODUCT_PtAP],((PetscObject)A)->type_name,((PetscObject)P)->type_name);
9630:     MatProductSymbolic(*C);
9631:   } else { /* scall == MAT_REUSE_MATRIX */
9632:     MatProductReplaceMats(A,P,NULL,*C);
9633:   }

9635:   MatProductNumeric(*C);
9636:   if (A->symmetric_set && A->symmetric) {
9637:     MatSetOption(*C,MAT_SYMMETRIC,PETSC_TRUE);
9638:   }
9639:   return(0);
9640: }

9642: /*@
9643:    MatRARt - Creates the matrix product C = R * A * R^T

9645:    Neighbor-wise Collective on Mat

9647:    Input Parameters:
9648: +  A - the matrix
9649: .  R - the projection matrix
9650: .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
9651: -  fill - expected fill as ratio of nnz(C)/nnz(A), use PETSC_DEFAULT if you do not have a good estimate
9652:           if the result is a dense matrix this is irrelevent

9654:    Output Parameters:
9655: .  C - the product matrix

9657:    Notes:
9658:    C will be created and must be destroyed by the user with MatDestroy().

9660:    This routine is currently only implemented for pairs of AIJ matrices and classes
9661:    which inherit from AIJ. Due to PETSc sparse matrix block row distribution among processes,
9662:    parallel MatRARt is implemented via explicit transpose of R, which could be very expensive.
9663:    We recommend using MatPtAP().

9665:    Level: intermediate

9667: .seealso: MatMatMult(), MatPtAP()
9668: @*/
9669: PetscErrorCode MatRARt(Mat A,Mat R,MatReuse scall,PetscReal fill,Mat *C)
9670: {

9674:   if (scall == MAT_REUSE_MATRIX) MatCheckProduct(*C,5);
9675:   if (scall == MAT_INPLACE_MATRIX) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Inplace product not supported");

9677:   if (scall == MAT_INITIAL_MATRIX) {
9678:     MatProductCreate(A,R,NULL,C);
9679:     MatProductSetType(*C,MATPRODUCT_RARt);
9680:     MatProductSetAlgorithm(*C,"default");
9681:     MatProductSetFill(*C,fill);

9683:     (*C)->product->api_user = PETSC_TRUE;
9684:     MatProductSetFromOptions(*C);
9685:     if (!(*C)->ops->productsymbolic) SETERRQ3(PetscObjectComm((PetscObject)(*C)),PETSC_ERR_SUP,"MatProduct %s not supported for A %s and R %s",MatProductTypes[MATPRODUCT_RARt],((PetscObject)A)->type_name,((PetscObject)R)->type_name);
9686:     MatProductSymbolic(*C);
9687:   } else { /* scall == MAT_REUSE_MATRIX */
9688:     MatProductReplaceMats(A,R,NULL,*C);
9689:   }

9691:   MatProductNumeric(*C);
9692:   if (A->symmetric_set && A->symmetric) {
9693:     MatSetOption(*C,MAT_SYMMETRIC,PETSC_TRUE);
9694:   }
9695:   return(0);
9696: }


9699: static PetscErrorCode MatProduct_Private(Mat A,Mat B,MatReuse scall,PetscReal fill,MatProductType ptype, Mat *C)
9700: {

9704:   if (scall == MAT_INPLACE_MATRIX) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Inplace product not supported");

9706:   if (scall == MAT_INITIAL_MATRIX) {
9707:     PetscInfo1(A,"Calling MatProduct API with MAT_INITIAL_MATRIX and product type %s\n",MatProductTypes[ptype]);
9708:     MatProductCreate(A,B,NULL,C);
9709:     MatProductSetType(*C,ptype);
9710:     MatProductSetAlgorithm(*C,MATPRODUCTALGORITHM_DEFAULT);
9711:     MatProductSetFill(*C,fill);

9713:     (*C)->product->api_user = PETSC_TRUE;
9714:     MatProductSetFromOptions(*C);
9715:     MatProductSymbolic(*C);
9716:   } else { /* scall == MAT_REUSE_MATRIX */
9717:     Mat_Product *product = (*C)->product;

9719:     PetscInfo2(A,"Calling MatProduct API with MAT_REUSE_MATRIX %s product present and product type %s\n",product ? "with" : "without",MatProductTypes[ptype]);
9720:     if (!product) {
9721:       /* user provide the dense matrix *C without calling MatProductCreate() */
9722:       PetscBool isdense;

9724:       PetscObjectBaseTypeCompareAny((PetscObject)(*C),&isdense,MATSEQDENSE,MATMPIDENSE,"");
9725:       if (isdense) {
9726:         /* user wants to reuse an assembled dense matrix */
9727:         /* Create product -- see MatCreateProduct() */
9728:         MatProductCreate_Private(A,B,NULL,*C);
9729:         product = (*C)->product;
9730:         product->fill     = fill;
9731:         product->api_user = PETSC_TRUE;
9732:         product->clear    = PETSC_TRUE;

9734:         MatProductSetType(*C,ptype);
9735:         MatProductSetFromOptions(*C);
9736:         if (!(*C)->ops->productsymbolic) SETERRQ3(PetscObjectComm((PetscObject)(*C)),PETSC_ERR_SUP,"MatProduct %s not supported for %s and %s",MatProductTypes[ptype],((PetscObject)A)->type_name,((PetscObject)B)->type_name);
9737:         MatProductSymbolic(*C);
9738:       } else SETERRQ(PetscObjectComm((PetscObject)(*C)),PETSC_ERR_SUP,"Call MatProductCreate() first");
9739:     } else { /* user may change input matrices A or B when REUSE */
9740:       MatProductReplaceMats(A,B,NULL,*C);
9741:     }
9742:   }
9743:   MatProductNumeric(*C);
9744:   return(0);
9745: }

9747: /*@
9748:    MatMatMult - Performs Matrix-Matrix Multiplication C=A*B.

9750:    Neighbor-wise Collective on Mat

9752:    Input Parameters:
9753: +  A - the left matrix
9754: .  B - the right matrix
9755: .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
9756: -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(B)), use PETSC_DEFAULT if you do not have a good estimate
9757:           if the result is a dense matrix this is irrelevent

9759:    Output Parameters:
9760: .  C - the product matrix

9762:    Notes:
9763:    Unless scall is MAT_REUSE_MATRIX C will be created.

9765:    MAT_REUSE_MATRIX can only be used if the matrices A and B have the same nonzero pattern as in the previous call and C was obtained from a previous
9766:    call to this function with MAT_INITIAL_MATRIX.

9768:    To determine the correct fill value, run with -info and search for the string "Fill ratio" to see the value actually needed.

9770:    If you have many matrices with the same non-zero structure to multiply, you should use MatProductCreate()/MatProductSymbolic(C)/ReplaceMats(), and call MatProductNumeric() repeatedly.

9772:    In the special case where matrix B (and hence C) are dense you can create the correctly sized matrix C yourself and then call this routine with MAT_REUSE_MATRIX, rather than first having MatMatMult() create it for you. You can NEVER do this if the matrix C is sparse.

9774:    Level: intermediate

9776: .seealso: MatTransposeMatMult(), MatMatTransposeMult(), MatPtAP()
9777: @*/
9778: PetscErrorCode MatMatMult(Mat A,Mat B,MatReuse scall,PetscReal fill,Mat *C)
9779: {

9783:   MatProduct_Private(A,B,scall,fill,MATPRODUCT_AB,C);
9784:   return(0);
9785: }

9787: /*@
9788:    MatMatTransposeMult - Performs Matrix-Matrix Multiplication C=A*B^T.

9790:    Neighbor-wise Collective on Mat

9792:    Input Parameters:
9793: +  A - the left matrix
9794: .  B - the right matrix
9795: .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
9796: -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(B)), use PETSC_DEFAULT if not known

9798:    Output Parameters:
9799: .  C - the product matrix

9801:    Notes:
9802:    C will be created if MAT_INITIAL_MATRIX and must be destroyed by the user with MatDestroy().

9804:    MAT_REUSE_MATRIX can only be used if the matrices A and B have the same nonzero pattern as in the previous call

9806:   To determine the correct fill value, run with -info and search for the string "Fill ratio" to see the value
9807:    actually needed.

9809:    This routine is currently only implemented for pairs of SeqAIJ matrices, for the SeqDense class,
9810:    and for pairs of MPIDense matrices.

9812:    Options Database Keys:
9813: .  -matmattransmult_mpidense_mpidense_via {allgatherv,cyclic} - Choose between algorthims for MPIDense matrices: the
9814:                                                                 first redundantly copies the transposed B matrix on each process and requiers O(log P) communication complexity;
9815:                                                                 the second never stores more than one portion of the B matrix at a time by requires O(P) communication complexity.

9817:    Level: intermediate

9819: .seealso: MatMatMult(), MatTransposeMatMult() MatPtAP()
9820: @*/
9821: PetscErrorCode MatMatTransposeMult(Mat A,Mat B,MatReuse scall,PetscReal fill,Mat *C)
9822: {

9826:   MatProduct_Private(A,B,scall,fill,MATPRODUCT_ABt,C);
9827:   return(0);
9828: }

9830: /*@
9831:    MatTransposeMatMult - Performs Matrix-Matrix Multiplication C=A^T*B.

9833:    Neighbor-wise Collective on Mat

9835:    Input Parameters:
9836: +  A - the left matrix
9837: .  B - the right matrix
9838: .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
9839: -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(B)), use PETSC_DEFAULT if not known

9841:    Output Parameters:
9842: .  C - the product matrix

9844:    Notes:
9845:    C will be created if MAT_INITIAL_MATRIX and must be destroyed by the user with MatDestroy().

9847:    MAT_REUSE_MATRIX can only be used if the matrices A and B have the same nonzero pattern as in the previous call.

9849:   To determine the correct fill value, run with -info and search for the string "Fill ratio" to see the value
9850:    actually needed.

9852:    This routine is currently implemented for pairs of AIJ matrices and pairs of SeqDense matrices and classes
9853:    which inherit from SeqAIJ.  C will be of same type as the input matrices.

9855:    Level: intermediate

9857: .seealso: MatMatMult(), MatMatTransposeMult(), MatPtAP()
9858: @*/
9859: PetscErrorCode MatTransposeMatMult(Mat A,Mat B,MatReuse scall,PetscReal fill,Mat *C)
9860: {

9864:   MatProduct_Private(A,B,scall,fill,MATPRODUCT_AtB,C);
9865:   return(0);
9866: }

9868: /*@
9869:    MatMatMatMult - Performs Matrix-Matrix-Matrix Multiplication D=A*B*C.

9871:    Neighbor-wise Collective on Mat

9873:    Input Parameters:
9874: +  A - the left matrix
9875: .  B - the middle matrix
9876: .  C - the right matrix
9877: .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
9878: -  fill - expected fill as ratio of nnz(D)/(nnz(A) + nnz(B)+nnz(C)), use PETSC_DEFAULT if you do not have a good estimate
9879:           if the result is a dense matrix this is irrelevent

9881:    Output Parameters:
9882: .  D - the product matrix

9884:    Notes:
9885:    Unless scall is MAT_REUSE_MATRIX D will be created.

9887:    MAT_REUSE_MATRIX can only be used if the matrices A, B and C have the same nonzero pattern as in the previous call

9889:    To determine the correct fill value, run with -info and search for the string "Fill ratio" to see the value
9890:    actually needed.

9892:    If you have many matrices with the same non-zero structure to multiply, you
9893:    should use MAT_REUSE_MATRIX in all calls but the first or

9895:    Level: intermediate

9897: .seealso: MatMatMult, MatPtAP()
9898: @*/
9899: PetscErrorCode MatMatMatMult(Mat A,Mat B,Mat C,MatReuse scall,PetscReal fill,Mat *D)
9900: {

9904:   if (scall == MAT_REUSE_MATRIX) MatCheckProduct(*D,6);
9905:   if (scall == MAT_INPLACE_MATRIX) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Inplace product not supported");

9907:   if (scall == MAT_INITIAL_MATRIX) {
9908:     MatProductCreate(A,B,C,D);
9909:     MatProductSetType(*D,MATPRODUCT_ABC);
9910:     MatProductSetAlgorithm(*D,"default");
9911:     MatProductSetFill(*D,fill);

9913:     (*D)->product->api_user = PETSC_TRUE;
9914:     MatProductSetFromOptions(*D);
9915:     if (!(*D)->ops->productsymbolic) SETERRQ4(PetscObjectComm((PetscObject)(*D)),PETSC_ERR_SUP,"MatProduct %s not supported for A %s, B %s and C %s",MatProductTypes[MATPRODUCT_ABC],((PetscObject)A)->type_name,((PetscObject)B)->type_name,((PetscObject)C)->type_name);
9916:     MatProductSymbolic(*D);
9917:   } else { /* user may change input matrices when REUSE */
9918:     MatProductReplaceMats(A,B,C,*D);
9919:   }
9920:   MatProductNumeric(*D);
9921:   return(0);
9922: }

9924: /*@
9925:    MatCreateRedundantMatrix - Create redundant matrices and put them into processors of subcommunicators.

9927:    Collective on Mat

9929:    Input Parameters:
9930: +  mat - the matrix
9931: .  nsubcomm - the number of subcommunicators (= number of redundant parallel or sequential matrices)
9932: .  subcomm - MPI communicator split from the communicator where mat resides in (or MPI_COMM_NULL if nsubcomm is used)
9933: -  reuse - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX

9935:    Output Parameter:
9936: .  matredundant - redundant matrix

9938:    Notes:
9939:    MAT_REUSE_MATRIX can only be used when the nonzero structure of the
9940:    original matrix has not changed from that last call to MatCreateRedundantMatrix().

9942:    This routine creates the duplicated matrices in subcommunicators; you should NOT create them before
9943:    calling it.

9945:    Level: advanced


9948: .seealso: MatDestroy()
9949: @*/
9950: PetscErrorCode MatCreateRedundantMatrix(Mat mat,PetscInt nsubcomm,MPI_Comm subcomm,MatReuse reuse,Mat *matredundant)
9951: {
9953:   MPI_Comm       comm;
9954:   PetscMPIInt    size;
9955:   PetscInt       mloc_sub,nloc_sub,rstart,rend,M=mat->rmap->N,N=mat->cmap->N,bs=mat->rmap->bs;
9956:   Mat_Redundant  *redund=NULL;
9957:   PetscSubcomm   psubcomm=NULL;
9958:   MPI_Comm       subcomm_in=subcomm;
9959:   Mat            *matseq;
9960:   IS             isrow,iscol;
9961:   PetscBool      newsubcomm=PETSC_FALSE;

9965:   if (nsubcomm && reuse == MAT_REUSE_MATRIX) {
9968:   }

9970:   MPI_Comm_size(PetscObjectComm((PetscObject)mat),&size);
9971:   if (size == 1 || nsubcomm == 1) {
9972:     if (reuse == MAT_INITIAL_MATRIX) {
9973:       MatDuplicate(mat,MAT_COPY_VALUES,matredundant);
9974:     } else {
9975:       if (*matredundant == mat) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MAT_REUSE_MATRIX means reuse the matrix passed in as the final argument, not the original matrix");
9976:       MatCopy(mat,*matredundant,SAME_NONZERO_PATTERN);
9977:     }
9978:     return(0);
9979:   }

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

9985:   PetscLogEventBegin(MAT_RedundantMat,mat,0,0,0);
9986:   if (subcomm_in == MPI_COMM_NULL && reuse == MAT_INITIAL_MATRIX) { /* get subcomm if user does not provide subcomm */
9987:     /* create psubcomm, then get subcomm */
9988:     PetscObjectGetComm((PetscObject)mat,&comm);
9989:     MPI_Comm_size(comm,&size);
9990:     if (nsubcomm < 1 || nsubcomm > size) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"nsubcomm must between 1 and %D",size);

9992:     PetscSubcommCreate(comm,&psubcomm);
9993:     PetscSubcommSetNumber(psubcomm,nsubcomm);
9994:     PetscSubcommSetType(psubcomm,PETSC_SUBCOMM_CONTIGUOUS);
9995:     PetscSubcommSetFromOptions(psubcomm);
9996:     PetscCommDuplicate(PetscSubcommChild(psubcomm),&subcomm,NULL);
9997:     newsubcomm = PETSC_TRUE;
9998:     PetscSubcommDestroy(&psubcomm);
9999:   }

10001:   /* get isrow, iscol and a local sequential matrix matseq[0] */
10002:   if (reuse == MAT_INITIAL_MATRIX) {
10003:     mloc_sub = PETSC_DECIDE;
10004:     nloc_sub = PETSC_DECIDE;
10005:     if (bs < 1) {
10006:       PetscSplitOwnership(subcomm,&mloc_sub,&M);
10007:       PetscSplitOwnership(subcomm,&nloc_sub,&N);
10008:     } else {
10009:       PetscSplitOwnershipBlock(subcomm,bs,&mloc_sub,&M);
10010:       PetscSplitOwnershipBlock(subcomm,bs,&nloc_sub,&N);
10011:     }
10012:     MPI_Scan(&mloc_sub,&rend,1,MPIU_INT,MPI_SUM,subcomm);
10013:     rstart = rend - mloc_sub;
10014:     ISCreateStride(PETSC_COMM_SELF,mloc_sub,rstart,1,&isrow);
10015:     ISCreateStride(PETSC_COMM_SELF,N,0,1,&iscol);
10016:   } else { /* reuse == MAT_REUSE_MATRIX */
10017:     if (*matredundant == mat) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MAT_REUSE_MATRIX means reuse the matrix passed in as the final argument, not the original matrix");
10018:     /* retrieve subcomm */
10019:     PetscObjectGetComm((PetscObject)(*matredundant),&subcomm);
10020:     redund = (*matredundant)->redundant;
10021:     isrow  = redund->isrow;
10022:     iscol  = redund->iscol;
10023:     matseq = redund->matseq;
10024:   }
10025:   MatCreateSubMatrices(mat,1,&isrow,&iscol,reuse,&matseq);

10027:   /* get matredundant over subcomm */
10028:   if (reuse == MAT_INITIAL_MATRIX) {
10029:     MatCreateMPIMatConcatenateSeqMat(subcomm,matseq[0],nloc_sub,reuse,matredundant);

10031:     /* create a supporting struct and attach it to C for reuse */
10032:     PetscNewLog(*matredundant,&redund);
10033:     (*matredundant)->redundant = redund;
10034:     redund->isrow              = isrow;
10035:     redund->iscol              = iscol;
10036:     redund->matseq             = matseq;
10037:     if (newsubcomm) {
10038:       redund->subcomm          = subcomm;
10039:     } else {
10040:       redund->subcomm          = MPI_COMM_NULL;
10041:     }
10042:   } else {
10043:     MatCreateMPIMatConcatenateSeqMat(subcomm,matseq[0],PETSC_DECIDE,reuse,matredundant);
10044:   }
10045:   PetscLogEventEnd(MAT_RedundantMat,mat,0,0,0);
10046:   return(0);
10047: }

10049: /*@C
10050:    MatGetMultiProcBlock - Create multiple [bjacobi] 'parallel submatrices' from
10051:    a given 'mat' object. Each submatrix can span multiple procs.

10053:    Collective on Mat

10055:    Input Parameters:
10056: +  mat - the matrix
10057: .  subcomm - the subcommunicator obtained by com_split(comm)
10058: -  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX

10060:    Output Parameter:
10061: .  subMat - 'parallel submatrices each spans a given subcomm

10063:   Notes:
10064:   The submatrix partition across processors is dictated by 'subComm' a
10065:   communicator obtained by com_split(comm). The comm_split
10066:   is not restriced to be grouped with consecutive original ranks.

10068:   Due the comm_split() usage, the parallel layout of the submatrices
10069:   map directly to the layout of the original matrix [wrt the local
10070:   row,col partitioning]. So the original 'DiagonalMat' naturally maps
10071:   into the 'DiagonalMat' of the subMat, hence it is used directly from
10072:   the subMat. However the offDiagMat looses some columns - and this is
10073:   reconstructed with MatSetValues()

10075:   Level: advanced


10078: .seealso: MatCreateSubMatrices()
10079: @*/
10080: PetscErrorCode   MatGetMultiProcBlock(Mat mat, MPI_Comm subComm, MatReuse scall,Mat *subMat)
10081: {
10083:   PetscMPIInt    commsize,subCommSize;

10086:   MPI_Comm_size(PetscObjectComm((PetscObject)mat),&commsize);
10087:   MPI_Comm_size(subComm,&subCommSize);
10088:   if (subCommSize > commsize) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"CommSize %D < SubCommZize %D",commsize,subCommSize);

10090:   if (scall == MAT_REUSE_MATRIX && *subMat == mat) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MAT_REUSE_MATRIX means reuse the matrix passed in as the final argument, not the original matrix");
10091:   PetscLogEventBegin(MAT_GetMultiProcBlock,mat,0,0,0);
10092:   (*mat->ops->getmultiprocblock)(mat,subComm,scall,subMat);
10093:   PetscLogEventEnd(MAT_GetMultiProcBlock,mat,0,0,0);
10094:   return(0);
10095: }

10097: /*@
10098:    MatGetLocalSubMatrix - Gets a reference to a submatrix specified in local numbering

10100:    Not Collective

10102:    Input Arguments:
10103: +  mat - matrix to extract local submatrix from
10104: .  isrow - local row indices for submatrix
10105: -  iscol - local column indices for submatrix

10107:    Output Arguments:
10108: .  submat - the submatrix

10110:    Level: intermediate

10112:    Notes:
10113:    The submat should be returned with MatRestoreLocalSubMatrix().

10115:    Depending on the format of mat, the returned submat may not implement MatMult().  Its communicator may be
10116:    the same as mat, it may be PETSC_COMM_SELF, or some other subcomm of mat's.

10118:    The submat always implements MatSetValuesLocal().  If isrow and iscol have the same block size, then
10119:    MatSetValuesBlockedLocal() will also be implemented.

10121:    The mat must have had a ISLocalToGlobalMapping provided to it with MatSetLocalToGlobalMapping(). Note that
10122:    matrices obtained with DMCreateMatrix() generally already have the local to global mapping provided.

10124: .seealso: MatRestoreLocalSubMatrix(), MatCreateLocalRef(), MatSetLocalToGlobalMapping()
10125: @*/
10126: PetscErrorCode MatGetLocalSubMatrix(Mat mat,IS isrow,IS iscol,Mat *submat)
10127: {

10136:   if (!mat->rmap->mapping) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Matrix must have local to global mapping provided before this call");

10138:   if (mat->ops->getlocalsubmatrix) {
10139:     (*mat->ops->getlocalsubmatrix)(mat,isrow,iscol,submat);
10140:   } else {
10141:     MatCreateLocalRef(mat,isrow,iscol,submat);
10142:   }
10143:   return(0);
10144: }

10146: /*@
10147:    MatRestoreLocalSubMatrix - Restores a reference to a submatrix specified in local numbering

10149:    Not Collective

10151:    Input Arguments:
10152:    mat - matrix to extract local submatrix from
10153:    isrow - local row indices for submatrix
10154:    iscol - local column indices for submatrix
10155:    submat - the submatrix

10157:    Level: intermediate

10159: .seealso: MatGetLocalSubMatrix()
10160: @*/
10161: PetscErrorCode MatRestoreLocalSubMatrix(Mat mat,IS isrow,IS iscol,Mat *submat)
10162: {

10171:   if (*submat) {
10173:   }

10175:   if (mat->ops->restorelocalsubmatrix) {
10176:     (*mat->ops->restorelocalsubmatrix)(mat,isrow,iscol,submat);
10177:   } else {
10178:     MatDestroy(submat);
10179:   }
10180:   *submat = NULL;
10181:   return(0);
10182: }

10184: /* --------------------------------------------------------*/
10185: /*@
10186:    MatFindZeroDiagonals - Finds all the rows of a matrix that have zero or no diagonal entry in the matrix

10188:    Collective on Mat

10190:    Input Parameter:
10191: .  mat - the matrix

10193:    Output Parameter:
10194: .  is - if any rows have zero diagonals this contains the list of them

10196:    Level: developer

10198: .seealso: MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
10199: @*/
10200: PetscErrorCode MatFindZeroDiagonals(Mat mat,IS *is)
10201: {

10207:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
10208:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");

10210:   if (!mat->ops->findzerodiagonals) {
10211:     Vec                diag;
10212:     const PetscScalar *a;
10213:     PetscInt          *rows;
10214:     PetscInt           rStart, rEnd, r, nrow = 0;

10216:     MatCreateVecs(mat, &diag, NULL);
10217:     MatGetDiagonal(mat, diag);
10218:     MatGetOwnershipRange(mat, &rStart, &rEnd);
10219:     VecGetArrayRead(diag, &a);
10220:     for (r = 0; r < rEnd-rStart; ++r) if (a[r] == 0.0) ++nrow;
10221:     PetscMalloc1(nrow, &rows);
10222:     nrow = 0;
10223:     for (r = 0; r < rEnd-rStart; ++r) if (a[r] == 0.0) rows[nrow++] = r+rStart;
10224:     VecRestoreArrayRead(diag, &a);
10225:     VecDestroy(&diag);
10226:     ISCreateGeneral(PetscObjectComm((PetscObject) mat), nrow, rows, PETSC_OWN_POINTER, is);
10227:   } else {
10228:     (*mat->ops->findzerodiagonals)(mat, is);
10229:   }
10230:   return(0);
10231: }

10233: /*@
10234:    MatFindOffBlockDiagonalEntries - Finds all the rows of a matrix that have entries outside of the main diagonal block (defined by the matrix block size)

10236:    Collective on Mat

10238:    Input Parameter:
10239: .  mat - the matrix

10241:    Output Parameter:
10242: .  is - contains the list of rows with off block diagonal entries

10244:    Level: developer

10246: .seealso: MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
10247: @*/
10248: PetscErrorCode MatFindOffBlockDiagonalEntries(Mat mat,IS *is)
10249: {

10255:   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
10256:   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");

10258:   if (!mat->ops->findoffblockdiagonalentries) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s does not have a find off block diagonal entries defined",((PetscObject)mat)->type_name);
10259:   (*mat->ops->findoffblockdiagonalentries)(mat,is);
10260:   return(0);
10261: }

10263: /*@C
10264:   MatInvertBlockDiagonal - Inverts the block diagonal entries.

10266:   Collective on Mat

10268:   Input Parameters:
10269: . mat - the matrix

10271:   Output Parameters:
10272: . values - the block inverses in column major order (FORTRAN-like)

10274:    Note:
10275:    This routine is not available from Fortran.

10277:   Level: advanced

10279: .seealso: MatInvertBockDiagonalMat
10280: @*/
10281: PetscErrorCode MatInvertBlockDiagonal(Mat mat,const PetscScalar **values)
10282: {

10287:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
10288:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
10289:   if (!mat->ops->invertblockdiagonal) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Not supported for type %s",((PetscObject)mat)->type_name);
10290:   (*mat->ops->invertblockdiagonal)(mat,values);
10291:   return(0);
10292: }

10294: /*@C
10295:   MatInvertVariableBlockDiagonal - Inverts the block diagonal entries.

10297:   Collective on Mat

10299:   Input Parameters:
10300: + mat - the matrix
10301: . nblocks - the number of blocks
10302: - bsizes - the size of each block

10304:   Output Parameters:
10305: . values - the block inverses in column major order (FORTRAN-like)

10307:    Note:
10308:    This routine is not available from Fortran.

10310:   Level: advanced

10312: .seealso: MatInvertBockDiagonal()
10313: @*/
10314: PetscErrorCode MatInvertVariableBlockDiagonal(Mat mat,PetscInt nblocks,const PetscInt *bsizes,PetscScalar *values)
10315: {

10320:   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
10321:   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
10322:   if (!mat->ops->invertvariableblockdiagonal) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Not supported for type",((PetscObject)mat)->type_name);
10323:   (*mat->ops->invertvariableblockdiagonal)(mat,nblocks,bsizes,values);
10324:   return(0);
10325: }

10327: /*@
10328:   MatInvertBlockDiagonalMat - set matrix C to be the inverted block diagonal of matrix A

10330:   Collective on Mat

10332:   Input Parameters:
10333: . A - the matrix

10335:   Output Parameters:
10336: . C - matrix with inverted block diagonal of A.  This matrix should be created and may have its type set.

10338:   Notes: the blocksize of the matrix is used to determine the blocks on the diagonal of C

10340:   Level: advanced

10342: .seealso: MatInvertBockDiagonal()
10343: @*/
10344: PetscErrorCode MatInvertBlockDiagonalMat(Mat A,Mat C)
10345: {
10346:   PetscErrorCode     ierr;
10347:   const PetscScalar *vals;
10348:   PetscInt          *dnnz;
10349:   PetscInt           M,N,m,n,rstart,rend,bs,i,j;

10352:   MatInvertBlockDiagonal(A,&vals);
10353:   MatGetBlockSize(A,&bs);
10354:   MatGetSize(A,&M,&N);
10355:   MatGetLocalSize(A,&m,&n);
10356:   MatSetSizes(C,m,n,M,N);
10357:   MatSetBlockSize(C,bs);
10358:   PetscMalloc1(m/bs,&dnnz);
10359:   for (j = 0; j < m/bs; j++) dnnz[j] = 1;
10360:   MatXAIJSetPreallocation(C,bs,dnnz,NULL,NULL,NULL);
10361:   PetscFree(dnnz);
10362:   MatGetOwnershipRange(C,&rstart,&rend);
10363:   MatSetOption(C,MAT_ROW_ORIENTED,PETSC_FALSE);
10364:   for (i = rstart/bs; i < rend/bs; i++) {
10365:     MatSetValuesBlocked(C,1,&i,1,&i,&vals[(i-rstart/bs)*bs*bs],INSERT_VALUES);
10366:   }
10367:   MatAssemblyBegin(C,MAT_FINAL_ASSEMBLY);
10368:   MatAssemblyEnd(C,MAT_FINAL_ASSEMBLY);
10369:   MatSetOption(C,MAT_ROW_ORIENTED,PETSC_TRUE);
10370:   return(0);
10371: }

10373: /*@C
10374:     MatTransposeColoringDestroy - Destroys a coloring context for matrix product C=A*B^T that was created
10375:     via MatTransposeColoringCreate().

10377:     Collective on MatTransposeColoring

10379:     Input Parameter:
10380: .   c - coloring context

10382:     Level: intermediate

10384: .seealso: MatTransposeColoringCreate()
10385: @*/
10386: PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring *c)
10387: {
10388:   PetscErrorCode       ierr;
10389:   MatTransposeColoring matcolor=*c;

10392:   if (!matcolor) return(0);
10393:   if (--((PetscObject)matcolor)->refct > 0) {matcolor = NULL; return(0);}

10395:   PetscFree3(matcolor->ncolumns,matcolor->nrows,matcolor->colorforrow);
10396:   PetscFree(matcolor->rows);
10397:   PetscFree(matcolor->den2sp);
10398:   PetscFree(matcolor->colorforcol);
10399:   PetscFree(matcolor->columns);
10400:   if (matcolor->brows>0) {
10401:     PetscFree(matcolor->lstart);
10402:   }
10403:   PetscHeaderDestroy(c);
10404:   return(0);
10405: }

10407: /*@C
10408:     MatTransColoringApplySpToDen - Given a symbolic matrix product C=A*B^T for which
10409:     a MatTransposeColoring context has been created, computes a dense B^T by Apply
10410:     MatTransposeColoring to sparse B.

10412:     Collective on MatTransposeColoring

10414:     Input Parameters:
10415: +   B - sparse matrix B
10416: .   Btdense - symbolic dense matrix B^T
10417: -   coloring - coloring context created with MatTransposeColoringCreate()

10419:     Output Parameter:
10420: .   Btdense - dense matrix B^T

10422:     Level: advanced

10424:      Notes:
10425:     These are used internally for some implementations of MatRARt()

10427: .seealso: MatTransposeColoringCreate(), MatTransposeColoringDestroy(), MatTransColoringApplyDenToSp()

10429: @*/
10430: PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring coloring,Mat B,Mat Btdense)
10431: {


10439:   if (!B->ops->transcoloringapplysptoden) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Not supported for this matrix type %s",((PetscObject)B)->type_name);
10440:   (B->ops->transcoloringapplysptoden)(coloring,B,Btdense);
10441:   return(0);
10442: }

10444: /*@C
10445:     MatTransColoringApplyDenToSp - Given a symbolic matrix product Csp=A*B^T for which
10446:     a MatTransposeColoring context has been created and a dense matrix Cden=A*Btdense
10447:     in which Btdens is obtained from MatTransColoringApplySpToDen(), recover sparse matrix
10448:     Csp from Cden.

10450:     Collective on MatTransposeColoring

10452:     Input Parameters:
10453: +   coloring - coloring context created with MatTransposeColoringCreate()
10454: -   Cden - matrix product of a sparse matrix and a dense matrix Btdense

10456:     Output Parameter:
10457: .   Csp - sparse matrix

10459:     Level: advanced

10461:      Notes:
10462:     These are used internally for some implementations of MatRARt()

10464: .seealso: MatTransposeColoringCreate(), MatTransposeColoringDestroy(), MatTransColoringApplySpToDen()

10466: @*/
10467: PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring matcoloring,Mat Cden,Mat Csp)
10468: {


10476:   if (!Csp->ops->transcoloringapplydentosp) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Not supported for this matrix type %s",((PetscObject)Csp)->type_name);
10477:   (Csp->ops->transcoloringapplydentosp)(matcoloring,Cden,Csp);
10478:   MatAssemblyBegin(Csp,MAT_FINAL_ASSEMBLY);
10479:   MatAssemblyEnd(Csp,MAT_FINAL_ASSEMBLY);
10480:   return(0);
10481: }

10483: /*@C
10484:    MatTransposeColoringCreate - Creates a matrix coloring context for matrix product C=A*B^T.

10486:    Collective on Mat

10488:    Input Parameters:
10489: +  mat - the matrix product C
10490: -  iscoloring - the coloring of the matrix; usually obtained with MatColoringCreate() or DMCreateColoring()

10492:     Output Parameter:
10493: .   color - the new coloring context

10495:     Level: intermediate

10497: .seealso: MatTransposeColoringDestroy(),  MatTransColoringApplySpToDen(),
10498:            MatTransColoringApplyDenToSp()
10499: @*/
10500: PetscErrorCode MatTransposeColoringCreate(Mat mat,ISColoring iscoloring,MatTransposeColoring *color)
10501: {
10502:   MatTransposeColoring c;
10503:   MPI_Comm             comm;
10504:   PetscErrorCode       ierr;

10507:   PetscLogEventBegin(MAT_TransposeColoringCreate,mat,0,0,0);
10508:   PetscObjectGetComm((PetscObject)mat,&comm);
10509:   PetscHeaderCreate(c,MAT_TRANSPOSECOLORING_CLASSID,"MatTransposeColoring","Matrix product C=A*B^T via coloring","Mat",comm,MatTransposeColoringDestroy,NULL);

10511:   c->ctype = iscoloring->ctype;
10512:   if (mat->ops->transposecoloringcreate) {
10513:     (*mat->ops->transposecoloringcreate)(mat,iscoloring,c);
10514:   } else SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Code not yet written for matrix type %s",((PetscObject)mat)->type_name);

10516:   *color = c;
10517:   PetscLogEventEnd(MAT_TransposeColoringCreate,mat,0,0,0);
10518:   return(0);
10519: }

10521: /*@
10522:       MatGetNonzeroState - Returns a 64 bit integer representing the current state of nonzeros in the matrix. If the
10523:         matrix has had no new nonzero locations added to the matrix since the previous call then the value will be the
10524:         same, otherwise it will be larger

10526:      Not Collective

10528:   Input Parameter:
10529: .    A  - the matrix

10531:   Output Parameter:
10532: .    state - the current state

10534:   Notes:
10535:     You can only compare states from two different calls to the SAME matrix, you cannot compare calls between
10536:          different matrices

10538:   Level: intermediate

10540: @*/
10541: PetscErrorCode MatGetNonzeroState(Mat mat,PetscObjectState *state)
10542: {
10545:   *state = mat->nonzerostate;
10546:   return(0);
10547: }

10549: /*@
10550:       MatCreateMPIMatConcatenateSeqMat - Creates a single large PETSc matrix by concatenating sequential
10551:                  matrices from each processor

10553:     Collective

10555:    Input Parameters:
10556: +    comm - the communicators the parallel matrix will live on
10557: .    seqmat - the input sequential matrices
10558: .    n - number of local columns (or PETSC_DECIDE)
10559: -    reuse - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX

10561:    Output Parameter:
10562: .    mpimat - the parallel matrix generated

10564:     Level: advanced

10566:    Notes:
10567:     The number of columns of the matrix in EACH processor MUST be the same.

10569: @*/
10570: PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm comm,Mat seqmat,PetscInt n,MatReuse reuse,Mat *mpimat)
10571: {

10575:   if (!seqmat->ops->creatempimatconcatenateseqmat) SETERRQ1(PetscObjectComm((PetscObject)seqmat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)seqmat)->type_name);
10576:   if (reuse == MAT_REUSE_MATRIX && seqmat == *mpimat) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MAT_REUSE_MATRIX means reuse the matrix passed in as the final argument, not the original matrix");

10578:   PetscLogEventBegin(MAT_Merge,seqmat,0,0,0);
10579:   (*seqmat->ops->creatempimatconcatenateseqmat)(comm,seqmat,n,reuse,mpimat);
10580:   PetscLogEventEnd(MAT_Merge,seqmat,0,0,0);
10581:   return(0);
10582: }

10584: /*@
10585:      MatSubdomainsCreateCoalesce - Creates index subdomains by coalescing adjacent
10586:                  ranks' ownership ranges.

10588:     Collective on A

10590:    Input Parameters:
10591: +    A   - the matrix to create subdomains from
10592: -    N   - requested number of subdomains


10595:    Output Parameters:
10596: +    n   - number of subdomains resulting on this rank
10597: -    iss - IS list with indices of subdomains on this rank

10599:     Level: advanced

10601:     Notes:
10602:     number of subdomains must be smaller than the communicator size
10603: @*/
10604: PetscErrorCode MatSubdomainsCreateCoalesce(Mat A,PetscInt N,PetscInt *n,IS *iss[])
10605: {
10606:   MPI_Comm        comm,subcomm;
10607:   PetscMPIInt     size,rank,color;
10608:   PetscInt        rstart,rend,k;
10609:   PetscErrorCode  ierr;

10612:   PetscObjectGetComm((PetscObject)A,&comm);
10613:   MPI_Comm_size(comm,&size);
10614:   MPI_Comm_rank(comm,&rank);
10615:   if (N < 1 || N >= (PetscInt)size) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"number of subdomains must be > 0 and < %D, got N = %D",size,N);
10616:   *n = 1;
10617:   k = ((PetscInt)size)/N + ((PetscInt)size%N>0); /* There are up to k ranks to a color */
10618:   color = rank/k;
10619:   MPI_Comm_split(comm,color,rank,&subcomm);
10620:   PetscMalloc1(1,iss);
10621:   MatGetOwnershipRange(A,&rstart,&rend);
10622:   ISCreateStride(subcomm,rend-rstart,rstart,1,iss[0]);
10623:   MPI_Comm_free(&subcomm);
10624:   return(0);
10625: }

10627: /*@
10628:    MatGalerkin - Constructs the coarse grid problem via Galerkin projection.

10630:    If the interpolation and restriction operators are the same, uses MatPtAP.
10631:    If they are not the same, use MatMatMatMult.

10633:    Once the coarse grid problem is constructed, correct for interpolation operators
10634:    that are not of full rank, which can legitimately happen in the case of non-nested
10635:    geometric multigrid.

10637:    Input Parameters:
10638: +  restrct - restriction operator
10639: .  dA - fine grid matrix
10640: .  interpolate - interpolation operator
10641: .  reuse - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
10642: -  fill - expected fill, use PETSC_DEFAULT if you do not have a good estimate

10644:    Output Parameters:
10645: .  A - the Galerkin coarse matrix

10647:    Options Database Key:
10648: .  -pc_mg_galerkin <both,pmat,mat,none>

10650:    Level: developer

10652: .seealso: MatPtAP(), MatMatMatMult()
10653: @*/
10654: PetscErrorCode  MatGalerkin(Mat restrct, Mat dA, Mat interpolate, MatReuse reuse, PetscReal fill, Mat *A)
10655: {
10657:   IS             zerorows;
10658:   Vec            diag;

10661:   if (reuse == MAT_INPLACE_MATRIX) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Inplace product not supported");
10662:   /* Construct the coarse grid matrix */
10663:   if (interpolate == restrct) {
10664:     MatPtAP(dA,interpolate,reuse,fill,A);
10665:   } else {
10666:     MatMatMatMult(restrct,dA,interpolate,reuse,fill,A);
10667:   }

10669:   /* If the interpolation matrix is not of full rank, A will have zero rows.
10670:      This can legitimately happen in the case of non-nested geometric multigrid.
10671:      In that event, we set the rows of the matrix to the rows of the identity,
10672:      ignoring the equations (as the RHS will also be zero). */

10674:   MatFindZeroRows(*A, &zerorows);

10676:   if (zerorows != NULL) { /* if there are any zero rows */
10677:     MatCreateVecs(*A, &diag, NULL);
10678:     MatGetDiagonal(*A, diag);
10679:     VecISSet(diag, zerorows, 1.0);
10680:     MatDiagonalSet(*A, diag, INSERT_VALUES);
10681:     VecDestroy(&diag);
10682:     ISDestroy(&zerorows);
10683:   }
10684:   return(0);
10685: }

10687: /*@C
10688:     MatSetOperation - Allows user to set a matrix operation for any matrix type

10690:    Logically Collective on Mat

10692:     Input Parameters:
10693: +   mat - the matrix
10694: .   op - the name of the operation
10695: -   f - the function that provides the operation

10697:    Level: developer

10699:     Usage:
10700: $      extern PetscErrorCode usermult(Mat,Vec,Vec);
10701: $      MatCreateXXX(comm,...&A);
10702: $      MatSetOperation(A,MATOP_MULT,(void(*)(void))usermult);

10704:     Notes:
10705:     See the file include/petscmat.h for a complete list of matrix
10706:     operations, which all have the form MATOP_<OPERATION>, where
10707:     <OPERATION> is the name (in all capital letters) of the
10708:     user interface routine (e.g., MatMult() -> MATOP_MULT).

10710:     All user-provided functions (except for MATOP_DESTROY) should have the same calling
10711:     sequence as the usual matrix interface routines, since they
10712:     are intended to be accessed via the usual matrix interface
10713:     routines, e.g.,
10714: $       MatMult(Mat,Vec,Vec) -> usermult(Mat,Vec,Vec)

10716:     In particular each function MUST return an error code of 0 on success and
10717:     nonzero on failure.

10719:     This routine is distinct from MatShellSetOperation() in that it can be called on any matrix type.

10721: .seealso: MatGetOperation(), MatCreateShell(), MatShellSetContext(), MatShellSetOperation()
10722: @*/
10723: PetscErrorCode MatSetOperation(Mat mat,MatOperation op,void (*f)(void))
10724: {
10727:   if (op == MATOP_VIEW && !mat->ops->viewnative && f != (void (*)(void))(mat->ops->view)) {
10728:     mat->ops->viewnative = mat->ops->view;
10729:   }
10730:   (((void(**)(void))mat->ops)[op]) = f;
10731:   return(0);
10732: }

10734: /*@C
10735:     MatGetOperation - Gets a matrix operation for any matrix type.

10737:     Not Collective

10739:     Input Parameters:
10740: +   mat - the matrix
10741: -   op - the name of the operation

10743:     Output Parameter:
10744: .   f - the function that provides the operation

10746:     Level: developer

10748:     Usage:
10749: $      PetscErrorCode (*usermult)(Mat,Vec,Vec);
10750: $      MatGetOperation(A,MATOP_MULT,(void(**)(void))&usermult);

10752:     Notes:
10753:     See the file include/petscmat.h for a complete list of matrix
10754:     operations, which all have the form MATOP_<OPERATION>, where
10755:     <OPERATION> is the name (in all capital letters) of the
10756:     user interface routine (e.g., MatMult() -> MATOP_MULT).

10758:     This routine is distinct from MatShellGetOperation() in that it can be called on any matrix type.

10760: .seealso: MatSetOperation(), MatCreateShell(), MatShellGetContext(), MatShellGetOperation()
10761: @*/
10762: PetscErrorCode MatGetOperation(Mat mat,MatOperation op,void(**f)(void))
10763: {
10766:   *f = (((void (**)(void))mat->ops)[op]);
10767:   return(0);
10768: }

10770: /*@
10771:     MatHasOperation - Determines whether the given matrix supports the particular
10772:     operation.

10774:    Not Collective

10776:    Input Parameters:
10777: +  mat - the matrix
10778: -  op - the operation, for example, MATOP_GET_DIAGONAL

10780:    Output Parameter:
10781: .  has - either PETSC_TRUE or PETSC_FALSE

10783:    Level: advanced

10785:    Notes:
10786:    See the file include/petscmat.h for a complete list of matrix
10787:    operations, which all have the form MATOP_<OPERATION>, where
10788:    <OPERATION> is the name (in all capital letters) of the
10789:    user-level routine.  E.g., MatNorm() -> MATOP_NORM.

10791: .seealso: MatCreateShell()
10792: @*/
10793: PetscErrorCode MatHasOperation(Mat mat,MatOperation op,PetscBool *has)
10794: {

10799:   /* symbolic product can be set before matrix type */
10802:   if (mat->ops->hasoperation) {
10803:     (*mat->ops->hasoperation)(mat,op,has);
10804:   } else {
10805:     if (((void**)mat->ops)[op]) *has =  PETSC_TRUE;
10806:     else {
10807:       *has = PETSC_FALSE;
10808:       if (op == MATOP_CREATE_SUBMATRIX) {
10809:         PetscMPIInt size;

10811:         MPI_Comm_size(PetscObjectComm((PetscObject)mat),&size);
10812:         if (size == 1) {
10813:           MatHasOperation(mat,MATOP_CREATE_SUBMATRICES,has);
10814:         }
10815:       }
10816:     }
10817:   }
10818:   return(0);
10819: }

10821: /*@
10822:     MatHasCongruentLayouts - Determines whether the rows and columns layouts
10823:     of the matrix are congruent

10825:    Collective on mat

10827:    Input Parameters:
10828: .  mat - the matrix

10830:    Output Parameter:
10831: .  cong - either PETSC_TRUE or PETSC_FALSE

10833:    Level: beginner

10835:    Notes:

10837: .seealso: MatCreate(), MatSetSizes()
10838: @*/
10839: PetscErrorCode MatHasCongruentLayouts(Mat mat,PetscBool *cong)
10840: {

10847:   if (!mat->rmap || !mat->cmap) {
10848:     *cong = mat->rmap == mat->cmap ? PETSC_TRUE : PETSC_FALSE;
10849:     return(0);
10850:   }
10851:   if (mat->congruentlayouts == PETSC_DECIDE) { /* first time we compare rows and cols layouts */
10852:     PetscLayoutCompare(mat->rmap,mat->cmap,cong);
10853:     if (*cong) mat->congruentlayouts = 1;
10854:     else       mat->congruentlayouts = 0;
10855:   } else *cong = mat->congruentlayouts ? PETSC_TRUE : PETSC_FALSE;
10856:   return(0);
10857: }

10859: PetscErrorCode MatSetInf(Mat A)
10860: {

10864:   if (!A->ops->setinf) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"No support for this operation for this matrix type");
10865:   (*A->ops->setinf)(A);
10866:   return(0);
10867: }