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