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