xref: /petsc/include/petscmat.h (revision c6a45a9732aaf0679b0f4eb4ddc75ce99ee9558a)
1 /*
2      Include file for the matrix component of PETSc
3 */
4 #ifndef __MAT_PACKAGE
5 #define __MAT_PACKAGE
6 #include "vec.h"
7 
8 typedef struct _Mat*           Mat;
9 typedef struct _MatScatterCtx* MatScatterCtx;
10 
11 
12 extern int MatCreateSequentialDense(int,int,Mat*);
13 extern int MatCreateSequentialAIJ(int,int,int,int *,Mat*);
14 
15 #if defined(USING_MPI)
16 extern int MatCreateMPIAIJ(MPI_Comm,int,int,int,int,int,int*,int,int*,Mat*);
17 #endif
18 
19 extern int MatShellCreate(int,int,void *,Mat*);
20 extern int MatShellSetMult(Mat,int (*)(void*,Vec,Vec));
21 extern int MatShellSetMultTrans(Mat,int (*)(void*,Vec,Vec));
22 
23 
24 /* ------------------------------------------------------------*/
25 extern int  MatValidMatrix(Mat);
26 
27 extern int MatSetValues(Mat,int,int*,int,int*,Scalar*,InsertMode);
28 extern int MatBeginAssembly(Mat);
29 extern int MatEndAssembly(Mat);
30 extern int MatSetOption(Mat,int);
31 #define ROW_ORIENTED              1
32 #define COLUMN_ORIENTED           2
33 #define ROWS_SORTED               4
34 #define COLUMNS_SORTED            8
35 #define NO_NEW_NONZERO_LOCATIONS  16
36 #define YES_NEW_NONZERO_LOCATIONS 32
37 
38 extern int MatGetValues(Mat,Scalar*,int,int*,int,int*);
39 extern int MatGetRow(Mat,int,int *,int **,Scalar**);
40 extern int MatRestoreRow(Mat,int,int *,int **,Scalar**);
41 extern int MatGetCol(Mat,int,int *,int **,Scalar**);
42 extern int MatRestoreCol(Mat,int,int *,int **,Scalar**);
43 
44 extern int MatMult(Mat,Vec,Vec);
45 extern int MatMultAdd(Mat,Vec,Vec,Vec);
46 extern int MatMultTrans(Mat,Vec,Vec);
47 extern int MatMultTransAdd(Mat,Vec,Vec,Vec);
48 
49 #define ORDER_NATURAL 0
50 #define ORDER_ND      1
51 #define ORDER_1WD     2
52 #define ORDER_RCM     3
53 #define ORDER_QMD     4
54 extern int MatGetReordering(Mat,int,IS*,IS*);
55 
56 extern int MatLUFactor(Mat,IS,IS);
57 extern int MatCholeskyFactor(Mat,IS);
58 extern int MatLUFactorSymbolic(Mat,IS,IS,Mat*);
59 extern int MatCholeskyFactorSymbolic(Mat,IS,Mat*);
60 extern int MatLUFactorNumeric(Mat,Mat*);
61 extern int MatCholeskyFactorNumeric(Mat,Mat*);
62 
63 extern int MatSolve(Mat,Vec,Vec);
64 extern int MatSolveAdd(Mat,Vec,Vec,Vec);
65 extern int MatSolveTran(Mat,Vec,Vec);
66 extern int MatSolveTranAdd(Mat,Vec,Vec,Vec);
67 
68 #define SOR_FORWARD_SWEEP      1
69 #define SOR_BACKWARD_SWEEP     2
70 #define SOR_SYMMETRIC_SWEEP    3
71 #define SOR_ZERO_INITIAL_GUESS 4
72 extern int MatRelax(Mat,Vec,double,int,IS,int,Vec);
73 
74 extern int MatCopy(Mat,Mat*);
75 extern int MatView(Mat,Viewer);
76 #include <stdio.h>
77 extern int MatPrintMatlab(Mat,FILE*,char *);
78 extern int MatNonZeros(Mat,int*);
79 extern int MatMemoryUsed(Mat,int*);
80 extern int MatGetDiagonal(Mat,Vec);
81 extern int MatTranspose(Mat);
82 extern int MatScale(Mat,Vec,Vec);
83 extern int MatShrink(Mat,int,int*,int,int*);
84 extern int MatEqual(Mat,Mat);
85 extern int MatScatterBegin(Mat,IS,IS,Mat,IS,IS,InsertMode,MatScatterCtx*);
86 extern int MatScatterEnd(Mat,IS,IS,Mat,IS,IS,InsertMode,MatScatterCtx*);
87 extern int MatReOrder(Mat,IS,IS);
88 
89 #define NORM_1         1
90 #define NORM_2         2
91 #define NORM_FROBENIUS 3
92 #define NORM_INFINITY  4
93 extern int MatNorm(Mat,int,double *);
94 
95 extern int MatZeroEntries(Mat);
96 extern int MatZeroRows(Mat,IS,Scalar*);
97 extern int MatZeroColumns(Mat,IS,Scalar*);
98 
99 extern int MatCompress(Mat);
100 extern int MatDestroy(Mat);
101 
102 extern int MatGetSize(Mat,int*,int*);
103 extern int MatGetLocalSize(Mat,int*,int*);
104 
105 extern int MatCreateInitialMatrix(int,int,Mat*);
106 
107 
108 
109 
110 #endif
111 
112 
113