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