1 /* 2 Include file for the matrix component of PETSc 3 */ 4 #pragma once 5 6 #include <petscvec.h> 7 8 /* SUBMANSEC = Mat */ 9 10 /*S 11 Mat - Abstract PETSc matrix object used to manage all linear operators in PETSc, even those without 12 an explicit sparse representation (such as matrix-free operators). Also used to hold representations of graphs 13 for graph operations such as coloring, `MatColoringCreate()` 14 15 Level: beginner 16 17 Note: 18 See [](doc_matrix), [](ch_matrices) and `MatType` for available matrix types 19 20 .seealso: [](doc_matrix), [](ch_matrices), `MatCreate()`, `MatType`, `MatSetType()`, `MatDestroy()` 21 S*/ 22 typedef struct _p_Mat *Mat; 23 24 /*J 25 MatType - String with the name of a PETSc matrix type 26 27 Level: beginner 28 29 Note: 30 [](doc_matrix) for a table of available matrix types 31 32 .seealso: [](doc_matrix), [](ch_matrices), `MatSetType()`, `Mat`, `MatSolverType`, `MatRegister()` 33 J*/ 34 typedef const char *MatType; 35 #define MATSAME "same" 36 #define MATMAIJ "maij" 37 #define MATSEQMAIJ "seqmaij" 38 #define MATMPIMAIJ "mpimaij" 39 #define MATKAIJ "kaij" 40 #define MATSEQKAIJ "seqkaij" 41 #define MATMPIKAIJ "mpikaij" 42 #define MATIS "is" 43 #define MATAIJ "aij" 44 #define MATSEQAIJ "seqaij" 45 #define MATMPIAIJ "mpiaij" 46 #define MATAIJCRL "aijcrl" 47 #define MATSEQAIJCRL "seqaijcrl" 48 #define MATMPIAIJCRL "mpiaijcrl" 49 #define MATAIJCUSPARSE "aijcusparse" 50 #define MATSEQAIJCUSPARSE "seqaijcusparse" 51 #define MATMPIAIJCUSPARSE "mpiaijcusparse" 52 #define MATAIJHIPSPARSE "aijhipsparse" 53 #define MATSEQAIJHIPSPARSE "seqaijhipsparse" 54 #define MATMPIAIJHIPSPARSE "mpiaijhipsparse" 55 #define MATAIJKOKKOS "aijkokkos" 56 #define MATSEQAIJKOKKOS "seqaijkokkos" 57 #define MATMPIAIJKOKKOS "mpiaijkokkos" 58 #define MATAIJVIENNACL "aijviennacl" 59 #define MATSEQAIJVIENNACL "seqaijviennacl" 60 #define MATMPIAIJVIENNACL "mpiaijviennacl" 61 #define MATAIJPERM "aijperm" 62 #define MATSEQAIJPERM "seqaijperm" 63 #define MATMPIAIJPERM "mpiaijperm" 64 #define MATAIJSELL "aijsell" 65 #define MATSEQAIJSELL "seqaijsell" 66 #define MATMPIAIJSELL "mpiaijsell" 67 #define MATAIJMKL "aijmkl" 68 #define MATSEQAIJMKL "seqaijmkl" 69 #define MATMPIAIJMKL "mpiaijmkl" 70 #define MATBAIJMKL "baijmkl" 71 #define MATSEQBAIJMKL "seqbaijmkl" 72 #define MATMPIBAIJMKL "mpibaijmkl" 73 #define MATSHELL "shell" 74 #define MATCENTERING "centering" 75 #define MATDENSE "dense" 76 #define MATDENSECUDA "densecuda" 77 #define MATDENSEHIP "densehip" 78 #define MATSEQDENSE "seqdense" 79 #define MATSEQDENSECUDA "seqdensecuda" 80 #define MATSEQDENSEHIP "seqdensehip" 81 #define MATMPIDENSE "mpidense" 82 #define MATMPIDENSECUDA "mpidensecuda" 83 #define MATMPIDENSEHIP "mpidensehip" 84 #define MATELEMENTAL "elemental" 85 #define MATSCALAPACK "scalapack" 86 #define MATBAIJ "baij" 87 #define MATSEQBAIJ "seqbaij" 88 #define MATMPIBAIJ "mpibaij" 89 #define MATMPIADJ "mpiadj" 90 #define MATSBAIJ "sbaij" 91 #define MATSEQSBAIJ "seqsbaij" 92 #define MATMPISBAIJ "mpisbaij" 93 #define MATMFFD "mffd" 94 #define MATNORMAL "normal" 95 #define MATNORMALHERMITIAN "normalh" 96 #define MATLRC "lrc" 97 #define MATSCATTER "scatter" 98 #define MATBLOCKMAT "blockmat" 99 #define MATCOMPOSITE "composite" 100 #define MATFFT "fft" 101 #define MATFFTW "fftw" 102 #define MATSEQCUFFT "seqcufft" 103 #define MATSEQHIPFFT "seqhipfft" 104 #define MATTRANSPOSEMAT PETSC_DEPRECATED_MACRO(3, 18, 0, "MATTRANSPOSEVIRTUAL", ) "transpose" 105 #define MATTRANSPOSEVIRTUAL "transpose" 106 #define MATHERMITIANTRANSPOSEVIRTUAL "hermitiantranspose" 107 #define MATSCHURCOMPLEMENT "schurcomplement" 108 #define MATPYTHON "python" 109 #define MATHYPRE "hypre" 110 #define MATHYPRESTRUCT "hyprestruct" 111 #define MATHYPRESSTRUCT "hypresstruct" 112 #define MATSUBMATRIX "submatrix" 113 #define MATLOCALREF "localref" 114 #define MATNEST "nest" 115 #define MATPREALLOCATOR "preallocator" 116 #define MATSELL "sell" 117 #define MATSEQSELL "seqsell" 118 #define MATMPISELL "mpisell" 119 #define MATSELLCUDA "sellcuda" 120 #define MATSEQSELLCUDA "seqsellcuda" 121 #define MATMPISELLCUDA "mpisellcuda" 122 #define MATDUMMY "dummy" 123 #define MATLMVM "lmvm" 124 #define MATLMVMDFP "lmvmdfp" 125 #define MATLMVMBFGS "lmvmbfgs" 126 #define MATLMVMSR1 "lmvmsr1" 127 #define MATLMVMBROYDEN "lmvmbroyden" 128 #define MATLMVMBADBROYDEN "lmvmbadbroyden" 129 #define MATLMVMSYMBROYDEN "lmvmsymbroyden" 130 #define MATLMVMSYMBADBROYDEN "lmvmsymbadbroyden" 131 #define MATLMVMDIAGBROYDEN "lmvmdiagbroyden" 132 #define MATCONSTANTDIAGONAL "constantdiagonal" 133 #define MATDIAGONAL "diagonal" 134 #define MATHTOOL "htool" 135 #define MATH2OPUS "h2opus" 136 137 /*J 138 MatSolverType - String with the name of a PETSc factorization-based matrix solver type. 139 140 For example: "petsc" indicates what PETSc provides, "superlu_dist" the parallel SuperLU_DIST package etc 141 142 Level: beginner 143 144 Note: 145 `MATSOLVERUMFPACK`, `MATSOLVERCHOLMOD`, `MATSOLVERKLU`, `MATSOLVERSPQR` form the SuiteSparse package; you can use `--download-suitesparse` as 146 a ./configure option to install them 147 148 .seealso: [](sec_matfactor), [](ch_matrices), `MatGetFactor()`, `PCFactorSetMatSolverType()`, `PCFactorGetMatSolverType()` 149 J*/ 150 typedef const char *MatSolverType; 151 #define MATSOLVERSUPERLU "superlu" 152 #define MATSOLVERSUPERLU_DIST "superlu_dist" 153 #define MATSOLVERSTRUMPACK "strumpack" 154 #define MATSOLVERUMFPACK "umfpack" 155 #define MATSOLVERCHOLMOD "cholmod" 156 #define MATSOLVERKLU "klu" 157 #define MATSOLVERELEMENTAL "elemental" 158 #define MATSOLVERSCALAPACK "scalapack" 159 #define MATSOLVERESSL "essl" 160 #define MATSOLVERLUSOL "lusol" 161 #define MATSOLVERMUMPS "mumps" 162 #define MATSOLVERMKL_PARDISO "mkl_pardiso" 163 #define MATSOLVERMKL_CPARDISO "mkl_cpardiso" 164 #define MATSOLVERPASTIX "pastix" 165 #define MATSOLVERMATLAB "matlab" 166 #define MATSOLVERPETSC "petsc" 167 #define MATSOLVERBAS "bas" 168 #define MATSOLVERCUSPARSE "cusparse" 169 #define MATSOLVERCUDA "cuda" 170 #define MATSOLVERHIPSPARSE "hipsparse" 171 #define MATSOLVERHIP "hip" 172 #define MATSOLVERKOKKOS "kokkos" 173 #define MATSOLVERSPQR "spqr" 174 175 /*E 176 MatFactorType - indicates what type of factorization is requested 177 178 Values: 179 + `MAT_FACTOR_LU` - LU factorization 180 . `MAT_FACTOR_CHOLESKY` - Cholesky factorization 181 . `MAT_FACTOR_ILU` - ILU factorization 182 . `MAT_FACTOR_ICC` - incomplete Cholesky factorization 183 . `MAT_FACTOR_ILUDT` - ILU factorization with drop tolerance 184 - `MAT_FACTOR_QR` - QR factorization 185 186 Level: beginner 187 188 .seealso: [](ch_matrices), `MatSolverType`, `MatGetFactor()`, `MatGetFactorAvailable()`, `MatSolverTypeRegister()` 189 E*/ 190 typedef enum { 191 MAT_FACTOR_NONE, 192 MAT_FACTOR_LU, 193 MAT_FACTOR_CHOLESKY, 194 MAT_FACTOR_ILU, 195 MAT_FACTOR_ICC, 196 MAT_FACTOR_ILUDT, 197 MAT_FACTOR_QR, 198 MAT_FACTOR_NUM_TYPES 199 } MatFactorType; 200 PETSC_EXTERN const char *const MatFactorTypes[]; 201 202 PETSC_EXTERN PetscErrorCode MatGetFactor(Mat, MatSolverType, MatFactorType, Mat *); 203 PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat, MatSolverType, MatFactorType, PetscBool *); 204 PETSC_EXTERN PetscErrorCode MatFactorGetCanUseOrdering(Mat, PetscBool *); 205 PETSC_DEPRECATED_FUNCTION(3, 15, 0, "MatFactorGetCanUseOrdering()", ) static inline PetscErrorCode MatFactorGetUseOrdering(Mat A, PetscBool *b) 206 { 207 return MatFactorGetCanUseOrdering(A, b); 208 } 209 PETSC_EXTERN PetscErrorCode MatFactorGetSolverType(Mat, MatSolverType *); 210 PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat, MatFactorType *); 211 PETSC_EXTERN PetscErrorCode MatSetFactorType(Mat, MatFactorType); 212 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode(MatSolverFn)(Mat, MatFactorType, Mat *); 213 PETSC_EXTERN_TYPEDEF typedef MatSolverFn *MatSolverFunction; 214 215 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType, MatType, MatFactorType, MatSolverFn *); 216 PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType, MatType, MatFactorType, PetscBool *, PetscBool *, MatSolverFn **); 217 typedef MatSolverType MatSolverPackage PETSC_DEPRECATED_TYPEDEF(3, 9, 0, "MatSolverType", ); 218 PETSC_DEPRECATED_FUNCTION(3, 9, 0, "MatSolverTypeRegister()", ) static inline PetscErrorCode MatSolverPackageRegister(MatSolverType stype, MatType mtype, MatFactorType ftype, MatSolverFn *f) 219 { 220 return MatSolverTypeRegister(stype, mtype, ftype, f); 221 } 222 PETSC_DEPRECATED_FUNCTION(3, 9, 0, "MatSolverTypeGet()", ) static inline PetscErrorCode MatSolverPackageGet(MatSolverType stype, MatType mtype, MatFactorType ftype, PetscBool *foundmtype, PetscBool *foundstype, MatSolverFn **f) 223 { 224 return MatSolverTypeGet(stype, mtype, ftype, foundmtype, foundstype, f); 225 } 226 227 /*E 228 MatProductType - indicates what type of matrix product to compute 229 230 Values: 231 + `MATPRODUCT_AB` - product of two matrices 232 . `MATPRODUCT_AtB` - product of the transpose of a given matrix with a matrix 233 . `MATPRODUCT_ABt` - product of a matrix with the transpose of another given matrix 234 . `MATPRODUCT_PtAP` - the triple product of the transpose of a matrix with another matrix and itself 235 . `MATPRODUCT_RARt` - the triple product of a matrix, another matrix and the transpose of the first matrix 236 - `MATPRODUCT_ABC` - the product of three matrices 237 238 Level: beginner 239 240 .seealso: [](sec_matmatproduct), [](ch_matrices), `MatProductSetType()` 241 E*/ 242 typedef enum { 243 MATPRODUCT_UNSPECIFIED = 0, 244 MATPRODUCT_AB, 245 MATPRODUCT_AtB, 246 MATPRODUCT_ABt, 247 MATPRODUCT_PtAP, 248 MATPRODUCT_RARt, 249 MATPRODUCT_ABC 250 } MatProductType; 251 PETSC_EXTERN const char *const MatProductTypes[]; 252 253 /*J 254 MatProductAlgorithm - String with the name of an algorithm for a PETSc matrix product implementation 255 256 Level: beginner 257 258 .seealso: [](sec_matmatproduct), [](ch_matrices), `MatSetType()`, `Mat`, `MatProductSetAlgorithm()`, `MatProductType` 259 J*/ 260 typedef const char *MatProductAlgorithm; 261 #define MATPRODUCTALGORITHMDEFAULT "default" 262 #define MATPRODUCTALGORITHMSORTED "sorted" 263 #define MATPRODUCTALGORITHMSCALABLE "scalable" 264 #define MATPRODUCTALGORITHMSCALABLEFAST "scalable_fast" 265 #define MATPRODUCTALGORITHMHEAP "heap" 266 #define MATPRODUCTALGORITHMBHEAP "btheap" 267 #define MATPRODUCTALGORITHMLLCONDENSED "llcondensed" 268 #define MATPRODUCTALGORITHMROWMERGE "rowmerge" 269 #define MATPRODUCTALGORITHMOUTERPRODUCT "outerproduct" 270 #define MATPRODUCTALGORITHMATB "at*b" 271 #define MATPRODUCTALGORITHMRAP "rap" 272 #define MATPRODUCTALGORITHMNONSCALABLE "nonscalable" 273 #define MATPRODUCTALGORITHMSEQMPI "seqmpi" 274 #define MATPRODUCTALGORITHMBACKEND "backend" 275 #define MATPRODUCTALGORITHMOVERLAPPING "overlapping" 276 #define MATPRODUCTALGORITHMMERGED "merged" 277 #define MATPRODUCTALGORITHMALLATONCE "allatonce" 278 #define MATPRODUCTALGORITHMALLATONCEMERGED "allatonce_merged" 279 #define MATPRODUCTALGORITHMALLGATHERV "allgatherv" 280 #define MATPRODUCTALGORITHMCYCLIC "cyclic" 281 #if defined(PETSC_HAVE_HYPRE) 282 #define MATPRODUCTALGORITHMHYPRE "hypre" 283 #endif 284 285 PETSC_EXTERN PetscErrorCode MatProductCreate(Mat, Mat, Mat, Mat *); 286 PETSC_EXTERN PetscErrorCode MatProductCreateWithMat(Mat, Mat, Mat, Mat); 287 PETSC_EXTERN PetscErrorCode MatProductSetType(Mat, MatProductType); 288 PETSC_EXTERN PetscErrorCode MatProductSetAlgorithm(Mat, MatProductAlgorithm); 289 PETSC_EXTERN PetscErrorCode MatProductGetAlgorithm(Mat, MatProductAlgorithm *); 290 PETSC_EXTERN PetscErrorCode MatProductSetFill(Mat, PetscReal); 291 PETSC_EXTERN PetscErrorCode MatProductSetFromOptions(Mat); 292 PETSC_EXTERN PetscErrorCode MatProductSymbolic(Mat); 293 PETSC_EXTERN PetscErrorCode MatProductNumeric(Mat); 294 PETSC_EXTERN PetscErrorCode MatProductReplaceMats(Mat, Mat, Mat, Mat); 295 PETSC_EXTERN PetscErrorCode MatProductClear(Mat); 296 PETSC_EXTERN PetscErrorCode MatProductView(Mat, PetscViewer); 297 PETSC_EXTERN PetscErrorCode MatProductGetType(Mat, MatProductType *); 298 PETSC_EXTERN PetscErrorCode MatProductGetMats(Mat, Mat *, Mat *, Mat *); 299 300 /* Logging support */ 301 #define MAT_FILE_CLASSID 1211216 /* used to indicate matrices in binary files */ 302 PETSC_EXTERN PetscClassId MAT_CLASSID; 303 PETSC_EXTERN PetscClassId MAT_COLORING_CLASSID; 304 PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID; 305 PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID; 306 PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID; 307 PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID; 308 PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID; 309 PETSC_EXTERN PetscClassId MATMFFD_CLASSID; 310 311 /*E 312 MatReuse - Indicates if matrices obtained from a previous call to `MatCreateSubMatrices()`, `MatCreateSubMatrix()`, `MatConvert()` or several other functions 313 are to be reused to store the new matrix values. 314 315 Values: 316 + `MAT_INITIAL_MATRIX` - create a new matrix 317 . `MAT_REUSE_MATRIX` - reuse the matrix created with a previous call that used `MAT_INITIAL_MATRIX` 318 . `MAT_INPLACE_MATRIX` - replace the first input matrix with the new matrix (not applicable to all functions) 319 - `MAT_IGNORE_MATRIX` - do not create a new matrix or reuse a give matrix, just ignore that matrix argument (not applicable to all functions) 320 321 Level: beginner 322 323 .seealso: [](ch_matrices), `Mat`, `MatCreateSubMatrices()`, `MatCreateSubMatrix()`, `MatDestroyMatrices()`, `MatConvert()` 324 E*/ 325 typedef enum { 326 MAT_INITIAL_MATRIX, 327 MAT_REUSE_MATRIX, 328 MAT_IGNORE_MATRIX, 329 MAT_INPLACE_MATRIX 330 } MatReuse; 331 332 /*E 333 MatCreateSubMatrixOption - Indicates if matrices obtained from a call to `MatCreateSubMatrices()` 334 include the matrix values. Currently it is only used by `MatGetSeqNonzeroStructure()`. 335 336 Values: 337 + `MAT_DO_NOT_GET_VALUES` - do not copy the matrix values 338 - `MAT_GET_VALUES` - copy the matrix values 339 340 Level: developer 341 342 Developer Note: 343 Why is not just a boolean used for this information? 344 345 .seealso: [](ch_matrices), `Mat`, `MatDuplicateOption`, `PetscCopyMode`, `MatGetSeqNonzeroStructure()` 346 E*/ 347 typedef enum { 348 MAT_DO_NOT_GET_VALUES, 349 MAT_GET_VALUES 350 } MatCreateSubMatrixOption; 351 352 PETSC_EXTERN PetscErrorCode MatInitializePackage(void); 353 PETSC_EXTERN PetscErrorCode MatFinalizePackage(void); 354 355 PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm, Mat *); 356 PETSC_EXTERN PetscErrorCode MatCreateFromOptions(MPI_Comm, const char *, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, Mat *); 357 PETSC_EXTERN PetscErrorCode MatSetSizes(Mat, PetscInt, PetscInt, PetscInt, PetscInt); 358 PETSC_EXTERN PetscErrorCode MatSetType(Mat, MatType); 359 PETSC_EXTERN PetscErrorCode MatGetVecType(Mat, VecType *); 360 PETSC_EXTERN PetscErrorCode MatSetVecType(Mat, VecType); 361 PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat); 362 PETSC_EXTERN PetscErrorCode MatViewFromOptions(Mat, PetscObject, const char[]); 363 PETSC_EXTERN PetscErrorCode MatRegister(const char[], PetscErrorCode (*)(Mat)); 364 PETSC_EXTERN PetscErrorCode MatRegisterRootName(const char[], const char[], const char[]); 365 PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat, const char[]); 366 PETSC_EXTERN PetscErrorCode MatSetOptionsPrefixFactor(Mat, const char[]); 367 PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefixFactor(Mat, const char[]); 368 PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat, const char[]); 369 PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat, const char *[]); 370 PETSC_EXTERN PetscErrorCode MatSetErrorIfFailure(Mat, PetscBool); 371 372 PETSC_EXTERN PetscFunctionList MatList; 373 PETSC_EXTERN PetscFunctionList MatColoringList; 374 PETSC_EXTERN PetscFunctionList MatPartitioningList; 375 376 /*E 377 MatStructure - Indicates if two matrices have the same nonzero structure 378 379 Values: 380 + `SAME_NONZERO_PATTERN` - the two matrices have identical nonzero patterns 381 . `DIFFERENT_NONZERO_PATTERN` - the two matrices may have different nonzero patterns 382 . `SUBSET_NONZERO_PATTERN` - the nonzero pattern of the second matrix is a subset of the nonzero pattern of the first matrix 383 - `UNKNOWN_NONZERO_PATTERN` - there is no known relationship between the nonzero patterns. In this case the implementations 384 may try to detect a relationship to optimize the operation 385 386 Level: beginner 387 388 Note: 389 Certain matrix operations (such as `MatAXPY()`) can run much faster if the sparsity pattern of the matrices are the same. But actually determining if 390 the patterns are the same may be costly. This provides a way for users who know something about the sparsity patterns to provide this information 391 to certain PETSc routines. 392 393 .seealso: [](ch_matrices), `Mat`, `MatCopy()`, `MatAXPY()`, `MatAYPX()` 394 E*/ 395 typedef enum { 396 DIFFERENT_NONZERO_PATTERN, 397 SUBSET_NONZERO_PATTERN, 398 SAME_NONZERO_PATTERN, 399 UNKNOWN_NONZERO_PATTERN 400 } MatStructure; 401 PETSC_EXTERN const char *const MatStructures[]; 402 403 #if defined PETSC_HAVE_MKL_SPARSE 404 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *); 405 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *); 406 PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *); 407 PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *); 408 #endif 409 410 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJPERM(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *); 411 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJPERM(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *); 412 413 PETSC_EXTERN PetscErrorCode MatCreateSeqSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *); 414 PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *); 415 PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat, PetscInt, const PetscInt[]); 416 PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]); 417 PETSC_EXTERN PetscErrorCode MatSeqSELLGetFillRatio(Mat, PetscReal *); 418 PETSC_EXTERN PetscErrorCode MatSeqSELLGetMaxSliceWidth(Mat, PetscInt *); 419 PETSC_EXTERN PetscErrorCode MatSeqSELLGetAvgSliceWidth(Mat, PetscReal *); 420 PETSC_EXTERN PetscErrorCode MatSeqSELLSetSliceHeight(Mat, PetscInt); 421 PETSC_EXTERN PetscErrorCode MatSeqSELLGetVarSliceSize(Mat, PetscReal *); 422 423 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *); 424 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSELL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *); 425 PETSC_EXTERN PetscErrorCode MatMPISELLGetLocalMatCondensed(Mat, MatReuse, IS *, IS *, Mat *); 426 PETSC_EXTERN PetscErrorCode MatMPISELLGetSeqSELL(Mat, Mat *, Mat *, const PetscInt *[]); 427 428 PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm, PetscInt, PetscInt, PetscScalar[], Mat *); 429 PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar[], Mat *); 430 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *); 431 PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *); 432 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], Mat *); 433 PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArrays(Mat, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]); 434 PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArray(Mat, const PetscScalar[]); 435 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], PetscInt[], PetscInt[], PetscScalar[], Mat *); 436 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm, Mat, Mat, const PetscInt[], Mat *); 437 438 PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *); 439 PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *); 440 PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], Mat *); 441 442 PETSC_EXTERN PetscErrorCode MatSetPreallocationCOO(Mat, PetscCount, PetscInt[], PetscInt[]); 443 PETSC_EXTERN PetscErrorCode MatSetPreallocationCOOLocal(Mat, PetscCount, PetscInt[], PetscInt[]); 444 PETSC_EXTERN PetscErrorCode MatSetValuesCOO(Mat, const PetscScalar[], InsertMode); 445 446 PETSC_EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscInt[], Mat *); 447 PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *); 448 449 PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *); 450 PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], Mat *); 451 PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]); 452 PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]); 453 PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscInt[], const PetscInt[]); 454 455 PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, void *, Mat *); 456 PETSC_EXTERN PetscErrorCode MatCreateCentering(MPI_Comm, PetscInt, PetscInt, Mat *); 457 PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat, Mat *); 458 PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat, Mat *); 459 PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat, Mat, Vec, Mat, Mat *); 460 PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat, Mat *, Mat *, Vec *, Mat *); 461 PETSC_EXTERN PetscErrorCode MatLRCSetMats(Mat, Mat, Mat, Vec, Mat); 462 PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, ISLocalToGlobalMapping, ISLocalToGlobalMapping, Mat *); 463 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *); 464 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *); 465 466 PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm, VecScatter, Mat *); 467 PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat, VecScatter); 468 PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat, VecScatter *); 469 PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt *, Mat *); 470 PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat, Mat); 471 PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat); 472 typedef enum { 473 MAT_COMPOSITE_MERGE_RIGHT, 474 MAT_COMPOSITE_MERGE_LEFT 475 } MatCompositeMergeType; 476 PETSC_EXTERN PetscErrorCode MatCompositeSetMergeType(Mat, MatCompositeMergeType); 477 PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm, PetscInt, const Mat *, Mat *); 478 /*E 479 MatCompositeType - indicates what type of `MATCOMPOSITE` is used 480 481 Values: 482 + `MAT_COMPOSITE_ADDITIVE` - sum of matrices (default) 483 - `MAT_COMPOSITE_MULTIPLICATIVE` - product of matrices 484 485 Level: beginner 486 487 .seealso: [](ch_matrices), `MATCOMPOSITE`, `MatCompositeSetType()`, `MatCompositeGetType()` 488 E*/ 489 typedef enum { 490 MAT_COMPOSITE_ADDITIVE, 491 MAT_COMPOSITE_MULTIPLICATIVE 492 } MatCompositeType; 493 PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat, MatCompositeType); 494 PETSC_EXTERN PetscErrorCode MatCompositeGetType(Mat, MatCompositeType *); 495 PETSC_EXTERN PetscErrorCode MatCompositeSetMatStructure(Mat, MatStructure); 496 PETSC_EXTERN PetscErrorCode MatCompositeGetMatStructure(Mat, MatStructure *); 497 PETSC_EXTERN PetscErrorCode MatCompositeGetNumberMat(Mat, PetscInt *); 498 PETSC_EXTERN PetscErrorCode MatCompositeGetMat(Mat, PetscInt, Mat *); 499 PETSC_EXTERN PetscErrorCode MatCompositeSetScalings(Mat, const PetscScalar *); 500 501 PETSC_EXTERN PetscErrorCode MatCreateFFT(MPI_Comm, PetscInt, const PetscInt[], MatType, Mat *); 502 PETSC_EXTERN PetscErrorCode MatCreateSeqCUFFT(MPI_Comm, PetscInt, const PetscInt[], Mat *); 503 504 PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat, Mat *); 505 PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat, Mat *); 506 PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat, Mat *); 507 PETSC_EXTERN PetscErrorCode MatHermitianTransposeGetMat(Mat, Mat *); 508 PETSC_EXTERN PetscErrorCode MatNormalGetMat(Mat, Mat *); 509 PETSC_EXTERN PetscErrorCode MatNormalHermitianGetMat(Mat, Mat *); 510 PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat, IS, IS, Mat *); 511 PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat, Mat, IS, IS); 512 PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat, IS, IS, Mat *); 513 PETSC_EXTERN PetscErrorCode MatCreateConstantDiagonal(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar, Mat *); 514 PETSC_EXTERN PetscErrorCode MatCreateDiagonal(Vec, Mat *); 515 PETSC_EXTERN PetscErrorCode MatDiagonalGetDiagonal(Mat, Vec *); 516 PETSC_EXTERN PetscErrorCode MatDiagonalRestoreDiagonal(Mat, Vec *); 517 PETSC_EXTERN PetscErrorCode MatDiagonalGetInverseDiagonal(Mat, Vec *); 518 PETSC_EXTERN PetscErrorCode MatDiagonalRestoreInverseDiagonal(Mat, Vec *); 519 520 #if defined(PETSC_HAVE_HYPRE) 521 PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]); 522 #endif 523 524 PETSC_EXTERN PetscErrorCode MatPythonSetType(Mat, const char[]); 525 PETSC_EXTERN PetscErrorCode MatPythonGetType(Mat, const char *[]); 526 527 PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat); 528 PETSC_EXTERN PetscErrorCode MatSetUp(Mat); 529 PETSC_EXTERN PetscErrorCode MatDestroy(Mat *); 530 PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat, PetscObjectState *); 531 532 PETSC_EXTERN PetscErrorCode MatConjugate(Mat); 533 PETSC_EXTERN PetscErrorCode MatRealPart(Mat); 534 PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat); 535 PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat, Mat *); 536 PETSC_EXTERN PetscErrorCode MatGetTrace(Mat, PetscScalar *); 537 PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat, const PetscScalar **); 538 PETSC_EXTERN PetscErrorCode MatInvertVariableBlockDiagonal(Mat, PetscInt, const PetscInt *, PetscScalar *); 539 PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat, Mat); 540 PETSC_EXTERN PetscErrorCode MatInvertVariableBlockEnvelope(Mat, MatReuse, Mat *); 541 PETSC_EXTERN PetscErrorCode MatComputeVariableBlockEnvelope(Mat); 542 543 PETSC_EXTERN PetscErrorCode MatSetValues(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode); 544 PETSC_EXTERN PetscErrorCode MatSetValuesIS(Mat, IS, IS, const PetscScalar[], InsertMode); 545 PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode); 546 PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat, PetscInt, const PetscScalar[]); 547 PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat, PetscInt, const PetscScalar[]); 548 PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat, PetscInt, PetscInt, PetscInt[], const PetscScalar[]); 549 PETSC_EXTERN PetscErrorCode MatSetRandom(Mat, PetscRandom); 550 551 /*S 552 MatStencil - Data structure (C struct) for storing information about rows and 553 columns of a matrix as indexed on an associated grid. These are arguments to `MatSetStencil()` and `MatSetBlockStencil()` 554 555 Level: beginner 556 557 Notes: 558 The i,j, and k represent the logical coordinates over the entire grid (for 2 and 1 dimensional problems the k and j entries are ignored). 559 The c represents the degrees of freedom at each grid point (the dof argument to `DMDASetDOF()`). If dof is 1 then this entry is ignored. 560 561 For stencil access to vectors see `DMDAVecGetArray()`, `DMDAVecGetArrayF90()`. 562 563 For staggered grids, see `DMStagStencil` 564 565 Fortran Note: 566 See `MatSetValuesStencil()` for details. 567 568 .seealso: [](ch_matrices), `Mat`, `MatSetValuesStencil()`, `MatSetStencil()`, `MatSetValuesBlockedStencil()`, `DMDAVecGetArray()`, `DMDAVecGetArrayF90()`, 569 `DMStagStencil` 570 S*/ 571 typedef struct { 572 PetscInt k, j, i, c; 573 } MatStencil; 574 575 PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat, PetscInt, const MatStencil[], PetscInt, const MatStencil[], const PetscScalar[], InsertMode); 576 PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat, PetscInt, const MatStencil[], PetscInt, const MatStencil[], const PetscScalar[], InsertMode); 577 PETSC_EXTERN PetscErrorCode MatSetStencil(Mat, PetscInt, const PetscInt[], const PetscInt[], PetscInt); 578 579 /*E 580 MatAssemblyType - Indicates if the process of setting values into the matrix is complete, and the matrix is ready for use 581 582 Values: 583 + `MAT_FLUSH_ASSEMBLY` - you will continue to put values into the matrix 584 - `MAT_FINAL_ASSEMBLY` - you wish to use the matrix with the values currently inserted 585 586 Level: beginner 587 588 .seealso: [](ch_matrices), `Mat`, `MatSetValues`, `MatAssemblyBegin()`, `MatAssemblyEnd()` 589 E*/ 590 typedef enum { 591 MAT_FLUSH_ASSEMBLY = 1, 592 MAT_FINAL_ASSEMBLY = 0 593 } MatAssemblyType; 594 595 PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat, MatAssemblyType); 596 PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat, MatAssemblyType); 597 PETSC_EXTERN PetscErrorCode MatAssembled(Mat, PetscBool *); 598 599 /*E 600 MatOption - Options that may be set for a matrix that indicate properties of the matrix or affect its behavior or storage 601 602 Level: beginner 603 604 Note: 605 See `MatSetOption()` for the use of the options 606 607 Developer Note: 608 Entries that are negative need not be called collectively by all processes. 609 610 .seealso: [](ch_matrices), `Mat`, `MatSetOption()` 611 E*/ 612 typedef enum { 613 MAT_OPTION_MIN = -3, 614 MAT_UNUSED_NONZERO_LOCATION_ERR = -2, 615 MAT_ROW_ORIENTED = -1, 616 MAT_SYMMETRIC = 1, 617 MAT_STRUCTURALLY_SYMMETRIC = 2, 618 MAT_FORCE_DIAGONAL_ENTRIES = 3, 619 MAT_IGNORE_OFF_PROC_ENTRIES = 4, 620 MAT_USE_HASH_TABLE = 5, 621 MAT_KEEP_NONZERO_PATTERN = 6, 622 MAT_IGNORE_ZERO_ENTRIES = 7, 623 MAT_USE_INODES = 8, 624 MAT_HERMITIAN = 9, 625 MAT_SYMMETRY_ETERNAL = 10, 626 MAT_NEW_NONZERO_LOCATION_ERR = 11, 627 MAT_IGNORE_LOWER_TRIANGULAR = 12, 628 MAT_ERROR_LOWER_TRIANGULAR = 13, 629 MAT_GETROW_UPPERTRIANGULAR = 14, 630 MAT_SPD = 15, 631 MAT_NO_OFF_PROC_ZERO_ROWS = 16, 632 MAT_NO_OFF_PROC_ENTRIES = 17, 633 MAT_NEW_NONZERO_LOCATIONS = 18, 634 MAT_NEW_NONZERO_ALLOCATION_ERR = 19, 635 MAT_SUBSET_OFF_PROC_ENTRIES = 20, 636 MAT_SUBMAT_SINGLEIS = 21, 637 MAT_STRUCTURE_ONLY = 22, 638 MAT_SORTED_FULL = 23, 639 MAT_FORM_EXPLICIT_TRANSPOSE = 24, 640 MAT_STRUCTURAL_SYMMETRY_ETERNAL = 25, 641 MAT_SPD_ETERNAL = 26, 642 MAT_OPTION_MAX = 27 643 } MatOption; 644 645 PETSC_EXTERN const char *const *MatOptions; 646 PETSC_EXTERN PetscErrorCode MatSetOption(Mat, MatOption, PetscBool); 647 PETSC_EXTERN PetscErrorCode MatGetOption(Mat, MatOption, PetscBool *); 648 PETSC_EXTERN PetscErrorCode MatPropagateSymmetryOptions(Mat, Mat); 649 PETSC_EXTERN PetscErrorCode MatGetType(Mat, MatType *); 650 651 PETSC_EXTERN PetscErrorCode MatGetValues(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], PetscScalar[]); 652 PETSC_EXTERN PetscErrorCode MatGetRow(Mat, PetscInt, PetscInt *, const PetscInt *[], const PetscScalar *[]); 653 PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat, PetscInt, PetscInt *, const PetscInt *[], const PetscScalar *[]); 654 PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat); 655 PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat); 656 PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat, Vec, PetscInt); 657 PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat, PetscScalar *[]); 658 PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayRead(Mat, const PetscScalar *[]); 659 PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayWrite(Mat, PetscScalar *[]); 660 PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat, PetscScalar *[]); 661 PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayRead(Mat, const PetscScalar *[]); 662 PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayWrite(Mat, PetscScalar *[]); 663 PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat, PetscInt *); 664 PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode); 665 PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat, MatType); 666 PETSC_EXTERN PetscErrorCode MatSeqAIJKron(Mat, Mat, MatReuse, Mat *); 667 PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[], PetscErrorCode (*)(Mat, MatType, MatReuse, Mat *)); 668 PETSC_EXTERN PetscFunctionList MatSeqAIJList; 669 PETSC_EXTERN PetscErrorCode MatSeqBAIJGetArray(Mat, PetscScalar *[]); 670 PETSC_EXTERN PetscErrorCode MatSeqBAIJRestoreArray(Mat, PetscScalar *[]); 671 PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat, PetscScalar *[]); 672 PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat, PetscScalar *[]); 673 PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat, PetscScalar *[]); 674 PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat, PetscScalar *[]); 675 PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat, const PetscScalar[]); 676 PETSC_EXTERN PetscErrorCode MatDenseReplaceArray(Mat, const PetscScalar[]); 677 PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat); 678 PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat, const PetscScalar *[]); 679 PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat, const PetscScalar *[]); 680 PETSC_EXTERN PetscErrorCode MatDenseGetArrayWrite(Mat, PetscScalar *[]); 681 PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayWrite(Mat, PetscScalar *[]); 682 PETSC_EXTERN PetscErrorCode MatDenseGetArrayAndMemType(Mat, PetscScalar *[], PetscMemType *); 683 PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayAndMemType(Mat, PetscScalar *[]); 684 PETSC_EXTERN PetscErrorCode MatDenseGetArrayReadAndMemType(Mat, const PetscScalar *[], PetscMemType *); 685 PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayReadAndMemType(Mat, const PetscScalar *[]); 686 PETSC_EXTERN PetscErrorCode MatDenseGetArrayWriteAndMemType(Mat, PetscScalar *[], PetscMemType *); 687 PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayWriteAndMemType(Mat, PetscScalar *[]); 688 PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat, PetscInt *); 689 PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat, PetscInt); 690 PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat, PetscInt *, PetscInt *); 691 PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat, PetscInt, PetscInt); 692 PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat, Mat, Mat); 693 PETSC_EXTERN PetscErrorCode MatSetVariableBlockSizes(Mat, PetscInt, PetscInt *); 694 PETSC_EXTERN PetscErrorCode MatGetVariableBlockSizes(Mat, PetscInt *, const PetscInt **); 695 696 PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat, PetscInt, PetscScalar *[]); 697 PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat, PetscScalar *[]); 698 PETSC_EXTERN PetscErrorCode MatDenseGetColumnVec(Mat, PetscInt, Vec *); 699 PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVec(Mat, PetscInt, Vec *); 700 PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecRead(Mat, PetscInt, Vec *); 701 PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecRead(Mat, PetscInt, Vec *); 702 PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecWrite(Mat, PetscInt, Vec *); 703 PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecWrite(Mat, PetscInt, Vec *); 704 PETSC_EXTERN PetscErrorCode MatDenseGetSubMatrix(Mat, PetscInt, PetscInt, PetscInt, PetscInt, Mat *); 705 PETSC_EXTERN PetscErrorCode MatDenseRestoreSubMatrix(Mat, Mat *); 706 707 PETSC_EXTERN PetscErrorCode MatMult(Mat, Vec, Vec); 708 PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat, Vec, Vec); 709 PETSC_EXTERN PetscErrorCode MatMultAdd(Mat, Vec, Vec, Vec); 710 PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat, Vec, Vec); 711 PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat, Vec, Vec); 712 PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat, Mat, PetscReal, PetscBool *); 713 PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat, Mat, PetscReal, PetscBool *); 714 PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat, Vec, Vec, Vec); 715 PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat, Vec, Vec, Vec); 716 PETSC_EXTERN PetscErrorCode MatMatSolve(Mat, Mat, Mat); 717 PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat, Mat, Mat); 718 PETSC_EXTERN PetscErrorCode MatMatTransposeSolve(Mat, Mat, Mat); 719 PETSC_EXTERN PetscErrorCode MatResidual(Mat, Vec, Vec, Vec); 720 721 /*E 722 MatDuplicateOption - Indicates if a duplicated sparse matrix should have 723 its numerical values copied over or just its nonzero structure. 724 725 Values: 726 + `MAT_DO_NOT_COPY_VALUES` - Create a matrix using the same nonzero pattern as the original matrix, 727 with zeros for the numerical values 728 . `MAT_COPY_VALUES` - Create a matrix with the same nonzero pattern as the original matrix 729 and with the same numerical values. 730 - `MAT_SHARE_NONZERO_PATTERN` - Create a matrix that shares the nonzero structure with the previous matrix 731 and does not copy it, using zeros for the numerical values. The parent and 732 child matrices will share their index (i and j) arrays, and you cannot 733 insert new nonzero entries into either matrix 734 735 Level: beginner 736 737 Note: 738 Many matrix types (including `MATSEQAIJ`) do not support the `MAT_SHARE_NONZERO_PATTERN` optimization; in 739 this case the behavior is as if `MAT_DO_NOT_COPY_VALUES` has been specified. 740 741 .seealso: [](ch_matrices), `Mat`, `MatDuplicate()` 742 E*/ 743 typedef enum { 744 MAT_DO_NOT_COPY_VALUES, 745 MAT_COPY_VALUES, 746 MAT_SHARE_NONZERO_PATTERN 747 } MatDuplicateOption; 748 749 PETSC_EXTERN PetscErrorCode MatConvert(Mat, MatType, MatReuse, Mat *); 750 PETSC_EXTERN PetscErrorCode MatDuplicate(Mat, MatDuplicateOption, Mat *); 751 752 PETSC_EXTERN PetscErrorCode MatCopy(Mat, Mat, MatStructure); 753 PETSC_EXTERN PetscErrorCode MatView(Mat, PetscViewer); 754 PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat, PetscReal, PetscBool *); 755 PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat, PetscBool *); 756 PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat, PetscReal, PetscBool *); 757 PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat, PetscBool *, PetscBool *); 758 PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat, PetscBool *, PetscBool *); 759 PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetricKnown(Mat, PetscBool *, PetscBool *); 760 PETSC_EXTERN PetscErrorCode MatIsSPDKnown(Mat, PetscBool *, PetscBool *); 761 PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat, PetscBool *, PetscInt *); 762 PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer); 763 764 PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *); 765 PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *); 766 PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *); 767 PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *); 768 769 /*S 770 MatInfo - Context of matrix information, used with `MatGetInfo()` 771 772 Level: intermediate 773 774 Fortran Note: 775 Information is stored as a double-precision array of dimension `MAT_INFO_SIZE` 776 777 .seealso: [](ch_matrices), `Mat`, `MatGetInfo()`, `MatInfoType` 778 S*/ 779 typedef struct { 780 PetscLogDouble block_size; /* block size */ 781 PetscLogDouble nz_allocated, nz_used, nz_unneeded; /* number of nonzeros */ 782 PetscLogDouble memory; /* memory allocated */ 783 PetscLogDouble assemblies; /* number of matrix assemblies called */ 784 PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */ 785 PetscLogDouble fill_ratio_given, fill_ratio_needed; /* fill ratio for LU/ILU */ 786 PetscLogDouble factor_mallocs; /* number of mallocs during factorization */ 787 } MatInfo; 788 789 /*E 790 MatInfoType - Indicates if you want information about the local part of the matrix, 791 the entire parallel matrix or the maximum over all the local parts. 792 793 Values: 794 + `MAT_LOCAL` - values for each MPI process part of the matrix 795 . `MAT_GLOBAL_MAX` - maximum of each value over all MPI processes 796 - `MAT_GLOBAL_SUM` - sum of each value over all MPI processes 797 798 Level: beginner 799 800 .seealso: [](ch_matrices), `MatGetInfo()`, `MatInfo` 801 E*/ 802 typedef enum { 803 MAT_LOCAL = 1, 804 MAT_GLOBAL_MAX = 2, 805 MAT_GLOBAL_SUM = 3 806 } MatInfoType; 807 PETSC_EXTERN PetscErrorCode MatGetInfo(Mat, MatInfoType, MatInfo *); 808 PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat, Vec); 809 PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat, Vec, PetscInt[]); 810 PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat, Vec, PetscInt[]); 811 PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat, Vec, PetscInt[]); 812 PETSC_EXTERN PetscErrorCode MatGetRowSumAbs(Mat, Vec); 813 PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat, Vec, PetscInt[]); 814 PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat, Vec); 815 PETSC_EXTERN PetscErrorCode MatTranspose(Mat, MatReuse, Mat *); 816 PETSC_EXTERN PetscErrorCode MatTransposeSymbolic(Mat, Mat *); 817 PETSC_EXTERN PetscErrorCode MatTransposeSetPrecursor(Mat, Mat); 818 PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat, MatReuse, Mat *); 819 PETSC_EXTERN PetscErrorCode MatPermute(Mat, IS, IS, Mat *); 820 PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat, Vec, Vec); 821 PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat, Vec, InsertMode); 822 823 PETSC_EXTERN PetscErrorCode MatEqual(Mat, Mat, PetscBool *); 824 PETSC_EXTERN PetscErrorCode MatMultEqual(Mat, Mat, PetscInt, PetscBool *); 825 PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat, Mat, PetscInt, PetscBool *); 826 PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat, Mat, PetscInt, PetscBool *); 827 PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat, Mat, PetscInt, PetscBool *); 828 PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeEqual(Mat, Mat, PetscInt, PetscBool *); 829 PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAddEqual(Mat, Mat, PetscInt, PetscBool *); 830 PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *); 831 PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *); 832 PETSC_EXTERN PetscErrorCode MatMatTransposeMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *); 833 PETSC_EXTERN PetscErrorCode MatPtAPMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *); 834 PETSC_EXTERN PetscErrorCode MatRARtMultEqual(Mat, Mat, Mat, PetscInt, PetscBool *); 835 PETSC_EXTERN PetscErrorCode MatIsLinear(Mat, PetscInt, PetscBool *); 836 837 PETSC_EXTERN PetscErrorCode MatNorm(Mat, NormType, PetscReal *); 838 PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat, NormType, PetscReal *); 839 PETSC_EXTERN PetscErrorCode MatGetColumnSums(Mat, PetscScalar *); 840 PETSC_EXTERN PetscErrorCode MatGetColumnSumsRealPart(Mat, PetscReal *); 841 PETSC_EXTERN PetscErrorCode MatGetColumnSumsImaginaryPart(Mat, PetscReal *); 842 PETSC_EXTERN PetscErrorCode MatGetColumnMeans(Mat, PetscScalar *); 843 PETSC_EXTERN PetscErrorCode MatGetColumnMeansRealPart(Mat, PetscReal *); 844 PETSC_EXTERN PetscErrorCode MatGetColumnMeansImaginaryPart(Mat, PetscReal *); 845 PETSC_EXTERN PetscErrorCode MatGetColumnReductions(Mat, PetscInt, PetscReal *); 846 PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat); 847 PETSC_EXTERN PetscErrorCode MatSetInf(Mat); 848 PETSC_EXTERN PetscErrorCode MatZeroRows(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec); 849 PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat, IS, PetscScalar, Vec, Vec); 850 PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat, PetscInt, const MatStencil[], PetscScalar, Vec, Vec); 851 PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat, PetscInt, const MatStencil[], PetscScalar, Vec, Vec); 852 PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec); 853 PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat, IS, PetscScalar, Vec, Vec); 854 855 PETSC_EXTERN PetscErrorCode MatGetSize(Mat, PetscInt *, PetscInt *); 856 PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat, PetscInt *, PetscInt *); 857 PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat, PetscInt *, PetscInt *); 858 PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat, const PetscInt **); 859 PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat, PetscInt *, PetscInt *); 860 PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat, const PetscInt **); 861 PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat, IS *, IS *); 862 863 PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat, PetscInt, const IS[], const IS[], MatReuse, Mat *[]); 864 PETSC_DEPRECATED_FUNCTION(3, 8, 0, "MatCreateSubMatrices()", ) static inline PetscErrorCode MatGetSubMatrices(Mat mat, PetscInt n, const IS irow[], const IS icol[], MatReuse scall, Mat *submat[]) 865 { 866 return MatCreateSubMatrices(mat, n, irow, icol, scall, submat); 867 } 868 PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat, PetscInt, const IS[], const IS[], MatReuse, Mat *[]); 869 PETSC_DEPRECATED_FUNCTION(3, 8, 0, "MatCreateSubMatricesMPI()", ) static inline PetscErrorCode MatGetSubMatricesMPI(Mat mat, PetscInt n, const IS irow[], const IS icol[], MatReuse scall, Mat *submat[]) 870 { 871 return MatCreateSubMatricesMPI(mat, n, irow, icol, scall, submat); 872 } 873 PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt, Mat *[]); 874 PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt, Mat *[]); 875 PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat, IS, IS, MatReuse, Mat *); 876 PETSC_DEPRECATED_FUNCTION(3, 8, 0, "MatCreateSubMatrix()", ) static inline PetscErrorCode MatGetSubMatrix(Mat mat, IS isrow, IS iscol, MatReuse cll, Mat *newmat) 877 { 878 return MatCreateSubMatrix(mat, isrow, iscol, cll, newmat); 879 } 880 PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat, IS, IS, Mat *); 881 PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat, IS, IS, Mat *); 882 PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat, Mat *); 883 PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat *); 884 885 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm, Mat, PetscInt, PetscInt, MatReuse, Mat *); 886 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm, Mat, PetscInt, PetscInt, Mat *); 887 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat, Mat); 888 PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat, MatReuse, Mat *); 889 PETSC_EXTERN PetscErrorCode MatAIJGetLocalMat(Mat, Mat *); 890 PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat, MatReuse, IS *, IS *, Mat *); 891 PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatMerge(Mat, MatReuse, IS *, Mat *); 892 PETSC_EXTERN PetscErrorCode MatMPIAIJGetNumberNonzeros(Mat, PetscCount *); 893 PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat, Mat, MatReuse, IS *, IS *, Mat *); 894 PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *, const PetscInt *[]); 895 896 PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat, PetscInt, IS[], PetscInt); 897 PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat, PetscInt n, IS is[], PetscInt ov); 898 PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat, PetscBool); 899 900 PETSC_EXTERN PetscErrorCode MatMatMult(Mat, Mat, MatReuse, PetscReal, Mat *); 901 902 PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat, Mat, Mat, MatReuse, PetscReal, Mat *); 903 PETSC_EXTERN PetscErrorCode MatGalerkin(Mat, Mat, Mat, MatReuse, PetscReal, Mat *); 904 905 PETSC_EXTERN PetscErrorCode MatPtAP(Mat, Mat, MatReuse, PetscReal, Mat *); 906 PETSC_EXTERN PetscErrorCode MatRARt(Mat, Mat, MatReuse, PetscReal, Mat *); 907 908 PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat, Mat, MatReuse, PetscReal, Mat *); 909 PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat, Mat, MatReuse, PetscReal, Mat *); 910 911 PETSC_EXTERN PetscErrorCode MatAXPY(Mat, PetscScalar, Mat, MatStructure); 912 PETSC_EXTERN PetscErrorCode MatAYPX(Mat, PetscScalar, Mat, MatStructure); 913 914 PETSC_EXTERN PetscErrorCode MatScale(Mat, PetscScalar); 915 PETSC_EXTERN PetscErrorCode MatShift(Mat, PetscScalar); 916 917 PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat, ISLocalToGlobalMapping, ISLocalToGlobalMapping); 918 PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat, ISLocalToGlobalMapping *, ISLocalToGlobalMapping *); 919 PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat, PetscLayout *, PetscLayout *); 920 PETSC_EXTERN PetscErrorCode MatSetLayouts(Mat, PetscLayout, PetscLayout); 921 PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec); 922 PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat, IS, PetscScalar, Vec, Vec); 923 PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat, PetscInt, const PetscInt[], PetscScalar, Vec, Vec); 924 PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat, IS, PetscScalar, Vec, Vec); 925 PETSC_EXTERN PetscErrorCode MatGetValuesLocal(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], PetscScalar[]); 926 PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode); 927 PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode); 928 929 PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat, PetscInt, PetscInt); 930 PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat, PetscInt *, PetscInt *, PetscInt *, PetscInt *); 931 932 PETSC_EXTERN PetscErrorCode MatInterpolate(Mat, Vec, Vec); 933 PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat, Vec, Vec, Vec); 934 PETSC_EXTERN PetscErrorCode MatRestrict(Mat, Vec, Vec); 935 PETSC_EXTERN PetscErrorCode MatMatInterpolate(Mat, Mat, Mat *); 936 PETSC_EXTERN PetscErrorCode MatMatInterpolateAdd(Mat, Mat, Mat, Mat *); 937 PETSC_EXTERN PetscErrorCode MatMatRestrict(Mat, Mat, Mat *); 938 PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat, Vec *, Vec *); 939 PETSC_DEPRECATED_FUNCTION(3, 6, 0, "MatCreateVecs()", ) static inline PetscErrorCode MatGetVecs(Mat mat, Vec *x, Vec *y) 940 { 941 return MatCreateVecs(mat, x, y); 942 } 943 PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat, PetscInt, MPI_Comm, MatReuse, Mat *); 944 PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat, MPI_Comm, MatReuse, Mat *); 945 PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat, IS *); 946 PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat, IS *); 947 PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm, Mat, PetscInt, MatReuse, Mat *); 948 949 /*@C 950 MatSetValue - Set a single entry into a matrix. 951 952 Not Collective 953 954 Input Parameters: 955 + mat - the matrix 956 . i - the row location of the entry 957 . j - the column location of the entry 958 . va - the value to insert 959 - mode - either `INSERT_VALUES` or `ADD_VALUES` 960 961 Level: beginner 962 963 Notes: 964 This value may be cached, so `MatAssemblyBegin()` and `MatAssemblyEnd()` 965 MUST be called after all calls to `MatSetValue()` have been completed. 966 967 For efficiency one should use `MatSetValues()` and set several values simultaneously. 968 969 .seealso: [](ch_matrices), `Mat`, `MatAssemblyBegin()`, `MatAssemblyEnd()`, `InsertMode`, `MatGetValue()`, `MatSetValues()`, 970 `MatSetValueLocal()`, `MatSetValuesLocal()` 971 @*/ 972 static inline PetscErrorCode MatSetValue(Mat mat, PetscInt i, PetscInt j, PetscScalar va, InsertMode mode) 973 { 974 return MatSetValues(mat, 1, &i, 1, &j, &va, mode); 975 } 976 977 /*@C 978 MatGetValue - Gets a single value from a matrix 979 980 Not Collective; can only return a value owned by the given process 981 982 Input Parameters: 983 + mat - the matrix 984 . row - the row location of the entry 985 - col - the column location of the entry 986 987 Output Parameter: 988 . va - the value 989 990 Level: advanced 991 992 Notes: 993 The matrix must have been assembled with `MatAssemblyBegin()` and `MatAssemblyEnd()` before this call 994 995 For efficiency one should use `MatGetValues()` and get several values simultaneously. 996 997 See notes for `MatGetValues()`. 998 999 .seealso: [](ch_matrices), `Mat`, `MatAssemblyBegin()`, `MatAssemblyEnd()`, `MatSetValue()`, `MatGetValueLocal()`, `MatGetValues()` 1000 @*/ 1001 static inline PetscErrorCode MatGetValue(Mat mat, PetscInt row, PetscInt col, PetscScalar *va) 1002 { 1003 return MatGetValues(mat, 1, &row, 1, &col, va); 1004 } 1005 1006 /*@C 1007 MatSetValueLocal - Inserts or adds a single value into a matrix, using a local numbering of the nodes. 1008 1009 Not Collective 1010 1011 Input Parameters: 1012 + mat - the matrix 1013 . i - the row location of the entry 1014 . j - the column location of the entry 1015 . va - the value to insert 1016 - mode - either `INSERT_VALUES` or `ADD_VALUES` 1017 1018 Level: intermediate 1019 1020 Notes: 1021 For efficiency one should use `MatSetValuesLocal()` and set several values simultaneously. 1022 1023 See notes for `MatSetValuesLocal()` for additional information on when and how this function can be used. 1024 1025 .seealso: [](ch_matrices), `MatSetValue()`, `MatSetValuesLocal()` 1026 @*/ 1027 static inline PetscErrorCode MatSetValueLocal(Mat mat, PetscInt i, PetscInt j, PetscScalar va, InsertMode mode) 1028 { 1029 return MatSetValuesLocal(mat, 1, &i, 1, &j, &va, mode); 1030 } 1031 1032 /*MC 1033 MatPreallocateBegin - Begins the block of code that will count the number of nonzeros per 1034 row in a matrix providing the data that one can use to correctly preallocate the matrix. 1035 1036 Synopsis: 1037 #include <petscmat.h> 1038 PetscErrorCode MatPreallocateBegin(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 1039 1040 Collective 1041 1042 Input Parameters: 1043 + comm - the communicator that will share the eventually allocated matrix 1044 . nrows - the number of LOCAL rows in the matrix 1045 - ncols - the number of LOCAL columns in the matrix 1046 1047 Output Parameters: 1048 + dnz - the array that will be passed to the matrix preallocation routines 1049 - onz - the other array passed to the matrix preallocation routines 1050 1051 Level: deprecated (since v3.19) 1052 1053 Notes: 1054 This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than 1055 the use of this routine 1056 1057 This is a macro that handles its own error checking, it does not return an error code. 1058 1059 Do not malloc or free `dnz` and `onz`, that is handled internally by these routines 1060 1061 Developer Note: 1062 This is a MACRO, not a function, because it has a leading { that is closed by `PetscPreallocateFinalize()`. 1063 1064 .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`, 1065 `MatPreallocateSymmetricSetLocalBlock()` 1066 M*/ 1067 #define MatPreallocateBegin(comm, nrows, ncols, dnz, onz) \ 1068 do { \ 1069 PetscInt __nrows = (nrows), __ncols = (ncols), __rstart, __end = 0; \ 1070 PetscInt PETSC_UNUSED __start; \ 1071 PetscCall(PetscCalloc2(__nrows, &(dnz), __nrows, &(onz))); \ 1072 PetscCallMPI(MPI_Scan(&__ncols, &__end, 1, MPIU_INT, MPI_SUM, comm)); \ 1073 __start = __end - __ncols; \ 1074 (void)__start; \ 1075 PetscCallMPI(MPI_Scan(&__nrows, &__rstart, 1, MPIU_INT, MPI_SUM, comm)); \ 1076 __rstart -= __nrows 1077 1078 #define MatPreallocateInitialize(...) PETSC_DEPRECATED_MACRO(3, 18, 0, "MatPreallocateBegin()", ) MatPreallocateBegin(__VA_ARGS__) 1079 1080 /*MC 1081 MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1082 inserted using a local number of the rows and columns 1083 1084 Synopsis: 1085 #include <petscmat.h> 1086 PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1087 1088 Not Collective 1089 1090 Input Parameters: 1091 + map - the row mapping from local numbering to global numbering 1092 . nrows - the number of rows indicated 1093 . rows - the indices of the rows 1094 . cmap - the column mapping from local to global numbering 1095 . ncols - the number of columns in the matrix 1096 . cols - the columns indicated 1097 . dnz - the array that will be passed to the matrix preallocation routines 1098 - onz - the other array passed to the matrix preallocation routines 1099 1100 Level: deprecated (since v3.19) 1101 1102 Notes: 1103 This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than 1104 the use of this routine 1105 1106 Do not malloc or free `dnz` and `onz`, that is handled internally by these routines 1107 1108 .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()` 1109 `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocalRemoveDups()` 1110 M*/ 1111 #define MatPreallocateSetLocal(rmap, nrows, rows, cmap, ncols, cols, dnz, onz) \ 1112 PetscMacroReturnStandard(PetscCall(ISLocalToGlobalMappingApply(rmap, nrows, rows, rows)); PetscCall(ISLocalToGlobalMappingApply(cmap, ncols, cols, cols)); for (PetscInt __l = 0; __l < nrows; __l++) PetscCall(MatPreallocateSet((rows)[__l], ncols, cols, dnz, onz));) 1113 1114 /*MC 1115 MatPreallocateSetLocalRemoveDups - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1116 inserted using a local number of the rows and columns. This version removes any duplicate columns in cols 1117 1118 Synopsis: 1119 #include <petscmat.h> 1120 PetscErrorCode MatPreallocateSetLocalRemoveDups(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1121 1122 Not Collective 1123 1124 Input Parameters: 1125 + map - the row mapping from local numbering to global numbering 1126 . nrows - the number of rows indicated 1127 . rows - the indices of the rows (these values are mapped to the global values) 1128 . cmap - the column mapping from local to global numbering 1129 . ncols - the number of columns in the matrix (this value will be changed if duplicate columns are found) 1130 . cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed) 1131 . dnz - the array that will be passed to the matrix preallocation routines 1132 - onz - the other array passed to the matrix preallocation routines 1133 1134 Level: deprecated (since v3.19) 1135 1136 Notes: 1137 This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than 1138 the use of this routine 1139 1140 Do not malloc or free `dnz` and `onz`, that is handled internally by these routines 1141 1142 .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()` 1143 `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocal()` 1144 M*/ 1145 #define MatPreallocateSetLocalRemoveDups(rmap, nrows, rows, cmap, ncols, cols, dnz, onz) \ 1146 PetscMacroReturnStandard(PetscCall(ISLocalToGlobalMappingApply(rmap, nrows, rows, rows)); PetscCall(ISLocalToGlobalMappingApply(cmap, ncols, cols, cols)); PetscCall(PetscSortRemoveDupsInt(&ncols, cols)); for (PetscInt __l = 0; __l < nrows; __l++) PetscCall(MatPreallocateSet((rows)[__l], ncols, cols, dnz, onz));) 1147 1148 /*MC 1149 MatPreallocateSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1150 inserted using a local number of the rows and columns 1151 1152 Synopsis: 1153 #include <petscmat.h> 1154 PetscErrorCode MatPreallocateSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1155 1156 Not Collective 1157 1158 Input Parameters: 1159 + map - the row mapping from local numbering to global numbering 1160 . nrows - the number of rows indicated 1161 . rows - the indices of the rows 1162 . cmap - the column mapping from local to global numbering 1163 . ncols - the number of columns in the matrix 1164 . cols - the columns indicated 1165 . dnz - the array that will be passed to the matrix preallocation routines 1166 - onz - the other array passed to the matrix preallocation routines 1167 1168 Level: deprecated (since v3.19) 1169 1170 Notes: 1171 This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than 1172 the use of this routine 1173 1174 Do not malloc or free `dnz` and `onz`, that is handled internally by these routines 1175 1176 .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()` 1177 `MatPreallocateBegin()`, `MatPreallocateSymmetricSetLocalBlock()` 1178 M*/ 1179 #define MatPreallocateSetLocalBlock(rmap, nrows, rows, cmap, ncols, cols, dnz, onz) \ 1180 PetscMacroReturnStandard(PetscCall(ISLocalToGlobalMappingApplyBlock(rmap, nrows, rows, rows)); PetscCall(ISLocalToGlobalMappingApplyBlock(cmap, ncols, cols, cols)); for (PetscInt __l = 0; __l < nrows; __l++) PetscCall(MatPreallocateSet((rows)[__l], ncols, cols, dnz, onz));) 1181 1182 /*MC 1183 MatPreallocateSymmetricSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1184 inserted using a local number of the rows and columns 1185 1186 Synopsis: 1187 #include <petscmat.h> 1188 PetscErrorCode MatPreallocateSymmetricSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1189 1190 Not Collective 1191 1192 Input Parameters: 1193 + map - the mapping between local numbering and global numbering 1194 . nrows - the number of rows indicated 1195 . rows - the indices of the rows 1196 . ncols - the number of columns in the matrix 1197 . cols - the columns indicated 1198 . dnz - the array that will be passed to the matrix preallocation routines 1199 - onz - the other array passed to the matrix preallocation routines 1200 1201 Level: deprecated (since v3.19) 1202 1203 Notes: 1204 This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than 1205 the use of this routine 1206 1207 Do not malloc or free `dnz` and `onz` that is handled internally by these routines 1208 1209 .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()` 1210 `MatPreallocateBegin()`, `MatPreallocateSetLocal()` 1211 M*/ 1212 #define MatPreallocateSymmetricSetLocalBlock(map, nrows, rows, ncols, cols, dnz, onz) \ 1213 PetscMacroReturnStandard(PetscCall(ISLocalToGlobalMappingApplyBlock(map, nrows, rows, rows)); PetscCall(ISLocalToGlobalMappingApplyBlock(map, ncols, cols, cols)); for (PetscInt __l = 0; __l < nrows; __l++) PetscCall(MatPreallocateSymmetricSetBlock((rows)[__l], ncols, cols, dnz, onz));) 1214 1215 /*MC 1216 MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1217 inserted using a local number of the rows and columns 1218 1219 Synopsis: 1220 #include <petscmat.h> 1221 PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1222 1223 Not Collective 1224 1225 Input Parameters: 1226 + row - the row 1227 . ncols - the number of columns in the matrix 1228 - cols - the columns indicated 1229 1230 Output Parameters: 1231 + dnz - the array that will be passed to the matrix preallocation routines 1232 - onz - the other array passed to the matrix preallocation routines 1233 1234 Level: deprecated (since v3.19) 1235 1236 Notes: 1237 This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than 1238 the use of this routine 1239 1240 Do not malloc or free `dnz` and `onz` that is handled internally by these routines 1241 1242 This is a MACRO, not a function, because it uses variables declared in MatPreallocateBegin(). 1243 1244 .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()` 1245 `MatPreallocateBegin()`, `MatPreallocateSetLocal()` 1246 M*/ 1247 #define MatPreallocateSet(row, nc, cols, dnz, onz) \ 1248 PetscMacroReturnStandard(PetscCheck(row >= __rstart, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Trying to set preallocation for row %" PetscInt_FMT " less than first local row %" PetscInt_FMT, row, __rstart); PetscCheck(row < __rstart + __nrows, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Trying to set preallocation for row %" PetscInt_FMT " greater than last local row %" PetscInt_FMT, row, __rstart + __nrows - 1); for (PetscInt __i = 0; __i < nc; ++__i) { \ 1249 if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \ 1250 else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \ 1251 }) 1252 1253 /*MC 1254 MatPreallocateSymmetricSetBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 1255 inserted using a local number of the rows and columns 1256 1257 Synopsis: 1258 #include <petscmat.h> 1259 PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 1260 1261 Not Collective 1262 1263 Input Parameters: 1264 + nrows - the number of rows indicated 1265 . rows - the indices of the rows 1266 . ncols - the number of columns in the matrix 1267 . cols - the columns indicated 1268 . dnz - the array that will be passed to the matrix preallocation routines 1269 - onz - the other array passed to the matrix preallocation routines 1270 1271 Level: deprecated (since v3.19) 1272 1273 Notes: 1274 This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than 1275 the use of this routine 1276 1277 Do not malloc or free `dnz` and `onz` that is handled internally by these routines 1278 1279 This is a MACRO, not a function, because it uses variables declared in MatPreallocateBegin(). 1280 1281 .seealso: [](ch_matrices), `MatPreallocateEnd()`, `MatPreallocateSet()`, `MatPreallocateBegin()`, 1282 `MatPreallocateSymmetricSetLocalBlock()`, `MatPreallocateSetLocal()` 1283 M*/ 1284 #define MatPreallocateSymmetricSetBlock(row, nc, cols, dnz, onz) \ 1285 PetscMacroReturnStandard(for (PetscInt __i = 0; __i < nc; __i++) { \ 1286 if (cols[__i] >= __end) onz[row - __rstart]++; \ 1287 else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++; \ 1288 }) 1289 1290 /*MC 1291 MatPreallocateLocation - An alternative to MatPreallocateSet() that puts the nonzero locations into the matrix if it exists 1292 1293 Synopsis: 1294 #include <petscmat.h> 1295 PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz) 1296 1297 Not Collective 1298 1299 Input Parameters: 1300 + A - matrix 1301 . row - row where values exist (must be local to this process) 1302 . ncols - number of columns 1303 . cols - columns with nonzeros 1304 . dnz - the array that will be passed to the matrix preallocation routines 1305 - onz - the other array passed to the matrix preallocation routines 1306 1307 Level: deprecated (since v3.19) 1308 1309 Notes: 1310 This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than 1311 the use of this routine 1312 1313 Do not malloc or free `dnz` and `onz` that is handled internally by these routines 1314 1315 Developer Note: 1316 This is a MACRO, not a function, because it uses a bunch of variables private to the MatPreallocation.... routines. 1317 1318 .seealso: [](ch_matrices), `MatPreallocateBegin()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`, 1319 `MatPreallocateSymmetricSetLocalBlock()` 1320 M*/ 1321 #define MatPreallocateLocation(A, row, ncols, cols, dnz, onz) (A ? MatSetValues(A, 1, &row, ncols, cols, NULL, INSERT_VALUES) : MatPreallocateSet(row, ncols, cols, dnz, onz)) 1322 1323 /*MC 1324 MatPreallocateEnd - Ends the block of code that will count the number of nonzeros per 1325 row in a matrix providing the data that one can use to correctly preallocate the matrix. 1326 1327 Synopsis: 1328 #include <petscmat.h> 1329 PetscErrorCode MatPreallocateEnd(PetscInt *dnz, PetscInt *onz) 1330 1331 Collective 1332 1333 Input Parameters: 1334 + dnz - the array that was be passed to the matrix preallocation routines 1335 - onz - the other array passed to the matrix preallocation routines 1336 1337 Level: deprecated (since v3.19) 1338 1339 Notes: 1340 This routine is no longer needed since assembling matrices without explicit preallocation will not be slower than 1341 the use of this routine 1342 1343 Do not malloc or free `dnz` and `onz`, that is handled internally by these routines 1344 1345 Developer Note: 1346 This is a MACRO, not a function, because it closes the { started in MatPreallocateBegin(). 1347 1348 .seealso: [](ch_matrices), `MatPreallocateBegin()`, `MatPreallocateSet()`, `MatPreallocateSymmetricSetBlock()`, `MatPreallocateSetLocal()`, 1349 `MatPreallocateSymmetricSetLocalBlock()` 1350 M*/ 1351 #define MatPreallocateEnd(dnz, onz) \ 1352 PetscCall(PetscFree2(dnz, onz)); \ 1353 } \ 1354 while (0) 1355 1356 #define MatPreallocateFinalize(...) PETSC_DEPRECATED_MACRO(3, 18, 0, "MatPreallocateEnd()", ) MatPreallocateEnd(__VA_ARGS__) 1357 1358 /* Routines unique to particular data structures */ 1359 PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat, void *); 1360 1361 PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat, IS *, IS *); 1362 PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat, PetscInt *, PetscInt *[], PetscInt *); 1363 1364 PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat, PetscInt[]); 1365 PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat, PetscInt[]); 1366 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *); 1367 PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *); 1368 PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *); 1369 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], Mat *, PetscInt, PetscBool); 1370 1371 #define MAT_SKIP_ALLOCATION -4 1372 1373 PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[]); 1374 PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[]); 1375 PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat, PetscInt, const PetscInt[]); 1376 PETSC_EXTERN PetscErrorCode MatSeqAIJSetTotalPreallocation(Mat, PetscInt); 1377 1378 PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[]); 1379 PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[]); 1380 PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]); 1381 PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat, const PetscInt[], const PetscInt[], const PetscScalar[]); 1382 PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]); 1383 PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat, const PetscInt[], const PetscInt[], const PetscScalar[]); 1384 PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[]); 1385 PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat, PetscInt[], PetscInt[], PetscInt[]); 1386 PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat, Mat *); 1387 PETSC_EXTERN PetscErrorCode MatMPIAdjToSeqRankZero(Mat, Mat *); 1388 PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat, PetscScalar[]); 1389 PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat, PetscScalar[]); 1390 PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat, Mat *, Mat *, const PetscInt *[]); 1391 PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat, Mat *, Mat *, const PetscInt *[]); 1392 PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat, Mat *); 1393 1394 PETSC_EXTERN PetscErrorCode MatDenseGetLDA(Mat, PetscInt *); 1395 PETSC_EXTERN PetscErrorCode MatDenseSetLDA(Mat, PetscInt); 1396 PETSC_DEPRECATED_FUNCTION(3, 14, 0, "MatDenseSetLDA()", ) static inline PetscErrorCode MatSeqDenseSetLDA(Mat A, PetscInt lda) 1397 { 1398 return MatDenseSetLDA(A, lda); 1399 } 1400 PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat, Mat *); 1401 1402 PETSC_EXTERN PetscErrorCode MatBlockMatSetPreallocation(Mat, PetscInt, PetscInt, const PetscInt[]); 1403 1404 PETSC_EXTERN PetscErrorCode MatStoreValues(Mat); 1405 PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat); 1406 1407 PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat, IS *); 1408 PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat, IS *); 1409 /* 1410 These routines are not usually accessed directly, rather solving is 1411 done through the KSP and PC interfaces. 1412 */ 1413 1414 /*J 1415 MatOrderingType - String with the name of a PETSc matrix ordering. These orderings are most commonly used 1416 to reduce fill in sparse factorizations. 1417 1418 Level: beginner 1419 1420 Notes: 1421 If `MATORDERINGEXTERNAL` is used then PETSc does not compute an ordering and instead the external factorization solver package called utilizes one 1422 of its own. 1423 1424 There is no `MatOrdering` object, the ordering is obtained directly from the matrix with `MatGetOrdering()` 1425 1426 Developer Note: 1427 This API should be converted to an API similar to those for `MatColoring` and `MatPartitioning` 1428 1429 .seealso: [](ch_matrices), [](sec_graph), `MatGetFactor()`, `MatGetOrdering()`, `MatColoringType`, `MatPartitioningType`, `MatCoarsenType`, `MatCoarsenType`, 1430 `PCFactorSetOrderingType()` 1431 J*/ 1432 typedef const char *MatOrderingType; 1433 #define MATORDERINGNATURAL "natural" 1434 #define MATORDERINGND "nd" 1435 #define MATORDERING1WD "1wd" 1436 #define MATORDERINGRCM "rcm" 1437 #define MATORDERINGQMD "qmd" 1438 #define MATORDERINGROWLENGTH "rowlength" 1439 #define MATORDERINGWBM "wbm" 1440 #define MATORDERINGSPECTRAL "spectral" 1441 #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */ 1442 #define MATORDERINGMETISND "metisnd" /* only works if METIS is installed with PETSc */ 1443 #define MATORDERINGNATURAL_OR_ND "natural_or_nd" /* special coase used for Cholesky and ICC, allows ND when AIJ matrix is used but Natural when SBAIJ is used */ 1444 #define MATORDERINGEXTERNAL "external" /* uses an ordering type internal to the factorization package */ 1445 1446 PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat, MatOrderingType, IS *, IS *); 1447 PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList *); 1448 PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[], PetscErrorCode (*)(Mat, MatOrderingType, IS *, IS *)); 1449 PETSC_EXTERN PetscFunctionList MatOrderingList; 1450 1451 #include "petscmatcoarsen.h" 1452 1453 PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat, PetscReal, IS, IS); 1454 PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat, PetscReal, PetscBool, Mat *); 1455 1456 PETSC_EXTERN PetscErrorCode MatFactorGetPreferredOrdering(Mat, MatFactorType, MatOrderingType *); 1457 1458 /*S 1459 MatFactorShiftType - Type of numeric shift used for factorizations 1460 1461 Values: 1462 + `MAT_SHIFT_NONE` - do not shift the matrix diagonal entries 1463 . `MAT_SHIFT_NONZERO` - shift the entries to be non-zero 1464 . `MAT_SHIFT_POSITIVE_DEFINITE` - shift the entries to force the factorization to be positive definite 1465 - `MAT_SHIFT_INBLOCKS` - only shift the factors inside the small dense diagonal blocks of the matrix, for example with `MATBAIJ` 1466 1467 Level: intermediate 1468 1469 .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `PCFactorSetShiftType()` 1470 S*/ 1471 typedef enum { 1472 MAT_SHIFT_NONE, 1473 MAT_SHIFT_NONZERO, 1474 MAT_SHIFT_POSITIVE_DEFINITE, 1475 MAT_SHIFT_INBLOCKS 1476 } MatFactorShiftType; 1477 PETSC_EXTERN const char *const MatFactorShiftTypes[]; 1478 PETSC_EXTERN const char *const MatFactorShiftTypesDetail[]; 1479 1480 /*S 1481 MatFactorError - indicates what type of error was generated in a matrix factorization 1482 1483 Values: 1484 + `MAT_FACTOR_NOERROR` - there was no error during the factorization 1485 . `MAT_FACTOR_STRUCT_ZEROPIVOT` - there was a missing entry in a diagonal location of the matrix 1486 . `MAT_FACTOR_NUMERIC_ZEROPIVOT` - there was a (near) zero pivot during the factorization 1487 . `MAT_FACTOR_OUTMEMORY` - the factorization has run out of memory 1488 - `MAT_FACTOR_OTHER` - some other error has occurred. 1489 1490 Level: intermediate 1491 1492 Note: 1493 When a factorization is done in a preconditioner `PC` the error may be propagated up to a `PCFailedReason` or a `KSPConvergedReason` 1494 1495 .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatFactorGetError()`, `MatFactorGetErrorZeroPivot()`, `MatFactorClearError()`, 1496 `PCFailedReason`, `PCGetFailedReason()`, `KSPConvergedReason` 1497 S*/ 1498 typedef enum { 1499 MAT_FACTOR_NOERROR, 1500 MAT_FACTOR_STRUCT_ZEROPIVOT, 1501 MAT_FACTOR_NUMERIC_ZEROPIVOT, 1502 MAT_FACTOR_OUTMEMORY, 1503 MAT_FACTOR_OTHER 1504 } MatFactorError; 1505 1506 PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat, MatFactorError *); 1507 PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat); 1508 PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat, PetscReal *, PetscInt *); 1509 1510 /*S 1511 MatFactorInfo - Data passed into the matrix factorization routines, and information about the resulting factorization 1512 1513 Level: developer 1514 1515 Note: 1516 You can use `MatFactorInfoInitialize()` to set default values. 1517 1518 Fortran Note: 1519 The data is available in a double precision arrays of size `MAT_FACTORINFO_SIZE` 1520 1521 .seealso: [](ch_matrices), `Mat`, `MatInfo`, `MatGetFactor()`, `MatLUFactorSymbolic()`, `MatILUFactorSymbolic()`, `MatCholeskyFactorSymbolic()`, 1522 `MatICCFactorSymbolic()`, `MatICCFactor()`, `MatFactorInfoInitialize()` 1523 S*/ 1524 typedef struct { 1525 PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 1526 PetscReal usedt; 1527 PetscReal dt; /* drop tolerance */ 1528 PetscReal dtcol; /* tolerance for pivoting */ 1529 PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 1530 PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */ 1531 PetscReal levels; /* ICC/ILU(levels) */ 1532 PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 1533 factorization may be faster if do not pivot */ 1534 PetscReal zeropivot; /* pivot is called zero if less than this */ 1535 PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */ 1536 PetscReal shiftamount; /* how large the shift is */ 1537 } MatFactorInfo; 1538 1539 PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo *); 1540 PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat, IS, const MatFactorInfo *); 1541 PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat, Mat, IS, const MatFactorInfo *); 1542 PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat, Mat, const MatFactorInfo *); 1543 PETSC_EXTERN PetscErrorCode MatLUFactor(Mat, IS, IS, const MatFactorInfo *); 1544 PETSC_EXTERN PetscErrorCode MatILUFactor(Mat, IS, IS, const MatFactorInfo *); 1545 PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat, Mat, IS, IS, const MatFactorInfo *); 1546 PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat, Mat, IS, IS, const MatFactorInfo *); 1547 PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat, Mat, IS, const MatFactorInfo *); 1548 PETSC_EXTERN PetscErrorCode MatICCFactor(Mat, IS, const MatFactorInfo *); 1549 PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat, Mat, const MatFactorInfo *); 1550 PETSC_EXTERN PetscErrorCode MatQRFactor(Mat, IS, const MatFactorInfo *); 1551 PETSC_EXTERN PetscErrorCode MatQRFactorSymbolic(Mat, Mat, IS, const MatFactorInfo *); 1552 PETSC_EXTERN PetscErrorCode MatQRFactorNumeric(Mat, Mat, const MatFactorInfo *); 1553 PETSC_EXTERN PetscErrorCode MatGetInertia(Mat, PetscInt *, PetscInt *, PetscInt *); 1554 PETSC_EXTERN PetscErrorCode MatSolve(Mat, Vec, Vec); 1555 PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat, Vec, Vec); 1556 PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat, Vec, Vec); 1557 PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat, Vec, Vec, Vec); 1558 PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat, Vec, Vec); 1559 PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat, Vec, Vec, Vec); 1560 PETSC_EXTERN PetscErrorCode MatSolves(Mat, Vecs, Vecs); 1561 PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat); 1562 1563 typedef enum { 1564 MAT_FACTOR_SCHUR_UNFACTORED, 1565 MAT_FACTOR_SCHUR_FACTORED, 1566 MAT_FACTOR_SCHUR_INVERTED 1567 } MatFactorSchurStatus; 1568 PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat, IS); 1569 PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat, Mat *, MatFactorSchurStatus *); 1570 PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat, Mat *, MatFactorSchurStatus); 1571 PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat); 1572 PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat, Mat *, MatFactorSchurStatus *); 1573 PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat, Vec, Vec); 1574 PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat, Vec, Vec); 1575 PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat); 1576 1577 PETSC_EXTERN PetscErrorCode MatSeqDenseInvert(Mat); 1578 /*E 1579 MatSORType - What type of (S)SOR to perform 1580 1581 Values: 1582 + `SOR_FORWARD_SWEEP` - do a sweep from the first row of the matrix to the last 1583 . `SOR_BACKWARD_SWEEP` - do a sweep from the last row to the first 1584 . `SOR_SYMMETRIC_SWEEP` - do a sweep from the first row to the last and then back to the first 1585 . `SOR_LOCAL_FORWARD_SWEEP` - each MPI process does its own forward sweep with no communication 1586 . `SOR_LOCAL_BACKWARD_SWEEP` - each MPI process does its own backward sweep with no communication 1587 . `SOR_LOCAL_SYMMETRIC_SWEEP` - each MPI process does its own symmetric sweep with no communication 1588 . `SOR_ZERO_INITIAL_GUESS` - indicates the initial solution is zero so the sweep can avoid unneeded computation 1589 . `SOR_EISENSTAT` - apply the Eisentat application of SOR, see `PCEISENSTAT` 1590 . `SOR_APPLY_UPPER` - multiply by the upper triangular portion of the matrix 1591 - `SOR_APPLY_LOWER` - multiply by the lower triangular portion of the matrix 1592 1593 Level: beginner 1594 1595 Note: 1596 These may be bitwise ORd together 1597 1598 Developer Note: 1599 Since `MatSORType` may be bitwise ORd together, so do not change the numerical values below 1600 1601 .seealso: [](ch_matrices), `MatSOR()` 1602 E*/ 1603 typedef enum { 1604 SOR_FORWARD_SWEEP = 1, 1605 SOR_BACKWARD_SWEEP = 2, 1606 SOR_SYMMETRIC_SWEEP = 3, 1607 SOR_LOCAL_FORWARD_SWEEP = 4, 1608 SOR_LOCAL_BACKWARD_SWEEP = 8, 1609 SOR_LOCAL_SYMMETRIC_SWEEP = 12, 1610 SOR_ZERO_INITIAL_GUESS = 16, 1611 SOR_EISENSTAT = 32, 1612 SOR_APPLY_UPPER = 64, 1613 SOR_APPLY_LOWER = 128 1614 } MatSORType; 1615 PETSC_EXTERN PetscErrorCode MatSOR(Mat, Vec, PetscReal, MatSORType, PetscReal, PetscInt, PetscInt, Vec); 1616 1617 /*S 1618 MatColoring - Object for managing the coloring of matrices. 1619 1620 Level: beginner 1621 1622 Notes: 1623 Coloring of matrices can be computed directly from the sparse matrix nonzero structure via the `MatColoring` object or from the mesh from which the 1624 matrix comes from via `DMCreateColoring()`. In general using the mesh produces a more optimal coloring (fewer colors). 1625 1626 Once a coloring is available `MatFDColoringCreate()` creates an object that can be used to efficiently compute Jacobians using that coloring. This 1627 same object can also be used to efficiently convert data created by Automatic Differentiation tools to PETSc sparse matrices. 1628 1629 .seealso: [](ch_matrices), [](sec_graph), `MatFDColoringCreate()`, `MatColoringWeightType`, `ISColoring`, `MatFDColoring`, `DMCreateColoring()`, `MatColoringCreate()`, 1630 `MatPartitioning`, `MatColoringType`, `MatPartitioningType`, `MatOrderingType`, `MatColoringSetWeightType()`, 1631 `MatColoringSetWeights()`, `MatCoarsenType`, `MatCoarsen` 1632 S*/ 1633 typedef struct _p_MatColoring *MatColoring; 1634 1635 /*J 1636 MatColoringType - String with the name of a PETSc matrix coloring 1637 1638 Level: beginner 1639 1640 .seealso: [](ch_matrices), [](sec_graph), `Mat`, `MatFDColoringCreate()`, `MatColoringSetType()`, `MatColoring` 1641 J*/ 1642 typedef const char *MatColoringType; 1643 #define MATCOLORINGJP "jp" 1644 #define MATCOLORINGPOWER "power" 1645 #define MATCOLORINGNATURAL "natural" 1646 #define MATCOLORINGSL "sl" 1647 #define MATCOLORINGLF "lf" 1648 #define MATCOLORINGID "id" 1649 #define MATCOLORINGGREEDY "greedy" 1650 1651 /*E 1652 MatColoringWeightType - Type of weight scheme used for the coloring algorithm 1653 1654 Values: 1655 + `MAT_COLORING_RANDOM` - Random weights 1656 . `MAT_COLORING_LEXICAL` - Lexical weighting based upon global numbering. 1657 - `MAT_COLORING_LF` - Last-first weighting. 1658 1659 Level: intermediate 1660 1661 .seealso: [](ch_matrices), `MatColoring`, `MatColoringCreate()`, `MatColoringSetWeightType()`, `MatColoringSetWeights()` 1662 E*/ 1663 typedef enum { 1664 MAT_COLORING_WEIGHT_RANDOM, 1665 MAT_COLORING_WEIGHT_LEXICAL, 1666 MAT_COLORING_WEIGHT_LF, 1667 MAT_COLORING_WEIGHT_SL 1668 } MatColoringWeightType; 1669 1670 PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat, MatColoring *); 1671 PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat, PetscInt, PetscInt *); 1672 PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring *); 1673 PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring, PetscViewer); 1674 PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring, MatColoringType); 1675 PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring); 1676 PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring, PetscInt); 1677 PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring, PetscInt *); 1678 PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring, PetscInt); 1679 PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring, PetscInt *); 1680 PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring, ISColoring *); 1681 PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[], PetscErrorCode (*)(MatColoring)); 1682 PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat, PetscInt, PetscInt, ISColoringValue[], ISColoring *); 1683 PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring, MatColoringWeightType); 1684 PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring, PetscReal *, PetscInt *); 1685 PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring, PetscReal **, PetscInt **lperm); 1686 PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring, ISColoring); 1687 PETSC_DEPRECATED_FUNCTION(3, 10, 0, "MatColoringTest()", ) static inline PetscErrorCode MatColoringTestValid(MatColoring matcoloring, ISColoring iscoloring) 1688 { 1689 return MatColoringTest(matcoloring, iscoloring); 1690 } 1691 PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat, ISColoring); 1692 1693 /*S 1694 MatFDColoring - Object for computing a sparse Jacobian via finite differences with coloring 1695 1696 Level: beginner 1697 1698 Notes: 1699 This object is creating utilizing a coloring provided by the `MatColoring` object or `DMCreateColoring()` 1700 1701 The `SNES` option `-snes_fd_coloring` will cause the Jacobian needed by `SNES` to be computed via a use of this object 1702 1703 .seealso: [](ch_matrices), `Mat`, `MatFDColoringCreate()`, `MatFDColoringSetFunction()`, `MatColoring`, `DMCreateColoring()` 1704 S*/ 1705 typedef struct _p_MatFDColoring *MatFDColoring; 1706 1707 PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat, ISColoring, MatFDColoring *); 1708 PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring *); 1709 PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring, PetscViewer); 1710 PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring, PetscErrorCode (*)(void), void *); 1711 PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring, PetscErrorCode (**)(void), void **); 1712 PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring, PetscReal, PetscReal); 1713 PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring); 1714 PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat, MatFDColoring, Vec, void *); 1715 PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring, Vec); 1716 PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring, PetscInt *, const PetscInt *[]); 1717 PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat, ISColoring, MatFDColoring); 1718 PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring, PetscInt, PetscInt); 1719 PETSC_EXTERN PetscErrorCode MatFDColoringSetValues(Mat, MatFDColoring, const PetscScalar *); 1720 1721 /*S 1722 MatTransposeColoring - Object for computing a sparse matrix product $C = A*B^T$ via coloring 1723 1724 Level: developer 1725 1726 .seealso: [](ch_matrices), `Mat`, `MatProductType`, `MatTransposeColoringCreate()` 1727 S*/ 1728 typedef struct _p_MatTransposeColoring *MatTransposeColoring; 1729 1730 PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat, ISColoring, MatTransposeColoring *); 1731 PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring, Mat, Mat); 1732 PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring, Mat, Mat); 1733 PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring *); 1734 1735 /*S 1736 MatPartitioning - Object for managing the partitioning of a matrix or graph 1737 1738 Level: beginner 1739 1740 Note: 1741 There is also a `PetscPartitioner` object that provides the same functionality. It can utilize the `MatPartitioning` operations 1742 via `PetscPartitionerSetType`(p,`PETSCPARTITIONERMATPARTITIONING`) 1743 1744 Developer Note: 1745 It is an extra maintenance and documentation cost to have two objects with the same functionality. `PetscPartitioner` should be removed 1746 1747 .seealso: [](ch_matrices), [](sec_graph), `Mat`, `MatPartitioningCreate()`, `MatPartitioningType`, `MatColoring`, `MatGetOrdering()`, `MatOrderingType`, 1748 `MatCoarsenType`, `MatCoarsenType` 1749 S*/ 1750 typedef struct _p_MatPartitioning *MatPartitioning; 1751 1752 /*J 1753 MatPartitioningType - String with the name of a PETSc matrix partitioning 1754 1755 Level: beginner 1756 dm 1757 .seealso: [](ch_matrices), [](sec_graph), `Mat`, `MatPartitioningCreate()`, `MatPartitioning`, `MatPartitioningSetType()`, `MatColoringType`, `MatOrderingType`, 1758 `MatCoarsenType`, `MatCoarsenType` 1759 J*/ 1760 typedef const char *MatPartitioningType; 1761 #define MATPARTITIONINGCURRENT "current" 1762 #define MATPARTITIONINGAVERAGE "average" 1763 #define MATPARTITIONINGSQUARE "square" 1764 #define MATPARTITIONINGPARMETIS "parmetis" 1765 #define MATPARTITIONINGCHACO "chaco" 1766 #define MATPARTITIONINGPARTY "party" 1767 #define MATPARTITIONINGPTSCOTCH "ptscotch" 1768 #define MATPARTITIONINGHIERARCH "hierarch" 1769 1770 PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm, MatPartitioning *); 1771 PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning, MatPartitioningType); 1772 PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning, PetscInt); 1773 PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning, Mat); 1774 PETSC_EXTERN PetscErrorCode MatPartitioningSetNumberVertexWeights(MatPartitioning, PetscInt); 1775 PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning, const PetscInt[]); 1776 PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning, const PetscReal[]); 1777 PETSC_EXTERN PetscErrorCode MatPartitioningSetUseEdgeWeights(MatPartitioning, PetscBool); 1778 PETSC_EXTERN PetscErrorCode MatPartitioningGetUseEdgeWeights(MatPartitioning, PetscBool *); 1779 PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning, IS *); 1780 PETSC_EXTERN PetscErrorCode MatPartitioningImprove(MatPartitioning, IS *); 1781 PETSC_EXTERN PetscErrorCode MatPartitioningViewImbalance(MatPartitioning, IS); 1782 PETSC_EXTERN PetscErrorCode MatPartitioningApplyND(MatPartitioning, IS *); 1783 PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning *); 1784 PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[], PetscErrorCode (*)(MatPartitioning)); 1785 PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning, PetscViewer); 1786 PETSC_EXTERN PetscErrorCode MatPartitioningViewFromOptions(MatPartitioning, PetscObject, const char[]); 1787 PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning); 1788 PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning, MatPartitioningType *); 1789 1790 PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part); 1791 PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 1792 PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *); 1793 1794 typedef enum { 1795 MP_CHACO_MULTILEVEL = 1, 1796 MP_CHACO_SPECTRAL = 2, 1797 MP_CHACO_LINEAR = 4, 1798 MP_CHACO_RANDOM = 5, 1799 MP_CHACO_SCATTERED = 6 1800 } MPChacoGlobalType; 1801 PETSC_EXTERN const char *const MPChacoGlobalTypes[]; 1802 typedef enum { 1803 MP_CHACO_KERNIGHAN = 1, 1804 MP_CHACO_NONE = 2 1805 } MPChacoLocalType; 1806 PETSC_EXTERN const char *const MPChacoLocalTypes[]; 1807 typedef enum { 1808 MP_CHACO_LANCZOS = 0, 1809 MP_CHACO_RQI = 1 1810 } MPChacoEigenType; 1811 PETSC_EXTERN const char *const MPChacoEigenTypes[]; 1812 1813 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType); 1814 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning, MPChacoGlobalType *); 1815 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType); 1816 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning, MPChacoLocalType *); 1817 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning, PetscReal); 1818 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning, MPChacoEigenType); 1819 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning, MPChacoEigenType *); 1820 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal); 1821 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning, PetscReal *); 1822 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt); 1823 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning, PetscInt *); 1824 1825 #define MP_PARTY_OPT "opt" 1826 #define MP_PARTY_LIN "lin" 1827 #define MP_PARTY_SCA "sca" 1828 #define MP_PARTY_RAN "ran" 1829 #define MP_PARTY_GBF "gbf" 1830 #define MP_PARTY_GCF "gcf" 1831 #define MP_PARTY_BUB "bub" 1832 #define MP_PARTY_DEF "def" 1833 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning, const char *); 1834 #define MP_PARTY_HELPFUL_SETS "hs" 1835 #define MP_PARTY_KERNIGHAN_LIN "kl" 1836 #define MP_PARTY_NONE "no" 1837 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning, const char *); 1838 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning, PetscReal); 1839 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning, PetscBool); 1840 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning, PetscBool); 1841 1842 typedef enum { 1843 MP_PTSCOTCH_DEFAULT, 1844 MP_PTSCOTCH_QUALITY, 1845 MP_PTSCOTCH_SPEED, 1846 MP_PTSCOTCH_BALANCE, 1847 MP_PTSCOTCH_SAFETY, 1848 MP_PTSCOTCH_SCALABILITY 1849 } MPPTScotchStrategyType; 1850 PETSC_EXTERN const char *const MPPTScotchStrategyTypes[]; 1851 1852 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning, PetscReal); 1853 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning, PetscReal *); 1854 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning, MPPTScotchStrategyType); 1855 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning, MPPTScotchStrategyType *); 1856 1857 /* 1858 * hierarchical partitioning 1859 */ 1860 PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning, IS *); 1861 PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning, IS *); 1862 PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning, PetscInt); 1863 PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt); 1864 1865 PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat, PetscInt, Mat *); 1866 1867 /* 1868 If you add entries here you must also add them to src/mat/f90-mod/petscmat.h 1869 If any of the enum values are changed, also update dMatOps dict at src/binding/petsc4py/src/libpetsc4py/libpetsc4py.pyx 1870 */ 1871 typedef enum { 1872 MATOP_SET_VALUES = 0, 1873 MATOP_GET_ROW = 1, 1874 MATOP_RESTORE_ROW = 2, 1875 MATOP_MULT = 3, 1876 MATOP_MULT_ADD = 4, 1877 MATOP_MULT_TRANSPOSE = 5, 1878 MATOP_MULT_TRANSPOSE_ADD = 6, 1879 MATOP_SOLVE = 7, 1880 MATOP_SOLVE_ADD = 8, 1881 MATOP_SOLVE_TRANSPOSE = 9, 1882 MATOP_SOLVE_TRANSPOSE_ADD = 10, 1883 MATOP_LUFACTOR = 11, 1884 MATOP_CHOLESKYFACTOR = 12, 1885 MATOP_SOR = 13, 1886 MATOP_TRANSPOSE = 14, 1887 MATOP_GETINFO = 15, 1888 MATOP_EQUAL = 16, 1889 MATOP_GET_DIAGONAL = 17, 1890 MATOP_DIAGONAL_SCALE = 18, 1891 MATOP_NORM = 19, 1892 MATOP_ASSEMBLY_BEGIN = 20, 1893 MATOP_ASSEMBLY_END = 21, 1894 MATOP_SET_OPTION = 22, 1895 MATOP_ZERO_ENTRIES = 23, 1896 MATOP_ZERO_ROWS = 24, 1897 MATOP_LUFACTOR_SYMBOLIC = 25, 1898 MATOP_LUFACTOR_NUMERIC = 26, 1899 MATOP_CHOLESKY_FACTOR_SYMBOLIC = 27, 1900 MATOP_CHOLESKY_FACTOR_NUMERIC = 28, 1901 MATOP_SETUP = 29, 1902 MATOP_ILUFACTOR_SYMBOLIC = 30, 1903 MATOP_ICCFACTOR_SYMBOLIC = 31, 1904 MATOP_GET_DIAGONAL_BLOCK = 32, 1905 MATOP_SET_INF = 33, 1906 MATOP_DUPLICATE = 34, 1907 MATOP_FORWARD_SOLVE = 35, 1908 MATOP_BACKWARD_SOLVE = 36, 1909 MATOP_ILUFACTOR = 37, 1910 MATOP_ICCFACTOR = 38, 1911 MATOP_AXPY = 39, 1912 MATOP_CREATE_SUBMATRICES = 40, 1913 MATOP_INCREASE_OVERLAP = 41, 1914 MATOP_GET_VALUES = 42, 1915 MATOP_COPY = 43, 1916 MATOP_GET_ROW_MAX = 44, 1917 MATOP_SCALE = 45, 1918 MATOP_SHIFT = 46, 1919 MATOP_DIAGONAL_SET = 47, 1920 MATOP_ZERO_ROWS_COLUMNS = 48, 1921 MATOP_SET_RANDOM = 49, 1922 MATOP_GET_ROW_IJ = 50, 1923 MATOP_RESTORE_ROW_IJ = 51, 1924 MATOP_GET_COLUMN_IJ = 52, 1925 MATOP_RESTORE_COLUMN_IJ = 53, 1926 MATOP_FDCOLORING_CREATE = 54, 1927 MATOP_COLORING_PATCH = 55, 1928 MATOP_SET_UNFACTORED = 56, 1929 MATOP_PERMUTE = 57, 1930 MATOP_SET_VALUES_BLOCKED = 58, 1931 MATOP_CREATE_SUBMATRIX = 59, 1932 MATOP_DESTROY = 60, 1933 MATOP_VIEW = 61, 1934 MATOP_CONVERT_FROM = 62, 1935 /* MATOP_PLACEHOLDER_63=63 */ 1936 MATOP_MATMAT_MULT_SYMBOLIC = 64, 1937 MATOP_MATMAT_MULT_NUMERIC = 65, 1938 MATOP_SET_LOCAL_TO_GLOBAL_MAP = 66, 1939 MATOP_SET_VALUES_LOCAL = 67, 1940 MATOP_ZERO_ROWS_LOCAL = 68, 1941 MATOP_GET_ROW_MAX_ABS = 69, 1942 MATOP_GET_ROW_MIN_ABS = 70, 1943 MATOP_CONVERT = 71, 1944 MATOP_HAS_OPERATION = 72, 1945 /* MATOP_PLACEHOLDER_73=73, */ 1946 MATOP_SET_VALUES_ADIFOR = 74, 1947 MATOP_FD_COLORING_APPLY = 75, 1948 MATOP_SET_FROM_OPTIONS = 76, 1949 /* MATOP_PLACEHOLDER_77=77, */ 1950 /* MATOP_PLACEHOLDER_78=78, */ 1951 MATOP_FIND_ZERO_DIAGONALS = 79, 1952 MATOP_MULT_MULTIPLE = 80, 1953 MATOP_SOLVE_MULTIPLE = 81, 1954 MATOP_GET_INERTIA = 82, 1955 MATOP_LOAD = 83, 1956 MATOP_IS_SYMMETRIC = 84, 1957 MATOP_IS_HERMITIAN = 85, 1958 MATOP_IS_STRUCTURALLY_SYMMETRIC = 86, 1959 MATOP_SET_VALUES_BLOCKEDLOCAL = 87, 1960 MATOP_CREATE_VECS = 88, 1961 /* MATOP_PLACEHOLDER_89=89, */ 1962 MATOP_MAT_MULT_SYMBOLIC = 90, 1963 MATOP_MAT_MULT_NUMERIC = 91, 1964 /* MATOP_PLACEHOLDER_92=92, */ 1965 MATOP_PTAP_SYMBOLIC = 93, 1966 MATOP_PTAP_NUMERIC = 94, 1967 /* MATOP_PLACEHOLDER_95=95, */ 1968 MATOP_MAT_TRANSPOSE_MULT_SYMBO = 96, 1969 MATOP_MAT_TRANSPOSE_MULT_NUMER = 97, 1970 MATOP_BIND_TO_CPU = 98, 1971 MATOP_PRODUCTSETFROMOPTIONS = 99, 1972 MATOP_PRODUCTSYMBOLIC = 100, 1973 MATOP_PRODUCTNUMERIC = 101, 1974 MATOP_CONJUGATE = 102, 1975 MATOP_VIEW_NATIVE = 103, 1976 MATOP_SET_VALUES_ROW = 104, 1977 MATOP_REAL_PART = 105, 1978 MATOP_IMAGINARY_PART = 106, 1979 MATOP_GET_ROW_UPPER_TRIANGULAR = 107, 1980 MATOP_RESTORE_ROW_UPPER_TRIANG = 108, 1981 MATOP_MAT_SOLVE = 109, 1982 MATOP_MAT_SOLVE_TRANSPOSE = 110, 1983 MATOP_GET_ROW_MIN = 111, 1984 MATOP_GET_COLUMN_VECTOR = 112, 1985 MATOP_MISSING_DIAGONAL = 113, 1986 MATOP_GET_SEQ_NONZERO_STRUCTUR = 114, 1987 MATOP_CREATE = 115, 1988 MATOP_GET_GHOSTS = 116, 1989 MATOP_GET_LOCAL_SUB_MATRIX = 117, 1990 MATOP_RESTORE_LOCALSUB_MATRIX = 118, 1991 MATOP_MULT_DIAGONAL_BLOCK = 119, 1992 MATOP_HERMITIAN_TRANSPOSE = 120, 1993 MATOP_MULT_HERMITIAN_TRANSPOSE = 121, 1994 MATOP_MULT_HERMITIAN_TRANS_ADD = 122, 1995 MATOP_GET_MULTI_PROC_BLOCK = 123, 1996 MATOP_FIND_NONZERO_ROWS = 124, 1997 MATOP_GET_COLUMN_NORMS = 125, 1998 MATOP_INVERT_BLOCK_DIAGONAL = 126, 1999 MATOP_INVERT_VBLOCK_DIAGONAL = 127, 2000 MATOP_CREATE_SUB_MATRICES_MPI = 128, 2001 MATOP_SET_VALUES_BATCH = 129, 2002 /* MATOP_PLACEHOLDER_130=130, */ 2003 MATOP_TRANSPOSE_MAT_MULT_SYMBO = 131, 2004 MATOP_TRANSPOSE_MAT_MULT_NUMER = 132, 2005 MATOP_TRANSPOSE_COLORING_CREAT = 133, 2006 MATOP_TRANS_COLORING_APPLY_SPT = 134, 2007 MATOP_TRANS_COLORING_APPLY_DEN = 135, 2008 /* MATOP_PLACEHOLDER_136=136, */ 2009 MATOP_RART_SYMBOLIC = 137, 2010 MATOP_RART_NUMERIC = 138, 2011 MATOP_SET_BLOCK_SIZES = 139, 2012 MATOP_AYPX = 140, 2013 MATOP_RESIDUAL = 141, 2014 MATOP_FDCOLORING_SETUP = 142, 2015 MATOP_FIND_OFFBLOCK_ENTRIES = 143, 2016 MATOP_MPICONCATENATESEQ = 144, 2017 MATOP_DESTROYSUBMATRICES = 145, 2018 MATOP_TRANSPOSE_SOLVE = 146, 2019 MATOP_GET_VALUES_LOCAL = 147 2020 } MatOperation; 2021 PETSC_EXTERN PetscErrorCode MatSetOperation(Mat, MatOperation, void (*)(void)); 2022 PETSC_EXTERN PetscErrorCode MatGetOperation(Mat, MatOperation, void (**)(void)); 2023 PETSC_EXTERN PetscErrorCode MatHasOperation(Mat, MatOperation, PetscBool *); 2024 PETSC_EXTERN PetscErrorCode MatHasCongruentLayouts(Mat, PetscBool *); 2025 PETSC_DEPRECATED_FUNCTION(3, 14, 0, "MatProductClear()", ) static inline PetscErrorCode MatFreeIntermediateDataStructures(Mat A) 2026 { 2027 return MatProductClear(A); 2028 } 2029 PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat, MatOperation, void (*)(void)); 2030 PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat, MatOperation, void (**)(void)); 2031 PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat, void *); 2032 PETSC_EXTERN PetscErrorCode MatShellSetContextDestroy(Mat, PetscErrorCode (*)(void *)); 2033 PETSC_EXTERN PetscErrorCode MatShellSetVecType(Mat, VecType); 2034 PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat, PetscErrorCode (*)(void *, Vec, Vec), Vec, void *, PetscBool *); 2035 PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat, PetscErrorCode (*)(void *, Vec, Vec), Vec, void *, PetscBool *); 2036 PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat); 2037 PETSC_EXTERN PetscErrorCode MatShellSetMatProductOperation(Mat, MatProductType, PetscErrorCode (*)(Mat, Mat, Mat, void **), PetscErrorCode (*)(Mat, Mat, Mat, void *), PetscErrorCode (*)(void *), MatType, MatType); 2038 PETSC_EXTERN PetscErrorCode MatIsShell(Mat, PetscBool *); 2039 2040 /* 2041 Codes for matrices stored on disk. By default they are 2042 stored in a universal format. By changing the format with 2043 PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will 2044 be stored in a way natural for the matrix, for example dense matrices 2045 would be stored as dense. Matrices stored this way may only be 2046 read into matrices of the same type. 2047 */ 2048 #define MATRIX_BINARY_FORMAT_DENSE -1 2049 2050 PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat, PetscReal); 2051 2052 PETSC_EXTERN PetscErrorCode MatISSetLocalMatType(Mat, MatType); 2053 PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[]); 2054 PETSC_EXTERN PetscErrorCode MatISSetAllowRepeated(Mat, PetscBool); 2055 PETSC_EXTERN PetscErrorCode MatISGetAllowRepeated(Mat, PetscBool *); 2056 PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat, PetscBool); 2057 PETSC_EXTERN PetscErrorCode MatISFixLocalEmpty(Mat, PetscBool); 2058 PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat, Mat *); 2059 PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat, Mat *); 2060 PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat, Mat); 2061 PETSC_EXTERN PetscErrorCode MatISGetLocalToGlobalMapping(Mat, ISLocalToGlobalMapping *, ISLocalToGlobalMapping *); 2062 2063 /*S 2064 MatNullSpace - Object that removes a null space from a vector, i.e. 2065 orthogonalizes the vector to a subspace 2066 2067 Level: advanced 2068 2069 .seealso: [](ch_matrices), `Mat`, `MatNullSpaceCreate()`, `MatNullSpaceSetFunction()`, `MatGetNullSpace()`, `MatSetNullSpace()` 2070 S*/ 2071 typedef struct _p_MatNullSpace *MatNullSpace; 2072 2073 PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm, PetscBool, PetscInt, const Vec[], MatNullSpace *); 2074 PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace, PetscErrorCode (*)(MatNullSpace, Vec, void *), void *); 2075 PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace *); 2076 PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace, Vec); 2077 PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *); 2078 PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *); 2079 PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat, MatNullSpace); 2080 PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat, MatNullSpace); 2081 PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat, MatNullSpace); 2082 PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat, MatNullSpace *); 2083 PETSC_EXTERN PetscErrorCode MatGetNullSpaces(PetscInt, Mat[], MatNullSpace *[]); 2084 PETSC_EXTERN PetscErrorCode MatRestoreNullSpaces(PetscInt, Mat[], MatNullSpace *[]); 2085 PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace, Mat, PetscBool *); 2086 PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace, PetscViewer); 2087 PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace, PetscBool *, PetscInt *, const Vec **); 2088 PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec, MatNullSpace *); 2089 2090 PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat, IS); 2091 PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat, PetscReal); 2092 PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat, PetscInt *); 2093 2094 PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat, PetscInt, Mat *); 2095 PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat, PetscInt, Mat *); 2096 PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat, Mat *); 2097 2098 PETSC_EXTERN PetscErrorCode MatComputeOperator(Mat, MatType, Mat *); 2099 PETSC_EXTERN PetscErrorCode MatComputeOperatorTranspose(Mat, MatType, Mat *); 2100 2101 PETSC_DEPRECATED_FUNCTION(3, 12, 0, "MatComputeOperator()", ) static inline PetscErrorCode MatComputeExplicitOperator(Mat A, Mat *B) 2102 { 2103 return MatComputeOperator(A, PETSC_NULLPTR, B); 2104 } 2105 PETSC_DEPRECATED_FUNCTION(3, 12, 0, "MatComputeOperatorTranspose()", ) static inline PetscErrorCode MatComputeExplicitOperatorTranspose(Mat A, Mat *B) 2106 { 2107 return MatComputeOperatorTranspose(A, PETSC_NULLPTR, B); 2108 } 2109 2110 PETSC_EXTERN PetscErrorCode MatCreateKAIJ(Mat, PetscInt, PetscInt, const PetscScalar[], const PetscScalar[], Mat *); 2111 PETSC_EXTERN PetscErrorCode MatKAIJGetAIJ(Mat, Mat *); 2112 PETSC_EXTERN PetscErrorCode MatKAIJGetS(Mat, PetscInt *, PetscInt *, PetscScalar **); 2113 PETSC_EXTERN PetscErrorCode MatKAIJGetSRead(Mat, PetscInt *, PetscInt *, const PetscScalar **); 2114 PETSC_EXTERN PetscErrorCode MatKAIJRestoreS(Mat, PetscScalar **); 2115 PETSC_EXTERN PetscErrorCode MatKAIJRestoreSRead(Mat, const PetscScalar **); 2116 PETSC_EXTERN PetscErrorCode MatKAIJGetT(Mat, PetscInt *, PetscInt *, PetscScalar **); 2117 PETSC_EXTERN PetscErrorCode MatKAIJGetTRead(Mat, PetscInt *, PetscInt *, const PetscScalar **); 2118 PETSC_EXTERN PetscErrorCode MatKAIJRestoreT(Mat, PetscScalar **); 2119 PETSC_EXTERN PetscErrorCode MatKAIJRestoreTRead(Mat, const PetscScalar **); 2120 PETSC_EXTERN PetscErrorCode MatKAIJSetAIJ(Mat, Mat); 2121 PETSC_EXTERN PetscErrorCode MatKAIJSetS(Mat, PetscInt, PetscInt, const PetscScalar[]); 2122 PETSC_EXTERN PetscErrorCode MatKAIJSetT(Mat, PetscInt, PetscInt, const PetscScalar[]); 2123 PETSC_EXTERN PetscErrorCode MatKAIJGetScaledIdentity(Mat, PetscBool *); 2124 2125 PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat, Vec); 2126 2127 PETSC_EXTERN PetscErrorCode MatMFFDInitializePackage(void); 2128 PETSC_EXTERN PetscErrorCode MatMFFDFinalizePackage(void); 2129 2130 PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, Mat *); 2131 PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat, Vec, Vec); 2132 PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat, PetscErrorCode (*)(void *, Vec, Vec), void *); 2133 PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat, PetscErrorCode (*)(void *, PetscInt, Vec, PetscScalar *)); 2134 PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat, PetscErrorCode (*)(void *, Vec)); 2135 PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat, PetscScalar[], PetscInt); 2136 PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat); 2137 PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat, PetscReal); 2138 PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat, PetscInt); 2139 PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat, PetscScalar *); 2140 PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat, const char[]); 2141 PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void *, Vec, Vec, PetscScalar *); 2142 PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat, PetscErrorCode (*)(void *, Vec, Vec, PetscScalar *), void *); 2143 2144 /*S 2145 MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free 2146 Jacobian vector products 2147 2148 Level: developer 2149 2150 Notes: 2151 `MATMFFD` is a specific `MatType` which uses the `MatMFFD` data structure 2152 2153 MatMFFD*() methods actually take the `Mat` as their first argument. Not a `MatMFFD` data structure 2154 2155 This functionality is often obtained using `MatCreateSNESMF()` or with `SNES` solvers using `-snes_mf` or `-snes_mf_operator` 2156 2157 .seealso: [](ch_matrices), `MatMFFDType`, `MATMFFD`, `MatCreateMFFD()`, `MatMFFDSetFuction()`, `MatMFFDSetType()`, `MatMFFDRegister()`, 2158 `MatCreateSNESMF()`, `SNES`, `-snes_mf`, `-snes_mf_operator` 2159 S*/ 2160 typedef struct _p_MatMFFD *MatMFFD; 2161 2162 /*J 2163 MatMFFDType - algorithm used to compute the `h` used in computing matrix-vector products via differencing of a function 2164 2165 Values: 2166 + `MATMFFD_DS` - an algorithm described by Dennis and Schnabel {cite}`dennis:83` 2167 - `MATMFFD_WP` - the Walker-Pernice {cite}`pw98` strategy. 2168 2169 Level: beginner 2170 2171 .seealso: [](ch_matrices), `MatMFFDSetType()`, `MatMFFDRegister()`, `MatMFFDSetFunction()`, `MatCreateMFFD()` 2172 J*/ 2173 typedef const char *MatMFFDType; 2174 #define MATMFFD_DS "ds" 2175 #define MATMFFD_WP "wp" 2176 2177 PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat, MatMFFDType); 2178 PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[], PetscErrorCode (*)(MatMFFD)); 2179 2180 PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat, PetscReal); 2181 PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat, PetscBool); 2182 2183 PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring, MatMFFDType); 2184 2185 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 2186 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 2187 2188 #ifdef PETSC_HAVE_H2OPUS 2189 PETSC_EXTERN_TYPEDEF typedef PetscScalar(MatH2OpusKernelFn)(PetscInt, PetscReal[], PetscReal[], void *); 2190 PETSC_EXTERN_TYPEDEF typedef MatH2OpusKernelFn *MatH2OpusKernel; 2191 PETSC_EXTERN PetscErrorCode MatCreateH2OpusFromKernel(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscReal[], PetscBool, MatH2OpusKernelFn *, void *, PetscReal, PetscInt, PetscInt, Mat *); 2192 PETSC_EXTERN PetscErrorCode MatCreateH2OpusFromMat(Mat, PetscInt, const PetscReal[], PetscBool, PetscReal, PetscInt, PetscInt, PetscInt, PetscReal, Mat *); 2193 PETSC_EXTERN PetscErrorCode MatH2OpusSetSamplingMat(Mat, Mat, PetscInt, PetscReal); 2194 PETSC_EXTERN PetscErrorCode MatH2OpusOrthogonalize(Mat); 2195 PETSC_EXTERN PetscErrorCode MatH2OpusCompress(Mat, PetscReal); 2196 PETSC_EXTERN PetscErrorCode MatH2OpusSetNativeMult(Mat, PetscBool); 2197 PETSC_EXTERN PetscErrorCode MatH2OpusGetNativeMult(Mat, PetscBool *); 2198 PETSC_EXTERN PetscErrorCode MatH2OpusGetIndexMap(Mat, IS *); 2199 PETSC_EXTERN PetscErrorCode MatH2OpusMapVec(Mat, PetscBool, Vec, Vec *); 2200 PETSC_EXTERN PetscErrorCode MatH2OpusLowRankUpdate(Mat, Mat, Mat, PetscScalar); 2201 #endif 2202 2203 #ifdef PETSC_HAVE_HTOOL 2204 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode(MatHtoolKernelFn)(PetscInt, PetscInt, PetscInt, const PetscInt *, const PetscInt *, PetscScalar *, void *); 2205 PETSC_EXTERN_TYPEDEF typedef MatHtoolKernelFn *MatHtoolKernel; 2206 PETSC_EXTERN PetscErrorCode MatCreateHtoolFromKernel(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscReal[], const PetscReal[], MatHtoolKernelFn *, void *, Mat *); 2207 PETSC_EXTERN PetscErrorCode MatHtoolSetKernel(Mat, MatHtoolKernelFn *, void *); 2208 PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationSource(Mat, IS *); 2209 PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationTarget(Mat, IS *); 2210 PETSC_EXTERN PetscErrorCode MatHtoolUsePermutation(Mat, PetscBool); 2211 2212 /*E 2213 MatHtoolCompressorType - Indicates the type of compressor used by a `MATHTOOL` 2214 2215 Values: 2216 + `MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA` (default) - symmetric partial adaptive cross approximation 2217 . `MAT_HTOOL_COMPRESSOR_FULL_ACA` - full adaptive cross approximation 2218 - `MAT_HTOOL_COMPRESSOR_SVD` - singular value decomposition 2219 2220 Level: intermediate 2221 2222 .seealso: [](ch_matrices), `Mat`, `MatCreateHtoolFromKernel()`, `MATHTOOL`, `MatHtoolClusteringType` 2223 E*/ 2224 typedef enum { 2225 MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA, 2226 MAT_HTOOL_COMPRESSOR_FULL_ACA, 2227 MAT_HTOOL_COMPRESSOR_SVD 2228 } MatHtoolCompressorType; 2229 2230 /*E 2231 MatHtoolClusteringType - Indicates the type of clustering used by a `MATHTOOL` 2232 2233 Values: 2234 + `MAT_HTOOL_CLUSTERING_PCA_REGULAR` (default) - axis computed via principle component analysis, split uniformly 2235 . `MAT_HTOOL_CLUSTERING_PCA_GEOMETRIC` - axis computed via principle component analysis, split barycentrically 2236 . `MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_REGULAR` - axis along the largest extent of the bounding box, split uniformly 2237 - `MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_GEOMETRIC` - axis along the largest extent of the bounding box, split barycentrically 2238 2239 Level: intermediate 2240 2241 Note: 2242 Higher-dimensional clustering is not yet supported in Htool, but once it is, one should add BOUNDING_BOX_{2,3} types 2243 2244 .seealso: [](ch_matrices), `Mat`, `MatCreateHtoolFromKernel()`, `MATHTOOL`, `MatHtoolCompressorType` 2245 E*/ 2246 typedef enum { 2247 MAT_HTOOL_CLUSTERING_PCA_REGULAR, 2248 MAT_HTOOL_CLUSTERING_PCA_GEOMETRIC, 2249 MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_REGULAR, 2250 MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_GEOMETRIC 2251 } MatHtoolClusteringType; 2252 #endif 2253 2254 #ifdef PETSC_HAVE_MUMPS 2255 PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat, PetscInt, PetscInt); 2256 PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat, PetscInt, PetscInt *); 2257 PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat, PetscInt, PetscReal); 2258 PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat, PetscInt, PetscReal *); 2259 2260 PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat, PetscInt, PetscInt *); 2261 PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat, PetscInt, PetscInt *); 2262 PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat, PetscInt, PetscReal *); 2263 PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat, PetscInt, PetscReal *); 2264 PETSC_EXTERN PetscErrorCode MatMumpsGetNullPivots(Mat, PetscInt *, PetscInt **); 2265 PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat, Mat); 2266 PETSC_EXTERN PetscErrorCode MatMumpsGetInverseTranspose(Mat, Mat); 2267 #endif 2268 2269 #ifdef PETSC_HAVE_MKL_PARDISO 2270 PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat, PetscInt, PetscInt); 2271 #endif 2272 2273 #ifdef PETSC_HAVE_MKL_CPARDISO 2274 PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat, PetscInt, PetscInt); 2275 #endif 2276 2277 #ifdef PETSC_HAVE_SUPERLU 2278 PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat, PetscReal); 2279 #endif 2280 2281 #ifdef PETSC_HAVE_SUPERLU_DIST 2282 PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat, PetscScalar *); 2283 #endif 2284 2285 #ifdef PETSC_HAVE_STRUMPACK 2286 /*E 2287 MatSTRUMPACKReordering - sparsity reducing ordering to be used in `MATSOLVERSTRUMPACK` 2288 2289 Values: 2290 + `MAT_STRUMPACK_NATURAL` - use the current ordering 2291 . `MAT_STRUMPACK_METIS` - use MeTis to compute an ordering 2292 . `MAT_STRUMPACK_PARMETIS` - use ParMeTis to compute an ordering 2293 . `MAT_STRUMPACK_SCOTCH` - use Scotch to compute an ordering 2294 . `MAT_STRUMPACK_PTSCOTCH` - use parallel Scotch to compute an ordering 2295 . `MAT_STRUMPACK_RCM` - use an RCM ordering 2296 . `MAT_STRUMPACK_GEOMETRIC` - use a geometric ordering (needs mesh info from user) 2297 . `MAT_STRUMPACK_AMD` - approximate minimum degree 2298 . `MAT_STRUMPACK_MMD` - multiple minimum degree 2299 . `MAT_STRUMPACK_AND` - approximate nested dissection 2300 . `MAT_STRUMPACK_MLF` - minimum local fill 2301 - `MAT_STRUMPACK_SPECTRAL` - spectral nested dissection 2302 2303 Level: intermediate 2304 2305 Developer Note: 2306 Should be called `MatSTRUMPACKReorderingType` 2307 2308 .seealso: `Mat`, `MATSOLVERSTRUMPACK`, `MatGetFactor()`, `MatSTRUMPACKSetReordering()` 2309 E*/ 2310 typedef enum { 2311 MAT_STRUMPACK_NATURAL, 2312 MAT_STRUMPACK_METIS, 2313 MAT_STRUMPACK_PARMETIS, 2314 MAT_STRUMPACK_SCOTCH, 2315 MAT_STRUMPACK_PTSCOTCH, 2316 MAT_STRUMPACK_RCM, 2317 MAT_STRUMPACK_GEOMETRIC, 2318 MAT_STRUMPACK_AMD, 2319 MAT_STRUMPACK_MMD, 2320 MAT_STRUMPACK_AND, 2321 MAT_STRUMPACK_MLF, 2322 MAT_STRUMPACK_SPECTRAL 2323 } MatSTRUMPACKReordering; 2324 2325 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat, MatSTRUMPACKReordering); 2326 PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetReordering(Mat, MatSTRUMPACKReordering *); 2327 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGeometricNxyz(Mat, PetscInt, PetscInt, PetscInt); 2328 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGeometricComponents(Mat, PetscInt); 2329 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGeometricWidth(Mat, PetscInt); 2330 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat, PetscBool); 2331 PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetColPerm(Mat, PetscBool *); 2332 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetGPU(Mat, PetscBool); 2333 PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetGPU(Mat, PetscBool *); 2334 2335 /*E 2336 MatSTRUMPACKCompressionType - Compression used in the approximate sparse factorization solver `MATSOLVERSTRUMPACK` 2337 2338 Values: 2339 + `MAT_STRUMPACK_COMPRESSION_TYPE_NONE` - no compression, direct solver 2340 . `MAT_STRUMPACK_COMPRESSION_TYPE_HSS` - hierarchically semi-separable 2341 . `MAT_STRUMPACK_COMPRESSION_TYPE_BLR` - block low rank 2342 . `MAT_STRUMPACK_COMPRESSION_TYPE_HODLR` - hierarchically off-diagonal low rank (requires ButterfyPACK support, configure with --download-butterflypack) 2343 . `MAT_STRUMPACK_COMPRESSION_TYPE_BLR_HODLR` - hybrid of BLR and HODLR (requires ButterfyPACK support, configure with --download-butterflypack) 2344 . `MAT_STRUMPACK_COMPRESSION_TYPE_ZFP_BLR_HODLR` - hybrid of lossy (ZFP), BLR and HODLR (requires ButterfyPACK and ZFP support, configure with --download-butterflypack --download-zfp) 2345 . `MAT_STRUMPACK_COMPRESSION_TYPE_LOSSLESS` - lossless compression (requires ZFP support, configure with --download-zfp) 2346 - `MAT_STRUMPACK_COMPRESSION_TYPE_LOSSY` - lossy compression (requires ZFP support, configure with --download-zfp) 2347 2348 Level: intermediate 2349 2350 .seealso: `Mat`, `MATSOLVERSTRUMPACK`, `MatGetFactor()`, `MatSTRUMPACKSetCompression()` 2351 E*/ 2352 typedef enum { 2353 MAT_STRUMPACK_COMPRESSION_TYPE_NONE, 2354 MAT_STRUMPACK_COMPRESSION_TYPE_HSS, 2355 MAT_STRUMPACK_COMPRESSION_TYPE_BLR, 2356 MAT_STRUMPACK_COMPRESSION_TYPE_HODLR, 2357 MAT_STRUMPACK_COMPRESSION_TYPE_BLR_HODLR, 2358 MAT_STRUMPACK_COMPRESSION_TYPE_ZFP_BLR_HODLR, 2359 MAT_STRUMPACK_COMPRESSION_TYPE_LOSSLESS, 2360 MAT_STRUMPACK_COMPRESSION_TYPE_LOSSY 2361 } MatSTRUMPACKCompressionType; 2362 2363 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompression(Mat, MatSTRUMPACKCompressionType); 2364 PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompression(Mat, MatSTRUMPACKCompressionType *); 2365 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompRelTol(Mat, PetscReal); 2366 PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompRelTol(Mat, PetscReal *); 2367 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompAbsTol(Mat, PetscReal); 2368 PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompAbsTol(Mat, PetscReal *); 2369 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompMinSepSize(Mat, PetscInt); 2370 PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompMinSepSize(Mat, PetscInt *); 2371 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompLeafSize(Mat, PetscInt); 2372 PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompLeafSize(Mat, PetscInt *); 2373 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompLossyPrecision(Mat, PetscInt); 2374 PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompLossyPrecision(Mat, PetscInt *); 2375 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetCompButterflyLevels(Mat, PetscInt); 2376 PETSC_EXTERN PetscErrorCode MatSTRUMPACKGetCompButterflyLevels(Mat, PetscInt *); 2377 #endif 2378 2379 PETSC_EXTERN PetscErrorCode MatBindToCPU(Mat, PetscBool); 2380 PETSC_EXTERN PetscErrorCode MatBoundToCPU(Mat, PetscBool *); 2381 PETSC_DEPRECATED_FUNCTION(3, 13, 0, "MatBindToCPU()", ) static inline PetscErrorCode MatPinToCPU(Mat A, PetscBool flg) 2382 { 2383 return MatBindToCPU(A, flg); 2384 } 2385 PETSC_EXTERN PetscErrorCode MatSetBindingPropagates(Mat, PetscBool); 2386 PETSC_EXTERN PetscErrorCode MatGetBindingPropagates(Mat, PetscBool *); 2387 2388 #ifdef PETSC_HAVE_CUDA 2389 /*E 2390 MatCUSPARSEStorageFormat - indicates the storage format for `MATAIJCUSPARSE` (GPU) 2391 matrices. 2392 2393 Values: 2394 + `MAT_CUSPARSE_CSR` - Compressed Sparse Row 2395 . `MAT_CUSPARSE_ELL` - Ellpack (requires CUDA 4.2 or later). 2396 - `MAT_CUSPARSE_HYB` - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later). 2397 2398 Level: intermediate 2399 2400 .seealso: [](ch_matrices), `MATAIJCUSPARSE`, `MatCUSPARSESetFormat()`, `MatCUSPARSEFormatOperation` 2401 E*/ 2402 2403 typedef enum { 2404 MAT_CUSPARSE_CSR, 2405 MAT_CUSPARSE_ELL, 2406 MAT_CUSPARSE_HYB 2407 } MatCUSPARSEStorageFormat; 2408 2409 /* these will be strings associated with enumerated type defined above */ 2410 PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[]; 2411 2412 /*E 2413 MatCUSPARSEFormatOperation - indicates the operation of `MATAIJCUSPARSE` (GPU) 2414 matrices whose operation should use a particular storage format. 2415 2416 Values: 2417 + `MAT_CUSPARSE_MULT_DIAG` - sets the storage format for the diagonal matrix in the parallel `MatMult()` 2418 . `MAT_CUSPARSE_MULT_OFFDIAG` - sets the storage format for the off-diagonal matrix in the parallel `MatMult()` 2419 . `MAT_CUSPARSE_MULT` - sets the storage format for the entire matrix in the serial (single GPU) `MatMult()` 2420 - `MAT_CUSPARSE_ALL` - sets the storage format for all `MATAIJCUSPARSE` (GPU) matrices 2421 2422 Level: intermediate 2423 2424 .seealso: [](ch_matrices), `MatCUSPARSESetFormat()`, `MatCUSPARSEStorageFormat` 2425 E*/ 2426 typedef enum { 2427 MAT_CUSPARSE_MULT_DIAG, 2428 MAT_CUSPARSE_MULT_OFFDIAG, 2429 MAT_CUSPARSE_MULT, 2430 MAT_CUSPARSE_ALL 2431 } MatCUSPARSEFormatOperation; 2432 2433 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *); 2434 PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *); 2435 PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat, MatCUSPARSEFormatOperation, MatCUSPARSEStorageFormat); 2436 PETSC_EXTERN PetscErrorCode MatCUSPARSESetUseCPUSolve(Mat, PetscBool); 2437 PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetIJ(Mat, PetscBool, const int **, const int **); 2438 PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreIJ(Mat, PetscBool, const int **, const int **); 2439 PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayRead(Mat, const PetscScalar **); 2440 PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayRead(Mat, const PetscScalar **); 2441 PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArrayWrite(Mat, PetscScalar **); 2442 PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArrayWrite(Mat, PetscScalar **); 2443 PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSEGetArray(Mat, PetscScalar **); 2444 PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSERestoreArray(Mat, PetscScalar **); 2445 2446 PETSC_EXTERN PetscErrorCode MatCreateDenseCUDA(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar[], Mat *); 2447 PETSC_EXTERN PetscErrorCode MatCreateSeqDenseCUDA(MPI_Comm, PetscInt, PetscInt, PetscScalar[], Mat *); 2448 PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayWrite(Mat, PetscScalar **); 2449 PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayRead(Mat, const PetscScalar **); 2450 PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArray(Mat, PetscScalar **); 2451 PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayWrite(Mat, PetscScalar **); 2452 PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayRead(Mat, const PetscScalar **); 2453 PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArray(Mat, PetscScalar **); 2454 PETSC_EXTERN PetscErrorCode MatDenseCUDAPlaceArray(Mat, const PetscScalar *); 2455 PETSC_EXTERN PetscErrorCode MatDenseCUDAReplaceArray(Mat, const PetscScalar *); 2456 PETSC_EXTERN PetscErrorCode MatDenseCUDAResetArray(Mat); 2457 PETSC_EXTERN PetscErrorCode MatDenseCUDASetPreallocation(Mat, PetscScalar *); 2458 2459 PETSC_EXTERN PetscErrorCode MatCreateSeqSELLCUDA(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *); 2460 PETSC_EXTERN PetscErrorCode MatCreateSELLCUDA(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *); 2461 #endif 2462 2463 #ifdef PETSC_HAVE_HIP 2464 /*E 2465 MatHIPSPARSEStorageFormat - indicates the storage format for `MATAIJHIPSPARSE` (GPU) 2466 matrices. 2467 2468 Values: 2469 + `MAT_HIPSPARSE_CSR` - Compressed Sparse Row 2470 . `MAT_HIPSPARSE_ELL` - Ellpack 2471 - `MAT_HIPSPARSE_HYB` - Hybrid, a combination of Ellpack and Coordinate format 2472 2473 Level: intermediate 2474 2475 .seealso: [](ch_matrices), `MatHIPSPARSESetFormat()`, `MatHIPSPARSEFormatOperation` 2476 E*/ 2477 2478 typedef enum { 2479 MAT_HIPSPARSE_CSR, 2480 MAT_HIPSPARSE_ELL, 2481 MAT_HIPSPARSE_HYB 2482 } MatHIPSPARSEStorageFormat; 2483 2484 /* these will be strings associated with enumerated type defined above */ 2485 PETSC_EXTERN const char *const MatHIPSPARSEStorageFormats[]; 2486 2487 /*E 2488 MatHIPSPARSEFormatOperation - indicates the operation of `MATAIJHIPSPARSE` (GPU) 2489 matrices whose operation should use a particular storage format. 2490 2491 Values: 2492 + `MAT_HIPSPARSE_MULT_DIAG` - sets the storage format for the diagonal matrix in the parallel `MatMult()` 2493 . `MAT_HIPSPARSE_MULT_OFFDIAG` - sets the storage format for the off-diagonal matrix in the parallel `MatMult()` 2494 . `MAT_HIPSPARSE_MULT` - sets the storage format for the entire matrix in the serial (single GPU) `MatMult()` 2495 - `MAT_HIPSPARSE_ALL` - sets the storage format for all HIPSPARSE (GPU) matrices 2496 2497 Level: intermediate 2498 2499 .seealso: [](ch_matrices), `MatHIPSPARSESetFormat()`, `MatHIPSPARSEStorageFormat` 2500 E*/ 2501 typedef enum { 2502 MAT_HIPSPARSE_MULT_DIAG, 2503 MAT_HIPSPARSE_MULT_OFFDIAG, 2504 MAT_HIPSPARSE_MULT, 2505 MAT_HIPSPARSE_ALL 2506 } MatHIPSPARSEFormatOperation; 2507 2508 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJHIPSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *); 2509 PETSC_EXTERN PetscErrorCode MatCreateAIJHIPSPARSE(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *); 2510 PETSC_EXTERN PetscErrorCode MatHIPSPARSESetFormat(Mat, MatHIPSPARSEFormatOperation, MatHIPSPARSEStorageFormat); 2511 PETSC_EXTERN PetscErrorCode MatHIPSPARSESetUseCPUSolve(Mat, PetscBool); 2512 PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetIJ(Mat, PetscBool, const int **, const int **); 2513 PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreIJ(Mat, PetscBool, const int **, const int **); 2514 PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetArrayRead(Mat, const PetscScalar **); 2515 PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreArrayRead(Mat, const PetscScalar **); 2516 PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetArrayWrite(Mat, PetscScalar **); 2517 PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreArrayWrite(Mat, PetscScalar **); 2518 PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSEGetArray(Mat, PetscScalar **); 2519 PETSC_EXTERN PetscErrorCode MatSeqAIJHIPSPARSERestoreArray(Mat, PetscScalar **); 2520 2521 PETSC_EXTERN PetscErrorCode MatCreateDenseHIP(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar[], Mat *); 2522 PETSC_EXTERN PetscErrorCode MatCreateSeqDenseHIP(MPI_Comm, PetscInt, PetscInt, PetscScalar[], Mat *); 2523 PETSC_EXTERN PetscErrorCode MatDenseHIPGetArrayWrite(Mat, PetscScalar **); 2524 PETSC_EXTERN PetscErrorCode MatDenseHIPGetArrayRead(Mat, const PetscScalar **); 2525 PETSC_EXTERN PetscErrorCode MatDenseHIPGetArray(Mat, PetscScalar **); 2526 PETSC_EXTERN PetscErrorCode MatDenseHIPRestoreArrayWrite(Mat, PetscScalar **); 2527 PETSC_EXTERN PetscErrorCode MatDenseHIPRestoreArrayRead(Mat, const PetscScalar **); 2528 PETSC_EXTERN PetscErrorCode MatDenseHIPRestoreArray(Mat, PetscScalar **); 2529 PETSC_EXTERN PetscErrorCode MatDenseHIPPlaceArray(Mat, const PetscScalar *); 2530 PETSC_EXTERN PetscErrorCode MatDenseHIPReplaceArray(Mat, const PetscScalar *); 2531 PETSC_EXTERN PetscErrorCode MatDenseHIPResetArray(Mat); 2532 PETSC_EXTERN PetscErrorCode MatDenseHIPSetPreallocation(Mat, PetscScalar *); 2533 #endif 2534 2535 #if defined(PETSC_HAVE_VIENNACL) 2536 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *); 2537 PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *); 2538 #endif 2539 2540 #if PetscDefined(HAVE_KOKKOS) 2541 PETSC_EXTERN PetscErrorCode MatCreateAIJKokkos(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], PetscInt, const PetscInt[], Mat *); 2542 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJKokkos(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Mat *); 2543 #endif 2544 2545 #if defined(PETSC_HAVE_FFTW) 2546 PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat, Vec, Vec); 2547 PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat, Vec, Vec); 2548 PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat, Vec *, Vec *, Vec *); 2549 #endif 2550 2551 #if defined(PETSC_HAVE_SCALAPACK) 2552 PETSC_EXTERN PetscErrorCode MatCreateScaLAPACK(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, Mat *); 2553 PETSC_EXTERN PetscErrorCode MatScaLAPACKSetBlockSizes(Mat, PetscInt, PetscInt); 2554 PETSC_EXTERN PetscErrorCode MatScaLAPACKGetBlockSizes(Mat, PetscInt *, PetscInt *); 2555 #endif 2556 2557 PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm, PetscInt, const IS[], PetscInt, const IS[], const Mat[], Mat *); 2558 PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat, PetscInt *, PetscInt *); 2559 PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat, IS[], IS[]); 2560 PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat, IS[], IS[]); 2561 PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat, PetscInt *, PetscInt *, Mat ***); 2562 PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat, PetscInt, PetscInt, Mat *); 2563 PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat, VecType); 2564 PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat, PetscInt, const IS[], PetscInt, const IS[], const Mat[]); 2565 PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat, PetscInt, PetscInt, Mat); 2566 2567 PETSC_EXTERN PetscErrorCode MatFilter(Mat, PetscReal, PetscBool, PetscBool); 2568 PETSC_DEPRECATED_FUNCTION(3, 20, 0, "MatFilter()", ) static inline PetscErrorCode MatChop(Mat A, PetscReal tol) 2569 { 2570 return MatFilter(A, tol, PETSC_FALSE, PETSC_FALSE); 2571 } 2572 PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat, PetscReal, PetscInt *); 2573 2574 PETSC_EXTERN PetscErrorCode MatSubdomainsCreateCoalesce(Mat, PetscInt, PetscInt *, IS **); 2575 2576 PETSC_EXTERN PetscErrorCode MatPreallocatorPreallocate(Mat, PetscBool, Mat); 2577 2578 PETSC_EXTERN PetscErrorCode MatHeaderMerge(Mat, Mat *); 2579 PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat, Mat *); 2580 2581 PETSC_EXTERN PetscErrorCode MatSeqAIJGetCSRAndMemType(Mat, const PetscInt **, const PetscInt **, PetscScalar **, PetscMemType *); 2582 2583 PETSC_EXTERN PetscErrorCode MatCreateGraph(Mat, PetscBool, PetscBool, PetscReal, PetscInt, PetscInt[], Mat *); 2584 PETSC_EXTERN PetscErrorCode MatEliminateZeros(Mat, PetscBool); 2585 2586 PETSC_EXTERN PetscErrorCode MatCreateDenseFromVecType(MPI_Comm, VecType, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar *, Mat *); 2587 2588 PETSC_EXTERN PetscErrorCode MatSetHPL(Mat, int); 2589 #define PETSCBMHPL "hpl" 2590