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