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