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(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 620 MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal() 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(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 660 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 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 MatPreallocateSymmetricSetLocal - 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 MatPreallocateSymmetricSetLocal(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 mapping between local numbering and global numbering 684 . nrows - the number of rows indicated 685 . rows - the indices of the rows 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 Level: intermediate 692 693 Notes: 694 See Users-Manual: ch_performance for more details. 695 696 Do not malloc or free dnz and onz that is handled internally by these routines 697 698 Concepts: preallocation^Matrix 699 700 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 701 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 702 M*/ 703 #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 704 {\ 705 PetscInt __l;\ 706 _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 707 _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 708 for (__l=0;__l<nrows;__l++) {\ 709 _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 710 }\ 711 } 712 713 /*MC 714 MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 715 inserted using a local number of the rows and columns 716 717 Synopsis: 718 #include <petscmat.h> 719 PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 720 721 Not Collective 722 723 Input Parameters: 724 + row - the row 725 . ncols - the number of columns in the matrix 726 - cols - the columns indicated 727 728 Output Parameters: 729 + dnz - the array that will be passed to the matrix preallocation routines 730 - ozn - the other array passed to the matrix preallocation routines 731 732 Level: intermediate 733 734 Notes: 735 See Users-Manual: ch_performance for more details. 736 737 Do not malloc or free dnz and onz that is handled internally by these routines 738 739 This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize(). 740 741 Concepts: preallocation^Matrix 742 743 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 744 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 745 M*/ 746 #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\ 747 { PetscInt __i; \ 748 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);\ 749 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);\ 750 for (__i=0; __i<nc; __i++) {\ 751 if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \ 752 else dnz[row - __rstart]++;\ 753 }\ 754 } 755 756 /*MC 757 MatPreallocateSymmetricSet - 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 MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 763 764 Not Collective 765 766 Input Parameters: 767 + nrows - the number of rows indicated 768 . rows - the indices of the rows 769 . ncols - the number of columns in the matrix 770 . cols - the columns indicated 771 . dnz - the array that will be passed to the matrix preallocation routines 772 - ozn - the other array passed to the matrix preallocation routines 773 774 Level: intermediate 775 776 Notes: 777 See Users-Manual: ch_performance for more details. 778 779 Do not malloc or free dnz and onz that is handled internally by these routines 780 781 This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize(). 782 783 Concepts: preallocation^Matrix 784 785 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 786 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 787 M*/ 788 #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\ 789 { PetscInt __i; \ 790 for (__i=0; __i<nc; __i++) {\ 791 if (cols[__i] >= __end) onz[row - __rstart]++; \ 792 else if (cols[__i] >= row) dnz[row - __rstart]++;\ 793 }\ 794 } 795 796 /*MC 797 MatPreallocateLocation - An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists 798 799 Synopsis: 800 #include <petscmat.h> 801 PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz) 802 803 Not Collective 804 805 Input Parameters: 806 . A - matrix 807 . row - row where values exist (must be local to this process) 808 . ncols - number of columns 809 . cols - columns with nonzeros 810 . dnz - the array that will be passed to the matrix preallocation routines 811 - ozn - the other array passed to the matrix preallocation routines 812 813 Level: intermediate 814 815 Notes: 816 See Users-Manual: ch_performance for more details. 817 818 Do not malloc or free dnz and onz that is handled internally by these routines 819 820 This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines. 821 822 Concepts: preallocation^Matrix 823 824 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 825 MatPreallocateSymmetricSetLocal() 826 M*/ 827 #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);} 828 829 830 /*MC 831 MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per 832 row in a matrix providing the data that one can use to correctly preallocate the matrix. 833 834 Synopsis: 835 #include <petscmat.h> 836 PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz) 837 838 Collective on MPI_Comm 839 840 Input Parameters: 841 + dnz - the array that was be passed to the matrix preallocation routines 842 - ozn - the other array passed to the matrix preallocation routines 843 844 Level: intermediate 845 846 Notes: 847 See Users-Manual: ch_performance for more details. 848 849 Do not malloc or free dnz and onz that is handled internally by these routines 850 851 This is a MACRO not a function because it closes the { started in MatPreallocateInitialize(). 852 853 Concepts: preallocation^Matrix 854 855 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 856 MatPreallocateSymmetricSetLocal() 857 M*/ 858 #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);} 859 860 /* Routines unique to particular data structures */ 861 PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat,void *); 862 863 PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*); 864 PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *); 865 866 PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]); 867 PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]); 868 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 869 PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 870 PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 871 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool); 872 873 #define MAT_SKIP_ALLOCATION -4 874 875 PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 876 PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 877 PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]); 878 879 PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 880 PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 881 PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 882 PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []); 883 PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 884 PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]); 885 PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 886 PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]); 887 PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 888 PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 889 PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 890 PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]); 891 PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*); 892 893 PETSC_EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt); 894 PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*); 895 896 PETSC_EXTERN PetscErrorCode MatStoreValues(Mat); 897 PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat); 898 899 PETSC_EXTERN PetscErrorCode MatDAADSetCtx(Mat,void*); 900 901 PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*); 902 /* 903 These routines are not usually accessed directly, rather solving is 904 done through the KSP and PC interfaces. 905 */ 906 907 /*J 908 MatOrderingType - String with the name of a PETSc matrix ordering 909 910 Level: beginner 911 912 .seealso: MatGetOrdering() 913 J*/ 914 typedef const char* MatOrderingType; 915 #define MATORDERINGNATURAL "natural" 916 #define MATORDERINGND "nd" 917 #define MATORDERING1WD "1wd" 918 #define MATORDERINGRCM "rcm" 919 #define MATORDERINGQMD "qmd" 920 #define MATORDERINGROWLENGTH "rowlength" 921 #define MATORDERINGWBM "wbm" 922 #define MATORDERINGSPECTRAL "spectral" 923 #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */ 924 925 PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*); 926 PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*); 927 PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*)); 928 PETSC_EXTERN PetscErrorCode MatOrderingRegisterAll(void); 929 PETSC_EXTERN PetscBool MatOrderingRegisterAllCalled; 930 PETSC_EXTERN PetscFunctionList MatOrderingList; 931 932 PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 933 PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*); 934 935 /*S 936 MatFactorShiftType - Numeric Shift. 937 938 Level: beginner 939 940 S*/ 941 typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType; 942 PETSC_EXTERN const char *const MatFactorShiftTypes[]; 943 PETSC_EXTERN const char *const MatFactorShiftTypesDetail[]; 944 945 /*S 946 MatFactorInfo - Data passed into the matrix factorization routines 947 948 In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use 949 $ MatFactorInfo info(MAT_FACTORINFO_SIZE) 950 951 Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 952 953 You can use MatFactorInfoInitialize() to set default values. 954 955 Level: developer 956 957 .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(), 958 MatFactorInfoInitialize() 959 960 S*/ 961 typedef struct { 962 PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 963 PetscReal usedt; 964 PetscReal dt; /* drop tolerance */ 965 PetscReal dtcol; /* tolerance for pivoting */ 966 PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 967 PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */ 968 PetscReal levels; /* ICC/ILU(levels) */ 969 PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 970 factorization may be faster if do not pivot */ 971 PetscReal zeropivot; /* pivot is called zero if less than this */ 972 PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */ 973 PetscReal shiftamount; /* how large the shift is */ 974 } MatFactorInfo; 975 976 PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*); 977 PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*); 978 PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 979 PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*); 980 PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*); 981 PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*); 982 PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 983 PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 984 PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 985 PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*); 986 PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*); 987 PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 988 PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec); 989 PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec); 990 PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec); 991 PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec); 992 PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec); 993 PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 994 PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs); 995 996 PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat); 997 998 /*E 999 MatSORType - What type of (S)SOR to perform 1000 1001 Level: beginner 1002 1003 May be bitwise ORd together 1004 1005 Any additions/changes here MUST also be made in include/finclude/petscmat.h 1006 1007 MatSORType may be bitwise ORd together, so do not change the numbers 1008 1009 .seealso: MatSOR() 1010 E*/ 1011 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 1012 SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 1013 SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 1014 SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 1015 PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 1016 1017 /* 1018 These routines are for efficiently computing Jacobians via finite differences. 1019 */ 1020 1021 /*S 1022 MatColoring - Object for managing the coloring of matrices. 1023 1024 Level: beginner 1025 1026 Concepts: matrix, coloring 1027 1028 .seealso: MatFDColoringCreate() ISColoring MatFDColoring 1029 S*/ 1030 typedef struct _p_MatColoring* MatColoring; 1031 /*J 1032 MatColoringType - String with the name of a PETSc matrix coloring 1033 1034 Level: beginner 1035 1036 .seealso: MatColoringSetType(), MatColoring 1037 J*/ 1038 1039 typedef const char* MatColoringType; 1040 #define MATCOLORINGJP "jp" 1041 #define MATCOLORINGNATURAL "natural" 1042 #define MATCOLORINGSL "sl" 1043 #define MATCOLORINGLF "lf" 1044 #define MATCOLORINGID "id" 1045 #define MATCOLORINGGREEDY "greedy" 1046 1047 /*E 1048 MatColoringWeightType - Type of weight scheme 1049 1050 Not Collective 1051 1052 + MAT_COLORING_RANDOM - Random weights 1053 . MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering. 1054 - MAT_COLORING_LF - Last-first weighting. 1055 1056 Level: intermediate 1057 1058 Any additions/changes here MUST also be made in include/finclude/petscmat.h 1059 1060 .seealso: MatCUSPSetFormat(), MatCUSPFormatOperation 1061 E*/ 1062 typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType; 1063 1064 PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*); 1065 PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*); 1066 PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*); 1067 PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer); 1068 PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType); 1069 PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring); 1070 PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt); 1071 PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*); 1072 PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt); 1073 PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*); 1074 PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*); 1075 PETSC_EXTERN PetscErrorCode MatColoringRegisterAll(void); 1076 PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring)); 1077 PETSC_EXTERN PetscBool MatColoringRegisterAllCalled; 1078 PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 1079 PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType); 1080 PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*); 1081 PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm); 1082 1083 /*S 1084 MatFDColoring - Object for computing a sparse Jacobian via finite differences 1085 and coloring 1086 1087 Level: beginner 1088 1089 Concepts: coloring, sparse Jacobian, finite differences 1090 1091 .seealso: MatFDColoringCreate() 1092 S*/ 1093 typedef struct _p_MatFDColoring* MatFDColoring; 1094 1095 PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 1096 PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*); 1097 PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer); 1098 PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 1099 PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**); 1100 PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1101 PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring); 1102 PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *); 1103 PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec); 1104 PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]); 1105 PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring); 1106 PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt); 1107 1108 1109 /*S 1110 MatTransposeColoring - Object for computing a sparse matrix product C=A*B^T via coloring 1111 1112 Level: beginner 1113 1114 Concepts: coloring, sparse matrix product 1115 1116 .seealso: MatTransposeColoringCreate() 1117 S*/ 1118 typedef struct _p_MatTransposeColoring* MatTransposeColoring; 1119 1120 PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *); 1121 PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat); 1122 PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat); 1123 PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*); 1124 1125 /* 1126 These routines are for partitioning matrices: currently used only 1127 for adjacency matrix, MatCreateMPIAdj(). 1128 */ 1129 1130 /*S 1131 MatPartitioning - Object for managing the partitioning of a matrix or graph 1132 1133 Level: beginner 1134 1135 Concepts: partitioning 1136 1137 .seealso: MatPartitioningCreate(), MatPartitioningType 1138 S*/ 1139 typedef struct _p_MatPartitioning* MatPartitioning; 1140 1141 /*J 1142 MatPartitioningType - String with the name of a PETSc matrix partitioning 1143 1144 Level: beginner 1145 dm 1146 .seealso: MatPartitioningCreate(), MatPartitioning 1147 J*/ 1148 typedef const char* MatPartitioningType; 1149 #define MATPARTITIONINGCURRENT "current" 1150 #define MATPARTITIONINGSQUARE "square" 1151 #define MATPARTITIONINGPARMETIS "parmetis" 1152 #define MATPARTITIONINGCHACO "chaco" 1153 #define MATPARTITIONINGPARTY "party" 1154 #define MATPARTITIONINGPTSCOTCH "ptscotch" 1155 1156 1157 PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*); 1158 PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType); 1159 PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt); 1160 PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat); 1161 PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1162 PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1163 PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*); 1164 PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*); 1165 1166 PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],PetscErrorCode (*)(MatPartitioning)); 1167 1168 PETSC_EXTERN PetscBool MatPartitioningRegisterAllCalled; 1169 1170 PETSC_EXTERN PetscErrorCode MatPartitioningRegisterAll(void); 1171 1172 PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer); 1173 PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning); 1174 PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*); 1175 1176 PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 1177 PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *); 1178 1179 typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType; 1180 PETSC_EXTERN const char *const MPChacoGlobalTypes[]; 1181 typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType; 1182 PETSC_EXTERN const char *const MPChacoLocalTypes[]; 1183 typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType; 1184 PETSC_EXTERN const char *const MPChacoEigenTypes[]; 1185 1186 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType); 1187 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*); 1188 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType); 1189 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*); 1190 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 1191 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1192 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*); 1193 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal); 1194 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*); 1195 PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt); 1196 PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*); 1197 1198 #define MP_PARTY_OPT "opt" 1199 #define MP_PARTY_LIN "lin" 1200 #define MP_PARTY_SCA "sca" 1201 #define MP_PARTY_RAN "ran" 1202 #define MP_PARTY_GBF "gbf" 1203 #define MP_PARTY_GCF "gcf" 1204 #define MP_PARTY_BUB "bub" 1205 #define MP_PARTY_DEF "def" 1206 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*); 1207 #define MP_PARTY_HELPFUL_SETS "hs" 1208 #define MP_PARTY_KERNIGHAN_LIN "kl" 1209 #define MP_PARTY_NONE "no" 1210 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*); 1211 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1212 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool); 1213 PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool); 1214 1215 typedef enum { MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType; 1216 PETSC_EXTERN const char *const MPPTScotchStrategyTypes[]; 1217 1218 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal); 1219 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*); 1220 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType); 1221 PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*); 1222 1223 /* 1224 These routines are for coarsening matrices: 1225 */ 1226 1227 /*S 1228 MatCoarsen - Object for managing the coarsening of a graph (symmetric matrix) 1229 1230 Level: beginner 1231 1232 Concepts: coarsen 1233 1234 .seealso: MatCoarsenCreate), MatCoarsenType 1235 S*/ 1236 typedef struct _p_MatCoarsen* MatCoarsen; 1237 1238 /*J 1239 MatCoarsenType - String with the name of a PETSc matrix coarsen 1240 1241 Level: beginner 1242 1243 .seealso: MatCoarsenCreate(), MatCoarsen 1244 J*/ 1245 typedef const char* MatCoarsenType; 1246 #define MATCOARSENMIS "mis" 1247 #define MATCOARSENHEM "hem" 1248 1249 /* linked list for aggregates */ 1250 typedef struct _PetscCDIntNd{ 1251 struct _PetscCDIntNd *next; 1252 PetscInt gid; 1253 }PetscCDIntNd; 1254 1255 /* only used by node pool */ 1256 typedef struct _PetscCDArrNd{ 1257 struct _PetscCDArrNd *next; 1258 struct _PetscCDIntNd *array; 1259 }PetscCDArrNd; 1260 1261 typedef struct _PetscCoarsenData{ 1262 PetscCDArrNd pool_list; /* node pool */ 1263 PetscCDIntNd *new_node; 1264 PetscInt new_left; 1265 PetscInt chk_sz; 1266 PetscCDIntNd *extra_nodes; 1267 PetscCDIntNd **array; /* Array of lists */ 1268 PetscInt size; 1269 Mat mat; /* cache a Mat for communication data */ 1270 }PetscCoarsenData; 1271 1272 PETSC_EXTERN PetscErrorCode MatCoarsenCreate(MPI_Comm,MatCoarsen*); 1273 PETSC_EXTERN PetscErrorCode MatCoarsenSetType(MatCoarsen,MatCoarsenType); 1274 PETSC_EXTERN PetscErrorCode MatCoarsenSetAdjacency(MatCoarsen,Mat); 1275 PETSC_EXTERN PetscErrorCode MatCoarsenSetGreedyOrdering(MatCoarsen,const IS); 1276 PETSC_EXTERN PetscErrorCode MatCoarsenSetStrictAggs(MatCoarsen,PetscBool); 1277 PETSC_EXTERN PetscErrorCode MatCoarsenSetVerbose(MatCoarsen,PetscInt); 1278 PETSC_EXTERN PetscErrorCode MatCoarsenGetData( MatCoarsen, PetscCoarsenData ** ); 1279 PETSC_EXTERN PetscErrorCode MatCoarsenApply(MatCoarsen); 1280 PETSC_EXTERN PetscErrorCode MatCoarsenDestroy(MatCoarsen*); 1281 1282 PETSC_EXTERN PetscErrorCode MatCoarsenRegister(const char[],PetscErrorCode (*)(MatCoarsen)); 1283 1284 PETSC_EXTERN PetscBool MatCoarsenRegisterAllCalled; 1285 1286 PETSC_EXTERN PetscErrorCode MatCoarsenRegisterAll(void); 1287 1288 PETSC_EXTERN PetscErrorCode MatCoarsenView(MatCoarsen,PetscViewer); 1289 PETSC_EXTERN PetscErrorCode MatCoarsenSetFromOptions(MatCoarsen); 1290 PETSC_EXTERN PetscErrorCode MatCoarsenGetType(MatCoarsen,MatCoarsenType*); 1291 PETSC_STATIC_INLINE PetscErrorCode MatCoarsenViewFromOptions(MatCoarsen A,const char prefix[],const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,prefix,name);} 1292 1293 PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*); 1294 PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*); 1295 1296 /* 1297 If you add entries here you must also add them to finclude/petscmat.h 1298 */ 1299 typedef enum { MATOP_SET_VALUES=0, 1300 MATOP_GET_ROW=1, 1301 MATOP_RESTORE_ROW=2, 1302 MATOP_MULT=3, 1303 MATOP_MULT_ADD=4, 1304 MATOP_MULT_TRANSPOSE=5, 1305 MATOP_MULT_TRANSPOSE_ADD=6, 1306 MATOP_SOLVE=7, 1307 MATOP_SOLVE_ADD=8, 1308 MATOP_SOLVE_TRANSPOSE=9, 1309 MATOP_SOLVE_TRANSPOSE_ADD=10, 1310 MATOP_LUFACTOR=11, 1311 MATOP_CHOLESKYFACTOR=12, 1312 MATOP_SOR=13, 1313 MATOP_TRANSPOSE=14, 1314 MATOP_GETINFO=15, 1315 MATOP_EQUAL=16, 1316 MATOP_GET_DIAGONAL=17, 1317 MATOP_DIAGONAL_SCALE=18, 1318 MATOP_NORM=19, 1319 MATOP_ASSEMBLY_BEGIN=20, 1320 MATOP_ASSEMBLY_END=21, 1321 MATOP_SET_OPTION=22, 1322 MATOP_ZERO_ENTRIES=23, 1323 MATOP_ZERO_ROWS=24, 1324 MATOP_LUFACTOR_SYMBOLIC=25, 1325 MATOP_LUFACTOR_NUMERIC=26, 1326 MATOP_CHOLESKY_FACTOR_SYMBOLIC=27, 1327 MATOP_CHOLESKY_FACTOR_NUMERIC=28, 1328 MATOP_SETUP_PREALLOCATION=29, 1329 MATOP_ILUFACTOR_SYMBOLIC=30, 1330 MATOP_ICCFACTOR_SYMBOLIC=31, 1331 /* MATOP_PLACEHOLDER_32=32, */ 1332 /* MATOP_PLACEHOLDER_33=33, */ 1333 MATOP_DUPLICATE=34, 1334 MATOP_FORWARD_SOLVE=35, 1335 MATOP_BACKWARD_SOLVE=36, 1336 MATOP_ILUFACTOR=37, 1337 MATOP_ICCFACTOR=38, 1338 MATOP_AXPY=39, 1339 MATOP_GET_SUBMATRICES=40, 1340 MATOP_INCREASE_OVERLAP=41, 1341 MATOP_GET_VALUES=42, 1342 MATOP_COPY=43, 1343 MATOP_GET_ROW_MAX=44, 1344 MATOP_SCALE=45, 1345 MATOP_SHIFT=46, 1346 MATOP_DIAGONAL_SET=47, 1347 MATOP_ZERO_ROWS_COLUMNS=48, 1348 MATOP_SET_RANDOM=49, 1349 MATOP_GET_ROW_IJ=50, 1350 MATOP_RESTORE_ROW_IJ=51, 1351 MATOP_GET_COLUMN_IJ=52, 1352 MATOP_RESTORE_COLUMN_IJ=53, 1353 MATOP_FDCOLORING_CREATE=54, 1354 MATOP_COLORING_PATCH=55, 1355 MATOP_SET_UNFACTORED=56, 1356 MATOP_PERMUTE=57, 1357 MATOP_SET_VALUES_BLOCKED=58, 1358 MATOP_GET_SUBMATRIX=59, 1359 MATOP_DESTROY=60, 1360 MATOP_VIEW=61, 1361 MATOP_CONVERT_FROM=62, 1362 MATOP_MATMAT_MULT=63, 1363 MATOP_MATMAT_MULT_SYMBOLIC=64, 1364 MATOP_MATMAT_MULT_NUMERIC=65, 1365 MATOP_SET_LOCAL_TO_GLOBAL_MAP=66, 1366 MATOP_SET_VALUES_LOCAL=67, 1367 MATOP_ZERO_ROWS_LOCAL=68, 1368 MATOP_GET_ROW_MAX_ABS=69, 1369 MATOP_GET_ROW_MIN_ABS=70, 1370 MATOP_CONVERT=71, 1371 MATOP_SET_COLORING=72, 1372 /* MATOP_PLACEHOLDER_73=73, */ 1373 MATOP_SET_VALUES_ADIFOR=74, 1374 MATOP_FD_COLORING_APPLY=75, 1375 MATOP_SET_FROM_OPTIONS=76, 1376 MATOP_MULT_CONSTRAINED=77, 1377 MATOP_MULT_TRANSPOSE_CONSTRAIN=78, 1378 MATOP_FIND_ZERO_DIAGONALS=79, 1379 MATOP_MULT_MULTIPLE=80, 1380 MATOP_SOLVE_MULTIPLE=81, 1381 MATOP_GET_INERTIA=82, 1382 MATOP_LOAD=83, 1383 MATOP_IS_SYMMETRIC=84, 1384 MATOP_IS_HERMITIAN=85, 1385 MATOP_IS_STRUCTURALLY_SYMMETRIC=86, 1386 MATOP_SET_VALUES_BLOCKEDLOCAL=87, 1387 MATOP_GET_VECS=88, 1388 MATOP_MAT_MULT=89, 1389 MATOP_MAT_MULT_SYMBOLIC=90, 1390 MATOP_MAT_MULT_NUMERIC=91, 1391 MATOP_PTAP=92, 1392 MATOP_PTAP_SYMBOLIC=93, 1393 MATOP_PTAP_NUMERIC=94, 1394 MATOP_MAT_TRANSPOSE_MULT=95, 1395 MATOP_MAT_TRANSPOSE_MULT_SYMBO=96, 1396 MATOP_MAT_TRANSPOSE_MULT_NUMER=97, 1397 /* MATOP_PLACEHOLDER_98=98, */ 1398 /* MATOP_PLACEHOLDER_99=99, */ 1399 /* MATOP_PLACEHOLDER_100=100, */ 1400 /* MATOP_PLACEHOLDER_101=101, */ 1401 MATOP_CONJUGATE=102, 1402 /* MATOP_PLACEHOLDER_103=103, */ 1403 MATOP_SET_VALUES_ROW=104, 1404 MATOP_REAL_PART=105, 1405 MATOP_IMAGINARY_PART=106, 1406 MATOP_GET_ROW_UPPER_TRIANGULAR=107, 1407 MATOP_RESTORE_ROW_UPPER_TRIANG=108, 1408 MATOP_MAT_SOLVE=109, 1409 MATOP_GET_REDUNDANT_MATRIX=110, 1410 MATOP_GET_ROW_MIN=111, 1411 MATOP_GET_COLUMN_VECTOR=112, 1412 MATOP_MISSING_DIAGONAL=113, 1413 MATOP_GET_SEQ_NONZERO_STRUCTUR=114, 1414 MATOP_CREATE=115, 1415 MATOP_GET_GHOSTS=116, 1416 MATOP_GET_LOCAL_SUB_MATRIX=117, 1417 MATOP_RESTORE_LOCALSUB_MATRIX=118, 1418 MATOP_MULT_DIAGONAL_BLOCK=119, 1419 MATOP_HERMITIAN_TRANSPOSE=120, 1420 MATOP_MULT_HERMITIAN_TRANSPOSE=121, 1421 MATOP_MULT_HERMITIAN_TRANS_ADD=122, 1422 MATOP_GET_MULTI_PROC_BLOCK=123, 1423 MATOP_FIND_NONZERO_ROWS=124, 1424 MATOP_GET_COLUMN_NORMS=125, 1425 MATOP_INVERT_BLOCK_DIAGONAL=126, 1426 /* MATOP_PLACEHOLDER_127=127, */ 1427 MATOP_GET_SUB_MATRICES_PARALLE=128, 1428 MATOP_SET_VALUES_BATCH=129, 1429 MATOP_TRANSPOSE_MAT_MULT=130, 1430 MATOP_TRANSPOSE_MAT_MULT_SYMBO=131, 1431 MATOP_TRANSPOSE_MAT_MULT_NUMER=132, 1432 MATOP_TRANSPOSE_COLORING_CREAT=133, 1433 MATOP_TRANS_COLORING_APPLY_SPT=134, 1434 MATOP_TRANS_COLORING_APPLY_DEN=135, 1435 MATOP_RART=136, 1436 MATOP_RART_SYMBOLIC=137, 1437 MATOP_RART_NUMERIC=138, 1438 MATOP_SET_BLOCK_SIZES=139, 1439 MATOP_AYPX=140, 1440 MATOP_RESIDUAL=141, 1441 MATOP_FDCOLORING_SETUP= 142 1442 } MatOperation; 1443 PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool *); 1444 PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1445 PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1446 PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*); 1447 1448 /* 1449 Codes for matrices stored on disk. By default they are 1450 stored in a universal format. By changing the format with 1451 PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will 1452 be stored in a way natural for the matrix, for example dense matrices 1453 would be stored as dense. Matrices stored this way may only be 1454 read into matrices of the same type. 1455 */ 1456 #define MATRIX_BINARY_FORMAT_DENSE -1 1457 1458 PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 1459 PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*); 1460 PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat); 1461 1462 /*S 1463 MatNullSpace - Object that removes a null space from a vector, i.e. 1464 orthogonalizes the vector to a subsapce 1465 1466 Level: advanced 1467 1468 Concepts: matrix; linear operator, null space 1469 1470 Users manual sections: 1471 . sec_singular 1472 1473 .seealso: MatNullSpaceCreate() 1474 S*/ 1475 typedef struct _p_MatNullSpace* MatNullSpace; 1476 1477 PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*); 1478 PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*); 1479 PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*); 1480 PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec); 1481 PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *); 1482 PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace); 1483 PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace); 1484 PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*); 1485 PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool *); 1486 PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer); 1487 PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**); 1488 PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*); 1489 1490 PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS); 1491 PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1492 PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 1493 PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat); 1494 1495 PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*); 1496 PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*); 1497 PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*); 1498 1499 PETSC_EXTERN PetscErrorCode MatComputeExplicitOperator(Mat,Mat*); 1500 1501 PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec); 1502 1503 PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 1504 PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec); 1505 PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*); 1506 PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*)); 1507 PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec)); 1508 PETSC_EXTERN PetscErrorCode MatMFFDAddNullSpace(Mat,MatNullSpace); 1509 PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt); 1510 PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat); 1511 PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal); 1512 PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt); 1513 PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *); 1514 PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]); 1515 PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*); 1516 PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*); 1517 1518 /*S 1519 MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free 1520 Jacobian vector products 1521 1522 Notes: MATMFFD is a specific MatType which uses the MatMFFD data structure 1523 1524 MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure 1525 1526 Level: developer 1527 1528 .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister() 1529 S*/ 1530 typedef struct _p_MatMFFD* MatMFFD; 1531 1532 /*J 1533 MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function 1534 1535 Level: beginner 1536 1537 .seealso: MatMFFDSetType(), MatMFFDRegister() 1538 J*/ 1539 typedef const char* MatMFFDType; 1540 #define MATMFFD_DS "ds" 1541 #define MATMFFD_WP "wp" 1542 1543 PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat,MatMFFDType); 1544 PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[],PetscErrorCode (*)(MatMFFD)); 1545 1546 PETSC_EXTERN PetscErrorCode MatMFFDRegisterAll(void); 1547 PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal); 1548 PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool ); 1549 1550 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1551 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 1552 1553 /* 1554 PETSc interface to MUMPS 1555 */ 1556 #ifdef PETSC_HAVE_MUMPS 1557 PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt); 1558 PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal); 1559 #endif 1560 1561 /* 1562 PETSc interface to SUPERLU 1563 */ 1564 #ifdef PETSC_HAVE_SUPERLU 1565 PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal); 1566 #endif 1567 1568 #ifdef PETSC_HAVE_CUDA 1569 /*E 1570 MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU) 1571 matrices. 1572 1573 Not Collective 1574 1575 + MAT_CUSPARSE_CSR - Compressed Sparse Row 1576 . MAT_CUSPARSE_ELL - Ellpack (requires CUDA 4.2 or later). 1577 - MAT_CUSPARSE_HYB - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later). 1578 1579 Level: intermediate 1580 1581 Any additions/changes here MUST also be made in include/finclude/petscmat.h 1582 1583 .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation 1584 E*/ 1585 1586 typedef enum {MAT_CUSPARSE_CSR, MAT_CUSPARSE_ELL, MAT_CUSPARSE_HYB} MatCUSPARSEStorageFormat; 1587 1588 /* these will be strings associated with enumerated type defined above */ 1589 PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[]; 1590 1591 /*E 1592 MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU) 1593 matrices whose operation should use a particular storage format. 1594 1595 Not Collective 1596 1597 + MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult 1598 . MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult 1599 . MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult 1600 - MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices 1601 1602 Level: intermediate 1603 1604 .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat 1605 E*/ 1606 typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation; 1607 1608 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 1609 PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 1610 PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat); 1611 #endif 1612 1613 #if defined(PETSC_HAVE_CUSP) 1614 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 1615 PETSC_EXTERN PetscErrorCode MatCreateAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 1616 1617 /*E 1618 MatCUSPStorageFormat - indicates the storage format for CUSP (GPU) 1619 matrices. 1620 1621 Not Collective 1622 1623 + MAT_CUSP_CSR - Compressed Sparse Row 1624 . MAT_CUSP_DIA - Diagonal 1625 - MAT_CUSP_ELL - Ellpack 1626 1627 Level: intermediate 1628 1629 Any additions/changes here MUST also be made in include/finclude/petscmat.h 1630 1631 .seealso: MatCUSPSetFormat(), MatCUSPFormatOperation 1632 E*/ 1633 typedef enum {MAT_CUSP_CSR, MAT_CUSP_DIA, MAT_CUSP_ELL} MatCUSPStorageFormat; 1634 1635 /* these will be strings associated with enumerated type defined above */ 1636 PETSC_EXTERN const char *const MatCUSPStorageFormats[]; 1637 1638 /*E 1639 MatCUSPFormatOperation - indicates the operation of CUSP (GPU) 1640 matrices whose operation should use a particular storage format. 1641 1642 Not Collective 1643 1644 + MAT_CUSP_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult 1645 . MAT_CUSP_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult 1646 . MAT_CUSP_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult 1647 - MAT_CUSP_ALL - sets the storage format for all CUSP (GPU) matrices 1648 1649 Level: intermediate 1650 1651 Any additions/changes here MUST also be made in include/finclude/petscmat.h 1652 1653 .seealso: MatCUSPSetFormat(), MatCUSPStorageFormat 1654 E*/ 1655 typedef enum {MAT_CUSP_MULT_DIAG, MAT_CUSP_MULT_OFFDIAG, MAT_CUSP_MULT, MAT_CUSP_ALL} MatCUSPFormatOperation; 1656 1657 PETSC_EXTERN PetscErrorCode MatCUSPSetFormat(Mat,MatCUSPFormatOperation,MatCUSPStorageFormat); 1658 #endif 1659 1660 #if defined(PETSC_HAVE_VIENNACL) 1661 PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 1662 PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 1663 #endif 1664 1665 /* 1666 PETSc interface to FFTW 1667 */ 1668 #if defined(PETSC_HAVE_FFTW) 1669 PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec); 1670 PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec); 1671 PETSC_EXTERN PetscErrorCode MatGetVecsFFTW(Mat,Vec*,Vec*,Vec*); 1672 #endif 1673 1674 #if defined(PETSC_HAVE_ELEMENTAL) 1675 PETSC_EXTERN PetscErrorCode PetscElementalInitializePackage(void); 1676 PETSC_EXTERN PetscErrorCode PetscElementalFinalizePackage(void); 1677 #endif 1678 1679 PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*); 1680 PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*); 1681 PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]); 1682 PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]); 1683 PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***); 1684 PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*); 1685 PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType); 1686 PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]); 1687 PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat); 1688 1689 PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal); 1690 PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*); 1691 1692 #endif 1693