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