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