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