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