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