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