xref: /petsc/src/mat/interface/matrix.c (revision f98cea2c07897992b5b1217b65e95b08e1a8f673)
1 #define PETSCMAT_DLL
2 
3 /*
4    This is where the abstract matrix operations are defined
5 */
6 
7 #include "include/private/matimpl.h"        /*I "petscmat.h" I*/
8 #include "private/vecimpl.h"
9 
10 /* Logging support */
11 PetscCookie PETSCMAT_DLLEXPORT MAT_COOKIE = 0;
12 PetscEvent  MAT_Mult = 0, MAT_Mults = 0, MAT_MultConstrained = 0, MAT_MultAdd = 0, MAT_MultTranspose = 0;
13 PetscEvent  MAT_MultTransposeConstrained = 0, MAT_MultTransposeAdd = 0, MAT_Solve = 0, MAT_Solves = 0, MAT_SolveAdd = 0, MAT_SolveTranspose = 0, MAT_MatSolve = 0;
14 PetscEvent  MAT_SolveTransposeAdd = 0, MAT_Relax = 0, MAT_ForwardSolve = 0, MAT_BackwardSolve = 0, MAT_LUFactor = 0, MAT_LUFactorSymbolic = 0;
15 PetscEvent  MAT_LUFactorNumeric = 0, MAT_CholeskyFactor = 0, MAT_CholeskyFactorSymbolic = 0, MAT_CholeskyFactorNumeric = 0, MAT_ILUFactor = 0;
16 PetscEvent  MAT_ILUFactorSymbolic = 0, MAT_ICCFactorSymbolic = 0, MAT_Copy = 0, MAT_Convert = 0, MAT_Scale = 0, MAT_AssemblyBegin = 0;
17 PetscEvent  MAT_AssemblyEnd = 0, MAT_SetValues = 0, MAT_GetValues = 0, MAT_GetRow = 0, MAT_GetRowIJ = 0, MAT_GetSubMatrices = 0, MAT_GetColoring = 0, MAT_GetOrdering = 0, MAT_GetRedundantMatrix = 0;
18 PetscEvent  MAT_IncreaseOverlap = 0, MAT_Partitioning = 0, MAT_ZeroEntries = 0, MAT_Load = 0, MAT_View = 0, MAT_AXPY = 0, MAT_FDColoringCreate = 0;
19 PetscEvent  MAT_FDColoringApply = 0,MAT_Transpose = 0,MAT_FDColoringFunction = 0;
20 PetscEvent  MAT_MatMult = 0, MAT_MatMultSymbolic = 0, MAT_MatMultNumeric = 0;
21 PetscEvent  MAT_PtAP = 0, MAT_PtAPSymbolic = 0, MAT_PtAPNumeric = 0;
22 PetscEvent  MAT_MatMultTranspose = 0, MAT_MatMultTransposeSymbolic = 0, MAT_MatMultTransposeNumeric = 0;
23 
24 /* nasty global values for MatSetValue() */
25 PetscInt    PETSCMAT_DLLEXPORT MatSetValue_Row = 0;
26 PetscInt    PETSCMAT_DLLEXPORT MatSetValue_Column = 0;
27 PetscScalar PETSCMAT_DLLEXPORT MatSetValue_Value = 0.0;
28 
29 #undef __FUNCT__
30 #define __FUNCT__ "MatRealPart"
31 /*@
32    MatRealPart - Zeros out the imaginary part of the matrix
33 
34    Collective on Mat
35 
36    Input Parameters:
37 .  mat - the matrix
38 
39    Level: advanced
40 
41 
42 .seealso: MatImaginaryPart()
43 @*/
44 
45 PetscErrorCode PETSCMAT_DLLEXPORT MatRealPart(Mat mat)
46 {
47   PetscErrorCode ierr;
48 
49   PetscFunctionBegin;
50   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
51   PetscValidType(mat,1);
52   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
53   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
54   if (!mat->ops->realpart) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
55   ierr = MatPreallocated(mat);CHKERRQ(ierr);
56   ierr = (*mat->ops->realpart)(mat);CHKERRQ(ierr);
57   PetscFunctionReturn(0);
58 }
59 
60 #undef __FUNCT__
61 #define __FUNCT__ "MatImaginaryPart"
62 /*@
63    MatImaginaryPart - Moves the imaginary part of the matrix to the real part and zeros the imaginary part
64 
65    Collective on Mat
66 
67    Input Parameters:
68 .  mat - the matrix
69 
70    Level: advanced
71 
72 
73 .seealso: MatRealPart()
74 @*/
75 
76 PetscErrorCode PETSCMAT_DLLEXPORT MatImaginaryPart(Mat mat)
77 {
78   PetscErrorCode ierr;
79 
80   PetscFunctionBegin;
81   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
82   PetscValidType(mat,1);
83   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
84   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
85   if (!mat->ops->imaginarypart) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
86   ierr = MatPreallocated(mat);CHKERRQ(ierr);
87   ierr = (*mat->ops->imaginarypart)(mat);CHKERRQ(ierr);
88   PetscFunctionReturn(0);
89 }
90 
91 #undef __FUNCT__
92 #define __FUNCT__ "MatGetRow"
93 /*@C
94    MatGetRow - Gets a row of a matrix.  You MUST call MatRestoreRow()
95    for each row that you get to ensure that your application does
96    not bleed memory.
97 
98    Not Collective
99 
100    Input Parameters:
101 +  mat - the matrix
102 -  row - the row to get
103 
104    Output Parameters:
105 +  ncols -  if not NULL, the number of nonzeros in the row
106 .  cols - if not NULL, the column numbers
107 -  vals - if not NULL, the values
108 
109    Notes:
110    This routine is provided for people who need to have direct access
111    to the structure of a matrix.  We hope that we provide enough
112    high-level matrix routines that few users will need it.
113 
114    MatGetRow() always returns 0-based column indices, regardless of
115    whether the internal representation is 0-based (default) or 1-based.
116 
117    For better efficiency, set cols and/or vals to PETSC_NULL if you do
118    not wish to extract these quantities.
119 
120    The user can only examine the values extracted with MatGetRow();
121    the values cannot be altered.  To change the matrix entries, one
122    must use MatSetValues().
123 
124    You can only have one call to MatGetRow() outstanding for a particular
125    matrix at a time, per processor. MatGetRow() can only obtain rows
126    associated with the given processor, it cannot get rows from the
127    other processors; for that we suggest using MatGetSubMatrices(), then
128    MatGetRow() on the submatrix. The row indix passed to MatGetRows()
129    is in the global number of rows.
130 
131    Fortran Notes:
132    The calling sequence from Fortran is
133 .vb
134    MatGetRow(matrix,row,ncols,cols,values,ierr)
135          Mat     matrix (input)
136          integer row    (input)
137          integer ncols  (output)
138          integer cols(maxcols) (output)
139          double precision (or double complex) values(maxcols) output
140 .ve
141    where maxcols >= maximum nonzeros in any row of the matrix.
142 
143 
144    Caution:
145    Do not try to change the contents of the output arrays (cols and vals).
146    In some cases, this may corrupt the matrix.
147 
148    Level: advanced
149 
150    Concepts: matrices^row access
151 
152 .seealso: MatRestoreRow(), MatSetValues(), MatGetValues(), MatGetSubMatrices(), MatGetDiagonal()
153 @*/
154 
155 PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat mat,PetscInt row,PetscInt *ncols,const PetscInt *cols[],const PetscScalar *vals[])
156 {
157   PetscErrorCode ierr;
158   PetscInt       incols;
159 
160   PetscFunctionBegin;
161   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
162   PetscValidType(mat,1);
163   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
164   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
165   if (!mat->ops->getrow) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
166   ierr = MatPreallocated(mat);CHKERRQ(ierr);
167   ierr = PetscLogEventBegin(MAT_GetRow,mat,0,0,0);CHKERRQ(ierr);
168   ierr = (*mat->ops->getrow)(mat,row,&incols,(PetscInt **)cols,(PetscScalar **)vals);CHKERRQ(ierr);
169   if (ncols) *ncols = incols;
170   ierr = PetscLogEventEnd(MAT_GetRow,mat,0,0,0);CHKERRQ(ierr);
171   PetscFunctionReturn(0);
172 }
173 
174 #undef __FUNCT__
175 #define __FUNCT__ "MatConjugate"
176 /*@
177    MatConjugate - replaces the matrix values with their complex conjugates
178 
179    Collective on Mat
180 
181    Input Parameters:
182 .  mat - the matrix
183 
184    Level: advanced
185 
186 .seealso:  VecConjugate()
187 @*/
188 PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat mat)
189 {
190   PetscErrorCode ierr;
191 
192   PetscFunctionBegin;
193   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
194   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
195   if (!mat->ops->conjugate) SETERRQ(PETSC_ERR_SUP,"Not provided for this matrix format, send email to petsc-maint@mcs.anl.gov");
196   ierr = (*mat->ops->conjugate)(mat);CHKERRQ(ierr);
197   PetscFunctionReturn(0);
198 }
199 
200 #undef __FUNCT__
201 #define __FUNCT__ "MatRestoreRow"
202 /*@C
203    MatRestoreRow - Frees any temporary space allocated by MatGetRow().
204 
205    Not Collective
206 
207    Input Parameters:
208 +  mat - the matrix
209 .  row - the row to get
210 .  ncols, cols - the number of nonzeros and their columns
211 -  vals - if nonzero the column values
212 
213    Notes:
214    This routine should be called after you have finished examining the entries.
215 
216    Fortran Notes:
217    The calling sequence from Fortran is
218 .vb
219    MatRestoreRow(matrix,row,ncols,cols,values,ierr)
220       Mat     matrix (input)
221       integer row    (input)
222       integer ncols  (output)
223       integer cols(maxcols) (output)
224       double precision (or double complex) values(maxcols) output
225 .ve
226    Where maxcols >= maximum nonzeros in any row of the matrix.
227 
228    In Fortran MatRestoreRow() MUST be called after MatGetRow()
229    before another call to MatGetRow() can be made.
230 
231    Level: advanced
232 
233 .seealso:  MatGetRow()
234 @*/
235 PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat mat,PetscInt row,PetscInt *ncols,const PetscInt *cols[],const PetscScalar *vals[])
236 {
237   PetscErrorCode ierr;
238 
239   PetscFunctionBegin;
240   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
241   PetscValidIntPointer(ncols,3);
242   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
243   if (!mat->ops->restorerow) PetscFunctionReturn(0);
244   ierr = (*mat->ops->restorerow)(mat,row,ncols,(PetscInt **)cols,(PetscScalar **)vals);CHKERRQ(ierr);
245   PetscFunctionReturn(0);
246 }
247 
248 #undef __FUNCT__
249 #define __FUNCT__ "MatGetRowUpperTriangular"
250 /*@C
251    MatGetRowUpperTriangular - Sets a flag to enable calls to MatGetRow() for matrix in MATSBAIJ format.
252    You should call MatRestoreRowUpperTriangular() after calling MatGetRow/MatRestoreRow() to disable the flag.
253 
254    Not Collective
255 
256    Input Parameters:
257 +  mat - the matrix
258 
259    Notes:
260    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.
261 
262    Level: advanced
263 
264    Concepts: matrices^row access
265 
266 .seealso: MatRestoreRowRowUpperTriangular()
267 @*/
268 
269 PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowUpperTriangular(Mat mat)
270 {
271   PetscErrorCode ierr;
272 
273   PetscFunctionBegin;
274   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
275   PetscValidType(mat,1);
276   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
277   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
278   if (!mat->ops->getrowuppertriangular) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
279   ierr = MatPreallocated(mat);CHKERRQ(ierr);
280   ierr = (*mat->ops->getrowuppertriangular)(mat);CHKERRQ(ierr);
281   PetscFunctionReturn(0);
282 }
283 
284 #undef __FUNCT__
285 #define __FUNCT__ "MatRestoreRowUpperTriangular"
286 /*@C
287    MatRestoreRowUpperTriangular - Disable calls to MatGetRow() for matrix in MATSBAIJ format.
288 
289    Not Collective
290 
291    Input Parameters:
292 +  mat - the matrix
293 
294    Notes:
295    This routine should be called after you have finished MatGetRow/MatRestoreRow().
296 
297 
298    Level: advanced
299 
300 .seealso:  MatGetRowUpperTriangular()
301 @*/
302 PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowUpperTriangular(Mat mat)
303 {
304   PetscErrorCode ierr;
305 
306   PetscFunctionBegin;
307   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
308   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
309   if (!mat->ops->restorerowuppertriangular) PetscFunctionReturn(0);
310   ierr = (*mat->ops->restorerowuppertriangular)(mat);CHKERRQ(ierr);
311   PetscFunctionReturn(0);
312 }
313 
314 #undef __FUNCT__
315 #define __FUNCT__ "MatSetOptionsPrefix"
316 /*@C
317    MatSetOptionsPrefix - Sets the prefix used for searching for all
318    Mat options in the database.
319 
320    Collective on Mat
321 
322    Input Parameter:
323 +  A - the Mat context
324 -  prefix - the prefix to prepend to all option names
325 
326    Notes:
327    A hyphen (-) must NOT be given at the beginning of the prefix name.
328    The first character of all runtime options is AUTOMATICALLY the hyphen.
329 
330    Level: advanced
331 
332 .keywords: Mat, set, options, prefix, database
333 
334 .seealso: MatSetFromOptions()
335 @*/
336 PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat A,const char prefix[])
337 {
338   PetscErrorCode ierr;
339 
340   PetscFunctionBegin;
341   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
342   ierr = PetscObjectSetOptionsPrefix((PetscObject)A,prefix);CHKERRQ(ierr);
343   PetscFunctionReturn(0);
344 }
345 
346 #undef __FUNCT__
347 #define __FUNCT__ "MatAppendOptionsPrefix"
348 /*@C
349    MatAppendOptionsPrefix - Appends to the prefix used for searching for all
350    Mat options in the database.
351 
352    Collective on Mat
353 
354    Input Parameters:
355 +  A - the Mat context
356 -  prefix - the prefix to prepend to all option names
357 
358    Notes:
359    A hyphen (-) must NOT be given at the beginning of the prefix name.
360    The first character of all runtime options is AUTOMATICALLY the hyphen.
361 
362    Level: advanced
363 
364 .keywords: Mat, append, options, prefix, database
365 
366 .seealso: MatGetOptionsPrefix()
367 @*/
368 PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat A,const char prefix[])
369 {
370   PetscErrorCode ierr;
371 
372   PetscFunctionBegin;
373   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
374   ierr = PetscObjectAppendOptionsPrefix((PetscObject)A,prefix);CHKERRQ(ierr);
375   PetscFunctionReturn(0);
376 }
377 
378 #undef __FUNCT__
379 #define __FUNCT__ "MatGetOptionsPrefix"
380 /*@C
381    MatGetOptionsPrefix - Sets the prefix used for searching for all
382    Mat options in the database.
383 
384    Not Collective
385 
386    Input Parameter:
387 .  A - the Mat context
388 
389    Output Parameter:
390 .  prefix - pointer to the prefix string used
391 
392    Notes: On the fortran side, the user should pass in a string 'prefix' of
393    sufficient length to hold the prefix.
394 
395    Level: advanced
396 
397 .keywords: Mat, get, options, prefix, database
398 
399 .seealso: MatAppendOptionsPrefix()
400 @*/
401 PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat A,const char *prefix[])
402 {
403   PetscErrorCode ierr;
404 
405   PetscFunctionBegin;
406   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
407   ierr = PetscObjectGetOptionsPrefix((PetscObject)A,prefix);CHKERRQ(ierr);
408   PetscFunctionReturn(0);
409 }
410 
411 #undef __FUNCT__
412 #define __FUNCT__ "MatSetUp"
413 /*@
414    MatSetUp - Sets up the internal matrix data structures for the later use.
415 
416    Collective on Mat
417 
418    Input Parameters:
419 .  A - the Mat context
420 
421    Notes:
422    For basic use of the Mat classes the user need not explicitly call
423    MatSetUp(), since these actions will happen automatically.
424 
425    Level: advanced
426 
427 .keywords: Mat, setup
428 
429 .seealso: MatCreate(), MatDestroy()
430 @*/
431 PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat A)
432 {
433   PetscErrorCode ierr;
434 
435   PetscFunctionBegin;
436   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
437   ierr = MatSetUpPreallocation(A);CHKERRQ(ierr);
438   ierr = MatSetFromOptions(A);CHKERRQ(ierr);
439   PetscFunctionReturn(0);
440 }
441 
442 #undef __FUNCT__
443 #define __FUNCT__ "MatView"
444 /*@C
445    MatView - Visualizes a matrix object.
446 
447    Collective on Mat
448 
449    Input Parameters:
450 +  mat - the matrix
451 -  viewer - visualization context
452 
453   Notes:
454   The available visualization contexts include
455 +    PETSC_VIEWER_STDOUT_SELF - standard output (default)
456 .    PETSC_VIEWER_STDOUT_WORLD - synchronized standard
457         output where only the first processor opens
458         the file.  All other processors send their
459         data to the first processor to print.
460 -     PETSC_VIEWER_DRAW_WORLD - graphical display of nonzero structure
461 
462    The user can open alternative visualization contexts with
463 +    PetscViewerASCIIOpen() - Outputs matrix to a specified file
464 .    PetscViewerBinaryOpen() - Outputs matrix in binary to a
465          specified file; corresponding input uses MatLoad()
466 .    PetscViewerDrawOpen() - Outputs nonzero matrix structure to
467          an X window display
468 -    PetscViewerSocketOpen() - Outputs matrix to Socket viewer.
469          Currently only the sequential dense and AIJ
470          matrix types support the Socket viewer.
471 
472    The user can call PetscViewerSetFormat() to specify the output
473    format of ASCII printed objects (when using PETSC_VIEWER_STDOUT_SELF,
474    PETSC_VIEWER_STDOUT_WORLD and PetscViewerASCIIOpen).  Available formats include
475 +    PETSC_VIEWER_ASCII_DEFAULT - default, prints matrix contents
476 .    PETSC_VIEWER_ASCII_MATLAB - prints matrix contents in Matlab format
477 .    PETSC_VIEWER_ASCII_DENSE - prints entire matrix including zeros
478 .    PETSC_VIEWER_ASCII_COMMON - prints matrix contents, using a sparse
479          format common among all matrix types
480 .    PETSC_VIEWER_ASCII_IMPL - prints matrix contents, using an implementation-specific
481          format (which is in many cases the same as the default)
482 .    PETSC_VIEWER_ASCII_INFO - prints basic information about the matrix
483          size and structure (not the matrix entries)
484 .    PETSC_VIEWER_ASCII_INFO_DETAIL - prints more detailed information about
485          the matrix structure
486 
487    Options Database Keys:
488 +  -mat_view_info - Prints info on matrix at conclusion of MatEndAssembly()
489 .  -mat_view_info_detailed - Prints more detailed info
490 .  -mat_view - Prints matrix in ASCII format
491 .  -mat_view_matlab - Prints matrix in Matlab format
492 .  -mat_view_draw - PetscDraws nonzero structure of matrix, using MatView() and PetscDrawOpenX().
493 .  -display <name> - Sets display name (default is host)
494 .  -draw_pause <sec> - Sets number of seconds to pause after display
495 .  -mat_view_socket - Sends matrix to socket, can be accessed from Matlab (see users manual)
496 .  -viewer_socket_machine <machine>
497 .  -viewer_socket_port <port>
498 .  -mat_view_binary - save matrix to file in binary format
499 -  -viewer_binary_filename <name>
500    Level: beginner
501 
502    Concepts: matrices^viewing
503    Concepts: matrices^plotting
504    Concepts: matrices^printing
505 
506 .seealso: PetscViewerSetFormat(), PetscViewerASCIIOpen(), PetscViewerDrawOpen(),
507           PetscViewerSocketOpen(), PetscViewerBinaryOpen(), MatLoad()
508 @*/
509 PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat mat,PetscViewer viewer)
510 {
511   PetscErrorCode    ierr;
512   PetscInt          rows,cols;
513   PetscTruth        iascii;
514   const char        *cstr;
515   PetscViewerFormat format;
516 
517   PetscFunctionBegin;
518   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
519   PetscValidType(mat,1);
520   if (!viewer) {
521     ierr = PetscViewerASCIIGetStdout(mat->comm,&viewer);CHKERRQ(ierr);
522   }
523   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_COOKIE,2);
524   PetscCheckSameComm(mat,1,viewer,2);
525   if (!mat->assembled) SETERRQ(PETSC_ERR_ORDER,"Must call MatAssemblyBegin/End() before viewing matrix");
526   ierr = MatPreallocated(mat);CHKERRQ(ierr);
527 
528   ierr = PetscTypeCompare((PetscObject)viewer,PETSC_VIEWER_ASCII,&iascii);CHKERRQ(ierr);
529   if (iascii) {
530     ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr);
531     if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
532       if (mat->prefix) {
533         ierr = PetscViewerASCIIPrintf(viewer,"Matrix Object:(%s)\n",mat->prefix);CHKERRQ(ierr);
534       } else {
535         ierr = PetscViewerASCIIPrintf(viewer,"Matrix Object:\n");CHKERRQ(ierr);
536       }
537       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
538       ierr = MatGetType(mat,&cstr);CHKERRQ(ierr);
539       ierr = MatGetSize(mat,&rows,&cols);CHKERRQ(ierr);
540       ierr = PetscViewerASCIIPrintf(viewer,"type=%s, rows=%D, cols=%D\n",cstr,rows,cols);CHKERRQ(ierr);
541       if (mat->ops->getinfo) {
542         MatInfo info;
543         ierr = MatGetInfo(mat,MAT_GLOBAL_SUM,&info);CHKERRQ(ierr);
544         ierr = PetscViewerASCIIPrintf(viewer,"total: nonzeros=%D, allocated nonzeros=%D\n",
545                           (PetscInt)info.nz_used,(PetscInt)info.nz_allocated);CHKERRQ(ierr);
546       }
547     }
548   }
549   if (mat->ops->view) {
550     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
551     ierr = (*mat->ops->view)(mat,viewer);CHKERRQ(ierr);
552     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
553   } else if (!iascii) {
554     SETERRQ1(PETSC_ERR_SUP,"Viewer type %s not supported",((PetscObject)viewer)->type_name);
555   }
556   if (iascii) {
557     ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr);
558     if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
559       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
560     }
561   }
562   PetscFunctionReturn(0);
563 }
564 
565 #undef __FUNCT__
566 #define __FUNCT__ "MatScaleSystem"
567 /*@C
568    MatScaleSystem - Scale a vector solution and right hand side to
569    match the scaling of a scaled matrix.
570 
571    Collective on Mat
572 
573    Input Parameter:
574 +  mat - the matrix
575 .  b - right hand side vector (or PETSC_NULL)
576 -  x - solution vector (or PETSC_NULL)
577 
578 
579    Notes:
580    For AIJ, BAIJ, and BDiag matrix formats, the matrices are not
581    internally scaled, so this does nothing. For MPIROWBS it
582    permutes and diagonally scales.
583 
584    The KSP methods automatically call this routine when required
585    (via PCPreSolve()) so it is rarely used directly.
586 
587    Level: Developer
588 
589    Concepts: matrices^scaling
590 
591 .seealso: MatUseScaledForm(), MatUnScaleSystem()
592 @*/
593 PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat mat,Vec b,Vec x)
594 {
595   PetscErrorCode ierr;
596 
597   PetscFunctionBegin;
598   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
599   PetscValidType(mat,1);
600   ierr = MatPreallocated(mat);CHKERRQ(ierr);
601   if (x) {PetscValidHeaderSpecific(x,VEC_COOKIE,2);PetscCheckSameComm(mat,1,x,2);}
602   if (b) {PetscValidHeaderSpecific(b,VEC_COOKIE,3);PetscCheckSameComm(mat,1,b,3);}
603 
604   if (mat->ops->scalesystem) {
605     ierr = (*mat->ops->scalesystem)(mat,b,x);CHKERRQ(ierr);
606   }
607   PetscFunctionReturn(0);
608 }
609 
610 #undef __FUNCT__
611 #define __FUNCT__ "MatUnScaleSystem"
612 /*@C
613    MatUnScaleSystem - Unscales a vector solution and right hand side to
614    match the original scaling of a scaled matrix.
615 
616    Collective on Mat
617 
618    Input Parameter:
619 +  mat - the matrix
620 .  b - right hand side vector (or PETSC_NULL)
621 -  x - solution vector (or PETSC_NULL)
622 
623 
624    Notes:
625    For AIJ, BAIJ, and BDiag matrix formats, the matrices are not
626    internally scaled, so this does nothing. For MPIROWBS it
627    permutes and diagonally scales.
628 
629    The KSP methods automatically call this routine when required
630    (via PCPreSolve()) so it is rarely used directly.
631 
632    Level: Developer
633 
634 .seealso: MatUseScaledForm(), MatScaleSystem()
635 @*/
636 PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat mat,Vec b,Vec x)
637 {
638   PetscErrorCode ierr;
639 
640   PetscFunctionBegin;
641   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
642   PetscValidType(mat,1);
643   ierr = MatPreallocated(mat);CHKERRQ(ierr);
644   if (x) {PetscValidHeaderSpecific(x,VEC_COOKIE,2);PetscCheckSameComm(mat,1,x,2);}
645   if (b) {PetscValidHeaderSpecific(b,VEC_COOKIE,3);PetscCheckSameComm(mat,1,b,3);}
646   if (mat->ops->unscalesystem) {
647     ierr = (*mat->ops->unscalesystem)(mat,b,x);CHKERRQ(ierr);
648   }
649   PetscFunctionReturn(0);
650 }
651 
652 #undef __FUNCT__
653 #define __FUNCT__ "MatUseScaledForm"
654 /*@C
655    MatUseScaledForm - For matrix storage formats that scale the
656    matrix (for example MPIRowBS matrices are diagonally scaled on
657    assembly) indicates matrix operations (MatMult() etc) are
658    applied using the scaled matrix.
659 
660    Collective on Mat
661 
662    Input Parameter:
663 +  mat - the matrix
664 -  scaled - PETSC_TRUE for applying the scaled, PETSC_FALSE for
665             applying the original matrix
666 
667    Notes:
668    For scaled matrix formats, applying the original, unscaled matrix
669    will be slightly more expensive
670 
671    Level: Developer
672 
673 .seealso: MatScaleSystem(), MatUnScaleSystem()
674 @*/
675 PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat mat,PetscTruth scaled)
676 {
677   PetscErrorCode ierr;
678 
679   PetscFunctionBegin;
680   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
681   PetscValidType(mat,1);
682   ierr = MatPreallocated(mat);CHKERRQ(ierr);
683   if (mat->ops->usescaledform) {
684     ierr = (*mat->ops->usescaledform)(mat,scaled);CHKERRQ(ierr);
685   }
686   PetscFunctionReturn(0);
687 }
688 
689 #undef __FUNCT__
690 #define __FUNCT__ "MatDestroy"
691 /*@
692    MatDestroy - Frees space taken by a matrix.
693 
694    Collective on Mat
695 
696    Input Parameter:
697 .  A - the matrix
698 
699    Level: beginner
700 
701 @*/
702 PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat A)
703 {
704   PetscErrorCode ierr;
705   PetscFunctionBegin;
706   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
707   if (--A->refct > 0) PetscFunctionReturn(0);
708   ierr = MatPreallocated(A);CHKERRQ(ierr);
709   /* if memory was published with AMS then destroy it */
710   ierr = PetscObjectDepublish(A);CHKERRQ(ierr);
711   if (A->ops->destroy) {
712     ierr = (*A->ops->destroy)(A);CHKERRQ(ierr);
713   }
714   if (A->mapping) {
715     ierr = ISLocalToGlobalMappingDestroy(A->mapping);CHKERRQ(ierr);
716   }
717   if (A->bmapping) {
718     ierr = ISLocalToGlobalMappingDestroy(A->bmapping);CHKERRQ(ierr);
719   }
720   ierr = PetscFree(A->rmap.range);CHKERRQ(ierr);
721   ierr = PetscFree(A->cmap.range);CHKERRQ(ierr);
722   ierr = PetscFree(A->spptr);CHKERRQ(ierr);
723   ierr = PetscHeaderDestroy(A);CHKERRQ(ierr);
724   PetscFunctionReturn(0);
725 }
726 
727 #undef __FUNCT__
728 #define __FUNCT__ "MatValid"
729 /*@
730    MatValid - Checks whether a matrix object is valid.
731 
732    Collective on Mat
733 
734    Input Parameter:
735 .  m - the matrix to check
736 
737    Output Parameter:
738    flg - flag indicating matrix status, either
739    PETSC_TRUE if matrix is valid, or PETSC_FALSE otherwise.
740 
741    Level: developer
742 
743    Concepts: matrices^validity
744 @*/
745 PetscErrorCode PETSCMAT_DLLEXPORT MatValid(Mat m,PetscTruth *flg)
746 {
747   PetscFunctionBegin;
748   PetscValidIntPointer(flg,1);
749   if (!m)                           *flg = PETSC_FALSE;
750   else if (m->cookie != MAT_COOKIE) *flg = PETSC_FALSE;
751   else                              *flg = PETSC_TRUE;
752   PetscFunctionReturn(0);
753 }
754 
755 #undef __FUNCT__
756 #define __FUNCT__ "MatSetValues"
757 /*@
758    MatSetValues - Inserts or adds a block of values into a matrix.
759    These values may be cached, so MatAssemblyBegin() and MatAssemblyEnd()
760    MUST be called after all calls to MatSetValues() have been completed.
761 
762    Not Collective
763 
764    Input Parameters:
765 +  mat - the matrix
766 .  v - a logically two-dimensional array of values
767 .  m, idxm - the number of rows and their global indices
768 .  n, idxn - the number of columns and their global indices
769 -  addv - either ADD_VALUES or INSERT_VALUES, where
770    ADD_VALUES adds values to any existing entries, and
771    INSERT_VALUES replaces existing entries with new values
772 
773    Notes:
774    By default the values, v, are row-oriented and unsorted.
775    See MatSetOption() for other options.
776 
777    Calls to MatSetValues() with the INSERT_VALUES and ADD_VALUES
778    options cannot be mixed without intervening calls to the assembly
779    routines.
780 
781    MatSetValues() uses 0-based row and column numbers in Fortran
782    as well as in C.
783 
784    Negative indices may be passed in idxm and idxn, these rows and columns are
785    simply ignored. This allows easily inserting element stiffness matrices
786    with homogeneous Dirchlet boundary conditions that you don't want represented
787    in the matrix.
788 
789    Efficiency Alert:
790    The routine MatSetValuesBlocked() may offer much better efficiency
791    for users of block sparse formats (MATSEQBAIJ and MATMPIBAIJ).
792 
793    Level: beginner
794 
795    Concepts: matrices^putting entries in
796 
797 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
798           InsertMode, INSERT_VALUES, ADD_VALUES
799 @*/
800 PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat mat,PetscInt m,const PetscInt idxm[],PetscInt n,const PetscInt idxn[],const PetscScalar v[],InsertMode addv)
801 {
802   PetscErrorCode ierr;
803 
804   PetscFunctionBegin;
805   if (!m || !n) PetscFunctionReturn(0); /* no values to insert */
806   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
807   PetscValidType(mat,1);
808   PetscValidIntPointer(idxm,3);
809   PetscValidIntPointer(idxn,5);
810   PetscValidScalarPointer(v,6);
811   ierr = MatPreallocated(mat);CHKERRQ(ierr);
812   if (mat->insertmode == NOT_SET_VALUES) {
813     mat->insertmode = addv;
814   }
815 #if defined(PETSC_USE_DEBUG)
816   else if (mat->insertmode != addv) {
817     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
818   }
819   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
820 #endif
821 
822   if (mat->assembled) {
823     mat->was_assembled = PETSC_TRUE;
824     mat->assembled     = PETSC_FALSE;
825   }
826   ierr = PetscLogEventBegin(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
827   if (!mat->ops->setvalues) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
828   ierr = (*mat->ops->setvalues)(mat,m,idxm,n,idxn,v,addv);CHKERRQ(ierr);
829   ierr = PetscLogEventEnd(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
830   PetscFunctionReturn(0);
831 }
832 
833 
834 #undef __FUNCT__
835 #define __FUNCT__ "MatSetValuesRowLocal"
836 /*@
837    MatSetValuesRowLocal - Inserts a row (block row for BAIJ matrices) of nonzero
838         values into a matrix
839 
840    Not Collective
841 
842    Input Parameters:
843 +  mat - the matrix
844 .  row - the (block) row to set
845 -  v - a logically two-dimensional array of values
846 
847    Notes:
848    By the values, v, are column-oriented (for the block version) and sorted
849 
850    All the nonzeros in the row must be provided
851 
852    The matrix must have previously had its column indices set
853 
854    The row must belong to this process
855 
856    Level: intermediate
857 
858    Concepts: matrices^putting entries in
859 
860 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
861           InsertMode, INSERT_VALUES, ADD_VALUES, MatSetValues(), MatSetValuesRow(), MatSetLocalToGlobalMapping()
862 @*/
863 PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRowLocal(Mat mat,PetscInt row,const PetscScalar v[])
864 {
865   PetscErrorCode ierr;
866 
867   PetscFunctionBegin;
868   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
869   PetscValidType(mat,1);
870   PetscValidScalarPointer(v,2);
871   ierr = MatSetValuesRow(mat, mat->mapping->indices[row],v);CHKERRQ(ierr);
872   PetscFunctionReturn(0);
873 }
874 
875 #undef __FUNCT__
876 #define __FUNCT__ "MatSetValuesRow"
877 /*@
878    MatSetValuesRow - Inserts a row (block row for BAIJ matrices) of nonzero
879         values into a matrix
880 
881    Not Collective
882 
883    Input Parameters:
884 +  mat - the matrix
885 .  row - the (block) row to set
886 -  v - a logically two-dimensional array of values
887 
888    Notes:
889    By the values, v, are column-oriented (for the block version) and sorted
890 
891    All the nonzeros in the row must be provided
892 
893    The matrix must have previously had its column indices set
894 
895    The row must belong to this process
896 
897    Level: intermediate
898 
899    Concepts: matrices^putting entries in
900 
901 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
902           InsertMode, INSERT_VALUES, ADD_VALUES, MatSetValues()
903 @*/
904 PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat mat,PetscInt row,const PetscScalar v[])
905 {
906   PetscErrorCode ierr;
907 
908   PetscFunctionBegin;
909   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
910   PetscValidType(mat,1);
911   PetscValidScalarPointer(v,2);
912 #if defined(PETSC_USE_DEBUG)
913   if (mat->insertmode == ADD_VALUES) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add and insert values");
914   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
915 #endif
916   mat->insertmode = INSERT_VALUES;
917 
918   if (mat->assembled) {
919     mat->was_assembled = PETSC_TRUE;
920     mat->assembled     = PETSC_FALSE;
921   }
922   ierr = PetscLogEventBegin(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
923   if (!mat->ops->setvaluesrow) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
924   ierr = (*mat->ops->setvaluesrow)(mat,row,v);CHKERRQ(ierr);
925   ierr = PetscLogEventEnd(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
926   PetscFunctionReturn(0);
927 }
928 
929 #undef __FUNCT__
930 #define __FUNCT__ "MatSetValuesStencil"
931 /*@
932    MatSetValuesStencil - Inserts or adds a block of values into a matrix.
933      Using structured grid indexing
934 
935    Not Collective
936 
937    Input Parameters:
938 +  mat - the matrix
939 .  v - a logically two-dimensional array of values
940 .  m - number of rows being entered
941 .  idxm - grid coordinates (and component number when dof > 1) for matrix rows being entered
942 .  n - number of columns being entered
943 .  idxn - grid coordinates (and component number when dof > 1) for matrix columns being entered
944 -  addv - either ADD_VALUES or INSERT_VALUES, where
945    ADD_VALUES adds values to any existing entries, and
946    INSERT_VALUES replaces existing entries with new values
947 
948    Notes:
949    By default the values, v, are row-oriented and unsorted.
950    See MatSetOption() for other options.
951 
952    Calls to MatSetValuesStencil() with the INSERT_VALUES and ADD_VALUES
953    options cannot be mixed without intervening calls to the assembly
954    routines.
955 
956    The grid coordinates are across the entire grid, not just the local portion
957 
958    MatSetValuesStencil() uses 0-based row and column numbers in Fortran
959    as well as in C.
960 
961    For setting/accessing vector values via array coordinates you can use the DAVecGetArray() routine
962 
963    In order to use this routine you must either obtain the matrix with DAGetMatrix()
964    or call MatSetLocalToGlobalMapping() and MatSetStencil() first.
965 
966    The columns and rows in the stencil passed in MUST be contained within the
967    ghost region of the given process as set with DACreateXXX() or MatSetStencil(). For example,
968    if you create a DA with an overlap of one grid level and on a particular process its first
969    local nonghost x logical coordinate is 6 (so its first ghost x logical coordinate is 5) the
970    first i index you can use in your column and row indices in MatSetStencil() is 5.
971 
972    In Fortran idxm and idxn should be declared as
973 $     MatStencil idxm(4,m),idxn(4,n)
974    and the values inserted using
975 $    idxm(MatStencil_i,1) = i
976 $    idxm(MatStencil_j,1) = j
977 $    idxm(MatStencil_k,1) = k
978 $    idxm(MatStencil_c,1) = c
979    etc
980 
981    For periodic boundary conditions use negative indices for values to the left (below 0; that are to be
982    obtained by wrapping values from right edge). For values to the right of the last entry using that index plus one
983    etc to obtain values that obtained by wrapping the values from the left edge.
984 
985    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
986    a single value per point) you can skip filling those indices.
987 
988    Inspired by the structured grid interface to the HYPRE package
989    (http://www.llnl.gov/CASC/hypre)
990 
991    Efficiency Alert:
992    The routine MatSetValuesBlockedStencil() may offer much better efficiency
993    for users of block sparse formats (MATSEQBAIJ and MATMPIBAIJ).
994 
995    Level: beginner
996 
997    Concepts: matrices^putting entries in
998 
999 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal()
1000           MatSetValues(), MatSetValuesBlockedStencil(), MatSetStencil(), DAGetMatrix(), DAVecGetArray(), MatStencil
1001 @*/
1002 PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat mat,PetscInt m,const MatStencil idxm[],PetscInt n,const MatStencil idxn[],const PetscScalar v[],InsertMode addv)
1003 {
1004   PetscErrorCode ierr;
1005   PetscInt       j,i,jdxm[128],jdxn[256],dim = mat->stencil.dim,*dims = mat->stencil.dims+1,tmp;
1006   PetscInt       *starts = mat->stencil.starts,*dxm = (PetscInt*)idxm,*dxn = (PetscInt*)idxn,sdim = dim - (1 - (PetscInt)mat->stencil.noc);
1007 
1008   PetscFunctionBegin;
1009   if (!m || !n) PetscFunctionReturn(0); /* no values to insert */
1010   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
1011   PetscValidType(mat,1);
1012   PetscValidIntPointer(idxm,3);
1013   PetscValidIntPointer(idxn,5);
1014   PetscValidScalarPointer(v,6);
1015 
1016   if (m > 128) SETERRQ1(PETSC_ERR_SUP,"Can only set 128 rows at a time; trying to set %D",m);
1017   if (n > 256) SETERRQ1(PETSC_ERR_SUP,"Can only set 256 columns at a time; trying to set %D",n);
1018 
1019   for (i=0; i<m; i++) {
1020     for (j=0; j<3-sdim; j++) dxm++;
1021     tmp = *dxm++ - starts[0];
1022     for (j=0; j<dim-1; j++) {
1023       if ((*dxm++ - starts[j+1]) < 0 || tmp < 0) tmp = PETSC_MIN_INT;
1024       else                                       tmp = tmp*dims[j] + *(dxm-1) - starts[j+1];
1025     }
1026     if (mat->stencil.noc) dxm++;
1027     jdxm[i] = tmp;
1028   }
1029   for (i=0; i<n; i++) {
1030     for (j=0; j<3-sdim; j++) dxn++;
1031     tmp = *dxn++ - starts[0];
1032     for (j=0; j<dim-1; j++) {
1033       if ((*dxn++ - starts[j+1]) < 0 || tmp < 0) tmp = PETSC_MIN_INT;
1034       else                                       tmp = tmp*dims[j] + *(dxn-1) - starts[j+1];
1035     }
1036     if (mat->stencil.noc) dxn++;
1037     jdxn[i] = tmp;
1038   }
1039   ierr = MatSetValuesLocal(mat,m,jdxm,n,jdxn,v,addv);CHKERRQ(ierr);
1040   PetscFunctionReturn(0);
1041 }
1042 
1043 #undef __FUNCT__
1044 #define __FUNCT__ "MatSetValuesBlockedStencil"
1045 /*@C
1046    MatSetValuesBlockedStencil - Inserts or adds a block of values into a matrix.
1047      Using structured grid indexing
1048 
1049    Not Collective
1050 
1051    Input Parameters:
1052 +  mat - the matrix
1053 .  v - a logically two-dimensional array of values
1054 .  m - number of rows being entered
1055 .  idxm - grid coordinates for matrix rows being entered
1056 .  n - number of columns being entered
1057 .  idxn - grid coordinates for matrix columns being entered
1058 -  addv - either ADD_VALUES or INSERT_VALUES, where
1059    ADD_VALUES adds values to any existing entries, and
1060    INSERT_VALUES replaces existing entries with new values
1061 
1062    Notes:
1063    By default the values, v, are row-oriented and unsorted.
1064    See MatSetOption() for other options.
1065 
1066    Calls to MatSetValuesBlockedStencil() with the INSERT_VALUES and ADD_VALUES
1067    options cannot be mixed without intervening calls to the assembly
1068    routines.
1069 
1070    The grid coordinates are across the entire grid, not just the local portion
1071 
1072    MatSetValuesBlockedStencil() uses 0-based row and column numbers in Fortran
1073    as well as in C.
1074 
1075    For setting/accessing vector values via array coordinates you can use the DAVecGetArray() routine
1076 
1077    In order to use this routine you must either obtain the matrix with DAGetMatrix()
1078    or call MatSetLocalToGlobalMapping() and MatSetStencil() first.
1079 
1080    The columns and rows in the stencil passed in MUST be contained within the
1081    ghost region of the given process as set with DACreateXXX() or MatSetStencil(). For example,
1082    if you create a DA with an overlap of one grid level and on a particular process its first
1083    local nonghost x logical coordinate is 6 (so its first ghost x logical coordinate is 5) the
1084    first i index you can use in your column and row indices in MatSetStencil() is 5.
1085 
1086    In Fortran idxm and idxn should be declared as
1087 $     MatStencil idxm(4,m),idxn(4,n)
1088    and the values inserted using
1089 $    idxm(MatStencil_i,1) = i
1090 $    idxm(MatStencil_j,1) = j
1091 $    idxm(MatStencil_k,1) = k
1092    etc
1093 
1094    Negative indices may be passed in idxm and idxn, these rows and columns are
1095    simply ignored. This allows easily inserting element stiffness matrices
1096    with homogeneous Dirchlet boundary conditions that you don't want represented
1097    in the matrix.
1098 
1099    Inspired by the structured grid interface to the HYPRE package
1100    (http://www.llnl.gov/CASC/hypre)
1101 
1102    Level: beginner
1103 
1104    Concepts: matrices^putting entries in
1105 
1106 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal()
1107           MatSetValues(), MatSetValuesStencil(), MatSetStencil(), DAGetMatrix(), DAVecGetArray(), MatStencil
1108 @*/
1109 PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat mat,PetscInt m,const MatStencil idxm[],PetscInt n,const MatStencil idxn[],const PetscScalar v[],InsertMode addv)
1110 {
1111   PetscErrorCode ierr;
1112   PetscInt       j,i,jdxm[128],jdxn[256],dim = mat->stencil.dim,*dims = mat->stencil.dims+1,tmp;
1113   PetscInt       *starts = mat->stencil.starts,*dxm = (PetscInt*)idxm,*dxn = (PetscInt*)idxn,sdim = dim - (1 - (PetscInt)mat->stencil.noc);
1114 
1115   PetscFunctionBegin;
1116   if (!m || !n) PetscFunctionReturn(0); /* no values to insert */
1117   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
1118   PetscValidType(mat,1);
1119   PetscValidIntPointer(idxm,3);
1120   PetscValidIntPointer(idxn,5);
1121   PetscValidScalarPointer(v,6);
1122 
1123   if (m > 128) SETERRQ1(PETSC_ERR_SUP,"Can only set 128 rows at a time; trying to set %D",m);
1124   if (n > 128) SETERRQ1(PETSC_ERR_SUP,"Can only set 256 columns at a time; trying to set %D",n);
1125 
1126   for (i=0; i<m; i++) {
1127     for (j=0; j<3-sdim; j++) dxm++;
1128     tmp = *dxm++ - starts[0];
1129     for (j=0; j<sdim-1; j++) {
1130       if ((*dxm++ - starts[j+1]) < 0 || tmp < 0) tmp = PETSC_MIN_INT;
1131       else                                      tmp = tmp*dims[j] + *(dxm-1) - starts[j+1];
1132     }
1133     dxm++;
1134     jdxm[i] = tmp;
1135   }
1136   for (i=0; i<n; i++) {
1137     for (j=0; j<3-sdim; j++) dxn++;
1138     tmp = *dxn++ - starts[0];
1139     for (j=0; j<sdim-1; j++) {
1140       if ((*dxn++ - starts[j+1]) < 0 || tmp < 0) tmp = PETSC_MIN_INT;
1141       else                                       tmp = tmp*dims[j] + *(dxn-1) - starts[j+1];
1142     }
1143     dxn++;
1144     jdxn[i] = tmp;
1145   }
1146   ierr = MatSetValuesBlockedLocal(mat,m,jdxm,n,jdxn,v,addv);CHKERRQ(ierr);
1147   PetscFunctionReturn(0);
1148 }
1149 
1150 #undef __FUNCT__
1151 #define __FUNCT__ "MatSetStencil"
1152 /*@
1153    MatSetStencil - Sets the grid information for setting values into a matrix via
1154         MatSetValuesStencil()
1155 
1156    Not Collective
1157 
1158    Input Parameters:
1159 +  mat - the matrix
1160 .  dim - dimension of the grid 1, 2, or 3
1161 .  dims - number of grid points in x, y, and z direction, including ghost points on your processor
1162 .  starts - starting point of ghost nodes on your processor in x, y, and z direction
1163 -  dof - number of degrees of freedom per node
1164 
1165 
1166    Inspired by the structured grid interface to the HYPRE package
1167    (www.llnl.gov/CASC/hyper)
1168 
1169    For matrices generated with DAGetMatrix() this routine is automatically called and so not needed by the
1170    user.
1171 
1172    Level: beginner
1173 
1174    Concepts: matrices^putting entries in
1175 
1176 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal()
1177           MatSetValues(), MatSetValuesBlockedStencil(), MatSetValuesStencil()
1178 @*/
1179 PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat mat,PetscInt dim,const PetscInt dims[],const PetscInt starts[],PetscInt dof)
1180 {
1181   PetscInt i;
1182 
1183   PetscFunctionBegin;
1184   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
1185   PetscValidIntPointer(dims,3);
1186   PetscValidIntPointer(starts,4);
1187 
1188   mat->stencil.dim = dim + (dof > 1);
1189   for (i=0; i<dim; i++) {
1190     mat->stencil.dims[i]   = dims[dim-i-1];      /* copy the values in backwards */
1191     mat->stencil.starts[i] = starts[dim-i-1];
1192   }
1193   mat->stencil.dims[dim]   = dof;
1194   mat->stencil.starts[dim] = 0;
1195   mat->stencil.noc         = (PetscTruth)(dof == 1);
1196   PetscFunctionReturn(0);
1197 }
1198 
1199 #undef __FUNCT__
1200 #define __FUNCT__ "MatSetValuesBlocked"
1201 /*@
1202    MatSetValuesBlocked - Inserts or adds a block of values into a matrix.
1203 
1204    Not Collective
1205 
1206    Input Parameters:
1207 +  mat - the matrix
1208 .  v - a logically two-dimensional array of values
1209 .  m, idxm - the number of block rows and their global block indices
1210 .  n, idxn - the number of block columns and their global block indices
1211 -  addv - either ADD_VALUES or INSERT_VALUES, where
1212    ADD_VALUES adds values to any existing entries, and
1213    INSERT_VALUES replaces existing entries with new values
1214 
1215    Notes:
1216    The m and n count the NUMBER of blocks in the row direction and column direction,
1217    NOT the total number of rows/columns; for example, if the block size is 2 and
1218    you are passing in values for rows 2,3,4,5  then m would be 2 (not 4).
1219 
1220    By default the values, v, are row-oriented and unsorted. So the layout of
1221    v is the same as for MatSetValues(). See MatSetOption() for other options.
1222 
1223    Calls to MatSetValuesBlocked() with the INSERT_VALUES and ADD_VALUES
1224    options cannot be mixed without intervening calls to the assembly
1225    routines.
1226 
1227    MatSetValuesBlocked() uses 0-based row and column numbers in Fortran
1228    as well as in C.
1229 
1230    Negative indices may be passed in idxm and idxn, these rows and columns are
1231    simply ignored. This allows easily inserting element stiffness matrices
1232    with homogeneous Dirchlet boundary conditions that you don't want represented
1233    in the matrix.
1234 
1235    Each time an entry is set within a sparse matrix via MatSetValues(),
1236    internal searching must be done to determine where to place the the
1237    data in the matrix storage space.  By instead inserting blocks of
1238    entries via MatSetValuesBlocked(), the overhead of matrix assembly is
1239    reduced.
1240 
1241    Example:
1242 $   Suppose m=n=2 and block size(bs) = 2 The matrix is
1243 $
1244 $   1  2  | 3  4
1245 $   5  6  | 7  8
1246 $   - - - | - - -
1247 $   9  10 | 11 12
1248 $   13 14 | 15 16
1249 $
1250 $   v[] should be passed in like
1251 $   v[] = [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16]
1252 
1253    Restrictions:
1254    MatSetValuesBlocked() is currently supported only for the BAIJ and SBAIJ formats
1255 
1256    Level: intermediate
1257 
1258    Concepts: matrices^putting entries in blocked
1259 
1260 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValues(), MatSetValuesBlockedLocal()
1261 @*/
1262 PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat mat,PetscInt m,const PetscInt idxm[],PetscInt n,const PetscInt idxn[],const PetscScalar v[],InsertMode addv)
1263 {
1264   PetscErrorCode ierr;
1265 
1266   PetscFunctionBegin;
1267   if (!m || !n) PetscFunctionReturn(0); /* no values to insert */
1268   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
1269   PetscValidType(mat,1);
1270   PetscValidIntPointer(idxm,3);
1271   PetscValidIntPointer(idxn,5);
1272   PetscValidScalarPointer(v,6);
1273   ierr = MatPreallocated(mat);CHKERRQ(ierr);
1274   if (mat->insertmode == NOT_SET_VALUES) {
1275     mat->insertmode = addv;
1276   }
1277 #if defined(PETSC_USE_DEBUG)
1278   else if (mat->insertmode != addv) {
1279     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
1280   }
1281   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1282 #endif
1283 
1284   if (mat->assembled) {
1285     mat->was_assembled = PETSC_TRUE;
1286     mat->assembled     = PETSC_FALSE;
1287   }
1288   ierr = PetscLogEventBegin(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
1289   if (!mat->ops->setvaluesblocked) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
1290   ierr = (*mat->ops->setvaluesblocked)(mat,m,idxm,n,idxn,v,addv);CHKERRQ(ierr);
1291   ierr = PetscLogEventEnd(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
1292   PetscFunctionReturn(0);
1293 }
1294 
1295 #undef __FUNCT__
1296 #define __FUNCT__ "MatGetValues"
1297 /*@
1298    MatGetValues - Gets a block of values from a matrix.
1299 
1300    Not Collective; currently only returns a local block
1301 
1302    Input Parameters:
1303 +  mat - the matrix
1304 .  v - a logically two-dimensional array for storing the values
1305 .  m, idxm - the number of rows and their global indices
1306 -  n, idxn - the number of columns and their global indices
1307 
1308    Notes:
1309    The user must allocate space (m*n PetscScalars) for the values, v.
1310    The values, v, are then returned in a row-oriented format,
1311    analogous to that used by default in MatSetValues().
1312 
1313    MatGetValues() uses 0-based row and column numbers in
1314    Fortran as well as in C.
1315 
1316    MatGetValues() requires that the matrix has been assembled
1317    with MatAssemblyBegin()/MatAssemblyEnd().  Thus, calls to
1318    MatSetValues() and MatGetValues() CANNOT be made in succession
1319    without intermediate matrix assembly.
1320 
1321    Level: advanced
1322 
1323    Concepts: matrices^accessing values
1324 
1325 .seealso: MatGetRow(), MatGetSubMatrices(), MatSetValues()
1326 @*/
1327 PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat mat,PetscInt m,const PetscInt idxm[],PetscInt n,const PetscInt idxn[],PetscScalar v[])
1328 {
1329   PetscErrorCode ierr;
1330 
1331   PetscFunctionBegin;
1332   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
1333   PetscValidType(mat,1);
1334   PetscValidIntPointer(idxm,3);
1335   PetscValidIntPointer(idxn,5);
1336   PetscValidScalarPointer(v,6);
1337   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
1338   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1339   if (!mat->ops->getvalues) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
1340   ierr = MatPreallocated(mat);CHKERRQ(ierr);
1341 
1342   ierr = PetscLogEventBegin(MAT_GetValues,mat,0,0,0);CHKERRQ(ierr);
1343   ierr = (*mat->ops->getvalues)(mat,m,idxm,n,idxn,v);CHKERRQ(ierr);
1344   ierr = PetscLogEventEnd(MAT_GetValues,mat,0,0,0);CHKERRQ(ierr);
1345   PetscFunctionReturn(0);
1346 }
1347 
1348 #undef __FUNCT__
1349 #define __FUNCT__ "MatSetLocalToGlobalMapping"
1350 /*@
1351    MatSetLocalToGlobalMapping - Sets a local-to-global numbering for use by
1352    the routine MatSetValuesLocal() to allow users to insert matrix entries
1353    using a local (per-processor) numbering.
1354 
1355    Not Collective
1356 
1357    Input Parameters:
1358 +  x - the matrix
1359 -  mapping - mapping created with ISLocalToGlobalMappingCreate()
1360              or ISLocalToGlobalMappingCreateIS()
1361 
1362    Level: intermediate
1363 
1364    Concepts: matrices^local to global mapping
1365    Concepts: local to global mapping^for matrices
1366 
1367 .seealso:  MatAssemblyBegin(), MatAssemblyEnd(), MatSetValues(), MatSetValuesLocal()
1368 @*/
1369 PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat x,ISLocalToGlobalMapping mapping)
1370 {
1371   PetscErrorCode ierr;
1372   PetscFunctionBegin;
1373   PetscValidHeaderSpecific(x,MAT_COOKIE,1);
1374   PetscValidType(x,1);
1375   PetscValidHeaderSpecific(mapping,IS_LTOGM_COOKIE,2);
1376   if (x->mapping) {
1377     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Mapping already set for matrix");
1378   }
1379   ierr = MatPreallocated(x);CHKERRQ(ierr);
1380 
1381   if (x->ops->setlocaltoglobalmapping) {
1382     ierr = (*x->ops->setlocaltoglobalmapping)(x,mapping);CHKERRQ(ierr);
1383   } else {
1384     ierr = PetscObjectReference((PetscObject)mapping);CHKERRQ(ierr);
1385     if (x->mapping) { ierr = ISLocalToGlobalMappingDestroy(x->mapping);CHKERRQ(ierr); }
1386     x->mapping = mapping;
1387   }
1388   PetscFunctionReturn(0);
1389 }
1390 
1391 #undef __FUNCT__
1392 #define __FUNCT__ "MatSetLocalToGlobalMappingBlock"
1393 /*@
1394    MatSetLocalToGlobalMappingBlock - Sets a local-to-global numbering for use
1395    by the routine MatSetValuesBlockedLocal() to allow users to insert matrix
1396    entries using a local (per-processor) numbering.
1397 
1398    Not Collective
1399 
1400    Input Parameters:
1401 +  x - the matrix
1402 -  mapping - mapping created with ISLocalToGlobalMappingCreate() or
1403              ISLocalToGlobalMappingCreateIS()
1404 
1405    Level: intermediate
1406 
1407    Concepts: matrices^local to global mapping blocked
1408    Concepts: local to global mapping^for matrices, blocked
1409 
1410 .seealso:  MatAssemblyBegin(), MatAssemblyEnd(), MatSetValues(), MatSetValuesBlockedLocal(),
1411            MatSetValuesBlocked(), MatSetValuesLocal()
1412 @*/
1413 PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat x,ISLocalToGlobalMapping mapping)
1414 {
1415   PetscErrorCode ierr;
1416   PetscFunctionBegin;
1417   PetscValidHeaderSpecific(x,MAT_COOKIE,1);
1418   PetscValidType(x,1);
1419   PetscValidHeaderSpecific(mapping,IS_LTOGM_COOKIE,2);
1420   if (x->bmapping) {
1421     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Mapping already set for matrix");
1422   }
1423   ierr = PetscObjectReference((PetscObject)mapping);CHKERRQ(ierr);
1424   if (x->bmapping) { ierr = ISLocalToGlobalMappingDestroy(x->mapping);CHKERRQ(ierr); }
1425   x->bmapping = mapping;
1426   PetscFunctionReturn(0);
1427 }
1428 
1429 #undef __FUNCT__
1430 #define __FUNCT__ "MatSetValuesLocal"
1431 /*@
1432    MatSetValuesLocal - Inserts or adds values into certain locations of a matrix,
1433    using a local ordering of the nodes.
1434 
1435    Not Collective
1436 
1437    Input Parameters:
1438 +  x - the matrix
1439 .  nrow, irow - number of rows and their local indices
1440 .  ncol, icol - number of columns and their local indices
1441 .  y -  a logically two-dimensional array of values
1442 -  addv - either INSERT_VALUES or ADD_VALUES, where
1443    ADD_VALUES adds values to any existing entries, and
1444    INSERT_VALUES replaces existing entries with new values
1445 
1446    Notes:
1447    Before calling MatSetValuesLocal(), the user must first set the
1448    local-to-global mapping by calling MatSetLocalToGlobalMapping().
1449 
1450    Calls to MatSetValuesLocal() with the INSERT_VALUES and ADD_VALUES
1451    options cannot be mixed without intervening calls to the assembly
1452    routines.
1453 
1454    These values may be cached, so MatAssemblyBegin() and MatAssemblyEnd()
1455    MUST be called after all calls to MatSetValuesLocal() have been completed.
1456 
1457    Level: intermediate
1458 
1459    Concepts: matrices^putting entries in with local numbering
1460 
1461 .seealso:  MatAssemblyBegin(), MatAssemblyEnd(), MatSetValues(), MatSetLocalToGlobalMapping(),
1462            MatSetValueLocal()
1463 @*/
1464 PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat mat,PetscInt nrow,const PetscInt irow[],PetscInt ncol,const PetscInt icol[],const PetscScalar y[],InsertMode addv)
1465 {
1466   PetscErrorCode ierr;
1467   PetscInt       irowm[2048],icolm[2048];
1468 
1469   PetscFunctionBegin;
1470   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
1471   PetscValidType(mat,1);
1472   PetscValidIntPointer(irow,3);
1473   PetscValidIntPointer(icol,5);
1474   PetscValidScalarPointer(y,6);
1475   ierr = MatPreallocated(mat);CHKERRQ(ierr);
1476   if (mat->insertmode == NOT_SET_VALUES) {
1477     mat->insertmode = addv;
1478   }
1479 #if defined(PETSC_USE_DEBUG)
1480   else if (mat->insertmode != addv) {
1481     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
1482   }
1483   if (!mat->ops->setvalueslocal && (nrow > 2048 || ncol > 2048)) {
1484     SETERRQ2(PETSC_ERR_SUP,"Number column/row indices must be <= 2048: are %D %D",nrow,ncol);
1485   }
1486   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1487 #endif
1488 
1489   if (mat->assembled) {
1490     mat->was_assembled = PETSC_TRUE;
1491     mat->assembled     = PETSC_FALSE;
1492   }
1493   ierr = PetscLogEventBegin(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
1494   if (!mat->ops->setvalueslocal) {
1495     ierr = ISLocalToGlobalMappingApply(mat->mapping,nrow,irow,irowm);CHKERRQ(ierr);
1496     ierr = ISLocalToGlobalMappingApply(mat->mapping,ncol,icol,icolm);CHKERRQ(ierr);
1497     ierr = (*mat->ops->setvalues)(mat,nrow,irowm,ncol,icolm,y,addv);CHKERRQ(ierr);
1498   } else {
1499     ierr = (*mat->ops->setvalueslocal)(mat,nrow,irow,ncol,icol,y,addv);CHKERRQ(ierr);
1500   }
1501   mat->same_nonzero = PETSC_FALSE;
1502   ierr = PetscLogEventEnd(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
1503   PetscFunctionReturn(0);
1504 }
1505 
1506 #undef __FUNCT__
1507 #define __FUNCT__ "MatSetValuesBlockedLocal"
1508 /*@
1509    MatSetValuesBlockedLocal - Inserts or adds values into certain locations of a matrix,
1510    using a local ordering of the nodes a block at a time.
1511 
1512    Not Collective
1513 
1514    Input Parameters:
1515 +  x - the matrix
1516 .  nrow, irow - number of rows and their local indices
1517 .  ncol, icol - number of columns and their local indices
1518 .  y -  a logically two-dimensional array of values
1519 -  addv - either INSERT_VALUES or ADD_VALUES, where
1520    ADD_VALUES adds values to any existing entries, and
1521    INSERT_VALUES replaces existing entries with new values
1522 
1523    Notes:
1524    Before calling MatSetValuesBlockedLocal(), the user must first set the
1525    local-to-global mapping by calling MatSetLocalToGlobalMappingBlock(),
1526    where the mapping MUST be set for matrix blocks, not for matrix elements.
1527 
1528    Calls to MatSetValuesBlockedLocal() with the INSERT_VALUES and ADD_VALUES
1529    options cannot be mixed without intervening calls to the assembly
1530    routines.
1531 
1532    These values may be cached, so MatAssemblyBegin() and MatAssemblyEnd()
1533    MUST be called after all calls to MatSetValuesBlockedLocal() have been completed.
1534 
1535    Level: intermediate
1536 
1537    Concepts: matrices^putting blocked values in with local numbering
1538 
1539 .seealso:  MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesLocal(), MatSetLocalToGlobalMappingBlock(), MatSetValuesBlocked()
1540 @*/
1541 PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat mat,PetscInt nrow,const PetscInt irow[],PetscInt ncol,const PetscInt icol[],const PetscScalar y[],InsertMode addv)
1542 {
1543   PetscErrorCode ierr;
1544   PetscInt       irowm[2048],icolm[2048];
1545 
1546   PetscFunctionBegin;
1547   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
1548   PetscValidType(mat,1);
1549   PetscValidIntPointer(irow,3);
1550   PetscValidIntPointer(icol,5);
1551   PetscValidScalarPointer(y,6);
1552   ierr = MatPreallocated(mat);CHKERRQ(ierr);
1553   if (mat->insertmode == NOT_SET_VALUES) {
1554     mat->insertmode = addv;
1555   }
1556 #if defined(PETSC_USE_DEBUG)
1557   else if (mat->insertmode != addv) {
1558     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Cannot mix add values and insert values");
1559   }
1560   if (!mat->bmapping) {
1561     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Local to global never set with MatSetLocalToGlobalMappingBlock()");
1562   }
1563   if (nrow > 2048 || ncol > 2048) {
1564     SETERRQ2(PETSC_ERR_SUP,"Number column/row indices must be <= 2048: are %D %D",nrow,ncol);
1565   }
1566   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1567 #endif
1568 
1569   if (mat->assembled) {
1570     mat->was_assembled = PETSC_TRUE;
1571     mat->assembled     = PETSC_FALSE;
1572   }
1573   ierr = PetscLogEventBegin(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
1574   ierr = ISLocalToGlobalMappingApply(mat->bmapping,nrow,irow,irowm);CHKERRQ(ierr);
1575   ierr = ISLocalToGlobalMappingApply(mat->bmapping,ncol,icol,icolm);CHKERRQ(ierr);
1576   ierr = (*mat->ops->setvaluesblocked)(mat,nrow,irowm,ncol,icolm,y,addv);CHKERRQ(ierr);
1577   ierr = PetscLogEventEnd(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
1578   PetscFunctionReturn(0);
1579 }
1580 
1581 /* --------------------------------------------------------*/
1582 #undef __FUNCT__
1583 #define __FUNCT__ "MatMult"
1584 /*@
1585    MatMult - Computes the matrix-vector product, y = Ax.
1586 
1587    Collective on Mat and Vec
1588 
1589    Input Parameters:
1590 +  mat - the matrix
1591 -  x   - the vector to be multiplied
1592 
1593    Output Parameters:
1594 .  y - the result
1595 
1596    Notes:
1597    The vectors x and y cannot be the same.  I.e., one cannot
1598    call MatMult(A,y,y).
1599 
1600    Level: beginner
1601 
1602    Concepts: matrix-vector product
1603 
1604 .seealso: MatMultTranspose(), MatMultAdd(), MatMultTransposeAdd()
1605 @*/
1606 PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat mat,Vec x,Vec y)
1607 {
1608   PetscErrorCode ierr;
1609 
1610   PetscFunctionBegin;
1611   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
1612   PetscValidType(mat,1);
1613   PetscValidHeaderSpecific(x,VEC_COOKIE,2);
1614   PetscValidHeaderSpecific(y,VEC_COOKIE,3);
1615 
1616   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
1617   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1618   if (x == y) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
1619 #ifndef PETSC_HAVE_CONSTRAINTS
1620   if (mat->cmap.N != x->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap.N,x->map.N);
1621   if (mat->rmap.N != y->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: global dim %D %D",mat->rmap.N,y->map.N);
1622   if (mat->rmap.n != y->map.n) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: local dim %D %D",mat->rmap.n,y->map.n);
1623 #endif
1624   ierr = MatPreallocated(mat);CHKERRQ(ierr);
1625 
1626   if (mat->nullsp) {
1627     ierr = MatNullSpaceRemove(mat->nullsp,x,&x);CHKERRQ(ierr);
1628   }
1629 
1630   if (!mat->ops->mult) SETERRQ(PETSC_ERR_SUP,"This matrix type does not have a multiply defined");
1631   ierr = PetscLogEventBegin(MAT_Mult,mat,x,y,0);CHKERRQ(ierr);
1632   ierr = (*mat->ops->mult)(mat,x,y);CHKERRQ(ierr);
1633   ierr = PetscLogEventEnd(MAT_Mult,mat,x,y,0);CHKERRQ(ierr);
1634 
1635   if (mat->nullsp) {
1636     ierr = MatNullSpaceRemove(mat->nullsp,y,PETSC_NULL);CHKERRQ(ierr);
1637   }
1638   ierr = PetscObjectStateIncrease((PetscObject)y);CHKERRQ(ierr);
1639   PetscFunctionReturn(0);
1640 }
1641 
1642 #undef __FUNCT__
1643 #define __FUNCT__ "MatMultTranspose"
1644 /*@
1645    MatMultTranspose - Computes matrix transpose times a vector.
1646 
1647    Collective on Mat and Vec
1648 
1649    Input Parameters:
1650 +  mat - the matrix
1651 -  x   - the vector to be multilplied
1652 
1653    Output Parameters:
1654 .  y - the result
1655 
1656    Notes:
1657    The vectors x and y cannot be the same.  I.e., one cannot
1658    call MatMultTranspose(A,y,y).
1659 
1660    Level: beginner
1661 
1662    Concepts: matrix vector product^transpose
1663 
1664 .seealso: MatMult(), MatMultAdd(), MatMultTransposeAdd()
1665 @*/
1666 PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat mat,Vec x,Vec y)
1667 {
1668   PetscErrorCode ierr;
1669 
1670   PetscFunctionBegin;
1671   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
1672   PetscValidType(mat,1);
1673   PetscValidHeaderSpecific(x,VEC_COOKIE,2);
1674   PetscValidHeaderSpecific(y,VEC_COOKIE,3);
1675 
1676   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
1677   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1678   if (x == y) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
1679 #ifndef PETSC_HAVE_CONSTRAINTS
1680   if (mat->rmap.N != x->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->rmap.N,x->map.N);
1681   if (mat->cmap.N != y->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: global dim %D %D",mat->cmap.N,y->map.N);
1682 #endif
1683   ierr = MatPreallocated(mat);CHKERRQ(ierr);
1684 
1685   if (!mat->ops->multtranspose) SETERRQ(PETSC_ERR_SUP,"This matrix type does not have a multiply tranpose defined");
1686   ierr = PetscLogEventBegin(MAT_MultTranspose,mat,x,y,0);CHKERRQ(ierr);
1687   ierr = (*mat->ops->multtranspose)(mat,x,y);CHKERRQ(ierr);
1688   ierr = PetscLogEventEnd(MAT_MultTranspose,mat,x,y,0);CHKERRQ(ierr);
1689   ierr = PetscObjectStateIncrease((PetscObject)y);CHKERRQ(ierr);
1690   PetscFunctionReturn(0);
1691 }
1692 
1693 #undef __FUNCT__
1694 #define __FUNCT__ "MatMultAdd"
1695 /*@
1696     MatMultAdd -  Computes v3 = v2 + A * v1.
1697 
1698     Collective on Mat and Vec
1699 
1700     Input Parameters:
1701 +   mat - the matrix
1702 -   v1, v2 - the vectors
1703 
1704     Output Parameters:
1705 .   v3 - the result
1706 
1707     Notes:
1708     The vectors v1 and v3 cannot be the same.  I.e., one cannot
1709     call MatMultAdd(A,v1,v2,v1).
1710 
1711     Level: beginner
1712 
1713     Concepts: matrix vector product^addition
1714 
1715 .seealso: MatMultTranspose(), MatMult(), MatMultTransposeAdd()
1716 @*/
1717 PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat mat,Vec v1,Vec v2,Vec v3)
1718 {
1719   PetscErrorCode ierr;
1720 
1721   PetscFunctionBegin;
1722   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
1723   PetscValidType(mat,1);
1724   PetscValidHeaderSpecific(v1,VEC_COOKIE,2);
1725   PetscValidHeaderSpecific(v2,VEC_COOKIE,3);
1726   PetscValidHeaderSpecific(v3,VEC_COOKIE,4);
1727 
1728   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
1729   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1730   if (mat->cmap.N != v1->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec v1: global dim %D %D",mat->cmap.N,v1->map.N);
1731   if (mat->rmap.N != v2->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec v2: global dim %D %D",mat->rmap.N,v2->map.N);
1732   if (mat->rmap.N != v3->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec v3: global dim %D %D",mat->rmap.N,v3->map.N);
1733   if (mat->rmap.n != v3->map.n) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec v3: local dim %D %D",mat->rmap.n,v3->map.n);
1734   if (mat->rmap.n != v2->map.n) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec v2: local dim %D %D",mat->rmap.n,v2->map.n);
1735   if (v1 == v3) SETERRQ(PETSC_ERR_ARG_IDN,"v1 and v3 must be different vectors");
1736   ierr = MatPreallocated(mat);CHKERRQ(ierr);
1737 
1738   ierr = PetscLogEventBegin(MAT_MultAdd,mat,v1,v2,v3);CHKERRQ(ierr);
1739   ierr = (*mat->ops->multadd)(mat,v1,v2,v3);CHKERRQ(ierr);
1740   ierr = PetscLogEventEnd(MAT_MultAdd,mat,v1,v2,v3);CHKERRQ(ierr);
1741   ierr = PetscObjectStateIncrease((PetscObject)v3);CHKERRQ(ierr);
1742   PetscFunctionReturn(0);
1743 }
1744 
1745 #undef __FUNCT__
1746 #define __FUNCT__ "MatMultTransposeAdd"
1747 /*@
1748    MatMultTransposeAdd - Computes v3 = v2 + A' * v1.
1749 
1750    Collective on Mat and Vec
1751 
1752    Input Parameters:
1753 +  mat - the matrix
1754 -  v1, v2 - the vectors
1755 
1756    Output Parameters:
1757 .  v3 - the result
1758 
1759    Notes:
1760    The vectors v1 and v3 cannot be the same.  I.e., one cannot
1761    call MatMultTransposeAdd(A,v1,v2,v1).
1762 
1763    Level: beginner
1764 
1765    Concepts: matrix vector product^transpose and addition
1766 
1767 .seealso: MatMultTranspose(), MatMultAdd(), MatMult()
1768 @*/
1769 PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat mat,Vec v1,Vec v2,Vec v3)
1770 {
1771   PetscErrorCode ierr;
1772 
1773   PetscFunctionBegin;
1774   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
1775   PetscValidType(mat,1);
1776   PetscValidHeaderSpecific(v1,VEC_COOKIE,2);
1777   PetscValidHeaderSpecific(v2,VEC_COOKIE,3);
1778   PetscValidHeaderSpecific(v3,VEC_COOKIE,4);
1779 
1780   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
1781   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1782   if (!mat->ops->multtransposeadd) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
1783   if (v1 == v3) SETERRQ(PETSC_ERR_ARG_IDN,"v1 and v3 must be different vectors");
1784   if (mat->rmap.N != v1->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec v1: global dim %D %D",mat->rmap.N,v1->map.N);
1785   if (mat->cmap.N != v2->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec v2: global dim %D %D",mat->cmap.N,v2->map.N);
1786   if (mat->cmap.N != v3->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec v3: global dim %D %D",mat->cmap.N,v3->map.N);
1787   ierr = MatPreallocated(mat);CHKERRQ(ierr);
1788 
1789   ierr = PetscLogEventBegin(MAT_MultTransposeAdd,mat,v1,v2,v3);CHKERRQ(ierr);
1790   ierr = (*mat->ops->multtransposeadd)(mat,v1,v2,v3);CHKERRQ(ierr);
1791   ierr = PetscLogEventEnd(MAT_MultTransposeAdd,mat,v1,v2,v3);CHKERRQ(ierr);
1792   ierr = PetscObjectStateIncrease((PetscObject)v3);CHKERRQ(ierr);
1793   PetscFunctionReturn(0);
1794 }
1795 
1796 #undef __FUNCT__
1797 #define __FUNCT__ "MatMultConstrained"
1798 /*@
1799    MatMultConstrained - The inner multiplication routine for a
1800    constrained matrix P^T A P.
1801 
1802    Collective on Mat and Vec
1803 
1804    Input Parameters:
1805 +  mat - the matrix
1806 -  x   - the vector to be multilplied
1807 
1808    Output Parameters:
1809 .  y - the result
1810 
1811    Notes:
1812    The vectors x and y cannot be the same.  I.e., one cannot
1813    call MatMult(A,y,y).
1814 
1815    Level: beginner
1816 
1817 .keywords: matrix, multiply, matrix-vector product, constraint
1818 .seealso: MatMult(), MatMultTrans(), MatMultAdd(), MatMultTransAdd()
1819 @*/
1820 PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat mat,Vec x,Vec y)
1821 {
1822   PetscErrorCode ierr;
1823 
1824   PetscFunctionBegin;
1825   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
1826   PetscValidHeaderSpecific(x,VEC_COOKIE,2);
1827   PetscValidHeaderSpecific(y,VEC_COOKIE,3);
1828   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
1829   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1830   if (x == y) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
1831   if (mat->cmap.N != x->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap.N,x->map.N);
1832   if (mat->rmap.N != y->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: global dim %D %D",mat->rmap.N,y->map.N);
1833   if (mat->rmap.n != y->map.n) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: local dim %D %D",mat->rmap.n,y->map.n);
1834 
1835   ierr = PetscLogEventBegin(MAT_MultConstrained,mat,x,y,0);CHKERRQ(ierr);
1836   ierr = (*mat->ops->multconstrained)(mat,x,y);CHKERRQ(ierr);
1837   ierr = PetscLogEventEnd(MAT_MultConstrained,mat,x,y,0);CHKERRQ(ierr);
1838   ierr = PetscObjectStateIncrease((PetscObject)y);CHKERRQ(ierr);
1839 
1840   PetscFunctionReturn(0);
1841 }
1842 
1843 #undef __FUNCT__
1844 #define __FUNCT__ "MatMultTransposeConstrained"
1845 /*@
1846    MatMultTransposeConstrained - The inner multiplication routine for a
1847    constrained matrix P^T A^T P.
1848 
1849    Collective on Mat and Vec
1850 
1851    Input Parameters:
1852 +  mat - the matrix
1853 -  x   - the vector to be multilplied
1854 
1855    Output Parameters:
1856 .  y - the result
1857 
1858    Notes:
1859    The vectors x and y cannot be the same.  I.e., one cannot
1860    call MatMult(A,y,y).
1861 
1862    Level: beginner
1863 
1864 .keywords: matrix, multiply, matrix-vector product, constraint
1865 .seealso: MatMult(), MatMultTrans(), MatMultAdd(), MatMultTransAdd()
1866 @*/
1867 PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat mat,Vec x,Vec y)
1868 {
1869   PetscErrorCode ierr;
1870 
1871   PetscFunctionBegin;
1872   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
1873   PetscValidHeaderSpecific(x,VEC_COOKIE,2);
1874   PetscValidHeaderSpecific(y,VEC_COOKIE,3);
1875   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
1876   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
1877   if (x == y) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"x and y must be different vectors");
1878   if (mat->rmap.N != x->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap.N,x->map.N);
1879   if (mat->cmap.N != y->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: global dim %D %D",mat->rmap.N,y->map.N);
1880 
1881   ierr = PetscLogEventBegin(MAT_MultConstrained,mat,x,y,0);CHKERRQ(ierr);
1882   ierr = (*mat->ops->multtransposeconstrained)(mat,x,y);CHKERRQ(ierr);
1883   ierr = PetscLogEventEnd(MAT_MultConstrained,mat,x,y,0);CHKERRQ(ierr);
1884   ierr = PetscObjectStateIncrease((PetscObject)y);CHKERRQ(ierr);
1885 
1886   PetscFunctionReturn(0);
1887 }
1888 /* ------------------------------------------------------------*/
1889 #undef __FUNCT__
1890 #define __FUNCT__ "MatGetInfo"
1891 /*@
1892    MatGetInfo - Returns information about matrix storage (number of
1893    nonzeros, memory, etc.).
1894 
1895    Collective on Mat if MAT_GLOBAL_MAX or MAT_GLOBAL_SUM is used
1896    as the flag
1897 
1898    Input Parameters:
1899 .  mat - the matrix
1900 
1901    Output Parameters:
1902 +  flag - flag indicating the type of parameters to be returned
1903    (MAT_LOCAL - local matrix, MAT_GLOBAL_MAX - maximum over all processors,
1904    MAT_GLOBAL_SUM - sum over all processors)
1905 -  info - matrix information context
1906 
1907    Notes:
1908    The MatInfo context contains a variety of matrix data, including
1909    number of nonzeros allocated and used, number of mallocs during
1910    matrix assembly, etc.  Additional information for factored matrices
1911    is provided (such as the fill ratio, number of mallocs during
1912    factorization, etc.).  Much of this info is printed to STDOUT
1913    when using the runtime options
1914 $       -info -mat_view_info
1915 
1916    Example for C/C++ Users:
1917    See the file ${PETSC_DIR}/include/petscmat.h for a complete list of
1918    data within the MatInfo context.  For example,
1919 .vb
1920       MatInfo info;
1921       Mat     A;
1922       double  mal, nz_a, nz_u;
1923 
1924       MatGetInfo(A,MAT_LOCAL,&info);
1925       mal  = info.mallocs;
1926       nz_a = info.nz_allocated;
1927 .ve
1928 
1929    Example for Fortran Users:
1930    Fortran users should declare info as a double precision
1931    array of dimension MAT_INFO_SIZE, and then extract the parameters
1932    of interest.  See the file ${PETSC_DIR}/include/finclude/petscmat.h
1933    a complete list of parameter names.
1934 .vb
1935       double  precision info(MAT_INFO_SIZE)
1936       double  precision mal, nz_a
1937       Mat     A
1938       integer ierr
1939 
1940       call MatGetInfo(A,MAT_LOCAL,info,ierr)
1941       mal = info(MAT_INFO_MALLOCS)
1942       nz_a = info(MAT_INFO_NZ_ALLOCATED)
1943 .ve
1944 
1945     Level: intermediate
1946 
1947     Concepts: matrices^getting information on
1948 
1949 @*/
1950 PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat mat,MatInfoType flag,MatInfo *info)
1951 {
1952   PetscErrorCode ierr;
1953 
1954   PetscFunctionBegin;
1955   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
1956   PetscValidType(mat,1);
1957   PetscValidPointer(info,3);
1958   if (!mat->ops->getinfo) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
1959   ierr = MatPreallocated(mat);CHKERRQ(ierr);
1960   ierr = (*mat->ops->getinfo)(mat,flag,info);CHKERRQ(ierr);
1961   PetscFunctionReturn(0);
1962 }
1963 
1964 /* ----------------------------------------------------------*/
1965 #undef __FUNCT__
1966 #define __FUNCT__ "MatILUDTFactor"
1967 /*@C
1968    MatILUDTFactor - Performs a drop tolerance ILU factorization.
1969 
1970    Collective on Mat
1971 
1972    Input Parameters:
1973 +  mat - the matrix
1974 .  row - row permutation
1975 .  col - column permutation
1976 -  info - information about the factorization to be done
1977 
1978    Output Parameters:
1979 .  fact - the factored matrix
1980 
1981    Level: developer
1982 
1983    Notes:
1984    Most users should employ the simplified KSP interface for linear solvers
1985    instead of working directly with matrix algebra routines such as this.
1986    See, e.g., KSPCreate().
1987 
1988    This is currently only supported for the SeqAIJ matrix format using code
1989    from Yousef Saad's SPARSEKIT2  package (translated to C with f2c) and/or
1990    Matlab. SPARSEKIT2 is copyrighted by Yousef Saad with the GNU copyright
1991    and thus can be distributed with PETSc.
1992 
1993     Concepts: matrices^ILUDT factorization
1994 
1995 .seealso: MatLUFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor(), MatFactorInfo
1996 @*/
1997 PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactor(Mat mat,IS row,IS col,MatFactorInfo *info,Mat *fact)
1998 {
1999   PetscErrorCode ierr;
2000 
2001   PetscFunctionBegin;
2002   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2003   PetscValidType(mat,1);
2004   if (row) PetscValidHeaderSpecific(row,IS_COOKIE,2);
2005   if (col) PetscValidHeaderSpecific(col,IS_COOKIE,3);
2006   PetscValidPointer(info,4);
2007   PetscValidPointer(fact,5);
2008   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2009   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2010   if (!mat->ops->iludtfactor) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
2011   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2012   ierr = PetscLogEventBegin(MAT_ILUFactor,mat,row,col,0);CHKERRQ(ierr);
2013   ierr = (*mat->ops->iludtfactor)(mat,row,col,info,fact);CHKERRQ(ierr);
2014   ierr = PetscLogEventEnd(MAT_ILUFactor,mat,row,col,0);CHKERRQ(ierr);
2015   ierr = PetscObjectStateIncrease((PetscObject)*fact);CHKERRQ(ierr);
2016 
2017   PetscFunctionReturn(0);
2018 }
2019 
2020 #undef __FUNCT__
2021 #define __FUNCT__ "MatLUFactor"
2022 /*@
2023    MatLUFactor - Performs in-place LU factorization of matrix.
2024 
2025    Collective on Mat
2026 
2027    Input Parameters:
2028 +  mat - the matrix
2029 .  row - row permutation
2030 .  col - column permutation
2031 -  info - options for factorization, includes
2032 $          fill - expected fill as ratio of original fill.
2033 $          dtcol - pivot tolerance (0 no pivot, 1 full column pivoting)
2034 $                   Run with the option -info to determine an optimal value to use
2035 
2036    Notes:
2037    Most users should employ the simplified KSP interface for linear solvers
2038    instead of working directly with matrix algebra routines such as this.
2039    See, e.g., KSPCreate().
2040 
2041    This changes the state of the matrix to a factored matrix; it cannot be used
2042    for example with MatSetValues() unless one first calls MatSetUnfactored().
2043 
2044    Level: developer
2045 
2046    Concepts: matrices^LU factorization
2047 
2048 .seealso: MatLUFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor(),
2049           MatGetOrdering(), MatSetUnfactored(), MatFactorInfo
2050 
2051 @*/
2052 PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat mat,IS row,IS col,MatFactorInfo *info)
2053 {
2054   PetscErrorCode ierr;
2055 
2056   PetscFunctionBegin;
2057   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2058   if (row) PetscValidHeaderSpecific(row,IS_COOKIE,2);
2059   if (col) PetscValidHeaderSpecific(col,IS_COOKIE,3);
2060   PetscValidPointer(info,4);
2061   PetscValidType(mat,1);
2062   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2063   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2064   if (!mat->ops->lufactor) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
2065   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2066 
2067   ierr = PetscLogEventBegin(MAT_LUFactor,mat,row,col,0);CHKERRQ(ierr);
2068   ierr = (*mat->ops->lufactor)(mat,row,col,info);CHKERRQ(ierr);
2069   ierr = PetscLogEventEnd(MAT_LUFactor,mat,row,col,0);CHKERRQ(ierr);
2070   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
2071   PetscFunctionReturn(0);
2072 }
2073 
2074 #undef __FUNCT__
2075 #define __FUNCT__ "MatILUFactor"
2076 /*@
2077    MatILUFactor - Performs in-place ILU factorization of matrix.
2078 
2079    Collective on Mat
2080 
2081    Input Parameters:
2082 +  mat - the matrix
2083 .  row - row permutation
2084 .  col - column permutation
2085 -  info - structure containing
2086 $      levels - number of levels of fill.
2087 $      expected fill - as ratio of original fill.
2088 $      1 or 0 - indicating force fill on diagonal (improves robustness for matrices
2089                 missing diagonal entries)
2090 
2091    Notes:
2092    Probably really in-place only when level of fill is zero, otherwise allocates
2093    new space to store factored matrix and deletes previous memory.
2094 
2095    Most users should employ the simplified KSP interface for linear solvers
2096    instead of working directly with matrix algebra routines such as this.
2097    See, e.g., KSPCreate().
2098 
2099    Level: developer
2100 
2101    Concepts: matrices^ILU factorization
2102 
2103 .seealso: MatILUFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor(), MatFactorInfo
2104 @*/
2105 PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat mat,IS row,IS col,MatFactorInfo *info)
2106 {
2107   PetscErrorCode ierr;
2108 
2109   PetscFunctionBegin;
2110   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2111   if (row) PetscValidHeaderSpecific(row,IS_COOKIE,2);
2112   if (col) PetscValidHeaderSpecific(col,IS_COOKIE,3);
2113   PetscValidPointer(info,4);
2114   PetscValidType(mat,1);
2115   if (mat->rmap.N != mat->cmap.N) SETERRQ(PETSC_ERR_ARG_WRONG,"matrix must be square");
2116   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2117   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2118   if (!mat->ops->ilufactor) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
2119   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2120 
2121   ierr = PetscLogEventBegin(MAT_ILUFactor,mat,row,col,0);CHKERRQ(ierr);
2122   ierr = (*mat->ops->ilufactor)(mat,row,col,info);CHKERRQ(ierr);
2123   ierr = PetscLogEventEnd(MAT_ILUFactor,mat,row,col,0);CHKERRQ(ierr);
2124   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
2125   PetscFunctionReturn(0);
2126 }
2127 
2128 #undef __FUNCT__
2129 #define __FUNCT__ "MatLUFactorSymbolic"
2130 /*@
2131    MatLUFactorSymbolic - Performs symbolic LU factorization of matrix.
2132    Call this routine before calling MatLUFactorNumeric().
2133 
2134    Collective on Mat
2135 
2136    Input Parameters:
2137 +  mat - the matrix
2138 .  row, col - row and column permutations
2139 -  info - options for factorization, includes
2140 $          fill - expected fill as ratio of original fill.
2141 $          dtcol - pivot tolerance (0 no pivot, 1 full column pivoting)
2142 $                   Run with the option -info to determine an optimal value to use
2143 
2144    Output Parameter:
2145 .  fact - new matrix that has been symbolically factored
2146 
2147    Notes:
2148    See the users manual for additional information about
2149    choosing the fill factor for better efficiency.
2150 
2151    Most users should employ the simplified KSP interface for linear solvers
2152    instead of working directly with matrix algebra routines such as this.
2153    See, e.g., KSPCreate().
2154 
2155    Level: developer
2156 
2157    Concepts: matrices^LU symbolic factorization
2158 
2159 .seealso: MatLUFactor(), MatLUFactorNumeric(), MatCholeskyFactor(), MatFactorInfo
2160 @*/
2161 PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat mat,IS row,IS col,MatFactorInfo *info,Mat *fact)
2162 {
2163   PetscErrorCode ierr;
2164 
2165   PetscFunctionBegin;
2166   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2167   if (row) PetscValidHeaderSpecific(row,IS_COOKIE,2);
2168   if (col) PetscValidHeaderSpecific(col,IS_COOKIE,3);
2169   PetscValidPointer(info,4);
2170   PetscValidType(mat,1);
2171   PetscValidPointer(fact,5);
2172   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2173   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2174   if (!mat->ops->lufactorsymbolic) SETERRQ1(PETSC_ERR_SUP,"Matrix type %s  symbolic LU",mat->type_name);
2175   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2176 
2177   ierr = PetscLogEventBegin(MAT_LUFactorSymbolic,mat,row,col,0);CHKERRQ(ierr);
2178   ierr = (*mat->ops->lufactorsymbolic)(mat,row,col,info,fact);CHKERRQ(ierr);
2179   ierr = PetscLogEventEnd(MAT_LUFactorSymbolic,mat,row,col,0);CHKERRQ(ierr);
2180   ierr = PetscObjectStateIncrease((PetscObject)*fact);CHKERRQ(ierr);
2181   PetscFunctionReturn(0);
2182 }
2183 
2184 #undef __FUNCT__
2185 #define __FUNCT__ "MatLUFactorNumeric"
2186 /*@
2187    MatLUFactorNumeric - Performs numeric LU factorization of a matrix.
2188    Call this routine after first calling MatLUFactorSymbolic().
2189 
2190    Collective on Mat
2191 
2192    Input Parameters:
2193 +  mat - the matrix
2194 .  info - options for factorization
2195 -  fact - the matrix generated for the factor, from MatLUFactorSymbolic()
2196 
2197    Notes:
2198    See MatLUFactor() for in-place factorization.  See
2199    MatCholeskyFactorNumeric() for the symmetric, positive definite case.
2200 
2201    Most users should employ the simplified KSP interface for linear solvers
2202    instead of working directly with matrix algebra routines such as this.
2203    See, e.g., KSPCreate().
2204 
2205    Level: developer
2206 
2207    Concepts: matrices^LU numeric factorization
2208 
2209 .seealso: MatLUFactorSymbolic(), MatLUFactor(), MatCholeskyFactor()
2210 @*/
2211 PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat mat,MatFactorInfo *info,Mat *fact)
2212 {
2213   PetscErrorCode ierr;
2214 
2215   PetscFunctionBegin;
2216   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2217   PetscValidType(mat,1);
2218   PetscValidPointer(fact,2);
2219   PetscValidHeaderSpecific(*fact,MAT_COOKIE,2);
2220   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2221   if (mat->rmap.N != (*fact)->rmap.N || mat->cmap.N != (*fact)->cmap.N) {
2222     SETERRQ4(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);
2223   }
2224   if (!(*fact)->ops->lufactornumeric) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
2225   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2226   ierr = PetscLogEventBegin(MAT_LUFactorNumeric,mat,*fact,0,0);CHKERRQ(ierr);
2227   ierr = (*(*fact)->ops->lufactornumeric)(mat,info,fact);CHKERRQ(ierr);
2228   ierr = PetscLogEventEnd(MAT_LUFactorNumeric,mat,*fact,0,0);CHKERRQ(ierr);
2229 
2230   ierr = MatView_Private(*fact);CHKERRQ(ierr);
2231   ierr = PetscObjectStateIncrease((PetscObject)*fact);CHKERRQ(ierr);
2232   PetscFunctionReturn(0);
2233 }
2234 
2235 #undef __FUNCT__
2236 #define __FUNCT__ "MatCholeskyFactor"
2237 /*@
2238    MatCholeskyFactor - Performs in-place Cholesky factorization of a
2239    symmetric matrix.
2240 
2241    Collective on Mat
2242 
2243    Input Parameters:
2244 +  mat - the matrix
2245 .  perm - row and column permutations
2246 -  f - expected fill as ratio of original fill
2247 
2248    Notes:
2249    See MatLUFactor() for the nonsymmetric case.  See also
2250    MatCholeskyFactorSymbolic(), and MatCholeskyFactorNumeric().
2251 
2252    Most users should employ the simplified KSP interface for linear solvers
2253    instead of working directly with matrix algebra routines such as this.
2254    See, e.g., KSPCreate().
2255 
2256    Level: developer
2257 
2258    Concepts: matrices^Cholesky factorization
2259 
2260 .seealso: MatLUFactor(), MatCholeskyFactorSymbolic(), MatCholeskyFactorNumeric()
2261           MatGetOrdering()
2262 
2263 @*/
2264 PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat mat,IS perm,MatFactorInfo *info)
2265 {
2266   PetscErrorCode ierr;
2267 
2268   PetscFunctionBegin;
2269   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2270   PetscValidType(mat,1);
2271   PetscValidHeaderSpecific(perm,IS_COOKIE,2);
2272   PetscValidPointer(info,3);
2273   if (mat->rmap.N != mat->cmap.N) SETERRQ(PETSC_ERR_ARG_WRONG,"Matrix must be square");
2274   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2275   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2276   if (!mat->ops->choleskyfactor) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
2277   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2278 
2279   ierr = PetscLogEventBegin(MAT_CholeskyFactor,mat,perm,0,0);CHKERRQ(ierr);
2280   ierr = (*mat->ops->choleskyfactor)(mat,perm,info);CHKERRQ(ierr);
2281   ierr = PetscLogEventEnd(MAT_CholeskyFactor,mat,perm,0,0);CHKERRQ(ierr);
2282   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
2283   PetscFunctionReturn(0);
2284 }
2285 
2286 #undef __FUNCT__
2287 #define __FUNCT__ "MatCholeskyFactorSymbolic"
2288 /*@
2289    MatCholeskyFactorSymbolic - Performs symbolic Cholesky factorization
2290    of a symmetric matrix.
2291 
2292    Collective on Mat
2293 
2294    Input Parameters:
2295 +  mat - the matrix
2296 .  perm - row and column permutations
2297 -  info - options for factorization, includes
2298 $          fill - expected fill as ratio of original fill.
2299 $          dtcol - pivot tolerance (0 no pivot, 1 full column pivoting)
2300 $                   Run with the option -info to determine an optimal value to use
2301 
2302    Output Parameter:
2303 .  fact - the factored matrix
2304 
2305    Notes:
2306    See MatLUFactorSymbolic() for the nonsymmetric case.  See also
2307    MatCholeskyFactor() and MatCholeskyFactorNumeric().
2308 
2309    Most users should employ the simplified KSP interface for linear solvers
2310    instead of working directly with matrix algebra routines such as this.
2311    See, e.g., KSPCreate().
2312 
2313    Level: developer
2314 
2315    Concepts: matrices^Cholesky symbolic factorization
2316 
2317 .seealso: MatLUFactorSymbolic(), MatCholeskyFactor(), MatCholeskyFactorNumeric()
2318           MatGetOrdering()
2319 
2320 @*/
2321 PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat mat,IS perm,MatFactorInfo *info,Mat *fact)
2322 {
2323   PetscErrorCode ierr;
2324 
2325   PetscFunctionBegin;
2326   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2327   PetscValidType(mat,1);
2328   if (perm) PetscValidHeaderSpecific(perm,IS_COOKIE,2);
2329   PetscValidPointer(info,3);
2330   PetscValidPointer(fact,4);
2331   if (mat->rmap.N != mat->cmap.N) SETERRQ(PETSC_ERR_ARG_WRONG,"Matrix must be square");
2332   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2333   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2334   if (!mat->ops->choleskyfactorsymbolic) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
2335   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2336 
2337   ierr = PetscLogEventBegin(MAT_CholeskyFactorSymbolic,mat,perm,0,0);CHKERRQ(ierr);
2338   ierr = (*mat->ops->choleskyfactorsymbolic)(mat,perm,info,fact);CHKERRQ(ierr);
2339   ierr = PetscLogEventEnd(MAT_CholeskyFactorSymbolic,mat,perm,0,0);CHKERRQ(ierr);
2340   ierr = PetscObjectStateIncrease((PetscObject)*fact);CHKERRQ(ierr);
2341   PetscFunctionReturn(0);
2342 }
2343 
2344 #undef __FUNCT__
2345 #define __FUNCT__ "MatCholeskyFactorNumeric"
2346 /*@
2347    MatCholeskyFactorNumeric - Performs numeric Cholesky factorization
2348    of a symmetric matrix. Call this routine after first calling
2349    MatCholeskyFactorSymbolic().
2350 
2351    Collective on Mat
2352 
2353    Input Parameter:
2354 .  mat - the initial matrix
2355 .  info - options for factorization
2356 -  fact - the symbolic factor of mat
2357 
2358    Output Parameter:
2359 .  fact - the factored matrix
2360 
2361    Notes:
2362    Most users should employ the simplified KSP interface for linear solvers
2363    instead of working directly with matrix algebra routines such as this.
2364    See, e.g., KSPCreate().
2365 
2366    Level: developer
2367 
2368    Concepts: matrices^Cholesky numeric factorization
2369 
2370 .seealso: MatCholeskyFactorSymbolic(), MatCholeskyFactor(), MatLUFactorNumeric()
2371 @*/
2372 PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat mat,MatFactorInfo *info,Mat *fact)
2373 {
2374   PetscErrorCode ierr;
2375 
2376   PetscFunctionBegin;
2377   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2378   PetscValidType(mat,1);
2379   PetscValidPointer(fact,2);
2380   PetscValidHeaderSpecific(*fact,MAT_COOKIE,2);
2381   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2382   if (!(*fact)->ops->choleskyfactornumeric) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
2383   if (mat->rmap.N != (*fact)->rmap.N || mat->cmap.N != (*fact)->cmap.N) {
2384     SETERRQ4(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);
2385   }
2386   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2387 
2388   ierr = PetscLogEventBegin(MAT_CholeskyFactorNumeric,mat,*fact,0,0);CHKERRQ(ierr);
2389   ierr = (*(*fact)->ops->choleskyfactornumeric)(mat,info,fact);CHKERRQ(ierr);
2390   ierr = PetscLogEventEnd(MAT_CholeskyFactorNumeric,mat,*fact,0,0);CHKERRQ(ierr);
2391 
2392   ierr = MatView_Private(*fact);CHKERRQ(ierr);
2393   ierr = PetscObjectStateIncrease((PetscObject)*fact);CHKERRQ(ierr);
2394   PetscFunctionReturn(0);
2395 }
2396 
2397 /* ----------------------------------------------------------------*/
2398 #undef __FUNCT__
2399 #define __FUNCT__ "MatSolve"
2400 /*@
2401    MatSolve - Solves A x = b, given a factored matrix.
2402 
2403    Collective on Mat and Vec
2404 
2405    Input Parameters:
2406 +  mat - the factored matrix
2407 -  b - the right-hand-side vector
2408 
2409    Output Parameter:
2410 .  x - the result vector
2411 
2412    Notes:
2413    The vectors b and x cannot be the same.  I.e., one cannot
2414    call MatSolve(A,x,x).
2415 
2416    Notes:
2417    Most users should employ the simplified KSP interface for linear solvers
2418    instead of working directly with matrix algebra routines such as this.
2419    See, e.g., KSPCreate().
2420 
2421    Level: developer
2422 
2423    Concepts: matrices^triangular solves
2424 
2425 .seealso: MatSolveAdd(), MatSolveTranspose(), MatSolveTransposeAdd()
2426 @*/
2427 PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat mat,Vec b,Vec x)
2428 {
2429   PetscErrorCode ierr;
2430 
2431   PetscFunctionBegin;
2432   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2433   PetscValidType(mat,1);
2434   PetscValidHeaderSpecific(b,VEC_COOKIE,2);
2435   PetscValidHeaderSpecific(x,VEC_COOKIE,3);
2436   PetscCheckSameComm(mat,1,b,2);
2437   PetscCheckSameComm(mat,1,x,3);
2438   if (x == b) SETERRQ(PETSC_ERR_ARG_IDN,"x and b must be different vectors");
2439   if (!mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
2440   if (mat->cmap.N != x->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap.N,x->map.N);
2441   if (mat->rmap.N != b->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: global dim %D %D",mat->rmap.N,b->map.N);
2442   if (mat->rmap.n != b->map.n) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: local dim %D %D",mat->rmap.n,b->map.n);
2443   if (!mat->rmap.N && !mat->cmap.N) PetscFunctionReturn(0);
2444   if (!mat->ops->solve) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
2445   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2446 
2447   ierr = PetscLogEventBegin(MAT_Solve,mat,b,x,0);CHKERRQ(ierr);
2448   ierr = (*mat->ops->solve)(mat,b,x);CHKERRQ(ierr);
2449   ierr = PetscLogEventEnd(MAT_Solve,mat,b,x,0);CHKERRQ(ierr);
2450   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
2451   PetscFunctionReturn(0);
2452 }
2453 
2454 #undef __FUNCT__
2455 #define __FUNCT__ "MatMatSolve"
2456 /*@
2457    MatMatSolve - Solves A X = B, given a factored matrix.
2458 
2459    Collective on Mat
2460 
2461    Input Parameters:
2462 +  mat - the factored matrix
2463 -  b - the right-hand-side vector
2464 
2465    Output Parameter:
2466 .  x - the result vector
2467 
2468    Notes:
2469    The vectors b and x cannot be the same.  I.e., one cannot
2470    call MatMatSolve(A,x,x).
2471 
2472    Notes:
2473    Most users should employ the simplified KSP interface for linear solvers
2474    instead of working directly with matrix algebra routines such as this.
2475    See, e.g., KSPCreate().
2476 
2477    Level: developer
2478 
2479    Concepts: matrices^triangular solves
2480 
2481 .seealso: MatMatSolveAdd(), MatMatSolveTranspose(), MatMatSolveTransposeAdd()
2482 @*/
2483 PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve(Mat A,Mat B,Mat X)
2484 {
2485   PetscErrorCode ierr;
2486 
2487   PetscFunctionBegin;
2488   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
2489   PetscValidType(A,1);
2490   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
2491   PetscValidHeaderSpecific(X,MAT_COOKIE,3);
2492   PetscCheckSameComm(A,1,B,2);
2493   PetscCheckSameComm(A,1,X,3);
2494   if (X == B) SETERRQ(PETSC_ERR_ARG_IDN,"X and B must be different matrices");
2495   if (!A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
2496   if (A->cmap.N != X->rmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat A,Mat X: global dim %D %D",A->cmap.N,X->rmap.N);
2497   if (A->rmap.N != B->rmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat A,Mat B: global dim %D %D",A->rmap.N,B->rmap.N);
2498   if (A->rmap.n != B->rmap.n) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat A,Mat B: local dim %D %D",A->rmap.n,B->rmap.n);
2499   if (!A->rmap.N && !A->cmap.N) PetscFunctionReturn(0);
2500   if (!A->ops->matsolve) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",A->type_name);
2501   ierr = MatPreallocated(A);CHKERRQ(ierr);
2502 
2503   ierr = PetscLogEventBegin(MAT_MatSolve,A,B,X,0);CHKERRQ(ierr);
2504   ierr = (*A->ops->matsolve)(A,B,X);CHKERRQ(ierr);
2505   ierr = PetscLogEventEnd(MAT_MatSolve,A,B,X,0);CHKERRQ(ierr);
2506   ierr = PetscObjectStateIncrease((PetscObject)X);CHKERRQ(ierr);
2507   PetscFunctionReturn(0);
2508 }
2509 
2510 
2511 #undef __FUNCT__
2512 #define __FUNCT__ "MatForwardSolve"
2513 /* @
2514    MatForwardSolve - Solves L x = b, given a factored matrix, A = LU, or
2515                             U^T*D^(1/2) x = b, given a factored symmetric matrix, A = U^T*D*U,
2516 
2517    Collective on Mat and Vec
2518 
2519    Input Parameters:
2520 +  mat - the factored matrix
2521 -  b - the right-hand-side vector
2522 
2523    Output Parameter:
2524 .  x - the result vector
2525 
2526    Notes:
2527    MatSolve() should be used for most applications, as it performs
2528    a forward solve followed by a backward solve.
2529 
2530    The vectors b and x cannot be the same,  i.e., one cannot
2531    call MatForwardSolve(A,x,x).
2532 
2533    For matrix in seqsbaij format with block size larger than 1,
2534    the diagonal blocks are not implemented as D = D^(1/2) * D^(1/2) yet.
2535    MatForwardSolve() solves U^T*D y = b, and
2536    MatBackwardSolve() solves U x = y.
2537    Thus they do not provide a symmetric preconditioner.
2538 
2539    Most users should employ the simplified KSP interface for linear solvers
2540    instead of working directly with matrix algebra routines such as this.
2541    See, e.g., KSPCreate().
2542 
2543    Level: developer
2544 
2545    Concepts: matrices^forward solves
2546 
2547 .seealso: MatSolve(), MatBackwardSolve()
2548 @ */
2549 PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat mat,Vec b,Vec x)
2550 {
2551   PetscErrorCode ierr;
2552 
2553   PetscFunctionBegin;
2554   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2555   PetscValidType(mat,1);
2556   PetscValidHeaderSpecific(b,VEC_COOKIE,2);
2557   PetscValidHeaderSpecific(x,VEC_COOKIE,3);
2558   PetscCheckSameComm(mat,1,b,2);
2559   PetscCheckSameComm(mat,1,x,3);
2560   if (x == b) SETERRQ(PETSC_ERR_ARG_IDN,"x and b must be different vectors");
2561   if (!mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
2562   if (!mat->ops->forwardsolve) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
2563   if (mat->cmap.N != x->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap.N,x->map.N);
2564   if (mat->rmap.N != b->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: global dim %D %D",mat->rmap.N,b->map.N);
2565   if (mat->rmap.n != b->map.n) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: local dim %D %D",mat->rmap.n,b->map.n);
2566   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2567   ierr = PetscLogEventBegin(MAT_ForwardSolve,mat,b,x,0);CHKERRQ(ierr);
2568   ierr = (*mat->ops->forwardsolve)(mat,b,x);CHKERRQ(ierr);
2569   ierr = PetscLogEventEnd(MAT_ForwardSolve,mat,b,x,0);CHKERRQ(ierr);
2570   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
2571   PetscFunctionReturn(0);
2572 }
2573 
2574 #undef __FUNCT__
2575 #define __FUNCT__ "MatBackwardSolve"
2576 /* @
2577    MatBackwardSolve - Solves U x = b, given a factored matrix, A = LU.
2578                              D^(1/2) U x = b, given a factored symmetric matrix, A = U^T*D*U,
2579 
2580    Collective on Mat and Vec
2581 
2582    Input Parameters:
2583 +  mat - the factored matrix
2584 -  b - the right-hand-side vector
2585 
2586    Output Parameter:
2587 .  x - the result vector
2588 
2589    Notes:
2590    MatSolve() should be used for most applications, as it performs
2591    a forward solve followed by a backward solve.
2592 
2593    The vectors b and x cannot be the same.  I.e., one cannot
2594    call MatBackwardSolve(A,x,x).
2595 
2596    For matrix in seqsbaij format with block size larger than 1,
2597    the diagonal blocks are not implemented as D = D^(1/2) * D^(1/2) yet.
2598    MatForwardSolve() solves U^T*D y = b, and
2599    MatBackwardSolve() solves U x = y.
2600    Thus they do not provide a symmetric preconditioner.
2601 
2602    Most users should employ the simplified KSP interface for linear solvers
2603    instead of working directly with matrix algebra routines such as this.
2604    See, e.g., KSPCreate().
2605 
2606    Level: developer
2607 
2608    Concepts: matrices^backward solves
2609 
2610 .seealso: MatSolve(), MatForwardSolve()
2611 @ */
2612 PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat mat,Vec b,Vec x)
2613 {
2614   PetscErrorCode ierr;
2615 
2616   PetscFunctionBegin;
2617   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2618   PetscValidType(mat,1);
2619   PetscValidHeaderSpecific(b,VEC_COOKIE,2);
2620   PetscValidHeaderSpecific(x,VEC_COOKIE,3);
2621   PetscCheckSameComm(mat,1,b,2);
2622   PetscCheckSameComm(mat,1,x,3);
2623   if (x == b) SETERRQ(PETSC_ERR_ARG_IDN,"x and b must be different vectors");
2624   if (!mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
2625   if (!mat->ops->backwardsolve) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
2626   if (mat->cmap.N != x->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap.N,x->map.N);
2627   if (mat->rmap.N != b->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: global dim %D %D",mat->rmap.N,b->map.N);
2628   if (mat->rmap.n != b->map.n) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: local dim %D %D",mat->rmap.n,b->map.n);
2629   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2630 
2631   ierr = PetscLogEventBegin(MAT_BackwardSolve,mat,b,x,0);CHKERRQ(ierr);
2632   ierr = (*mat->ops->backwardsolve)(mat,b,x);CHKERRQ(ierr);
2633   ierr = PetscLogEventEnd(MAT_BackwardSolve,mat,b,x,0);CHKERRQ(ierr);
2634   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
2635   PetscFunctionReturn(0);
2636 }
2637 
2638 #undef __FUNCT__
2639 #define __FUNCT__ "MatSolveAdd"
2640 /*@
2641    MatSolveAdd - Computes x = y + inv(A)*b, given a factored matrix.
2642 
2643    Collective on Mat and Vec
2644 
2645    Input Parameters:
2646 +  mat - the factored matrix
2647 .  b - the right-hand-side vector
2648 -  y - the vector to be added to
2649 
2650    Output Parameter:
2651 .  x - the result vector
2652 
2653    Notes:
2654    The vectors b and x cannot be the same.  I.e., one cannot
2655    call MatSolveAdd(A,x,y,x).
2656 
2657    Most users should employ the simplified KSP interface for linear solvers
2658    instead of working directly with matrix algebra routines such as this.
2659    See, e.g., KSPCreate().
2660 
2661    Level: developer
2662 
2663    Concepts: matrices^triangular solves
2664 
2665 .seealso: MatSolve(), MatSolveTranspose(), MatSolveTransposeAdd()
2666 @*/
2667 PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat mat,Vec b,Vec y,Vec x)
2668 {
2669   PetscScalar    one = 1.0;
2670   Vec            tmp;
2671   PetscErrorCode ierr;
2672 
2673   PetscFunctionBegin;
2674   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2675   PetscValidType(mat,1);
2676   PetscValidHeaderSpecific(y,VEC_COOKIE,2);
2677   PetscValidHeaderSpecific(b,VEC_COOKIE,3);
2678   PetscValidHeaderSpecific(x,VEC_COOKIE,4);
2679   PetscCheckSameComm(mat,1,b,2);
2680   PetscCheckSameComm(mat,1,y,2);
2681   PetscCheckSameComm(mat,1,x,3);
2682   if (x == b) SETERRQ(PETSC_ERR_ARG_IDN,"x and b must be different vectors");
2683   if (!mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
2684   if (mat->cmap.N != x->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap.N,x->map.N);
2685   if (mat->rmap.N != b->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: global dim %D %D",mat->rmap.N,b->map.N);
2686   if (mat->rmap.N != y->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: global dim %D %D",mat->rmap.N,y->map.N);
2687   if (mat->rmap.n != b->map.n) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: local dim %D %D",mat->rmap.n,b->map.n);
2688   if (x->map.n != y->map.n) SETERRQ2(PETSC_ERR_ARG_SIZ,"Vec x,Vec y: local dim %D %D",x->map.n,y->map.n);
2689   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2690 
2691   ierr = PetscLogEventBegin(MAT_SolveAdd,mat,b,x,y);CHKERRQ(ierr);
2692   if (mat->ops->solveadd)  {
2693     ierr = (*mat->ops->solveadd)(mat,b,y,x);CHKERRQ(ierr);
2694   } else {
2695     /* do the solve then the add manually */
2696     if (x != y) {
2697       ierr = MatSolve(mat,b,x);CHKERRQ(ierr);
2698       ierr = VecAXPY(x,one,y);CHKERRQ(ierr);
2699     } else {
2700       ierr = VecDuplicate(x,&tmp);CHKERRQ(ierr);
2701       ierr = PetscLogObjectParent(mat,tmp);CHKERRQ(ierr);
2702       ierr = VecCopy(x,tmp);CHKERRQ(ierr);
2703       ierr = MatSolve(mat,b,x);CHKERRQ(ierr);
2704       ierr = VecAXPY(x,one,tmp);CHKERRQ(ierr);
2705       ierr = VecDestroy(tmp);CHKERRQ(ierr);
2706     }
2707   }
2708   ierr = PetscLogEventEnd(MAT_SolveAdd,mat,b,x,y);CHKERRQ(ierr);
2709   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
2710   PetscFunctionReturn(0);
2711 }
2712 
2713 #undef __FUNCT__
2714 #define __FUNCT__ "MatSolveTranspose"
2715 /*@
2716    MatSolveTranspose - Solves A' x = b, given a factored matrix.
2717 
2718    Collective on Mat and Vec
2719 
2720    Input Parameters:
2721 +  mat - the factored matrix
2722 -  b - the right-hand-side vector
2723 
2724    Output Parameter:
2725 .  x - the result vector
2726 
2727    Notes:
2728    The vectors b and x cannot be the same.  I.e., one cannot
2729    call MatSolveTranspose(A,x,x).
2730 
2731    Most users should employ the simplified KSP interface for linear solvers
2732    instead of working directly with matrix algebra routines such as this.
2733    See, e.g., KSPCreate().
2734 
2735    Level: developer
2736 
2737    Concepts: matrices^triangular solves
2738 
2739 .seealso: MatSolve(), MatSolveAdd(), MatSolveTransposeAdd()
2740 @*/
2741 PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat mat,Vec b,Vec x)
2742 {
2743   PetscErrorCode ierr;
2744 
2745   PetscFunctionBegin;
2746   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2747   PetscValidType(mat,1);
2748   PetscValidHeaderSpecific(b,VEC_COOKIE,2);
2749   PetscValidHeaderSpecific(x,VEC_COOKIE,3);
2750   PetscCheckSameComm(mat,1,b,2);
2751   PetscCheckSameComm(mat,1,x,3);
2752   if (!mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
2753   if (x == b) SETERRQ(PETSC_ERR_ARG_IDN,"x and b must be different vectors");
2754   if (!mat->ops->solvetranspose) SETERRQ1(PETSC_ERR_SUP,"Matrix type %s",mat->type_name);
2755   if (mat->rmap.N != x->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->rmap.N,x->map.N);
2756   if (mat->cmap.N != b->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: global dim %D %D",mat->cmap.N,b->map.N);
2757   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2758   ierr = PetscLogEventBegin(MAT_SolveTranspose,mat,b,x,0);CHKERRQ(ierr);
2759   ierr = (*mat->ops->solvetranspose)(mat,b,x);CHKERRQ(ierr);
2760   ierr = PetscLogEventEnd(MAT_SolveTranspose,mat,b,x,0);CHKERRQ(ierr);
2761   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
2762   PetscFunctionReturn(0);
2763 }
2764 
2765 #undef __FUNCT__
2766 #define __FUNCT__ "MatSolveTransposeAdd"
2767 /*@
2768    MatSolveTransposeAdd - Computes x = y + inv(Transpose(A)) b, given a
2769                       factored matrix.
2770 
2771    Collective on Mat and Vec
2772 
2773    Input Parameters:
2774 +  mat - the factored matrix
2775 .  b - the right-hand-side vector
2776 -  y - the vector to be added to
2777 
2778    Output Parameter:
2779 .  x - the result vector
2780 
2781    Notes:
2782    The vectors b and x cannot be the same.  I.e., one cannot
2783    call MatSolveTransposeAdd(A,x,y,x).
2784 
2785    Most users should employ the simplified KSP interface for linear solvers
2786    instead of working directly with matrix algebra routines such as this.
2787    See, e.g., KSPCreate().
2788 
2789    Level: developer
2790 
2791    Concepts: matrices^triangular solves
2792 
2793 .seealso: MatSolve(), MatSolveAdd(), MatSolveTranspose()
2794 @*/
2795 PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat mat,Vec b,Vec y,Vec x)
2796 {
2797   PetscScalar    one = 1.0;
2798   PetscErrorCode ierr;
2799   Vec            tmp;
2800 
2801   PetscFunctionBegin;
2802   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2803   PetscValidType(mat,1);
2804   PetscValidHeaderSpecific(y,VEC_COOKIE,2);
2805   PetscValidHeaderSpecific(b,VEC_COOKIE,3);
2806   PetscValidHeaderSpecific(x,VEC_COOKIE,4);
2807   PetscCheckSameComm(mat,1,b,2);
2808   PetscCheckSameComm(mat,1,y,3);
2809   PetscCheckSameComm(mat,1,x,4);
2810   if (x == b) SETERRQ(PETSC_ERR_ARG_IDN,"x and b must be different vectors");
2811   if (!mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
2812   if (mat->rmap.N != x->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->rmap.N,x->map.N);
2813   if (mat->cmap.N != b->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: global dim %D %D",mat->cmap.N,b->map.N);
2814   if (mat->cmap.N != y->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec y: global dim %D %D",mat->cmap.N,y->map.N);
2815   if (x->map.n != y->map.n)   SETERRQ2(PETSC_ERR_ARG_SIZ,"Vec x,Vec y: local dim %D %D",x->map.n,y->map.n);
2816   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2817 
2818   ierr = PetscLogEventBegin(MAT_SolveTransposeAdd,mat,b,x,y);CHKERRQ(ierr);
2819   if (mat->ops->solvetransposeadd) {
2820     ierr = (*mat->ops->solvetransposeadd)(mat,b,y,x);CHKERRQ(ierr);
2821   } else {
2822     /* do the solve then the add manually */
2823     if (x != y) {
2824       ierr = MatSolveTranspose(mat,b,x);CHKERRQ(ierr);
2825       ierr = VecAXPY(x,one,y);CHKERRQ(ierr);
2826     } else {
2827       ierr = VecDuplicate(x,&tmp);CHKERRQ(ierr);
2828       ierr = PetscLogObjectParent(mat,tmp);CHKERRQ(ierr);
2829       ierr = VecCopy(x,tmp);CHKERRQ(ierr);
2830       ierr = MatSolveTranspose(mat,b,x);CHKERRQ(ierr);
2831       ierr = VecAXPY(x,one,tmp);CHKERRQ(ierr);
2832       ierr = VecDestroy(tmp);CHKERRQ(ierr);
2833     }
2834   }
2835   ierr = PetscLogEventEnd(MAT_SolveTransposeAdd,mat,b,x,y);CHKERRQ(ierr);
2836   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
2837   PetscFunctionReturn(0);
2838 }
2839 /* ----------------------------------------------------------------*/
2840 
2841 #undef __FUNCT__
2842 #define __FUNCT__ "MatRelax"
2843 /*@
2844    MatRelax - Computes relaxation (SOR, Gauss-Seidel) sweeps.
2845 
2846    Collective on Mat and Vec
2847 
2848    Input Parameters:
2849 +  mat - the matrix
2850 .  b - the right hand side
2851 .  omega - the relaxation factor
2852 .  flag - flag indicating the type of SOR (see below)
2853 .  shift -  diagonal shift
2854 -  its - the number of iterations
2855 -  lits - the number of local iterations
2856 
2857    Output Parameters:
2858 .  x - the solution (can contain an initial guess)
2859 
2860    SOR Flags:
2861 .     SOR_FORWARD_SWEEP - forward SOR
2862 .     SOR_BACKWARD_SWEEP - backward SOR
2863 .     SOR_SYMMETRIC_SWEEP - SSOR (symmetric SOR)
2864 .     SOR_LOCAL_FORWARD_SWEEP - local forward SOR
2865 .     SOR_LOCAL_BACKWARD_SWEEP - local forward SOR
2866 .     SOR_LOCAL_SYMMETRIC_SWEEP - local SSOR
2867 .     SOR_APPLY_UPPER, SOR_APPLY_LOWER - applies
2868          upper/lower triangular part of matrix to
2869          vector (with omega)
2870 .     SOR_ZERO_INITIAL_GUESS - zero initial guess
2871 
2872    Notes:
2873    SOR_LOCAL_FORWARD_SWEEP, SOR_LOCAL_BACKWARD_SWEEP, and
2874    SOR_LOCAL_SYMMETRIC_SWEEP perform separate independent smoothings
2875    on each processor.
2876 
2877    Application programmers will not generally use MatRelax() directly,
2878    but instead will employ the KSP/PC interface.
2879 
2880    Notes for Advanced Users:
2881    The flags are implemented as bitwise inclusive or operations.
2882    For example, use (SOR_ZERO_INITIAL_GUESS | SOR_SYMMETRIC_SWEEP)
2883    to specify a zero initial guess for SSOR.
2884 
2885    Most users should employ the simplified KSP interface for linear solvers
2886    instead of working directly with matrix algebra routines such as this.
2887    See, e.g., KSPCreate().
2888 
2889    See also, MatPBRelax(). This routine will automatically call the point block
2890    version if the point version is not available.
2891 
2892    Level: developer
2893 
2894    Concepts: matrices^relaxation
2895    Concepts: matrices^SOR
2896    Concepts: matrices^Gauss-Seidel
2897 
2898 @*/
2899 PetscErrorCode PETSCMAT_DLLEXPORT MatRelax(Mat mat,Vec b,PetscReal omega,MatSORType flag,PetscReal shift,PetscInt its,PetscInt lits,Vec x)
2900 {
2901   PetscErrorCode ierr;
2902 
2903   PetscFunctionBegin;
2904   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2905   PetscValidType(mat,1);
2906   PetscValidHeaderSpecific(b,VEC_COOKIE,2);
2907   PetscValidHeaderSpecific(x,VEC_COOKIE,8);
2908   PetscCheckSameComm(mat,1,b,2);
2909   PetscCheckSameComm(mat,1,x,8);
2910   if (!mat->ops->relax && !mat->ops->pbrelax) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
2911   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2912   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2913   if (mat->cmap.N != x->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap.N,x->map.N);
2914   if (mat->rmap.N != b->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: global dim %D %D",mat->rmap.N,b->map.N);
2915   if (mat->rmap.n != b->map.n) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: local dim %D %D",mat->rmap.n,b->map.n);
2916   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2917   ierr = PetscLogEventBegin(MAT_Relax,mat,b,x,0);CHKERRQ(ierr);
2918   if (mat->ops->relax) {
2919     ierr =(*mat->ops->relax)(mat,b,omega,flag,shift,its,lits,x);CHKERRQ(ierr);
2920   } else {
2921     ierr =(*mat->ops->pbrelax)(mat,b,omega,flag,shift,its,lits,x);CHKERRQ(ierr);
2922   }
2923   ierr = PetscLogEventEnd(MAT_Relax,mat,b,x,0);CHKERRQ(ierr);
2924   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
2925   PetscFunctionReturn(0);
2926 }
2927 
2928 #undef __FUNCT__
2929 #define __FUNCT__ "MatPBRelax"
2930 /*@
2931    MatPBRelax - Computes relaxation (SOR, Gauss-Seidel) sweeps.
2932 
2933    Collective on Mat and Vec
2934 
2935    See MatRelax() for usage
2936 
2937    For multi-component PDEs where the Jacobian is stored in a point block format
2938    (with the PETSc BAIJ matrix formats) the relaxation is done one point block at
2939    a time. That is, the small (for example, 4 by 4) blocks along the diagonal are solved
2940    simultaneously (that is a 4 by 4 linear solve is done) to update all the values at a point.
2941 
2942    Level: developer
2943 
2944 @*/
2945 PetscErrorCode PETSCMAT_DLLEXPORT MatPBRelax(Mat mat,Vec b,PetscReal omega,MatSORType flag,PetscReal shift,PetscInt its,PetscInt lits,Vec x)
2946 {
2947   PetscErrorCode ierr;
2948 
2949   PetscFunctionBegin;
2950   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2951   PetscValidType(mat,1);
2952   PetscValidHeaderSpecific(b,VEC_COOKIE,2);
2953   PetscValidHeaderSpecific(x,VEC_COOKIE,8);
2954   PetscCheckSameComm(mat,1,b,2);
2955   PetscCheckSameComm(mat,1,x,8);
2956   if (!mat->ops->pbrelax) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
2957   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2958   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2959   if (mat->cmap.N != x->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec x: global dim %D %D",mat->cmap.N,x->map.N);
2960   if (mat->rmap.N != b->map.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: global dim %D %D",mat->rmap.N,b->map.N);
2961   if (mat->rmap.n != b->map.n) SETERRQ2(PETSC_ERR_ARG_SIZ,"Mat mat,Vec b: local dim %D %D",mat->rmap.n,b->map.n);
2962   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2963 
2964   ierr = PetscLogEventBegin(MAT_Relax,mat,b,x,0);CHKERRQ(ierr);
2965   ierr =(*mat->ops->pbrelax)(mat,b,omega,flag,shift,its,lits,x);CHKERRQ(ierr);
2966   ierr = PetscLogEventEnd(MAT_Relax,mat,b,x,0);CHKERRQ(ierr);
2967   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
2968   PetscFunctionReturn(0);
2969 }
2970 
2971 #undef __FUNCT__
2972 #define __FUNCT__ "MatCopy_Basic"
2973 /*
2974       Default matrix copy routine.
2975 */
2976 PetscErrorCode MatCopy_Basic(Mat A,Mat B,MatStructure str)
2977 {
2978   PetscErrorCode    ierr;
2979   PetscInt          i,rstart,rend,nz;
2980   const PetscInt    *cwork;
2981   const PetscScalar *vwork;
2982 
2983   PetscFunctionBegin;
2984   if (B->assembled) {
2985     ierr = MatZeroEntries(B);CHKERRQ(ierr);
2986   }
2987   ierr = MatGetOwnershipRange(A,&rstart,&rend);CHKERRQ(ierr);
2988   for (i=rstart; i<rend; i++) {
2989     ierr = MatGetRow(A,i,&nz,&cwork,&vwork);CHKERRQ(ierr);
2990     ierr = MatSetValues(B,1,&i,nz,cwork,vwork,INSERT_VALUES);CHKERRQ(ierr);
2991     ierr = MatRestoreRow(A,i,&nz,&cwork,&vwork);CHKERRQ(ierr);
2992   }
2993   ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
2994   ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
2995   ierr = PetscObjectStateIncrease((PetscObject)B);CHKERRQ(ierr);
2996   PetscFunctionReturn(0);
2997 }
2998 
2999 #undef __FUNCT__
3000 #define __FUNCT__ "MatCopy"
3001 /*@
3002    MatCopy - Copys a matrix to another matrix.
3003 
3004    Collective on Mat
3005 
3006    Input Parameters:
3007 +  A - the matrix
3008 -  str - SAME_NONZERO_PATTERN or DIFFERENT_NONZERO_PATTERN
3009 
3010    Output Parameter:
3011 .  B - where the copy is put
3012 
3013    Notes:
3014    If you use SAME_NONZERO_PATTERN then the two matrices had better have the
3015    same nonzero pattern or the routine will crash.
3016 
3017    MatCopy() copies the matrix entries of a matrix to another existing
3018    matrix (after first zeroing the second matrix).  A related routine is
3019    MatConvert(), which first creates a new matrix and then copies the data.
3020 
3021    Level: intermediate
3022 
3023    Concepts: matrices^copying
3024 
3025 .seealso: MatConvert(), MatDuplicate()
3026 
3027 @*/
3028 PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat A,Mat B,MatStructure str)
3029 {
3030   PetscErrorCode ierr;
3031 
3032   PetscFunctionBegin;
3033   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
3034   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
3035   PetscValidType(A,1);
3036   PetscValidType(B,2);
3037   MatPreallocated(B);
3038   PetscCheckSameComm(A,1,B,2);
3039   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3040   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3041   if (A->rmap.N != B->rmap.N || A->cmap.N != B->cmap.N) SETERRQ4(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);
3042   ierr = MatPreallocated(A);CHKERRQ(ierr);
3043 
3044   ierr = PetscLogEventBegin(MAT_Copy,A,B,0,0);CHKERRQ(ierr);
3045   if (A->ops->copy) {
3046     ierr = (*A->ops->copy)(A,B,str);CHKERRQ(ierr);
3047   } else { /* generic conversion */
3048     ierr = MatCopy_Basic(A,B,str);CHKERRQ(ierr);
3049   }
3050   if (A->mapping) {
3051     if (B->mapping) {ierr = ISLocalToGlobalMappingDestroy(B->mapping);CHKERRQ(ierr);B->mapping = 0;}
3052     ierr = MatSetLocalToGlobalMapping(B,A->mapping);CHKERRQ(ierr);
3053   }
3054   if (A->bmapping) {
3055     if (B->bmapping) {ierr = ISLocalToGlobalMappingDestroy(B->bmapping);CHKERRQ(ierr);B->bmapping = 0;}
3056     ierr = MatSetLocalToGlobalMappingBlock(B,A->mapping);CHKERRQ(ierr);
3057   }
3058   ierr = PetscLogEventEnd(MAT_Copy,A,B,0,0);CHKERRQ(ierr);
3059   ierr = PetscObjectStateIncrease((PetscObject)B);CHKERRQ(ierr);
3060   PetscFunctionReturn(0);
3061 }
3062 
3063 #undef __FUNCT__
3064 #define __FUNCT__ "MatConvert"
3065 /*@C
3066    MatConvert - Converts a matrix to another matrix, either of the same
3067    or different type.
3068 
3069    Collective on Mat
3070 
3071    Input Parameters:
3072 +  mat - the matrix
3073 .  newtype - new matrix type.  Use MATSAME to create a new matrix of the
3074    same type as the original matrix.
3075 -  reuse - denotes if the destination matrix is to be created or reused.  Currently
3076    MAT_REUSE_MATRIX is only supported for inplace conversion, otherwise use
3077    MAT_INITIAL_MATRIX.
3078    Output Parameter:
3079 .  M - pointer to place new matrix
3080 
3081    Notes:
3082    MatConvert() first creates a new matrix and then copies the data from
3083    the first matrix.  A related routine is MatCopy(), which copies the matrix
3084    entries of one matrix to another already existing matrix context.
3085 
3086    Level: intermediate
3087 
3088    Concepts: matrices^converting between storage formats
3089 
3090 .seealso: MatCopy(), MatDuplicate()
3091 @*/
3092 PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat mat, MatType newtype,MatReuse reuse,Mat *M)
3093 {
3094   PetscErrorCode         ierr;
3095   PetscTruth             sametype,issame,flg;
3096   char                   convname[256],mtype[256];
3097   Mat                    B;
3098 
3099   PetscFunctionBegin;
3100   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3101   PetscValidType(mat,1);
3102   PetscValidPointer(M,3);
3103   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3104   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3105   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3106 
3107   ierr = PetscOptionsGetString(PETSC_NULL,"-matconvert_type",mtype,256,&flg);CHKERRQ(ierr);
3108   if (flg) {
3109     newtype = mtype;
3110   }
3111   ierr = PetscLogEventBegin(MAT_Convert,mat,0,0,0);CHKERRQ(ierr);
3112 
3113   ierr = PetscTypeCompare((PetscObject)mat,newtype,&sametype);CHKERRQ(ierr);
3114   ierr = PetscStrcmp(newtype,"same",&issame);CHKERRQ(ierr);
3115   if ((reuse==MAT_REUSE_MATRIX) && (mat != *M)) {
3116     SETERRQ(PETSC_ERR_SUP,"MAT_REUSE_MATRIX only supported for in-place conversion currently");
3117   }
3118   if ((sametype || issame) && (reuse==MAT_INITIAL_MATRIX) && mat->ops->duplicate) {
3119     ierr = (*mat->ops->duplicate)(mat,MAT_COPY_VALUES,M);CHKERRQ(ierr);
3120   } else {
3121     PetscErrorCode (*conv)(Mat, MatType,MatReuse,Mat*)=PETSC_NULL;
3122     const char     *prefix[3] = {"seq","mpi",""};
3123     PetscInt       i;
3124 
3125     /*
3126        Order of precedence:
3127        1) See if a specialized converter is known to the current matrix.
3128        2) See if a specialized converter is known to the desired matrix class.
3129        3) See if a good general converter is registered for the desired class
3130           (as of 6/27/03 only MATMPIADJ falls into this category).
3131        4) See if a good general converter is known for the current matrix.
3132        5) Use a really basic converter.
3133     */
3134     for (i=0; i<3; i++) {
3135       /* 1) See if a specialized converter is known to the current matrix and the desired class */
3136       ierr = PetscStrcpy(convname,"MatConvert_");CHKERRQ(ierr);
3137       ierr = PetscStrcat(convname,mat->type_name);CHKERRQ(ierr);
3138       ierr = PetscStrcat(convname,"_");CHKERRQ(ierr);
3139       ierr = PetscStrcat(convname,prefix[i]);CHKERRQ(ierr);
3140       ierr = PetscStrcat(convname,newtype);CHKERRQ(ierr);
3141       ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr);
3142       ierr = PetscObjectQueryFunction((PetscObject)mat,convname,(void (**)(void))&conv);CHKERRQ(ierr);
3143       if (conv) goto foundconv;
3144     }
3145 
3146     /* 2)  See if a specialized converter is known to the desired matrix class. */
3147     ierr = MatCreate(mat->comm,&B);CHKERRQ(ierr);
3148     ierr = MatSetSizes(B,mat->rmap.n,mat->cmap.n,mat->rmap.N,mat->cmap.N);CHKERRQ(ierr);
3149     ierr = MatSetType(B,newtype);CHKERRQ(ierr);
3150     for (i=0; i<3; i++) {
3151       ierr = PetscStrcpy(convname,"MatConvert_");CHKERRQ(ierr);
3152       ierr = PetscStrcat(convname,mat->type_name);CHKERRQ(ierr);
3153       ierr = PetscStrcat(convname,"_");CHKERRQ(ierr);
3154       ierr = PetscStrcat(convname,prefix[i]);CHKERRQ(ierr);
3155       ierr = PetscStrcat(convname,newtype);CHKERRQ(ierr);
3156       ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr);
3157       ierr = PetscObjectQueryFunction((PetscObject)B,convname,(void (**)(void))&conv);CHKERRQ(ierr);
3158       if (conv) {
3159         ierr = MatDestroy(B);CHKERRQ(ierr);
3160         goto foundconv;
3161       }
3162     }
3163 
3164     /* 3) See if a good general converter is registered for the desired class */
3165     conv = B->ops->convertfrom;
3166     ierr = MatDestroy(B);CHKERRQ(ierr);
3167     if (conv) goto foundconv;
3168 
3169     /* 4) See if a good general converter is known for the current matrix */
3170     if (mat->ops->convert) {
3171       conv = mat->ops->convert;
3172     }
3173     if (conv) goto foundconv;
3174 
3175     /* 5) Use a really basic converter. */
3176     conv = MatConvert_Basic;
3177 
3178     foundconv:
3179     ierr = (*conv)(mat,newtype,reuse,M);CHKERRQ(ierr);
3180   }
3181   B = *M;
3182   ierr = PetscLogEventEnd(MAT_Convert,mat,0,0,0);CHKERRQ(ierr);
3183   ierr = PetscObjectStateIncrease((PetscObject)B);CHKERRQ(ierr);
3184   PetscFunctionReturn(0);
3185 }
3186 
3187 
3188 #undef __FUNCT__
3189 #define __FUNCT__ "MatDuplicate"
3190 /*@
3191    MatDuplicate - Duplicates a matrix including the non-zero structure.
3192 
3193    Collective on Mat
3194 
3195    Input Parameters:
3196 +  mat - the matrix
3197 -  op - either MAT_DO_NOT_COPY_VALUES or MAT_COPY_VALUES, cause it to copy nonzero
3198         values as well or not
3199 
3200    Output Parameter:
3201 .  M - pointer to place new matrix
3202 
3203    Level: intermediate
3204 
3205    Concepts: matrices^duplicating
3206 
3207 .seealso: MatCopy(), MatConvert()
3208 @*/
3209 PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat mat,MatDuplicateOption op,Mat *M)
3210 {
3211   PetscErrorCode ierr;
3212   Mat            B;
3213 
3214   PetscFunctionBegin;
3215   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3216   PetscValidType(mat,1);
3217   PetscValidPointer(M,3);
3218   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3219   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3220   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3221 
3222   *M  = 0;
3223   ierr = PetscLogEventBegin(MAT_Convert,mat,0,0,0);CHKERRQ(ierr);
3224   if (!mat->ops->duplicate) {
3225     SETERRQ(PETSC_ERR_SUP,"Not written for this matrix type");
3226   }
3227   ierr = (*mat->ops->duplicate)(mat,op,M);CHKERRQ(ierr);
3228   B = *M;
3229   if (mat->mapping) {
3230     ierr = MatSetLocalToGlobalMapping(B,mat->mapping);CHKERRQ(ierr);
3231   }
3232   if (mat->bmapping) {
3233     ierr = MatSetLocalToGlobalMappingBlock(B,mat->bmapping);CHKERRQ(ierr);
3234   }
3235   ierr = PetscMapCopy(mat->comm,&mat->rmap,&B->rmap);CHKERRQ(ierr);
3236   ierr = PetscMapCopy(mat->comm,&mat->cmap,&B->cmap);CHKERRQ(ierr);
3237 
3238   ierr = PetscLogEventEnd(MAT_Convert,mat,0,0,0);CHKERRQ(ierr);
3239   ierr = PetscObjectStateIncrease((PetscObject)B);CHKERRQ(ierr);
3240   PetscFunctionReturn(0);
3241 }
3242 
3243 #undef __FUNCT__
3244 #define __FUNCT__ "MatGetDiagonal"
3245 /*@
3246    MatGetDiagonal - Gets the diagonal of a matrix.
3247 
3248    Collective on Mat and Vec
3249 
3250    Input Parameters:
3251 +  mat - the matrix
3252 -  v - the vector for storing the diagonal
3253 
3254    Output Parameter:
3255 .  v - the diagonal of the matrix
3256 
3257    Notes: The result of this call are the same as if one converted the matrix to dense format
3258       and found the minimum value in each row (i.e. the implicit zeros are counted as zeros).
3259 
3260    Level: intermediate
3261 
3262    Concepts: matrices^accessing diagonals
3263 
3264 .seealso: MatGetRow(), MatGetSubMatrices(), MatGetSubmatrix(), MatGetRowMaxAbs()
3265 @*/
3266 PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat mat,Vec v)
3267 {
3268   PetscErrorCode ierr;
3269 
3270   PetscFunctionBegin;
3271   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3272   PetscValidType(mat,1);
3273   PetscValidHeaderSpecific(v,VEC_COOKIE,2);
3274   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3275   if (!mat->ops->getdiagonal) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
3276   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3277 
3278   ierr = (*mat->ops->getdiagonal)(mat,v);CHKERRQ(ierr);
3279   ierr = PetscObjectStateIncrease((PetscObject)v);CHKERRQ(ierr);
3280   PetscFunctionReturn(0);
3281 }
3282 
3283 #undef __FUNCT__
3284 #define __FUNCT__ "MatGetRowMin"
3285 /*@
3286    MatGetRowMin - Gets the minimum value (of the real part) of each
3287         row of the matrix
3288 
3289    Collective on Mat and Vec
3290 
3291    Input Parameters:
3292 .  mat - the matrix
3293 
3294    Output Parameter:
3295 +  v - the vector for storing the maximums
3296 -  idx - the indices of the column found for each row (optional)
3297 
3298    Level: intermediate
3299 
3300    Notes: The result of this call are the same as if one converted the matrix to dense format
3301       and found the minimum value in each row (i.e. the implicit zeros are counted as zeros).
3302 
3303     This code is only implemented for a couple of matrix formats.
3304 
3305    Concepts: matrices^getting row maximums
3306 
3307 .seealso: MatGetDiagonal(), MatGetSubMatrices(), MatGetSubmatrix(), MatGetRowMaxAbs(),
3308           MatGetRowMax()
3309 @*/
3310 PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMin(Mat mat,Vec v,PetscInt idx[])
3311 {
3312   PetscErrorCode ierr;
3313 
3314   PetscFunctionBegin;
3315   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3316   PetscValidType(mat,1);
3317   PetscValidHeaderSpecific(v,VEC_COOKIE,2);
3318   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3319   if (!mat->ops->getrowmax) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
3320   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3321 
3322   ierr = (*mat->ops->getrowmin)(mat,v,idx);CHKERRQ(ierr);
3323   ierr = PetscObjectStateIncrease((PetscObject)v);CHKERRQ(ierr);
3324   PetscFunctionReturn(0);
3325 }
3326 
3327 #undef __FUNCT__
3328 #define __FUNCT__ "MatGetRowMax"
3329 /*@
3330    MatGetRowMax - Gets the maximum value (of the real part) of each
3331         row of the matrix
3332 
3333    Collective on Mat and Vec
3334 
3335    Input Parameters:
3336 .  mat - the matrix
3337 
3338    Output Parameter:
3339 +  v - the vector for storing the maximums
3340 -  idx - the indices of the column found for each row (optional)
3341 
3342    Level: intermediate
3343 
3344    Notes: The result of this call are the same as if one converted the matrix to dense format
3345       and found the minimum value in each row (i.e. the implicit zeros are counted as zeros).
3346 
3347     This code is only implemented for a couple of matrix formats.
3348 
3349    Concepts: matrices^getting row maximums
3350 
3351 .seealso: MatGetDiagonal(), MatGetSubMatrices(), MatGetSubmatrix(), MatGetRowMaxAbs(), MatGetRowMin()
3352 @*/
3353 PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat mat,Vec v,PetscInt idx[])
3354 {
3355   PetscErrorCode ierr;
3356 
3357   PetscFunctionBegin;
3358   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3359   PetscValidType(mat,1);
3360   PetscValidHeaderSpecific(v,VEC_COOKIE,2);
3361   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3362   if (!mat->ops->getrowmax) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
3363   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3364 
3365   ierr = (*mat->ops->getrowmax)(mat,v,idx);CHKERRQ(ierr);
3366   ierr = PetscObjectStateIncrease((PetscObject)v);CHKERRQ(ierr);
3367   PetscFunctionReturn(0);
3368 }
3369 
3370 #undef __FUNCT__
3371 #define __FUNCT__ "MatGetRowMaxAbs"
3372 /*@
3373    MatGetRowMaxAbs - Gets the maximum value (in absolute value) of each
3374         row of the matrix
3375 
3376    Collective on Mat and Vec
3377 
3378    Input Parameters:
3379 .  mat - the matrix
3380 
3381    Output Parameter:
3382 +  v - the vector for storing the maximums
3383 -  idx - the indices of the column found for each row (optional)
3384 
3385    Level: intermediate
3386 
3387    Notes: if a row is completely empty or has only 0.0 values then the idx[] value for that
3388     row is 0 (the first column).
3389 
3390     This code is only implemented for a couple of matrix formats.
3391 
3392    Concepts: matrices^getting row maximums
3393 
3394 .seealso: MatGetDiagonal(), MatGetSubMatrices(), MatGetSubmatrix(), MatGetRowMax(), MatGetRowMin()
3395 @*/
3396 PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMaxAbs(Mat mat,Vec v,PetscInt idx[])
3397 {
3398   PetscErrorCode ierr;
3399 
3400   PetscFunctionBegin;
3401   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3402   PetscValidType(mat,1);
3403   PetscValidHeaderSpecific(v,VEC_COOKIE,2);
3404   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3405   if (!mat->ops->getrowmaxabs) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
3406   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3407 
3408   ierr = (*mat->ops->getrowmaxabs)(mat,v,idx);CHKERRQ(ierr);
3409   ierr = PetscObjectStateIncrease((PetscObject)v);CHKERRQ(ierr);
3410   PetscFunctionReturn(0);
3411 }
3412 
3413 #undef __FUNCT__
3414 #define __FUNCT__ "MatTranspose"
3415 /*@C
3416    MatTranspose - Computes an in-place or out-of-place transpose of a matrix.
3417 
3418    Collective on Mat
3419 
3420    Input Parameter:
3421 .  mat - the matrix to transpose
3422 
3423    Output Parameters:
3424 .  B - the transpose
3425 
3426    Notes:
3427      If you  pass in PETSC_NULL for B an in-place transpose in mat will be done
3428 
3429    Level: intermediate
3430 
3431    Concepts: matrices^transposing
3432 
3433 .seealso: MatMultTranspose(), MatMultTransposeAdd(), MatIsTranspose()
3434 @*/
3435 PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat mat,Mat *B)
3436 {
3437   PetscErrorCode ierr;
3438 
3439   PetscFunctionBegin;
3440   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3441   PetscValidType(mat,1);
3442   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3443   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3444   if (!mat->ops->transpose) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
3445   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3446 
3447   ierr = PetscLogEventBegin(MAT_Transpose,mat,0,0,0);CHKERRQ(ierr);
3448   ierr = (*mat->ops->transpose)(mat,B);CHKERRQ(ierr);
3449   ierr = PetscLogEventEnd(MAT_Transpose,mat,0,0,0);CHKERRQ(ierr);
3450   if (B) {ierr = PetscObjectStateIncrease((PetscObject)*B);CHKERRQ(ierr);}
3451   PetscFunctionReturn(0);
3452 }
3453 
3454 #undef __FUNCT__
3455 #define __FUNCT__ "MatIsTranspose"
3456 /*@C
3457    MatIsTranspose - Test whether a matrix is another one's transpose,
3458         or its own, in which case it tests symmetry.
3459 
3460    Collective on Mat
3461 
3462    Input Parameter:
3463 +  A - the matrix to test
3464 -  B - the matrix to test against, this can equal the first parameter
3465 
3466    Output Parameters:
3467 .  flg - the result
3468 
3469    Notes:
3470    Only available for SeqAIJ/MPIAIJ matrices. The sequential algorithm
3471    has a running time of the order of the number of nonzeros; the parallel
3472    test involves parallel copies of the block-offdiagonal parts of the matrix.
3473 
3474    Level: intermediate
3475 
3476    Concepts: matrices^transposing, matrix^symmetry
3477 
3478 .seealso: MatTranspose(), MatIsSymmetric(), MatIsHermitian()
3479 @*/
3480 PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat A,Mat B,PetscReal tol,PetscTruth *flg)
3481 {
3482   PetscErrorCode ierr,(*f)(Mat,Mat,PetscReal,PetscTruth*),(*g)(Mat,Mat,PetscReal,PetscTruth*);
3483 
3484   PetscFunctionBegin;
3485   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
3486   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
3487   PetscValidPointer(flg,3);
3488   ierr = PetscObjectQueryFunction((PetscObject)A,"MatIsTranspose_C",(void (**)(void))&f);CHKERRQ(ierr);
3489   ierr = PetscObjectQueryFunction((PetscObject)B,"MatIsTranspose_C",(void (**)(void))&g);CHKERRQ(ierr);
3490   if (f && g) {
3491     if (f==g) {
3492       ierr = (*f)(A,B,tol,flg);CHKERRQ(ierr);
3493     } else {
3494       SETERRQ(PETSC_ERR_ARG_NOTSAMETYPE,"Matrices do not have the same comparator for symmetry test");
3495     }
3496   }
3497   PetscFunctionReturn(0);
3498 }
3499 
3500 #undef __FUNCT__
3501 #define __FUNCT__ "MatPermute"
3502 /*@C
3503    MatPermute - Creates a new matrix with rows and columns permuted from the
3504    original.
3505 
3506    Collective on Mat
3507 
3508    Input Parameters:
3509 +  mat - the matrix to permute
3510 .  row - row permutation, each processor supplies only the permutation for its rows
3511 -  col - column permutation, each processor needs the entire column permutation, that is
3512          this is the same size as the total number of columns in the matrix
3513 
3514    Output Parameters:
3515 .  B - the permuted matrix
3516 
3517    Level: advanced
3518 
3519    Concepts: matrices^permuting
3520 
3521 .seealso: MatGetOrdering()
3522 @*/
3523 PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat mat,IS row,IS col,Mat *B)
3524 {
3525   PetscErrorCode ierr;
3526 
3527   PetscFunctionBegin;
3528   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3529   PetscValidType(mat,1);
3530   PetscValidHeaderSpecific(row,IS_COOKIE,2);
3531   PetscValidHeaderSpecific(col,IS_COOKIE,3);
3532   PetscValidPointer(B,4);
3533   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3534   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3535   if (!mat->ops->permute) SETERRQ1(PETSC_ERR_SUP,"MatPermute not available for Mat type %s",mat->type_name);
3536   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3537 
3538   ierr = (*mat->ops->permute)(mat,row,col,B);CHKERRQ(ierr);
3539   ierr = PetscObjectStateIncrease((PetscObject)*B);CHKERRQ(ierr);
3540   PetscFunctionReturn(0);
3541 }
3542 
3543 #undef __FUNCT__
3544 #define __FUNCT__ "MatPermuteSparsify"
3545 /*@C
3546   MatPermuteSparsify - Creates a new matrix with rows and columns permuted from the
3547   original and sparsified to the prescribed tolerance.
3548 
3549   Collective on Mat
3550 
3551   Input Parameters:
3552 + A    - The matrix to permute
3553 . band - The half-bandwidth of the sparsified matrix, or PETSC_DECIDE
3554 . frac - The half-bandwidth as a fraction of the total size, or 0.0
3555 . tol  - The drop tolerance
3556 . rowp - The row permutation
3557 - colp - The column permutation
3558 
3559   Output Parameter:
3560 . B    - The permuted, sparsified matrix
3561 
3562   Level: advanced
3563 
3564   Note:
3565   The default behavior (band = PETSC_DECIDE and frac = 0.0) is to
3566   restrict the half-bandwidth of the resulting matrix to 5% of the
3567   total matrix size.
3568 
3569 .keywords: matrix, permute, sparsify
3570 
3571 .seealso: MatGetOrdering(), MatPermute()
3572 @*/
3573 PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat A, PetscInt band, PetscReal frac, PetscReal tol, IS rowp, IS colp, Mat *B)
3574 {
3575   IS                irowp, icolp;
3576   PetscInt          *rows, *cols;
3577   PetscInt          M, N, locRowStart, locRowEnd;
3578   PetscInt          nz, newNz;
3579   const PetscInt    *cwork;
3580   PetscInt          *cnew;
3581   const PetscScalar *vwork;
3582   PetscScalar       *vnew;
3583   PetscInt          bw, issize;
3584   PetscInt          row, locRow, newRow, col, newCol;
3585   PetscErrorCode    ierr;
3586 
3587   PetscFunctionBegin;
3588   PetscValidHeaderSpecific(A,    MAT_COOKIE,1);
3589   PetscValidHeaderSpecific(rowp, IS_COOKIE,5);
3590   PetscValidHeaderSpecific(colp, IS_COOKIE,6);
3591   PetscValidPointer(B,7);
3592   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE, "Not for unassembled matrix");
3593   if (A->factor)     SETERRQ(PETSC_ERR_ARG_WRONGSTATE, "Not for factored matrix");
3594   if (!A->ops->permutesparsify) {
3595     ierr = MatGetSize(A, &M, &N);CHKERRQ(ierr);
3596     ierr = MatGetOwnershipRange(A, &locRowStart, &locRowEnd);CHKERRQ(ierr);
3597     ierr = ISGetSize(rowp, &issize);CHKERRQ(ierr);
3598     if (issize != M) SETERRQ2(PETSC_ERR_ARG_WRONG, "Wrong size %D for row permutation, should be %D", issize, M);
3599     ierr = ISGetSize(colp, &issize);CHKERRQ(ierr);
3600     if (issize != N) SETERRQ2(PETSC_ERR_ARG_WRONG, "Wrong size %D for column permutation, should be %D", issize, N);
3601     ierr = ISInvertPermutation(rowp, 0, &irowp);CHKERRQ(ierr);
3602     ierr = ISGetIndices(irowp, &rows);CHKERRQ(ierr);
3603     ierr = ISInvertPermutation(colp, 0, &icolp);CHKERRQ(ierr);
3604     ierr = ISGetIndices(icolp, &cols);CHKERRQ(ierr);
3605     ierr = PetscMalloc(N * sizeof(PetscInt),         &cnew);CHKERRQ(ierr);
3606     ierr = PetscMalloc(N * sizeof(PetscScalar), &vnew);CHKERRQ(ierr);
3607 
3608     /* Setup bandwidth to include */
3609     if (band == PETSC_DECIDE) {
3610       if (frac <= 0.0)
3611         bw = (PetscInt) (M * 0.05);
3612       else
3613         bw = (PetscInt) (M * frac);
3614     } else {
3615       if (band <= 0) SETERRQ(PETSC_ERR_ARG_WRONG, "Bandwidth must be a positive integer");
3616       bw = band;
3617     }
3618 
3619     /* Put values into new matrix */
3620     ierr = MatDuplicate(A, MAT_DO_NOT_COPY_VALUES, B);CHKERRQ(ierr);
3621     for(row = locRowStart, locRow = 0; row < locRowEnd; row++, locRow++) {
3622       ierr = MatGetRow(A, row, &nz, &cwork, &vwork);CHKERRQ(ierr);
3623       newRow   = rows[locRow]+locRowStart;
3624       for(col = 0, newNz = 0; col < nz; col++) {
3625         newCol = cols[cwork[col]];
3626         if ((newCol >= newRow - bw) && (newCol < newRow + bw) && (PetscAbsScalar(vwork[col]) >= tol)) {
3627           cnew[newNz] = newCol;
3628           vnew[newNz] = vwork[col];
3629           newNz++;
3630         }
3631       }
3632       ierr = MatSetValues(*B, 1, &newRow, newNz, cnew, vnew, INSERT_VALUES);CHKERRQ(ierr);
3633       ierr = MatRestoreRow(A, row, &nz, &cwork, &vwork);CHKERRQ(ierr);
3634     }
3635     ierr = PetscFree(cnew);CHKERRQ(ierr);
3636     ierr = PetscFree(vnew);CHKERRQ(ierr);
3637     ierr = MatAssemblyBegin(*B, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
3638     ierr = MatAssemblyEnd(*B, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
3639     ierr = ISRestoreIndices(irowp, &rows);CHKERRQ(ierr);
3640     ierr = ISRestoreIndices(icolp, &cols);CHKERRQ(ierr);
3641     ierr = ISDestroy(irowp);CHKERRQ(ierr);
3642     ierr = ISDestroy(icolp);CHKERRQ(ierr);
3643   } else {
3644     ierr = (*A->ops->permutesparsify)(A, band, frac, tol, rowp, colp, B);CHKERRQ(ierr);
3645   }
3646   ierr = PetscObjectStateIncrease((PetscObject)*B);CHKERRQ(ierr);
3647   PetscFunctionReturn(0);
3648 }
3649 
3650 #undef __FUNCT__
3651 #define __FUNCT__ "MatEqual"
3652 /*@
3653    MatEqual - Compares two matrices.
3654 
3655    Collective on Mat
3656 
3657    Input Parameters:
3658 +  A - the first matrix
3659 -  B - the second matrix
3660 
3661    Output Parameter:
3662 .  flg - PETSC_TRUE if the matrices are equal; PETSC_FALSE otherwise.
3663 
3664    Level: intermediate
3665 
3666    Concepts: matrices^equality between
3667 @*/
3668 PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat A,Mat B,PetscTruth *flg)
3669 {
3670   PetscErrorCode ierr;
3671 
3672   PetscFunctionBegin;
3673   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
3674   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
3675   PetscValidType(A,1);
3676   PetscValidType(B,2);
3677   MatPreallocated(B);
3678   PetscValidIntPointer(flg,3);
3679   PetscCheckSameComm(A,1,B,2);
3680   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3681   if (!B->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3682   if (A->rmap.N != B->rmap.N || A->cmap.N != B->cmap.N) SETERRQ4(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);
3683   if (!A->ops->equal) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",A->type_name);
3684   if (!B->ops->equal) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",B->type_name);
3685   if (A->ops->equal != B->ops->equal) SETERRQ2(PETSC_ERR_ARG_INCOMP,"A is type: %s\nB is type: %s",A->type_name,B->type_name);
3686   ierr = MatPreallocated(A);CHKERRQ(ierr);
3687 
3688   ierr = (*A->ops->equal)(A,B,flg);CHKERRQ(ierr);
3689   PetscFunctionReturn(0);
3690 }
3691 
3692 #undef __FUNCT__
3693 #define __FUNCT__ "MatDiagonalScale"
3694 /*@
3695    MatDiagonalScale - Scales a matrix on the left and right by diagonal
3696    matrices that are stored as vectors.  Either of the two scaling
3697    matrices can be PETSC_NULL.
3698 
3699    Collective on Mat
3700 
3701    Input Parameters:
3702 +  mat - the matrix to be scaled
3703 .  l - the left scaling vector (or PETSC_NULL)
3704 -  r - the right scaling vector (or PETSC_NULL)
3705 
3706    Notes:
3707    MatDiagonalScale() computes A = LAR, where
3708    L = a diagonal matrix (stored as a vector), R = a diagonal matrix (stored as a vector)
3709 
3710    Level: intermediate
3711 
3712    Concepts: matrices^diagonal scaling
3713    Concepts: diagonal scaling of matrices
3714 
3715 .seealso: MatScale()
3716 @*/
3717 PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat mat,Vec l,Vec r)
3718 {
3719   PetscErrorCode ierr;
3720 
3721   PetscFunctionBegin;
3722   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3723   PetscValidType(mat,1);
3724   if (!mat->ops->diagonalscale) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
3725   if (l) {PetscValidHeaderSpecific(l,VEC_COOKIE,2);PetscCheckSameComm(mat,1,l,2);}
3726   if (r) {PetscValidHeaderSpecific(r,VEC_COOKIE,3);PetscCheckSameComm(mat,1,r,3);}
3727   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3728   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3729   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3730 
3731   ierr = PetscLogEventBegin(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
3732   ierr = (*mat->ops->diagonalscale)(mat,l,r);CHKERRQ(ierr);
3733   ierr = PetscLogEventEnd(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
3734   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
3735   PetscFunctionReturn(0);
3736 }
3737 
3738 #undef __FUNCT__
3739 #define __FUNCT__ "MatScale"
3740 /*@
3741     MatScale - Scales all elements of a matrix by a given number.
3742 
3743     Collective on Mat
3744 
3745     Input Parameters:
3746 +   mat - the matrix to be scaled
3747 -   a  - the scaling value
3748 
3749     Output Parameter:
3750 .   mat - the scaled matrix
3751 
3752     Level: intermediate
3753 
3754     Concepts: matrices^scaling all entries
3755 
3756 .seealso: MatDiagonalScale()
3757 @*/
3758 PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat mat,PetscScalar a)
3759 {
3760   PetscErrorCode ierr;
3761 
3762   PetscFunctionBegin;
3763   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3764   PetscValidType(mat,1);
3765   if (!mat->ops->scale) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
3766   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3767   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3768   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3769 
3770   ierr = PetscLogEventBegin(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
3771   ierr = (*mat->ops->scale)(mat,a);CHKERRQ(ierr);
3772   ierr = PetscLogEventEnd(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
3773   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
3774   PetscFunctionReturn(0);
3775 }
3776 
3777 #undef __FUNCT__
3778 #define __FUNCT__ "MatNorm"
3779 /*@
3780    MatNorm - Calculates various norms of a matrix.
3781 
3782    Collective on Mat
3783 
3784    Input Parameters:
3785 +  mat - the matrix
3786 -  type - the type of norm, NORM_1, NORM_FROBENIUS, NORM_INFINITY
3787 
3788    Output Parameters:
3789 .  nrm - the resulting norm
3790 
3791    Level: intermediate
3792 
3793    Concepts: matrices^norm
3794    Concepts: norm^of matrix
3795 @*/
3796 PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat mat,NormType type,PetscReal *nrm)
3797 {
3798   PetscErrorCode ierr;
3799 
3800   PetscFunctionBegin;
3801   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3802   PetscValidType(mat,1);
3803   PetscValidScalarPointer(nrm,3);
3804 
3805   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3806   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3807   if (!mat->ops->norm) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
3808   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3809 
3810   ierr = (*mat->ops->norm)(mat,type,nrm);CHKERRQ(ierr);
3811   PetscFunctionReturn(0);
3812 }
3813 
3814 /*
3815      This variable is used to prevent counting of MatAssemblyBegin() that
3816    are called from within a MatAssemblyEnd().
3817 */
3818 static PetscInt MatAssemblyEnd_InUse = 0;
3819 #undef __FUNCT__
3820 #define __FUNCT__ "MatAssemblyBegin"
3821 /*@
3822    MatAssemblyBegin - Begins assembling the matrix.  This routine should
3823    be called after completing all calls to MatSetValues().
3824 
3825    Collective on Mat
3826 
3827    Input Parameters:
3828 +  mat - the matrix
3829 -  type - type of assembly, either MAT_FLUSH_ASSEMBLY or MAT_FINAL_ASSEMBLY
3830 
3831    Notes:
3832    MatSetValues() generally caches the values.  The matrix is ready to
3833    use only after MatAssemblyBegin() and MatAssemblyEnd() have been called.
3834    Use MAT_FLUSH_ASSEMBLY when switching between ADD_VALUES and INSERT_VALUES
3835    in MatSetValues(); use MAT_FINAL_ASSEMBLY for the final assembly before
3836    using the matrix.
3837 
3838    Level: beginner
3839 
3840    Concepts: matrices^assembling
3841 
3842 .seealso: MatAssemblyEnd(), MatSetValues(), MatAssembled()
3843 @*/
3844 PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat mat,MatAssemblyType type)
3845 {
3846   PetscErrorCode ierr;
3847 
3848   PetscFunctionBegin;
3849   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3850   PetscValidType(mat,1);
3851   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3852   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix.\nDid you forget to call MatSetUnfactored()?");
3853   if (mat->assembled) {
3854     mat->was_assembled = PETSC_TRUE;
3855     mat->assembled     = PETSC_FALSE;
3856   }
3857   if (!MatAssemblyEnd_InUse) {
3858     ierr = PetscLogEventBegin(MAT_AssemblyBegin,mat,0,0,0);CHKERRQ(ierr);
3859     if (mat->ops->assemblybegin){ierr = (*mat->ops->assemblybegin)(mat,type);CHKERRQ(ierr);}
3860     ierr = PetscLogEventEnd(MAT_AssemblyBegin,mat,0,0,0);CHKERRQ(ierr);
3861   } else {
3862     if (mat->ops->assemblybegin){ierr = (*mat->ops->assemblybegin)(mat,type);CHKERRQ(ierr);}
3863   }
3864   PetscFunctionReturn(0);
3865 }
3866 
3867 #undef __FUNCT__
3868 #define __FUNCT__ "MatAssembed"
3869 /*@
3870    MatAssembled - Indicates if a matrix has been assembled and is ready for
3871      use; for example, in matrix-vector product.
3872 
3873    Collective on Mat
3874 
3875    Input Parameter:
3876 .  mat - the matrix
3877 
3878    Output Parameter:
3879 .  assembled - PETSC_TRUE or PETSC_FALSE
3880 
3881    Level: advanced
3882 
3883    Concepts: matrices^assembled?
3884 
3885 .seealso: MatAssemblyEnd(), MatSetValues(), MatAssemblyBegin()
3886 @*/
3887 PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat mat,PetscTruth *assembled)
3888 {
3889   PetscFunctionBegin;
3890   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3891   PetscValidType(mat,1);
3892   PetscValidPointer(assembled,2);
3893   *assembled = mat->assembled;
3894   PetscFunctionReturn(0);
3895 }
3896 
3897 #undef __FUNCT__
3898 #define __FUNCT__ "MatView_Private"
3899 /*
3900     Processes command line options to determine if/how a matrix
3901   is to be viewed. Called by MatAssemblyEnd() and MatLoad().
3902 */
3903 PetscErrorCode MatView_Private(Mat mat)
3904 {
3905   PetscErrorCode    ierr;
3906   PetscTruth        flg1,flg2,flg3,flg4,flg6,flg7,flg8;
3907   static PetscTruth incall = PETSC_FALSE;
3908 #if defined(PETSC_USE_SOCKET_VIEWER)
3909   PetscTruth        flg5;
3910 #endif
3911 
3912   PetscFunctionBegin;
3913   if (incall) PetscFunctionReturn(0);
3914   incall = PETSC_TRUE;
3915   ierr = PetscOptionsBegin(mat->comm,mat->prefix,"Matrix Options","Mat");CHKERRQ(ierr);
3916     ierr = PetscOptionsName("-mat_view_info","Information on matrix size","MatView",&flg1);CHKERRQ(ierr);
3917     ierr = PetscOptionsName("-mat_view_info_detailed","Nonzeros in the matrix","MatView",&flg2);CHKERRQ(ierr);
3918     ierr = PetscOptionsName("-mat_view","Print matrix to stdout","MatView",&flg3);CHKERRQ(ierr);
3919     ierr = PetscOptionsName("-mat_view_matlab","Print matrix to stdout in a format Matlab can read","MatView",&flg4);CHKERRQ(ierr);
3920 #if defined(PETSC_USE_SOCKET_VIEWER)
3921     ierr = PetscOptionsName("-mat_view_socket","Send matrix to socket (can be read from matlab)","MatView",&flg5);CHKERRQ(ierr);
3922 #endif
3923     ierr = PetscOptionsName("-mat_view_binary","Save matrix to file in binary format","MatView",&flg6);CHKERRQ(ierr);
3924     ierr = PetscOptionsName("-mat_view_draw","Draw the matrix nonzero structure","MatView",&flg7);CHKERRQ(ierr);
3925   ierr = PetscOptionsEnd();CHKERRQ(ierr);
3926 
3927   if (flg1) {
3928     PetscViewer viewer;
3929 
3930     ierr = PetscViewerASCIIGetStdout(mat->comm,&viewer);CHKERRQ(ierr);
3931     ierr = PetscViewerPushFormat(viewer,PETSC_VIEWER_ASCII_INFO);CHKERRQ(ierr);
3932     ierr = MatView(mat,viewer);CHKERRQ(ierr);
3933     ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3934   }
3935   if (flg2) {
3936     PetscViewer viewer;
3937 
3938     ierr = PetscViewerASCIIGetStdout(mat->comm,&viewer);CHKERRQ(ierr);
3939     ierr = PetscViewerPushFormat(viewer,PETSC_VIEWER_ASCII_INFO_DETAIL);CHKERRQ(ierr);
3940     ierr = MatView(mat,viewer);CHKERRQ(ierr);
3941     ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3942   }
3943   if (flg3) {
3944     PetscViewer viewer;
3945 
3946     ierr = PetscViewerASCIIGetStdout(mat->comm,&viewer);CHKERRQ(ierr);
3947     ierr = MatView(mat,viewer);CHKERRQ(ierr);
3948   }
3949   if (flg4) {
3950     PetscViewer viewer;
3951 
3952     ierr = PetscViewerASCIIGetStdout(mat->comm,&viewer);CHKERRQ(ierr);
3953     ierr = PetscViewerPushFormat(viewer,PETSC_VIEWER_ASCII_MATLAB);CHKERRQ(ierr);
3954     ierr = MatView(mat,viewer);CHKERRQ(ierr);
3955     ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3956   }
3957 #if defined(PETSC_USE_SOCKET_VIEWER)
3958   if (flg5) {
3959     ierr = MatView(mat,PETSC_VIEWER_SOCKET_(mat->comm));CHKERRQ(ierr);
3960     ierr = PetscViewerFlush(PETSC_VIEWER_SOCKET_(mat->comm));CHKERRQ(ierr);
3961   }
3962 #endif
3963   if (flg6) {
3964     ierr = MatView(mat,PETSC_VIEWER_BINARY_(mat->comm));CHKERRQ(ierr);
3965     ierr = PetscViewerFlush(PETSC_VIEWER_BINARY_(mat->comm));CHKERRQ(ierr);
3966   }
3967   if (flg7) {
3968     ierr = PetscOptionsHasName(mat->prefix,"-mat_view_contour",&flg8);CHKERRQ(ierr);
3969     if (flg8) {
3970       PetscViewerPushFormat(PETSC_VIEWER_DRAW_(mat->comm),PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);
3971     }
3972     ierr = MatView(mat,PETSC_VIEWER_DRAW_(mat->comm));CHKERRQ(ierr);
3973     ierr = PetscViewerFlush(PETSC_VIEWER_DRAW_(mat->comm));CHKERRQ(ierr);
3974     if (flg8) {
3975       PetscViewerPopFormat(PETSC_VIEWER_DRAW_(mat->comm));CHKERRQ(ierr);
3976     }
3977   }
3978   incall = PETSC_FALSE;
3979   PetscFunctionReturn(0);
3980 }
3981 
3982 #undef __FUNCT__
3983 #define __FUNCT__ "MatAssemblyEnd"
3984 /*@
3985    MatAssemblyEnd - Completes assembling the matrix.  This routine should
3986    be called after MatAssemblyBegin().
3987 
3988    Collective on Mat
3989 
3990    Input Parameters:
3991 +  mat - the matrix
3992 -  type - type of assembly, either MAT_FLUSH_ASSEMBLY or MAT_FINAL_ASSEMBLY
3993 
3994    Options Database Keys:
3995 +  -mat_view_info - Prints info on matrix at conclusion of MatEndAssembly()
3996 .  -mat_view_info_detailed - Prints more detailed info
3997 .  -mat_view - Prints matrix in ASCII format
3998 .  -mat_view_matlab - Prints matrix in Matlab format
3999 .  -mat_view_draw - PetscDraws nonzero structure of matrix, using MatView() and PetscDrawOpenX().
4000 .  -display <name> - Sets display name (default is host)
4001 .  -draw_pause <sec> - Sets number of seconds to pause after display
4002 .  -mat_view_socket - Sends matrix to socket, can be accessed from Matlab (see users manual)
4003 .  -viewer_socket_machine <machine>
4004 .  -viewer_socket_port <port>
4005 .  -mat_view_binary - save matrix to file in binary format
4006 -  -viewer_binary_filename <name>
4007 
4008    Notes:
4009    MatSetValues() generally caches the values.  The matrix is ready to
4010    use only after MatAssemblyBegin() and MatAssemblyEnd() have been called.
4011    Use MAT_FLUSH_ASSEMBLY when switching between ADD_VALUES and INSERT_VALUES
4012    in MatSetValues(); use MAT_FINAL_ASSEMBLY for the final assembly before
4013    using the matrix.
4014 
4015    Level: beginner
4016 
4017 .seealso: MatAssemblyBegin(), MatSetValues(), PetscDrawOpenX(), MatView(), MatAssembled(), PetscViewerSocketOpen()
4018 @*/
4019 PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat mat,MatAssemblyType type)
4020 {
4021   PetscErrorCode  ierr;
4022   static PetscInt inassm = 0;
4023   PetscTruth      flg;
4024 
4025   PetscFunctionBegin;
4026   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4027   PetscValidType(mat,1);
4028 
4029   inassm++;
4030   MatAssemblyEnd_InUse++;
4031   if (MatAssemblyEnd_InUse == 1) { /* Do the logging only the first time through */
4032     ierr = PetscLogEventBegin(MAT_AssemblyEnd,mat,0,0,0);CHKERRQ(ierr);
4033     if (mat->ops->assemblyend) {
4034       ierr = (*mat->ops->assemblyend)(mat,type);CHKERRQ(ierr);
4035     }
4036     ierr = PetscLogEventEnd(MAT_AssemblyEnd,mat,0,0,0);CHKERRQ(ierr);
4037   } else {
4038     if (mat->ops->assemblyend) {
4039       ierr = (*mat->ops->assemblyend)(mat,type);CHKERRQ(ierr);
4040     }
4041   }
4042 
4043   /* Flush assembly is not a true assembly */
4044   if (type != MAT_FLUSH_ASSEMBLY) {
4045     mat->assembled  = PETSC_TRUE; mat->num_ass++;
4046   }
4047   mat->insertmode = NOT_SET_VALUES;
4048   MatAssemblyEnd_InUse--;
4049   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
4050   if (!mat->symmetric_eternal) {
4051     mat->symmetric_set              = PETSC_FALSE;
4052     mat->hermitian_set              = PETSC_FALSE;
4053     mat->structurally_symmetric_set = PETSC_FALSE;
4054   }
4055   if (inassm == 1 && type != MAT_FLUSH_ASSEMBLY) {
4056     ierr = MatView_Private(mat);CHKERRQ(ierr);
4057     ierr = PetscOptionsHasName(mat->prefix,"-mat_is_symmetric",&flg);CHKERRQ(ierr);
4058     if (flg) {
4059       PetscReal tol = 0.0;
4060       ierr = PetscOptionsGetReal(mat->prefix,"-mat_is_symmetric",&tol,PETSC_NULL);CHKERRQ(ierr);
4061       ierr = MatIsSymmetric(mat,tol,&flg);CHKERRQ(ierr);
4062       if (flg) {
4063         ierr = PetscPrintf(mat->comm,"Matrix is symmetric (tolerance %G)\n",tol);CHKERRQ(ierr);
4064       } else {
4065         ierr = PetscPrintf(mat->comm,"Matrix is not symmetric (tolerance %G)\n",tol);CHKERRQ(ierr);
4066       }
4067     }
4068   }
4069   inassm--;
4070   PetscFunctionReturn(0);
4071 }
4072 
4073 
4074 #undef __FUNCT__
4075 #define __FUNCT__ "MatCompress"
4076 /*@
4077    MatCompress - Tries to store the matrix in as little space as
4078    possible.  May fail if memory is already fully used, since it
4079    tries to allocate new space.
4080 
4081    Collective on Mat
4082 
4083    Input Parameters:
4084 .  mat - the matrix
4085 
4086    Level: advanced
4087 
4088 @*/
4089 PetscErrorCode PETSCMAT_DLLEXPORT MatCompress(Mat mat)
4090 {
4091   PetscErrorCode ierr;
4092 
4093   PetscFunctionBegin;
4094   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4095   PetscValidType(mat,1);
4096   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4097   if (mat->ops->compress) {ierr = (*mat->ops->compress)(mat);CHKERRQ(ierr);}
4098   PetscFunctionReturn(0);
4099 }
4100 
4101 #undef __FUNCT__
4102 #define __FUNCT__ "MatSetOption"
4103 /*@
4104    MatSetOption - Sets a parameter option for a matrix. Some options
4105    may be specific to certain storage formats.  Some options
4106    determine how values will be inserted (or added). Sorted,
4107    row-oriented input will generally assemble the fastest. The default
4108    is row-oriented, nonsorted input.
4109 
4110    Collective on Mat
4111 
4112    Input Parameters:
4113 +  mat - the matrix
4114 -  option - the option, one of those listed below (and possibly others),
4115              e.g., MAT_ROWS_SORTED, MAT_NEW_NONZERO_LOCATION_ERR
4116 
4117    Options Describing Matrix Structure:
4118 +    MAT_SYMMETRIC - symmetric in terms of both structure and value
4119 .    MAT_HERMITIAN - transpose is the complex conjugation
4120 .    MAT_STRUCTURALLY_SYMMETRIC - symmetric nonzero structure
4121 .    MAT_NOT_SYMMETRIC - not symmetric in value
4122 .    MAT_NOT_HERMITIAN - transpose is not the complex conjugation
4123 .    MAT_NOT_STRUCTURALLY_SYMMETRIC - not symmetric nonzero structure
4124 .    MAT_SYMMETRY_ETERNAL - if you would like the symmetry/Hermitian flag
4125                             you set to be kept with all future use of the matrix
4126                             including after MatAssemblyBegin/End() which could
4127                             potentially change the symmetry structure, i.e. you
4128                             KNOW the matrix will ALWAYS have the property you set.
4129 -    MAT_NOT_SYMMETRY_ETERNAL - if MatAssemblyBegin/End() is called then the
4130                                 flags you set will be dropped (in case potentially
4131                                 the symmetry etc was lost).
4132 
4133    Options For Use with MatSetValues():
4134    Insert a logically dense subblock, which can be
4135 +    MAT_ROW_ORIENTED - row-oriented (default)
4136 .    MAT_COLUMN_ORIENTED - column-oriented
4137 .    MAT_ROWS_SORTED - sorted by row
4138 .    MAT_ROWS_UNSORTED - not sorted by row (default)
4139 .    MAT_COLUMNS_SORTED - sorted by column
4140 -    MAT_COLUMNS_UNSORTED - not sorted by column (default)
4141 
4142    Not these options reflect the data you pass in with MatSetValues(); it has
4143    nothing to do with how the data is stored internally in the matrix
4144    data structure.
4145 
4146    When (re)assembling a matrix, we can restrict the input for
4147    efficiency/debugging purposes.  These options include
4148 +    MAT_NO_NEW_NONZERO_LOCATIONS - additional insertions will not be
4149         allowed if they generate a new nonzero
4150 .    MAT_YES_NEW_NONZERO_LOCATIONS - additional insertions will be allowed
4151 .    MAT_NO_NEW_DIAGONALS - additional insertions will not be allowed if
4152          they generate a nonzero in a new diagonal (for block diagonal format only)
4153 .    MAT_YES_NEW_DIAGONALS - new diagonals will be allowed (for block diagonal format only)
4154 .    MAT_IGNORE_OFF_PROC_ENTRIES - drops off-processor entries
4155 .    MAT_NEW_NONZERO_LOCATION_ERR - generates an error for new matrix entry
4156 -    MAT_USE_HASH_TABLE - uses a hash table to speed up matrix assembly
4157 
4158    Notes:
4159    Some options are relevant only for particular matrix types and
4160    are thus ignored by others.  Other options are not supported by
4161    certain matrix types and will generate an error message if set.
4162 
4163    If using a Fortran 77 module to compute a matrix, one may need to
4164    use the column-oriented option (or convert to the row-oriented
4165    format).
4166 
4167    MAT_NO_NEW_NONZERO_LOCATIONS indicates that any add or insertion
4168    that would generate a new entry in the nonzero structure is instead
4169    ignored.  Thus, if memory has not alredy been allocated for this particular
4170    data, then the insertion is ignored. For dense matrices, in which
4171    the entire array is allocated, no entries are ever ignored.
4172    Set after the first MatAssemblyEnd()
4173 
4174    MAT_NEW_NONZERO_LOCATION_ERR indicates that any add or insertion
4175    that would generate a new entry in the nonzero structure instead produces
4176    an error. (Currently supported for AIJ and BAIJ formats only.)
4177    This is a useful flag when using SAME_NONZERO_PATTERN in calling
4178    KSPSetOperators() to ensure that the nonzero pattern truely does
4179    remain unchanged. Set after the first MatAssemblyEnd()
4180 
4181    MAT_NEW_NONZERO_ALLOCATION_ERR indicates that any add or insertion
4182    that would generate a new entry that has not been preallocated will
4183    instead produce an error. (Currently supported for AIJ and BAIJ formats
4184    only.) This is a useful flag when debugging matrix memory preallocation.
4185 
4186    MAT_IGNORE_OFF_PROC_ENTRIES indicates entries destined for
4187    other processors should be dropped, rather than stashed.
4188    This is useful if you know that the "owning" processor is also
4189    always generating the correct matrix entries, so that PETSc need
4190    not transfer duplicate entries generated on another processor.
4191 
4192    MAT_USE_HASH_TABLE indicates that a hash table be used to improve the
4193    searches during matrix assembly. When this flag is set, the hash table
4194    is created during the first Matrix Assembly. This hash table is
4195    used the next time through, during MatSetVaules()/MatSetVaulesBlocked()
4196    to improve the searching of indices. MAT_NO_NEW_NONZERO_LOCATIONS flag
4197    should be used with MAT_USE_HASH_TABLE flag. This option is currently
4198    supported by MATMPIBAIJ format only.
4199 
4200    MAT_KEEP_ZEROED_ROWS indicates when MatZeroRows() is called the zeroed entries
4201    are kept in the nonzero structure
4202 
4203    MAT_IGNORE_ZERO_ENTRIES - for AIJ/IS matrices this will stop zero values from creating
4204    a zero location in the matrix
4205 
4206    MAT_USE_INODES - indicates using inode version of the code - works with AIJ and
4207    ROWBS matrix types
4208 
4209    MAT_DO_NOT_USE_INODES - indicates not using inode version of the code - works
4210    with AIJ and ROWBS matrix types (database option "-mat_no_inode")
4211 
4212    Level: intermediate
4213 
4214    Concepts: matrices^setting options
4215 
4216 @*/
4217 PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat mat,MatOption op)
4218 {
4219   PetscErrorCode ierr;
4220 
4221   PetscFunctionBegin;
4222   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4223   PetscValidType(mat,1);
4224   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4225   switch (op) {
4226   case MAT_SYMMETRIC:
4227     mat->symmetric                  = PETSC_TRUE;
4228     mat->structurally_symmetric     = PETSC_TRUE;
4229     mat->symmetric_set              = PETSC_TRUE;
4230     mat->structurally_symmetric_set = PETSC_TRUE;
4231     break;
4232   case MAT_HERMITIAN:
4233     mat->hermitian                  = PETSC_TRUE;
4234     mat->structurally_symmetric     = PETSC_TRUE;
4235     mat->hermitian_set              = PETSC_TRUE;
4236     mat->structurally_symmetric_set = PETSC_TRUE;
4237     break;
4238   case MAT_STRUCTURALLY_SYMMETRIC:
4239     mat->structurally_symmetric     = PETSC_TRUE;
4240     mat->structurally_symmetric_set = PETSC_TRUE;
4241     break;
4242   case MAT_NOT_SYMMETRIC:
4243     mat->symmetric                  = PETSC_FALSE;
4244     mat->symmetric_set              = PETSC_TRUE;
4245     break;
4246   case MAT_NOT_HERMITIAN:
4247     mat->hermitian                  = PETSC_FALSE;
4248     mat->hermitian_set              = PETSC_TRUE;
4249     break;
4250   case MAT_NOT_STRUCTURALLY_SYMMETRIC:
4251     mat->structurally_symmetric     = PETSC_FALSE;
4252     mat->structurally_symmetric_set = PETSC_TRUE;
4253     break;
4254   case MAT_SYMMETRY_ETERNAL:
4255     mat->symmetric_eternal          = PETSC_TRUE;
4256     break;
4257   case MAT_NOT_SYMMETRY_ETERNAL:
4258     mat->symmetric_eternal          = PETSC_FALSE;
4259     break;
4260   default:
4261     break;
4262   }
4263   if (mat->ops->setoption) {
4264     ierr = (*mat->ops->setoption)(mat,op);CHKERRQ(ierr);
4265   }
4266   PetscFunctionReturn(0);
4267 }
4268 
4269 #undef __FUNCT__
4270 #define __FUNCT__ "MatZeroEntries"
4271 /*@
4272    MatZeroEntries - Zeros all entries of a matrix.  For sparse matrices
4273    this routine retains the old nonzero structure.
4274 
4275    Collective on Mat
4276 
4277    Input Parameters:
4278 .  mat - the matrix
4279 
4280    Level: intermediate
4281 
4282    Concepts: matrices^zeroing
4283 
4284 .seealso: MatZeroRows()
4285 @*/
4286 PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat mat)
4287 {
4288   PetscErrorCode ierr;
4289 
4290   PetscFunctionBegin;
4291   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4292   PetscValidType(mat,1);
4293   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4294   if (mat->insertmode != NOT_SET_VALUES) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for matrices where you have set values but not yet assembled");
4295   if (!mat->ops->zeroentries) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
4296   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4297 
4298   ierr = PetscLogEventBegin(MAT_ZeroEntries,mat,0,0,0);CHKERRQ(ierr);
4299   ierr = (*mat->ops->zeroentries)(mat);CHKERRQ(ierr);
4300   ierr = PetscLogEventEnd(MAT_ZeroEntries,mat,0,0,0);CHKERRQ(ierr);
4301   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
4302   PetscFunctionReturn(0);
4303 }
4304 
4305 #undef __FUNCT__
4306 #define __FUNCT__ "MatZeroRows"
4307 /*@C
4308    MatZeroRows - Zeros all entries (except possibly the main diagonal)
4309    of a set of rows of a matrix.
4310 
4311    Collective on Mat
4312 
4313    Input Parameters:
4314 +  mat - the matrix
4315 .  numRows - the number of rows to remove
4316 .  rows - the global row indices
4317 -  diag - value put in all diagonals of eliminated rows
4318 
4319    Notes:
4320    For the AIJ and BAIJ matrix formats this removes the old nonzero structure,
4321    but does not release memory.  For the dense and block diagonal
4322    formats this does not alter the nonzero structure.
4323 
4324    If the option MatSetOption(mat,MAT_KEEP_ZEROED_ROWS) the nonzero structure
4325    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
4326    merely zeroed.
4327 
4328    The user can set a value in the diagonal entry (or for the AIJ and
4329    row formats can optionally remove the main diagonal entry from the
4330    nonzero structure as well, by passing 0.0 as the final argument).
4331 
4332    For the parallel case, all processes that share the matrix (i.e.,
4333    those in the communicator used for matrix creation) MUST call this
4334    routine, regardless of whether any rows being zeroed are owned by
4335    them.
4336 
4337    Each processor should list the rows that IT wants zeroed
4338 
4339    Level: intermediate
4340 
4341    Concepts: matrices^zeroing rows
4342 
4343 .seealso: MatZeroRowsIS(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption()
4344 @*/
4345 PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag)
4346 {
4347   PetscErrorCode ierr;
4348 
4349   PetscFunctionBegin;
4350   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4351   PetscValidType(mat,1);
4352   if (numRows) PetscValidIntPointer(rows,3);
4353   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4354   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4355   if (!mat->ops->zerorows) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
4356   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4357 
4358   ierr = (*mat->ops->zerorows)(mat,numRows,rows,diag);CHKERRQ(ierr);
4359   ierr = MatView_Private(mat);CHKERRQ(ierr);
4360   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
4361   PetscFunctionReturn(0);
4362 }
4363 
4364 #undef __FUNCT__
4365 #define __FUNCT__ "MatZeroRowsIS"
4366 /*@C
4367    MatZeroRowsIS - Zeros all entries (except possibly the main diagonal)
4368    of a set of rows of a matrix.
4369 
4370    Collective on Mat
4371 
4372    Input Parameters:
4373 +  mat - the matrix
4374 .  is - index set of rows to remove
4375 -  diag - value put in all diagonals of eliminated rows
4376 
4377    Notes:
4378    For the AIJ and BAIJ matrix formats this removes the old nonzero structure,
4379    but does not release memory.  For the dense and block diagonal
4380    formats this does not alter the nonzero structure.
4381 
4382    If the option MatSetOption(mat,MAT_KEEP_ZEROED_ROWS) the nonzero structure
4383    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
4384    merely zeroed.
4385 
4386    The user can set a value in the diagonal entry (or for the AIJ and
4387    row formats can optionally remove the main diagonal entry from the
4388    nonzero structure as well, by passing 0.0 as the final argument).
4389 
4390    For the parallel case, all processes that share the matrix (i.e.,
4391    those in the communicator used for matrix creation) MUST call this
4392    routine, regardless of whether any rows being zeroed are owned by
4393    them.
4394 
4395    Each processor should list the rows that IT wants zeroed
4396 
4397    Level: intermediate
4398 
4399    Concepts: matrices^zeroing rows
4400 
4401 .seealso: MatZeroRows(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption()
4402 @*/
4403 PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat mat,IS is,PetscScalar diag)
4404 {
4405   PetscInt       numRows;
4406   PetscInt       *rows;
4407   PetscErrorCode ierr;
4408 
4409   PetscFunctionBegin;
4410   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4411   PetscValidType(mat,1);
4412   PetscValidHeaderSpecific(is,IS_COOKIE,2);
4413   ierr = ISGetLocalSize(is,&numRows);CHKERRQ(ierr);
4414   ierr = ISGetIndices(is,&rows);CHKERRQ(ierr);
4415   ierr = MatZeroRows(mat,numRows,rows,diag);CHKERRQ(ierr);
4416   ierr = ISRestoreIndices(is,&rows);CHKERRQ(ierr);
4417   PetscFunctionReturn(0);
4418 }
4419 
4420 #undef __FUNCT__
4421 #define __FUNCT__ "MatZeroRowsLocal"
4422 /*@C
4423    MatZeroRowsLocal - Zeros all entries (except possibly the main diagonal)
4424    of a set of rows of a matrix; using local numbering of rows.
4425 
4426    Collective on Mat
4427 
4428    Input Parameters:
4429 +  mat - the matrix
4430 .  numRows - the number of rows to remove
4431 .  rows - the global row indices
4432 -  diag - value put in all diagonals of eliminated rows
4433 
4434    Notes:
4435    Before calling MatZeroRowsLocal(), the user must first set the
4436    local-to-global mapping by calling MatSetLocalToGlobalMapping().
4437 
4438    For the AIJ matrix formats this removes the old nonzero structure,
4439    but does not release memory.  For the dense and block diagonal
4440    formats this does not alter the nonzero structure.
4441 
4442    If the option MatSetOption(mat,MAT_KEEP_ZEROED_ROWS) the nonzero structure
4443    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
4444    merely zeroed.
4445 
4446    The user can set a value in the diagonal entry (or for the AIJ and
4447    row formats can optionally remove the main diagonal entry from the
4448    nonzero structure as well, by passing 0.0 as the final argument).
4449 
4450    Level: intermediate
4451 
4452    Concepts: matrices^zeroing
4453 
4454 .seealso: MatZeroRows(), MatZeroRowsLocalIS(), MatZeroEntries(), MatZeroRows(), MatSetLocalToGlobalMapping
4455 @*/
4456 PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag)
4457 {
4458   PetscErrorCode ierr;
4459 
4460   PetscFunctionBegin;
4461   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4462   PetscValidType(mat,1);
4463   if (numRows) PetscValidIntPointer(rows,3);
4464   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4465   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4466   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4467 
4468   if (mat->ops->zerorowslocal) {
4469     ierr = (*mat->ops->zerorowslocal)(mat,numRows,rows,diag);CHKERRQ(ierr);
4470   } else {
4471     IS is, newis;
4472     PetscInt *newRows;
4473 
4474     if (!mat->mapping) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Need to provide local to global mapping to matrix first");
4475     ierr = ISCreateGeneral(PETSC_COMM_SELF,numRows,rows,&is);CHKERRQ(ierr);
4476     ierr = ISLocalToGlobalMappingApplyIS(mat->mapping,is,&newis);CHKERRQ(ierr);
4477     ierr = ISGetIndices(newis,&newRows);CHKERRQ(ierr);
4478     ierr = (*mat->ops->zerorows)(mat,numRows,newRows,diag);CHKERRQ(ierr);
4479     ierr = ISRestoreIndices(newis,&newRows);CHKERRQ(ierr);
4480     ierr = ISDestroy(newis);CHKERRQ(ierr);
4481     ierr = ISDestroy(is);CHKERRQ(ierr);
4482   }
4483   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
4484   PetscFunctionReturn(0);
4485 }
4486 
4487 #undef __FUNCT__
4488 #define __FUNCT__ "MatZeroRowsLocal"
4489 /*@C
4490    MatZeroRowsLocal - Zeros all entries (except possibly the main diagonal)
4491    of a set of rows of a matrix; using local numbering of rows.
4492 
4493    Collective on Mat
4494 
4495    Input Parameters:
4496 +  mat - the matrix
4497 .  is - index set of rows to remove
4498 -  diag - value put in all diagonals of eliminated rows
4499 
4500    Notes:
4501    Before calling MatZeroRowsLocal(), the user must first set the
4502    local-to-global mapping by calling MatSetLocalToGlobalMapping().
4503 
4504    For the AIJ matrix formats this removes the old nonzero structure,
4505    but does not release memory.  For the dense and block diagonal
4506    formats this does not alter the nonzero structure.
4507 
4508    If the option MatSetOption(mat,MAT_KEEP_ZEROED_ROWS) the nonzero structure
4509    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
4510    merely zeroed.
4511 
4512    The user can set a value in the diagonal entry (or for the AIJ and
4513    row formats can optionally remove the main diagonal entry from the
4514    nonzero structure as well, by passing 0.0 as the final argument).
4515 
4516    Level: intermediate
4517 
4518    Concepts: matrices^zeroing
4519 
4520 .seealso: MatZeroRows(), MatZeroRowsLocal(), MatZeroEntries(), MatZeroRows(), MatSetLocalToGlobalMapping
4521 @*/
4522 PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat mat,IS is,PetscScalar diag)
4523 {
4524   PetscErrorCode ierr;
4525   PetscInt       numRows;
4526   PetscInt       *rows;
4527 
4528   PetscFunctionBegin;
4529   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4530   PetscValidType(mat,1);
4531   PetscValidHeaderSpecific(is,IS_COOKIE,2);
4532   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4533   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4534   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4535 
4536   ierr = ISGetLocalSize(is,&numRows);CHKERRQ(ierr);
4537   ierr = ISGetIndices(is,&rows);CHKERRQ(ierr);
4538   ierr = MatZeroRowsLocal(mat,numRows,rows,diag);CHKERRQ(ierr);
4539   ierr = ISRestoreIndices(is,&rows);CHKERRQ(ierr);
4540   PetscFunctionReturn(0);
4541 }
4542 
4543 #undef __FUNCT__
4544 #define __FUNCT__ "MatGetSize"
4545 /*@
4546    MatGetSize - Returns the numbers of rows and columns in a matrix.
4547 
4548    Not Collective
4549 
4550    Input Parameter:
4551 .  mat - the matrix
4552 
4553    Output Parameters:
4554 +  m - the number of global rows
4555 -  n - the number of global columns
4556 
4557    Note: both output parameters can be PETSC_NULL on input.
4558 
4559    Level: beginner
4560 
4561    Concepts: matrices^size
4562 
4563 .seealso: MatGetLocalSize()
4564 @*/
4565 PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat mat,PetscInt *m,PetscInt* n)
4566 {
4567   PetscFunctionBegin;
4568   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4569   if (m) *m = mat->rmap.N;
4570   if (n) *n = mat->cmap.N;
4571   PetscFunctionReturn(0);
4572 }
4573 
4574 #undef __FUNCT__
4575 #define __FUNCT__ "MatGetLocalSize"
4576 /*@
4577    MatGetLocalSize - Returns the number of rows and columns in a matrix
4578    stored locally.  This information may be implementation dependent, so
4579    use with care.
4580 
4581    Not Collective
4582 
4583    Input Parameters:
4584 .  mat - the matrix
4585 
4586    Output Parameters:
4587 +  m - the number of local rows
4588 -  n - the number of local columns
4589 
4590    Note: both output parameters can be PETSC_NULL on input.
4591 
4592    Level: beginner
4593 
4594    Concepts: matrices^local size
4595 
4596 .seealso: MatGetSize()
4597 @*/
4598 PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat mat,PetscInt *m,PetscInt* n)
4599 {
4600   PetscFunctionBegin;
4601   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4602   if (m) PetscValidIntPointer(m,2);
4603   if (n) PetscValidIntPointer(n,3);
4604   if (m) *m = mat->rmap.n;
4605   if (n) *n = mat->cmap.n;
4606   PetscFunctionReturn(0);
4607 }
4608 
4609 
4610 #undef __FUNCT__
4611 #define __FUNCT__ "MatGetOwnershipRange"
4612 /*@
4613    MatGetOwnershipRange - Returns the range of matrix rows owned by
4614    this processor, assuming that the matrix is laid out with the first
4615    n1 rows on the first processor, the next n2 rows on the second, etc.
4616    For certain parallel layouts this range may not be well defined.
4617 
4618    Not Collective
4619 
4620    Input Parameters:
4621 .  mat - the matrix
4622 
4623    Output Parameters:
4624 +  m - the global index of the first local row
4625 -  n - one more than the global index of the last local row
4626 
4627    Note: both output parameters can be PETSC_NULL on input.
4628 
4629    Level: beginner
4630 
4631    Concepts: matrices^row ownership
4632 
4633 .seealso:   MatGetOwnershipRanges()
4634 
4635 @*/
4636 PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat mat,PetscInt *m,PetscInt* n)
4637 {
4638   PetscErrorCode ierr;
4639 
4640   PetscFunctionBegin;
4641   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4642   PetscValidType(mat,1);
4643   if (m) PetscValidIntPointer(m,2);
4644   if (n) PetscValidIntPointer(n,3);
4645   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4646   if (m) *m = mat->rmap.rstart;
4647   if (n) *n = mat->rmap.rend;
4648   PetscFunctionReturn(0);
4649 }
4650 
4651 #undef __FUNCT__
4652 #define __FUNCT__ "MatGetOwnershipRanges"
4653 /*@C
4654    MatGetOwnershipRanges - Returns the range of matrix rows owned by
4655    each process
4656 
4657    Not Collective
4658 
4659    Input Parameters:
4660 .  mat - the matrix
4661 
4662    Output Parameters:
4663 .  ranges - start of each processors portion plus one more then the total length at the end
4664 
4665    Level: beginner
4666 
4667    Concepts: matrices^row ownership
4668 
4669 .seealso:   MatGetOwnershipRange()
4670 
4671 @*/
4672 PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRanges(Mat mat,const PetscInt **ranges)
4673 {
4674   PetscErrorCode ierr;
4675 
4676   PetscFunctionBegin;
4677   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4678   PetscValidType(mat,1);
4679   ierr = PetscMapGetGlobalRange(&mat->rmap,ranges);CHKERRQ(ierr);
4680   PetscFunctionReturn(0);
4681 }
4682 
4683 #undef __FUNCT__
4684 #define __FUNCT__ "MatILUFactorSymbolic"
4685 /*@
4686    MatILUFactorSymbolic - Performs symbolic ILU factorization of a matrix.
4687    Uses levels of fill only, not drop tolerance. Use MatLUFactorNumeric()
4688    to complete the factorization.
4689 
4690    Collective on Mat
4691 
4692    Input Parameters:
4693 +  mat - the matrix
4694 .  row - row permutation
4695 .  column - column permutation
4696 -  info - structure containing
4697 $      levels - number of levels of fill.
4698 $      expected fill - as ratio of original fill.
4699 $      1 or 0 - indicating force fill on diagonal (improves robustness for matrices
4700                 missing diagonal entries)
4701 
4702    Output Parameters:
4703 .  fact - new matrix that has been symbolically factored
4704 
4705    Notes:
4706    See the users manual for additional information about
4707    choosing the fill factor for better efficiency.
4708 
4709    Most users should employ the simplified KSP interface for linear solvers
4710    instead of working directly with matrix algebra routines such as this.
4711    See, e.g., KSPCreate().
4712 
4713    Level: developer
4714 
4715   Concepts: matrices^symbolic LU factorization
4716   Concepts: matrices^factorization
4717   Concepts: LU^symbolic factorization
4718 
4719 .seealso: MatLUFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor()
4720           MatGetOrdering(), MatFactorInfo
4721 
4722 @*/
4723 PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat mat,IS row,IS col,MatFactorInfo *info,Mat *fact)
4724 {
4725   PetscErrorCode ierr;
4726 
4727   PetscFunctionBegin;
4728   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4729   PetscValidType(mat,1);
4730   PetscValidHeaderSpecific(row,IS_COOKIE,2);
4731   PetscValidHeaderSpecific(col,IS_COOKIE,3);
4732   PetscValidPointer(info,4);
4733   PetscValidPointer(fact,5);
4734   if (info->levels < 0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Levels of fill negative %D",(PetscInt)info->levels);
4735   if (info->fill < 1.0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Expected fill less than 1.0 %G",info->fill);
4736   if (!mat->ops->ilufactorsymbolic) SETERRQ1(PETSC_ERR_SUP,"Matrix type %s  symbolic ILU",mat->type_name);
4737   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4738   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4739   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4740 
4741   ierr = PetscLogEventBegin(MAT_ILUFactorSymbolic,mat,row,col,0);CHKERRQ(ierr);
4742   ierr = (*mat->ops->ilufactorsymbolic)(mat,row,col,info,fact);CHKERRQ(ierr);
4743   ierr = PetscLogEventEnd(MAT_ILUFactorSymbolic,mat,row,col,0);CHKERRQ(ierr);
4744   PetscFunctionReturn(0);
4745 }
4746 
4747 #undef __FUNCT__
4748 #define __FUNCT__ "MatICCFactorSymbolic"
4749 /*@
4750    MatICCFactorSymbolic - Performs symbolic incomplete
4751    Cholesky factorization for a symmetric matrix.  Use
4752    MatCholeskyFactorNumeric() to complete the factorization.
4753 
4754    Collective on Mat
4755 
4756    Input Parameters:
4757 +  mat - the matrix
4758 .  perm - row and column permutation
4759 -  info - structure containing
4760 $      levels - number of levels of fill.
4761 $      expected fill - as ratio of original fill.
4762 
4763    Output Parameter:
4764 .  fact - the factored matrix
4765 
4766    Notes:
4767    Most users should employ the KSP interface for linear solvers
4768    instead of working directly with matrix algebra routines such as this.
4769    See, e.g., KSPCreate().
4770 
4771    Level: developer
4772 
4773   Concepts: matrices^symbolic incomplete Cholesky factorization
4774   Concepts: matrices^factorization
4775   Concepts: Cholsky^symbolic factorization
4776 
4777 .seealso: MatCholeskyFactorNumeric(), MatCholeskyFactor(), MatFactorInfo
4778 @*/
4779 PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat mat,IS perm,MatFactorInfo *info,Mat *fact)
4780 {
4781   PetscErrorCode ierr;
4782 
4783   PetscFunctionBegin;
4784   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4785   PetscValidType(mat,1);
4786   PetscValidHeaderSpecific(perm,IS_COOKIE,2);
4787   PetscValidPointer(info,3);
4788   PetscValidPointer(fact,4);
4789   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4790   if (info->levels < 0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Levels negative %D",(PetscInt) info->levels);
4791   if (info->fill < 1.0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Expected fill less than 1.0 %G",info->fill);
4792   if (!mat->ops->iccfactorsymbolic) SETERRQ1(PETSC_ERR_SUP,"Matrix type %s  symbolic ICC",mat->type_name);
4793   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4794   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4795 
4796   ierr = PetscLogEventBegin(MAT_ICCFactorSymbolic,mat,perm,0,0);CHKERRQ(ierr);
4797   ierr = (*mat->ops->iccfactorsymbolic)(mat,perm,info,fact);CHKERRQ(ierr);
4798   ierr = PetscLogEventEnd(MAT_ICCFactorSymbolic,mat,perm,0,0);CHKERRQ(ierr);
4799   PetscFunctionReturn(0);
4800 }
4801 
4802 #undef __FUNCT__
4803 #define __FUNCT__ "MatGetArray"
4804 /*@C
4805    MatGetArray - Returns a pointer to the element values in the matrix.
4806    The result of this routine is dependent on the underlying matrix data
4807    structure, and may not even work for certain matrix types.  You MUST
4808    call MatRestoreArray() when you no longer need to access the array.
4809 
4810    Not Collective
4811 
4812    Input Parameter:
4813 .  mat - the matrix
4814 
4815    Output Parameter:
4816 .  v - the location of the values
4817 
4818 
4819    Fortran Note:
4820    This routine is used differently from Fortran, e.g.,
4821 .vb
4822         Mat         mat
4823         PetscScalar mat_array(1)
4824         PetscOffset i_mat
4825         PetscErrorCode ierr
4826         call MatGetArray(mat,mat_array,i_mat,ierr)
4827 
4828   C  Access first local entry in matrix; note that array is
4829   C  treated as one dimensional
4830         value = mat_array(i_mat + 1)
4831 
4832         [... other code ...]
4833         call MatRestoreArray(mat,mat_array,i_mat,ierr)
4834 .ve
4835 
4836    See the Fortran chapter of the users manual and
4837    petsc/src/mat/examples/tests for details.
4838 
4839    Level: advanced
4840 
4841    Concepts: matrices^access array
4842 
4843 .seealso: MatRestoreArray(), MatGetArrayF90()
4844 @*/
4845 PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat mat,PetscScalar *v[])
4846 {
4847   PetscErrorCode ierr;
4848 
4849   PetscFunctionBegin;
4850   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4851   PetscValidType(mat,1);
4852   PetscValidPointer(v,2);
4853   if (!mat->ops->getarray) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
4854   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4855   ierr = (*mat->ops->getarray)(mat,v);CHKERRQ(ierr);
4856   CHKMEMQ;
4857   PetscFunctionReturn(0);
4858 }
4859 
4860 #undef __FUNCT__
4861 #define __FUNCT__ "MatRestoreArray"
4862 /*@C
4863    MatRestoreArray - Restores the matrix after MatGetArray() has been called.
4864 
4865    Not Collective
4866 
4867    Input Parameter:
4868 +  mat - the matrix
4869 -  v - the location of the values
4870 
4871    Fortran Note:
4872    This routine is used differently from Fortran, e.g.,
4873 .vb
4874         Mat         mat
4875         PetscScalar mat_array(1)
4876         PetscOffset i_mat
4877         PetscErrorCode ierr
4878         call MatGetArray(mat,mat_array,i_mat,ierr)
4879 
4880   C  Access first local entry in matrix; note that array is
4881   C  treated as one dimensional
4882         value = mat_array(i_mat + 1)
4883 
4884         [... other code ...]
4885         call MatRestoreArray(mat,mat_array,i_mat,ierr)
4886 .ve
4887 
4888    See the Fortran chapter of the users manual and
4889    petsc/src/mat/examples/tests for details
4890 
4891    Level: advanced
4892 
4893 .seealso: MatGetArray(), MatRestoreArrayF90()
4894 @*/
4895 PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat mat,PetscScalar *v[])
4896 {
4897   PetscErrorCode ierr;
4898 
4899   PetscFunctionBegin;
4900   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4901   PetscValidType(mat,1);
4902   PetscValidPointer(v,2);
4903 #if defined(PETSC_USE_DEBUG)
4904   CHKMEMQ;
4905 #endif
4906   if (!mat->ops->restorearray) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
4907   ierr = (*mat->ops->restorearray)(mat,v);CHKERRQ(ierr);
4908   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
4909   PetscFunctionReturn(0);
4910 }
4911 
4912 #undef __FUNCT__
4913 #define __FUNCT__ "MatGetSubMatrices"
4914 /*@C
4915    MatGetSubMatrices - Extracts several submatrices from a matrix. If submat
4916    points to an array of valid matrices, they may be reused to store the new
4917    submatrices.
4918 
4919    Collective on Mat
4920 
4921    Input Parameters:
4922 +  mat - the matrix
4923 .  n   - the number of submatrixes to be extracted (on this processor, may be zero)
4924 .  irow, icol - index sets of rows and columns to extract
4925 -  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
4926 
4927    Output Parameter:
4928 .  submat - the array of submatrices
4929 
4930    Notes:
4931    MatGetSubMatrices() can extract only sequential submatrices
4932    (from both sequential and parallel matrices). Use MatGetSubMatrix()
4933    to extract a parallel submatrix.
4934 
4935    When extracting submatrices from a parallel matrix, each processor can
4936    form a different submatrix by setting the rows and columns of its
4937    individual index sets according to the local submatrix desired.
4938 
4939    When finished using the submatrices, the user should destroy
4940    them with MatDestroyMatrices().
4941 
4942    MAT_REUSE_MATRIX can only be used when the nonzero structure of the
4943    original matrix has not changed from that last call to MatGetSubMatrices().
4944 
4945    This routine creates the matrices in submat; you should NOT create them before
4946    calling it. It also allocates the array of matrix pointers submat.
4947 
4948    For BAIJ matrices the index sets must respect the block structure, that is if they
4949    request one row/column in a block, they must request all rows/columns that are in
4950    that block. For example, if the block size is 2 you cannot request just row 0 and
4951    column 0.
4952 
4953    Fortran Note:
4954    The Fortran interface is slightly different from that given below; it
4955    requires one to pass in  as submat a Mat (integer) array of size at least m.
4956 
4957    Level: advanced
4958 
4959    Concepts: matrices^accessing submatrices
4960    Concepts: submatrices
4961 
4962 .seealso: MatDestroyMatrices(), MatGetSubMatrix(), MatGetRow(), MatGetDiagonal()
4963 @*/
4964 PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[])
4965 {
4966   PetscErrorCode ierr;
4967   PetscInt        i;
4968   PetscTruth      eq;
4969 
4970   PetscFunctionBegin;
4971   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4972   PetscValidType(mat,1);
4973   if (n) {
4974     PetscValidPointer(irow,3);
4975     PetscValidHeaderSpecific(*irow,IS_COOKIE,3);
4976     PetscValidPointer(icol,4);
4977     PetscValidHeaderSpecific(*icol,IS_COOKIE,4);
4978   }
4979   PetscValidPointer(submat,6);
4980   if (n && scall == MAT_REUSE_MATRIX) {
4981     PetscValidPointer(*submat,6);
4982     PetscValidHeaderSpecific(**submat,MAT_COOKIE,6);
4983   }
4984   if (!mat->ops->getsubmatrices) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
4985   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4986   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4987   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4988 
4989   ierr = PetscLogEventBegin(MAT_GetSubMatrices,mat,0,0,0);CHKERRQ(ierr);
4990   ierr = (*mat->ops->getsubmatrices)(mat,n,irow,icol,scall,submat);CHKERRQ(ierr);
4991   ierr = PetscLogEventEnd(MAT_GetSubMatrices,mat,0,0,0);CHKERRQ(ierr);
4992   for (i=0; i<n; i++) {
4993     if (mat->symmetric || mat->structurally_symmetric || mat->hermitian) {
4994       ierr = ISEqual(irow[i],icol[i],&eq);CHKERRQ(ierr);
4995       if (eq) {
4996 	if (mat->symmetric){
4997 	  ierr = MatSetOption((*submat)[i],MAT_SYMMETRIC);CHKERRQ(ierr);
4998 	} else if (mat->hermitian) {
4999 	  ierr = MatSetOption((*submat)[i],MAT_HERMITIAN);CHKERRQ(ierr);
5000 	} else if (mat->structurally_symmetric) {
5001 	  ierr = MatSetOption((*submat)[i],MAT_STRUCTURALLY_SYMMETRIC);CHKERRQ(ierr);
5002 	}
5003       }
5004     }
5005   }
5006   PetscFunctionReturn(0);
5007 }
5008 
5009 #undef __FUNCT__
5010 #define __FUNCT__ "MatDestroyMatrices"
5011 /*@C
5012    MatDestroyMatrices - Destroys a set of matrices obtained with MatGetSubMatrices().
5013 
5014    Collective on Mat
5015 
5016    Input Parameters:
5017 +  n - the number of local matrices
5018 -  mat - the matrices (note that this is a pointer to the array of matrices, just to match the calling
5019                        sequence of MatGetSubMatrices())
5020 
5021    Level: advanced
5022 
5023     Notes: Frees not only the matrices, but also the array that contains the matrices
5024 
5025 .seealso: MatGetSubMatrices()
5026 @*/
5027 PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt n,Mat *mat[])
5028 {
5029   PetscErrorCode ierr;
5030   PetscInt       i;
5031 
5032   PetscFunctionBegin;
5033   if (n < 0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Trying to destroy negative number of matrices %D",n);
5034   PetscValidPointer(mat,2);
5035   for (i=0; i<n; i++) {
5036     ierr = MatDestroy((*mat)[i]);CHKERRQ(ierr);
5037   }
5038   /* memory is allocated even if n = 0 */
5039   ierr = PetscFree(*mat);CHKERRQ(ierr);
5040   PetscFunctionReturn(0);
5041 }
5042 
5043 #undef __FUNCT__
5044 #define __FUNCT__ "MatIncreaseOverlap"
5045 /*@
5046    MatIncreaseOverlap - Given a set of submatrices indicated by index sets,
5047    replaces the index sets by larger ones that represent submatrices with
5048    additional overlap.
5049 
5050    Collective on Mat
5051 
5052    Input Parameters:
5053 +  mat - the matrix
5054 .  n   - the number of index sets
5055 .  is  - the array of index sets (these index sets will changed during the call)
5056 -  ov  - the additional overlap requested
5057 
5058    Level: developer
5059 
5060    Concepts: overlap
5061    Concepts: ASM^computing overlap
5062 
5063 .seealso: MatGetSubMatrices()
5064 @*/
5065 PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat mat,PetscInt n,IS is[],PetscInt ov)
5066 {
5067   PetscErrorCode ierr;
5068 
5069   PetscFunctionBegin;
5070   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5071   PetscValidType(mat,1);
5072   if (n < 0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Must have one or more domains, you have %D",n);
5073   if (n) {
5074     PetscValidPointer(is,3);
5075     PetscValidHeaderSpecific(*is,IS_COOKIE,3);
5076   }
5077   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5078   if (mat->factor)     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5079   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5080 
5081   if (!ov) PetscFunctionReturn(0);
5082   if (!mat->ops->increaseoverlap) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
5083   ierr = PetscLogEventBegin(MAT_IncreaseOverlap,mat,0,0,0);CHKERRQ(ierr);
5084   ierr = (*mat->ops->increaseoverlap)(mat,n,is,ov);CHKERRQ(ierr);
5085   ierr = PetscLogEventEnd(MAT_IncreaseOverlap,mat,0,0,0);CHKERRQ(ierr);
5086   PetscFunctionReturn(0);
5087 }
5088 
5089 #undef __FUNCT__
5090 #define __FUNCT__ "MatGetBlockSize"
5091 /*@
5092    MatGetBlockSize - Returns the matrix block size; useful especially for the
5093    block row and block diagonal formats.
5094 
5095    Not Collective
5096 
5097    Input Parameter:
5098 .  mat - the matrix
5099 
5100    Output Parameter:
5101 .  bs - block size
5102 
5103    Notes:
5104    Block diagonal formats are MATSEQBDIAG, MATMPIBDIAG.
5105    Block row formats are MATSEQBAIJ, MATMPIBAIJ, MATSEQSBAIJ, MATMPISBAIJ
5106 
5107    Level: intermediate
5108 
5109    Concepts: matrices^block size
5110 
5111 .seealso: MatCreateSeqBAIJ(), MatCreateMPIBAIJ(), MatCreateSeqBDiag(), MatCreateMPIBDiag()
5112 @*/
5113 PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat mat,PetscInt *bs)
5114 {
5115   PetscErrorCode ierr;
5116 
5117   PetscFunctionBegin;
5118   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5119   PetscValidType(mat,1);
5120   PetscValidIntPointer(bs,2);
5121   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5122   *bs = mat->rmap.bs;
5123   PetscFunctionReturn(0);
5124 }
5125 
5126 #undef __FUNCT__
5127 #define __FUNCT__ "MatSetBlockSize"
5128 /*@
5129    MatSetBlockSize - Sets the matrix block size; for many matrix types you
5130      cannot use this and MUST set the blocksize when you preallocate the matrix
5131 
5132    Not Collective
5133 
5134    Input Parameters:
5135 +  mat - the matrix
5136 -  bs - block size
5137 
5138    Notes:
5139      Only works for shell and AIJ matrices
5140 
5141    Level: intermediate
5142 
5143    Concepts: matrices^block size
5144 
5145 .seealso: MatCreateSeqBAIJ(), MatCreateMPIBAIJ(), MatCreateSeqBDiag(), MatCreateMPIBDiag(), MatGetBlockSize()
5146 @*/
5147 PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat mat,PetscInt bs)
5148 {
5149   PetscErrorCode ierr;
5150 
5151   PetscFunctionBegin;
5152   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5153   PetscValidType(mat,1);
5154   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5155   if (mat->ops->setblocksize) {
5156     mat->rmap.bs = bs;
5157     ierr = (*mat->ops->setblocksize)(mat,bs);CHKERRQ(ierr);
5158   } else {
5159     SETERRQ1(PETSC_ERR_ARG_INCOMP,"Cannot set the blocksize for matrix type %s",mat->type_name);
5160   }
5161   PetscFunctionReturn(0);
5162 }
5163 
5164 #undef __FUNCT__
5165 #define __FUNCT__ "MatGetRowIJ"
5166 /*@C
5167     MatGetRowIJ - Returns the compressed row storage i and j indices for sequential matrices.
5168 
5169    Collective on Mat
5170 
5171     Input Parameters:
5172 +   mat - the matrix
5173 .   shift -  0 or 1 indicating we want the indices starting at 0 or 1
5174 -   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
5175                 symmetrized
5176 
5177     Output Parameters:
5178 +   n - number of rows in the (possibly compressed) matrix
5179 .   ia - the row pointers
5180 .   ja - the column indices
5181 -   done - indicates if the routine actually worked and returned appropriate ia[] and ja[] arrays; callers
5182            are responsible for handling the case when done == PETSC_FALSE and ia and ja are not set
5183 
5184     Level: developer
5185 
5186     Notes: You CANNOT change any of the ia[] or ja[] values.
5187 
5188            Use MatRestoreRowIJ() when you are finished accessing the ia[] and ja[] values
5189 
5190 .seealso: MatGetColumnIJ(), MatRestoreRowIJ()
5191 @*/
5192 PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat mat,PetscInt shift,PetscTruth symmetric,PetscInt *n,PetscInt *ia[],PetscInt* ja[],PetscTruth *done)
5193 {
5194   PetscErrorCode ierr;
5195 
5196   PetscFunctionBegin;
5197   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5198   PetscValidType(mat,1);
5199   PetscValidIntPointer(n,4);
5200   if (ia) PetscValidIntPointer(ia,5);
5201   if (ja) PetscValidIntPointer(ja,6);
5202   PetscValidIntPointer(done,7);
5203   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5204   if (!mat->ops->getrowij) *done = PETSC_FALSE;
5205   else {
5206     *done = PETSC_TRUE;
5207     ierr = PetscLogEventBegin(MAT_GetRowIJ,mat,0,0,0);CHKERRQ(ierr);
5208     ierr  = (*mat->ops->getrowij)(mat,shift,symmetric,n,ia,ja,done);CHKERRQ(ierr);
5209     ierr = PetscLogEventEnd(MAT_GetRowIJ,mat,0,0,0);CHKERRQ(ierr);
5210   }
5211   PetscFunctionReturn(0);
5212 }
5213 
5214 #undef __FUNCT__
5215 #define __FUNCT__ "MatGetColumnIJ"
5216 /*@C
5217     MatGetColumnIJ - Returns the compressed column storage i and j indices for sequential matrices.
5218 
5219     Collective on Mat
5220 
5221     Input Parameters:
5222 +   mat - the matrix
5223 .   shift - 1 or zero indicating we want the indices starting at 0 or 1
5224 -   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
5225                 symmetrized
5226 
5227     Output Parameters:
5228 +   n - number of columns in the (possibly compressed) matrix
5229 .   ia - the column pointers
5230 .   ja - the row indices
5231 -   done - PETSC_TRUE or PETSC_FALSE, indicating whether the values have been returned
5232 
5233     Level: developer
5234 
5235 .seealso: MatGetRowIJ(), MatRestoreColumnIJ()
5236 @*/
5237 PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat mat,PetscInt shift,PetscTruth symmetric,PetscInt *n,PetscInt *ia[],PetscInt* ja[],PetscTruth *done)
5238 {
5239   PetscErrorCode ierr;
5240 
5241   PetscFunctionBegin;
5242   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5243   PetscValidType(mat,1);
5244   PetscValidIntPointer(n,4);
5245   if (ia) PetscValidIntPointer(ia,5);
5246   if (ja) PetscValidIntPointer(ja,6);
5247   PetscValidIntPointer(done,7);
5248   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5249   if (!mat->ops->getcolumnij) *done = PETSC_FALSE;
5250   else {
5251     *done = PETSC_TRUE;
5252     ierr  = (*mat->ops->getcolumnij)(mat,shift,symmetric,n,ia,ja,done);CHKERRQ(ierr);
5253   }
5254   PetscFunctionReturn(0);
5255 }
5256 
5257 #undef __FUNCT__
5258 #define __FUNCT__ "MatRestoreRowIJ"
5259 /*@C
5260     MatRestoreRowIJ - Call after you are completed with the ia,ja indices obtained with
5261     MatGetRowIJ().
5262 
5263     Collective on Mat
5264 
5265     Input Parameters:
5266 +   mat - the matrix
5267 .   shift - 1 or zero indicating we want the indices starting at 0 or 1
5268 -   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
5269                 symmetrized
5270 
5271     Output Parameters:
5272 +   n - size of (possibly compressed) matrix
5273 .   ia - the row pointers
5274 .   ja - the column indices
5275 -   done - PETSC_TRUE or PETSC_FALSE indicated that the values have been returned
5276 
5277     Level: developer
5278 
5279 .seealso: MatGetRowIJ(), MatRestoreColumnIJ()
5280 @*/
5281 PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat mat,PetscInt shift,PetscTruth symmetric,PetscInt *n,PetscInt *ia[],PetscInt* ja[],PetscTruth *done)
5282 {
5283   PetscErrorCode ierr;
5284 
5285   PetscFunctionBegin;
5286   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5287   PetscValidType(mat,1);
5288   if (ia) PetscValidIntPointer(ia,5);
5289   if (ja) PetscValidIntPointer(ja,6);
5290   PetscValidIntPointer(done,7);
5291   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5292 
5293   if (!mat->ops->restorerowij) *done = PETSC_FALSE;
5294   else {
5295     *done = PETSC_TRUE;
5296     ierr  = (*mat->ops->restorerowij)(mat,shift,symmetric,n,ia,ja,done);CHKERRQ(ierr);
5297   }
5298   PetscFunctionReturn(0);
5299 }
5300 
5301 #undef __FUNCT__
5302 #define __FUNCT__ "MatRestoreColumnIJ"
5303 /*@C
5304     MatRestoreColumnIJ - Call after you are completed with the ia,ja indices obtained with
5305     MatGetColumnIJ().
5306 
5307     Collective on Mat
5308 
5309     Input Parameters:
5310 +   mat - the matrix
5311 .   shift - 1 or zero indicating we want the indices starting at 0 or 1
5312 -   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
5313                 symmetrized
5314 
5315     Output Parameters:
5316 +   n - size of (possibly compressed) matrix
5317 .   ia - the column pointers
5318 .   ja - the row indices
5319 -   done - PETSC_TRUE or PETSC_FALSE indicated that the values have been returned
5320 
5321     Level: developer
5322 
5323 .seealso: MatGetColumnIJ(), MatRestoreRowIJ()
5324 @*/
5325 PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat mat,PetscInt shift,PetscTruth symmetric,PetscInt *n,PetscInt *ia[],PetscInt* ja[],PetscTruth *done)
5326 {
5327   PetscErrorCode ierr;
5328 
5329   PetscFunctionBegin;
5330   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5331   PetscValidType(mat,1);
5332   if (ia) PetscValidIntPointer(ia,5);
5333   if (ja) PetscValidIntPointer(ja,6);
5334   PetscValidIntPointer(done,7);
5335   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5336 
5337   if (!mat->ops->restorecolumnij) *done = PETSC_FALSE;
5338   else {
5339     *done = PETSC_TRUE;
5340     ierr  = (*mat->ops->restorecolumnij)(mat,shift,symmetric,n,ia,ja,done);CHKERRQ(ierr);
5341   }
5342   PetscFunctionReturn(0);
5343 }
5344 
5345 #undef __FUNCT__
5346 #define __FUNCT__ "MatColoringPatch"
5347 /*@C
5348     MatColoringPatch -Used inside matrix coloring routines that
5349     use MatGetRowIJ() and/or MatGetColumnIJ().
5350 
5351     Collective on Mat
5352 
5353     Input Parameters:
5354 +   mat - the matrix
5355 .   ncolors - max color value
5356 .   n   - number of entries in colorarray
5357 -   colorarray - array indicating color for each column
5358 
5359     Output Parameters:
5360 .   iscoloring - coloring generated using colorarray information
5361 
5362     Level: developer
5363 
5364 .seealso: MatGetRowIJ(), MatGetColumnIJ()
5365 
5366 @*/
5367 PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat mat,PetscInt ncolors,PetscInt n,ISColoringValue colorarray[],ISColoring *iscoloring)
5368 {
5369   PetscErrorCode ierr;
5370 
5371   PetscFunctionBegin;
5372   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5373   PetscValidType(mat,1);
5374   PetscValidIntPointer(colorarray,4);
5375   PetscValidPointer(iscoloring,5);
5376   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5377 
5378   if (!mat->ops->coloringpatch){
5379     ierr = ISColoringCreate(mat->comm,ncolors,n,colorarray,iscoloring);CHKERRQ(ierr);
5380   } else {
5381     ierr = (*mat->ops->coloringpatch)(mat,ncolors,n,colorarray,iscoloring);CHKERRQ(ierr);
5382   }
5383   PetscFunctionReturn(0);
5384 }
5385 
5386 
5387 #undef __FUNCT__
5388 #define __FUNCT__ "MatSetUnfactored"
5389 /*@
5390    MatSetUnfactored - Resets a factored matrix to be treated as unfactored.
5391 
5392    Collective on Mat
5393 
5394    Input Parameter:
5395 .  mat - the factored matrix to be reset
5396 
5397    Notes:
5398    This routine should be used only with factored matrices formed by in-place
5399    factorization via ILU(0) (or by in-place LU factorization for the MATSEQDENSE
5400    format).  This option can save memory, for example, when solving nonlinear
5401    systems with a matrix-free Newton-Krylov method and a matrix-based, in-place
5402    ILU(0) preconditioner.
5403 
5404    Note that one can specify in-place ILU(0) factorization by calling
5405 .vb
5406      PCType(pc,PCILU);
5407      PCFactorSeUseInPlace(pc);
5408 .ve
5409    or by using the options -pc_type ilu -pc_factor_in_place
5410 
5411    In-place factorization ILU(0) can also be used as a local
5412    solver for the blocks within the block Jacobi or additive Schwarz
5413    methods (runtime option: -sub_pc_factor_in_place).  See the discussion
5414    of these preconditioners in the users manual for details on setting
5415    local solver options.
5416 
5417    Most users should employ the simplified KSP interface for linear solvers
5418    instead of working directly with matrix algebra routines such as this.
5419    See, e.g., KSPCreate().
5420 
5421    Level: developer
5422 
5423 .seealso: PCFactorSetUseInPlace()
5424 
5425    Concepts: matrices^unfactored
5426 
5427 @*/
5428 PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat mat)
5429 {
5430   PetscErrorCode ierr;
5431 
5432   PetscFunctionBegin;
5433   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5434   PetscValidType(mat,1);
5435   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5436   mat->factor = 0;
5437   if (!mat->ops->setunfactored) PetscFunctionReturn(0);
5438   ierr = (*mat->ops->setunfactored)(mat);CHKERRQ(ierr);
5439   PetscFunctionReturn(0);
5440 }
5441 
5442 /*MC
5443     MatGetArrayF90 - Accesses a matrix array from Fortran90.
5444 
5445     Synopsis:
5446     MatGetArrayF90(Mat x,{Scalar, pointer :: xx_v(:)},integer ierr)
5447 
5448     Not collective
5449 
5450     Input Parameter:
5451 .   x - matrix
5452 
5453     Output Parameters:
5454 +   xx_v - the Fortran90 pointer to the array
5455 -   ierr - error code
5456 
5457     Example of Usage:
5458 .vb
5459       PetscScalar, pointer xx_v(:)
5460       ....
5461       call MatGetArrayF90(x,xx_v,ierr)
5462       a = xx_v(3)
5463       call MatRestoreArrayF90(x,xx_v,ierr)
5464 .ve
5465 
5466     Notes:
5467     Not yet supported for all F90 compilers
5468 
5469     Level: advanced
5470 
5471 .seealso:  MatRestoreArrayF90(), MatGetArray(), MatRestoreArray()
5472 
5473     Concepts: matrices^accessing array
5474 
5475 M*/
5476 
5477 /*MC
5478     MatRestoreArrayF90 - Restores a matrix array that has been
5479     accessed with MatGetArrayF90().
5480 
5481     Synopsis:
5482     MatRestoreArrayF90(Mat x,{Scalar, pointer :: xx_v(:)},integer ierr)
5483 
5484     Not collective
5485 
5486     Input Parameters:
5487 +   x - matrix
5488 -   xx_v - the Fortran90 pointer to the array
5489 
5490     Output Parameter:
5491 .   ierr - error code
5492 
5493     Example of Usage:
5494 .vb
5495        PetscScalar, pointer xx_v(:)
5496        ....
5497        call MatGetArrayF90(x,xx_v,ierr)
5498        a = xx_v(3)
5499        call MatRestoreArrayF90(x,xx_v,ierr)
5500 .ve
5501 
5502     Notes:
5503     Not yet supported for all F90 compilers
5504 
5505     Level: advanced
5506 
5507 .seealso:  MatGetArrayF90(), MatGetArray(), MatRestoreArray()
5508 
5509 M*/
5510 
5511 
5512 #undef __FUNCT__
5513 #define __FUNCT__ "MatGetSubMatrix"
5514 /*@
5515     MatGetSubMatrix - Gets a single submatrix on the same number of processors
5516                       as the original matrix.
5517 
5518     Collective on Mat
5519 
5520     Input Parameters:
5521 +   mat - the original matrix
5522 .   isrow - rows this processor should obtain
5523 .   iscol - columns for all processors you wish to keep
5524 .   csize - number of columns "local" to this processor (does nothing for sequential
5525             matrices). This should match the result from VecGetLocalSize(x,...) if you
5526             plan to use the matrix in a A*x; alternatively, you can use PETSC_DECIDE
5527 -   cll - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
5528 
5529     Output Parameter:
5530 .   newmat - the new submatrix, of the same type as the old
5531 
5532     Level: advanced
5533 
5534     Notes: the iscol argument MUST be the same on each processor. You might be
5535     able to create the iscol argument with ISAllGather(). The rows is isrow will be
5536     sorted into the same order as the original matrix.
5537 
5538       The first time this is called you should use a cll of MAT_INITIAL_MATRIX,
5539    the MatGetSubMatrix() routine will create the newmat for you. Any additional calls
5540    to this routine with a mat of the same nonzero structure and with a call of MAT_REUSE_MATRIX
5541    will reuse the matrix generated the first time.  You should call MatDestroy() on newmat when
5542    you are finished using it.
5543 
5544     Concepts: matrices^submatrices
5545 
5546 .seealso: MatGetSubMatrices(), ISAllGather()
5547 @*/
5548 PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat mat,IS isrow,IS iscol,PetscInt csize,MatReuse cll,Mat *newmat)
5549 {
5550   PetscErrorCode ierr;
5551   PetscMPIInt    size;
5552   Mat            *local;
5553 
5554   PetscFunctionBegin;
5555   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5556   PetscValidHeaderSpecific(isrow,IS_COOKIE,2);
5557   PetscValidHeaderSpecific(iscol,IS_COOKIE,3);
5558   PetscValidPointer(newmat,6);
5559   if (cll == MAT_REUSE_MATRIX) PetscValidHeaderSpecific(*newmat,MAT_COOKIE,6);
5560   PetscValidType(mat,1);
5561   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5562   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5563   ierr = MPI_Comm_size(mat->comm,&size);CHKERRQ(ierr);
5564 
5565   /* if original matrix is on just one processor then use submatrix generated */
5566   if (!mat->ops->getsubmatrix && size == 1 && cll == MAT_REUSE_MATRIX) {
5567     ierr = MatGetSubMatrices(mat,1,&isrow,&iscol,MAT_REUSE_MATRIX,&newmat);CHKERRQ(ierr);
5568     PetscFunctionReturn(0);
5569   } else if (!mat->ops->getsubmatrix && size == 1) {
5570     ierr    = MatGetSubMatrices(mat,1,&isrow,&iscol,MAT_INITIAL_MATRIX,&local);CHKERRQ(ierr);
5571     *newmat = *local;
5572     ierr    = PetscFree(local);CHKERRQ(ierr);
5573     PetscFunctionReturn(0);
5574   }
5575 
5576   if (!mat->ops->getsubmatrix) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
5577   ierr = (*mat->ops->getsubmatrix)(mat,isrow,iscol,csize,cll,newmat);CHKERRQ(ierr);
5578   ierr = PetscObjectStateIncrease((PetscObject)*newmat);CHKERRQ(ierr);
5579   PetscFunctionReturn(0);
5580 }
5581 
5582 #undef __FUNCT__
5583 #define __FUNCT__ "MatGetSubMatrixRaw"
5584 /*@
5585     MatGetSubMatrixRaw - Gets a single submatrix on the same number of processors
5586                          as the original matrix.
5587 
5588     Collective on Mat
5589 
5590     Input Parameters:
5591 +   mat - the original matrix
5592 .   nrows - the number of rows this processor should obtain
5593 .   rows - rows this processor should obtain
5594 .   ncols - the number of columns for all processors you wish to keep
5595 .   cols - columns for all processors you wish to keep
5596 .   csize - number of columns "local" to this processor (does nothing for sequential
5597             matrices). This should match the result from VecGetLocalSize(x,...) if you
5598             plan to use the matrix in a A*x; alternatively, you can use PETSC_DECIDE
5599 -   cll - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
5600 
5601     Output Parameter:
5602 .   newmat - the new submatrix, of the same type as the old
5603 
5604     Level: advanced
5605 
5606     Notes: the iscol argument MUST be the same on each processor. You might be
5607     able to create the iscol argument with ISAllGather().
5608 
5609       The first time this is called you should use a cll of MAT_INITIAL_MATRIX,
5610    the MatGetSubMatrix() routine will create the newmat for you. Any additional calls
5611    to this routine with a mat of the same nonzero structure and with a cll of MAT_REUSE_MATRIX
5612    will reuse the matrix generated the first time.
5613 
5614     Concepts: matrices^submatrices
5615 
5616 .seealso: MatGetSubMatrices(), ISAllGather()
5617 @*/
5618 PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrixRaw(Mat mat,PetscInt nrows,const PetscInt rows[],PetscInt ncols,const PetscInt cols[],PetscInt csize,MatReuse cll,Mat *newmat)
5619 {
5620   IS             isrow, iscol;
5621   PetscErrorCode ierr;
5622 
5623   PetscFunctionBegin;
5624   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5625   PetscValidIntPointer(rows,2);
5626   PetscValidIntPointer(cols,3);
5627   PetscValidPointer(newmat,6);
5628   if (cll == MAT_REUSE_MATRIX) PetscValidHeaderSpecific(*newmat,MAT_COOKIE,6);
5629   PetscValidType(mat,1);
5630   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5631   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5632   ierr = ISCreateGeneralWithArray(PETSC_COMM_SELF, nrows, (PetscInt *) rows, &isrow);CHKERRQ(ierr);
5633   ierr = ISCreateGeneralWithArray(PETSC_COMM_SELF, ncols, (PetscInt *) cols, &iscol);CHKERRQ(ierr);
5634   ierr = MatGetSubMatrix(mat, isrow, iscol, csize, cll, newmat);CHKERRQ(ierr);
5635   ierr = ISDestroy(isrow);CHKERRQ(ierr);
5636   ierr = ISDestroy(iscol);CHKERRQ(ierr);
5637   PetscFunctionReturn(0);
5638 }
5639 
5640 #undef __FUNCT__
5641 #define __FUNCT__ "MatStashSetInitialSize"
5642 /*@
5643    MatStashSetInitialSize - sets the sizes of the matrix stash, that is
5644    used during the assembly process to store values that belong to
5645    other processors.
5646 
5647    Not Collective
5648 
5649    Input Parameters:
5650 +  mat   - the matrix
5651 .  size  - the initial size of the stash.
5652 -  bsize - the initial size of the block-stash(if used).
5653 
5654    Options Database Keys:
5655 +   -matstash_initial_size <size> or <size0,size1,...sizep-1>
5656 -   -matstash_block_initial_size <bsize>  or <bsize0,bsize1,...bsizep-1>
5657 
5658    Level: intermediate
5659 
5660    Notes:
5661      The block-stash is used for values set with MatSetValuesBlocked() while
5662      the stash is used for values set with MatSetValues()
5663 
5664      Run with the option -info and look for output of the form
5665      MatAssemblyBegin_MPIXXX:Stash has MM entries, uses nn mallocs.
5666      to determine the appropriate value, MM, to use for size and
5667      MatAssemblyBegin_MPIXXX:Block-Stash has BMM entries, uses nn mallocs.
5668      to determine the value, BMM to use for bsize
5669 
5670    Concepts: stash^setting matrix size
5671    Concepts: matrices^stash
5672 
5673 @*/
5674 PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat mat,PetscInt size, PetscInt bsize)
5675 {
5676   PetscErrorCode ierr;
5677 
5678   PetscFunctionBegin;
5679   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5680   PetscValidType(mat,1);
5681   ierr = MatStashSetInitialSize_Private(&mat->stash,size);CHKERRQ(ierr);
5682   ierr = MatStashSetInitialSize_Private(&mat->bstash,bsize);CHKERRQ(ierr);
5683   PetscFunctionReturn(0);
5684 }
5685 
5686 #undef __FUNCT__
5687 #define __FUNCT__ "MatInterpolateAdd"
5688 /*@
5689    MatInterpolateAdd - w = y + A*x or A'*x depending on the shape of
5690      the matrix
5691 
5692    Collective on Mat
5693 
5694    Input Parameters:
5695 +  mat   - the matrix
5696 .  x,y - the vectors
5697 -  w - where the result is stored
5698 
5699    Level: intermediate
5700 
5701    Notes:
5702     w may be the same vector as y.
5703 
5704     This allows one to use either the restriction or interpolation (its transpose)
5705     matrix to do the interpolation
5706 
5707     Concepts: interpolation
5708 
5709 .seealso: MatMultAdd(), MatMultTransposeAdd(), MatRestrict()
5710 
5711 @*/
5712 PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat A,Vec x,Vec y,Vec w)
5713 {
5714   PetscErrorCode ierr;
5715   PetscInt       M,N;
5716 
5717   PetscFunctionBegin;
5718   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
5719   PetscValidHeaderSpecific(x,VEC_COOKIE,2);
5720   PetscValidHeaderSpecific(y,VEC_COOKIE,3);
5721   PetscValidHeaderSpecific(w,VEC_COOKIE,4);
5722   PetscValidType(A,1);
5723   ierr = MatPreallocated(A);CHKERRQ(ierr);
5724   ierr = MatGetSize(A,&M,&N);CHKERRQ(ierr);
5725   if (N > M) {
5726     ierr = MatMultTransposeAdd(A,x,y,w);CHKERRQ(ierr);
5727   } else {
5728     ierr = MatMultAdd(A,x,y,w);CHKERRQ(ierr);
5729   }
5730   PetscFunctionReturn(0);
5731 }
5732 
5733 #undef __FUNCT__
5734 #define __FUNCT__ "MatInterpolate"
5735 /*@
5736    MatInterpolate - y = A*x or A'*x depending on the shape of
5737      the matrix
5738 
5739    Collective on Mat
5740 
5741    Input Parameters:
5742 +  mat   - the matrix
5743 -  x,y - the vectors
5744 
5745    Level: intermediate
5746 
5747    Notes:
5748     This allows one to use either the restriction or interpolation (its transpose)
5749     matrix to do the interpolation
5750 
5751    Concepts: matrices^interpolation
5752 
5753 .seealso: MatMultAdd(), MatMultTransposeAdd(), MatRestrict()
5754 
5755 @*/
5756 PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat A,Vec x,Vec y)
5757 {
5758   PetscErrorCode ierr;
5759   PetscInt       M,N;
5760 
5761   PetscFunctionBegin;
5762   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
5763   PetscValidHeaderSpecific(x,VEC_COOKIE,2);
5764   PetscValidHeaderSpecific(y,VEC_COOKIE,3);
5765   PetscValidType(A,1);
5766   ierr = MatPreallocated(A);CHKERRQ(ierr);
5767   ierr = MatGetSize(A,&M,&N);CHKERRQ(ierr);
5768   if (N > M) {
5769     ierr = MatMultTranspose(A,x,y);CHKERRQ(ierr);
5770   } else {
5771     ierr = MatMult(A,x,y);CHKERRQ(ierr);
5772   }
5773   PetscFunctionReturn(0);
5774 }
5775 
5776 #undef __FUNCT__
5777 #define __FUNCT__ "MatRestrict"
5778 /*@
5779    MatRestrict - y = A*x or A'*x
5780 
5781    Collective on Mat
5782 
5783    Input Parameters:
5784 +  mat   - the matrix
5785 -  x,y - the vectors
5786 
5787    Level: intermediate
5788 
5789    Notes:
5790     This allows one to use either the restriction or interpolation (its transpose)
5791     matrix to do the restriction
5792 
5793    Concepts: matrices^restriction
5794 
5795 .seealso: MatMultAdd(), MatMultTransposeAdd(), MatInterpolate()
5796 
5797 @*/
5798 PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat A,Vec x,Vec y)
5799 {
5800   PetscErrorCode ierr;
5801   PetscInt       M,N;
5802 
5803   PetscFunctionBegin;
5804   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
5805   PetscValidHeaderSpecific(x,VEC_COOKIE,2);
5806   PetscValidHeaderSpecific(y,VEC_COOKIE,3);
5807   PetscValidType(A,1);
5808   ierr = MatPreallocated(A);CHKERRQ(ierr);
5809 
5810   ierr = MatGetSize(A,&M,&N);CHKERRQ(ierr);
5811   if (N > M) {
5812     ierr = MatMult(A,x,y);CHKERRQ(ierr);
5813   } else {
5814     ierr = MatMultTranspose(A,x,y);CHKERRQ(ierr);
5815   }
5816   PetscFunctionReturn(0);
5817 }
5818 
5819 #undef __FUNCT__
5820 #define __FUNCT__ "MatNullSpaceAttach"
5821 /*@C
5822    MatNullSpaceAttach - attaches a null space to a matrix.
5823         This null space will be removed from the resulting vector whenever
5824         MatMult() is called
5825 
5826    Collective on Mat
5827 
5828    Input Parameters:
5829 +  mat - the matrix
5830 -  nullsp - the null space object
5831 
5832    Level: developer
5833 
5834    Notes:
5835       Overwrites any previous null space that may have been attached
5836 
5837    Concepts: null space^attaching to matrix
5838 
5839 .seealso: MatCreate(), MatNullSpaceCreate()
5840 @*/
5841 PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat mat,MatNullSpace nullsp)
5842 {
5843   PetscErrorCode ierr;
5844 
5845   PetscFunctionBegin;
5846   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5847   PetscValidType(mat,1);
5848   PetscValidHeaderSpecific(nullsp,MAT_NULLSPACE_COOKIE,2);
5849   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5850   ierr = PetscObjectReference((PetscObject)nullsp);CHKERRQ(ierr);
5851   if (mat->nullsp) { ierr = MatNullSpaceDestroy(mat->nullsp);CHKERRQ(ierr); }
5852   mat->nullsp = nullsp;
5853   PetscFunctionReturn(0);
5854 }
5855 
5856 #undef __FUNCT__
5857 #define __FUNCT__ "MatICCFactor"
5858 /*@
5859    MatICCFactor - Performs in-place incomplete Cholesky factorization of matrix.
5860 
5861    Collective on Mat
5862 
5863    Input Parameters:
5864 +  mat - the matrix
5865 .  row - row/column permutation
5866 .  fill - expected fill factor >= 1.0
5867 -  level - level of fill, for ICC(k)
5868 
5869    Notes:
5870    Probably really in-place only when level of fill is zero, otherwise allocates
5871    new space to store factored matrix and deletes previous memory.
5872 
5873    Most users should employ the simplified KSP interface for linear solvers
5874    instead of working directly with matrix algebra routines such as this.
5875    See, e.g., KSPCreate().
5876 
5877    Level: developer
5878 
5879    Concepts: matrices^incomplete Cholesky factorization
5880    Concepts: Cholesky factorization
5881 
5882 .seealso: MatICCFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor()
5883 @*/
5884 PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat mat,IS row,MatFactorInfo* info)
5885 {
5886   PetscErrorCode ierr;
5887 
5888   PetscFunctionBegin;
5889   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5890   PetscValidType(mat,1);
5891   if (row) PetscValidHeaderSpecific(row,IS_COOKIE,2);
5892   PetscValidPointer(info,3);
5893   if (mat->rmap.N != mat->cmap.N) SETERRQ(PETSC_ERR_ARG_WRONG,"matrix must be square");
5894   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5895   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5896   if (!mat->ops->iccfactor) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
5897   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5898   ierr = (*mat->ops->iccfactor)(mat,row,info);CHKERRQ(ierr);
5899   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
5900   PetscFunctionReturn(0);
5901 }
5902 
5903 #undef __FUNCT__
5904 #define __FUNCT__ "MatSetValuesAdic"
5905 /*@
5906    MatSetValuesAdic - Sets values computed with ADIC automatic differentiation into a matrix.
5907 
5908    Not Collective
5909 
5910    Input Parameters:
5911 +  mat - the matrix
5912 -  v - the values compute with ADIC
5913 
5914    Level: developer
5915 
5916    Notes:
5917      Must call MatSetColoring() before using this routine. Also this matrix must already
5918      have its nonzero pattern determined.
5919 
5920 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
5921           MatSetValues(), MatSetColoring(), MatSetValuesAdifor()
5922 @*/
5923 PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat mat,void *v)
5924 {
5925   PetscErrorCode ierr;
5926 
5927   PetscFunctionBegin;
5928   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5929   PetscValidType(mat,1);
5930   PetscValidPointer(mat,2);
5931 
5932   if (!mat->assembled) {
5933     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Matrix must be already assembled");
5934   }
5935   ierr = PetscLogEventBegin(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
5936   if (!mat->ops->setvaluesadic) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
5937   ierr = (*mat->ops->setvaluesadic)(mat,v);CHKERRQ(ierr);
5938   ierr = PetscLogEventEnd(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
5939   ierr = MatView_Private(mat);CHKERRQ(ierr);
5940   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
5941   PetscFunctionReturn(0);
5942 }
5943 
5944 
5945 #undef __FUNCT__
5946 #define __FUNCT__ "MatSetColoring"
5947 /*@
5948    MatSetColoring - Sets a coloring used by calls to MatSetValuesAdic()
5949 
5950    Not Collective
5951 
5952    Input Parameters:
5953 +  mat - the matrix
5954 -  coloring - the coloring
5955 
5956    Level: developer
5957 
5958 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
5959           MatSetValues(), MatSetValuesAdic()
5960 @*/
5961 PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat mat,ISColoring coloring)
5962 {
5963   PetscErrorCode ierr;
5964 
5965   PetscFunctionBegin;
5966   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5967   PetscValidType(mat,1);
5968   PetscValidPointer(coloring,2);
5969 
5970   if (!mat->assembled) {
5971     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Matrix must be already assembled");
5972   }
5973   if (!mat->ops->setcoloring) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
5974   ierr = (*mat->ops->setcoloring)(mat,coloring);CHKERRQ(ierr);
5975   PetscFunctionReturn(0);
5976 }
5977 
5978 #undef __FUNCT__
5979 #define __FUNCT__ "MatSetValuesAdifor"
5980 /*@
5981    MatSetValuesAdifor - Sets values computed with automatic differentiation into a matrix.
5982 
5983    Not Collective
5984 
5985    Input Parameters:
5986 +  mat - the matrix
5987 .  nl - leading dimension of v
5988 -  v - the values compute with ADIFOR
5989 
5990    Level: developer
5991 
5992    Notes:
5993      Must call MatSetColoring() before using this routine. Also this matrix must already
5994      have its nonzero pattern determined.
5995 
5996 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
5997           MatSetValues(), MatSetColoring()
5998 @*/
5999 PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat mat,PetscInt nl,void *v)
6000 {
6001   PetscErrorCode ierr;
6002 
6003   PetscFunctionBegin;
6004   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
6005   PetscValidType(mat,1);
6006   PetscValidPointer(v,3);
6007 
6008   if (!mat->assembled) {
6009     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Matrix must be already assembled");
6010   }
6011   ierr = PetscLogEventBegin(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
6012   if (!mat->ops->setvaluesadifor) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
6013   ierr = (*mat->ops->setvaluesadifor)(mat,nl,v);CHKERRQ(ierr);
6014   ierr = PetscLogEventEnd(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
6015   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
6016   PetscFunctionReturn(0);
6017 }
6018 
6019 #undef __FUNCT__
6020 #define __FUNCT__ "MatDiagonalScaleLocal"
6021 /*@
6022    MatDiagonalScaleLocal - Scales columns of a matrix given the scaling values including the
6023          ghosted ones.
6024 
6025    Not Collective
6026 
6027    Input Parameters:
6028 +  mat - the matrix
6029 -  diag = the diagonal values, including ghost ones
6030 
6031    Level: developer
6032 
6033    Notes: Works only for MPIAIJ and MPIBAIJ matrices
6034 
6035 .seealso: MatDiagonalScale()
6036 @*/
6037 PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat mat,Vec diag)
6038 {
6039   PetscErrorCode ierr;
6040   PetscMPIInt    size;
6041 
6042   PetscFunctionBegin;
6043   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
6044   PetscValidHeaderSpecific(diag,VEC_COOKIE,2);
6045   PetscValidType(mat,1);
6046 
6047   if (!mat->assembled) {
6048     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Matrix must be already assembled");
6049   }
6050   ierr = PetscLogEventBegin(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
6051   ierr = MPI_Comm_size(mat->comm,&size);CHKERRQ(ierr);
6052   if (size == 1) {
6053     PetscInt n,m;
6054     ierr = VecGetSize(diag,&n);CHKERRQ(ierr);
6055     ierr = MatGetSize(mat,0,&m);CHKERRQ(ierr);
6056     if (m == n) {
6057       ierr = MatDiagonalScale(mat,0,diag);CHKERRQ(ierr);
6058     } else {
6059       SETERRQ(PETSC_ERR_SUP,"Only supported for sequential matrices when no ghost points/periodic conditions");
6060     }
6061   } else {
6062     PetscErrorCode (*f)(Mat,Vec);
6063     ierr = PetscObjectQueryFunction((PetscObject)mat,"MatDiagonalScaleLocal_C",(void (**)(void))&f);CHKERRQ(ierr);
6064     if (f) {
6065       ierr = (*f)(mat,diag);CHKERRQ(ierr);
6066     } else {
6067       SETERRQ(PETSC_ERR_SUP,"Only supported for MPIAIJ and MPIBAIJ parallel matrices");
6068     }
6069   }
6070   ierr = PetscLogEventEnd(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
6071   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
6072   PetscFunctionReturn(0);
6073 }
6074 
6075 #undef __FUNCT__
6076 #define __FUNCT__ "MatGetInertia"
6077 /*@
6078    MatGetInertia - Gets the inertia from a factored matrix
6079 
6080    Collective on Mat
6081 
6082    Input Parameter:
6083 .  mat - the matrix
6084 
6085    Output Parameters:
6086 +   nneg - number of negative eigenvalues
6087 .   nzero - number of zero eigenvalues
6088 -   npos - number of positive eigenvalues
6089 
6090    Level: advanced
6091 
6092    Notes: Matrix must have been factored by MatCholeskyFactor()
6093 
6094 
6095 @*/
6096 PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat mat,PetscInt *nneg,PetscInt *nzero,PetscInt *npos)
6097 {
6098   PetscErrorCode ierr;
6099 
6100   PetscFunctionBegin;
6101   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
6102   PetscValidType(mat,1);
6103   if (!mat->factor)    SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
6104   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Numeric factor mat is not assembled");
6105   if (!mat->ops->getinertia) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
6106   ierr = (*mat->ops->getinertia)(mat,nneg,nzero,npos);CHKERRQ(ierr);
6107   PetscFunctionReturn(0);
6108 }
6109 
6110 /* ----------------------------------------------------------------*/
6111 #undef __FUNCT__
6112 #define __FUNCT__ "MatSolves"
6113 /*@
6114    MatSolves - Solves A x = b, given a factored matrix, for a collection of vectors
6115 
6116    Collective on Mat and Vecs
6117 
6118    Input Parameters:
6119 +  mat - the factored matrix
6120 -  b - the right-hand-side vectors
6121 
6122    Output Parameter:
6123 .  x - the result vectors
6124 
6125    Notes:
6126    The vectors b and x cannot be the same.  I.e., one cannot
6127    call MatSolves(A,x,x).
6128 
6129    Notes:
6130    Most users should employ the simplified KSP interface for linear solvers
6131    instead of working directly with matrix algebra routines such as this.
6132    See, e.g., KSPCreate().
6133 
6134    Level: developer
6135 
6136    Concepts: matrices^triangular solves
6137 
6138 .seealso: MatSolveAdd(), MatSolveTranspose(), MatSolveTransposeAdd(), MatSolve()
6139 @*/
6140 PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat mat,Vecs b,Vecs x)
6141 {
6142   PetscErrorCode ierr;
6143 
6144   PetscFunctionBegin;
6145   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
6146   PetscValidType(mat,1);
6147   if (x == b) SETERRQ(PETSC_ERR_ARG_IDN,"x and b must be different vectors");
6148   if (!mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
6149   if (!mat->rmap.N && !mat->cmap.N) PetscFunctionReturn(0);
6150 
6151   if (!mat->ops->solves) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
6152   ierr = MatPreallocated(mat);CHKERRQ(ierr);
6153   ierr = PetscLogEventBegin(MAT_Solves,mat,0,0,0);CHKERRQ(ierr);
6154   ierr = (*mat->ops->solves)(mat,b,x);CHKERRQ(ierr);
6155   ierr = PetscLogEventEnd(MAT_Solves,mat,0,0,0);CHKERRQ(ierr);
6156   PetscFunctionReturn(0);
6157 }
6158 
6159 #undef __FUNCT__
6160 #define __FUNCT__ "MatIsSymmetric"
6161 /*@
6162    MatIsSymmetric - Test whether a matrix is symmetric
6163 
6164    Collective on Mat
6165 
6166    Input Parameter:
6167 +  A - the matrix to test
6168 -  tol - difference between value and its transpose less than this amount counts as equal (use 0.0 for exact transpose)
6169 
6170    Output Parameters:
6171 .  flg - the result
6172 
6173    Level: intermediate
6174 
6175    Concepts: matrix^symmetry
6176 
6177 .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetricKnown()
6178 @*/
6179 PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat A,PetscReal tol,PetscTruth *flg)
6180 {
6181   PetscErrorCode ierr;
6182 
6183   PetscFunctionBegin;
6184   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6185   PetscValidPointer(flg,2);
6186   if (!A->symmetric_set) {
6187     if (!A->ops->issymmetric) {
6188       MatType mattype;
6189       ierr = MatGetType(A,&mattype);CHKERRQ(ierr);
6190       SETERRQ1(PETSC_ERR_SUP,"Matrix of type <%s> does not support checking for symmetric",mattype);
6191     }
6192     ierr = (*A->ops->issymmetric)(A,tol,&A->symmetric);CHKERRQ(ierr);
6193     A->symmetric_set = PETSC_TRUE;
6194     if (A->symmetric) {
6195       A->structurally_symmetric_set = PETSC_TRUE;
6196       A->structurally_symmetric     = PETSC_TRUE;
6197     }
6198   }
6199   *flg = A->symmetric;
6200   PetscFunctionReturn(0);
6201 }
6202 
6203 #undef __FUNCT__
6204 #define __FUNCT__ "MatIsSymmetricKnown"
6205 /*@
6206    MatIsSymmetricKnown - Checks the flag on the matrix to see if it is symmetric.
6207 
6208    Collective on Mat
6209 
6210    Input Parameter:
6211 .  A - the matrix to check
6212 
6213    Output Parameters:
6214 +  set - if the symmetric flag is set (this tells you if the next flag is valid)
6215 -  flg - the result
6216 
6217    Level: advanced
6218 
6219    Concepts: matrix^symmetry
6220 
6221    Note: Does not check the matrix values directly, so this may return unknown (set = PETSC_FALSE). Use MatIsSymmetric()
6222          if you want it explicitly checked
6223 
6224 .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetric()
6225 @*/
6226 PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat A,PetscTruth *set,PetscTruth *flg)
6227 {
6228   PetscFunctionBegin;
6229   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6230   PetscValidPointer(set,2);
6231   PetscValidPointer(flg,3);
6232   if (A->symmetric_set) {
6233     *set = PETSC_TRUE;
6234     *flg = A->symmetric;
6235   } else {
6236     *set = PETSC_FALSE;
6237   }
6238   PetscFunctionReturn(0);
6239 }
6240 
6241 #undef __FUNCT__
6242 #define __FUNCT__ "MatIsHermitianKnown"
6243 /*@
6244    MatIsHermitianKnown - Checks the flag on the matrix to see if it is hermitian.
6245 
6246    Collective on Mat
6247 
6248    Input Parameter:
6249 .  A - the matrix to check
6250 
6251    Output Parameters:
6252 +  set - if the hermitian flag is set (this tells you if the next flag is valid)
6253 -  flg - the result
6254 
6255    Level: advanced
6256 
6257    Concepts: matrix^symmetry
6258 
6259    Note: Does not check the matrix values directly, so this may return unknown (set = PETSC_FALSE). Use MatIsHermitian()
6260          if you want it explicitly checked
6261 
6262 .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetric()
6263 @*/
6264 PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat A,PetscTruth *set,PetscTruth *flg)
6265 {
6266   PetscFunctionBegin;
6267   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6268   PetscValidPointer(set,2);
6269   PetscValidPointer(flg,3);
6270   if (A->hermitian_set) {
6271     *set = PETSC_TRUE;
6272     *flg = A->hermitian;
6273   } else {
6274     *set = PETSC_FALSE;
6275   }
6276   PetscFunctionReturn(0);
6277 }
6278 
6279 #undef __FUNCT__
6280 #define __FUNCT__ "MatIsStructurallySymmetric"
6281 /*@
6282    MatIsStructurallySymmetric - Test whether a matrix is structurally symmetric
6283 
6284    Collective on Mat
6285 
6286    Input Parameter:
6287 .  A - the matrix to test
6288 
6289    Output Parameters:
6290 .  flg - the result
6291 
6292    Level: intermediate
6293 
6294    Concepts: matrix^symmetry
6295 
6296 .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsSymmetric(), MatSetOption()
6297 @*/
6298 PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat A,PetscTruth *flg)
6299 {
6300   PetscErrorCode ierr;
6301 
6302   PetscFunctionBegin;
6303   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6304   PetscValidPointer(flg,2);
6305   if (!A->structurally_symmetric_set) {
6306     if (!A->ops->isstructurallysymmetric) SETERRQ(PETSC_ERR_SUP,"Matrix does not support checking for structural symmetric");
6307     ierr = (*A->ops->isstructurallysymmetric)(A,&A->structurally_symmetric);CHKERRQ(ierr);
6308     A->structurally_symmetric_set = PETSC_TRUE;
6309   }
6310   *flg = A->structurally_symmetric;
6311   PetscFunctionReturn(0);
6312 }
6313 
6314 #undef __FUNCT__
6315 #define __FUNCT__ "MatIsHermitian"
6316 /*@
6317    MatIsHermitian - Test whether a matrix is Hermitian, i.e. it is the complex conjugate of its transpose.
6318 
6319    Collective on Mat
6320 
6321    Input Parameter:
6322 .  A - the matrix to test
6323 
6324    Output Parameters:
6325 .  flg - the result
6326 
6327    Level: intermediate
6328 
6329    Concepts: matrix^symmetry
6330 
6331 .seealso: MatTranspose(), MatIsTranspose(), MatIsSymmetric(), MatIsStructurallySymmetric(), MatSetOption()
6332 @*/
6333 PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat A,PetscTruth *flg)
6334 {
6335   PetscErrorCode ierr;
6336 
6337   PetscFunctionBegin;
6338   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6339   PetscValidPointer(flg,2);
6340   if (!A->hermitian_set) {
6341     if (!A->ops->ishermitian) SETERRQ(PETSC_ERR_SUP,"Matrix does not support checking for being Hermitian");
6342     ierr = (*A->ops->ishermitian)(A,&A->hermitian);CHKERRQ(ierr);
6343     A->hermitian_set = PETSC_TRUE;
6344     if (A->hermitian) {
6345       A->structurally_symmetric_set = PETSC_TRUE;
6346       A->structurally_symmetric     = PETSC_TRUE;
6347     }
6348   }
6349   *flg = A->hermitian;
6350   PetscFunctionReturn(0);
6351 }
6352 
6353 #undef __FUNCT__
6354 #define __FUNCT__ "MatStashGetInfo"
6355 extern PetscErrorCode MatStashGetInfo_Private(MatStash*,PetscInt*,PetscInt*);
6356 /*@
6357    MatStashGetInfo - Gets how many values are currently in the vector stash, i.e. need
6358        to be communicated to other processors during the MatAssemblyBegin/End() process
6359 
6360     Not collective
6361 
6362    Input Parameter:
6363 .   vec - the vector
6364 
6365    Output Parameters:
6366 +   nstash   - the size of the stash
6367 .   reallocs - the number of additional mallocs incurred.
6368 .   bnstash   - the size of the block stash
6369 -   breallocs - the number of additional mallocs incurred.in the block stash
6370 
6371    Level: advanced
6372 
6373 .seealso: MatAssemblyBegin(), MatAssemblyEnd(), Mat, MatStashSetInitialSize()
6374 
6375 @*/
6376 PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat mat,PetscInt *nstash,PetscInt *reallocs,PetscInt *bnstash,PetscInt *breallocs)
6377 {
6378   PetscErrorCode ierr;
6379   PetscFunctionBegin;
6380   ierr = MatStashGetInfo_Private(&mat->stash,nstash,reallocs);CHKERRQ(ierr);
6381   ierr = MatStashGetInfo_Private(&mat->bstash,bnstash,breallocs);CHKERRQ(ierr);
6382   PetscFunctionReturn(0);
6383 }
6384 
6385 #undef __FUNCT__
6386 #define __FUNCT__ "MatGetVecs"
6387 /*@
6388    MatGetVecs - Get vector(s) compatible with the matrix, i.e. with the same
6389      parallel layout
6390 
6391    Collective on Mat
6392 
6393    Input Parameter:
6394 .  mat - the matrix
6395 
6396    Output Parameter:
6397 +   right - (optional) vector that the matrix can be multiplied against
6398 -   left - (optional) vector that the matrix vector product can be stored in
6399 
6400   Level: advanced
6401 
6402 .seealso: MatCreate()
6403 @*/
6404 PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat mat,Vec *right,Vec *left)
6405 {
6406   PetscErrorCode ierr;
6407 
6408   PetscFunctionBegin;
6409   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
6410   PetscValidType(mat,1);
6411   ierr = MatPreallocated(mat);CHKERRQ(ierr);
6412   if (mat->ops->getvecs) {
6413     ierr = (*mat->ops->getvecs)(mat,right,left);CHKERRQ(ierr);
6414   } else {
6415     PetscMPIInt size;
6416     ierr = MPI_Comm_size(mat->comm, &size);CHKERRQ(ierr);
6417     if (right) {
6418       ierr = VecCreate(mat->comm,right);CHKERRQ(ierr);
6419       ierr = VecSetSizes(*right,mat->cmap.n,PETSC_DETERMINE);CHKERRQ(ierr);
6420       if (size > 1) {ierr = VecSetType(*right,VECMPI);CHKERRQ(ierr);}
6421       else {ierr = VecSetType(*right,VECSEQ);CHKERRQ(ierr);}
6422     }
6423     if (left) {
6424       ierr = VecCreate(mat->comm,left);CHKERRQ(ierr);
6425       ierr = VecSetSizes(*left,mat->rmap.n,PETSC_DETERMINE);CHKERRQ(ierr);
6426       if (size > 1) {ierr = VecSetType(*left,VECMPI);CHKERRQ(ierr);}
6427       else {ierr = VecSetType(*left,VECSEQ);CHKERRQ(ierr);}
6428     }
6429   }
6430   if (right) {ierr = VecSetBlockSize(*right,mat->rmap.bs);CHKERRQ(ierr);}
6431   if (left) {ierr = VecSetBlockSize(*left,mat->rmap.bs);CHKERRQ(ierr);}
6432   PetscFunctionReturn(0);
6433 }
6434 
6435 #undef __FUNCT__
6436 #define __FUNCT__ "MatFactorInfoInitialize"
6437 /*@
6438    MatFactorInfoInitialize - Initializes a MatFactorInfo data structure
6439      with default values.
6440 
6441    Not Collective
6442 
6443    Input Parameters:
6444 .    info - the MatFactorInfo data structure
6445 
6446 
6447    Notes: The solvers are generally used through the KSP and PC objects, for example
6448           PCLU, PCILU, PCCHOLESKY, PCICC
6449 
6450    Level: developer
6451 
6452 .seealso: MatFactorInfo
6453 @*/
6454 
6455 PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo *info)
6456 {
6457   PetscErrorCode ierr;
6458 
6459   PetscFunctionBegin;
6460   ierr = PetscMemzero(info,sizeof(MatFactorInfo));CHKERRQ(ierr);
6461   PetscFunctionReturn(0);
6462 }
6463 
6464 #undef __FUNCT__
6465 #define __FUNCT__ "MatPtAP"
6466 /*@
6467    MatPtAP - Creates the matrix projection C = P^T * A * P
6468 
6469    Collective on Mat
6470 
6471    Input Parameters:
6472 +  A - the matrix
6473 .  P - the projection matrix
6474 .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
6475 -  fill - expected fill as ratio of nnz(C)/nnz(A)
6476 
6477    Output Parameters:
6478 .  C - the product matrix
6479 
6480    Notes:
6481    C will be created and must be destroyed by the user with MatDestroy().
6482 
6483    This routine is currently only implemented for pairs of AIJ matrices and classes
6484    which inherit from AIJ.
6485 
6486    Level: intermediate
6487 
6488 .seealso: MatPtAPSymbolic(), MatPtAPNumeric(), MatMatMult()
6489 @*/
6490 PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat A,Mat P,MatReuse scall,PetscReal fill,Mat *C)
6491 {
6492   PetscErrorCode ierr;
6493 
6494   PetscFunctionBegin;
6495   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6496   PetscValidType(A,1);
6497   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6498   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6499   PetscValidHeaderSpecific(P,MAT_COOKIE,2);
6500   PetscValidType(P,2);
6501   MatPreallocated(P);
6502   if (!P->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6503   if (P->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6504   PetscValidPointer(C,3);
6505   if (P->rmap.N!=A->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->rmap.N,A->cmap.N);
6506   if (fill < 1.0) SETERRQ1(PETSC_ERR_ARG_SIZ,"Expected fill=%G must be >= 1.0",fill);
6507   ierr = MatPreallocated(A);CHKERRQ(ierr);
6508 
6509   ierr = PetscLogEventBegin(MAT_PtAP,A,P,0,0);CHKERRQ(ierr);
6510   ierr = (*A->ops->ptap)(A,P,scall,fill,C);CHKERRQ(ierr);
6511   ierr = PetscLogEventEnd(MAT_PtAP,A,P,0,0);CHKERRQ(ierr);
6512 
6513   PetscFunctionReturn(0);
6514 }
6515 
6516 #undef __FUNCT__
6517 #define __FUNCT__ "MatPtAPNumeric"
6518 /*@
6519    MatPtAPNumeric - Computes the matrix projection C = P^T * A * P
6520 
6521    Collective on Mat
6522 
6523    Input Parameters:
6524 +  A - the matrix
6525 -  P - the projection matrix
6526 
6527    Output Parameters:
6528 .  C - the product matrix
6529 
6530    Notes:
6531    C must have been created by calling MatPtAPSymbolic and must be destroyed by
6532    the user using MatDeatroy().
6533 
6534    This routine is currently only implemented for pairs of AIJ matrices and classes
6535    which inherit from AIJ.  C will be of type MATAIJ.
6536 
6537    Level: intermediate
6538 
6539 .seealso: MatPtAP(), MatPtAPSymbolic(), MatMatMultNumeric()
6540 @*/
6541 PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat A,Mat P,Mat C)
6542 {
6543   PetscErrorCode ierr;
6544 
6545   PetscFunctionBegin;
6546   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6547   PetscValidType(A,1);
6548   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6549   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6550   PetscValidHeaderSpecific(P,MAT_COOKIE,2);
6551   PetscValidType(P,2);
6552   MatPreallocated(P);
6553   if (!P->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6554   if (P->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6555   PetscValidHeaderSpecific(C,MAT_COOKIE,3);
6556   PetscValidType(C,3);
6557   MatPreallocated(C);
6558   if (C->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6559   if (P->cmap.N!=C->rmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->cmap.N,C->rmap.N);
6560   if (P->rmap.N!=A->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->rmap.N,A->cmap.N);
6561   if (A->rmap.N!=A->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix 'A' must be square, %D != %D",A->rmap.N,A->cmap.N);
6562   if (P->cmap.N!=C->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->cmap.N,C->cmap.N);
6563   ierr = MatPreallocated(A);CHKERRQ(ierr);
6564 
6565   ierr = PetscLogEventBegin(MAT_PtAPNumeric,A,P,0,0);CHKERRQ(ierr);
6566   ierr = (*A->ops->ptapnumeric)(A,P,C);CHKERRQ(ierr);
6567   ierr = PetscLogEventEnd(MAT_PtAPNumeric,A,P,0,0);CHKERRQ(ierr);
6568   PetscFunctionReturn(0);
6569 }
6570 
6571 #undef __FUNCT__
6572 #define __FUNCT__ "MatPtAPSymbolic"
6573 /*@
6574    MatPtAPSymbolic - Creates the (i,j) structure of the matrix projection C = P^T * A * P
6575 
6576    Collective on Mat
6577 
6578    Input Parameters:
6579 +  A - the matrix
6580 -  P - the projection matrix
6581 
6582    Output Parameters:
6583 .  C - the (i,j) structure of the product matrix
6584 
6585    Notes:
6586    C will be created and must be destroyed by the user with MatDestroy().
6587 
6588    This routine is currently only implemented for pairs of SeqAIJ matrices and classes
6589    which inherit from SeqAIJ.  C will be of type MATSEQAIJ.  The product is computed using
6590    this (i,j) structure by calling MatPtAPNumeric().
6591 
6592    Level: intermediate
6593 
6594 .seealso: MatPtAP(), MatPtAPNumeric(), MatMatMultSymbolic()
6595 @*/
6596 PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat A,Mat P,PetscReal fill,Mat *C)
6597 {
6598   PetscErrorCode ierr;
6599 
6600   PetscFunctionBegin;
6601   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6602   PetscValidType(A,1);
6603   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6604   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6605   if (fill <1.0) SETERRQ1(PETSC_ERR_ARG_SIZ,"Expected fill=%G must be >= 1.0",fill);
6606   PetscValidHeaderSpecific(P,MAT_COOKIE,2);
6607   PetscValidType(P,2);
6608   MatPreallocated(P);
6609   if (!P->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6610   if (P->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6611   PetscValidPointer(C,3);
6612 
6613   if (P->rmap.N!=A->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->rmap.N,A->cmap.N);
6614   if (A->rmap.N!=A->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix 'A' must be square, %D != %D",A->rmap.N,A->cmap.N);
6615   ierr = MatPreallocated(A);CHKERRQ(ierr);
6616   ierr = PetscLogEventBegin(MAT_PtAPSymbolic,A,P,0,0);CHKERRQ(ierr);
6617   ierr = (*A->ops->ptapsymbolic)(A,P,fill,C);CHKERRQ(ierr);
6618   ierr = PetscLogEventEnd(MAT_PtAPSymbolic,A,P,0,0);CHKERRQ(ierr);
6619 
6620   ierr = MatSetBlockSize(*C,A->rmap.bs);CHKERRQ(ierr);
6621 
6622   PetscFunctionReturn(0);
6623 }
6624 
6625 #undef __FUNCT__
6626 #define __FUNCT__ "MatMatMult"
6627 /*@
6628    MatMatMult - Performs Matrix-Matrix Multiplication C=A*B.
6629 
6630    Collective on Mat
6631 
6632    Input Parameters:
6633 +  A - the left matrix
6634 .  B - the right matrix
6635 .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
6636 -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(B))
6637 
6638    Output Parameters:
6639 .  C - the product matrix
6640 
6641    Notes:
6642    C will be created and must be destroyed by the user with MatDestroy().
6643    Unless scall is MAT_REUSE_MATRIX
6644 
6645    If you have many matrices with the same non-zero structure to multiply, you
6646    should either
6647 $   1) use MAT_REUSE_MATRIX in all calls but the first or
6648 $   2) call MatMatMultSymbolic() once and then MatMatMultNumeric() for each product needed
6649 
6650    Level: intermediate
6651 
6652 .seealso: MatMatMultSymbolic(), MatMatMultNumeric(), MatPtAP()
6653 @*/
6654 PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat A,Mat B,MatReuse scall,PetscReal fill,Mat *C)
6655 {
6656   PetscErrorCode ierr;
6657   PetscErrorCode (*fA)(Mat,Mat,MatReuse,PetscReal,Mat*);
6658   PetscErrorCode (*fB)(Mat,Mat,MatReuse,PetscReal,Mat*);
6659   PetscErrorCode (*mult)(Mat,Mat,MatReuse,PetscReal,Mat *)=PETSC_NULL;
6660 
6661   PetscFunctionBegin;
6662   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6663   PetscValidType(A,1);
6664   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6665   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6666   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
6667   PetscValidType(B,2);
6668   MatPreallocated(B);
6669   if (!B->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6670   if (B->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6671   PetscValidPointer(C,3);
6672   if (B->rmap.N!=A->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",B->rmap.N,A->cmap.N);
6673   if (fill == PETSC_DEFAULT) fill = 2.0;
6674   if (fill < 1.0) SETERRQ1(PETSC_ERR_ARG_SIZ,"Expected fill=%G must be >= 1.0",fill);
6675   ierr = MatPreallocated(A);CHKERRQ(ierr);
6676 
6677   fA = A->ops->matmult;
6678   fB = B->ops->matmult;
6679   if (fB == fA) {
6680     if (!fB) SETERRQ1(PETSC_ERR_SUP,"MatMatMult not supported for B of type %s",B->type_name);
6681     mult = fB;
6682   } else {
6683     /* dispatch based on the type of A and B */
6684     char  multname[256];
6685     ierr = PetscStrcpy(multname,"MatMatMult_");CHKERRQ(ierr);
6686     ierr = PetscStrcat(multname,A->type_name);CHKERRQ(ierr);
6687     ierr = PetscStrcat(multname,"_");CHKERRQ(ierr);
6688     ierr = PetscStrcat(multname,B->type_name);CHKERRQ(ierr);
6689     ierr = PetscStrcat(multname,"_C");CHKERRQ(ierr); /* e.g., multname = "MatMatMult_aij_dense_C" */
6690     ierr = PetscObjectQueryFunction((PetscObject)B,multname,(void (**)(void))&mult);CHKERRQ(ierr);
6691     if (!mult) SETERRQ2(PETSC_ERR_ARG_INCOMP,"MatMatMult requires A, %s, to be compatible with B, %s",A->type_name,B->type_name);
6692   }
6693   ierr = PetscLogEventBegin(MAT_MatMult,A,B,0,0);CHKERRQ(ierr);
6694   ierr = (*mult)(A,B,scall,fill,C);CHKERRQ(ierr);
6695   ierr = PetscLogEventEnd(MAT_MatMult,A,B,0,0);CHKERRQ(ierr);
6696   PetscFunctionReturn(0);
6697 }
6698 
6699 #undef __FUNCT__
6700 #define __FUNCT__ "MatMatMultSymbolic"
6701 /*@
6702    MatMatMultSymbolic - Performs construction, preallocation, and computes the ij structure
6703    of the matrix-matrix product C=A*B.  Call this routine before calling MatMatMultNumeric().
6704 
6705    Collective on Mat
6706 
6707    Input Parameters:
6708 +  A - the left matrix
6709 .  B - the right matrix
6710 -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(B))
6711 
6712    Output Parameters:
6713 .  C - the matrix containing the ij structure of product matrix
6714 
6715    Notes:
6716    C will be created and must be destroyed by the user with MatDestroy().
6717 
6718    This routine is currently implemented for
6719     - pairs of AIJ matrices and classes which inherit from AIJ, C will be of type MATAIJ.
6720     - pairs of AIJ (A) and Dense (B) matrix, C will be of type MATDENSE.
6721 
6722    Level: intermediate
6723 
6724 .seealso: MatMatMult(), MatMatMultNumeric()
6725 @*/
6726 PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat A,Mat B,PetscReal fill,Mat *C)
6727 {
6728   PetscErrorCode ierr;
6729   PetscErrorCode (*Asymbolic)(Mat,Mat,PetscReal,Mat *);
6730   PetscErrorCode (*Bsymbolic)(Mat,Mat,PetscReal,Mat *);
6731   PetscErrorCode (*symbolic)(Mat,Mat,PetscReal,Mat *)=PETSC_NULL;
6732 
6733   PetscFunctionBegin;
6734   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6735   PetscValidType(A,1);
6736   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6737   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6738 
6739   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
6740   PetscValidType(B,2);
6741   MatPreallocated(B);
6742   if (!B->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6743   if (B->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6744   PetscValidPointer(C,3);
6745 
6746   if (B->rmap.N!=A->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",B->rmap.N,A->cmap.N);
6747   if (fill == PETSC_DEFAULT) fill = 2.0;
6748   if (fill < 1.0) SETERRQ1(PETSC_ERR_ARG_SIZ,"Expected fill=%G must be > 1.0",fill);
6749   ierr = MatPreallocated(A);CHKERRQ(ierr);
6750 
6751   Asymbolic = A->ops->matmultsymbolic;
6752   Bsymbolic = B->ops->matmultsymbolic;
6753   if (Asymbolic == Bsymbolic){
6754     if (!Bsymbolic) SETERRQ1(PETSC_ERR_SUP,"C=A*B not implemented for B of type %s",B->type_name);
6755     symbolic = Bsymbolic;
6756   } else { /* dispatch based on the type of A and B */
6757     char  symbolicname[256];
6758     ierr = PetscStrcpy(symbolicname,"MatMatMultSymbolic_");CHKERRQ(ierr);
6759     ierr = PetscStrcat(symbolicname,A->type_name);CHKERRQ(ierr);
6760     ierr = PetscStrcat(symbolicname,"_");CHKERRQ(ierr);
6761     ierr = PetscStrcat(symbolicname,B->type_name);CHKERRQ(ierr);
6762     ierr = PetscStrcat(symbolicname,"_C");CHKERRQ(ierr);
6763     ierr = PetscObjectQueryFunction((PetscObject)B,symbolicname,(void (**)(void))&symbolic);CHKERRQ(ierr);
6764     if (!symbolic) SETERRQ2(PETSC_ERR_ARG_INCOMP,"MatMatMultSymbolic requires A, %s, to be compatible with B, %s",A->type_name,B->type_name);
6765   }
6766   ierr = PetscLogEventBegin(MAT_MatMultSymbolic,A,B,0,0);CHKERRQ(ierr);
6767   ierr = (*symbolic)(A,B,fill,C);CHKERRQ(ierr);
6768   ierr = PetscLogEventEnd(MAT_MatMultSymbolic,A,B,0,0);CHKERRQ(ierr);
6769   PetscFunctionReturn(0);
6770 }
6771 
6772 #undef __FUNCT__
6773 #define __FUNCT__ "MatMatMultNumeric"
6774 /*@
6775    MatMatMultNumeric - Performs the numeric matrix-matrix product.
6776    Call this routine after first calling MatMatMultSymbolic().
6777 
6778    Collective on Mat
6779 
6780    Input Parameters:
6781 +  A - the left matrix
6782 -  B - the right matrix
6783 
6784    Output Parameters:
6785 .  C - the product matrix, whose ij structure was defined from MatMatMultSymbolic().
6786 
6787    Notes:
6788    C must have been created with MatMatMultSymbolic.
6789 
6790    This routine is currently implemented for
6791     - pairs of AIJ matrices and classes which inherit from AIJ, C will be of type MATAIJ.
6792     - pairs of AIJ (A) and Dense (B) matrix, C will be of type MATDENSE.
6793 
6794    Level: intermediate
6795 
6796 .seealso: MatMatMult(), MatMatMultSymbolic()
6797 @*/
6798 PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat A,Mat B,Mat C)
6799 {
6800   PetscErrorCode ierr;
6801   PetscErrorCode (*Anumeric)(Mat,Mat,Mat);
6802   PetscErrorCode (*Bnumeric)(Mat,Mat,Mat);
6803   PetscErrorCode (*numeric)(Mat,Mat,Mat)=PETSC_NULL;
6804 
6805   PetscFunctionBegin;
6806   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6807   PetscValidType(A,1);
6808   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6809   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6810 
6811   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
6812   PetscValidType(B,2);
6813   MatPreallocated(B);
6814   if (!B->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6815   if (B->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6816 
6817   PetscValidHeaderSpecific(C,MAT_COOKIE,3);
6818   PetscValidType(C,3);
6819   MatPreallocated(C);
6820   if (!C->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6821   if (C->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6822 
6823   if (B->cmap.N!=C->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",B->cmap.N,C->cmap.N);
6824   if (B->rmap.N!=A->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",B->rmap.N,A->cmap.N);
6825   if (A->rmap.N!=C->rmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",A->rmap.N,C->rmap.N);
6826   ierr = MatPreallocated(A);CHKERRQ(ierr);
6827 
6828   Anumeric = A->ops->matmultnumeric;
6829   Bnumeric = B->ops->matmultnumeric;
6830   if (Anumeric == Bnumeric){
6831     if (!Bnumeric) SETERRQ1(PETSC_ERR_SUP,"MatMatMultNumeric not supported for B of type %s",B->type_name);
6832     numeric = Bnumeric;
6833   } else {
6834     char  numericname[256];
6835     ierr = PetscStrcpy(numericname,"MatMatMultNumeric_");CHKERRQ(ierr);
6836     ierr = PetscStrcat(numericname,A->type_name);CHKERRQ(ierr);
6837     ierr = PetscStrcat(numericname,"_");CHKERRQ(ierr);
6838     ierr = PetscStrcat(numericname,B->type_name);CHKERRQ(ierr);
6839     ierr = PetscStrcat(numericname,"_C");CHKERRQ(ierr);
6840     ierr = PetscObjectQueryFunction((PetscObject)B,numericname,(void (**)(void))&numeric);CHKERRQ(ierr);
6841     if (!numeric)
6842       SETERRQ2(PETSC_ERR_ARG_INCOMP,"MatMatMultNumeric requires A, %s, to be compatible with B, %s",A->type_name,B->type_name);
6843   }
6844   ierr = PetscLogEventBegin(MAT_MatMultNumeric,A,B,0,0);CHKERRQ(ierr);
6845   ierr = (*numeric)(A,B,C);CHKERRQ(ierr);
6846   ierr = PetscLogEventEnd(MAT_MatMultNumeric,A,B,0,0);CHKERRQ(ierr);
6847   PetscFunctionReturn(0);
6848 }
6849 
6850 #undef __FUNCT__
6851 #define __FUNCT__ "MatMatMultTranspose"
6852 /*@
6853    MatMatMultTranspose - Performs Matrix-Matrix Multiplication C=A^T*B.
6854 
6855    Collective on Mat
6856 
6857    Input Parameters:
6858 +  A - the left matrix
6859 .  B - the right matrix
6860 .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
6861 -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(B))
6862 
6863    Output Parameters:
6864 .  C - the product matrix
6865 
6866    Notes:
6867    C will be created and must be destroyed by the user with MatDestroy().
6868 
6869    This routine is currently only implemented for pairs of SeqAIJ matrices and classes
6870    which inherit from SeqAIJ.  C will be of type MATSEQAIJ.
6871 
6872    Level: intermediate
6873 
6874 .seealso: MatMatMultTransposeSymbolic(), MatMatMultTransposeNumeric(), MatPtAP()
6875 @*/
6876 PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat A,Mat B,MatReuse scall,PetscReal fill,Mat *C)
6877 {
6878   PetscErrorCode ierr;
6879   PetscErrorCode (*fA)(Mat,Mat,MatReuse,PetscReal,Mat*);
6880   PetscErrorCode (*fB)(Mat,Mat,MatReuse,PetscReal,Mat*);
6881 
6882   PetscFunctionBegin;
6883   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6884   PetscValidType(A,1);
6885   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6886   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6887   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
6888   PetscValidType(B,2);
6889   MatPreallocated(B);
6890   if (!B->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6891   if (B->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6892   PetscValidPointer(C,3);
6893   if (B->rmap.N!=A->rmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",B->rmap.N,A->rmap.N);
6894   if (fill < 1.0) SETERRQ1(PETSC_ERR_ARG_SIZ,"Expected fill=%G must be > 1.0",fill);
6895   ierr = MatPreallocated(A);CHKERRQ(ierr);
6896 
6897   fA = A->ops->matmulttranspose;
6898   if (!fA) SETERRQ1(PETSC_ERR_SUP,"MatMatMultTranspose not supported for A of type %s",A->type_name);
6899   fB = B->ops->matmulttranspose;
6900   if (!fB) SETERRQ1(PETSC_ERR_SUP,"MatMatMultTranspose not supported for B of type %s",B->type_name);
6901   if (fB!=fA) SETERRQ2(PETSC_ERR_ARG_INCOMP,"MatMatMultTranspose requires A, %s, to be compatible with B, %s",A->type_name,B->type_name);
6902 
6903   ierr = PetscLogEventBegin(MAT_MatMultTranspose,A,B,0,0);CHKERRQ(ierr);
6904   ierr = (*A->ops->matmulttranspose)(A,B,scall,fill,C);CHKERRQ(ierr);
6905   ierr = PetscLogEventEnd(MAT_MatMultTranspose,A,B,0,0);CHKERRQ(ierr);
6906 
6907   PetscFunctionReturn(0);
6908 }
6909 
6910 #undef __FUNCT__
6911 #define __FUNCT__ "MatGetRedundantMatrix"
6912 /*@C
6913    MatGetRedundantMatrix - Create redundant matrices and put them into processors of subcommunicators.
6914 
6915    Collective on Mat
6916 
6917    Input Parameters:
6918 +  mat - the matrix
6919 .  nsubcomm - the number of subcommunicators (= number of redundant pareallel or sequential matrices)
6920 .  subcomm - MPI communicator split from the communicator where mat resides in
6921 .  mlocal_red - number of local rows of the redundant matrix
6922 -  reuse - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
6923 
6924    Output Parameter:
6925 .  matredundant - redundant matrix
6926 
6927    Notes:
6928    MAT_REUSE_MATRIX can only be used when the nonzero structure of the
6929    original matrix has not changed from that last call to MatGetRedundantMatrix().
6930 
6931    This routine creates the duplicated matrices in subcommunicators; you should NOT create them before
6932    calling it.
6933 
6934    Only MPIAIJ matrix is supported.
6935 
6936    Level: advanced
6937 
6938    Concepts: subcommunicator
6939    Concepts: duplicate matrix
6940 
6941 .seealso: MatDestroy()
6942 @*/
6943 PetscErrorCode PETSCMAT_DLLEXPORT MatGetRedundantMatrix(Mat mat,PetscInt nsubcomm,MPI_Comm subcomm,PetscInt mlocal_red,MatReuse reuse,Mat *matredundant)
6944 {
6945   PetscErrorCode ierr;
6946 
6947   PetscFunctionBegin;
6948   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
6949   if (nsubcomm && reuse == MAT_REUSE_MATRIX) {
6950     PetscValidPointer(*matredundant,6);
6951     PetscValidHeaderSpecific(*matredundant,MAT_COOKIE,6);
6952   }
6953   if (!mat->ops->getredundantmatrix) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",mat->type_name);
6954   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6955   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6956   ierr = MatPreallocated(mat);CHKERRQ(ierr);
6957 
6958   ierr = PetscLogEventBegin(MAT_GetRedundantMatrix,mat,0,0,0);CHKERRQ(ierr);
6959   ierr = (*mat->ops->getredundantmatrix)(mat,nsubcomm,subcomm,mlocal_red,reuse,matredundant);CHKERRQ(ierr);
6960   ierr = PetscLogEventEnd(MAT_GetRedundantMatrix,mat,0,0,0);CHKERRQ(ierr);
6961   PetscFunctionReturn(0);
6962 }
6963