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