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