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