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