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