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