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