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