1 /* $Id: mat.h,v 1.79 1995/12/15 23:15:18 curfman Exp bsmith $ */ 2 /* 3 Include file for the matrix component of PETSc 4 */ 5 #ifndef __MAT_PACKAGE 6 #define __MAT_PACKAGE 7 #include "vec.h" 8 9 #define MAT_COOKIE PETSC_COOKIE+5 10 #define MAT_SCATTER_COOKIE PETSC_COOKIE+15 11 12 typedef struct _Mat* Mat; 13 typedef struct _MatScatterCtx* MatScatterCtx; 14 15 typedef enum { MATSAME=-1, MATSEQDENSE, MATSEQAIJ, MATMPIAIJ, MATSHELL, 16 MATSEQROW, MATMPIROW, MATMPIROWBS, MATSEQBDIAG, MATMPIBDIAG, 17 MATMPIDENSE } MatType; 18 19 extern int MatCreateSeqDense(MPI_Comm,int,int,Scalar*,Mat*); 20 extern int MatCreateMPIDense(MPI_Comm,int,int,int,int,Scalar*,Mat*); 21 extern int MatCreateSeqAIJ(MPI_Comm,int,int,int,int*,Mat*); 22 extern int MatCreateMPIAIJ(MPI_Comm,int,int,int,int,int,int*,int,int*,Mat*); 23 extern int MatCreateSeqRow(MPI_Comm,int,int,int,int*,Mat*); 24 extern int MatCreateMPIRow(MPI_Comm,int,int,int,int,int,int*,int,int*,Mat*); 25 extern int MatCreateMPIRowbs(MPI_Comm,int,int,int,int*,void*,Mat*); 26 extern int MatCreateSeqBDiag(MPI_Comm,int,int,int,int,int*,Scalar**,Mat*); 27 extern int MatCreateMPIBDiag(MPI_Comm,int,int,int,int,int,int*,Scalar**,Mat*); 28 29 extern int MatShellCreate(MPI_Comm,int,int,void *,Mat*); 30 extern int MatShellGetContext(Mat,void **); 31 extern int MatShellSetMult(Mat,int (*)(void*,Vec,Vec)); 32 extern int MatShellSetDestroy(Mat,int (*)(void*)); 33 extern int MatShellSetMultTrans(Mat,int (*)(void*,Vec,Vec)); 34 extern int MatShellSetMultTransAdd(Mat,int (*)(void*,Vec,Vec,Vec)); 35 36 /* ------------------------------------------------------------*/ 37 extern int MatValidMatrix(Mat); 38 39 typedef enum {FLUSH_ASSEMBLY=1,FINAL_ASSEMBLY=0} MatAssemblyType; 40 41 extern int MatSetValues(Mat,int,int*,int,int*,Scalar*,InsertMode); 42 extern int MatAssemblyBegin(Mat,MatAssemblyType); 43 extern int MatAssemblyEnd(Mat,MatAssemblyType); 44 45 typedef enum {ROW_ORIENTED=1,COLUMN_ORIENTED=2,ROWS_SORTED=4, 46 COLUMNS_SORTED=8,NO_NEW_NONZERO_LOCATIONS=16, 47 YES_NEW_NONZERO_LOCATIONS=32,SYMMETRIC_MATRIX=64, 48 STRUCTURALLY_SYMMETRIC_MATRIX,NO_NEW_DIAGONALS, 49 YES_NEW_DIAGONALS,INODE_LIMIT_1,INODE_LIMIT_2, 50 INODE_LIMIT_3,INODE_LIMIT_4,INODE_LIMIT_5} MatOption; 51 52 extern int MatSetOption(Mat,MatOption); 53 extern int MatGetType(Mat,MatType*); 54 extern int MatGetName(Mat,char**); 55 extern int MatGetFormatFromOptions(MPI_Comm,char*,MatType*,int*); 56 extern int MatGetValues(Mat,int,int*,int,int*,Scalar*); 57 extern int MatGetRow(Mat,int,int *,int **,Scalar**); 58 extern int MatRestoreRow(Mat,int,int *,int **,Scalar**); 59 extern int MatGetCol(Mat,int,int *,int **,Scalar**); 60 extern int MatRestoreCol(Mat,int,int *,int **,Scalar**); 61 extern int MatGetArray(Mat,Scalar **); 62 extern int MatMult(Mat,Vec,Vec); 63 extern int MatMultAdd(Mat,Vec,Vec,Vec); 64 extern int MatMultTrans(Mat,Vec,Vec); 65 extern int MatMultTransAdd(Mat,Vec,Vec,Vec); 66 67 typedef enum {ORDER_NATURAL=0,ORDER_ND=1,ORDER_1WD=2, 68 ORDER_RCM=3,ORDER_QMD=4,ORDER_APPLICATION_1, 69 ORDER_APPLICATION_2} MatOrdering; 70 71 extern int MatGetReordering(Mat,MatOrdering,IS*,IS*); 72 extern int MatGetReorderingTypeFromOptions(char *,MatOrdering*); 73 extern int MatReorderForNonzeroDiagonal(Mat,double,IS,IS); 74 extern int MatReorderingRegister(MatOrdering,char*,int (*)(int*,int*,int*,int*,int*)); 75 extern int MatReorderingRegisterAll(); 76 extern int MatReorderingRegisterDestroy(); 77 78 extern int MatLUFactor(Mat,IS,IS,double); 79 extern int MatILUFactor(Mat,IS,IS,double,int); 80 extern int MatCholeskyFactor(Mat,IS,double); 81 extern int MatLUFactorSymbolic(Mat,IS,IS,double,Mat*); 82 extern int MatILUFactorSymbolic(Mat,IS,IS,double,int,Mat*); 83 extern int MatCholeskyFactorSymbolic(Mat,IS,double,Mat*); 84 extern int MatIncompleteCholeskyFactorSymbolic(Mat,IS,double,int,Mat*); 85 extern int MatLUFactorNumeric(Mat,Mat*); 86 extern int MatCholeskyFactorNumeric(Mat,Mat*); 87 88 extern int MatSolve(Mat,Vec,Vec); 89 extern int MatForwardSolve(Mat,Vec,Vec); 90 extern int MatBackwardSolve(Mat,Vec,Vec); 91 extern int MatSolveAdd(Mat,Vec,Vec,Vec); 92 extern int MatSolveTrans(Mat,Vec,Vec); 93 extern int MatSolveTransAdd(Mat,Vec,Vec,Vec); 94 95 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 96 SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 97 SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 98 SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128 99 } MatSORType; 100 101 extern int MatRelax(Mat,Vec,double,MatSORType,double,int,Vec); 102 103 extern int MatConvert(Mat,MatType,Mat*); 104 extern int MatView(Mat,Viewer); 105 extern int MatLoad(Viewer,MatType,Mat*); 106 107 typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 108 109 extern int MatGetInfo(Mat,MatInfoType,int*,int*,int*); 110 extern int MatGetDiagonal(Mat,Vec); 111 extern int MatTranspose(Mat,Mat*); 112 extern int MatScale(Mat,Vec,Vec); 113 extern int MatEqual(Mat,Mat); 114 extern int MatScatterBegin(Mat,Mat,InsertMode,MatScatterCtx); 115 extern int MatScatterEnd(Mat,Mat,InsertMode,MatScatterCtx); 116 extern int MatScatterCtxCreate(Mat,IS,IS,Mat,IS,IS,MatScatterCtx*); 117 extern int MatScatterCtxDestroy(MatScatterCtx); 118 119 extern int MatNorm(Mat,NormType,double *); 120 121 extern int MatZeroEntries(Mat); 122 extern int MatZeroRows(Mat,IS,Scalar*); 123 extern int MatZeroColumns(Mat,IS,Scalar*); 124 125 extern int MatDestroy(Mat); 126 127 extern int MatGetSize(Mat,int*,int*); 128 extern int MatGetLocalSize(Mat,int*,int*); 129 extern int MatGetOwnershipRange(Mat,int*,int*); 130 131 extern int MatCreate(MPI_Comm,int,int,Mat*); 132 133 typedef enum {MAT_INITIAL_MATRIX, MAT_REUSE_MATRIX} MatGetSubMatrixCall; 134 extern int MatGetSubMatrix(Mat,IS,IS,MatGetSubMatrixCall,Mat*); 135 extern int MatGetSubMatrixInPlace(Mat,IS,IS); 136 extern int MatGetSubMatrices(Mat,int,IS *,IS *,MatGetSubMatrixCall,Mat **); 137 extern int MatIncreaseOverlap(Mat,int,IS *,int); 138 139 extern int MatAXPY(Scalar *,Mat,Mat); 140 extern int MatCompress(Mat); 141 142 /* Routines unique to particular data structures */ 143 extern int MatBDiagGetData(Mat,int*,int*,int**,int**,Scalar***); 144 145 #endif 146 147 148 149