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