xref: /petsc/src/mat/impls/aij/seq/aij.h (revision ea709b57ddb8cc304f11df2e9a39d6a8fdb28b53)
1*ea709b57SSatish Balay /* $Id: aij.h,v 1.45 2001/08/06 21:15:14 bsmith Exp balay $ */
2b8a66259SBarry Smith 
370f55243SBarry Smith #include "src/mat/matimpl.h"
4b8a66259SBarry Smith 
52d40f771SBarry Smith #if !defined(__AIJ_H)
62d40f771SBarry Smith #define __AIJ_H
72d40f771SBarry Smith 
8ed2daf61SLois Curfman McInnes /* Info about i-nodes (identical nodes) */
9957e4c30SSatish Balay typedef struct {
104c49b128SBarry Smith   PetscTruth use;
11ed2daf61SLois Curfman McInnes   int        node_count;                    /* number of inodes */
12ed2daf61SLois Curfman McInnes   int        *size;                         /* size of each inode */
13ed2daf61SLois Curfman McInnes   int        limit;                         /* inode limit */
14ed2daf61SLois Curfman McInnes   int        max_limit;                     /* maximum supported inode limit */
153a7fca6bSBarry Smith   PetscTruth checked;                       /* if inodes have been checked for */
1676dd722bSSatish Balay } Mat_SeqAIJ_Inode;
17957e4c30SSatish Balay 
182d40f771SBarry Smith /*
19ec8511deSBarry Smith   MATSEQAIJ format - Compressed row storage (also called Yale sparse matrix
20d35516d3SLois Curfman McInnes   format), compatible with Fortran.  The i[] and j[] arrays start at 1,
21d5d45c9bSBarry Smith   or 0, depending on the value of shift.  For example, in Fortran
225768c4f9SLois Curfman McInnes   j[i[k]+p+shift] is the pth column in row k.  Note that the diagonal
235768c4f9SLois Curfman McInnes   matrix elements are stored with the rest of the nonzeros (not separately).
242d40f771SBarry Smith */
25d35516d3SLois Curfman McInnes 
26b8a66259SBarry Smith typedef struct {
277c922b88SBarry Smith   PetscTruth       sorted;           /* if true, rows are sorted by increasing columns */
287c922b88SBarry Smith   PetscTruth       roworiented;      /* if true, row-oriented input, default */
293369ce9aSBarry Smith   int              nonew;            /* 1 don't add new nonzeros, -1 generate error on new */
307c922b88SBarry Smith   PetscTruth       singlemalloc;     /* if true a, i, and j have been obtained with
31d35516d3SLois Curfman McInnes                                           one big malloc */
32329f5518SBarry Smith   PetscTruth       freedata;        /* free the i,j,a data when the matrix is destroyed; true by default */
3380b4ade8SLois Curfman McInnes   int              nz,maxnz;        /* nonzeros, allocated nonzeros */
34d35516d3SLois Curfman McInnes   int              *diag;            /* pointers to diagonal elements */
35d35516d3SLois Curfman McInnes   int              *i;               /* pointer to beginning of each row */
36d35516d3SLois Curfman McInnes   int              *imax;            /* maximum space allocated for each row */
37d35516d3SLois Curfman McInnes   int              *ilen;            /* actual length of each row */
38d35516d3SLois Curfman McInnes   int              *j;               /* column values: j + i[k] - 1 is start of row k */
39*ea709b57SSatish Balay   PetscScalar      *a;               /* nonzero elements */
4082bf6240SBarry Smith   IS               row,col,icol;   /* index sets, used for reorderings */
41*ea709b57SSatish Balay   PetscScalar      *solve_work;      /* work space used in MatSolve */
42dbb450caSBarry Smith   void             *spptr;           /* pointer for special library like SuperLU */
43dbb450caSBarry Smith   int              indexshift;       /* zero or -one for C or Fortran indexing */
4476dd722bSSatish Balay   Mat_SeqAIJ_Inode inode;            /* identical node informaton */
454fc8c0a5SBarry Smith   int              reallocs;         /* number of mallocs done during MatSetValues()
467823673eSLois Curfman McInnes                                         as more values are set than were prealloced */
47329f5518SBarry Smith   int              rmax;             /* max nonzeros in any row */
4835aab85fSBarry Smith   PetscTruth       ilu_preserve_row_sums;
49b9b97703SBarry Smith   PetscReal        lu_dtcol;
50b9b97703SBarry Smith   PetscTruth       lu_damp;
51b9b97703SBarry Smith   PetscReal        lu_damping;
5287828ca2SBarry Smith   PetscReal        lu_zeropivot;
53*ea709b57SSatish Balay   PetscScalar      *saved_values;    /* location for stashing nonzero values of matrix */
54*ea709b57SSatish Balay   PetscScalar      *idiag,*ssor;     /* inverse of diagonal entries; space for eisen */
557c922b88SBarry Smith 
567c922b88SBarry Smith   PetscTruth       keepzeroedrows;   /* keeps matrix structure same in calls to MatZeroRows()*/
57329f5518SBarry Smith   PetscTruth       ignorezeroentries;
583a7fca6bSBarry Smith   ISColoring       coloring;         /* set with MatADSetColoring() used by MatADSetValues() */
59ec8511deSBarry Smith } Mat_SeqAIJ;
60b8a66259SBarry Smith 
61ca44d042SBarry Smith EXTERN int MatILUFactorSymbolic_SeqAIJ(Mat,IS,IS,MatILUInfo*,Mat *);
62ca44d042SBarry Smith EXTERN int MatDuplicate_SeqAIJ(Mat,MatDuplicateOption,Mat*);
63ca44d042SBarry Smith EXTERN int MatMarkDiagonal_SeqAIJ(Mat);
6408480c60SBarry Smith 
65ca44d042SBarry Smith EXTERN int MatMult_SeqAIJ(Mat A,Vec,Vec);
66ca44d042SBarry Smith EXTERN int MatMultAdd_SeqAIJ(Mat A,Vec,Vec,Vec);
67ca44d042SBarry Smith EXTERN int MatMultTranspose_SeqAIJ(Mat A,Vec,Vec);
68ca44d042SBarry Smith EXTERN int MatMultTransposeAdd_SeqAIJ(Mat A,Vec,Vec,Vec);
6987828ca2SBarry Smith EXTERN int MatRelax_SeqAIJ(Mat,Vec,PetscReal,MatSORType,PetscReal,int,Vec);
7008480c60SBarry Smith 
713a7fca6bSBarry Smith EXTERN int MatSetColoring_SeqAIJ(Mat,ISColoring);
723a7fca6bSBarry Smith EXTERN int MatSetValuesAdic_SeqAIJ(Mat,void*);
733a7fca6bSBarry Smith EXTERN int MatSetValuesAdifor_SeqAIJ(Mat,int,void*);
743a7fca6bSBarry Smith 
752d40f771SBarry Smith #endif
76