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