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