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