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