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