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