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