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