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