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