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