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