xref: /petsc/include/petscmat.h (revision e8d4e0b961827e7b3eb2f088182f4a74ed5a7ba0)
1 /*
2      Include file for the matrix component of PETSc
3 */
4 #ifndef __MAT
5 #define __MAT
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 MatInsertValues(Mat,Scalar*,int,int*,int,int*);
28 extern int MatAddValues(Mat,Scalar*,int,int*,int,int*);
29 extern int MatBeginAssembly(Mat);
30 extern int MatEndAssembly(Mat);
31 extern int MatSetInsertOption(Mat,int);
32 #define ROW_ORIENTED              1
33 #define COLUMN_ORIENTED           2
34 #define ROWS_SORTED               3
35 #define COLUMNS_SORTED            4
36 #define NO_NEW_NONZERO_LOCATIONS  5
37 #define YES_NEW_NONZERO_LOCATIONS 6
38 
39 extern int MatGetValues(Mat,Scalar*,int,int*,int,int*);
40 extern int MatGetRow(Mat,int,int *,int **,Scalar**);
41 extern int MatRestoreRow(Mat,int,int *,int **,Scalar**);
42 extern int MatGetCol(Mat,int,int *,int **,Scalar**);
43 extern int MatRestoreCol(Mat,int,int *,int **,Scalar**);
44 
45 extern int MatMult(Mat,Vec,Vec);
46 extern int MatMultAdd(Mat,Vec,Vec,Vec);
47 extern int MatMultTrans(Mat,Vec,Vec);
48 extern int MatMultTransAdd(Mat,Vec,Vec,Vec);
49 
50 #define ORDER_NATURAL 0
51 #define ORDER_ND      1
52 #define ORDER_1WD     2
53 #define ORDER_RCM     3
54 #define ORDER_QMD     4
55 extern int MatGetReordering(Mat,int,IS*,IS*);
56 
57 extern int MatLUFactor(Mat,IS,IS);
58 extern int MatCholeskyFactor(Mat,IS);
59 extern int MatLUFactorSymbolic(Mat,IS,IS,Mat*);
60 extern int MatCholeskyFactorSymbolic(Mat,IS,Mat*);
61 extern int MatLUFactorNumeric(Mat,Mat);
62 extern int MatCholeskyFactorNumeric(Mat,Mat);
63 
64 extern int MatSolve(Mat,Vec,Vec);
65 extern int MatSolveAdd(Mat,Vec,Vec,Vec);
66 extern int MatSolveTran(Mat,Vec,Vec);
67 extern int MatSolveTranAdd(Mat,Vec,Vec,Vec);
68 
69 #define SOR_FORWARD_SWEEP      1
70 #define SOR_BACKWARD_SWEEP     2
71 #define SOR_SYMMETRIC_SWEEP    3
72 #define SOR_ZERO_INITIAL_GUESS 4
73 extern int MatRelax(Mat,Vec,double,int,IS,int,Vec);
74 
75 extern int MatCopy(Mat,Mat*);
76 extern int MatView(Mat,Viewer);
77 #include <stdio.h>
78 extern int MatPrintMatlab(Mat,FILE*,char *);
79 extern int  MatNonZeros(Mat,int*);
80 extern int  MatMemoryUsed(Mat,int*);
81 extern int MatGetDiagonal(Mat,Vec);
82 extern int MatTranspose(Mat);
83 extern int MatScale(Mat,Vec,Vec);
84 extern int MatShrink(Mat,int,int*,int,int*);
85 extern int  MatEqual(Mat,Mat);
86 extern int  MatScatterBegin(Mat,IS,IS,Mat,IS,IS,MatScatterCtx*);
87 extern int  MatScatterEnd(Mat,IS,IS,Mat,IS,IS,MatScatterCtx*);
88 extern int  MatScatterAddBegin(Mat,IS,IS,Mat,IS,IS,MatScatterCtx*);
89 extern int  MatScatterAddEnd(Mat,IS,IS,Mat,IS,IS,MatScatterCtx*);
90 extern int MatReOrder(Mat,IS,IS);
91 
92 #define NORM_1         1
93 #define NORM_2         2
94 #define NORM_FROBENIUS 3
95 #define NORM_INFINITY  4
96 extern int MatNorm(Mat,int,double *);
97 
98 extern int MatZeroEntries(Mat);
99 extern int MatZeroRows(Mat);
100 
101 extern int MatCompress(Mat);
102 extern int MatDestroy(Mat);
103 
104 extern int MatCreateInitialMatrix(int,int,Mat*);
105 
106 
107 
108 #endif
109 
110 
111