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