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