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