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