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