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