1 /* $Id: mat.h,v 1.46 1995/07/28 21:50:52 curfman 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 MatSetOption(Mat,MatOption); 48 extern int MatGetType(Mat,MatType*); 49 extern int MatGetName(Mat,char**); 50 extern int MatGetValues(Mat,int,int*,int,int*,Scalar*); 51 extern int MatGetRow(Mat,int,int *,int **,Scalar**); 52 extern int MatRestoreRow(Mat,int,int *,int **,Scalar**); 53 extern int MatGetCol(Mat,int,int *,int **,Scalar**); 54 extern int MatRestoreCol(Mat,int,int *,int **,Scalar**); 55 extern int MatGetArray(Mat,Scalar **); 56 extern int MatMult(Mat,Vec,Vec); 57 extern int MatMultAdd(Mat,Vec,Vec,Vec); 58 extern int MatMultTrans(Mat,Vec,Vec); 59 extern int MatMultTransAdd(Mat,Vec,Vec,Vec); 60 61 typedef enum {ORDER_DATABASE=-1,ORDER_NATURAL=0,ORDER_ND=1,ORDER_1WD=2, 62 ORDER_RCM=3,ORDER_QMD=4} MatOrdering; 63 64 extern int MatGetReordering(Mat,MatOrdering,IS*,IS*); 65 extern int MatReorderForNonzeroDiagonal(Mat,double,IS,IS); 66 67 extern int MatLUFactor(Mat,IS,IS,double); 68 extern int MatCholeskyFactor(Mat,IS,double); 69 extern int MatLUFactorSymbolic(Mat,IS,IS,double,Mat*); 70 extern int MatILUFactorSymbolic(Mat,IS,IS,double,int,Mat*); 71 extern int MatCholeskyFactorSymbolic(Mat,IS,double,Mat*); 72 extern int MatIncompleteCholeskyFactorSymbolic(Mat,IS,double,int,Mat*); 73 extern int MatLUFactorNumeric(Mat,Mat*); 74 extern int MatCholeskyFactorNumeric(Mat,Mat*); 75 76 extern int MatSolve(Mat,Vec,Vec); 77 extern int MatForwardSolve(Mat,Vec,Vec); 78 extern int MatBackwardSolve(Mat,Vec,Vec); 79 extern int MatSolveAdd(Mat,Vec,Vec,Vec); 80 extern int MatSolveTrans(Mat,Vec,Vec); 81 extern int MatSolveTransAdd(Mat,Vec,Vec,Vec); 82 83 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 84 SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 85 SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 86 SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128 87 } MatSORType; 88 89 extern int MatRelax(Mat,Vec,double,MatSORType,double,int,Vec); 90 91 extern int MatConvert(Mat,MatType,Mat*); 92 extern int MatView(Mat,Viewer); 93 #include <stdio.h> 94 95 typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 96 97 extern int MatGetInfo(Mat,MatInfoType,int*,int*,int*); 98 extern int MatGetDiagonal(Mat,Vec); 99 extern int MatTranspose(Mat,Mat*); 100 extern int MatScale(Mat,Vec,Vec); 101 extern int MatEqual(Mat,Mat); 102 extern int MatScatterBegin(Mat,Mat,InsertMode,MatScatterCtx); 103 extern int MatScatterEnd(Mat,Mat,InsertMode,MatScatterCtx); 104 extern int MatScatterCtxCreate(Mat,IS,IS,Mat,IS,IS,MatScatterCtx*); 105 extern int MatScatterCtxDestroy(MatScatterCtx); 106 107 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4} MatNormType; 108 extern int MatNorm(Mat,MatNormType,double *); 109 110 extern int MatZeroEntries(Mat); 111 extern int MatZeroRows(Mat,IS,Scalar*); 112 extern int MatZeroColumns(Mat,IS,Scalar*); 113 114 extern int MatDestroy(Mat); 115 116 extern int MatGetSize(Mat,int*,int*); 117 extern int MatGetLocalSize(Mat,int*,int*); 118 extern int MatGetOwnershipRange(Mat,int*,int*); 119 120 extern int MatCreate(MPI_Comm,int,int,Mat*); 121 122 extern int MatGetSubMatrix(Mat,IS,IS,Mat*); 123 extern int MatGetSubMatrixInPlace(Mat,IS,IS); 124 125 extern int MatAXPY(Scalar *,Mat,Mat); 126 127 /* Routines unique to particular data structures */ 128 extern int MatBDiagGetData(Mat,int*,int*,int**,int**,Scalar***); 129 130 #endif 131 132 133 134