xref: /petsc/src/mat/impls/aij/seq/aij.h (revision 5e71baeff2f3138f93cd4f5927dfd596eb8325cc)
1 
2 #if !defined(__AIJ_H)
3 #define __AIJ_H
4 
5 #include <petsc/private/matimpl.h>
6 #include <petscctable.h>
7 
8 /*
9     Struct header shared by SeqAIJ, SeqBAIJ and SeqSBAIJ matrix formats
10 */
11 #define SEQAIJHEADER(datatype)        \
12   PetscBool roworiented;              /* if true, row-oriented input, default */ \
13   PetscInt  nonew;                    /* 1 don't add new nonzeros, -1 generate error on new */ \
14   PetscInt  nounused;                 /* -1 generate error on unused space */ \
15   PetscBool singlemalloc;             /* if true a, i, and j have been obtained with one big malloc */ \
16   PetscInt  maxnz;                    /* allocated nonzeros */ \
17   PetscInt  *imax;                    /* maximum space allocated for each row */ \
18   PetscInt  *ilen;                    /* actual length of each row */ \
19   PetscInt  *ipre;                    /* space preallocated for each row by user */ \
20   PetscBool free_imax_ilen;  \
21   PetscInt  reallocs;                 /* number of mallocs done during MatSetValues() \
22                                         as more values are set than were prealloced */\
23   PetscInt          rmax;             /* max nonzeros in any row */ \
24   PetscBool         keepnonzeropattern;   /* keeps matrix structure same in calls to MatZeroRows()*/ \
25   PetscBool         ignorezeroentries; \
26   PetscBool         free_ij;          /* free the column indices j and row offsets i when the matrix is destroyed */ \
27   PetscBool         free_a;           /* free the numerical values when matrix is destroy */ \
28   Mat_CompressedRow compressedrow;    /* use compressed row format */                      \
29   PetscInt          nz;               /* nonzeros */                                       \
30   PetscInt          *i;               /* pointer to beginning of each row */               \
31   PetscInt          *j;               /* column values: j + i[k] - 1 is start of row k */  \
32   PetscInt          *diag;            /* pointers to diagonal elements */                  \
33   PetscInt          nonzerorowcnt;    /* how many rows have nonzero entries */             \
34   PetscBool         free_diag;         \
35   datatype          *a;               /* nonzero elements */                               \
36   PetscScalar       *solve_work;      /* work space used in MatSolve */                    \
37   IS                row, col, icol;   /* index sets, used for reorderings */ \
38   PetscBool         pivotinblocks;    /* pivot inside factorization of each diagonal block */ \
39   Mat               parent;           /* set if this matrix was formed with MatDuplicate(...,MAT_SHARE_NONZERO_PATTERN,....); \
40                                          means that this shares some data structures with the parent including diag, ilen, imax, i, j */\
41   Mat_SubSppt       *submatis1         /* used by MatCreateSubMatrices_MPIXAIJ_Local */
42 
43 typedef struct {
44   MatTransposeColoring matcoloring;
45   Mat                  Bt_den;       /* dense matrix of B^T */
46   Mat                  ABt_den;      /* dense matrix of A*B^T */
47   PetscBool            usecoloring;
48   PetscErrorCode (*destroy)(Mat);
49 } Mat_MatMatTransMult;
50 
51 typedef struct { /* used by MatTransposeMatMult() */
52   Mat          At;           /* transpose of the first matrix */
53   Mat          mA;           /* maij matrix of A */
54   Vec          bt,ct;        /* vectors to hold locally transposed arrays of B and C */
55   PetscErrorCode (*destroy)(Mat);
56 } Mat_MatTransMatMult;
57 
58 typedef struct {
59   PetscInt    *api,*apj;       /* symbolic structure of A*P */
60   PetscScalar *apa;            /* temporary array for storing one row of A*P */
61   PetscErrorCode (*destroy)(Mat);
62 } Mat_PtAP;
63 
64 typedef struct {
65   MatTransposeColoring matcoloring;
66   Mat                  Rt;    /* sparse or dense matrix of R^T */
67   Mat                  RARt;  /* dense matrix of R*A*R^T */
68   Mat                  ARt;   /* A*R^T used for the case -matrart_color_art */
69   MatScalar            *work; /* work array to store columns of A*R^T used in MatMatMatMultNumeric_SeqAIJ_SeqAIJ_SeqDense() */
70   PetscErrorCode (*destroy)(Mat);
71 } Mat_RARt;
72 
73 typedef struct {
74   Mat BC;               /* temp matrix for storing B*C */
75   PetscErrorCode (*destroy)(Mat);
76 } Mat_MatMatMatMult;
77 
78 /*
79   MATSEQAIJ format - Compressed row storage (also called Yale sparse matrix
80   format) or compressed sparse row (CSR).  The i[] and j[] arrays start at 0. For example,
81   j[i[k]+p] is the pth column in row k.  Note that the diagonal
82   matrix elements are stored with the rest of the nonzeros (not separately).
83 */
84 
85 /* Info about i-nodes (identical nodes) helper class for SeqAIJ */
86 typedef struct {
87   MatScalar        *bdiag,*ibdiag,*ssor_work;        /* diagonal blocks of matrix used for MatSOR_SeqAIJ_Inode() */
88   PetscInt         bdiagsize;                         /* length of bdiag and ibdiag */
89   PetscBool        ibdiagvalid;                       /* do ibdiag[] and bdiag[] contain the most recent values */
90 
91   PetscBool        use;
92   PetscInt         node_count;                     /* number of inodes */
93   PetscInt         *size;                          /* size of each inode */
94   PetscInt         limit;                          /* inode limit */
95   PetscInt         max_limit;                      /* maximum supported inode limit */
96   PetscBool        checked;                        /* if inodes have been checked for */
97   PetscObjectState mat_nonzerostate;               /* non-zero state when inodes were checked for */
98 } Mat_SeqAIJ_Inode;
99 
100 PETSC_INTERN PetscErrorCode MatView_SeqAIJ_Inode(Mat,PetscViewer);
101 PETSC_INTERN PetscErrorCode MatAssemblyEnd_SeqAIJ_Inode(Mat,MatAssemblyType);
102 PETSC_INTERN PetscErrorCode MatDestroy_SeqAIJ_Inode(Mat);
103 PETSC_INTERN PetscErrorCode MatCreate_SeqAIJ_Inode(Mat);
104 PETSC_INTERN PetscErrorCode MatSetOption_SeqAIJ_Inode(Mat,MatOption,PetscBool);
105 PETSC_INTERN PetscErrorCode MatDuplicate_SeqAIJ_Inode(Mat,MatDuplicateOption,Mat*);
106 PETSC_INTERN PetscErrorCode MatDuplicateNoCreate_SeqAIJ(Mat,Mat,MatDuplicateOption,PetscBool);
107 PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ_Inode_inplace(Mat,Mat,const MatFactorInfo*);
108 PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ_Inode(Mat,Mat,const MatFactorInfo*);
109 
110 typedef struct {
111   SEQAIJHEADER(MatScalar);
112   Mat_SeqAIJ_Inode inode;
113   MatScalar        *saved_values;             /* location for stashing nonzero values of matrix */
114 
115   PetscScalar *idiag,*mdiag,*ssor_work;       /* inverse of diagonal entries, diagonal values and workspace for Eisenstat trick */
116   PetscBool   idiagvalid;                     /* current idiag[] and mdiag[] are valid */
117   PetscScalar *ibdiag;                        /* inverses of block diagonals */
118   PetscBool   ibdiagvalid;                    /* inverses of block diagonals are valid. */
119   PetscScalar fshift,omega;                   /* last used omega and fshift */
120 
121   ISColoring  coloring;                       /* set with MatADSetColoring() used by MatADSetValues() */
122 
123   PetscScalar         *matmult_abdense;    /* used by MatMatMult() */
124   Mat_PtAP            *ptap;               /* used by MatPtAP() */
125   Mat_MatMatMatMult   *matmatmatmult;      /* used by MatMatMatMult() */
126   Mat_RARt            *rart;               /* used by MatRARt() */
127   Mat_MatMatTransMult *abt;                /* used by MatMatTransposeMult() */
128   Mat_MatTransMatMult *atb;                /* used by MatTransposeMatMult() */
129 } Mat_SeqAIJ;
130 
131 /*
132   Frees the a, i, and j arrays from the XAIJ (AIJ, BAIJ, and SBAIJ) matrix types
133 */
134 PETSC_STATIC_INLINE PetscErrorCode MatSeqXAIJFreeAIJ(Mat AA,MatScalar **a,PetscInt **j,PetscInt **i)
135 {
136   PetscErrorCode ierr;
137   Mat_SeqAIJ     *A = (Mat_SeqAIJ*) AA->data;
138   if (A->singlemalloc) {
139     ierr = PetscFree3(*a,*j,*i);CHKERRQ(ierr);
140   } else {
141     if (A->free_a)  {ierr = PetscFree(*a);CHKERRQ(ierr);}
142     if (A->free_ij) {ierr = PetscFree(*j);CHKERRQ(ierr);}
143     if (A->free_ij) {ierr = PetscFree(*i);CHKERRQ(ierr);}
144   }
145   return 0;
146 }
147 /*
148     Allocates larger a, i, and j arrays for the XAIJ (AIJ, BAIJ, and SBAIJ) matrix types
149     This is a macro because it takes the datatype as an argument which can be either a Mat or a MatScalar
150 */
151 #define MatSeqXAIJReallocateAIJ(Amat,AM,BS2,NROW,ROW,COL,RMAX,AA,AI,AJ,RP,AP,AIMAX,NONEW,datatype) \
152   if (NROW >= RMAX) { \
153     Mat_SeqAIJ *Ain = (Mat_SeqAIJ*)Amat->data; \
154     /* there is no extra room in row, therefore enlarge */ \
155     PetscInt CHUNKSIZE = 15,new_nz = AI[AM] + CHUNKSIZE,len,*new_i=0,*new_j=0; \
156     datatype *new_a; \
157  \
158     if (NONEW == -2) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"New nonzero at (%D,%D) caused a malloc\nUse MatSetOption(A, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE) to turn off this check",ROW,COL); \
159     /* malloc new storage space */ \
160     ierr = PetscMalloc3(BS2*new_nz,&new_a,new_nz,&new_j,AM+1,&new_i);CHKERRQ(ierr); \
161  \
162     /* copy over old data into new slots */ \
163     for (ii=0; ii<ROW+1; ii++) {new_i[ii] = AI[ii];} \
164     for (ii=ROW+1; ii<AM+1; ii++) {new_i[ii] = AI[ii]+CHUNKSIZE;} \
165     ierr = PetscMemcpy(new_j,AJ,(AI[ROW]+NROW)*sizeof(PetscInt));CHKERRQ(ierr); \
166     len  = (new_nz - CHUNKSIZE - AI[ROW] - NROW); \
167     ierr = PetscMemcpy(new_j+AI[ROW]+NROW+CHUNKSIZE,AJ+AI[ROW]+NROW,len*sizeof(PetscInt));CHKERRQ(ierr); \
168     ierr = PetscMemcpy(new_a,AA,BS2*(AI[ROW]+NROW)*sizeof(datatype));CHKERRQ(ierr); \
169     ierr = PetscMemzero(new_a+BS2*(AI[ROW]+NROW),BS2*CHUNKSIZE*sizeof(datatype));CHKERRQ(ierr); \
170     ierr = PetscMemcpy(new_a+BS2*(AI[ROW]+NROW+CHUNKSIZE),AA+BS2*(AI[ROW]+NROW),BS2*len*sizeof(datatype));CHKERRQ(ierr);  \
171     /* free up old matrix storage */ \
172     ierr              = MatSeqXAIJFreeAIJ(A,&Ain->a,&Ain->j,&Ain->i);CHKERRQ(ierr); \
173     AA                = new_a; \
174     Ain->a            = (MatScalar*) new_a;                   \
175     AI                = Ain->i = new_i; AJ = Ain->j = new_j;  \
176     Ain->singlemalloc = PETSC_TRUE; \
177  \
178     RP          = AJ + AI[ROW]; AP = AA + BS2*AI[ROW]; \
179     RMAX        = AIMAX[ROW] = AIMAX[ROW] + CHUNKSIZE; \
180     Ain->maxnz += BS2*CHUNKSIZE; \
181     Ain->reallocs++; \
182   } \
183 
184 #define MatSeqXAIJReallocateAIJ_structure_only(Amat,AM,BS2,NROW,ROW,COL,RMAX,AI,AJ,RP,AIMAX,NONEW,datatype) \
185   if (NROW >= RMAX) { \
186     Mat_SeqAIJ *Ain = (Mat_SeqAIJ*)Amat->data; \
187     /* there is no extra room in row, therefore enlarge */ \
188     PetscInt CHUNKSIZE = 15,new_nz = AI[AM] + CHUNKSIZE,len,*new_i=0,*new_j=0; \
189  \
190     if (NONEW == -2) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"New nonzero at (%D,%D) caused a malloc\nUse MatSetOption(A, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE) to turn off this check",ROW,COL); \
191     /* malloc new storage space */ \
192     ierr = PetscMalloc1(new_nz,&new_j);CHKERRQ(ierr); \
193     ierr = PetscMalloc1(AM+1,&new_i);CHKERRQ(ierr);\
194  \
195     /* copy over old data into new slots */ \
196     for (ii=0; ii<ROW+1; ii++) {new_i[ii] = AI[ii];} \
197     for (ii=ROW+1; ii<AM+1; ii++) {new_i[ii] = AI[ii]+CHUNKSIZE;} \
198     ierr = PetscMemcpy(new_j,AJ,(AI[ROW]+NROW)*sizeof(PetscInt));CHKERRQ(ierr); \
199     len  = (new_nz - CHUNKSIZE - AI[ROW] - NROW); \
200     ierr = PetscMemcpy(new_j+AI[ROW]+NROW+CHUNKSIZE,AJ+AI[ROW]+NROW,len*sizeof(PetscInt));CHKERRQ(ierr); \
201  \
202     /* free up old matrix storage */ \
203     ierr              = MatSeqXAIJFreeAIJ(A,&Ain->a,&Ain->j,&Ain->i);CHKERRQ(ierr); \
204     Ain->a            = NULL;                   \
205     AI                = Ain->i = new_i; AJ = Ain->j = new_j;  \
206     Ain->singlemalloc = PETSC_FALSE; \
207     Ain->free_a       = PETSC_FALSE;             \
208  \
209     RP          = AJ + AI[ROW];    \
210     RMAX        = AIMAX[ROW] = AIMAX[ROW] + CHUNKSIZE; \
211     Ain->maxnz += BS2*CHUNKSIZE; \
212     Ain->reallocs++; \
213   } \
214 
215 PETSC_INTERN PetscErrorCode MatSeqAIJSetPreallocation_SeqAIJ(Mat,PetscInt,const PetscInt*);
216 PETSC_INTERN PetscErrorCode MatILUFactorSymbolic_SeqAIJ_inplace(Mat,Mat,IS,IS,const MatFactorInfo*);
217 PETSC_INTERN PetscErrorCode MatILUFactorSymbolic_SeqAIJ(Mat,Mat,IS,IS,const MatFactorInfo*);
218 PETSC_INTERN PetscErrorCode MatILUFactorSymbolic_SeqAIJ_ilu0(Mat,Mat,IS,IS,const MatFactorInfo*);
219 
220 PETSC_INTERN PetscErrorCode MatICCFactorSymbolic_SeqAIJ_inplace(Mat,Mat,IS,const MatFactorInfo*);
221 PETSC_INTERN PetscErrorCode MatICCFactorSymbolic_SeqAIJ(Mat,Mat,IS,const MatFactorInfo*);
222 PETSC_INTERN PetscErrorCode MatCholeskyFactorSymbolic_SeqAIJ_inplace(Mat,Mat,IS,const MatFactorInfo*);
223 PETSC_INTERN PetscErrorCode MatCholeskyFactorSymbolic_SeqAIJ(Mat,Mat,IS,const MatFactorInfo*);
224 PETSC_INTERN PetscErrorCode MatCholeskyFactorNumeric_SeqAIJ_inplace(Mat,Mat,const MatFactorInfo*);
225 PETSC_INTERN PetscErrorCode MatCholeskyFactorNumeric_SeqAIJ(Mat,Mat,const MatFactorInfo*);
226 PETSC_INTERN PetscErrorCode MatDuplicate_SeqAIJ(Mat,MatDuplicateOption,Mat*);
227 PETSC_INTERN PetscErrorCode MatCopy_SeqAIJ(Mat,Mat,MatStructure);
228 PETSC_INTERN PetscErrorCode MatMissingDiagonal_SeqAIJ(Mat,PetscBool*,PetscInt*);
229 PETSC_INTERN PetscErrorCode MatMarkDiagonal_SeqAIJ(Mat);
230 PETSC_INTERN PetscErrorCode MatFindZeroDiagonals_SeqAIJ_Private(Mat,PetscInt*,PetscInt**);
231 
232 PETSC_INTERN PetscErrorCode MatMult_SeqAIJ(Mat A,Vec,Vec);
233 PETSC_INTERN PetscErrorCode MatMultAdd_SeqAIJ(Mat A,Vec,Vec,Vec);
234 PETSC_INTERN PetscErrorCode MatMultTranspose_SeqAIJ(Mat A,Vec,Vec);
235 PETSC_INTERN PetscErrorCode MatMultTransposeAdd_SeqAIJ(Mat A,Vec,Vec,Vec);
236 PETSC_INTERN PetscErrorCode MatSOR_SeqAIJ(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
237 
238 PETSC_INTERN PetscErrorCode MatSetOption_SeqAIJ(Mat,MatOption,PetscBool);
239 
240 PETSC_INTERN PetscErrorCode MatGetSymbolicTranspose_SeqAIJ(Mat,PetscInt *[],PetscInt *[]);
241 PETSC_INTERN PetscErrorCode MatGetSymbolicTransposeReduced_SeqAIJ(Mat,PetscInt,PetscInt,PetscInt *[],PetscInt *[]);
242 PETSC_INTERN PetscErrorCode MatRestoreSymbolicTranspose_SeqAIJ(Mat,PetscInt *[],PetscInt *[]);
243 PETSC_INTERN PetscErrorCode MatTransposeSymbolic_SeqAIJ(Mat,Mat*);
244 PETSC_INTERN PetscErrorCode MatTranspose_SeqAIJ(Mat,MatReuse,Mat*);
245 PETSC_INTERN PetscErrorCode MatToSymmetricIJ_SeqAIJ(PetscInt,PetscInt*,PetscInt*,PetscBool,PetscInt,PetscInt,PetscInt**,PetscInt**);
246 PETSC_INTERN PetscErrorCode MatLUFactorSymbolic_SeqAIJ_inplace(Mat,Mat,IS,IS,const MatFactorInfo*);
247 PETSC_INTERN PetscErrorCode MatLUFactorSymbolic_SeqAIJ(Mat,Mat,IS,IS,const MatFactorInfo*);
248 PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ_inplace(Mat,Mat,const MatFactorInfo*);
249 PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ(Mat,Mat,const MatFactorInfo*);
250 PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ_InplaceWithPerm(Mat,Mat,const MatFactorInfo*);
251 PETSC_INTERN PetscErrorCode MatLUFactor_SeqAIJ(Mat,IS,IS,const MatFactorInfo*);
252 PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_inplace(Mat,Vec,Vec);
253 PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ(Mat,Vec,Vec);
254 PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_Inode_inplace(Mat,Vec,Vec);
255 PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_Inode(Mat,Vec,Vec);
256 PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_NaturalOrdering_inplace(Mat,Vec,Vec);
257 PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_NaturalOrdering(Mat,Vec,Vec);
258 PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_InplaceWithPerm(Mat,Vec,Vec);
259 PETSC_INTERN PetscErrorCode MatSolveAdd_SeqAIJ_inplace(Mat,Vec,Vec,Vec);
260 PETSC_INTERN PetscErrorCode MatSolveAdd_SeqAIJ(Mat,Vec,Vec,Vec);
261 PETSC_INTERN PetscErrorCode MatSolveTranspose_SeqAIJ_inplace(Mat,Vec,Vec);
262 PETSC_INTERN PetscErrorCode MatSolveTranspose_SeqAIJ(Mat,Vec,Vec);
263 PETSC_INTERN PetscErrorCode MatSolveTransposeAdd_SeqAIJ_inplace(Mat,Vec,Vec,Vec);
264 PETSC_INTERN PetscErrorCode MatSolveTransposeAdd_SeqAIJ(Mat,Vec,Vec,Vec);
265 PETSC_INTERN PetscErrorCode MatMatSolve_SeqAIJ_inplace(Mat,Mat,Mat);
266 PETSC_INTERN PetscErrorCode MatMatSolve_SeqAIJ(Mat,Mat,Mat);
267 PETSC_INTERN PetscErrorCode MatEqual_SeqAIJ(Mat,Mat,PetscBool*);
268 PETSC_INTERN PetscErrorCode MatFDColoringCreate_SeqXAIJ(Mat,ISColoring,MatFDColoring);
269 PETSC_INTERN PetscErrorCode MatFDColoringSetUp_SeqXAIJ(Mat,ISColoring,MatFDColoring);
270 PETSC_INTERN PetscErrorCode MatFDColoringSetUpBlocked_AIJ_Private(Mat,MatFDColoring,PetscInt);
271 PETSC_INTERN PetscErrorCode MatLoad_SeqAIJ(Mat,PetscViewer);
272 PETSC_INTERN PetscErrorCode RegisterApplyPtAPRoutines_Private(Mat);
273 
274 PETSC_INTERN PetscErrorCode MatMatMult_SeqAIJ_SeqAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
275 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ(Mat,Mat,PetscReal,Mat*);
276 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqDense_SeqAIJ(Mat,Mat,PetscReal,Mat*);
277 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_Scalable(Mat,Mat,PetscReal,Mat*);
278 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_Scalable_fast(Mat,Mat,PetscReal,Mat*);
279 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_Heap(Mat,Mat,PetscReal,Mat*);
280 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_BTHeap(Mat,Mat,PetscReal,Mat*);
281 PETSC_INTERN PetscErrorCode MatMatMultNumeric_SeqAIJ_SeqAIJ(Mat,Mat,Mat);
282 PETSC_INTERN PetscErrorCode MatMatMultNumeric_SeqDense_SeqAIJ(Mat,Mat,Mat);
283 PETSC_INTERN PetscErrorCode MatMatMultNumeric_SeqAIJ_SeqAIJ_Scalable(Mat,Mat,Mat);
284 
285 PETSC_INTERN PetscErrorCode MatPtAP_SeqAIJ_SeqAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
286 PETSC_INTERN PetscErrorCode MatPtAPSymbolic_SeqAIJ_SeqAIJ_SparseAxpy(Mat,Mat,PetscReal,Mat*);
287 PETSC_INTERN PetscErrorCode MatPtAPNumeric_SeqAIJ_SeqAIJ(Mat,Mat,Mat);
288 PETSC_INTERN PetscErrorCode MatPtAPNumeric_SeqAIJ_SeqAIJ_SparseAxpy(Mat,Mat,Mat);
289 
290 PETSC_INTERN PetscErrorCode MatRARtSymbolic_SeqAIJ_SeqAIJ(Mat,Mat,PetscReal,Mat*);
291 PETSC_INTERN PetscErrorCode MatRARtSymbolic_SeqAIJ_SeqAIJ_matmattransposemult(Mat,Mat,PetscReal,Mat*);
292 PETSC_INTERN PetscErrorCode MatRARtSymbolic_SeqAIJ_SeqAIJ_colorrart(Mat,Mat,PetscReal,Mat*);
293 PETSC_INTERN PetscErrorCode MatRARtNumeric_SeqAIJ_SeqAIJ(Mat,Mat,Mat);
294 PETSC_INTERN PetscErrorCode MatRARtNumeric_SeqAIJ_SeqAIJ_matmattransposemult(Mat,Mat,Mat);
295 PETSC_INTERN PetscErrorCode MatRARtNumeric_SeqAIJ_SeqAIJ_colorrart(Mat,Mat,Mat);
296 
297 PETSC_INTERN PetscErrorCode MatTransposeMatMult_SeqAIJ_SeqAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
298 PETSC_INTERN PetscErrorCode MatTransposeMatMultSymbolic_SeqAIJ_SeqAIJ(Mat,Mat,PetscReal,Mat*);
299 PETSC_INTERN PetscErrorCode MatTransposeMatMultNumeric_SeqAIJ_SeqAIJ(Mat,Mat,Mat);
300 PETSC_INTERN PetscErrorCode MatDestroy_SeqAIJ_MatTransMatMult(Mat);
301 
302 PETSC_INTERN PetscErrorCode MatTransposeMatMult_SeqAIJ_SeqDense(Mat,Mat,MatReuse,PetscReal,Mat*);
303 PETSC_INTERN PetscErrorCode MatTransposeMatMultSymbolic_SeqAIJ_SeqDense(Mat,Mat,PetscReal,Mat*);
304 PETSC_INTERN PetscErrorCode MatTransposeMatMultNumeric_SeqAIJ_SeqDense(Mat,Mat,Mat);
305 
306 PETSC_INTERN PetscErrorCode MatMatTransposeMult_SeqAIJ_SeqAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
307 PETSC_INTERN PetscErrorCode MatMatTransposeMultSymbolic_SeqAIJ_SeqAIJ(Mat,Mat,PetscReal,Mat*);
308 PETSC_INTERN PetscErrorCode MatMatTransposeMultNumeric_SeqAIJ_SeqAIJ(Mat,Mat,Mat);
309 PETSC_INTERN PetscErrorCode MatTransposeColoringCreate_SeqAIJ(Mat,ISColoring,MatTransposeColoring);
310 PETSC_INTERN PetscErrorCode MatTransColoringApplySpToDen_SeqAIJ(MatTransposeColoring,Mat,Mat);
311 PETSC_INTERN PetscErrorCode MatTransColoringApplyDenToSp_SeqAIJ(MatTransposeColoring,Mat,Mat);
312 
313 PETSC_INTERN PetscErrorCode MatMatMatMult_SeqAIJ_SeqAIJ_SeqAIJ(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
314 PETSC_INTERN PetscErrorCode MatMatMatMultSymbolic_SeqAIJ_SeqAIJ_SeqAIJ(Mat,Mat,Mat,PetscReal,Mat*);
315 PETSC_INTERN PetscErrorCode MatMatMatMultNumeric_SeqAIJ_SeqAIJ_SeqAIJ(Mat,Mat,Mat,Mat);
316 
317 PETSC_INTERN PetscErrorCode MatSetValues_SeqAIJ(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
318 PETSC_INTERN PetscErrorCode MatGetRow_SeqAIJ(Mat,PetscInt,PetscInt*,PetscInt**,PetscScalar**);
319 PETSC_INTERN PetscErrorCode MatRestoreRow_SeqAIJ(Mat,PetscInt,PetscInt*,PetscInt**,PetscScalar**);
320 PETSC_INTERN PetscErrorCode MatScale_SeqAIJ(Mat,PetscScalar);
321 PETSC_INTERN PetscErrorCode MatDiagonalScale_SeqAIJ(Mat,Vec,Vec);
322 PETSC_INTERN PetscErrorCode MatDiagonalSet_SeqAIJ(Mat,Vec,InsertMode);
323 PETSC_INTERN PetscErrorCode MatAXPY_SeqAIJ(Mat,PetscScalar,Mat,MatStructure);
324 PETSC_INTERN PetscErrorCode MatGetRowIJ_SeqAIJ(Mat,PetscInt,PetscBool,PetscBool,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool*);
325 PETSC_INTERN PetscErrorCode MatRestoreRowIJ_SeqAIJ(Mat,PetscInt,PetscBool,PetscBool,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool*);
326 PETSC_INTERN PetscErrorCode MatGetColumnIJ_SeqAIJ(Mat,PetscInt,PetscBool,PetscBool,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool*);
327 PETSC_INTERN PetscErrorCode MatRestoreColumnIJ_SeqAIJ(Mat,PetscInt,PetscBool,PetscBool,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool*);
328 PETSC_INTERN PetscErrorCode MatGetColumnIJ_SeqAIJ_Color(Mat,PetscInt,PetscBool,PetscBool,PetscInt*,const PetscInt *[],const PetscInt *[],PetscInt *[],PetscBool*);
329 PETSC_INTERN PetscErrorCode MatRestoreColumnIJ_SeqAIJ_Color(Mat,PetscInt,PetscBool,PetscBool,PetscInt*,const PetscInt *[],const PetscInt *[],PetscInt *[],PetscBool*);
330 PETSC_INTERN PetscErrorCode MatDestroy_SeqAIJ(Mat);
331 PETSC_INTERN PetscErrorCode MatSetUp_SeqAIJ(Mat);
332 PETSC_INTERN PetscErrorCode MatView_SeqAIJ(Mat,PetscViewer);
333 
334 PETSC_INTERN PetscErrorCode MatSeqAIJInvalidateDiagonal(Mat);
335 PETSC_INTERN PetscErrorCode MatSeqAIJInvalidateDiagonal_Inode(Mat);
336 PETSC_INTERN PetscErrorCode MatSeqAIJCheckInode(Mat);
337 PETSC_INTERN PetscErrorCode MatSeqAIJCheckInode_FactorLU(Mat);
338 
339 PETSC_INTERN PetscErrorCode MatAXPYGetPreallocation_SeqAIJ(Mat,Mat,PetscInt*);
340 
341 PETSC_INTERN PetscErrorCode MatMatMatMult_Transpose_AIJ_AIJ(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
342 PETSC_EXTERN PetscErrorCode MatlabEnginePut_SeqAIJ(PetscObject,void*);
343 PETSC_EXTERN PetscErrorCode MatlabEngineGet_SeqAIJ(PetscObject,void*);
344 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqSBAIJ(Mat,MatType,MatReuse,Mat*);
345 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqBAIJ(Mat,MatType,MatReuse,Mat*);
346 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqDense(Mat,MatType,MatReuse,Mat*);
347 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJCRL(Mat,MatType,MatReuse,Mat*);
348 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_Elemental(Mat,MatType,MatReuse,Mat*);
349 PETSC_INTERN PetscErrorCode MatConvert_AIJ_HYPRE(Mat,MatType,MatReuse,Mat*);
350 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJPERM(Mat,MatType,MatReuse,Mat*);
351 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJMKL(Mat,MatType,MatReuse,Mat*);
352 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJViennaCL(Mat,MatType,MatReuse,Mat*);
353 PETSC_INTERN PetscErrorCode MatReorderForNonzeroDiagonal_SeqAIJ(Mat,PetscReal,IS,IS);
354 PETSC_INTERN PetscErrorCode MatMatMult_SeqDense_SeqAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
355 PETSC_INTERN PetscErrorCode MatRARt_SeqAIJ_SeqAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
356 PETSC_EXTERN PetscErrorCode MatCreate_SeqAIJ(Mat);
357 PETSC_INTERN PetscErrorCode MatAssemblyEnd_SeqAIJ(Mat,MatAssemblyType);
358 
359 PETSC_INTERN PetscErrorCode MatAXPYGetPreallocation_SeqX_private(PetscInt,const PetscInt*,const PetscInt*,const PetscInt*,const PetscInt*,PetscInt*);
360 PETSC_INTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat_SeqAIJ(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
361 PETSC_INTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat_MPIAIJ(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
362 
363 PETSC_INTERN PetscErrorCode MatSetSeqMat_SeqAIJ(Mat,IS,IS,MatStructure,Mat);
364 PETSC_INTERN PetscErrorCode MatDestroySubMatrix_Private(Mat_SubSppt*);
365 PETSC_INTERN PetscErrorCode MatDestroySubMatrix_SeqAIJ(Mat);
366 PETSC_INTERN PetscErrorCode MatDestroySubMatrix_Dummy(Mat);
367 PETSC_INTERN PetscErrorCode MatCreateSubMatrix_SeqAIJ(Mat,IS,IS,PetscInt,MatReuse,Mat*);
368 
369 /*
370     PetscSparseDenseMinusDot - The inner kernel of triangular solves and Gauss-Siedel smoothing. \sum_i xv[i] * r[xi[i]] for CSR storage
371 
372   Input Parameters:
373 +  nnz - the number of entries
374 .  r - the array of vector values
375 .  xv - the matrix values for the row
376 -  xi - the column indices of the nonzeros in the row
377 
378   Output Parameter:
379 .  sum - negative the sum of results
380 
381   PETSc compile flags:
382 +   PETSC_KERNEL_USE_UNROLL_4 -   don't use this; it changes nnz and hence is WRONG
383 -   PETSC_KERNEL_USE_UNROLL_2 -
384 
385 .seealso: PetscSparseDensePlusDot()
386 
387 */
388 #if defined(PETSC_KERNEL_USE_UNROLL_4)
389 #define PetscSparseDenseMinusDot(sum,r,xv,xi,nnz) { \
390     if (nnz > 0) { \
391       switch (nnz & 0x3) { \
392       case 3: sum -= *xv++ *r[*xi++]; \
393       case 2: sum -= *xv++ *r[*xi++]; \
394       case 1: sum -= *xv++ *r[*xi++]; \
395         nnz       -= 4;} \
396       while (nnz > 0) { \
397         sum -=  xv[0] * r[xi[0]] - xv[1] * r[xi[1]] - \
398                xv[2] * r[xi[2]] - xv[3] * r[xi[3]]; \
399         xv += 4; xi += 4; nnz -= 4; }}}
400 
401 #elif defined(PETSC_KERNEL_USE_UNROLL_2)
402 #define PetscSparseDenseMinusDot(sum,r,xv,xi,nnz) { \
403     PetscInt __i,__i1,__i2; \
404     for (__i=0; __i<nnz-1; __i+=2) {__i1 = xi[__i]; __i2=xi[__i+1]; \
405                                     sum -= (xv[__i]*r[__i1] + xv[__i+1]*r[__i2]);} \
406     if (nnz & 0x1) sum -= xv[__i] * r[xi[__i]];}
407 
408 #else
409 #define PetscSparseDenseMinusDot(sum,r,xv,xi,nnz) { \
410     PetscInt __i; \
411     for (__i=0; __i<nnz; __i++) sum -= xv[__i] * r[xi[__i]];}
412 #endif
413 
414 
415 
416 /*
417     PetscSparseDensePlusDot - The inner kernel of matrix-vector product \sum_i xv[i] * r[xi[i]] for CSR storage
418 
419   Input Parameters:
420 +  nnz - the number of entries
421 .  r - the array of vector values
422 .  xv - the matrix values for the row
423 -  xi - the column indices of the nonzeros in the row
424 
425   Output Parameter:
426 .  sum - the sum of results
427 
428   PETSc compile flags:
429 +   PETSC_KERNEL_USE_UNROLL_4 -  don't use this; it changes nnz and hence is WRONG
430 -   PETSC_KERNEL_USE_UNROLL_2 -
431 
432 .seealso: PetscSparseDenseMinusDot()
433 
434 */
435 #if defined(PETSC_KERNEL_USE_UNROLL_4)
436 #define PetscSparseDensePlusDot(sum,r,xv,xi,nnz) { \
437     if (nnz > 0) { \
438       switch (nnz & 0x3) { \
439       case 3: sum += *xv++ *r[*xi++]; \
440       case 2: sum += *xv++ *r[*xi++]; \
441       case 1: sum += *xv++ *r[*xi++]; \
442         nnz       -= 4;} \
443       while (nnz > 0) { \
444         sum +=  xv[0] * r[xi[0]] + xv[1] * r[xi[1]] + \
445                xv[2] * r[xi[2]] + xv[3] * r[xi[3]]; \
446         xv += 4; xi += 4; nnz -= 4; }}}
447 
448 #elif defined(PETSC_KERNEL_USE_UNROLL_2)
449 #define PetscSparseDensePlusDot(sum,r,xv,xi,nnz) { \
450     PetscInt __i,__i1,__i2; \
451     for (__i=0; __i<nnz-1; __i+=2) {__i1 = xi[__i]; __i2=xi[__i+1]; \
452                                     sum += (xv[__i]*r[__i1] + xv[__i+1]*r[__i2]);} \
453     if (nnz & 0x1) sum += xv[__i] * r[xi[__i]];}
454 
455 #else
456 #define PetscSparseDensePlusDot(sum,r,xv,xi,nnz) { \
457     PetscInt __i; \
458     for (__i=0; __i<nnz; __i++) sum += xv[__i] * r[xi[__i]];}
459 #endif
460 
461 
462 /*
463     PetscSparseDenseMaxDot - The inner kernel of a modified matrix-vector product \max_i xv[i] * r[xi[i]] for CSR storage
464 
465   Input Parameters:
466 +  nnz - the number of entries
467 .  r - the array of vector values
468 .  xv - the matrix values for the row
469 -  xi - the column indices of the nonzeros in the row
470 
471   Output Parameter:
472 .  max - the max of results
473 
474 .seealso: PetscSparseDensePlusDot(), PetscSparseDenseMinusDot()
475 
476 */
477 #define PetscSparseDenseMaxDot(max,r,xv,xi,nnz) { \
478     PetscInt __i; \
479     for (__i=0; __i<nnz; __i++) max = PetscMax(PetscRealPart(max), PetscRealPart(xv[__i] * r[xi[__i]]));}
480 
481 /*
482  Add column indices into table for counting the max nonzeros of merged rows
483  */
484 #define MatRowMergeMax_SeqAIJ(mat,nrows,ta) {       \
485     PetscInt _j,_row,_nz,*_col;                     \
486     if (mat) { \
487       for (_row=0; _row<nrows; _row++) {   \
488         _nz = mat->i[_row+1] - mat->i[_row];    \
489         for (_j=0; _j<_nz; _j++) {               \
490           _col = _j + mat->j + mat->i[_row];       \
491           PetscTableAdd(ta,*_col+1,1,INSERT_VALUES);                    \
492         }                                                               \
493       }                                                                 \
494     }    \
495 }
496 
497 /*
498  Add column indices into table for counting the nonzeros of merged rows
499  */
500 #define MatMergeRows_SeqAIJ(mat,nrows,rows,ta) {    \
501   PetscInt _j,_row,_nz,*_col,_i;                      \
502     for (_i=0; _i<nrows; _i++) {\
503       _row = rows[_i]; \
504       _nz = mat->i[_row+1] - mat->i[_row]; \
505       for (_j=0; _j<_nz; _j++) {                \
506         _col = _j + mat->j + mat->i[_row];       \
507         PetscTableAdd(ta,*_col+1,1,INSERT_VALUES); \
508       }                                                                 \
509     }                                                                   \
510 }
511 
512 #endif
513