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