xref: /petsc/src/mat/impls/aij/seq/aij.h (revision da33ede1553502984e650134bd16e8383e3e4e5b)
173f4d377SMatthew Knepley /* $Id: aij.h,v 1.46 2001/08/07 03:02:47 balay Exp $ */
2b8a66259SBarry Smith 
32d40f771SBarry Smith #if !defined(__AIJ_H)
42d40f771SBarry Smith #define __AIJ_H
5*da33ede1SBarry Smith #include "src/mat/matimpl.h"
62d40f771SBarry Smith 
7ed2daf61SLois Curfman McInnes /* Info about i-nodes (identical nodes) */
8957e4c30SSatish Balay typedef struct {
94c49b128SBarry Smith   PetscTruth use;
10ed2daf61SLois Curfman McInnes   int        node_count;                    /* number of inodes */
11ed2daf61SLois Curfman McInnes   int        *size;                         /* size of each inode */
12ed2daf61SLois Curfman McInnes   int        limit;                         /* inode limit */
13ed2daf61SLois Curfman McInnes   int        max_limit;                     /* maximum supported inode limit */
143a7fca6bSBarry Smith   PetscTruth checked;                       /* if inodes have been checked for */
1576dd722bSSatish Balay } Mat_SeqAIJ_Inode;
16957e4c30SSatish Balay 
172d40f771SBarry Smith /*
18ec8511deSBarry Smith   MATSEQAIJ format - Compressed row storage (also called Yale sparse matrix
19dfbc5765Svictorle   format).  The i[] and j[] arrays start at 0. For example,
20dfbc5765Svictorle   j[i[k]+p] is the pth column in row k.  Note that the diagonal
215768c4f9SLois Curfman McInnes   matrix elements are stored with the rest of the nonzeros (not separately).
222d40f771SBarry Smith */
23d35516d3SLois Curfman McInnes 
24b8a66259SBarry Smith typedef struct {
257c922b88SBarry Smith   PetscTruth       sorted;           /* if true, rows are sorted by increasing columns */
267c922b88SBarry Smith   PetscTruth       roworiented;      /* if true, row-oriented input, default */
273369ce9aSBarry Smith   int              nonew;            /* 1 don't add new nonzeros, -1 generate error on new */
287c922b88SBarry Smith   PetscTruth       singlemalloc;     /* if true a, i, and j have been obtained with
29d35516d3SLois Curfman McInnes                                           one big malloc */
30329f5518SBarry Smith   PetscTruth       freedata;        /* free the i,j,a data when the matrix is destroyed; true by default */
3180b4ade8SLois Curfman McInnes   int              nz,maxnz;        /* nonzeros, allocated nonzeros */
32d35516d3SLois Curfman McInnes   int              *diag;            /* pointers to diagonal elements */
33d35516d3SLois Curfman McInnes   int              *i;               /* pointer to beginning of each row */
34d35516d3SLois Curfman McInnes   int              *imax;            /* maximum space allocated for each row */
35d35516d3SLois Curfman McInnes   int              *ilen;            /* actual length of each row */
36d35516d3SLois Curfman McInnes   int              *j;               /* column values: j + i[k] - 1 is start of row k */
37ea709b57SSatish Balay   PetscScalar      *a;               /* nonzero elements */
3882bf6240SBarry Smith   IS               row,col,icol;   /* index sets, used for reorderings */
39ea709b57SSatish Balay   PetscScalar      *solve_work;      /* work space used in MatSolve */
4076dd722bSSatish Balay   Mat_SeqAIJ_Inode inode;            /* identical node informaton */
414fc8c0a5SBarry Smith   int              reallocs;         /* number of mallocs done during MatSetValues()
427823673eSLois Curfman McInnes                                         as more values are set than were prealloced */
43329f5518SBarry Smith   int              rmax;             /* max nonzeros in any row */
4435aab85fSBarry Smith   PetscTruth       ilu_preserve_row_sums;
45b9b97703SBarry Smith   PetscReal        lu_dtcol;
46b9b97703SBarry Smith   PetscReal        lu_damping;
47f4cce38bSHong Zhang   PetscReal        lu_shift;         /* Manteuffel shift switch, fraction */
486cc28720Svictorle   PetscReal        lu_shift_fraction;
4987828ca2SBarry Smith   PetscReal        lu_zeropivot;
50ea709b57SSatish Balay   PetscScalar      *saved_values;    /* location for stashing nonzero values of matrix */
51ea709b57SSatish Balay   PetscScalar      *idiag,*ssor;     /* inverse of diagonal entries; space for eisen */
527c922b88SBarry Smith 
537c922b88SBarry Smith   PetscTruth       keepzeroedrows;   /* keeps matrix structure same in calls to MatZeroRows()*/
54329f5518SBarry Smith   PetscTruth       ignorezeroentries;
553a7fca6bSBarry Smith   ISColoring       coloring;         /* set with MatADSetColoring() used by MatADSetValues() */
560968510aSHong Zhang   Mat              sbaijMat;         /* mat in sbaij format */
57a30b2313SHong Zhang 
58a30b2313SHong Zhang   int              *xtoy,*xtoyB;     /* map nonzero pattern of X into Y's, used by MatAXPY() */
59a30b2313SHong Zhang   Mat              XtoY;             /* used by MatAXPY() */
60ec8511deSBarry Smith } Mat_SeqAIJ;
61b8a66259SBarry Smith 
62b380c88cSHong Zhang EXTERN int MatILUFactorSymbolic_SeqAIJ(Mat,IS,IS,MatFactorInfo*,Mat *);
6315e8a5b3SHong Zhang EXTERN int MatICCFactorSymbolic_SeqAIJ(Mat,IS,MatFactorInfo*,Mat *);
64f76d2b81SHong Zhang EXTERN int MatCholeskyFactorSymbolic_SeqAIJ(Mat,IS,MatFactorInfo*,Mat*);
65a6175056SHong Zhang EXTERN int MatCholeskyFactorNumeric_SeqAIJ(Mat,Mat *);
66ca44d042SBarry Smith EXTERN int MatDuplicate_SeqAIJ(Mat,MatDuplicateOption,Mat*);
67ca44d042SBarry Smith EXTERN int MatMarkDiagonal_SeqAIJ(Mat);
6808480c60SBarry Smith 
69ca44d042SBarry Smith EXTERN int MatMult_SeqAIJ(Mat A,Vec,Vec);
70ca44d042SBarry Smith EXTERN int MatMultAdd_SeqAIJ(Mat A,Vec,Vec,Vec);
71ca44d042SBarry Smith EXTERN int MatMultTranspose_SeqAIJ(Mat A,Vec,Vec);
72ca44d042SBarry Smith EXTERN int MatMultTransposeAdd_SeqAIJ(Mat A,Vec,Vec,Vec);
73c14dc6b6SHong Zhang EXTERN int MatRelax_SeqAIJ(Mat,Vec,PetscReal,MatSORType,PetscReal,int,int,Vec);
7408480c60SBarry Smith 
753a7fca6bSBarry Smith EXTERN int MatSetColoring_SeqAIJ(Mat,ISColoring);
763a7fca6bSBarry Smith EXTERN int MatSetValuesAdic_SeqAIJ(Mat,void*);
773a7fca6bSBarry Smith EXTERN int MatSetValuesAdifor_SeqAIJ(Mat,int,void*);
783a7fca6bSBarry Smith 
7970f19b1fSKris Buschelman EXTERN int MatGetSymbolicTranspose_SeqAIJ(Mat,int *[],int *[]);
8070f19b1fSKris Buschelman EXTERN int MatRestoreSymbolicTranspose_SeqAIJ(Mat,int *[],int *[]);
8197304618SKris Buschelman EXTERN int MatToSymmetricIJ_SeqAIJ(int,int*,int*,int,int,int**,int**);
8297304618SKris Buschelman EXTERN int Mat_AIJ_CheckInode(Mat,PetscTruth);
8397304618SKris Buschelman EXTERN int MatLUFactorSymbolic_SeqAIJ(Mat,IS,IS,MatFactorInfo*,Mat*);
8497304618SKris Buschelman EXTERN int MatLUFactorNumeric_SeqAIJ(Mat,Mat*);
8597304618SKris Buschelman EXTERN int MatLUFactor_SeqAIJ(Mat,IS,IS,MatFactorInfo*);
8697304618SKris Buschelman EXTERN int MatSolve_SeqAIJ(Mat,Vec,Vec);
8797304618SKris Buschelman EXTERN int MatSolveAdd_SeqAIJ(Mat,Vec,Vec,Vec);
8897304618SKris Buschelman EXTERN int MatSolveTranspose_SeqAIJ(Mat,Vec,Vec);
8997304618SKris Buschelman EXTERN int MatSolveTransposeAdd_SeqAIJ(Mat,Vec,Vec,Vec);
9097304618SKris Buschelman EXTERN int MatEqual_SeqAIJ(Mat A,Mat B,PetscTruth* flg);
9197304618SKris Buschelman EXTERN int MatFDColoringCreate_SeqAIJ(Mat,ISColoring,MatFDColoring);
9297304618SKris Buschelman EXTERN int MatILUDTFactor_SeqAIJ(Mat,MatFactorInfo*,IS,IS,Mat*);
93f248c16bSBarry Smith EXTERN int MatLoad_SeqAIJ(PetscViewer,const MatType,Mat*);
9497304618SKris Buschelman EXTERN int RegisterApplyPtAPRoutines_Private(Mat);
9597304618SKris Buschelman EXTERN_C_BEGIN
96f248c16bSBarry Smith EXTERN int MatConvert_SeqAIJ_SeqSBAIJ(Mat,const MatType,Mat*);
97f248c16bSBarry Smith EXTERN int MatConvert_SeqAIJ_SeqBAIJ(Mat,const MatType,Mat*);
9897304618SKris Buschelman EXTERN int MatReorderForNonzeroDiagonal_SeqAIJ(Mat,PetscReal,IS,IS);
9997304618SKris Buschelman EXTERN int MatAdjustForInodes_SeqAIJ(Mat,IS*,IS*);
10097304618SKris Buschelman EXTERN int MatSeqAIJGetInodeSizes_SeqAIJ(Mat,int*,int*[],int*);
10197304618SKris Buschelman EXTERN_C_END
10270f19b1fSKris Buschelman 
1032d40f771SBarry Smith #endif
104