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