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