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 = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \ 623 _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 624 _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr); __start = 0; __end = __start; \ 625 _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\ 626 _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows; 627 628 /*MC 629 MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 630 inserted using a local number of the rows and columns 631 632 Synopsis: 633 #include "petscmat.h" 634 PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 635 636 Not Collective 637 638 Input Parameters: 639 + map - the row mapping from local numbering to global numbering 640 . nrows - the number of rows indicated 641 . rows - the indices of the rows 642 . cmap - the column mapping from local to global numbering 643 . ncols - the number of columns in the matrix 644 . cols - the columns indicated 645 . dnz - the array that will be passed to the matrix preallocation routines 646 - ozn - the other array passed to the matrix preallocation routines 647 648 649 Level: intermediate 650 651 Notes: 652 See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details. 653 654 Do not malloc or free dnz and onz, that is handled internally by these routines 655 656 Concepts: preallocation^Matrix 657 658 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 659 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 660 M*/ 661 #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \ 662 {\ 663 PetscInt __l;\ 664 _4_ierr = ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\ 665 _4_ierr = ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\ 666 for (__l=0;__l<nrows;__l++) {\ 667 _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 668 }\ 669 } 670 671 /*MC 672 MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 673 inserted using a local number of the rows and columns 674 675 Synopsis: 676 #include "petscmat.h" 677 PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 678 679 Not Collective 680 681 Input Parameters: 682 + map - the mapping between local numbering and global numbering 683 . nrows - the number of rows indicated 684 . rows - the indices of the rows 685 . ncols - the number of columns in the matrix 686 . cols - the columns indicated 687 . dnz - the array that will be passed to the matrix preallocation routines 688 - ozn - the other array passed to the matrix preallocation routines 689 690 691 Level: intermediate 692 693 Notes: 694 See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details. 695 696 Do not malloc or free dnz and onz that is handled internally by these routines 697 698 Concepts: preallocation^Matrix 699 700 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 701 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 702 M*/ 703 #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 704 {\ 705 PetscInt __l;\ 706 _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 707 _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 708 for (__l=0;__l<nrows;__l++) {\ 709 _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 710 }\ 711 } 712 713 /*MC 714 MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 715 inserted using a local number of the rows and columns 716 717 Synopsis: 718 #include "petscmat.h" 719 PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 720 721 Not Collective 722 723 Input Parameters: 724 + row - the row 725 . ncols - the number of columns in the matrix 726 - cols - the columns indicated 727 728 Output Parameters: 729 + dnz - the array that will be passed to the matrix preallocation routines 730 - ozn - the other array passed to the matrix preallocation routines 731 732 733 Level: intermediate 734 735 Notes: 736 See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details. 737 738 Do not malloc or free dnz and onz that is handled internally by these routines 739 740 This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize(). 741 742 Concepts: preallocation^Matrix 743 744 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 745 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 746 M*/ 747 #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\ 748 { PetscInt __i; \ 749 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);\ 750 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);\ 751 for (__i=0; __i<nc; __i++) {\ 752 if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \ 753 else dnz[row - __rstart]++;\ 754 }\ 755 } 756 757 /*MC 758 MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 759 inserted using a local number of the rows and columns 760 761 Synopsis: 762 #include "petscmat.h" 763 PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 764 765 Not Collective 766 767 Input Parameters: 768 + nrows - the number of rows indicated 769 . rows - the indices of the rows 770 . ncols - the number of columns in the matrix 771 . cols - the columns indicated 772 . dnz - the array that will be passed to the matrix preallocation routines 773 - ozn - the other array passed to the matrix preallocation routines 774 775 776 Level: intermediate 777 778 Notes: 779 See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details. 780 781 Do not malloc or free dnz and onz that is handled internally by these routines 782 783 This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize(). 784 785 Concepts: preallocation^Matrix 786 787 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 788 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 789 M*/ 790 #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\ 791 { PetscInt __i; \ 792 for (__i=0; __i<nc; __i++) {\ 793 if (cols[__i] >= __end) onz[row - __rstart]++; \ 794 else if (cols[__i] >= row) dnz[row - __rstart]++;\ 795 }\ 796 } 797 798 /*MC 799 MatPreallocateLocation - An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists 800 801 Synopsis: 802 #include "petscmat.h" 803 PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz) 804 805 Not Collective 806 807 Input Parameters: 808 . A - matrix 809 . row - row where values exist (must be local to this process) 810 . ncols - number of columns 811 . cols - columns with nonzeros 812 . dnz - the array that will be passed to the matrix preallocation routines 813 - ozn - the other array passed to the matrix preallocation routines 814 815 816 Level: intermediate 817 818 Notes: 819 See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details. 820 821 Do not malloc or free dnz and onz that is handled internally by these routines 822 823 This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines. 824 825 Concepts: preallocation^Matrix 826 827 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 828 MatPreallocateSymmetricSetLocal() 829 M*/ 830 #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);} 831 832 833 /*MC 834 MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per 835 row in a matrix providing the data that one can use to correctly preallocate the matrix. 836 837 Synopsis: 838 #include "petscmat.h" 839 PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz) 840 841 Collective on MPI_Comm 842 843 Input Parameters: 844 + dnz - the array that was be passed to the matrix preallocation routines 845 - ozn - the other array passed to the matrix preallocation routines 846 847 848 Level: intermediate 849 850 Notes: 851 See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details. 852 853 Do not malloc or free dnz and onz that is handled internally by these routines 854 855 This is a MACRO not a function because it closes the { started in MatPreallocateInitialize(). 856 857 Concepts: preallocation^Matrix 858 859 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 860 MatPreallocateSymmetricSetLocal() 861 M*/ 862 #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);} 863 864 865 866 /* Routines unique to particular data structures */ 867 PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat,void *); 868 869 PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*); 870 PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *); 871 872 PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]); 873 PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]); 874 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 875 PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 876 PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 877 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool); 878 879 #define MAT_SKIP_ALLOCATION -4 880 881 PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 882 PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 883 PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]); 884 885 PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 886 PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 887 PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 888 PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []); 889 PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 890 PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]); 891 PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 892 PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]); 893 PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 894 PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 895 PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 896 PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 897 PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*); 898 899 PETSC_EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt); 900 PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*); 901 902 PETSC_EXTERN PetscErrorCode MatStoreValues(Mat); 903 PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat); 904 905 PETSC_EXTERN PetscErrorCode MatDAADSetCtx(Mat,void*); 906 907 PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*); 908 /* 909 These routines are not usually accessed directly, rather solving is 910 done through the KSP and PC interfaces. 911 */ 912 913 /*J 914 MatOrderingType - String with the name of a PETSc matrix ordering 915 916 Level: beginner 917 918 .seealso: MatGetOrdering() 919 J*/ 920 typedef const char* MatOrderingType; 921 #define MATORDERINGNATURAL "natural" 922 #define MATORDERINGND "nd" 923 #define MATORDERING1WD "1wd" 924 #define MATORDERINGRCM "rcm" 925 #define MATORDERINGQMD "qmd" 926 #define MATORDERINGROWLENGTH "rowlength" 927 #define MATORDERINGWBM "wbm" 928 #define MATORDERINGSPECTRAL "spectral" 929 #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */ 930 931 PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*); 932 PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*); 933 PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*)); 934 PETSC_EXTERN PetscErrorCode MatOrderingRegisterAll(void); 935 PETSC_EXTERN PetscBool MatOrderingRegisterAllCalled; 936 PETSC_EXTERN PetscFunctionList MatOrderingList; 937 938 PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 939 PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*); 940 941 /*S 942 MatFactorShiftType - Numeric Shift. 943 944 Level: beginner 945 946 S*/ 947 typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType; 948 PETSC_EXTERN const char *const MatFactorShiftTypes[]; 949 PETSC_EXTERN const char *const MatFactorShiftTypesDetail[]; 950 951 /*S 952 MatFactorInfo - Data passed into the matrix factorization routines 953 954 In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use 955 $ MatFactorInfo info(MAT_FACTORINFO_SIZE) 956 957 Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 958 959 You can use MatFactorInfoInitialize() to set default values. 960 961 Level: developer 962 963 .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(), 964 MatFactorInfoInitialize() 965 966 S*/ 967 typedef struct { 968 PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 969 PetscReal usedt; 970 PetscReal dt; /* drop tolerance */ 971 PetscReal dtcol; /* tolerance for pivoting */ 972 PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 973 PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */ 974 PetscReal levels; /* ICC/ILU(levels) */ 975 PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 976 factorization may be faster if do not pivot */ 977 PetscReal zeropivot; /* pivot is called zero if less than this */ 978 PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */ 979 PetscReal shiftamount; /* how large the shift is */ 980 } MatFactorInfo; 981 982 PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*); 983 PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*); 984 PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 985 PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*); 986 PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*); 987 PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*); 988 PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 989 PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 990 PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 991 PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*); 992 PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*); 993 PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 994 PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec); 995 PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec); 996 PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec); 997 PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec); 998 PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec); 999 PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 1000 PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs); 1001 1002 PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat); 1003 1004 /*E 1005 MatSORType - What type of (S)SOR to perform 1006 1007 Level: beginner 1008 1009 May be bitwise ORd together 1010 1011 Any additions/changes here MUST also be made in include/finclude/petscmat.h 1012 1013 MatSORType may be bitwise ORd together, so do not change the numbers 1014 1015 .seealso: MatSOR() 1016 E*/ 1017 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 1018 SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 1019 SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 1020 SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 1021 PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 1022 1023 /* 1024 These routines are for efficiently computing Jacobians via finite differences. 1025 */ 1026 1027 /*S 1028 MatColoring - Object for managing the coloring of matrices. 1029 1030 Level: beginner 1031 1032 Concepts: matrix, coloring 1033 1034 .seealso: MatFDColoringCreate() ISColoring MatFDColoring 1035 S*/ 1036 typedef struct _p_MatColoring* MatColoring; 1037 /*J 1038 MatColoringType - String with the name of a PETSc matrix coloring 1039 1040 Level: beginner 1041 1042 .seealso: MatColoringSetType(), MatColoring 1043 J*/ 1044 1045 typedef const char* MatColoringType; 1046 #define MATCOLORINGJP "jp" 1047 #define MATCOLORINGMIS "mis" 1048 #define MATCOLORINGNATURAL "natural" 1049 #define MATCOLORINGSL "sl" 1050 #define MATCOLORINGLF "lf" 1051 #define MATCOLORINGID "id" 1052 1053 PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*); 1054 PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*); 1055 PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer); 1056 PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType); 1057 PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring); 1058 PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt); 1059 PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*); 1060 PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt); 1061 PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*); 1062 PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*); 1063 PETSC_EXTERN PetscErrorCode MatColoringRegisterAll(void); 1064 PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring)); 1065 PETSC_EXTERN PetscBool MatColoringRegisterAllCalled; 1066 PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 1067 1068 /*S 1069 MatFDColoring - Object for computing a sparse Jacobian via finite differences 1070 and coloring 1071 1072 Level: beginner 1073 1074 Concepts: coloring, sparse Jacobian, finite differences 1075 1076 .seealso: MatFDColoringCreate() 1077 S*/ 1078 typedef struct _p_MatFDColoring* MatFDColoring; 1079 1080 PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 1081 PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*); 1082 PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer); 1083 PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 1084 PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**); 1085 PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1086 PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring); 1087 PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *); 1088 PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec); 1089 PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]); 1090 PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring); 1091 PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt); 1092 1093 1094 /*S 1095 MatTransposeColoring - Object for computing a sparse matrix product C=A*B^T via coloring 1096 1097 Level: beginner 1098 1099 Concepts: coloring, sparse matrix product 1100 1101 .seealso: MatTransposeColoringCreate() 1102 S*/ 1103 typedef struct _p_MatTransposeColoring* MatTransposeColoring; 1104 1105 PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *); 1106 PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat); 1107 PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat); 1108 PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*); 1109 1110 /* 1111 These routines are for partitioning matrices: currently used only 1112 for adjacency matrix, MatCreateMPIAdj(). 1113 */ 1114 1115 /*S 1116 MatPartitioning - Object for managing the partitioning of a matrix or graph 1117 1118 Level: beginner 1119 1120 Concepts: partitioning 1121 1122 .seealso: MatPartitioningCreate(), MatPartitioningType 1123 S*/ 1124 typedef struct _p_MatPartitioning* MatPartitioning; 1125 1126 /*J 1127 MatPartitioningType - String with the name of a PETSc matrix partitioning 1128 1129 Level: beginner 1130 dm 1131 .seealso: MatPartitioningCreate(), MatPartitioning 1132 J*/ 1133 typedef const char* MatPartitioningType; 1134 #define MATPARTITIONINGCURRENT "current" 1135 #define MATPARTITIONINGSQUARE "square" 1136 #define MATPARTITIONINGPARMETIS "parmetis" 1137 #define MATPARTITIONINGCHACO "chaco" 1138 #define MATPARTITIONINGPARTY "party" 1139 #define MATPARTITIONINGPTSCOTCH "ptscotch" 1140 1141 1142 PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*); 1143 PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType); 1144 PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt); 1145 PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat); 1146 PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1147 PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1148 PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*); 1149 PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*); 1150 1151 PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],PetscErrorCode (*)(MatPartitioning)); 1152 1153 PETSC_EXTERN PetscBool MatPartitioningRegisterAllCalled; 1154 1155 PETSC_EXTERN PetscErrorCode MatPartitioningRegisterAll(void); 1156 1157 PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer); 1158 PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning); 1159 PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*); 1160 1161 PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 1162 PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *); 1163 1164 typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType; 1165 PETSC_EXTERN const char *const MPChacoGlobalTypes[]; 1166 typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType; 1167 PETSC_EXTERN const char *const MPChacoLocalTypes[]; 1168 typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType; 1169 PETSC_EXTERN const char *const MPChacoEigenTypes[]; 1170 1171 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType); 1172 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*); 1173 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType); 1174 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*); 1175 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 1176 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1177 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*); 1178 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal); 1179 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*); 1180 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt); 1181 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*); 1182 1183 #define MP_PARTY_OPT "opt" 1184 #define MP_PARTY_LIN "lin" 1185 #define MP_PARTY_SCA "sca" 1186 #define MP_PARTY_RAN "ran" 1187 #define MP_PARTY_GBF "gbf" 1188 #define MP_PARTY_GCF "gcf" 1189 #define MP_PARTY_BUB "bub" 1190 #define MP_PARTY_DEF "def" 1191 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*); 1192 #define MP_PARTY_HELPFUL_SETS "hs" 1193 #define MP_PARTY_KERNIGHAN_LIN "kl" 1194 #define MP_PARTY_NONE "no" 1195 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*); 1196 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1197 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool); 1198 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool); 1199 1200 typedef enum { MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType; 1201 PETSC_EXTERN const char *const MPPTScotchStrategyTypes[]; 1202 1203 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal); 1204 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*); 1205 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType); 1206 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*); 1207 1208 /* 1209 These routines are for coarsening matrices: 1210 */ 1211 1212 /*S 1213 MatCoarsen - Object for managing the coarsening of a graph (symmetric matrix) 1214 1215 Level: beginner 1216 1217 Concepts: coarsen 1218 1219 .seealso: MatCoarsenCreate), MatCoarsenType 1220 S*/ 1221 typedef struct _p_MatCoarsen* MatCoarsen; 1222 1223 /*J 1224 MatCoarsenType - String with the name of a PETSc matrix coarsen 1225 1226 Level: beginner 1227 1228 .seealso: MatCoarsenCreate(), MatCoarsen 1229 J*/ 1230 typedef const char* MatCoarsenType; 1231 #define MATCOARSENMIS "mis" 1232 #define MATCOARSENHEM "hem" 1233 1234 /* linked list for aggregates */ 1235 typedef struct _PetscCDIntNd{ 1236 struct _PetscCDIntNd *next; 1237 PetscInt gid; 1238 }PetscCDIntNd; 1239 1240 /* only used by node pool */ 1241 typedef struct _PetscCDArrNd{ 1242 struct _PetscCDArrNd *next; 1243 struct _PetscCDIntNd *array; 1244 }PetscCDArrNd; 1245 1246 typedef struct _PetscCoarsenData{ 1247 PetscCDArrNd pool_list; /* node pool */ 1248 PetscCDIntNd *new_node; 1249 PetscInt new_left; 1250 PetscInt chk_sz; 1251 PetscCDIntNd *extra_nodes; 1252 PetscCDIntNd **array; /* Array of lists */ 1253 PetscInt size; 1254 Mat mat; /* cache a Mat for communication data */ 1255 }PetscCoarsenData; 1256 1257 PETSC_EXTERN PetscErrorCode MatCoarsenCreate(MPI_Comm,MatCoarsen*); 1258 PETSC_EXTERN PetscErrorCode MatCoarsenSetType(MatCoarsen,MatCoarsenType); 1259 PETSC_EXTERN PetscErrorCode MatCoarsenSetAdjacency(MatCoarsen,Mat); 1260 PETSC_EXTERN PetscErrorCode MatCoarsenSetGreedyOrdering(MatCoarsen,const IS); 1261 PETSC_EXTERN PetscErrorCode MatCoarsenSetStrictAggs(MatCoarsen,PetscBool); 1262 PETSC_EXTERN PetscErrorCode MatCoarsenSetVerbose(MatCoarsen,PetscInt); 1263 PETSC_EXTERN PetscErrorCode MatCoarsenGetData( MatCoarsen, PetscCoarsenData ** ); 1264 PETSC_EXTERN PetscErrorCode MatCoarsenApply(MatCoarsen); 1265 PETSC_EXTERN PetscErrorCode MatCoarsenDestroy(MatCoarsen*); 1266 1267 PETSC_EXTERN PetscErrorCode MatCoarsenRegister(const char[],PetscErrorCode (*)(MatCoarsen)); 1268 1269 PETSC_EXTERN PetscBool MatCoarsenRegisterAllCalled; 1270 1271 PETSC_EXTERN PetscErrorCode MatCoarsenRegisterAll(void); 1272 1273 PETSC_EXTERN PetscErrorCode MatCoarsenView(MatCoarsen,PetscViewer); 1274 PETSC_EXTERN PetscErrorCode MatCoarsenSetFromOptions(MatCoarsen); 1275 PETSC_EXTERN PetscErrorCode MatCoarsenGetType(MatCoarsen,MatCoarsenType*); 1276 1277 PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*); 1278 PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*); 1279 1280 /* 1281 If you add entries here you must also add them to finclude/petscmat.h 1282 */ 1283 typedef enum { MATOP_SET_VALUES=0, 1284 MATOP_GET_ROW=1, 1285 MATOP_RESTORE_ROW=2, 1286 MATOP_MULT=3, 1287 MATOP_MULT_ADD=4, 1288 MATOP_MULT_TRANSPOSE=5, 1289 MATOP_MULT_TRANSPOSE_ADD=6, 1290 MATOP_SOLVE=7, 1291 MATOP_SOLVE_ADD=8, 1292 MATOP_SOLVE_TRANSPOSE=9, 1293 MATOP_SOLVE_TRANSPOSE_ADD=10, 1294 MATOP_LUFACTOR=11, 1295 MATOP_CHOLESKYFACTOR=12, 1296 MATOP_SOR=13, 1297 MATOP_TRANSPOSE=14, 1298 MATOP_GETINFO=15, 1299 MATOP_EQUAL=16, 1300 MATOP_GET_DIAGONAL=17, 1301 MATOP_DIAGONAL_SCALE=18, 1302 MATOP_NORM=19, 1303 MATOP_ASSEMBLY_BEGIN=20, 1304 MATOP_ASSEMBLY_END=21, 1305 MATOP_SET_OPTION=22, 1306 MATOP_ZERO_ENTRIES=23, 1307 MATOP_ZERO_ROWS=24, 1308 MATOP_LUFACTOR_SYMBOLIC=25, 1309 MATOP_LUFACTOR_NUMERIC=26, 1310 MATOP_CHOLESKY_FACTOR_SYMBOLIC=27, 1311 MATOP_CHOLESKY_FACTOR_NUMERIC=28, 1312 MATOP_SETUP_PREALLOCATION=29, 1313 MATOP_ILUFACTOR_SYMBOLIC=30, 1314 MATOP_ICCFACTOR_SYMBOLIC=31, 1315 /* MATOP_PLACEHOLDER_32=32, */ 1316 /* MATOP_PLACEHOLDER_33=33, */ 1317 MATOP_DUPLICATE=34, 1318 MATOP_FORWARD_SOLVE=35, 1319 MATOP_BACKWARD_SOLVE=36, 1320 MATOP_ILUFACTOR=37, 1321 MATOP_ICCFACTOR=38, 1322 MATOP_AXPY=39, 1323 MATOP_GET_SUBMATRICES=40, 1324 MATOP_INCREASE_OVERLAP=41, 1325 MATOP_GET_VALUES=42, 1326 MATOP_COPY=43, 1327 MATOP_GET_ROW_MAX=44, 1328 MATOP_SCALE=45, 1329 MATOP_SHIFT=46, 1330 MATOP_DIAGONAL_SET=47, 1331 MATOP_ZERO_ROWS_COLUMNS=48, 1332 MATOP_SET_RANDOM=49, 1333 MATOP_GET_ROW_IJ=50, 1334 MATOP_RESTORE_ROW_IJ=51, 1335 MATOP_GET_COLUMN_IJ=52, 1336 MATOP_RESTORE_COLUMN_IJ=53, 1337 MATOP_FDCOLORING_CREATE=54, 1338 MATOP_COLORING_PATCH=55, 1339 MATOP_SET_UNFACTORED=56, 1340 MATOP_PERMUTE=57, 1341 MATOP_SET_VALUES_BLOCKED=58, 1342 MATOP_GET_SUBMATRIX=59, 1343 MATOP_DESTROY=60, 1344 MATOP_VIEW=61, 1345 MATOP_CONVERT_FROM=62, 1346 MATOP_MATMAT_MULT=63, 1347 MATOP_MATMAT_MULT_SYMBOLIC=64, 1348 MATOP_MATMAT_MULT_NUMERIC=65, 1349 MATOP_SET_LOCAL_TO_GLOBAL_MAP=66, 1350 MATOP_SET_VALUES_LOCAL=67, 1351 MATOP_ZERO_ROWS_LOCAL=68, 1352 MATOP_GET_ROW_MAX_ABS=69, 1353 MATOP_GET_ROW_MIN_ABS=70, 1354 MATOP_CONVERT=71, 1355 MATOP_SET_COLORING=72, 1356 /* MATOP_PLACEHOLDER_73=73, */ 1357 MATOP_SET_VALUES_ADIFOR=74, 1358 MATOP_FD_COLORING_APPLY=75, 1359 MATOP_SET_FROM_OPTIONS=76, 1360 MATOP_MULT_CONSTRAINED=77, 1361 MATOP_MULT_TRANSPOSE_CONSTRAIN=78, 1362 MATOP_FIND_ZERO_DIAGONALS=79, 1363 MATOP_MULT_MULTIPLE=80, 1364 MATOP_SOLVE_MULTIPLE=81, 1365 MATOP_GET_INERTIA=82, 1366 MATOP_LOAD=83, 1367 MATOP_IS_SYMMETRIC=84, 1368 MATOP_IS_HERMITIAN=85, 1369 MATOP_IS_STRUCTURALLY_SYMMETRIC=86, 1370 MATOP_SET_VALUES_BLOCKEDLOCAL=87, 1371 MATOP_GET_VECS=88, 1372 MATOP_MAT_MULT=89, 1373 MATOP_MAT_MULT_SYMBOLIC=90, 1374 MATOP_MAT_MULT_NUMERIC=91, 1375 MATOP_PTAP=92, 1376 MATOP_PTAP_SYMBOLIC=93, 1377 MATOP_PTAP_NUMERIC=94, 1378 MATOP_MAT_TRANSPOSE_MULT=95, 1379 MATOP_MAT_TRANSPOSE_MULT_SYMBO=96, 1380 MATOP_MAT_TRANSPOSE_MULT_NUMER=97, 1381 /* MATOP_PLACEHOLDER_98=98, */ 1382 /* MATOP_PLACEHOLDER_99=99, */ 1383 /* MATOP_PLACEHOLDER_100=100, */ 1384 /* MATOP_PLACEHOLDER_101=101, */ 1385 MATOP_CONJUGATE=102, 1386 /* MATOP_PLACEHOLDER_103=103, */ 1387 MATOP_SET_VALUES_ROW=104, 1388 MATOP_REAL_PART=105, 1389 MATOP_IMAGINARY_PART=106, 1390 MATOP_GET_ROW_UPPER_TRIANGULAR=107, 1391 MATOP_RESTORE_ROW_UPPER_TRIANG=108, 1392 MATOP_MAT_SOLVE=109, 1393 MATOP_GET_REDUNDANT_MATRIX=110, 1394 MATOP_GET_ROW_MIN=111, 1395 MATOP_GET_COLUMN_VECTOR=112, 1396 MATOP_MISSING_DIAGONAL=113, 1397 MATOP_GET_SEQ_NONZERO_STRUCTUR=114, 1398 MATOP_CREATE=115, 1399 MATOP_GET_GHOSTS=116, 1400 MATOP_GET_LOCAL_SUB_MATRIX=117, 1401 MATOP_RESTORE_LOCALSUB_MATRIX=118, 1402 MATOP_MULT_DIAGONAL_BLOCK=119, 1403 MATOP_HERMITIAN_TRANSPOSE=120, 1404 MATOP_MULT_HERMITIAN_TRANSPOSE=121, 1405 MATOP_MULT_HERMITIAN_TRANS_ADD=122, 1406 MATOP_GET_MULTI_PROC_BLOCK=123, 1407 MATOP_FIND_NONZERO_ROWS=124, 1408 MATOP_GET_COLUMN_NORMS=125, 1409 MATOP_INVERT_BLOCK_DIAGONAL=126, 1410 /* MATOP_PLACEHOLDER_127=127, */ 1411 MATOP_GET_SUB_MATRICES_PARALLE=128, 1412 MATOP_SET_VALUES_BATCH=129, 1413 MATOP_TRANSPOSE_MAT_MULT=130, 1414 MATOP_TRANSPOSE_MAT_MULT_SYMBO=131, 1415 MATOP_TRANSPOSE_MAT_MULT_NUMER=132, 1416 MATOP_TRANSPOSE_COLORING_CREAT=133, 1417 MATOP_TRANS_COLORING_APPLY_SPT=134, 1418 MATOP_TRANS_COLORING_APPLY_DEN=135, 1419 MATOP_RART=136, 1420 MATOP_RART_SYMBOLIC=137, 1421 MATOP_RART_NUMERIC=138, 1422 MATOP_SET_BLOCK_SIZES=139, 1423 MATOP_AYPX=140, 1424 MATOP_RESIDUAL=141, 1425 MATOP_FDCOLORING_SETUP= 142 1426 } MatOperation; 1427 PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool *); 1428 PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1429 PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1430 PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*); 1431 1432 /* 1433 Codes for matrices stored on disk. By default they are 1434 stored in a universal format. By changing the format with 1435 PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will 1436 be stored in a way natural for the matrix, for example dense matrices 1437 would be stored as dense. Matrices stored this way may only be 1438 read into matrices of the same type. 1439 */ 1440 #define MATRIX_BINARY_FORMAT_DENSE -1 1441 1442 PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 1443 PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*); 1444 PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat); 1445 1446 /*S 1447 MatNullSpace - Object that removes a null space from a vector, i.e. 1448 orthogonalizes the vector to a subsapce 1449 1450 Level: advanced 1451 1452 Concepts: matrix; linear operator, null space 1453 1454 Users manual sections: 1455 . sec_singular 1456 1457 .seealso: MatNullSpaceCreate() 1458 S*/ 1459 typedef struct _p_MatNullSpace* MatNullSpace; 1460 1461 PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*); 1462 PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*); 1463 PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*); 1464 PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec); 1465 PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *); 1466 PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace); 1467 PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace); 1468 PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*); 1469 PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool *); 1470 PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer); 1471 PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**); 1472 PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*); 1473 1474 PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS); 1475 PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1476 PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 1477 PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat); 1478 1479 PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*); 1480 PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*); 1481 PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*); 1482 1483 PETSC_EXTERN PetscErrorCode MatComputeExplicitOperator(Mat,Mat*); 1484 1485 PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec); 1486 1487 PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 1488 PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec); 1489 PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*); 1490 PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*)); 1491 PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec)); 1492 PETSC_EXTERN PetscErrorCode MatMFFDAddNullSpace(Mat,MatNullSpace); 1493 PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt); 1494 PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat); 1495 PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal); 1496 PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt); 1497 PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *); 1498 PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]); 1499 PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*); 1500 PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*); 1501 1502 /*S 1503 MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free 1504 Jacobian vector products 1505 1506 Notes: MATMFFD is a specific MatType which uses the MatMFFD data structure 1507 1508 MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure 1509 1510 Level: developer 1511 1512 .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister() 1513 S*/ 1514 typedef struct _p_MatMFFD* MatMFFD; 1515 1516 /*J 1517 MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function 1518 1519 Level: beginner 1520 1521 .seealso: MatMFFDSetType(), MatMFFDRegister() 1522 J*/ 1523 typedef const char* MatMFFDType; 1524 #define MATMFFD_DS "ds" 1525 #define MATMFFD_WP "wp" 1526 1527 PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat,MatMFFDType); 1528 PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[],PetscErrorCode (*)(MatMFFD)); 1529 1530 PETSC_EXTERN PetscErrorCode MatMFFDRegisterAll(void); 1531 PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal); 1532 PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool ); 1533 1534 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1535 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 1536 1537 /* 1538 PETSc interface to MUMPS 1539 */ 1540 #ifdef PETSC_HAVE_MUMPS 1541 PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt); 1542 PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal); 1543 #endif 1544 1545 /* 1546 PETSc interface to SUPERLU 1547 */ 1548 #ifdef PETSC_HAVE_SUPERLU 1549 PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal); 1550 #endif 1551 1552 #ifdef PETSC_HAVE_CUDA 1553 /*E 1554 MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU) 1555 matrices. 1556 1557 Not Collective 1558 1559 + MAT_CUSPARSE_CSR - Compressed Sparse Row 1560 . MAT_CUSPARSE_ELL - Ellpack (requires CUDA 4.2 or later). 1561 - MAT_CUSPARSE_HYB - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later). 1562 1563 Level: intermediate 1564 1565 Any additions/changes here MUST also be made in include/finclude/petscmat.h 1566 1567 .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation 1568 E*/ 1569 1570 typedef enum {MAT_CUSPARSE_CSR, MAT_CUSPARSE_ELL, MAT_CUSPARSE_HYB} MatCUSPARSEStorageFormat; 1571 1572 /* these will be strings associated with enumerated type defined above */ 1573 PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[]; 1574 1575 /*E 1576 MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU) 1577 matrices whose operation should use a particular storage format. 1578 1579 Not Collective 1580 1581 + MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult 1582 . MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult 1583 . MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult 1584 - MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices 1585 1586 Level: intermediate 1587 1588 .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat 1589 E*/ 1590 typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation; 1591 1592 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 1593 PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 1594 PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat); 1595 #endif 1596 1597 #if defined(PETSC_HAVE_CUSP) 1598 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 1599 PETSC_EXTERN PetscErrorCode MatCreateAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 1600 1601 /*E 1602 MatCUSPStorageFormat - indicates the storage format for CUSP (GPU) 1603 matrices. 1604 1605 Not Collective 1606 1607 + MAT_CUSP_CSR - Compressed Sparse Row 1608 . MAT_CUSP_DIA - Diagonal 1609 - MAT_CUSP_ELL - Ellpack 1610 1611 Level: intermediate 1612 1613 Any additions/changes here MUST also be made in include/finclude/petscmat.h 1614 1615 .seealso: MatCUSPSetFormat(), MatCUSPFormatOperation 1616 E*/ 1617 typedef enum {MAT_CUSP_CSR, MAT_CUSP_DIA, MAT_CUSP_ELL} MatCUSPStorageFormat; 1618 1619 /* these will be strings associated with enumerated type defined above */ 1620 PETSC_EXTERN const char *const MatCUSPStorageFormats[]; 1621 1622 /*E 1623 MatCUSPFormatOperation - indicates the operation of CUSP (GPU) 1624 matrices whose operation should use a particular storage format. 1625 1626 Not Collective 1627 1628 + MAT_CUSP_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult 1629 . MAT_CUSP_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult 1630 . MAT_CUSP_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult 1631 - MAT_CUSP_ALL - sets the storage format for all CUSP (GPU) matrices 1632 1633 Level: intermediate 1634 1635 Any additions/changes here MUST also be made in include/finclude/petscmat.h 1636 1637 .seealso: MatCUSPSetFormat(), MatCUSPStorageFormat 1638 E*/ 1639 typedef enum {MAT_CUSP_MULT_DIAG, MAT_CUSP_MULT_OFFDIAG, MAT_CUSP_MULT, MAT_CUSP_ALL} MatCUSPFormatOperation; 1640 1641 PETSC_EXTERN PetscErrorCode MatCUSPSetFormat(Mat,MatCUSPFormatOperation,MatCUSPStorageFormat); 1642 #endif 1643 1644 #if defined(PETSC_HAVE_VIENNACL) 1645 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 1646 PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 1647 #endif 1648 1649 /* 1650 PETSc interface to FFTW 1651 */ 1652 #if defined(PETSC_HAVE_FFTW) 1653 PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec); 1654 PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec); 1655 PETSC_EXTERN PetscErrorCode MatGetVecsFFTW(Mat,Vec*,Vec*,Vec*); 1656 #endif 1657 1658 #if defined(PETSC_HAVE_ELEMENTAL) 1659 PETSC_EXTERN PetscErrorCode PetscElementalInitializePackage(void); 1660 PETSC_EXTERN PetscErrorCode PetscElementalFinalizePackage(void); 1661 #endif 1662 1663 PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*); 1664 PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*); 1665 PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]); 1666 PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]); 1667 PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***); 1668 PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*); 1669 PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType); 1670 PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]); 1671 PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat); 1672 1673 PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal); 1674 PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*); 1675 1676 #endif 1677