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