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