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