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