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