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