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