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