1 /* $Id: petscmat.h,v 1.228 2001/09/07 20:09:08 bsmith Exp $ */ 2 /* 3 Include file for the matrix component of PETSc 4 */ 5 #ifndef __PETSCMAT_H 6 #define __PETSCMAT_H 7 #include "petscvec.h" 8 PETSC_EXTERN_CXX_BEGIN 9 10 /*S 11 Mat - Abstract PETSc matrix object 12 13 Level: beginner 14 15 Concepts: matrix; linear operator 16 17 .seealso: MatCreate(), MatType, MatSetType() 18 S*/ 19 typedef struct _p_Mat* Mat; 20 21 /*E 22 MatType - String with the name of a PETSc matrix or the creation function 23 with an optional dynamic library name, for example 24 http://www.mcs.anl.gov/petsc/lib.a:mymatcreate() 25 26 Level: beginner 27 28 .seealso: MatSetType(), Mat 29 E*/ 30 #define MATSAME "same" 31 #define MATSEQMAIJ "seqmaij" 32 #define MATMPIMAIJ "mpimaij" 33 #define MATMAIJ "maij" 34 #define MATIS "is" 35 #define MATMPIROWBS "mpirowbs" 36 #define MATSEQAIJ "seqaij" 37 #define MATMPIAIJ "mpiaij" 38 #define MATAIJ "aij" 39 #define MATSHELL "shell" 40 #define MATSEQBDIAG "seqbdiag" 41 #define MATMPIBDIAG "mpibdiag" 42 #define MATBDIAG "bdiag" 43 #define MATSEQDENSE "seqdense" 44 #define MATMPIDENSE "mpidense" 45 #define MATDENSE "dense" 46 #define MATSEQBAIJ "seqbaij" 47 #define MATMPIBAIJ "mpibaij" 48 #define MATBAIJ "baij" 49 #define MATMPIADJ "mpiadj" 50 #define MATSEQSBAIJ "seqsbaij" 51 #define MATMPISBAIJ "mpisbaij" 52 #define MATSBAIJ "sbaij" 53 #define MATDAAD "daad" 54 #define MATMFFD "mffd" 55 #define MATESI "esi" 56 #define MATPETSCESI "petscesi" 57 #define MATNORMAL "normal" 58 #define MATSEQAIJSPOOLES "seqaijspooles" 59 #define MATMPIAIJSPOOLES "mpiaijspooles" 60 #define MATSEQSBAIJSPOOLES "seqsbaijspooles" 61 #define MATMPISBAIJSPOOLES "mpisbaijspooles" 62 #define MATSUPERLU "superlu" 63 #define MATSUPERLU_DIST "superlu_dist" 64 #define MATUMFPACK "umfpack" 65 #define MATESSL "essl" 66 #define MATLUSOL "lusol" 67 #define MATAIJMUMPS "aijmumps" 68 #define MATSBAIJMUMPS "sbaijmumps" 69 #define MATDSCPACK "dscpack" 70 #define MATMATLAB "matlab" 71 #define MatType char* 72 73 /* Logging support */ 74 #define MAT_FILE_COOKIE 1211216 /* used to indicate matrices in binary files */ 75 extern int MAT_COOKIE; 76 extern int MATSNESMFCTX_COOKIE; 77 extern int MAT_FDCOLORING_COOKIE; 78 extern int MAT_PARTITIONING_COOKIE; 79 extern int MAT_NULLSPACE_COOKIE; 80 extern int MAT_Mult, MAT_MultMatrixFree, MAT_Mults, MAT_MultConstrained, MAT_MultAdd, MAT_MultTranspose; 81 extern int MAT_MultTransposeConstrained, MAT_MultTransposeAdd, MAT_Solve, MAT_Solves, MAT_SolveAdd, MAT_SolveTranspose; 82 extern int MAT_SolveTransposeAdd, MAT_Relax, MAT_ForwardSolve, MAT_BackwardSolve, MAT_LUFactor, MAT_LUFactorSymbolic; 83 extern int MAT_LUFactorNumeric, MAT_CholeskyFactor, MAT_CholeskyFactorSymbolic, MAT_CholeskyFactorNumeric, MAT_ILUFactor; 84 extern int MAT_ILUFactorSymbolic, MAT_ICCFactorSymbolic, MAT_Copy, MAT_Convert, MAT_Scale, MAT_AssemblyBegin; 85 extern int MAT_AssemblyEnd, MAT_SetValues, MAT_GetValues, MAT_GetRow, MAT_GetSubMatrices, MAT_GetColoring, MAT_GetOrdering; 86 extern int MAT_IncreaseOverlap, MAT_Partitioning, MAT_ZeroEntries, MAT_Load, MAT_View, MAT_AXPY, MAT_FDColoringCreate; 87 extern int MAT_FDColoringApply, MAT_Transpose, MAT_FDColoringFunction; 88 89 EXTERN int MatInitializePackage(char *); 90 91 EXTERN int MatCreate(MPI_Comm,int,int,int,int,Mat*); 92 EXTERN int MatSetType(Mat,const MatType); 93 EXTERN int MatSetFromOptions(Mat); 94 EXTERN int MatSetUpPreallocation(Mat); 95 EXTERN int MatRegisterAll(const char[]); 96 EXTERN int MatRegister(const char[],const char[],const char[],int(*)(Mat)); 97 98 /*MC 99 MatRegisterDynamic - Adds a new matrix type 100 101 Synopsis: 102 int MatRegisterDynamic(char *name,char *path,char *name_create,int (*routine_create)(Mat)) 103 104 Not Collective 105 106 Input Parameters: 107 + name - name of a new user-defined matrix type 108 . path - path (either absolute or relative) the library containing this solver 109 . name_create - name of routine to create method context 110 - routine_create - routine to create method context 111 112 Notes: 113 MatRegisterDynamic() may be called multiple times to add several user-defined solvers. 114 115 If dynamic libraries are used, then the fourth input argument (routine_create) 116 is ignored. 117 118 Sample usage: 119 .vb 120 MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a, 121 "MyMatCreate",MyMatCreate); 122 .ve 123 124 Then, your solver can be chosen with the procedural interface via 125 $ MatSetType(Mat,"my_mat") 126 or at runtime via the option 127 $ -mat_type my_mat 128 129 Level: advanced 130 131 Notes: ${PETSC_ARCH} and ${BOPT} occuring in pathname will be replaced with appropriate values. 132 If your function is not being put into a shared library then use VecRegister() instead 133 134 .keywords: Mat, register 135 136 .seealso: MatRegisterAll(), MatRegisterDestroy() 137 138 M*/ 139 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 140 #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0) 141 #else 142 #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d) 143 #endif 144 145 extern PetscTruth MatRegisterAllCalled; 146 extern PetscFList MatList; 147 148 EXTERN int MatCreateSeqDense(MPI_Comm,int,int,PetscScalar[],Mat*); 149 EXTERN int MatCreateMPIDense(MPI_Comm,int,int,int,int,PetscScalar[],Mat*); 150 EXTERN int MatCreateSeqAIJ(MPI_Comm,int,int,int,const int[],Mat*); 151 EXTERN int MatCreateMPIAIJ(MPI_Comm,int,int,int,int,int,const int[],int,const int[],Mat*); 152 EXTERN int MatCreateMPIRowbs(MPI_Comm,int,int,int,const int[],Mat*); 153 EXTERN int MatCreateSeqBDiag(MPI_Comm,int,int,int,int,const int[],PetscScalar*[],Mat*); 154 EXTERN int MatCreateMPIBDiag(MPI_Comm,int,int,int,int,int,const int[],PetscScalar*[],Mat*); 155 EXTERN int MatCreateSeqBAIJ(MPI_Comm,int,int,int,int,const int[],Mat*); 156 EXTERN int MatCreateMPIBAIJ(MPI_Comm,int,int,int,int,int,int,const int[],int,const int[],Mat*); 157 EXTERN int MatCreateMPIAdj(MPI_Comm,int,int,int[],int[],int[],Mat*); 158 EXTERN int MatCreateSeqSBAIJ(MPI_Comm,int,int,int,int,const int[],Mat*); 159 EXTERN int MatCreateMPISBAIJ(MPI_Comm,int,int,int,int,int,int,const int[],int,const int[],Mat*); 160 EXTERN int MatCreateShell(MPI_Comm,int,int,int,int,void *,Mat*); 161 EXTERN int MatCreateAdic(MPI_Comm,int,int,int,int,int,void (*)(void),Mat*); 162 EXTERN int MatCreateNormal(Mat,Mat*); 163 EXTERN int MatDestroy(Mat); 164 165 EXTERN int MatPrintHelp(Mat); 166 EXTERN int MatGetPetscMaps(Mat,PetscMap*,PetscMap*); 167 168 /* ------------------------------------------------------------*/ 169 EXTERN int MatSetValues(Mat,int,const int[],int,const int[],const PetscScalar[],InsertMode); 170 EXTERN int MatSetValuesBlocked(Mat,int,const int[],int,const int[],const PetscScalar[],InsertMode); 171 172 /*S 173 MatStencil - Data structure (C struct) for storing information about a single row or 174 column of a matrix as index on an associated grid. 175 176 Level: beginner 177 178 Concepts: matrix; linear operator 179 180 .seealso: MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil() 181 S*/ 182 typedef struct { 183 int k,j,i,c; 184 } MatStencil; 185 186 EXTERN int MatSetValuesStencil(Mat,int,const MatStencil[],int,const MatStencil[],const PetscScalar[],InsertMode); 187 EXTERN int MatSetValuesBlockedStencil(Mat,int,const MatStencil[],int,const MatStencil[],const PetscScalar[],InsertMode); 188 EXTERN int MatSetStencil(Mat,int,const int[],const int[],int); 189 190 EXTERN int MatSetColoring(Mat,ISColoring); 191 EXTERN int MatSetValuesAdic(Mat,void*); 192 EXTERN int MatSetValuesAdifor(Mat,int,void*); 193 194 /*E 195 MatAssemblyType - Indicates if the matrix is now to be used, or if you plan 196 to continue to add values to it 197 198 Level: beginner 199 200 .seealso: MatAssemblyBegin(), MatAssemblyEnd() 201 E*/ 202 typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType; 203 EXTERN int MatAssemblyBegin(Mat,MatAssemblyType); 204 EXTERN int MatAssemblyEnd(Mat,MatAssemblyType); 205 EXTERN int MatAssembled(Mat,PetscTruth*); 206 207 extern int MatSetValue_Row, MatSetValue_Column; 208 extern PetscScalar MatSetValue_Value; 209 210 /*MC 211 MatSetValue - Set a single entry into a matrix. 212 213 Synopsis: 214 int MatSetValue(Mat m,int row,int col,PetscScalar value,InsertMode mode); 215 216 Not collective 217 218 Input Parameters: 219 + m - the matrix 220 . row - the row location of the entry 221 . col - the column location of the entry 222 . value - the value to insert 223 - mode - either INSERT_VALUES or ADD_VALUES 224 225 Notes: 226 For efficiency one should use MatSetValues() and set several or many 227 values simultaneously if possible. 228 229 Level: beginner 230 231 .seealso: MatSetValues(), MatSetValueLocal() 232 M*/ 233 #define MatSetValue(v,i,j,va,mode) \ 234 (MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va, \ 235 MatSetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode)) 236 237 #define MatGetValue(v,i,j,va) \ 238 (MatSetValue_Row = i,MatSetValue_Column = j,\ 239 MatGetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&va)) 240 241 #define MatSetValueLocal(v,i,j,va,mode) \ 242 (MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va, \ 243 MatSetValuesLocal(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode)) 244 245 /*E 246 MatOption - Options that may be set for a matrix and its behavior or storage 247 248 Level: beginner 249 250 Any additions/changes here MUST also be made in include/finclude/petscmat.h 251 252 .seealso: MatSetOption() 253 E*/ 254 typedef enum {MAT_ROW_ORIENTED=1,MAT_COLUMN_ORIENTED=2,MAT_ROWS_SORTED=4, 255 MAT_COLUMNS_SORTED=8,MAT_NO_NEW_NONZERO_LOCATIONS=16, 256 MAT_YES_NEW_NONZERO_LOCATIONS=32,MAT_SYMMETRIC=64, 257 MAT_STRUCTURALLY_SYMMETRIC=65,MAT_NO_NEW_DIAGONALS=66, 258 MAT_YES_NEW_DIAGONALS=67,MAT_INODE_LIMIT_1=68,MAT_INODE_LIMIT_2=69, 259 MAT_INODE_LIMIT_3=70,MAT_INODE_LIMIT_4=71,MAT_INODE_LIMIT_5=72, 260 MAT_IGNORE_OFF_PROC_ENTRIES=73,MAT_ROWS_UNSORTED=74, 261 MAT_COLUMNS_UNSORTED=75,MAT_NEW_NONZERO_LOCATION_ERR=76, 262 MAT_NEW_NONZERO_ALLOCATION_ERR=77,MAT_USE_HASH_TABLE=78, 263 MAT_KEEP_ZEROED_ROWS=79,MAT_IGNORE_ZERO_ENTRIES=80,MAT_USE_INODES=81, 264 MAT_DO_NOT_USE_INODES=82,MAT_NOT_SYMMETRIC=83,MAT_HERMITIAN=84, 265 MAT_NOT_STRUCTURALLY_SYMMETRIC=85,MAT_NOT_HERMITIAN=86, 266 MAT_SYMMETRY_ETERNAL=87,MAT_NOT_SYMMETRY_ETERNAL=88} MatOption; 267 EXTERN int MatSetOption(Mat,MatOption); 268 EXTERN int MatGetType(Mat,MatType*); 269 270 EXTERN int MatGetValues(Mat,int,const int[],int,const int[],PetscScalar[]); 271 EXTERN int MatGetRow(Mat,int,int *,int *[],PetscScalar*[]); 272 EXTERN int MatRestoreRow(Mat,int,int *,int *[],PetscScalar*[]); 273 EXTERN int MatGetColumn(Mat,int,int *,int *[],PetscScalar*[]); 274 EXTERN int MatRestoreColumn(Mat,int,int *,int *[],PetscScalar*[]); 275 EXTERN int MatGetColumnVector(Mat,Vec,int); 276 EXTERN int MatGetArray(Mat,PetscScalar *[]); 277 EXTERN int MatRestoreArray(Mat,PetscScalar *[]); 278 EXTERN int MatGetBlockSize(Mat,int *); 279 280 EXTERN int MatMult(Mat,Vec,Vec); 281 EXTERN int MatMultAdd(Mat,Vec,Vec,Vec); 282 EXTERN int MatMultTranspose(Mat,Vec,Vec); 283 EXTERN int MatIsTranspose(Mat,Mat,PetscTruth*); 284 EXTERN int MatMultTransposeAdd(Mat,Vec,Vec,Vec); 285 EXTERN int MatMultConstrained(Mat,Vec,Vec); 286 EXTERN int MatMultTransposeConstrained(Mat,Vec,Vec); 287 288 /*E 289 MatDuplicateOption - Indicates if a duplicated sparse matrix should have 290 its numerical values copied over or just its nonzero structure. 291 292 Level: beginner 293 294 Any additions/changes here MUST also be made in include/finclude/petscmat.h 295 296 .seealso: MatDuplicate() 297 E*/ 298 typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES} MatDuplicateOption; 299 300 EXTERN int MatConvertRegister(const char[],const char[],const char[],int (*)(Mat,MatType,Mat*)); 301 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 302 #define MatConvertRegisterDynamic(a,b,c,d) MatConvertRegister(a,b,c,0) 303 #else 304 #define MatConvertRegisterDynamic(a,b,c,d) MatConvertRegister(a,b,c,d) 305 #endif 306 EXTERN int MatConvertRegisterAll(const char[]); 307 EXTERN int MatConvertRegisterDestroy(void); 308 extern PetscTruth MatConvertRegisterAllCalled; 309 extern PetscFList MatConvertList; 310 EXTERN int MatConvert(Mat,const MatType,Mat*); 311 EXTERN int MatDuplicate(Mat,MatDuplicateOption,Mat*); 312 313 /*E 314 MatStructure - Indicates if the matrix has the same nonzero structure 315 316 Level: beginner 317 318 Any additions/changes here MUST also be made in include/finclude/petscmat.h 319 320 .seealso: MatCopy(), KSPSetOperators(), PCSetOperators() 321 E*/ 322 typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure; 323 324 EXTERN int MatCopy(Mat,Mat,MatStructure); 325 EXTERN int MatView(Mat,PetscViewer); 326 EXTERN int MatIsSymmetric(Mat,PetscTruth*); 327 EXTERN int MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*); 328 EXTERN int MatLoad(PetscViewer,const MatType,Mat*); 329 EXTERN int MatMerge(MPI_Comm,Mat,Mat*); 330 331 EXTERN int MatGetRowIJ(Mat,int,PetscTruth,int*,int *[],int *[],PetscTruth *); 332 EXTERN int MatRestoreRowIJ(Mat,int,PetscTruth,int *,int *[],int *[],PetscTruth *); 333 EXTERN int MatGetColumnIJ(Mat,int,PetscTruth,int*,int *[],int *[],PetscTruth *); 334 EXTERN int MatRestoreColumnIJ(Mat,int,PetscTruth,int *,int *[],int *[],PetscTruth *); 335 336 /*S 337 MatInfo - Context of matrix information, used with MatGetInfo() 338 339 In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE 340 341 Level: intermediate 342 343 Concepts: matrix^nonzero information 344 345 .seealso: MatGetInfo(), MatInfoType 346 S*/ 347 typedef struct { 348 PetscLogDouble rows_global,columns_global; /* number of global rows and columns */ 349 PetscLogDouble rows_local,columns_local; /* number of local rows and columns */ 350 PetscLogDouble block_size; /* block size */ 351 PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */ 352 PetscLogDouble memory; /* memory allocated */ 353 PetscLogDouble assemblies; /* number of matrix assemblies called */ 354 PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */ 355 PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */ 356 PetscLogDouble factor_mallocs; /* number of mallocs during factorization */ 357 } MatInfo; 358 359 /*E 360 MatInfoType - Indicates if you want information about the local part of the matrix, 361 the entire parallel matrix or the maximum over all the local parts. 362 363 Level: beginner 364 365 Any additions/changes here MUST also be made in include/finclude/petscmat.h 366 367 .seealso: MatGetInfo(), MatInfo 368 E*/ 369 typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 370 EXTERN int MatGetInfo(Mat,MatInfoType,MatInfo*); 371 EXTERN int MatValid(Mat,PetscTruth*); 372 EXTERN int MatGetDiagonal(Mat,Vec); 373 EXTERN int MatGetRowMax(Mat,Vec); 374 EXTERN int MatTranspose(Mat,Mat*); 375 EXTERN int MatPermute(Mat,IS,IS,Mat *); 376 EXTERN int MatPermuteSparsify(Mat,int,PetscReal,PetscReal,IS,IS,Mat *); 377 EXTERN int MatDiagonalScale(Mat,Vec,Vec); 378 EXTERN int MatDiagonalSet(Mat,Vec,InsertMode); 379 EXTERN int MatEqual(Mat,Mat,PetscTruth*); 380 381 EXTERN int MatNorm(Mat,NormType,PetscReal *); 382 EXTERN int MatZeroEntries(Mat); 383 EXTERN int MatZeroRows(Mat,IS,const PetscScalar*); 384 EXTERN int MatZeroColumns(Mat,IS,const PetscScalar*); 385 386 EXTERN int MatUseScaledForm(Mat,PetscTruth); 387 EXTERN int MatScaleSystem(Mat,Vec,Vec); 388 EXTERN int MatUnScaleSystem(Mat,Vec,Vec); 389 390 EXTERN int MatGetSize(Mat,int*,int*); 391 EXTERN int MatGetLocalSize(Mat,int*,int*); 392 EXTERN int MatGetOwnershipRange(Mat,int*,int*); 393 394 /*E 395 MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices() 396 or MatGetSubMatrix() are to be reused to store the new matrix values. 397 398 Level: beginner 399 400 Any additions/changes here MUST also be made in include/finclude/petscmat.h 401 402 .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices() 403 E*/ 404 typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX} MatReuse; 405 EXTERN int MatGetSubMatrices(Mat,int,const IS[],const IS[],MatReuse,Mat *[]); 406 EXTERN int MatDestroyMatrices(int,Mat *[]); 407 EXTERN int MatGetSubMatrix(Mat,IS,IS,int,MatReuse,Mat *); 408 409 EXTERN int MatIncreaseOverlap(Mat,int,IS[],int); 410 411 EXTERN int MatAXPY(const PetscScalar *,Mat,Mat,MatStructure); 412 EXTERN int MatAYPX(const PetscScalar *,Mat,Mat); 413 EXTERN int MatCompress(Mat); 414 415 EXTERN int MatScale(const PetscScalar *,Mat); 416 EXTERN int MatShift(const PetscScalar *,Mat); 417 418 EXTERN int MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping); 419 EXTERN int MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping); 420 EXTERN int MatZeroRowsLocal(Mat,IS,const PetscScalar*); 421 EXTERN int MatSetValuesLocal(Mat,int,const int[],int,const int[],const PetscScalar[],InsertMode); 422 EXTERN int MatSetValuesBlockedLocal(Mat,int,const int[],int,const int[],const PetscScalar[],InsertMode); 423 424 EXTERN int MatStashSetInitialSize(Mat,int,int); 425 EXTERN int MatStashGetInfo(Mat,int*,int*,int*,int*); 426 427 EXTERN int MatInterpolateAdd(Mat,Vec,Vec,Vec); 428 EXTERN int MatInterpolate(Mat,Vec,Vec); 429 EXTERN int MatRestrict(Mat,Vec,Vec); 430 431 432 /*MC 433 MatPreallocInitialize - Begins the block of code that will count the number of nonzeros per 434 row in a matrix providing the data that one can use to correctly preallocate the matrix. 435 436 Synopsis: 437 int MatPreallocateInitialize(MPI_Comm comm, int nrows, int ncols, int *dnz, int *onz) 438 439 Collective on MPI_Comm 440 441 Input Parameters: 442 + comm - the communicator that will share the eventually allocated matrix 443 . nrows - the number of rows in the matrix 444 - ncols - the number of columns in the matrix 445 446 Output Parameters: 447 + dnz - the array that will be passed to the matrix preallocation routines 448 - ozn - the other array passed to the matrix preallocation routines 449 450 451 Level: intermediate 452 453 Notes: 454 See the chapter in the users manual on performance for more details 455 456 Do not malloc or free dnz and onz, that is handled internally by these routines 457 458 Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices) 459 460 Concepts: preallocation^Matrix 461 462 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 463 MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal() 464 M*/ 465 #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \ 466 { \ 467 int _4_ierr,__tmp = (nrows),__ctmp = (ncols),__rstart,__start,__end; \ 468 _4_ierr = PetscMalloc(2*__tmp*sizeof(int),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\ 469 _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(int));CHKERRQ(_4_ierr);\ 470 _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPI_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\ 471 _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPI_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp; 472 473 /*MC 474 MatPreallocSymmetricInitialize - Begins the block of code that will count the number of nonzeros per 475 row in a matrix providing the data that one can use to correctly preallocate the matrix. 476 477 Synopsis: 478 int MatPreallocateSymmetricInitialize(MPI_Comm comm, int nrows, int ncols, int *dnz, int *onz) 479 480 Collective on MPI_Comm 481 482 Input Parameters: 483 + comm - the communicator that will share the eventually allocated matrix 484 . nrows - the number of rows in the matrix 485 - ncols - the number of columns in the matrix 486 487 Output Parameters: 488 + dnz - the array that will be passed to the matrix preallocation routines 489 - ozn - the other array passed to the matrix preallocation routines 490 491 492 Level: intermediate 493 494 Notes: 495 See the chapter in the users manual on performance for more details 496 497 Do not malloc or free dnz and onz, that is handled internally by these routines 498 499 Concepts: preallocation^Matrix 500 501 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 502 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 503 M*/ 504 #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \ 505 { \ 506 int _4_ierr,__tmp = (nrows),__ctmp = (ncols),__rstart,__end; \ 507 _4_ierr = PetscMalloc(2*__tmp*sizeof(int),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\ 508 _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(int));CHKERRQ(_4_ierr);\ 509 _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPI_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\ 510 _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPI_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp; 511 512 /*MC 513 MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 514 inserted using a local number of the rows and columns 515 516 Synopsis: 517 int MatPreallocateSetLocal(ISLocalToGlobalMappping map,int nrows, int *rows,int ncols, int *cols,int *dnz, int *onz) 518 519 Not Collective 520 521 Input Parameters: 522 + map - the mapping between local numbering and global numbering 523 . nrows - the number of rows indicated 524 . rows - the indices of the rows 525 . ncols - the number of columns in the matrix 526 . cols - the columns indicated 527 . dnz - the array that will be passed to the matrix preallocation routines 528 - ozn - the other array passed to the matrix preallocation routines 529 530 531 Level: intermediate 532 533 Notes: 534 See the chapter in the users manual on performance for more details 535 536 Do not malloc or free dnz and onz, that is handled internally by these routines 537 538 Concepts: preallocation^Matrix 539 540 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 541 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 542 M*/ 543 #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 544 {\ 545 int __l;\ 546 _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 547 _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 548 for (__l=0;__l<nrows;__l++) {\ 549 _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 550 }\ 551 } 552 553 /*MC 554 MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 555 inserted using a local number of the rows and columns 556 557 Synopsis: 558 int MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,int nrows, int *rows,int ncols, int *cols,int *dnz, int *onz) 559 560 Not Collective 561 562 Input Parameters: 563 + map - the mapping between local numbering and global numbering 564 . nrows - the number of rows indicated 565 . rows - the indices of the rows 566 . ncols - the number of columns in the matrix 567 . cols - the columns indicated 568 . dnz - the array that will be passed to the matrix preallocation routines 569 - ozn - the other array passed to the matrix preallocation routines 570 571 572 Level: intermediate 573 574 Notes: 575 See the chapter in the users manual on performance for more details 576 577 Do not malloc or free dnz and onz that is handled internally by these routines 578 579 Concepts: preallocation^Matrix 580 581 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 582 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 583 M*/ 584 #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 585 {\ 586 int __l;\ 587 _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 588 _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 589 for (__l=0;__l<nrows;__l++) {\ 590 _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 591 }\ 592 } 593 594 /*MC 595 MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 596 inserted using a local number of the rows and columns 597 598 Synopsis: 599 int MatPreallocateSet(int nrows, int *rows,int ncols, int *cols,int *dnz, int *onz) 600 601 Not Collective 602 603 Input Parameters: 604 + nrows - the number of rows indicated 605 . rows - the indices of the rows 606 . ncols - the number of columns in the matrix 607 . cols - the columns indicated 608 . dnz - the array that will be passed to the matrix preallocation routines 609 - ozn - the other array passed to the matrix preallocation routines 610 611 612 Level: intermediate 613 614 Notes: 615 See the chapter in the users manual on performance for more details 616 617 Do not malloc or free dnz and onz that is handled internally by these routines 618 619 Concepts: preallocation^Matrix 620 621 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 622 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 623 M*/ 624 #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\ 625 { int __i; \ 626 for (__i=0; __i<nc; __i++) {\ 627 if (cols[__i] < __start || cols[__i] >= __end) onz[row - __rstart]++; \ 628 }\ 629 dnz[row - __rstart] = nc - onz[row - __rstart];\ 630 } 631 632 /*MC 633 MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 634 inserted using a local number of the rows and columns 635 636 Synopsis: 637 int MatPreallocateSymmetricSet(int nrows, int *rows,int ncols, int *cols,int *dnz, int *onz) 638 639 Not Collective 640 641 Input Parameters: 642 + nrows - the number of rows indicated 643 . rows - the indices of the rows 644 . ncols - the number of columns in the matrix 645 . cols - the columns indicated 646 . dnz - the array that will be passed to the matrix preallocation routines 647 - ozn - the other array passed to the matrix preallocation routines 648 649 650 Level: intermediate 651 652 Notes: 653 See the chapter in the users manual on performance for more details 654 655 Do not malloc or free dnz and onz that is handled internally by these routines 656 657 Concepts: preallocation^Matrix 658 659 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 660 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 661 M*/ 662 #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\ 663 { int __i; \ 664 for (__i=0; __i<nc; __i++) {\ 665 if (cols[__i] >= __end) onz[row - __rstart]++; \ 666 else if (cols[__i] >= row) dnz[row - __rstart]++;\ 667 }\ 668 } 669 670 /*MC 671 MatPreallocFinalize - Ends the block of code that will count the number of nonzeros per 672 row in a matrix providing the data that one can use to correctly preallocate the matrix. 673 674 Synopsis: 675 int MatPreallocateFinalize(int *dnz, int *onz) 676 677 Collective on MPI_Comm 678 679 Input Parameters: 680 + dnz - the array that will be passed to the matrix preallocation routines 681 - ozn - the other array passed to the matrix preallocation routines 682 683 684 Level: intermediate 685 686 Notes: 687 See the chapter in the users manual on performance for more details 688 689 Do not malloc or free dnz and onz that is handled internally by these routines 690 691 Concepts: preallocation^Matrix 692 693 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 694 MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal() 695 M*/ 696 #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree(dnz);CHKERRQ(_4_ierr);} 697 698 699 700 /* Routines unique to particular data structures */ 701 EXTERN int MatShellGetContext(Mat,void **); 702 703 EXTERN int MatBDiagGetData(Mat,int*,int*,int*[],int*[],PetscScalar***); 704 EXTERN int MatSeqAIJSetColumnIndices(Mat,int[]); 705 EXTERN int MatSeqBAIJSetColumnIndices(Mat,int[]); 706 EXTERN int MatCreateSeqAIJWithArrays(MPI_Comm,int,int,int[],int[],PetscScalar[],Mat*); 707 708 EXTERN int MatSeqBAIJSetPreallocation(Mat,int,int,const int[]); 709 EXTERN int MatSeqSBAIJSetPreallocation(Mat,int,int,const int[]); 710 EXTERN int MatSeqAIJSetPreallocation(Mat,int,const int[]); 711 EXTERN int MatSeqDensePreallocation(Mat,PetscScalar[]); 712 EXTERN int MatSeqBDiagSetPreallocation(Mat,int,int,const int[],PetscScalar*[]); 713 EXTERN int MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 714 715 EXTERN int MatMPIBAIJSetPreallocation(Mat,int,int,const int[],int,const int[]); 716 EXTERN int MatMPISBAIJSetPreallocation(Mat,int,int,const int[],int,const int[]); 717 EXTERN int MatMPIAIJSetPreallocation(Mat,int,const int[],int,const int[]); 718 EXTERN int MatMPIDensePreallocation(Mat,PetscScalar[]); 719 EXTERN int MatMPIBDiagSetPreallocation(Mat,int,int,const int[],PetscScalar*[]); 720 EXTERN int MatMPIAdjSetPreallocation(Mat,int[],int[],int[]); 721 EXTERN int MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 722 EXTERN int MatMPIRowbsSetPreallocation(Mat,int,const int[]); 723 EXTERN int MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,int*[]); 724 EXTERN int MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,int*[]); 725 EXTERN int MatAdicSetLocalFunction(Mat,void (*)(void)); 726 727 EXTERN int MatSeqDenseSetLDA(Mat,int); 728 729 EXTERN int MatStoreValues(Mat); 730 EXTERN int MatRetrieveValues(Mat); 731 732 EXTERN int MatDAADSetCtx(Mat,void*); 733 734 /* 735 These routines are not usually accessed directly, rather solving is 736 done through the KSP and PC interfaces. 737 */ 738 739 /*E 740 MatOrderingType - String with the name of a PETSc matrix ordering or the creation function 741 with an optional dynamic library name, for example 742 http://www.mcs.anl.gov/petsc/lib.a:orderingcreate() 743 744 Level: beginner 745 746 .seealso: MatGetOrdering() 747 E*/ 748 #define MatOrderingType char* 749 #define MATORDERING_NATURAL "natural" 750 #define MATORDERING_ND "nd" 751 #define MATORDERING_1WD "1wd" 752 #define MATORDERING_RCM "rcm" 753 #define MATORDERING_QMD "qmd" 754 #define MATORDERING_ROWLENGTH "rowlength" 755 #define MATORDERING_DSC_ND "dsc_nd" 756 #define MATORDERING_DSC_MMD "dsc_mmd" 757 #define MATORDERING_DSC_MDF "dsc_mdf" 758 #define MATORDERING_CONSTRAINED "constrained" 759 #define MATORDERING_IDENTITY "identity" 760 #define MATORDERING_REVERSE "reverse" 761 762 EXTERN int MatGetOrdering(Mat,const MatOrderingType,IS*,IS*); 763 EXTERN int MatOrderingRegister(const char[],const char[],const char[],int(*)(Mat,const MatOrderingType,IS*,IS*)); 764 765 /*MC 766 MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the 767 matrix package. 768 769 Synopsis: 770 int MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,int (*routine_create)(MatOrdering)) 771 772 Not Collective 773 774 Input Parameters: 775 + sname - name of ordering (for example MATORDERING_ND) 776 . path - location of library where creation routine is 777 . name - name of function that creates the ordering type,a string 778 - function - function pointer that creates the ordering 779 780 Level: developer 781 782 If dynamic libraries are used, then the fourth input argument (function) 783 is ignored. 784 785 Sample usage: 786 .vb 787 MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a, 788 "MyOrder",MyOrder); 789 .ve 790 791 Then, your partitioner can be chosen with the procedural interface via 792 $ MatOrderingSetType(part,"my_order) 793 or at runtime via the option 794 $ -pc_ilu_mat_ordering_type my_order 795 $ -pc_lu_mat_ordering_type my_order 796 797 ${PETSC_ARCH} and ${BOPT} occuring in pathname will be replaced with appropriate values. 798 799 .keywords: matrix, ordering, register 800 801 .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll() 802 M*/ 803 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 804 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0) 805 #else 806 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d) 807 #endif 808 809 EXTERN int MatOrderingRegisterDestroy(void); 810 EXTERN int MatOrderingRegisterAll(const char[]); 811 extern PetscTruth MatOrderingRegisterAllCalled; 812 extern PetscFList MatOrderingList; 813 814 EXTERN int MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 815 816 /*S 817 MatFactorInfo - Data based into the matrix factorization routines 818 819 In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE 820 821 Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 822 823 Level: developer 824 825 .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor() 826 827 S*/ 828 typedef struct { 829 PetscReal damping; /* scaling of identity added to matrix to prevent zero pivots */ 830 PetscReal shift; /* if true, shift until positive pivots */ 831 PetscReal shift_fraction; /* record shift fraction taken */ 832 PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 833 PetscReal dt; /* drop tolerance */ 834 PetscReal dtcol; /* tolerance for pivoting */ 835 PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 836 PetscReal fill; /* expected fill; nonzeros in factored matrix/nonzeros in original matrix*/ 837 PetscReal levels; /* ICC/ILU(levels) */ 838 PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 839 factorization may be faster if do not pivot */ 840 PetscReal zeropivot; /* pivot is called zero if less than this */ 841 } MatFactorInfo; 842 843 EXTERN int MatCholeskyFactor(Mat,IS,MatFactorInfo*); 844 EXTERN int MatCholeskyFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*); 845 EXTERN int MatCholeskyFactorNumeric(Mat,Mat*); 846 EXTERN int MatLUFactor(Mat,IS,IS,MatFactorInfo*); 847 EXTERN int MatILUFactor(Mat,IS,IS,MatFactorInfo*); 848 EXTERN int MatLUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*); 849 EXTERN int MatILUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*); 850 EXTERN int MatICCFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*); 851 EXTERN int MatICCFactor(Mat,IS,MatFactorInfo*); 852 EXTERN int MatLUFactorNumeric(Mat,Mat*); 853 EXTERN int MatILUDTFactor(Mat,MatFactorInfo*,IS,IS,Mat *); 854 EXTERN int MatGetInertia(Mat,int*,int*,int*); 855 EXTERN int MatSolve(Mat,Vec,Vec); 856 EXTERN int MatForwardSolve(Mat,Vec,Vec); 857 EXTERN int MatBackwardSolve(Mat,Vec,Vec); 858 EXTERN int MatSolveAdd(Mat,Vec,Vec,Vec); 859 EXTERN int MatSolveTranspose(Mat,Vec,Vec); 860 EXTERN int MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 861 EXTERN int MatSolves(Mat,Vecs,Vecs); 862 863 EXTERN int MatSetUnfactored(Mat); 864 865 /*E 866 MatSORType - What type of (S)SOR to perform 867 868 Level: beginner 869 870 May be bitwise ORd together 871 872 Any additions/changes here MUST also be made in include/finclude/petscmat.h 873 874 MatSORType may be bitwise ORd together, so do not change the numbers 875 876 .seealso: MatRelax(), MatPBRelax() 877 E*/ 878 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 879 SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 880 SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 881 SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 882 EXTERN int MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,int,int,Vec); 883 EXTERN int MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,int,int,Vec); 884 885 /* 886 These routines are for efficiently computing Jacobians via finite differences. 887 */ 888 889 /*E 890 MatColoringType - String with the name of a PETSc matrix coloring or the creation function 891 with an optional dynamic library name, for example 892 http://www.mcs.anl.gov/petsc/lib.a:coloringcreate() 893 894 Level: beginner 895 896 .seealso: MatGetColoring() 897 E*/ 898 #define MatColoringType char* 899 #define MATCOLORING_NATURAL "natural" 900 #define MATCOLORING_SL "sl" 901 #define MATCOLORING_LF "lf" 902 #define MATCOLORING_ID "id" 903 904 EXTERN int MatGetColoring(Mat,const MatColoringType,ISColoring*); 905 EXTERN int MatColoringRegister(const char[],const char[],const char[],int(*)(Mat,const MatColoringType,ISColoring *)); 906 907 /*MC 908 MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the 909 matrix package. 910 911 Synopsis: 912 int MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,int (*routine_create)(MatColoring)) 913 914 Not Collective 915 916 Input Parameters: 917 + sname - name of Coloring (for example MATCOLORING_SL) 918 . path - location of library where creation routine is 919 . name - name of function that creates the Coloring type, a string 920 - function - function pointer that creates the coloring 921 922 Level: developer 923 924 If dynamic libraries are used, then the fourth input argument (function) 925 is ignored. 926 927 Sample usage: 928 .vb 929 MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a, 930 "MyColor",MyColor); 931 .ve 932 933 Then, your partitioner can be chosen with the procedural interface via 934 $ MatColoringSetType(part,"my_color") 935 or at runtime via the option 936 $ -mat_coloring_type my_color 937 938 $PETSC_ARCH and $BOPT occuring in pathname will be replaced with appropriate values. 939 940 .keywords: matrix, Coloring, register 941 942 .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll() 943 M*/ 944 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 945 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0) 946 #else 947 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d) 948 #endif 949 950 EXTERN int MatColoringRegisterAll(const char[]); 951 extern PetscTruth MatColoringRegisterAllCalled; 952 EXTERN int MatColoringRegisterDestroy(void); 953 EXTERN int MatColoringPatch(Mat,int,int,const ISColoringValue[],ISColoring*); 954 955 /*S 956 MatFDColoring - Object for computing a sparse Jacobian via finite differences 957 and coloring 958 959 Level: beginner 960 961 Concepts: coloring, sparse Jacobian, finite differences 962 963 .seealso: MatFDColoringCreate() 964 S*/ 965 typedef struct _p_MatFDColoring *MatFDColoring; 966 967 EXTERN int MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 968 EXTERN int MatFDColoringDestroy(MatFDColoring); 969 EXTERN int MatFDColoringView(MatFDColoring,PetscViewer); 970 EXTERN int MatFDColoringSetFunction(MatFDColoring,int (*)(void),void*); 971 EXTERN int MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 972 EXTERN int MatFDColoringSetFrequency(MatFDColoring,int); 973 EXTERN int MatFDColoringGetFrequency(MatFDColoring,int*); 974 EXTERN int MatFDColoringSetFromOptions(MatFDColoring); 975 EXTERN int MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *); 976 EXTERN int MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *); 977 EXTERN int MatFDColoringSetRecompute(MatFDColoring); 978 EXTERN int MatFDColoringSetF(MatFDColoring,Vec); 979 EXTERN int MatFDColoringGetPerturbedColumns(MatFDColoring,int*,int*[]); 980 /* 981 These routines are for partitioning matrices: currently used only 982 for adjacency matrix, MatCreateMPIAdj(). 983 */ 984 985 /*S 986 MatPartitioning - Object for managing the partitioning of a matrix or graph 987 988 Level: beginner 989 990 Concepts: partitioning 991 992 .seealso: MatPartitioningCreate(), MatPartitioningType 993 S*/ 994 typedef struct _p_MatPartitioning *MatPartitioning; 995 996 /*E 997 MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function 998 with an optional dynamic library name, for example 999 http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate() 1000 1001 Level: beginner 1002 1003 .seealso: MatPartitioningCreate(), MatPartitioning 1004 E*/ 1005 #define MatPartitioningType char* 1006 #define MAT_PARTITIONING_CURRENT "current" 1007 #define MAT_PARTITIONING_PARMETIS "parmetis" 1008 #define MAT_PARTITIONING_CHACO "chaco" 1009 #define MAT_PARTITIONING_JOSTLE "jostle" 1010 #define MAT_PARTITIONING_PARTY "party" 1011 #define MAT_PARTITIONING_SCOTCH "scotch" 1012 1013 1014 EXTERN int MatPartitioningCreate(MPI_Comm,MatPartitioning*); 1015 EXTERN int MatPartitioningSetType(MatPartitioning,const MatPartitioningType); 1016 EXTERN int MatPartitioningSetNParts(MatPartitioning,int); 1017 EXTERN int MatPartitioningSetAdjacency(MatPartitioning,Mat); 1018 EXTERN int MatPartitioningSetVertexWeights(MatPartitioning,const int[]); 1019 EXTERN int MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1020 EXTERN int MatPartitioningApply(MatPartitioning,IS*); 1021 EXTERN int MatPartitioningDestroy(MatPartitioning); 1022 1023 EXTERN int MatPartitioningRegister(const char[],const char[],const char[],int(*)(MatPartitioning)); 1024 1025 /*MC 1026 MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the 1027 matrix package. 1028 1029 Synopsis: 1030 int MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,int (*routine_create)(MatPartitioning)) 1031 1032 Not Collective 1033 1034 Input Parameters: 1035 + sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis 1036 . path - location of library where creation routine is 1037 . name - name of function that creates the partitioning type, a string 1038 - function - function pointer that creates the partitioning type 1039 1040 Level: developer 1041 1042 If dynamic libraries are used, then the fourth input argument (function) 1043 is ignored. 1044 1045 Sample usage: 1046 .vb 1047 MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a, 1048 "MyPartCreate",MyPartCreate); 1049 .ve 1050 1051 Then, your partitioner can be chosen with the procedural interface via 1052 $ MatPartitioningSetType(part,"my_part") 1053 or at runtime via the option 1054 $ -mat_partitioning_type my_part 1055 1056 $PETSC_ARCH and $BOPT occuring in pathname will be replaced with appropriate values. 1057 1058 .keywords: matrix, partitioning, register 1059 1060 .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll() 1061 M*/ 1062 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1063 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0) 1064 #else 1065 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d) 1066 #endif 1067 1068 EXTERN int MatPartitioningRegisterAll(const char[]); 1069 extern PetscTruth MatPartitioningRegisterAllCalled; 1070 EXTERN int MatPartitioningRegisterDestroy(void); 1071 1072 EXTERN int MatPartitioningView(MatPartitioning,PetscViewer); 1073 EXTERN int MatPartitioningSetFromOptions(MatPartitioning); 1074 EXTERN int MatPartitioningGetType(MatPartitioning,MatPartitioningType*); 1075 1076 EXTERN int MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 1077 1078 EXTERN int MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal); 1079 EXTERN int MatPartitioningJostleSetCoarseSequential(MatPartitioning); 1080 1081 typedef enum { MP_CHACO_MULTILEVEL_KL, MP_CHACO_SPECTRAL, MP_CHACO_LINEAR, 1082 MP_CHACO_RANDOM, MP_CHACO_SCATTERED } MPChacoGlobalType; 1083 EXTERN int MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType); 1084 typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType; 1085 EXTERN int MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType); 1086 EXTERN int MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 1087 typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType; 1088 EXTERN int MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1089 EXTERN int MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal); 1090 EXTERN int MatPartitioningChacoSetEigenNumber(MatPartitioning, int); 1091 1092 #define MP_PARTY_OPT "opt" 1093 #define MP_PARTY_LIN "lin" 1094 #define MP_PARTY_SCA "sca" 1095 #define MP_PARTY_RAN "ran" 1096 #define MP_PARTY_GBF "gbf" 1097 #define MP_PARTY_GCF "gcf" 1098 #define MP_PARTY_BUB "bub" 1099 #define MP_PARTY_DEF "def" 1100 EXTERN int MatPartitioningPartySetGlobal(MatPartitioning, const char*); 1101 #define MP_PARTY_HELPFUL_SETS "hs" 1102 #define MP_PARTY_KERNIGHAN_LIN "kl" 1103 #define MP_PARTY_NONE "no" 1104 EXTERN int MatPartitioningPartySetLocal(MatPartitioning, const char*); 1105 EXTERN int MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1106 EXTERN int MatPartitioningPartySetBipart(MatPartitioning,PetscTruth); 1107 EXTERN int MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth); 1108 1109 typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType; 1110 EXTERN int MatPartitioningScotchSetArch(MatPartitioning,const char*); 1111 EXTERN int MatPartitioningScotchSetMultilevel(MatPartitioning); 1112 EXTERN int MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType); 1113 EXTERN int MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal); 1114 EXTERN int MatPartitioningScotchSetHostList(MatPartitioning,const char*); 1115 typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType; 1116 EXTERN int MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType); 1117 EXTERN int MatPartitioningScotchSetMapping(MatPartitioning); 1118 EXTERN int MatPartitioningScotchSetStrategy(MatPartitioning,char*); 1119 1120 /* 1121 If you add entries here you must also add them to finclude/petscmat.h 1122 */ 1123 typedef enum { MATOP_SET_VALUES=0, 1124 MATOP_GET_ROW=1, 1125 MATOP_RESTORE_ROW=2, 1126 MATOP_MULT=3, 1127 MATOP_MULT_ADD=4, 1128 MATOP_MULT_TRANSPOSE=5, 1129 MATOP_MULT_TRANSPOSE_ADD=6, 1130 MATOP_SOLVE=7, 1131 MATOP_SOLVE_ADD=8, 1132 MATOP_SOLVE_TRANSPOSE=9, 1133 MATOP_SOLVE_TRANSPOSE_ADD=10, 1134 MATOP_LUFACTOR=11, 1135 MATOP_CHOLESKYFACTOR=12, 1136 MATOP_RELAX=13, 1137 MATOP_TRANSPOSE=14, 1138 MATOP_GETINFO=15, 1139 MATOP_EQUAL=16, 1140 MATOP_GET_DIAGONAL=17, 1141 MATOP_DIAGONAL_SCALE=18, 1142 MATOP_NORM=19, 1143 MATOP_ASSEMBLY_BEGIN=20, 1144 MATOP_ASSEMBLY_END=21, 1145 MATOP_COMPRESS=22, 1146 MATOP_SET_OPTION=23, 1147 MATOP_ZERO_ENTRIES=24, 1148 MATOP_ZERO_ROWS=25, 1149 MATOP_LUFACTOR_SYMBOLIC=26, 1150 MATOP_LUFACTOR_NUMERIC=27, 1151 MATOP_CHOLESKY_FACTOR_SYMBOLIC=28, 1152 MATOP_CHOLESKY_FACTOR_NUMERIC=29, 1153 MATOP_SETUP_PREALLOCATION=30, 1154 MATOP_ILUFACTOR_SYMBOLIC=31, 1155 MATOP_ICCFACTOR_SYMBOLIC=32, 1156 MATOP_GET_ARRAY=33, 1157 MATOP_RESTORE_ARRAY=34, 1158 MATOP_DUPLCIATE=35, 1159 MATOP_FORWARD_SOLVE=36, 1160 MATOP_BACKWARD_SOLVE=37, 1161 MATOP_ILUFACTOR=38, 1162 MATOP_ICCFACTOR=39, 1163 MATOP_AXPY=40, 1164 MATOP_GET_SUBMATRICES=41, 1165 MATOP_INCREASE_OVERLAP=42, 1166 MATOP_GET_VALUES=43, 1167 MATOP_COPY=44, 1168 MATOP_PRINT_HELP=45, 1169 MATOP_SCALE=46, 1170 MATOP_SHIFT=47, 1171 MATOP_DIAGONAL_SHIFT=48, 1172 MATOP_ILUDT_FACTOR=49, 1173 MATOP_GET_BLOCK_SIZE=50, 1174 MATOP_GET_ROW_IJ=51, 1175 MATOP_RESTORE_ROW_IJ=52, 1176 MATOP_GET_COLUMN_IJ=53, 1177 MATOP_RESTORE_COLUMN_IJ=54, 1178 MATOP_FDCOLORING_CREATE=55, 1179 MATOP_COLORING_PATCH=56, 1180 MATOP_SET_UNFACTORED=57, 1181 MATOP_PERMUTE=58, 1182 MATOP_SET_VALUES_BLOCKED=59, 1183 MATOP_GET_SUBMATRIX=60, 1184 MATOP_DESTROY=61, 1185 MATOP_VIEW=62, 1186 MATOP_GET_MAPS=63, 1187 MATOP_USE_SCALED_FORM=64, 1188 MATOP_SCALE_SYSTEM=65, 1189 MATOP_UNSCALE_SYSTEM=66, 1190 MATOP_SET_LOCAL_TO_GLOBAL_MAPPING=67, 1191 MATOP_SET_VALUES_LOCAL=68, 1192 MATOP_ZERO_ROWS_LOCAL=69, 1193 MATOP_GET_ROW_MAX=70, 1194 MATOP_CONVERT=71, 1195 MATOP_SET_COLORING=72, 1196 MATOP_SET_VALUES_ADIC=73, 1197 MATOP_SET_VALUES_ADIFOR=74, 1198 MATOP_FD_COLORING_APPLY=75, 1199 MATOP_SET_FROM_OPTIONS=76, 1200 MATOP_MULT_CONSTRAINED=77, 1201 MATOP_MULT_TRANSPOSE_CONSTRAINED=78, 1202 MATOP_ILU_FACTOR_SYMBOLIC_CONSTRAINED=79, 1203 MATOP_PERMUTE_SPARSIFY=80, 1204 MATOP_MULT_MULTIPLE=81, 1205 MATOP_SOLVE_MULTIPLE=82 1206 } MatOperation; 1207 EXTERN int MatHasOperation(Mat,MatOperation,PetscTruth*); 1208 EXTERN int MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1209 EXTERN int MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1210 EXTERN int MatShellSetContext(Mat,void*); 1211 1212 /* 1213 Codes for matrices stored on disk. By default they are 1214 stored in a universal format. By changing the format with 1215 PetscViewerSetFormat(viewer,PETSC_VIEWER_BINARY_NATIVE); the matrices will 1216 be stored in a way natural for the matrix, for example dense matrices 1217 would be stored as dense. Matrices stored this way may only be 1218 read into matrices of the same time. 1219 */ 1220 #define MATRIX_BINARY_FORMAT_DENSE -1 1221 1222 EXTERN int MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 1223 EXTERN int MatSeqAIJGetInodeSizes(Mat,int *,int *[],int *); 1224 EXTERN int MatMPIRowbsGetColor(Mat,ISColoring *); 1225 1226 EXTERN int MatISGetLocalMat(Mat,Mat*); 1227 1228 /*S 1229 MatNullSpace - Object that removes a null space from a vector, i.e. 1230 orthogonalizes the vector to a subsapce 1231 1232 Level: advanced 1233 1234 Concepts: matrix; linear operator, null space 1235 1236 Users manual sections: 1237 . sec_singular 1238 1239 .seealso: MatNullSpaceCreate() 1240 S*/ 1241 typedef struct _p_MatNullSpace* MatNullSpace; 1242 1243 EXTERN int MatNullSpaceCreate(MPI_Comm,int,int,const Vec[],MatNullSpace*); 1244 EXTERN int MatNullSpaceDestroy(MatNullSpace); 1245 EXTERN int MatNullSpaceRemove(MatNullSpace,Vec,Vec*); 1246 EXTERN int MatNullSpaceAttach(Mat,MatNullSpace); 1247 EXTERN int MatNullSpaceTest(MatNullSpace,Mat); 1248 1249 EXTERN int MatReorderingSeqSBAIJ(Mat A,IS isp); 1250 EXTERN int MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1251 EXTERN int MatSeqSBAIJSetColumnIndices(Mat,int *); 1252 1253 EXTERN int MatMatMult(Mat A,Mat B, Mat *C); 1254 EXTERN int MatMatMultSymbolic(Mat A,Mat B,Mat *C); 1255 EXTERN int MatMatMultNumeric(Mat A,Mat B,Mat C); 1256 1257 EXTERN int MatCreateMAIJ(Mat,int,Mat*); 1258 EXTERN int MatMAIJRedimension(Mat,int,Mat*); 1259 EXTERN int MatMAIJGetAIJ(Mat,Mat*); 1260 1261 EXTERN int MatComputeExplicitOperator(Mat,Mat*); 1262 1263 EXTERN int MatESISetType(Mat,const char*); 1264 EXTERN int MatESISetFromOptions(Mat); 1265 1266 EXTERN int MatDiagonalScaleLocal(Mat,Vec); 1267 1268 EXTERN int PetscViewerMathematicaPutMatrix(PetscViewer, int, int, PetscReal *); 1269 EXTERN int PetscViewerMathematicaPutCSRMatrix(PetscViewer, int, int, int *, int *, PetscReal *); 1270 1271 EXTERN int MatSeqAIJPtAP(Mat,Mat,Mat*); 1272 1273 PETSC_EXTERN_CXX_END 1274 #endif 1275