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