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