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