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