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