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