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