1 /* $Id: mat.h,v 1.43 1995/07/09 23:17:55 bsmith Exp curfman $ */ 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, MATDENSE, MATAIJ, MATMPIAIJ, MATSHELL, MATROW, 16 MATMPIROW, MATMPIROW_BS, MATBDIAG, MATMPIBDIAG } MatType; 17 18 extern int MatCreateSequentialDense(MPI_Comm,int,int,Mat*); 19 extern int MatCreateSequentialAIJ(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 MatCreateSequentialRow(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 MatCreateSequentialBDiag(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 MatShellSetMultTrans(Mat,int (*)(void*,Vec,Vec)); 32 extern int MatShellSetMultTransAdd(Mat,int (*)(void*,Vec,Vec,Vec)); 33 34 /* ------------------------------------------------------------*/ 35 extern int MatValidMatrix(Mat); 36 37 typedef enum {FLUSH_ASSEMBLY=1,FINAL_ASSEMBLY=0} MatAssemblyType; 38 39 extern int MatSetValues(Mat,int,int*,int,int*,Scalar*,InsertMode); 40 extern int MatAssemblyBegin(Mat,MatAssemblyType); 41 extern int MatAssemblyEnd(Mat,MatAssemblyType); 42 43 typedef enum {ROW_ORIENTED=1,COLUMN_ORIENTED=2,ROWS_SORTED=4, 44 COLUMNS_SORTED=8,NO_NEW_NONZERO_LOCATIONS=16, 45 YES_NEW_NONZERO_LOCATIONS=32} MatOption; 46 47 extern int MatGetBDiagData(Mat,int*,int*,int**,Scalar***); 48 49 extern int MatSetOption(Mat,MatOption); 50 51 extern int MatGetType(Mat,MatType*); 52 extern int MatGetName(Mat,char**); 53 extern int MatGetValues(Mat,int,int*,int,int*,Scalar*); 54 extern int MatGetRow(Mat,int,int *,int **,Scalar**); 55 extern int MatRestoreRow(Mat,int,int *,int **,Scalar**); 56 extern int MatGetCol(Mat,int,int *,int **,Scalar**); 57 extern int MatRestoreCol(Mat,int,int *,int **,Scalar**); 58 extern int MatGetArray(Mat,Scalar **); 59 extern int MatMult(Mat,Vec,Vec); 60 extern int MatMultAdd(Mat,Vec,Vec,Vec); 61 extern int MatMultTrans(Mat,Vec,Vec); 62 extern int MatMultTransAdd(Mat,Vec,Vec,Vec); 63 64 typedef enum {ORDER_DATABASE=-1,ORDER_NATURAL=0,ORDER_ND=1,ORDER_1WD=2, 65 ORDER_RCM=3,ORDER_QMD=4} MatOrdering; 66 67 extern int MatGetReordering(Mat,MatOrdering,IS*,IS*); 68 extern int MatReorderForNonzeroDiagonal(Mat,double,IS,IS); 69 70 extern int MatLUFactor(Mat,IS,IS,double); 71 extern int MatCholeskyFactor(Mat,IS,double); 72 extern int MatLUFactorSymbolic(Mat,IS,IS,double,Mat*); 73 extern int MatILUFactorSymbolic(Mat,IS,IS,double,int,Mat*); 74 extern int MatCholeskyFactorSymbolic(Mat,IS,double,Mat*); 75 extern int MatIncompleteCholeskyFactorSymbolic(Mat,IS,double,int,Mat*); 76 extern int MatLUFactorNumeric(Mat,Mat*); 77 extern int MatCholeskyFactorNumeric(Mat,Mat*); 78 79 extern int MatSolve(Mat,Vec,Vec); 80 extern int MatSolveAdd(Mat,Vec,Vec,Vec); 81 extern int MatSolveTrans(Mat,Vec,Vec); 82 extern int MatSolveTransAdd(Mat,Vec,Vec,Vec); 83 84 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 85 SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 86 SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 87 SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128 88 } MatSORType; 89 90 extern int MatRelax(Mat,Vec,double,MatSORType,double,int,Vec); 91 92 extern int MatConvert(Mat,MatType,Mat*); 93 extern int MatView(Mat,Viewer); 94 #include <stdio.h> 95 96 typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 97 98 extern int MatGetInfo(Mat,MatInfoType,int*,int*,int*); 99 extern int MatGetDiagonal(Mat,Vec); 100 extern int MatTranspose(Mat,Mat*); 101 extern int MatScale(Mat,Vec,Vec); 102 extern int MatEqual(Mat,Mat); 103 extern int MatScatterBegin(Mat,Mat,InsertMode,MatScatterCtx); 104 extern int MatScatterEnd(Mat,Mat,InsertMode,MatScatterCtx); 105 extern int MatScatterCtxCreate(Mat,IS,IS,Mat,IS,IS,MatScatterCtx*); 106 extern int MatScatterCtxDestroy(MatScatterCtx); 107 108 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4} MatNormType; 109 extern int MatNorm(Mat,MatNormType,double *); 110 111 extern int MatZeroEntries(Mat); 112 extern int MatZeroRows(Mat,IS,Scalar*); 113 extern int MatZeroColumns(Mat,IS,Scalar*); 114 115 extern int MatDestroy(Mat); 116 117 extern int MatGetSize(Mat,int*,int*); 118 extern int MatGetLocalSize(Mat,int*,int*); 119 extern int MatGetOwnershipRange(Mat,int*,int*); 120 121 extern int MatCreate(MPI_Comm,int,int,Mat*); 122 123 extern int MatGetSubMatrix(Mat,IS,IS,Mat*); 124 extern int MatGetSubMatrixInPlace(Mat,IS,IS); 125 126 extern int MatAXPY(Scalar *,Mat,Mat); 127 128 #endif 129 130 131 132