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