xref: /petsc/src/mat/interface/matrix.c (revision bb1d7374b64f295b2ed5ff23b89435d65e905a54)
1 
2 /*
3    This is where the abstract matrix operations are defined
4 */
5 
6 #include <petsc/private/matimpl.h>        /*I "petscmat.h" I*/
7 #include <petsc/private/vecimpl.h>
8 #include <petsc/private/isimpl.h>
9 
10 /* Logging support */
11 PetscClassId MAT_CLASSID;
12 PetscClassId MAT_COLORING_CLASSID;
13 PetscClassId MAT_FDCOLORING_CLASSID;
14 PetscClassId MAT_TRANSPOSECOLORING_CLASSID;
15 
16 PetscLogEvent MAT_Mult, MAT_Mults, MAT_MultConstrained, MAT_MultAdd, MAT_MultTranspose;
17 PetscLogEvent MAT_MultTransposeConstrained, MAT_MultTransposeAdd, MAT_Solve, MAT_Solves, MAT_SolveAdd, MAT_SolveTranspose, MAT_MatSolve;
18 PetscLogEvent MAT_SolveTransposeAdd, MAT_SOR, MAT_ForwardSolve, MAT_BackwardSolve, MAT_LUFactor, MAT_LUFactorSymbolic;
19 PetscLogEvent MAT_LUFactorNumeric, MAT_CholeskyFactor, MAT_CholeskyFactorSymbolic, MAT_CholeskyFactorNumeric, MAT_ILUFactor;
20 PetscLogEvent MAT_ILUFactorSymbolic, MAT_ICCFactorSymbolic, MAT_Copy, MAT_Convert, MAT_Scale, MAT_AssemblyBegin;
21 PetscLogEvent MAT_AssemblyEnd, MAT_SetValues, MAT_GetValues, MAT_GetRow, MAT_GetRowIJ, MAT_GetSubMatrices, MAT_GetOrdering, MAT_RedundantMat, MAT_GetSeqNonzeroStructure;
22 PetscLogEvent MAT_IncreaseOverlap, MAT_Partitioning, MAT_Coarsen, MAT_ZeroEntries, MAT_Load, MAT_View, MAT_AXPY, MAT_FDColoringCreate;
23 PetscLogEvent MAT_FDColoringSetUp, MAT_FDColoringApply,MAT_Transpose,MAT_FDColoringFunction, MAT_GetSubMatrix;
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_Transpose_SeqAIJ, 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_CUSPCopyToGPU, MAT_CUSPARSECopyToGPU, MAT_SetValuesBatch, MAT_SetValuesBatchI, MAT_SetValuesBatchII, MAT_SetValuesBatchIII, MAT_SetValuesBatchIV;
36 PetscLogEvent MAT_ViennaCLCopyToGPU;
37 PetscLogEvent MAT_Merge,MAT_Residual;
38 PetscLogEvent Mat_Coloring_Apply,Mat_Coloring_Comm,Mat_Coloring_Local,Mat_Coloring_ISCreate,Mat_Coloring_SetUp,Mat_Coloring_Weights;
39 
40 const char *const MatFactorTypes[] = {"NONE","LU","CHOLESKY","ILU","ICC","ILUDT","MatFactorType","MAT_FACTOR_",0};
41 
42 #undef __FUNCT__
43 #define __FUNCT__ "MatSetRandom"
44 /*@
45    MatSetRandom - Sets all components of a matrix to random numbers. For sparse matrices that have been preallocated it randomly selects appropriate locations
46 
47    Logically Collective on Vec
48 
49    Input Parameters:
50 +  x  - the vector
51 -  rctx - the random number context, formed by PetscRandomCreate(), or NULL and
52           it will create one internally.
53 
54    Output Parameter:
55 .  x  - the vector
56 
57    Example of Usage:
58 .vb
59      PetscRandomCreate(PETSC_COMM_WORLD,&rctx);
60      VecSetRandom(x,rctx);
61      PetscRandomDestroy(rctx);
62 .ve
63 
64    Level: intermediate
65 
66    Concepts: vector^setting to random
67    Concepts: random^vector
68 
69 .seealso: MatZeroEntries(), MatSetValues(), PetscRandomCreate(), PetscRandomDestroy()
70 @*/
71 PetscErrorCode  MatSetRandom(Mat x,PetscRandom rctx)
72 {
73   PetscErrorCode ierr;
74   PetscRandom    randObj = NULL;
75 
76   PetscFunctionBegin;
77   PetscValidHeaderSpecific(x,MAT_CLASSID,1);
78   if (rctx) PetscValidHeaderSpecific(rctx,PETSC_RANDOM_CLASSID,2);
79   PetscValidType(x,1);
80 
81   if (!rctx) {
82     MPI_Comm comm;
83     ierr = PetscObjectGetComm((PetscObject)x,&comm);CHKERRQ(ierr);
84     ierr = PetscRandomCreate(comm,&randObj);CHKERRQ(ierr);
85     ierr = PetscRandomSetFromOptions(randObj);CHKERRQ(ierr);
86     rctx = randObj;
87   }
88 
89   ierr = PetscLogEventBegin(VEC_SetRandom,x,rctx,0,0);CHKERRQ(ierr);
90   ierr = (*x->ops->setrandom)(x,rctx);CHKERRQ(ierr);
91   ierr = PetscLogEventEnd(VEC_SetRandom,x,rctx,0,0);CHKERRQ(ierr);
92 
93   x->assembled = PETSC_TRUE;
94   ierr         = PetscRandomDestroy(&randObj);CHKERRQ(ierr);
95   PetscFunctionReturn(0);
96 }
97 
98 
99 #undef __FUNCT__
100 #define __FUNCT__ "MatFindNonzeroRows"
101 /*@
102       MatFindNonzeroRows - Locate all rows that are not completely zero in the matrix
103 
104   Input Parameter:
105 .    A  - the matrix
106 
107   Output Parameter:
108 .    keptrows - the rows that are not completely zero
109 
110   Level: intermediate
111 
112  @*/
113 PetscErrorCode MatFindNonzeroRows(Mat mat,IS *keptrows)
114 {
115   PetscErrorCode ierr;
116 
117   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
118   PetscValidType(mat,1);
119   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
120   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
121   if (!mat->ops->findnonzerorows) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Not coded for this matrix type");
122   ierr = (*mat->ops->findnonzerorows)(mat,keptrows);CHKERRQ(ierr);
123   PetscFunctionReturn(0);
124 }
125 
126 #undef __FUNCT__
127 #define __FUNCT__ "MatGetDiagonalBlock"
128 /*@
129    MatGetDiagonalBlock - Returns the part of the matrix associated with the on-process coupling
130 
131    Not Collective
132 
133    Input Parameters:
134 .   A - the matrix
135 
136    Output Parameters:
137 .   a - the diagonal part (which is a SEQUENTIAL matrix)
138 
139    Notes: see the manual page for MatCreateAIJ() for more information on the "diagonal part" of the matrix.
140           Use caution, as the reference count on the returned matrix is not incremented and it is used as
141 	  part of the containing MPI Mat's normal operation.
142 
143    Level: advanced
144 
145 @*/
146 PetscErrorCode  MatGetDiagonalBlock(Mat A,Mat *a)
147 {
148   PetscErrorCode ierr,(*f)(Mat,Mat*);
149   PetscMPIInt    size;
150 
151   PetscFunctionBegin;
152   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
153   PetscValidType(A,1);
154   PetscValidPointer(a,3);
155   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
156   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);CHKERRQ(ierr);
157   ierr = PetscObjectQueryFunction((PetscObject)A,"MatGetDiagonalBlock_C",&f);CHKERRQ(ierr);
158   if (f) {
159     ierr = (*f)(A,a);CHKERRQ(ierr);
160     PetscFunctionReturn(0);
161   } else if (size == 1) {
162     *a = A;
163   } else {
164     MatType mattype;
165     ierr = MatGetType(A,&mattype);CHKERRQ(ierr);
166     SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Matrix type %s does not support getting diagonal block",mattype);
167   }
168   PetscFunctionReturn(0);
169 }
170 
171 #undef __FUNCT__
172 #define __FUNCT__ "MatGetTrace"
173 /*@
174    MatGetTrace - Gets the trace of a matrix. The sum of the diagonal entries.
175 
176    Collective on Mat
177 
178    Input Parameters:
179 .  mat - the matrix
180 
181    Output Parameter:
182 .   trace - the sum of the diagonal entries
183 
184    Level: advanced
185 
186 @*/
187 PetscErrorCode  MatGetTrace(Mat mat,PetscScalar *trace)
188 {
189   PetscErrorCode ierr;
190   Vec            diag;
191 
192   PetscFunctionBegin;
193   ierr = MatCreateVecs(mat,&diag,NULL);CHKERRQ(ierr);
194   ierr = MatGetDiagonal(mat,diag);CHKERRQ(ierr);
195   ierr = VecSum(diag,trace);CHKERRQ(ierr);
196   ierr = VecDestroy(&diag);CHKERRQ(ierr);
197   PetscFunctionReturn(0);
198 }
199 
200 #undef __FUNCT__
201 #define __FUNCT__ "MatRealPart"
202 /*@
203    MatRealPart - Zeros out the imaginary part of the matrix
204 
205    Logically Collective on Mat
206 
207    Input Parameters:
208 .  mat - the matrix
209 
210    Level: advanced
211 
212 
213 .seealso: MatImaginaryPart()
214 @*/
215 PetscErrorCode  MatRealPart(Mat mat)
216 {
217   PetscErrorCode ierr;
218 
219   PetscFunctionBegin;
220   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
221   PetscValidType(mat,1);
222   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
223   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
224   if (!mat->ops->realpart) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
225   MatCheckPreallocated(mat,1);
226   ierr = (*mat->ops->realpart)(mat);CHKERRQ(ierr);
227 #if defined(PETSC_HAVE_CUSP)
228   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
229     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
230   }
231 #endif
232 #if defined(PETSC_HAVE_VIENNACL)
233   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
234     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
235   }
236 #endif
237   PetscFunctionReturn(0);
238 }
239 
240 #undef __FUNCT__
241 #define __FUNCT__ "MatGetGhosts"
242 /*@C
243    MatGetGhosts - Get the global index of all ghost nodes defined by the sparse matrix
244 
245    Collective on Mat
246 
247    Input Parameter:
248 .  mat - the matrix
249 
250    Output Parameters:
251 +   nghosts - number of ghosts (note for BAIJ matrices there is one ghost for each block)
252 -   ghosts - the global indices of the ghost points
253 
254    Notes: the nghosts and ghosts are suitable to pass into VecCreateGhost()
255 
256    Level: advanced
257 
258 @*/
259 PetscErrorCode  MatGetGhosts(Mat mat,PetscInt *nghosts,const PetscInt *ghosts[])
260 {
261   PetscErrorCode ierr;
262 
263   PetscFunctionBegin;
264   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
265   PetscValidType(mat,1);
266   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
267   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
268   if (!mat->ops->getghosts) {
269     if (nghosts) *nghosts = 0;
270     if (ghosts) *ghosts = 0;
271   } else {
272     ierr = (*mat->ops->getghosts)(mat,nghosts,ghosts);CHKERRQ(ierr);
273   }
274   PetscFunctionReturn(0);
275 }
276 
277 
278 #undef __FUNCT__
279 #define __FUNCT__ "MatImaginaryPart"
280 /*@
281    MatImaginaryPart - Moves the imaginary part of the matrix to the real part and zeros the imaginary part
282 
283    Logically Collective on Mat
284 
285    Input Parameters:
286 .  mat - the matrix
287 
288    Level: advanced
289 
290 
291 .seealso: MatRealPart()
292 @*/
293 PetscErrorCode  MatImaginaryPart(Mat mat)
294 {
295   PetscErrorCode ierr;
296 
297   PetscFunctionBegin;
298   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
299   PetscValidType(mat,1);
300   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
301   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
302   if (!mat->ops->imaginarypart) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
303   MatCheckPreallocated(mat,1);
304   ierr = (*mat->ops->imaginarypart)(mat);CHKERRQ(ierr);
305 #if defined(PETSC_HAVE_CUSP)
306   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
307     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
308   }
309 #endif
310 #if defined(PETSC_HAVE_VIENNACL)
311   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
312     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
313   }
314 #endif
315   PetscFunctionReturn(0);
316 }
317 
318 #undef __FUNCT__
319 #define __FUNCT__ "MatMissingDiagonal"
320 /*@
321    MatMissingDiagonal - Determine if sparse matrix is missing a diagonal entry (or block entry for BAIJ matrices)
322 
323    Collective on Mat
324 
325    Input Parameter:
326 .  mat - the matrix
327 
328    Output Parameters:
329 +  missing - is any diagonal missing
330 -  dd - first diagonal entry that is missing (optional)
331 
332    Level: advanced
333 
334 
335 .seealso: MatRealPart()
336 @*/
337 PetscErrorCode  MatMissingDiagonal(Mat mat,PetscBool *missing,PetscInt *dd)
338 {
339   PetscErrorCode ierr;
340 
341   PetscFunctionBegin;
342   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
343   PetscValidType(mat,1);
344   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
345   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
346   if (!mat->ops->missingdiagonal) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
347   ierr = (*mat->ops->missingdiagonal)(mat,missing,dd);CHKERRQ(ierr);
348   PetscFunctionReturn(0);
349 }
350 
351 #undef __FUNCT__
352 #define __FUNCT__ "MatGetRow"
353 /*@C
354    MatGetRow - Gets a row of a matrix.  You MUST call MatRestoreRow()
355    for each row that you get to ensure that your application does
356    not bleed memory.
357 
358    Not Collective
359 
360    Input Parameters:
361 +  mat - the matrix
362 -  row - the row to get
363 
364    Output Parameters:
365 +  ncols -  if not NULL, the number of nonzeros in the row
366 .  cols - if not NULL, the column numbers
367 -  vals - if not NULL, the values
368 
369    Notes:
370    This routine is provided for people who need to have direct access
371    to the structure of a matrix.  We hope that we provide enough
372    high-level matrix routines that few users will need it.
373 
374    MatGetRow() always returns 0-based column indices, regardless of
375    whether the internal representation is 0-based (default) or 1-based.
376 
377    For better efficiency, set cols and/or vals to NULL if you do
378    not wish to extract these quantities.
379 
380    The user can only examine the values extracted with MatGetRow();
381    the values cannot be altered.  To change the matrix entries, one
382    must use MatSetValues().
383 
384    You can only have one call to MatGetRow() outstanding for a particular
385    matrix at a time, per processor. MatGetRow() can only obtain rows
386    associated with the given processor, it cannot get rows from the
387    other processors; for that we suggest using MatGetSubMatrices(), then
388    MatGetRow() on the submatrix. The row indix passed to MatGetRows()
389    is in the global number of rows.
390 
391    Fortran Notes:
392    The calling sequence from Fortran is
393 .vb
394    MatGetRow(matrix,row,ncols,cols,values,ierr)
395          Mat     matrix (input)
396          integer row    (input)
397          integer ncols  (output)
398          integer cols(maxcols) (output)
399          double precision (or double complex) values(maxcols) output
400 .ve
401    where maxcols >= maximum nonzeros in any row of the matrix.
402 
403 
404    Caution:
405    Do not try to change the contents of the output arrays (cols and vals).
406    In some cases, this may corrupt the matrix.
407 
408    Level: advanced
409 
410    Concepts: matrices^row access
411 
412 .seealso: MatRestoreRow(), MatSetValues(), MatGetValues(), MatGetSubMatrices(), MatGetDiagonal()
413 @*/
414 PetscErrorCode MatGetRow(Mat mat,PetscInt row,PetscInt *ncols,const PetscInt *cols[],const PetscScalar *vals[])
415 {
416   PetscErrorCode ierr;
417   PetscInt       incols;
418 
419   PetscFunctionBegin;
420   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
421   PetscValidType(mat,1);
422   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
423   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
424   if (!mat->ops->getrow) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
425   MatCheckPreallocated(mat,1);
426   ierr = PetscLogEventBegin(MAT_GetRow,mat,0,0,0);CHKERRQ(ierr);
427   ierr = (*mat->ops->getrow)(mat,row,&incols,(PetscInt**)cols,(PetscScalar**)vals);CHKERRQ(ierr);
428   if (ncols) *ncols = incols;
429   ierr = PetscLogEventEnd(MAT_GetRow,mat,0,0,0);CHKERRQ(ierr);
430   PetscFunctionReturn(0);
431 }
432 
433 #undef __FUNCT__
434 #define __FUNCT__ "MatConjugate"
435 /*@
436    MatConjugate - replaces the matrix values with their complex conjugates
437 
438    Logically Collective on Mat
439 
440    Input Parameters:
441 .  mat - the matrix
442 
443    Level: advanced
444 
445 .seealso:  VecConjugate()
446 @*/
447 PetscErrorCode  MatConjugate(Mat mat)
448 {
449 #if defined(PETSC_USE_COMPLEX)
450   PetscErrorCode ierr;
451 
452   PetscFunctionBegin;
453   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
454   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
455   if (!mat->ops->conjugate) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Not provided for this matrix format, send email to petsc-maint@mcs.anl.gov");
456   ierr = (*mat->ops->conjugate)(mat);CHKERRQ(ierr);
457 #if defined(PETSC_HAVE_CUSP)
458   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
459     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
460   }
461 #endif
462 #if defined(PETSC_HAVE_VIENNACL)
463   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
464     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
465   }
466 #endif
467   PetscFunctionReturn(0);
468 #else
469   return 0;
470 #endif
471 }
472 
473 #undef __FUNCT__
474 #define __FUNCT__ "MatRestoreRow"
475 /*@C
476    MatRestoreRow - Frees any temporary space allocated by MatGetRow().
477 
478    Not Collective
479 
480    Input Parameters:
481 +  mat - the matrix
482 .  row - the row to get
483 .  ncols, cols - the number of nonzeros and their columns
484 -  vals - if nonzero the column values
485 
486    Notes:
487    This routine should be called after you have finished examining the entries.
488 
489    This routine zeros out ncols, cols, and vals. This is to prevent accidental
490    us of the array after it has been restored. If you pass NULL, it will
491    not zero the pointers.  Use of cols or vals after MatRestoreRow is invalid.
492 
493    Fortran Notes:
494    The calling sequence from Fortran is
495 .vb
496    MatRestoreRow(matrix,row,ncols,cols,values,ierr)
497       Mat     matrix (input)
498       integer row    (input)
499       integer ncols  (output)
500       integer cols(maxcols) (output)
501       double precision (or double complex) values(maxcols) output
502 .ve
503    Where maxcols >= maximum nonzeros in any row of the matrix.
504 
505    In Fortran MatRestoreRow() MUST be called after MatGetRow()
506    before another call to MatGetRow() can be made.
507 
508    Level: advanced
509 
510 .seealso:  MatGetRow()
511 @*/
512 PetscErrorCode MatRestoreRow(Mat mat,PetscInt row,PetscInt *ncols,const PetscInt *cols[],const PetscScalar *vals[])
513 {
514   PetscErrorCode ierr;
515 
516   PetscFunctionBegin;
517   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
518   if (ncols) PetscValidIntPointer(ncols,3);
519   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
520   if (!mat->ops->restorerow) PetscFunctionReturn(0);
521   ierr = (*mat->ops->restorerow)(mat,row,ncols,(PetscInt **)cols,(PetscScalar **)vals);CHKERRQ(ierr);
522   if (ncols) *ncols = 0;
523   if (cols)  *cols = NULL;
524   if (vals)  *vals = NULL;
525   PetscFunctionReturn(0);
526 }
527 
528 #undef __FUNCT__
529 #define __FUNCT__ "MatGetRowUpperTriangular"
530 /*@
531    MatGetRowUpperTriangular - Sets a flag to enable calls to MatGetRow() for matrix in MATSBAIJ format.
532    You should call MatRestoreRowUpperTriangular() after calling MatGetRow/MatRestoreRow() to disable the flag.
533 
534    Not Collective
535 
536    Input Parameters:
537 +  mat - the matrix
538 
539    Notes:
540    The flag is to ensure that users are aware of MatGetRow() only provides the upper trianglular part of the row for the matrices in MATSBAIJ format.
541 
542    Level: advanced
543 
544    Concepts: matrices^row access
545 
546 .seealso: MatRestoreRowRowUpperTriangular()
547 @*/
548 PetscErrorCode  MatGetRowUpperTriangular(Mat mat)
549 {
550   PetscErrorCode ierr;
551 
552   PetscFunctionBegin;
553   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
554   PetscValidType(mat,1);
555   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
556   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
557   if (!mat->ops->getrowuppertriangular) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
558   MatCheckPreallocated(mat,1);
559   ierr = (*mat->ops->getrowuppertriangular)(mat);CHKERRQ(ierr);
560   PetscFunctionReturn(0);
561 }
562 
563 #undef __FUNCT__
564 #define __FUNCT__ "MatRestoreRowUpperTriangular"
565 /*@
566    MatRestoreRowUpperTriangular - Disable calls to MatGetRow() for matrix in MATSBAIJ format.
567 
568    Not Collective
569 
570    Input Parameters:
571 +  mat - the matrix
572 
573    Notes:
574    This routine should be called after you have finished MatGetRow/MatRestoreRow().
575 
576 
577    Level: advanced
578 
579 .seealso:  MatGetRowUpperTriangular()
580 @*/
581 PetscErrorCode  MatRestoreRowUpperTriangular(Mat mat)
582 {
583   PetscErrorCode ierr;
584 
585   PetscFunctionBegin;
586   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
587   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
588   if (!mat->ops->restorerowuppertriangular) PetscFunctionReturn(0);
589   ierr = (*mat->ops->restorerowuppertriangular)(mat);CHKERRQ(ierr);
590   PetscFunctionReturn(0);
591 }
592 
593 #undef __FUNCT__
594 #define __FUNCT__ "MatSetOptionsPrefix"
595 /*@C
596    MatSetOptionsPrefix - Sets the prefix used for searching for all
597    Mat options in the database.
598 
599    Logically Collective on Mat
600 
601    Input Parameter:
602 +  A - the Mat context
603 -  prefix - the prefix to prepend to all option names
604 
605    Notes:
606    A hyphen (-) must NOT be given at the beginning of the prefix name.
607    The first character of all runtime options is AUTOMATICALLY the hyphen.
608 
609    Level: advanced
610 
611 .keywords: Mat, set, options, prefix, database
612 
613 .seealso: MatSetFromOptions()
614 @*/
615 PetscErrorCode  MatSetOptionsPrefix(Mat A,const char prefix[])
616 {
617   PetscErrorCode ierr;
618 
619   PetscFunctionBegin;
620   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
621   ierr = PetscObjectSetOptionsPrefix((PetscObject)A,prefix);CHKERRQ(ierr);
622   PetscFunctionReturn(0);
623 }
624 
625 #undef __FUNCT__
626 #define __FUNCT__ "MatAppendOptionsPrefix"
627 /*@C
628    MatAppendOptionsPrefix - Appends to the prefix used for searching for all
629    Mat options in the database.
630 
631    Logically Collective on Mat
632 
633    Input Parameters:
634 +  A - the Mat context
635 -  prefix - the prefix to prepend to all option names
636 
637    Notes:
638    A hyphen (-) must NOT be given at the beginning of the prefix name.
639    The first character of all runtime options is AUTOMATICALLY the hyphen.
640 
641    Level: advanced
642 
643 .keywords: Mat, append, options, prefix, database
644 
645 .seealso: MatGetOptionsPrefix()
646 @*/
647 PetscErrorCode  MatAppendOptionsPrefix(Mat A,const char prefix[])
648 {
649   PetscErrorCode ierr;
650 
651   PetscFunctionBegin;
652   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
653   ierr = PetscObjectAppendOptionsPrefix((PetscObject)A,prefix);CHKERRQ(ierr);
654   PetscFunctionReturn(0);
655 }
656 
657 #undef __FUNCT__
658 #define __FUNCT__ "MatGetOptionsPrefix"
659 /*@C
660    MatGetOptionsPrefix - Sets the prefix used for searching for all
661    Mat options in the database.
662 
663    Not Collective
664 
665    Input Parameter:
666 .  A - the Mat context
667 
668    Output Parameter:
669 .  prefix - pointer to the prefix string used
670 
671    Notes: On the fortran side, the user should pass in a string 'prefix' of
672    sufficient length to hold the prefix.
673 
674    Level: advanced
675 
676 .keywords: Mat, get, options, prefix, database
677 
678 .seealso: MatAppendOptionsPrefix()
679 @*/
680 PetscErrorCode  MatGetOptionsPrefix(Mat A,const char *prefix[])
681 {
682   PetscErrorCode ierr;
683 
684   PetscFunctionBegin;
685   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
686   ierr = PetscObjectGetOptionsPrefix((PetscObject)A,prefix);CHKERRQ(ierr);
687   PetscFunctionReturn(0);
688 }
689 
690 #undef __FUNCT__
691 #define __FUNCT__ "MatSetUp"
692 /*@
693    MatSetUp - Sets up the internal matrix data structures for the later use.
694 
695    Collective on Mat
696 
697    Input Parameters:
698 .  A - the Mat context
699 
700    Notes:
701    If the user has not set preallocation for this matrix then a default preallocation that is likely to be inefficient is used.
702 
703    If a suitable preallocation routine is used, this function does not need to be called.
704 
705    See the Performance chapter of the PETSc users manual for how to preallocate matrices
706 
707    Level: beginner
708 
709 .keywords: Mat, setup
710 
711 .seealso: MatCreate(), MatDestroy()
712 @*/
713 PetscErrorCode  MatSetUp(Mat A)
714 {
715   PetscMPIInt    size;
716   PetscErrorCode ierr;
717 
718   PetscFunctionBegin;
719   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
720   if (!((PetscObject)A)->type_name) {
721     ierr = MPI_Comm_size(PetscObjectComm((PetscObject)A), &size);CHKERRQ(ierr);
722     if (size == 1) {
723       ierr = MatSetType(A, MATSEQAIJ);CHKERRQ(ierr);
724     } else {
725       ierr = MatSetType(A, MATMPIAIJ);CHKERRQ(ierr);
726     }
727   }
728   if (!A->preallocated && A->ops->setup) {
729     ierr = PetscInfo(A,"Warning not preallocating matrix storage\n");CHKERRQ(ierr);
730     ierr = (*A->ops->setup)(A);CHKERRQ(ierr);
731   }
732   A->preallocated = PETSC_TRUE;
733   PetscFunctionReturn(0);
734 }
735 
736 #if defined(PETSC_HAVE_SAWS)
737 #include <petscviewersaws.h>
738 #endif
739 #undef __FUNCT__
740 #define __FUNCT__ "MatView"
741 /*@C
742    MatView - Visualizes a matrix object.
743 
744    Collective on Mat
745 
746    Input Parameters:
747 +  mat - the matrix
748 -  viewer - visualization context
749 
750   Notes:
751   The available visualization contexts include
752 +    PETSC_VIEWER_STDOUT_SELF - for sequential matrices
753 .    PETSC_VIEWER_STDOUT_WORLD - for parallel matrices created on PETSC_COMM_WORLD
754 .    PETSC_VIEWER_STDOUT_(comm) - for matrices created on MPI communicator comm
755 -     PETSC_VIEWER_DRAW_WORLD - graphical display of nonzero structure
756 
757    The user can open alternative visualization contexts with
758 +    PetscViewerASCIIOpen() - Outputs matrix to a specified file
759 .    PetscViewerBinaryOpen() - Outputs matrix in binary to a
760          specified file; corresponding input uses MatLoad()
761 .    PetscViewerDrawOpen() - Outputs nonzero matrix structure to
762          an X window display
763 -    PetscViewerSocketOpen() - Outputs matrix to Socket viewer.
764          Currently only the sequential dense and AIJ
765          matrix types support the Socket viewer.
766 
767    The user can call PetscViewerSetFormat() to specify the output
768    format of ASCII printed objects (when using PETSC_VIEWER_STDOUT_SELF,
769    PETSC_VIEWER_STDOUT_WORLD and PetscViewerASCIIOpen).  Available formats include
770 +    PETSC_VIEWER_DEFAULT - default, prints matrix contents
771 .    PETSC_VIEWER_ASCII_MATLAB - prints matrix contents in Matlab format
772 .    PETSC_VIEWER_ASCII_DENSE - prints entire matrix including zeros
773 .    PETSC_VIEWER_ASCII_COMMON - prints matrix contents, using a sparse
774          format common among all matrix types
775 .    PETSC_VIEWER_ASCII_IMPL - prints matrix contents, using an implementation-specific
776          format (which is in many cases the same as the default)
777 .    PETSC_VIEWER_ASCII_INFO - prints basic information about the matrix
778          size and structure (not the matrix entries)
779 .    PETSC_VIEWER_ASCII_INFO_DETAIL - prints more detailed information about
780          the matrix structure
781 
782    Options Database Keys:
783 +  -mat_view ::ascii_info - Prints info on matrix at conclusion of MatEndAssembly()
784 .  -mat_view ::ascii_info_detail - Prints more detailed info
785 .  -mat_view - Prints matrix in ASCII format
786 .  -mat_view ::ascii_matlab - Prints matrix in Matlab format
787 .  -mat_view draw - PetscDraws nonzero structure of matrix, using MatView() and PetscDrawOpenX().
788 .  -display <name> - Sets display name (default is host)
789 .  -draw_pause <sec> - Sets number of seconds to pause after display
790 .  -mat_view socket - Sends matrix to socket, can be accessed from Matlab (see Users-Manual: ch_matlab for details)
791 .  -viewer_socket_machine <machine> -
792 .  -viewer_socket_port <port> -
793 .  -mat_view binary - save matrix to file in binary format
794 -  -viewer_binary_filename <name> -
795    Level: beginner
796 
797    Notes: see the manual page for MatLoad() for the exact format of the binary file when the binary
798       viewer is used.
799 
800       See share/petsc/matlab/PetscBinaryRead.m for a Matlab code that can read in the binary file when the binary
801       viewer is used.
802 
803       One can use '-mat_view draw -draw_pause -1' to pause the graphical display of matrix nonzero structure.
804       And then use the following mouse functions:
805           left mouse: zoom in
806           middle mouse: zoom out
807           right mouse: continue with the simulation
808 
809    Concepts: matrices^viewing
810    Concepts: matrices^plotting
811    Concepts: matrices^printing
812 
813 .seealso: PetscViewerSetFormat(), PetscViewerASCIIOpen(), PetscViewerDrawOpen(),
814           PetscViewerSocketOpen(), PetscViewerBinaryOpen(), MatLoad()
815 @*/
816 PetscErrorCode  MatView(Mat mat,PetscViewer viewer)
817 {
818   PetscErrorCode    ierr;
819   PetscInt          rows,cols,rbs,cbs;
820   PetscBool         iascii;
821   PetscViewerFormat format;
822 #if defined(PETSC_HAVE_SAWS)
823   PetscBool         issaws;
824 #endif
825 
826   PetscFunctionBegin;
827   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
828   PetscValidType(mat,1);
829   if (!viewer) {
830     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)mat),&viewer);CHKERRQ(ierr);
831   }
832   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
833   PetscCheckSameComm(mat,1,viewer,2);
834   MatCheckPreallocated(mat,1);
835 
836   ierr = PetscLogEventBegin(MAT_View,mat,viewer,0,0);CHKERRQ(ierr);
837   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
838   ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr);
839   if ((!iascii || (format != PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL)) && mat->factortype) {
840     SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"No viewers for factored matrix except ASCII info or info_detailed");
841   }
842 
843 #if defined(PETSC_HAVE_SAWS)
844   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
845 #endif
846   if (iascii) {
847     if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ORDER,"Must call MatAssemblyBegin/End() before viewing matrix");
848     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)mat,viewer);CHKERRQ(ierr);
849     if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
850       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
851       ierr = MatGetSize(mat,&rows,&cols);CHKERRQ(ierr);
852       ierr = MatGetBlockSizes(mat,&rbs,&cbs);CHKERRQ(ierr);
853       if (rbs != 1 || cbs != 1) {
854         if (rbs != cbs) {ierr = PetscViewerASCIIPrintf(viewer,"rows=%D, cols=%D, rbs=%D, cbs = %D\n",rows,cols,rbs,cbs);CHKERRQ(ierr);}
855         else            {ierr = PetscViewerASCIIPrintf(viewer,"rows=%D, cols=%D, bs=%D\n",rows,cols,rbs);CHKERRQ(ierr);}
856       } else {
857         ierr = PetscViewerASCIIPrintf(viewer,"rows=%D, cols=%D\n",rows,cols);CHKERRQ(ierr);
858       }
859       if (mat->factortype) {
860         const MatSolverPackage solver;
861         ierr = MatFactorGetSolverPackage(mat,&solver);CHKERRQ(ierr);
862         ierr = PetscViewerASCIIPrintf(viewer,"package used to perform factorization: %s\n",solver);CHKERRQ(ierr);
863       }
864       if (mat->ops->getinfo) {
865         MatInfo info;
866         ierr = MatGetInfo(mat,MAT_GLOBAL_SUM,&info);CHKERRQ(ierr);
867         ierr = PetscViewerASCIIPrintf(viewer,"total: nonzeros=%g, allocated nonzeros=%g\n",info.nz_used,info.nz_allocated);CHKERRQ(ierr);
868         ierr = PetscViewerASCIIPrintf(viewer,"total number of mallocs used during MatSetValues calls =%D\n",(PetscInt)info.mallocs);CHKERRQ(ierr);
869       }
870       if (mat->nullsp) {ierr = PetscViewerASCIIPrintf(viewer,"  has attached null space\n");CHKERRQ(ierr);}
871       if (mat->nearnullsp) {ierr = PetscViewerASCIIPrintf(viewer,"  has attached near null space\n");CHKERRQ(ierr);}
872     }
873 #if defined(PETSC_HAVE_SAWS)
874   } else if (issaws) {
875     PetscMPIInt rank;
876 
877     ierr = PetscObjectName((PetscObject)mat);CHKERRQ(ierr);
878     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
879     if (!((PetscObject)mat)->amsmem && !rank) {
880       ierr = PetscObjectViewSAWs((PetscObject)mat,viewer);CHKERRQ(ierr);
881     }
882 #endif
883   }
884   if (mat->ops->view) {
885     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
886     ierr = (*mat->ops->view)(mat,viewer);CHKERRQ(ierr);
887     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
888   }
889   if (iascii) {
890     if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ORDER,"Must call MatAssemblyBegin/End() before viewing matrix");
891     ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr);
892     if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
893       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
894     }
895   }
896   ierr = PetscLogEventEnd(MAT_View,mat,viewer,0,0);CHKERRQ(ierr);
897   PetscFunctionReturn(0);
898 }
899 
900 #if defined(PETSC_USE_DEBUG)
901 #include <../src/sys/totalview/tv_data_display.h>
902 PETSC_UNUSED static int TV_display_type(const struct _p_Mat *mat)
903 {
904   TV_add_row("Local rows", "int", &mat->rmap->n);
905   TV_add_row("Local columns", "int", &mat->cmap->n);
906   TV_add_row("Global rows", "int", &mat->rmap->N);
907   TV_add_row("Global columns", "int", &mat->cmap->N);
908   TV_add_row("Typename", TV_ascii_string_type, ((PetscObject)mat)->type_name);
909   return TV_format_OK;
910 }
911 #endif
912 
913 #undef __FUNCT__
914 #define __FUNCT__ "MatLoad"
915 /*@C
916    MatLoad - Loads a matrix that has been stored in binary format
917    with MatView().  The matrix format is determined from the options database.
918    Generates a parallel MPI matrix if the communicator has more than one
919    processor.  The default matrix type is AIJ.
920 
921    Collective on PetscViewer
922 
923    Input Parameters:
924 +  newmat - the newly loaded matrix, this needs to have been created with MatCreate()
925             or some related function before a call to MatLoad()
926 -  viewer - binary file viewer, created with PetscViewerBinaryOpen()
927 
928    Options Database Keys:
929    Used with block matrix formats (MATSEQBAIJ,  ...) to specify
930    block size
931 .    -matload_block_size <bs>
932 
933    Level: beginner
934 
935    Notes:
936    If the Mat type has not yet been given then MATAIJ is used, call MatSetFromOptions() on the
937    Mat before calling this routine if you wish to set it from the options database.
938 
939    MatLoad() automatically loads into the options database any options
940    given in the file filename.info where filename is the name of the file
941    that was passed to the PetscViewerBinaryOpen(). The options in the info
942    file will be ignored if you use the -viewer_binary_skip_info option.
943 
944    If the type or size of newmat is not set before a call to MatLoad, PETSc
945    sets the default matrix type AIJ and sets the local and global sizes.
946    If type and/or size is already set, then the same are used.
947 
948    In parallel, each processor can load a subset of rows (or the
949    entire matrix).  This routine is especially useful when a large
950    matrix is stored on disk and only part of it is desired on each
951    processor.  For example, a parallel solver may access only some of
952    the rows from each processor.  The algorithm used here reads
953    relatively small blocks of data rather than reading the entire
954    matrix and then subsetting it.
955 
956    Notes for advanced users:
957    Most users should not need to know the details of the binary storage
958    format, since MatLoad() and MatView() completely hide these details.
959    But for anyone who's interested, the standard binary matrix storage
960    format is
961 
962 $    int    MAT_FILE_CLASSID
963 $    int    number of rows
964 $    int    number of columns
965 $    int    total number of nonzeros
966 $    int    *number nonzeros in each row
967 $    int    *column indices of all nonzeros (starting index is zero)
968 $    PetscScalar *values of all nonzeros
969 
970    PETSc automatically does the byte swapping for
971 machines that store the bytes reversed, e.g.  DEC alpha, freebsd,
972 linux, Windows and the paragon; thus if you write your own binary
973 read/write routines you have to swap the bytes; see PetscBinaryRead()
974 and PetscBinaryWrite() to see how this may be done.
975 
976 .keywords: matrix, load, binary, input
977 
978 .seealso: PetscViewerBinaryOpen(), MatView(), VecLoad()
979 
980  @*/
981 PetscErrorCode  MatLoad(Mat newmat,PetscViewer viewer)
982 {
983   PetscErrorCode ierr;
984   PetscBool      isbinary,flg;
985 
986   PetscFunctionBegin;
987   PetscValidHeaderSpecific(newmat,MAT_CLASSID,1);
988   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
989   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
990   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
991 
992   if (!((PetscObject)newmat)->type_name) {
993     ierr = MatSetType(newmat,MATAIJ);CHKERRQ(ierr);
994   }
995 
996   if (!newmat->ops->load) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"MatLoad is not supported for type");
997   ierr = PetscLogEventBegin(MAT_Load,viewer,0,0,0);CHKERRQ(ierr);
998   ierr = (*newmat->ops->load)(newmat,viewer);CHKERRQ(ierr);
999   ierr = PetscLogEventEnd(MAT_Load,viewer,0,0,0);CHKERRQ(ierr);
1000 
1001   flg  = PETSC_FALSE;
1002   ierr = PetscOptionsGetBool(((PetscObject)newmat)->prefix,"-matload_symmetric",&flg,NULL);CHKERRQ(ierr);
1003   if (flg) {
1004     ierr = MatSetOption(newmat,MAT_SYMMETRIC,PETSC_TRUE);CHKERRQ(ierr);
1005     ierr = MatSetOption(newmat,MAT_SYMMETRY_ETERNAL,PETSC_TRUE);CHKERRQ(ierr);
1006   }
1007   flg  = PETSC_FALSE;
1008   ierr = PetscOptionsGetBool(((PetscObject)newmat)->prefix,"-matload_spd",&flg,NULL);CHKERRQ(ierr);
1009   if (flg) {
1010     ierr = MatSetOption(newmat,MAT_SPD,PETSC_TRUE);CHKERRQ(ierr);
1011   }
1012   PetscFunctionReturn(0);
1013 }
1014 
1015 #undef __FUNCT__
1016 #define __FUNCT__ "MatDestroy_Redundant"
1017 PetscErrorCode MatDestroy_Redundant(Mat_Redundant **redundant)
1018 {
1019   PetscErrorCode ierr;
1020   Mat_Redundant  *redund = *redundant;
1021   PetscInt       i;
1022 
1023   PetscFunctionBegin;
1024   if (redund){
1025     if (redund->matseq) { /* via MatGetSubMatrices()  */
1026       ierr = ISDestroy(&redund->isrow);CHKERRQ(ierr);
1027       ierr = ISDestroy(&redund->iscol);CHKERRQ(ierr);
1028       ierr = MatDestroy(&redund->matseq[0]);CHKERRQ(ierr);
1029       ierr = PetscFree(redund->matseq);CHKERRQ(ierr);
1030     } else {
1031       ierr = PetscFree2(redund->send_rank,redund->recv_rank);CHKERRQ(ierr);
1032       ierr = PetscFree(redund->sbuf_j);CHKERRQ(ierr);
1033       ierr = PetscFree(redund->sbuf_a);CHKERRQ(ierr);
1034       for (i=0; i<redund->nrecvs; i++) {
1035         ierr = PetscFree(redund->rbuf_j[i]);CHKERRQ(ierr);
1036         ierr = PetscFree(redund->rbuf_a[i]);CHKERRQ(ierr);
1037       }
1038       ierr = PetscFree4(redund->sbuf_nz,redund->rbuf_nz,redund->rbuf_j,redund->rbuf_a);CHKERRQ(ierr);
1039     }
1040 
1041     if (redund->subcomm) {
1042       ierr = PetscCommDestroy(&redund->subcomm);CHKERRQ(ierr);
1043     }
1044     ierr = PetscFree(redund);CHKERRQ(ierr);
1045   }
1046   PetscFunctionReturn(0);
1047 }
1048 
1049 #undef __FUNCT__
1050 #define __FUNCT__ "MatDestroy"
1051 /*@
1052    MatDestroy - Frees space taken by a matrix.
1053 
1054    Collective on Mat
1055 
1056    Input Parameter:
1057 .  A - the matrix
1058 
1059    Level: beginner
1060 
1061 @*/
1062 PetscErrorCode  MatDestroy(Mat *A)
1063 {
1064   PetscErrorCode ierr;
1065 
1066   PetscFunctionBegin;
1067   if (!*A) PetscFunctionReturn(0);
1068   PetscValidHeaderSpecific(*A,MAT_CLASSID,1);
1069   if (--((PetscObject)(*A))->refct > 0) {*A = NULL; PetscFunctionReturn(0);}
1070 
1071   /* if memory was published with SAWs then destroy it */
1072   ierr = PetscObjectSAWsViewOff((PetscObject)*A);CHKERRQ(ierr);
1073   if ((*A)->ops->destroy) {
1074     ierr = (*(*A)->ops->destroy)(*A);CHKERRQ(ierr);
1075   }
1076   ierr = MatDestroy_Redundant(&(*A)->redundant);CHKERRQ(ierr);
1077   ierr = MatNullSpaceDestroy(&(*A)->nullsp);CHKERRQ(ierr);
1078   ierr = MatNullSpaceDestroy(&(*A)->transnullsp);CHKERRQ(ierr);
1079   ierr = MatNullSpaceDestroy(&(*A)->nearnullsp);CHKERRQ(ierr);
1080   ierr = PetscLayoutDestroy(&(*A)->rmap);CHKERRQ(ierr);
1081   ierr = PetscLayoutDestroy(&(*A)->cmap);CHKERRQ(ierr);
1082   ierr = PetscHeaderDestroy(A);CHKERRQ(ierr);
1083   PetscFunctionReturn(0);
1084 }
1085 
1086 #undef __FUNCT__
1087 #define __FUNCT__ "MatSetValues"
1088 /*@
1089    MatSetValues - Inserts or adds a block of values into a matrix.
1090    These values may be cached, so MatAssemblyBegin() and MatAssemblyEnd()
1091    MUST be called after all calls to MatSetValues() have been completed.
1092 
1093    Not Collective
1094 
1095    Input Parameters:
1096 +  mat - the matrix
1097 .  v - a logically two-dimensional array of values
1098 .  m, idxm - the number of rows and their global indices
1099 .  n, idxn - the number of columns and their global indices
1100 -  addv - either ADD_VALUES or INSERT_VALUES, where
1101    ADD_VALUES adds values to any existing entries, and
1102    INSERT_VALUES replaces existing entries with new values
1103 
1104    Notes:
1105    If you create the matrix yourself (that is not with a call to DMCreateMatrix()) then you MUST call MatXXXXSetPreallocation() or
1106       MatSetUp() before using this routine
1107 
1108    By default the values, v, are row-oriented. See MatSetOption() for other options.
1109 
1110    Calls to MatSetValues() with the INSERT_VALUES and ADD_VALUES
1111    options cannot be mixed without intervening calls to the assembly
1112    routines.
1113 
1114    MatSetValues() uses 0-based row and column numbers in Fortran
1115    as well as in C.
1116 
1117    Negative indices may be passed in idxm and idxn, these rows and columns are
1118    simply ignored. This allows easily inserting element stiffness matrices
1119    with homogeneous Dirchlet boundary conditions that you don't want represented
1120    in the matrix.
1121 
1122    Efficiency Alert:
1123    The routine MatSetValuesBlocked() may offer much better efficiency
1124    for users of block sparse formats (MATSEQBAIJ and MATMPIBAIJ).
1125 
1126    Level: beginner
1127 
1128    Concepts: matrices^putting entries in
1129 
1130 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
1131           InsertMode, INSERT_VALUES, ADD_VALUES
1132 @*/
1133 PetscErrorCode  MatSetValues(Mat mat,PetscInt m,const PetscInt idxm[],PetscInt n,const PetscInt idxn[],const PetscScalar v[],InsertMode addv)
1134 {
1135   PetscErrorCode ierr;
1136 #if defined(PETSC_USE_DEBUG)
1137   PetscInt       i,j;
1138 #endif
1139 
1140   PetscFunctionBeginHot;
1141   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
1142   PetscValidType(mat,1);
1143   if (!m || !n) PetscFunctionReturn(0); /* no values to insert */
1144   PetscValidIntPointer(idxm,3);
1145   PetscValidIntPointer(idxn,5);
1146   PetscValidScalarPointer(v,6);
1147   MatCheckPreallocated(mat,1);
1148   if (mat->insertmode == NOT_SET_VALUES) {
1149     mat->insertmode = addv;
1150   }
1151 #if defined(PETSC_USE_DEBUG)
1152   else if (mat->insertmode != addv) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
1153   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1154   if (!mat->ops->setvalues) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
1155 
1156   for (i=0; i<m; i++) {
1157     for (j=0; j<n; j++) {
1158       if (mat->erroriffpe && PetscIsInfOrNanScalar(v[i*n+j]))
1159 #if defined(PETSC_USE_COMPLEX)
1160         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]);
1161 #else
1162       SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_FP,"Inserting %g at matrix entry (%D,%D)",(double)v[i*n+j],idxm[i],idxn[j]);
1163 #endif
1164     }
1165   }
1166 #endif
1167 
1168   if (mat->assembled) {
1169     mat->was_assembled = PETSC_TRUE;
1170     mat->assembled     = PETSC_FALSE;
1171   }
1172   ierr = PetscLogEventBegin(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
1173   ierr = (*mat->ops->setvalues)(mat,m,idxm,n,idxn,v,addv);CHKERRQ(ierr);
1174   ierr = PetscLogEventEnd(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
1175 #if defined(PETSC_HAVE_CUSP)
1176   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
1177     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
1178   }
1179 #endif
1180 #if defined(PETSC_HAVE_VIENNACL)
1181   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
1182     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
1183   }
1184 #endif
1185   PetscFunctionReturn(0);
1186 }
1187 
1188 
1189 #undef __FUNCT__
1190 #define __FUNCT__ "MatSetValuesRowLocal"
1191 /*@
1192    MatSetValuesRowLocal - Inserts a row (block row for BAIJ matrices) of nonzero
1193         values into a matrix
1194 
1195    Not Collective
1196 
1197    Input Parameters:
1198 +  mat - the matrix
1199 .  row - the (block) row to set
1200 -  v - a logically two-dimensional array of values
1201 
1202    Notes:
1203    By the values, v, are column-oriented (for the block version) and sorted
1204 
1205    All the nonzeros in the row must be provided
1206 
1207    The matrix must have previously had its column indices set
1208 
1209    The row must belong to this process
1210 
1211    Level: intermediate
1212 
1213    Concepts: matrices^putting entries in
1214 
1215 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
1216           InsertMode, INSERT_VALUES, ADD_VALUES, MatSetValues(), MatSetValuesRow(), MatSetLocalToGlobalMapping()
1217 @*/
1218 PetscErrorCode  MatSetValuesRowLocal(Mat mat,PetscInt row,const PetscScalar v[])
1219 {
1220   PetscErrorCode ierr;
1221   PetscInt       globalrow;
1222 
1223   PetscFunctionBegin;
1224   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
1225   PetscValidType(mat,1);
1226   PetscValidScalarPointer(v,2);
1227   ierr = ISLocalToGlobalMappingApply(mat->rmap->mapping,1,&row,&globalrow);CHKERRQ(ierr);
1228   ierr = MatSetValuesRow(mat,globalrow,v);CHKERRQ(ierr);
1229 #if defined(PETSC_HAVE_CUSP)
1230   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
1231     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
1232   }
1233 #endif
1234 #if defined(PETSC_HAVE_VIENNACL)
1235   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
1236     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
1237   }
1238 #endif
1239   PetscFunctionReturn(0);
1240 }
1241 
1242 #undef __FUNCT__
1243 #define __FUNCT__ "MatSetValuesRow"
1244 /*@
1245    MatSetValuesRow - Inserts a row (block row for BAIJ matrices) of nonzero
1246         values into a matrix
1247 
1248    Not Collective
1249 
1250    Input Parameters:
1251 +  mat - the matrix
1252 .  row - the (block) row to set
1253 -  v - a logically two-dimensional array of values
1254 
1255    Notes:
1256    The values, v, are column-oriented for the block version.
1257 
1258    All the nonzeros in the row must be provided
1259 
1260    THE MATRIX MUSAT HAVE PREVIOUSLY HAD ITS COLUMN INDICES SET. IT IS RARE THAT THIS ROUTINE IS USED, usually MatSetValues() is used.
1261 
1262    The row must belong to this process
1263 
1264    Level: advanced
1265 
1266    Concepts: matrices^putting entries in
1267 
1268 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
1269           InsertMode, INSERT_VALUES, ADD_VALUES, MatSetValues()
1270 @*/
1271 PetscErrorCode  MatSetValuesRow(Mat mat,PetscInt row,const PetscScalar v[])
1272 {
1273   PetscErrorCode ierr;
1274 
1275   PetscFunctionBeginHot;
1276   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
1277   PetscValidType(mat,1);
1278   MatCheckPreallocated(mat,1);
1279   PetscValidScalarPointer(v,2);
1280 #if defined(PETSC_USE_DEBUG)
1281   if (mat->insertmode == ADD_VALUES) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add and insert values");
1282   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1283 #endif
1284   mat->insertmode = INSERT_VALUES;
1285 
1286   if (mat->assembled) {
1287     mat->was_assembled = PETSC_TRUE;
1288     mat->assembled     = PETSC_FALSE;
1289   }
1290   ierr = PetscLogEventBegin(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
1291   if (!mat->ops->setvaluesrow) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
1292   ierr = (*mat->ops->setvaluesrow)(mat,row,v);CHKERRQ(ierr);
1293   ierr = PetscLogEventEnd(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
1294 #if defined(PETSC_HAVE_CUSP)
1295   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
1296     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
1297   }
1298 #endif
1299 #if defined(PETSC_HAVE_VIENNACL)
1300   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
1301     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
1302   }
1303 #endif
1304   PetscFunctionReturn(0);
1305 }
1306 
1307 #undef __FUNCT__
1308 #define __FUNCT__ "MatSetValuesStencil"
1309 /*@
1310    MatSetValuesStencil - Inserts or adds a block of values into a matrix.
1311      Using structured grid indexing
1312 
1313    Not Collective
1314 
1315    Input Parameters:
1316 +  mat - the matrix
1317 .  m - number of rows being entered
1318 .  idxm - grid coordinates (and component number when dof > 1) for matrix rows being entered
1319 .  n - number of columns being entered
1320 .  idxn - grid coordinates (and component number when dof > 1) for matrix columns being entered
1321 .  v - a logically two-dimensional array of values
1322 -  addv - either ADD_VALUES or INSERT_VALUES, where
1323    ADD_VALUES adds values to any existing entries, and
1324    INSERT_VALUES replaces existing entries with new values
1325 
1326    Notes:
1327    By default the values, v, are row-oriented.  See MatSetOption() for other options.
1328 
1329    Calls to MatSetValuesStencil() with the INSERT_VALUES and ADD_VALUES
1330    options cannot be mixed without intervening calls to the assembly
1331    routines.
1332 
1333    The grid coordinates are across the entire grid, not just the local portion
1334 
1335    MatSetValuesStencil() uses 0-based row and column numbers in Fortran
1336    as well as in C.
1337 
1338    For setting/accessing vector values via array coordinates you can use the DMDAVecGetArray() routine
1339 
1340    In order to use this routine you must either obtain the matrix with DMCreateMatrix()
1341    or call MatSetLocalToGlobalMapping() and MatSetStencil() first.
1342 
1343    The columns and rows in the stencil passed in MUST be contained within the
1344    ghost region of the given process as set with DMDACreateXXX() or MatSetStencil(). For example,
1345    if you create a DMDA with an overlap of one grid level and on a particular process its first
1346    local nonghost x logical coordinate is 6 (so its first ghost x logical coordinate is 5) the
1347    first i index you can use in your column and row indices in MatSetStencil() is 5.
1348 
1349    In Fortran idxm and idxn should be declared as
1350 $     MatStencil idxm(4,m),idxn(4,n)
1351    and the values inserted using
1352 $    idxm(MatStencil_i,1) = i
1353 $    idxm(MatStencil_j,1) = j
1354 $    idxm(MatStencil_k,1) = k
1355 $    idxm(MatStencil_c,1) = c
1356    etc
1357 
1358    For periodic boundary conditions use negative indices for values to the left (below 0; that are to be
1359    obtained by wrapping values from right edge). For values to the right of the last entry using that index plus one
1360    etc to obtain values that obtained by wrapping the values from the left edge. This does not work for anything but the
1361    DM_BOUNDARY_PERIODIC boundary type.
1362 
1363    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
1364    a single value per point) you can skip filling those indices.
1365 
1366    Inspired by the structured grid interface to the HYPRE package
1367    (http://www.llnl.gov/CASC/hypre)
1368 
1369    Efficiency Alert:
1370    The routine MatSetValuesBlockedStencil() may offer much better efficiency
1371    for users of block sparse formats (MATSEQBAIJ and MATMPIBAIJ).
1372 
1373    Level: beginner
1374 
1375    Concepts: matrices^putting entries in
1376 
1377 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal()
1378           MatSetValues(), MatSetValuesBlockedStencil(), MatSetStencil(), DMCreateMatrix(), DMDAVecGetArray(), MatStencil
1379 @*/
1380 PetscErrorCode  MatSetValuesStencil(Mat mat,PetscInt m,const MatStencil idxm[],PetscInt n,const MatStencil idxn[],const PetscScalar v[],InsertMode addv)
1381 {
1382   PetscErrorCode ierr;
1383   PetscInt       buf[8192],*bufm=0,*bufn=0,*jdxm,*jdxn;
1384   PetscInt       j,i,dim = mat->stencil.dim,*dims = mat->stencil.dims+1,tmp;
1385   PetscInt       *starts = mat->stencil.starts,*dxm = (PetscInt*)idxm,*dxn = (PetscInt*)idxn,sdim = dim - (1 - (PetscInt)mat->stencil.noc);
1386 
1387   PetscFunctionBegin;
1388   if (!m || !n) PetscFunctionReturn(0); /* no values to insert */
1389   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
1390   PetscValidType(mat,1);
1391   PetscValidIntPointer(idxm,3);
1392   PetscValidIntPointer(idxn,5);
1393   PetscValidScalarPointer(v,6);
1394 
1395   if ((m+n) <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
1396     jdxm = buf; jdxn = buf+m;
1397   } else {
1398     ierr = PetscMalloc2(m,&bufm,n,&bufn);CHKERRQ(ierr);
1399     jdxm = bufm; jdxn = bufn;
1400   }
1401   for (i=0; i<m; i++) {
1402     for (j=0; j<3-sdim; j++) dxm++;
1403     tmp = *dxm++ - starts[0];
1404     for (j=0; j<dim-1; j++) {
1405       if ((*dxm++ - starts[j+1]) < 0 || tmp < 0) tmp = -1;
1406       else                                       tmp = tmp*dims[j] + *(dxm-1) - starts[j+1];
1407     }
1408     if (mat->stencil.noc) dxm++;
1409     jdxm[i] = tmp;
1410   }
1411   for (i=0; i<n; i++) {
1412     for (j=0; j<3-sdim; j++) dxn++;
1413     tmp = *dxn++ - starts[0];
1414     for (j=0; j<dim-1; j++) {
1415       if ((*dxn++ - starts[j+1]) < 0 || tmp < 0) tmp = -1;
1416       else                                       tmp = tmp*dims[j] + *(dxn-1) - starts[j+1];
1417     }
1418     if (mat->stencil.noc) dxn++;
1419     jdxn[i] = tmp;
1420   }
1421   ierr = MatSetValuesLocal(mat,m,jdxm,n,jdxn,v,addv);CHKERRQ(ierr);
1422   ierr = PetscFree2(bufm,bufn);CHKERRQ(ierr);
1423   PetscFunctionReturn(0);
1424 }
1425 
1426 #undef __FUNCT__
1427 #define __FUNCT__ "MatSetValuesBlockedStencil"
1428 /*@
1429    MatSetValuesBlockedStencil - Inserts or adds a block of values into a matrix.
1430      Using structured grid indexing
1431 
1432    Not Collective
1433 
1434    Input Parameters:
1435 +  mat - the matrix
1436 .  m - number of rows being entered
1437 .  idxm - grid coordinates for matrix rows being entered
1438 .  n - number of columns being entered
1439 .  idxn - grid coordinates for matrix columns being entered
1440 .  v - a logically two-dimensional array of values
1441 -  addv - either ADD_VALUES or INSERT_VALUES, where
1442    ADD_VALUES adds values to any existing entries, and
1443    INSERT_VALUES replaces existing entries with new values
1444 
1445    Notes:
1446    By default the values, v, are row-oriented and unsorted.
1447    See MatSetOption() for other options.
1448 
1449    Calls to MatSetValuesBlockedStencil() with the INSERT_VALUES and ADD_VALUES
1450    options cannot be mixed without intervening calls to the assembly
1451    routines.
1452 
1453    The grid coordinates are across the entire grid, not just the local portion
1454 
1455    MatSetValuesBlockedStencil() uses 0-based row and column numbers in Fortran
1456    as well as in C.
1457 
1458    For setting/accessing vector values via array coordinates you can use the DMDAVecGetArray() routine
1459 
1460    In order to use this routine you must either obtain the matrix with DMCreateMatrix()
1461    or call MatSetBlockSize(), MatSetLocalToGlobalMapping() and MatSetStencil() first.
1462 
1463    The columns and rows in the stencil passed in MUST be contained within the
1464    ghost region of the given process as set with DMDACreateXXX() or MatSetStencil(). For example,
1465    if you create a DMDA with an overlap of one grid level and on a particular process its first
1466    local nonghost x logical coordinate is 6 (so its first ghost x logical coordinate is 5) the
1467    first i index you can use in your column and row indices in MatSetStencil() is 5.
1468 
1469    In Fortran idxm and idxn should be declared as
1470 $     MatStencil idxm(4,m),idxn(4,n)
1471    and the values inserted using
1472 $    idxm(MatStencil_i,1) = i
1473 $    idxm(MatStencil_j,1) = j
1474 $    idxm(MatStencil_k,1) = k
1475    etc
1476 
1477    Negative indices may be passed in idxm and idxn, these rows and columns are
1478    simply ignored. This allows easily inserting element stiffness matrices
1479    with homogeneous Dirchlet boundary conditions that you don't want represented
1480    in the matrix.
1481 
1482    Inspired by the structured grid interface to the HYPRE package
1483    (http://www.llnl.gov/CASC/hypre)
1484 
1485    Level: beginner
1486 
1487    Concepts: matrices^putting entries in
1488 
1489 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal()
1490           MatSetValues(), MatSetValuesStencil(), MatSetStencil(), DMCreateMatrix(), DMDAVecGetArray(), MatStencil,
1491           MatSetBlockSize(), MatSetLocalToGlobalMapping()
1492 @*/
1493 PetscErrorCode  MatSetValuesBlockedStencil(Mat mat,PetscInt m,const MatStencil idxm[],PetscInt n,const MatStencil idxn[],const PetscScalar v[],InsertMode addv)
1494 {
1495   PetscErrorCode ierr;
1496   PetscInt       buf[8192],*bufm=0,*bufn=0,*jdxm,*jdxn;
1497   PetscInt       j,i,dim = mat->stencil.dim,*dims = mat->stencil.dims+1,tmp;
1498   PetscInt       *starts = mat->stencil.starts,*dxm = (PetscInt*)idxm,*dxn = (PetscInt*)idxn,sdim = dim - (1 - (PetscInt)mat->stencil.noc);
1499 
1500   PetscFunctionBegin;
1501   if (!m || !n) PetscFunctionReturn(0); /* no values to insert */
1502   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
1503   PetscValidType(mat,1);
1504   PetscValidIntPointer(idxm,3);
1505   PetscValidIntPointer(idxn,5);
1506   PetscValidScalarPointer(v,6);
1507 
1508   if ((m+n) <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
1509     jdxm = buf; jdxn = buf+m;
1510   } else {
1511     ierr = PetscMalloc2(m,&bufm,n,&bufn);CHKERRQ(ierr);
1512     jdxm = bufm; jdxn = bufn;
1513   }
1514   for (i=0; i<m; i++) {
1515     for (j=0; j<3-sdim; j++) dxm++;
1516     tmp = *dxm++ - starts[0];
1517     for (j=0; j<sdim-1; j++) {
1518       if ((*dxm++ - starts[j+1]) < 0 || tmp < 0) tmp = -1;
1519       else                                       tmp = tmp*dims[j] + *(dxm-1) - starts[j+1];
1520     }
1521     dxm++;
1522     jdxm[i] = tmp;
1523   }
1524   for (i=0; i<n; i++) {
1525     for (j=0; j<3-sdim; j++) dxn++;
1526     tmp = *dxn++ - starts[0];
1527     for (j=0; j<sdim-1; j++) {
1528       if ((*dxn++ - starts[j+1]) < 0 || tmp < 0) tmp = -1;
1529       else                                       tmp = tmp*dims[j] + *(dxn-1) - starts[j+1];
1530     }
1531     dxn++;
1532     jdxn[i] = tmp;
1533   }
1534   ierr = MatSetValuesBlockedLocal(mat,m,jdxm,n,jdxn,v,addv);CHKERRQ(ierr);
1535   ierr = PetscFree2(bufm,bufn);CHKERRQ(ierr);
1536 #if defined(PETSC_HAVE_CUSP)
1537   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
1538     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
1539   }
1540 #endif
1541 #if defined(PETSC_HAVE_VIENNACL)
1542   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
1543     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
1544   }
1545 #endif
1546   PetscFunctionReturn(0);
1547 }
1548 
1549 #undef __FUNCT__
1550 #define __FUNCT__ "MatSetStencil"
1551 /*@
1552    MatSetStencil - Sets the grid information for setting values into a matrix via
1553         MatSetValuesStencil()
1554 
1555    Not Collective
1556 
1557    Input Parameters:
1558 +  mat - the matrix
1559 .  dim - dimension of the grid 1, 2, or 3
1560 .  dims - number of grid points in x, y, and z direction, including ghost points on your processor
1561 .  starts - starting point of ghost nodes on your processor in x, y, and z direction
1562 -  dof - number of degrees of freedom per node
1563 
1564 
1565    Inspired by the structured grid interface to the HYPRE package
1566    (www.llnl.gov/CASC/hyper)
1567 
1568    For matrices generated with DMCreateMatrix() this routine is automatically called and so not needed by the
1569    user.
1570 
1571    Level: beginner
1572 
1573    Concepts: matrices^putting entries in
1574 
1575 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal()
1576           MatSetValues(), MatSetValuesBlockedStencil(), MatSetValuesStencil()
1577 @*/
1578 PetscErrorCode  MatSetStencil(Mat mat,PetscInt dim,const PetscInt dims[],const PetscInt starts[],PetscInt dof)
1579 {
1580   PetscInt i;
1581 
1582   PetscFunctionBegin;
1583   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
1584   PetscValidIntPointer(dims,3);
1585   PetscValidIntPointer(starts,4);
1586 
1587   mat->stencil.dim = dim + (dof > 1);
1588   for (i=0; i<dim; i++) {
1589     mat->stencil.dims[i]   = dims[dim-i-1];      /* copy the values in backwards */
1590     mat->stencil.starts[i] = starts[dim-i-1];
1591   }
1592   mat->stencil.dims[dim]   = dof;
1593   mat->stencil.starts[dim] = 0;
1594   mat->stencil.noc         = (PetscBool)(dof == 1);
1595   PetscFunctionReturn(0);
1596 }
1597 
1598 #undef __FUNCT__
1599 #define __FUNCT__ "MatSetValuesBlocked"
1600 /*@
1601    MatSetValuesBlocked - Inserts or adds a block of values into a matrix.
1602 
1603    Not Collective
1604 
1605    Input Parameters:
1606 +  mat - the matrix
1607 .  v - a logically two-dimensional array of values
1608 .  m, idxm - the number of block rows and their global block indices
1609 .  n, idxn - the number of block columns and their global block indices
1610 -  addv - either ADD_VALUES or INSERT_VALUES, where
1611    ADD_VALUES adds values to any existing entries, and
1612    INSERT_VALUES replaces existing entries with new values
1613 
1614    Notes:
1615    If you create the matrix yourself (that is not with a call to DMCreateMatrix()) then you MUST call
1616    MatXXXXSetPreallocation() or MatSetUp() before using this routine.
1617 
1618    The m and n count the NUMBER of blocks in the row direction and column direction,
1619    NOT the total number of rows/columns; for example, if the block size is 2 and
1620    you are passing in values for rows 2,3,4,5  then m would be 2 (not 4).
1621    The values in idxm would be 1 2; that is the first index for each block divided by
1622    the block size.
1623 
1624    Note that you must call MatSetBlockSize() when constructing this matrix (before
1625    preallocating it).
1626 
1627    By default the values, v, are row-oriented, so the layout of
1628    v is the same as for MatSetValues(). See MatSetOption() for other options.
1629 
1630    Calls to MatSetValuesBlocked() with the INSERT_VALUES and ADD_VALUES
1631    options cannot be mixed without intervening calls to the assembly
1632    routines.
1633 
1634    MatSetValuesBlocked() uses 0-based row and column numbers in Fortran
1635    as well as in C.
1636 
1637    Negative indices may be passed in idxm and idxn, these rows and columns are
1638    simply ignored. This allows easily inserting element stiffness matrices
1639    with homogeneous Dirchlet boundary conditions that you don't want represented
1640    in the matrix.
1641 
1642    Each time an entry is set within a sparse matrix via MatSetValues(),
1643    internal searching must be done to determine where to place the the
1644    data in the matrix storage space.  By instead inserting blocks of
1645    entries via MatSetValuesBlocked(), the overhead of matrix assembly is
1646    reduced.
1647 
1648    Example:
1649 $   Suppose m=n=2 and block size(bs) = 2 The array is
1650 $
1651 $   1  2  | 3  4
1652 $   5  6  | 7  8
1653 $   - - - | - - -
1654 $   9  10 | 11 12
1655 $   13 14 | 15 16
1656 $
1657 $   v[] should be passed in like
1658 $   v[] = [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16]
1659 $
1660 $  If you are not using row oriented storage of v (that is you called MatSetOption(mat,MAT_ROW_ORIENTED,PETSC_FALSE)) then
1661 $   v[] = [1,5,9,13,2,6,10,14,3,7,11,15,4,8,12,16]
1662 
1663    Level: intermediate
1664 
1665    Concepts: matrices^putting entries in blocked
1666 
1667 .seealso: MatSetBlockSize(), MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValues(), MatSetValuesBlockedLocal()
1668 @*/
1669 PetscErrorCode  MatSetValuesBlocked(Mat mat,PetscInt m,const PetscInt idxm[],PetscInt n,const PetscInt idxn[],const PetscScalar v[],InsertMode addv)
1670 {
1671   PetscErrorCode ierr;
1672 
1673   PetscFunctionBeginHot;
1674   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
1675   PetscValidType(mat,1);
1676   if (!m || !n) PetscFunctionReturn(0); /* no values to insert */
1677   PetscValidIntPointer(idxm,3);
1678   PetscValidIntPointer(idxn,5);
1679   PetscValidScalarPointer(v,6);
1680   MatCheckPreallocated(mat,1);
1681   if (mat->insertmode == NOT_SET_VALUES) {
1682     mat->insertmode = addv;
1683   }
1684 #if defined(PETSC_USE_DEBUG)
1685   else if (mat->insertmode != addv) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
1686   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1687   if (!mat->ops->setvaluesblocked && !mat->ops->setvalues) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
1688 #endif
1689 
1690   if (mat->assembled) {
1691     mat->was_assembled = PETSC_TRUE;
1692     mat->assembled     = PETSC_FALSE;
1693   }
1694   ierr = PetscLogEventBegin(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
1695   if (mat->ops->setvaluesblocked) {
1696     ierr = (*mat->ops->setvaluesblocked)(mat,m,idxm,n,idxn,v,addv);CHKERRQ(ierr);
1697   } else {
1698     PetscInt buf[8192],*bufr=0,*bufc=0,*iidxm,*iidxn;
1699     PetscInt i,j,bs,cbs;
1700     ierr = MatGetBlockSizes(mat,&bs,&cbs);CHKERRQ(ierr);
1701     if (m*bs+n*cbs <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
1702       iidxm = buf; iidxn = buf + m*bs;
1703     } else {
1704       ierr  = PetscMalloc2(m*bs,&bufr,n*cbs,&bufc);CHKERRQ(ierr);
1705       iidxm = bufr; iidxn = bufc;
1706     }
1707     for (i=0; i<m; i++) {
1708       for (j=0; j<bs; j++) {
1709         iidxm[i*bs+j] = bs*idxm[i] + j;
1710       }
1711     }
1712     for (i=0; i<n; i++) {
1713       for (j=0; j<cbs; j++) {
1714         iidxn[i*cbs+j] = cbs*idxn[i] + j;
1715       }
1716     }
1717     ierr = MatSetValues(mat,m*bs,iidxm,n*cbs,iidxn,v,addv);CHKERRQ(ierr);
1718     ierr = PetscFree2(bufr,bufc);CHKERRQ(ierr);
1719   }
1720   ierr = PetscLogEventEnd(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
1721 #if defined(PETSC_HAVE_CUSP)
1722   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
1723     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
1724   }
1725 #endif
1726 #if defined(PETSC_HAVE_VIENNACL)
1727   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
1728     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
1729   }
1730 #endif
1731   PetscFunctionReturn(0);
1732 }
1733 
1734 #undef __FUNCT__
1735 #define __FUNCT__ "MatGetValues"
1736 /*@
1737    MatGetValues - Gets a block of values from a matrix.
1738 
1739    Not Collective; currently only returns a local block
1740 
1741    Input Parameters:
1742 +  mat - the matrix
1743 .  v - a logically two-dimensional array for storing the values
1744 .  m, idxm - the number of rows and their global indices
1745 -  n, idxn - the number of columns and their global indices
1746 
1747    Notes:
1748    The user must allocate space (m*n PetscScalars) for the values, v.
1749    The values, v, are then returned in a row-oriented format,
1750    analogous to that used by default in MatSetValues().
1751 
1752    MatGetValues() uses 0-based row and column numbers in
1753    Fortran as well as in C.
1754 
1755    MatGetValues() requires that the matrix has been assembled
1756    with MatAssemblyBegin()/MatAssemblyEnd().  Thus, calls to
1757    MatSetValues() and MatGetValues() CANNOT be made in succession
1758    without intermediate matrix assembly.
1759 
1760    Negative row or column indices will be ignored and those locations in v[] will be
1761    left unchanged.
1762 
1763    Level: advanced
1764 
1765    Concepts: matrices^accessing values
1766 
1767 .seealso: MatGetRow(), MatGetSubMatrices(), MatSetValues()
1768 @*/
1769 PetscErrorCode  MatGetValues(Mat mat,PetscInt m,const PetscInt idxm[],PetscInt n,const PetscInt idxn[],PetscScalar v[])
1770 {
1771   PetscErrorCode ierr;
1772 
1773   PetscFunctionBegin;
1774   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
1775   PetscValidType(mat,1);
1776   if (!m || !n) PetscFunctionReturn(0);
1777   PetscValidIntPointer(idxm,3);
1778   PetscValidIntPointer(idxn,5);
1779   PetscValidScalarPointer(v,6);
1780   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
1781   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1782   if (!mat->ops->getvalues) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
1783   MatCheckPreallocated(mat,1);
1784 
1785   ierr = PetscLogEventBegin(MAT_GetValues,mat,0,0,0);CHKERRQ(ierr);
1786   ierr = (*mat->ops->getvalues)(mat,m,idxm,n,idxn,v);CHKERRQ(ierr);
1787   ierr = PetscLogEventEnd(MAT_GetValues,mat,0,0,0);CHKERRQ(ierr);
1788   PetscFunctionReturn(0);
1789 }
1790 
1791 #undef __FUNCT__
1792 #define __FUNCT__ "MatSetValuesBatch"
1793 /*@
1794   MatSetValuesBatch - Adds (ADD_VALUES) many blocks of values into a matrix at once. The blocks must all be square and
1795   the same size. Currently, this can only be called once and creates the given matrix.
1796 
1797   Not Collective
1798 
1799   Input Parameters:
1800 + mat - the matrix
1801 . nb - the number of blocks
1802 . bs - the number of rows (and columns) in each block
1803 . rows - a concatenation of the rows for each block
1804 - v - a concatenation of logically two-dimensional arrays of values
1805 
1806   Notes:
1807   In the future, we will extend this routine to handle rectangular blocks, and to allow multiple calls for a given matrix.
1808 
1809   Level: advanced
1810 
1811   Concepts: matrices^putting entries in
1812 
1813 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
1814           InsertMode, INSERT_VALUES, ADD_VALUES, MatSetValues()
1815 @*/
1816 PetscErrorCode MatSetValuesBatch(Mat mat, PetscInt nb, PetscInt bs, PetscInt rows[], const PetscScalar v[])
1817 {
1818   PetscErrorCode ierr;
1819 
1820   PetscFunctionBegin;
1821   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
1822   PetscValidType(mat,1);
1823   PetscValidScalarPointer(rows,4);
1824   PetscValidScalarPointer(v,5);
1825 #if defined(PETSC_USE_DEBUG)
1826   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1827 #endif
1828 
1829   ierr = PetscLogEventBegin(MAT_SetValuesBatch,mat,0,0,0);CHKERRQ(ierr);
1830   if (mat->ops->setvaluesbatch) {
1831     ierr = (*mat->ops->setvaluesbatch)(mat,nb,bs,rows,v);CHKERRQ(ierr);
1832   } else {
1833     PetscInt b;
1834     for (b = 0; b < nb; ++b) {
1835       ierr = MatSetValues(mat, bs, &rows[b*bs], bs, &rows[b*bs], &v[b*bs*bs], ADD_VALUES);CHKERRQ(ierr);
1836     }
1837   }
1838   ierr = PetscLogEventEnd(MAT_SetValuesBatch,mat,0,0,0);CHKERRQ(ierr);
1839   PetscFunctionReturn(0);
1840 }
1841 
1842 #undef __FUNCT__
1843 #define __FUNCT__ "MatSetLocalToGlobalMapping"
1844 /*@
1845    MatSetLocalToGlobalMapping - Sets a local-to-global numbering for use by
1846    the routine MatSetValuesLocal() to allow users to insert matrix entries
1847    using a local (per-processor) numbering.
1848 
1849    Not Collective
1850 
1851    Input Parameters:
1852 +  x - the matrix
1853 .  rmapping - row mapping created with ISLocalToGlobalMappingCreate()   or ISLocalToGlobalMappingCreateIS()
1854 - cmapping - column mapping
1855 
1856    Level: intermediate
1857 
1858    Concepts: matrices^local to global mapping
1859    Concepts: local to global mapping^for matrices
1860 
1861 .seealso:  MatAssemblyBegin(), MatAssemblyEnd(), MatSetValues(), MatSetValuesLocal()
1862 @*/
1863 PetscErrorCode  MatSetLocalToGlobalMapping(Mat x,ISLocalToGlobalMapping rmapping,ISLocalToGlobalMapping cmapping)
1864 {
1865   PetscErrorCode ierr;
1866 
1867   PetscFunctionBegin;
1868   PetscValidHeaderSpecific(x,MAT_CLASSID,1);
1869   PetscValidType(x,1);
1870   PetscValidHeaderSpecific(rmapping,IS_LTOGM_CLASSID,2);
1871   PetscValidHeaderSpecific(cmapping,IS_LTOGM_CLASSID,3);
1872 
1873   if (x->ops->setlocaltoglobalmapping) {
1874     ierr = (*x->ops->setlocaltoglobalmapping)(x,rmapping,cmapping);CHKERRQ(ierr);
1875   } else {
1876     ierr = PetscLayoutSetISLocalToGlobalMapping(x->rmap,rmapping);CHKERRQ(ierr);
1877     ierr = PetscLayoutSetISLocalToGlobalMapping(x->cmap,cmapping);CHKERRQ(ierr);
1878   }
1879   PetscFunctionReturn(0);
1880 }
1881 
1882 
1883 #undef __FUNCT__
1884 #define __FUNCT__ "MatGetLocalToGlobalMapping"
1885 /*@
1886    MatGetLocalToGlobalMapping - Gets the local-to-global numbering set by MatSetLocalToGlobalMapping()
1887 
1888    Not Collective
1889 
1890    Input Parameters:
1891 .  A - the matrix
1892 
1893    Output Parameters:
1894 + rmapping - row mapping
1895 - cmapping - column mapping
1896 
1897    Level: advanced
1898 
1899    Concepts: matrices^local to global mapping
1900    Concepts: local to global mapping^for matrices
1901 
1902 .seealso:  MatSetValuesLocal()
1903 @*/
1904 PetscErrorCode  MatGetLocalToGlobalMapping(Mat A,ISLocalToGlobalMapping *rmapping,ISLocalToGlobalMapping *cmapping)
1905 {
1906   PetscFunctionBegin;
1907   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
1908   PetscValidType(A,1);
1909   if (rmapping) PetscValidPointer(rmapping,2);
1910   if (cmapping) PetscValidPointer(cmapping,3);
1911   if (rmapping) *rmapping = A->rmap->mapping;
1912   if (cmapping) *cmapping = A->cmap->mapping;
1913   PetscFunctionReturn(0);
1914 }
1915 
1916 #undef __FUNCT__
1917 #define __FUNCT__ "MatGetLayouts"
1918 /*@
1919    MatGetLayouts - Gets the PetscLayout objects for rows and columns
1920 
1921    Not Collective
1922 
1923    Input Parameters:
1924 .  A - the matrix
1925 
1926    Output Parameters:
1927 + rmap - row layout
1928 - cmap - column layout
1929 
1930    Level: advanced
1931 
1932 .seealso:  MatCreateVecs(), MatGetLocalToGlobalMapping()
1933 @*/
1934 PetscErrorCode  MatGetLayouts(Mat A,PetscLayout *rmap,PetscLayout *cmap)
1935 {
1936   PetscFunctionBegin;
1937   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
1938   PetscValidType(A,1);
1939   if (rmap) PetscValidPointer(rmap,2);
1940   if (cmap) PetscValidPointer(cmap,3);
1941   if (rmap) *rmap = A->rmap;
1942   if (cmap) *cmap = A->cmap;
1943   PetscFunctionReturn(0);
1944 }
1945 
1946 #undef __FUNCT__
1947 #define __FUNCT__ "MatSetValuesLocal"
1948 /*@
1949    MatSetValuesLocal - Inserts or adds values into certain locations of a matrix,
1950    using a local ordering of the nodes.
1951 
1952    Not Collective
1953 
1954    Input Parameters:
1955 +  x - the matrix
1956 .  nrow, irow - number of rows and their local indices
1957 .  ncol, icol - number of columns and their local indices
1958 .  y -  a logically two-dimensional array of values
1959 -  addv - either INSERT_VALUES or ADD_VALUES, where
1960    ADD_VALUES adds values to any existing entries, and
1961    INSERT_VALUES replaces existing entries with new values
1962 
1963    Notes:
1964    If you create the matrix yourself (that is not with a call to DMCreateMatrix()) then you MUST call MatXXXXSetPreallocation() or
1965       MatSetUp() before using this routine
1966 
1967    If you create the matrix yourself (that is not with a call to DMCreateMatrix()) then you MUST call MatSetLocalToGlobalMapping() before using this routine
1968 
1969    Calls to MatSetValuesLocal() with the INSERT_VALUES and ADD_VALUES
1970    options cannot be mixed without intervening calls to the assembly
1971    routines.
1972 
1973    These values may be cached, so MatAssemblyBegin() and MatAssemblyEnd()
1974    MUST be called after all calls to MatSetValuesLocal() have been completed.
1975 
1976    Level: intermediate
1977 
1978    Concepts: matrices^putting entries in with local numbering
1979 
1980 .seealso:  MatAssemblyBegin(), MatAssemblyEnd(), MatSetValues(), MatSetLocalToGlobalMapping(),
1981            MatSetValueLocal()
1982 @*/
1983 PetscErrorCode  MatSetValuesLocal(Mat mat,PetscInt nrow,const PetscInt irow[],PetscInt ncol,const PetscInt icol[],const PetscScalar y[],InsertMode addv)
1984 {
1985   PetscErrorCode ierr;
1986 
1987   PetscFunctionBeginHot;
1988   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
1989   PetscValidType(mat,1);
1990   MatCheckPreallocated(mat,1);
1991   if (!nrow || !ncol) PetscFunctionReturn(0); /* no values to insert */
1992   PetscValidIntPointer(irow,3);
1993   PetscValidIntPointer(icol,5);
1994   PetscValidScalarPointer(y,6);
1995   if (mat->insertmode == NOT_SET_VALUES) {
1996     mat->insertmode = addv;
1997   }
1998 #if defined(PETSC_USE_DEBUG)
1999   else if (mat->insertmode != addv) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
2000   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2001   if (!mat->ops->setvalueslocal && !mat->ops->setvalues) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2002 #endif
2003 
2004   if (mat->assembled) {
2005     mat->was_assembled = PETSC_TRUE;
2006     mat->assembled     = PETSC_FALSE;
2007   }
2008   ierr = PetscLogEventBegin(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
2009   if (mat->ops->setvalueslocal) {
2010     ierr = (*mat->ops->setvalueslocal)(mat,nrow,irow,ncol,icol,y,addv);CHKERRQ(ierr);
2011   } else {
2012     PetscInt buf[8192],*bufr=0,*bufc=0,*irowm,*icolm;
2013     if ((nrow+ncol) <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
2014       irowm = buf; icolm = buf+nrow;
2015     } else {
2016       ierr  = PetscMalloc2(nrow,&bufr,ncol,&bufc);CHKERRQ(ierr);
2017       irowm = bufr; icolm = bufc;
2018     }
2019     ierr = ISLocalToGlobalMappingApply(mat->rmap->mapping,nrow,irow,irowm);CHKERRQ(ierr);
2020     ierr = ISLocalToGlobalMappingApply(mat->cmap->mapping,ncol,icol,icolm);CHKERRQ(ierr);
2021     ierr = MatSetValues(mat,nrow,irowm,ncol,icolm,y,addv);CHKERRQ(ierr);
2022     ierr = PetscFree2(bufr,bufc);CHKERRQ(ierr);
2023   }
2024   ierr = PetscLogEventEnd(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
2025 #if defined(PETSC_HAVE_CUSP)
2026   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
2027     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
2028   }
2029 #endif
2030 #if defined(PETSC_HAVE_VIENNACL)
2031   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
2032     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
2033   }
2034 #endif
2035   PetscFunctionReturn(0);
2036 }
2037 
2038 #undef __FUNCT__
2039 #define __FUNCT__ "MatSetValuesBlockedLocal"
2040 /*@
2041    MatSetValuesBlockedLocal - Inserts or adds values into certain locations of a matrix,
2042    using a local ordering of the nodes a block at a time.
2043 
2044    Not Collective
2045 
2046    Input Parameters:
2047 +  x - the matrix
2048 .  nrow, irow - number of rows and their local indices
2049 .  ncol, icol - number of columns and their local indices
2050 .  y -  a logically two-dimensional array of values
2051 -  addv - either INSERT_VALUES or ADD_VALUES, where
2052    ADD_VALUES adds values to any existing entries, and
2053    INSERT_VALUES replaces existing entries with new values
2054 
2055    Notes:
2056    If you create the matrix yourself (that is not with a call to DMCreateMatrix()) then you MUST call MatXXXXSetPreallocation() or
2057       MatSetUp() before using this routine
2058 
2059    If you create the matrix yourself (that is not with a call to DMCreateMatrix()) then you MUST call MatSetBlockSize() and MatSetLocalToGlobalMapping()
2060       before using this routineBefore calling MatSetValuesLocal(), the user must first set the
2061 
2062    Calls to MatSetValuesBlockedLocal() with the INSERT_VALUES and ADD_VALUES
2063    options cannot be mixed without intervening calls to the assembly
2064    routines.
2065 
2066    These values may be cached, so MatAssemblyBegin() and MatAssemblyEnd()
2067    MUST be called after all calls to MatSetValuesBlockedLocal() have been completed.
2068 
2069    Level: intermediate
2070 
2071    Concepts: matrices^putting blocked values in with local numbering
2072 
2073 .seealso:  MatSetBlockSize(), MatSetLocalToGlobalMapping(), MatAssemblyBegin(), MatAssemblyEnd(),
2074            MatSetValuesLocal(),  MatSetValuesBlocked()
2075 @*/
2076 PetscErrorCode  MatSetValuesBlockedLocal(Mat mat,PetscInt nrow,const PetscInt irow[],PetscInt ncol,const PetscInt icol[],const PetscScalar y[],InsertMode addv)
2077 {
2078   PetscErrorCode ierr;
2079 
2080   PetscFunctionBeginHot;
2081   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2082   PetscValidType(mat,1);
2083   MatCheckPreallocated(mat,1);
2084   if (!nrow || !ncol) PetscFunctionReturn(0); /* no values to insert */
2085   PetscValidIntPointer(irow,3);
2086   PetscValidIntPointer(icol,5);
2087   PetscValidScalarPointer(y,6);
2088   if (mat->insertmode == NOT_SET_VALUES) {
2089     mat->insertmode = addv;
2090   }
2091 #if defined(PETSC_USE_DEBUG)
2092   else if (mat->insertmode != addv) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
2093   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2094   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);
2095 #endif
2096 
2097   if (mat->assembled) {
2098     mat->was_assembled = PETSC_TRUE;
2099     mat->assembled     = PETSC_FALSE;
2100   }
2101   ierr = PetscLogEventBegin(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
2102   if (mat->ops->setvaluesblockedlocal) {
2103     ierr = (*mat->ops->setvaluesblockedlocal)(mat,nrow,irow,ncol,icol,y,addv);CHKERRQ(ierr);
2104   } else {
2105     PetscInt buf[8192],*bufr=0,*bufc=0,*irowm,*icolm;
2106     if ((nrow+ncol) <= (PetscInt)(sizeof(buf)/sizeof(PetscInt))) {
2107       irowm = buf; icolm = buf + nrow;
2108     } else {
2109       ierr  = PetscMalloc2(nrow,&bufr,ncol,&bufc);CHKERRQ(ierr);
2110       irowm = bufr; icolm = bufc;
2111     }
2112     ierr = ISLocalToGlobalMappingApplyBlock(mat->rmap->mapping,nrow,irow,irowm);CHKERRQ(ierr);
2113     ierr = ISLocalToGlobalMappingApplyBlock(mat->cmap->mapping,ncol,icol,icolm);CHKERRQ(ierr);
2114     ierr = MatSetValuesBlocked(mat,nrow,irowm,ncol,icolm,y,addv);CHKERRQ(ierr);
2115     ierr = PetscFree2(bufr,bufc);CHKERRQ(ierr);
2116   }
2117   ierr = PetscLogEventEnd(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
2118 #if defined(PETSC_HAVE_CUSP)
2119   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
2120     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
2121   }
2122 #endif
2123 #if defined(PETSC_HAVE_VIENNACL)
2124   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
2125     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
2126   }
2127 #endif
2128   PetscFunctionReturn(0);
2129 }
2130 
2131 #undef __FUNCT__
2132 #define __FUNCT__ "MatMultDiagonalBlock"
2133 /*@
2134    MatMultDiagonalBlock - Computes the matrix-vector product, y = Dx. Where D is defined by the inode or block structure of the diagonal
2135 
2136    Collective on Mat and Vec
2137 
2138    Input Parameters:
2139 +  mat - the matrix
2140 -  x   - the vector to be multiplied
2141 
2142    Output Parameters:
2143 .  y - the result
2144 
2145    Notes:
2146    The vectors x and y cannot be the same.  I.e., one cannot
2147    call MatMult(A,y,y).
2148 
2149    Level: developer
2150 
2151    Concepts: matrix-vector product
2152 
2153 .seealso: MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
2154 @*/
2155 PetscErrorCode  MatMultDiagonalBlock(Mat mat,Vec x,Vec y)
2156 {
2157   PetscErrorCode ierr;
2158 
2159   PetscFunctionBegin;
2160   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2161   PetscValidType(mat,1);
2162   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
2163   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
2164 
2165   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2166   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2167   if (x == y) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2168   MatCheckPreallocated(mat,1);
2169 
2170   if (!mat->ops->multdiagonalblock) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"This matrix type does not have a multiply defined");
2171   ierr = (*mat->ops->multdiagonalblock)(mat,x,y);CHKERRQ(ierr);
2172   ierr = PetscObjectStateIncrease((PetscObject)y);CHKERRQ(ierr);
2173   PetscFunctionReturn(0);
2174 }
2175 
2176 /* --------------------------------------------------------*/
2177 #undef __FUNCT__
2178 #define __FUNCT__ "MatMult"
2179 /*@
2180    MatMult - Computes the matrix-vector product, y = Ax.
2181 
2182    Neighbor-wise Collective on Mat and Vec
2183 
2184    Input Parameters:
2185 +  mat - the matrix
2186 -  x   - the vector to be multiplied
2187 
2188    Output Parameters:
2189 .  y - the result
2190 
2191    Notes:
2192    The vectors x and y cannot be the same.  I.e., one cannot
2193    call MatMult(A,y,y).
2194 
2195    Level: beginner
2196 
2197    Concepts: matrix-vector product
2198 
2199 .seealso: MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
2200 @*/
2201 PetscErrorCode  MatMult(Mat mat,Vec x,Vec y)
2202 {
2203   PetscErrorCode ierr;
2204 
2205   PetscFunctionBegin;
2206   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2207   PetscValidType(mat,1);
2208   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
2209   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
2210   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2211   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2212   if (x == y) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2213 #if !defined(PETSC_HAVE_CONSTRAINTS)
2214   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);
2215   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);
2216   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);
2217 #endif
2218   VecLocked(y,3);
2219   if (mat->erroriffpe) {ierr = VecValidValues(x,2,PETSC_TRUE);CHKERRQ(ierr);}
2220   MatCheckPreallocated(mat,1);
2221 
2222   ierr = VecLockPush(x);CHKERRQ(ierr);
2223   if (!mat->ops->mult) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"This matrix type does not have a multiply defined");
2224   ierr = PetscLogEventBegin(MAT_Mult,mat,x,y,0);CHKERRQ(ierr);
2225   ierr = (*mat->ops->mult)(mat,x,y);CHKERRQ(ierr);
2226   ierr = PetscLogEventEnd(MAT_Mult,mat,x,y,0);CHKERRQ(ierr);
2227   if (mat->erroriffpe) {ierr = VecValidValues(y,3,PETSC_FALSE);CHKERRQ(ierr);}
2228   ierr = VecLockPop(x);CHKERRQ(ierr);
2229   PetscFunctionReturn(0);
2230 }
2231 
2232 #undef __FUNCT__
2233 #define __FUNCT__ "MatMultTranspose"
2234 /*@
2235    MatMultTranspose - Computes matrix transpose times a vector.
2236 
2237    Neighbor-wise Collective on Mat and Vec
2238 
2239    Input Parameters:
2240 +  mat - the matrix
2241 -  x   - the vector to be multilplied
2242 
2243    Output Parameters:
2244 .  y - the result
2245 
2246    Notes:
2247    The vectors x and y cannot be the same.  I.e., one cannot
2248    call MatMultTranspose(A,y,y).
2249 
2250    For complex numbers this does NOT compute the Hermitian (complex conjugate) transpose multiple,
2251    use MatMultHermitianTranspose()
2252 
2253    Level: beginner
2254 
2255    Concepts: matrix vector product^transpose
2256 
2257 .seealso: MatMult(), MatMultAdd(), MatMultTransposeAdd(), MatMultHermitianTranspose(), MatTranspose()
2258 @*/
2259 PetscErrorCode  MatMultTranspose(Mat mat,Vec x,Vec y)
2260 {
2261   PetscErrorCode ierr;
2262 
2263   PetscFunctionBegin;
2264   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2265   PetscValidType(mat,1);
2266   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
2267   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
2268 
2269   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2270   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2271   if (x == y) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2272 #if !defined(PETSC_HAVE_CONSTRAINTS)
2273   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);
2274   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);
2275 #endif
2276   if (mat->erroriffpe) {ierr = VecValidValues(x,2,PETSC_TRUE);CHKERRQ(ierr);}
2277   MatCheckPreallocated(mat,1);
2278 
2279   if (!mat->ops->multtranspose) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"This matrix type does not have a multiply tranpose defined");
2280   ierr = PetscLogEventBegin(MAT_MultTranspose,mat,x,y,0);CHKERRQ(ierr);
2281   ierr = VecLockPush(x);CHKERRQ(ierr);
2282   ierr = (*mat->ops->multtranspose)(mat,x,y);CHKERRQ(ierr);
2283   ierr = VecLockPop(x);CHKERRQ(ierr);
2284   ierr = PetscLogEventEnd(MAT_MultTranspose,mat,x,y,0);CHKERRQ(ierr);
2285   ierr = PetscObjectStateIncrease((PetscObject)y);CHKERRQ(ierr);
2286   if (mat->erroriffpe) {ierr = VecValidValues(y,3,PETSC_FALSE);CHKERRQ(ierr);}
2287   PetscFunctionReturn(0);
2288 }
2289 
2290 #undef __FUNCT__
2291 #define __FUNCT__ "MatMultHermitianTranspose"
2292 /*@
2293    MatMultHermitianTranspose - Computes matrix Hermitian transpose times a vector.
2294 
2295    Neighbor-wise Collective on Mat and Vec
2296 
2297    Input Parameters:
2298 +  mat - the matrix
2299 -  x   - the vector to be multilplied
2300 
2301    Output Parameters:
2302 .  y - the result
2303 
2304    Notes:
2305    The vectors x and y cannot be the same.  I.e., one cannot
2306    call MatMultHermitianTranspose(A,y,y).
2307 
2308    Also called the conjugate transpose, complex conjugate transpose, or adjoint.
2309 
2310    For real numbers MatMultTranspose() and MatMultHermitianTranspose() are identical.
2311 
2312    Level: beginner
2313 
2314    Concepts: matrix vector product^transpose
2315 
2316 .seealso: MatMult(), MatMultAdd(), MatMultHermitianTransposeAdd(), MatMultTranspose()
2317 @*/
2318 PetscErrorCode  MatMultHermitianTranspose(Mat mat,Vec x,Vec y)
2319 {
2320   PetscErrorCode ierr;
2321   Vec            w;
2322 
2323   PetscFunctionBegin;
2324   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2325   PetscValidType(mat,1);
2326   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
2327   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
2328 
2329   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2330   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2331   if (x == y) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2332 #if !defined(PETSC_HAVE_CONSTRAINTS)
2333   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);
2334   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);
2335 #endif
2336   MatCheckPreallocated(mat,1);
2337 
2338   ierr = PetscLogEventBegin(MAT_MultHermitianTranspose,mat,x,y,0);CHKERRQ(ierr);
2339   if (mat->ops->multhermitiantranspose) {
2340     ierr = VecLockPush(x);CHKERRQ(ierr);
2341     ierr = (*mat->ops->multhermitiantranspose)(mat,x,y);CHKERRQ(ierr);
2342     ierr = VecLockPop(x);CHKERRQ(ierr);
2343   } else {
2344     ierr = VecDuplicate(x,&w);CHKERRQ(ierr);
2345     ierr = VecCopy(x,w);CHKERRQ(ierr);
2346     ierr = VecConjugate(w);CHKERRQ(ierr);
2347     ierr = MatMultTranspose(mat,w,y);CHKERRQ(ierr);
2348     ierr = VecDestroy(&w);CHKERRQ(ierr);
2349     ierr = VecConjugate(y);CHKERRQ(ierr);
2350   }
2351   ierr = PetscLogEventEnd(MAT_MultHermitianTranspose,mat,x,y,0);CHKERRQ(ierr);
2352   ierr = PetscObjectStateIncrease((PetscObject)y);CHKERRQ(ierr);
2353   PetscFunctionReturn(0);
2354 }
2355 
2356 #undef __FUNCT__
2357 #define __FUNCT__ "MatMultAdd"
2358 /*@
2359     MatMultAdd -  Computes v3 = v2 + A * v1.
2360 
2361     Neighbor-wise Collective on Mat and Vec
2362 
2363     Input Parameters:
2364 +   mat - the matrix
2365 -   v1, v2 - the vectors
2366 
2367     Output Parameters:
2368 .   v3 - the result
2369 
2370     Notes:
2371     The vectors v1 and v3 cannot be the same.  I.e., one cannot
2372     call MatMultAdd(A,v1,v2,v1).
2373 
2374     Level: beginner
2375 
2376     Concepts: matrix vector product^addition
2377 
2378 .seealso: MatMultTranspose(), MatMult(), MatMultTransposeAdd()
2379 @*/
2380 PetscErrorCode  MatMultAdd(Mat mat,Vec v1,Vec v2,Vec v3)
2381 {
2382   PetscErrorCode ierr;
2383 
2384   PetscFunctionBegin;
2385   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2386   PetscValidType(mat,1);
2387   PetscValidHeaderSpecific(v1,VEC_CLASSID,2);
2388   PetscValidHeaderSpecific(v2,VEC_CLASSID,3);
2389   PetscValidHeaderSpecific(v3,VEC_CLASSID,4);
2390 
2391   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2392   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2393   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);
2394   /* 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);
2395      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); */
2396   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);
2397   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);
2398   if (v1 == v3) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"v1 and v3 must be different vectors");
2399   MatCheckPreallocated(mat,1);
2400 
2401   if (!mat->ops->multadd) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"No MatMultAdd() for matrix type '%s'",((PetscObject)mat)->type_name);
2402   ierr = PetscLogEventBegin(MAT_MultAdd,mat,v1,v2,v3);CHKERRQ(ierr);
2403   ierr = VecLockPush(v1);CHKERRQ(ierr);
2404   ierr = (*mat->ops->multadd)(mat,v1,v2,v3);CHKERRQ(ierr);
2405   ierr = VecLockPop(v1);CHKERRQ(ierr);
2406   ierr = PetscLogEventEnd(MAT_MultAdd,mat,v1,v2,v3);CHKERRQ(ierr);
2407   ierr = PetscObjectStateIncrease((PetscObject)v3);CHKERRQ(ierr);
2408   PetscFunctionReturn(0);
2409 }
2410 
2411 #undef __FUNCT__
2412 #define __FUNCT__ "MatMultTransposeAdd"
2413 /*@
2414    MatMultTransposeAdd - Computes v3 = v2 + A' * v1.
2415 
2416    Neighbor-wise Collective on Mat and Vec
2417 
2418    Input Parameters:
2419 +  mat - the matrix
2420 -  v1, v2 - the vectors
2421 
2422    Output Parameters:
2423 .  v3 - the result
2424 
2425    Notes:
2426    The vectors v1 and v3 cannot be the same.  I.e., one cannot
2427    call MatMultTransposeAdd(A,v1,v2,v1).
2428 
2429    Level: beginner
2430 
2431    Concepts: matrix vector product^transpose and addition
2432 
2433 .seealso: MatMultTranspose(), MatMultAdd(), MatMult()
2434 @*/
2435 PetscErrorCode  MatMultTransposeAdd(Mat mat,Vec v1,Vec v2,Vec v3)
2436 {
2437   PetscErrorCode ierr;
2438 
2439   PetscFunctionBegin;
2440   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2441   PetscValidType(mat,1);
2442   PetscValidHeaderSpecific(v1,VEC_CLASSID,2);
2443   PetscValidHeaderSpecific(v2,VEC_CLASSID,3);
2444   PetscValidHeaderSpecific(v3,VEC_CLASSID,4);
2445 
2446   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2447   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2448   if (!mat->ops->multtransposeadd) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2449   if (v1 == v3) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"v1 and v3 must be different vectors");
2450   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);
2451   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);
2452   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);
2453   MatCheckPreallocated(mat,1);
2454 
2455   ierr = PetscLogEventBegin(MAT_MultTransposeAdd,mat,v1,v2,v3);CHKERRQ(ierr);
2456   ierr = VecLockPush(v1);CHKERRQ(ierr);
2457   ierr = (*mat->ops->multtransposeadd)(mat,v1,v2,v3);CHKERRQ(ierr);
2458   ierr = VecLockPop(v1);CHKERRQ(ierr);
2459   ierr = PetscLogEventEnd(MAT_MultTransposeAdd,mat,v1,v2,v3);CHKERRQ(ierr);
2460   ierr = PetscObjectStateIncrease((PetscObject)v3);CHKERRQ(ierr);
2461   PetscFunctionReturn(0);
2462 }
2463 
2464 #undef __FUNCT__
2465 #define __FUNCT__ "MatMultHermitianTransposeAdd"
2466 /*@
2467    MatMultHermitianTransposeAdd - Computes v3 = v2 + A^H * v1.
2468 
2469    Neighbor-wise Collective on Mat and Vec
2470 
2471    Input Parameters:
2472 +  mat - the matrix
2473 -  v1, v2 - the vectors
2474 
2475    Output Parameters:
2476 .  v3 - the result
2477 
2478    Notes:
2479    The vectors v1 and v3 cannot be the same.  I.e., one cannot
2480    call MatMultHermitianTransposeAdd(A,v1,v2,v1).
2481 
2482    Level: beginner
2483 
2484    Concepts: matrix vector product^transpose and addition
2485 
2486 .seealso: MatMultHermitianTranspose(), MatMultTranspose(), MatMultAdd(), MatMult()
2487 @*/
2488 PetscErrorCode  MatMultHermitianTransposeAdd(Mat mat,Vec v1,Vec v2,Vec v3)
2489 {
2490   PetscErrorCode ierr;
2491 
2492   PetscFunctionBegin;
2493   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2494   PetscValidType(mat,1);
2495   PetscValidHeaderSpecific(v1,VEC_CLASSID,2);
2496   PetscValidHeaderSpecific(v2,VEC_CLASSID,3);
2497   PetscValidHeaderSpecific(v3,VEC_CLASSID,4);
2498 
2499   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2500   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2501   if (!mat->ops->multhermitiantransposeadd) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2502   if (v1 == v3) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"v1 and v3 must be different vectors");
2503   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);
2504   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);
2505   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);
2506   MatCheckPreallocated(mat,1);
2507 
2508   ierr = PetscLogEventBegin(MAT_MultHermitianTransposeAdd,mat,v1,v2,v3);CHKERRQ(ierr);
2509   ierr = VecLockPush(v1);CHKERRQ(ierr);
2510   ierr = (*mat->ops->multhermitiantransposeadd)(mat,v1,v2,v3);CHKERRQ(ierr);
2511   ierr = VecLockPop(v1);CHKERRQ(ierr);
2512   ierr = PetscLogEventEnd(MAT_MultHermitianTransposeAdd,mat,v1,v2,v3);CHKERRQ(ierr);
2513   ierr = PetscObjectStateIncrease((PetscObject)v3);CHKERRQ(ierr);
2514   PetscFunctionReturn(0);
2515 }
2516 
2517 #undef __FUNCT__
2518 #define __FUNCT__ "MatMultConstrained"
2519 /*@
2520    MatMultConstrained - The inner multiplication routine for a
2521    constrained matrix P^T A P.
2522 
2523    Neighbor-wise Collective on Mat and Vec
2524 
2525    Input Parameters:
2526 +  mat - the matrix
2527 -  x   - the vector to be multilplied
2528 
2529    Output Parameters:
2530 .  y - the result
2531 
2532    Notes:
2533    The vectors x and y cannot be the same.  I.e., one cannot
2534    call MatMult(A,y,y).
2535 
2536    Level: beginner
2537 
2538 .keywords: matrix, multiply, matrix-vector product, constraint
2539 .seealso: MatMult(), MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
2540 @*/
2541 PetscErrorCode  MatMultConstrained(Mat mat,Vec x,Vec y)
2542 {
2543   PetscErrorCode ierr;
2544 
2545   PetscFunctionBegin;
2546   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2547   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
2548   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
2549   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2550   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2551   if (x == y) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2552   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);
2553   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);
2554   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);
2555 
2556   ierr = PetscLogEventBegin(MAT_MultConstrained,mat,x,y,0);CHKERRQ(ierr);
2557   ierr = VecLockPush(x);CHKERRQ(ierr);
2558   ierr = (*mat->ops->multconstrained)(mat,x,y);CHKERRQ(ierr);
2559   ierr = VecLockPop(x);CHKERRQ(ierr);
2560   ierr = PetscLogEventEnd(MAT_MultConstrained,mat,x,y,0);CHKERRQ(ierr);
2561   ierr = PetscObjectStateIncrease((PetscObject)y);CHKERRQ(ierr);
2562   PetscFunctionReturn(0);
2563 }
2564 
2565 #undef __FUNCT__
2566 #define __FUNCT__ "MatMultTransposeConstrained"
2567 /*@
2568    MatMultTransposeConstrained - The inner multiplication routine for a
2569    constrained matrix P^T A^T P.
2570 
2571    Neighbor-wise Collective on Mat and Vec
2572 
2573    Input Parameters:
2574 +  mat - the matrix
2575 -  x   - the vector to be multilplied
2576 
2577    Output Parameters:
2578 .  y - the result
2579 
2580    Notes:
2581    The vectors x and y cannot be the same.  I.e., one cannot
2582    call MatMult(A,y,y).
2583 
2584    Level: beginner
2585 
2586 .keywords: matrix, multiply, matrix-vector product, constraint
2587 .seealso: MatMult(), MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
2588 @*/
2589 PetscErrorCode  MatMultTransposeConstrained(Mat mat,Vec x,Vec y)
2590 {
2591   PetscErrorCode ierr;
2592 
2593   PetscFunctionBegin;
2594   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2595   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
2596   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
2597   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2598   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2599   if (x == y) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
2600   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);
2601   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);
2602 
2603   ierr = PetscLogEventBegin(MAT_MultConstrained,mat,x,y,0);CHKERRQ(ierr);
2604   ierr = (*mat->ops->multtransposeconstrained)(mat,x,y);CHKERRQ(ierr);
2605   ierr = PetscLogEventEnd(MAT_MultConstrained,mat,x,y,0);CHKERRQ(ierr);
2606   ierr = PetscObjectStateIncrease((PetscObject)y);CHKERRQ(ierr);
2607   PetscFunctionReturn(0);
2608 }
2609 
2610 #undef __FUNCT__
2611 #define __FUNCT__ "MatGetFactorType"
2612 /*@C
2613    MatGetFactorType - gets the type of factorization it is
2614 
2615    Note Collective
2616    as the flag
2617 
2618    Input Parameters:
2619 .  mat - the matrix
2620 
2621    Output Parameters:
2622 .  t - the type, one of MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT
2623 
2624     Level: intermediate
2625 
2626 .seealso:    MatFactorType, MatGetFactor()
2627 @*/
2628 PetscErrorCode  MatGetFactorType(Mat mat,MatFactorType *t)
2629 {
2630   PetscFunctionBegin;
2631   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2632   PetscValidType(mat,1);
2633   *t = mat->factortype;
2634   PetscFunctionReturn(0);
2635 }
2636 
2637 /* ------------------------------------------------------------*/
2638 #undef __FUNCT__
2639 #define __FUNCT__ "MatGetInfo"
2640 /*@C
2641    MatGetInfo - Returns information about matrix storage (number of
2642    nonzeros, memory, etc.).
2643 
2644    Collective on Mat if MAT_GLOBAL_MAX or MAT_GLOBAL_SUM is used as the flag
2645 
2646    Input Parameters:
2647 .  mat - the matrix
2648 
2649    Output Parameters:
2650 +  flag - flag indicating the type of parameters to be returned
2651    (MAT_LOCAL - local matrix, MAT_GLOBAL_MAX - maximum over all processors,
2652    MAT_GLOBAL_SUM - sum over all processors)
2653 -  info - matrix information context
2654 
2655    Notes:
2656    The MatInfo context contains a variety of matrix data, including
2657    number of nonzeros allocated and used, number of mallocs during
2658    matrix assembly, etc.  Additional information for factored matrices
2659    is provided (such as the fill ratio, number of mallocs during
2660    factorization, etc.).  Much of this info is printed to PETSC_STDOUT
2661    when using the runtime options
2662 $       -info -mat_view ::ascii_info
2663 
2664    Example for C/C++ Users:
2665    See the file ${PETSC_DIR}/include/petscmat.h for a complete list of
2666    data within the MatInfo context.  For example,
2667 .vb
2668       MatInfo info;
2669       Mat     A;
2670       double  mal, nz_a, nz_u;
2671 
2672       MatGetInfo(A,MAT_LOCAL,&info);
2673       mal  = info.mallocs;
2674       nz_a = info.nz_allocated;
2675 .ve
2676 
2677    Example for Fortran Users:
2678    Fortran users should declare info as a double precision
2679    array of dimension MAT_INFO_SIZE, and then extract the parameters
2680    of interest.  See the file ${PETSC_DIR}/include/petsc/finclude/petscmat.h
2681    a complete list of parameter names.
2682 .vb
2683       double  precision info(MAT_INFO_SIZE)
2684       double  precision mal, nz_a
2685       Mat     A
2686       integer ierr
2687 
2688       call MatGetInfo(A,MAT_LOCAL,info,ierr)
2689       mal = info(MAT_INFO_MALLOCS)
2690       nz_a = info(MAT_INFO_NZ_ALLOCATED)
2691 .ve
2692 
2693     Level: intermediate
2694 
2695     Concepts: matrices^getting information on
2696 
2697     Developer Note: fortran interface is not autogenerated as the f90
2698     interface defintion cannot be generated correctly [due to MatInfo]
2699 
2700 .seealso: MatStashGetInfo()
2701 
2702 @*/
2703 PetscErrorCode  MatGetInfo(Mat mat,MatInfoType flag,MatInfo *info)
2704 {
2705   PetscErrorCode ierr;
2706 
2707   PetscFunctionBegin;
2708   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2709   PetscValidType(mat,1);
2710   PetscValidPointer(info,3);
2711   if (!mat->ops->getinfo) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2712   MatCheckPreallocated(mat,1);
2713   ierr = (*mat->ops->getinfo)(mat,flag,info);CHKERRQ(ierr);
2714   PetscFunctionReturn(0);
2715 }
2716 
2717 /* ----------------------------------------------------------*/
2718 
2719 #undef __FUNCT__
2720 #define __FUNCT__ "MatLUFactor"
2721 /*@C
2722    MatLUFactor - Performs in-place LU factorization of matrix.
2723 
2724    Collective on Mat
2725 
2726    Input Parameters:
2727 +  mat - the matrix
2728 .  row - row permutation
2729 .  col - column permutation
2730 -  info - options for factorization, includes
2731 $          fill - expected fill as ratio of original fill.
2732 $          dtcol - pivot tolerance (0 no pivot, 1 full column pivoting)
2733 $                   Run with the option -info to determine an optimal value to use
2734 
2735    Notes:
2736    Most users should employ the simplified KSP interface for linear solvers
2737    instead of working directly with matrix algebra routines such as this.
2738    See, e.g., KSPCreate().
2739 
2740    This changes the state of the matrix to a factored matrix; it cannot be used
2741    for example with MatSetValues() unless one first calls MatSetUnfactored().
2742 
2743    Level: developer
2744 
2745    Concepts: matrices^LU factorization
2746 
2747 .seealso: MatLUFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor(),
2748           MatGetOrdering(), MatSetUnfactored(), MatFactorInfo, MatGetFactor()
2749 
2750     Developer Note: fortran interface is not autogenerated as the f90
2751     interface defintion cannot be generated correctly [due to MatFactorInfo]
2752 
2753 @*/
2754 PetscErrorCode  MatLUFactor(Mat mat,IS row,IS col,const MatFactorInfo *info)
2755 {
2756   PetscErrorCode ierr;
2757   MatFactorInfo  tinfo;
2758 
2759   PetscFunctionBegin;
2760   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2761   if (row) PetscValidHeaderSpecific(row,IS_CLASSID,2);
2762   if (col) PetscValidHeaderSpecific(col,IS_CLASSID,3);
2763   if (info) PetscValidPointer(info,4);
2764   PetscValidType(mat,1);
2765   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2766   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2767   if (!mat->ops->lufactor) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2768   MatCheckPreallocated(mat,1);
2769   if (!info) {
2770     ierr = MatFactorInfoInitialize(&tinfo);CHKERRQ(ierr);
2771     info = &tinfo;
2772   }
2773 
2774   ierr = PetscLogEventBegin(MAT_LUFactor,mat,row,col,0);CHKERRQ(ierr);
2775   ierr = (*mat->ops->lufactor)(mat,row,col,info);CHKERRQ(ierr);
2776   ierr = PetscLogEventEnd(MAT_LUFactor,mat,row,col,0);CHKERRQ(ierr);
2777   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
2778   PetscFunctionReturn(0);
2779 }
2780 
2781 #undef __FUNCT__
2782 #define __FUNCT__ "MatILUFactor"
2783 /*@C
2784    MatILUFactor - Performs in-place ILU factorization of matrix.
2785 
2786    Collective on Mat
2787 
2788    Input Parameters:
2789 +  mat - the matrix
2790 .  row - row permutation
2791 .  col - column permutation
2792 -  info - structure containing
2793 $      levels - number of levels of fill.
2794 $      expected fill - as ratio of original fill.
2795 $      1 or 0 - indicating force fill on diagonal (improves robustness for matrices
2796                 missing diagonal entries)
2797 
2798    Notes:
2799    Probably really in-place only when level of fill is zero, otherwise allocates
2800    new space to store factored matrix and deletes previous memory.
2801 
2802    Most users should employ the simplified KSP interface for linear solvers
2803    instead of working directly with matrix algebra routines such as this.
2804    See, e.g., KSPCreate().
2805 
2806    Level: developer
2807 
2808    Concepts: matrices^ILU factorization
2809 
2810 .seealso: MatILUFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor(), MatFactorInfo
2811 
2812     Developer Note: fortran interface is not autogenerated as the f90
2813     interface defintion cannot be generated correctly [due to MatFactorInfo]
2814 
2815 @*/
2816 PetscErrorCode  MatILUFactor(Mat mat,IS row,IS col,const MatFactorInfo *info)
2817 {
2818   PetscErrorCode ierr;
2819 
2820   PetscFunctionBegin;
2821   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2822   if (row) PetscValidHeaderSpecific(row,IS_CLASSID,2);
2823   if (col) PetscValidHeaderSpecific(col,IS_CLASSID,3);
2824   PetscValidPointer(info,4);
2825   PetscValidType(mat,1);
2826   if (mat->rmap->N != mat->cmap->N) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONG,"matrix must be square");
2827   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2828   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2829   if (!mat->ops->ilufactor) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2830   MatCheckPreallocated(mat,1);
2831 
2832   ierr = PetscLogEventBegin(MAT_ILUFactor,mat,row,col,0);CHKERRQ(ierr);
2833   ierr = (*mat->ops->ilufactor)(mat,row,col,info);CHKERRQ(ierr);
2834   ierr = PetscLogEventEnd(MAT_ILUFactor,mat,row,col,0);CHKERRQ(ierr);
2835   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
2836   PetscFunctionReturn(0);
2837 }
2838 
2839 #undef __FUNCT__
2840 #define __FUNCT__ "MatLUFactorSymbolic"
2841 /*@C
2842    MatLUFactorSymbolic - Performs symbolic LU factorization of matrix.
2843    Call this routine before calling MatLUFactorNumeric().
2844 
2845    Collective on Mat
2846 
2847    Input Parameters:
2848 +  fact - the factor matrix obtained with MatGetFactor()
2849 .  mat - the matrix
2850 .  row, col - row and column permutations
2851 -  info - options for factorization, includes
2852 $          fill - expected fill as ratio of original fill.
2853 $          dtcol - pivot tolerance (0 no pivot, 1 full column pivoting)
2854 $                   Run with the option -info to determine an optimal value to use
2855 
2856 
2857    Notes: See Users-Manual: ch_mat for additional information about choosing the fill factor for better efficiency.
2858 
2859    Most users should employ the simplified KSP interface for linear solvers
2860    instead of working directly with matrix algebra routines such as this.
2861    See, e.g., KSPCreate().
2862 
2863    Level: developer
2864 
2865    Concepts: matrices^LU symbolic factorization
2866 
2867 .seealso: MatLUFactor(), MatLUFactorNumeric(), MatCholeskyFactor(), MatFactorInfo, MatFactorInfoInitialize()
2868 
2869     Developer Note: fortran interface is not autogenerated as the f90
2870     interface defintion cannot be generated correctly [due to MatFactorInfo]
2871 
2872 @*/
2873 PetscErrorCode  MatLUFactorSymbolic(Mat fact,Mat mat,IS row,IS col,const MatFactorInfo *info)
2874 {
2875   PetscErrorCode ierr;
2876 
2877   PetscFunctionBegin;
2878   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2879   if (row) PetscValidHeaderSpecific(row,IS_CLASSID,2);
2880   if (col) PetscValidHeaderSpecific(col,IS_CLASSID,3);
2881   if (info) PetscValidPointer(info,4);
2882   PetscValidType(mat,1);
2883   PetscValidPointer(fact,5);
2884   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2885   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2886   if (!(fact)->ops->lufactorsymbolic) {
2887     const MatSolverPackage spackage;
2888     ierr = MatFactorGetSolverPackage(fact,&spackage);CHKERRQ(ierr);
2889     SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s symbolic LU using solver package %s",((PetscObject)mat)->type_name,spackage);
2890   }
2891   MatCheckPreallocated(mat,2);
2892 
2893   ierr = PetscLogEventBegin(MAT_LUFactorSymbolic,mat,row,col,0);CHKERRQ(ierr);
2894   ierr = (fact->ops->lufactorsymbolic)(fact,mat,row,col,info);CHKERRQ(ierr);
2895   ierr = PetscLogEventEnd(MAT_LUFactorSymbolic,mat,row,col,0);CHKERRQ(ierr);
2896   ierr = PetscObjectStateIncrease((PetscObject)fact);CHKERRQ(ierr);
2897   PetscFunctionReturn(0);
2898 }
2899 
2900 #undef __FUNCT__
2901 #define __FUNCT__ "MatLUFactorNumeric"
2902 /*@C
2903    MatLUFactorNumeric - Performs numeric LU factorization of a matrix.
2904    Call this routine after first calling MatLUFactorSymbolic().
2905 
2906    Collective on Mat
2907 
2908    Input Parameters:
2909 +  fact - the factor matrix obtained with MatGetFactor()
2910 .  mat - the matrix
2911 -  info - options for factorization
2912 
2913    Notes:
2914    See MatLUFactor() for in-place factorization.  See
2915    MatCholeskyFactorNumeric() for the symmetric, positive definite case.
2916 
2917    Most users should employ the simplified KSP interface for linear solvers
2918    instead of working directly with matrix algebra routines such as this.
2919    See, e.g., KSPCreate().
2920 
2921    Level: developer
2922 
2923    Concepts: matrices^LU numeric factorization
2924 
2925 .seealso: MatLUFactorSymbolic(), MatLUFactor(), MatCholeskyFactor()
2926 
2927     Developer Note: fortran interface is not autogenerated as the f90
2928     interface defintion cannot be generated correctly [due to MatFactorInfo]
2929 
2930 @*/
2931 PetscErrorCode  MatLUFactorNumeric(Mat fact,Mat mat,const MatFactorInfo *info)
2932 {
2933   PetscErrorCode ierr;
2934 
2935   PetscFunctionBegin;
2936   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2937   PetscValidType(mat,1);
2938   PetscValidPointer(fact,2);
2939   PetscValidHeaderSpecific(fact,MAT_CLASSID,2);
2940   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2941   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);
2942 
2943   if (!(fact)->ops->lufactornumeric) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s numeric LU",((PetscObject)mat)->type_name);
2944   MatCheckPreallocated(mat,2);
2945   ierr = PetscLogEventBegin(MAT_LUFactorNumeric,mat,fact,0,0);CHKERRQ(ierr);
2946   ierr = (fact->ops->lufactornumeric)(fact,mat,info);CHKERRQ(ierr);
2947   ierr = PetscLogEventEnd(MAT_LUFactorNumeric,mat,fact,0,0);CHKERRQ(ierr);
2948   ierr = MatViewFromOptions(fact,NULL,"-mat_factor_view");CHKERRQ(ierr);
2949   ierr = PetscObjectStateIncrease((PetscObject)fact);CHKERRQ(ierr);
2950   PetscFunctionReturn(0);
2951 }
2952 
2953 #undef __FUNCT__
2954 #define __FUNCT__ "MatCholeskyFactor"
2955 /*@C
2956    MatCholeskyFactor - Performs in-place Cholesky factorization of a
2957    symmetric matrix.
2958 
2959    Collective on Mat
2960 
2961    Input Parameters:
2962 +  mat - the matrix
2963 .  perm - row and column permutations
2964 -  f - expected fill as ratio of original fill
2965 
2966    Notes:
2967    See MatLUFactor() for the nonsymmetric case.  See also
2968    MatCholeskyFactorSymbolic(), and MatCholeskyFactorNumeric().
2969 
2970    Most users should employ the simplified KSP interface for linear solvers
2971    instead of working directly with matrix algebra routines such as this.
2972    See, e.g., KSPCreate().
2973 
2974    Level: developer
2975 
2976    Concepts: matrices^Cholesky factorization
2977 
2978 .seealso: MatLUFactor(), MatCholeskyFactorSymbolic(), MatCholeskyFactorNumeric()
2979           MatGetOrdering()
2980 
2981     Developer Note: fortran interface is not autogenerated as the f90
2982     interface defintion cannot be generated correctly [due to MatFactorInfo]
2983 
2984 @*/
2985 PetscErrorCode  MatCholeskyFactor(Mat mat,IS perm,const MatFactorInfo *info)
2986 {
2987   PetscErrorCode ierr;
2988 
2989   PetscFunctionBegin;
2990   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
2991   PetscValidType(mat,1);
2992   if (perm) PetscValidHeaderSpecific(perm,IS_CLASSID,2);
2993   if (info) PetscValidPointer(info,3);
2994   if (mat->rmap->N != mat->cmap->N) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONG,"Matrix must be square");
2995   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2996   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2997   if (!mat->ops->choleskyfactor) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2998   MatCheckPreallocated(mat,1);
2999 
3000   ierr = PetscLogEventBegin(MAT_CholeskyFactor,mat,perm,0,0);CHKERRQ(ierr);
3001   ierr = (*mat->ops->choleskyfactor)(mat,perm,info);CHKERRQ(ierr);
3002   ierr = PetscLogEventEnd(MAT_CholeskyFactor,mat,perm,0,0);CHKERRQ(ierr);
3003   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
3004   PetscFunctionReturn(0);
3005 }
3006 
3007 #undef __FUNCT__
3008 #define __FUNCT__ "MatCholeskyFactorSymbolic"
3009 /*@C
3010    MatCholeskyFactorSymbolic - Performs symbolic Cholesky factorization
3011    of a symmetric matrix.
3012 
3013    Collective on Mat
3014 
3015    Input Parameters:
3016 +  fact - the factor matrix obtained with MatGetFactor()
3017 .  mat - the matrix
3018 .  perm - row and column permutations
3019 -  info - options for factorization, includes
3020 $          fill - expected fill as ratio of original fill.
3021 $          dtcol - pivot tolerance (0 no pivot, 1 full column pivoting)
3022 $                   Run with the option -info to determine an optimal value to use
3023 
3024    Notes:
3025    See MatLUFactorSymbolic() for the nonsymmetric case.  See also
3026    MatCholeskyFactor() and MatCholeskyFactorNumeric().
3027 
3028    Most users should employ the simplified KSP interface for linear solvers
3029    instead of working directly with matrix algebra routines such as this.
3030    See, e.g., KSPCreate().
3031 
3032    Level: developer
3033 
3034    Concepts: matrices^Cholesky symbolic factorization
3035 
3036 .seealso: MatLUFactorSymbolic(), MatCholeskyFactor(), MatCholeskyFactorNumeric()
3037           MatGetOrdering()
3038 
3039     Developer Note: fortran interface is not autogenerated as the f90
3040     interface defintion cannot be generated correctly [due to MatFactorInfo]
3041 
3042 @*/
3043 PetscErrorCode  MatCholeskyFactorSymbolic(Mat fact,Mat mat,IS perm,const MatFactorInfo *info)
3044 {
3045   PetscErrorCode ierr;
3046 
3047   PetscFunctionBegin;
3048   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
3049   PetscValidType(mat,1);
3050   if (perm) PetscValidHeaderSpecific(perm,IS_CLASSID,2);
3051   if (info) PetscValidPointer(info,3);
3052   PetscValidPointer(fact,4);
3053   if (mat->rmap->N != mat->cmap->N) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONG,"Matrix must be square");
3054   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3055   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3056   if (!(fact)->ops->choleskyfactorsymbolic) {
3057     const MatSolverPackage spackage;
3058     ierr = MatFactorGetSolverPackage(fact,&spackage);CHKERRQ(ierr);
3059     SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s symbolic factor Cholesky using solver package %s",((PetscObject)mat)->type_name,spackage);
3060   }
3061   MatCheckPreallocated(mat,2);
3062 
3063   ierr = PetscLogEventBegin(MAT_CholeskyFactorSymbolic,mat,perm,0,0);CHKERRQ(ierr);
3064   ierr = (fact->ops->choleskyfactorsymbolic)(fact,mat,perm,info);CHKERRQ(ierr);
3065   ierr = PetscLogEventEnd(MAT_CholeskyFactorSymbolic,mat,perm,0,0);CHKERRQ(ierr);
3066   ierr = PetscObjectStateIncrease((PetscObject)fact);CHKERRQ(ierr);
3067   PetscFunctionReturn(0);
3068 }
3069 
3070 #undef __FUNCT__
3071 #define __FUNCT__ "MatCholeskyFactorNumeric"
3072 /*@C
3073    MatCholeskyFactorNumeric - Performs numeric Cholesky factorization
3074    of a symmetric matrix. Call this routine after first calling
3075    MatCholeskyFactorSymbolic().
3076 
3077    Collective on Mat
3078 
3079    Input Parameters:
3080 +  fact - the factor matrix obtained with MatGetFactor()
3081 .  mat - the initial matrix
3082 .  info - options for factorization
3083 -  fact - the symbolic factor of mat
3084 
3085 
3086    Notes:
3087    Most users should employ the simplified KSP interface for linear solvers
3088    instead of working directly with matrix algebra routines such as this.
3089    See, e.g., KSPCreate().
3090 
3091    Level: developer
3092 
3093    Concepts: matrices^Cholesky numeric factorization
3094 
3095 .seealso: MatCholeskyFactorSymbolic(), MatCholeskyFactor(), MatLUFactorNumeric()
3096 
3097     Developer Note: fortran interface is not autogenerated as the f90
3098     interface defintion cannot be generated correctly [due to MatFactorInfo]
3099 
3100 @*/
3101 PetscErrorCode  MatCholeskyFactorNumeric(Mat fact,Mat mat,const MatFactorInfo *info)
3102 {
3103   PetscErrorCode ierr;
3104 
3105   PetscFunctionBegin;
3106   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
3107   PetscValidType(mat,1);
3108   PetscValidPointer(fact,2);
3109   PetscValidHeaderSpecific(fact,MAT_CLASSID,2);
3110   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3111   if (!(fact)->ops->choleskyfactornumeric) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s numeric factor Cholesky",((PetscObject)mat)->type_name);
3112   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);
3113   MatCheckPreallocated(mat,2);
3114 
3115   ierr = PetscLogEventBegin(MAT_CholeskyFactorNumeric,mat,fact,0,0);CHKERRQ(ierr);
3116   ierr = (fact->ops->choleskyfactornumeric)(fact,mat,info);CHKERRQ(ierr);
3117   ierr = PetscLogEventEnd(MAT_CholeskyFactorNumeric,mat,fact,0,0);CHKERRQ(ierr);
3118   ierr = MatViewFromOptions(fact,NULL,"-mat_factor_view");CHKERRQ(ierr);
3119   ierr = PetscObjectStateIncrease((PetscObject)fact);CHKERRQ(ierr);
3120   PetscFunctionReturn(0);
3121 }
3122 
3123 /* ----------------------------------------------------------------*/
3124 #undef __FUNCT__
3125 #define __FUNCT__ "MatSolve"
3126 /*@
3127    MatSolve - Solves A x = b, given a factored matrix.
3128 
3129    Neighbor-wise Collective on Mat and Vec
3130 
3131    Input Parameters:
3132 +  mat - the factored matrix
3133 -  b - the right-hand-side vector
3134 
3135    Output Parameter:
3136 .  x - the result vector
3137 
3138    Notes:
3139    The vectors b and x cannot be the same.  I.e., one cannot
3140    call MatSolve(A,x,x).
3141 
3142    Notes:
3143    Most users should employ the simplified KSP interface for linear solvers
3144    instead of working directly with matrix algebra routines such as this.
3145    See, e.g., KSPCreate().
3146 
3147    Level: developer
3148 
3149    Concepts: matrices^triangular solves
3150 
3151 .seealso: MatSolveAdd(), MatSolveTranspose(), MatSolveTransposeAdd()
3152 @*/
3153 PetscErrorCode  MatSolve(Mat mat,Vec b,Vec x)
3154 {
3155   PetscErrorCode ierr;
3156 
3157   PetscFunctionBegin;
3158   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
3159   PetscValidType(mat,1);
3160   PetscValidHeaderSpecific(b,VEC_CLASSID,2);
3161   PetscValidHeaderSpecific(x,VEC_CLASSID,3);
3162   PetscCheckSameComm(mat,1,b,2);
3163   PetscCheckSameComm(mat,1,x,3);
3164   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3165   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3166   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);
3167   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);
3168   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);
3169   if (!mat->rmap->N && !mat->cmap->N) PetscFunctionReturn(0);
3170   if (!mat->ops->solve) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3171   MatCheckPreallocated(mat,1);
3172 
3173   ierr = PetscLogEventBegin(MAT_Solve,mat,b,x,0);CHKERRQ(ierr);
3174   ierr = (*mat->ops->solve)(mat,b,x);CHKERRQ(ierr);
3175   ierr = PetscLogEventEnd(MAT_Solve,mat,b,x,0);CHKERRQ(ierr);
3176   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
3177   PetscFunctionReturn(0);
3178 }
3179 
3180 #undef __FUNCT__
3181 #define __FUNCT__ "MatMatSolve_Basic"
3182 PetscErrorCode  MatMatSolve_Basic(Mat A,Mat B,Mat X)
3183 {
3184   PetscErrorCode ierr;
3185   Vec            b,x;
3186   PetscInt       m,N,i;
3187   PetscScalar    *bb,*xx;
3188   PetscBool      flg;
3189 
3190   PetscFunctionBegin;
3191   ierr = PetscObjectTypeCompareAny((PetscObject)B,&flg,MATSEQDENSE,MATMPIDENSE,NULL);CHKERRQ(ierr);
3192   if (!flg) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONG,"Matrix B must be MATDENSE matrix");
3193   ierr = PetscObjectTypeCompareAny((PetscObject)X,&flg,MATSEQDENSE,MATMPIDENSE,NULL);CHKERRQ(ierr);
3194   if (!flg) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONG,"Matrix X must be MATDENSE matrix");
3195 
3196   ierr = MatDenseGetArray(B,&bb);CHKERRQ(ierr);
3197   ierr = MatDenseGetArray(X,&xx);CHKERRQ(ierr);
3198   ierr = MatGetLocalSize(B,&m,NULL);CHKERRQ(ierr);  /* number local rows */
3199   ierr = MatGetSize(B,NULL,&N);CHKERRQ(ierr);       /* total columns in dense matrix */
3200   ierr = MatCreateVecs(A,&x,&b);CHKERRQ(ierr);
3201   for (i=0; i<N; i++) {
3202     ierr = VecPlaceArray(b,bb + i*m);CHKERRQ(ierr);
3203     ierr = VecPlaceArray(x,xx + i*m);CHKERRQ(ierr);
3204     ierr = MatSolve(A,b,x);CHKERRQ(ierr);
3205     ierr = VecResetArray(x);CHKERRQ(ierr);
3206     ierr = VecResetArray(b);CHKERRQ(ierr);
3207   }
3208   ierr = VecDestroy(&b);CHKERRQ(ierr);
3209   ierr = VecDestroy(&x);CHKERRQ(ierr);
3210   ierr = MatDenseRestoreArray(B,&bb);CHKERRQ(ierr);
3211   ierr = MatDenseRestoreArray(X,&xx);CHKERRQ(ierr);
3212   PetscFunctionReturn(0);
3213 }
3214 
3215 #undef __FUNCT__
3216 #define __FUNCT__ "MatMatSolve"
3217 /*@
3218    MatMatSolve - Solves A X = B, given a factored matrix.
3219 
3220    Neighbor-wise Collective on Mat
3221 
3222    Input Parameters:
3223 +  A - the factored matrix
3224 -  B - the right-hand-side matrix  (dense matrix)
3225 
3226    Output Parameter:
3227 .  X - the result matrix (dense matrix)
3228 
3229    Notes:
3230    The matrices b and x cannot be the same.  I.e., one cannot
3231    call MatMatSolve(A,x,x).
3232 
3233    Notes:
3234    Most users should usually employ the simplified KSP interface for linear solvers
3235    instead of working directly with matrix algebra routines such as this.
3236    See, e.g., KSPCreate(). However KSP can only solve for one vector (column of X)
3237    at a time.
3238 
3239    When using SuperLU_Dist as a parallel solver PETSc will use the SuperLU_Dist functionality to solve multiple right hand sides simultaneously. For MUMPS
3240    it calls a separate solve for each right hand side since MUMPS does not yet support distributed right hand sides.
3241 
3242    Since the resulting matrix X must always be dense we do not support sparse representation of the matrix B.
3243 
3244    Level: developer
3245 
3246    Concepts: matrices^triangular solves
3247 
3248 .seealso: MatMatSolveAdd(), MatMatSolveTranspose(), MatMatSolveTransposeAdd(), MatLUFactor(), MatCholeskyFactor()
3249 @*/
3250 PetscErrorCode  MatMatSolve(Mat A,Mat B,Mat X)
3251 {
3252   PetscErrorCode ierr;
3253 
3254   PetscFunctionBegin;
3255   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
3256   PetscValidType(A,1);
3257   PetscValidHeaderSpecific(B,MAT_CLASSID,2);
3258   PetscValidHeaderSpecific(X,MAT_CLASSID,3);
3259   PetscCheckSameComm(A,1,B,2);
3260   PetscCheckSameComm(A,1,X,3);
3261   if (X == B) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_IDN,"X and B must be different matrices");
3262   if (!A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3263   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);
3264   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);
3265   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);
3266   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");
3267   if (!A->rmap->N && !A->cmap->N) PetscFunctionReturn(0);
3268   MatCheckPreallocated(A,1);
3269 
3270   ierr = PetscLogEventBegin(MAT_MatSolve,A,B,X,0);CHKERRQ(ierr);
3271   if (!A->ops->matsolve) {
3272     ierr = PetscInfo1(A,"Mat type %s using basic MatMatSolve\n",((PetscObject)A)->type_name);CHKERRQ(ierr);
3273     ierr = MatMatSolve_Basic(A,B,X);CHKERRQ(ierr);
3274   } else {
3275     ierr = (*A->ops->matsolve)(A,B,X);CHKERRQ(ierr);
3276   }
3277   ierr = PetscLogEventEnd(MAT_MatSolve,A,B,X,0);CHKERRQ(ierr);
3278   ierr = PetscObjectStateIncrease((PetscObject)X);CHKERRQ(ierr);
3279   PetscFunctionReturn(0);
3280 }
3281 
3282 
3283 #undef __FUNCT__
3284 #define __FUNCT__ "MatForwardSolve"
3285 /*@
3286    MatForwardSolve - Solves L x = b, given a factored matrix, A = LU, or
3287                             U^T*D^(1/2) x = b, given a factored symmetric matrix, A = U^T*D*U,
3288 
3289    Neighbor-wise Collective on Mat and Vec
3290 
3291    Input Parameters:
3292 +  mat - the factored matrix
3293 -  b - the right-hand-side vector
3294 
3295    Output Parameter:
3296 .  x - the result vector
3297 
3298    Notes:
3299    MatSolve() should be used for most applications, as it performs
3300    a forward solve followed by a backward solve.
3301 
3302    The vectors b and x cannot be the same,  i.e., one cannot
3303    call MatForwardSolve(A,x,x).
3304 
3305    For matrix in seqsbaij format with block size larger than 1,
3306    the diagonal blocks are not implemented as D = D^(1/2) * D^(1/2) yet.
3307    MatForwardSolve() solves U^T*D y = b, and
3308    MatBackwardSolve() solves U x = y.
3309    Thus they do not provide a symmetric preconditioner.
3310 
3311    Most users should employ the simplified KSP interface for linear solvers
3312    instead of working directly with matrix algebra routines such as this.
3313    See, e.g., KSPCreate().
3314 
3315    Level: developer
3316 
3317    Concepts: matrices^forward solves
3318 
3319 .seealso: MatSolve(), MatBackwardSolve()
3320 @*/
3321 PetscErrorCode  MatForwardSolve(Mat mat,Vec b,Vec x)
3322 {
3323   PetscErrorCode ierr;
3324 
3325   PetscFunctionBegin;
3326   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
3327   PetscValidType(mat,1);
3328   PetscValidHeaderSpecific(b,VEC_CLASSID,2);
3329   PetscValidHeaderSpecific(x,VEC_CLASSID,3);
3330   PetscCheckSameComm(mat,1,b,2);
3331   PetscCheckSameComm(mat,1,x,3);
3332   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3333   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3334   if (!mat->ops->forwardsolve) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3335   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);
3336   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);
3337   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);
3338   MatCheckPreallocated(mat,1);
3339   ierr = PetscLogEventBegin(MAT_ForwardSolve,mat,b,x,0);CHKERRQ(ierr);
3340   ierr = (*mat->ops->forwardsolve)(mat,b,x);CHKERRQ(ierr);
3341   ierr = PetscLogEventEnd(MAT_ForwardSolve,mat,b,x,0);CHKERRQ(ierr);
3342   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
3343   PetscFunctionReturn(0);
3344 }
3345 
3346 #undef __FUNCT__
3347 #define __FUNCT__ "MatBackwardSolve"
3348 /*@
3349    MatBackwardSolve - Solves U x = b, given a factored matrix, A = LU.
3350                              D^(1/2) U x = b, given a factored symmetric matrix, A = U^T*D*U,
3351 
3352    Neighbor-wise Collective on Mat and Vec
3353 
3354    Input Parameters:
3355 +  mat - the factored matrix
3356 -  b - the right-hand-side vector
3357 
3358    Output Parameter:
3359 .  x - the result vector
3360 
3361    Notes:
3362    MatSolve() should be used for most applications, as it performs
3363    a forward solve followed by a backward solve.
3364 
3365    The vectors b and x cannot be the same.  I.e., one cannot
3366    call MatBackwardSolve(A,x,x).
3367 
3368    For matrix in seqsbaij format with block size larger than 1,
3369    the diagonal blocks are not implemented as D = D^(1/2) * D^(1/2) yet.
3370    MatForwardSolve() solves U^T*D y = b, and
3371    MatBackwardSolve() solves U x = y.
3372    Thus they do not provide a symmetric preconditioner.
3373 
3374    Most users should employ the simplified KSP interface for linear solvers
3375    instead of working directly with matrix algebra routines such as this.
3376    See, e.g., KSPCreate().
3377 
3378    Level: developer
3379 
3380    Concepts: matrices^backward solves
3381 
3382 .seealso: MatSolve(), MatForwardSolve()
3383 @*/
3384 PetscErrorCode  MatBackwardSolve(Mat mat,Vec b,Vec x)
3385 {
3386   PetscErrorCode ierr;
3387 
3388   PetscFunctionBegin;
3389   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
3390   PetscValidType(mat,1);
3391   PetscValidHeaderSpecific(b,VEC_CLASSID,2);
3392   PetscValidHeaderSpecific(x,VEC_CLASSID,3);
3393   PetscCheckSameComm(mat,1,b,2);
3394   PetscCheckSameComm(mat,1,x,3);
3395   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3396   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3397   if (!mat->ops->backwardsolve) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3398   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);
3399   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);
3400   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);
3401   MatCheckPreallocated(mat,1);
3402 
3403   ierr = PetscLogEventBegin(MAT_BackwardSolve,mat,b,x,0);CHKERRQ(ierr);
3404   ierr = (*mat->ops->backwardsolve)(mat,b,x);CHKERRQ(ierr);
3405   ierr = PetscLogEventEnd(MAT_BackwardSolve,mat,b,x,0);CHKERRQ(ierr);
3406   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
3407   PetscFunctionReturn(0);
3408 }
3409 
3410 #undef __FUNCT__
3411 #define __FUNCT__ "MatSolveAdd"
3412 /*@
3413    MatSolveAdd - Computes x = y + inv(A)*b, given a factored matrix.
3414 
3415    Neighbor-wise Collective on Mat and Vec
3416 
3417    Input Parameters:
3418 +  mat - the factored matrix
3419 .  b - the right-hand-side vector
3420 -  y - the vector to be added to
3421 
3422    Output Parameter:
3423 .  x - the result vector
3424 
3425    Notes:
3426    The vectors b and x cannot be the same.  I.e., one cannot
3427    call MatSolveAdd(A,x,y,x).
3428 
3429    Most users should employ the simplified KSP interface for linear solvers
3430    instead of working directly with matrix algebra routines such as this.
3431    See, e.g., KSPCreate().
3432 
3433    Level: developer
3434 
3435    Concepts: matrices^triangular solves
3436 
3437 .seealso: MatSolve(), MatSolveTranspose(), MatSolveTransposeAdd()
3438 @*/
3439 PetscErrorCode  MatSolveAdd(Mat mat,Vec b,Vec y,Vec x)
3440 {
3441   PetscScalar    one = 1.0;
3442   Vec            tmp;
3443   PetscErrorCode ierr;
3444 
3445   PetscFunctionBegin;
3446   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
3447   PetscValidType(mat,1);
3448   PetscValidHeaderSpecific(y,VEC_CLASSID,2);
3449   PetscValidHeaderSpecific(b,VEC_CLASSID,3);
3450   PetscValidHeaderSpecific(x,VEC_CLASSID,4);
3451   PetscCheckSameComm(mat,1,b,2);
3452   PetscCheckSameComm(mat,1,y,2);
3453   PetscCheckSameComm(mat,1,x,3);
3454   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3455   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3456   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);
3457   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);
3458   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);
3459   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);
3460   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);
3461   MatCheckPreallocated(mat,1);
3462 
3463   ierr = PetscLogEventBegin(MAT_SolveAdd,mat,b,x,y);CHKERRQ(ierr);
3464   if (mat->ops->solveadd) {
3465     ierr = (*mat->ops->solveadd)(mat,b,y,x);CHKERRQ(ierr);
3466   } else {
3467     /* do the solve then the add manually */
3468     if (x != y) {
3469       ierr = MatSolve(mat,b,x);CHKERRQ(ierr);
3470       ierr = VecAXPY(x,one,y);CHKERRQ(ierr);
3471     } else {
3472       ierr = VecDuplicate(x,&tmp);CHKERRQ(ierr);
3473       ierr = PetscLogObjectParent((PetscObject)mat,(PetscObject)tmp);CHKERRQ(ierr);
3474       ierr = VecCopy(x,tmp);CHKERRQ(ierr);
3475       ierr = MatSolve(mat,b,x);CHKERRQ(ierr);
3476       ierr = VecAXPY(x,one,tmp);CHKERRQ(ierr);
3477       ierr = VecDestroy(&tmp);CHKERRQ(ierr);
3478     }
3479   }
3480   ierr = PetscLogEventEnd(MAT_SolveAdd,mat,b,x,y);CHKERRQ(ierr);
3481   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
3482   PetscFunctionReturn(0);
3483 }
3484 
3485 #undef __FUNCT__
3486 #define __FUNCT__ "MatSolveTranspose"
3487 /*@
3488    MatSolveTranspose - Solves A' x = b, given a factored matrix.
3489 
3490    Neighbor-wise Collective on Mat and Vec
3491 
3492    Input Parameters:
3493 +  mat - the factored matrix
3494 -  b - the right-hand-side vector
3495 
3496    Output Parameter:
3497 .  x - the result vector
3498 
3499    Notes:
3500    The vectors b and x cannot be the same.  I.e., one cannot
3501    call MatSolveTranspose(A,x,x).
3502 
3503    Most users should employ the simplified KSP interface for linear solvers
3504    instead of working directly with matrix algebra routines such as this.
3505    See, e.g., KSPCreate().
3506 
3507    Level: developer
3508 
3509    Concepts: matrices^triangular solves
3510 
3511 .seealso: MatSolve(), MatSolveAdd(), MatSolveTransposeAdd()
3512 @*/
3513 PetscErrorCode  MatSolveTranspose(Mat mat,Vec b,Vec x)
3514 {
3515   PetscErrorCode ierr;
3516 
3517   PetscFunctionBegin;
3518   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
3519   PetscValidType(mat,1);
3520   PetscValidHeaderSpecific(b,VEC_CLASSID,2);
3521   PetscValidHeaderSpecific(x,VEC_CLASSID,3);
3522   PetscCheckSameComm(mat,1,b,2);
3523   PetscCheckSameComm(mat,1,x,3);
3524   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3525   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3526   if (!mat->ops->solvetranspose) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s",((PetscObject)mat)->type_name);
3527   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);
3528   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);
3529   MatCheckPreallocated(mat,1);
3530   ierr = PetscLogEventBegin(MAT_SolveTranspose,mat,b,x,0);CHKERRQ(ierr);
3531   ierr = (*mat->ops->solvetranspose)(mat,b,x);CHKERRQ(ierr);
3532   ierr = PetscLogEventEnd(MAT_SolveTranspose,mat,b,x,0);CHKERRQ(ierr);
3533   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
3534   PetscFunctionReturn(0);
3535 }
3536 
3537 #undef __FUNCT__
3538 #define __FUNCT__ "MatSolveTransposeAdd"
3539 /*@
3540    MatSolveTransposeAdd - Computes x = y + inv(Transpose(A)) b, given a
3541                       factored matrix.
3542 
3543    Neighbor-wise Collective on Mat and Vec
3544 
3545    Input Parameters:
3546 +  mat - the factored matrix
3547 .  b - the right-hand-side vector
3548 -  y - the vector to be added to
3549 
3550    Output Parameter:
3551 .  x - the result vector
3552 
3553    Notes:
3554    The vectors b and x cannot be the same.  I.e., one cannot
3555    call MatSolveTransposeAdd(A,x,y,x).
3556 
3557    Most users should employ the simplified KSP interface for linear solvers
3558    instead of working directly with matrix algebra routines such as this.
3559    See, e.g., KSPCreate().
3560 
3561    Level: developer
3562 
3563    Concepts: matrices^triangular solves
3564 
3565 .seealso: MatSolve(), MatSolveAdd(), MatSolveTranspose()
3566 @*/
3567 PetscErrorCode  MatSolveTransposeAdd(Mat mat,Vec b,Vec y,Vec x)
3568 {
3569   PetscScalar    one = 1.0;
3570   PetscErrorCode ierr;
3571   Vec            tmp;
3572 
3573   PetscFunctionBegin;
3574   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
3575   PetscValidType(mat,1);
3576   PetscValidHeaderSpecific(y,VEC_CLASSID,2);
3577   PetscValidHeaderSpecific(b,VEC_CLASSID,3);
3578   PetscValidHeaderSpecific(x,VEC_CLASSID,4);
3579   PetscCheckSameComm(mat,1,b,2);
3580   PetscCheckSameComm(mat,1,y,3);
3581   PetscCheckSameComm(mat,1,x,4);
3582   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
3583   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
3584   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);
3585   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);
3586   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);
3587   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);
3588   MatCheckPreallocated(mat,1);
3589 
3590   ierr = PetscLogEventBegin(MAT_SolveTransposeAdd,mat,b,x,y);CHKERRQ(ierr);
3591   if (mat->ops->solvetransposeadd) {
3592     ierr = (*mat->ops->solvetransposeadd)(mat,b,y,x);CHKERRQ(ierr);
3593   } else {
3594     /* do the solve then the add manually */
3595     if (x != y) {
3596       ierr = MatSolveTranspose(mat,b,x);CHKERRQ(ierr);
3597       ierr = VecAXPY(x,one,y);CHKERRQ(ierr);
3598     } else {
3599       ierr = VecDuplicate(x,&tmp);CHKERRQ(ierr);
3600       ierr = PetscLogObjectParent((PetscObject)mat,(PetscObject)tmp);CHKERRQ(ierr);
3601       ierr = VecCopy(x,tmp);CHKERRQ(ierr);
3602       ierr = MatSolveTranspose(mat,b,x);CHKERRQ(ierr);
3603       ierr = VecAXPY(x,one,tmp);CHKERRQ(ierr);
3604       ierr = VecDestroy(&tmp);CHKERRQ(ierr);
3605     }
3606   }
3607   ierr = PetscLogEventEnd(MAT_SolveTransposeAdd,mat,b,x,y);CHKERRQ(ierr);
3608   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
3609   PetscFunctionReturn(0);
3610 }
3611 /* ----------------------------------------------------------------*/
3612 
3613 #undef __FUNCT__
3614 #define __FUNCT__ "MatSOR"
3615 /*@
3616    MatSOR - Computes relaxation (SOR, Gauss-Seidel) sweeps.
3617 
3618    Neighbor-wise Collective on Mat and Vec
3619 
3620    Input Parameters:
3621 +  mat - the matrix
3622 .  b - the right hand side
3623 .  omega - the relaxation factor
3624 .  flag - flag indicating the type of SOR (see below)
3625 .  shift -  diagonal shift
3626 .  its - the number of iterations
3627 -  lits - the number of local iterations
3628 
3629    Output Parameters:
3630 .  x - the solution (can contain an initial guess, use option SOR_ZERO_INITIAL_GUESS to indicate no guess)
3631 
3632    SOR Flags:
3633 .     SOR_FORWARD_SWEEP - forward SOR
3634 .     SOR_BACKWARD_SWEEP - backward SOR
3635 .     SOR_SYMMETRIC_SWEEP - SSOR (symmetric SOR)
3636 .     SOR_LOCAL_FORWARD_SWEEP - local forward SOR
3637 .     SOR_LOCAL_BACKWARD_SWEEP - local forward SOR
3638 .     SOR_LOCAL_SYMMETRIC_SWEEP - local SSOR
3639 .     SOR_APPLY_UPPER, SOR_APPLY_LOWER - applies
3640          upper/lower triangular part of matrix to
3641          vector (with omega)
3642 .     SOR_ZERO_INITIAL_GUESS - zero initial guess
3643 
3644    Notes:
3645    SOR_LOCAL_FORWARD_SWEEP, SOR_LOCAL_BACKWARD_SWEEP, and
3646    SOR_LOCAL_SYMMETRIC_SWEEP perform separate independent smoothings
3647    on each processor.
3648 
3649    Application programmers will not generally use MatSOR() directly,
3650    but instead will employ the KSP/PC interface.
3651 
3652    Notes: for BAIJ, SBAIJ, and AIJ matrices with Inodes this does a block SOR smoothing, otherwise it does a pointwise smoothing
3653 
3654    Notes for Advanced Users:
3655    The flags are implemented as bitwise inclusive or operations.
3656    For example, use (SOR_ZERO_INITIAL_GUESS | SOR_SYMMETRIC_SWEEP)
3657    to specify a zero initial guess for SSOR.
3658 
3659    Most users should employ the simplified KSP interface for linear solvers
3660    instead of working directly with matrix algebra routines such as this.
3661    See, e.g., KSPCreate().
3662 
3663    Vectors x and b CANNOT be the same
3664 
3665    Developer Note: We should add block SOR support for AIJ matrices with block size set to great than one and no inodes
3666 
3667    Level: developer
3668 
3669    Concepts: matrices^relaxation
3670    Concepts: matrices^SOR
3671    Concepts: matrices^Gauss-Seidel
3672 
3673 @*/
3674 PetscErrorCode  MatSOR(Mat mat,Vec b,PetscReal omega,MatSORType flag,PetscReal shift,PetscInt its,PetscInt lits,Vec x)
3675 {
3676   PetscErrorCode ierr;
3677 
3678   PetscFunctionBegin;
3679   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
3680   PetscValidType(mat,1);
3681   PetscValidHeaderSpecific(b,VEC_CLASSID,2);
3682   PetscValidHeaderSpecific(x,VEC_CLASSID,8);
3683   PetscCheckSameComm(mat,1,b,2);
3684   PetscCheckSameComm(mat,1,x,8);
3685   if (!mat->ops->sor) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3686   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3687   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3688   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);
3689   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);
3690   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);
3691   if (its <= 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Relaxation requires global its %D positive",its);
3692   if (lits <= 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Relaxation requires local its %D positive",lits);
3693   if (b == x) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"b and x vector cannot be the same");
3694 
3695   MatCheckPreallocated(mat,1);
3696   ierr = PetscLogEventBegin(MAT_SOR,mat,b,x,0);CHKERRQ(ierr);
3697   ierr =(*mat->ops->sor)(mat,b,omega,flag,shift,its,lits,x);CHKERRQ(ierr);
3698   ierr = PetscLogEventEnd(MAT_SOR,mat,b,x,0);CHKERRQ(ierr);
3699   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
3700   PetscFunctionReturn(0);
3701 }
3702 
3703 #undef __FUNCT__
3704 #define __FUNCT__ "MatCopy_Basic"
3705 /*
3706       Default matrix copy routine.
3707 */
3708 PetscErrorCode MatCopy_Basic(Mat A,Mat B,MatStructure str)
3709 {
3710   PetscErrorCode    ierr;
3711   PetscInt          i,rstart = 0,rend = 0,nz;
3712   const PetscInt    *cwork;
3713   const PetscScalar *vwork;
3714 
3715   PetscFunctionBegin;
3716   if (B->assembled) {
3717     ierr = MatZeroEntries(B);CHKERRQ(ierr);
3718   }
3719   ierr = MatGetOwnershipRange(A,&rstart,&rend);CHKERRQ(ierr);
3720   for (i=rstart; i<rend; i++) {
3721     ierr = MatGetRow(A,i,&nz,&cwork,&vwork);CHKERRQ(ierr);
3722     ierr = MatSetValues(B,1,&i,nz,cwork,vwork,INSERT_VALUES);CHKERRQ(ierr);
3723     ierr = MatRestoreRow(A,i,&nz,&cwork,&vwork);CHKERRQ(ierr);
3724   }
3725   ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
3726   ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
3727   ierr = PetscObjectStateIncrease((PetscObject)B);CHKERRQ(ierr);
3728   PetscFunctionReturn(0);
3729 }
3730 
3731 #undef __FUNCT__
3732 #define __FUNCT__ "MatCopy"
3733 /*@
3734    MatCopy - Copys a matrix to another matrix.
3735 
3736    Collective on Mat
3737 
3738    Input Parameters:
3739 +  A - the matrix
3740 -  str - SAME_NONZERO_PATTERN or DIFFERENT_NONZERO_PATTERN
3741 
3742    Output Parameter:
3743 .  B - where the copy is put
3744 
3745    Notes:
3746    If you use SAME_NONZERO_PATTERN then the two matrices had better have the
3747    same nonzero pattern or the routine will crash.
3748 
3749    MatCopy() copies the matrix entries of a matrix to another existing
3750    matrix (after first zeroing the second matrix).  A related routine is
3751    MatConvert(), which first creates a new matrix and then copies the data.
3752 
3753    Level: intermediate
3754 
3755    Concepts: matrices^copying
3756 
3757 .seealso: MatConvert(), MatDuplicate()
3758 
3759 @*/
3760 PetscErrorCode  MatCopy(Mat A,Mat B,MatStructure str)
3761 {
3762   PetscErrorCode ierr;
3763   PetscInt       i;
3764 
3765   PetscFunctionBegin;
3766   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
3767   PetscValidHeaderSpecific(B,MAT_CLASSID,2);
3768   PetscValidType(A,1);
3769   PetscValidType(B,2);
3770   PetscCheckSameComm(A,1,B,2);
3771   MatCheckPreallocated(B,2);
3772   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3773   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3774   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);
3775   MatCheckPreallocated(A,1);
3776 
3777   ierr = PetscLogEventBegin(MAT_Copy,A,B,0,0);CHKERRQ(ierr);
3778   if (A->ops->copy) {
3779     ierr = (*A->ops->copy)(A,B,str);CHKERRQ(ierr);
3780   } else { /* generic conversion */
3781     ierr = MatCopy_Basic(A,B,str);CHKERRQ(ierr);
3782   }
3783 
3784   B->stencil.dim = A->stencil.dim;
3785   B->stencil.noc = A->stencil.noc;
3786   for (i=0; i<=A->stencil.dim; i++) {
3787     B->stencil.dims[i]   = A->stencil.dims[i];
3788     B->stencil.starts[i] = A->stencil.starts[i];
3789   }
3790 
3791   ierr = PetscLogEventEnd(MAT_Copy,A,B,0,0);CHKERRQ(ierr);
3792   ierr = PetscObjectStateIncrease((PetscObject)B);CHKERRQ(ierr);
3793   PetscFunctionReturn(0);
3794 }
3795 
3796 #undef __FUNCT__
3797 #define __FUNCT__ "MatConvert"
3798 /*@C
3799    MatConvert - Converts a matrix to another matrix, either of the same
3800    or different type.
3801 
3802    Collective on Mat
3803 
3804    Input Parameters:
3805 +  mat - the matrix
3806 .  newtype - new matrix type.  Use MATSAME to create a new matrix of the
3807    same type as the original matrix.
3808 -  reuse - denotes if the destination matrix is to be created or reused.  Currently
3809    MAT_REUSE_MATRIX is only supported for inplace conversion, otherwise use
3810    MAT_INITIAL_MATRIX.
3811 
3812    Output Parameter:
3813 .  M - pointer to place new matrix
3814 
3815    Notes:
3816    MatConvert() first creates a new matrix and then copies the data from
3817    the first matrix.  A related routine is MatCopy(), which copies the matrix
3818    entries of one matrix to another already existing matrix context.
3819 
3820    Cannot be used to convert a sequential matrix to parallel or parallel to sequential,
3821    the MPI communicator of the generated matrix is always the same as the communicator
3822    of the input matrix.
3823 
3824    Level: intermediate
3825 
3826    Concepts: matrices^converting between storage formats
3827 
3828 .seealso: MatCopy(), MatDuplicate()
3829 @*/
3830 PetscErrorCode  MatConvert(Mat mat, MatType newtype,MatReuse reuse,Mat *M)
3831 {
3832   PetscErrorCode ierr;
3833   PetscBool      sametype,issame,flg;
3834   char           convname[256],mtype[256];
3835   Mat            B;
3836 
3837   PetscFunctionBegin;
3838   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
3839   PetscValidType(mat,1);
3840   PetscValidPointer(M,3);
3841   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3842   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3843   MatCheckPreallocated(mat,1);
3844   ierr = MatSetOption(mat,MAT_NEW_NONZERO_LOCATION_ERR,PETSC_FALSE);CHKERRQ(ierr);
3845 
3846   ierr = PetscOptionsGetString(((PetscObject)mat)->prefix,"-matconvert_type",mtype,256,&flg);CHKERRQ(ierr);
3847   if (flg) {
3848     newtype = mtype;
3849   }
3850   ierr = PetscObjectTypeCompare((PetscObject)mat,newtype,&sametype);CHKERRQ(ierr);
3851   ierr = PetscStrcmp(newtype,"same",&issame);CHKERRQ(ierr);
3852   if ((reuse == MAT_REUSE_MATRIX) && (mat != *M)) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"MAT_REUSE_MATRIX only supported for in-place conversion currently");
3853 
3854   if ((reuse == MAT_REUSE_MATRIX) && (issame || sametype)) PetscFunctionReturn(0);
3855 
3856   if ((sametype || issame) && (reuse==MAT_INITIAL_MATRIX) && mat->ops->duplicate) {
3857     ierr = (*mat->ops->duplicate)(mat,MAT_COPY_VALUES,M);CHKERRQ(ierr);
3858   } else {
3859     PetscErrorCode (*conv)(Mat, MatType,MatReuse,Mat*)=NULL;
3860     const char     *prefix[3] = {"seq","mpi",""};
3861     PetscInt       i;
3862     /*
3863        Order of precedence:
3864        1) See if a specialized converter is known to the current matrix.
3865        2) See if a specialized converter is known to the desired matrix class.
3866        3) See if a good general converter is registered for the desired class
3867           (as of 6/27/03 only MATMPIADJ falls into this category).
3868        4) See if a good general converter is known for the current matrix.
3869        5) Use a really basic converter.
3870     */
3871 
3872     /* 1) See if a specialized converter is known to the current matrix and the desired class */
3873     for (i=0; i<3; i++) {
3874       ierr = PetscStrcpy(convname,"MatConvert_");CHKERRQ(ierr);
3875       ierr = PetscStrcat(convname,((PetscObject)mat)->type_name);CHKERRQ(ierr);
3876       ierr = PetscStrcat(convname,"_");CHKERRQ(ierr);
3877       ierr = PetscStrcat(convname,prefix[i]);CHKERRQ(ierr);
3878       ierr = PetscStrcat(convname,issame ? ((PetscObject)mat)->type_name : newtype);CHKERRQ(ierr);
3879       ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr);
3880       ierr = PetscObjectQueryFunction((PetscObject)mat,convname,&conv);CHKERRQ(ierr);
3881       if (conv) goto foundconv;
3882     }
3883 
3884     /* 2)  See if a specialized converter is known to the desired matrix class. */
3885     ierr = MatCreate(PetscObjectComm((PetscObject)mat),&B);CHKERRQ(ierr);
3886     ierr = MatSetSizes(B,mat->rmap->n,mat->cmap->n,mat->rmap->N,mat->cmap->N);CHKERRQ(ierr);
3887     ierr = MatSetType(B,newtype);CHKERRQ(ierr);
3888     for (i=0; i<3; i++) {
3889       ierr = PetscStrcpy(convname,"MatConvert_");CHKERRQ(ierr);
3890       ierr = PetscStrcat(convname,((PetscObject)mat)->type_name);CHKERRQ(ierr);
3891       ierr = PetscStrcat(convname,"_");CHKERRQ(ierr);
3892       ierr = PetscStrcat(convname,prefix[i]);CHKERRQ(ierr);
3893       ierr = PetscStrcat(convname,newtype);CHKERRQ(ierr);
3894       ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr);
3895       ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr);
3896       if (conv) {
3897         ierr = MatDestroy(&B);CHKERRQ(ierr);
3898         goto foundconv;
3899       }
3900     }
3901 
3902     /* 3) See if a good general converter is registered for the desired class */
3903     conv = B->ops->convertfrom;
3904     ierr = MatDestroy(&B);CHKERRQ(ierr);
3905     if (conv) goto foundconv;
3906 
3907     /* 4) See if a good general converter is known for the current matrix */
3908     if (mat->ops->convert) {
3909       conv = mat->ops->convert;
3910     }
3911     if (conv) goto foundconv;
3912 
3913     /* 5) Use a really basic converter. */
3914     conv = MatConvert_Basic;
3915 
3916 foundconv:
3917     ierr = PetscLogEventBegin(MAT_Convert,mat,0,0,0);CHKERRQ(ierr);
3918     ierr = (*conv)(mat,newtype,reuse,M);CHKERRQ(ierr);
3919     ierr = PetscLogEventEnd(MAT_Convert,mat,0,0,0);CHKERRQ(ierr);
3920   }
3921   ierr = PetscObjectStateIncrease((PetscObject)*M);CHKERRQ(ierr);
3922 
3923   /* Copy Mat options */
3924   if (mat->symmetric) {ierr = MatSetOption(*M,MAT_SYMMETRIC,PETSC_TRUE);CHKERRQ(ierr);}
3925   if (mat->hermitian) {ierr = MatSetOption(*M,MAT_HERMITIAN,PETSC_TRUE);CHKERRQ(ierr);}
3926   PetscFunctionReturn(0);
3927 }
3928 
3929 #undef __FUNCT__
3930 #define __FUNCT__ "MatFactorGetSolverPackage"
3931 /*@C
3932    MatFactorGetSolverPackage - Returns name of the package providing the factorization routines
3933 
3934    Not Collective
3935 
3936    Input Parameter:
3937 .  mat - the matrix, must be a factored matrix
3938 
3939    Output Parameter:
3940 .   type - the string name of the package (do not free this string)
3941 
3942    Notes:
3943       In Fortran you pass in a empty string and the package name will be copied into it.
3944     (Make sure the string is long enough)
3945 
3946    Level: intermediate
3947 
3948 .seealso: MatCopy(), MatDuplicate(), MatGetFactorAvailable(), MatGetFactor()
3949 @*/
3950 PetscErrorCode  MatFactorGetSolverPackage(Mat mat, const MatSolverPackage *type)
3951 {
3952   PetscErrorCode ierr, (*conv)(Mat,const MatSolverPackage*);
3953 
3954   PetscFunctionBegin;
3955   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
3956   PetscValidType(mat,1);
3957   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Only for factored matrix");
3958   ierr = PetscObjectQueryFunction((PetscObject)mat,"MatFactorGetSolverPackage_C",&conv);CHKERRQ(ierr);
3959   if (!conv) {
3960     *type = MATSOLVERPETSC;
3961   } else {
3962     ierr = (*conv)(mat,type);CHKERRQ(ierr);
3963   }
3964   PetscFunctionReturn(0);
3965 }
3966 
3967 typedef struct _MatSolverPackageForSpecifcType* MatSolverPackageForSpecifcType;
3968 struct _MatSolverPackageForSpecifcType {
3969   MatType                        mtype;
3970   PetscErrorCode                 (*getfactor[4])(Mat,MatFactorType,Mat*);
3971   MatSolverPackageForSpecifcType next;
3972 };
3973 
3974 typedef struct _MatSolverPackageHolder* MatSolverPackageHolder;
3975 struct _MatSolverPackageHolder {
3976   char                           *name;
3977   MatSolverPackageForSpecifcType handlers;
3978   MatSolverPackageHolder         next;
3979 };
3980 
3981 static MatSolverPackageHolder MatSolverPackageHolders = NULL;
3982 
3983 #undef __FUNCT__
3984 #define __FUNCT__ "MatSolverPackageRegister"
3985 /*@C
3986    MatSolvePackageRegister - Registers a MatSolverPackage that works for a particular matrix type
3987 
3988    Input Parameters:
3989 +    package - name of the package, for example petsc or superlu
3990 .    mtype - the matrix type that works with this package
3991 .    ftype - the type of factorization supported by the package
3992 -    getfactor - routine that will create the factored matrix ready to be used
3993 
3994     Level: intermediate
3995 
3996 .seealso: MatCopy(), MatDuplicate(), MatGetFactorAvailable()
3997 @*/
3998 PetscErrorCode  MatSolverPackageRegister(const MatSolverPackage package,const MatType mtype,MatFactorType ftype,PetscErrorCode (*getfactor)(Mat,MatFactorType,Mat*))
3999 {
4000   PetscErrorCode                 ierr;
4001   MatSolverPackageHolder         next = MatSolverPackageHolders,prev;
4002   PetscBool                      flg;
4003   MatSolverPackageForSpecifcType inext,iprev = NULL;
4004 
4005   PetscFunctionBegin;
4006   if (!MatSolverPackageHolders) {
4007     ierr = PetscNew(&MatSolverPackageHolders);CHKERRQ(ierr);
4008     ierr = PetscStrallocpy(package,&MatSolverPackageHolders->name);CHKERRQ(ierr);
4009     ierr = PetscNew(&MatSolverPackageHolders->handlers);CHKERRQ(ierr);
4010     ierr = PetscStrallocpy(mtype,(char **)&MatSolverPackageHolders->handlers->mtype);CHKERRQ(ierr);
4011     MatSolverPackageHolders->handlers->getfactor[(int)ftype-1] = getfactor;
4012     PetscFunctionReturn(0);
4013   }
4014   while (next) {
4015     ierr = PetscStrcasecmp(package,next->name,&flg);CHKERRQ(ierr);
4016     if (flg) {
4017       inext = next->handlers;
4018       while (inext) {
4019         ierr = PetscStrcasecmp(mtype,inext->mtype,&flg);CHKERRQ(ierr);
4020         if (flg) {
4021           inext->getfactor[(int)ftype-1] = getfactor;
4022           PetscFunctionReturn(0);
4023         }
4024         iprev = inext;
4025         inext = inext->next;
4026       }
4027       ierr = PetscNew(&iprev->next);CHKERRQ(ierr);
4028       ierr = PetscStrallocpy(mtype,(char **)&iprev->next->mtype);CHKERRQ(ierr);
4029       iprev->next->getfactor[(int)ftype-1] = getfactor;
4030       PetscFunctionReturn(0);
4031     }
4032     prev = next;
4033     next = next->next;
4034   }
4035   ierr = PetscNew(&prev->next);CHKERRQ(ierr);
4036   ierr = PetscStrallocpy(package,&prev->next->name);CHKERRQ(ierr);
4037   ierr = PetscNew(&prev->next->handlers);CHKERRQ(ierr);
4038   ierr = PetscStrallocpy(mtype,(char **)&prev->next->handlers->mtype);CHKERRQ(ierr);
4039   prev->next->handlers->getfactor[(int)ftype-1] = getfactor;
4040   PetscFunctionReturn(0);
4041 }
4042 
4043 #undef __FUNCT__
4044 #define __FUNCT__ "MatSolverPackageGet"
4045 /*@C
4046    MatSolvePackageGet - Get's the function that creates the factor matrix if it exist
4047 
4048    Input Parameters:
4049 +    package - name of the package, for example petsc or superlu
4050 .    ftype - the type of factorization supported by the package
4051 -    mtype - the matrix type that works with this package
4052 
4053    Output Parameters:
4054 +   foundpackage - PETSC_TRUE if the package was registered
4055 .   foundmtype - PETSC_TRUE if the package supports the requested mtype
4056 -   getfactor - routine that will create the factored matrix ready to be used or NULL if not found
4057 
4058     Level: intermediate
4059 
4060 .seealso: MatCopy(), MatDuplicate(), MatGetFactorAvailable()
4061 @*/
4062 PetscErrorCode  MatSolverPackageGet(const MatSolverPackage package,const MatType mtype,MatFactorType ftype,PetscBool *foundpackage,PetscBool *foundmtype,PetscErrorCode (**getfactor)(Mat,MatFactorType,Mat*))
4063 {
4064   PetscErrorCode                 ierr;
4065   MatSolverPackageHolder         next = MatSolverPackageHolders;
4066   PetscBool                      flg;
4067   MatSolverPackageForSpecifcType inext;
4068 
4069   PetscFunctionBegin;
4070   if (foundpackage) *foundpackage = PETSC_FALSE;
4071   if (foundmtype)   *foundmtype   = PETSC_FALSE;
4072   if (getfactor)    *getfactor    = NULL;
4073   while (next) {
4074     ierr = PetscStrcasecmp(package,next->name,&flg);CHKERRQ(ierr);
4075     if (flg) {
4076       if (foundpackage) *foundpackage = PETSC_TRUE;
4077       inext = next->handlers;
4078       while (inext) {
4079         ierr = PetscStrcasecmp(mtype,inext->mtype,&flg);CHKERRQ(ierr);
4080         if (flg) {
4081           if (foundmtype) *foundmtype = PETSC_TRUE;
4082           if (getfactor)  *getfactor  = inext->getfactor[(int)ftype-1];
4083           PetscFunctionReturn(0);
4084         }
4085         inext = inext->next;
4086       }
4087     }
4088     next = next->next;
4089   }
4090   PetscFunctionReturn(0);
4091 }
4092 
4093 #undef __FUNCT__
4094 #define __FUNCT__ "MatSolverPackageDestroy"
4095 PetscErrorCode  MatSolverPackageDestroy(void)
4096 {
4097   PetscErrorCode                 ierr;
4098   MatSolverPackageHolder         next = MatSolverPackageHolders,prev;
4099   MatSolverPackageForSpecifcType inext,iprev;
4100 
4101   PetscFunctionBegin;
4102   while (next) {
4103     ierr = PetscFree(next->name);CHKERRQ(ierr);
4104     inext = next->handlers;
4105     while (inext) {
4106       ierr = PetscFree(inext->mtype);CHKERRQ(ierr);
4107       iprev = inext;
4108       inext = inext->next;
4109       ierr = PetscFree(iprev);CHKERRQ(ierr);
4110     }
4111     prev = next;
4112     next = next->next;
4113     ierr = PetscFree(prev);CHKERRQ(ierr);
4114   }
4115   MatSolverPackageHolders = NULL;
4116   PetscFunctionReturn(0);
4117 }
4118 
4119 #undef __FUNCT__
4120 #define __FUNCT__ "MatGetFactor"
4121 /*@C
4122    MatGetFactor - Returns a matrix suitable to calls to MatXXFactorSymbolic()
4123 
4124    Collective on Mat
4125 
4126    Input Parameters:
4127 +  mat - the matrix
4128 .  type - name of solver type, for example, superlu, petsc (to use PETSc's default)
4129 -  ftype - factor type, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ICC, MAT_FACTOR_ILU,
4130 
4131    Output Parameters:
4132 .  f - the factor matrix used with MatXXFactorSymbolic() calls
4133 
4134    Notes:
4135       Some PETSc matrix formats have alternative solvers available that are contained in alternative packages
4136      such as pastix, superlu, mumps etc.
4137 
4138       PETSc must have been ./configure to use the external solver, using the option --download-package
4139 
4140    Level: intermediate
4141 
4142 .seealso: MatCopy(), MatDuplicate(), MatGetFactorAvailable()
4143 @*/
4144 PetscErrorCode  MatGetFactor(Mat mat, const MatSolverPackage type,MatFactorType ftype,Mat *f)
4145 {
4146   PetscErrorCode ierr,(*conv)(Mat,MatFactorType,Mat*);
4147   PetscBool      foundpackage,foundmtype;
4148 
4149   PetscFunctionBegin;
4150   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
4151   PetscValidType(mat,1);
4152 
4153   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4154   MatCheckPreallocated(mat,1);
4155 
4156   ierr = MatSolverPackageGet(type,((PetscObject)mat)->type_name,ftype,&foundpackage,&foundmtype,&conv);CHKERRQ(ierr);
4157   if (!foundpackage) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_MISSING_FACTOR,"Could not locate solver package %s. Perhaps you must ./configure with --download-%s",type,type);
4158   if (!foundmtype) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_MISSING_FACTOR,"MatSolverPackage %s does not support matrix type %s",type,((PetscObject)mat)->type_name);
4159   if (!conv) SETERRQ3(PetscObjectComm((PetscObject)mat),PETSC_ERR_MISSING_FACTOR,"MatSolverPackage %s does not support factorization type %s for  matrix type %s",type,MatFactorTypes[ftype],((PetscObject)mat)->type_name);
4160 
4161   ierr = (*conv)(mat,ftype,f);CHKERRQ(ierr);
4162   PetscFunctionReturn(0);
4163 }
4164 
4165 #undef __FUNCT__
4166 #define __FUNCT__ "MatGetFactorAvailable"
4167 /*@C
4168    MatGetFactorAvailable - Returns a a flag if matrix supports particular package and factor type
4169 
4170    Not Collective
4171 
4172    Input Parameters:
4173 +  mat - the matrix
4174 .  type - name of solver type, for example, superlu, petsc (to use PETSc's default)
4175 -  ftype - factor type, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ICC, MAT_FACTOR_ILU,
4176 
4177    Output Parameter:
4178 .    flg - PETSC_TRUE if the factorization is available
4179 
4180    Notes:
4181       Some PETSc matrix formats have alternative solvers available that are contained in alternative packages
4182      such as pastix, superlu, mumps etc.
4183 
4184       PETSc must have been ./configure to use the external solver, using the option --download-package
4185 
4186    Level: intermediate
4187 
4188 .seealso: MatCopy(), MatDuplicate(), MatGetFactor()
4189 @*/
4190 PetscErrorCode  MatGetFactorAvailable(Mat mat, const MatSolverPackage type,MatFactorType ftype,PetscBool  *flg)
4191 {
4192   PetscErrorCode ierr, (*gconv)(Mat,MatFactorType,Mat*);
4193 
4194   PetscFunctionBegin;
4195   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
4196   PetscValidType(mat,1);
4197 
4198   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4199   MatCheckPreallocated(mat,1);
4200 
4201   *flg = PETSC_FALSE;
4202   ierr = MatSolverPackageGet(type,((PetscObject)mat)->type_name,ftype,NULL,NULL,&gconv);CHKERRQ(ierr);
4203   if (gconv) {
4204     *flg = PETSC_TRUE;
4205   }
4206   PetscFunctionReturn(0);
4207 }
4208 
4209 #include <petscdmtypes.h>
4210 
4211 #undef __FUNCT__
4212 #define __FUNCT__ "MatDuplicate"
4213 /*@
4214    MatDuplicate - Duplicates a matrix including the non-zero structure.
4215 
4216    Collective on Mat
4217 
4218    Input Parameters:
4219 +  mat - the matrix
4220 -  op - either MAT_DO_NOT_COPY_VALUES or MAT_COPY_VALUES, cause it to copy the numerical values in the matrix
4221         MAT_SHARE_NONZERO_PATTERN to share the nonzero patterns with the previous matrix and not copy them.
4222 
4223    Output Parameter:
4224 .  M - pointer to place new matrix
4225 
4226    Level: intermediate
4227 
4228    Concepts: matrices^duplicating
4229 
4230     Notes: You cannot change the nonzero pattern for the parent or child matrix if you use MAT_SHARE_NONZERO_PATTERN.
4231 
4232 .seealso: MatCopy(), MatConvert()
4233 @*/
4234 PetscErrorCode  MatDuplicate(Mat mat,MatDuplicateOption op,Mat *M)
4235 {
4236   PetscErrorCode ierr;
4237   Mat            B;
4238   PetscInt       i;
4239   DM             dm;
4240 
4241   PetscFunctionBegin;
4242   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
4243   PetscValidType(mat,1);
4244   PetscValidPointer(M,3);
4245   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4246   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4247   MatCheckPreallocated(mat,1);
4248 
4249   *M = 0;
4250   if (!mat->ops->duplicate) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Not written for this matrix type");
4251   ierr = PetscLogEventBegin(MAT_Convert,mat,0,0,0);CHKERRQ(ierr);
4252   ierr = (*mat->ops->duplicate)(mat,op,M);CHKERRQ(ierr);
4253   B    = *M;
4254 
4255   B->stencil.dim = mat->stencil.dim;
4256   B->stencil.noc = mat->stencil.noc;
4257   for (i=0; i<=mat->stencil.dim; i++) {
4258     B->stencil.dims[i]   = mat->stencil.dims[i];
4259     B->stencil.starts[i] = mat->stencil.starts[i];
4260   }
4261 
4262   B->nooffproczerorows = mat->nooffproczerorows;
4263   B->nooffprocentries  = mat->nooffprocentries;
4264 
4265   ierr = PetscObjectQuery((PetscObject) mat, "__PETSc_dm", (PetscObject*) &dm);CHKERRQ(ierr);
4266   if (dm) {
4267     ierr = PetscObjectCompose((PetscObject) B, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
4268   }
4269   ierr = PetscLogEventEnd(MAT_Convert,mat,0,0,0);CHKERRQ(ierr);
4270   ierr = PetscObjectStateIncrease((PetscObject)B);CHKERRQ(ierr);
4271   PetscFunctionReturn(0);
4272 }
4273 
4274 #undef __FUNCT__
4275 #define __FUNCT__ "MatGetDiagonal"
4276 /*@
4277    MatGetDiagonal - Gets the diagonal of a matrix.
4278 
4279    Logically Collective on Mat and Vec
4280 
4281    Input Parameters:
4282 +  mat - the matrix
4283 -  v - the vector for storing the diagonal
4284 
4285    Output Parameter:
4286 .  v - the diagonal of the matrix
4287 
4288    Level: intermediate
4289 
4290    Note:
4291    Currently only correct in parallel for square matrices.
4292 
4293    Concepts: matrices^accessing diagonals
4294 
4295 .seealso: MatGetRow(), MatGetSubMatrices(), MatGetSubmatrix(), MatGetRowMaxAbs()
4296 @*/
4297 PetscErrorCode  MatGetDiagonal(Mat mat,Vec v)
4298 {
4299   PetscErrorCode ierr;
4300 
4301   PetscFunctionBegin;
4302   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
4303   PetscValidType(mat,1);
4304   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
4305   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4306   if (!mat->ops->getdiagonal) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4307   MatCheckPreallocated(mat,1);
4308 
4309   ierr = (*mat->ops->getdiagonal)(mat,v);CHKERRQ(ierr);
4310   ierr = PetscObjectStateIncrease((PetscObject)v);CHKERRQ(ierr);
4311   PetscFunctionReturn(0);
4312 }
4313 
4314 #undef __FUNCT__
4315 #define __FUNCT__ "MatGetRowMin"
4316 /*@C
4317    MatGetRowMin - Gets the minimum value (of the real part) of each
4318         row of the matrix
4319 
4320    Logically Collective on Mat and Vec
4321 
4322    Input Parameters:
4323 .  mat - the matrix
4324 
4325    Output Parameter:
4326 +  v - the vector for storing the maximums
4327 -  idx - the indices of the column found for each row (optional)
4328 
4329    Level: intermediate
4330 
4331    Notes: The result of this call are the same as if one converted the matrix to dense format
4332       and found the minimum value in each row (i.e. the implicit zeros are counted as zeros).
4333 
4334     This code is only implemented for a couple of matrix formats.
4335 
4336    Concepts: matrices^getting row maximums
4337 
4338 .seealso: MatGetDiagonal(), MatGetSubMatrices(), MatGetSubmatrix(), MatGetRowMaxAbs(),
4339           MatGetRowMax()
4340 @*/
4341 PetscErrorCode  MatGetRowMin(Mat mat,Vec v,PetscInt idx[])
4342 {
4343   PetscErrorCode ierr;
4344 
4345   PetscFunctionBegin;
4346   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
4347   PetscValidType(mat,1);
4348   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
4349   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4350   if (!mat->ops->getrowmax) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4351   MatCheckPreallocated(mat,1);
4352 
4353   ierr = (*mat->ops->getrowmin)(mat,v,idx);CHKERRQ(ierr);
4354   ierr = PetscObjectStateIncrease((PetscObject)v);CHKERRQ(ierr);
4355   PetscFunctionReturn(0);
4356 }
4357 
4358 #undef __FUNCT__
4359 #define __FUNCT__ "MatGetRowMinAbs"
4360 /*@C
4361    MatGetRowMinAbs - Gets the minimum value (in absolute value) of each
4362         row of the matrix
4363 
4364    Logically Collective on Mat and Vec
4365 
4366    Input Parameters:
4367 .  mat - the matrix
4368 
4369    Output Parameter:
4370 +  v - the vector for storing the minimums
4371 -  idx - the indices of the column found for each row (or NULL if not needed)
4372 
4373    Level: intermediate
4374 
4375    Notes: if a row is completely empty or has only 0.0 values then the idx[] value for that
4376     row is 0 (the first column).
4377 
4378     This code is only implemented for a couple of matrix formats.
4379 
4380    Concepts: matrices^getting row maximums
4381 
4382 .seealso: MatGetDiagonal(), MatGetSubMatrices(), MatGetSubmatrix(), MatGetRowMax(), MatGetRowMaxAbs(), MatGetRowMin()
4383 @*/
4384 PetscErrorCode  MatGetRowMinAbs(Mat mat,Vec v,PetscInt idx[])
4385 {
4386   PetscErrorCode ierr;
4387 
4388   PetscFunctionBegin;
4389   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
4390   PetscValidType(mat,1);
4391   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
4392   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4393   if (!mat->ops->getrowminabs) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4394   MatCheckPreallocated(mat,1);
4395   if (idx) {ierr = PetscMemzero(idx,mat->rmap->n*sizeof(PetscInt));CHKERRQ(ierr);}
4396 
4397   ierr = (*mat->ops->getrowminabs)(mat,v,idx);CHKERRQ(ierr);
4398   ierr = PetscObjectStateIncrease((PetscObject)v);CHKERRQ(ierr);
4399   PetscFunctionReturn(0);
4400 }
4401 
4402 #undef __FUNCT__
4403 #define __FUNCT__ "MatGetRowMax"
4404 /*@C
4405    MatGetRowMax - Gets the maximum value (of the real part) of each
4406         row of the matrix
4407 
4408    Logically Collective on Mat and Vec
4409 
4410    Input Parameters:
4411 .  mat - the matrix
4412 
4413    Output Parameter:
4414 +  v - the vector for storing the maximums
4415 -  idx - the indices of the column found for each row (optional)
4416 
4417    Level: intermediate
4418 
4419    Notes: The result of this call are the same as if one converted the matrix to dense format
4420       and found the minimum value in each row (i.e. the implicit zeros are counted as zeros).
4421 
4422     This code is only implemented for a couple of matrix formats.
4423 
4424    Concepts: matrices^getting row maximums
4425 
4426 .seealso: MatGetDiagonal(), MatGetSubMatrices(), MatGetSubmatrix(), MatGetRowMaxAbs(), MatGetRowMin()
4427 @*/
4428 PetscErrorCode  MatGetRowMax(Mat mat,Vec v,PetscInt idx[])
4429 {
4430   PetscErrorCode ierr;
4431 
4432   PetscFunctionBegin;
4433   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
4434   PetscValidType(mat,1);
4435   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
4436   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4437   if (!mat->ops->getrowmax) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4438   MatCheckPreallocated(mat,1);
4439 
4440   ierr = (*mat->ops->getrowmax)(mat,v,idx);CHKERRQ(ierr);
4441   ierr = PetscObjectStateIncrease((PetscObject)v);CHKERRQ(ierr);
4442   PetscFunctionReturn(0);
4443 }
4444 
4445 #undef __FUNCT__
4446 #define __FUNCT__ "MatGetRowMaxAbs"
4447 /*@C
4448    MatGetRowMaxAbs - Gets the maximum value (in absolute value) of each
4449         row of the matrix
4450 
4451    Logically Collective on Mat and Vec
4452 
4453    Input Parameters:
4454 .  mat - the matrix
4455 
4456    Output Parameter:
4457 +  v - the vector for storing the maximums
4458 -  idx - the indices of the column found for each row (or NULL if not needed)
4459 
4460    Level: intermediate
4461 
4462    Notes: if a row is completely empty or has only 0.0 values then the idx[] value for that
4463     row is 0 (the first column).
4464 
4465     This code is only implemented for a couple of matrix formats.
4466 
4467    Concepts: matrices^getting row maximums
4468 
4469 .seealso: MatGetDiagonal(), MatGetSubMatrices(), MatGetSubmatrix(), MatGetRowMax(), MatGetRowMin()
4470 @*/
4471 PetscErrorCode  MatGetRowMaxAbs(Mat mat,Vec v,PetscInt idx[])
4472 {
4473   PetscErrorCode ierr;
4474 
4475   PetscFunctionBegin;
4476   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
4477   PetscValidType(mat,1);
4478   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
4479   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4480   if (!mat->ops->getrowmaxabs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4481   MatCheckPreallocated(mat,1);
4482   if (idx) {ierr = PetscMemzero(idx,mat->rmap->n*sizeof(PetscInt));CHKERRQ(ierr);}
4483 
4484   ierr = (*mat->ops->getrowmaxabs)(mat,v,idx);CHKERRQ(ierr);
4485   ierr = PetscObjectStateIncrease((PetscObject)v);CHKERRQ(ierr);
4486   PetscFunctionReturn(0);
4487 }
4488 
4489 #undef __FUNCT__
4490 #define __FUNCT__ "MatGetRowSum"
4491 /*@
4492    MatGetRowSum - Gets the sum of each row of the matrix
4493 
4494    Logically Collective on Mat and Vec
4495 
4496    Input Parameters:
4497 .  mat - the matrix
4498 
4499    Output Parameter:
4500 .  v - the vector for storing the sum of rows
4501 
4502    Level: intermediate
4503 
4504    Notes: This code is slow since it is not currently specialized for different formats
4505 
4506    Concepts: matrices^getting row sums
4507 
4508 .seealso: MatGetDiagonal(), MatGetSubMatrices(), MatGetSubmatrix(), MatGetRowMax(), MatGetRowMin()
4509 @*/
4510 PetscErrorCode  MatGetRowSum(Mat mat, Vec v)
4511 {
4512   PetscInt       start = 0, end = 0, row;
4513   PetscScalar    *array;
4514   PetscErrorCode ierr;
4515 
4516   PetscFunctionBegin;
4517   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
4518   PetscValidType(mat,1);
4519   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
4520   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4521   MatCheckPreallocated(mat,1);
4522   ierr = MatGetOwnershipRange(mat, &start, &end);CHKERRQ(ierr);
4523   ierr = VecGetArray(v, &array);CHKERRQ(ierr);
4524   for (row = start; row < end; ++row) {
4525     PetscInt          ncols, col;
4526     const PetscInt    *cols;
4527     const PetscScalar *vals;
4528 
4529     array[row - start] = 0.0;
4530 
4531     ierr = MatGetRow(mat, row, &ncols, &cols, &vals);CHKERRQ(ierr);
4532     for (col = 0; col < ncols; col++) {
4533       array[row - start] += vals[col];
4534     }
4535     ierr = MatRestoreRow(mat, row, &ncols, &cols, &vals);CHKERRQ(ierr);
4536   }
4537   ierr = VecRestoreArray(v, &array);CHKERRQ(ierr);
4538   ierr = PetscObjectStateIncrease((PetscObject) v);CHKERRQ(ierr);
4539   PetscFunctionReturn(0);
4540 }
4541 
4542 #undef __FUNCT__
4543 #define __FUNCT__ "MatTranspose"
4544 /*@
4545    MatTranspose - Computes an in-place or out-of-place transpose of a matrix.
4546 
4547    Collective on Mat
4548 
4549    Input Parameter:
4550 +  mat - the matrix to transpose
4551 -  reuse - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
4552 
4553    Output Parameters:
4554 .  B - the transpose
4555 
4556    Notes:
4557      If you  pass in &mat for B the transpose will be done in place, for example MatTranspose(mat,MAT_REUSE_MATRIX,&mat);
4558 
4559      Consider using MatCreateTranspose() instead if you only need a matrix that behaves like the transpose, but don't need the storage to be changed.
4560 
4561    Level: intermediate
4562 
4563    Concepts: matrices^transposing
4564 
4565 .seealso: MatMultTranspose(), MatMultTransposeAdd(), MatIsTranspose(), MatReuse
4566 @*/
4567 PetscErrorCode  MatTranspose(Mat mat,MatReuse reuse,Mat *B)
4568 {
4569   PetscErrorCode ierr;
4570 
4571   PetscFunctionBegin;
4572   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
4573   PetscValidType(mat,1);
4574   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4575   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4576   if (!mat->ops->transpose) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4577   MatCheckPreallocated(mat,1);
4578 
4579   ierr = PetscLogEventBegin(MAT_Transpose,mat,0,0,0);CHKERRQ(ierr);
4580   ierr = (*mat->ops->transpose)(mat,reuse,B);CHKERRQ(ierr);
4581   ierr = PetscLogEventEnd(MAT_Transpose,mat,0,0,0);CHKERRQ(ierr);
4582   if (B) {ierr = PetscObjectStateIncrease((PetscObject)*B);CHKERRQ(ierr);}
4583   PetscFunctionReturn(0);
4584 }
4585 
4586 #undef __FUNCT__
4587 #define __FUNCT__ "MatIsTranspose"
4588 /*@
4589    MatIsTranspose - Test whether a matrix is another one's transpose,
4590         or its own, in which case it tests symmetry.
4591 
4592    Collective on Mat
4593 
4594    Input Parameter:
4595 +  A - the matrix to test
4596 -  B - the matrix to test against, this can equal the first parameter
4597 
4598    Output Parameters:
4599 .  flg - the result
4600 
4601    Notes:
4602    Only available for SeqAIJ/MPIAIJ matrices. The sequential algorithm
4603    has a running time of the order of the number of nonzeros; the parallel
4604    test involves parallel copies of the block-offdiagonal parts of the matrix.
4605 
4606    Level: intermediate
4607 
4608    Concepts: matrices^transposing, matrix^symmetry
4609 
4610 .seealso: MatTranspose(), MatIsSymmetric(), MatIsHermitian()
4611 @*/
4612 PetscErrorCode  MatIsTranspose(Mat A,Mat B,PetscReal tol,PetscBool  *flg)
4613 {
4614   PetscErrorCode ierr,(*f)(Mat,Mat,PetscReal,PetscBool*),(*g)(Mat,Mat,PetscReal,PetscBool*);
4615 
4616   PetscFunctionBegin;
4617   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
4618   PetscValidHeaderSpecific(B,MAT_CLASSID,2);
4619   PetscValidPointer(flg,3);
4620   ierr = PetscObjectQueryFunction((PetscObject)A,"MatIsTranspose_C",&f);CHKERRQ(ierr);
4621   ierr = PetscObjectQueryFunction((PetscObject)B,"MatIsTranspose_C",&g);CHKERRQ(ierr);
4622   *flg = PETSC_FALSE;
4623   if (f && g) {
4624     if (f == g) {
4625       ierr = (*f)(A,B,tol,flg);CHKERRQ(ierr);
4626     } else SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_NOTSAMETYPE,"Matrices do not have the same comparator for symmetry test");
4627   } else {
4628     MatType mattype;
4629     if (!f) {
4630       ierr = MatGetType(A,&mattype);CHKERRQ(ierr);
4631     } else {
4632       ierr = MatGetType(B,&mattype);CHKERRQ(ierr);
4633     }
4634     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Matrix of type <%s> does not support checking for transpose",mattype);
4635   }
4636   PetscFunctionReturn(0);
4637 }
4638 
4639 #undef __FUNCT__
4640 #define __FUNCT__ "MatHermitianTranspose"
4641 /*@
4642    MatHermitianTranspose - Computes an in-place or out-of-place transpose of a matrix in complex conjugate.
4643 
4644    Collective on Mat
4645 
4646    Input Parameter:
4647 +  mat - the matrix to transpose and complex conjugate
4648 -  reuse - store the transpose matrix in the provided B
4649 
4650    Output Parameters:
4651 .  B - the Hermitian
4652 
4653    Notes:
4654      If you  pass in &mat for B the Hermitian will be done in place
4655 
4656    Level: intermediate
4657 
4658    Concepts: matrices^transposing, complex conjugatex
4659 
4660 .seealso: MatTranspose(), MatMultTranspose(), MatMultTransposeAdd(), MatIsTranspose(), MatReuse
4661 @*/
4662 PetscErrorCode  MatHermitianTranspose(Mat mat,MatReuse reuse,Mat *B)
4663 {
4664   PetscErrorCode ierr;
4665 
4666   PetscFunctionBegin;
4667   ierr = MatTranspose(mat,reuse,B);CHKERRQ(ierr);
4668 #if defined(PETSC_USE_COMPLEX)
4669   ierr = MatConjugate(*B);CHKERRQ(ierr);
4670 #endif
4671   PetscFunctionReturn(0);
4672 }
4673 
4674 #undef __FUNCT__
4675 #define __FUNCT__ "MatIsHermitianTranspose"
4676 /*@
4677    MatIsHermitianTranspose - Test whether a matrix is another one's Hermitian transpose,
4678 
4679    Collective on Mat
4680 
4681    Input Parameter:
4682 +  A - the matrix to test
4683 -  B - the matrix to test against, this can equal the first parameter
4684 
4685    Output Parameters:
4686 .  flg - the result
4687 
4688    Notes:
4689    Only available for SeqAIJ/MPIAIJ matrices. The sequential algorithm
4690    has a running time of the order of the number of nonzeros; the parallel
4691    test involves parallel copies of the block-offdiagonal parts of the matrix.
4692 
4693    Level: intermediate
4694 
4695    Concepts: matrices^transposing, matrix^symmetry
4696 
4697 .seealso: MatTranspose(), MatIsSymmetric(), MatIsHermitian(), MatIsTranspose()
4698 @*/
4699 PetscErrorCode  MatIsHermitianTranspose(Mat A,Mat B,PetscReal tol,PetscBool  *flg)
4700 {
4701   PetscErrorCode ierr,(*f)(Mat,Mat,PetscReal,PetscBool*),(*g)(Mat,Mat,PetscReal,PetscBool*);
4702 
4703   PetscFunctionBegin;
4704   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
4705   PetscValidHeaderSpecific(B,MAT_CLASSID,2);
4706   PetscValidPointer(flg,3);
4707   ierr = PetscObjectQueryFunction((PetscObject)A,"MatIsHermitianTranspose_C",&f);CHKERRQ(ierr);
4708   ierr = PetscObjectQueryFunction((PetscObject)B,"MatIsHermitianTranspose_C",&g);CHKERRQ(ierr);
4709   if (f && g) {
4710     if (f==g) {
4711       ierr = (*f)(A,B,tol,flg);CHKERRQ(ierr);
4712     } else SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_NOTSAMETYPE,"Matrices do not have the same comparator for Hermitian test");
4713   }
4714   PetscFunctionReturn(0);
4715 }
4716 
4717 #undef __FUNCT__
4718 #define __FUNCT__ "MatPermute"
4719 /*@
4720    MatPermute - Creates a new matrix with rows and columns permuted from the
4721    original.
4722 
4723    Collective on Mat
4724 
4725    Input Parameters:
4726 +  mat - the matrix to permute
4727 .  row - row permutation, each processor supplies only the permutation for its rows
4728 -  col - column permutation, each processor supplies only the permutation for its columns
4729 
4730    Output Parameters:
4731 .  B - the permuted matrix
4732 
4733    Level: advanced
4734 
4735    Note:
4736    The index sets map from row/col of permuted matrix to row/col of original matrix.
4737    The index sets should be on the same communicator as Mat and have the same local sizes.
4738 
4739    Concepts: matrices^permuting
4740 
4741 .seealso: MatGetOrdering(), ISAllGather()
4742 
4743 @*/
4744 PetscErrorCode  MatPermute(Mat mat,IS row,IS col,Mat *B)
4745 {
4746   PetscErrorCode ierr;
4747 
4748   PetscFunctionBegin;
4749   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
4750   PetscValidType(mat,1);
4751   PetscValidHeaderSpecific(row,IS_CLASSID,2);
4752   PetscValidHeaderSpecific(col,IS_CLASSID,3);
4753   PetscValidPointer(B,4);
4754   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4755   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4756   if (!mat->ops->permute) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"MatPermute not available for Mat type %s",((PetscObject)mat)->type_name);
4757   MatCheckPreallocated(mat,1);
4758 
4759   ierr = (*mat->ops->permute)(mat,row,col,B);CHKERRQ(ierr);
4760   ierr = PetscObjectStateIncrease((PetscObject)*B);CHKERRQ(ierr);
4761   PetscFunctionReturn(0);
4762 }
4763 
4764 #undef __FUNCT__
4765 #define __FUNCT__ "MatEqual"
4766 /*@
4767    MatEqual - Compares two matrices.
4768 
4769    Collective on Mat
4770 
4771    Input Parameters:
4772 +  A - the first matrix
4773 -  B - the second matrix
4774 
4775    Output Parameter:
4776 .  flg - PETSC_TRUE if the matrices are equal; PETSC_FALSE otherwise.
4777 
4778    Level: intermediate
4779 
4780    Concepts: matrices^equality between
4781 @*/
4782 PetscErrorCode  MatEqual(Mat A,Mat B,PetscBool  *flg)
4783 {
4784   PetscErrorCode ierr;
4785 
4786   PetscFunctionBegin;
4787   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
4788   PetscValidHeaderSpecific(B,MAT_CLASSID,2);
4789   PetscValidType(A,1);
4790   PetscValidType(B,2);
4791   PetscValidIntPointer(flg,3);
4792   PetscCheckSameComm(A,1,B,2);
4793   MatCheckPreallocated(B,2);
4794   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4795   if (!B->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4796   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);
4797   if (!A->ops->equal) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Mat type %s",((PetscObject)A)->type_name);
4798   if (!B->ops->equal) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Mat type %s",((PetscObject)B)->type_name);
4799   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);
4800   MatCheckPreallocated(A,1);
4801 
4802   ierr = (*A->ops->equal)(A,B,flg);CHKERRQ(ierr);
4803   PetscFunctionReturn(0);
4804 }
4805 
4806 #undef __FUNCT__
4807 #define __FUNCT__ "MatDiagonalScale"
4808 /*@
4809    MatDiagonalScale - Scales a matrix on the left and right by diagonal
4810    matrices that are stored as vectors.  Either of the two scaling
4811    matrices can be NULL.
4812 
4813    Collective on Mat
4814 
4815    Input Parameters:
4816 +  mat - the matrix to be scaled
4817 .  l - the left scaling vector (or NULL)
4818 -  r - the right scaling vector (or NULL)
4819 
4820    Notes:
4821    MatDiagonalScale() computes A = LAR, where
4822    L = a diagonal matrix (stored as a vector), R = a diagonal matrix (stored as a vector)
4823    The L scales the rows of the matrix, the R scales the columns of the matrix.
4824 
4825    Level: intermediate
4826 
4827    Concepts: matrices^diagonal scaling
4828    Concepts: diagonal scaling of matrices
4829 
4830 .seealso: MatScale()
4831 @*/
4832 PetscErrorCode  MatDiagonalScale(Mat mat,Vec l,Vec r)
4833 {
4834   PetscErrorCode ierr;
4835 
4836   PetscFunctionBegin;
4837   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
4838   PetscValidType(mat,1);
4839   if (!mat->ops->diagonalscale) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4840   if (l) {PetscValidHeaderSpecific(l,VEC_CLASSID,2);PetscCheckSameComm(mat,1,l,2);}
4841   if (r) {PetscValidHeaderSpecific(r,VEC_CLASSID,3);PetscCheckSameComm(mat,1,r,3);}
4842   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4843   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4844   MatCheckPreallocated(mat,1);
4845 
4846   ierr = PetscLogEventBegin(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
4847   ierr = (*mat->ops->diagonalscale)(mat,l,r);CHKERRQ(ierr);
4848   ierr = PetscLogEventEnd(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
4849   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
4850 #if defined(PETSC_HAVE_CUSP)
4851   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
4852     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
4853   }
4854 #endif
4855 #if defined(PETSC_HAVE_VIENNACL)
4856   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
4857     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
4858   }
4859 #endif
4860   PetscFunctionReturn(0);
4861 }
4862 
4863 #undef __FUNCT__
4864 #define __FUNCT__ "MatScale"
4865 /*@
4866     MatScale - Scales all elements of a matrix by a given number.
4867 
4868     Logically Collective on Mat
4869 
4870     Input Parameters:
4871 +   mat - the matrix to be scaled
4872 -   a  - the scaling value
4873 
4874     Output Parameter:
4875 .   mat - the scaled matrix
4876 
4877     Level: intermediate
4878 
4879     Concepts: matrices^scaling all entries
4880 
4881 .seealso: MatDiagonalScale()
4882 @*/
4883 PetscErrorCode  MatScale(Mat mat,PetscScalar a)
4884 {
4885   PetscErrorCode ierr;
4886 
4887   PetscFunctionBegin;
4888   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
4889   PetscValidType(mat,1);
4890   if (a != (PetscScalar)1.0 && !mat->ops->scale) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4891   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4892   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4893   PetscValidLogicalCollectiveScalar(mat,a,2);
4894   MatCheckPreallocated(mat,1);
4895 
4896   ierr = PetscLogEventBegin(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
4897   if (a != (PetscScalar)1.0) {
4898     ierr = (*mat->ops->scale)(mat,a);CHKERRQ(ierr);
4899     ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
4900   }
4901   ierr = PetscLogEventEnd(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
4902 #if defined(PETSC_HAVE_CUSP)
4903   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
4904     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
4905   }
4906 #endif
4907 #if defined(PETSC_HAVE_VIENNACL)
4908   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
4909     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
4910   }
4911 #endif
4912   PetscFunctionReturn(0);
4913 }
4914 
4915 #undef __FUNCT__
4916 #define __FUNCT__ "MatNorm"
4917 /*@
4918    MatNorm - Calculates various norms of a matrix.
4919 
4920    Collective on Mat
4921 
4922    Input Parameters:
4923 +  mat - the matrix
4924 -  type - the type of norm, NORM_1, NORM_FROBENIUS, NORM_INFINITY
4925 
4926    Output Parameters:
4927 .  nrm - the resulting norm
4928 
4929    Level: intermediate
4930 
4931    Concepts: matrices^norm
4932    Concepts: norm^of matrix
4933 @*/
4934 PetscErrorCode  MatNorm(Mat mat,NormType type,PetscReal *nrm)
4935 {
4936   PetscErrorCode ierr;
4937 
4938   PetscFunctionBegin;
4939   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
4940   PetscValidType(mat,1);
4941   PetscValidScalarPointer(nrm,3);
4942 
4943   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4944   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4945   if (!mat->ops->norm) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4946   MatCheckPreallocated(mat,1);
4947 
4948   ierr = (*mat->ops->norm)(mat,type,nrm);CHKERRQ(ierr);
4949   PetscFunctionReturn(0);
4950 }
4951 
4952 /*
4953      This variable is used to prevent counting of MatAssemblyBegin() that
4954    are called from within a MatAssemblyEnd().
4955 */
4956 static PetscInt MatAssemblyEnd_InUse = 0;
4957 #undef __FUNCT__
4958 #define __FUNCT__ "MatAssemblyBegin"
4959 /*@
4960    MatAssemblyBegin - Begins assembling the matrix.  This routine should
4961    be called after completing all calls to MatSetValues().
4962 
4963    Collective on Mat
4964 
4965    Input Parameters:
4966 +  mat - the matrix
4967 -  type - type of assembly, either MAT_FLUSH_ASSEMBLY or MAT_FINAL_ASSEMBLY
4968 
4969    Notes:
4970    MatSetValues() generally caches the values.  The matrix is ready to
4971    use only after MatAssemblyBegin() and MatAssemblyEnd() have been called.
4972    Use MAT_FLUSH_ASSEMBLY when switching between ADD_VALUES and INSERT_VALUES
4973    in MatSetValues(); use MAT_FINAL_ASSEMBLY for the final assembly before
4974    using the matrix.
4975 
4976    ALL processes that share a matrix MUST call MatAssemblyBegin() and MatAssemblyEnd() the SAME NUMBER of times, and each time with the
4977    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
4978    a global collective operation requring all processes that share the matrix.
4979 
4980    Space for preallocated nonzeros that is not filled by a call to MatSetValues() or a related routine are compressed
4981    out by assembly. If you intend to use that extra space on a subsequent assembly, be sure to insert explicit zeros
4982    before MAT_FINAL_ASSEMBLY so the space is not compressed out.
4983 
4984    Level: beginner
4985 
4986    Concepts: matrices^assembling
4987 
4988 .seealso: MatAssemblyEnd(), MatSetValues(), MatAssembled()
4989 @*/
4990 PetscErrorCode  MatAssemblyBegin(Mat mat,MatAssemblyType type)
4991 {
4992   PetscErrorCode ierr;
4993 
4994   PetscFunctionBegin;
4995   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
4996   PetscValidType(mat,1);
4997   MatCheckPreallocated(mat,1);
4998   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix.\nDid you forget to call MatSetUnfactored()?");
4999   if (mat->assembled) {
5000     mat->was_assembled = PETSC_TRUE;
5001     mat->assembled     = PETSC_FALSE;
5002   }
5003   if (!MatAssemblyEnd_InUse) {
5004     ierr = PetscLogEventBegin(MAT_AssemblyBegin,mat,0,0,0);CHKERRQ(ierr);
5005     if (mat->ops->assemblybegin) {ierr = (*mat->ops->assemblybegin)(mat,type);CHKERRQ(ierr);}
5006     ierr = PetscLogEventEnd(MAT_AssemblyBegin,mat,0,0,0);CHKERRQ(ierr);
5007   } else if (mat->ops->assemblybegin) {
5008     ierr = (*mat->ops->assemblybegin)(mat,type);CHKERRQ(ierr);
5009   }
5010   PetscFunctionReturn(0);
5011 }
5012 
5013 #undef __FUNCT__
5014 #define __FUNCT__ "MatAssembled"
5015 /*@
5016    MatAssembled - Indicates if a matrix has been assembled and is ready for
5017      use; for example, in matrix-vector product.
5018 
5019    Not Collective
5020 
5021    Input Parameter:
5022 .  mat - the matrix
5023 
5024    Output Parameter:
5025 .  assembled - PETSC_TRUE or PETSC_FALSE
5026 
5027    Level: advanced
5028 
5029    Concepts: matrices^assembled?
5030 
5031 .seealso: MatAssemblyEnd(), MatSetValues(), MatAssemblyBegin()
5032 @*/
5033 PetscErrorCode  MatAssembled(Mat mat,PetscBool  *assembled)
5034 {
5035   PetscFunctionBegin;
5036   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
5037   PetscValidType(mat,1);
5038   PetscValidPointer(assembled,2);
5039   *assembled = mat->assembled;
5040   PetscFunctionReturn(0);
5041 }
5042 
5043 #undef __FUNCT__
5044 #define __FUNCT__ "MatAssemblyEnd"
5045 /*@
5046    MatAssemblyEnd - Completes assembling the matrix.  This routine should
5047    be called after MatAssemblyBegin().
5048 
5049    Collective on Mat
5050 
5051    Input Parameters:
5052 +  mat - the matrix
5053 -  type - type of assembly, either MAT_FLUSH_ASSEMBLY or MAT_FINAL_ASSEMBLY
5054 
5055    Options Database Keys:
5056 +  -mat_view ::ascii_info - Prints info on matrix at conclusion of MatEndAssembly()
5057 .  -mat_view ::ascii_info_detail - Prints more detailed info
5058 .  -mat_view - Prints matrix in ASCII format
5059 .  -mat_view ::ascii_matlab - Prints matrix in Matlab format
5060 .  -mat_view draw - PetscDraws nonzero structure of matrix, using MatView() and PetscDrawOpenX().
5061 .  -display <name> - Sets display name (default is host)
5062 .  -draw_pause <sec> - Sets number of seconds to pause after display
5063 .  -mat_view socket - Sends matrix to socket, can be accessed from Matlab (See Users-Manual: ch_matlab )
5064 .  -viewer_socket_machine <machine> - Machine to use for socket
5065 .  -viewer_socket_port <port> - Port number to use for socket
5066 -  -mat_view binary:filename[:append] - Save matrix to file in binary format
5067 
5068    Notes:
5069    MatSetValues() generally caches the values.  The matrix is ready to
5070    use only after MatAssemblyBegin() and MatAssemblyEnd() have been called.
5071    Use MAT_FLUSH_ASSEMBLY when switching between ADD_VALUES and INSERT_VALUES
5072    in MatSetValues(); use MAT_FINAL_ASSEMBLY for the final assembly before
5073    using the matrix.
5074 
5075    Space for preallocated nonzeros that is not filled by a call to MatSetValues() or a related routine are compressed
5076    out by assembly. If you intend to use that extra space on a subsequent assembly, be sure to insert explicit zeros
5077    before MAT_FINAL_ASSEMBLY so the space is not compressed out.
5078 
5079    Level: beginner
5080 
5081 .seealso: MatAssemblyBegin(), MatSetValues(), PetscDrawOpenX(), PetscDrawCreate(), MatView(), MatAssembled(), PetscViewerSocketOpen()
5082 @*/
5083 PetscErrorCode  MatAssemblyEnd(Mat mat,MatAssemblyType type)
5084 {
5085   PetscErrorCode  ierr;
5086   static PetscInt inassm = 0;
5087   PetscBool       flg    = PETSC_FALSE;
5088 
5089   PetscFunctionBegin;
5090   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
5091   PetscValidType(mat,1);
5092 
5093   inassm++;
5094   MatAssemblyEnd_InUse++;
5095   if (MatAssemblyEnd_InUse == 1) { /* Do the logging only the first time through */
5096     ierr = PetscLogEventBegin(MAT_AssemblyEnd,mat,0,0,0);CHKERRQ(ierr);
5097     if (mat->ops->assemblyend) {
5098       ierr = (*mat->ops->assemblyend)(mat,type);CHKERRQ(ierr);
5099     }
5100     ierr = PetscLogEventEnd(MAT_AssemblyEnd,mat,0,0,0);CHKERRQ(ierr);
5101   } else if (mat->ops->assemblyend) {
5102     ierr = (*mat->ops->assemblyend)(mat,type);CHKERRQ(ierr);
5103   }
5104 
5105   /* Flush assembly is not a true assembly */
5106   if (type != MAT_FLUSH_ASSEMBLY) {
5107     mat->assembled = PETSC_TRUE; mat->num_ass++;
5108   }
5109   mat->insertmode = NOT_SET_VALUES;
5110   MatAssemblyEnd_InUse--;
5111   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
5112   if (!mat->symmetric_eternal) {
5113     mat->symmetric_set              = PETSC_FALSE;
5114     mat->hermitian_set              = PETSC_FALSE;
5115     mat->structurally_symmetric_set = PETSC_FALSE;
5116   }
5117 #if defined(PETSC_HAVE_CUSP)
5118   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
5119     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
5120   }
5121 #endif
5122 #if defined(PETSC_HAVE_VIENNACL)
5123   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
5124     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
5125   }
5126 #endif
5127   if (inassm == 1 && type != MAT_FLUSH_ASSEMBLY) {
5128     ierr = MatViewFromOptions(mat,NULL,"-mat_view");CHKERRQ(ierr);
5129 
5130     if (mat->checksymmetryonassembly) {
5131       ierr = MatIsSymmetric(mat,mat->checksymmetrytol,&flg);CHKERRQ(ierr);
5132       if (flg) {
5133         ierr = PetscPrintf(PetscObjectComm((PetscObject)mat),"Matrix is symmetric (tolerance %g)\n",(double)mat->checksymmetrytol);CHKERRQ(ierr);
5134       } else {
5135         ierr = PetscPrintf(PetscObjectComm((PetscObject)mat),"Matrix is not symmetric (tolerance %g)\n",(double)mat->checksymmetrytol);CHKERRQ(ierr);
5136       }
5137     }
5138     if (mat->nullsp && mat->checknullspaceonassembly) {
5139       ierr = MatNullSpaceTest(mat->nullsp,mat,NULL);CHKERRQ(ierr);
5140     }
5141   }
5142   inassm--;
5143   PetscFunctionReturn(0);
5144 }
5145 
5146 #undef __FUNCT__
5147 #define __FUNCT__ "MatSetOption"
5148 /*@
5149    MatSetOption - Sets a parameter option for a matrix. Some options
5150    may be specific to certain storage formats.  Some options
5151    determine how values will be inserted (or added). Sorted,
5152    row-oriented input will generally assemble the fastest. The default
5153    is row-oriented.
5154 
5155    Logically Collective on Mat for certain operations, such as MAT_SPD, not collective for MAT_ROW_ORIENTED, see MatOption
5156 
5157    Input Parameters:
5158 +  mat - the matrix
5159 .  option - the option, one of those listed below (and possibly others),
5160 -  flg - turn the option on (PETSC_TRUE) or off (PETSC_FALSE)
5161 
5162   Options Describing Matrix Structure:
5163 +    MAT_SPD - symmetric positive definite
5164 .    MAT_SYMMETRIC - symmetric in terms of both structure and value
5165 .    MAT_HERMITIAN - transpose is the complex conjugation
5166 .    MAT_STRUCTURALLY_SYMMETRIC - symmetric nonzero structure
5167 -    MAT_SYMMETRY_ETERNAL - if you would like the symmetry/Hermitian flag
5168                             you set to be kept with all future use of the matrix
5169                             including after MatAssemblyBegin/End() which could
5170                             potentially change the symmetry structure, i.e. you
5171                             KNOW the matrix will ALWAYS have the property you set.
5172 
5173 
5174    Options For Use with MatSetValues():
5175    Insert a logically dense subblock, which can be
5176 .    MAT_ROW_ORIENTED - row-oriented (default)
5177 
5178    Note these options reflect the data you pass in with MatSetValues(); it has
5179    nothing to do with how the data is stored internally in the matrix
5180    data structure.
5181 
5182    When (re)assembling a matrix, we can restrict the input for
5183    efficiency/debugging purposes.  These options include:
5184 +    MAT_NEW_NONZERO_LOCATIONS - additional insertions will be allowed if they generate a new nonzero (slow)
5185 .    MAT_NEW_DIAGONALS - new diagonals will be allowed (for block diagonal format only)
5186 .    MAT_IGNORE_OFF_PROC_ENTRIES - drops off-processor entries
5187 .    MAT_NEW_NONZERO_LOCATION_ERR - generates an error for new matrix entry
5188 .    MAT_USE_HASH_TABLE - uses a hash table to speed up matrix assembly
5189 .    MAT_NO_OFF_PROC_ENTRIES - you know each process will only set values for its own rows, will generate an error if
5190         any process sets values for another process. This avoids all reductions in the MatAssembly routines and thus improves
5191         performance for very large process counts.
5192 -    MAT_SUBSET_OFF_PROC_ENTRIES - you know that the first assembly after setting this flag will set a superset
5193         of the off-process entries required for all subsequent assemblies. This avoids a rendezvous step in the MatAssembly
5194         functions, instead sending only neighbor messages.
5195 
5196    Notes:
5197    Except for MAT_UNUSED_NONZERO_LOCATION_ERR and  MAT_ROW_ORIENTED all processes that share the matrix must pass the same value in flg!
5198 
5199    Some options are relevant only for particular matrix types and
5200    are thus ignored by others.  Other options are not supported by
5201    certain matrix types and will generate an error message if set.
5202 
5203    If using a Fortran 77 module to compute a matrix, one may need to
5204    use the column-oriented option (or convert to the row-oriented
5205    format).
5206 
5207    MAT_NEW_NONZERO_LOCATIONS set to PETSC_FALSE indicates that any add or insertion
5208    that would generate a new entry in the nonzero structure is instead
5209    ignored.  Thus, if memory has not alredy been allocated for this particular
5210    data, then the insertion is ignored. For dense matrices, in which
5211    the entire array is allocated, no entries are ever ignored.
5212    Set after the first MatAssemblyEnd(). If this option is set then the MatAssemblyBegin/End() processes has one less global reduction
5213 
5214    MAT_NEW_NONZERO_LOCATION_ERR set to PETSC_TRUE indicates that any add or insertion
5215    that would generate a new entry in the nonzero structure instead produces
5216    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
5217 
5218    MAT_NEW_NONZERO_ALLOCATION_ERR set to PETSC_TRUE indicates that any add or insertion
5219    that would generate a new entry that has not been preallocated will
5220    instead produce an error. (Currently supported for AIJ and BAIJ formats
5221    only.) This is a useful flag when debugging matrix memory preallocation.
5222    If this option is set then the MatAssemblyBegin/End() processes has one less global reduction
5223 
5224    MAT_IGNORE_OFF_PROC_ENTRIES set to PETSC_TRUE indicates entries destined for
5225    other processors should be dropped, rather than stashed.
5226    This is useful if you know that the "owning" processor is also
5227    always generating the correct matrix entries, so that PETSc need
5228    not transfer duplicate entries generated on another processor.
5229 
5230    MAT_USE_HASH_TABLE indicates that a hash table be used to improve the
5231    searches during matrix assembly. When this flag is set, the hash table
5232    is created during the first Matrix Assembly. This hash table is
5233    used the next time through, during MatSetVaules()/MatSetVaulesBlocked()
5234    to improve the searching of indices. MAT_NEW_NONZERO_LOCATIONS flag
5235    should be used with MAT_USE_HASH_TABLE flag. This option is currently
5236    supported by MATMPIBAIJ format only.
5237 
5238    MAT_KEEP_NONZERO_PATTERN indicates when MatZeroRows() is called the zeroed entries
5239    are kept in the nonzero structure
5240 
5241    MAT_IGNORE_ZERO_ENTRIES - for AIJ/IS matrices this will stop zero values from creating
5242    a zero location in the matrix
5243 
5244    MAT_USE_INODES - indicates using inode version of the code - works with AIJ matrix types
5245 
5246    MAT_NO_OFF_PROC_ZERO_ROWS - you know each process will only zero its own rows. This avoids all reductions in the
5247         zero row routines and thus improves performance for very large process counts.
5248 
5249    MAT_IGNORE_LOWER_TRIANGULAR - For SBAIJ matrices will ignore any insertions you make in the lower triangular
5250         part of the matrix (since they should match the upper triangular part).
5251 
5252    Notes: Can only be called after MatSetSizes() and MatSetType() have been set.
5253 
5254    Level: intermediate
5255 
5256    Concepts: matrices^setting options
5257 
5258 .seealso:  MatOption, Mat
5259 
5260 @*/
5261 PetscErrorCode  MatSetOption(Mat mat,MatOption op,PetscBool flg)
5262 {
5263   PetscErrorCode ierr;
5264 
5265   PetscFunctionBegin;
5266   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
5267   PetscValidType(mat,1);
5268   if (op > 0) {
5269     PetscValidLogicalCollectiveEnum(mat,op,2);
5270     PetscValidLogicalCollectiveBool(mat,flg,3);
5271   }
5272 
5273   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);
5274   if (!((PetscObject)mat)->type_name) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_TYPENOTSET,"Cannot set options until type and size have been set, see MatSetType() and MatSetSizes()");
5275 
5276   switch (op) {
5277   case MAT_NO_OFF_PROC_ENTRIES:
5278     mat->nooffprocentries = flg;
5279     PetscFunctionReturn(0);
5280     break;
5281   case MAT_SUBSET_OFF_PROC_ENTRIES:
5282     mat->subsetoffprocentries = flg;
5283     PetscFunctionReturn(0);
5284   case MAT_NO_OFF_PROC_ZERO_ROWS:
5285     mat->nooffproczerorows = flg;
5286     PetscFunctionReturn(0);
5287     break;
5288   case MAT_SPD:
5289     mat->spd_set = PETSC_TRUE;
5290     mat->spd     = flg;
5291     if (flg) {
5292       mat->symmetric                  = PETSC_TRUE;
5293       mat->structurally_symmetric     = PETSC_TRUE;
5294       mat->symmetric_set              = PETSC_TRUE;
5295       mat->structurally_symmetric_set = PETSC_TRUE;
5296     }
5297     break;
5298   case MAT_SYMMETRIC:
5299     mat->symmetric = flg;
5300     if (flg) mat->structurally_symmetric = PETSC_TRUE;
5301     mat->symmetric_set              = PETSC_TRUE;
5302     mat->structurally_symmetric_set = flg;
5303     break;
5304   case MAT_HERMITIAN:
5305     mat->hermitian = flg;
5306     if (flg) mat->structurally_symmetric = PETSC_TRUE;
5307     mat->hermitian_set              = PETSC_TRUE;
5308     mat->structurally_symmetric_set = flg;
5309     break;
5310   case MAT_STRUCTURALLY_SYMMETRIC:
5311     mat->structurally_symmetric     = flg;
5312     mat->structurally_symmetric_set = PETSC_TRUE;
5313     break;
5314   case MAT_SYMMETRY_ETERNAL:
5315     mat->symmetric_eternal = flg;
5316     break;
5317   default:
5318     break;
5319   }
5320   if (mat->ops->setoption) {
5321     ierr = (*mat->ops->setoption)(mat,op,flg);CHKERRQ(ierr);
5322   }
5323   PetscFunctionReturn(0);
5324 }
5325 
5326 #undef __FUNCT__
5327 #define __FUNCT__ "MatGetOption"
5328 /*@
5329    MatGetOption - Gets a parameter option that has been set for a matrix.
5330 
5331    Logically Collective on Mat for certain operations, such as MAT_SPD, not collective for MAT_ROW_ORIENTED, see MatOption
5332 
5333    Input Parameters:
5334 +  mat - the matrix
5335 -  option - the option, this only responds to certain options, check the code for which ones
5336 
5337    Output Parameter:
5338 .  flg - turn the option on (PETSC_TRUE) or off (PETSC_FALSE)
5339 
5340     Notes: Can only be called after MatSetSizes() and MatSetType() have been set.
5341 
5342    Level: intermediate
5343 
5344    Concepts: matrices^setting options
5345 
5346 .seealso:  MatOption, MatSetOption()
5347 
5348 @*/
5349 PetscErrorCode  MatGetOption(Mat mat,MatOption op,PetscBool *flg)
5350 {
5351   PetscFunctionBegin;
5352   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
5353   PetscValidType(mat,1);
5354 
5355   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);
5356   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()");
5357 
5358   switch (op) {
5359   case MAT_NO_OFF_PROC_ENTRIES:
5360     *flg = mat->nooffprocentries;
5361     break;
5362   case MAT_NO_OFF_PROC_ZERO_ROWS:
5363     *flg = mat->nooffproczerorows;
5364     break;
5365   case MAT_SYMMETRIC:
5366     *flg = mat->symmetric;
5367     break;
5368   case MAT_HERMITIAN:
5369     *flg = mat->hermitian;
5370     break;
5371   case MAT_STRUCTURALLY_SYMMETRIC:
5372     *flg = mat->structurally_symmetric;
5373     break;
5374   case MAT_SYMMETRY_ETERNAL:
5375     *flg = mat->symmetric_eternal;
5376     break;
5377   default:
5378     break;
5379   }
5380   PetscFunctionReturn(0);
5381 }
5382 
5383 #undef __FUNCT__
5384 #define __FUNCT__ "MatZeroEntries"
5385 /*@
5386    MatZeroEntries - Zeros all entries of a matrix.  For sparse matrices
5387    this routine retains the old nonzero structure.
5388 
5389    Logically Collective on Mat
5390 
5391    Input Parameters:
5392 .  mat - the matrix
5393 
5394    Level: intermediate
5395 
5396    Notes: 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.
5397    See the Performance chapter of the users manual for information on preallocating matrices.
5398 
5399    Concepts: matrices^zeroing
5400 
5401 .seealso: MatZeroRows()
5402 @*/
5403 PetscErrorCode  MatZeroEntries(Mat mat)
5404 {
5405   PetscErrorCode ierr;
5406 
5407   PetscFunctionBegin;
5408   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
5409   PetscValidType(mat,1);
5410   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5411   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");
5412   if (!mat->ops->zeroentries) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5413   MatCheckPreallocated(mat,1);
5414 
5415   ierr = PetscLogEventBegin(MAT_ZeroEntries,mat,0,0,0);CHKERRQ(ierr);
5416   ierr = (*mat->ops->zeroentries)(mat);CHKERRQ(ierr);
5417   ierr = PetscLogEventEnd(MAT_ZeroEntries,mat,0,0,0);CHKERRQ(ierr);
5418   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
5419 #if defined(PETSC_HAVE_CUSP)
5420   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
5421     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
5422   }
5423 #endif
5424 #if defined(PETSC_HAVE_VIENNACL)
5425   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
5426     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
5427   }
5428 #endif
5429   PetscFunctionReturn(0);
5430 }
5431 
5432 #undef __FUNCT__
5433 #define __FUNCT__ "MatZeroRowsColumns"
5434 /*@C
5435    MatZeroRowsColumns - Zeros all entries (except possibly the main diagonal)
5436    of a set of rows and columns of a matrix.
5437 
5438    Collective on Mat
5439 
5440    Input Parameters:
5441 +  mat - the matrix
5442 .  numRows - the number of rows to remove
5443 .  rows - the global row indices
5444 .  diag - value put in all diagonals of eliminated rows (0.0 will even eliminate diagonal entry)
5445 .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
5446 -  b - optional vector of right hand side, that will be adjusted by provided solution
5447 
5448    Notes:
5449    This does not change the nonzero structure of the matrix, it merely zeros those entries in the matrix.
5450 
5451    The user can set a value in the diagonal entry (or for the AIJ and
5452    row formats can optionally remove the main diagonal entry from the
5453    nonzero structure as well, by passing 0.0 as the final argument).
5454 
5455    For the parallel case, all processes that share the matrix (i.e.,
5456    those in the communicator used for matrix creation) MUST call this
5457    routine, regardless of whether any rows being zeroed are owned by
5458    them.
5459 
5460    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
5461    list only rows local to itself).
5462 
5463    The option MAT_NO_OFF_PROC_ZERO_ROWS does not apply to this routine.
5464 
5465    Level: intermediate
5466 
5467    Concepts: matrices^zeroing rows
5468 
5469 .seealso: MatZeroRowsIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(), MatZeroRowsColumnsIS()
5470 @*/
5471 PetscErrorCode  MatZeroRowsColumns(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag,Vec x,Vec b)
5472 {
5473   PetscErrorCode ierr;
5474 
5475   PetscFunctionBegin;
5476   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
5477   PetscValidType(mat,1);
5478   if (numRows) PetscValidIntPointer(rows,3);
5479   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5480   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5481   if (!mat->ops->zerorowscolumns) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5482   MatCheckPreallocated(mat,1);
5483 
5484   ierr = (*mat->ops->zerorowscolumns)(mat,numRows,rows,diag,x,b);CHKERRQ(ierr);
5485   ierr = MatViewFromOptions(mat,NULL,"-mat_view");CHKERRQ(ierr);
5486   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
5487 #if defined(PETSC_HAVE_CUSP)
5488   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
5489     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
5490   }
5491 #endif
5492 #if defined(PETSC_HAVE_VIENNACL)
5493   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
5494     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
5495   }
5496 #endif
5497   PetscFunctionReturn(0);
5498 }
5499 
5500 #undef __FUNCT__
5501 #define __FUNCT__ "MatZeroRowsColumnsIS"
5502 /*@C
5503    MatZeroRowsColumnsIS - Zeros all entries (except possibly the main diagonal)
5504    of a set of rows and columns of a matrix.
5505 
5506    Collective on Mat
5507 
5508    Input Parameters:
5509 +  mat - the matrix
5510 .  is - the rows to zero
5511 .  diag - value put in all diagonals of eliminated rows (0.0 will even eliminate diagonal entry)
5512 .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
5513 -  b - optional vector of right hand side, that will be adjusted by provided solution
5514 
5515    Notes:
5516    This does not change the nonzero structure of the matrix, it merely zeros those entries in the matrix.
5517 
5518    The user can set a value in the diagonal entry (or for the AIJ and
5519    row formats can optionally remove the main diagonal entry from the
5520    nonzero structure as well, by passing 0.0 as the final argument).
5521 
5522    For the parallel case, all processes that share the matrix (i.e.,
5523    those in the communicator used for matrix creation) MUST call this
5524    routine, regardless of whether any rows being zeroed are owned by
5525    them.
5526 
5527    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
5528    list only rows local to itself).
5529 
5530    The option MAT_NO_OFF_PROC_ZERO_ROWS does not apply to this routine.
5531 
5532    Level: intermediate
5533 
5534    Concepts: matrices^zeroing rows
5535 
5536 .seealso: MatZeroRowsIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption(), MatZeroRowsColumns()
5537 @*/
5538 PetscErrorCode  MatZeroRowsColumnsIS(Mat mat,IS is,PetscScalar diag,Vec x,Vec b)
5539 {
5540   PetscErrorCode ierr;
5541   PetscInt       numRows;
5542   const PetscInt *rows;
5543 
5544   PetscFunctionBegin;
5545   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
5546   PetscValidHeaderSpecific(is,IS_CLASSID,2);
5547   PetscValidType(mat,1);
5548   PetscValidType(is,2);
5549   ierr = ISGetLocalSize(is,&numRows);CHKERRQ(ierr);
5550   ierr = ISGetIndices(is,&rows);CHKERRQ(ierr);
5551   ierr = MatZeroRowsColumns(mat,numRows,rows,diag,x,b);CHKERRQ(ierr);
5552   ierr = ISRestoreIndices(is,&rows);CHKERRQ(ierr);
5553   PetscFunctionReturn(0);
5554 }
5555 
5556 #undef __FUNCT__
5557 #define __FUNCT__ "MatZeroRows"
5558 /*@C
5559    MatZeroRows - Zeros all entries (except possibly the main diagonal)
5560    of a set of rows of a matrix.
5561 
5562    Collective on Mat
5563 
5564    Input Parameters:
5565 +  mat - the matrix
5566 .  numRows - the number of rows to remove
5567 .  rows - the global row indices
5568 .  diag - value put in all diagonals of eliminated rows (0.0 will even eliminate diagonal entry)
5569 .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
5570 -  b - optional vector of right hand side, that will be adjusted by provided solution
5571 
5572    Notes:
5573    For the AIJ and BAIJ matrix formats this removes the old nonzero structure,
5574    but does not release memory.  For the dense and block diagonal
5575    formats this does not alter the nonzero structure.
5576 
5577    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
5578    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
5579    merely zeroed.
5580 
5581    The user can set a value in the diagonal entry (or for the AIJ and
5582    row formats can optionally remove the main diagonal entry from the
5583    nonzero structure as well, by passing 0.0 as the final argument).
5584 
5585    For the parallel case, all processes that share the matrix (i.e.,
5586    those in the communicator used for matrix creation) MUST call this
5587    routine, regardless of whether any rows being zeroed are owned by
5588    them.
5589 
5590    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
5591    list only rows local to itself).
5592 
5593    You can call MatSetOption(mat,MAT_NO_OFF_PROC_ZERO_ROWS,PETSC_TRUE) if each process indicates only rows it
5594    owns that are to be zeroed. This saves a global synchronization in the implementation.
5595 
5596    Level: intermediate
5597 
5598    Concepts: matrices^zeroing rows
5599 
5600 .seealso: MatZeroRowsIS(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption()
5601 @*/
5602 PetscErrorCode  MatZeroRows(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag,Vec x,Vec b)
5603 {
5604   PetscErrorCode ierr;
5605 
5606   PetscFunctionBegin;
5607   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
5608   PetscValidType(mat,1);
5609   if (numRows) PetscValidIntPointer(rows,3);
5610   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5611   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5612   if (!mat->ops->zerorows) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5613   MatCheckPreallocated(mat,1);
5614 
5615   ierr = (*mat->ops->zerorows)(mat,numRows,rows,diag,x,b);CHKERRQ(ierr);
5616   ierr = MatViewFromOptions(mat,NULL,"-mat_view");CHKERRQ(ierr);
5617   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
5618 #if defined(PETSC_HAVE_CUSP)
5619   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
5620     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
5621   }
5622 #endif
5623 #if defined(PETSC_HAVE_VIENNACL)
5624   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
5625     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
5626   }
5627 #endif
5628   PetscFunctionReturn(0);
5629 }
5630 
5631 #undef __FUNCT__
5632 #define __FUNCT__ "MatZeroRowsIS"
5633 /*@C
5634    MatZeroRowsIS - Zeros all entries (except possibly the main diagonal)
5635    of a set of rows of a matrix.
5636 
5637    Collective on Mat
5638 
5639    Input Parameters:
5640 +  mat - the matrix
5641 .  is - index set of rows to remove
5642 .  diag - value put in all diagonals of eliminated rows
5643 .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
5644 -  b - optional vector of right hand side, that will be adjusted by provided solution
5645 
5646    Notes:
5647    For the AIJ and BAIJ matrix formats this removes the old nonzero structure,
5648    but does not release memory.  For the dense and block diagonal
5649    formats this does not alter the nonzero structure.
5650 
5651    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
5652    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
5653    merely zeroed.
5654 
5655    The user can set a value in the diagonal entry (or for the AIJ and
5656    row formats can optionally remove the main diagonal entry from the
5657    nonzero structure as well, by passing 0.0 as the final argument).
5658 
5659    For the parallel case, all processes that share the matrix (i.e.,
5660    those in the communicator used for matrix creation) MUST call this
5661    routine, regardless of whether any rows being zeroed are owned by
5662    them.
5663 
5664    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
5665    list only rows local to itself).
5666 
5667    You can call MatSetOption(mat,MAT_NO_OFF_PROC_ZERO_ROWS,PETSC_TRUE) if each process indicates only rows it
5668    owns that are to be zeroed. This saves a global synchronization in the implementation.
5669 
5670    Level: intermediate
5671 
5672    Concepts: matrices^zeroing rows
5673 
5674 .seealso: MatZeroRows(), MatZeroRowsStencil(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption()
5675 @*/
5676 PetscErrorCode  MatZeroRowsIS(Mat mat,IS is,PetscScalar diag,Vec x,Vec b)
5677 {
5678   PetscInt       numRows;
5679   const PetscInt *rows;
5680   PetscErrorCode ierr;
5681 
5682   PetscFunctionBegin;
5683   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
5684   PetscValidType(mat,1);
5685   PetscValidHeaderSpecific(is,IS_CLASSID,2);
5686   ierr = ISGetLocalSize(is,&numRows);CHKERRQ(ierr);
5687   ierr = ISGetIndices(is,&rows);CHKERRQ(ierr);
5688   ierr = MatZeroRows(mat,numRows,rows,diag,x,b);CHKERRQ(ierr);
5689   ierr = ISRestoreIndices(is,&rows);CHKERRQ(ierr);
5690   PetscFunctionReturn(0);
5691 }
5692 
5693 #undef __FUNCT__
5694 #define __FUNCT__ "MatZeroRowsStencil"
5695 /*@C
5696    MatZeroRowsStencil - Zeros all entries (except possibly the main diagonal)
5697    of a set of rows of a matrix. These rows must be local to the process.
5698 
5699    Collective on Mat
5700 
5701    Input Parameters:
5702 +  mat - the matrix
5703 .  numRows - the number of rows to remove
5704 .  rows - the grid coordinates (and component number when dof > 1) for matrix rows
5705 .  diag - value put in all diagonals of eliminated rows (0.0 will even eliminate diagonal entry)
5706 .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
5707 -  b - optional vector of right hand side, that will be adjusted by provided solution
5708 
5709    Notes:
5710    For the AIJ and BAIJ matrix formats this removes the old nonzero structure,
5711    but does not release memory.  For the dense and block diagonal
5712    formats this does not alter the nonzero structure.
5713 
5714    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
5715    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
5716    merely zeroed.
5717 
5718    The user can set a value in the diagonal entry (or for the AIJ and
5719    row formats can optionally remove the main diagonal entry from the
5720    nonzero structure as well, by passing 0.0 as the final argument).
5721 
5722    For the parallel case, all processes that share the matrix (i.e.,
5723    those in the communicator used for matrix creation) MUST call this
5724    routine, regardless of whether any rows being zeroed are owned by
5725    them.
5726 
5727    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
5728    list only rows local to itself).
5729 
5730    The grid coordinates are across the entire grid, not just the local portion
5731 
5732    In Fortran idxm and idxn should be declared as
5733 $     MatStencil idxm(4,m)
5734    and the values inserted using
5735 $    idxm(MatStencil_i,1) = i
5736 $    idxm(MatStencil_j,1) = j
5737 $    idxm(MatStencil_k,1) = k
5738 $    idxm(MatStencil_c,1) = c
5739    etc
5740 
5741    For periodic boundary conditions use negative indices for values to the left (below 0; that are to be
5742    obtained by wrapping values from right edge). For values to the right of the last entry using that index plus one
5743    etc to obtain values that obtained by wrapping the values from the left edge. This does not work for anything but the
5744    DM_BOUNDARY_PERIODIC boundary type.
5745 
5746    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
5747    a single value per point) you can skip filling those indices.
5748 
5749    Level: intermediate
5750 
5751    Concepts: matrices^zeroing rows
5752 
5753 .seealso: MatZeroRows(), MatZeroRowsIS(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption()
5754 @*/
5755 PetscErrorCode  MatZeroRowsStencil(Mat mat,PetscInt numRows,const MatStencil rows[],PetscScalar diag,Vec x,Vec b)
5756 {
5757   PetscInt       dim     = mat->stencil.dim;
5758   PetscInt       sdim    = dim - (1 - (PetscInt) mat->stencil.noc);
5759   PetscInt       *dims   = mat->stencil.dims+1;
5760   PetscInt       *starts = mat->stencil.starts;
5761   PetscInt       *dxm    = (PetscInt*) rows;
5762   PetscInt       *jdxm, i, j, tmp, numNewRows = 0;
5763   PetscErrorCode ierr;
5764 
5765   PetscFunctionBegin;
5766   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
5767   PetscValidType(mat,1);
5768   if (numRows) PetscValidIntPointer(rows,3);
5769 
5770   ierr = PetscMalloc1(numRows, &jdxm);CHKERRQ(ierr);
5771   for (i = 0; i < numRows; ++i) {
5772     /* Skip unused dimensions (they are ordered k, j, i, c) */
5773     for (j = 0; j < 3-sdim; ++j) dxm++;
5774     /* Local index in X dir */
5775     tmp = *dxm++ - starts[0];
5776     /* Loop over remaining dimensions */
5777     for (j = 0; j < dim-1; ++j) {
5778       /* If nonlocal, set index to be negative */
5779       if ((*dxm++ - starts[j+1]) < 0 || tmp < 0) tmp = PETSC_MIN_INT;
5780       /* Update local index */
5781       else tmp = tmp*dims[j] + *(dxm-1) - starts[j+1];
5782     }
5783     /* Skip component slot if necessary */
5784     if (mat->stencil.noc) dxm++;
5785     /* Local row number */
5786     if (tmp >= 0) {
5787       jdxm[numNewRows++] = tmp;
5788     }
5789   }
5790   ierr = MatZeroRowsLocal(mat,numNewRows,jdxm,diag,x,b);CHKERRQ(ierr);
5791   ierr = PetscFree(jdxm);CHKERRQ(ierr);
5792   PetscFunctionReturn(0);
5793 }
5794 
5795 #undef __FUNCT__
5796 #define __FUNCT__ "MatZeroRowsColumnsStencil"
5797 /*@C
5798    MatZeroRowsColumnsStencil - Zeros all row and column entries (except possibly the main diagonal)
5799    of a set of rows and columns of a matrix.
5800 
5801    Collective on Mat
5802 
5803    Input Parameters:
5804 +  mat - the matrix
5805 .  numRows - the number of rows/columns to remove
5806 .  rows - the grid coordinates (and component number when dof > 1) for matrix rows
5807 .  diag - value put in all diagonals of eliminated rows (0.0 will even eliminate diagonal entry)
5808 .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
5809 -  b - optional vector of right hand side, that will be adjusted by provided solution
5810 
5811    Notes:
5812    For the AIJ and BAIJ matrix formats this removes the old nonzero structure,
5813    but does not release memory.  For the dense and block diagonal
5814    formats this does not alter the nonzero structure.
5815 
5816    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
5817    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
5818    merely zeroed.
5819 
5820    The user can set a value in the diagonal entry (or for the AIJ and
5821    row formats can optionally remove the main diagonal entry from the
5822    nonzero structure as well, by passing 0.0 as the final argument).
5823 
5824    For the parallel case, all processes that share the matrix (i.e.,
5825    those in the communicator used for matrix creation) MUST call this
5826    routine, regardless of whether any rows being zeroed are owned by
5827    them.
5828 
5829    Each processor can indicate any rows in the entire matrix to be zeroed (i.e. each process does NOT have to
5830    list only rows local to itself, but the row/column numbers are given in local numbering).
5831 
5832    The grid coordinates are across the entire grid, not just the local portion
5833 
5834    In Fortran idxm and idxn should be declared as
5835 $     MatStencil idxm(4,m)
5836    and the values inserted using
5837 $    idxm(MatStencil_i,1) = i
5838 $    idxm(MatStencil_j,1) = j
5839 $    idxm(MatStencil_k,1) = k
5840 $    idxm(MatStencil_c,1) = c
5841    etc
5842 
5843    For periodic boundary conditions use negative indices for values to the left (below 0; that are to be
5844    obtained by wrapping values from right edge). For values to the right of the last entry using that index plus one
5845    etc to obtain values that obtained by wrapping the values from the left edge. This does not work for anything but the
5846    DM_BOUNDARY_PERIODIC boundary type.
5847 
5848    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
5849    a single value per point) you can skip filling those indices.
5850 
5851    Level: intermediate
5852 
5853    Concepts: matrices^zeroing rows
5854 
5855 .seealso: MatZeroRows(), MatZeroRowsIS(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption()
5856 @*/
5857 PetscErrorCode  MatZeroRowsColumnsStencil(Mat mat,PetscInt numRows,const MatStencil rows[],PetscScalar diag,Vec x,Vec b)
5858 {
5859   PetscInt       dim     = mat->stencil.dim;
5860   PetscInt       sdim    = dim - (1 - (PetscInt) mat->stencil.noc);
5861   PetscInt       *dims   = mat->stencil.dims+1;
5862   PetscInt       *starts = mat->stencil.starts;
5863   PetscInt       *dxm    = (PetscInt*) rows;
5864   PetscInt       *jdxm, i, j, tmp, numNewRows = 0;
5865   PetscErrorCode ierr;
5866 
5867   PetscFunctionBegin;
5868   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
5869   PetscValidType(mat,1);
5870   if (numRows) PetscValidIntPointer(rows,3);
5871 
5872   ierr = PetscMalloc1(numRows, &jdxm);CHKERRQ(ierr);
5873   for (i = 0; i < numRows; ++i) {
5874     /* Skip unused dimensions (they are ordered k, j, i, c) */
5875     for (j = 0; j < 3-sdim; ++j) dxm++;
5876     /* Local index in X dir */
5877     tmp = *dxm++ - starts[0];
5878     /* Loop over remaining dimensions */
5879     for (j = 0; j < dim-1; ++j) {
5880       /* If nonlocal, set index to be negative */
5881       if ((*dxm++ - starts[j+1]) < 0 || tmp < 0) tmp = PETSC_MIN_INT;
5882       /* Update local index */
5883       else tmp = tmp*dims[j] + *(dxm-1) - starts[j+1];
5884     }
5885     /* Skip component slot if necessary */
5886     if (mat->stencil.noc) dxm++;
5887     /* Local row number */
5888     if (tmp >= 0) {
5889       jdxm[numNewRows++] = tmp;
5890     }
5891   }
5892   ierr = MatZeroRowsColumnsLocal(mat,numNewRows,jdxm,diag,x,b);CHKERRQ(ierr);
5893   ierr = PetscFree(jdxm);CHKERRQ(ierr);
5894   PetscFunctionReturn(0);
5895 }
5896 
5897 #undef __FUNCT__
5898 #define __FUNCT__ "MatZeroRowsLocal"
5899 /*@C
5900    MatZeroRowsLocal - Zeros all entries (except possibly the main diagonal)
5901    of a set of rows of a matrix; using local numbering of rows.
5902 
5903    Collective on Mat
5904 
5905    Input Parameters:
5906 +  mat - the matrix
5907 .  numRows - the number of rows to remove
5908 .  rows - the global row indices
5909 .  diag - value put in all diagonals of eliminated rows
5910 .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
5911 -  b - optional vector of right hand side, that will be adjusted by provided solution
5912 
5913    Notes:
5914    Before calling MatZeroRowsLocal(), the user must first set the
5915    local-to-global mapping by calling MatSetLocalToGlobalMapping().
5916 
5917    For the AIJ matrix formats this removes the old nonzero structure,
5918    but does not release memory.  For the dense and block diagonal
5919    formats this does not alter the nonzero structure.
5920 
5921    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
5922    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
5923    merely zeroed.
5924 
5925    The user can set a value in the diagonal entry (or for the AIJ and
5926    row formats can optionally remove the main diagonal entry from the
5927    nonzero structure as well, by passing 0.0 as the final argument).
5928 
5929    You can call MatSetOption(mat,MAT_NO_OFF_PROC_ZERO_ROWS,PETSC_TRUE) if each process indicates only rows it
5930    owns that are to be zeroed. This saves a global synchronization in the implementation.
5931 
5932    Level: intermediate
5933 
5934    Concepts: matrices^zeroing
5935 
5936 .seealso: MatZeroRows(), MatZeroRowsLocalIS(), MatZeroEntries(), MatZeroRows(), MatSetLocalToGlobalMapping
5937 @*/
5938 PetscErrorCode  MatZeroRowsLocal(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag,Vec x,Vec b)
5939 {
5940   PetscErrorCode ierr;
5941 
5942   PetscFunctionBegin;
5943   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
5944   PetscValidType(mat,1);
5945   if (numRows) PetscValidIntPointer(rows,3);
5946   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5947   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5948   MatCheckPreallocated(mat,1);
5949 
5950   if (mat->ops->zerorowslocal) {
5951     ierr = (*mat->ops->zerorowslocal)(mat,numRows,rows,diag,x,b);CHKERRQ(ierr);
5952   } else {
5953     IS             is, newis;
5954     const PetscInt *newRows;
5955 
5956     if (!mat->rmap->mapping) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Need to provide local to global mapping to matrix first");
5957     ierr = ISCreateGeneral(PETSC_COMM_SELF,numRows,rows,PETSC_COPY_VALUES,&is);CHKERRQ(ierr);
5958     ierr = ISLocalToGlobalMappingApplyIS(mat->rmap->mapping,is,&newis);CHKERRQ(ierr);
5959     ierr = ISGetIndices(newis,&newRows);CHKERRQ(ierr);
5960     ierr = (*mat->ops->zerorows)(mat,numRows,newRows,diag,x,b);CHKERRQ(ierr);
5961     ierr = ISRestoreIndices(newis,&newRows);CHKERRQ(ierr);
5962     ierr = ISDestroy(&newis);CHKERRQ(ierr);
5963     ierr = ISDestroy(&is);CHKERRQ(ierr);
5964   }
5965   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
5966 #if defined(PETSC_HAVE_CUSP)
5967   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
5968     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
5969   }
5970 #endif
5971 #if defined(PETSC_HAVE_VIENNACL)
5972   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
5973     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
5974   }
5975 #endif
5976   PetscFunctionReturn(0);
5977 }
5978 
5979 #undef __FUNCT__
5980 #define __FUNCT__ "MatZeroRowsLocalIS"
5981 /*@C
5982    MatZeroRowsLocalIS - Zeros all entries (except possibly the main diagonal)
5983    of a set of rows of a matrix; using local numbering of rows.
5984 
5985    Collective on Mat
5986 
5987    Input Parameters:
5988 +  mat - the matrix
5989 .  is - index set of rows to remove
5990 .  diag - value put in all diagonals of eliminated rows
5991 .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
5992 -  b - optional vector of right hand side, that will be adjusted by provided solution
5993 
5994    Notes:
5995    Before calling MatZeroRowsLocalIS(), the user must first set the
5996    local-to-global mapping by calling MatSetLocalToGlobalMapping().
5997 
5998    For the AIJ matrix formats this removes the old nonzero structure,
5999    but does not release memory.  For the dense and block diagonal
6000    formats this does not alter the nonzero structure.
6001 
6002    If the option MatSetOption(mat,MAT_KEEP_NONZERO_PATTERN,PETSC_TRUE) the nonzero structure
6003    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
6004    merely zeroed.
6005 
6006    The user can set a value in the diagonal entry (or for the AIJ and
6007    row formats can optionally remove the main diagonal entry from the
6008    nonzero structure as well, by passing 0.0 as the final argument).
6009 
6010    You can call MatSetOption(mat,MAT_NO_OFF_PROC_ZERO_ROWS,PETSC_TRUE) if each process indicates only rows it
6011    owns that are to be zeroed. This saves a global synchronization in the implementation.
6012 
6013    Level: intermediate
6014 
6015    Concepts: matrices^zeroing
6016 
6017 .seealso: MatZeroRows(), MatZeroRowsLocal(), MatZeroEntries(), MatZeroRows(), MatSetLocalToGlobalMapping
6018 @*/
6019 PetscErrorCode  MatZeroRowsLocalIS(Mat mat,IS is,PetscScalar diag,Vec x,Vec b)
6020 {
6021   PetscErrorCode ierr;
6022   PetscInt       numRows;
6023   const PetscInt *rows;
6024 
6025   PetscFunctionBegin;
6026   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6027   PetscValidType(mat,1);
6028   PetscValidHeaderSpecific(is,IS_CLASSID,2);
6029   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6030   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6031   MatCheckPreallocated(mat,1);
6032 
6033   ierr = ISGetLocalSize(is,&numRows);CHKERRQ(ierr);
6034   ierr = ISGetIndices(is,&rows);CHKERRQ(ierr);
6035   ierr = MatZeroRowsLocal(mat,numRows,rows,diag,x,b);CHKERRQ(ierr);
6036   ierr = ISRestoreIndices(is,&rows);CHKERRQ(ierr);
6037   PetscFunctionReturn(0);
6038 }
6039 
6040 #undef __FUNCT__
6041 #define __FUNCT__ "MatZeroRowsColumnsLocal"
6042 /*@C
6043    MatZeroRowsColumnsLocal - Zeros all entries (except possibly the main diagonal)
6044    of a set of rows and columns of a matrix; using local numbering of rows.
6045 
6046    Collective on Mat
6047 
6048    Input Parameters:
6049 +  mat - the matrix
6050 .  numRows - the number of rows to remove
6051 .  rows - the global row indices
6052 .  diag - value put in all diagonals of eliminated rows
6053 .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
6054 -  b - optional vector of right hand side, that will be adjusted by provided solution
6055 
6056    Notes:
6057    Before calling MatZeroRowsColumnsLocal(), the user must first set the
6058    local-to-global mapping by calling MatSetLocalToGlobalMapping().
6059 
6060    The user can set a value in the diagonal entry (or for the AIJ and
6061    row formats can optionally remove the main diagonal entry from the
6062    nonzero structure as well, by passing 0.0 as the final argument).
6063 
6064    Level: intermediate
6065 
6066    Concepts: matrices^zeroing
6067 
6068 .seealso: MatZeroRows(), MatZeroRowsLocalIS(), MatZeroEntries(), MatZeroRows(), MatSetLocalToGlobalMapping
6069 @*/
6070 PetscErrorCode  MatZeroRowsColumnsLocal(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag,Vec x,Vec b)
6071 {
6072   PetscErrorCode ierr;
6073   IS             is, newis;
6074   const PetscInt *newRows;
6075 
6076   PetscFunctionBegin;
6077   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6078   PetscValidType(mat,1);
6079   if (numRows) PetscValidIntPointer(rows,3);
6080   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6081   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6082   MatCheckPreallocated(mat,1);
6083 
6084   if (!mat->cmap->mapping) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Need to provide local to global mapping to matrix first");
6085   ierr = ISCreateGeneral(PETSC_COMM_SELF,numRows,rows,PETSC_COPY_VALUES,&is);CHKERRQ(ierr);
6086   ierr = ISLocalToGlobalMappingApplyIS(mat->cmap->mapping,is,&newis);CHKERRQ(ierr);
6087   ierr = ISGetIndices(newis,&newRows);CHKERRQ(ierr);
6088   ierr = (*mat->ops->zerorowscolumns)(mat,numRows,newRows,diag,x,b);CHKERRQ(ierr);
6089   ierr = ISRestoreIndices(newis,&newRows);CHKERRQ(ierr);
6090   ierr = ISDestroy(&newis);CHKERRQ(ierr);
6091   ierr = ISDestroy(&is);CHKERRQ(ierr);
6092   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
6093 #if defined(PETSC_HAVE_CUSP)
6094   if (mat->valid_GPU_matrix != PETSC_CUSP_UNALLOCATED) {
6095     mat->valid_GPU_matrix = PETSC_CUSP_CPU;
6096   }
6097 #endif
6098 #if defined(PETSC_HAVE_VIENNACL)
6099   if (mat->valid_GPU_matrix != PETSC_VIENNACL_UNALLOCATED) {
6100     mat->valid_GPU_matrix = PETSC_VIENNACL_CPU;
6101   }
6102 #endif
6103   PetscFunctionReturn(0);
6104 }
6105 
6106 #undef __FUNCT__
6107 #define __FUNCT__ "MatZeroRowsColumnsLocalIS"
6108 /*@C
6109    MatZeroRowsColumnsLocalIS - Zeros all entries (except possibly the main diagonal)
6110    of a set of rows and columns of a matrix; using local numbering of rows.
6111 
6112    Collective on Mat
6113 
6114    Input Parameters:
6115 +  mat - the matrix
6116 .  is - index set of rows to remove
6117 .  diag - value put in all diagonals of eliminated rows
6118 .  x - optional vector of solutions for zeroed rows (other entries in vector are not used)
6119 -  b - optional vector of right hand side, that will be adjusted by provided solution
6120 
6121    Notes:
6122    Before calling MatZeroRowsColumnsLocalIS(), the user must first set the
6123    local-to-global mapping by calling MatSetLocalToGlobalMapping().
6124 
6125    The user can set a value in the diagonal entry (or for the AIJ and
6126    row formats can optionally remove the main diagonal entry from the
6127    nonzero structure as well, by passing 0.0 as the final argument).
6128 
6129    Level: intermediate
6130 
6131    Concepts: matrices^zeroing
6132 
6133 .seealso: MatZeroRows(), MatZeroRowsLocal(), MatZeroEntries(), MatZeroRows(), MatSetLocalToGlobalMapping
6134 @*/
6135 PetscErrorCode  MatZeroRowsColumnsLocalIS(Mat mat,IS is,PetscScalar diag,Vec x,Vec b)
6136 {
6137   PetscErrorCode ierr;
6138   PetscInt       numRows;
6139   const PetscInt *rows;
6140 
6141   PetscFunctionBegin;
6142   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6143   PetscValidType(mat,1);
6144   PetscValidHeaderSpecific(is,IS_CLASSID,2);
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   MatCheckPreallocated(mat,1);
6148 
6149   ierr = ISGetLocalSize(is,&numRows);CHKERRQ(ierr);
6150   ierr = ISGetIndices(is,&rows);CHKERRQ(ierr);
6151   ierr = MatZeroRowsColumnsLocal(mat,numRows,rows,diag,x,b);CHKERRQ(ierr);
6152   ierr = ISRestoreIndices(is,&rows);CHKERRQ(ierr);
6153   PetscFunctionReturn(0);
6154 }
6155 
6156 #undef __FUNCT__
6157 #define __FUNCT__ "MatGetSize"
6158 /*@
6159    MatGetSize - Returns the numbers of rows and columns in a matrix.
6160 
6161    Not Collective
6162 
6163    Input Parameter:
6164 .  mat - the matrix
6165 
6166    Output Parameters:
6167 +  m - the number of global rows
6168 -  n - the number of global columns
6169 
6170    Note: both output parameters can be NULL on input.
6171 
6172    Level: beginner
6173 
6174    Concepts: matrices^size
6175 
6176 .seealso: MatGetLocalSize()
6177 @*/
6178 PetscErrorCode  MatGetSize(Mat mat,PetscInt *m,PetscInt *n)
6179 {
6180   PetscFunctionBegin;
6181   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6182   if (m) *m = mat->rmap->N;
6183   if (n) *n = mat->cmap->N;
6184   PetscFunctionReturn(0);
6185 }
6186 
6187 #undef __FUNCT__
6188 #define __FUNCT__ "MatGetLocalSize"
6189 /*@
6190    MatGetLocalSize - Returns the number of rows and columns in a matrix
6191    stored locally.  This information may be implementation dependent, so
6192    use with care.
6193 
6194    Not Collective
6195 
6196    Input Parameters:
6197 .  mat - the matrix
6198 
6199    Output Parameters:
6200 +  m - the number of local rows
6201 -  n - the number of local columns
6202 
6203    Note: both output parameters can be NULL on input.
6204 
6205    Level: beginner
6206 
6207    Concepts: matrices^local size
6208 
6209 .seealso: MatGetSize()
6210 @*/
6211 PetscErrorCode  MatGetLocalSize(Mat mat,PetscInt *m,PetscInt *n)
6212 {
6213   PetscFunctionBegin;
6214   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6215   if (m) PetscValidIntPointer(m,2);
6216   if (n) PetscValidIntPointer(n,3);
6217   if (m) *m = mat->rmap->n;
6218   if (n) *n = mat->cmap->n;
6219   PetscFunctionReturn(0);
6220 }
6221 
6222 #undef __FUNCT__
6223 #define __FUNCT__ "MatGetOwnershipRangeColumn"
6224 /*@
6225    MatGetOwnershipRangeColumn - Returns the range of matrix columns associated with rows of a vector one multiplies by that owned by
6226    this processor. (The columns of the "diagonal block")
6227 
6228    Not Collective, unless matrix has not been allocated, then collective on Mat
6229 
6230    Input Parameters:
6231 .  mat - the matrix
6232 
6233    Output Parameters:
6234 +  m - the global index of the first local column
6235 -  n - one more than the global index of the last local column
6236 
6237    Notes: both output parameters can be NULL on input.
6238 
6239    Level: developer
6240 
6241    Concepts: matrices^column ownership
6242 
6243 .seealso:  MatGetOwnershipRange(), MatGetOwnershipRanges(), MatGetOwnershipRangesColumn()
6244 
6245 @*/
6246 PetscErrorCode  MatGetOwnershipRangeColumn(Mat mat,PetscInt *m,PetscInt *n)
6247 {
6248   PetscFunctionBegin;
6249   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6250   PetscValidType(mat,1);
6251   if (m) PetscValidIntPointer(m,2);
6252   if (n) PetscValidIntPointer(n,3);
6253   MatCheckPreallocated(mat,1);
6254   if (m) *m = mat->cmap->rstart;
6255   if (n) *n = mat->cmap->rend;
6256   PetscFunctionReturn(0);
6257 }
6258 
6259 #undef __FUNCT__
6260 #define __FUNCT__ "MatGetOwnershipRange"
6261 /*@
6262    MatGetOwnershipRange - Returns the range of matrix rows owned by
6263    this processor, assuming that the matrix is laid out with the first
6264    n1 rows on the first processor, the next n2 rows on the second, etc.
6265    For certain parallel layouts this range may not be well defined.
6266 
6267    Not Collective
6268 
6269    Input Parameters:
6270 .  mat - the matrix
6271 
6272    Output Parameters:
6273 +  m - the global index of the first local row
6274 -  n - one more than the global index of the last local row
6275 
6276    Note: Both output parameters can be NULL on input.
6277 $  This function requires that the matrix be preallocated. If you have not preallocated, consider using
6278 $    PetscSplitOwnership(MPI_Comm comm, PetscInt *n, PetscInt *N)
6279 $  and then MPI_Scan() to calculate prefix sums of the local sizes.
6280 
6281    Level: beginner
6282 
6283    Concepts: matrices^row ownership
6284 
6285 .seealso:   MatGetOwnershipRanges(), MatGetOwnershipRangeColumn(), MatGetOwnershipRangesColumn(), PetscSplitOwnership(), PetscSplitOwnershipBlock()
6286 
6287 @*/
6288 PetscErrorCode  MatGetOwnershipRange(Mat mat,PetscInt *m,PetscInt *n)
6289 {
6290   PetscFunctionBegin;
6291   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6292   PetscValidType(mat,1);
6293   if (m) PetscValidIntPointer(m,2);
6294   if (n) PetscValidIntPointer(n,3);
6295   MatCheckPreallocated(mat,1);
6296   if (m) *m = mat->rmap->rstart;
6297   if (n) *n = mat->rmap->rend;
6298   PetscFunctionReturn(0);
6299 }
6300 
6301 #undef __FUNCT__
6302 #define __FUNCT__ "MatGetOwnershipRanges"
6303 /*@C
6304    MatGetOwnershipRanges - Returns the range of matrix rows owned by
6305    each process
6306 
6307    Not Collective, unless matrix has not been allocated, then collective on Mat
6308 
6309    Input Parameters:
6310 .  mat - the matrix
6311 
6312    Output Parameters:
6313 .  ranges - start of each processors portion plus one more then the total length at the end
6314 
6315    Level: beginner
6316 
6317    Concepts: matrices^row ownership
6318 
6319 .seealso:   MatGetOwnershipRange(), MatGetOwnershipRangeColumn(), MatGetOwnershipRangesColumn()
6320 
6321 @*/
6322 PetscErrorCode  MatGetOwnershipRanges(Mat mat,const PetscInt **ranges)
6323 {
6324   PetscErrorCode ierr;
6325 
6326   PetscFunctionBegin;
6327   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6328   PetscValidType(mat,1);
6329   MatCheckPreallocated(mat,1);
6330   ierr = PetscLayoutGetRanges(mat->rmap,ranges);CHKERRQ(ierr);
6331   PetscFunctionReturn(0);
6332 }
6333 
6334 #undef __FUNCT__
6335 #define __FUNCT__ "MatGetOwnershipRangesColumn"
6336 /*@C
6337    MatGetOwnershipRangesColumn - Returns the range of matrix columns associated with rows of a vector one multiplies by that owned by
6338    this processor. (The columns of the "diagonal blocks" for each process)
6339 
6340    Not Collective, unless matrix has not been allocated, then collective on Mat
6341 
6342    Input Parameters:
6343 .  mat - the matrix
6344 
6345    Output Parameters:
6346 .  ranges - start of each processors portion plus one more then the total length at the end
6347 
6348    Level: beginner
6349 
6350    Concepts: matrices^column ownership
6351 
6352 .seealso:   MatGetOwnershipRange(), MatGetOwnershipRangeColumn(), MatGetOwnershipRanges()
6353 
6354 @*/
6355 PetscErrorCode  MatGetOwnershipRangesColumn(Mat mat,const PetscInt **ranges)
6356 {
6357   PetscErrorCode ierr;
6358 
6359   PetscFunctionBegin;
6360   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6361   PetscValidType(mat,1);
6362   MatCheckPreallocated(mat,1);
6363   ierr = PetscLayoutGetRanges(mat->cmap,ranges);CHKERRQ(ierr);
6364   PetscFunctionReturn(0);
6365 }
6366 
6367 #undef __FUNCT__
6368 #define __FUNCT__ "MatGetOwnershipIS"
6369 /*@C
6370    MatGetOwnershipIS - Get row and column ownership as index sets
6371 
6372    Not Collective
6373 
6374    Input Arguments:
6375 .  A - matrix of type Elemental
6376 
6377    Output Arguments:
6378 +  rows - rows in which this process owns elements
6379 .  cols - columns in which this process owns elements
6380 
6381    Level: intermediate
6382 
6383 .seealso: MatGetOwnershipRange(), MatGetOwnershipRangeColumn(), MatSetValues(), MATELEMENTAL, MatSetValues()
6384 @*/
6385 PetscErrorCode MatGetOwnershipIS(Mat A,IS *rows,IS *cols)
6386 {
6387   PetscErrorCode ierr,(*f)(Mat,IS*,IS*);
6388 
6389   PetscFunctionBegin;
6390   MatCheckPreallocated(A,1);
6391   ierr = PetscObjectQueryFunction((PetscObject)A,"MatGetOwnershipIS_C",&f);CHKERRQ(ierr);
6392   if (f) {
6393     ierr = (*f)(A,rows,cols);CHKERRQ(ierr);
6394   } else {   /* Create a standard row-based partition, each process is responsible for ALL columns in their row block */
6395     if (rows) {ierr = ISCreateStride(PETSC_COMM_SELF,A->rmap->n,A->rmap->rstart,1,rows);CHKERRQ(ierr);}
6396     if (cols) {ierr = ISCreateStride(PETSC_COMM_SELF,A->cmap->N,0,1,cols);CHKERRQ(ierr);}
6397   }
6398   PetscFunctionReturn(0);
6399 }
6400 
6401 #undef __FUNCT__
6402 #define __FUNCT__ "MatILUFactorSymbolic"
6403 /*@C
6404    MatILUFactorSymbolic - Performs symbolic ILU factorization of a matrix.
6405    Uses levels of fill only, not drop tolerance. Use MatLUFactorNumeric()
6406    to complete the factorization.
6407 
6408    Collective on Mat
6409 
6410    Input Parameters:
6411 +  mat - the matrix
6412 .  row - row permutation
6413 .  column - column permutation
6414 -  info - structure containing
6415 $      levels - number of levels of fill.
6416 $      expected fill - as ratio of original fill.
6417 $      1 or 0 - indicating force fill on diagonal (improves robustness for matrices
6418                 missing diagonal entries)
6419 
6420    Output Parameters:
6421 .  fact - new matrix that has been symbolically factored
6422 
6423    Notes: See Users-Manual: ch_mat for additional information about choosing the fill factor for better efficiency.
6424 
6425    Most users should employ the simplified KSP interface for linear solvers
6426    instead of working directly with matrix algebra routines such as this.
6427    See, e.g., KSPCreate().
6428 
6429    Level: developer
6430 
6431   Concepts: matrices^symbolic LU factorization
6432   Concepts: matrices^factorization
6433   Concepts: LU^symbolic factorization
6434 
6435 .seealso: MatLUFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor()
6436           MatGetOrdering(), MatFactorInfo
6437 
6438     Developer Note: fortran interface is not autogenerated as the f90
6439     interface defintion cannot be generated correctly [due to MatFactorInfo]
6440 
6441 @*/
6442 PetscErrorCode  MatILUFactorSymbolic(Mat fact,Mat mat,IS row,IS col,const MatFactorInfo *info)
6443 {
6444   PetscErrorCode ierr;
6445 
6446   PetscFunctionBegin;
6447   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6448   PetscValidType(mat,1);
6449   PetscValidHeaderSpecific(row,IS_CLASSID,2);
6450   PetscValidHeaderSpecific(col,IS_CLASSID,3);
6451   PetscValidPointer(info,4);
6452   PetscValidPointer(fact,5);
6453   if (info->levels < 0) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Levels of fill negative %D",(PetscInt)info->levels);
6454   if (info->fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Expected fill less than 1.0 %g",(double)info->fill);
6455   if (!(fact)->ops->ilufactorsymbolic) {
6456     const MatSolverPackage spackage;
6457     ierr = MatFactorGetSolverPackage(fact,&spackage);CHKERRQ(ierr);
6458     SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s symbolic ILU using solver package %s",((PetscObject)mat)->type_name,spackage);
6459   }
6460   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6461   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6462   MatCheckPreallocated(mat,2);
6463 
6464   ierr = PetscLogEventBegin(MAT_ILUFactorSymbolic,mat,row,col,0);CHKERRQ(ierr);
6465   ierr = (fact->ops->ilufactorsymbolic)(fact,mat,row,col,info);CHKERRQ(ierr);
6466   ierr = PetscLogEventEnd(MAT_ILUFactorSymbolic,mat,row,col,0);CHKERRQ(ierr);
6467   PetscFunctionReturn(0);
6468 }
6469 
6470 #undef __FUNCT__
6471 #define __FUNCT__ "MatICCFactorSymbolic"
6472 /*@C
6473    MatICCFactorSymbolic - Performs symbolic incomplete
6474    Cholesky factorization for a symmetric matrix.  Use
6475    MatCholeskyFactorNumeric() to complete the factorization.
6476 
6477    Collective on Mat
6478 
6479    Input Parameters:
6480 +  mat - the matrix
6481 .  perm - row and column permutation
6482 -  info - structure containing
6483 $      levels - number of levels of fill.
6484 $      expected fill - as ratio of original fill.
6485 
6486    Output Parameter:
6487 .  fact - the factored matrix
6488 
6489    Notes:
6490    Most users should employ the KSP interface for linear solvers
6491    instead of working directly with matrix algebra routines such as this.
6492    See, e.g., KSPCreate().
6493 
6494    Level: developer
6495 
6496   Concepts: matrices^symbolic incomplete Cholesky factorization
6497   Concepts: matrices^factorization
6498   Concepts: Cholsky^symbolic factorization
6499 
6500 .seealso: MatCholeskyFactorNumeric(), MatCholeskyFactor(), MatFactorInfo
6501 
6502     Developer Note: fortran interface is not autogenerated as the f90
6503     interface defintion cannot be generated correctly [due to MatFactorInfo]
6504 
6505 @*/
6506 PetscErrorCode  MatICCFactorSymbolic(Mat fact,Mat mat,IS perm,const MatFactorInfo *info)
6507 {
6508   PetscErrorCode ierr;
6509 
6510   PetscFunctionBegin;
6511   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6512   PetscValidType(mat,1);
6513   PetscValidHeaderSpecific(perm,IS_CLASSID,2);
6514   PetscValidPointer(info,3);
6515   PetscValidPointer(fact,4);
6516   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6517   if (info->levels < 0) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Levels negative %D",(PetscInt) info->levels);
6518   if (info->fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Expected fill less than 1.0 %g",(double)info->fill);
6519   if (!(fact)->ops->iccfactorsymbolic) {
6520     const MatSolverPackage spackage;
6521     ierr = MatFactorGetSolverPackage(fact,&spackage);CHKERRQ(ierr);
6522     SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Matrix type %s symbolic ICC using solver package %s",((PetscObject)mat)->type_name,spackage);
6523   }
6524   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6525   MatCheckPreallocated(mat,2);
6526 
6527   ierr = PetscLogEventBegin(MAT_ICCFactorSymbolic,mat,perm,0,0);CHKERRQ(ierr);
6528   ierr = (fact->ops->iccfactorsymbolic)(fact,mat,perm,info);CHKERRQ(ierr);
6529   ierr = PetscLogEventEnd(MAT_ICCFactorSymbolic,mat,perm,0,0);CHKERRQ(ierr);
6530   PetscFunctionReturn(0);
6531 }
6532 
6533 #undef __FUNCT__
6534 #define __FUNCT__ "MatGetSubMatrices"
6535 /*@C
6536    MatGetSubMatrices - Extracts several submatrices from a matrix. If submat
6537    points to an array of valid matrices, they may be reused to store the new
6538    submatrices.
6539 
6540    Collective on Mat
6541 
6542    Input Parameters:
6543 +  mat - the matrix
6544 .  n   - the number of submatrixes to be extracted (on this processor, may be zero)
6545 .  irow, icol - index sets of rows and columns to extract
6546 -  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
6547 
6548    Output Parameter:
6549 .  submat - the array of submatrices
6550 
6551    Notes:
6552    MatGetSubMatrices() can extract ONLY sequential submatrices
6553    (from both sequential and parallel matrices). Use MatGetSubMatrix()
6554    to extract a parallel submatrix.
6555 
6556    Some matrix types place restrictions on the row and column
6557    indices, such as that they be sorted or that they be equal to each other.
6558 
6559    The index sets may not have duplicate entries.
6560 
6561    When extracting submatrices from a parallel matrix, each processor can
6562    form a different submatrix by setting the rows and columns of its
6563    individual index sets according to the local submatrix desired.
6564 
6565    When finished using the submatrices, the user should destroy
6566    them with MatDestroyMatrices().
6567 
6568    MAT_REUSE_MATRIX can only be used when the nonzero structure of the
6569    original matrix has not changed from that last call to MatGetSubMatrices().
6570 
6571    This routine creates the matrices in submat; you should NOT create them before
6572    calling it. It also allocates the array of matrix pointers submat.
6573 
6574    For BAIJ matrices the index sets must respect the block structure, that is if they
6575    request one row/column in a block, they must request all rows/columns that are in
6576    that block. For example, if the block size is 2 you cannot request just row 0 and
6577    column 0.
6578 
6579    Fortran Note:
6580    The Fortran interface is slightly different from that given below; it
6581    requires one to pass in  as submat a Mat (integer) array of size at least m.
6582 
6583    Level: advanced
6584 
6585    Concepts: matrices^accessing submatrices
6586    Concepts: submatrices
6587 
6588 .seealso: MatDestroyMatrices(), MatGetSubMatrix(), MatGetRow(), MatGetDiagonal(), MatReuse
6589 @*/
6590 PetscErrorCode  MatGetSubMatrices(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[])
6591 {
6592   PetscErrorCode ierr;
6593   PetscInt       i;
6594   PetscBool      eq;
6595 
6596   PetscFunctionBegin;
6597   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6598   PetscValidType(mat,1);
6599   if (n) {
6600     PetscValidPointer(irow,3);
6601     PetscValidHeaderSpecific(*irow,IS_CLASSID,3);
6602     PetscValidPointer(icol,4);
6603     PetscValidHeaderSpecific(*icol,IS_CLASSID,4);
6604   }
6605   PetscValidPointer(submat,6);
6606   if (n && scall == MAT_REUSE_MATRIX) {
6607     PetscValidPointer(*submat,6);
6608     PetscValidHeaderSpecific(**submat,MAT_CLASSID,6);
6609   }
6610   if (!mat->ops->getsubmatrices) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
6611   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6612   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6613   MatCheckPreallocated(mat,1);
6614 
6615   ierr = PetscLogEventBegin(MAT_GetSubMatrices,mat,0,0,0);CHKERRQ(ierr);
6616   ierr = (*mat->ops->getsubmatrices)(mat,n,irow,icol,scall,submat);CHKERRQ(ierr);
6617   ierr = PetscLogEventEnd(MAT_GetSubMatrices,mat,0,0,0);CHKERRQ(ierr);
6618   for (i=0; i<n; i++) {
6619     (*submat)[i]->factortype = MAT_FACTOR_NONE;  /* in case in place factorization was previously done on submatrix */
6620     if (mat->symmetric || mat->structurally_symmetric || mat->hermitian) {
6621       ierr = ISEqual(irow[i],icol[i],&eq);CHKERRQ(ierr);
6622       if (eq) {
6623         if (mat->symmetric) {
6624           ierr = MatSetOption((*submat)[i],MAT_SYMMETRIC,PETSC_TRUE);CHKERRQ(ierr);
6625         } else if (mat->hermitian) {
6626           ierr = MatSetOption((*submat)[i],MAT_HERMITIAN,PETSC_TRUE);CHKERRQ(ierr);
6627         } else if (mat->structurally_symmetric) {
6628           ierr = MatSetOption((*submat)[i],MAT_STRUCTURALLY_SYMMETRIC,PETSC_TRUE);CHKERRQ(ierr);
6629         }
6630       }
6631     }
6632   }
6633   PetscFunctionReturn(0);
6634 }
6635 
6636 #undef __FUNCT__
6637 #define __FUNCT__ "MatGetSubMatricesMPI"
6638 PetscErrorCode  MatGetSubMatricesMPI(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[])
6639 {
6640   PetscErrorCode ierr;
6641   PetscInt       i;
6642   PetscBool      eq;
6643 
6644   PetscFunctionBegin;
6645   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6646   PetscValidType(mat,1);
6647   if (n) {
6648     PetscValidPointer(irow,3);
6649     PetscValidHeaderSpecific(*irow,IS_CLASSID,3);
6650     PetscValidPointer(icol,4);
6651     PetscValidHeaderSpecific(*icol,IS_CLASSID,4);
6652   }
6653   PetscValidPointer(submat,6);
6654   if (n && scall == MAT_REUSE_MATRIX) {
6655     PetscValidPointer(*submat,6);
6656     PetscValidHeaderSpecific(**submat,MAT_CLASSID,6);
6657   }
6658   if (!mat->ops->getsubmatricesmpi) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
6659   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6660   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6661   MatCheckPreallocated(mat,1);
6662 
6663   ierr = PetscLogEventBegin(MAT_GetSubMatrices,mat,0,0,0);CHKERRQ(ierr);
6664   ierr = (*mat->ops->getsubmatricesmpi)(mat,n,irow,icol,scall,submat);CHKERRQ(ierr);
6665   ierr = PetscLogEventEnd(MAT_GetSubMatrices,mat,0,0,0);CHKERRQ(ierr);
6666   for (i=0; i<n; i++) {
6667     if (mat->symmetric || mat->structurally_symmetric || mat->hermitian) {
6668       ierr = ISEqual(irow[i],icol[i],&eq);CHKERRQ(ierr);
6669       if (eq) {
6670         if (mat->symmetric) {
6671           ierr = MatSetOption((*submat)[i],MAT_SYMMETRIC,PETSC_TRUE);CHKERRQ(ierr);
6672         } else if (mat->hermitian) {
6673           ierr = MatSetOption((*submat)[i],MAT_HERMITIAN,PETSC_TRUE);CHKERRQ(ierr);
6674         } else if (mat->structurally_symmetric) {
6675           ierr = MatSetOption((*submat)[i],MAT_STRUCTURALLY_SYMMETRIC,PETSC_TRUE);CHKERRQ(ierr);
6676         }
6677       }
6678     }
6679   }
6680   PetscFunctionReturn(0);
6681 }
6682 
6683 #undef __FUNCT__
6684 #define __FUNCT__ "MatDestroyMatrices"
6685 /*@C
6686    MatDestroyMatrices - Destroys a set of matrices obtained with MatGetSubMatrices().
6687 
6688    Collective on Mat
6689 
6690    Input Parameters:
6691 +  n - the number of local matrices
6692 -  mat - the matrices (note that this is a pointer to the array of matrices, just to match the calling
6693                        sequence of MatGetSubMatrices())
6694 
6695    Level: advanced
6696 
6697     Notes: Frees not only the matrices, but also the array that contains the matrices
6698            In Fortran will not free the array.
6699 
6700 .seealso: MatGetSubMatrices()
6701 @*/
6702 PetscErrorCode  MatDestroyMatrices(PetscInt n,Mat *mat[])
6703 {
6704   PetscErrorCode ierr;
6705   PetscInt       i;
6706 
6707   PetscFunctionBegin;
6708   if (!*mat) PetscFunctionReturn(0);
6709   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to destroy negative number of matrices %D",n);
6710   PetscValidPointer(mat,2);
6711   for (i=0; i<n; i++) {
6712     ierr = MatDestroy(&(*mat)[i]);CHKERRQ(ierr);
6713   }
6714   /* memory is allocated even if n = 0 */
6715   ierr = PetscFree(*mat);CHKERRQ(ierr);
6716   *mat = NULL;
6717   PetscFunctionReturn(0);
6718 }
6719 
6720 #undef __FUNCT__
6721 #define __FUNCT__ "MatGetSeqNonzeroStructure"
6722 /*@C
6723    MatGetSeqNonzeroStructure - Extracts the sequential nonzero structure from a matrix.
6724 
6725    Collective on Mat
6726 
6727    Input Parameters:
6728 .  mat - the matrix
6729 
6730    Output Parameter:
6731 .  matstruct - the sequential matrix with the nonzero structure of mat
6732 
6733   Level: intermediate
6734 
6735 .seealso: MatDestroySeqNonzeroStructure(), MatGetSubMatrices(), MatDestroyMatrices()
6736 @*/
6737 PetscErrorCode  MatGetSeqNonzeroStructure(Mat mat,Mat *matstruct)
6738 {
6739   PetscErrorCode ierr;
6740 
6741   PetscFunctionBegin;
6742   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6743   PetscValidPointer(matstruct,2);
6744 
6745   PetscValidType(mat,1);
6746   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6747   MatCheckPreallocated(mat,1);
6748 
6749   if (!mat->ops->getseqnonzerostructure) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Not for matrix type %s\n",((PetscObject)mat)->type_name);
6750   ierr = PetscLogEventBegin(MAT_GetSeqNonzeroStructure,mat,0,0,0);CHKERRQ(ierr);
6751   ierr = (*mat->ops->getseqnonzerostructure)(mat,matstruct);CHKERRQ(ierr);
6752   ierr = PetscLogEventEnd(MAT_GetSeqNonzeroStructure,mat,0,0,0);CHKERRQ(ierr);
6753   PetscFunctionReturn(0);
6754 }
6755 
6756 #undef __FUNCT__
6757 #define __FUNCT__ "MatDestroySeqNonzeroStructure"
6758 /*@C
6759    MatDestroySeqNonzeroStructure - Destroys matrix obtained with MatGetSeqNonzeroStructure().
6760 
6761    Collective on Mat
6762 
6763    Input Parameters:
6764 .  mat - the matrix (note that this is a pointer to the array of matrices, just to match the calling
6765                        sequence of MatGetSequentialNonzeroStructure())
6766 
6767    Level: advanced
6768 
6769     Notes: Frees not only the matrices, but also the array that contains the matrices
6770 
6771 .seealso: MatGetSeqNonzeroStructure()
6772 @*/
6773 PetscErrorCode  MatDestroySeqNonzeroStructure(Mat *mat)
6774 {
6775   PetscErrorCode ierr;
6776 
6777   PetscFunctionBegin;
6778   PetscValidPointer(mat,1);
6779   ierr = MatDestroy(mat);CHKERRQ(ierr);
6780   PetscFunctionReturn(0);
6781 }
6782 
6783 #undef __FUNCT__
6784 #define __FUNCT__ "MatIncreaseOverlap"
6785 /*@
6786    MatIncreaseOverlap - Given a set of submatrices indicated by index sets,
6787    replaces the index sets by larger ones that represent submatrices with
6788    additional overlap.
6789 
6790    Collective on Mat
6791 
6792    Input Parameters:
6793 +  mat - the matrix
6794 .  n   - the number of index sets
6795 .  is  - the array of index sets (these index sets will changed during the call)
6796 -  ov  - the additional overlap requested
6797 
6798    Level: developer
6799 
6800    Concepts: overlap
6801    Concepts: ASM^computing overlap
6802 
6803 .seealso: MatGetSubMatrices()
6804 @*/
6805 PetscErrorCode  MatIncreaseOverlap(Mat mat,PetscInt n,IS is[],PetscInt ov)
6806 {
6807   PetscErrorCode ierr;
6808 
6809   PetscFunctionBegin;
6810   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6811   PetscValidType(mat,1);
6812   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Must have one or more domains, you have %D",n);
6813   if (n) {
6814     PetscValidPointer(is,3);
6815     PetscValidHeaderSpecific(*is,IS_CLASSID,3);
6816   }
6817   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6818   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6819   MatCheckPreallocated(mat,1);
6820 
6821   if (!ov) PetscFunctionReturn(0);
6822   if (!mat->ops->increaseoverlap) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
6823   ierr = PetscLogEventBegin(MAT_IncreaseOverlap,mat,0,0,0);CHKERRQ(ierr);
6824   ierr = (*mat->ops->increaseoverlap)(mat,n,is,ov);CHKERRQ(ierr);
6825   ierr = PetscLogEventEnd(MAT_IncreaseOverlap,mat,0,0,0);CHKERRQ(ierr);
6826   PetscFunctionReturn(0);
6827 }
6828 
6829 #undef __FUNCT__
6830 #define __FUNCT__ "MatGetBlockSize"
6831 /*@
6832    MatGetBlockSize - Returns the matrix block size.
6833 
6834    Not Collective
6835 
6836    Input Parameter:
6837 .  mat - the matrix
6838 
6839    Output Parameter:
6840 .  bs - block size
6841 
6842    Notes:
6843     Block row formats are MATSEQBAIJ, MATMPIBAIJ, MATSEQSBAIJ, MATMPISBAIJ. These formats ALWAYS have square block storage in the matrix.
6844 
6845    If the block size has not been set yet this routine returns 1.
6846 
6847    Level: intermediate
6848 
6849    Concepts: matrices^block size
6850 
6851 .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSizes()
6852 @*/
6853 PetscErrorCode  MatGetBlockSize(Mat mat,PetscInt *bs)
6854 {
6855   PetscFunctionBegin;
6856   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6857   PetscValidIntPointer(bs,2);
6858   *bs = PetscAbs(mat->rmap->bs);
6859   PetscFunctionReturn(0);
6860 }
6861 
6862 #undef __FUNCT__
6863 #define __FUNCT__ "MatGetBlockSizes"
6864 /*@
6865    MatGetBlockSizes - Returns the matrix block row and column sizes.
6866 
6867    Not Collective
6868 
6869    Input Parameter:
6870 .  mat - the matrix
6871 
6872    Output Parameter:
6873 .  rbs - row block size
6874 .  cbs - coumn block size
6875 
6876    Notes:
6877     Block row formats are MATSEQBAIJ, MATMPIBAIJ, MATSEQSBAIJ, MATMPISBAIJ. These formats ALWAYS have square block storage in the matrix.
6878     If you pass a different block size for the columns than the rows, the row block size determines the square block storage.
6879 
6880    If a block size has not been set yet this routine returns 1.
6881 
6882    Level: intermediate
6883 
6884    Concepts: matrices^block size
6885 
6886 .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSize(), MatSetBlockSizes()
6887 @*/
6888 PetscErrorCode  MatGetBlockSizes(Mat mat,PetscInt *rbs, PetscInt *cbs)
6889 {
6890   PetscFunctionBegin;
6891   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6892   if (rbs) PetscValidIntPointer(rbs,2);
6893   if (cbs) PetscValidIntPointer(cbs,3);
6894   if (rbs) *rbs = PetscAbs(mat->rmap->bs);
6895   if (cbs) *cbs = PetscAbs(mat->cmap->bs);
6896   PetscFunctionReturn(0);
6897 }
6898 
6899 #undef __FUNCT__
6900 #define __FUNCT__ "MatSetBlockSize"
6901 /*@
6902    MatSetBlockSize - Sets the matrix block size.
6903 
6904    Logically Collective on Mat
6905 
6906    Input Parameters:
6907 +  mat - the matrix
6908 -  bs - block size
6909 
6910    Notes:
6911     Block row formats are MATSEQBAIJ, MATMPIBAIJ, MATSEQSBAIJ, MATMPISBAIJ. These formats ALWAYS have square block storage in the matrix.
6912 
6913      This must be called before MatSetUp() or MatXXXSetPreallocation() (or will default to 1) and the block size cannot be changed later
6914 
6915    Level: intermediate
6916 
6917    Concepts: matrices^block size
6918 
6919 .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSizes(), MatGetBlockSizes()
6920 @*/
6921 PetscErrorCode  MatSetBlockSize(Mat mat,PetscInt bs)
6922 {
6923   PetscErrorCode ierr;
6924 
6925   PetscFunctionBegin;
6926   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6927   PetscValidLogicalCollectiveInt(mat,bs,2);
6928   ierr = PetscLayoutSetBlockSize(mat->rmap,bs);CHKERRQ(ierr);
6929   ierr = PetscLayoutSetBlockSize(mat->cmap,bs);CHKERRQ(ierr);
6930   PetscFunctionReturn(0);
6931 }
6932 
6933 #undef __FUNCT__
6934 #define __FUNCT__ "MatSetBlockSizes"
6935 /*@
6936    MatSetBlockSizes - Sets the matrix block row and column sizes.
6937 
6938    Logically Collective on Mat
6939 
6940    Input Parameters:
6941 +  mat - the matrix
6942 -  rbs - row block size
6943 -  cbs - column block size
6944 
6945    Notes:
6946     Block row formats are MATSEQBAIJ, MATMPIBAIJ, MATSEQSBAIJ, MATMPISBAIJ. These formats ALWAYS have square block storage in the matrix.
6947     If you pass a different block size for the columns than the rows, the row block size determines the square block storage.
6948 
6949     This must be called before MatSetUp() or MatXXXSetPreallocation() (or will default to 1) and the block size cannot be changed later
6950 
6951     The row and column block size determine the blocksize of the "row" and "column" vectors returned by MatCreateVecs().
6952 
6953    Level: intermediate
6954 
6955    Concepts: matrices^block size
6956 
6957 .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSize(), MatGetBlockSizes()
6958 @*/
6959 PetscErrorCode  MatSetBlockSizes(Mat mat,PetscInt rbs,PetscInt cbs)
6960 {
6961   PetscErrorCode ierr;
6962 
6963   PetscFunctionBegin;
6964   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6965   PetscValidLogicalCollectiveInt(mat,rbs,2);
6966   PetscValidLogicalCollectiveInt(mat,cbs,3);
6967   ierr = PetscLayoutSetBlockSize(mat->rmap,rbs);CHKERRQ(ierr);
6968   ierr = PetscLayoutSetBlockSize(mat->cmap,cbs);CHKERRQ(ierr);
6969   PetscFunctionReturn(0);
6970 }
6971 
6972 #undef __FUNCT__
6973 #define __FUNCT__ "MatSetBlockSizesFromMats"
6974 /*@
6975    MatSetBlockSizesFromMats - Sets the matrix block row and column sizes to match a pair of matrices
6976 
6977    Logically Collective on Mat
6978 
6979    Input Parameters:
6980 +  mat - the matrix
6981 .  fromRow - matrix from which to copy row block size
6982 -  fromCol - matrix from which to copy column block size (can be same as fromRow)
6983 
6984    Level: developer
6985 
6986    Concepts: matrices^block size
6987 
6988 .seealso: MatCreateSeqBAIJ(), MatCreateBAIJ(), MatGetBlockSize(), MatSetBlockSizes()
6989 @*/
6990 PetscErrorCode  MatSetBlockSizesFromMats(Mat mat,Mat fromRow,Mat fromCol)
6991 {
6992   PetscErrorCode ierr;
6993 
6994   PetscFunctionBegin;
6995   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
6996   PetscValidHeaderSpecific(fromRow,MAT_CLASSID,2);
6997   PetscValidHeaderSpecific(fromCol,MAT_CLASSID,3);
6998   if (fromRow->rmap->bs > 0) {ierr = PetscLayoutSetBlockSize(mat->rmap,fromRow->rmap->bs);CHKERRQ(ierr);}
6999   if (fromCol->cmap->bs > 0) {ierr = PetscLayoutSetBlockSize(mat->cmap,fromCol->cmap->bs);CHKERRQ(ierr);}
7000   PetscFunctionReturn(0);
7001 }
7002 
7003 #undef __FUNCT__
7004 #define __FUNCT__ "MatResidual"
7005 /*@
7006    MatResidual - Default routine to calculate the residual.
7007 
7008    Collective on Mat and Vec
7009 
7010    Input Parameters:
7011 +  mat - the matrix
7012 .  b   - the right-hand-side
7013 -  x   - the approximate solution
7014 
7015    Output Parameter:
7016 .  r - location to store the residual
7017 
7018    Level: developer
7019 
7020 .keywords: MG, default, multigrid, residual
7021 
7022 .seealso: PCMGSetResidual()
7023 @*/
7024 PetscErrorCode  MatResidual(Mat mat,Vec b,Vec x,Vec r)
7025 {
7026   PetscErrorCode ierr;
7027 
7028   PetscFunctionBegin;
7029   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
7030   PetscValidHeaderSpecific(b,VEC_CLASSID,2);
7031   PetscValidHeaderSpecific(x,VEC_CLASSID,3);
7032   PetscValidHeaderSpecific(r,VEC_CLASSID,4);
7033   PetscValidType(mat,1);
7034   MatCheckPreallocated(mat,1);
7035   ierr  = PetscLogEventBegin(MAT_Residual,mat,0,0,0);CHKERRQ(ierr);
7036   if (!mat->ops->residual) {
7037     ierr = MatMult(mat,x,r);CHKERRQ(ierr);
7038     ierr = VecAYPX(r,-1.0,b);CHKERRQ(ierr);
7039   } else {
7040     ierr  = (*mat->ops->residual)(mat,b,x,r);CHKERRQ(ierr);
7041   }
7042   ierr  = PetscLogEventEnd(MAT_Residual,mat,0,0,0);CHKERRQ(ierr);
7043   PetscFunctionReturn(0);
7044 }
7045 
7046 #undef __FUNCT__
7047 #define __FUNCT__ "MatGetRowIJ"
7048 /*@C
7049     MatGetRowIJ - Returns the compressed row storage i and j indices for sequential matrices.
7050 
7051    Collective on Mat
7052 
7053     Input Parameters:
7054 +   mat - the matrix
7055 .   shift -  0 or 1 indicating we want the indices starting at 0 or 1
7056 .   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be   symmetrized
7057 -   inodecompressed - PETSC_TRUE or PETSC_FALSE  indicating if the nonzero structure of the
7058                  inodes or the nonzero elements is wanted. For BAIJ matrices the compressed version is
7059                  always used.
7060 
7061     Output Parameters:
7062 +   n - number of rows in the (possibly compressed) matrix
7063 .   ia - the row pointers [of length n+1]
7064 .   ja - the column indices
7065 -   done - indicates if the routine actually worked and returned appropriate ia[] and ja[] arrays; callers
7066            are responsible for handling the case when done == PETSC_FALSE and ia and ja are not set
7067 
7068     Level: developer
7069 
7070     Notes: You CANNOT change any of the ia[] or ja[] values.
7071 
7072            Use MatRestoreRowIJ() when you are finished accessing the ia[] and ja[] values
7073 
7074     Fortran Node
7075 
7076            In Fortran use
7077 $           PetscInt ia(1), ja(1)
7078 $           PetscOffset iia, jja
7079 $      call MatGetRowIJ(mat,shift,symmetric,inodecompressed,n,ia,iia,ja,jja,done,ierr)
7080 $
7081 $          or
7082 $
7083 $           PetscScalar, pointer :: xx_v(:)
7084 $    call  MatGetRowIJF90(mat,shift,symmetric,inodecompressed,n,ia,ja,done,ierr)
7085 
7086 
7087        Acess the ith and jth entries via ia(iia + i) and ja(jja + j)
7088 
7089 .seealso: MatGetColumnIJ(), MatRestoreRowIJ(), MatSeqAIJGetArray()
7090 @*/
7091 PetscErrorCode MatGetRowIJ(Mat mat,PetscInt shift,PetscBool symmetric,PetscBool inodecompressed,PetscInt *n,const PetscInt *ia[],const PetscInt *ja[],PetscBool  *done)
7092 {
7093   PetscErrorCode ierr;
7094 
7095   PetscFunctionBegin;
7096   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
7097   PetscValidType(mat,1);
7098   PetscValidIntPointer(n,4);
7099   if (ia) PetscValidIntPointer(ia,5);
7100   if (ja) PetscValidIntPointer(ja,6);
7101   PetscValidIntPointer(done,7);
7102   MatCheckPreallocated(mat,1);
7103   if (!mat->ops->getrowij) *done = PETSC_FALSE;
7104   else {
7105     *done = PETSC_TRUE;
7106     ierr  = PetscLogEventBegin(MAT_GetRowIJ,mat,0,0,0);CHKERRQ(ierr);
7107     ierr  = (*mat->ops->getrowij)(mat,shift,symmetric,inodecompressed,n,ia,ja,done);CHKERRQ(ierr);
7108     ierr  = PetscLogEventEnd(MAT_GetRowIJ,mat,0,0,0);CHKERRQ(ierr);
7109   }
7110   PetscFunctionReturn(0);
7111 }
7112 
7113 #undef __FUNCT__
7114 #define __FUNCT__ "MatGetColumnIJ"
7115 /*@C
7116     MatGetColumnIJ - Returns the compressed column storage i and j indices for sequential matrices.
7117 
7118     Collective on Mat
7119 
7120     Input Parameters:
7121 +   mat - the matrix
7122 .   shift - 1 or zero indicating we want the indices starting at 0 or 1
7123 .   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
7124                 symmetrized
7125 .   inodecompressed - PETSC_TRUE or PETSC_FALSE indicating if the nonzero structure of the
7126                  inodes or the nonzero elements is wanted. For BAIJ matrices the compressed version is
7127                  always used.
7128 .   n - number of columns in the (possibly compressed) matrix
7129 .   ia - the column pointers
7130 -   ja - the row indices
7131 
7132     Output Parameters:
7133 .   done - PETSC_TRUE or PETSC_FALSE, indicating whether the values have been returned
7134 
7135     Note:
7136     This routine zeros out n, ia, and ja. This is to prevent accidental
7137     us of the array after it has been restored. If you pass NULL, it will
7138     not zero the pointers.  Use of ia or ja after MatRestoreColumnIJ() is invalid.
7139 
7140     Level: developer
7141 
7142 .seealso: MatGetRowIJ(), MatRestoreColumnIJ()
7143 @*/
7144 PetscErrorCode MatGetColumnIJ(Mat mat,PetscInt shift,PetscBool symmetric,PetscBool inodecompressed,PetscInt *n,const PetscInt *ia[],const PetscInt *ja[],PetscBool  *done)
7145 {
7146   PetscErrorCode ierr;
7147 
7148   PetscFunctionBegin;
7149   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
7150   PetscValidType(mat,1);
7151   PetscValidIntPointer(n,4);
7152   if (ia) PetscValidIntPointer(ia,5);
7153   if (ja) PetscValidIntPointer(ja,6);
7154   PetscValidIntPointer(done,7);
7155   MatCheckPreallocated(mat,1);
7156   if (!mat->ops->getcolumnij) *done = PETSC_FALSE;
7157   else {
7158     *done = PETSC_TRUE;
7159     ierr  = (*mat->ops->getcolumnij)(mat,shift,symmetric,inodecompressed,n,ia,ja,done);CHKERRQ(ierr);
7160   }
7161   PetscFunctionReturn(0);
7162 }
7163 
7164 #undef __FUNCT__
7165 #define __FUNCT__ "MatRestoreRowIJ"
7166 /*@C
7167     MatRestoreRowIJ - Call after you are completed with the ia,ja indices obtained with
7168     MatGetRowIJ().
7169 
7170     Collective on Mat
7171 
7172     Input Parameters:
7173 +   mat - the matrix
7174 .   shift - 1 or zero indicating we want the indices starting at 0 or 1
7175 .   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
7176                 symmetrized
7177 .   inodecompressed -  PETSC_TRUE or PETSC_FALSE indicating if the nonzero structure of the
7178                  inodes or the nonzero elements is wanted. For BAIJ matrices the compressed version is
7179                  always used.
7180 .   n - size of (possibly compressed) matrix
7181 .   ia - the row pointers
7182 -   ja - the column indices
7183 
7184     Output Parameters:
7185 .   done - PETSC_TRUE or PETSC_FALSE indicated that the values have been returned
7186 
7187     Note:
7188     This routine zeros out n, ia, and ja. This is to prevent accidental
7189     us of the array after it has been restored. If you pass NULL, it will
7190     not zero the pointers.  Use of ia or ja after MatRestoreRowIJ() is invalid.
7191 
7192     Level: developer
7193 
7194 .seealso: MatGetRowIJ(), MatRestoreColumnIJ()
7195 @*/
7196 PetscErrorCode MatRestoreRowIJ(Mat mat,PetscInt shift,PetscBool symmetric,PetscBool inodecompressed,PetscInt *n,const PetscInt *ia[],const PetscInt *ja[],PetscBool  *done)
7197 {
7198   PetscErrorCode ierr;
7199 
7200   PetscFunctionBegin;
7201   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
7202   PetscValidType(mat,1);
7203   if (ia) PetscValidIntPointer(ia,5);
7204   if (ja) PetscValidIntPointer(ja,6);
7205   PetscValidIntPointer(done,7);
7206   MatCheckPreallocated(mat,1);
7207 
7208   if (!mat->ops->restorerowij) *done = PETSC_FALSE;
7209   else {
7210     *done = PETSC_TRUE;
7211     ierr  = (*mat->ops->restorerowij)(mat,shift,symmetric,inodecompressed,n,ia,ja,done);CHKERRQ(ierr);
7212     if (n)  *n = 0;
7213     if (ia) *ia = NULL;
7214     if (ja) *ja = NULL;
7215   }
7216   PetscFunctionReturn(0);
7217 }
7218 
7219 #undef __FUNCT__
7220 #define __FUNCT__ "MatRestoreColumnIJ"
7221 /*@C
7222     MatRestoreColumnIJ - Call after you are completed with the ia,ja indices obtained with
7223     MatGetColumnIJ().
7224 
7225     Collective on Mat
7226 
7227     Input Parameters:
7228 +   mat - the matrix
7229 .   shift - 1 or zero indicating we want the indices starting at 0 or 1
7230 -   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
7231                 symmetrized
7232 -   inodecompressed - PETSC_TRUE or PETSC_FALSE indicating if the nonzero structure of the
7233                  inodes or the nonzero elements is wanted. For BAIJ matrices the compressed version is
7234                  always used.
7235 
7236     Output Parameters:
7237 +   n - size of (possibly compressed) matrix
7238 .   ia - the column pointers
7239 .   ja - the row indices
7240 -   done - PETSC_TRUE or PETSC_FALSE indicated that the values have been returned
7241 
7242     Level: developer
7243 
7244 .seealso: MatGetColumnIJ(), MatRestoreRowIJ()
7245 @*/
7246 PetscErrorCode MatRestoreColumnIJ(Mat mat,PetscInt shift,PetscBool symmetric,PetscBool inodecompressed,PetscInt *n,const PetscInt *ia[],const PetscInt *ja[],PetscBool  *done)
7247 {
7248   PetscErrorCode ierr;
7249 
7250   PetscFunctionBegin;
7251   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
7252   PetscValidType(mat,1);
7253   if (ia) PetscValidIntPointer(ia,5);
7254   if (ja) PetscValidIntPointer(ja,6);
7255   PetscValidIntPointer(done,7);
7256   MatCheckPreallocated(mat,1);
7257 
7258   if (!mat->ops->restorecolumnij) *done = PETSC_FALSE;
7259   else {
7260     *done = PETSC_TRUE;
7261     ierr  = (*mat->ops->restorecolumnij)(mat,shift,symmetric,inodecompressed,n,ia,ja,done);CHKERRQ(ierr);
7262     if (n)  *n = 0;
7263     if (ia) *ia = NULL;
7264     if (ja) *ja = NULL;
7265   }
7266   PetscFunctionReturn(0);
7267 }
7268 
7269 #undef __FUNCT__
7270 #define __FUNCT__ "MatColoringPatch"
7271 /*@C
7272     MatColoringPatch -Used inside matrix coloring routines that
7273     use MatGetRowIJ() and/or MatGetColumnIJ().
7274 
7275     Collective on Mat
7276 
7277     Input Parameters:
7278 +   mat - the matrix
7279 .   ncolors - max color value
7280 .   n   - number of entries in colorarray
7281 -   colorarray - array indicating color for each column
7282 
7283     Output Parameters:
7284 .   iscoloring - coloring generated using colorarray information
7285 
7286     Level: developer
7287 
7288 .seealso: MatGetRowIJ(), MatGetColumnIJ()
7289 
7290 @*/
7291 PetscErrorCode  MatColoringPatch(Mat mat,PetscInt ncolors,PetscInt n,ISColoringValue colorarray[],ISColoring *iscoloring)
7292 {
7293   PetscErrorCode ierr;
7294 
7295   PetscFunctionBegin;
7296   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
7297   PetscValidType(mat,1);
7298   PetscValidIntPointer(colorarray,4);
7299   PetscValidPointer(iscoloring,5);
7300   MatCheckPreallocated(mat,1);
7301 
7302   if (!mat->ops->coloringpatch) {
7303     ierr = ISColoringCreate(PetscObjectComm((PetscObject)mat),ncolors,n,colorarray,PETSC_OWN_POINTER,iscoloring);CHKERRQ(ierr);
7304   } else {
7305     ierr = (*mat->ops->coloringpatch)(mat,ncolors,n,colorarray,iscoloring);CHKERRQ(ierr);
7306   }
7307   PetscFunctionReturn(0);
7308 }
7309 
7310 
7311 #undef __FUNCT__
7312 #define __FUNCT__ "MatSetUnfactored"
7313 /*@
7314    MatSetUnfactored - Resets a factored matrix to be treated as unfactored.
7315 
7316    Logically Collective on Mat
7317 
7318    Input Parameter:
7319 .  mat - the factored matrix to be reset
7320 
7321    Notes:
7322    This routine should be used only with factored matrices formed by in-place
7323    factorization via ILU(0) (or by in-place LU factorization for the MATSEQDENSE
7324    format).  This option can save memory, for example, when solving nonlinear
7325    systems with a matrix-free Newton-Krylov method and a matrix-based, in-place
7326    ILU(0) preconditioner.
7327 
7328    Note that one can specify in-place ILU(0) factorization by calling
7329 .vb
7330      PCType(pc,PCILU);
7331      PCFactorSeUseInPlace(pc);
7332 .ve
7333    or by using the options -pc_type ilu -pc_factor_in_place
7334 
7335    In-place factorization ILU(0) can also be used as a local
7336    solver for the blocks within the block Jacobi or additive Schwarz
7337    methods (runtime option: -sub_pc_factor_in_place).  See Users-Manual: ch_pc
7338    for details on setting local solver options.
7339 
7340    Most users should employ the simplified KSP interface for linear solvers
7341    instead of working directly with matrix algebra routines such as this.
7342    See, e.g., KSPCreate().
7343 
7344    Level: developer
7345 
7346 .seealso: PCFactorSetUseInPlace(), PCFactorGetUseInPlace()
7347 
7348    Concepts: matrices^unfactored
7349 
7350 @*/
7351 PetscErrorCode  MatSetUnfactored(Mat mat)
7352 {
7353   PetscErrorCode ierr;
7354 
7355   PetscFunctionBegin;
7356   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
7357   PetscValidType(mat,1);
7358   MatCheckPreallocated(mat,1);
7359   mat->factortype = MAT_FACTOR_NONE;
7360   if (!mat->ops->setunfactored) PetscFunctionReturn(0);
7361   ierr = (*mat->ops->setunfactored)(mat);CHKERRQ(ierr);
7362   PetscFunctionReturn(0);
7363 }
7364 
7365 /*MC
7366     MatDenseGetArrayF90 - Accesses a matrix array from Fortran90.
7367 
7368     Synopsis:
7369     MatDenseGetArrayF90(Mat x,{Scalar, pointer :: xx_v(:,:)},integer ierr)
7370 
7371     Not collective
7372 
7373     Input Parameter:
7374 .   x - matrix
7375 
7376     Output Parameters:
7377 +   xx_v - the Fortran90 pointer to the array
7378 -   ierr - error code
7379 
7380     Example of Usage:
7381 .vb
7382       PetscScalar, pointer xx_v(:,:)
7383       ....
7384       call MatDenseGetArrayF90(x,xx_v,ierr)
7385       a = xx_v(3)
7386       call MatDenseRestoreArrayF90(x,xx_v,ierr)
7387 .ve
7388 
7389     Level: advanced
7390 
7391 .seealso:  MatDenseRestoreArrayF90(), MatDenseGetArray(), MatDenseRestoreArray(), MatSeqAIJGetArrayF90()
7392 
7393     Concepts: matrices^accessing array
7394 
7395 M*/
7396 
7397 /*MC
7398     MatDenseRestoreArrayF90 - Restores a matrix array that has been
7399     accessed with MatDenseGetArrayF90().
7400 
7401     Synopsis:
7402     MatDenseRestoreArrayF90(Mat x,{Scalar, pointer :: xx_v(:)},integer ierr)
7403 
7404     Not collective
7405 
7406     Input Parameters:
7407 +   x - matrix
7408 -   xx_v - the Fortran90 pointer to the array
7409 
7410     Output Parameter:
7411 .   ierr - error code
7412 
7413     Example of Usage:
7414 .vb
7415        PetscScalar, pointer xx_v(:)
7416        ....
7417        call MatDenseGetArrayF90(x,xx_v,ierr)
7418        a = xx_v(3)
7419        call MatDenseRestoreArrayF90(x,xx_v,ierr)
7420 .ve
7421 
7422     Level: advanced
7423 
7424 .seealso:  MatDenseGetArrayF90(), MatDenseGetArray(), MatDenseRestoreArray(), MatSeqAIJRestoreArrayF90()
7425 
7426 M*/
7427 
7428 
7429 /*MC
7430     MatSeqAIJGetArrayF90 - Accesses a matrix array from Fortran90.
7431 
7432     Synopsis:
7433     MatSeqAIJGetArrayF90(Mat x,{Scalar, pointer :: xx_v(:,:)},integer ierr)
7434 
7435     Not collective
7436 
7437     Input Parameter:
7438 .   x - matrix
7439 
7440     Output Parameters:
7441 +   xx_v - the Fortran90 pointer to the array
7442 -   ierr - error code
7443 
7444     Example of Usage:
7445 .vb
7446       PetscScalar, pointer xx_v(:,:)
7447       ....
7448       call MatSeqAIJGetArrayF90(x,xx_v,ierr)
7449       a = xx_v(3)
7450       call MatSeqAIJRestoreArrayF90(x,xx_v,ierr)
7451 .ve
7452 
7453     Level: advanced
7454 
7455 .seealso:  MatSeqAIJRestoreArrayF90(), MatSeqAIJGetArray(), MatSeqAIJRestoreArray(), MatDenseGetArrayF90()
7456 
7457     Concepts: matrices^accessing array
7458 
7459 M*/
7460 
7461 /*MC
7462     MatSeqAIJRestoreArrayF90 - Restores a matrix array that has been
7463     accessed with MatSeqAIJGetArrayF90().
7464 
7465     Synopsis:
7466     MatSeqAIJRestoreArrayF90(Mat x,{Scalar, pointer :: xx_v(:)},integer ierr)
7467 
7468     Not collective
7469 
7470     Input Parameters:
7471 +   x - matrix
7472 -   xx_v - the Fortran90 pointer to the array
7473 
7474     Output Parameter:
7475 .   ierr - error code
7476 
7477     Example of Usage:
7478 .vb
7479        PetscScalar, pointer xx_v(:)
7480        ....
7481        call MatSeqAIJGetArrayF90(x,xx_v,ierr)
7482        a = xx_v(3)
7483        call MatSeqAIJRestoreArrayF90(x,xx_v,ierr)
7484 .ve
7485 
7486     Level: advanced
7487 
7488 .seealso:  MatSeqAIJGetArrayF90(), MatSeqAIJGetArray(), MatSeqAIJRestoreArray(), MatDenseRestoreArrayF90()
7489 
7490 M*/
7491 
7492 
7493 #undef __FUNCT__
7494 #define __FUNCT__ "MatGetSubMatrix"
7495 /*@
7496     MatGetSubMatrix - Gets a single submatrix on the same number of processors
7497                       as the original matrix.
7498 
7499     Collective on Mat
7500 
7501     Input Parameters:
7502 +   mat - the original matrix
7503 .   isrow - parallel IS containing the rows this processor should obtain
7504 .   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.
7505 -   cll - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
7506 
7507     Output Parameter:
7508 .   newmat - the new submatrix, of the same type as the old
7509 
7510     Level: advanced
7511 
7512     Notes:
7513     The submatrix will be able to be multiplied with vectors using the same layout as iscol.
7514 
7515     Some matrix types place restrictions on the row and column indices, such
7516     as that they be sorted or that they be equal to each other.
7517 
7518     The index sets may not have duplicate entries.
7519 
7520       The first time this is called you should use a cll of MAT_INITIAL_MATRIX,
7521    the MatGetSubMatrix() routine will create the newmat for you. Any additional calls
7522    to this routine with a mat of the same nonzero structure and with a call of MAT_REUSE_MATRIX
7523    will reuse the matrix generated the first time.  You should call MatDestroy() on newmat when
7524    you are finished using it.
7525 
7526     The communicator of the newly obtained matrix is ALWAYS the same as the communicator of
7527     the input matrix.
7528 
7529     If iscol is NULL then all columns are obtained (not supported in Fortran).
7530 
7531    Example usage:
7532    Consider the following 8x8 matrix with 34 non-zero values, that is
7533    assembled across 3 processors. Let's assume that proc0 owns 3 rows,
7534    proc1 owns 3 rows, proc2 owns 2 rows. This division can be shown
7535    as follows:
7536 
7537 .vb
7538             1  2  0  |  0  3  0  |  0  4
7539     Proc0   0  5  6  |  7  0  0  |  8  0
7540             9  0 10  | 11  0  0  | 12  0
7541     -------------------------------------
7542            13  0 14  | 15 16 17  |  0  0
7543     Proc1   0 18  0  | 19 20 21  |  0  0
7544             0  0  0  | 22 23  0  | 24  0
7545     -------------------------------------
7546     Proc2  25 26 27  |  0  0 28  | 29  0
7547            30  0  0  | 31 32 33  |  0 34
7548 .ve
7549 
7550     Suppose isrow = [0 1 | 4 | 6 7] and iscol = [1 2 | 3 4 5 | 6].  The resulting submatrix is
7551 
7552 .vb
7553             2  0  |  0  3  0  |  0
7554     Proc0   5  6  |  7  0  0  |  8
7555     -------------------------------
7556     Proc1  18  0  | 19 20 21  |  0
7557     -------------------------------
7558     Proc2  26 27  |  0  0 28  | 29
7559             0  0  | 31 32 33  |  0
7560 .ve
7561 
7562 
7563     Concepts: matrices^submatrices
7564 
7565 .seealso: MatGetSubMatrices()
7566 @*/
7567 PetscErrorCode  MatGetSubMatrix(Mat mat,IS isrow,IS iscol,MatReuse cll,Mat *newmat)
7568 {
7569   PetscErrorCode ierr;
7570   PetscMPIInt    size;
7571   Mat            *local;
7572   IS             iscoltmp;
7573 
7574   PetscFunctionBegin;
7575   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
7576   PetscValidHeaderSpecific(isrow,IS_CLASSID,2);
7577   if (iscol) PetscValidHeaderSpecific(iscol,IS_CLASSID,3);
7578   PetscValidPointer(newmat,5);
7579   if (cll == MAT_REUSE_MATRIX) PetscValidHeaderSpecific(*newmat,MAT_CLASSID,5);
7580   PetscValidType(mat,1);
7581   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
7582   if (cll == MAT_IGNORE_MATRIX) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Cannot use MAT_IGNORE_MATRIX");
7583 
7584   MatCheckPreallocated(mat,1);
7585   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)mat),&size);CHKERRQ(ierr);
7586 
7587   if (!iscol || isrow == iscol) {
7588     PetscBool   stride;
7589     PetscMPIInt grabentirematrix = 0,grab;
7590     ierr = PetscObjectTypeCompare((PetscObject)isrow,ISSTRIDE,&stride);CHKERRQ(ierr);
7591     if (stride) {
7592       PetscInt first,step,n,rstart,rend;
7593       ierr = ISStrideGetInfo(isrow,&first,&step);CHKERRQ(ierr);
7594       if (step == 1) {
7595         ierr = MatGetOwnershipRange(mat,&rstart,&rend);CHKERRQ(ierr);
7596         if (rstart == first) {
7597           ierr = ISGetLocalSize(isrow,&n);CHKERRQ(ierr);
7598           if (n == rend-rstart) {
7599             grabentirematrix = 1;
7600           }
7601         }
7602       }
7603     }
7604     ierr = MPI_Allreduce(&grabentirematrix,&grab,1,MPI_INT,MPI_MIN,PetscObjectComm((PetscObject)mat));CHKERRQ(ierr);
7605     if (grab) {
7606       ierr = PetscInfo(mat,"Getting entire matrix as submatrix\n");CHKERRQ(ierr);
7607       if (cll == MAT_INITIAL_MATRIX) {
7608         *newmat = mat;
7609         ierr    = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr);
7610       }
7611       PetscFunctionReturn(0);
7612     }
7613   }
7614 
7615   if (!iscol) {
7616     ierr = ISCreateStride(PetscObjectComm((PetscObject)mat),mat->cmap->n,mat->cmap->rstart,1,&iscoltmp);CHKERRQ(ierr);
7617   } else {
7618     iscoltmp = iscol;
7619   }
7620 
7621   /* if original matrix is on just one processor then use submatrix generated */
7622   if (mat->ops->getsubmatrices && !mat->ops->getsubmatrix && size == 1 && cll == MAT_REUSE_MATRIX) {
7623     ierr = MatGetSubMatrices(mat,1,&isrow,&iscoltmp,MAT_REUSE_MATRIX,&newmat);CHKERRQ(ierr);
7624     if (!iscol) {ierr = ISDestroy(&iscoltmp);CHKERRQ(ierr);}
7625     PetscFunctionReturn(0);
7626   } else if (mat->ops->getsubmatrices && !mat->ops->getsubmatrix && size == 1) {
7627     ierr    = MatGetSubMatrices(mat,1,&isrow,&iscoltmp,MAT_INITIAL_MATRIX,&local);CHKERRQ(ierr);
7628     *newmat = *local;
7629     ierr    = PetscFree(local);CHKERRQ(ierr);
7630     if (!iscol) {ierr = ISDestroy(&iscoltmp);CHKERRQ(ierr);}
7631     PetscFunctionReturn(0);
7632   } else if (!mat->ops->getsubmatrix) {
7633     /* Create a new matrix type that implements the operation using the full matrix */
7634     ierr = PetscLogEventBegin(MAT_GetSubMatrix,mat,0,0,0);CHKERRQ(ierr);
7635     switch (cll) {
7636     case MAT_INITIAL_MATRIX:
7637       ierr = MatCreateSubMatrix(mat,isrow,iscoltmp,newmat);CHKERRQ(ierr);
7638       break;
7639     case MAT_REUSE_MATRIX:
7640       ierr = MatSubMatrixUpdate(*newmat,mat,isrow,iscoltmp);CHKERRQ(ierr);
7641       break;
7642     default: SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"Invalid MatReuse, must be either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX");
7643     }
7644     ierr = PetscLogEventEnd(MAT_GetSubMatrix,mat,0,0,0);CHKERRQ(ierr);
7645     if (!iscol) {ierr = ISDestroy(&iscoltmp);CHKERRQ(ierr);}
7646     PetscFunctionReturn(0);
7647   }
7648 
7649   if (!mat->ops->getsubmatrix) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
7650   ierr = PetscLogEventBegin(MAT_GetSubMatrix,mat,0,0,0);CHKERRQ(ierr);
7651   ierr = (*mat->ops->getsubmatrix)(mat,isrow,iscoltmp,cll,newmat);CHKERRQ(ierr);
7652   ierr = PetscLogEventEnd(MAT_GetSubMatrix,mat,0,0,0);CHKERRQ(ierr);
7653   if (!iscol) {ierr = ISDestroy(&iscoltmp);CHKERRQ(ierr);}
7654   if (*newmat && cll == MAT_INITIAL_MATRIX) {ierr = PetscObjectStateIncrease((PetscObject)*newmat);CHKERRQ(ierr);}
7655   PetscFunctionReturn(0);
7656 }
7657 
7658 #undef __FUNCT__
7659 #define __FUNCT__ "MatStashSetInitialSize"
7660 /*@
7661    MatStashSetInitialSize - sets the sizes of the matrix stash, that is
7662    used during the assembly process to store values that belong to
7663    other processors.
7664 
7665    Not Collective
7666 
7667    Input Parameters:
7668 +  mat   - the matrix
7669 .  size  - the initial size of the stash.
7670 -  bsize - the initial size of the block-stash(if used).
7671 
7672    Options Database Keys:
7673 +   -matstash_initial_size <size> or <size0,size1,...sizep-1>
7674 -   -matstash_block_initial_size <bsize>  or <bsize0,bsize1,...bsizep-1>
7675 
7676    Level: intermediate
7677 
7678    Notes:
7679      The block-stash is used for values set with MatSetValuesBlocked() while
7680      the stash is used for values set with MatSetValues()
7681 
7682      Run with the option -info and look for output of the form
7683      MatAssemblyBegin_MPIXXX:Stash has MM entries, uses nn mallocs.
7684      to determine the appropriate value, MM, to use for size and
7685      MatAssemblyBegin_MPIXXX:Block-Stash has BMM entries, uses nn mallocs.
7686      to determine the value, BMM to use for bsize
7687 
7688    Concepts: stash^setting matrix size
7689    Concepts: matrices^stash
7690 
7691 .seealso: MatAssemblyBegin(), MatAssemblyEnd(), Mat, MatStashGetInfo()
7692 
7693 @*/
7694 PetscErrorCode  MatStashSetInitialSize(Mat mat,PetscInt size, PetscInt bsize)
7695 {
7696   PetscErrorCode ierr;
7697 
7698   PetscFunctionBegin;
7699   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
7700   PetscValidType(mat,1);
7701   ierr = MatStashSetInitialSize_Private(&mat->stash,size);CHKERRQ(ierr);
7702   ierr = MatStashSetInitialSize_Private(&mat->bstash,bsize);CHKERRQ(ierr);
7703   PetscFunctionReturn(0);
7704 }
7705 
7706 #undef __FUNCT__
7707 #define __FUNCT__ "MatInterpolateAdd"
7708 /*@
7709    MatInterpolateAdd - w = y + A*x or A'*x depending on the shape of
7710      the matrix
7711 
7712    Neighbor-wise Collective on Mat
7713 
7714    Input Parameters:
7715 +  mat   - the matrix
7716 .  x,y - the vectors
7717 -  w - where the result is stored
7718 
7719    Level: intermediate
7720 
7721    Notes:
7722     w may be the same vector as y.
7723 
7724     This allows one to use either the restriction or interpolation (its transpose)
7725     matrix to do the interpolation
7726 
7727     Concepts: interpolation
7728 
7729 .seealso: MatMultAdd(), MatMultTransposeAdd(), MatRestrict()
7730 
7731 @*/
7732 PetscErrorCode  MatInterpolateAdd(Mat A,Vec x,Vec y,Vec w)
7733 {
7734   PetscErrorCode ierr;
7735   PetscInt       M,N,Ny;
7736 
7737   PetscFunctionBegin;
7738   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
7739   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
7740   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
7741   PetscValidHeaderSpecific(w,VEC_CLASSID,4);
7742   PetscValidType(A,1);
7743   MatCheckPreallocated(A,1);
7744   ierr = MatGetSize(A,&M,&N);CHKERRQ(ierr);
7745   ierr = VecGetSize(y,&Ny);CHKERRQ(ierr);
7746   if (M == Ny) {
7747     ierr = MatMultAdd(A,x,y,w);CHKERRQ(ierr);
7748   } else {
7749     ierr = MatMultTransposeAdd(A,x,y,w);CHKERRQ(ierr);
7750   }
7751   PetscFunctionReturn(0);
7752 }
7753 
7754 #undef __FUNCT__
7755 #define __FUNCT__ "MatInterpolate"
7756 /*@
7757    MatInterpolate - y = A*x or A'*x depending on the shape of
7758      the matrix
7759 
7760    Neighbor-wise Collective on Mat
7761 
7762    Input Parameters:
7763 +  mat   - the matrix
7764 -  x,y - the vectors
7765 
7766    Level: intermediate
7767 
7768    Notes:
7769     This allows one to use either the restriction or interpolation (its transpose)
7770     matrix to do the interpolation
7771 
7772    Concepts: matrices^interpolation
7773 
7774 .seealso: MatMultAdd(), MatMultTransposeAdd(), MatRestrict()
7775 
7776 @*/
7777 PetscErrorCode  MatInterpolate(Mat A,Vec x,Vec y)
7778 {
7779   PetscErrorCode ierr;
7780   PetscInt       M,N,Ny;
7781 
7782   PetscFunctionBegin;
7783   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
7784   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
7785   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
7786   PetscValidType(A,1);
7787   MatCheckPreallocated(A,1);
7788   ierr = MatGetSize(A,&M,&N);CHKERRQ(ierr);
7789   ierr = VecGetSize(y,&Ny);CHKERRQ(ierr);
7790   if (M == Ny) {
7791     ierr = MatMult(A,x,y);CHKERRQ(ierr);
7792   } else {
7793     ierr = MatMultTranspose(A,x,y);CHKERRQ(ierr);
7794   }
7795   PetscFunctionReturn(0);
7796 }
7797 
7798 #undef __FUNCT__
7799 #define __FUNCT__ "MatRestrict"
7800 /*@
7801    MatRestrict - y = A*x or A'*x
7802 
7803    Neighbor-wise Collective on Mat
7804 
7805    Input Parameters:
7806 +  mat   - the matrix
7807 -  x,y - the vectors
7808 
7809    Level: intermediate
7810 
7811    Notes:
7812     This allows one to use either the restriction or interpolation (its transpose)
7813     matrix to do the restriction
7814 
7815    Concepts: matrices^restriction
7816 
7817 .seealso: MatMultAdd(), MatMultTransposeAdd(), MatInterpolate()
7818 
7819 @*/
7820 PetscErrorCode  MatRestrict(Mat A,Vec x,Vec y)
7821 {
7822   PetscErrorCode ierr;
7823   PetscInt       M,N,Ny;
7824 
7825   PetscFunctionBegin;
7826   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
7827   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
7828   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
7829   PetscValidType(A,1);
7830   MatCheckPreallocated(A,1);
7831 
7832   ierr = MatGetSize(A,&M,&N);CHKERRQ(ierr);
7833   ierr = VecGetSize(y,&Ny);CHKERRQ(ierr);
7834   if (M == Ny) {
7835     ierr = MatMult(A,x,y);CHKERRQ(ierr);
7836   } else {
7837     ierr = MatMultTranspose(A,x,y);CHKERRQ(ierr);
7838   }
7839   PetscFunctionReturn(0);
7840 }
7841 
7842 #undef __FUNCT__
7843 #define __FUNCT__ "MatGetNullSpace"
7844 /*@
7845    MatGetNullSpace - retrieves the null space to a matrix.
7846 
7847    Logically Collective on Mat and MatNullSpace
7848 
7849    Input Parameters:
7850 +  mat - the matrix
7851 -  nullsp - the null space object
7852 
7853    Level: developer
7854 
7855    Concepts: null space^attaching to matrix
7856 
7857 .seealso: MatCreate(), MatNullSpaceCreate(), MatSetNearNullSpace(), MatSetNullSpace()
7858 @*/
7859 PetscErrorCode MatGetNullSpace(Mat mat, MatNullSpace *nullsp)
7860 {
7861   PetscFunctionBegin;
7862   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
7863   PetscValidType(mat,1);
7864   PetscValidPointer(nullsp,2);
7865   *nullsp = mat->nullsp;
7866   PetscFunctionReturn(0);
7867 }
7868 
7869 #undef __FUNCT__
7870 #define __FUNCT__ "MatSetNullSpace"
7871 /*@
7872    MatSetNullSpace - attaches a null space to a matrix.
7873 
7874    Logically Collective on Mat and MatNullSpace
7875 
7876    Input Parameters:
7877 +  mat - the matrix
7878 -  nullsp - the null space object
7879 
7880    Level: advanced
7881 
7882    Notes:
7883       This null space is used by the linear solvers. Overwrites any previous null space that may have been attached
7884 
7885       For inconsistent singular systems (linear systems where the right hand side is not in the range of the operator) you also likely should
7886       call MatSetTransposeNullSpace(). This allows the linear system to be solved in a least squares sense.
7887 
7888       You can remove the null space by calling this routine with an nullsp of NULL
7889 
7890 
7891       The fundamental theorem of linear algebra (Gilbert Strang, Introduction to Applied Mathematics, page 72) states that
7892    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).
7893    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
7894    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
7895    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).
7896 
7897       Krylov solvers can produce the minimal norm solution to the least squares problem by utilizing MatNullSpaceRemove().
7898 
7899    Concepts: null space^attaching to matrix
7900 
7901 .seealso: MatCreate(), MatNullSpaceCreate(), MatSetNearNullSpace(), MatGetNullSpace(), MatSetTransposeNullSpace(), MatGetTransposeNullSpace(), MatNullSpaceRemove()
7902 @*/
7903 PetscErrorCode  MatSetNullSpace(Mat mat,MatNullSpace nullsp)
7904 {
7905   PetscErrorCode ierr;
7906 
7907   PetscFunctionBegin;
7908   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
7909   PetscValidType(mat,1);
7910   if (nullsp) PetscValidHeaderSpecific(nullsp,MAT_NULLSPACE_CLASSID,2);
7911   MatCheckPreallocated(mat,1);
7912   if (nullsp) {ierr = PetscObjectReference((PetscObject)nullsp);CHKERRQ(ierr);}
7913   ierr = MatNullSpaceDestroy(&mat->nullsp);CHKERRQ(ierr);
7914   mat->nullsp = nullsp;
7915   PetscFunctionReturn(0);
7916 }
7917 
7918 #undef __FUNCT__
7919 #define __FUNCT__ "MatGetTransposeNullSpace"
7920 /*@
7921    MatGetTransposeNullSpace - retrieves the null space to a matrix.
7922 
7923    Logically Collective on Mat and MatNullSpace
7924 
7925    Input Parameters:
7926 +  mat - the matrix
7927 -  nullsp - the null space object
7928 
7929    Level: developer
7930 
7931    Notes:
7932       This null space is used by solvers. Overwrites any previous null space that may have been attached
7933 
7934    Concepts: null space^attaching to matrix
7935 
7936 .seealso: MatCreate(), MatNullSpaceCreate(), MatSetNearNullSpace()
7937 @*/
7938 PetscErrorCode MatGetTransposeNullSpace(Mat mat, MatNullSpace *nullsp)
7939 {
7940   PetscFunctionBegin;
7941   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
7942   PetscValidType(mat,1);
7943   PetscValidPointer(nullsp,2);
7944   *nullsp = mat->transnullsp;
7945   PetscFunctionReturn(0);
7946 }
7947 
7948 #undef __FUNCT__
7949 #define __FUNCT__ "MatSetTransposeNullSpace"
7950 /*@
7951    MatSetTransposeNullSpace - attaches a null space to a matrix.
7952 
7953    Logically Collective on Mat and MatNullSpace
7954 
7955    Input Parameters:
7956 +  mat - the matrix
7957 -  nullsp - the null space object
7958 
7959    Level: advanced
7960 
7961    Notes:
7962       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.
7963       You must also call MatSetNullSpace()
7964 
7965 
7966       The fundamental theorem of linear algebra (Gilbert Strang, Introduction to Applied Mathematics, page 72) states that
7967    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).
7968    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
7969    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
7970    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).
7971 
7972       Krylov solvers can produce the minimal norm solution to the least squares problem by utilizing MatNullSpaceRemove().
7973 
7974    Concepts: null space^attaching to matrix
7975 
7976 .seealso: MatCreate(), MatNullSpaceCreate(), MatSetNearNullSpace(), MatGetNullSpace(), MatSetNullSpace(), MatGetNullSpace(), MatNullSpaceRemove()
7977 @*/
7978 PetscErrorCode  MatSetTransposeNullSpace(Mat mat,MatNullSpace nullsp)
7979 {
7980   PetscErrorCode ierr;
7981 
7982   PetscFunctionBegin;
7983   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
7984   PetscValidType(mat,1);
7985   PetscValidHeaderSpecific(nullsp,MAT_NULLSPACE_CLASSID,2);
7986   MatCheckPreallocated(mat,1);
7987   ierr = PetscObjectReference((PetscObject)nullsp);CHKERRQ(ierr);
7988   ierr = MatNullSpaceDestroy(&mat->transnullsp);CHKERRQ(ierr);
7989   mat->transnullsp = nullsp;
7990   PetscFunctionReturn(0);
7991 }
7992 
7993 #undef __FUNCT__
7994 #define __FUNCT__ "MatSetNearNullSpace"
7995 /*@
7996    MatSetNearNullSpace - attaches a null space to a matrix.
7997         This null space will be used to provide near null space vectors to a multigrid preconditioner built from this matrix.
7998 
7999    Logically Collective on Mat and MatNullSpace
8000 
8001    Input Parameters:
8002 +  mat - the matrix
8003 -  nullsp - the null space object
8004 
8005    Level: advanced
8006 
8007    Notes:
8008       Overwrites any previous near null space that may have been attached
8009 
8010       You can remove the null space by calling this routine with an nullsp of NULL
8011 
8012    Concepts: null space^attaching to matrix
8013 
8014 .seealso: MatCreate(), MatNullSpaceCreate(), MatSetNullSpace()
8015 @*/
8016 PetscErrorCode MatSetNearNullSpace(Mat mat,MatNullSpace nullsp)
8017 {
8018   PetscErrorCode ierr;
8019 
8020   PetscFunctionBegin;
8021   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
8022   PetscValidType(mat,1);
8023   if (nullsp) PetscValidHeaderSpecific(nullsp,MAT_NULLSPACE_CLASSID,2);
8024   MatCheckPreallocated(mat,1);
8025   if (nullsp) {ierr = PetscObjectReference((PetscObject)nullsp);CHKERRQ(ierr);}
8026   ierr = MatNullSpaceDestroy(&mat->nearnullsp);CHKERRQ(ierr);
8027   mat->nearnullsp = nullsp;
8028   PetscFunctionReturn(0);
8029 }
8030 
8031 #undef __FUNCT__
8032 #define __FUNCT__ "MatGetNearNullSpace"
8033 /*@
8034    MatGetNearNullSpace -Get null space attached with MatSetNearNullSpace()
8035 
8036    Not Collective
8037 
8038    Input Parameters:
8039 .  mat - the matrix
8040 
8041    Output Parameters:
8042 .  nullsp - the null space object, NULL if not set
8043 
8044    Level: developer
8045 
8046    Concepts: null space^attaching to matrix
8047 
8048 .seealso: MatSetNearNullSpace(), MatGetNullSpace()
8049 @*/
8050 PetscErrorCode MatGetNearNullSpace(Mat mat,MatNullSpace *nullsp)
8051 {
8052   PetscFunctionBegin;
8053   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
8054   PetscValidType(mat,1);
8055   PetscValidPointer(nullsp,2);
8056   MatCheckPreallocated(mat,1);
8057   *nullsp = mat->nearnullsp;
8058   PetscFunctionReturn(0);
8059 }
8060 
8061 #undef __FUNCT__
8062 #define __FUNCT__ "MatICCFactor"
8063 /*@C
8064    MatICCFactor - Performs in-place incomplete Cholesky factorization of matrix.
8065 
8066    Collective on Mat
8067 
8068    Input Parameters:
8069 +  mat - the matrix
8070 .  row - row/column permutation
8071 .  fill - expected fill factor >= 1.0
8072 -  level - level of fill, for ICC(k)
8073 
8074    Notes:
8075    Probably really in-place only when level of fill is zero, otherwise allocates
8076    new space to store factored matrix and deletes previous memory.
8077 
8078    Most users should employ the simplified KSP interface for linear solvers
8079    instead of working directly with matrix algebra routines such as this.
8080    See, e.g., KSPCreate().
8081 
8082    Level: developer
8083 
8084    Concepts: matrices^incomplete Cholesky factorization
8085    Concepts: Cholesky factorization
8086 
8087 .seealso: MatICCFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor()
8088 
8089     Developer Note: fortran interface is not autogenerated as the f90
8090     interface defintion cannot be generated correctly [due to MatFactorInfo]
8091 
8092 @*/
8093 PetscErrorCode  MatICCFactor(Mat mat,IS row,const MatFactorInfo *info)
8094 {
8095   PetscErrorCode ierr;
8096 
8097   PetscFunctionBegin;
8098   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
8099   PetscValidType(mat,1);
8100   if (row) PetscValidHeaderSpecific(row,IS_CLASSID,2);
8101   PetscValidPointer(info,3);
8102   if (mat->rmap->N != mat->cmap->N) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONG,"matrix must be square");
8103   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
8104   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8105   if (!mat->ops->iccfactor) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
8106   MatCheckPreallocated(mat,1);
8107   ierr = (*mat->ops->iccfactor)(mat,row,info);CHKERRQ(ierr);
8108   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
8109   PetscFunctionReturn(0);
8110 }
8111 
8112 #undef __FUNCT__
8113 #define __FUNCT__ "MatSetValuesAdifor"
8114 /*@
8115    MatSetValuesAdifor - Sets values computed with automatic differentiation into a matrix.
8116 
8117    Not Collective
8118 
8119    Input Parameters:
8120 +  mat - the matrix
8121 .  nl - leading dimension of v
8122 -  v - the values compute with ADIFOR
8123 
8124    Level: developer
8125 
8126    Notes:
8127      Must call MatSetColoring() before using this routine. Also this matrix must already
8128      have its nonzero pattern determined.
8129 
8130 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
8131           MatSetValues(), MatSetColoring()
8132 @*/
8133 PetscErrorCode  MatSetValuesAdifor(Mat mat,PetscInt nl,void *v)
8134 {
8135   PetscErrorCode ierr;
8136 
8137   PetscFunctionBegin;
8138   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
8139   PetscValidType(mat,1);
8140   PetscValidPointer(v,3);
8141 
8142   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Matrix must be already assembled");
8143   ierr = PetscLogEventBegin(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
8144   if (!mat->ops->setvaluesadifor) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
8145   ierr = (*mat->ops->setvaluesadifor)(mat,nl,v);CHKERRQ(ierr);
8146   ierr = PetscLogEventEnd(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
8147   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
8148   PetscFunctionReturn(0);
8149 }
8150 
8151 #undef __FUNCT__
8152 #define __FUNCT__ "MatDiagonalScaleLocal"
8153 /*@
8154    MatDiagonalScaleLocal - Scales columns of a matrix given the scaling values including the
8155          ghosted ones.
8156 
8157    Not Collective
8158 
8159    Input Parameters:
8160 +  mat - the matrix
8161 -  diag = the diagonal values, including ghost ones
8162 
8163    Level: developer
8164 
8165    Notes: Works only for MPIAIJ and MPIBAIJ matrices
8166 
8167 .seealso: MatDiagonalScale()
8168 @*/
8169 PetscErrorCode  MatDiagonalScaleLocal(Mat mat,Vec diag)
8170 {
8171   PetscErrorCode ierr;
8172   PetscMPIInt    size;
8173 
8174   PetscFunctionBegin;
8175   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
8176   PetscValidHeaderSpecific(diag,VEC_CLASSID,2);
8177   PetscValidType(mat,1);
8178 
8179   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Matrix must be already assembled");
8180   ierr = PetscLogEventBegin(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
8181   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)mat),&size);CHKERRQ(ierr);
8182   if (size == 1) {
8183     PetscInt n,m;
8184     ierr = VecGetSize(diag,&n);CHKERRQ(ierr);
8185     ierr = MatGetSize(mat,0,&m);CHKERRQ(ierr);
8186     if (m == n) {
8187       ierr = MatDiagonalScale(mat,0,diag);CHKERRQ(ierr);
8188     } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Only supported for sequential matrices when no ghost points/periodic conditions");
8189   } else {
8190     ierr = PetscUseMethod(mat,"MatDiagonalScaleLocal_C",(Mat,Vec),(mat,diag));CHKERRQ(ierr);
8191   }
8192   ierr = PetscLogEventEnd(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
8193   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
8194   PetscFunctionReturn(0);
8195 }
8196 
8197 #undef __FUNCT__
8198 #define __FUNCT__ "MatGetInertia"
8199 /*@
8200    MatGetInertia - Gets the inertia from a factored matrix
8201 
8202    Collective on Mat
8203 
8204    Input Parameter:
8205 .  mat - the matrix
8206 
8207    Output Parameters:
8208 +   nneg - number of negative eigenvalues
8209 .   nzero - number of zero eigenvalues
8210 -   npos - number of positive eigenvalues
8211 
8212    Level: advanced
8213 
8214    Notes: Matrix must have been factored by MatCholeskyFactor()
8215 
8216 
8217 @*/
8218 PetscErrorCode  MatGetInertia(Mat mat,PetscInt *nneg,PetscInt *nzero,PetscInt *npos)
8219 {
8220   PetscErrorCode ierr;
8221 
8222   PetscFunctionBegin;
8223   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
8224   PetscValidType(mat,1);
8225   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
8226   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Numeric factor mat is not assembled");
8227   if (!mat->ops->getinertia) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
8228   ierr = (*mat->ops->getinertia)(mat,nneg,nzero,npos);CHKERRQ(ierr);
8229   PetscFunctionReturn(0);
8230 }
8231 
8232 /* ----------------------------------------------------------------*/
8233 #undef __FUNCT__
8234 #define __FUNCT__ "MatSolves"
8235 /*@C
8236    MatSolves - Solves A x = b, given a factored matrix, for a collection of vectors
8237 
8238    Neighbor-wise Collective on Mat and Vecs
8239 
8240    Input Parameters:
8241 +  mat - the factored matrix
8242 -  b - the right-hand-side vectors
8243 
8244    Output Parameter:
8245 .  x - the result vectors
8246 
8247    Notes:
8248    The vectors b and x cannot be the same.  I.e., one cannot
8249    call MatSolves(A,x,x).
8250 
8251    Notes:
8252    Most users should employ the simplified KSP interface for linear solvers
8253    instead of working directly with matrix algebra routines such as this.
8254    See, e.g., KSPCreate().
8255 
8256    Level: developer
8257 
8258    Concepts: matrices^triangular solves
8259 
8260 .seealso: MatSolveAdd(), MatSolveTranspose(), MatSolveTransposeAdd(), MatSolve()
8261 @*/
8262 PetscErrorCode  MatSolves(Mat mat,Vecs b,Vecs x)
8263 {
8264   PetscErrorCode ierr;
8265 
8266   PetscFunctionBegin;
8267   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
8268   PetscValidType(mat,1);
8269   if (x == b) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_IDN,"x and b must be different vectors");
8270   if (!mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
8271   if (!mat->rmap->N && !mat->cmap->N) PetscFunctionReturn(0);
8272 
8273   if (!mat->ops->solves) SETERRQ1(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
8274   MatCheckPreallocated(mat,1);
8275   ierr = PetscLogEventBegin(MAT_Solves,mat,0,0,0);CHKERRQ(ierr);
8276   ierr = (*mat->ops->solves)(mat,b,x);CHKERRQ(ierr);
8277   ierr = PetscLogEventEnd(MAT_Solves,mat,0,0,0);CHKERRQ(ierr);
8278   PetscFunctionReturn(0);
8279 }
8280 
8281 #undef __FUNCT__
8282 #define __FUNCT__ "MatIsSymmetric"
8283 /*@
8284    MatIsSymmetric - Test whether a matrix is symmetric
8285 
8286    Collective on Mat
8287 
8288    Input Parameter:
8289 +  A - the matrix to test
8290 -  tol - difference between value and its transpose less than this amount counts as equal (use 0.0 for exact transpose)
8291 
8292    Output Parameters:
8293 .  flg - the result
8294 
8295    Notes: For real numbers MatIsSymmetric() and MatIsHermitian() return identical results
8296 
8297    Level: intermediate
8298 
8299    Concepts: matrix^symmetry
8300 
8301 .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetricKnown()
8302 @*/
8303 PetscErrorCode  MatIsSymmetric(Mat A,PetscReal tol,PetscBool  *flg)
8304 {
8305   PetscErrorCode ierr;
8306 
8307   PetscFunctionBegin;
8308   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
8309   PetscValidPointer(flg,2);
8310 
8311   if (!A->symmetric_set) {
8312     if (!A->ops->issymmetric) {
8313       MatType mattype;
8314       ierr = MatGetType(A,&mattype);CHKERRQ(ierr);
8315       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Matrix of type <%s> does not support checking for symmetric",mattype);
8316     }
8317     ierr = (*A->ops->issymmetric)(A,tol,flg);CHKERRQ(ierr);
8318     if (!tol) {
8319       A->symmetric_set = PETSC_TRUE;
8320       A->symmetric     = *flg;
8321       if (A->symmetric) {
8322         A->structurally_symmetric_set = PETSC_TRUE;
8323         A->structurally_symmetric     = PETSC_TRUE;
8324       }
8325     }
8326   } else if (A->symmetric) {
8327     *flg = PETSC_TRUE;
8328   } else if (!tol) {
8329     *flg = PETSC_FALSE;
8330   } else {
8331     if (!A->ops->issymmetric) {
8332       MatType mattype;
8333       ierr = MatGetType(A,&mattype);CHKERRQ(ierr);
8334       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Matrix of type <%s> does not support checking for symmetric",mattype);
8335     }
8336     ierr = (*A->ops->issymmetric)(A,tol,flg);CHKERRQ(ierr);
8337   }
8338   PetscFunctionReturn(0);
8339 }
8340 
8341 #undef __FUNCT__
8342 #define __FUNCT__ "MatIsHermitian"
8343 /*@
8344    MatIsHermitian - Test whether a matrix is Hermitian
8345 
8346    Collective on Mat
8347 
8348    Input Parameter:
8349 +  A - the matrix to test
8350 -  tol - difference between value and its transpose less than this amount counts as equal (use 0.0 for exact Hermitian)
8351 
8352    Output Parameters:
8353 .  flg - the result
8354 
8355    Level: intermediate
8356 
8357    Concepts: matrix^symmetry
8358 
8359 .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(),
8360           MatIsSymmetricKnown(), MatIsSymmetric()
8361 @*/
8362 PetscErrorCode  MatIsHermitian(Mat A,PetscReal tol,PetscBool  *flg)
8363 {
8364   PetscErrorCode ierr;
8365 
8366   PetscFunctionBegin;
8367   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
8368   PetscValidPointer(flg,2);
8369 
8370   if (!A->hermitian_set) {
8371     if (!A->ops->ishermitian) {
8372       MatType mattype;
8373       ierr = MatGetType(A,&mattype);CHKERRQ(ierr);
8374       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Matrix of type <%s> does not support checking for hermitian",mattype);
8375     }
8376     ierr = (*A->ops->ishermitian)(A,tol,flg);CHKERRQ(ierr);
8377     if (!tol) {
8378       A->hermitian_set = PETSC_TRUE;
8379       A->hermitian     = *flg;
8380       if (A->hermitian) {
8381         A->structurally_symmetric_set = PETSC_TRUE;
8382         A->structurally_symmetric     = PETSC_TRUE;
8383       }
8384     }
8385   } else if (A->hermitian) {
8386     *flg = PETSC_TRUE;
8387   } else if (!tol) {
8388     *flg = PETSC_FALSE;
8389   } else {
8390     if (!A->ops->ishermitian) {
8391       MatType mattype;
8392       ierr = MatGetType(A,&mattype);CHKERRQ(ierr);
8393       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Matrix of type <%s> does not support checking for hermitian",mattype);
8394     }
8395     ierr = (*A->ops->ishermitian)(A,tol,flg);CHKERRQ(ierr);
8396   }
8397   PetscFunctionReturn(0);
8398 }
8399 
8400 #undef __FUNCT__
8401 #define __FUNCT__ "MatIsSymmetricKnown"
8402 /*@
8403    MatIsSymmetricKnown - Checks the flag on the matrix to see if it is symmetric.
8404 
8405    Not Collective
8406 
8407    Input Parameter:
8408 .  A - the matrix to check
8409 
8410    Output Parameters:
8411 +  set - if the symmetric flag is set (this tells you if the next flag is valid)
8412 -  flg - the result
8413 
8414    Level: advanced
8415 
8416    Concepts: matrix^symmetry
8417 
8418    Note: Does not check the matrix values directly, so this may return unknown (set = PETSC_FALSE). Use MatIsSymmetric()
8419          if you want it explicitly checked
8420 
8421 .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetric()
8422 @*/
8423 PetscErrorCode  MatIsSymmetricKnown(Mat A,PetscBool  *set,PetscBool  *flg)
8424 {
8425   PetscFunctionBegin;
8426   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
8427   PetscValidPointer(set,2);
8428   PetscValidPointer(flg,3);
8429   if (A->symmetric_set) {
8430     *set = PETSC_TRUE;
8431     *flg = A->symmetric;
8432   } else {
8433     *set = PETSC_FALSE;
8434   }
8435   PetscFunctionReturn(0);
8436 }
8437 
8438 #undef __FUNCT__
8439 #define __FUNCT__ "MatIsHermitianKnown"
8440 /*@
8441    MatIsHermitianKnown - Checks the flag on the matrix to see if it is hermitian.
8442 
8443    Not Collective
8444 
8445    Input Parameter:
8446 .  A - the matrix to check
8447 
8448    Output Parameters:
8449 +  set - if the hermitian flag is set (this tells you if the next flag is valid)
8450 -  flg - the result
8451 
8452    Level: advanced
8453 
8454    Concepts: matrix^symmetry
8455 
8456    Note: Does not check the matrix values directly, so this may return unknown (set = PETSC_FALSE). Use MatIsHermitian()
8457          if you want it explicitly checked
8458 
8459 .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetric()
8460 @*/
8461 PetscErrorCode  MatIsHermitianKnown(Mat A,PetscBool  *set,PetscBool  *flg)
8462 {
8463   PetscFunctionBegin;
8464   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
8465   PetscValidPointer(set,2);
8466   PetscValidPointer(flg,3);
8467   if (A->hermitian_set) {
8468     *set = PETSC_TRUE;
8469     *flg = A->hermitian;
8470   } else {
8471     *set = PETSC_FALSE;
8472   }
8473   PetscFunctionReturn(0);
8474 }
8475 
8476 #undef __FUNCT__
8477 #define __FUNCT__ "MatIsStructurallySymmetric"
8478 /*@
8479    MatIsStructurallySymmetric - Test whether a matrix is structurally symmetric
8480 
8481    Collective on Mat
8482 
8483    Input Parameter:
8484 .  A - the matrix to test
8485 
8486    Output Parameters:
8487 .  flg - the result
8488 
8489    Level: intermediate
8490 
8491    Concepts: matrix^symmetry
8492 
8493 .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsSymmetric(), MatSetOption()
8494 @*/
8495 PetscErrorCode  MatIsStructurallySymmetric(Mat A,PetscBool  *flg)
8496 {
8497   PetscErrorCode ierr;
8498 
8499   PetscFunctionBegin;
8500   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
8501   PetscValidPointer(flg,2);
8502   if (!A->structurally_symmetric_set) {
8503     if (!A->ops->isstructurallysymmetric) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Matrix does not support checking for structural symmetric");
8504     ierr = (*A->ops->isstructurallysymmetric)(A,&A->structurally_symmetric);CHKERRQ(ierr);
8505 
8506     A->structurally_symmetric_set = PETSC_TRUE;
8507   }
8508   *flg = A->structurally_symmetric;
8509   PetscFunctionReturn(0);
8510 }
8511 
8512 #undef __FUNCT__
8513 #define __FUNCT__ "MatStashGetInfo"
8514 extern PetscErrorCode MatStashGetInfo_Private(MatStash*,PetscInt*,PetscInt*);
8515 /*@
8516    MatStashGetInfo - Gets how many values are currently in the matrix stash, i.e. need
8517        to be communicated to other processors during the MatAssemblyBegin/End() process
8518 
8519     Not collective
8520 
8521    Input Parameter:
8522 .   vec - the vector
8523 
8524    Output Parameters:
8525 +   nstash   - the size of the stash
8526 .   reallocs - the number of additional mallocs incurred.
8527 .   bnstash   - the size of the block stash
8528 -   breallocs - the number of additional mallocs incurred.in the block stash
8529 
8530    Level: advanced
8531 
8532 .seealso: MatAssemblyBegin(), MatAssemblyEnd(), Mat, MatStashSetInitialSize()
8533 
8534 @*/
8535 PetscErrorCode  MatStashGetInfo(Mat mat,PetscInt *nstash,PetscInt *reallocs,PetscInt *bnstash,PetscInt *breallocs)
8536 {
8537   PetscErrorCode ierr;
8538 
8539   PetscFunctionBegin;
8540   ierr = MatStashGetInfo_Private(&mat->stash,nstash,reallocs);CHKERRQ(ierr);
8541   ierr = MatStashGetInfo_Private(&mat->bstash,bnstash,breallocs);CHKERRQ(ierr);
8542   PetscFunctionReturn(0);
8543 }
8544 
8545 #undef __FUNCT__
8546 #define __FUNCT__ "MatCreateVecs"
8547 /*@C
8548    MatCreateVecs - Get vector(s) compatible with the matrix, i.e. with the same
8549      parallel layout
8550 
8551    Collective on Mat
8552 
8553    Input Parameter:
8554 .  mat - the matrix
8555 
8556    Output Parameter:
8557 +   right - (optional) vector that the matrix can be multiplied against
8558 -   left - (optional) vector that the matrix vector product can be stored in
8559 
8560    Notes:
8561     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().
8562 
8563   Notes: These are new vectors which are not owned by the Mat, they should be destroyed in VecDestroy() when no longer needed
8564 
8565   Level: advanced
8566 
8567 .seealso: MatCreate(), VecDestroy()
8568 @*/
8569 PetscErrorCode  MatCreateVecs(Mat mat,Vec *right,Vec *left)
8570 {
8571   PetscErrorCode ierr;
8572 
8573   PetscFunctionBegin;
8574   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
8575   PetscValidType(mat,1);
8576   if (mat->ops->getvecs) {
8577     ierr = (*mat->ops->getvecs)(mat,right,left);CHKERRQ(ierr);
8578   } else {
8579     PetscInt rbs,cbs;
8580     ierr = MatGetBlockSizes(mat,&rbs,&cbs);CHKERRQ(ierr);
8581     if (right) {
8582       if (mat->cmap->n < 0) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"PetscLayout for columns not yet setup");
8583       ierr = VecCreate(PetscObjectComm((PetscObject)mat),right);CHKERRQ(ierr);
8584       ierr = VecSetSizes(*right,mat->cmap->n,PETSC_DETERMINE);CHKERRQ(ierr);
8585       ierr = VecSetBlockSize(*right,cbs);CHKERRQ(ierr);
8586       ierr = VecSetType(*right,VECSTANDARD);CHKERRQ(ierr);
8587       ierr = PetscLayoutReference(mat->cmap,&(*right)->map);CHKERRQ(ierr);
8588     }
8589     if (left) {
8590       if (mat->rmap->n < 0) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"PetscLayout for rows not yet setup");
8591       ierr = VecCreate(PetscObjectComm((PetscObject)mat),left);CHKERRQ(ierr);
8592       ierr = VecSetSizes(*left,mat->rmap->n,PETSC_DETERMINE);CHKERRQ(ierr);
8593       ierr = VecSetBlockSize(*left,rbs);CHKERRQ(ierr);
8594       ierr = VecSetType(*left,VECSTANDARD);CHKERRQ(ierr);
8595       ierr = PetscLayoutReference(mat->rmap,&(*left)->map);CHKERRQ(ierr);
8596     }
8597   }
8598   PetscFunctionReturn(0);
8599 }
8600 
8601 #undef __FUNCT__
8602 #define __FUNCT__ "MatFactorInfoInitialize"
8603 /*@C
8604    MatFactorInfoInitialize - Initializes a MatFactorInfo data structure
8605      with default values.
8606 
8607    Not Collective
8608 
8609    Input Parameters:
8610 .    info - the MatFactorInfo data structure
8611 
8612 
8613    Notes: The solvers are generally used through the KSP and PC objects, for example
8614           PCLU, PCILU, PCCHOLESKY, PCICC
8615 
8616    Level: developer
8617 
8618 .seealso: MatFactorInfo
8619 
8620     Developer Note: fortran interface is not autogenerated as the f90
8621     interface defintion cannot be generated correctly [due to MatFactorInfo]
8622 
8623 @*/
8624 
8625 PetscErrorCode  MatFactorInfoInitialize(MatFactorInfo *info)
8626 {
8627   PetscErrorCode ierr;
8628 
8629   PetscFunctionBegin;
8630   ierr = PetscMemzero(info,sizeof(MatFactorInfo));CHKERRQ(ierr);
8631   PetscFunctionReturn(0);
8632 }
8633 
8634 #undef __FUNCT__
8635 #define __FUNCT__ "MatPtAP"
8636 /*@
8637    MatPtAP - Creates the matrix product C = P^T * A * P
8638 
8639    Neighbor-wise Collective on Mat
8640 
8641    Input Parameters:
8642 +  A - the matrix
8643 .  P - the projection matrix
8644 .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
8645 -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(P))
8646 
8647    Output Parameters:
8648 .  C - the product matrix
8649 
8650    Notes:
8651    C will be created and must be destroyed by the user with MatDestroy().
8652 
8653    This routine is currently only implemented for pairs of AIJ matrices and classes
8654    which inherit from AIJ.
8655 
8656    Level: intermediate
8657 
8658 .seealso: MatPtAPSymbolic(), MatPtAPNumeric(), MatMatMult(), MatRARt()
8659 @*/
8660 PetscErrorCode  MatPtAP(Mat A,Mat P,MatReuse scall,PetscReal fill,Mat *C)
8661 {
8662   PetscErrorCode ierr;
8663   PetscErrorCode (*fA)(Mat,Mat,MatReuse,PetscReal,Mat*);
8664   PetscErrorCode (*fP)(Mat,Mat,MatReuse,PetscReal,Mat*);
8665   PetscErrorCode (*ptap)(Mat,Mat,MatReuse,PetscReal,Mat*)=NULL;
8666   PetscBool      viatranspose=PETSC_FALSE,viamatmatmatmult=PETSC_FALSE;
8667 
8668   PetscFunctionBegin;
8669   ierr = PetscOptionsGetBool(((PetscObject)A)->prefix,"-matptap_viatranspose",&viatranspose,NULL);CHKERRQ(ierr);
8670   ierr = PetscOptionsGetBool(((PetscObject)A)->prefix,"-matptap_viamatmatmatmult",&viamatmatmatmult,NULL);CHKERRQ(ierr);
8671 
8672   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
8673   PetscValidType(A,1);
8674   MatCheckPreallocated(A,1);
8675   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
8676   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8677   PetscValidHeaderSpecific(P,MAT_CLASSID,2);
8678   PetscValidType(P,2);
8679   MatCheckPreallocated(P,2);
8680   if (!P->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
8681   if (P->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8682 
8683   if (P->rmap->N!=A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->rmap->N,A->cmap->N);
8684   if (fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Expected fill=%g must be >= 1.0",(double)fill);
8685 
8686   if (scall == MAT_REUSE_MATRIX) {
8687     PetscValidPointer(*C,5);
8688     PetscValidHeaderSpecific(*C,MAT_CLASSID,5);
8689     if (viatranspose || viamatmatmatmult) {
8690       Mat Pt;
8691       ierr = MatTranspose(P,MAT_INITIAL_MATRIX,&Pt);CHKERRQ(ierr);
8692       if (viamatmatmatmult) {
8693         ierr = MatMatMatMult(Pt,A,P,scall,fill,C);CHKERRQ(ierr);
8694       } else {
8695         Mat AP;
8696         ierr = MatMatMult(A,P,MAT_INITIAL_MATRIX,fill,&AP);CHKERRQ(ierr);
8697         ierr = MatMatMult(Pt,AP,scall,fill,C);CHKERRQ(ierr);
8698         ierr = MatDestroy(&AP);CHKERRQ(ierr);
8699       }
8700       ierr = MatDestroy(&Pt);CHKERRQ(ierr);
8701     } else {
8702       ierr = PetscLogEventBegin(MAT_PtAP,A,P,0,0);CHKERRQ(ierr);
8703       ierr = PetscLogEventBegin(MAT_PtAPNumeric,A,P,0,0);CHKERRQ(ierr);
8704       ierr = (*(*C)->ops->ptapnumeric)(A,P,*C);CHKERRQ(ierr);
8705       ierr = PetscLogEventEnd(MAT_PtAPNumeric,A,P,0,0);CHKERRQ(ierr);
8706       ierr = PetscLogEventEnd(MAT_PtAP,A,P,0,0);CHKERRQ(ierr);
8707     }
8708     PetscFunctionReturn(0);
8709   }
8710 
8711   if (fill == PETSC_DEFAULT || fill == PETSC_DECIDE) fill = 2.0;
8712   if (fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Expected fill=%g must be >= 1.0",(double)fill);
8713 
8714   fA = A->ops->ptap;
8715   fP = P->ops->ptap;
8716   if (fP == fA) {
8717     if (!fA) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"MatPtAP not supported for A of type %s",((PetscObject)A)->type_name);
8718     ptap = fA;
8719   } else {
8720     /* dispatch based on the type of A and P from their PetscObject's PetscFunctionLists. */
8721     char ptapname[256];
8722     ierr = PetscStrcpy(ptapname,"MatPtAP_");CHKERRQ(ierr);
8723     ierr = PetscStrcat(ptapname,((PetscObject)A)->type_name);CHKERRQ(ierr);
8724     ierr = PetscStrcat(ptapname,"_");CHKERRQ(ierr);
8725     ierr = PetscStrcat(ptapname,((PetscObject)P)->type_name);CHKERRQ(ierr);
8726     ierr = PetscStrcat(ptapname,"_C");CHKERRQ(ierr); /* e.g., ptapname = "MatPtAP_seqdense_seqaij_C" */
8727     ierr = PetscObjectQueryFunction((PetscObject)P,ptapname,&ptap);CHKERRQ(ierr);
8728     if (!ptap) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_INCOMP,"MatPtAP requires A, %s, to be compatible with P, %s",((PetscObject)A)->type_name,((PetscObject)P)->type_name);
8729   }
8730 
8731   if (viatranspose || viamatmatmatmult) {
8732     Mat Pt;
8733     ierr = MatTranspose(P,MAT_INITIAL_MATRIX,&Pt);CHKERRQ(ierr);
8734     if (viamatmatmatmult) {
8735       ierr = MatMatMatMult(Pt,A,P,scall,fill,C);CHKERRQ(ierr);
8736       ierr = PetscInfo(*C,"MatPtAP via MatMatMatMult\n");CHKERRQ(ierr);
8737     } else {
8738       Mat AP;
8739       ierr = MatMatMult(A,P,MAT_INITIAL_MATRIX,fill,&AP);CHKERRQ(ierr);
8740       ierr = MatMatMult(Pt,AP,scall,fill,C);CHKERRQ(ierr);
8741       ierr = MatDestroy(&AP);CHKERRQ(ierr);
8742       ierr = PetscInfo(*C,"MatPtAP via MatTranspose and MatMatMult\n");CHKERRQ(ierr);
8743     }
8744     ierr = MatDestroy(&Pt);CHKERRQ(ierr);
8745   } else {
8746     ierr = PetscLogEventBegin(MAT_PtAP,A,P,0,0);CHKERRQ(ierr);
8747     ierr = (*ptap)(A,P,scall,fill,C);CHKERRQ(ierr);
8748     ierr = PetscLogEventEnd(MAT_PtAP,A,P,0,0);CHKERRQ(ierr);
8749   }
8750   PetscFunctionReturn(0);
8751 }
8752 
8753 #undef __FUNCT__
8754 #define __FUNCT__ "MatPtAPNumeric"
8755 /*@
8756    MatPtAPNumeric - Computes the matrix product C = P^T * A * P
8757 
8758    Neighbor-wise Collective on Mat
8759 
8760    Input Parameters:
8761 +  A - the matrix
8762 -  P - the projection matrix
8763 
8764    Output Parameters:
8765 .  C - the product matrix
8766 
8767    Notes:
8768    C must have been created by calling MatPtAPSymbolic and must be destroyed by
8769    the user using MatDeatroy().
8770 
8771    This routine is currently only implemented for pairs of AIJ matrices and classes
8772    which inherit from AIJ.  C will be of type MATAIJ.
8773 
8774    Level: intermediate
8775 
8776 .seealso: MatPtAP(), MatPtAPSymbolic(), MatMatMultNumeric()
8777 @*/
8778 PetscErrorCode  MatPtAPNumeric(Mat A,Mat P,Mat C)
8779 {
8780   PetscErrorCode ierr;
8781 
8782   PetscFunctionBegin;
8783   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
8784   PetscValidType(A,1);
8785   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
8786   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8787   PetscValidHeaderSpecific(P,MAT_CLASSID,2);
8788   PetscValidType(P,2);
8789   MatCheckPreallocated(P,2);
8790   if (!P->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
8791   if (P->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8792   PetscValidHeaderSpecific(C,MAT_CLASSID,3);
8793   PetscValidType(C,3);
8794   MatCheckPreallocated(C,3);
8795   if (C->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8796   if (P->cmap->N!=C->rmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->cmap->N,C->rmap->N);
8797   if (P->rmap->N!=A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->rmap->N,A->cmap->N);
8798   if (A->rmap->N!=A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix 'A' must be square, %D != %D",A->rmap->N,A->cmap->N);
8799   if (P->cmap->N!=C->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->cmap->N,C->cmap->N);
8800   MatCheckPreallocated(A,1);
8801 
8802   ierr = PetscLogEventBegin(MAT_PtAPNumeric,A,P,0,0);CHKERRQ(ierr);
8803   ierr = (*C->ops->ptapnumeric)(A,P,C);CHKERRQ(ierr);
8804   ierr = PetscLogEventEnd(MAT_PtAPNumeric,A,P,0,0);CHKERRQ(ierr);
8805   PetscFunctionReturn(0);
8806 }
8807 
8808 #undef __FUNCT__
8809 #define __FUNCT__ "MatPtAPSymbolic"
8810 /*@
8811    MatPtAPSymbolic - Creates the (i,j) structure of the matrix product C = P^T * A * P
8812 
8813    Neighbor-wise Collective on Mat
8814 
8815    Input Parameters:
8816 +  A - the matrix
8817 -  P - the projection matrix
8818 
8819    Output Parameters:
8820 .  C - the (i,j) structure of the product matrix
8821 
8822    Notes:
8823    C will be created and must be destroyed by the user with MatDestroy().
8824 
8825    This routine is currently only implemented for pairs of SeqAIJ matrices and classes
8826    which inherit from SeqAIJ.  C will be of type MATSEQAIJ.  The product is computed using
8827    this (i,j) structure by calling MatPtAPNumeric().
8828 
8829    Level: intermediate
8830 
8831 .seealso: MatPtAP(), MatPtAPNumeric(), MatMatMultSymbolic()
8832 @*/
8833 PetscErrorCode  MatPtAPSymbolic(Mat A,Mat P,PetscReal fill,Mat *C)
8834 {
8835   PetscErrorCode ierr;
8836 
8837   PetscFunctionBegin;
8838   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
8839   PetscValidType(A,1);
8840   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
8841   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8842   if (fill <1.0) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Expected fill=%g must be >= 1.0",(double)fill);
8843   PetscValidHeaderSpecific(P,MAT_CLASSID,2);
8844   PetscValidType(P,2);
8845   MatCheckPreallocated(P,2);
8846   if (!P->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
8847   if (P->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8848   PetscValidPointer(C,3);
8849 
8850   if (P->rmap->N!=A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->rmap->N,A->cmap->N);
8851   if (A->rmap->N!=A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix 'A' must be square, %D != %D",A->rmap->N,A->cmap->N);
8852   MatCheckPreallocated(A,1);
8853   ierr = PetscLogEventBegin(MAT_PtAPSymbolic,A,P,0,0);CHKERRQ(ierr);
8854   ierr = (*A->ops->ptapsymbolic)(A,P,fill,C);CHKERRQ(ierr);
8855   ierr = PetscLogEventEnd(MAT_PtAPSymbolic,A,P,0,0);CHKERRQ(ierr);
8856 
8857   /* ierr = MatSetBlockSize(*C,A->rmap->bs);CHKERRQ(ierr); NO! this is not always true -ma */
8858   PetscFunctionReturn(0);
8859 }
8860 
8861 #undef __FUNCT__
8862 #define __FUNCT__ "MatRARt"
8863 /*@
8864    MatRARt - Creates the matrix product C = R * A * R^T
8865 
8866    Neighbor-wise Collective on Mat
8867 
8868    Input Parameters:
8869 +  A - the matrix
8870 .  R - the projection matrix
8871 .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
8872 -  fill - expected fill as ratio of nnz(C)/nnz(A)
8873 
8874    Output Parameters:
8875 .  C - the product matrix
8876 
8877    Notes:
8878    C will be created and must be destroyed by the user with MatDestroy().
8879 
8880    This routine is currently only implemented for pairs of AIJ matrices and classes
8881    which inherit from AIJ.
8882 
8883    Level: intermediate
8884 
8885 .seealso: MatRARtSymbolic(), MatRARtNumeric(), MatMatMult(), MatPtAP()
8886 @*/
8887 PetscErrorCode  MatRARt(Mat A,Mat R,MatReuse scall,PetscReal fill,Mat *C)
8888 {
8889   PetscErrorCode ierr;
8890 
8891   PetscFunctionBegin;
8892   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
8893   PetscValidType(A,1);
8894   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
8895   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8896   PetscValidHeaderSpecific(R,MAT_CLASSID,2);
8897   PetscValidType(R,2);
8898   MatCheckPreallocated(R,2);
8899   if (!R->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
8900   if (R->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8901   PetscValidPointer(C,3);
8902   if (R->cmap->N!=A->rmap->N) SETERRQ2(PetscObjectComm((PetscObject)R),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",R->cmap->N,A->rmap->N);
8903   if (fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Expected fill=%g must be >= 1.0",(double)fill);
8904   MatCheckPreallocated(A,1);
8905 
8906   if (!A->ops->rart) {
8907     MatType mattype;
8908     ierr = MatGetType(A,&mattype);CHKERRQ(ierr);
8909     SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Matrix of type <%s> does not support RARt",mattype);
8910   }
8911   ierr = PetscLogEventBegin(MAT_RARt,A,R,0,0);CHKERRQ(ierr);
8912   ierr = (*A->ops->rart)(A,R,scall,fill,C);CHKERRQ(ierr);
8913   ierr = PetscLogEventEnd(MAT_RARt,A,R,0,0);CHKERRQ(ierr);
8914   PetscFunctionReturn(0);
8915 }
8916 
8917 #undef __FUNCT__
8918 #define __FUNCT__ "MatRARtNumeric"
8919 /*@
8920    MatRARtNumeric - Computes the matrix product C = R * A * R^T
8921 
8922    Neighbor-wise Collective on Mat
8923 
8924    Input Parameters:
8925 +  A - the matrix
8926 -  R - the projection matrix
8927 
8928    Output Parameters:
8929 .  C - the product matrix
8930 
8931    Notes:
8932    C must have been created by calling MatRARtSymbolic and must be destroyed by
8933    the user using MatDeatroy().
8934 
8935    This routine is currently only implemented for pairs of AIJ matrices and classes
8936    which inherit from AIJ.  C will be of type MATAIJ.
8937 
8938    Level: intermediate
8939 
8940 .seealso: MatRARt(), MatRARtSymbolic(), MatMatMultNumeric()
8941 @*/
8942 PetscErrorCode  MatRARtNumeric(Mat A,Mat R,Mat C)
8943 {
8944   PetscErrorCode ierr;
8945 
8946   PetscFunctionBegin;
8947   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
8948   PetscValidType(A,1);
8949   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
8950   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8951   PetscValidHeaderSpecific(R,MAT_CLASSID,2);
8952   PetscValidType(R,2);
8953   MatCheckPreallocated(R,2);
8954   if (!R->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
8955   if (R->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8956   PetscValidHeaderSpecific(C,MAT_CLASSID,3);
8957   PetscValidType(C,3);
8958   MatCheckPreallocated(C,3);
8959   if (C->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
8960   if (R->rmap->N!=C->rmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",R->rmap->N,C->rmap->N);
8961   if (R->cmap->N!=A->rmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",R->cmap->N,A->rmap->N);
8962   if (A->rmap->N!=A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix 'A' must be square, %D != %D",A->rmap->N,A->cmap->N);
8963   if (R->rmap->N!=C->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",R->rmap->N,C->cmap->N);
8964   MatCheckPreallocated(A,1);
8965 
8966   ierr = PetscLogEventBegin(MAT_RARtNumeric,A,R,0,0);CHKERRQ(ierr);
8967   ierr = (*A->ops->rartnumeric)(A,R,C);CHKERRQ(ierr);
8968   ierr = PetscLogEventEnd(MAT_RARtNumeric,A,R,0,0);CHKERRQ(ierr);
8969   PetscFunctionReturn(0);
8970 }
8971 
8972 #undef __FUNCT__
8973 #define __FUNCT__ "MatRARtSymbolic"
8974 /*@
8975    MatRARtSymbolic - Creates the (i,j) structure of the matrix product C = R * A * R^T
8976 
8977    Neighbor-wise Collective on Mat
8978 
8979    Input Parameters:
8980 +  A - the matrix
8981 -  R - the projection matrix
8982 
8983    Output Parameters:
8984 .  C - the (i,j) structure of the product matrix
8985 
8986    Notes:
8987    C will be created and must be destroyed by the user with MatDestroy().
8988 
8989    This routine is currently only implemented for pairs of SeqAIJ matrices and classes
8990    which inherit from SeqAIJ.  C will be of type MATSEQAIJ.  The product is computed using
8991    this (i,j) structure by calling MatRARtNumeric().
8992 
8993    Level: intermediate
8994 
8995 .seealso: MatRARt(), MatRARtNumeric(), MatMatMultSymbolic()
8996 @*/
8997 PetscErrorCode  MatRARtSymbolic(Mat A,Mat R,PetscReal fill,Mat *C)
8998 {
8999   PetscErrorCode ierr;
9000 
9001   PetscFunctionBegin;
9002   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
9003   PetscValidType(A,1);
9004   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9005   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9006   if (fill <1.0) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Expected fill=%g must be >= 1.0",(double)fill);
9007   PetscValidHeaderSpecific(R,MAT_CLASSID,2);
9008   PetscValidType(R,2);
9009   MatCheckPreallocated(R,2);
9010   if (!R->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9011   if (R->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9012   PetscValidPointer(C,3);
9013 
9014   if (R->cmap->N!=A->rmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",R->cmap->N,A->rmap->N);
9015   if (A->rmap->N!=A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix 'A' must be square, %D != %D",A->rmap->N,A->cmap->N);
9016   MatCheckPreallocated(A,1);
9017   ierr = PetscLogEventBegin(MAT_RARtSymbolic,A,R,0,0);CHKERRQ(ierr);
9018   ierr = (*A->ops->rartsymbolic)(A,R,fill,C);CHKERRQ(ierr);
9019   ierr = PetscLogEventEnd(MAT_RARtSymbolic,A,R,0,0);CHKERRQ(ierr);
9020 
9021   ierr = MatSetBlockSizes(*C,PetscAbs(R->rmap->bs),PetscAbs(R->rmap->bs));CHKERRQ(ierr);
9022   PetscFunctionReturn(0);
9023 }
9024 
9025 #undef __FUNCT__
9026 #define __FUNCT__ "MatMatMult"
9027 /*@
9028    MatMatMult - Performs Matrix-Matrix Multiplication C=A*B.
9029 
9030    Neighbor-wise Collective on Mat
9031 
9032    Input Parameters:
9033 +  A - the left matrix
9034 .  B - the right matrix
9035 .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
9036 -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(B)), use PETSC_DEFAULT if you do not have a good estimate
9037           if the result is a dense matrix this is irrelevent
9038 
9039    Output Parameters:
9040 .  C - the product matrix
9041 
9042    Notes:
9043    Unless scall is MAT_REUSE_MATRIX C will be created.
9044 
9045    MAT_REUSE_MATRIX can only be used if the matrices A and B have the same nonzero pattern as in the previous call
9046 
9047    To determine the correct fill value, run with -info and search for the string "Fill ratio" to see the value
9048    actually needed.
9049 
9050    If you have many matrices with the same non-zero structure to multiply, you
9051    should either
9052 $   1) use MAT_REUSE_MATRIX in all calls but the first or
9053 $   2) call MatMatMultSymbolic() once and then MatMatMultNumeric() for each product needed
9054    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
9055    with MAT_REUSE_MATRIX, rather than first having MatMatMult() create it for you. You can NEVER do this if the matrix C is sparse.
9056 
9057    Level: intermediate
9058 
9059 .seealso: MatMatMultSymbolic(), MatMatMultNumeric(), MatTransposeMatMult(),  MatMatTransposeMult(), MatPtAP()
9060 @*/
9061 PetscErrorCode  MatMatMult(Mat A,Mat B,MatReuse scall,PetscReal fill,Mat *C)
9062 {
9063   PetscErrorCode ierr;
9064   PetscErrorCode (*fA)(Mat,Mat,MatReuse,PetscReal,Mat*);
9065   PetscErrorCode (*fB)(Mat,Mat,MatReuse,PetscReal,Mat*);
9066   PetscErrorCode (*mult)(Mat,Mat,MatReuse,PetscReal,Mat*)=NULL;
9067 
9068   PetscFunctionBegin;
9069   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
9070   PetscValidType(A,1);
9071   MatCheckPreallocated(A,1);
9072   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9073   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9074   PetscValidHeaderSpecific(B,MAT_CLASSID,2);
9075   PetscValidType(B,2);
9076   MatCheckPreallocated(B,2);
9077   if (!B->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9078   if (B->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9079   PetscValidPointer(C,3);
9080   if (B->rmap->N!=A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",B->rmap->N,A->cmap->N);
9081   if (scall == MAT_REUSE_MATRIX) {
9082     PetscValidPointer(*C,5);
9083     PetscValidHeaderSpecific(*C,MAT_CLASSID,5);
9084     ierr = PetscLogEventBegin(MAT_MatMult,A,B,0,0);CHKERRQ(ierr);
9085     ierr = PetscLogEventBegin(MAT_MatMultNumeric,A,B,0,0);CHKERRQ(ierr);
9086     ierr = (*(*C)->ops->matmultnumeric)(A,B,*C);CHKERRQ(ierr);
9087     ierr = PetscLogEventEnd(MAT_MatMultNumeric,A,B,0,0);CHKERRQ(ierr);
9088     ierr = PetscLogEventEnd(MAT_MatMult,A,B,0,0);CHKERRQ(ierr);
9089     PetscFunctionReturn(0);
9090   }
9091   if (fill == PETSC_DEFAULT || fill == PETSC_DECIDE) fill = 2.0;
9092   if (fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Expected fill=%g must be >= 1.0",(double)fill);
9093 
9094   fA = A->ops->matmult;
9095   fB = B->ops->matmult;
9096   if (fB == fA) {
9097     if (!fB) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"MatMatMult not supported for B of type %s",((PetscObject)B)->type_name);
9098     mult = fB;
9099   } else {
9100     /* dispatch based on the type of A and B from their PetscObject's PetscFunctionLists. */
9101     char multname[256];
9102     ierr = PetscStrcpy(multname,"MatMatMult_");CHKERRQ(ierr);
9103     ierr = PetscStrcat(multname,((PetscObject)A)->type_name);CHKERRQ(ierr);
9104     ierr = PetscStrcat(multname,"_");CHKERRQ(ierr);
9105     ierr = PetscStrcat(multname,((PetscObject)B)->type_name);CHKERRQ(ierr);
9106     ierr = PetscStrcat(multname,"_C");CHKERRQ(ierr); /* e.g., multname = "MatMatMult_seqdense_seqaij_C" */
9107     ierr = PetscObjectQueryFunction((PetscObject)B,multname,&mult);CHKERRQ(ierr);
9108     if (!mult) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_INCOMP,"MatMatMult requires A, %s, to be compatible with B, %s",((PetscObject)A)->type_name,((PetscObject)B)->type_name);
9109   }
9110   ierr = PetscLogEventBegin(MAT_MatMult,A,B,0,0);CHKERRQ(ierr);
9111   ierr = (*mult)(A,B,scall,fill,C);CHKERRQ(ierr);
9112   ierr = PetscLogEventEnd(MAT_MatMult,A,B,0,0);CHKERRQ(ierr);
9113   PetscFunctionReturn(0);
9114 }
9115 
9116 #undef __FUNCT__
9117 #define __FUNCT__ "MatMatMultSymbolic"
9118 /*@
9119    MatMatMultSymbolic - Performs construction, preallocation, and computes the ij structure
9120    of the matrix-matrix product C=A*B.  Call this routine before calling MatMatMultNumeric().
9121 
9122    Neighbor-wise Collective on Mat
9123 
9124    Input Parameters:
9125 +  A - the left matrix
9126 .  B - the right matrix
9127 -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(B)), use PETSC_DEFAULT if you do not have a good estimate,
9128       if C is a dense matrix this is irrelevent
9129 
9130    Output Parameters:
9131 .  C - the product matrix
9132 
9133    Notes:
9134    Unless scall is MAT_REUSE_MATRIX C will be created.
9135 
9136    To determine the correct fill value, run with -info and search for the string "Fill ratio" to see the value
9137    actually needed.
9138 
9139    This routine is currently implemented for
9140     - pairs of AIJ matrices and classes which inherit from AIJ, C will be of type AIJ
9141     - pairs of AIJ (A) and Dense (B) matrix, C will be of type Dense.
9142     - pairs of Dense (A) and AIJ (B) matrix, C will be of type Dense.
9143 
9144    Level: intermediate
9145 
9146    Developers Note: There are ways to estimate the number of nonzeros in the resulting product, see for example, http://arxiv.org/abs/1006.4173
9147      We should incorporate them into PETSc.
9148 
9149 .seealso: MatMatMult(), MatMatMultNumeric()
9150 @*/
9151 PetscErrorCode  MatMatMultSymbolic(Mat A,Mat B,PetscReal fill,Mat *C)
9152 {
9153   PetscErrorCode ierr;
9154   PetscErrorCode (*Asymbolic)(Mat,Mat,PetscReal,Mat*);
9155   PetscErrorCode (*Bsymbolic)(Mat,Mat,PetscReal,Mat*);
9156   PetscErrorCode (*symbolic)(Mat,Mat,PetscReal,Mat*)=NULL;
9157 
9158   PetscFunctionBegin;
9159   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
9160   PetscValidType(A,1);
9161   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9162   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9163 
9164   PetscValidHeaderSpecific(B,MAT_CLASSID,2);
9165   PetscValidType(B,2);
9166   MatCheckPreallocated(B,2);
9167   if (!B->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9168   if (B->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9169   PetscValidPointer(C,3);
9170 
9171   if (B->rmap->N!=A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",B->rmap->N,A->cmap->N);
9172   if (fill == PETSC_DEFAULT) fill = 2.0;
9173   if (fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Expected fill=%g must be > 1.0",(double)fill);
9174   MatCheckPreallocated(A,1);
9175 
9176   Asymbolic = A->ops->matmultsymbolic;
9177   Bsymbolic = B->ops->matmultsymbolic;
9178   if (Asymbolic == Bsymbolic) {
9179     if (!Bsymbolic) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"C=A*B not implemented for B of type %s",((PetscObject)B)->type_name);
9180     symbolic = Bsymbolic;
9181   } else { /* dispatch based on the type of A and B */
9182     char symbolicname[256];
9183     ierr = PetscStrcpy(symbolicname,"MatMatMultSymbolic_");CHKERRQ(ierr);
9184     ierr = PetscStrcat(symbolicname,((PetscObject)A)->type_name);CHKERRQ(ierr);
9185     ierr = PetscStrcat(symbolicname,"_");CHKERRQ(ierr);
9186     ierr = PetscStrcat(symbolicname,((PetscObject)B)->type_name);CHKERRQ(ierr);
9187     ierr = PetscStrcat(symbolicname,"_C");CHKERRQ(ierr);
9188     ierr = PetscObjectQueryFunction((PetscObject)B,symbolicname,&symbolic);CHKERRQ(ierr);
9189     if (!symbolic) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_INCOMP,"MatMatMultSymbolic requires A, %s, to be compatible with B, %s",((PetscObject)A)->type_name,((PetscObject)B)->type_name);
9190   }
9191   ierr = PetscLogEventBegin(MAT_MatMultSymbolic,A,B,0,0);CHKERRQ(ierr);
9192   ierr = (*symbolic)(A,B,fill,C);CHKERRQ(ierr);
9193   ierr = PetscLogEventEnd(MAT_MatMultSymbolic,A,B,0,0);CHKERRQ(ierr);
9194   PetscFunctionReturn(0);
9195 }
9196 
9197 #undef __FUNCT__
9198 #define __FUNCT__ "MatMatMultNumeric"
9199 /*@
9200    MatMatMultNumeric - Performs the numeric matrix-matrix product.
9201    Call this routine after first calling MatMatMultSymbolic().
9202 
9203    Neighbor-wise Collective on Mat
9204 
9205    Input Parameters:
9206 +  A - the left matrix
9207 -  B - the right matrix
9208 
9209    Output Parameters:
9210 .  C - the product matrix, which was created by from MatMatMultSymbolic() or a call to MatMatMult().
9211 
9212    Notes:
9213    C must have been created with MatMatMultSymbolic().
9214 
9215    This routine is currently implemented for
9216     - pairs of AIJ matrices and classes which inherit from AIJ, C will be of type MATAIJ.
9217     - pairs of AIJ (A) and Dense (B) matrix, C will be of type Dense.
9218     - pairs of Dense (A) and AIJ (B) matrix, C will be of type Dense.
9219 
9220    Level: intermediate
9221 
9222 .seealso: MatMatMult(), MatMatMultSymbolic()
9223 @*/
9224 PetscErrorCode  MatMatMultNumeric(Mat A,Mat B,Mat C)
9225 {
9226   PetscErrorCode ierr;
9227 
9228   PetscFunctionBegin;
9229   ierr = MatMatMult(A,B,MAT_REUSE_MATRIX,0.0,&C);CHKERRQ(ierr);
9230   PetscFunctionReturn(0);
9231 }
9232 
9233 #undef __FUNCT__
9234 #define __FUNCT__ "MatMatTransposeMult"
9235 /*@
9236    MatMatTransposeMult - Performs Matrix-Matrix Multiplication C=A*B^T.
9237 
9238    Neighbor-wise Collective on Mat
9239 
9240    Input Parameters:
9241 +  A - the left matrix
9242 .  B - the right matrix
9243 .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
9244 -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(B)), use PETSC_DEFAULT if not known
9245 
9246    Output Parameters:
9247 .  C - the product matrix
9248 
9249    Notes:
9250    C will be created if MAT_INITIAL_MATRIX and must be destroyed by the user with MatDestroy().
9251 
9252    MAT_REUSE_MATRIX can only be used if the matrices A and B have the same nonzero pattern as in the previous call
9253 
9254   To determine the correct fill value, run with -info and search for the string "Fill ratio" to see the value
9255    actually needed.
9256 
9257    This routine is currently only implemented for pairs of SeqAIJ matrices.  C will be of type MATSEQAIJ.
9258 
9259    Level: intermediate
9260 
9261 .seealso: MatMatTransposeMultSymbolic(), MatMatTransposeMultNumeric(), MatMatMult(), MatTransposeMatMult() MatPtAP()
9262 @*/
9263 PetscErrorCode  MatMatTransposeMult(Mat A,Mat B,MatReuse scall,PetscReal fill,Mat *C)
9264 {
9265   PetscErrorCode ierr;
9266   PetscErrorCode (*fA)(Mat,Mat,MatReuse,PetscReal,Mat*);
9267   PetscErrorCode (*fB)(Mat,Mat,MatReuse,PetscReal,Mat*);
9268 
9269   PetscFunctionBegin;
9270   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
9271   PetscValidType(A,1);
9272   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9273   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9274   PetscValidHeaderSpecific(B,MAT_CLASSID,2);
9275   PetscValidType(B,2);
9276   MatCheckPreallocated(B,2);
9277   if (!B->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9278   if (B->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9279   PetscValidPointer(C,3);
9280   if (B->cmap->N!=A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, AN %D != BN %D",A->cmap->N,B->cmap->N);
9281   if (fill == PETSC_DEFAULT || fill == PETSC_DECIDE) fill = 2.0;
9282   if (fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Expected fill=%g must be > 1.0",(double)fill);
9283   MatCheckPreallocated(A,1);
9284 
9285   fA = A->ops->mattransposemult;
9286   if (!fA) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"MatMatTransposeMult not supported for A of type %s",((PetscObject)A)->type_name);
9287   fB = B->ops->mattransposemult;
9288   if (!fB) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"MatMatTransposeMult not supported for B of type %s",((PetscObject)B)->type_name);
9289   if (fB!=fA) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_INCOMP,"MatMatTransposeMult requires A, %s, to be compatible with B, %s",((PetscObject)A)->type_name,((PetscObject)B)->type_name);
9290 
9291   ierr = PetscLogEventBegin(MAT_MatTransposeMult,A,B,0,0);CHKERRQ(ierr);
9292   if (scall == MAT_INITIAL_MATRIX) {
9293     ierr = PetscLogEventBegin(MAT_MatTransposeMultSymbolic,A,B,0,0);CHKERRQ(ierr);
9294     ierr = (*A->ops->mattransposemultsymbolic)(A,B,fill,C);CHKERRQ(ierr);
9295     ierr = PetscLogEventEnd(MAT_MatTransposeMultSymbolic,A,B,0,0);CHKERRQ(ierr);
9296   }
9297   ierr = PetscLogEventBegin(MAT_MatTransposeMultNumeric,A,B,0,0);CHKERRQ(ierr);
9298   ierr = (*A->ops->mattransposemultnumeric)(A,B,*C);CHKERRQ(ierr);
9299   ierr = PetscLogEventEnd(MAT_MatTransposeMultNumeric,A,B,0,0);CHKERRQ(ierr);
9300   ierr = PetscLogEventEnd(MAT_MatTransposeMult,A,B,0,0);CHKERRQ(ierr);
9301   PetscFunctionReturn(0);
9302 }
9303 
9304 #undef __FUNCT__
9305 #define __FUNCT__ "MatTransposeMatMult"
9306 /*@
9307    MatTransposeMatMult - Performs Matrix-Matrix Multiplication C=A^T*B.
9308 
9309    Neighbor-wise Collective on Mat
9310 
9311    Input Parameters:
9312 +  A - the left matrix
9313 .  B - the right matrix
9314 .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
9315 -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(B)), use PETSC_DEFAULT if not known
9316 
9317    Output Parameters:
9318 .  C - the product matrix
9319 
9320    Notes:
9321    C will be created if MAT_INITIAL_MATRIX and must be destroyed by the user with MatDestroy().
9322 
9323    MAT_REUSE_MATRIX can only be used if the matrices A and B have the same nonzero pattern as in the previous call
9324 
9325   To determine the correct fill value, run with -info and search for the string "Fill ratio" to see the value
9326    actually needed.
9327 
9328    This routine is currently implemented for pairs of AIJ matrices and pairs of SeqDense matrices and classes
9329    which inherit from SeqAIJ.  C will be of same type as the input matrices.
9330 
9331    Level: intermediate
9332 
9333 .seealso: MatTransposeMatMultSymbolic(), MatTransposeMatMultNumeric(), MatMatMult(), MatMatTransposeMult(), MatPtAP()
9334 @*/
9335 PetscErrorCode  MatTransposeMatMult(Mat A,Mat B,MatReuse scall,PetscReal fill,Mat *C)
9336 {
9337   PetscErrorCode ierr;
9338   PetscErrorCode (*fA)(Mat,Mat,MatReuse,PetscReal,Mat*);
9339   PetscErrorCode (*fB)(Mat,Mat,MatReuse,PetscReal,Mat*);
9340   PetscErrorCode (*transposematmult)(Mat,Mat,MatReuse,PetscReal,Mat*) = NULL;
9341 
9342   PetscFunctionBegin;
9343   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
9344   PetscValidType(A,1);
9345   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9346   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9347   PetscValidHeaderSpecific(B,MAT_CLASSID,2);
9348   PetscValidType(B,2);
9349   MatCheckPreallocated(B,2);
9350   if (!B->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9351   if (B->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9352   PetscValidPointer(C,3);
9353   if (B->rmap->N!=A->rmap->N) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",B->rmap->N,A->rmap->N);
9354   if (fill == PETSC_DEFAULT || fill == PETSC_DECIDE) fill = 2.0;
9355   if (fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Expected fill=%g must be > 1.0",(double)fill);
9356   MatCheckPreallocated(A,1);
9357 
9358   fA = A->ops->transposematmult;
9359   fB = B->ops->transposematmult;
9360   if (fB==fA) {
9361     if (!fA) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"MatTransposeMatMult not supported for A of type %s",((PetscObject)A)->type_name);
9362     transposematmult = fA;
9363   } else {
9364     /* dispatch based on the type of A and B from their PetscObject's PetscFunctionLists. */
9365     char multname[256];
9366     ierr = PetscStrcpy(multname,"MatTransposeMatMult_");CHKERRQ(ierr);
9367     ierr = PetscStrcat(multname,((PetscObject)A)->type_name);CHKERRQ(ierr);
9368     ierr = PetscStrcat(multname,"_");CHKERRQ(ierr);
9369     ierr = PetscStrcat(multname,((PetscObject)B)->type_name);CHKERRQ(ierr);
9370     ierr = PetscStrcat(multname,"_C");CHKERRQ(ierr); /* e.g., multname = "MatMatMult_seqdense_seqaij_C" */
9371     ierr = PetscObjectQueryFunction((PetscObject)B,multname,&transposematmult);CHKERRQ(ierr);
9372     if (!transposematmult) SETERRQ2(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_INCOMP,"MatTransposeMatMult requires A, %s, to be compatible with B, %s",((PetscObject)A)->type_name,((PetscObject)B)->type_name);
9373   }
9374   ierr = PetscLogEventBegin(MAT_TransposeMatMult,A,B,0,0);CHKERRQ(ierr);
9375   ierr = (*transposematmult)(A,B,scall,fill,C);CHKERRQ(ierr);
9376   ierr = PetscLogEventEnd(MAT_TransposeMatMult,A,B,0,0);CHKERRQ(ierr);
9377   PetscFunctionReturn(0);
9378 }
9379 
9380 #undef __FUNCT__
9381 #define __FUNCT__ "MatMatMatMult"
9382 /*@
9383    MatMatMatMult - Performs Matrix-Matrix-Matrix Multiplication D=A*B*C.
9384 
9385    Neighbor-wise Collective on Mat
9386 
9387    Input Parameters:
9388 +  A - the left matrix
9389 .  B - the middle matrix
9390 .  C - the right matrix
9391 .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
9392 -  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
9393           if the result is a dense matrix this is irrelevent
9394 
9395    Output Parameters:
9396 .  D - the product matrix
9397 
9398    Notes:
9399    Unless scall is MAT_REUSE_MATRIX D will be created.
9400 
9401    MAT_REUSE_MATRIX can only be used if the matrices A, B and C have the same nonzero pattern as in the previous call
9402 
9403    To determine the correct fill value, run with -info and search for the string "Fill ratio" to see the value
9404    actually needed.
9405 
9406    If you have many matrices with the same non-zero structure to multiply, you
9407    should either
9408 $   1) use MAT_REUSE_MATRIX in all calls but the first or
9409 $   2) call MatMatMatMultSymbolic() once and then MatMatMatMultNumeric() for each product needed
9410 
9411    Level: intermediate
9412 
9413 .seealso: MatMatMult, MatPtAP()
9414 @*/
9415 PetscErrorCode  MatMatMatMult(Mat A,Mat B,Mat C,MatReuse scall,PetscReal fill,Mat *D)
9416 {
9417   PetscErrorCode ierr;
9418   PetscErrorCode (*fA)(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
9419   PetscErrorCode (*fB)(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
9420   PetscErrorCode (*fC)(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
9421   PetscErrorCode (*mult)(Mat,Mat,Mat,MatReuse,PetscReal,Mat*)=NULL;
9422 
9423   PetscFunctionBegin;
9424   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
9425   PetscValidType(A,1);
9426   MatCheckPreallocated(A,1);
9427   if (!A->assembled) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9428   if (A->factortype) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9429   PetscValidHeaderSpecific(B,MAT_CLASSID,2);
9430   PetscValidType(B,2);
9431   MatCheckPreallocated(B,2);
9432   if (!B->assembled) SETERRQ(PetscObjectComm((PetscObject)B),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9433   if (B->factortype) SETERRQ(PetscObjectComm((PetscObject)B),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9434   PetscValidHeaderSpecific(C,MAT_CLASSID,3);
9435   PetscValidPointer(C,3);
9436   MatCheckPreallocated(C,3);
9437   if (!C->assembled) SETERRQ(PetscObjectComm((PetscObject)C),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9438   if (C->factortype) SETERRQ(PetscObjectComm((PetscObject)C),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9439   if (B->rmap->N!=A->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)B),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",B->rmap->N,A->cmap->N);
9440   if (C->rmap->N!=B->cmap->N) SETERRQ2(PetscObjectComm((PetscObject)C),PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",C->rmap->N,B->cmap->N);
9441   if (scall == MAT_REUSE_MATRIX) {
9442     PetscValidPointer(*D,6);
9443     PetscValidHeaderSpecific(*D,MAT_CLASSID,6);
9444     ierr = PetscLogEventBegin(MAT_MatMatMult,A,B,0,0);CHKERRQ(ierr);
9445     ierr = (*(*D)->ops->matmatmult)(A,B,C,scall,fill,D);CHKERRQ(ierr);
9446     ierr = PetscLogEventEnd(MAT_MatMatMult,A,B,0,0);CHKERRQ(ierr);
9447     PetscFunctionReturn(0);
9448   }
9449   if (fill == PETSC_DEFAULT || fill == PETSC_DECIDE) fill = 2.0;
9450   if (fill < 1.0) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_SIZ,"Expected fill=%g must be >= 1.0",(double)fill);
9451 
9452   fA = A->ops->matmatmult;
9453   fB = B->ops->matmatmult;
9454   fC = C->ops->matmatmult;
9455   if (fA == fB && fA == fC) {
9456     if (!fA) SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"MatMatMatMult not supported for A of type %s",((PetscObject)A)->type_name);
9457     mult = fA;
9458   } else {
9459     /* dispatch based on the type of A, B and C from their PetscObject's PetscFunctionLists. */
9460     char multname[256];
9461     ierr = PetscStrcpy(multname,"MatMatMatMult_");CHKERRQ(ierr);
9462     ierr = PetscStrcat(multname,((PetscObject)A)->type_name);CHKERRQ(ierr);
9463     ierr = PetscStrcat(multname,"_");CHKERRQ(ierr);
9464     ierr = PetscStrcat(multname,((PetscObject)B)->type_name);CHKERRQ(ierr);
9465     ierr = PetscStrcat(multname,"_");CHKERRQ(ierr);
9466     ierr = PetscStrcat(multname,((PetscObject)C)->type_name);CHKERRQ(ierr);
9467     ierr = PetscStrcat(multname,"_C");CHKERRQ(ierr);
9468     ierr = PetscObjectQueryFunction((PetscObject)B,multname,&mult);CHKERRQ(ierr);
9469     if (!mult) SETERRQ3(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_INCOMP,"MatMatMatMult requires A, %s, to be compatible with B, %s, C, %s",((PetscObject)A)->type_name,((PetscObject)B)->type_name,((PetscObject)C)->type_name);
9470   }
9471   ierr = PetscLogEventBegin(MAT_MatMatMult,A,B,0,0);CHKERRQ(ierr);
9472   ierr = (*mult)(A,B,C,scall,fill,D);CHKERRQ(ierr);
9473   ierr = PetscLogEventEnd(MAT_MatMatMult,A,B,0,0);CHKERRQ(ierr);
9474   PetscFunctionReturn(0);
9475 }
9476 
9477 #undef __FUNCT__
9478 #define __FUNCT__ "MatCreateRedundantMatrix"
9479 /*@C
9480    MatCreateRedundantMatrix - Create redundant matrices and put them into processors of subcommunicators.
9481 
9482    Collective on Mat
9483 
9484    Input Parameters:
9485 +  mat - the matrix
9486 .  nsubcomm - the number of subcommunicators (= number of redundant parallel or sequential matrices)
9487 .  subcomm - MPI communicator split from the communicator where mat resides in (or MPI_COMM_NULL if nsubcomm is used)
9488 -  reuse - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
9489 
9490    Output Parameter:
9491 .  matredundant - redundant matrix
9492 
9493    Notes:
9494    MAT_REUSE_MATRIX can only be used when the nonzero structure of the
9495    original matrix has not changed from that last call to MatCreateRedundantMatrix().
9496 
9497    This routine creates the duplicated matrices in subcommunicators; you should NOT create them before
9498    calling it.
9499 
9500    Level: advanced
9501 
9502    Concepts: subcommunicator
9503    Concepts: duplicate matrix
9504 
9505 .seealso: MatDestroy()
9506 @*/
9507 PetscErrorCode MatCreateRedundantMatrix(Mat mat,PetscInt nsubcomm,MPI_Comm subcomm,MatReuse reuse,Mat *matredundant)
9508 {
9509   PetscErrorCode ierr;
9510   MPI_Comm       comm;
9511   PetscMPIInt    size;
9512   PetscInt       mloc_sub,rstart,rend,M=mat->rmap->N,N=mat->cmap->N,bs=mat->rmap->bs;
9513   Mat_Redundant  *redund=NULL;
9514   PetscSubcomm   psubcomm=NULL;
9515   MPI_Comm       subcomm_in=subcomm;
9516   Mat            *matseq;
9517   IS             isrow,iscol;
9518   PetscBool      newsubcomm=PETSC_FALSE;
9519 
9520   PetscFunctionBegin;
9521   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)mat),&size);CHKERRQ(ierr);
9522   if (size == 1 || nsubcomm == 1) {
9523     if (reuse == MAT_INITIAL_MATRIX) {
9524       ierr = MatDuplicate(mat,MAT_COPY_VALUES,matredundant);CHKERRQ(ierr);
9525     } else {
9526       ierr = MatCopy(mat,*matredundant,SAME_NONZERO_PATTERN);CHKERRQ(ierr);
9527     }
9528     PetscFunctionReturn(0);
9529   }
9530 
9531   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
9532   if (nsubcomm && reuse == MAT_REUSE_MATRIX) {
9533     PetscValidPointer(*matredundant,5);
9534     PetscValidHeaderSpecific(*matredundant,MAT_CLASSID,5);
9535   }
9536   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9537   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9538   MatCheckPreallocated(mat,1);
9539 
9540   ierr = PetscLogEventBegin(MAT_RedundantMat,mat,0,0,0);CHKERRQ(ierr);
9541   if (subcomm_in == MPI_COMM_NULL && reuse == MAT_INITIAL_MATRIX) { /* get subcomm if user does not provide subcomm */
9542     /* create psubcomm, then get subcomm */
9543     ierr = PetscObjectGetComm((PetscObject)mat,&comm);CHKERRQ(ierr);
9544     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
9545     if (nsubcomm < 1 || nsubcomm > size) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"nsubcomm must between 1 and %D",size);
9546 
9547     ierr = PetscSubcommCreate(comm,&psubcomm);CHKERRQ(ierr);
9548     ierr = PetscSubcommSetNumber(psubcomm,nsubcomm);CHKERRQ(ierr);
9549     ierr = PetscSubcommSetType(psubcomm,PETSC_SUBCOMM_CONTIGUOUS);CHKERRQ(ierr);
9550     ierr = PetscSubcommSetFromOptions(psubcomm);CHKERRQ(ierr);
9551     ierr = PetscCommDuplicate(PetscSubcommChild(psubcomm),&subcomm,NULL);CHKERRQ(ierr);
9552     newsubcomm = PETSC_TRUE;
9553     ierr = PetscSubcommDestroy(&psubcomm);CHKERRQ(ierr);
9554   }
9555 
9556   /* get isrow, iscol and a local sequential matrix matseq[0] */
9557   if (reuse == MAT_INITIAL_MATRIX) {
9558     mloc_sub = PETSC_DECIDE;
9559     if (bs < 1) {
9560       ierr = PetscSplitOwnership(subcomm,&mloc_sub,&M);CHKERRQ(ierr);
9561     } else {
9562       ierr = PetscSplitOwnershipBlock(subcomm,bs,&mloc_sub,&M);CHKERRQ(ierr);
9563     }
9564     ierr = MPI_Scan(&mloc_sub,&rend,1,MPIU_INT,MPI_SUM,subcomm);CHKERRQ(ierr);
9565     rstart = rend - mloc_sub;
9566     ierr = ISCreateStride(PETSC_COMM_SELF,mloc_sub,rstart,1,&isrow);CHKERRQ(ierr);
9567     ierr = ISCreateStride(PETSC_COMM_SELF,N,0,1,&iscol);CHKERRQ(ierr);
9568   } else { /* reuse == MAT_REUSE_MATRIX */
9569     /* retrieve subcomm */
9570     ierr = PetscObjectGetComm((PetscObject)(*matredundant),&subcomm);CHKERRQ(ierr);
9571     redund = (*matredundant)->redundant;
9572     isrow  = redund->isrow;
9573     iscol  = redund->iscol;
9574     matseq = redund->matseq;
9575   }
9576   ierr = MatGetSubMatrices(mat,1,&isrow,&iscol,reuse,&matseq);CHKERRQ(ierr);
9577 
9578   /* get matredundant over subcomm */
9579   if (reuse == MAT_INITIAL_MATRIX) {
9580     ierr = MatCreateMPIMatConcatenateSeqMat(subcomm,matseq[0],mloc_sub,reuse,matredundant);CHKERRQ(ierr);
9581 
9582     /* create a supporting struct and attach it to C for reuse */
9583     ierr = PetscNewLog(*matredundant,&redund);CHKERRQ(ierr);
9584     (*matredundant)->redundant = redund;
9585     redund->isrow              = isrow;
9586     redund->iscol              = iscol;
9587     redund->matseq             = matseq;
9588     if (newsubcomm) {
9589       redund->subcomm          = subcomm;
9590     } else {
9591       redund->subcomm          = MPI_COMM_NULL;
9592     }
9593   } else {
9594     ierr = MatCreateMPIMatConcatenateSeqMat(subcomm,matseq[0],PETSC_DECIDE,reuse,matredundant);CHKERRQ(ierr);
9595   }
9596   ierr = PetscLogEventEnd(MAT_RedundantMat,mat,0,0,0);CHKERRQ(ierr);
9597   PetscFunctionReturn(0);
9598 }
9599 
9600 #undef __FUNCT__
9601 #define __FUNCT__ "MatGetMultiProcBlock"
9602 /*@C
9603    MatGetMultiProcBlock - Create multiple [bjacobi] 'parallel submatrices' from
9604    a given 'mat' object. Each submatrix can span multiple procs.
9605 
9606    Collective on Mat
9607 
9608    Input Parameters:
9609 +  mat - the matrix
9610 .  subcomm - the subcommunicator obtained by com_split(comm)
9611 -  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
9612 
9613    Output Parameter:
9614 .  subMat - 'parallel submatrices each spans a given subcomm
9615 
9616   Notes:
9617   The submatrix partition across processors is dictated by 'subComm' a
9618   communicator obtained by com_split(comm). The comm_split
9619   is not restriced to be grouped with consecutive original ranks.
9620 
9621   Due the comm_split() usage, the parallel layout of the submatrices
9622   map directly to the layout of the original matrix [wrt the local
9623   row,col partitioning]. So the original 'DiagonalMat' naturally maps
9624   into the 'DiagonalMat' of the subMat, hence it is used directly from
9625   the subMat. However the offDiagMat looses some columns - and this is
9626   reconstructed with MatSetValues()
9627 
9628   Level: advanced
9629 
9630   Concepts: subcommunicator
9631   Concepts: submatrices
9632 
9633 .seealso: MatGetSubMatrices()
9634 @*/
9635 PetscErrorCode   MatGetMultiProcBlock(Mat mat, MPI_Comm subComm, MatReuse scall,Mat *subMat)
9636 {
9637   PetscErrorCode ierr;
9638   PetscMPIInt    commsize,subCommSize;
9639 
9640   PetscFunctionBegin;
9641   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)mat),&commsize);CHKERRQ(ierr);
9642   ierr = MPI_Comm_size(subComm,&subCommSize);CHKERRQ(ierr);
9643   if (subCommSize > commsize) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_OUTOFRANGE,"CommSize %D < SubCommZize %D",commsize,subCommSize);
9644 
9645   ierr = PetscLogEventBegin(MAT_GetMultiProcBlock,mat,0,0,0);CHKERRQ(ierr);
9646   ierr = (*mat->ops->getmultiprocblock)(mat,subComm,scall,subMat);CHKERRQ(ierr);
9647   ierr = PetscLogEventEnd(MAT_GetMultiProcBlock,mat,0,0,0);CHKERRQ(ierr);
9648   PetscFunctionReturn(0);
9649 }
9650 
9651 #undef __FUNCT__
9652 #define __FUNCT__ "MatGetLocalSubMatrix"
9653 /*@
9654    MatGetLocalSubMatrix - Gets a reference to a submatrix specified in local numbering
9655 
9656    Not Collective
9657 
9658    Input Arguments:
9659    mat - matrix to extract local submatrix from
9660    isrow - local row indices for submatrix
9661    iscol - local column indices for submatrix
9662 
9663    Output Arguments:
9664    submat - the submatrix
9665 
9666    Level: intermediate
9667 
9668    Notes:
9669    The submat should be returned with MatRestoreLocalSubMatrix().
9670 
9671    Depending on the format of mat, the returned submat may not implement MatMult().  Its communicator may be
9672    the same as mat, it may be PETSC_COMM_SELF, or some other subcomm of mat's.
9673 
9674    The submat always implements MatSetValuesLocal().  If isrow and iscol have the same block size, then
9675    MatSetValuesBlockedLocal() will also be implemented.
9676 
9677 .seealso: MatRestoreLocalSubMatrix(), MatCreateLocalRef()
9678 @*/
9679 PetscErrorCode  MatGetLocalSubMatrix(Mat mat,IS isrow,IS iscol,Mat *submat)
9680 {
9681   PetscErrorCode ierr;
9682 
9683   PetscFunctionBegin;
9684   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
9685   PetscValidHeaderSpecific(isrow,IS_CLASSID,2);
9686   PetscValidHeaderSpecific(iscol,IS_CLASSID,3);
9687   PetscCheckSameComm(isrow,2,iscol,3);
9688   PetscValidPointer(submat,4);
9689 
9690   if (mat->ops->getlocalsubmatrix) {
9691     ierr = (*mat->ops->getlocalsubmatrix)(mat,isrow,iscol,submat);CHKERRQ(ierr);
9692   } else {
9693     ierr = MatCreateLocalRef(mat,isrow,iscol,submat);CHKERRQ(ierr);
9694   }
9695   PetscFunctionReturn(0);
9696 }
9697 
9698 #undef __FUNCT__
9699 #define __FUNCT__ "MatRestoreLocalSubMatrix"
9700 /*@
9701    MatRestoreLocalSubMatrix - Restores a reference to a submatrix specified in local numbering
9702 
9703    Not Collective
9704 
9705    Input Arguments:
9706    mat - matrix to extract local submatrix from
9707    isrow - local row indices for submatrix
9708    iscol - local column indices for submatrix
9709    submat - the submatrix
9710 
9711    Level: intermediate
9712 
9713 .seealso: MatGetLocalSubMatrix()
9714 @*/
9715 PetscErrorCode  MatRestoreLocalSubMatrix(Mat mat,IS isrow,IS iscol,Mat *submat)
9716 {
9717   PetscErrorCode ierr;
9718 
9719   PetscFunctionBegin;
9720   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
9721   PetscValidHeaderSpecific(isrow,IS_CLASSID,2);
9722   PetscValidHeaderSpecific(iscol,IS_CLASSID,3);
9723   PetscCheckSameComm(isrow,2,iscol,3);
9724   PetscValidPointer(submat,4);
9725   if (*submat) {
9726     PetscValidHeaderSpecific(*submat,MAT_CLASSID,4);
9727   }
9728 
9729   if (mat->ops->restorelocalsubmatrix) {
9730     ierr = (*mat->ops->restorelocalsubmatrix)(mat,isrow,iscol,submat);CHKERRQ(ierr);
9731   } else {
9732     ierr = MatDestroy(submat);CHKERRQ(ierr);
9733   }
9734   *submat = NULL;
9735   PetscFunctionReturn(0);
9736 }
9737 
9738 /* --------------------------------------------------------*/
9739 #undef __FUNCT__
9740 #define __FUNCT__ "MatFindZeroDiagonals"
9741 /*@
9742    MatFindZeroDiagonals - Finds all the rows of a matrix that have zero or no entry in the matrix
9743 
9744    Collective on Mat
9745 
9746    Input Parameter:
9747 .  mat - the matrix
9748 
9749    Output Parameter:
9750 .  is - if any rows have zero diagonals this contains the list of them
9751 
9752    Level: developer
9753 
9754    Concepts: matrix-vector product
9755 
9756 .seealso: MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
9757 @*/
9758 PetscErrorCode  MatFindZeroDiagonals(Mat mat,IS *is)
9759 {
9760   PetscErrorCode ierr;
9761 
9762   PetscFunctionBegin;
9763   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
9764   PetscValidType(mat,1);
9765   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9766   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9767 
9768   if (!mat->ops->findzerodiagonals) {
9769     Vec                diag;
9770     const PetscScalar *a;
9771     PetscInt          *rows;
9772     PetscInt           rStart, rEnd, r, nrow = 0;
9773 
9774     ierr = MatCreateVecs(mat, &diag, NULL);CHKERRQ(ierr);
9775     ierr = MatGetDiagonal(mat, diag);CHKERRQ(ierr);
9776     ierr = MatGetOwnershipRange(mat, &rStart, &rEnd);CHKERRQ(ierr);
9777     ierr = VecGetArrayRead(diag, &a);CHKERRQ(ierr);
9778     for (r = 0; r < rEnd-rStart; ++r) if (a[r] == 0.0) ++nrow;
9779     ierr = PetscMalloc1(nrow, &rows);CHKERRQ(ierr);
9780     nrow = 0;
9781     for (r = 0; r < rEnd-rStart; ++r) if (a[r] == 0.0) rows[nrow++] = r+rStart;
9782     ierr = VecRestoreArrayRead(diag, &a);CHKERRQ(ierr);
9783     ierr = VecDestroy(&diag);CHKERRQ(ierr);
9784     ierr = ISCreateGeneral(PetscObjectComm((PetscObject) mat), nrow, rows, PETSC_OWN_POINTER, is);CHKERRQ(ierr);
9785   } else {
9786     ierr = (*mat->ops->findzerodiagonals)(mat, is);CHKERRQ(ierr);
9787   }
9788   PetscFunctionReturn(0);
9789 }
9790 
9791 #undef __FUNCT__
9792 #define __FUNCT__ "MatFindOffBlockDiagonalEntries"
9793 /*@
9794    MatFindOffBlockDiagonalEntries - Finds all the rows of a matrix that have entries outside of the main diagonal block (defined by the matrix block size)
9795 
9796    Collective on Mat
9797 
9798    Input Parameter:
9799 .  mat - the matrix
9800 
9801    Output Parameter:
9802 .  is - contains the list of rows with off block diagonal entries
9803 
9804    Level: developer
9805 
9806    Concepts: matrix-vector product
9807 
9808 .seealso: MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
9809 @*/
9810 PetscErrorCode  MatFindOffBlockDiagonalEntries(Mat mat,IS *is)
9811 {
9812   PetscErrorCode ierr;
9813 
9814   PetscFunctionBegin;
9815   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
9816   PetscValidType(mat,1);
9817   if (!mat->assembled) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9818   if (mat->factortype) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9819 
9820   if (!mat->ops->findoffblockdiagonalentries) SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"This matrix type does not have a find off block diagonal entries defined");
9821   ierr = (*mat->ops->findoffblockdiagonalentries)(mat,is);CHKERRQ(ierr);
9822   PetscFunctionReturn(0);
9823 }
9824 
9825 #undef __FUNCT__
9826 #define __FUNCT__ "MatInvertBlockDiagonal"
9827 /*@C
9828   MatInvertBlockDiagonal - Inverts the block diagonal entries.
9829 
9830   Collective on Mat
9831 
9832   Input Parameters:
9833 . mat - the matrix
9834 
9835   Output Parameters:
9836 . values - the block inverses in column major order (FORTRAN-like)
9837 
9838    Note:
9839    This routine is not available from Fortran.
9840 
9841   Level: advanced
9842 @*/
9843 PetscErrorCode MatInvertBlockDiagonal(Mat mat,const PetscScalar **values)
9844 {
9845   PetscErrorCode ierr;
9846 
9847   PetscFunctionBegin;
9848   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
9849   if (!mat->assembled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
9850   if (mat->factortype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
9851   if (!mat->ops->invertblockdiagonal) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Not supported");
9852   ierr = (*mat->ops->invertblockdiagonal)(mat,values);CHKERRQ(ierr);
9853   PetscFunctionReturn(0);
9854 }
9855 
9856 #undef __FUNCT__
9857 #define __FUNCT__ "MatTransposeColoringDestroy"
9858 /*@C
9859     MatTransposeColoringDestroy - Destroys a coloring context for matrix product C=A*B^T that was created
9860     via MatTransposeColoringCreate().
9861 
9862     Collective on MatTransposeColoring
9863 
9864     Input Parameter:
9865 .   c - coloring context
9866 
9867     Level: intermediate
9868 
9869 .seealso: MatTransposeColoringCreate()
9870 @*/
9871 PetscErrorCode  MatTransposeColoringDestroy(MatTransposeColoring *c)
9872 {
9873   PetscErrorCode       ierr;
9874   MatTransposeColoring matcolor=*c;
9875 
9876   PetscFunctionBegin;
9877   if (!matcolor) PetscFunctionReturn(0);
9878   if (--((PetscObject)matcolor)->refct > 0) {matcolor = 0; PetscFunctionReturn(0);}
9879 
9880   ierr = PetscFree3(matcolor->ncolumns,matcolor->nrows,matcolor->colorforrow);CHKERRQ(ierr);
9881   ierr = PetscFree(matcolor->rows);CHKERRQ(ierr);
9882   ierr = PetscFree(matcolor->den2sp);CHKERRQ(ierr);
9883   ierr = PetscFree(matcolor->colorforcol);CHKERRQ(ierr);
9884   ierr = PetscFree(matcolor->columns);CHKERRQ(ierr);
9885   if (matcolor->brows>0) {
9886     ierr = PetscFree(matcolor->lstart);CHKERRQ(ierr);
9887   }
9888   ierr = PetscHeaderDestroy(c);CHKERRQ(ierr);
9889   PetscFunctionReturn(0);
9890 }
9891 
9892 #undef __FUNCT__
9893 #define __FUNCT__ "MatTransColoringApplySpToDen"
9894 /*@C
9895     MatTransColoringApplySpToDen - Given a symbolic matrix product C=A*B^T for which
9896     a MatTransposeColoring context has been created, computes a dense B^T by Apply
9897     MatTransposeColoring to sparse B.
9898 
9899     Collective on MatTransposeColoring
9900 
9901     Input Parameters:
9902 +   B - sparse matrix B
9903 .   Btdense - symbolic dense matrix B^T
9904 -   coloring - coloring context created with MatTransposeColoringCreate()
9905 
9906     Output Parameter:
9907 .   Btdense - dense matrix B^T
9908 
9909     Options Database Keys:
9910 +    -mat_transpose_coloring_view - Activates basic viewing or coloring
9911 .    -mat_transpose_coloring_view_draw - Activates drawing of coloring
9912 -    -mat_transpose_coloring_view_info - Activates viewing of coloring info
9913 
9914     Level: intermediate
9915 
9916 .seealso: MatTransposeColoringCreate(), MatTransposeColoringDestroy()
9917 
9918 .keywords: coloring
9919 @*/
9920 PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring coloring,Mat B,Mat Btdense)
9921 {
9922   PetscErrorCode ierr;
9923 
9924   PetscFunctionBegin;
9925   PetscValidHeaderSpecific(B,MAT_CLASSID,1);
9926   PetscValidHeaderSpecific(Btdense,MAT_CLASSID,2);
9927   PetscValidHeaderSpecific(coloring,MAT_TRANSPOSECOLORING_CLASSID,3);
9928 
9929   if (!B->ops->transcoloringapplysptoden) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Not supported for this matrix type %s",((PetscObject)B)->type_name);
9930   ierr = (B->ops->transcoloringapplysptoden)(coloring,B,Btdense);CHKERRQ(ierr);
9931   PetscFunctionReturn(0);
9932 }
9933 
9934 #undef __FUNCT__
9935 #define __FUNCT__ "MatTransColoringApplyDenToSp"
9936 /*@C
9937     MatTransColoringApplyDenToSp - Given a symbolic matrix product Csp=A*B^T for which
9938     a MatTransposeColoring context has been created and a dense matrix Cden=A*Btdense
9939     in which Btdens is obtained from MatTransColoringApplySpToDen(), recover sparse matrix
9940     Csp from Cden.
9941 
9942     Collective on MatTransposeColoring
9943 
9944     Input Parameters:
9945 +   coloring - coloring context created with MatTransposeColoringCreate()
9946 -   Cden - matrix product of a sparse matrix and a dense matrix Btdense
9947 
9948     Output Parameter:
9949 .   Csp - sparse matrix
9950 
9951     Options Database Keys:
9952 +    -mat_multtranspose_coloring_view - Activates basic viewing or coloring
9953 .    -mat_multtranspose_coloring_view_draw - Activates drawing of coloring
9954 -    -mat_multtranspose_coloring_view_info - Activates viewing of coloring info
9955 
9956     Level: intermediate
9957 
9958 .seealso: MatTransposeColoringCreate(), MatTransposeColoringDestroy(), MatTransColoringApplySpToDen()
9959 
9960 .keywords: coloring
9961 @*/
9962 PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring matcoloring,Mat Cden,Mat Csp)
9963 {
9964   PetscErrorCode ierr;
9965 
9966   PetscFunctionBegin;
9967   PetscValidHeaderSpecific(matcoloring,MAT_TRANSPOSECOLORING_CLASSID,1);
9968   PetscValidHeaderSpecific(Cden,MAT_CLASSID,2);
9969   PetscValidHeaderSpecific(Csp,MAT_CLASSID,3);
9970 
9971   if (!Csp->ops->transcoloringapplydentosp) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Not supported for this matrix type %s",((PetscObject)Csp)->type_name);
9972   ierr = (Csp->ops->transcoloringapplydentosp)(matcoloring,Cden,Csp);CHKERRQ(ierr);
9973   PetscFunctionReturn(0);
9974 }
9975 
9976 #undef __FUNCT__
9977 #define __FUNCT__ "MatTransposeColoringCreate"
9978 /*@C
9979    MatTransposeColoringCreate - Creates a matrix coloring context for matrix product C=A*B^T.
9980 
9981    Collective on Mat
9982 
9983    Input Parameters:
9984 +  mat - the matrix product C
9985 -  iscoloring - the coloring of the matrix; usually obtained with MatColoringCreate() or DMCreateColoring()
9986 
9987     Output Parameter:
9988 .   color - the new coloring context
9989 
9990     Level: intermediate
9991 
9992 .seealso: MatTransposeColoringDestroy(), MatTransposeColoringSetFromOptions(), MatTransColoringApplySpToDen(),
9993            MatTransColoringApplyDenToSp(), MatTransposeColoringView(),
9994 @*/
9995 PetscErrorCode  MatTransposeColoringCreate(Mat mat,ISColoring iscoloring,MatTransposeColoring *color)
9996 {
9997   MatTransposeColoring c;
9998   MPI_Comm             comm;
9999   PetscErrorCode       ierr;
10000 
10001   PetscFunctionBegin;
10002   ierr = PetscLogEventBegin(MAT_TransposeColoringCreate,mat,0,0,0);CHKERRQ(ierr);
10003   ierr = PetscObjectGetComm((PetscObject)mat,&comm);CHKERRQ(ierr);
10004   ierr = PetscHeaderCreate(c,MAT_TRANSPOSECOLORING_CLASSID,"MatTransposeColoring","Matrix product C=A*B^T via coloring","Mat",comm,MatTransposeColoringDestroy,NULL);CHKERRQ(ierr);
10005 
10006   c->ctype = iscoloring->ctype;
10007   if (mat->ops->transposecoloringcreate) {
10008     ierr = (*mat->ops->transposecoloringcreate)(mat,iscoloring,c);CHKERRQ(ierr);
10009   } else SETERRQ(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Code not yet written for this matrix type");
10010 
10011   *color = c;
10012   ierr   = PetscLogEventEnd(MAT_TransposeColoringCreate,mat,0,0,0);CHKERRQ(ierr);
10013   PetscFunctionReturn(0);
10014 }
10015 
10016 #undef __FUNCT__
10017 #define __FUNCT__ "MatGetNonzeroState"
10018 /*@
10019       MatGetNonzeroState - Returns a 64 bit integer representing the current state of nonzeros in the matrix. If the
10020         matrix has had no new nonzero locations added to the matrix since the previous call then the value will be the
10021         same, otherwise it will be larger
10022 
10023      Not Collective
10024 
10025   Input Parameter:
10026 .    A  - the matrix
10027 
10028   Output Parameter:
10029 .    state - the current state
10030 
10031   Notes: You can only compare states from two different calls to the SAME matrix, you cannot compare calls between
10032          different matrices
10033 
10034   Level: intermediate
10035 
10036 @*/
10037 PetscErrorCode MatGetNonzeroState(Mat mat,PetscObjectState *state)
10038 {
10039   PetscFunctionBegin;
10040   PetscValidHeaderSpecific(mat,MAT_CLASSID,1);
10041   *state = mat->nonzerostate;
10042   PetscFunctionReturn(0);
10043 }
10044 
10045 #undef __FUNCT__
10046 #define __FUNCT__ "MatCreateMPIMatConcatenateSeqMat"
10047 /*@
10048       MatCreateMPIMatConcatenateSeqMat - Creates a single large PETSc matrix by concatenating sequential
10049                  matrices from each processor
10050 
10051     Collective on MPI_Comm
10052 
10053    Input Parameters:
10054 +    comm - the communicators the parallel matrix will live on
10055 .    seqmat - the input sequential matrices
10056 .    n - number of local columns (or PETSC_DECIDE)
10057 -    reuse - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
10058 
10059    Output Parameter:
10060 .    mpimat - the parallel matrix generated
10061 
10062     Level: advanced
10063 
10064    Notes: The number of columns of the matrix in EACH processor MUST be the same.
10065 
10066 @*/
10067 PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm comm,Mat seqmat,PetscInt n,MatReuse reuse,Mat *mpimat)
10068 {
10069   PetscErrorCode ierr;
10070   PetscMPIInt    size;
10071 
10072   PetscFunctionBegin;
10073   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
10074   if (size == 1) {
10075     if (reuse == MAT_INITIAL_MATRIX) {
10076       ierr = MatDuplicate(seqmat,MAT_COPY_VALUES,mpimat);CHKERRQ(ierr);
10077     } else {
10078       ierr = MatCopy(seqmat,*mpimat,SAME_NONZERO_PATTERN);CHKERRQ(ierr);
10079     }
10080     PetscFunctionReturn(0);
10081   }
10082 
10083   if (!seqmat->ops->creatempimatconcatenateseqmat) SETERRQ1(PetscObjectComm((PetscObject)seqmat),PETSC_ERR_SUP,"Mat type %s",((PetscObject)seqmat)->type_name);
10084   ierr = PetscLogEventBegin(MAT_Merge,seqmat,0,0,0);CHKERRQ(ierr);
10085   ierr = (*seqmat->ops->creatempimatconcatenateseqmat)(comm,seqmat,n,reuse,mpimat);CHKERRQ(ierr);
10086   ierr = PetscLogEventEnd(MAT_Merge,seqmat,0,0,0);CHKERRQ(ierr);
10087   PetscFunctionReturn(0);
10088 }
10089 
10090 #undef __FUNCT__
10091 #define __FUNCT__ "MatSubdomainsCreateCoalesce"
10092 /*@
10093      MatSubdomainsCreateCoalesce - Creates index subdomains by coalescing adjacent
10094                  ranks' ownership ranges.
10095 
10096     Collective on A
10097 
10098    Input Parameters:
10099 +    A   - the matrix to create subdomains from
10100 -    N   - requested number of subdomains
10101 
10102 
10103    Output Parameters:
10104 +    n   - number of subdomains resulting on this rank
10105 -    iss - IS list with indices of subdomains on this rank
10106 
10107     Level: advanced
10108 
10109     Notes: number of subdomains must be smaller than the communicator size
10110 @*/
10111 PetscErrorCode  MatSubdomainsCreateCoalesce(Mat A,PetscInt N,PetscInt *n,IS *iss[])
10112 {
10113   MPI_Comm        comm,subcomm;
10114   PetscMPIInt     size,rank,color,subsize,subrank;
10115   PetscInt        rstart,rend,k;
10116   PetscErrorCode  ierr;
10117 
10118   PetscFunctionBegin;
10119   ierr = PetscObjectGetComm((PetscObject)A,&comm);CHKERRQ(ierr);
10120   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
10121   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
10122   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);
10123   *n = 1;
10124   k = ((PetscInt)size)/N + ((PetscInt)size%N>0); /* There are up to k ranks to a color */
10125   color = rank/k;
10126   ierr = MPI_Comm_split(comm,color,rank,&subcomm);CHKERRQ(ierr);
10127   ierr = MPI_Comm_size(subcomm,&subsize);CHKERRQ(ierr);
10128   ierr = MPI_Comm_size(subcomm,&subrank);CHKERRQ(ierr);
10129   ierr = PetscMalloc1(1,iss);CHKERRQ(ierr);
10130   ierr = MatGetOwnershipRange(A,&rstart,&rend);CHKERRQ(ierr);
10131   ierr = ISCreateStride(subcomm,rend-rstart,rstart,1,*iss);CHKERRQ(ierr);
10132   PetscFunctionReturn(0);
10133 }
10134