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