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