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