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