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