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