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