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