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