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