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