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 MATLDFP "lmvmldfp" 93 #define MATLBFGS "lmvmlbfgs" 94 #define MATLSR1 "lmvmlsr1" 95 #define MATLBRDN "lmvmlbrdn" 96 #define MATLMBRDN "lmvmlmbrdn" 97 #define MATLSBRDN "lmvmlsbrdn" 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,MAT_FACTOR_LMVM} 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 MatResidual(Mat,Vec,Vec,Vec); 434 435 /*E 436 MatDuplicateOption - Indicates if a duplicated sparse matrix should have 437 its numerical values copied over or just its nonzero structure. 438 439 Level: beginner 440 441 Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 442 443 $ MAT_DO_NOT_COPY_VALUES - Create a matrix using the same nonzero pattern as the original matrix, 444 $ with zeros for the numerical values. 445 $ MAT_COPY_VALUES - Create a matrix with the same nonzero pattern as the original matrix 446 $ and with the same numerical values. 447 $ MAT_SHARE_NONZERO_PATTERN - Create a matrix that shares the nonzero structure with the previous matrix 448 $ and does not copy it, using zeros for the numerical values. The parent and 449 $ child matrices will share their index (i and j) arrays, and you cannot 450 $ insert new nonzero entries into either matrix. 451 452 Notes: 453 Many matrix types (including SeqAIJ) do not support the MAT_SHARE_NONZERO_PATTERN optimization; in 454 this case the behavior is as if MAT_DO_NOT_COPY_VALUES has been specified. 455 456 .seealso: MatDuplicate() 457 E*/ 458 typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption; 459 460 PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*); 461 PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*); 462 463 464 PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure); 465 PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer); 466 PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *); 467 PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *); 468 PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *); 469 PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *); 470 PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *); 471 PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool *,PetscInt *); 472 PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer); 473 474 PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *); 475 PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *); 476 PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool *); 477 PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool *); 478 479 /*S 480 MatInfo - Context of matrix information, used with MatGetInfo() 481 482 In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE 483 484 Level: intermediate 485 486 Concepts: matrix^nonzero information 487 488 .seealso: MatGetInfo(), MatInfoType 489 S*/ 490 typedef struct { 491 PetscLogDouble block_size; /* block size */ 492 PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */ 493 PetscLogDouble memory; /* memory allocated */ 494 PetscLogDouble assemblies; /* number of matrix assemblies called */ 495 PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */ 496 PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */ 497 PetscLogDouble factor_mallocs; /* number of mallocs during factorization */ 498 } MatInfo; 499 500 /*E 501 MatInfoType - Indicates if you want information about the local part of the matrix, 502 the entire parallel matrix or the maximum over all the local parts. 503 504 Level: beginner 505 506 Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 507 508 .seealso: MatGetInfo(), MatInfo 509 E*/ 510 typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 511 PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*); 512 PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec); 513 PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]); 514 PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]); 515 PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]); 516 PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]); 517 PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec); 518 PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*); 519 PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*); 520 PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat*); 521 PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec); 522 PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode); 523 524 PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool*); 525 PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool*); 526 PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool*); 527 PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool*); 528 PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*); 529 PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 530 PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*); 531 532 PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal*); 533 PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal*); 534 PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat); 535 PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 536 PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec); 537 PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec); 538 PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec); 539 PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 540 PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec); 541 542 PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*); 543 PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*); 544 PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*); 545 PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**); 546 PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*); 547 PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**); 548 PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*); 549 550 PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 551 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);} 552 PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 553 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);} 554 PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]); 555 PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt,Mat *[]); 556 PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,MatReuse,Mat *); 557 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);} 558 PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*); 559 PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*); 560 PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*); 561 PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*); 562 563 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*); 564 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*); 565 PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat); 566 PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*); 567 PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*); 568 PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*); 569 PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]); 570 571 PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt); 572 PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov); 573 PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat,PetscBool); 574 575 PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 576 PETSC_EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*); 577 PETSC_EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat); 578 579 PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*); 580 PETSC_EXTERN PetscErrorCode MatGalerkin(Mat,Mat,Mat,MatReuse,PetscReal,Mat*); 581 582 PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*); 583 PETSC_EXTERN PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*); 584 PETSC_EXTERN PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat); 585 PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*); 586 PETSC_EXTERN PetscErrorCode MatRARtSymbolic(Mat,Mat,PetscReal,Mat*); 587 PETSC_EXTERN PetscErrorCode MatRARtNumeric(Mat,Mat,Mat); 588 589 PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 590 PETSC_EXTERN PetscErrorCode MatTransposetMatMultSymbolic(Mat,Mat,PetscReal,Mat*); 591 PETSC_EXTERN PetscErrorCode MatTransposetMatMultNumeric(Mat,Mat,Mat); 592 PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*); 593 PETSC_EXTERN PetscErrorCode MatMatTransposeMultSymbolic(Mat,Mat,PetscReal,Mat*); 594 PETSC_EXTERN PetscErrorCode MatMatTransposeMultNumeric(Mat,Mat,Mat); 595 596 PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure); 597 PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure); 598 599 PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar); 600 PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar); 601 602 PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping); 603 PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*); 604 PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat,PetscLayout*,PetscLayout*); 605 PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 606 PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec); 607 PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 608 PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec); 609 PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 610 PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 611 612 PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt); 613 PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 614 615 PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec); 616 PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec); 617 PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec); 618 PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat,Vec*,Vec*); 619 PETSC_DEPRECATED("Use MatCreateVecs()") PETSC_STATIC_INLINE PetscErrorCode MatGetVecs(Mat mat,Vec *x,Vec *y) {return MatCreateVecs(mat,x,y);} 620 PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*); 621 PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*); 622 PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*); 623 PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*); 624 PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm,Mat,PetscInt,MatReuse,Mat*); 625 626 /*MC 627 MatSetValue - Set a single entry into a matrix. 628 629 Not collective 630 631 Synopsis: 632 #include <petscmat.h> 633 PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode) 634 635 Input Parameters: 636 + m - the matrix 637 . row - the row location of the entry 638 . col - the column location of the entry 639 . value - the value to insert 640 - mode - either INSERT_VALUES or ADD_VALUES 641 642 Notes: 643 For efficiency one should use MatSetValues() and set several or many 644 values simultaneously if possible. 645 646 Level: beginner 647 648 .seealso: MatSetValues(), MatSetValueLocal() 649 M*/ 650 PETSC_STATIC_INLINE PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);} 651 652 PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);} 653 654 PETSC_STATIC_INLINE PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);} 655 656 /*MC 657 MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per 658 row in a matrix providing the data that one can use to correctly preallocate the matrix. 659 660 Synopsis: 661 #include <petscmat.h> 662 PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 663 664 Collective on MPI_Comm 665 666 Input Parameters: 667 + comm - the communicator that will share the eventually allocated matrix 668 . nrows - the number of LOCAL rows in the matrix 669 - ncols - the number of LOCAL columns in the matrix 670 671 Output Parameters: 672 + dnz - the array that will be passed to the matrix preallocation routines 673 - onz - the other array passed to the matrix preallocation routines 674 675 Level: intermediate 676 677 Notes: 678 See Users-Manual: ch_performance for more details. 679 680 Do not malloc or free dnz and onz, that is handled internally by these routines 681 682 Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices) 683 684 This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize(). 685 686 Concepts: preallocation^Matrix 687 688 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(), 689 MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocalBlock() 690 M*/ 691 #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \ 692 { \ 693 PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ncols = (ncols),__rstart,__start,__end; \ 694 _4_ierr = PetscCalloc2((size_t)__nrows,&dnz,(size_t)__nrows,&onz);CHKERRQ(_4_ierr); \ 695 __start = 0; __end = __start; \ 696 _4_ierr = MPI_Scan(&__ncols,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ncols;\ 697 _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows; 698 699 /*MC 700 MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 701 inserted using a local number of the rows and columns 702 703 Synopsis: 704 #include <petscmat.h> 705 PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 706 707 Not Collective 708 709 Input Parameters: 710 + map - the row mapping from local numbering to global numbering 711 . nrows - the number of rows indicated 712 . rows - the indices of the rows 713 . cmap - the column mapping from local to global numbering 714 . ncols - the number of columns in the matrix 715 . cols - the columns indicated 716 . dnz - the array that will be passed to the matrix preallocation routines 717 - onz - the other array passed to the matrix preallocation routines 718 719 Level: intermediate 720 721 Notes: 722 See Users-Manual: ch_performance for more details. 723 724 Do not malloc or free dnz and onz, that is handled internally by these routines 725 726 Concepts: preallocation^Matrix 727 728 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 729 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocalRemoveDups() 730 M*/ 731 #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \ 732 {\ 733 PetscInt __l;\ 734 _4_ierr = ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\ 735 _4_ierr = ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\ 736 for (__l=0;__l<nrows;__l++) {\ 737 _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 738 }\ 739 } 740 741 /*MC 742 MatPreallocateSetLocalRemoveDups - Indicates the locations (rows and columns) in the matrix where nonzeros will be 743 inserted using a local number of the rows and columns. This version removes any duplicate columns in cols 744 745 Synopsis: 746 #include <petscmat.h> 747 PetscErrorCode MatPreallocateSetLocalRemoveDups(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 748 749 Not Collective 750 751 Input Parameters: 752 + map - the row mapping from local numbering to global numbering 753 . nrows - the number of rows indicated 754 . rows - the indices of the rows (these values are mapped to the global values) 755 . cmap - the column mapping from local to global numbering 756 . ncols - the number of columns in the matrix (this value will be changed if duplicate columns are found) 757 . cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed) 758 . dnz - the array that will be passed to the matrix preallocation routines 759 - onz - the other array passed to the matrix preallocation routines 760 761 Level: intermediate 762 763 Notes: 764 See Users-Manual: ch_performance for more details. 765 766 Do not malloc or free dnz and onz, that is handled internally by these routines 767 768 Concepts: preallocation^Matrix 769 770 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 771 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal() 772 M*/ 773 #define MatPreallocateSetLocalRemoveDups(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \ 774 {\ 775 PetscInt __l;\ 776 _4_ierr = ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\ 777 _4_ierr = ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\ 778 _4_ierr = PetscSortRemoveDupsInt(&ncols,cols);CHKERRQ(_4_ierr);\ 779 for (__l=0;__l<nrows;__l++) {\ 780 _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 781 }\ 782 } 783 784 /*MC 785 MatPreallocateSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 786 inserted using a local number of the rows and columns 787 788 Synopsis: 789 #include <petscmat.h> 790 PetscErrorCode MatPreallocateSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 791 792 Not Collective 793 794 Input Parameters: 795 + map - the row mapping from local numbering to global numbering 796 . nrows - the number of rows indicated 797 . rows - the indices of the rows 798 . cmap - the column mapping from local to global numbering 799 . ncols - the number of columns in the matrix 800 . cols - the columns indicated 801 . dnz - the array that will be passed to the matrix preallocation routines 802 - onz - the other array passed to the matrix preallocation routines 803 804 Level: intermediate 805 806 Notes: 807 See Users-Manual: ch_performance for more details. 808 809 Do not malloc or free dnz and onz, that is handled internally by these routines 810 811 Concepts: preallocation^Matrix 812 813 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 814 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock() 815 M*/ 816 #define MatPreallocateSetLocalBlock(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \ 817 {\ 818 PetscInt __l;\ 819 _4_ierr = ISLocalToGlobalMappingApplyBlock(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\ 820 _4_ierr = ISLocalToGlobalMappingApplyBlock(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\ 821 for (__l=0;__l<nrows;__l++) {\ 822 _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 823 }\ 824 } 825 826 /*MC 827 MatPreallocateSymmetricSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 828 inserted using a local number of the rows and columns 829 830 Synopsis: 831 #include <petscmat.h> 832 PetscErrorCode MatPreallocateSymmetricSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 833 834 Not Collective 835 836 Input Parameters: 837 + map - the mapping between local numbering and global numbering 838 . nrows - the number of rows indicated 839 . rows - the indices of the rows 840 . ncols - the number of columns in the matrix 841 . cols - the columns indicated 842 . dnz - the array that will be passed to the matrix preallocation routines 843 - onz - the other array passed to the matrix preallocation routines 844 845 Level: intermediate 846 847 Notes: 848 See Users-Manual: ch_performance for more details. 849 850 Do not malloc or free dnz and onz that is handled internally by these routines 851 852 Concepts: preallocation^Matrix 853 854 .seealso: MatPreallocateFinalize(), MatPreallocateSet() 855 MatPreallocateInitialize(), MatPreallocateSetLocal() 856 M*/ 857 #define MatPreallocateSymmetricSetLocalBlock(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 858 {\ 859 PetscInt __l;\ 860 _4_ierr = ISLocalToGlobalMappingApplyBlock(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 861 _4_ierr = ISLocalToGlobalMappingApplyBlock(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 862 for (__l=0;__l<nrows;__l++) {\ 863 _4_ierr = MatPreallocateSymmetricSetBlock((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 864 }\ 865 } 866 /*MC 867 MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 868 inserted using a local number of the rows and columns 869 870 Synopsis: 871 #include <petscmat.h> 872 PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 873 874 Not Collective 875 876 Input Parameters: 877 + row - the row 878 . ncols - the number of columns in the matrix 879 - cols - the columns indicated 880 881 Output Parameters: 882 + dnz - the array that will be passed to the matrix preallocation routines 883 - onz - the other array passed to the matrix preallocation routines 884 885 Level: intermediate 886 887 Notes: 888 See Users-Manual: ch_performance for more details. 889 890 Do not malloc or free dnz and onz that is handled internally by these routines 891 892 This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize(). 893 894 Concepts: preallocation^Matrix 895 896 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock() 897 MatPreallocateInitialize(), MatPreallocateSetLocal() 898 M*/ 899 #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\ 900 { PetscInt __i; \ 901 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);\ 902 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);\ 903 for (__i=0; __i<nc; __i++) {\ 904 if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \ 905 else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\ 906 }\ 907 } 908 909 /*MC 910 MatPreallocateSymmetricSetBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be 911 inserted using a local number of the rows and columns 912 913 Synopsis: 914 #include <petscmat.h> 915 PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 916 917 Not Collective 918 919 Input Parameters: 920 + nrows - the number of rows indicated 921 . rows - the indices of the rows 922 . ncols - the number of columns in the matrix 923 . cols - the columns indicated 924 . dnz - the array that will be passed to the matrix preallocation routines 925 - onz - the other array passed to the matrix preallocation routines 926 927 Level: intermediate 928 929 Notes: 930 See Users-Manual: ch_performance for more details. 931 932 Do not malloc or free dnz and onz that is handled internally by these routines 933 934 This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize(). 935 936 Concepts: preallocation^Matrix 937 938 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateInitialize(), 939 MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal() 940 M*/ 941 #define MatPreallocateSymmetricSetBlock(row,nc,cols,dnz,onz) 0;\ 942 { PetscInt __i; \ 943 for (__i=0; __i<nc; __i++) {\ 944 if (cols[__i] >= __end) onz[row - __rstart]++; \ 945 else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\ 946 }\ 947 } 948 949 /*MC 950 MatPreallocateLocation - An alternative to MatPreallocateSet() that puts the nonzero locations into the matrix if it exists 951 952 Synopsis: 953 #include <petscmat.h> 954 PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz) 955 956 Not Collective 957 958 Input Parameters: 959 . A - matrix 960 . row - row where values exist (must be local to this process) 961 . ncols - number of columns 962 . cols - columns with nonzeros 963 . dnz - the array that will be passed to the matrix preallocation routines 964 - onz - the other array passed to the matrix preallocation routines 965 966 Level: intermediate 967 968 Notes: 969 See Users-Manual: ch_performance for more details. 970 971 Do not malloc or free dnz and onz that is handled internally by these routines 972 973 This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines. 974 975 Concepts: preallocation^Matrix 976 977 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(), 978 MatPreallocateSymmetricSetLocalBlock() 979 M*/ 980 #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);} 981 982 983 /*MC 984 MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per 985 row in a matrix providing the data that one can use to correctly preallocate the matrix. 986 987 Synopsis: 988 #include <petscmat.h> 989 PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz) 990 991 Collective on MPI_Comm 992 993 Input Parameters: 994 + dnz - the array that was be passed to the matrix preallocation routines 995 - onz - the other array passed to the matrix preallocation routines 996 997 Level: intermediate 998 999 Notes: 1000 See Users-Manual: ch_performance for more details. 1001 1002 Do not malloc or free dnz and onz that is handled internally by these routines 1003 1004 This is a MACRO not a function because it closes the { started in MatPreallocateInitialize(). 1005 1006 Concepts: preallocation^Matrix 1007 1008 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(), 1009 MatPreallocateSymmetricSetLocalBlock() 1010 M*/ 1011 #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);} 1012 1013 /* Routines unique to particular data structures */ 1014 PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat,void *); 1015 1016 PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*); 1017 PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *); 1018 1019 PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]); 1020 PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]); 1021 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1022 PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1023 PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1024 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool); 1025 1026 #define MAT_SKIP_ALLOCATION -4 1027 1028 PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1029 PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1030 PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]); 1031 1032 PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1033 PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1034 PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1035 PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []); 1036 PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1037 PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]); 1038 PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1039 PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]); 1040 PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat,Mat*); 1041 PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 1042 PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 1043 PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 1044 PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 1045 PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*); 1046 1047 PETSC_EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt); 1048 PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*); 1049 1050 PETSC_EXTERN PetscErrorCode MatStoreValues(Mat); 1051 PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat); 1052 1053 PETSC_EXTERN PetscErrorCode MatDAADSetCtx(Mat,void*); 1054 1055 PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*); 1056 PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat,IS*); 1057 /* 1058 These routines are not usually accessed directly, rather solving is 1059 done through the KSP and PC interfaces. 1060 */ 1061 1062 /*J 1063 MatOrderingType - String with the name of a PETSc matrix ordering 1064 1065 Level: beginner 1066 1067 .seealso: MatGetOrdering() 1068 J*/ 1069 typedef const char* MatOrderingType; 1070 #define MATORDERINGNATURAL "natural" 1071 #define MATORDERINGND "nd" 1072 #define MATORDERING1WD "1wd" 1073 #define MATORDERINGRCM "rcm" 1074 #define MATORDERINGQMD "qmd" 1075 #define MATORDERINGROWLENGTH "rowlength" 1076 #define MATORDERINGWBM "wbm" 1077 #define MATORDERINGSPECTRAL "spectral" 1078 #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */ 1079 1080 PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*); 1081 PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*); 1082 PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*)); 1083 PETSC_EXTERN PetscFunctionList MatOrderingList; 1084 1085 PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 1086 PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*); 1087 1088 /*S 1089 MatFactorShiftType - Numeric Shift. 1090 1091 Level: beginner 1092 1093 S*/ 1094 typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType; 1095 PETSC_EXTERN const char *const MatFactorShiftTypes[]; 1096 PETSC_EXTERN const char *const MatFactorShiftTypesDetail[]; 1097 1098 /*S 1099 MatFactorError - indicates what type of error in matrix factor 1100 1101 Level: beginner 1102 1103 Developer Notes: 1104 Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 1105 1106 .seealso: MatGetFactor() 1107 S*/ 1108 typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError; 1109 1110 PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*); 1111 PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat); 1112 PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*); 1113 1114 /*S 1115 MatFactorInfo - Data passed into the matrix factorization routines, and information about the resulting factorization 1116 1117 In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use 1118 $ MatFactorInfo info(MAT_FACTORINFO_SIZE) 1119 1120 Notes: 1121 These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 1122 1123 You can use MatFactorInfoInitialize() to set default values. 1124 1125 Level: developer 1126 1127 .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(), 1128 MatFactorInfoInitialize() 1129 1130 S*/ 1131 typedef struct { 1132 PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 1133 PetscReal usedt; 1134 PetscReal dt; /* drop tolerance */ 1135 PetscReal dtcol; /* tolerance for pivoting */ 1136 PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 1137 PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */ 1138 PetscReal levels; /* ICC/ILU(levels) */ 1139 PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 1140 factorization may be faster if do not pivot */ 1141 PetscReal zeropivot; /* pivot is called zero if less than this */ 1142 PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */ 1143 PetscReal shiftamount; /* how large the shift is */ 1144 } MatFactorInfo; 1145 1146 PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*); 1147 PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*); 1148 PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 1149 PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*); 1150 PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*); 1151 PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*); 1152 PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 1153 PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 1154 PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 1155 PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*); 1156 PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*); 1157 PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 1158 PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec); 1159 PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec); 1160 PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec); 1161 PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec); 1162 PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec); 1163 PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 1164 PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs); 1165 PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat); 1166 1167 typedef enum {MAT_FACTOR_SCHUR_UNFACTORED, MAT_FACTOR_SCHUR_FACTORED, MAT_FACTOR_SCHUR_INVERTED} MatFactorSchurStatus; 1168 PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat,IS); 1169 PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat,Mat*,MatFactorSchurStatus*); 1170 PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat,Mat*,MatFactorSchurStatus); 1171 PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat); 1172 PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat,Mat*,MatFactorSchurStatus*); 1173 PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat,Vec,Vec); 1174 PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat,Vec,Vec); 1175 PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat); 1176 1177 /*E 1178 MatSORType - What type of (S)SOR to perform 1179 1180 Level: beginner 1181 1182 May be bitwise ORd together 1183 1184 Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 1185 1186 MatSORType may be bitwise ORd together, so do not change the numbers 1187 1188 .seealso: MatSOR() 1189 E*/ 1190 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 1191 SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 1192 SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 1193 SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 1194 PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 1195 1196 /* 1197 These routines are for efficiently computing Jacobians via finite differences. 1198 */ 1199 1200 /*S 1201 MatColoring - Object for managing the coloring of matrices. 1202 1203 Level: beginner 1204 1205 Concepts: matrix, coloring 1206 1207 .seealso: MatFDColoringCreate() ISColoring MatFDColoring 1208 S*/ 1209 typedef struct _p_MatColoring* MatColoring; 1210 /*J 1211 MatColoringType - String with the name of a PETSc matrix coloring 1212 1213 Level: beginner 1214 1215 .seealso: MatColoringSetType(), MatColoring 1216 J*/ 1217 1218 typedef const char* MatColoringType; 1219 #define MATCOLORINGJP "jp" 1220 #define MATCOLORINGPOWER "power" 1221 #define MATCOLORINGNATURAL "natural" 1222 #define MATCOLORINGSL "sl" 1223 #define MATCOLORINGLF "lf" 1224 #define MATCOLORINGID "id" 1225 #define MATCOLORINGGREEDY "greedy" 1226 1227 /*E 1228 MatColoringWeightType - Type of weight scheme 1229 1230 Not Collective 1231 1232 + MAT_COLORING_RANDOM - Random weights 1233 . MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering. 1234 - MAT_COLORING_LF - Last-first weighting. 1235 1236 Level: intermediate 1237 1238 Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 1239 E*/ 1240 typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType; 1241 1242 PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*); 1243 PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*); 1244 PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*); 1245 PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer); 1246 PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType); 1247 PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring); 1248 PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt); 1249 PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*); 1250 PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt); 1251 PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*); 1252 PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*); 1253 PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring)); 1254 PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 1255 PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType); 1256 PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*); 1257 PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm); 1258 PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring,ISColoring); 1259 PETSC_DEPRECATED("Use MatColoringTest()") PETSC_STATIC_INLINE PetscErrorCode MatColoringTestValid(MatColoring matcoloring,ISColoring iscoloring) {return MatColoringTest(matcoloring,iscoloring);} 1260 PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat,ISColoring); 1261 1262 /*S 1263 MatFDColoring - Object for computing a sparse Jacobian via finite differences 1264 and coloring 1265 1266 Level: beginner 1267 1268 Concepts: coloring, sparse Jacobian, finite differences 1269 1270 .seealso: MatFDColoringCreate() 1271 S*/ 1272 typedef struct _p_MatFDColoring* MatFDColoring; 1273 1274 PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 1275 PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*); 1276 PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer); 1277 PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 1278 PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**); 1279 PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1280 PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring); 1281 PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *); 1282 PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec); 1283 PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,const PetscInt*[]); 1284 PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring); 1285 PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt); 1286 1287 1288 /*S 1289 MatTransposeColoring - Object for computing a sparse matrix product C=A*B^T via coloring 1290 1291 Level: beginner 1292 1293 Concepts: coloring, sparse matrix product 1294 1295 .seealso: MatTransposeColoringCreate() 1296 S*/ 1297 typedef struct _p_MatTransposeColoring* MatTransposeColoring; 1298 1299 PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *); 1300 PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat); 1301 PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat); 1302 PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*); 1303 1304 /* 1305 These routines are for partitioning matrices: currently used only 1306 for adjacency matrix, MatCreateMPIAdj(). 1307 */ 1308 1309 /*S 1310 MatPartitioning - Object for managing the partitioning of a matrix or graph 1311 1312 Level: beginner 1313 1314 Concepts: partitioning 1315 1316 .seealso: MatPartitioningCreate(), MatPartitioningType 1317 S*/ 1318 typedef struct _p_MatPartitioning* MatPartitioning; 1319 1320 /*J 1321 MatPartitioningType - String with the name of a PETSc matrix partitioning 1322 1323 Level: beginner 1324 dm 1325 .seealso: MatPartitioningCreate(), MatPartitioning 1326 J*/ 1327 typedef const char* MatPartitioningType; 1328 #define MATPARTITIONINGCURRENT "current" 1329 #define MATPARTITIONINGAVERAGE "average" 1330 #define MATPARTITIONINGSQUARE "square" 1331 #define MATPARTITIONINGPARMETIS "parmetis" 1332 #define MATPARTITIONINGCHACO "chaco" 1333 #define MATPARTITIONINGPARTY "party" 1334 #define MATPARTITIONINGPTSCOTCH "ptscotch" 1335 #define MATPARTITIONINGHIERARCH "hierarch" 1336 1337 1338 PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*); 1339 PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType); 1340 PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt); 1341 PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat); 1342 PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1343 PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1344 PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*); 1345 PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*); 1346 1347 PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],PetscErrorCode (*)(MatPartitioning)); 1348 1349 1350 1351 PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer); 1352 PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning); 1353 PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*); 1354 1355 PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part); 1356 PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 1357 PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *); 1358 1359 typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType; 1360 PETSC_EXTERN const char *const MPChacoGlobalTypes[]; 1361 typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType; 1362 PETSC_EXTERN const char *const MPChacoLocalTypes[]; 1363 typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType; 1364 PETSC_EXTERN const char *const MPChacoEigenTypes[]; 1365 1366 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType); 1367 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*); 1368 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType); 1369 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*); 1370 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 1371 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1372 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*); 1373 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal); 1374 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*); 1375 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt); 1376 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*); 1377 1378 #define MP_PARTY_OPT "opt" 1379 #define MP_PARTY_LIN "lin" 1380 #define MP_PARTY_SCA "sca" 1381 #define MP_PARTY_RAN "ran" 1382 #define MP_PARTY_GBF "gbf" 1383 #define MP_PARTY_GCF "gcf" 1384 #define MP_PARTY_BUB "bub" 1385 #define MP_PARTY_DEF "def" 1386 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*); 1387 #define MP_PARTY_HELPFUL_SETS "hs" 1388 #define MP_PARTY_KERNIGHAN_LIN "kl" 1389 #define MP_PARTY_NONE "no" 1390 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*); 1391 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1392 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool); 1393 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool); 1394 1395 typedef enum { MP_PTSCOTCH_DEFAULT,MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType; 1396 PETSC_EXTERN const char *const MPPTScotchStrategyTypes[]; 1397 1398 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal); 1399 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*); 1400 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType); 1401 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*); 1402 1403 /* 1404 * hierarchical partitioning 1405 */ 1406 PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*); 1407 PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*); 1408 PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt); 1409 PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt); 1410 1411 PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*); 1412 PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*); 1413 1414 /* 1415 If you add entries here you must also add them to petsc/finclude/petscmat.h 1416 */ 1417 typedef enum { MATOP_SET_VALUES=0, 1418 MATOP_GET_ROW=1, 1419 MATOP_RESTORE_ROW=2, 1420 MATOP_MULT=3, 1421 MATOP_MULT_ADD=4, 1422 MATOP_MULT_TRANSPOSE=5, 1423 MATOP_MULT_TRANSPOSE_ADD=6, 1424 MATOP_SOLVE=7, 1425 MATOP_SOLVE_ADD=8, 1426 MATOP_SOLVE_TRANSPOSE=9, 1427 MATOP_SOLVE_TRANSPOSE_ADD=10, 1428 MATOP_LUFACTOR=11, 1429 MATOP_CHOLESKYFACTOR=12, 1430 MATOP_SOR=13, 1431 MATOP_TRANSPOSE=14, 1432 MATOP_GETINFO=15, 1433 MATOP_EQUAL=16, 1434 MATOP_GET_DIAGONAL=17, 1435 MATOP_DIAGONAL_SCALE=18, 1436 MATOP_NORM=19, 1437 MATOP_ASSEMBLY_BEGIN=20, 1438 MATOP_ASSEMBLY_END=21, 1439 MATOP_SET_OPTION=22, 1440 MATOP_ZERO_ENTRIES=23, 1441 MATOP_ZERO_ROWS=24, 1442 MATOP_LUFACTOR_SYMBOLIC=25, 1443 MATOP_LUFACTOR_NUMERIC=26, 1444 MATOP_CHOLESKY_FACTOR_SYMBOLIC=27, 1445 MATOP_CHOLESKY_FACTOR_NUMERIC=28, 1446 MATOP_SETUP_PREALLOCATION=29, 1447 MATOP_ILUFACTOR_SYMBOLIC=30, 1448 MATOP_ICCFACTOR_SYMBOLIC=31, 1449 MATOP_GET_DIAGONAL_BLOCK=32, 1450 /* MATOP_PLACEHOLDER_33=33, */ 1451 MATOP_DUPLICATE=34, 1452 MATOP_FORWARD_SOLVE=35, 1453 MATOP_BACKWARD_SOLVE=36, 1454 MATOP_ILUFACTOR=37, 1455 MATOP_ICCFACTOR=38, 1456 MATOP_AXPY=39, 1457 MATOP_CREATE_SUBMATRICES=40, 1458 MATOP_INCREASE_OVERLAP=41, 1459 MATOP_GET_VALUES=42, 1460 MATOP_COPY=43, 1461 MATOP_GET_ROW_MAX=44, 1462 MATOP_SCALE=45, 1463 MATOP_SHIFT=46, 1464 MATOP_DIAGONAL_SET=47, 1465 MATOP_ZERO_ROWS_COLUMNS=48, 1466 MATOP_SET_RANDOM=49, 1467 MATOP_GET_ROW_IJ=50, 1468 MATOP_RESTORE_ROW_IJ=51, 1469 MATOP_GET_COLUMN_IJ=52, 1470 MATOP_RESTORE_COLUMN_IJ=53, 1471 MATOP_FDCOLORING_CREATE=54, 1472 MATOP_COLORING_PATCH=55, 1473 MATOP_SET_UNFACTORED=56, 1474 MATOP_PERMUTE=57, 1475 MATOP_SET_VALUES_BLOCKED=58, 1476 MATOP_CREATE_SUBMATRIX=59, 1477 MATOP_DESTROY=60, 1478 MATOP_VIEW=61, 1479 MATOP_CONVERT_FROM=62, 1480 MATOP_MATMAT_MULT=63, 1481 MATOP_MATMAT_MULT_SYMBOLIC=64, 1482 MATOP_MATMAT_MULT_NUMERIC=65, 1483 MATOP_SET_LOCAL_TO_GLOBAL_MAP=66, 1484 MATOP_SET_VALUES_LOCAL=67, 1485 MATOP_ZERO_ROWS_LOCAL=68, 1486 MATOP_GET_ROW_MAX_ABS=69, 1487 MATOP_GET_ROW_MIN_ABS=70, 1488 MATOP_CONVERT=71, 1489 MATOP_SET_COLORING=72, 1490 /* MATOP_PLACEHOLDER_73=73, */ 1491 MATOP_SET_VALUES_ADIFOR=74, 1492 MATOP_FD_COLORING_APPLY=75, 1493 MATOP_SET_FROM_OPTIONS=76, 1494 MATOP_MULT_CONSTRAINED=77, 1495 MATOP_MULT_TRANSPOSE_CONSTRAIN=78, 1496 MATOP_FIND_ZERO_DIAGONALS=79, 1497 MATOP_MULT_MULTIPLE=80, 1498 MATOP_SOLVE_MULTIPLE=81, 1499 MATOP_GET_INERTIA=82, 1500 MATOP_LOAD=83, 1501 MATOP_IS_SYMMETRIC=84, 1502 MATOP_IS_HERMITIAN=85, 1503 MATOP_IS_STRUCTURALLY_SYMMETRIC=86, 1504 MATOP_SET_VALUES_BLOCKEDLOCAL=87, 1505 MATOP_CREATE_VECS=88, 1506 MATOP_MAT_MULT=89, 1507 MATOP_MAT_MULT_SYMBOLIC=90, 1508 MATOP_MAT_MULT_NUMERIC=91, 1509 MATOP_PTAP=92, 1510 MATOP_PTAP_SYMBOLIC=93, 1511 MATOP_PTAP_NUMERIC=94, 1512 MATOP_MAT_TRANSPOSE_MULT=95, 1513 MATOP_MAT_TRANSPOSE_MULT_SYMBO=96, 1514 MATOP_MAT_TRANSPOSE_MULT_NUMER=97, 1515 /* MATOP_PLACEHOLDER_98=98, */ 1516 /* MATOP_PLACEHOLDER_99=99, */ 1517 /* MATOP_PLACEHOLDER_100=100, */ 1518 /* MATOP_PLACEHOLDER_101=101, */ 1519 MATOP_CONJUGATE=102, 1520 /* MATOP_PLACEHOLDER_103=103, */ 1521 MATOP_SET_VALUES_ROW=104, 1522 MATOP_REAL_PART=105, 1523 MATOP_IMAGINARY_PART=106, 1524 MATOP_GET_ROW_UPPER_TRIANGULAR=107, 1525 MATOP_RESTORE_ROW_UPPER_TRIANG=108, 1526 MATOP_MAT_SOLVE=109, 1527 MATOP_MAT_SOLVE_TRANSPOSE=110, 1528 MATOP_GET_ROW_MIN=111, 1529 MATOP_GET_COLUMN_VECTOR=112, 1530 MATOP_MISSING_DIAGONAL=113, 1531 MATOP_GET_SEQ_NONZERO_STRUCTUR=114, 1532 MATOP_CREATE=115, 1533 MATOP_GET_GHOSTS=116, 1534 MATOP_GET_LOCAL_SUB_MATRIX=117, 1535 MATOP_RESTORE_LOCALSUB_MATRIX=118, 1536 MATOP_MULT_DIAGONAL_BLOCK=119, 1537 MATOP_HERMITIAN_TRANSPOSE=120, 1538 MATOP_MULT_HERMITIAN_TRANSPOSE=121, 1539 MATOP_MULT_HERMITIAN_TRANS_ADD=122, 1540 MATOP_GET_MULTI_PROC_BLOCK=123, 1541 MATOP_FIND_NONZERO_ROWS=124, 1542 MATOP_GET_COLUMN_NORMS=125, 1543 MATOP_INVERT_BLOCK_DIAGONAL=126, 1544 /* MATOP_PLACEHOLDER_127=127, */ 1545 MATOP_CREATE_SUB_MATRICES_MPI=128, 1546 MATOP_SET_VALUES_BATCH=129, 1547 MATOP_TRANSPOSE_MAT_MULT=130, 1548 MATOP_TRANSPOSE_MAT_MULT_SYMBO=131, 1549 MATOP_TRANSPOSE_MAT_MULT_NUMER=132, 1550 MATOP_TRANSPOSE_COLORING_CREAT=133, 1551 MATOP_TRANS_COLORING_APPLY_SPT=134, 1552 MATOP_TRANS_COLORING_APPLY_DEN=135, 1553 MATOP_RART=136, 1554 MATOP_RART_SYMBOLIC=137, 1555 MATOP_RART_NUMERIC=138, 1556 MATOP_SET_BLOCK_SIZES=139, 1557 MATOP_AYPX=140, 1558 MATOP_RESIDUAL=141, 1559 MATOP_FDCOLORING_SETUP=142, 1560 MATOP_MPICONCATENATESEQ=144, 1561 MATOP_DESTROYSUBMATRICES=145 1562 } MatOperation; 1563 PETSC_EXTERN PetscErrorCode MatSetOperation(Mat,MatOperation,void(*)(void)); 1564 PETSC_EXTERN PetscErrorCode MatGetOperation(Mat,MatOperation,void(**)(void)); 1565 PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool *); 1566 1567 PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1568 PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1569 PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*); 1570 PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*); 1571 PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*); 1572 PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat); 1573 1574 /* 1575 Codes for matrices stored on disk. By default they are 1576 stored in a universal format. By changing the format with 1577 PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will 1578 be stored in a way natural for the matrix, for example dense matrices 1579 would be stored as dense. Matrices stored this way may only be 1580 read into matrices of the same type. 1581 */ 1582 #define MATRIX_BINARY_FORMAT_DENSE -1 1583 1584 PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 1585 1586 PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1587 PETSC_EXTERN PetscErrorCode MatISSetUpSF(Mat); 1588 PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat,PetscBool); 1589 PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*); 1590 PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*); 1591 PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat); 1592 PETSC_EXTERN PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*); 1593 1594 /*S 1595 MatNullSpace - Object that removes a null space from a vector, i.e. 1596 orthogonalizes the vector to a subsapce 1597 1598 Level: advanced 1599 1600 Concepts: matrix; linear operator, null space 1601 1602 Users manual sections: 1603 . sec_singular 1604 1605 .seealso: MatNullSpaceCreate() 1606 S*/ 1607 typedef struct _p_MatNullSpace* MatNullSpace; 1608 1609 PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*); 1610 PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*); 1611 PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*); 1612 PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec); 1613 PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *); 1614 PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *); 1615 PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat,MatNullSpace); 1616 PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace); 1617 PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace); 1618 PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*); 1619 PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool *); 1620 PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer); 1621 PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**); 1622 PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*); 1623 1624 PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS); 1625 PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1626 PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 1627 PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat); 1628 1629 PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*); 1630 PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*); 1631 PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*); 1632 1633 PETSC_EXTERN PetscErrorCode MatComputeExplicitOperator(Mat,Mat*); 1634 PETSC_EXTERN PetscErrorCode MatComputeExplicitOperatorTranspose(Mat,Mat*); 1635 1636 PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec); 1637 1638 PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 1639 PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec); 1640 PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*); 1641 PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*)); 1642 PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec)); 1643 PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt); 1644 PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat); 1645 PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal); 1646 PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt); 1647 PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *); 1648 PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]); 1649 PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*); 1650 PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*); 1651 1652 /*S 1653 MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free 1654 Jacobian vector products 1655 1656 Notes: 1657 MATMFFD is a specific MatType which uses the MatMFFD data structure 1658 1659 MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure 1660 1661 Level: developer 1662 1663 .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister() 1664 S*/ 1665 typedef struct _p_MatMFFD* MatMFFD; 1666 1667 /*J 1668 MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function 1669 1670 Level: beginner 1671 1672 .seealso: MatMFFDSetType(), MatMFFDRegister() 1673 J*/ 1674 typedef const char* MatMFFDType; 1675 #define MATMFFD_DS "ds" 1676 #define MATMFFD_WP "wp" 1677 1678 PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat,MatMFFDType); 1679 PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[],PetscErrorCode (*)(MatMFFD)); 1680 1681 PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal); 1682 PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool ); 1683 1684 PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType); 1685 1686 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1687 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 1688 1689 /* 1690 PETSc interface to MUMPS 1691 */ 1692 #ifdef PETSC_HAVE_MUMPS 1693 PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt); 1694 PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*); 1695 PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal); 1696 PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*); 1697 1698 PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*); 1699 PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*); 1700 PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*); 1701 PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*); 1702 PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat,Mat); 1703 #endif 1704 1705 /* 1706 PETSc interface to Mkl_Pardiso 1707 */ 1708 #ifdef PETSC_HAVE_MKL_PARDISO 1709 PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt); 1710 #endif 1711 1712 /* 1713 PETSc interface to Mkl_CPardiso 1714 */ 1715 #ifdef PETSC_HAVE_MKL_CPARDISO 1716 PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt); 1717 #endif 1718 1719 /* 1720 PETSc interface to SUPERLU 1721 */ 1722 #ifdef PETSC_HAVE_SUPERLU 1723 PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal); 1724 #endif 1725 1726 /* 1727 PETSc interface to SUPERLU_DIST 1728 */ 1729 #ifdef PETSC_HAVE_SUPERLU_DIST 1730 PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*); 1731 #endif 1732 1733 /* 1734 PETSc interface to STRUMPACK 1735 */ 1736 #ifdef PETSC_HAVE_STRUMPACK 1737 /*E 1738 MatSTRUMPACKReordering - sparsity reducing ordering to be used in STRUMPACK 1739 1740 Level: intermediate 1741 E*/ 1742 typedef enum {MAT_STRUMPACK_NATURAL=0, 1743 MAT_STRUMPACK_METIS=1, 1744 MAT_STRUMPACK_PARMETIS=2, 1745 MAT_STRUMPACK_SCOTCH=3, 1746 MAT_STRUMPACK_PTSCOTCH=4, 1747 MAT_STRUMPACK_RCM=5} MatSTRUMPACKReordering; 1748 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat,MatSTRUMPACKReordering); 1749 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat,PetscBool); 1750 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSRelTol(Mat,PetscReal); 1751 PETSC_DEPRECATED ("Use MatSTRUMPACKSetHSSRelTol()") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSRelCompTol(Mat mat,PetscReal rtol) {return MatSTRUMPACKSetHSSRelTol(mat,rtol);} 1752 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSAbsTol(Mat,PetscReal); 1753 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMinSepSize(Mat,PetscInt); 1754 PETSC_DEPRECATED ("Use MatSTRUMPACKSetHSSMinSepSize()") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSMinSize(Mat mat,PetscInt hssminsize) {return MatSTRUMPACKSetHSSMinSepSize(mat,hssminsize);} 1755 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMaxRank(Mat,PetscInt); 1756 PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSLeafSize(Mat,PetscInt); 1757 #endif 1758 1759 1760 #ifdef PETSC_HAVE_CUDA 1761 /*E 1762 MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU) 1763 matrices. 1764 1765 Not Collective 1766 1767 + MAT_CUSPARSE_CSR - Compressed Sparse Row 1768 . MAT_CUSPARSE_ELL - Ellpack (requires CUDA 4.2 or later). 1769 - MAT_CUSPARSE_HYB - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later). 1770 1771 Level: intermediate 1772 1773 Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h 1774 1775 .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation 1776 E*/ 1777 1778 typedef enum {MAT_CUSPARSE_CSR, MAT_CUSPARSE_ELL, MAT_CUSPARSE_HYB} MatCUSPARSEStorageFormat; 1779 1780 /* these will be strings associated with enumerated type defined above */ 1781 PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[]; 1782 1783 /*E 1784 MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU) 1785 matrices whose operation should use a particular storage format. 1786 1787 Not Collective 1788 1789 + MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult 1790 . MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult 1791 . MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult 1792 - MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices 1793 1794 Level: intermediate 1795 1796 .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat 1797 E*/ 1798 typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation; 1799 1800 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 1801 PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 1802 PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat); 1803 #endif 1804 1805 #if defined(PETSC_HAVE_VIENNACL) 1806 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 1807 PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 1808 #endif 1809 1810 /* 1811 PETSc interface to FFTW 1812 */ 1813 #if defined(PETSC_HAVE_FFTW) 1814 PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec); 1815 PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec); 1816 PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*); 1817 #endif 1818 1819 PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*); 1820 PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*); 1821 PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]); 1822 PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]); 1823 PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***); 1824 PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*); 1825 PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType); 1826 PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]); 1827 PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat); 1828 1829 PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal); 1830 PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*); 1831 1832 PETSC_EXTERN PetscErrorCode MatSubdomainsCreateCoalesce(Mat,PetscInt,PetscInt*,IS**); 1833 1834 PETSC_EXTERN PetscErrorCode MatPreallocatorPreallocate(Mat,PetscBool,Mat); 1835 1836 PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*); 1837 PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*); 1838 1839 #endif 1840