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