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