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