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