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