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