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