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