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