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