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