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