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