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