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 383 EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal *); 384 EXTERN PetscErrorCode MatZeroEntries(Mat); 385 EXTERN PetscErrorCode MatZeroRows(Mat,IS,const PetscScalar*); 386 EXTERN PetscErrorCode MatZeroColumns(Mat,IS,const PetscScalar*); 387 388 EXTERN PetscErrorCode MatUseScaledForm(Mat,PetscTruth); 389 EXTERN PetscErrorCode MatScaleSystem(Mat,Vec,Vec); 390 EXTERN PetscErrorCode MatUnScaleSystem(Mat,Vec,Vec); 391 392 EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*); 393 EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*); 394 EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*); 395 396 /*E 397 MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices() 398 or MatGetSubMatrix() are to be reused to store the new matrix values. 399 400 Level: beginner 401 402 Any additions/changes here MUST also be made in include/finclude/petscmat.h 403 404 .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices() 405 E*/ 406 typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX} MatReuse; 407 EXTERN PetscErrorCode MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 408 EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]); 409 EXTERN PetscErrorCode MatGetSubMatrix(Mat,IS,IS,PetscInt,MatReuse,Mat *); 410 EXTERN PetscErrorCode MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*); 411 EXTERN PetscErrorCode MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*); 412 EXTERN PetscErrorCode MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*); 413 EXTERN PetscErrorCode MatMerge_SeqsToMPINumeric(Mat,Mat); 414 EXTERN PetscErrorCode MatDestroy_MPIAIJ_SeqsToMPI(Mat); 415 EXTERN PetscErrorCode MatGetLocalMat(Mat,MatReuse,Mat*); 416 EXTERN PetscErrorCode MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*); 417 EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*); 418 EXTERN PetscErrorCode MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscScalar**,Mat*); 419 420 EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt); 421 422 EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 423 EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*); 424 EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat); 425 426 EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*); 427 EXTERN PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*); 428 EXTERN PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat); 429 430 EXTERN PetscErrorCode MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*); 431 EXTERN PetscErrorCode MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*); 432 EXTERN PetscErrorCode MatMatMultTransposeNumeric(Mat,Mat,Mat); 433 434 EXTERN PetscErrorCode MatAXPY(const PetscScalar *,Mat,Mat,MatStructure); 435 EXTERN PetscErrorCode MatAYPX(const PetscScalar *,Mat,Mat); 436 EXTERN PetscErrorCode MatCompress(Mat); 437 438 EXTERN PetscErrorCode MatScale(const PetscScalar *,Mat); 439 EXTERN PetscErrorCode MatShift(const PetscScalar *,Mat); 440 441 EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping); 442 EXTERN PetscErrorCode MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping); 443 EXTERN PetscErrorCode MatZeroRowsLocal(Mat,IS,const PetscScalar*); 444 EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 445 EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 446 447 EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt); 448 EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 449 450 EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec); 451 EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec); 452 EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec); 453 EXTERN PetscErrorCode MatGetVecs(Mat,Vec*,Vec*); 454 455 /*MC 456 MatPreallocInitialize - Begins the block of code that will count the number of nonzeros per 457 row in a matrix providing the data that one can use to correctly preallocate the matrix. 458 459 Synopsis: 460 PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 461 462 Collective on MPI_Comm 463 464 Input Parameters: 465 + comm - the communicator that will share the eventually allocated matrix 466 . nrows - the number of LOCAL rows in the matrix 467 - ncols - the number of LOCAL columns in the matrix 468 469 Output Parameters: 470 + dnz - the array that will be passed to the matrix preallocation routines 471 - ozn - the other array passed to the matrix preallocation routines 472 473 474 Level: intermediate 475 476 Notes: 477 See the chapter in the users manual on performance for more details 478 479 Do not malloc or free dnz and onz, that is handled internally by these routines 480 481 Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices) 482 483 Concepts: preallocation^Matrix 484 485 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 486 MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal() 487 M*/ 488 #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \ 489 { \ 490 PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__start,__end; \ 491 _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\ 492 _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 493 _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\ 494 _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp; 495 496 /*MC 497 MatPreallocSymmetricInitialize - Begins the block of code that will count the number of nonzeros per 498 row in a matrix providing the data that one can use to correctly preallocate the matrix. 499 500 Synopsis: 501 PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 502 503 Collective on MPI_Comm 504 505 Input Parameters: 506 + comm - the communicator that will share the eventually allocated matrix 507 . nrows - the number of LOCAL rows in the matrix 508 - ncols - the number of LOCAL columns in the matrix 509 510 Output Parameters: 511 + dnz - the array that will be passed to the matrix preallocation routines 512 - ozn - the other array passed to the matrix preallocation routines 513 514 515 Level: intermediate 516 517 Notes: 518 See the chapter in the users manual on performance for more details 519 520 Do not malloc or free dnz and onz, that is handled internally by these routines 521 522 Concepts: preallocation^Matrix 523 524 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 525 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 526 M*/ 527 #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \ 528 { \ 529 PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__end; \ 530 _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\ 531 _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 532 _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\ 533 _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp; 534 535 /*MC 536 MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 537 inserted using a local number of the rows and columns 538 539 Synopsis: 540 PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 541 542 Not Collective 543 544 Input Parameters: 545 + map - the mapping between local numbering and global numbering 546 . nrows - the number of rows indicated 547 . rows - the indices of the rows 548 . ncols - the number of columns in the matrix 549 . cols - the columns indicated 550 . dnz - the array that will be passed to the matrix preallocation routines 551 - ozn - the other array passed to the matrix preallocation routines 552 553 554 Level: intermediate 555 556 Notes: 557 See the chapter in the users manual on performance for more details 558 559 Do not malloc or free dnz and onz, that is handled internally by these routines 560 561 Concepts: preallocation^Matrix 562 563 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 564 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 565 M*/ 566 #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 567 {\ 568 PetscInt __l;\ 569 _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 570 _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 571 for (__l=0;__l<nrows;__l++) {\ 572 _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 573 }\ 574 } 575 576 /*MC 577 MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 578 inserted using a local number of the rows and columns 579 580 Synopsis: 581 PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 582 583 Not Collective 584 585 Input Parameters: 586 + map - the mapping between local numbering and global numbering 587 . nrows - the number of rows indicated 588 . rows - the indices of the rows 589 . ncols - the number of columns in the matrix 590 . cols - the columns indicated 591 . dnz - the array that will be passed to the matrix preallocation routines 592 - ozn - the other array passed to the matrix preallocation routines 593 594 595 Level: intermediate 596 597 Notes: 598 See the chapter in the users manual on performance for more details 599 600 Do not malloc or free dnz and onz that is handled internally by these routines 601 602 Concepts: preallocation^Matrix 603 604 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 605 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 606 M*/ 607 #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 608 {\ 609 PetscInt __l;\ 610 _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 611 _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 612 for (__l=0;__l<nrows;__l++) {\ 613 _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 614 }\ 615 } 616 617 /*MC 618 MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 619 inserted using a local number of the rows and columns 620 621 Synopsis: 622 PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 623 624 Not Collective 625 626 Input Parameters: 627 + nrows - the number of rows indicated 628 . rows - the indices of the rows 629 . ncols - the number of columns in the matrix 630 - cols - the columns indicated 631 632 Output Parameters: 633 + dnz - the array that will be passed to the matrix preallocation routines 634 - ozn - the other array passed to the matrix preallocation routines 635 636 637 Level: intermediate 638 639 Notes: 640 See the chapter in the users manual on performance for more details 641 642 Do not malloc or free dnz and onz that is handled internally by these routines 643 644 Concepts: preallocation^Matrix 645 646 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 647 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 648 M*/ 649 #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\ 650 { PetscInt __i; \ 651 for (__i=0; __i<nc; __i++) {\ 652 if (cols[__i] < __start || cols[__i] >= __end) onz[row - __rstart]++; \ 653 }\ 654 dnz[row - __rstart] = nc - onz[row - __rstart];\ 655 } 656 657 /*MC 658 MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 659 inserted using a local number of the rows and columns 660 661 Synopsis: 662 PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 663 664 Not Collective 665 666 Input Parameters: 667 + nrows - the number of rows indicated 668 . rows - the indices of the rows 669 . ncols - the number of columns in the matrix 670 . cols - the columns indicated 671 . dnz - the array that will be passed to the matrix preallocation routines 672 - ozn - the other array passed to the matrix preallocation routines 673 674 675 Level: intermediate 676 677 Notes: 678 See the chapter in the users manual on performance for more details 679 680 Do not malloc or free dnz and onz that is handled internally by these routines 681 682 Concepts: preallocation^Matrix 683 684 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 685 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 686 M*/ 687 #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\ 688 { PetscInt __i; \ 689 for (__i=0; __i<nc; __i++) {\ 690 if (cols[__i] >= __end) onz[row - __rstart]++; \ 691 else if (cols[__i] >= row) dnz[row - __rstart]++;\ 692 }\ 693 } 694 695 /*MC 696 MatPreallocFinalize - Ends the block of code that will count the number of nonzeros per 697 row in a matrix providing the data that one can use to correctly preallocate the matrix. 698 699 Synopsis: 700 PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz) 701 702 Collective on MPI_Comm 703 704 Input Parameters: 705 + dnz - the array that will be passed to the matrix preallocation routines 706 - ozn - the other array passed to the matrix preallocation routines 707 708 709 Level: intermediate 710 711 Notes: 712 See the chapter in the users manual on performance for more details 713 714 Do not malloc or free dnz and onz that is handled internally by these routines 715 716 Concepts: preallocation^Matrix 717 718 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 719 MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal() 720 M*/ 721 #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree(dnz);CHKERRQ(_4_ierr);} 722 723 724 725 /* Routines unique to particular data structures */ 726 EXTERN PetscErrorCode MatShellGetContext(Mat,void **); 727 728 EXTERN PetscErrorCode MatBDiagGetData(Mat,PetscInt*,PetscInt*,PetscInt*[],PetscInt*[],PetscScalar***); 729 EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]); 730 EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]); 731 EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 732 733 EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 734 EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 735 EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]); 736 EXTERN PetscErrorCode MatSeqDensePreallocation(Mat,PetscScalar[]); 737 EXTERN PetscErrorCode MatSeqBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]); 738 EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 739 740 EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 741 EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 742 EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 743 EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]); 744 EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 745 EXTERN PetscErrorCode MatMPIDensePreallocation(Mat,PetscScalar[]); 746 EXTERN PetscErrorCode MatMPIBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]); 747 EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]); 748 EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 749 EXTERN PetscErrorCode MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]); 750 EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]); 751 EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]); 752 EXTERN PetscErrorCode MatAdicSetLocalFunction(Mat,void (*)(void)); 753 754 EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt); 755 756 EXTERN PetscErrorCode MatStoreValues(Mat); 757 EXTERN PetscErrorCode MatRetrieveValues(Mat); 758 759 EXTERN PetscErrorCode MatDAADSetCtx(Mat,void*); 760 761 /* 762 These routines are not usually accessed directly, rather solving is 763 done through the KSP and PC interfaces. 764 */ 765 766 /*E 767 MatOrderingType - String with the name of a PETSc matrix ordering or the creation function 768 with an optional dynamic library name, for example 769 http://www.mcs.anl.gov/petsc/lib.a:orderingcreate() 770 771 Level: beginner 772 773 .seealso: MatGetOrdering() 774 E*/ 775 #define MatOrderingType char* 776 #define MATORDERING_NATURAL "natural" 777 #define MATORDERING_ND "nd" 778 #define MATORDERING_1WD "1wd" 779 #define MATORDERING_RCM "rcm" 780 #define MATORDERING_QMD "qmd" 781 #define MATORDERING_ROWLENGTH "rowlength" 782 #define MATORDERING_DSC_ND "dsc_nd" 783 #define MATORDERING_DSC_MMD "dsc_mmd" 784 #define MATORDERING_DSC_MDF "dsc_mdf" 785 #define MATORDERING_CONSTRAINED "constrained" 786 #define MATORDERING_IDENTITY "identity" 787 #define MATORDERING_REVERSE "reverse" 788 789 EXTERN PetscErrorCode MatGetOrdering(Mat,const MatOrderingType,IS*,IS*); 790 EXTERN PetscErrorCode MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*)); 791 792 /*MC 793 MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the 794 matrix package. 795 796 Synopsis: 797 PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering)) 798 799 Not Collective 800 801 Input Parameters: 802 + sname - name of ordering (for example MATORDERING_ND) 803 . path - location of library where creation routine is 804 . name - name of function that creates the ordering type,a string 805 - function - function pointer that creates the ordering 806 807 Level: developer 808 809 If dynamic libraries are used, then the fourth input argument (function) 810 is ignored. 811 812 Sample usage: 813 .vb 814 MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a, 815 "MyOrder",MyOrder); 816 .ve 817 818 Then, your partitioner can be chosen with the procedural interface via 819 $ MatOrderingSetType(part,"my_order) 820 or at runtime via the option 821 $ -pc_ilu_mat_ordering_type my_order 822 $ -pc_lu_mat_ordering_type my_order 823 824 ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values. 825 826 .keywords: matrix, ordering, register 827 828 .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll() 829 M*/ 830 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 831 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0) 832 #else 833 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d) 834 #endif 835 836 EXTERN PetscErrorCode MatOrderingRegisterDestroy(void); 837 EXTERN PetscErrorCode MatOrderingRegisterAll(const char[]); 838 extern PetscTruth MatOrderingRegisterAllCalled; 839 extern PetscFList MatOrderingList; 840 841 EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 842 843 /*S 844 MatFactorInfo - Data based into the matrix factorization routines 845 846 In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE 847 848 Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 849 850 Level: developer 851 852 .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(), 853 MatFactorInfoInitialize() 854 855 S*/ 856 typedef struct { 857 PetscReal damping; /* scaling of identity added to matrix to prevent zero pivots */ 858 PetscReal shift; /* if true, shift until positive pivots */ 859 PetscReal shift_fraction; /* record shift fraction taken */ 860 PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 861 PetscReal dt; /* drop tolerance */ 862 PetscReal dtcol; /* tolerance for pivoting */ 863 PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 864 PetscReal fill; /* expected fill; nonzeros in factored matrix/nonzeros in original matrix*/ 865 PetscReal levels; /* ICC/ILU(levels) */ 866 PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 867 factorization may be faster if do not pivot */ 868 PetscReal zeropivot; /* pivot is called zero if less than this */ 869 } MatFactorInfo; 870 871 EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*); 872 EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,MatFactorInfo*); 873 EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*); 874 EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat*); 875 EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,MatFactorInfo*); 876 EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,MatFactorInfo*); 877 EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*); 878 EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*); 879 EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*); 880 EXTERN PetscErrorCode MatICCFactor(Mat,IS,MatFactorInfo*); 881 EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat*); 882 EXTERN PetscErrorCode MatILUDTFactor(Mat,MatFactorInfo*,IS,IS,Mat *); 883 EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 884 EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec); 885 EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec); 886 EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec); 887 EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec); 888 EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec); 889 EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 890 EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs); 891 892 EXTERN PetscErrorCode MatSetUnfactored(Mat); 893 894 /*E 895 MatSORType - What type of (S)SOR to perform 896 897 Level: beginner 898 899 May be bitwise ORd together 900 901 Any additions/changes here MUST also be made in include/finclude/petscmat.h 902 903 MatSORType may be bitwise ORd together, so do not change the numbers 904 905 .seealso: MatRelax(), MatPBRelax() 906 E*/ 907 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 908 SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 909 SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 910 SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 911 EXTERN PetscErrorCode MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 912 EXTERN PetscErrorCode MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 913 914 /* 915 These routines are for efficiently computing Jacobians via finite differences. 916 */ 917 918 /*E 919 MatColoringType - String with the name of a PETSc matrix coloring or the creation function 920 with an optional dynamic library name, for example 921 http://www.mcs.anl.gov/petsc/lib.a:coloringcreate() 922 923 Level: beginner 924 925 .seealso: MatGetColoring() 926 E*/ 927 #define MatColoringType char* 928 #define MATCOLORING_NATURAL "natural" 929 #define MATCOLORING_SL "sl" 930 #define MATCOLORING_LF "lf" 931 #define MATCOLORING_ID "id" 932 933 EXTERN PetscErrorCode MatGetColoring(Mat,const MatColoringType,ISColoring*); 934 EXTERN PetscErrorCode MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatColoringType,ISColoring *)); 935 936 /*MC 937 MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the 938 matrix package. 939 940 Synopsis: 941 PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring)) 942 943 Not Collective 944 945 Input Parameters: 946 + sname - name of Coloring (for example MATCOLORING_SL) 947 . path - location of library where creation routine is 948 . name - name of function that creates the Coloring type, a string 949 - function - function pointer that creates the coloring 950 951 Level: developer 952 953 If dynamic libraries are used, then the fourth input argument (function) 954 is ignored. 955 956 Sample usage: 957 .vb 958 MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a, 959 "MyColor",MyColor); 960 .ve 961 962 Then, your partitioner can be chosen with the procedural interface via 963 $ MatColoringSetType(part,"my_color") 964 or at runtime via the option 965 $ -mat_coloring_type my_color 966 967 $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 968 969 .keywords: matrix, Coloring, register 970 971 .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll() 972 M*/ 973 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 974 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0) 975 #else 976 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d) 977 #endif 978 979 extern PetscTruth MatColoringRegisterAllCalled; 980 981 EXTERN PetscErrorCode MatColoringRegisterAll(const char[]); 982 EXTERN PetscErrorCode MatColoringRegisterDestroy(void); 983 EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 984 985 /*S 986 MatFDColoring - Object for computing a sparse Jacobian via finite differences 987 and coloring 988 989 Level: beginner 990 991 Concepts: coloring, sparse Jacobian, finite differences 992 993 .seealso: MatFDColoringCreate() 994 S*/ 995 typedef struct _p_MatFDColoring *MatFDColoring; 996 997 EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 998 EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring); 999 EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer); 1000 EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 1001 EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1002 EXTERN PetscErrorCode MatFDColoringSetFrequency(MatFDColoring,PetscInt); 1003 EXTERN PetscErrorCode MatFDColoringGetFrequency(MatFDColoring,PetscInt*); 1004 EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring); 1005 EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *); 1006 EXTERN PetscErrorCode MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *); 1007 EXTERN PetscErrorCode MatFDColoringSetRecompute(MatFDColoring); 1008 EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec); 1009 EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]); 1010 /* 1011 These routines are for partitioning matrices: currently used only 1012 for adjacency matrix, MatCreateMPIAdj(). 1013 */ 1014 1015 /*S 1016 MatPartitioning - Object for managing the partitioning of a matrix or graph 1017 1018 Level: beginner 1019 1020 Concepts: partitioning 1021 1022 .seealso: MatPartitioningCreate(), MatPartitioningType 1023 S*/ 1024 typedef struct _p_MatPartitioning *MatPartitioning; 1025 1026 /*E 1027 MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function 1028 with an optional dynamic library name, for example 1029 http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate() 1030 1031 Level: beginner 1032 1033 .seealso: MatPartitioningCreate(), MatPartitioning 1034 E*/ 1035 #define MatPartitioningType char* 1036 #define MAT_PARTITIONING_CURRENT "current" 1037 #define MAT_PARTITIONING_SQUARE "square" 1038 #define MAT_PARTITIONING_PARMETIS "parmetis" 1039 #define MAT_PARTITIONING_CHACO "chaco" 1040 #define MAT_PARTITIONING_JOSTLE "jostle" 1041 #define MAT_PARTITIONING_PARTY "party" 1042 #define MAT_PARTITIONING_SCOTCH "scotch" 1043 1044 1045 EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*); 1046 EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,const MatPartitioningType); 1047 EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt); 1048 EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat); 1049 EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1050 EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1051 EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*); 1052 EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning); 1053 1054 EXTERN PetscErrorCode MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning)); 1055 1056 /*MC 1057 MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the 1058 matrix package. 1059 1060 Synopsis: 1061 PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning)) 1062 1063 Not Collective 1064 1065 Input Parameters: 1066 + sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis 1067 . path - location of library where creation routine is 1068 . name - name of function that creates the partitioning type, a string 1069 - function - function pointer that creates the partitioning type 1070 1071 Level: developer 1072 1073 If dynamic libraries are used, then the fourth input argument (function) 1074 is ignored. 1075 1076 Sample usage: 1077 .vb 1078 MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a, 1079 "MyPartCreate",MyPartCreate); 1080 .ve 1081 1082 Then, your partitioner can be chosen with the procedural interface via 1083 $ MatPartitioningSetType(part,"my_part") 1084 or at runtime via the option 1085 $ -mat_partitioning_type my_part 1086 1087 $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 1088 1089 .keywords: matrix, partitioning, register 1090 1091 .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll() 1092 M*/ 1093 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1094 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0) 1095 #else 1096 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d) 1097 #endif 1098 1099 extern PetscTruth MatPartitioningRegisterAllCalled; 1100 1101 EXTERN PetscErrorCode MatPartitioningRegisterAll(const char[]); 1102 EXTERN PetscErrorCode MatPartitioningRegisterDestroy(void); 1103 1104 EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer); 1105 EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning); 1106 EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*); 1107 1108 EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 1109 1110 EXTERN PetscErrorCode MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal); 1111 EXTERN PetscErrorCode MatPartitioningJostleSetCoarseSequential(MatPartitioning); 1112 1113 typedef enum { MP_CHACO_MULTILEVEL_KL, MP_CHACO_SPECTRAL, MP_CHACO_LINEAR, 1114 MP_CHACO_RANDOM, MP_CHACO_SCATTERED } MPChacoGlobalType; 1115 EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType); 1116 typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType; 1117 EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType); 1118 EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 1119 typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType; 1120 EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1121 EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal); 1122 EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt); 1123 1124 #define MP_PARTY_OPT "opt" 1125 #define MP_PARTY_LIN "lin" 1126 #define MP_PARTY_SCA "sca" 1127 #define MP_PARTY_RAN "ran" 1128 #define MP_PARTY_GBF "gbf" 1129 #define MP_PARTY_GCF "gcf" 1130 #define MP_PARTY_BUB "bub" 1131 #define MP_PARTY_DEF "def" 1132 EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning, const char*); 1133 #define MP_PARTY_HELPFUL_SETS "hs" 1134 #define MP_PARTY_KERNIGHAN_LIN "kl" 1135 #define MP_PARTY_NONE "no" 1136 EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning, const char*); 1137 EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1138 EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscTruth); 1139 EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth); 1140 1141 typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType; 1142 EXTERN PetscErrorCode MatPartitioningScotchSetArch(MatPartitioning,const char*); 1143 EXTERN PetscErrorCode MatPartitioningScotchSetMultilevel(MatPartitioning); 1144 EXTERN PetscErrorCode MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType); 1145 EXTERN PetscErrorCode MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal); 1146 EXTERN PetscErrorCode MatPartitioningScotchSetHostList(MatPartitioning,const char*); 1147 typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType; 1148 EXTERN PetscErrorCode MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType); 1149 EXTERN PetscErrorCode MatPartitioningScotchSetMapping(MatPartitioning); 1150 EXTERN PetscErrorCode MatPartitioningScotchSetStrategy(MatPartitioning,char*); 1151 1152 /* 1153 If you add entries here you must also add them to finclude/petscmat.h 1154 */ 1155 typedef enum { MATOP_SET_VALUES=0, 1156 MATOP_GET_ROW=1, 1157 MATOP_RESTORE_ROW=2, 1158 MATOP_MULT=3, 1159 MATOP_MULT_ADD=4, 1160 MATOP_MULT_TRANSPOSE=5, 1161 MATOP_MULT_TRANSPOSE_ADD=6, 1162 MATOP_SOLVE=7, 1163 MATOP_SOLVE_ADD=8, 1164 MATOP_SOLVE_TRANSPOSE=9, 1165 MATOP_SOLVE_TRANSPOSE_ADD=10, 1166 MATOP_LUFACTOR=11, 1167 MATOP_CHOLESKYFACTOR=12, 1168 MATOP_RELAX=13, 1169 MATOP_TRANSPOSE=14, 1170 MATOP_GETINFO=15, 1171 MATOP_EQUAL=16, 1172 MATOP_GET_DIAGONAL=17, 1173 MATOP_DIAGONAL_SCALE=18, 1174 MATOP_NORM=19, 1175 MATOP_ASSEMBLY_BEGIN=20, 1176 MATOP_ASSEMBLY_END=21, 1177 MATOP_COMPRESS=22, 1178 MATOP_SET_OPTION=23, 1179 MATOP_ZERO_ENTRIES=24, 1180 MATOP_ZERO_ROWS=25, 1181 MATOP_LUFACTOR_SYMBOLIC=26, 1182 MATOP_LUFACTOR_NUMERIC=27, 1183 MATOP_CHOLESKY_FACTOR_SYMBOLIC=28, 1184 MATOP_CHOLESKY_FACTOR_NUMERIC=29, 1185 MATOP_SETUP_PREALLOCATION=30, 1186 MATOP_ILUFACTOR_SYMBOLIC=31, 1187 MATOP_ICCFACTOR_SYMBOLIC=32, 1188 MATOP_GET_ARRAY=33, 1189 MATOP_RESTORE_ARRAY=34, 1190 MATOP_DUPLCIATE=35, 1191 MATOP_FORWARD_SOLVE=36, 1192 MATOP_BACKWARD_SOLVE=37, 1193 MATOP_ILUFACTOR=38, 1194 MATOP_ICCFACTOR=39, 1195 MATOP_AXPY=40, 1196 MATOP_GET_SUBMATRICES=41, 1197 MATOP_INCREASE_OVERLAP=42, 1198 MATOP_GET_VALUES=43, 1199 MATOP_COPY=44, 1200 MATOP_PRINT_HELP=45, 1201 MATOP_SCALE=46, 1202 MATOP_SHIFT=47, 1203 MATOP_DIAGONAL_SHIFT=48, 1204 MATOP_ILUDT_FACTOR=49, 1205 MATOP_GET_BLOCK_SIZE=50, 1206 MATOP_GET_ROW_IJ=51, 1207 MATOP_RESTORE_ROW_IJ=52, 1208 MATOP_GET_COLUMN_IJ=53, 1209 MATOP_RESTORE_COLUMN_IJ=54, 1210 MATOP_FDCOLORING_CREATE=55, 1211 MATOP_COLORING_PATCH=56, 1212 MATOP_SET_UNFACTORED=57, 1213 MATOP_PERMUTE=58, 1214 MATOP_SET_VALUES_BLOCKED=59, 1215 MATOP_GET_SUBMATRIX=60, 1216 MATOP_DESTROY=61, 1217 MATOP_VIEW=62, 1218 MATOP_GET_MAPS=63, 1219 MATOP_USE_SCALED_FORM=64, 1220 MATOP_SCALE_SYSTEM=65, 1221 MATOP_UNSCALE_SYSTEM=66, 1222 MATOP_SET_LOCAL_TO_GLOBAL_MAP=67, 1223 MATOP_SET_VALUES_LOCAL=68, 1224 MATOP_ZERO_ROWS_LOCAL=69, 1225 MATOP_GET_ROW_MAX=70, 1226 MATOP_CONVERT=71, 1227 MATOP_SET_COLORING=72, 1228 MATOP_SET_VALUES_ADIC=73, 1229 MATOP_SET_VALUES_ADIFOR=74, 1230 MATOP_FD_COLORING_APPLY=75, 1231 MATOP_SET_FROM_OPTIONS=76, 1232 MATOP_MULT_CON=77, 1233 MATOP_MULT_TRANSPOSE_CON=78, 1234 MATOP_ILU_FACTOR_SYMBOLIC_CON=79, 1235 MATOP_PERMUTE_SPARSIFY=80, 1236 MATOP_MULT_MULTIPLE=81, 1237 MATOP_SOLVE_MULTIPLE=82, 1238 MATOP_GET_INERTIA=83, 1239 MATOP_LOAD=84, 1240 MATOP_IS_SYMMETRIC=85, 1241 MATOP_IS_HERMITIAN=86, 1242 MATOP_IS_STRUCTURALLY_SYMMETRIC=87, 1243 MATOP_PB_RELAX=88, 1244 MATOP_GET_VECS=89, 1245 MATOP_MAT_MULT=90, 1246 MATOP_MAT_MULT_SYMBOLIC=91, 1247 MATOP_MAT_MULT_NUMERIC=92, 1248 MATOP_PTAP=93, 1249 MATOP_PTAP_SYMBOLIC=94, 1250 MATOP_PTAP_NUMERIC=95, 1251 MATOP_MAT_MULTTRANSPOSE=96, 1252 MATOP_MAT_MULTTRANSPOSE_SYMBOLIC=97, 1253 MATOP_MAT_MULTTRANSPOSE_NUMERIC=98 1254 } MatOperation; 1255 EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscTruth*); 1256 EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1257 EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1258 EXTERN PetscErrorCode MatShellSetContext(Mat,void*); 1259 1260 /* 1261 Codes for matrices stored on disk. By default they are 1262 stored in a universal format. By changing the format with 1263 PetscViewerSetFormat(viewer,PETSC_VIEWER_BINARY_NATIVE); the matrices will 1264 be stored in a way natural for the matrix, for example dense matrices 1265 would be stored as dense. Matrices stored this way may only be 1266 read into matrices of the same time. 1267 */ 1268 #define MATRIX_BINARY_FORMAT_DENSE -1 1269 1270 EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 1271 EXTERN PetscErrorCode MatSeqAIJGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *); 1272 EXTERN PetscErrorCode MatMPIRowbsGetColor(Mat,ISColoring *); 1273 1274 EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*); 1275 1276 /*S 1277 MatNullSpace - Object that removes a null space from a vector, i.e. 1278 orthogonalizes the vector to a subsapce 1279 1280 Level: advanced 1281 1282 Concepts: matrix; linear operator, null space 1283 1284 Users manual sections: 1285 . sec_singular 1286 1287 .seealso: MatNullSpaceCreate() 1288 S*/ 1289 typedef struct _p_MatNullSpace* MatNullSpace; 1290 1291 EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*); 1292 EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace); 1293 EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec,Vec*); 1294 EXTERN PetscErrorCode MatNullSpaceAttach(Mat,MatNullSpace); 1295 EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat); 1296 1297 EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS); 1298 EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1299 EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 1300 1301 1302 EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*); 1303 EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*); 1304 EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*); 1305 1306 EXTERN PetscErrorCode MatComputeExplicitOperator(Mat,Mat*); 1307 1308 EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec); 1309 1310 EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1311 EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 1312 1313 PETSC_EXTERN_CXX_END 1314 #endif 1315