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