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