xref: /petsc/src/mat/interface/matrix.c (revision 6895c4454d0419b7d1cef7fe2938cafebbe2c313)
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, and BAIJ 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 and BAIJ 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_Basic"
2505 PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve_Basic(Mat A,Mat B,Mat X)
2506 {
2507   PetscErrorCode ierr;
2508   Vec            b,x;
2509   PetscInt       m,N,i;
2510   PetscScalar    *bb,*xx;
2511 
2512   PetscFunctionBegin;
2513   ierr = MatGetArray(B,&bb);CHKERRQ(ierr);
2514   ierr = MatGetArray(X,&xx);CHKERRQ(ierr);
2515   ierr = MatGetLocalSize(B,&m,PETSC_NULL);CHKERRQ(ierr);  /* number local rows */
2516   ierr = MatGetSize(B,PETSC_NULL,&N);CHKERRQ(ierr);       /* total columns in dense matrix */
2517   ierr = VecCreateMPIWithArray(A->hdr.comm,m,PETSC_DETERMINE,PETSC_NULL,&b);CHKERRQ(ierr);
2518   ierr = VecCreateMPIWithArray(A->hdr.comm,m,PETSC_DETERMINE,PETSC_NULL,&x);CHKERRQ(ierr);
2519   for (i=0; i<N; i++) {
2520     ierr = VecPlaceArray(b,bb + i*m);CHKERRQ(ierr);
2521     ierr = VecPlaceArray(x,xx + i*m);CHKERRQ(ierr);
2522     ierr = MatSolve(A,b,x);CHKERRQ(ierr);
2523   }
2524   ierr = VecDestroy(b);CHKERRQ(ierr);
2525   ierr = VecDestroy(x);CHKERRQ(ierr);
2526   ierr = MatRestoreArray(B,&bb);CHKERRQ(ierr);
2527   ierr = MatRestoreArray(X,&xx);CHKERRQ(ierr);
2528   PetscFunctionReturn(0);
2529 }
2530 
2531 #undef __FUNCT__
2532 #define __FUNCT__ "MatMatSolve"
2533 /*@
2534    MatMatSolve - Solves A X = B, given a factored matrix.
2535 
2536    Collective on Mat
2537 
2538    Input Parameters:
2539 +  mat - the factored matrix
2540 -  B - the right-hand-side matrix  (dense matrix)
2541 
2542    Output Parameter:
2543 .  B - the result matrix (dense matrix)
2544 
2545    Notes:
2546    The matrices b and x cannot be the same.  I.e., one cannot
2547    call MatMatSolve(A,x,x).
2548 
2549    Notes:
2550    Most users should usually employ the simplified KSP interface for linear solvers
2551    instead of working directly with matrix algebra routines such as this.
2552    See, e.g., KSPCreate(). However KSP can only solve for one vector (column of X)
2553    at a time.
2554 
2555    Level: developer
2556 
2557    Concepts: matrices^triangular solves
2558 
2559 .seealso: MatMatSolveAdd(), MatMatSolveTranspose(), MatMatSolveTransposeAdd(), MatLUFactor(), MatCholeskyFactor()
2560 @*/
2561 PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve(Mat A,Mat B,Mat X)
2562 {
2563   PetscErrorCode ierr;
2564 
2565   PetscFunctionBegin;
2566   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
2567   PetscValidType(A,1);
2568   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
2569   PetscValidHeaderSpecific(X,MAT_COOKIE,3);
2570   PetscCheckSameComm(A,1,B,2);
2571   PetscCheckSameComm(A,1,X,3);
2572   if (X == B) SETERRQ(PETSC_ERR_ARG_IDN,"X and B must be different matrices");
2573   if (!A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
2574   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);
2575   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);
2576   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);
2577   if (!A->rmap.N && !A->cmap.N) PetscFunctionReturn(0);
2578   ierr = MatPreallocated(A);CHKERRQ(ierr);
2579 
2580   ierr = PetscLogEventBegin(MAT_MatSolve,A,B,X,0);CHKERRQ(ierr);
2581   if (!A->ops->matsolve) {
2582     ierr = PetscInfo1(A,"Mat type %s using basic MatMatSolve",((PetscObject)A)->type_name);CHKERRQ(ierr);
2583     ierr = MatMatSolve_Basic(A,B,X);CHKERRQ(ierr);
2584   } else {
2585     ierr = (*A->ops->matsolve)(A,B,X);CHKERRQ(ierr);
2586   }
2587   ierr = PetscLogEventEnd(MAT_MatSolve,A,B,X,0);CHKERRQ(ierr);
2588   ierr = PetscObjectStateIncrease((PetscObject)X);CHKERRQ(ierr);
2589   PetscFunctionReturn(0);
2590 }
2591 
2592 
2593 #undef __FUNCT__
2594 #define __FUNCT__ "MatForwardSolve"
2595 /* @
2596    MatForwardSolve - Solves L x = b, given a factored matrix, A = LU, or
2597                             U^T*D^(1/2) x = b, given a factored symmetric matrix, A = U^T*D*U,
2598 
2599    Collective on Mat and Vec
2600 
2601    Input Parameters:
2602 +  mat - the factored matrix
2603 -  b - the right-hand-side vector
2604 
2605    Output Parameter:
2606 .  x - the result vector
2607 
2608    Notes:
2609    MatSolve() should be used for most applications, as it performs
2610    a forward solve followed by a backward solve.
2611 
2612    The vectors b and x cannot be the same,  i.e., one cannot
2613    call MatForwardSolve(A,x,x).
2614 
2615    For matrix in seqsbaij format with block size larger than 1,
2616    the diagonal blocks are not implemented as D = D^(1/2) * D^(1/2) yet.
2617    MatForwardSolve() solves U^T*D y = b, and
2618    MatBackwardSolve() solves U x = y.
2619    Thus they do not provide a symmetric preconditioner.
2620 
2621    Most users should employ the simplified KSP interface for linear solvers
2622    instead of working directly with matrix algebra routines such as this.
2623    See, e.g., KSPCreate().
2624 
2625    Level: developer
2626 
2627    Concepts: matrices^forward solves
2628 
2629 .seealso: MatSolve(), MatBackwardSolve()
2630 @ */
2631 PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat mat,Vec b,Vec x)
2632 {
2633   PetscErrorCode ierr;
2634 
2635   PetscFunctionBegin;
2636   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2637   PetscValidType(mat,1);
2638   PetscValidHeaderSpecific(b,VEC_COOKIE,2);
2639   PetscValidHeaderSpecific(x,VEC_COOKIE,3);
2640   PetscCheckSameComm(mat,1,b,2);
2641   PetscCheckSameComm(mat,1,x,3);
2642   if (x == b) SETERRQ(PETSC_ERR_ARG_IDN,"x and b must be different vectors");
2643   if (!mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
2644   if (!mat->ops->forwardsolve) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2645   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);
2646   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);
2647   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);
2648   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2649   ierr = PetscLogEventBegin(MAT_ForwardSolve,mat,b,x,0);CHKERRQ(ierr);
2650   ierr = (*mat->ops->forwardsolve)(mat,b,x);CHKERRQ(ierr);
2651   ierr = PetscLogEventEnd(MAT_ForwardSolve,mat,b,x,0);CHKERRQ(ierr);
2652   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
2653   PetscFunctionReturn(0);
2654 }
2655 
2656 #undef __FUNCT__
2657 #define __FUNCT__ "MatBackwardSolve"
2658 /* @
2659    MatBackwardSolve - Solves U x = b, given a factored matrix, A = LU.
2660                              D^(1/2) U x = b, given a factored symmetric matrix, A = U^T*D*U,
2661 
2662    Collective on Mat and Vec
2663 
2664    Input Parameters:
2665 +  mat - the factored matrix
2666 -  b - the right-hand-side vector
2667 
2668    Output Parameter:
2669 .  x - the result vector
2670 
2671    Notes:
2672    MatSolve() should be used for most applications, as it performs
2673    a forward solve followed by a backward solve.
2674 
2675    The vectors b and x cannot be the same.  I.e., one cannot
2676    call MatBackwardSolve(A,x,x).
2677 
2678    For matrix in seqsbaij format with block size larger than 1,
2679    the diagonal blocks are not implemented as D = D^(1/2) * D^(1/2) yet.
2680    MatForwardSolve() solves U^T*D y = b, and
2681    MatBackwardSolve() solves U x = y.
2682    Thus they do not provide a symmetric preconditioner.
2683 
2684    Most users should employ the simplified KSP interface for linear solvers
2685    instead of working directly with matrix algebra routines such as this.
2686    See, e.g., KSPCreate().
2687 
2688    Level: developer
2689 
2690    Concepts: matrices^backward solves
2691 
2692 .seealso: MatSolve(), MatForwardSolve()
2693 @ */
2694 PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat mat,Vec b,Vec x)
2695 {
2696   PetscErrorCode ierr;
2697 
2698   PetscFunctionBegin;
2699   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2700   PetscValidType(mat,1);
2701   PetscValidHeaderSpecific(b,VEC_COOKIE,2);
2702   PetscValidHeaderSpecific(x,VEC_COOKIE,3);
2703   PetscCheckSameComm(mat,1,b,2);
2704   PetscCheckSameComm(mat,1,x,3);
2705   if (x == b) SETERRQ(PETSC_ERR_ARG_IDN,"x and b must be different vectors");
2706   if (!mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
2707   if (!mat->ops->backwardsolve) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2708   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);
2709   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);
2710   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);
2711   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2712 
2713   ierr = PetscLogEventBegin(MAT_BackwardSolve,mat,b,x,0);CHKERRQ(ierr);
2714   ierr = (*mat->ops->backwardsolve)(mat,b,x);CHKERRQ(ierr);
2715   ierr = PetscLogEventEnd(MAT_BackwardSolve,mat,b,x,0);CHKERRQ(ierr);
2716   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
2717   PetscFunctionReturn(0);
2718 }
2719 
2720 #undef __FUNCT__
2721 #define __FUNCT__ "MatSolveAdd"
2722 /*@
2723    MatSolveAdd - Computes x = y + inv(A)*b, given a factored matrix.
2724 
2725    Collective on Mat and Vec
2726 
2727    Input Parameters:
2728 +  mat - the factored matrix
2729 .  b - the right-hand-side vector
2730 -  y - the vector to be added to
2731 
2732    Output Parameter:
2733 .  x - the result vector
2734 
2735    Notes:
2736    The vectors b and x cannot be the same.  I.e., one cannot
2737    call MatSolveAdd(A,x,y,x).
2738 
2739    Most users should employ the simplified KSP interface for linear solvers
2740    instead of working directly with matrix algebra routines such as this.
2741    See, e.g., KSPCreate().
2742 
2743    Level: developer
2744 
2745    Concepts: matrices^triangular solves
2746 
2747 .seealso: MatSolve(), MatSolveTranspose(), MatSolveTransposeAdd()
2748 @*/
2749 PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat mat,Vec b,Vec y,Vec x)
2750 {
2751   PetscScalar    one = 1.0;
2752   Vec            tmp;
2753   PetscErrorCode ierr;
2754 
2755   PetscFunctionBegin;
2756   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2757   PetscValidType(mat,1);
2758   PetscValidHeaderSpecific(y,VEC_COOKIE,2);
2759   PetscValidHeaderSpecific(b,VEC_COOKIE,3);
2760   PetscValidHeaderSpecific(x,VEC_COOKIE,4);
2761   PetscCheckSameComm(mat,1,b,2);
2762   PetscCheckSameComm(mat,1,y,2);
2763   PetscCheckSameComm(mat,1,x,3);
2764   if (x == b) SETERRQ(PETSC_ERR_ARG_IDN,"x and b must be different vectors");
2765   if (!mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
2766   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);
2767   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);
2768   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);
2769   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);
2770   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);
2771   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2772 
2773   ierr = PetscLogEventBegin(MAT_SolveAdd,mat,b,x,y);CHKERRQ(ierr);
2774   if (mat->ops->solveadd)  {
2775     ierr = (*mat->ops->solveadd)(mat,b,y,x);CHKERRQ(ierr);
2776   } else {
2777     /* do the solve then the add manually */
2778     if (x != y) {
2779       ierr = MatSolve(mat,b,x);CHKERRQ(ierr);
2780       ierr = VecAXPY(x,one,y);CHKERRQ(ierr);
2781     } else {
2782       ierr = VecDuplicate(x,&tmp);CHKERRQ(ierr);
2783       ierr = PetscLogObjectParent(mat,tmp);CHKERRQ(ierr);
2784       ierr = VecCopy(x,tmp);CHKERRQ(ierr);
2785       ierr = MatSolve(mat,b,x);CHKERRQ(ierr);
2786       ierr = VecAXPY(x,one,tmp);CHKERRQ(ierr);
2787       ierr = VecDestroy(tmp);CHKERRQ(ierr);
2788     }
2789   }
2790   ierr = PetscLogEventEnd(MAT_SolveAdd,mat,b,x,y);CHKERRQ(ierr);
2791   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
2792   PetscFunctionReturn(0);
2793 }
2794 
2795 #undef __FUNCT__
2796 #define __FUNCT__ "MatSolveTranspose"
2797 /*@
2798    MatSolveTranspose - Solves A' x = b, given a factored matrix.
2799 
2800    Collective on Mat and Vec
2801 
2802    Input Parameters:
2803 +  mat - the factored matrix
2804 -  b - the right-hand-side vector
2805 
2806    Output Parameter:
2807 .  x - the result vector
2808 
2809    Notes:
2810    The vectors b and x cannot be the same.  I.e., one cannot
2811    call MatSolveTranspose(A,x,x).
2812 
2813    Most users should employ the simplified KSP interface for linear solvers
2814    instead of working directly with matrix algebra routines such as this.
2815    See, e.g., KSPCreate().
2816 
2817    Level: developer
2818 
2819    Concepts: matrices^triangular solves
2820 
2821 .seealso: MatSolve(), MatSolveAdd(), MatSolveTransposeAdd()
2822 @*/
2823 PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat mat,Vec b,Vec x)
2824 {
2825   PetscErrorCode ierr;
2826 
2827   PetscFunctionBegin;
2828   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2829   PetscValidType(mat,1);
2830   PetscValidHeaderSpecific(b,VEC_COOKIE,2);
2831   PetscValidHeaderSpecific(x,VEC_COOKIE,3);
2832   PetscCheckSameComm(mat,1,b,2);
2833   PetscCheckSameComm(mat,1,x,3);
2834   if (!mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
2835   if (x == b) SETERRQ(PETSC_ERR_ARG_IDN,"x and b must be different vectors");
2836   if (!mat->ops->solvetranspose) SETERRQ1(PETSC_ERR_SUP,"Matrix type %s",((PetscObject)mat)->type_name);
2837   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);
2838   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);
2839   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2840   ierr = PetscLogEventBegin(MAT_SolveTranspose,mat,b,x,0);CHKERRQ(ierr);
2841   ierr = (*mat->ops->solvetranspose)(mat,b,x);CHKERRQ(ierr);
2842   ierr = PetscLogEventEnd(MAT_SolveTranspose,mat,b,x,0);CHKERRQ(ierr);
2843   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
2844   PetscFunctionReturn(0);
2845 }
2846 
2847 #undef __FUNCT__
2848 #define __FUNCT__ "MatSolveTransposeAdd"
2849 /*@
2850    MatSolveTransposeAdd - Computes x = y + inv(Transpose(A)) b, given a
2851                       factored matrix.
2852 
2853    Collective on Mat and Vec
2854 
2855    Input Parameters:
2856 +  mat - the factored matrix
2857 .  b - the right-hand-side vector
2858 -  y - the vector to be added to
2859 
2860    Output Parameter:
2861 .  x - the result vector
2862 
2863    Notes:
2864    The vectors b and x cannot be the same.  I.e., one cannot
2865    call MatSolveTransposeAdd(A,x,y,x).
2866 
2867    Most users should employ the simplified KSP interface for linear solvers
2868    instead of working directly with matrix algebra routines such as this.
2869    See, e.g., KSPCreate().
2870 
2871    Level: developer
2872 
2873    Concepts: matrices^triangular solves
2874 
2875 .seealso: MatSolve(), MatSolveAdd(), MatSolveTranspose()
2876 @*/
2877 PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat mat,Vec b,Vec y,Vec x)
2878 {
2879   PetscScalar    one = 1.0;
2880   PetscErrorCode ierr;
2881   Vec            tmp;
2882 
2883   PetscFunctionBegin;
2884   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2885   PetscValidType(mat,1);
2886   PetscValidHeaderSpecific(y,VEC_COOKIE,2);
2887   PetscValidHeaderSpecific(b,VEC_COOKIE,3);
2888   PetscValidHeaderSpecific(x,VEC_COOKIE,4);
2889   PetscCheckSameComm(mat,1,b,2);
2890   PetscCheckSameComm(mat,1,y,3);
2891   PetscCheckSameComm(mat,1,x,4);
2892   if (x == b) SETERRQ(PETSC_ERR_ARG_IDN,"x and b must be different vectors");
2893   if (!mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
2894   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);
2895   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);
2896   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);
2897   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);
2898   ierr = MatPreallocated(mat);CHKERRQ(ierr);
2899 
2900   ierr = PetscLogEventBegin(MAT_SolveTransposeAdd,mat,b,x,y);CHKERRQ(ierr);
2901   if (mat->ops->solvetransposeadd) {
2902     ierr = (*mat->ops->solvetransposeadd)(mat,b,y,x);CHKERRQ(ierr);
2903   } else {
2904     /* do the solve then the add manually */
2905     if (x != y) {
2906       ierr = MatSolveTranspose(mat,b,x);CHKERRQ(ierr);
2907       ierr = VecAXPY(x,one,y);CHKERRQ(ierr);
2908     } else {
2909       ierr = VecDuplicate(x,&tmp);CHKERRQ(ierr);
2910       ierr = PetscLogObjectParent(mat,tmp);CHKERRQ(ierr);
2911       ierr = VecCopy(x,tmp);CHKERRQ(ierr);
2912       ierr = MatSolveTranspose(mat,b,x);CHKERRQ(ierr);
2913       ierr = VecAXPY(x,one,tmp);CHKERRQ(ierr);
2914       ierr = VecDestroy(tmp);CHKERRQ(ierr);
2915     }
2916   }
2917   ierr = PetscLogEventEnd(MAT_SolveTransposeAdd,mat,b,x,y);CHKERRQ(ierr);
2918   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
2919   PetscFunctionReturn(0);
2920 }
2921 /* ----------------------------------------------------------------*/
2922 
2923 #undef __FUNCT__
2924 #define __FUNCT__ "MatRelax"
2925 /*@
2926    MatRelax - Computes relaxation (SOR, Gauss-Seidel) sweeps.
2927 
2928    Collective on Mat and Vec
2929 
2930    Input Parameters:
2931 +  mat - the matrix
2932 .  b - the right hand side
2933 .  omega - the relaxation factor
2934 .  flag - flag indicating the type of SOR (see below)
2935 .  shift -  diagonal shift
2936 .  its - the number of iterations
2937 -  lits - the number of local iterations
2938 
2939    Output Parameters:
2940 .  x - the solution (can contain an initial guess)
2941 
2942    SOR Flags:
2943 .     SOR_FORWARD_SWEEP - forward SOR
2944 .     SOR_BACKWARD_SWEEP - backward SOR
2945 .     SOR_SYMMETRIC_SWEEP - SSOR (symmetric SOR)
2946 .     SOR_LOCAL_FORWARD_SWEEP - local forward SOR
2947 .     SOR_LOCAL_BACKWARD_SWEEP - local forward SOR
2948 .     SOR_LOCAL_SYMMETRIC_SWEEP - local SSOR
2949 .     SOR_APPLY_UPPER, SOR_APPLY_LOWER - applies
2950          upper/lower triangular part of matrix to
2951          vector (with omega)
2952 .     SOR_ZERO_INITIAL_GUESS - zero initial guess
2953 
2954    Notes:
2955    SOR_LOCAL_FORWARD_SWEEP, SOR_LOCAL_BACKWARD_SWEEP, and
2956    SOR_LOCAL_SYMMETRIC_SWEEP perform separate independent smoothings
2957    on each processor.
2958 
2959    Application programmers will not generally use MatRelax() directly,
2960    but instead will employ the KSP/PC interface.
2961 
2962    Notes for Advanced Users:
2963    The flags are implemented as bitwise inclusive or operations.
2964    For example, use (SOR_ZERO_INITIAL_GUESS | SOR_SYMMETRIC_SWEEP)
2965    to specify a zero initial guess for SSOR.
2966 
2967    Most users should employ the simplified KSP interface for linear solvers
2968    instead of working directly with matrix algebra routines such as this.
2969    See, e.g., KSPCreate().
2970 
2971    See also, MatPBRelax(). This routine will automatically call the point block
2972    version if the point version is not available.
2973 
2974    Level: developer
2975 
2976    Concepts: matrices^relaxation
2977    Concepts: matrices^SOR
2978    Concepts: matrices^Gauss-Seidel
2979 
2980 @*/
2981 PetscErrorCode PETSCMAT_DLLEXPORT MatRelax(Mat mat,Vec b,PetscReal omega,MatSORType flag,PetscReal shift,PetscInt its,PetscInt lits,Vec x)
2982 {
2983   PetscErrorCode ierr;
2984 
2985   PetscFunctionBegin;
2986   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
2987   PetscValidType(mat,1);
2988   PetscValidHeaderSpecific(b,VEC_COOKIE,2);
2989   PetscValidHeaderSpecific(x,VEC_COOKIE,8);
2990   PetscCheckSameComm(mat,1,b,2);
2991   PetscCheckSameComm(mat,1,x,8);
2992   if (!mat->ops->relax && !mat->ops->pbrelax) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
2993   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
2994   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
2995   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);
2996   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);
2997   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);
2998   if (its <= 0) SETERRQ1(PETSC_ERR_ARG_WRONG,"Relaxation requires global its %D positive",its);
2999   if (lits <= 0) SETERRQ1(PETSC_ERR_ARG_WRONG,"Relaxation requires local its %D positive",lits);
3000 
3001   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3002   ierr = PetscLogEventBegin(MAT_Relax,mat,b,x,0);CHKERRQ(ierr);
3003   if (mat->ops->relax) {
3004     ierr =(*mat->ops->relax)(mat,b,omega,flag,shift,its,lits,x);CHKERRQ(ierr);
3005   } else {
3006     ierr =(*mat->ops->pbrelax)(mat,b,omega,flag,shift,its,lits,x);CHKERRQ(ierr);
3007   }
3008   ierr = PetscLogEventEnd(MAT_Relax,mat,b,x,0);CHKERRQ(ierr);
3009   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
3010   PetscFunctionReturn(0);
3011 }
3012 
3013 #undef __FUNCT__
3014 #define __FUNCT__ "MatPBRelax"
3015 /*@
3016    MatPBRelax - Computes relaxation (SOR, Gauss-Seidel) sweeps.
3017 
3018    Collective on Mat and Vec
3019 
3020    See MatRelax() for usage
3021 
3022    For multi-component PDEs where the Jacobian is stored in a point block format
3023    (with the PETSc BAIJ matrix formats) the relaxation is done one point block at
3024    a time. That is, the small (for example, 4 by 4) blocks along the diagonal are solved
3025    simultaneously (that is a 4 by 4 linear solve is done) to update all the values at a point.
3026 
3027    Level: developer
3028 
3029 @*/
3030 PetscErrorCode PETSCMAT_DLLEXPORT MatPBRelax(Mat mat,Vec b,PetscReal omega,MatSORType flag,PetscReal shift,PetscInt its,PetscInt lits,Vec x)
3031 {
3032   PetscErrorCode ierr;
3033 
3034   PetscFunctionBegin;
3035   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3036   PetscValidType(mat,1);
3037   PetscValidHeaderSpecific(b,VEC_COOKIE,2);
3038   PetscValidHeaderSpecific(x,VEC_COOKIE,8);
3039   PetscCheckSameComm(mat,1,b,2);
3040   PetscCheckSameComm(mat,1,x,8);
3041   if (!mat->ops->pbrelax) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3042   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3043   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3044   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);
3045   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);
3046   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);
3047   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3048 
3049   ierr = PetscLogEventBegin(MAT_Relax,mat,b,x,0);CHKERRQ(ierr);
3050   ierr =(*mat->ops->pbrelax)(mat,b,omega,flag,shift,its,lits,x);CHKERRQ(ierr);
3051   ierr = PetscLogEventEnd(MAT_Relax,mat,b,x,0);CHKERRQ(ierr);
3052   ierr = PetscObjectStateIncrease((PetscObject)x);CHKERRQ(ierr);
3053   PetscFunctionReturn(0);
3054 }
3055 
3056 #undef __FUNCT__
3057 #define __FUNCT__ "MatCopy_Basic"
3058 /*
3059       Default matrix copy routine.
3060 */
3061 PetscErrorCode MatCopy_Basic(Mat A,Mat B,MatStructure str)
3062 {
3063   PetscErrorCode    ierr;
3064   PetscInt          i,rstart,rend,nz;
3065   const PetscInt    *cwork;
3066   const PetscScalar *vwork;
3067 
3068   PetscFunctionBegin;
3069   if (B->assembled) {
3070     ierr = MatZeroEntries(B);CHKERRQ(ierr);
3071   }
3072   ierr = MatGetOwnershipRange(A,&rstart,&rend);CHKERRQ(ierr);
3073   for (i=rstart; i<rend; i++) {
3074     ierr = MatGetRow(A,i,&nz,&cwork,&vwork);CHKERRQ(ierr);
3075     ierr = MatSetValues(B,1,&i,nz,cwork,vwork,INSERT_VALUES);CHKERRQ(ierr);
3076     ierr = MatRestoreRow(A,i,&nz,&cwork,&vwork);CHKERRQ(ierr);
3077   }
3078   ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
3079   ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
3080   ierr = PetscObjectStateIncrease((PetscObject)B);CHKERRQ(ierr);
3081   PetscFunctionReturn(0);
3082 }
3083 
3084 #undef __FUNCT__
3085 #define __FUNCT__ "MatCopy"
3086 /*@
3087    MatCopy - Copys a matrix to another matrix.
3088 
3089    Collective on Mat
3090 
3091    Input Parameters:
3092 +  A - the matrix
3093 -  str - SAME_NONZERO_PATTERN or DIFFERENT_NONZERO_PATTERN
3094 
3095    Output Parameter:
3096 .  B - where the copy is put
3097 
3098    Notes:
3099    If you use SAME_NONZERO_PATTERN then the two matrices had better have the
3100    same nonzero pattern or the routine will crash.
3101 
3102    MatCopy() copies the matrix entries of a matrix to another existing
3103    matrix (after first zeroing the second matrix).  A related routine is
3104    MatConvert(), which first creates a new matrix and then copies the data.
3105 
3106    Level: intermediate
3107 
3108    Concepts: matrices^copying
3109 
3110 .seealso: MatConvert(), MatDuplicate()
3111 
3112 @*/
3113 PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat A,Mat B,MatStructure str)
3114 {
3115   PetscErrorCode ierr;
3116 
3117   PetscFunctionBegin;
3118   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
3119   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
3120   PetscValidType(A,1);
3121   PetscValidType(B,2);
3122   MatPreallocated(B);
3123   PetscCheckSameComm(A,1,B,2);
3124   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3125   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3126   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);
3127   ierr = MatPreallocated(A);CHKERRQ(ierr);
3128 
3129   ierr = PetscLogEventBegin(MAT_Copy,A,B,0,0);CHKERRQ(ierr);
3130   if (A->ops->copy) {
3131     ierr = (*A->ops->copy)(A,B,str);CHKERRQ(ierr);
3132   } else { /* generic conversion */
3133     ierr = MatCopy_Basic(A,B,str);CHKERRQ(ierr);
3134   }
3135   if (A->mapping) {
3136     if (B->mapping) {ierr = ISLocalToGlobalMappingDestroy(B->mapping);CHKERRQ(ierr);B->mapping = 0;}
3137     ierr = MatSetLocalToGlobalMapping(B,A->mapping);CHKERRQ(ierr);
3138   }
3139   if (A->bmapping) {
3140     if (B->bmapping) {ierr = ISLocalToGlobalMappingDestroy(B->bmapping);CHKERRQ(ierr);B->bmapping = 0;}
3141     ierr = MatSetLocalToGlobalMappingBlock(B,A->mapping);CHKERRQ(ierr);
3142   }
3143   ierr = PetscLogEventEnd(MAT_Copy,A,B,0,0);CHKERRQ(ierr);
3144   ierr = PetscObjectStateIncrease((PetscObject)B);CHKERRQ(ierr);
3145   PetscFunctionReturn(0);
3146 }
3147 
3148 #undef __FUNCT__
3149 #define __FUNCT__ "MatConvert"
3150 /*@C
3151    MatConvert - Converts a matrix to another matrix, either of the same
3152    or different type.
3153 
3154    Collective on Mat
3155 
3156    Input Parameters:
3157 +  mat - the matrix
3158 .  newtype - new matrix type.  Use MATSAME to create a new matrix of the
3159    same type as the original matrix.
3160 -  reuse - denotes if the destination matrix is to be created or reused.  Currently
3161    MAT_REUSE_MATRIX is only supported for inplace conversion, otherwise use
3162    MAT_INITIAL_MATRIX.
3163 
3164    Output Parameter:
3165 .  M - pointer to place new matrix
3166 
3167    Notes:
3168    MatConvert() first creates a new matrix and then copies the data from
3169    the first matrix.  A related routine is MatCopy(), which copies the matrix
3170    entries of one matrix to another already existing matrix context.
3171 
3172    Level: intermediate
3173 
3174    Concepts: matrices^converting between storage formats
3175 
3176 .seealso: MatCopy(), MatDuplicate()
3177 @*/
3178 PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat mat, MatType newtype,MatReuse reuse,Mat *M)
3179 {
3180   PetscErrorCode         ierr;
3181   PetscTruth             sametype,issame,flg;
3182   char                   convname[256],mtype[256];
3183   Mat                    B;
3184 
3185   PetscFunctionBegin;
3186   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3187   PetscValidType(mat,1);
3188   PetscValidPointer(M,3);
3189   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3190   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3191   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3192 
3193   ierr = PetscOptionsGetString(((PetscObject)mat)->prefix,"-matconvert_type",mtype,256,&flg);CHKERRQ(ierr);
3194   if (flg) {
3195     newtype = mtype;
3196   }
3197   ierr = PetscTypeCompare((PetscObject)mat,newtype,&sametype);CHKERRQ(ierr);
3198   ierr = PetscStrcmp(newtype,"same",&issame);CHKERRQ(ierr);
3199   if ((reuse==MAT_REUSE_MATRIX) && (mat != *M)) {
3200     SETERRQ(PETSC_ERR_SUP,"MAT_REUSE_MATRIX only supported for in-place conversion currently");
3201   }
3202 
3203   if ((reuse == MAT_REUSE_MATRIX) && (issame || sametype)) PetscFunctionReturn(0);
3204 
3205   if ((sametype || issame) && (reuse==MAT_INITIAL_MATRIX) && mat->ops->duplicate) {
3206     ierr = (*mat->ops->duplicate)(mat,MAT_COPY_VALUES,M);CHKERRQ(ierr);
3207   } else {
3208     PetscErrorCode (*conv)(Mat, MatType,MatReuse,Mat*)=PETSC_NULL;
3209     const char     *prefix[3] = {"seq","mpi",""};
3210     PetscInt       i;
3211     /*
3212        Order of precedence:
3213        1) See if a specialized converter is known to the current matrix.
3214        2) See if a specialized converter is known to the desired matrix class.
3215        3) See if a good general converter is registered for the desired class
3216           (as of 6/27/03 only MATMPIADJ falls into this category).
3217        4) See if a good general converter is known for the current matrix.
3218        5) Use a really basic converter.
3219     */
3220 
3221     /* 1) See if a specialized converter is known to the current matrix and the desired class */
3222     for (i=0; i<3; i++) {
3223       ierr = PetscStrcpy(convname,"MatConvert_");CHKERRQ(ierr);
3224       ierr = PetscStrcat(convname,((PetscObject)mat)->type_name);CHKERRQ(ierr);
3225       ierr = PetscStrcat(convname,"_");CHKERRQ(ierr);
3226       ierr = PetscStrcat(convname,prefix[i]);CHKERRQ(ierr);
3227       ierr = PetscStrcat(convname,newtype);CHKERRQ(ierr);
3228       ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr);
3229       ierr = PetscObjectQueryFunction((PetscObject)mat,convname,(void (**)(void))&conv);CHKERRQ(ierr);
3230       if (conv) goto foundconv;
3231     }
3232 
3233     /* 2)  See if a specialized converter is known to the desired matrix class. */
3234     ierr = MatCreate(((PetscObject)mat)->comm,&B);CHKERRQ(ierr);
3235     ierr = MatSetSizes(B,mat->rmap.n,mat->cmap.n,mat->rmap.N,mat->cmap.N);CHKERRQ(ierr);
3236     ierr = MatSetType(B,newtype);CHKERRQ(ierr);
3237     for (i=0; i<3; i++) {
3238       ierr = PetscStrcpy(convname,"MatConvert_");CHKERRQ(ierr);
3239       ierr = PetscStrcat(convname,((PetscObject)mat)->type_name);CHKERRQ(ierr);
3240       ierr = PetscStrcat(convname,"_");CHKERRQ(ierr);
3241       ierr = PetscStrcat(convname,prefix[i]);CHKERRQ(ierr);
3242       ierr = PetscStrcat(convname,newtype);CHKERRQ(ierr);
3243       ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr);
3244       ierr = PetscObjectQueryFunction((PetscObject)B,convname,(void (**)(void))&conv);CHKERRQ(ierr);
3245       if (conv) {
3246         ierr = MatDestroy(B);CHKERRQ(ierr);
3247         goto foundconv;
3248       }
3249     }
3250 
3251     /* 3) See if a good general converter is registered for the desired class */
3252     conv = B->ops->convertfrom;
3253     ierr = MatDestroy(B);CHKERRQ(ierr);
3254     if (conv) goto foundconv;
3255 
3256     /* 4) See if a good general converter is known for the current matrix */
3257     if (mat->ops->convert) {
3258       conv = mat->ops->convert;
3259     }
3260     if (conv) goto foundconv;
3261 
3262     /* 5) Use a really basic converter. */
3263     conv = MatConvert_Basic;
3264 
3265     foundconv:
3266     ierr = PetscLogEventBegin(MAT_Convert,mat,0,0,0);CHKERRQ(ierr);
3267     ierr = (*conv)(mat,newtype,reuse,M);CHKERRQ(ierr);
3268     ierr = PetscLogEventEnd(MAT_Convert,mat,0,0,0);CHKERRQ(ierr);
3269   }
3270   ierr = PetscObjectStateIncrease((PetscObject)*M);CHKERRQ(ierr);
3271   PetscFunctionReturn(0);
3272 }
3273 
3274 
3275 #undef __FUNCT__
3276 #define __FUNCT__ "MatDuplicate"
3277 /*@
3278    MatDuplicate - Duplicates a matrix including the non-zero structure.
3279 
3280    Collective on Mat
3281 
3282    Input Parameters:
3283 +  mat - the matrix
3284 -  op - either MAT_DO_NOT_COPY_VALUES or MAT_COPY_VALUES, cause it to copy nonzero
3285         values as well or not
3286 
3287    Output Parameter:
3288 .  M - pointer to place new matrix
3289 
3290    Level: intermediate
3291 
3292    Concepts: matrices^duplicating
3293 
3294 .seealso: MatCopy(), MatConvert()
3295 @*/
3296 PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat mat,MatDuplicateOption op,Mat *M)
3297 {
3298   PetscErrorCode ierr;
3299   Mat            B;
3300 
3301   PetscFunctionBegin;
3302   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3303   PetscValidType(mat,1);
3304   PetscValidPointer(M,3);
3305   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3306   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3307   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3308 
3309   *M  = 0;
3310   if (!mat->ops->duplicate) {
3311     SETERRQ(PETSC_ERR_SUP,"Not written for this matrix type");
3312   }
3313   ierr = PetscLogEventBegin(MAT_Convert,mat,0,0,0);CHKERRQ(ierr);
3314   ierr = (*mat->ops->duplicate)(mat,op,M);CHKERRQ(ierr);
3315   B = *M;
3316   if (mat->mapping) {
3317     ierr = MatSetLocalToGlobalMapping(B,mat->mapping);CHKERRQ(ierr);
3318   }
3319   if (mat->bmapping) {
3320     ierr = MatSetLocalToGlobalMappingBlock(B,mat->bmapping);CHKERRQ(ierr);
3321   }
3322   ierr = PetscMapCopy(((PetscObject)mat)->comm,&mat->rmap,&B->rmap);CHKERRQ(ierr);
3323   ierr = PetscMapCopy(((PetscObject)mat)->comm,&mat->cmap,&B->cmap);CHKERRQ(ierr);
3324 
3325   ierr = PetscLogEventEnd(MAT_Convert,mat,0,0,0);CHKERRQ(ierr);
3326   ierr = PetscObjectStateIncrease((PetscObject)B);CHKERRQ(ierr);
3327   PetscFunctionReturn(0);
3328 }
3329 
3330 #undef __FUNCT__
3331 #define __FUNCT__ "MatGetDiagonal"
3332 /*@
3333    MatGetDiagonal - Gets the diagonal of a matrix.
3334 
3335    Collective on Mat and Vec
3336 
3337    Input Parameters:
3338 +  mat - the matrix
3339 -  v - the vector for storing the diagonal
3340 
3341    Output Parameter:
3342 .  v - the diagonal of the matrix
3343 
3344    Notes: The result of this call are the same as if one converted the matrix to dense format
3345       and found the minimum value in each row (i.e. the implicit zeros are counted as zeros).
3346 
3347    Level: intermediate
3348 
3349    Concepts: matrices^accessing diagonals
3350 
3351 .seealso: MatGetRow(), MatGetSubMatrices(), MatGetSubmatrix(), MatGetRowMaxAbs()
3352 @*/
3353 PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat mat,Vec v)
3354 {
3355   PetscErrorCode ierr;
3356 
3357   PetscFunctionBegin;
3358   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3359   PetscValidType(mat,1);
3360   PetscValidHeaderSpecific(v,VEC_COOKIE,2);
3361   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3362   if (!mat->ops->getdiagonal) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3363   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3364 
3365   ierr = (*mat->ops->getdiagonal)(mat,v);CHKERRQ(ierr);
3366   ierr = PetscObjectStateIncrease((PetscObject)v);CHKERRQ(ierr);
3367   PetscFunctionReturn(0);
3368 }
3369 
3370 #undef __FUNCT__
3371 #define __FUNCT__ "MatGetRowMin"
3372 /*@
3373    MatGetRowMin - Gets the minimum value (of the real part) of each
3374         row of the matrix
3375 
3376    Collective on Mat and Vec
3377 
3378    Input Parameters:
3379 .  mat - the matrix
3380 
3381    Output Parameter:
3382 +  v - the vector for storing the maximums
3383 -  idx - the indices of the column found for each row (optional)
3384 
3385    Level: intermediate
3386 
3387    Notes: The result of this call are the same as if one converted the matrix to dense format
3388       and found the minimum value in each row (i.e. the implicit zeros are counted as zeros).
3389 
3390     This code is only implemented for a couple of matrix formats.
3391 
3392    Concepts: matrices^getting row maximums
3393 
3394 .seealso: MatGetDiagonal(), MatGetSubMatrices(), MatGetSubmatrix(), MatGetRowMaxAbs(),
3395           MatGetRowMax()
3396 @*/
3397 PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMin(Mat mat,Vec v,PetscInt idx[])
3398 {
3399   PetscErrorCode ierr;
3400 
3401   PetscFunctionBegin;
3402   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3403   PetscValidType(mat,1);
3404   PetscValidHeaderSpecific(v,VEC_COOKIE,2);
3405   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3406   if (!mat->ops->getrowmax) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3407   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3408 
3409   ierr = (*mat->ops->getrowmin)(mat,v,idx);CHKERRQ(ierr);
3410   ierr = PetscObjectStateIncrease((PetscObject)v);CHKERRQ(ierr);
3411   PetscFunctionReturn(0);
3412 }
3413 
3414 #undef __FUNCT__
3415 #define __FUNCT__ "MatGetRowMax"
3416 /*@
3417    MatGetRowMax - Gets the maximum value (of the real part) of each
3418         row of the matrix
3419 
3420    Collective on Mat and Vec
3421 
3422    Input Parameters:
3423 .  mat - the matrix
3424 
3425    Output Parameter:
3426 +  v - the vector for storing the maximums
3427 -  idx - the indices of the column found for each row (optional)
3428 
3429    Level: intermediate
3430 
3431    Notes: The result of this call are the same as if one converted the matrix to dense format
3432       and found the minimum value in each row (i.e. the implicit zeros are counted as zeros).
3433 
3434     This code is only implemented for a couple of matrix formats.
3435 
3436    Concepts: matrices^getting row maximums
3437 
3438 .seealso: MatGetDiagonal(), MatGetSubMatrices(), MatGetSubmatrix(), MatGetRowMaxAbs(), MatGetRowMin()
3439 @*/
3440 PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat mat,Vec v,PetscInt idx[])
3441 {
3442   PetscErrorCode ierr;
3443 
3444   PetscFunctionBegin;
3445   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3446   PetscValidType(mat,1);
3447   PetscValidHeaderSpecific(v,VEC_COOKIE,2);
3448   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3449   if (!mat->ops->getrowmax) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3450   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3451 
3452   ierr = (*mat->ops->getrowmax)(mat,v,idx);CHKERRQ(ierr);
3453   ierr = PetscObjectStateIncrease((PetscObject)v);CHKERRQ(ierr);
3454   PetscFunctionReturn(0);
3455 }
3456 
3457 #undef __FUNCT__
3458 #define __FUNCT__ "MatGetRowMaxAbs"
3459 /*@
3460    MatGetRowMaxAbs - Gets the maximum value (in absolute value) of each
3461         row of the matrix
3462 
3463    Collective on Mat and Vec
3464 
3465    Input Parameters:
3466 .  mat - the matrix
3467 
3468    Output Parameter:
3469 +  v - the vector for storing the maximums
3470 -  idx - the indices of the column found for each row (optional)
3471 
3472    Level: intermediate
3473 
3474    Notes: if a row is completely empty or has only 0.0 values then the idx[] value for that
3475     row is 0 (the first column).
3476 
3477     This code is only implemented for a couple of matrix formats.
3478 
3479    Concepts: matrices^getting row maximums
3480 
3481 .seealso: MatGetDiagonal(), MatGetSubMatrices(), MatGetSubmatrix(), MatGetRowMax(), MatGetRowMin()
3482 @*/
3483 PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMaxAbs(Mat mat,Vec v,PetscInt idx[])
3484 {
3485   PetscErrorCode ierr;
3486 
3487   PetscFunctionBegin;
3488   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3489   PetscValidType(mat,1);
3490   PetscValidHeaderSpecific(v,VEC_COOKIE,2);
3491   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3492   if (!mat->ops->getrowmaxabs) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3493   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3494 
3495   ierr = (*mat->ops->getrowmaxabs)(mat,v,idx);CHKERRQ(ierr);
3496   ierr = PetscObjectStateIncrease((PetscObject)v);CHKERRQ(ierr);
3497   PetscFunctionReturn(0);
3498 }
3499 
3500 #undef __FUNCT__
3501 #define __FUNCT__ "MatGetRowSum"
3502 /*@
3503    MatGetRowSum - Gets the sum of each row of the matrix
3504 
3505    Collective on Mat and Vec
3506 
3507    Input Parameters:
3508 .  mat - the matrix
3509 
3510    Output Parameter:
3511 .  v - the vector for storing the maximums
3512 
3513    Level: intermediate
3514 
3515    Notes: This code is slow since it is not currently specialized for different formats
3516 
3517    Concepts: matrices^getting row sums
3518 
3519 .seealso: MatGetDiagonal(), MatGetSubMatrices(), MatGetSubmatrix(), MatGetRowMax(), MatGetRowMin()
3520 @*/
3521 PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowSum(Mat mat, Vec v)
3522 {
3523   PetscInt       start, end, row;
3524   PetscScalar   *array;
3525   PetscErrorCode ierr;
3526 
3527   PetscFunctionBegin;
3528   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3529   PetscValidType(mat,1);
3530   PetscValidHeaderSpecific(v,VEC_COOKIE,2);
3531   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3532   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3533   ierr = MatGetOwnershipRange(mat, &start, &end);CHKERRQ(ierr);
3534   ierr = VecGetArray(v, &array);CHKERRQ(ierr);
3535   for(row = start; row < end; ++row) {
3536     PetscInt           ncols, col;
3537     const PetscInt    *cols;
3538     const PetscScalar *vals;
3539 
3540     array[row - start] = 0.0;
3541     ierr = MatGetRow(mat, row, &ncols, &cols, &vals);CHKERRQ(ierr);
3542     for(col = 0; col < ncols; col++) {
3543       array[row - start] += vals[col];
3544     }
3545     ierr = MatRestoreRow(mat, row, &ncols, &cols, &vals);CHKERRQ(ierr);
3546   }
3547   ierr = VecRestoreArray(v, &array);CHKERRQ(ierr);
3548   ierr = PetscObjectStateIncrease((PetscObject) v);CHKERRQ(ierr);
3549   PetscFunctionReturn(0);
3550 }
3551 
3552 #undef __FUNCT__
3553 #define __FUNCT__ "MatTranspose"
3554 /*@
3555    MatTranspose - Computes an in-place or out-of-place transpose of a matrix.
3556 
3557    Collective on Mat
3558 
3559    Input Parameter:
3560 .  mat - the matrix to transpose
3561 
3562    Output Parameters:
3563 .  B - the transpose
3564 
3565    Notes:
3566      If you  pass in PETSC_NULL for B an in-place transpose in mat will be done
3567 
3568    Level: intermediate
3569 
3570    Concepts: matrices^transposing
3571 
3572 .seealso: MatMultTranspose(), MatMultTransposeAdd(), MatIsTranspose()
3573 @*/
3574 PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat mat,Mat *B)
3575 {
3576   PetscErrorCode ierr;
3577 
3578   PetscFunctionBegin;
3579   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3580   PetscValidType(mat,1);
3581   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3582   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3583   if (!mat->ops->transpose) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3584   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3585 
3586   ierr = PetscLogEventBegin(MAT_Transpose,mat,0,0,0);CHKERRQ(ierr);
3587   ierr = (*mat->ops->transpose)(mat,B);CHKERRQ(ierr);
3588   ierr = PetscLogEventEnd(MAT_Transpose,mat,0,0,0);CHKERRQ(ierr);
3589   if (B) {ierr = PetscObjectStateIncrease((PetscObject)*B);CHKERRQ(ierr);}
3590   PetscFunctionReturn(0);
3591 }
3592 
3593 #undef __FUNCT__
3594 #define __FUNCT__ "MatIsTranspose"
3595 /*@
3596    MatIsTranspose - Test whether a matrix is another one's transpose,
3597         or its own, in which case it tests symmetry.
3598 
3599    Collective on Mat
3600 
3601    Input Parameter:
3602 +  A - the matrix to test
3603 -  B - the matrix to test against, this can equal the first parameter
3604 
3605    Output Parameters:
3606 .  flg - the result
3607 
3608    Notes:
3609    Only available for SeqAIJ/MPIAIJ matrices. The sequential algorithm
3610    has a running time of the order of the number of nonzeros; the parallel
3611    test involves parallel copies of the block-offdiagonal parts of the matrix.
3612 
3613    Level: intermediate
3614 
3615    Concepts: matrices^transposing, matrix^symmetry
3616 
3617 .seealso: MatTranspose(), MatIsSymmetric(), MatIsHermitian()
3618 @*/
3619 PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat A,Mat B,PetscReal tol,PetscTruth *flg)
3620 {
3621   PetscErrorCode ierr,(*f)(Mat,Mat,PetscReal,PetscTruth*),(*g)(Mat,Mat,PetscReal,PetscTruth*);
3622 
3623   PetscFunctionBegin;
3624   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
3625   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
3626   PetscValidPointer(flg,3);
3627   ierr = PetscObjectQueryFunction((PetscObject)A,"MatIsTranspose_C",(void (**)(void))&f);CHKERRQ(ierr);
3628   ierr = PetscObjectQueryFunction((PetscObject)B,"MatIsTranspose_C",(void (**)(void))&g);CHKERRQ(ierr);
3629   if (f && g) {
3630     if (f==g) {
3631       ierr = (*f)(A,B,tol,flg);CHKERRQ(ierr);
3632     } else {
3633       SETERRQ(PETSC_ERR_ARG_NOTSAMETYPE,"Matrices do not have the same comparator for symmetry test");
3634     }
3635   }
3636   PetscFunctionReturn(0);
3637 }
3638 
3639 #undef __FUNCT__
3640 #define __FUNCT__ "MatIsHermitianTranspose"
3641 /*@
3642    MatIsHermitianTranspose - Test whether a matrix is another one's Hermitian transpose,
3643 
3644    Collective on Mat
3645 
3646    Input Parameter:
3647 +  A - the matrix to test
3648 -  B - the matrix to test against, this can equal the first parameter
3649 
3650    Output Parameters:
3651 .  flg - the result
3652 
3653    Notes:
3654    Only available for SeqAIJ/MPIAIJ matrices. The sequential algorithm
3655    has a running time of the order of the number of nonzeros; the parallel
3656    test involves parallel copies of the block-offdiagonal parts of the matrix.
3657 
3658    Level: intermediate
3659 
3660    Concepts: matrices^transposing, matrix^symmetry
3661 
3662 .seealso: MatTranspose(), MatIsSymmetric(), MatIsHermitian(), MatIsTranspose()
3663 @*/
3664 PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianTranspose(Mat A,Mat B,PetscReal tol,PetscTruth *flg)
3665 {
3666   PetscErrorCode ierr,(*f)(Mat,Mat,PetscReal,PetscTruth*),(*g)(Mat,Mat,PetscReal,PetscTruth*);
3667 
3668   PetscFunctionBegin;
3669   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
3670   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
3671   PetscValidPointer(flg,3);
3672   ierr = PetscObjectQueryFunction((PetscObject)A,"MatIsHermitianTranspose_C",(void (**)(void))&f);CHKERRQ(ierr);
3673   ierr = PetscObjectQueryFunction((PetscObject)B,"MatIsHermitianTranspose_C",(void (**)(void))&g);CHKERRQ(ierr);
3674   if (f && g) {
3675     if (f==g) {
3676       ierr = (*f)(A,B,tol,flg);CHKERRQ(ierr);
3677     } else {
3678       SETERRQ(PETSC_ERR_ARG_NOTSAMETYPE,"Matrices do not have the same comparator for Hermitian test");
3679     }
3680   }
3681   PetscFunctionReturn(0);
3682 }
3683 
3684 #undef __FUNCT__
3685 #define __FUNCT__ "MatPermute"
3686 /*@
3687    MatPermute - Creates a new matrix with rows and columns permuted from the
3688    original.
3689 
3690    Collective on Mat
3691 
3692    Input Parameters:
3693 +  mat - the matrix to permute
3694 .  row - row permutation, each processor supplies only the permutation for its rows
3695 -  col - column permutation, each processor needs the entire column permutation, that is
3696          this is the same size as the total number of columns in the matrix
3697 
3698    Output Parameters:
3699 .  B - the permuted matrix
3700 
3701    Level: advanced
3702 
3703    Concepts: matrices^permuting
3704 
3705 .seealso: MatGetOrdering()
3706 @*/
3707 PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat mat,IS row,IS col,Mat *B)
3708 {
3709   PetscErrorCode ierr;
3710 
3711   PetscFunctionBegin;
3712   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3713   PetscValidType(mat,1);
3714   PetscValidHeaderSpecific(row,IS_COOKIE,2);
3715   PetscValidHeaderSpecific(col,IS_COOKIE,3);
3716   PetscValidPointer(B,4);
3717   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3718   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3719   if (!mat->ops->permute) SETERRQ1(PETSC_ERR_SUP,"MatPermute not available for Mat type %s",((PetscObject)mat)->type_name);
3720   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3721 
3722   ierr = (*mat->ops->permute)(mat,row,col,B);CHKERRQ(ierr);
3723   ierr = PetscObjectStateIncrease((PetscObject)*B);CHKERRQ(ierr);
3724   PetscFunctionReturn(0);
3725 }
3726 
3727 #undef __FUNCT__
3728 #define __FUNCT__ "MatPermuteSparsify"
3729 /*@
3730   MatPermuteSparsify - Creates a new matrix with rows and columns permuted from the
3731   original and sparsified to the prescribed tolerance.
3732 
3733   Collective on Mat
3734 
3735   Input Parameters:
3736 + A    - The matrix to permute
3737 . band - The half-bandwidth of the sparsified matrix, or PETSC_DECIDE
3738 . frac - The half-bandwidth as a fraction of the total size, or 0.0
3739 . tol  - The drop tolerance
3740 . rowp - The row permutation
3741 - colp - The column permutation
3742 
3743   Output Parameter:
3744 . B    - The permuted, sparsified matrix
3745 
3746   Level: advanced
3747 
3748   Note:
3749   The default behavior (band = PETSC_DECIDE and frac = 0.0) is to
3750   restrict the half-bandwidth of the resulting matrix to 5% of the
3751   total matrix size.
3752 
3753 .keywords: matrix, permute, sparsify
3754 
3755 .seealso: MatGetOrdering(), MatPermute()
3756 @*/
3757 PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat A, PetscInt band, PetscReal frac, PetscReal tol, IS rowp, IS colp, Mat *B)
3758 {
3759   IS                irowp, icolp;
3760   PetscInt          *rows, *cols;
3761   PetscInt          M, N, locRowStart, locRowEnd;
3762   PetscInt          nz, newNz;
3763   const PetscInt    *cwork;
3764   PetscInt          *cnew;
3765   const PetscScalar *vwork;
3766   PetscScalar       *vnew;
3767   PetscInt          bw, issize;
3768   PetscInt          row, locRow, newRow, col, newCol;
3769   PetscErrorCode    ierr;
3770 
3771   PetscFunctionBegin;
3772   PetscValidHeaderSpecific(A,    MAT_COOKIE,1);
3773   PetscValidHeaderSpecific(rowp, IS_COOKIE,5);
3774   PetscValidHeaderSpecific(colp, IS_COOKIE,6);
3775   PetscValidPointer(B,7);
3776   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE, "Not for unassembled matrix");
3777   if (A->factor)     SETERRQ(PETSC_ERR_ARG_WRONGSTATE, "Not for factored matrix");
3778   if (!A->ops->permutesparsify) {
3779     ierr = MatGetSize(A, &M, &N);CHKERRQ(ierr);
3780     ierr = MatGetOwnershipRange(A, &locRowStart, &locRowEnd);CHKERRQ(ierr);
3781     ierr = ISGetSize(rowp, &issize);CHKERRQ(ierr);
3782     if (issize != M) SETERRQ2(PETSC_ERR_ARG_WRONG, "Wrong size %D for row permutation, should be %D", issize, M);
3783     ierr = ISGetSize(colp, &issize);CHKERRQ(ierr);
3784     if (issize != N) SETERRQ2(PETSC_ERR_ARG_WRONG, "Wrong size %D for column permutation, should be %D", issize, N);
3785     ierr = ISInvertPermutation(rowp, 0, &irowp);CHKERRQ(ierr);
3786     ierr = ISGetIndices(irowp, &rows);CHKERRQ(ierr);
3787     ierr = ISInvertPermutation(colp, 0, &icolp);CHKERRQ(ierr);
3788     ierr = ISGetIndices(icolp, &cols);CHKERRQ(ierr);
3789     ierr = PetscMalloc(N * sizeof(PetscInt),         &cnew);CHKERRQ(ierr);
3790     ierr = PetscMalloc(N * sizeof(PetscScalar), &vnew);CHKERRQ(ierr);
3791 
3792     /* Setup bandwidth to include */
3793     if (band == PETSC_DECIDE) {
3794       if (frac <= 0.0)
3795         bw = (PetscInt) (M * 0.05);
3796       else
3797         bw = (PetscInt) (M * frac);
3798     } else {
3799       if (band <= 0) SETERRQ(PETSC_ERR_ARG_WRONG, "Bandwidth must be a positive integer");
3800       bw = band;
3801     }
3802 
3803     /* Put values into new matrix */
3804     ierr = MatDuplicate(A, MAT_DO_NOT_COPY_VALUES, B);CHKERRQ(ierr);
3805     for(row = locRowStart, locRow = 0; row < locRowEnd; row++, locRow++) {
3806       ierr = MatGetRow(A, row, &nz, &cwork, &vwork);CHKERRQ(ierr);
3807       newRow   = rows[locRow]+locRowStart;
3808       for(col = 0, newNz = 0; col < nz; col++) {
3809         newCol = cols[cwork[col]];
3810         if ((newCol >= newRow - bw) && (newCol < newRow + bw) && (PetscAbsScalar(vwork[col]) >= tol)) {
3811           cnew[newNz] = newCol;
3812           vnew[newNz] = vwork[col];
3813           newNz++;
3814         }
3815       }
3816       ierr = MatSetValues(*B, 1, &newRow, newNz, cnew, vnew, INSERT_VALUES);CHKERRQ(ierr);
3817       ierr = MatRestoreRow(A, row, &nz, &cwork, &vwork);CHKERRQ(ierr);
3818     }
3819     ierr = PetscFree(cnew);CHKERRQ(ierr);
3820     ierr = PetscFree(vnew);CHKERRQ(ierr);
3821     ierr = MatAssemblyBegin(*B, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
3822     ierr = MatAssemblyEnd(*B, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
3823     ierr = ISRestoreIndices(irowp, &rows);CHKERRQ(ierr);
3824     ierr = ISRestoreIndices(icolp, &cols);CHKERRQ(ierr);
3825     ierr = ISDestroy(irowp);CHKERRQ(ierr);
3826     ierr = ISDestroy(icolp);CHKERRQ(ierr);
3827   } else {
3828     ierr = (*A->ops->permutesparsify)(A, band, frac, tol, rowp, colp, B);CHKERRQ(ierr);
3829   }
3830   ierr = PetscObjectStateIncrease((PetscObject)*B);CHKERRQ(ierr);
3831   PetscFunctionReturn(0);
3832 }
3833 
3834 #undef __FUNCT__
3835 #define __FUNCT__ "MatEqual"
3836 /*@
3837    MatEqual - Compares two matrices.
3838 
3839    Collective on Mat
3840 
3841    Input Parameters:
3842 +  A - the first matrix
3843 -  B - the second matrix
3844 
3845    Output Parameter:
3846 .  flg - PETSC_TRUE if the matrices are equal; PETSC_FALSE otherwise.
3847 
3848    Level: intermediate
3849 
3850    Concepts: matrices^equality between
3851 @*/
3852 PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat A,Mat B,PetscTruth *flg)
3853 {
3854   PetscErrorCode ierr;
3855 
3856   PetscFunctionBegin;
3857   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
3858   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
3859   PetscValidType(A,1);
3860   PetscValidType(B,2);
3861   MatPreallocated(B);
3862   PetscValidIntPointer(flg,3);
3863   PetscCheckSameComm(A,1,B,2);
3864   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3865   if (!B->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3866   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);
3867   if (!A->ops->equal) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)A)->type_name);
3868   if (!B->ops->equal) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)B)->type_name);
3869   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);
3870   ierr = MatPreallocated(A);CHKERRQ(ierr);
3871 
3872   ierr = (*A->ops->equal)(A,B,flg);CHKERRQ(ierr);
3873   PetscFunctionReturn(0);
3874 }
3875 
3876 #undef __FUNCT__
3877 #define __FUNCT__ "MatDiagonalScale"
3878 /*@
3879    MatDiagonalScale - Scales a matrix on the left and right by diagonal
3880    matrices that are stored as vectors.  Either of the two scaling
3881    matrices can be PETSC_NULL.
3882 
3883    Collective on Mat
3884 
3885    Input Parameters:
3886 +  mat - the matrix to be scaled
3887 .  l - the left scaling vector (or PETSC_NULL)
3888 -  r - the right scaling vector (or PETSC_NULL)
3889 
3890    Notes:
3891    MatDiagonalScale() computes A = LAR, where
3892    L = a diagonal matrix (stored as a vector), R = a diagonal matrix (stored as a vector)
3893 
3894    Level: intermediate
3895 
3896    Concepts: matrices^diagonal scaling
3897    Concepts: diagonal scaling of matrices
3898 
3899 .seealso: MatScale()
3900 @*/
3901 PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat mat,Vec l,Vec r)
3902 {
3903   PetscErrorCode ierr;
3904 
3905   PetscFunctionBegin;
3906   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3907   PetscValidType(mat,1);
3908   if (!mat->ops->diagonalscale) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3909   if (l) {PetscValidHeaderSpecific(l,VEC_COOKIE,2);PetscCheckSameComm(mat,1,l,2);}
3910   if (r) {PetscValidHeaderSpecific(r,VEC_COOKIE,3);PetscCheckSameComm(mat,1,r,3);}
3911   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3912   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3913   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3914 
3915   ierr = PetscLogEventBegin(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
3916   ierr = (*mat->ops->diagonalscale)(mat,l,r);CHKERRQ(ierr);
3917   ierr = PetscLogEventEnd(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
3918   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
3919   PetscFunctionReturn(0);
3920 }
3921 
3922 #undef __FUNCT__
3923 #define __FUNCT__ "MatScale"
3924 /*@
3925     MatScale - Scales all elements of a matrix by a given number.
3926 
3927     Collective on Mat
3928 
3929     Input Parameters:
3930 +   mat - the matrix to be scaled
3931 -   a  - the scaling value
3932 
3933     Output Parameter:
3934 .   mat - the scaled matrix
3935 
3936     Level: intermediate
3937 
3938     Concepts: matrices^scaling all entries
3939 
3940 .seealso: MatDiagonalScale()
3941 @*/
3942 PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat mat,PetscScalar a)
3943 {
3944   PetscErrorCode ierr;
3945 
3946   PetscFunctionBegin;
3947   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3948   PetscValidType(mat,1);
3949   if (!mat->ops->scale) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3950   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3951   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3952   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3953 
3954   ierr = PetscLogEventBegin(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
3955   ierr = (*mat->ops->scale)(mat,a);CHKERRQ(ierr);
3956   ierr = PetscLogEventEnd(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
3957   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
3958   PetscFunctionReturn(0);
3959 }
3960 
3961 #undef __FUNCT__
3962 #define __FUNCT__ "MatNorm"
3963 /*@
3964    MatNorm - Calculates various norms of a matrix.
3965 
3966    Collective on Mat
3967 
3968    Input Parameters:
3969 +  mat - the matrix
3970 -  type - the type of norm, NORM_1, NORM_FROBENIUS, NORM_INFINITY
3971 
3972    Output Parameters:
3973 .  nrm - the resulting norm
3974 
3975    Level: intermediate
3976 
3977    Concepts: matrices^norm
3978    Concepts: norm^of matrix
3979 @*/
3980 PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat mat,NormType type,PetscReal *nrm)
3981 {
3982   PetscErrorCode ierr;
3983 
3984   PetscFunctionBegin;
3985   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
3986   PetscValidType(mat,1);
3987   PetscValidScalarPointer(nrm,3);
3988 
3989   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
3990   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
3991   if (!mat->ops->norm) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
3992   ierr = MatPreallocated(mat);CHKERRQ(ierr);
3993 
3994   ierr = (*mat->ops->norm)(mat,type,nrm);CHKERRQ(ierr);
3995   PetscFunctionReturn(0);
3996 }
3997 
3998 /*
3999      This variable is used to prevent counting of MatAssemblyBegin() that
4000    are called from within a MatAssemblyEnd().
4001 */
4002 static PetscInt MatAssemblyEnd_InUse = 0;
4003 #undef __FUNCT__
4004 #define __FUNCT__ "MatAssemblyBegin"
4005 /*@
4006    MatAssemblyBegin - Begins assembling the matrix.  This routine should
4007    be called after completing all calls to MatSetValues().
4008 
4009    Collective on Mat
4010 
4011    Input Parameters:
4012 +  mat - the matrix
4013 -  type - type of assembly, either MAT_FLUSH_ASSEMBLY or MAT_FINAL_ASSEMBLY
4014 
4015    Notes:
4016    MatSetValues() generally caches the values.  The matrix is ready to
4017    use only after MatAssemblyBegin() and MatAssemblyEnd() have been called.
4018    Use MAT_FLUSH_ASSEMBLY when switching between ADD_VALUES and INSERT_VALUES
4019    in MatSetValues(); use MAT_FINAL_ASSEMBLY for the final assembly before
4020    using the matrix.
4021 
4022    Level: beginner
4023 
4024    Concepts: matrices^assembling
4025 
4026 .seealso: MatAssemblyEnd(), MatSetValues(), MatAssembled()
4027 @*/
4028 PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat mat,MatAssemblyType type)
4029 {
4030   PetscErrorCode ierr;
4031 
4032   PetscFunctionBegin;
4033   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4034   PetscValidType(mat,1);
4035   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4036   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix.\nDid you forget to call MatSetUnfactored()?");
4037   if (mat->assembled) {
4038     mat->was_assembled = PETSC_TRUE;
4039     mat->assembled     = PETSC_FALSE;
4040   }
4041   if (!MatAssemblyEnd_InUse) {
4042     ierr = PetscLogEventBegin(MAT_AssemblyBegin,mat,0,0,0);CHKERRQ(ierr);
4043     if (mat->ops->assemblybegin){ierr = (*mat->ops->assemblybegin)(mat,type);CHKERRQ(ierr);}
4044     ierr = PetscLogEventEnd(MAT_AssemblyBegin,mat,0,0,0);CHKERRQ(ierr);
4045   } else {
4046     if (mat->ops->assemblybegin){ierr = (*mat->ops->assemblybegin)(mat,type);CHKERRQ(ierr);}
4047   }
4048   PetscFunctionReturn(0);
4049 }
4050 
4051 #undef __FUNCT__
4052 #define __FUNCT__ "MatAssembed"
4053 /*@
4054    MatAssembled - Indicates if a matrix has been assembled and is ready for
4055      use; for example, in matrix-vector product.
4056 
4057    Collective on Mat
4058 
4059    Input Parameter:
4060 .  mat - the matrix
4061 
4062    Output Parameter:
4063 .  assembled - PETSC_TRUE or PETSC_FALSE
4064 
4065    Level: advanced
4066 
4067    Concepts: matrices^assembled?
4068 
4069 .seealso: MatAssemblyEnd(), MatSetValues(), MatAssemblyBegin()
4070 @*/
4071 PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat mat,PetscTruth *assembled)
4072 {
4073   PetscFunctionBegin;
4074   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4075   PetscValidType(mat,1);
4076   PetscValidPointer(assembled,2);
4077   *assembled = mat->assembled;
4078   PetscFunctionReturn(0);
4079 }
4080 
4081 #undef __FUNCT__
4082 #define __FUNCT__ "MatView_Private"
4083 /*
4084     Processes command line options to determine if/how a matrix
4085   is to be viewed. Called by MatAssemblyEnd() and MatLoad().
4086 */
4087 PetscErrorCode MatView_Private(Mat mat)
4088 {
4089   PetscErrorCode    ierr;
4090   PetscTruth        flg1,flg2,flg3,flg4,flg6,flg7,flg8;
4091   static PetscTruth incall = PETSC_FALSE;
4092 #if defined(PETSC_USE_SOCKET_VIEWER)
4093   PetscTruth        flg5;
4094 #endif
4095 
4096   PetscFunctionBegin;
4097   if (incall) PetscFunctionReturn(0);
4098   incall = PETSC_TRUE;
4099   ierr = PetscOptionsBegin(((PetscObject)mat)->comm,((PetscObject)mat)->prefix,"Matrix Options","Mat");CHKERRQ(ierr);
4100     ierr = PetscOptionsName("-mat_view_info","Information on matrix size","MatView",&flg1);CHKERRQ(ierr);
4101     ierr = PetscOptionsName("-mat_view_info_detailed","Nonzeros in the matrix","MatView",&flg2);CHKERRQ(ierr);
4102     ierr = PetscOptionsName("-mat_view","Print matrix to stdout","MatView",&flg3);CHKERRQ(ierr);
4103     ierr = PetscOptionsName("-mat_view_matlab","Print matrix to stdout in a format Matlab can read","MatView",&flg4);CHKERRQ(ierr);
4104 #if defined(PETSC_USE_SOCKET_VIEWER)
4105     ierr = PetscOptionsName("-mat_view_socket","Send matrix to socket (can be read from matlab)","MatView",&flg5);CHKERRQ(ierr);
4106 #endif
4107     ierr = PetscOptionsName("-mat_view_binary","Save matrix to file in binary format","MatView",&flg6);CHKERRQ(ierr);
4108     ierr = PetscOptionsName("-mat_view_draw","Draw the matrix nonzero structure","MatView",&flg7);CHKERRQ(ierr);
4109   ierr = PetscOptionsEnd();CHKERRQ(ierr);
4110 
4111   if (flg1) {
4112     PetscViewer viewer;
4113 
4114     ierr = PetscViewerASCIIGetStdout(((PetscObject)mat)->comm,&viewer);CHKERRQ(ierr);
4115     ierr = PetscViewerPushFormat(viewer,PETSC_VIEWER_ASCII_INFO);CHKERRQ(ierr);
4116     ierr = MatView(mat,viewer);CHKERRQ(ierr);
4117     ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
4118   }
4119   if (flg2) {
4120     PetscViewer viewer;
4121 
4122     ierr = PetscViewerASCIIGetStdout(((PetscObject)mat)->comm,&viewer);CHKERRQ(ierr);
4123     ierr = PetscViewerPushFormat(viewer,PETSC_VIEWER_ASCII_INFO_DETAIL);CHKERRQ(ierr);
4124     ierr = MatView(mat,viewer);CHKERRQ(ierr);
4125     ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
4126   }
4127   if (flg3) {
4128     PetscViewer viewer;
4129 
4130     ierr = PetscViewerASCIIGetStdout(((PetscObject)mat)->comm,&viewer);CHKERRQ(ierr);
4131     ierr = MatView(mat,viewer);CHKERRQ(ierr);
4132   }
4133   if (flg4) {
4134     PetscViewer viewer;
4135 
4136     ierr = PetscViewerASCIIGetStdout(((PetscObject)mat)->comm,&viewer);CHKERRQ(ierr);
4137     ierr = PetscViewerPushFormat(viewer,PETSC_VIEWER_ASCII_MATLAB);CHKERRQ(ierr);
4138     ierr = MatView(mat,viewer);CHKERRQ(ierr);
4139     ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
4140   }
4141 #if defined(PETSC_USE_SOCKET_VIEWER)
4142   if (flg5) {
4143     ierr = MatView(mat,PETSC_VIEWER_SOCKET_(((PetscObject)mat)->comm));CHKERRQ(ierr);
4144     ierr = PetscViewerFlush(PETSC_VIEWER_SOCKET_(((PetscObject)mat)->comm));CHKERRQ(ierr);
4145   }
4146 #endif
4147   if (flg6) {
4148     ierr = MatView(mat,PETSC_VIEWER_BINARY_(((PetscObject)mat)->comm));CHKERRQ(ierr);
4149     ierr = PetscViewerFlush(PETSC_VIEWER_BINARY_(((PetscObject)mat)->comm));CHKERRQ(ierr);
4150   }
4151   if (flg7) {
4152     ierr = PetscOptionsHasName(((PetscObject)mat)->prefix,"-mat_view_contour",&flg8);CHKERRQ(ierr);
4153     if (flg8) {
4154       PetscViewerPushFormat(PETSC_VIEWER_DRAW_(((PetscObject)mat)->comm),PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);
4155     }
4156     ierr = MatView(mat,PETSC_VIEWER_DRAW_(((PetscObject)mat)->comm));CHKERRQ(ierr);
4157     ierr = PetscViewerFlush(PETSC_VIEWER_DRAW_(((PetscObject)mat)->comm));CHKERRQ(ierr);
4158     if (flg8) {
4159       PetscViewerPopFormat(PETSC_VIEWER_DRAW_(((PetscObject)mat)->comm));CHKERRQ(ierr);
4160     }
4161   }
4162   incall = PETSC_FALSE;
4163   PetscFunctionReturn(0);
4164 }
4165 
4166 #undef __FUNCT__
4167 #define __FUNCT__ "MatAssemblyEnd"
4168 /*@
4169    MatAssemblyEnd - Completes assembling the matrix.  This routine should
4170    be called after MatAssemblyBegin().
4171 
4172    Collective on Mat
4173 
4174    Input Parameters:
4175 +  mat - the matrix
4176 -  type - type of assembly, either MAT_FLUSH_ASSEMBLY or MAT_FINAL_ASSEMBLY
4177 
4178    Options Database Keys:
4179 +  -mat_view_info - Prints info on matrix at conclusion of MatEndAssembly()
4180 .  -mat_view_info_detailed - Prints more detailed info
4181 .  -mat_view - Prints matrix in ASCII format
4182 .  -mat_view_matlab - Prints matrix in Matlab format
4183 .  -mat_view_draw - PetscDraws nonzero structure of matrix, using MatView() and PetscDrawOpenX().
4184 .  -display <name> - Sets display name (default is host)
4185 .  -draw_pause <sec> - Sets number of seconds to pause after display
4186 .  -mat_view_socket - Sends matrix to socket, can be accessed from Matlab (see users manual)
4187 .  -viewer_socket_machine <machine>
4188 .  -viewer_socket_port <port>
4189 .  -mat_view_binary - save matrix to file in binary format
4190 -  -viewer_binary_filename <name>
4191 
4192    Notes:
4193    MatSetValues() generally caches the values.  The matrix is ready to
4194    use only after MatAssemblyBegin() and MatAssemblyEnd() have been called.
4195    Use MAT_FLUSH_ASSEMBLY when switching between ADD_VALUES and INSERT_VALUES
4196    in MatSetValues(); use MAT_FINAL_ASSEMBLY for the final assembly before
4197    using the matrix.
4198 
4199    Level: beginner
4200 
4201 .seealso: MatAssemblyBegin(), MatSetValues(), PetscDrawOpenX(), MatView(), MatAssembled(), PetscViewerSocketOpen()
4202 @*/
4203 PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat mat,MatAssemblyType type)
4204 {
4205   PetscErrorCode  ierr;
4206   static PetscInt inassm = 0;
4207   PetscTruth      flg;
4208 
4209   PetscFunctionBegin;
4210   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4211   PetscValidType(mat,1);
4212 
4213   inassm++;
4214   MatAssemblyEnd_InUse++;
4215   if (MatAssemblyEnd_InUse == 1) { /* Do the logging only the first time through */
4216     ierr = PetscLogEventBegin(MAT_AssemblyEnd,mat,0,0,0);CHKERRQ(ierr);
4217     if (mat->ops->assemblyend) {
4218       ierr = (*mat->ops->assemblyend)(mat,type);CHKERRQ(ierr);
4219     }
4220     ierr = PetscLogEventEnd(MAT_AssemblyEnd,mat,0,0,0);CHKERRQ(ierr);
4221   } else {
4222     if (mat->ops->assemblyend) {
4223       ierr = (*mat->ops->assemblyend)(mat,type);CHKERRQ(ierr);
4224     }
4225   }
4226 
4227   /* Flush assembly is not a true assembly */
4228   if (type != MAT_FLUSH_ASSEMBLY) {
4229     mat->assembled  = PETSC_TRUE; mat->num_ass++;
4230   }
4231   mat->insertmode = NOT_SET_VALUES;
4232   MatAssemblyEnd_InUse--;
4233   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
4234   if (!mat->symmetric_eternal) {
4235     mat->symmetric_set              = PETSC_FALSE;
4236     mat->hermitian_set              = PETSC_FALSE;
4237     mat->structurally_symmetric_set = PETSC_FALSE;
4238   }
4239   if (inassm == 1 && type != MAT_FLUSH_ASSEMBLY) {
4240     ierr = MatView_Private(mat);CHKERRQ(ierr);
4241     ierr = PetscOptionsHasName(((PetscObject)mat)->prefix,"-mat_is_symmetric",&flg);CHKERRQ(ierr);
4242     if (flg) {
4243       PetscReal tol = 0.0;
4244       ierr = PetscOptionsGetReal(((PetscObject)mat)->prefix,"-mat_is_symmetric",&tol,PETSC_NULL);CHKERRQ(ierr);
4245       ierr = MatIsSymmetric(mat,tol,&flg);CHKERRQ(ierr);
4246       if (flg) {
4247         ierr = PetscPrintf(((PetscObject)mat)->comm,"Matrix is symmetric (tolerance %G)\n",tol);CHKERRQ(ierr);
4248       } else {
4249         ierr = PetscPrintf(((PetscObject)mat)->comm,"Matrix is not symmetric (tolerance %G)\n",tol);CHKERRQ(ierr);
4250       }
4251     }
4252   }
4253   inassm--;
4254   PetscFunctionReturn(0);
4255 }
4256 
4257 
4258 #undef __FUNCT__
4259 #define __FUNCT__ "MatCompress"
4260 /*@
4261    MatCompress - Tries to store the matrix in as little space as
4262    possible.  May fail if memory is already fully used, since it
4263    tries to allocate new space.
4264 
4265    Collective on Mat
4266 
4267    Input Parameters:
4268 .  mat - the matrix
4269 
4270    Level: advanced
4271 
4272 @*/
4273 PetscErrorCode PETSCMAT_DLLEXPORT MatCompress(Mat mat)
4274 {
4275   PetscErrorCode ierr;
4276 
4277   PetscFunctionBegin;
4278   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4279   PetscValidType(mat,1);
4280   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4281   if (mat->ops->compress) {ierr = (*mat->ops->compress)(mat);CHKERRQ(ierr);}
4282   PetscFunctionReturn(0);
4283 }
4284 
4285 #undef __FUNCT__
4286 #define __FUNCT__ "MatSetOption"
4287 /*@
4288    MatSetOption - Sets a parameter option for a matrix. Some options
4289    may be specific to certain storage formats.  Some options
4290    determine how values will be inserted (or added). Sorted,
4291    row-oriented input will generally assemble the fastest. The default
4292    is row-oriented, nonsorted input.
4293 
4294    Collective on Mat
4295 
4296    Input Parameters:
4297 +  mat - the matrix
4298 .  option - the option, one of those listed below (and possibly others),
4299 -  flg - turn the option on (PETSC_TRUE) or off (PETSC_FALSE)
4300 
4301   Options Describing Matrix Structure:
4302 +    MAT_SYMMETRIC - symmetric in terms of both structure and value
4303 .    MAT_HERMITIAN - transpose is the complex conjugation
4304 .    MAT_STRUCTURALLY_SYMMETRIC - symmetric nonzero structure
4305 -    MAT_SYMMETRY_ETERNAL - if you would like the symmetry/Hermitian flag
4306                             you set to be kept with all future use of the matrix
4307                             including after MatAssemblyBegin/End() which could
4308                             potentially change the symmetry structure, i.e. you
4309                             KNOW the matrix will ALWAYS have the property you set.
4310 
4311 
4312    Options For Use with MatSetValues():
4313    Insert a logically dense subblock, which can be
4314 .    MAT_ROW_ORIENTED - row-oriented (default)
4315 
4316    Note these options reflect the data you pass in with MatSetValues(); it has
4317    nothing to do with how the data is stored internally in the matrix
4318    data structure.
4319 
4320    When (re)assembling a matrix, we can restrict the input for
4321    efficiency/debugging purposes.  These options include
4322 +    MAT_NEW_NONZERO_LOCATIONS - additional insertions will be
4323         allowed if they generate a new nonzero
4324 .    MAT_NEW_DIAGONALS - new diagonals will be allowed (for block diagonal format only)
4325 .    MAT_IGNORE_OFF_PROC_ENTRIES - drops off-processor entries
4326 .    MAT_NEW_NONZERO_LOCATION_ERR - generates an error for new matrix entry
4327 -    MAT_USE_HASH_TABLE - uses a hash table to speed up matrix assembly
4328 
4329    Notes:
4330    Some options are relevant only for particular matrix types and
4331    are thus ignored by others.  Other options are not supported by
4332    certain matrix types and will generate an error message if set.
4333 
4334    If using a Fortran 77 module to compute a matrix, one may need to
4335    use the column-oriented option (or convert to the row-oriented
4336    format).
4337 
4338    MAT_NEW_NONZERO_LOCATIONS set to PETSC_FALSE indicates that any add or insertion
4339    that would generate a new entry in the nonzero structure is instead
4340    ignored.  Thus, if memory has not alredy been allocated for this particular
4341    data, then the insertion is ignored. For dense matrices, in which
4342    the entire array is allocated, no entries are ever ignored.
4343    Set after the first MatAssemblyEnd()
4344 
4345    MAT_NEW_NONZERO_LOCATION_ERR indicates that any add or insertion
4346    that would generate a new entry in the nonzero structure instead produces
4347    an error. (Currently supported for AIJ and BAIJ formats only.)
4348    This is a useful flag when using SAME_NONZERO_PATTERN in calling
4349    KSPSetOperators() to ensure that the nonzero pattern truely does
4350    remain unchanged. Set after the first MatAssemblyEnd()
4351 
4352    MAT_NEW_NONZERO_ALLOCATION_ERR indicates that any add or insertion
4353    that would generate a new entry that has not been preallocated will
4354    instead produce an error. (Currently supported for AIJ and BAIJ formats
4355    only.) This is a useful flag when debugging matrix memory preallocation.
4356 
4357    MAT_IGNORE_OFF_PROC_ENTRIES indicates entries destined for
4358    other processors should be dropped, rather than stashed.
4359    This is useful if you know that the "owning" processor is also
4360    always generating the correct matrix entries, so that PETSc need
4361    not transfer duplicate entries generated on another processor.
4362 
4363    MAT_USE_HASH_TABLE indicates that a hash table be used to improve the
4364    searches during matrix assembly. When this flag is set, the hash table
4365    is created during the first Matrix Assembly. This hash table is
4366    used the next time through, during MatSetVaules()/MatSetVaulesBlocked()
4367    to improve the searching of indices. MAT_NEW_NONZERO_LOCATIONS flag
4368    should be used with MAT_USE_HASH_TABLE flag. This option is currently
4369    supported by MATMPIBAIJ format only.
4370 
4371    MAT_KEEP_ZEROED_ROWS indicates when MatZeroRows() is called the zeroed entries
4372    are kept in the nonzero structure
4373 
4374    MAT_IGNORE_ZERO_ENTRIES - for AIJ/IS matrices this will stop zero values from creating
4375    a zero location in the matrix
4376 
4377    MAT_USE_INODES - indicates using inode version of the code - works with AIJ and
4378    ROWBS matrix types
4379 
4380    Level: intermediate
4381 
4382    Concepts: matrices^setting options
4383 
4384 @*/
4385 PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat mat,MatOption op,PetscTruth flg)
4386 {
4387   PetscErrorCode ierr;
4388 
4389   PetscFunctionBegin;
4390   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4391   PetscValidType(mat,1);
4392   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4393   switch (op) {
4394   case MAT_SYMMETRIC:
4395     mat->symmetric                  = flg;
4396     if (flg) mat->structurally_symmetric     = PETSC_TRUE;
4397     mat->symmetric_set              = PETSC_TRUE;
4398     mat->structurally_symmetric_set = flg;
4399     break;
4400   case MAT_HERMITIAN:
4401     mat->hermitian                  = flg;
4402     if (flg) mat->structurally_symmetric     = PETSC_TRUE;
4403     mat->hermitian_set              = PETSC_TRUE;
4404     mat->structurally_symmetric_set = flg;
4405     break;
4406   case MAT_STRUCTURALLY_SYMMETRIC:
4407     mat->structurally_symmetric     = flg;
4408     mat->structurally_symmetric_set = PETSC_TRUE;
4409     break;
4410   case MAT_SYMMETRY_ETERNAL:
4411     mat->symmetric_eternal          = flg;
4412     break;
4413   default:
4414     break;
4415   }
4416   if (mat->ops->setoption) {
4417     ierr = (*mat->ops->setoption)(mat,op,flg);CHKERRQ(ierr);
4418   }
4419   PetscFunctionReturn(0);
4420 }
4421 
4422 #undef __FUNCT__
4423 #define __FUNCT__ "MatZeroEntries"
4424 /*@
4425    MatZeroEntries - Zeros all entries of a matrix.  For sparse matrices
4426    this routine retains the old nonzero structure.
4427 
4428    Collective on Mat
4429 
4430    Input Parameters:
4431 .  mat - the matrix
4432 
4433    Level: intermediate
4434 
4435    Concepts: matrices^zeroing
4436 
4437 .seealso: MatZeroRows()
4438 @*/
4439 PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat mat)
4440 {
4441   PetscErrorCode ierr;
4442 
4443   PetscFunctionBegin;
4444   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4445   PetscValidType(mat,1);
4446   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4447   if (mat->insertmode != NOT_SET_VALUES) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for matrices where you have set values but not yet assembled");
4448   if (!mat->ops->zeroentries) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4449   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4450 
4451   ierr = PetscLogEventBegin(MAT_ZeroEntries,mat,0,0,0);CHKERRQ(ierr);
4452   ierr = (*mat->ops->zeroentries)(mat);CHKERRQ(ierr);
4453   ierr = PetscLogEventEnd(MAT_ZeroEntries,mat,0,0,0);CHKERRQ(ierr);
4454   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
4455   PetscFunctionReturn(0);
4456 }
4457 
4458 #undef __FUNCT__
4459 #define __FUNCT__ "MatZeroRows"
4460 /*@C
4461    MatZeroRows - Zeros all entries (except possibly the main diagonal)
4462    of a set of rows of a matrix.
4463 
4464    Collective on Mat
4465 
4466    Input Parameters:
4467 +  mat - the matrix
4468 .  numRows - the number of rows to remove
4469 .  rows - the global row indices
4470 -  diag - value put in all diagonals of eliminated rows
4471 
4472    Notes:
4473    For the AIJ and BAIJ matrix formats this removes the old nonzero structure,
4474    but does not release memory.  For the dense and block diagonal
4475    formats this does not alter the nonzero structure.
4476 
4477    If the option MatSetOption(mat,MAT_KEEP_ZEROED_ROWS,PETSC_TRUE) the nonzero structure
4478    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
4479    merely zeroed.
4480 
4481    The user can set a value in the diagonal entry (or for the AIJ and
4482    row formats can optionally remove the main diagonal entry from the
4483    nonzero structure as well, by passing 0.0 as the final argument).
4484 
4485    For the parallel case, all processes that share the matrix (i.e.,
4486    those in the communicator used for matrix creation) MUST call this
4487    routine, regardless of whether any rows being zeroed are owned by
4488    them.
4489 
4490    Each processor should list the rows that IT wants zeroed
4491 
4492    Level: intermediate
4493 
4494    Concepts: matrices^zeroing rows
4495 
4496 .seealso: MatZeroRowsIS(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption()
4497 @*/
4498 PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag)
4499 {
4500   PetscErrorCode ierr;
4501 
4502   PetscFunctionBegin;
4503   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4504   PetscValidType(mat,1);
4505   if (numRows) PetscValidIntPointer(rows,3);
4506   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4507   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4508   if (!mat->ops->zerorows) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
4509   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4510 
4511   ierr = (*mat->ops->zerorows)(mat,numRows,rows,diag);CHKERRQ(ierr);
4512   ierr = MatView_Private(mat);CHKERRQ(ierr);
4513   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
4514   PetscFunctionReturn(0);
4515 }
4516 
4517 #undef __FUNCT__
4518 #define __FUNCT__ "MatZeroRowsIS"
4519 /*@C
4520    MatZeroRowsIS - Zeros all entries (except possibly the main diagonal)
4521    of a set of rows of a matrix.
4522 
4523    Collective on Mat
4524 
4525    Input Parameters:
4526 +  mat - the matrix
4527 .  is - index set of rows to remove
4528 -  diag - value put in all diagonals of eliminated rows
4529 
4530    Notes:
4531    For the AIJ and BAIJ matrix formats this removes the old nonzero structure,
4532    but does not release memory.  For the dense and block diagonal
4533    formats this does not alter the nonzero structure.
4534 
4535    If the option MatSetOption(mat,MAT_KEEP_ZEROED_ROWS,PETSC_TRUE) the nonzero structure
4536    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
4537    merely zeroed.
4538 
4539    The user can set a value in the diagonal entry (or for the AIJ and
4540    row formats can optionally remove the main diagonal entry from the
4541    nonzero structure as well, by passing 0.0 as the final argument).
4542 
4543    For the parallel case, all processes that share the matrix (i.e.,
4544    those in the communicator used for matrix creation) MUST call this
4545    routine, regardless of whether any rows being zeroed are owned by
4546    them.
4547 
4548    Each processor should list the rows that IT wants zeroed
4549 
4550    Level: intermediate
4551 
4552    Concepts: matrices^zeroing rows
4553 
4554 .seealso: MatZeroRows(), MatZeroEntries(), MatZeroRowsLocal(), MatSetOption()
4555 @*/
4556 PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat mat,IS is,PetscScalar diag)
4557 {
4558   PetscInt       numRows;
4559   PetscInt       *rows;
4560   PetscErrorCode ierr;
4561 
4562   PetscFunctionBegin;
4563   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4564   PetscValidType(mat,1);
4565   PetscValidHeaderSpecific(is,IS_COOKIE,2);
4566   ierr = ISGetLocalSize(is,&numRows);CHKERRQ(ierr);
4567   ierr = ISGetIndices(is,&rows);CHKERRQ(ierr);
4568   ierr = MatZeroRows(mat,numRows,rows,diag);CHKERRQ(ierr);
4569   ierr = ISRestoreIndices(is,&rows);CHKERRQ(ierr);
4570   PetscFunctionReturn(0);
4571 }
4572 
4573 #undef __FUNCT__
4574 #define __FUNCT__ "MatZeroRowsLocal"
4575 /*@C
4576    MatZeroRowsLocal - Zeros all entries (except possibly the main diagonal)
4577    of a set of rows of a matrix; using local numbering of rows.
4578 
4579    Collective on Mat
4580 
4581    Input Parameters:
4582 +  mat - the matrix
4583 .  numRows - the number of rows to remove
4584 .  rows - the global row indices
4585 -  diag - value put in all diagonals of eliminated rows
4586 
4587    Notes:
4588    Before calling MatZeroRowsLocal(), the user must first set the
4589    local-to-global mapping by calling MatSetLocalToGlobalMapping().
4590 
4591    For the AIJ matrix formats this removes the old nonzero structure,
4592    but does not release memory.  For the dense and block diagonal
4593    formats this does not alter the nonzero structure.
4594 
4595    If the option MatSetOption(mat,MAT_KEEP_ZEROED_ROWS,PETSC_TRUE) the nonzero structure
4596    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
4597    merely zeroed.
4598 
4599    The user can set a value in the diagonal entry (or for the AIJ and
4600    row formats can optionally remove the main diagonal entry from the
4601    nonzero structure as well, by passing 0.0 as the final argument).
4602 
4603    Level: intermediate
4604 
4605    Concepts: matrices^zeroing
4606 
4607 .seealso: MatZeroRows(), MatZeroRowsLocalIS(), MatZeroEntries(), MatZeroRows(), MatSetLocalToGlobalMapping
4608 @*/
4609 PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag)
4610 {
4611   PetscErrorCode ierr;
4612 
4613   PetscFunctionBegin;
4614   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4615   PetscValidType(mat,1);
4616   if (numRows) PetscValidIntPointer(rows,3);
4617   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4618   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4619   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4620 
4621   if (mat->ops->zerorowslocal) {
4622     ierr = (*mat->ops->zerorowslocal)(mat,numRows,rows,diag);CHKERRQ(ierr);
4623   } else {
4624     IS is, newis;
4625     PetscInt *newRows;
4626 
4627     if (!mat->mapping) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Need to provide local to global mapping to matrix first");
4628     ierr = ISCreateGeneral(PETSC_COMM_SELF,numRows,rows,&is);CHKERRQ(ierr);
4629     ierr = ISLocalToGlobalMappingApplyIS(mat->mapping,is,&newis);CHKERRQ(ierr);
4630     ierr = ISGetIndices(newis,&newRows);CHKERRQ(ierr);
4631     ierr = (*mat->ops->zerorows)(mat,numRows,newRows,diag);CHKERRQ(ierr);
4632     ierr = ISRestoreIndices(newis,&newRows);CHKERRQ(ierr);
4633     ierr = ISDestroy(newis);CHKERRQ(ierr);
4634     ierr = ISDestroy(is);CHKERRQ(ierr);
4635   }
4636   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
4637   PetscFunctionReturn(0);
4638 }
4639 
4640 #undef __FUNCT__
4641 #define __FUNCT__ "MatZeroRowsLocalIS"
4642 /*@C
4643    MatZeroRowsLocalIS - Zeros all entries (except possibly the main diagonal)
4644    of a set of rows of a matrix; using local numbering of rows.
4645 
4646    Collective on Mat
4647 
4648    Input Parameters:
4649 +  mat - the matrix
4650 .  is - index set of rows to remove
4651 -  diag - value put in all diagonals of eliminated rows
4652 
4653    Notes:
4654    Before calling MatZeroRowsLocalIS(), the user must first set the
4655    local-to-global mapping by calling MatSetLocalToGlobalMapping().
4656 
4657    For the AIJ matrix formats this removes the old nonzero structure,
4658    but does not release memory.  For the dense and block diagonal
4659    formats this does not alter the nonzero structure.
4660 
4661    If the option MatSetOption(mat,MAT_KEEP_ZEROED_ROWS,PETSC_TRUE) the nonzero structure
4662    of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
4663    merely zeroed.
4664 
4665    The user can set a value in the diagonal entry (or for the AIJ and
4666    row formats can optionally remove the main diagonal entry from the
4667    nonzero structure as well, by passing 0.0 as the final argument).
4668 
4669    Level: intermediate
4670 
4671    Concepts: matrices^zeroing
4672 
4673 .seealso: MatZeroRows(), MatZeroRowsLocal(), MatZeroEntries(), MatZeroRows(), MatSetLocalToGlobalMapping
4674 @*/
4675 PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat mat,IS is,PetscScalar diag)
4676 {
4677   PetscErrorCode ierr;
4678   PetscInt       numRows;
4679   PetscInt       *rows;
4680 
4681   PetscFunctionBegin;
4682   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4683   PetscValidType(mat,1);
4684   PetscValidHeaderSpecific(is,IS_COOKIE,2);
4685   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4686   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4687   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4688 
4689   ierr = ISGetLocalSize(is,&numRows);CHKERRQ(ierr);
4690   ierr = ISGetIndices(is,&rows);CHKERRQ(ierr);
4691   ierr = MatZeroRowsLocal(mat,numRows,rows,diag);CHKERRQ(ierr);
4692   ierr = ISRestoreIndices(is,&rows);CHKERRQ(ierr);
4693   PetscFunctionReturn(0);
4694 }
4695 
4696 #undef __FUNCT__
4697 #define __FUNCT__ "MatGetSize"
4698 /*@
4699    MatGetSize - Returns the numbers of rows and columns in a matrix.
4700 
4701    Not Collective
4702 
4703    Input Parameter:
4704 .  mat - the matrix
4705 
4706    Output Parameters:
4707 +  m - the number of global rows
4708 -  n - the number of global columns
4709 
4710    Note: both output parameters can be PETSC_NULL on input.
4711 
4712    Level: beginner
4713 
4714    Concepts: matrices^size
4715 
4716 .seealso: MatGetLocalSize()
4717 @*/
4718 PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat mat,PetscInt *m,PetscInt* n)
4719 {
4720   PetscFunctionBegin;
4721   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4722   if (m) *m = mat->rmap.N;
4723   if (n) *n = mat->cmap.N;
4724   PetscFunctionReturn(0);
4725 }
4726 
4727 #undef __FUNCT__
4728 #define __FUNCT__ "MatGetLocalSize"
4729 /*@
4730    MatGetLocalSize - Returns the number of rows and columns in a matrix
4731    stored locally.  This information may be implementation dependent, so
4732    use with care.
4733 
4734    Not Collective
4735 
4736    Input Parameters:
4737 .  mat - the matrix
4738 
4739    Output Parameters:
4740 +  m - the number of local rows
4741 -  n - the number of local columns
4742 
4743    Note: both output parameters can be PETSC_NULL on input.
4744 
4745    Level: beginner
4746 
4747    Concepts: matrices^local size
4748 
4749 .seealso: MatGetSize()
4750 @*/
4751 PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat mat,PetscInt *m,PetscInt* n)
4752 {
4753   PetscFunctionBegin;
4754   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4755   if (m) PetscValidIntPointer(m,2);
4756   if (n) PetscValidIntPointer(n,3);
4757   if (m) *m = mat->rmap.n;
4758   if (n) *n = mat->cmap.n;
4759   PetscFunctionReturn(0);
4760 }
4761 
4762 #undef __FUNCT__
4763 #define __FUNCT__ "MatGetOwnershipRangeColumn"
4764 /*@
4765    MatGetOwnershipRangeColumn - Returns the range of matrix columns owned by
4766    this processor.
4767 
4768    Not Collective
4769 
4770    Input Parameters:
4771 .  mat - the matrix
4772 
4773    Output Parameters:
4774 +  m - the global index of the first local column
4775 -  n - one more than the global index of the last local column
4776 
4777    Notes: both output parameters can be PETSC_NULL on input.
4778 
4779    Level: developer
4780 
4781    Concepts: matrices^column ownership
4782 @*/
4783 PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangeColumn(Mat mat,PetscInt *m,PetscInt* n)
4784 {
4785   PetscErrorCode ierr;
4786 
4787   PetscFunctionBegin;
4788   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4789   PetscValidType(mat,1);
4790   if (m) PetscValidIntPointer(m,2);
4791   if (n) PetscValidIntPointer(n,3);
4792   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4793   if (m) *m = mat->cmap.rstart;
4794   if (n) *n = mat->cmap.rend;
4795   PetscFunctionReturn(0);
4796 }
4797 
4798 #undef __FUNCT__
4799 #define __FUNCT__ "MatGetOwnershipRange"
4800 /*@
4801    MatGetOwnershipRange - Returns the range of matrix rows owned by
4802    this processor, assuming that the matrix is laid out with the first
4803    n1 rows on the first processor, the next n2 rows on the second, etc.
4804    For certain parallel layouts this range may not be well defined.
4805 
4806    Not Collective
4807 
4808    Input Parameters:
4809 .  mat - the matrix
4810 
4811    Output Parameters:
4812 +  m - the global index of the first local row
4813 -  n - one more than the global index of the last local row
4814 
4815    Note: both output parameters can be PETSC_NULL on input.
4816 
4817    Level: beginner
4818 
4819    Concepts: matrices^row ownership
4820 
4821 .seealso:   MatGetOwnershipRanges()
4822 
4823 @*/
4824 PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat mat,PetscInt *m,PetscInt* n)
4825 {
4826   PetscErrorCode ierr;
4827 
4828   PetscFunctionBegin;
4829   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4830   PetscValidType(mat,1);
4831   if (m) PetscValidIntPointer(m,2);
4832   if (n) PetscValidIntPointer(n,3);
4833   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4834   if (m) *m = mat->rmap.rstart;
4835   if (n) *n = mat->rmap.rend;
4836   PetscFunctionReturn(0);
4837 }
4838 
4839 #undef __FUNCT__
4840 #define __FUNCT__ "MatGetOwnershipRanges"
4841 /*@C
4842    MatGetOwnershipRanges - Returns the range of matrix rows owned by
4843    each process
4844 
4845    Not Collective
4846 
4847    Input Parameters:
4848 .  mat - the matrix
4849 
4850    Output Parameters:
4851 .  ranges - start of each processors portion plus one more then the total length at the end
4852 
4853    Level: beginner
4854 
4855    Concepts: matrices^row ownership
4856 
4857 .seealso:   MatGetOwnershipRange()
4858 
4859 @*/
4860 PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRanges(Mat mat,const PetscInt **ranges)
4861 {
4862   PetscErrorCode ierr;
4863 
4864   PetscFunctionBegin;
4865   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4866   PetscValidType(mat,1);
4867   ierr = PetscMapGetGlobalRange(&mat->rmap,ranges);CHKERRQ(ierr);
4868   PetscFunctionReturn(0);
4869 }
4870 
4871 #undef __FUNCT__
4872 #define __FUNCT__ "MatILUFactorSymbolic"
4873 /*@
4874    MatILUFactorSymbolic - Performs symbolic ILU factorization of a matrix.
4875    Uses levels of fill only, not drop tolerance. Use MatLUFactorNumeric()
4876    to complete the factorization.
4877 
4878    Collective on Mat
4879 
4880    Input Parameters:
4881 +  mat - the matrix
4882 .  row - row permutation
4883 .  column - column permutation
4884 -  info - structure containing
4885 $      levels - number of levels of fill.
4886 $      expected fill - as ratio of original fill.
4887 $      1 or 0 - indicating force fill on diagonal (improves robustness for matrices
4888                 missing diagonal entries)
4889 
4890    Output Parameters:
4891 .  fact - new matrix that has been symbolically factored
4892 
4893    Notes:
4894    See the users manual for additional information about
4895    choosing the fill factor for better efficiency.
4896 
4897    Most users should employ the simplified KSP interface for linear solvers
4898    instead of working directly with matrix algebra routines such as this.
4899    See, e.g., KSPCreate().
4900 
4901    Level: developer
4902 
4903   Concepts: matrices^symbolic LU factorization
4904   Concepts: matrices^factorization
4905   Concepts: LU^symbolic factorization
4906 
4907 .seealso: MatLUFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor()
4908           MatGetOrdering(), MatFactorInfo
4909 
4910 @*/
4911 PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat mat,IS row,IS col,MatFactorInfo *info,Mat *fact)
4912 {
4913   PetscErrorCode ierr;
4914 
4915   PetscFunctionBegin;
4916   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4917   PetscValidType(mat,1);
4918   PetscValidHeaderSpecific(row,IS_COOKIE,2);
4919   PetscValidHeaderSpecific(col,IS_COOKIE,3);
4920   PetscValidPointer(info,4);
4921   PetscValidPointer(fact,5);
4922   if (info->levels < 0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Levels of fill negative %D",(PetscInt)info->levels);
4923   if (info->fill < 1.0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Expected fill less than 1.0 %G",info->fill);
4924   if (!mat->ops->ilufactorsymbolic) SETERRQ1(PETSC_ERR_SUP,"Matrix type %s  symbolic ILU",((PetscObject)mat)->type_name);
4925   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4926   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4927   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4928 
4929   ierr = PetscLogEventBegin(MAT_ILUFactorSymbolic,mat,row,col,0);CHKERRQ(ierr);
4930   ierr = (*mat->ops->ilufactorsymbolic)(mat,row,col,info,fact);CHKERRQ(ierr);
4931   ierr = PetscLogEventEnd(MAT_ILUFactorSymbolic,mat,row,col,0);CHKERRQ(ierr);
4932   PetscFunctionReturn(0);
4933 }
4934 
4935 #undef __FUNCT__
4936 #define __FUNCT__ "MatICCFactorSymbolic"
4937 /*@
4938    MatICCFactorSymbolic - Performs symbolic incomplete
4939    Cholesky factorization for a symmetric matrix.  Use
4940    MatCholeskyFactorNumeric() to complete the factorization.
4941 
4942    Collective on Mat
4943 
4944    Input Parameters:
4945 +  mat - the matrix
4946 .  perm - row and column permutation
4947 -  info - structure containing
4948 $      levels - number of levels of fill.
4949 $      expected fill - as ratio of original fill.
4950 
4951    Output Parameter:
4952 .  fact - the factored matrix
4953 
4954    Notes:
4955    Most users should employ the KSP interface for linear solvers
4956    instead of working directly with matrix algebra routines such as this.
4957    See, e.g., KSPCreate().
4958 
4959    Level: developer
4960 
4961   Concepts: matrices^symbolic incomplete Cholesky factorization
4962   Concepts: matrices^factorization
4963   Concepts: Cholsky^symbolic factorization
4964 
4965 .seealso: MatCholeskyFactorNumeric(), MatCholeskyFactor(), MatFactorInfo
4966 @*/
4967 PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat mat,IS perm,MatFactorInfo *info,Mat *fact)
4968 {
4969   PetscErrorCode ierr;
4970 
4971   PetscFunctionBegin;
4972   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
4973   PetscValidType(mat,1);
4974   PetscValidHeaderSpecific(perm,IS_COOKIE,2);
4975   PetscValidPointer(info,3);
4976   PetscValidPointer(fact,4);
4977   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
4978   if (info->levels < 0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Levels negative %D",(PetscInt) info->levels);
4979   if (info->fill < 1.0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Expected fill less than 1.0 %G",info->fill);
4980   if (!mat->ops->iccfactorsymbolic) SETERRQ1(PETSC_ERR_SUP,"Matrix type %s  symbolic ICC",((PetscObject)mat)->type_name);
4981   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
4982   ierr = MatPreallocated(mat);CHKERRQ(ierr);
4983 
4984   ierr = PetscLogEventBegin(MAT_ICCFactorSymbolic,mat,perm,0,0);CHKERRQ(ierr);
4985   ierr = (*mat->ops->iccfactorsymbolic)(mat,perm,info,fact);CHKERRQ(ierr);
4986   ierr = PetscLogEventEnd(MAT_ICCFactorSymbolic,mat,perm,0,0);CHKERRQ(ierr);
4987   PetscFunctionReturn(0);
4988 }
4989 
4990 #undef __FUNCT__
4991 #define __FUNCT__ "MatGetArray"
4992 /*@C
4993    MatGetArray - Returns a pointer to the element values in the matrix.
4994    The result of this routine is dependent on the underlying matrix data
4995    structure, and may not even work for certain matrix types.  You MUST
4996    call MatRestoreArray() when you no longer need to access the array.
4997 
4998    Not Collective
4999 
5000    Input Parameter:
5001 .  mat - the matrix
5002 
5003    Output Parameter:
5004 .  v - the location of the values
5005 
5006 
5007    Fortran Note:
5008    This routine is used differently from Fortran, e.g.,
5009 .vb
5010         Mat         mat
5011         PetscScalar mat_array(1)
5012         PetscOffset i_mat
5013         PetscErrorCode ierr
5014         call MatGetArray(mat,mat_array,i_mat,ierr)
5015 
5016   C  Access first local entry in matrix; note that array is
5017   C  treated as one dimensional
5018         value = mat_array(i_mat + 1)
5019 
5020         [... other code ...]
5021         call MatRestoreArray(mat,mat_array,i_mat,ierr)
5022 .ve
5023 
5024    See the Fortran chapter of the users manual and
5025    petsc/src/mat/examples/tests for details.
5026 
5027    Level: advanced
5028 
5029    Concepts: matrices^access array
5030 
5031 .seealso: MatRestoreArray(), MatGetArrayF90(), MatGetRowIJ()
5032 @*/
5033 PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat mat,PetscScalar *v[])
5034 {
5035   PetscErrorCode ierr;
5036 
5037   PetscFunctionBegin;
5038   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5039   PetscValidType(mat,1);
5040   PetscValidPointer(v,2);
5041   if (!mat->ops->getarray) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5042   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5043   ierr = (*mat->ops->getarray)(mat,v);CHKERRQ(ierr);
5044   CHKMEMQ;
5045   PetscFunctionReturn(0);
5046 }
5047 
5048 #undef __FUNCT__
5049 #define __FUNCT__ "MatRestoreArray"
5050 /*@C
5051    MatRestoreArray - Restores the matrix after MatGetArray() has been called.
5052 
5053    Not Collective
5054 
5055    Input Parameter:
5056 +  mat - the matrix
5057 -  v - the location of the values
5058 
5059    Fortran Note:
5060    This routine is used differently from Fortran, e.g.,
5061 .vb
5062         Mat         mat
5063         PetscScalar mat_array(1)
5064         PetscOffset i_mat
5065         PetscErrorCode ierr
5066         call MatGetArray(mat,mat_array,i_mat,ierr)
5067 
5068   C  Access first local entry in matrix; note that array is
5069   C  treated as one dimensional
5070         value = mat_array(i_mat + 1)
5071 
5072         [... other code ...]
5073         call MatRestoreArray(mat,mat_array,i_mat,ierr)
5074 .ve
5075 
5076    See the Fortran chapter of the users manual and
5077    petsc/src/mat/examples/tests for details
5078 
5079    Level: advanced
5080 
5081 .seealso: MatGetArray(), MatRestoreArrayF90()
5082 @*/
5083 PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat mat,PetscScalar *v[])
5084 {
5085   PetscErrorCode ierr;
5086 
5087   PetscFunctionBegin;
5088   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5089   PetscValidType(mat,1);
5090   PetscValidPointer(v,2);
5091 #if defined(PETSC_USE_DEBUG)
5092   CHKMEMQ;
5093 #endif
5094   if (!mat->ops->restorearray) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5095   ierr = (*mat->ops->restorearray)(mat,v);CHKERRQ(ierr);
5096   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
5097   PetscFunctionReturn(0);
5098 }
5099 
5100 #undef __FUNCT__
5101 #define __FUNCT__ "MatGetSubMatrices"
5102 /*@C
5103    MatGetSubMatrices - Extracts several submatrices from a matrix. If submat
5104    points to an array of valid matrices, they may be reused to store the new
5105    submatrices.
5106 
5107    Collective on Mat
5108 
5109    Input Parameters:
5110 +  mat - the matrix
5111 .  n   - the number of submatrixes to be extracted (on this processor, may be zero)
5112 .  irow, icol - index sets of rows and columns to extract
5113 -  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
5114 
5115    Output Parameter:
5116 .  submat - the array of submatrices
5117 
5118    Notes:
5119    MatGetSubMatrices() can extract only sequential submatrices
5120    (from both sequential and parallel matrices). Use MatGetSubMatrix()
5121    to extract a parallel submatrix.
5122 
5123    When extracting submatrices from a parallel matrix, each processor can
5124    form a different submatrix by setting the rows and columns of its
5125    individual index sets according to the local submatrix desired.
5126 
5127    When finished using the submatrices, the user should destroy
5128    them with MatDestroyMatrices().
5129 
5130    MAT_REUSE_MATRIX can only be used when the nonzero structure of the
5131    original matrix has not changed from that last call to MatGetSubMatrices().
5132 
5133    This routine creates the matrices in submat; you should NOT create them before
5134    calling it. It also allocates the array of matrix pointers submat.
5135 
5136    For BAIJ matrices the index sets must respect the block structure, that is if they
5137    request one row/column in a block, they must request all rows/columns that are in
5138    that block. For example, if the block size is 2 you cannot request just row 0 and
5139    column 0.
5140 
5141    Fortran Note:
5142    The Fortran interface is slightly different from that given below; it
5143    requires one to pass in  as submat a Mat (integer) array of size at least m.
5144 
5145    Level: advanced
5146 
5147    Concepts: matrices^accessing submatrices
5148    Concepts: submatrices
5149 
5150 .seealso: MatDestroyMatrices(), MatGetSubMatrix(), MatGetRow(), MatGetDiagonal()
5151 @*/
5152 PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[])
5153 {
5154   PetscErrorCode ierr;
5155   PetscInt        i;
5156   PetscTruth      eq;
5157 
5158   PetscFunctionBegin;
5159   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5160   PetscValidType(mat,1);
5161   if (n) {
5162     PetscValidPointer(irow,3);
5163     PetscValidHeaderSpecific(*irow,IS_COOKIE,3);
5164     PetscValidPointer(icol,4);
5165     PetscValidHeaderSpecific(*icol,IS_COOKIE,4);
5166   }
5167   PetscValidPointer(submat,6);
5168   if (n && scall == MAT_REUSE_MATRIX) {
5169     PetscValidPointer(*submat,6);
5170     PetscValidHeaderSpecific(**submat,MAT_COOKIE,6);
5171   }
5172   if (!mat->ops->getsubmatrices) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5173   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5174   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5175   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5176 
5177   ierr = PetscLogEventBegin(MAT_GetSubMatrices,mat,0,0,0);CHKERRQ(ierr);
5178   ierr = (*mat->ops->getsubmatrices)(mat,n,irow,icol,scall,submat);CHKERRQ(ierr);
5179   ierr = PetscLogEventEnd(MAT_GetSubMatrices,mat,0,0,0);CHKERRQ(ierr);
5180   for (i=0; i<n; i++) {
5181     if (mat->symmetric || mat->structurally_symmetric || mat->hermitian) {
5182       ierr = ISEqual(irow[i],icol[i],&eq);CHKERRQ(ierr);
5183       if (eq) {
5184 	if (mat->symmetric){
5185 	  ierr = MatSetOption((*submat)[i],MAT_SYMMETRIC,PETSC_TRUE);CHKERRQ(ierr);
5186 	} else if (mat->hermitian) {
5187 	  ierr = MatSetOption((*submat)[i],MAT_HERMITIAN,PETSC_TRUE);CHKERRQ(ierr);
5188 	} else if (mat->structurally_symmetric) {
5189 	  ierr = MatSetOption((*submat)[i],MAT_STRUCTURALLY_SYMMETRIC,PETSC_TRUE);CHKERRQ(ierr);
5190 	}
5191       }
5192     }
5193   }
5194   PetscFunctionReturn(0);
5195 }
5196 
5197 #undef __FUNCT__
5198 #define __FUNCT__ "MatDestroyMatrices"
5199 /*@C
5200    MatDestroyMatrices - Destroys a set of matrices obtained with MatGetSubMatrices().
5201 
5202    Collective on Mat
5203 
5204    Input Parameters:
5205 +  n - the number of local matrices
5206 -  mat - the matrices (note that this is a pointer to the array of matrices, just to match the calling
5207                        sequence of MatGetSubMatrices())
5208 
5209    Level: advanced
5210 
5211     Notes: Frees not only the matrices, but also the array that contains the matrices
5212 
5213 .seealso: MatGetSubMatrices()
5214 @*/
5215 PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt n,Mat *mat[])
5216 {
5217   PetscErrorCode ierr;
5218   PetscInt       i;
5219 
5220   PetscFunctionBegin;
5221   if (n < 0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Trying to destroy negative number of matrices %D",n);
5222   PetscValidPointer(mat,2);
5223   for (i=0; i<n; i++) {
5224     ierr = MatDestroy((*mat)[i]);CHKERRQ(ierr);
5225   }
5226   /* memory is allocated even if n = 0 */
5227   ierr = PetscFree(*mat);CHKERRQ(ierr);
5228   PetscFunctionReturn(0);
5229 }
5230 
5231 #undef __FUNCT__
5232 #define __FUNCT__ "MatGetSeqNonzeroStructure"
5233 /*@C
5234    MatGetSeqNonzeroStructure - Extracts the sequential nonzero structure from a matrix.
5235 
5236    Collective on Mat
5237 
5238    Input Parameters:
5239 .  mat - the matrix
5240 
5241    Output Parameter:
5242 .  matstruct - the sequential matrix with the nonzero structure of mat
5243 
5244   Level: intermediate
5245 
5246 .seealso: MatDestroySeqNonzeroStructure(), MatGetSubMatrices(), MatDestroyMatrices()
5247 @*/
5248 PetscErrorCode PETSCMAT_DLLEXPORT MatGetSeqNonzeroStructure(Mat mat,Mat *matstruct[])
5249 {
5250   PetscErrorCode ierr;
5251 
5252   PetscFunctionBegin;
5253   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5254   PetscValidPointer(matstruct,2);
5255 
5256   PetscValidType(mat,1);
5257   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5258   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5259 
5260   ierr = PetscLogEventBegin(MAT_GetSeqNonzeroStructure,mat,0,0,0);CHKERRQ(ierr);
5261   ierr = (*mat->ops->getseqnonzerostructure)(mat,matstruct);CHKERRQ(ierr);
5262   ierr = PetscLogEventEnd(MAT_GetSeqNonzeroStructure,mat,0,0,0);CHKERRQ(ierr);
5263   PetscFunctionReturn(0);
5264 }
5265 
5266 #undef __FUNCT__
5267 #define __FUNCT__ "MatDestroySeqNonzeroStructure"
5268 /*@C
5269    MatDestroySeqNonzeroStructure - Destroys matrix obtained with MatGetSeqNonzeroStructure().
5270 
5271    Collective on Mat
5272 
5273    Input Parameters:
5274 .  mat - the matrix (note that this is a pointer to the array of matrices, just to match the calling
5275                        sequence of MatGetSequentialNonzeroStructure())
5276 
5277    Level: advanced
5278 
5279     Notes: Frees not only the matrices, but also the array that contains the matrices
5280 
5281 .seealso: MatGetSeqNonzeroStructure()
5282 @*/
5283 PetscErrorCode PETSCMAT_DLLEXPORT MatDestroySeqNonzeroStructure(Mat *mat[])
5284 {
5285   PetscErrorCode ierr;
5286 
5287   PetscFunctionBegin;
5288   PetscValidPointer(mat,1);
5289   ierr = MatDestroyMatrices(1,mat);CHKERRQ(ierr);
5290   PetscFunctionReturn(0);
5291 }
5292 
5293 #undef __FUNCT__
5294 #define __FUNCT__ "MatIncreaseOverlap"
5295 /*@
5296    MatIncreaseOverlap - Given a set of submatrices indicated by index sets,
5297    replaces the index sets by larger ones that represent submatrices with
5298    additional overlap.
5299 
5300    Collective on Mat
5301 
5302    Input Parameters:
5303 +  mat - the matrix
5304 .  n   - the number of index sets
5305 .  is  - the array of index sets (these index sets will changed during the call)
5306 -  ov  - the additional overlap requested
5307 
5308    Level: developer
5309 
5310    Concepts: overlap
5311    Concepts: ASM^computing overlap
5312 
5313 .seealso: MatGetSubMatrices()
5314 @*/
5315 PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat mat,PetscInt n,IS is[],PetscInt ov)
5316 {
5317   PetscErrorCode ierr;
5318 
5319   PetscFunctionBegin;
5320   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5321   PetscValidType(mat,1);
5322   if (n < 0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Must have one or more domains, you have %D",n);
5323   if (n) {
5324     PetscValidPointer(is,3);
5325     PetscValidHeaderSpecific(*is,IS_COOKIE,3);
5326   }
5327   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
5328   if (mat->factor)     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5329   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5330 
5331   if (!ov) PetscFunctionReturn(0);
5332   if (!mat->ops->increaseoverlap) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5333   ierr = PetscLogEventBegin(MAT_IncreaseOverlap,mat,0,0,0);CHKERRQ(ierr);
5334   ierr = (*mat->ops->increaseoverlap)(mat,n,is,ov);CHKERRQ(ierr);
5335   ierr = PetscLogEventEnd(MAT_IncreaseOverlap,mat,0,0,0);CHKERRQ(ierr);
5336   PetscFunctionReturn(0);
5337 }
5338 
5339 #undef __FUNCT__
5340 #define __FUNCT__ "MatGetBlockSize"
5341 /*@
5342    MatGetBlockSize - Returns the matrix block size; useful especially for the
5343    block row and block diagonal formats.
5344 
5345    Not Collective
5346 
5347    Input Parameter:
5348 .  mat - the matrix
5349 
5350    Output Parameter:
5351 .  bs - block size
5352 
5353    Notes:
5354    Block row formats are MATSEQBAIJ, MATMPIBAIJ, MATSEQSBAIJ, MATMPISBAIJ
5355 
5356    Level: intermediate
5357 
5358    Concepts: matrices^block size
5359 
5360 .seealso: MatCreateSeqBAIJ(), MatCreateMPIBAIJ()
5361 @*/
5362 PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat mat,PetscInt *bs)
5363 {
5364   PetscErrorCode ierr;
5365 
5366   PetscFunctionBegin;
5367   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5368   PetscValidType(mat,1);
5369   PetscValidIntPointer(bs,2);
5370   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5371   *bs = mat->rmap.bs;
5372   PetscFunctionReturn(0);
5373 }
5374 
5375 #undef __FUNCT__
5376 #define __FUNCT__ "MatSetBlockSize"
5377 /*@
5378    MatSetBlockSize - Sets the matrix block size; for many matrix types you
5379      cannot use this and MUST set the blocksize when you preallocate the matrix
5380 
5381    Collective on Mat
5382 
5383    Input Parameters:
5384 +  mat - the matrix
5385 -  bs - block size
5386 
5387    Notes:
5388      Only works for shell and AIJ matrices
5389 
5390    Level: intermediate
5391 
5392    Concepts: matrices^block size
5393 
5394 .seealso: MatCreateSeqBAIJ(), MatCreateMPIBAIJ(), MatGetBlockSize()
5395 @*/
5396 PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat mat,PetscInt bs)
5397 {
5398   PetscErrorCode ierr;
5399 
5400   PetscFunctionBegin;
5401   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5402   PetscValidType(mat,1);
5403   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5404   if (mat->ops->setblocksize) {
5405     mat->rmap.bs = bs;
5406     ierr = (*mat->ops->setblocksize)(mat,bs);CHKERRQ(ierr);
5407   } else {
5408     SETERRQ1(PETSC_ERR_ARG_INCOMP,"Cannot set the blocksize for matrix type %s",((PetscObject)mat)->type_name);
5409   }
5410   PetscFunctionReturn(0);
5411 }
5412 
5413 #undef __FUNCT__
5414 #define __FUNCT__ "MatGetRowIJ"
5415 /*@C
5416     MatGetRowIJ - Returns the compressed row storage i and j indices for sequential matrices.
5417 
5418    Collective on Mat
5419 
5420     Input Parameters:
5421 +   mat - the matrix
5422 .   shift -  0 or 1 indicating we want the indices starting at 0 or 1
5423 .   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
5424                 symmetrized
5425 -   blockcompressed - PETSC_TRUE or PETSC_FALSE  indicating if the nonzero structure of the
5426                  blockcompressed matrix is desired or not [inode, baij have blockcompressed
5427                  nonzero structure which is different than the full nonzero structure]
5428 
5429     Output Parameters:
5430 +   n - number of rows in the (possibly compressed) matrix
5431 .   ia - the row pointers [of length n+1]
5432 .   ja - the column indices
5433 -   done - indicates if the routine actually worked and returned appropriate ia[] and ja[] arrays; callers
5434            are responsible for handling the case when done == PETSC_FALSE and ia and ja are not set
5435 
5436     Level: developer
5437 
5438     Notes: You CANNOT change any of the ia[] or ja[] values.
5439 
5440            Use MatRestoreRowIJ() when you are finished accessing the ia[] and ja[] values
5441 
5442     Fortran Node
5443 
5444            In Fortran use
5445 $           PetscInt ia(1), ja(1)
5446 $           PetscOffset iia, jja
5447 $      call MatGetRowIJ(mat,shift,symmetric,blockcompressed,n,ia,iia,ja,jja,done,ierr)
5448 
5449        Acess the ith and jth entries via ia(iia + i) and ja(jja + j)
5450 
5451 .seealso: MatGetColumnIJ(), MatRestoreRowIJ(), MatGetArray()
5452 @*/
5453 PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat mat,PetscInt shift,PetscTruth symmetric,PetscTruth blockcompressed,PetscInt *n,PetscInt *ia[],PetscInt* ja[],PetscTruth *done)
5454 {
5455   PetscErrorCode ierr;
5456 
5457   PetscFunctionBegin;
5458   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5459   PetscValidType(mat,1);
5460   PetscValidIntPointer(n,4);
5461   if (ia) PetscValidIntPointer(ia,5);
5462   if (ja) PetscValidIntPointer(ja,6);
5463   PetscValidIntPointer(done,7);
5464   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5465   if (!mat->ops->getrowij) *done = PETSC_FALSE;
5466   else {
5467     *done = PETSC_TRUE;
5468     ierr = PetscLogEventBegin(MAT_GetRowIJ,mat,0,0,0);CHKERRQ(ierr);
5469     ierr  = (*mat->ops->getrowij)(mat,shift,symmetric,blockcompressed,n,ia,ja,done);CHKERRQ(ierr);
5470     ierr = PetscLogEventEnd(MAT_GetRowIJ,mat,0,0,0);CHKERRQ(ierr);
5471   }
5472   PetscFunctionReturn(0);
5473 }
5474 
5475 #undef __FUNCT__
5476 #define __FUNCT__ "MatGetColumnIJ"
5477 /*@C
5478     MatGetColumnIJ - Returns the compressed column storage i and j indices for sequential matrices.
5479 
5480     Collective on Mat
5481 
5482     Input Parameters:
5483 +   mat - the matrix
5484 .   shift - 1 or zero indicating we want the indices starting at 0 or 1
5485 .   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
5486                 symmetrized
5487 -   blockcompressed - PETSC_TRUE or PETSC_FALSE  indicating if the nonzero structure of the
5488                  blockcompressed matrix is desired or not [inode, baij have blockcompressed
5489                  nonzero structure which is different than the full nonzero structure]
5490 
5491     Output Parameters:
5492 +   n - number of columns in the (possibly compressed) matrix
5493 .   ia - the column pointers
5494 .   ja - the row indices
5495 -   done - PETSC_TRUE or PETSC_FALSE, indicating whether the values have been returned
5496 
5497     Level: developer
5498 
5499 .seealso: MatGetRowIJ(), MatRestoreColumnIJ()
5500 @*/
5501 PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat mat,PetscInt shift,PetscTruth symmetric,PetscTruth blockcompressed,PetscInt *n,PetscInt *ia[],PetscInt* ja[],PetscTruth *done)
5502 {
5503   PetscErrorCode ierr;
5504 
5505   PetscFunctionBegin;
5506   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5507   PetscValidType(mat,1);
5508   PetscValidIntPointer(n,4);
5509   if (ia) PetscValidIntPointer(ia,5);
5510   if (ja) PetscValidIntPointer(ja,6);
5511   PetscValidIntPointer(done,7);
5512   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5513   if (!mat->ops->getcolumnij) *done = PETSC_FALSE;
5514   else {
5515     *done = PETSC_TRUE;
5516     ierr  = (*mat->ops->getcolumnij)(mat,shift,symmetric,blockcompressed,n,ia,ja,done);CHKERRQ(ierr);
5517   }
5518   PetscFunctionReturn(0);
5519 }
5520 
5521 #undef __FUNCT__
5522 #define __FUNCT__ "MatRestoreRowIJ"
5523 /*@C
5524     MatRestoreRowIJ - Call after you are completed with the ia,ja indices obtained with
5525     MatGetRowIJ().
5526 
5527     Collective on Mat
5528 
5529     Input Parameters:
5530 +   mat - the matrix
5531 .   shift - 1 or zero indicating we want the indices starting at 0 or 1
5532 .   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
5533                 symmetrized
5534 -   blockcompressed - PETSC_TRUE or PETSC_FALSE  indicating if the nonzero structure of the
5535                  blockcompressed matrix is desired or not [inode, baij have blockcompressed
5536                  nonzero structure which is different than the full nonzero structure]
5537 
5538     Output Parameters:
5539 +   n - size of (possibly compressed) matrix
5540 .   ia - the row pointers
5541 .   ja - the column indices
5542 -   done - PETSC_TRUE or PETSC_FALSE indicated that the values have been returned
5543 
5544     Level: developer
5545 
5546 .seealso: MatGetRowIJ(), MatRestoreColumnIJ()
5547 @*/
5548 PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat mat,PetscInt shift,PetscTruth symmetric,PetscTruth blockcompressed,PetscInt *n,PetscInt *ia[],PetscInt* ja[],PetscTruth *done)
5549 {
5550   PetscErrorCode ierr;
5551 
5552   PetscFunctionBegin;
5553   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5554   PetscValidType(mat,1);
5555   if (ia) PetscValidIntPointer(ia,5);
5556   if (ja) PetscValidIntPointer(ja,6);
5557   PetscValidIntPointer(done,7);
5558   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5559 
5560   if (!mat->ops->restorerowij) *done = PETSC_FALSE;
5561   else {
5562     *done = PETSC_TRUE;
5563     ierr  = (*mat->ops->restorerowij)(mat,shift,symmetric,blockcompressed,n,ia,ja,done);CHKERRQ(ierr);
5564   }
5565   PetscFunctionReturn(0);
5566 }
5567 
5568 #undef __FUNCT__
5569 #define __FUNCT__ "MatRestoreColumnIJ"
5570 /*@C
5571     MatRestoreColumnIJ - Call after you are completed with the ia,ja indices obtained with
5572     MatGetColumnIJ().
5573 
5574     Collective on Mat
5575 
5576     Input Parameters:
5577 +   mat - the matrix
5578 .   shift - 1 or zero indicating we want the indices starting at 0 or 1
5579 -   symmetric - PETSC_TRUE or PETSC_FALSE indicating the matrix data structure should be
5580                 symmetrized
5581 -   blockcompressed - PETSC_TRUE or PETSC_FALSE  indicating if the nonzero structure of the
5582                  blockcompressed matrix is desired or not [inode, baij have blockcompressed
5583                  nonzero structure which is different than the full nonzero structure]
5584 
5585     Output Parameters:
5586 +   n - size of (possibly compressed) matrix
5587 .   ia - the column pointers
5588 .   ja - the row indices
5589 -   done - PETSC_TRUE or PETSC_FALSE indicated that the values have been returned
5590 
5591     Level: developer
5592 
5593 .seealso: MatGetColumnIJ(), MatRestoreRowIJ()
5594 @*/
5595 PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat mat,PetscInt shift,PetscTruth symmetric,PetscTruth blockcompressed,PetscInt *n,PetscInt *ia[],PetscInt* ja[],PetscTruth *done)
5596 {
5597   PetscErrorCode ierr;
5598 
5599   PetscFunctionBegin;
5600   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5601   PetscValidType(mat,1);
5602   if (ia) PetscValidIntPointer(ia,5);
5603   if (ja) PetscValidIntPointer(ja,6);
5604   PetscValidIntPointer(done,7);
5605   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5606 
5607   if (!mat->ops->restorecolumnij) *done = PETSC_FALSE;
5608   else {
5609     *done = PETSC_TRUE;
5610     ierr  = (*mat->ops->restorecolumnij)(mat,shift,symmetric,blockcompressed,n,ia,ja,done);CHKERRQ(ierr);
5611   }
5612   PetscFunctionReturn(0);
5613 }
5614 
5615 #undef __FUNCT__
5616 #define __FUNCT__ "MatColoringPatch"
5617 /*@C
5618     MatColoringPatch -Used inside matrix coloring routines that
5619     use MatGetRowIJ() and/or MatGetColumnIJ().
5620 
5621     Collective on Mat
5622 
5623     Input Parameters:
5624 +   mat - the matrix
5625 .   ncolors - max color value
5626 .   n   - number of entries in colorarray
5627 -   colorarray - array indicating color for each column
5628 
5629     Output Parameters:
5630 .   iscoloring - coloring generated using colorarray information
5631 
5632     Level: developer
5633 
5634 .seealso: MatGetRowIJ(), MatGetColumnIJ()
5635 
5636 @*/
5637 PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat mat,PetscInt ncolors,PetscInt n,ISColoringValue colorarray[],ISColoring *iscoloring)
5638 {
5639   PetscErrorCode ierr;
5640 
5641   PetscFunctionBegin;
5642   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5643   PetscValidType(mat,1);
5644   PetscValidIntPointer(colorarray,4);
5645   PetscValidPointer(iscoloring,5);
5646   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5647 
5648   if (!mat->ops->coloringpatch){
5649     ierr = ISColoringCreate(((PetscObject)mat)->comm,ncolors,n,colorarray,iscoloring);CHKERRQ(ierr);
5650   } else {
5651     ierr = (*mat->ops->coloringpatch)(mat,ncolors,n,colorarray,iscoloring);CHKERRQ(ierr);
5652   }
5653   PetscFunctionReturn(0);
5654 }
5655 
5656 
5657 #undef __FUNCT__
5658 #define __FUNCT__ "MatSetUnfactored"
5659 /*@
5660    MatSetUnfactored - Resets a factored matrix to be treated as unfactored.
5661 
5662    Collective on Mat
5663 
5664    Input Parameter:
5665 .  mat - the factored matrix to be reset
5666 
5667    Notes:
5668    This routine should be used only with factored matrices formed by in-place
5669    factorization via ILU(0) (or by in-place LU factorization for the MATSEQDENSE
5670    format).  This option can save memory, for example, when solving nonlinear
5671    systems with a matrix-free Newton-Krylov method and a matrix-based, in-place
5672    ILU(0) preconditioner.
5673 
5674    Note that one can specify in-place ILU(0) factorization by calling
5675 .vb
5676      PCType(pc,PCILU);
5677      PCFactorSeUseInPlace(pc);
5678 .ve
5679    or by using the options -pc_type ilu -pc_factor_in_place
5680 
5681    In-place factorization ILU(0) can also be used as a local
5682    solver for the blocks within the block Jacobi or additive Schwarz
5683    methods (runtime option: -sub_pc_factor_in_place).  See the discussion
5684    of these preconditioners in the users manual for details on setting
5685    local solver options.
5686 
5687    Most users should employ the simplified KSP interface for linear solvers
5688    instead of working directly with matrix algebra routines such as this.
5689    See, e.g., KSPCreate().
5690 
5691    Level: developer
5692 
5693 .seealso: PCFactorSetUseInPlace()
5694 
5695    Concepts: matrices^unfactored
5696 
5697 @*/
5698 PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat mat)
5699 {
5700   PetscErrorCode ierr;
5701 
5702   PetscFunctionBegin;
5703   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5704   PetscValidType(mat,1);
5705   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5706   mat->factor = 0;
5707   if (!mat->ops->setunfactored) PetscFunctionReturn(0);
5708   ierr = (*mat->ops->setunfactored)(mat);CHKERRQ(ierr);
5709   PetscFunctionReturn(0);
5710 }
5711 
5712 /*MC
5713     MatGetArrayF90 - Accesses a matrix array from Fortran90.
5714 
5715     Synopsis:
5716     MatGetArrayF90(Mat x,{Scalar, pointer :: xx_v(:)},integer ierr)
5717 
5718     Not collective
5719 
5720     Input Parameter:
5721 .   x - matrix
5722 
5723     Output Parameters:
5724 +   xx_v - the Fortran90 pointer to the array
5725 -   ierr - error code
5726 
5727     Example of Usage:
5728 .vb
5729       PetscScalar, pointer xx_v(:)
5730       ....
5731       call MatGetArrayF90(x,xx_v,ierr)
5732       a = xx_v(3)
5733       call MatRestoreArrayF90(x,xx_v,ierr)
5734 .ve
5735 
5736     Notes:
5737     Not yet supported for all F90 compilers
5738 
5739     Level: advanced
5740 
5741 .seealso:  MatRestoreArrayF90(), MatGetArray(), MatRestoreArray()
5742 
5743     Concepts: matrices^accessing array
5744 
5745 M*/
5746 
5747 /*MC
5748     MatRestoreArrayF90 - Restores a matrix array that has been
5749     accessed with MatGetArrayF90().
5750 
5751     Synopsis:
5752     MatRestoreArrayF90(Mat x,{Scalar, pointer :: xx_v(:)},integer ierr)
5753 
5754     Not collective
5755 
5756     Input Parameters:
5757 +   x - matrix
5758 -   xx_v - the Fortran90 pointer to the array
5759 
5760     Output Parameter:
5761 .   ierr - error code
5762 
5763     Example of Usage:
5764 .vb
5765        PetscScalar, pointer xx_v(:)
5766        ....
5767        call MatGetArrayF90(x,xx_v,ierr)
5768        a = xx_v(3)
5769        call MatRestoreArrayF90(x,xx_v,ierr)
5770 .ve
5771 
5772     Notes:
5773     Not yet supported for all F90 compilers
5774 
5775     Level: advanced
5776 
5777 .seealso:  MatGetArrayF90(), MatGetArray(), MatRestoreArray()
5778 
5779 M*/
5780 
5781 
5782 #undef __FUNCT__
5783 #define __FUNCT__ "MatGetSubMatrix"
5784 /*@
5785     MatGetSubMatrix - Gets a single submatrix on the same number of processors
5786                       as the original matrix.
5787 
5788     Collective on Mat
5789 
5790     Input Parameters:
5791 +   mat - the original matrix
5792 .   isrow - rows this processor should obtain
5793 .   iscol - columns for all processors you wish to keep
5794 .   csize - number of columns "local" to this processor (does nothing for sequential
5795             matrices). This should match the result from VecGetLocalSize(x,...) if you
5796             plan to use the matrix in a A*x; alternatively, you can use PETSC_DECIDE
5797 -   cll - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
5798 
5799     Output Parameter:
5800 .   newmat - the new submatrix, of the same type as the old
5801 
5802     Level: advanced
5803 
5804     Notes: the iscol argument MUST be the same on each processor. You might be
5805     able to create the iscol argument with ISAllGather(). The rows is isrow will be
5806     sorted into the same order as the original matrix.
5807 
5808       The first time this is called you should use a cll of MAT_INITIAL_MATRIX,
5809    the MatGetSubMatrix() routine will create the newmat for you. Any additional calls
5810    to this routine with a mat of the same nonzero structure and with a call of MAT_REUSE_MATRIX
5811    will reuse the matrix generated the first time.  You should call MatDestroy() on newmat when
5812    you are finished using it.
5813 
5814     Concepts: matrices^submatrices
5815 
5816 .seealso: MatGetSubMatrices(), ISAllGather()
5817 @*/
5818 PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat mat,IS isrow,IS iscol,PetscInt csize,MatReuse cll,Mat *newmat)
5819 {
5820   PetscErrorCode ierr;
5821   PetscMPIInt    size;
5822   Mat            *local;
5823 
5824   PetscFunctionBegin;
5825   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5826   PetscValidHeaderSpecific(isrow,IS_COOKIE,2);
5827   PetscValidHeaderSpecific(iscol,IS_COOKIE,3);
5828   PetscValidPointer(newmat,6);
5829   if (cll == MAT_REUSE_MATRIX) PetscValidHeaderSpecific(*newmat,MAT_COOKIE,6);
5830   PetscValidType(mat,1);
5831   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5832   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5833   ierr = MPI_Comm_size(((PetscObject)mat)->comm,&size);CHKERRQ(ierr);
5834 
5835   /* if original matrix is on just one processor then use submatrix generated */
5836   if (!mat->ops->getsubmatrix && size == 1 && cll == MAT_REUSE_MATRIX) {
5837     ierr = MatGetSubMatrices(mat,1,&isrow,&iscol,MAT_REUSE_MATRIX,&newmat);CHKERRQ(ierr);
5838     PetscFunctionReturn(0);
5839   } else if (!mat->ops->getsubmatrix && size == 1) {
5840     ierr    = MatGetSubMatrices(mat,1,&isrow,&iscol,MAT_INITIAL_MATRIX,&local);CHKERRQ(ierr);
5841     *newmat = *local;
5842     ierr    = PetscFree(local);CHKERRQ(ierr);
5843     PetscFunctionReturn(0);
5844   }
5845 
5846   if (!mat->ops->getsubmatrix) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
5847   ierr = (*mat->ops->getsubmatrix)(mat,isrow,iscol,csize,cll,newmat);CHKERRQ(ierr);
5848   ierr = PetscObjectStateIncrease((PetscObject)*newmat);CHKERRQ(ierr);
5849   PetscFunctionReturn(0);
5850 }
5851 
5852 #undef __FUNCT__
5853 #define __FUNCT__ "MatGetSubMatrixRaw"
5854 /*@
5855     MatGetSubMatrixRaw - Gets a single submatrix on the same number of processors
5856                          as the original matrix.
5857 
5858     Collective on Mat
5859 
5860     Input Parameters:
5861 +   mat - the original matrix
5862 .   nrows - the number of rows this processor should obtain
5863 .   rows - rows this processor should obtain
5864 .   ncols - the number of columns for all processors you wish to keep
5865 .   cols - columns for all processors you wish to keep
5866 .   csize - number of columns "local" to this processor (does nothing for sequential
5867             matrices). This should match the result from VecGetLocalSize(x,...) if you
5868             plan to use the matrix in a A*x; alternatively, you can use PETSC_DECIDE
5869 -   cll - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
5870 
5871     Output Parameter:
5872 .   newmat - the new submatrix, of the same type as the old
5873 
5874     Level: advanced
5875 
5876     Notes: the iscol argument MUST be the same on each processor. You might be
5877     able to create the iscol argument with ISAllGather().
5878 
5879       The first time this is called you should use a cll of MAT_INITIAL_MATRIX,
5880    the MatGetSubMatrix() routine will create the newmat for you. Any additional calls
5881    to this routine with a mat of the same nonzero structure and with a cll of MAT_REUSE_MATRIX
5882    will reuse the matrix generated the first time.
5883 
5884     Concepts: matrices^submatrices
5885 
5886 .seealso: MatGetSubMatrices(), ISAllGather()
5887 @*/
5888 PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrixRaw(Mat mat,PetscInt nrows,const PetscInt rows[],PetscInt ncols,const PetscInt cols[],PetscInt csize,MatReuse cll,Mat *newmat)
5889 {
5890   IS             isrow, iscol;
5891   PetscErrorCode ierr;
5892 
5893   PetscFunctionBegin;
5894   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5895   PetscValidIntPointer(rows,2);
5896   PetscValidIntPointer(cols,3);
5897   PetscValidPointer(newmat,6);
5898   if (cll == MAT_REUSE_MATRIX) PetscValidHeaderSpecific(*newmat,MAT_COOKIE,6);
5899   PetscValidType(mat,1);
5900   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
5901   ierr = MatPreallocated(mat);CHKERRQ(ierr);
5902   ierr = ISCreateGeneralWithArray(PETSC_COMM_SELF, nrows, (PetscInt *) rows, &isrow);CHKERRQ(ierr);
5903   ierr = ISCreateGeneralWithArray(PETSC_COMM_SELF, ncols, (PetscInt *) cols, &iscol);CHKERRQ(ierr);
5904   ierr = MatGetSubMatrix(mat, isrow, iscol, csize, cll, newmat);CHKERRQ(ierr);
5905   ierr = ISDestroy(isrow);CHKERRQ(ierr);
5906   ierr = ISDestroy(iscol);CHKERRQ(ierr);
5907   PetscFunctionReturn(0);
5908 }
5909 
5910 #undef __FUNCT__
5911 #define __FUNCT__ "MatStashSetInitialSize"
5912 /*@
5913    MatStashSetInitialSize - sets the sizes of the matrix stash, that is
5914    used during the assembly process to store values that belong to
5915    other processors.
5916 
5917    Not Collective
5918 
5919    Input Parameters:
5920 +  mat   - the matrix
5921 .  size  - the initial size of the stash.
5922 -  bsize - the initial size of the block-stash(if used).
5923 
5924    Options Database Keys:
5925 +   -matstash_initial_size <size> or <size0,size1,...sizep-1>
5926 -   -matstash_block_initial_size <bsize>  or <bsize0,bsize1,...bsizep-1>
5927 
5928    Level: intermediate
5929 
5930    Notes:
5931      The block-stash is used for values set with MatSetValuesBlocked() while
5932      the stash is used for values set with MatSetValues()
5933 
5934      Run with the option -info and look for output of the form
5935      MatAssemblyBegin_MPIXXX:Stash has MM entries, uses nn mallocs.
5936      to determine the appropriate value, MM, to use for size and
5937      MatAssemblyBegin_MPIXXX:Block-Stash has BMM entries, uses nn mallocs.
5938      to determine the value, BMM to use for bsize
5939 
5940    Concepts: stash^setting matrix size
5941    Concepts: matrices^stash
5942 
5943 @*/
5944 PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat mat,PetscInt size, PetscInt bsize)
5945 {
5946   PetscErrorCode ierr;
5947 
5948   PetscFunctionBegin;
5949   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
5950   PetscValidType(mat,1);
5951   ierr = MatStashSetInitialSize_Private(&mat->stash,size);CHKERRQ(ierr);
5952   ierr = MatStashSetInitialSize_Private(&mat->bstash,bsize);CHKERRQ(ierr);
5953   PetscFunctionReturn(0);
5954 }
5955 
5956 #undef __FUNCT__
5957 #define __FUNCT__ "MatInterpolateAdd"
5958 /*@
5959    MatInterpolateAdd - w = y + A*x or A'*x depending on the shape of
5960      the matrix
5961 
5962    Collective on Mat
5963 
5964    Input Parameters:
5965 +  mat   - the matrix
5966 .  x,y - the vectors
5967 -  w - where the result is stored
5968 
5969    Level: intermediate
5970 
5971    Notes:
5972     w may be the same vector as y.
5973 
5974     This allows one to use either the restriction or interpolation (its transpose)
5975     matrix to do the interpolation
5976 
5977     Concepts: interpolation
5978 
5979 .seealso: MatMultAdd(), MatMultTransposeAdd(), MatRestrict()
5980 
5981 @*/
5982 PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat A,Vec x,Vec y,Vec w)
5983 {
5984   PetscErrorCode ierr;
5985   PetscInt       M,N;
5986 
5987   PetscFunctionBegin;
5988   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
5989   PetscValidHeaderSpecific(x,VEC_COOKIE,2);
5990   PetscValidHeaderSpecific(y,VEC_COOKIE,3);
5991   PetscValidHeaderSpecific(w,VEC_COOKIE,4);
5992   PetscValidType(A,1);
5993   ierr = MatPreallocated(A);CHKERRQ(ierr);
5994   ierr = MatGetSize(A,&M,&N);CHKERRQ(ierr);
5995   if (N > M) {
5996     ierr = MatMultTransposeAdd(A,x,y,w);CHKERRQ(ierr);
5997   } else {
5998     ierr = MatMultAdd(A,x,y,w);CHKERRQ(ierr);
5999   }
6000   PetscFunctionReturn(0);
6001 }
6002 
6003 #undef __FUNCT__
6004 #define __FUNCT__ "MatInterpolate"
6005 /*@
6006    MatInterpolate - y = A*x or A'*x depending on the shape of
6007      the matrix
6008 
6009    Collective on Mat
6010 
6011    Input Parameters:
6012 +  mat   - the matrix
6013 -  x,y - the vectors
6014 
6015    Level: intermediate
6016 
6017    Notes:
6018     This allows one to use either the restriction or interpolation (its transpose)
6019     matrix to do the interpolation
6020 
6021    Concepts: matrices^interpolation
6022 
6023 .seealso: MatMultAdd(), MatMultTransposeAdd(), MatRestrict()
6024 
6025 @*/
6026 PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat A,Vec x,Vec y)
6027 {
6028   PetscErrorCode ierr;
6029   PetscInt       M,N;
6030 
6031   PetscFunctionBegin;
6032   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6033   PetscValidHeaderSpecific(x,VEC_COOKIE,2);
6034   PetscValidHeaderSpecific(y,VEC_COOKIE,3);
6035   PetscValidType(A,1);
6036   ierr = MatPreallocated(A);CHKERRQ(ierr);
6037   ierr = MatGetSize(A,&M,&N);CHKERRQ(ierr);
6038   if (N > M) {
6039     ierr = MatMultTranspose(A,x,y);CHKERRQ(ierr);
6040   } else {
6041     ierr = MatMult(A,x,y);CHKERRQ(ierr);
6042   }
6043   PetscFunctionReturn(0);
6044 }
6045 
6046 #undef __FUNCT__
6047 #define __FUNCT__ "MatRestrict"
6048 /*@
6049    MatRestrict - y = A*x or A'*x
6050 
6051    Collective on Mat
6052 
6053    Input Parameters:
6054 +  mat   - the matrix
6055 -  x,y - the vectors
6056 
6057    Level: intermediate
6058 
6059    Notes:
6060     This allows one to use either the restriction or interpolation (its transpose)
6061     matrix to do the restriction
6062 
6063    Concepts: matrices^restriction
6064 
6065 .seealso: MatMultAdd(), MatMultTransposeAdd(), MatInterpolate()
6066 
6067 @*/
6068 PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat A,Vec x,Vec y)
6069 {
6070   PetscErrorCode ierr;
6071   PetscInt       M,N;
6072 
6073   PetscFunctionBegin;
6074   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6075   PetscValidHeaderSpecific(x,VEC_COOKIE,2);
6076   PetscValidHeaderSpecific(y,VEC_COOKIE,3);
6077   PetscValidType(A,1);
6078   ierr = MatPreallocated(A);CHKERRQ(ierr);
6079 
6080   ierr = MatGetSize(A,&M,&N);CHKERRQ(ierr);
6081   if (N > M) {
6082     ierr = MatMult(A,x,y);CHKERRQ(ierr);
6083   } else {
6084     ierr = MatMultTranspose(A,x,y);CHKERRQ(ierr);
6085   }
6086   PetscFunctionReturn(0);
6087 }
6088 
6089 #undef __FUNCT__
6090 #define __FUNCT__ "MatNullSpaceAttach"
6091 /*@
6092    MatNullSpaceAttach - attaches a null space to a matrix.
6093         This null space will be removed from the resulting vector whenever
6094         MatMult() is called
6095 
6096    Collective on Mat
6097 
6098    Input Parameters:
6099 +  mat - the matrix
6100 -  nullsp - the null space object
6101 
6102    Level: developer
6103 
6104    Notes:
6105       Overwrites any previous null space that may have been attached
6106 
6107    Concepts: null space^attaching to matrix
6108 
6109 .seealso: MatCreate(), MatNullSpaceCreate()
6110 @*/
6111 PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat mat,MatNullSpace nullsp)
6112 {
6113   PetscErrorCode ierr;
6114 
6115   PetscFunctionBegin;
6116   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
6117   PetscValidType(mat,1);
6118   PetscValidHeaderSpecific(nullsp,MAT_NULLSPACE_COOKIE,2);
6119   ierr = MatPreallocated(mat);CHKERRQ(ierr);
6120   ierr = PetscObjectReference((PetscObject)nullsp);CHKERRQ(ierr);
6121   if (mat->nullsp) { ierr = MatNullSpaceDestroy(mat->nullsp);CHKERRQ(ierr); }
6122   mat->nullsp = nullsp;
6123   PetscFunctionReturn(0);
6124 }
6125 
6126 #undef __FUNCT__
6127 #define __FUNCT__ "MatICCFactor"
6128 /*@
6129    MatICCFactor - Performs in-place incomplete Cholesky factorization of matrix.
6130 
6131    Collective on Mat
6132 
6133    Input Parameters:
6134 +  mat - the matrix
6135 .  row - row/column permutation
6136 .  fill - expected fill factor >= 1.0
6137 -  level - level of fill, for ICC(k)
6138 
6139    Notes:
6140    Probably really in-place only when level of fill is zero, otherwise allocates
6141    new space to store factored matrix and deletes previous memory.
6142 
6143    Most users should employ the simplified KSP interface for linear solvers
6144    instead of working directly with matrix algebra routines such as this.
6145    See, e.g., KSPCreate().
6146 
6147    Level: developer
6148 
6149    Concepts: matrices^incomplete Cholesky factorization
6150    Concepts: Cholesky factorization
6151 
6152 .seealso: MatICCFactorSymbolic(), MatLUFactorNumeric(), MatCholeskyFactor()
6153 @*/
6154 PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat mat,IS row,MatFactorInfo* info)
6155 {
6156   PetscErrorCode ierr;
6157 
6158   PetscFunctionBegin;
6159   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
6160   PetscValidType(mat,1);
6161   if (row) PetscValidHeaderSpecific(row,IS_COOKIE,2);
6162   PetscValidPointer(info,3);
6163   if (mat->rmap.N != mat->cmap.N) SETERRQ(PETSC_ERR_ARG_WRONG,"matrix must be square");
6164   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6165   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6166   if (!mat->ops->iccfactor) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
6167   ierr = MatPreallocated(mat);CHKERRQ(ierr);
6168   ierr = (*mat->ops->iccfactor)(mat,row,info);CHKERRQ(ierr);
6169   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
6170   PetscFunctionReturn(0);
6171 }
6172 
6173 #undef __FUNCT__
6174 #define __FUNCT__ "MatSetValuesAdic"
6175 /*@
6176    MatSetValuesAdic - Sets values computed with ADIC automatic differentiation into a matrix.
6177 
6178    Not Collective
6179 
6180    Input Parameters:
6181 +  mat - the matrix
6182 -  v - the values compute with ADIC
6183 
6184    Level: developer
6185 
6186    Notes:
6187      Must call MatSetColoring() before using this routine. Also this matrix must already
6188      have its nonzero pattern determined.
6189 
6190 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
6191           MatSetValues(), MatSetColoring(), MatSetValuesAdifor()
6192 @*/
6193 PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat mat,void *v)
6194 {
6195   PetscErrorCode ierr;
6196 
6197   PetscFunctionBegin;
6198   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
6199   PetscValidType(mat,1);
6200   PetscValidPointer(mat,2);
6201 
6202   if (!mat->assembled) {
6203     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Matrix must be already assembled");
6204   }
6205   ierr = PetscLogEventBegin(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
6206   if (!mat->ops->setvaluesadic) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
6207   ierr = (*mat->ops->setvaluesadic)(mat,v);CHKERRQ(ierr);
6208   ierr = PetscLogEventEnd(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
6209   ierr = MatView_Private(mat);CHKERRQ(ierr);
6210   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
6211   PetscFunctionReturn(0);
6212 }
6213 
6214 
6215 #undef __FUNCT__
6216 #define __FUNCT__ "MatSetColoring"
6217 /*@
6218    MatSetColoring - Sets a coloring used by calls to MatSetValuesAdic()
6219 
6220    Not Collective
6221 
6222    Input Parameters:
6223 +  mat - the matrix
6224 -  coloring - the coloring
6225 
6226    Level: developer
6227 
6228 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
6229           MatSetValues(), MatSetValuesAdic()
6230 @*/
6231 PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat mat,ISColoring coloring)
6232 {
6233   PetscErrorCode ierr;
6234 
6235   PetscFunctionBegin;
6236   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
6237   PetscValidType(mat,1);
6238   PetscValidPointer(coloring,2);
6239 
6240   if (!mat->assembled) {
6241     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Matrix must be already assembled");
6242   }
6243   if (!mat->ops->setcoloring) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
6244   ierr = (*mat->ops->setcoloring)(mat,coloring);CHKERRQ(ierr);
6245   PetscFunctionReturn(0);
6246 }
6247 
6248 #undef __FUNCT__
6249 #define __FUNCT__ "MatSetValuesAdifor"
6250 /*@
6251    MatSetValuesAdifor - Sets values computed with automatic differentiation into a matrix.
6252 
6253    Not Collective
6254 
6255    Input Parameters:
6256 +  mat - the matrix
6257 .  nl - leading dimension of v
6258 -  v - the values compute with ADIFOR
6259 
6260    Level: developer
6261 
6262    Notes:
6263      Must call MatSetColoring() before using this routine. Also this matrix must already
6264      have its nonzero pattern determined.
6265 
6266 .seealso: MatSetOption(), MatAssemblyBegin(), MatAssemblyEnd(), MatSetValuesBlocked(), MatSetValuesLocal(),
6267           MatSetValues(), MatSetColoring()
6268 @*/
6269 PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat mat,PetscInt nl,void *v)
6270 {
6271   PetscErrorCode ierr;
6272 
6273   PetscFunctionBegin;
6274   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
6275   PetscValidType(mat,1);
6276   PetscValidPointer(v,3);
6277 
6278   if (!mat->assembled) {
6279     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Matrix must be already assembled");
6280   }
6281   ierr = PetscLogEventBegin(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
6282   if (!mat->ops->setvaluesadifor) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
6283   ierr = (*mat->ops->setvaluesadifor)(mat,nl,v);CHKERRQ(ierr);
6284   ierr = PetscLogEventEnd(MAT_SetValues,mat,0,0,0);CHKERRQ(ierr);
6285   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
6286   PetscFunctionReturn(0);
6287 }
6288 
6289 #undef __FUNCT__
6290 #define __FUNCT__ "MatDiagonalScaleLocal"
6291 /*@
6292    MatDiagonalScaleLocal - Scales columns of a matrix given the scaling values including the
6293          ghosted ones.
6294 
6295    Not Collective
6296 
6297    Input Parameters:
6298 +  mat - the matrix
6299 -  diag = the diagonal values, including ghost ones
6300 
6301    Level: developer
6302 
6303    Notes: Works only for MPIAIJ and MPIBAIJ matrices
6304 
6305 .seealso: MatDiagonalScale()
6306 @*/
6307 PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat mat,Vec diag)
6308 {
6309   PetscErrorCode ierr;
6310   PetscMPIInt    size;
6311 
6312   PetscFunctionBegin;
6313   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
6314   PetscValidHeaderSpecific(diag,VEC_COOKIE,2);
6315   PetscValidType(mat,1);
6316 
6317   if (!mat->assembled) {
6318     SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Matrix must be already assembled");
6319   }
6320   ierr = PetscLogEventBegin(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
6321   ierr = MPI_Comm_size(((PetscObject)mat)->comm,&size);CHKERRQ(ierr);
6322   if (size == 1) {
6323     PetscInt n,m;
6324     ierr = VecGetSize(diag,&n);CHKERRQ(ierr);
6325     ierr = MatGetSize(mat,0,&m);CHKERRQ(ierr);
6326     if (m == n) {
6327       ierr = MatDiagonalScale(mat,0,diag);CHKERRQ(ierr);
6328     } else {
6329       SETERRQ(PETSC_ERR_SUP,"Only supported for sequential matrices when no ghost points/periodic conditions");
6330     }
6331   } else {
6332     PetscErrorCode (*f)(Mat,Vec);
6333     ierr = PetscObjectQueryFunction((PetscObject)mat,"MatDiagonalScaleLocal_C",(void (**)(void))&f);CHKERRQ(ierr);
6334     if (f) {
6335       ierr = (*f)(mat,diag);CHKERRQ(ierr);
6336     } else {
6337       SETERRQ(PETSC_ERR_SUP,"Only supported for MPIAIJ and MPIBAIJ parallel matrices");
6338     }
6339   }
6340   ierr = PetscLogEventEnd(MAT_Scale,mat,0,0,0);CHKERRQ(ierr);
6341   ierr = PetscObjectStateIncrease((PetscObject)mat);CHKERRQ(ierr);
6342   PetscFunctionReturn(0);
6343 }
6344 
6345 #undef __FUNCT__
6346 #define __FUNCT__ "MatGetInertia"
6347 /*@
6348    MatGetInertia - Gets the inertia from a factored matrix
6349 
6350    Collective on Mat
6351 
6352    Input Parameter:
6353 .  mat - the matrix
6354 
6355    Output Parameters:
6356 +   nneg - number of negative eigenvalues
6357 .   nzero - number of zero eigenvalues
6358 -   npos - number of positive eigenvalues
6359 
6360    Level: advanced
6361 
6362    Notes: Matrix must have been factored by MatCholeskyFactor()
6363 
6364 
6365 @*/
6366 PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat mat,PetscInt *nneg,PetscInt *nzero,PetscInt *npos)
6367 {
6368   PetscErrorCode ierr;
6369 
6370   PetscFunctionBegin;
6371   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
6372   PetscValidType(mat,1);
6373   if (!mat->factor)    SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
6374   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Numeric factor mat is not assembled");
6375   if (!mat->ops->getinertia) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
6376   ierr = (*mat->ops->getinertia)(mat,nneg,nzero,npos);CHKERRQ(ierr);
6377   PetscFunctionReturn(0);
6378 }
6379 
6380 /* ----------------------------------------------------------------*/
6381 #undef __FUNCT__
6382 #define __FUNCT__ "MatSolves"
6383 /*@
6384    MatSolves - Solves A x = b, given a factored matrix, for a collection of vectors
6385 
6386    Collective on Mat and Vecs
6387 
6388    Input Parameters:
6389 +  mat - the factored matrix
6390 -  b - the right-hand-side vectors
6391 
6392    Output Parameter:
6393 .  x - the result vectors
6394 
6395    Notes:
6396    The vectors b and x cannot be the same.  I.e., one cannot
6397    call MatSolves(A,x,x).
6398 
6399    Notes:
6400    Most users should employ the simplified KSP interface for linear solvers
6401    instead of working directly with matrix algebra routines such as this.
6402    See, e.g., KSPCreate().
6403 
6404    Level: developer
6405 
6406    Concepts: matrices^triangular solves
6407 
6408 .seealso: MatSolveAdd(), MatSolveTranspose(), MatSolveTransposeAdd(), MatSolve()
6409 @*/
6410 PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat mat,Vecs b,Vecs x)
6411 {
6412   PetscErrorCode ierr;
6413 
6414   PetscFunctionBegin;
6415   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
6416   PetscValidType(mat,1);
6417   if (x == b) SETERRQ(PETSC_ERR_ARG_IDN,"x and b must be different vectors");
6418   if (!mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Unfactored matrix");
6419   if (!mat->rmap.N && !mat->cmap.N) PetscFunctionReturn(0);
6420 
6421   if (!mat->ops->solves) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
6422   ierr = MatPreallocated(mat);CHKERRQ(ierr);
6423   ierr = PetscLogEventBegin(MAT_Solves,mat,0,0,0);CHKERRQ(ierr);
6424   ierr = (*mat->ops->solves)(mat,b,x);CHKERRQ(ierr);
6425   ierr = PetscLogEventEnd(MAT_Solves,mat,0,0,0);CHKERRQ(ierr);
6426   PetscFunctionReturn(0);
6427 }
6428 
6429 #undef __FUNCT__
6430 #define __FUNCT__ "MatIsSymmetric"
6431 /*@
6432    MatIsSymmetric - Test whether a matrix is symmetric
6433 
6434    Collective on Mat
6435 
6436    Input Parameter:
6437 +  A - the matrix to test
6438 -  tol - difference between value and its transpose less than this amount counts as equal (use 0.0 for exact transpose)
6439 
6440    Output Parameters:
6441 .  flg - the result
6442 
6443    Level: intermediate
6444 
6445    Concepts: matrix^symmetry
6446 
6447 .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetricKnown()
6448 @*/
6449 PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat A,PetscReal tol,PetscTruth *flg)
6450 {
6451   PetscErrorCode ierr;
6452 
6453   PetscFunctionBegin;
6454   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6455   PetscValidPointer(flg,2);
6456   if (!A->symmetric_set) {
6457     if (!A->ops->issymmetric) {
6458       MatType mattype;
6459       ierr = MatGetType(A,&mattype);CHKERRQ(ierr);
6460       SETERRQ1(PETSC_ERR_SUP,"Matrix of type <%s> does not support checking for symmetric",mattype);
6461     }
6462     ierr = (*A->ops->issymmetric)(A,tol,&A->symmetric);CHKERRQ(ierr);
6463     A->symmetric_set = PETSC_TRUE;
6464     if (A->symmetric) {
6465       A->structurally_symmetric_set = PETSC_TRUE;
6466       A->structurally_symmetric     = PETSC_TRUE;
6467     }
6468   }
6469   *flg = A->symmetric;
6470   PetscFunctionReturn(0);
6471 }
6472 
6473 #undef __FUNCT__
6474 #define __FUNCT__ "MatIsHermitian"
6475 /*@
6476    MatIsHermitian - Test whether a matrix is Hermitian
6477 
6478    Collective on Mat
6479 
6480    Input Parameter:
6481 +  A - the matrix to test
6482 -  tol - difference between value and its transpose less than this amount counts as equal (use 0.0 for exact Hermitian)
6483 
6484    Output Parameters:
6485 .  flg - the result
6486 
6487    Level: intermediate
6488 
6489    Concepts: matrix^symmetry
6490 
6491 .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetricKnown()
6492 @*/
6493 PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat A,PetscReal tol,PetscTruth *flg)
6494 {
6495   PetscErrorCode ierr;
6496 
6497   PetscFunctionBegin;
6498   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6499   PetscValidPointer(flg,2);
6500   if (!A->hermitian_set) {
6501     if (!A->ops->ishermitian) {
6502       MatType mattype;
6503       ierr = MatGetType(A,&mattype);CHKERRQ(ierr);
6504       SETERRQ1(PETSC_ERR_SUP,"Matrix of type <%s> does not support checking for Hermitian",mattype);
6505     }
6506     ierr = (*A->ops->ishermitian)(A,tol,&A->hermitian);CHKERRQ(ierr);
6507     A->hermitian_set = PETSC_TRUE;
6508     if (A->hermitian) {
6509       A->structurally_symmetric_set = PETSC_TRUE;
6510       A->structurally_symmetric     = PETSC_TRUE;
6511     }
6512   }
6513   *flg = A->hermitian;
6514   PetscFunctionReturn(0);
6515 }
6516 
6517 #undef __FUNCT__
6518 #define __FUNCT__ "MatIsSymmetricKnown"
6519 /*@
6520    MatIsSymmetricKnown - Checks the flag on the matrix to see if it is symmetric.
6521 
6522    Collective on Mat
6523 
6524    Input Parameter:
6525 .  A - the matrix to check
6526 
6527    Output Parameters:
6528 +  set - if the symmetric flag is set (this tells you if the next flag is valid)
6529 -  flg - the result
6530 
6531    Level: advanced
6532 
6533    Concepts: matrix^symmetry
6534 
6535    Note: Does not check the matrix values directly, so this may return unknown (set = PETSC_FALSE). Use MatIsSymmetric()
6536          if you want it explicitly checked
6537 
6538 .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetric()
6539 @*/
6540 PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat A,PetscTruth *set,PetscTruth *flg)
6541 {
6542   PetscFunctionBegin;
6543   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6544   PetscValidPointer(set,2);
6545   PetscValidPointer(flg,3);
6546   if (A->symmetric_set) {
6547     *set = PETSC_TRUE;
6548     *flg = A->symmetric;
6549   } else {
6550     *set = PETSC_FALSE;
6551   }
6552   PetscFunctionReturn(0);
6553 }
6554 
6555 #undef __FUNCT__
6556 #define __FUNCT__ "MatIsHermitianKnown"
6557 /*@
6558    MatIsHermitianKnown - Checks the flag on the matrix to see if it is hermitian.
6559 
6560    Collective on Mat
6561 
6562    Input Parameter:
6563 .  A - the matrix to check
6564 
6565    Output Parameters:
6566 +  set - if the hermitian flag is set (this tells you if the next flag is valid)
6567 -  flg - the result
6568 
6569    Level: advanced
6570 
6571    Concepts: matrix^symmetry
6572 
6573    Note: Does not check the matrix values directly, so this may return unknown (set = PETSC_FALSE). Use MatIsHermitian()
6574          if you want it explicitly checked
6575 
6576 .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsStructurallySymmetric(), MatSetOption(), MatIsSymmetric()
6577 @*/
6578 PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat A,PetscTruth *set,PetscTruth *flg)
6579 {
6580   PetscFunctionBegin;
6581   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6582   PetscValidPointer(set,2);
6583   PetscValidPointer(flg,3);
6584   if (A->hermitian_set) {
6585     *set = PETSC_TRUE;
6586     *flg = A->hermitian;
6587   } else {
6588     *set = PETSC_FALSE;
6589   }
6590   PetscFunctionReturn(0);
6591 }
6592 
6593 #undef __FUNCT__
6594 #define __FUNCT__ "MatIsStructurallySymmetric"
6595 /*@
6596    MatIsStructurallySymmetric - Test whether a matrix is structurally symmetric
6597 
6598    Collective on Mat
6599 
6600    Input Parameter:
6601 .  A - the matrix to test
6602 
6603    Output Parameters:
6604 .  flg - the result
6605 
6606    Level: intermediate
6607 
6608    Concepts: matrix^symmetry
6609 
6610 .seealso: MatTranspose(), MatIsTranspose(), MatIsHermitian(), MatIsSymmetric(), MatSetOption()
6611 @*/
6612 PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat A,PetscTruth *flg)
6613 {
6614   PetscErrorCode ierr;
6615 
6616   PetscFunctionBegin;
6617   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6618   PetscValidPointer(flg,2);
6619   if (!A->structurally_symmetric_set) {
6620     if (!A->ops->isstructurallysymmetric) SETERRQ(PETSC_ERR_SUP,"Matrix does not support checking for structural symmetric");
6621     ierr = (*A->ops->isstructurallysymmetric)(A,&A->structurally_symmetric);CHKERRQ(ierr);
6622     A->structurally_symmetric_set = PETSC_TRUE;
6623   }
6624   *flg = A->structurally_symmetric;
6625   PetscFunctionReturn(0);
6626 }
6627 
6628 #undef __FUNCT__
6629 #define __FUNCT__ "MatStashGetInfo"
6630 extern PetscErrorCode MatStashGetInfo_Private(MatStash*,PetscInt*,PetscInt*);
6631 /*@
6632    MatStashGetInfo - Gets how many values are currently in the vector stash, i.e. need
6633        to be communicated to other processors during the MatAssemblyBegin/End() process
6634 
6635     Not collective
6636 
6637    Input Parameter:
6638 .   vec - the vector
6639 
6640    Output Parameters:
6641 +   nstash   - the size of the stash
6642 .   reallocs - the number of additional mallocs incurred.
6643 .   bnstash   - the size of the block stash
6644 -   breallocs - the number of additional mallocs incurred.in the block stash
6645 
6646    Level: advanced
6647 
6648 .seealso: MatAssemblyBegin(), MatAssemblyEnd(), Mat, MatStashSetInitialSize()
6649 
6650 @*/
6651 PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat mat,PetscInt *nstash,PetscInt *reallocs,PetscInt *bnstash,PetscInt *breallocs)
6652 {
6653   PetscErrorCode ierr;
6654   PetscFunctionBegin;
6655   ierr = MatStashGetInfo_Private(&mat->stash,nstash,reallocs);CHKERRQ(ierr);
6656   ierr = MatStashGetInfo_Private(&mat->bstash,bnstash,breallocs);CHKERRQ(ierr);
6657   PetscFunctionReturn(0);
6658 }
6659 
6660 #undef __FUNCT__
6661 #define __FUNCT__ "MatGetVecs"
6662 /*@
6663    MatGetVecs - Get vector(s) compatible with the matrix, i.e. with the same
6664      parallel layout
6665 
6666    Collective on Mat
6667 
6668    Input Parameter:
6669 .  mat - the matrix
6670 
6671    Output Parameter:
6672 +   right - (optional) vector that the matrix can be multiplied against
6673 -   left - (optional) vector that the matrix vector product can be stored in
6674 
6675   Level: advanced
6676 
6677 .seealso: MatCreate()
6678 @*/
6679 PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat mat,Vec *right,Vec *left)
6680 {
6681   PetscErrorCode ierr;
6682 
6683   PetscFunctionBegin;
6684   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
6685   PetscValidType(mat,1);
6686   ierr = MatPreallocated(mat);CHKERRQ(ierr);
6687   if (mat->ops->getvecs) {
6688     ierr = (*mat->ops->getvecs)(mat,right,left);CHKERRQ(ierr);
6689   } else {
6690     PetscMPIInt size;
6691     ierr = MPI_Comm_size(((PetscObject)mat)->comm, &size);CHKERRQ(ierr);
6692     if (right) {
6693       ierr = VecCreate(((PetscObject)mat)->comm,right);CHKERRQ(ierr);
6694       ierr = VecSetSizes(*right,mat->cmap.n,PETSC_DETERMINE);CHKERRQ(ierr);
6695       if (size > 1) {ierr = VecSetType(*right,VECMPI);CHKERRQ(ierr);}
6696       else {ierr = VecSetType(*right,VECSEQ);CHKERRQ(ierr);}
6697     }
6698     if (left) {
6699       ierr = VecCreate(((PetscObject)mat)->comm,left);CHKERRQ(ierr);
6700       ierr = VecSetSizes(*left,mat->rmap.n,PETSC_DETERMINE);CHKERRQ(ierr);
6701       if (size > 1) {ierr = VecSetType(*left,VECMPI);CHKERRQ(ierr);}
6702       else {ierr = VecSetType(*left,VECSEQ);CHKERRQ(ierr);}
6703     }
6704   }
6705   if (right) {ierr = VecSetBlockSize(*right,mat->rmap.bs);CHKERRQ(ierr);}
6706   if (left) {ierr = VecSetBlockSize(*left,mat->rmap.bs);CHKERRQ(ierr);}
6707   if (mat->mapping) {
6708     if (right) {ierr = VecSetLocalToGlobalMapping(*right,mat->mapping);CHKERRQ(ierr);}
6709     if (left) {ierr = VecSetLocalToGlobalMapping(*left,mat->mapping);CHKERRQ(ierr);}
6710   }
6711   if (mat->bmapping) {
6712     if (right) {ierr = VecSetLocalToGlobalMappingBlock(*right,mat->bmapping);CHKERRQ(ierr);}
6713     if (left) {ierr = VecSetLocalToGlobalMappingBlock(*left,mat->bmapping);CHKERRQ(ierr);}
6714   }
6715   PetscFunctionReturn(0);
6716 }
6717 
6718 #undef __FUNCT__
6719 #define __FUNCT__ "MatFactorInfoInitialize"
6720 /*@
6721    MatFactorInfoInitialize - Initializes a MatFactorInfo data structure
6722      with default values.
6723 
6724    Not Collective
6725 
6726    Input Parameters:
6727 .    info - the MatFactorInfo data structure
6728 
6729 
6730    Notes: The solvers are generally used through the KSP and PC objects, for example
6731           PCLU, PCILU, PCCHOLESKY, PCICC
6732 
6733    Level: developer
6734 
6735 .seealso: MatFactorInfo
6736 @*/
6737 
6738 PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo *info)
6739 {
6740   PetscErrorCode ierr;
6741 
6742   PetscFunctionBegin;
6743   ierr = PetscMemzero(info,sizeof(MatFactorInfo));CHKERRQ(ierr);
6744   PetscFunctionReturn(0);
6745 }
6746 
6747 #undef __FUNCT__
6748 #define __FUNCT__ "MatPtAP"
6749 /*@
6750    MatPtAP - Creates the matrix projection C = P^T * A * P
6751 
6752    Collective on Mat
6753 
6754    Input Parameters:
6755 +  A - the matrix
6756 .  P - the projection matrix
6757 .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
6758 -  fill - expected fill as ratio of nnz(C)/nnz(A)
6759 
6760    Output Parameters:
6761 .  C - the product matrix
6762 
6763    Notes:
6764    C will be created and must be destroyed by the user with MatDestroy().
6765 
6766    This routine is currently only implemented for pairs of AIJ matrices and classes
6767    which inherit from AIJ.
6768 
6769    Level: intermediate
6770 
6771 .seealso: MatPtAPSymbolic(), MatPtAPNumeric(), MatMatMult()
6772 @*/
6773 PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat A,Mat P,MatReuse scall,PetscReal fill,Mat *C)
6774 {
6775   PetscErrorCode ierr;
6776 
6777   PetscFunctionBegin;
6778   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6779   PetscValidType(A,1);
6780   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6781   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6782   PetscValidHeaderSpecific(P,MAT_COOKIE,2);
6783   PetscValidType(P,2);
6784   MatPreallocated(P);
6785   if (!P->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6786   if (P->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6787   PetscValidPointer(C,3);
6788   if (P->rmap.N!=A->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->rmap.N,A->cmap.N);
6789   if (fill < 1.0) SETERRQ1(PETSC_ERR_ARG_SIZ,"Expected fill=%G must be >= 1.0",fill);
6790   ierr = MatPreallocated(A);CHKERRQ(ierr);
6791 
6792   ierr = PetscLogEventBegin(MAT_PtAP,A,P,0,0);CHKERRQ(ierr);
6793   ierr = (*A->ops->ptap)(A,P,scall,fill,C);CHKERRQ(ierr);
6794   ierr = PetscLogEventEnd(MAT_PtAP,A,P,0,0);CHKERRQ(ierr);
6795 
6796   PetscFunctionReturn(0);
6797 }
6798 
6799 #undef __FUNCT__
6800 #define __FUNCT__ "MatPtAPNumeric"
6801 /*@
6802    MatPtAPNumeric - Computes the matrix projection C = P^T * A * P
6803 
6804    Collective on Mat
6805 
6806    Input Parameters:
6807 +  A - the matrix
6808 -  P - the projection matrix
6809 
6810    Output Parameters:
6811 .  C - the product matrix
6812 
6813    Notes:
6814    C must have been created by calling MatPtAPSymbolic and must be destroyed by
6815    the user using MatDeatroy().
6816 
6817    This routine is currently only implemented for pairs of AIJ matrices and classes
6818    which inherit from AIJ.  C will be of type MATAIJ.
6819 
6820    Level: intermediate
6821 
6822 .seealso: MatPtAP(), MatPtAPSymbolic(), MatMatMultNumeric()
6823 @*/
6824 PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat A,Mat P,Mat C)
6825 {
6826   PetscErrorCode ierr;
6827 
6828   PetscFunctionBegin;
6829   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6830   PetscValidType(A,1);
6831   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6832   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6833   PetscValidHeaderSpecific(P,MAT_COOKIE,2);
6834   PetscValidType(P,2);
6835   MatPreallocated(P);
6836   if (!P->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6837   if (P->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6838   PetscValidHeaderSpecific(C,MAT_COOKIE,3);
6839   PetscValidType(C,3);
6840   MatPreallocated(C);
6841   if (C->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6842   if (P->cmap.N!=C->rmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->cmap.N,C->rmap.N);
6843   if (P->rmap.N!=A->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->rmap.N,A->cmap.N);
6844   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);
6845   if (P->cmap.N!=C->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->cmap.N,C->cmap.N);
6846   ierr = MatPreallocated(A);CHKERRQ(ierr);
6847 
6848   ierr = PetscLogEventBegin(MAT_PtAPNumeric,A,P,0,0);CHKERRQ(ierr);
6849   ierr = (*A->ops->ptapnumeric)(A,P,C);CHKERRQ(ierr);
6850   ierr = PetscLogEventEnd(MAT_PtAPNumeric,A,P,0,0);CHKERRQ(ierr);
6851   PetscFunctionReturn(0);
6852 }
6853 
6854 #undef __FUNCT__
6855 #define __FUNCT__ "MatPtAPSymbolic"
6856 /*@
6857    MatPtAPSymbolic - Creates the (i,j) structure of the matrix projection C = P^T * A * P
6858 
6859    Collective on Mat
6860 
6861    Input Parameters:
6862 +  A - the matrix
6863 -  P - the projection matrix
6864 
6865    Output Parameters:
6866 .  C - the (i,j) structure of the product matrix
6867 
6868    Notes:
6869    C will be created and must be destroyed by the user with MatDestroy().
6870 
6871    This routine is currently only implemented for pairs of SeqAIJ matrices and classes
6872    which inherit from SeqAIJ.  C will be of type MATSEQAIJ.  The product is computed using
6873    this (i,j) structure by calling MatPtAPNumeric().
6874 
6875    Level: intermediate
6876 
6877 .seealso: MatPtAP(), MatPtAPNumeric(), MatMatMultSymbolic()
6878 @*/
6879 PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat A,Mat P,PetscReal fill,Mat *C)
6880 {
6881   PetscErrorCode ierr;
6882 
6883   PetscFunctionBegin;
6884   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6885   PetscValidType(A,1);
6886   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6887   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6888   if (fill <1.0) SETERRQ1(PETSC_ERR_ARG_SIZ,"Expected fill=%G must be >= 1.0",fill);
6889   PetscValidHeaderSpecific(P,MAT_COOKIE,2);
6890   PetscValidType(P,2);
6891   MatPreallocated(P);
6892   if (!P->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6893   if (P->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6894   PetscValidPointer(C,3);
6895 
6896   if (P->rmap.N!=A->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",P->rmap.N,A->cmap.N);
6897   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);
6898   ierr = MatPreallocated(A);CHKERRQ(ierr);
6899   ierr = PetscLogEventBegin(MAT_PtAPSymbolic,A,P,0,0);CHKERRQ(ierr);
6900   ierr = (*A->ops->ptapsymbolic)(A,P,fill,C);CHKERRQ(ierr);
6901   ierr = PetscLogEventEnd(MAT_PtAPSymbolic,A,P,0,0);CHKERRQ(ierr);
6902 
6903   ierr = MatSetBlockSize(*C,A->rmap.bs);CHKERRQ(ierr);
6904 
6905   PetscFunctionReturn(0);
6906 }
6907 
6908 #undef __FUNCT__
6909 #define __FUNCT__ "MatMatMult"
6910 /*@
6911    MatMatMult - Performs Matrix-Matrix Multiplication C=A*B.
6912 
6913    Collective on Mat
6914 
6915    Input Parameters:
6916 +  A - the left matrix
6917 .  B - the right matrix
6918 .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
6919 -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(B))
6920 
6921    Output Parameters:
6922 .  C - the product matrix
6923 
6924    Notes:
6925    C will be created and must be destroyed by the user with MatDestroy().
6926    Unless scall is MAT_REUSE_MATRIX
6927 
6928    If you have many matrices with the same non-zero structure to multiply, you
6929    should either
6930 $   1) use MAT_REUSE_MATRIX in all calls but the first or
6931 $   2) call MatMatMultSymbolic() once and then MatMatMultNumeric() for each product needed
6932 
6933    Level: intermediate
6934 
6935 .seealso: MatMatMultSymbolic(), MatMatMultNumeric(), MatPtAP()
6936 @*/
6937 PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat A,Mat B,MatReuse scall,PetscReal fill,Mat *C)
6938 {
6939   PetscErrorCode ierr;
6940   PetscErrorCode (*fA)(Mat,Mat,MatReuse,PetscReal,Mat*);
6941   PetscErrorCode (*fB)(Mat,Mat,MatReuse,PetscReal,Mat*);
6942   PetscErrorCode (*mult)(Mat,Mat,MatReuse,PetscReal,Mat *)=PETSC_NULL;
6943 
6944   PetscFunctionBegin;
6945   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
6946   PetscValidType(A,1);
6947   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6948   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6949   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
6950   PetscValidType(B,2);
6951   MatPreallocated(B);
6952   if (!B->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
6953   if (B->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
6954   PetscValidPointer(C,3);
6955   if (B->rmap.N!=A->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",B->rmap.N,A->cmap.N);
6956   if (scall == MAT_REUSE_MATRIX){
6957     PetscValidPointer(*C,5);
6958     PetscValidHeaderSpecific(*C,MAT_COOKIE,5);
6959   }
6960   if (fill == PETSC_DEFAULT) fill = 2.0;
6961   if (fill < 1.0) SETERRQ1(PETSC_ERR_ARG_SIZ,"Expected fill=%G must be >= 1.0",fill);
6962   ierr = MatPreallocated(A);CHKERRQ(ierr);
6963 
6964   fA = A->ops->matmult;
6965   fB = B->ops->matmult;
6966   if (fB == fA) {
6967     if (!fB) SETERRQ1(PETSC_ERR_SUP,"MatMatMult not supported for B of type %s",((PetscObject)B)->type_name);
6968     mult = fB;
6969   } else {
6970     /* dispatch based on the type of A and B */
6971     char  multname[256];
6972     ierr = PetscStrcpy(multname,"MatMatMult_");CHKERRQ(ierr);
6973     ierr = PetscStrcat(multname,((PetscObject)A)->type_name);CHKERRQ(ierr);
6974     ierr = PetscStrcat(multname,"_");CHKERRQ(ierr);
6975     ierr = PetscStrcat(multname,((PetscObject)B)->type_name);CHKERRQ(ierr);
6976     ierr = PetscStrcat(multname,"_C");CHKERRQ(ierr); /* e.g., multname = "MatMatMult_aij_dense_C" */
6977     ierr = PetscObjectQueryFunction((PetscObject)B,multname,(void (**)(void))&mult);CHKERRQ(ierr);
6978     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);
6979   }
6980   ierr = PetscLogEventBegin(MAT_MatMult,A,B,0,0);CHKERRQ(ierr);
6981   ierr = (*mult)(A,B,scall,fill,C);CHKERRQ(ierr);
6982   ierr = PetscLogEventEnd(MAT_MatMult,A,B,0,0);CHKERRQ(ierr);
6983   PetscFunctionReturn(0);
6984 }
6985 
6986 #undef __FUNCT__
6987 #define __FUNCT__ "MatMatMultSymbolic"
6988 /*@
6989    MatMatMultSymbolic - Performs construction, preallocation, and computes the ij structure
6990    of the matrix-matrix product C=A*B.  Call this routine before calling MatMatMultNumeric().
6991 
6992    Collective on Mat
6993 
6994    Input Parameters:
6995 +  A - the left matrix
6996 .  B - the right matrix
6997 -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(B))
6998 
6999    Output Parameters:
7000 .  C - the matrix containing the ij structure of product matrix
7001 
7002    Notes:
7003    C will be created and must be destroyed by the user with MatDestroy().
7004 
7005    This routine is currently implemented for
7006     - pairs of AIJ matrices and classes which inherit from AIJ, C will be of type MATAIJ.
7007     - pairs of AIJ (A) and Dense (B) matrix, C will be of type MATDENSE.
7008 
7009    Level: intermediate
7010 
7011 .seealso: MatMatMult(), MatMatMultNumeric()
7012 @*/
7013 PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat A,Mat B,PetscReal fill,Mat *C)
7014 {
7015   PetscErrorCode ierr;
7016   PetscErrorCode (*Asymbolic)(Mat,Mat,PetscReal,Mat *);
7017   PetscErrorCode (*Bsymbolic)(Mat,Mat,PetscReal,Mat *);
7018   PetscErrorCode (*symbolic)(Mat,Mat,PetscReal,Mat *)=PETSC_NULL;
7019 
7020   PetscFunctionBegin;
7021   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
7022   PetscValidType(A,1);
7023   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
7024   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
7025 
7026   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
7027   PetscValidType(B,2);
7028   MatPreallocated(B);
7029   if (!B->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
7030   if (B->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
7031   PetscValidPointer(C,3);
7032 
7033   if (B->rmap.N!=A->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",B->rmap.N,A->cmap.N);
7034   if (fill == PETSC_DEFAULT) fill = 2.0;
7035   if (fill < 1.0) SETERRQ1(PETSC_ERR_ARG_SIZ,"Expected fill=%G must be > 1.0",fill);
7036   ierr = MatPreallocated(A);CHKERRQ(ierr);
7037 
7038   Asymbolic = A->ops->matmultsymbolic;
7039   Bsymbolic = B->ops->matmultsymbolic;
7040   if (Asymbolic == Bsymbolic){
7041     if (!Bsymbolic) SETERRQ1(PETSC_ERR_SUP,"C=A*B not implemented for B of type %s",((PetscObject)B)->type_name);
7042     symbolic = Bsymbolic;
7043   } else { /* dispatch based on the type of A and B */
7044     char  symbolicname[256];
7045     ierr = PetscStrcpy(symbolicname,"MatMatMultSymbolic_");CHKERRQ(ierr);
7046     ierr = PetscStrcat(symbolicname,((PetscObject)A)->type_name);CHKERRQ(ierr);
7047     ierr = PetscStrcat(symbolicname,"_");CHKERRQ(ierr);
7048     ierr = PetscStrcat(symbolicname,((PetscObject)B)->type_name);CHKERRQ(ierr);
7049     ierr = PetscStrcat(symbolicname,"_C");CHKERRQ(ierr);
7050     ierr = PetscObjectQueryFunction((PetscObject)B,symbolicname,(void (**)(void))&symbolic);CHKERRQ(ierr);
7051     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);
7052   }
7053   ierr = PetscLogEventBegin(MAT_MatMultSymbolic,A,B,0,0);CHKERRQ(ierr);
7054   ierr = (*symbolic)(A,B,fill,C);CHKERRQ(ierr);
7055   ierr = PetscLogEventEnd(MAT_MatMultSymbolic,A,B,0,0);CHKERRQ(ierr);
7056   PetscFunctionReturn(0);
7057 }
7058 
7059 #undef __FUNCT__
7060 #define __FUNCT__ "MatMatMultNumeric"
7061 /*@
7062    MatMatMultNumeric - Performs the numeric matrix-matrix product.
7063    Call this routine after first calling MatMatMultSymbolic().
7064 
7065    Collective on Mat
7066 
7067    Input Parameters:
7068 +  A - the left matrix
7069 -  B - the right matrix
7070 
7071    Output Parameters:
7072 .  C - the product matrix, whose ij structure was defined from MatMatMultSymbolic().
7073 
7074    Notes:
7075    C must have been created with MatMatMultSymbolic.
7076 
7077    This routine is currently implemented for
7078     - pairs of AIJ matrices and classes which inherit from AIJ, C will be of type MATAIJ.
7079     - pairs of AIJ (A) and Dense (B) matrix, C will be of type MATDENSE.
7080 
7081    Level: intermediate
7082 
7083 .seealso: MatMatMult(), MatMatMultSymbolic()
7084 @*/
7085 PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat A,Mat B,Mat C)
7086 {
7087   PetscErrorCode ierr;
7088   PetscErrorCode (*Anumeric)(Mat,Mat,Mat);
7089   PetscErrorCode (*Bnumeric)(Mat,Mat,Mat);
7090   PetscErrorCode (*numeric)(Mat,Mat,Mat)=PETSC_NULL;
7091 
7092   PetscFunctionBegin;
7093   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
7094   PetscValidType(A,1);
7095   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
7096   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
7097 
7098   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
7099   PetscValidType(B,2);
7100   MatPreallocated(B);
7101   if (!B->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
7102   if (B->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
7103 
7104   PetscValidHeaderSpecific(C,MAT_COOKIE,3);
7105   PetscValidType(C,3);
7106   MatPreallocated(C);
7107   if (!C->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
7108   if (C->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
7109 
7110   if (B->cmap.N!=C->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",B->cmap.N,C->cmap.N);
7111   if (B->rmap.N!=A->cmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",B->rmap.N,A->cmap.N);
7112   if (A->rmap.N!=C->rmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",A->rmap.N,C->rmap.N);
7113   ierr = MatPreallocated(A);CHKERRQ(ierr);
7114 
7115   Anumeric = A->ops->matmultnumeric;
7116   Bnumeric = B->ops->matmultnumeric;
7117   if (Anumeric == Bnumeric){
7118     if (!Bnumeric) SETERRQ1(PETSC_ERR_SUP,"MatMatMultNumeric not supported for B of type %s",((PetscObject)B)->type_name);
7119     numeric = Bnumeric;
7120   } else {
7121     char  numericname[256];
7122     ierr = PetscStrcpy(numericname,"MatMatMultNumeric_");CHKERRQ(ierr);
7123     ierr = PetscStrcat(numericname,((PetscObject)A)->type_name);CHKERRQ(ierr);
7124     ierr = PetscStrcat(numericname,"_");CHKERRQ(ierr);
7125     ierr = PetscStrcat(numericname,((PetscObject)B)->type_name);CHKERRQ(ierr);
7126     ierr = PetscStrcat(numericname,"_C");CHKERRQ(ierr);
7127     ierr = PetscObjectQueryFunction((PetscObject)B,numericname,(void (**)(void))&numeric);CHKERRQ(ierr);
7128     if (!numeric)
7129       SETERRQ2(PETSC_ERR_ARG_INCOMP,"MatMatMultNumeric requires A, %s, to be compatible with B, %s",((PetscObject)A)->type_name,((PetscObject)B)->type_name);
7130   }
7131   ierr = PetscLogEventBegin(MAT_MatMultNumeric,A,B,0,0);CHKERRQ(ierr);
7132   ierr = (*numeric)(A,B,C);CHKERRQ(ierr);
7133   ierr = PetscLogEventEnd(MAT_MatMultNumeric,A,B,0,0);CHKERRQ(ierr);
7134   PetscFunctionReturn(0);
7135 }
7136 
7137 #undef __FUNCT__
7138 #define __FUNCT__ "MatMatMultTranspose"
7139 /*@
7140    MatMatMultTranspose - Performs Matrix-Matrix Multiplication C=A^T*B.
7141 
7142    Collective on Mat
7143 
7144    Input Parameters:
7145 +  A - the left matrix
7146 .  B - the right matrix
7147 .  scall - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
7148 -  fill - expected fill as ratio of nnz(C)/(nnz(A) + nnz(B))
7149 
7150    Output Parameters:
7151 .  C - the product matrix
7152 
7153    Notes:
7154    C will be created and must be destroyed by the user with MatDestroy().
7155 
7156    This routine is currently only implemented for pairs of SeqAIJ matrices and classes
7157    which inherit from SeqAIJ.  C will be of type MATSEQAIJ.
7158 
7159    Level: intermediate
7160 
7161 .seealso: MatMatMultTransposeSymbolic(), MatMatMultTransposeNumeric(), MatPtAP()
7162 @*/
7163 PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat A,Mat B,MatReuse scall,PetscReal fill,Mat *C)
7164 {
7165   PetscErrorCode ierr;
7166   PetscErrorCode (*fA)(Mat,Mat,MatReuse,PetscReal,Mat*);
7167   PetscErrorCode (*fB)(Mat,Mat,MatReuse,PetscReal,Mat*);
7168 
7169   PetscFunctionBegin;
7170   PetscValidHeaderSpecific(A,MAT_COOKIE,1);
7171   PetscValidType(A,1);
7172   if (!A->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
7173   if (A->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
7174   PetscValidHeaderSpecific(B,MAT_COOKIE,2);
7175   PetscValidType(B,2);
7176   MatPreallocated(B);
7177   if (!B->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
7178   if (B->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
7179   PetscValidPointer(C,3);
7180   if (B->rmap.N!=A->rmap.N) SETERRQ2(PETSC_ERR_ARG_SIZ,"Matrix dimensions are incompatible, %D != %D",B->rmap.N,A->rmap.N);
7181   if (fill < 1.0) SETERRQ1(PETSC_ERR_ARG_SIZ,"Expected fill=%G must be > 1.0",fill);
7182   ierr = MatPreallocated(A);CHKERRQ(ierr);
7183 
7184   fA = A->ops->matmulttranspose;
7185   if (!fA) SETERRQ1(PETSC_ERR_SUP,"MatMatMultTranspose not supported for A of type %s",((PetscObject)A)->type_name);
7186   fB = B->ops->matmulttranspose;
7187   if (!fB) SETERRQ1(PETSC_ERR_SUP,"MatMatMultTranspose not supported for B of type %s",((PetscObject)B)->type_name);
7188   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);
7189 
7190   ierr = PetscLogEventBegin(MAT_MatMultTranspose,A,B,0,0);CHKERRQ(ierr);
7191   ierr = (*A->ops->matmulttranspose)(A,B,scall,fill,C);CHKERRQ(ierr);
7192   ierr = PetscLogEventEnd(MAT_MatMultTranspose,A,B,0,0);CHKERRQ(ierr);
7193 
7194   PetscFunctionReturn(0);
7195 }
7196 
7197 #undef __FUNCT__
7198 #define __FUNCT__ "MatGetRedundantMatrix"
7199 /*@C
7200    MatGetRedundantMatrix - Create redundant matrices and put them into processors of subcommunicators.
7201 
7202    Collective on Mat
7203 
7204    Input Parameters:
7205 +  mat - the matrix
7206 .  nsubcomm - the number of subcommunicators (= number of redundant pareallel or sequential matrices)
7207 .  subcomm - MPI communicator split from the communicator where mat resides in
7208 .  mlocal_red - number of local rows of the redundant matrix
7209 -  reuse - either MAT_INITIAL_MATRIX or MAT_REUSE_MATRIX
7210 
7211    Output Parameter:
7212 .  matredundant - redundant matrix
7213 
7214    Notes:
7215    MAT_REUSE_MATRIX can only be used when the nonzero structure of the
7216    original matrix has not changed from that last call to MatGetRedundantMatrix().
7217 
7218    This routine creates the duplicated matrices in subcommunicators; you should NOT create them before
7219    calling it.
7220 
7221    Only MPIAIJ matrix is supported.
7222 
7223    Level: advanced
7224 
7225    Concepts: subcommunicator
7226    Concepts: duplicate matrix
7227 
7228 .seealso: MatDestroy()
7229 @*/
7230 PetscErrorCode PETSCMAT_DLLEXPORT MatGetRedundantMatrix(Mat mat,PetscInt nsubcomm,MPI_Comm subcomm,PetscInt mlocal_red,MatReuse reuse,Mat *matredundant)
7231 {
7232   PetscErrorCode ierr;
7233 
7234   PetscFunctionBegin;
7235   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
7236   if (nsubcomm && reuse == MAT_REUSE_MATRIX) {
7237     PetscValidPointer(*matredundant,6);
7238     PetscValidHeaderSpecific(*matredundant,MAT_COOKIE,6);
7239   }
7240   if (!mat->ops->getredundantmatrix) SETERRQ1(PETSC_ERR_SUP,"Mat type %s",((PetscObject)mat)->type_name);
7241   if (!mat->assembled) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for unassembled matrix");
7242   if (mat->factor) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Not for factored matrix");
7243   ierr = MatPreallocated(mat);CHKERRQ(ierr);
7244 
7245   ierr = PetscLogEventBegin(MAT_GetRedundantMatrix,mat,0,0,0);CHKERRQ(ierr);
7246   ierr = (*mat->ops->getredundantmatrix)(mat,nsubcomm,subcomm,mlocal_red,reuse,matredundant);CHKERRQ(ierr);
7247   ierr = PetscLogEventEnd(MAT_GetRedundantMatrix,mat,0,0,0);CHKERRQ(ierr);
7248   PetscFunctionReturn(0);
7249 }
7250