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