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