xref: /petsc/include/petscmat.h (revision 69e4de806daeac5cd3538e86d1ec7d6cbbb057ff)
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 #define MAT_COOKIE PETSC_COOKIE+5
9 
10 typedef struct _Mat*           Mat;
11 typedef struct _MatScatterCtx* MatScatterCtx;
12 
13 typedef enum { MATSAME=-1, MATDENSE, MATAIJ, MATMPIAIJ, MATSHELL, MATROW,
14                MATMPIROW, MATMPIROW_BS, MATBDIAG, MATMPIBDIAG } MatType;
15 
16 extern int MatCreateSequentialDense(MPI_Comm,int,int,Mat*);
17 extern int MatCreateSequentialAIJ(MPI_Comm,int,int,int,int *,Mat*);
18 extern int MatCreateMPIAIJ(MPI_Comm,int,int,int,int,int,int*,int,int*,Mat*);
19 extern int MatCreateSequentialRow(MPI_Comm,int,int,int,int *,Mat*);
20 extern int MatCreateMPIRow(MPI_Comm,int,int,int,int,int,int*,int,int*,Mat*);
21 extern int MatCreateMPIRowbs(MPI_Comm,int,int,int,int*,void*,Mat*);
22 extern int MatCreateSequentialBDiag(MPI_Comm,int,int,int,int,int*,
23                                     Scalar**,Mat*);
24 extern int MatCreateMPIBDiag(MPI_Comm,int,int,int,int,int,int*,
25                                     Scalar**,Mat*);
26 
27 extern int MatShellCreate(MPI_Comm,int,int,void *,Mat*);
28 extern int MatShellSetMult(Mat,int (*)(void*,Vec,Vec));
29 extern int MatShellSetMultTrans(Mat,int (*)(void*,Vec,Vec));
30 extern int MatShellSetMultTransAdd(Mat,int (*)(void*,Vec,Vec,Vec));
31 
32 /* ------------------------------------------------------------*/
33 extern int  MatValidMatrix(Mat);
34 
35 typedef enum {FLUSH_ASSEMBLY=1,FINAL_ASSEMBLY=0} MatAssemblyType;
36 
37 extern int MatSetValues(Mat,int,int*,int,int*,Scalar*,InsertMode);
38 extern int MatAssemblyBegin(Mat,MatAssemblyType);
39 extern int MatAssemblyEnd(Mat,MatAssemblyType);
40 
41 typedef enum {ROW_ORIENTED=1,COLUMN_ORIENTED=2,ROWS_SORTED=4,
42               COLUMNS_SORTED=8,NO_NEW_NONZERO_LOCATIONS=16,
43               YES_NEW_NONZERO_LOCATIONS=32} MatOption;
44 
45 extern int MatGetBDiagData(Mat,int*,int*,int**,Scalar***);
46 
47 extern int MatSetOption(Mat,MatOption);
48 
49 extern int MatGetType(Mat,MatType*);
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 
66 extern int MatLUFactor(Mat,IS,IS);
67 extern int MatCholeskyFactor(Mat,IS);
68 extern int MatLUFactorSymbolic(Mat,IS,IS,Mat*);
69 extern int MatILUFactorSymbolic(Mat,IS,IS,int,Mat*);
70 extern int MatCholeskyFactorSymbolic(Mat,IS,Mat*);
71 extern int MatIncompleteCholeskyFactorSymbolic(Mat,IS,int,Mat*);
72 extern int MatLUFactorNumeric(Mat,Mat*);
73 extern int MatCholeskyFactorNumeric(Mat,Mat*);
74 
75 extern int MatSolve(Mat,Vec,Vec);
76 extern int MatSolveAdd(Mat,Vec,Vec,Vec);
77 extern int MatSolveTrans(Mat,Vec,Vec);
78 extern int MatSolveTransAdd(Mat,Vec,Vec,Vec);
79 
80 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
81               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
82               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
83               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128
84               } MatSORType;
85 
86 extern int MatRelax(Mat,Vec,double,MatSORType,double,int,Vec);
87 
88 extern int MatConvert(Mat,MatType,Mat*);
89 extern int MatView(Mat,Viewer);
90 #include <stdio.h>
91 
92 typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
93 
94 extern int MatGetInfo(Mat,MatInfoType,int*,int*,int*);
95 extern int MatGetDiagonal(Mat,Vec);
96 extern int MatTranspose(Mat);
97 extern int MatScale(Mat,Vec,Vec);
98 extern int MatEqual(Mat,Mat);
99 extern int MatScatterBegin(Mat,IS,IS,Mat,IS,IS,InsertMode,MatScatterCtx*);
100 extern int MatScatterEnd(Mat,IS,IS,Mat,IS,IS,InsertMode,MatScatterCtx*);
101 
102 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4} MatNormType;
103 extern int MatNorm(Mat,MatNormType,double *);
104 
105 extern int MatZeroEntries(Mat);
106 extern int MatZeroRows(Mat,IS,Scalar*);
107 extern int MatZeroColumns(Mat,IS,Scalar*);
108 
109 extern int MatDestroy(Mat);
110 
111 extern int MatGetSize(Mat,int*,int*);
112 extern int MatGetLocalSize(Mat,int*,int*);
113 extern int MatGetOwnershipRange(Mat,int*,int*);
114 
115 extern int MatCreate(MPI_Comm,int,int,Mat*);
116 
117 extern int MatGetSubMatrix(Mat,IS,IS,Mat*);
118 extern int MatGetSubMatrixInPlace(Mat,IS,IS);
119 
120 extern int MatAXPY(Scalar *,Mat,Mat);
121 
122 #endif
123 
124 
125 
126