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