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