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