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