xref: /petsc/src/mat/impls/aij/seq/aij.h (revision bc011b1ea0f1d686ef542cd9b8d1c77812488e84)
1b8a66259SBarry Smith 
22d40f771SBarry Smith #if !defined(__AIJ_H)
32d40f771SBarry Smith #define __AIJ_H
4da33ede1SBarry Smith #include "src/mat/matimpl.h"
52d40f771SBarry Smith 
6ed2daf61SLois Curfman McInnes /* Info about i-nodes (identical nodes) */
7957e4c30SSatish Balay typedef struct {
84c49b128SBarry Smith   PetscTruth use;
9ed2daf61SLois Curfman McInnes   int        node_count;                    /* number of inodes */
10ed2daf61SLois Curfman McInnes   int        *size;                         /* size of each inode */
11ed2daf61SLois Curfman McInnes   int        limit;                         /* inode limit */
12ed2daf61SLois Curfman McInnes   int        max_limit;                     /* maximum supported inode limit */
133a7fca6bSBarry Smith   PetscTruth checked;                       /* if inodes have been checked for */
1476dd722bSSatish Balay } Mat_SeqAIJ_Inode;
15957e4c30SSatish Balay 
162d40f771SBarry Smith /*
17ec8511deSBarry Smith   MATSEQAIJ format - Compressed row storage (also called Yale sparse matrix
18dfbc5765Svictorle   format).  The i[] and j[] arrays start at 0. For example,
19dfbc5765Svictorle   j[i[k]+p] is the pth column in row k.  Note that the diagonal
205768c4f9SLois Curfman McInnes   matrix elements are stored with the rest of the nonzeros (not separately).
212d40f771SBarry Smith */
22d35516d3SLois Curfman McInnes 
23b8a66259SBarry Smith typedef struct {
247c922b88SBarry Smith   PetscTruth       sorted;           /* if true, rows are sorted by increasing columns */
257c922b88SBarry Smith   PetscTruth       roworiented;      /* if true, row-oriented input, default */
263369ce9aSBarry Smith   int              nonew;            /* 1 don't add new nonzeros, -1 generate error on new */
277c922b88SBarry Smith   PetscTruth       singlemalloc;     /* if true a, i, and j have been obtained with
28d35516d3SLois Curfman McInnes                                           one big malloc */
29329f5518SBarry Smith   PetscTruth       freedata;        /* free the i,j,a data when the matrix is destroyed; true by default */
3080b4ade8SLois Curfman McInnes   int              nz,maxnz;        /* nonzeros, allocated nonzeros */
31d35516d3SLois Curfman McInnes   int              *diag;            /* pointers to diagonal elements */
32d35516d3SLois Curfman McInnes   int              *i;               /* pointer to beginning of each row */
33d35516d3SLois Curfman McInnes   int              *imax;            /* maximum space allocated for each row */
34d35516d3SLois Curfman McInnes   int              *ilen;            /* actual length of each row */
35d35516d3SLois Curfman McInnes   int              *j;               /* column values: j + i[k] - 1 is start of row k */
36ea709b57SSatish Balay   PetscScalar      *a;               /* nonzero elements */
3782bf6240SBarry Smith   IS               row,col,icol;   /* index sets, used for reorderings */
38ea709b57SSatish Balay   PetscScalar      *solve_work;      /* work space used in MatSolve */
3976dd722bSSatish Balay   Mat_SeqAIJ_Inode inode;            /* identical node informaton */
404fc8c0a5SBarry Smith   int              reallocs;         /* number of mallocs done during MatSetValues()
417823673eSLois Curfman McInnes                                         as more values are set than were prealloced */
42329f5518SBarry Smith   int              rmax;             /* max nonzeros in any row */
4335aab85fSBarry Smith   PetscTruth       ilu_preserve_row_sums;
44b9b97703SBarry Smith   PetscReal        lu_dtcol;
45b9b97703SBarry Smith   PetscReal        lu_damping;
46f4cce38bSHong Zhang   PetscReal        lu_shift;         /* Manteuffel shift switch, fraction */
476cc28720Svictorle   PetscReal        lu_shift_fraction;
4887828ca2SBarry Smith   PetscReal        lu_zeropivot;
49ea709b57SSatish Balay   PetscScalar      *saved_values;    /* location for stashing nonzero values of matrix */
50ea709b57SSatish Balay   PetscScalar      *idiag,*ssor;     /* inverse of diagonal entries; space for eisen */
517c922b88SBarry Smith 
527c922b88SBarry Smith   PetscTruth       keepzeroedrows;   /* keeps matrix structure same in calls to MatZeroRows()*/
53329f5518SBarry Smith   PetscTruth       ignorezeroentries;
543a7fca6bSBarry Smith   ISColoring       coloring;         /* set with MatADSetColoring() used by MatADSetValues() */
550968510aSHong Zhang   Mat              sbaijMat;         /* mat in sbaij format */
56a30b2313SHong Zhang 
57a30b2313SHong Zhang   int              *xtoy,*xtoyB;     /* map nonzero pattern of X into Y's, used by MatAXPY() */
58a30b2313SHong Zhang   Mat              XtoY;             /* used by MatAXPY() */
59ec8511deSBarry Smith } Mat_SeqAIJ;
60b8a66259SBarry Smith 
61dfbe8321SBarry Smith EXTERN PetscErrorCode MatILUFactorSymbolic_SeqAIJ(Mat,IS,IS,MatFactorInfo*,Mat *);
62dfbe8321SBarry Smith EXTERN PetscErrorCode MatICCFactorSymbolic_SeqAIJ(Mat,IS,MatFactorInfo*,Mat *);
63dfbe8321SBarry Smith EXTERN PetscErrorCode MatCholeskyFactorSymbolic_SeqAIJ(Mat,IS,MatFactorInfo*,Mat*);
64dfbe8321SBarry Smith EXTERN PetscErrorCode MatCholeskyFactorNumeric_SeqAIJ(Mat,Mat *);
65dfbe8321SBarry Smith EXTERN PetscErrorCode MatDuplicate_SeqAIJ(Mat,MatDuplicateOption,Mat*);
66dfbe8321SBarry Smith EXTERN PetscErrorCode MatMissingDiagonal_SeqAIJ(Mat);
67dfbe8321SBarry Smith EXTERN PetscErrorCode MatMarkDiagonal_SeqAIJ(Mat);
6808480c60SBarry Smith 
69dfbe8321SBarry Smith EXTERN PetscErrorCode MatMult_SeqAIJ(Mat A,Vec,Vec);
70dfbe8321SBarry Smith EXTERN PetscErrorCode MatMultAdd_SeqAIJ(Mat A,Vec,Vec,Vec);
71dfbe8321SBarry Smith EXTERN PetscErrorCode MatMultTranspose_SeqAIJ(Mat A,Vec,Vec);
72dfbe8321SBarry Smith EXTERN PetscErrorCode MatMultTransposeAdd_SeqAIJ(Mat A,Vec,Vec,Vec);
73dfbe8321SBarry Smith EXTERN PetscErrorCode MatRelax_SeqAIJ(Mat,Vec,PetscReal,MatSORType,PetscReal,int,int,Vec);
7408480c60SBarry Smith 
75dfbe8321SBarry Smith EXTERN PetscErrorCode MatSetColoring_SeqAIJ(Mat,ISColoring);
76dfbe8321SBarry Smith EXTERN PetscErrorCode MatSetValuesAdic_SeqAIJ(Mat,void*);
77dfbe8321SBarry Smith EXTERN PetscErrorCode MatSetValuesAdifor_SeqAIJ(Mat,int,void*);
783a7fca6bSBarry Smith 
79dfbe8321SBarry Smith EXTERN PetscErrorCode MatGetSymbolicTranspose_SeqAIJ(Mat,int *[],int *[]);
80dfbe8321SBarry Smith EXTERN PetscErrorCode MatRestoreSymbolicTranspose_SeqAIJ(Mat,int *[],int *[]);
81dfbe8321SBarry Smith EXTERN PetscErrorCode MatToSymmetricIJ_SeqAIJ(int,int*,int*,int,int,int**,int**);
82dfbe8321SBarry Smith EXTERN PetscErrorCode Mat_AIJ_CheckInode(Mat,PetscTruth);
83dfbe8321SBarry Smith EXTERN PetscErrorCode MatLUFactorSymbolic_SeqAIJ(Mat,IS,IS,MatFactorInfo*,Mat*);
84dfbe8321SBarry Smith EXTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ(Mat,Mat*);
85dfbe8321SBarry Smith EXTERN PetscErrorCode MatLUFactor_SeqAIJ(Mat,IS,IS,MatFactorInfo*);
86dfbe8321SBarry Smith EXTERN PetscErrorCode MatSolve_SeqAIJ(Mat,Vec,Vec);
87dfbe8321SBarry Smith EXTERN PetscErrorCode MatSolveAdd_SeqAIJ(Mat,Vec,Vec,Vec);
88dfbe8321SBarry Smith EXTERN PetscErrorCode MatSolveTranspose_SeqAIJ(Mat,Vec,Vec);
89dfbe8321SBarry Smith EXTERN PetscErrorCode MatSolveTransposeAdd_SeqAIJ(Mat,Vec,Vec,Vec);
90dfbe8321SBarry Smith EXTERN PetscErrorCode MatEqual_SeqAIJ(Mat A,Mat B,PetscTruth* flg);
91dfbe8321SBarry Smith EXTERN PetscErrorCode MatFDColoringCreate_SeqAIJ(Mat,ISColoring,MatFDColoring);
92dfbe8321SBarry Smith EXTERN PetscErrorCode MatILUDTFactor_SeqAIJ(Mat,MatFactorInfo*,IS,IS,Mat*);
93dfbe8321SBarry Smith EXTERN PetscErrorCode MatLoad_SeqAIJ(PetscViewer,const MatType,Mat*);
94dfbe8321SBarry Smith EXTERN PetscErrorCode RegisterApplyPtAPRoutines_Private(Mat);
95dfbe8321SBarry Smith EXTERN PetscErrorCode MatMatMult_SeqAIJ_SeqAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
96dfbe8321SBarry Smith EXTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ(Mat,Mat,PetscReal,Mat*);
97dfbe8321SBarry Smith EXTERN PetscErrorCode MatMatMultNumeric_SeqAIJ_SeqAIJ(Mat,Mat,Mat);
98dfbe8321SBarry Smith EXTERN PetscErrorCode MatPtAP_SeqAIJ_SeqAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
99dfbe8321SBarry Smith EXTERN PetscErrorCode MatPtAPSymbolic_SeqAIJ_SeqAIJ(Mat,Mat,PetscReal,Mat*);
100dfbe8321SBarry Smith EXTERN PetscErrorCode MatPtAPNumeric_SeqAIJ_SeqAIJ(Mat,Mat,Mat);
101*bc011b1eSHong Zhang EXTERN PetscErrorCode MatMatMultTranspose_SeqAIJ_SeqAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
102*bc011b1eSHong Zhang EXTERN PetscErrorCode MatMatMultTransposeSymbolic_SeqAIJ_SeqAIJ(Mat,Mat,PetscReal,Mat*);
103*bc011b1eSHong Zhang EXTERN PetscErrorCode MatMatMultTransposeNumeric_SeqAIJ_SeqAIJ(Mat,Mat,Mat);
10437f24d82SSatish Balay EXTERN PetscErrorCode MatSetValues_SeqAIJ(Mat,int,const int[],int,const int[],const PetscScalar[],InsertMode);
10511d72411SSatish Balay EXTERN PetscErrorCode MatGetRow_SeqAIJ(Mat,int,int*,int**,PetscScalar**);
10611d72411SSatish Balay EXTERN PetscErrorCode MatRestoreRow_SeqAIJ(Mat,int,int*,int**,PetscScalar**);
10711d72411SSatish Balay EXTERN PetscErrorCode MatPrintHelp_SeqAIJ(Mat);
10811d72411SSatish Balay EXTERN PetscErrorCode MatAXPY_SeqAIJ(const PetscScalar[],Mat,Mat,MatStructure);
1099af31e4aSHong Zhang 
11097304618SKris Buschelman EXTERN_C_BEGIN
111dfbe8321SBarry Smith EXTERN PetscErrorCode MatConvert_SeqAIJ_SeqSBAIJ(Mat,const MatType,Mat*);
112dfbe8321SBarry Smith EXTERN PetscErrorCode MatConvert_SeqAIJ_SeqBAIJ(Mat,const MatType,Mat*);
113dfbe8321SBarry Smith EXTERN PetscErrorCode MatReorderForNonzeroDiagonal_SeqAIJ(Mat,PetscReal,IS,IS);
114dfbe8321SBarry Smith EXTERN PetscErrorCode MatAdjustForInodes_SeqAIJ(Mat,IS*,IS*);
115dfbe8321SBarry Smith EXTERN PetscErrorCode MatSeqAIJGetInodeSizes_SeqAIJ(Mat,int*,int*[],int*);
11697304618SKris Buschelman EXTERN_C_END
11770f19b1fSKris Buschelman 
1182d40f771SBarry Smith #endif
119