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