1 /* $Id: mat.h,v 1.63 1995/09/22 23:05:48 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, MATSEQROW, 16 MATMPIROW, MATMPIROWBS, MATSEQBDIAG, MATMPIBDIAG } MatType; 17 18 extern int MatCreateSeqDense(MPI_Comm,int,int,Mat*); 19 extern int MatCreateSeqAIJ(MPI_Comm,int,int,int,int *,Mat*); 20 extern int MatCreateMPIAIJ(MPI_Comm,int,int,int,int,int,int*,int,int*,Mat*); 21 extern int MatCreateSeqRow(MPI_Comm,int,int,int,int *,Mat*); 22 extern int MatCreateMPIRow(MPI_Comm,int,int,int,int,int,int*,int,int*,Mat*); 23 extern int MatCreateMPIRowbs(MPI_Comm,int,int,int,int*,void*,Mat*); 24 extern int MatCreateSeqBDiag(MPI_Comm,int,int,int,int,int*, 25 Scalar**,Mat*); 26 extern int MatCreateMPIBDiag(MPI_Comm,int,int,int,int,int,int*, 27 Scalar**,Mat*); 28 29 extern int MatShellCreate(MPI_Comm,int,int,void *,Mat*); 30 extern int MatShellSetMult(Mat,int (*)(void*,Vec,Vec)); 31 extern int MatShellSetDestroy(Mat,int (*)(void*)); 32 extern int MatShellSetMultTrans(Mat,int (*)(void*,Vec,Vec)); 33 extern int MatShellSetMultTransAdd(Mat,int (*)(void*,Vec,Vec,Vec)); 34 35 /* ------------------------------------------------------------*/ 36 extern int MatValidMatrix(Mat); 37 38 typedef enum {FLUSH_ASSEMBLY=1,FINAL_ASSEMBLY=0} MatAssemblyType; 39 40 extern int MatSetValues(Mat,int,int*,int,int*,Scalar*,InsertMode); 41 extern int MatAssemblyBegin(Mat,MatAssemblyType); 42 extern int MatAssemblyEnd(Mat,MatAssemblyType); 43 44 typedef enum {ROW_ORIENTED=1,COLUMN_ORIENTED=2,ROWS_SORTED=4, 45 COLUMNS_SORTED=8,NO_NEW_NONZERO_LOCATIONS=16, 46 YES_NEW_NONZERO_LOCATIONS=32,SYMMETRIC_MATRIX=64} MatOption; 47 48 extern int MatSetOption(Mat,MatOption); 49 extern int MatGetType(Mat,MatType*); 50 extern int MatGetName(Mat,char**); 51 extern int MatGetFormatFromOptions(MPI_Comm,MatType*,int*); 52 extern int MatGetValues(Mat,int,int*,int,int*,Scalar*); 53 extern int MatGetRow(Mat,int,int *,int **,Scalar**); 54 extern int MatRestoreRow(Mat,int,int *,int **,Scalar**); 55 extern int MatGetCol(Mat,int,int *,int **,Scalar**); 56 extern int MatRestoreCol(Mat,int,int *,int **,Scalar**); 57 extern int MatGetArray(Mat,Scalar **); 58 extern int MatMult(Mat,Vec,Vec); 59 extern int MatMultAdd(Mat,Vec,Vec,Vec); 60 extern int MatMultTrans(Mat,Vec,Vec); 61 extern int MatMultTransAdd(Mat,Vec,Vec,Vec); 62 63 typedef enum {ORDER_NATURAL=0,ORDER_ND=1,ORDER_1WD=2, 64 ORDER_RCM=3,ORDER_QMD=4,ORDER_APPLICATION_1, 65 ORDER_APPLICATION_2} MatOrdering; 66 67 extern int MatGetReordering(Mat,MatOrdering,IS*,IS*); 68 extern int MatReorderForNonzeroDiagonal(Mat,double,IS,IS); 69 extern int MatReorderingRegister(MatOrdering,char*, 70 int (*)(int*,int*,int*,int*,int*)); 71 extern int MatReorderingRegisterAll(); 72 extern int MatReorderingRegisterDestroy(); 73 74 extern int MatLUFactor(Mat,IS,IS,double); 75 extern int MatCholeskyFactor(Mat,IS,double); 76 extern int MatLUFactorSymbolic(Mat,IS,IS,double,Mat*); 77 extern int MatILUFactorSymbolic(Mat,IS,IS,double,int,Mat*); 78 extern int MatCholeskyFactorSymbolic(Mat,IS,double,Mat*); 79 extern int MatIncompleteCholeskyFactorSymbolic(Mat,IS,double,int,Mat*); 80 extern int MatLUFactorNumeric(Mat,Mat*); 81 extern int MatCholeskyFactorNumeric(Mat,Mat*); 82 83 extern int MatSolve(Mat,Vec,Vec); 84 extern int MatForwardSolve(Mat,Vec,Vec); 85 extern int MatBackwardSolve(Mat,Vec,Vec); 86 extern int MatSolveAdd(Mat,Vec,Vec,Vec); 87 extern int MatSolveTrans(Mat,Vec,Vec); 88 extern int MatSolveTransAdd(Mat,Vec,Vec,Vec); 89 90 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 91 SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 92 SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 93 SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128 94 } MatSORType; 95 96 extern int MatRelax(Mat,Vec,double,MatSORType,double,int,Vec); 97 98 extern int MatConvert(Mat,MatType,Mat*); 99 extern int MatView(Mat,Viewer); 100 extern int MatLoad(Viewer,MatType,Mat*); 101 102 typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 103 104 extern int MatGetInfo(Mat,MatInfoType,int*,int*,int*); 105 extern int MatGetDiagonal(Mat,Vec); 106 extern int MatTranspose(Mat,Mat*); 107 extern int MatScale(Mat,Vec,Vec); 108 extern int MatEqual(Mat,Mat); 109 extern int MatScatterBegin(Mat,Mat,InsertMode,MatScatterCtx); 110 extern int MatScatterEnd(Mat,Mat,InsertMode,MatScatterCtx); 111 extern int MatScatterCtxCreate(Mat,IS,IS,Mat,IS,IS,MatScatterCtx*); 112 extern int MatScatterCtxDestroy(MatScatterCtx); 113 114 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4} MatNormType; 115 extern int MatNorm(Mat,MatNormType,double *); 116 117 extern int MatZeroEntries(Mat); 118 extern int MatZeroRows(Mat,IS,Scalar*); 119 extern int MatZeroColumns(Mat,IS,Scalar*); 120 121 extern int MatDestroy(Mat); 122 123 extern int MatGetSize(Mat,int*,int*); 124 extern int MatGetLocalSize(Mat,int*,int*); 125 extern int MatGetOwnershipRange(Mat,int*,int*); 126 127 extern int MatCreate(MPI_Comm,int,int,Mat*); 128 129 extern int MatGetSubMatrix(Mat,IS,IS,Mat*); 130 extern int MatGetSubMatrixInPlace(Mat,IS,IS); 131 132 extern int MatAXPY(Scalar *,Mat,Mat); 133 extern int MatCompress(Mat); 134 135 /* Routines unique to particular data structures */ 136 extern int MatSeqBDiagGetData(Mat,int*,int*,int**,int**,Scalar***); 137 138 #endif 139 140 141 142