xref: /petsc/src/mat/impls/aij/seq/aijfact.c (revision 2b5a27fc12809319185defe9d9fed64c4e7d6059)
1 #ifdef PETSC_RCS_HEADER
2 static char vcid[] = "$Id: aijfact.c,v 1.108 1998/07/27 21:53:13 bsmith Exp bsmith $";
3 #endif
4 
5 #include "src/mat/impls/aij/seq/aij.h"
6 #include "src/vec/vecimpl.h"
7 #include "src/inline/dot.h"
8 
9 #undef __FUNC__
10 #define __FUNC__ "MatOrder_Flow_SeqAIJ"
11 int MatOrder_Flow_SeqAIJ(Mat mat,MatReorderingType type,IS *irow,IS *icol)
12 {
13   PetscFunctionBegin;
14 
15   SETERRQ(PETSC_ERR_SUP,0,"Code not written");
16 #if !defined(USE_PETSC_DEBUG)
17   PetscFunctionReturn(0);
18 #endif
19 }
20 
21 /*
22     Factorization code for AIJ format.
23 */
24 #undef __FUNC__
25 #define __FUNC__ "MatLUFactorSymbolic_SeqAIJ"
26 int MatLUFactorSymbolic_SeqAIJ(Mat A,IS isrow,IS iscol,double f,Mat *B)
27 {
28   Mat_SeqAIJ *a = (Mat_SeqAIJ *) A->data, *b;
29   IS         isicol;
30   int        *r,*ic, ierr, i, n = a->m, *ai = a->i, *aj = a->j;
31   int        *ainew,*ajnew, jmax,*fill, *ajtmp, nz,shift = a->indexshift;
32   int        *idnew, idx, row,m,fm, nnz, nzi, realloc = 0,nzbd,*im;
33 
34   PetscFunctionBegin;
35   PetscValidHeaderSpecific(isrow,IS_COOKIE);
36   PetscValidHeaderSpecific(iscol,IS_COOKIE);
37 
38   ierr = ISInvertPermutation(iscol,&isicol); CHKERRQ(ierr);
39   ierr = ISGetIndices(isrow,&r); CHKERRQ(ierr);
40   ierr = ISGetIndices(isicol,&ic); CHKERRQ(ierr);
41 
42   /* get new row pointers */
43   ainew    = (int *) PetscMalloc( (n+1)*sizeof(int) ); CHKPTRQ(ainew);
44   ainew[0] = -shift;
45   /* don't know how many column pointers are needed so estimate */
46   jmax  = (int) (f*ai[n]+(!shift));
47   ajnew = (int *) PetscMalloc( (jmax)*sizeof(int) ); CHKPTRQ(ajnew);
48   /* fill is a linked list of nonzeros in active row */
49   fill = (int *) PetscMalloc( (2*n+1)*sizeof(int)); CHKPTRQ(fill);
50   im   = fill + n + 1;
51   /* idnew is location of diagonal in factor */
52   idnew    = (int *) PetscMalloc( (n+1)*sizeof(int)); CHKPTRQ(idnew);
53   idnew[0] = -shift;
54 
55   for ( i=0; i<n; i++ ) {
56     /* first copy previous fill into linked list */
57     nnz     = nz    = ai[r[i]+1] - ai[r[i]];
58     if (!nz) SETERRQ(PETSC_ERR_MAT_LU_ZRPVT,1,"Empty row in matrix");
59     ajtmp   = aj + ai[r[i]] + shift;
60     fill[n] = n;
61     while (nz--) {
62       fm  = n;
63       idx = ic[*ajtmp++ + shift];
64       do {
65         m  = fm;
66         fm = fill[m];
67       } while (fm < idx);
68       fill[m]   = idx;
69       fill[idx] = fm;
70     }
71     row = fill[n];
72     while ( row < i ) {
73       ajtmp = ajnew + idnew[row] + (!shift);
74       nzbd  = 1 + idnew[row] - ainew[row];
75       nz    = im[row] - nzbd;
76       fm    = row;
77       while (nz-- > 0) {
78         idx = *ajtmp++ + shift;
79         nzbd++;
80         if (idx == i) im[row] = nzbd;
81         do {
82           m  = fm;
83           fm = fill[m];
84         } while (fm < idx);
85         if (fm != idx) {
86           fill[m]   = idx;
87           fill[idx] = fm;
88           fm        = idx;
89           nnz++;
90         }
91       }
92       row = fill[row];
93     }
94     /* copy new filled row into permanent storage */
95     ainew[i+1] = ainew[i] + nnz;
96     if (ainew[i+1] > jmax) {
97 
98       /* estimate how much additional space we will need */
99       /* use the strategy suggested by David Hysom <hysom@perch-t.icase.edu> */
100       /* just double the memory each time */
101       int maxadd = jmax;
102       /* maxadd = (int) ((f*(ai[n]+(!shift))*(n-i+5))/n); */
103       if (maxadd < nnz) maxadd = (n-i)*(nnz+1);
104       jmax += maxadd;
105 
106       /* allocate a longer ajnew */
107       ajtmp = (int *) PetscMalloc( jmax*sizeof(int) );CHKPTRQ(ajtmp);
108       PetscMemcpy(ajtmp,ajnew,(ainew[i]+shift)*sizeof(int));
109       PetscFree(ajnew);
110       ajnew = ajtmp;
111       realloc++; /* count how many times we realloc */
112     }
113     ajtmp = ajnew + ainew[i] + shift;
114     fm    = fill[n];
115     nzi   = 0;
116     im[i] = nnz;
117     while (nnz--) {
118       if (fm < i) nzi++;
119       *ajtmp++ = fm - shift;
120       fm       = fill[fm];
121     }
122     idnew[i] = ainew[i] + nzi;
123   }
124   if (ai[n] != 0) {
125     double af = ((double)ainew[n])/((double)ai[n]);
126     PLogInfo(A,"MatLUFactorSymbolic_SeqAIJ:Reallocs %d Fill ratio:given %g needed %g\n",
127              realloc,f,af);
128     PLogInfo(A,"MatLUFactorSymbolic_SeqAIJ:Run with -pc_lu_fill %g or use \n",af);
129     PLogInfo(A,"MatLUFactorSymbolic_SeqAIJ:PCLUSetFill(pc,%g);\n",af);
130     PLogInfo(A,"MatLUFactorSymbolic_SeqAIJ:for best performance.\n");
131   } else {
132     PLogInfo(A,"MatLUFactorSymbolic_SeqAIJ: Empty matrix\n");
133   }
134 
135   ierr = ISRestoreIndices(isrow,&r); CHKERRQ(ierr);
136   ierr = ISRestoreIndices(isicol,&ic); CHKERRQ(ierr);
137 
138   PetscFree(fill);
139 
140   /* put together the new matrix */
141   ierr = MatCreateSeqAIJ(A->comm,n,n,0,PETSC_NULL,B); CHKERRQ(ierr);
142   PLogObjectParent(*B,isicol);
143   b = (Mat_SeqAIJ *) (*B)->data;
144   PetscFree(b->imax);
145   b->singlemalloc = 0;
146   /* the next line frees the default space generated by the Create() */
147   PetscFree(b->a); PetscFree(b->ilen);
148   b->a          = (Scalar *) PetscMalloc((ainew[n]+shift+1)*sizeof(Scalar));CHKPTRQ(b->a);
149   b->j          = ajnew;
150   b->i          = ainew;
151   b->diag       = idnew;
152   b->ilen       = 0;
153   b->imax       = 0;
154   b->row        = isrow;
155   b->col        = iscol;
156   b->icol       = isicol;
157   b->solve_work = (Scalar *) PetscMalloc( (n+1)*sizeof(Scalar));CHKPTRQ(b->solve_work);
158   /* In b structure:  Free imax, ilen, old a, old j.
159      Allocate idnew, solve_work, new a, new j */
160   PLogObjectMemory(*B,(ainew[n]+shift-n)*(sizeof(int)+sizeof(Scalar)));
161   b->maxnz = b->nz = ainew[n] + shift;
162 
163   (*B)->factor                 =  FACTOR_LU;;
164   (*B)->info.factor_mallocs    = realloc;
165   (*B)->info.fill_ratio_given  = f;
166   if (ai[n] != 0) {
167     (*B)->info.fill_ratio_needed = ((double)ainew[n])/((double)ai[n]);
168   } else {
169     (*B)->info.fill_ratio_needed = 0.0;
170   }
171 
172   PetscFunctionReturn(0);
173 }
174 /* ----------------------------------------------------------- */
175 int Mat_AIJ_CheckInode(Mat);
176 
177 #undef __FUNC__
178 #define __FUNC__ "MatLUFactorNumeric_SeqAIJ"
179 int MatLUFactorNumeric_SeqAIJ(Mat A,Mat *B)
180 {
181   Mat        C = *B;
182   Mat_SeqAIJ *a = (Mat_SeqAIJ *) A->data, *b = (Mat_SeqAIJ *)C->data;
183   IS         isrow = b->row, isicol = b->icol;
184   int        *r,*ic, ierr, i, j, n = a->m, *ai = b->i, *aj = b->j;
185   int        *ajtmpold, *ajtmp, nz, row, *ics, shift = a->indexshift;
186   int        *diag_offset = b->diag,diag,k;
187   int        preserve_row_sums = (int) a->ilu_preserve_row_sums;
188   register   int    *pj;
189   Scalar     *rtmp,*v, *pc, multiplier,sum,inner_sum,*rowsums = 0;
190   double     ssum;
191   register   Scalar *pv, *rtmps,*u_values;
192 
193   PetscFunctionBegin;
194 
195   ierr  = ISGetIndices(isrow,&r); CHKERRQ(ierr);
196   ierr  = ISGetIndices(isicol,&ic); CHKERRQ(ierr);
197   rtmp  = (Scalar *) PetscMalloc( (n+1)*sizeof(Scalar) ); CHKPTRQ(rtmp);
198   PetscMemzero(rtmp,(n+1)*sizeof(Scalar));
199   rtmps = rtmp + shift; ics = ic + shift;
200 
201   /* precalcuate row sums */
202   if (preserve_row_sums) {
203     rowsums = (Scalar *) PetscMalloc( n*sizeof(Scalar) ); CHKPTRQ(rowsums);
204     for ( i=0; i<n; i++ ) {
205       nz  = a->i[r[i]+1] - a->i[r[i]];
206       v   = a->a + a->i[r[i]] + shift;
207       sum = 0.0;
208       for ( j=0; j<nz; j++ ) sum += v[j];
209       rowsums[i] = sum;
210     }
211   }
212 
213   for ( i=0; i<n; i++ ) {
214     nz    = ai[i+1] - ai[i];
215     ajtmp = aj + ai[i] + shift;
216     for  ( j=0; j<nz; j++ ) rtmps[ajtmp[j]] = 0.0;
217 
218     /* load in initial (unfactored row) */
219     nz       = a->i[r[i]+1] - a->i[r[i]];
220     ajtmpold = a->j + a->i[r[i]] + shift;
221     v        = a->a + a->i[r[i]] + shift;
222     for ( j=0; j<nz; j++ ) rtmp[ics[ajtmpold[j]]] =  v[j];
223 
224     row = *ajtmp++ + shift;
225       while  (row < i ) {
226       pc = rtmp + row;
227       if (*pc != 0.0) {
228         pv         = b->a + diag_offset[row] + shift;
229         pj         = b->j + diag_offset[row] + (!shift);
230         multiplier = *pc / *pv++;
231         *pc        = multiplier;
232         nz         = ai[row+1] - diag_offset[row] - 1;
233         for (j=0; j<nz; j++) rtmps[pj[j]] -= multiplier * pv[j];
234         PLogFlops(2*nz);
235       }
236       row = *ajtmp++ + shift;
237     }
238     /* finished row so stick it into b->a */
239     pv = b->a + ai[i] + shift;
240     pj = b->j + ai[i] + shift;
241     nz = ai[i+1] - ai[i];
242     for ( j=0; j<nz; j++ ) {pv[j] = rtmps[pj[j]];}
243     diag = diag_offset[i] - ai[i];
244     /*
245           Possibly adjust diagonal entry on current row to force
246         LU matrix to have same row sum as initial matrix.
247     */
248     if (pv[diag] == 0.0) {
249       SETERRQ(PETSC_ERR_MAT_LU_ZRPVT,0,"Zero pivot");
250     }
251     if (preserve_row_sums) {
252       pj  = b->j + ai[i] + shift;
253       sum = rowsums[i];
254       for ( j=0; j<diag; j++ ) {
255         u_values  = b->a + diag_offset[pj[j]] + shift;
256         nz        = ai[pj[j]+1] - diag_offset[pj[j]];
257         inner_sum = 0.0;
258         for ( k=0; k<nz; k++ ) {
259           inner_sum += u_values[k];
260         }
261         sum -= pv[j]*inner_sum;
262 
263       }
264       nz       = ai[i+1] - diag_offset[i] - 1;
265       u_values = b->a + diag_offset[i] + 1 + shift;
266       for ( k=0; k<nz; k++ ) {
267         sum -= u_values[k];
268       }
269       ssum = PetscAbsScalar(sum/pv[diag]);
270       if (ssum < 1000. && ssum > .001) pv[diag] = sum;
271     }
272     /* check pivot entry for current row */
273   }
274 
275   /* invert diagonal entries for simplier triangular solves */
276   for ( i=0; i<n; i++ ) {
277     b->a[diag_offset[i]+shift] = 1.0/b->a[diag_offset[i]+shift];
278   }
279 
280   if (preserve_row_sums) PetscFree(rowsums);
281   PetscFree(rtmp);
282   ierr = ISRestoreIndices(isicol,&ic); CHKERRQ(ierr);
283   ierr = ISRestoreIndices(isrow,&r); CHKERRQ(ierr);
284   C->factor = FACTOR_LU;
285   ierr = Mat_AIJ_CheckInode(C); CHKERRQ(ierr);
286   C->assembled = PETSC_TRUE;
287   PLogFlops(b->n);
288   PetscFunctionReturn(0);
289 }
290 /* ----------------------------------------------------------- */
291 #undef __FUNC__
292 #define __FUNC__ "MatLUFactor_SeqAIJ"
293 int MatLUFactor_SeqAIJ(Mat A,IS row,IS col,double f)
294 {
295   Mat_SeqAIJ     *mat = (Mat_SeqAIJ *) A->data;
296   int            ierr;
297   Mat            C;
298   PetscOps       *Abops;
299   MatOps         Aops;
300 
301   PetscFunctionBegin;
302   ierr = MatLUFactorSymbolic(A,row,col,f,&C); CHKERRQ(ierr);
303   ierr = MatLUFactorNumeric(A,&C); CHKERRQ(ierr);
304 
305   /* free all the data structures from mat */
306   PetscFree(mat->a);
307   if (!mat->singlemalloc) {PetscFree(mat->i); PetscFree(mat->j);}
308   if (mat->diag) PetscFree(mat->diag);
309   if (mat->ilen) PetscFree(mat->ilen);
310   if (mat->imax) PetscFree(mat->imax);
311   if (mat->solve_work) PetscFree(mat->solve_work);
312   if (mat->inode.size) PetscFree(mat->inode.size);
313   if (mat->icol) {ierr = ISDestroy(mat->icol);CHKERRQ(ierr);}
314   PetscFree(mat);
315 
316   ierr = MapDestroy(A->rmap);CHKERRQ(ierr);
317   ierr = MapDestroy(A->cmap);CHKERRQ(ierr);
318 
319   /*
320        This is horrible, horrible code. We need to keep the
321     A pointers for the bops and ops but copy everything
322     else from C.
323   */
324   Abops = A->bops;
325   Aops  = A->ops;
326   PetscMemcpy(A,C,sizeof(struct _p_Mat));
327   A->bops  = Abops;
328   A->ops   = Aops;
329   A->qlist = 0;
330 
331   PetscHeaderDestroy(C);
332   PetscFunctionReturn(0);
333 }
334 /* ----------------------------------------------------------- */
335 #undef __FUNC__
336 #define __FUNC__ "MatSolve_SeqAIJ"
337 int MatSolve_SeqAIJ(Mat A,Vec bb, Vec xx)
338 {
339   Mat_SeqAIJ *a = (Mat_SeqAIJ *) A->data;
340   IS         iscol = a->col, isrow = a->row;
341   int        *r,*c, ierr, i,  n = a->m, *vi, *ai = a->i, *aj = a->j;
342   int        nz,shift = a->indexshift,*rout,*cout;
343   Scalar     *x,*b,*tmp, *tmps, *aa = a->a, sum, *v;
344 
345   PetscFunctionBegin;
346   if (!n) PetscFunctionReturn(0);
347 
348   ierr = VecGetArray(bb,&b);CHKERRQ(ierr);
349   ierr = VecGetArray(xx,&x); CHKERRQ(ierr);
350   tmp  = a->solve_work;
351 
352   ierr = ISGetIndices(isrow,&rout);CHKERRQ(ierr); r = rout;
353   ierr = ISGetIndices(iscol,&cout);CHKERRQ(ierr); c = cout + (n-1);
354 
355   /* forward solve the lower triangular */
356   tmp[0] = b[*r++];
357   tmps   = tmp + shift;
358   for ( i=1; i<n; i++ ) {
359     v   = aa + ai[i] + shift;
360     vi  = aj + ai[i] + shift;
361     nz  = a->diag[i] - ai[i];
362     sum = b[*r++];
363     while (nz--) sum -= *v++ * tmps[*vi++];
364     tmp[i] = sum;
365   }
366 
367   /* backward solve the upper triangular */
368   for ( i=n-1; i>=0; i-- ){
369     v   = aa + a->diag[i] + (!shift);
370     vi  = aj + a->diag[i] + (!shift);
371     nz  = ai[i+1] - a->diag[i] - 1;
372     sum = tmp[i];
373     while (nz--) sum -= *v++ * tmps[*vi++];
374     x[*c--] = tmp[i] = sum*aa[a->diag[i]+shift];
375   }
376 
377   ierr = ISRestoreIndices(isrow,&rout); CHKERRQ(ierr);
378   ierr = ISRestoreIndices(iscol,&cout); CHKERRQ(ierr);
379   ierr = VecRestoreArray(bb,&b);CHKERRQ(ierr);
380   ierr = VecRestoreArray(xx,&x); CHKERRQ(ierr);
381   PLogFlops(2*a->nz - a->n);
382   PetscFunctionReturn(0);
383 }
384 
385 /* ----------------------------------------------------------- */
386 #undef __FUNC__
387 #define __FUNC__ "MatSolve_SeqAIJ_NaturalOrdering"
388 int MatSolve_SeqAIJ_NaturalOrdering(Mat A,Vec bb, Vec xx)
389 {
390   Mat_SeqAIJ *a = (Mat_SeqAIJ *) A->data;
391   int        n = a->m, *ai = a->i, *aj = a->j, *adiag = a->diag,ierr;
392   Scalar     *x,*b, *aa = a->a, sum;
393 #if !defined(USE_FORTRAN_KERNEL_SOLVEAIJ)
394   int        adiag_i,i,*vi,nz,ai_i;
395   Scalar     *v;
396 #endif
397 
398   PetscFunctionBegin;
399   if (!n) PetscFunctionReturn(0);
400   if (a->indexshift) {
401      ierr = MatSolve_SeqAIJ(A,bb,xx);CHKERRQ(ierr);
402      PetscFunctionReturn(0);
403   }
404 
405   ierr = VecGetArray(bb,&b); CHKERRQ(ierr);
406   ierr = VecGetArray(xx,&x); CHKERRQ(ierr);
407 
408 #if defined(USE_FORTRAN_KERNEL_SOLVEAIJ)
409   fortransolveaij_(&n,x,ai,aj,adiag,aa,b);
410 #else
411   /* forward solve the lower triangular */
412   x[0] = b[0];
413   for ( i=1; i<n; i++ ) {
414     ai_i = ai[i];
415     v    = aa + ai_i;
416     vi   = aj + ai_i;
417     nz   = adiag[i] - ai_i;
418     sum  = b[i];
419     while (nz--) sum -= *v++ * x[*vi++];
420     x[i] = sum;
421   }
422 
423   /* backward solve the upper triangular */
424   for ( i=n-1; i>=0; i-- ){
425     adiag_i = adiag[i];
426     v       = aa + adiag_i + 1;
427     vi      = aj + adiag_i + 1;
428     nz      = ai[i+1] - adiag_i - 1;
429     sum     = x[i];
430     while (nz--) sum -= *v++ * x[*vi++];
431     x[i]    = sum*aa[adiag_i];
432   }
433 #endif
434   PLogFlops(2*a->nz - a->n);
435   ierr = VecRestoreArray(bb,&b); CHKERRQ(ierr);
436   ierr = VecRestoreArray(xx,&x); CHKERRQ(ierr);
437   PetscFunctionReturn(0);
438 }
439 
440 #undef __FUNC__
441 #define __FUNC__ "MatSolveAdd_SeqAIJ"
442 int MatSolveAdd_SeqAIJ(Mat A,Vec bb, Vec yy, Vec xx)
443 {
444   Mat_SeqAIJ *a = (Mat_SeqAIJ *) A->data;
445   IS         iscol = a->col, isrow = a->row;
446   int        *r,*c, ierr, i,  n = a->m, *vi, *ai = a->i, *aj = a->j;
447   int        nz, shift = a->indexshift,*rout,*cout;
448   Scalar     *x,*b,*tmp, *aa = a->a, sum, *v;
449 
450   PetscFunctionBegin;
451   if (yy != xx) {ierr = VecCopy(yy,xx); CHKERRQ(ierr);}
452 
453   ierr = VecGetArray(bb,&b);CHKERRQ(ierr);
454   ierr = VecGetArray(xx,&x);CHKERRQ(ierr);
455   tmp  = a->solve_work;
456 
457   ierr = ISGetIndices(isrow,&rout); CHKERRQ(ierr); r = rout;
458   ierr = ISGetIndices(iscol,&cout); CHKERRQ(ierr); c = cout + (n-1);
459 
460   /* forward solve the lower triangular */
461   tmp[0] = b[*r++];
462   for ( i=1; i<n; i++ ) {
463     v   = aa + ai[i] + shift;
464     vi  = aj + ai[i] + shift;
465     nz  = a->diag[i] - ai[i];
466     sum = b[*r++];
467     while (nz--) sum -= *v++ * tmp[*vi++ + shift];
468     tmp[i] = sum;
469   }
470 
471   /* backward solve the upper triangular */
472   for ( i=n-1; i>=0; i-- ){
473     v   = aa + a->diag[i] + (!shift);
474     vi  = aj + a->diag[i] + (!shift);
475     nz  = ai[i+1] - a->diag[i] - 1;
476     sum = tmp[i];
477     while (nz--) sum -= *v++ * tmp[*vi++ + shift];
478     tmp[i] = sum*aa[a->diag[i]+shift];
479     x[*c--] += tmp[i];
480   }
481 
482   ierr = ISRestoreIndices(isrow,&rout); CHKERRQ(ierr);
483   ierr = ISRestoreIndices(iscol,&cout); CHKERRQ(ierr);
484   ierr = VecRestoreArray(bb,&b);CHKERRQ(ierr);
485   ierr = VecRestoreArray(xx,&x);CHKERRQ(ierr);
486   PLogFlops(2*a->nz);
487 
488   PetscFunctionReturn(0);
489 }
490 /* -------------------------------------------------------------------*/
491 #undef __FUNC__
492 #define __FUNC__ "MatSolveTrans_SeqAIJ"
493 int MatSolveTrans_SeqAIJ(Mat A,Vec bb, Vec xx)
494 {
495   Mat_SeqAIJ *a = (Mat_SeqAIJ *) A->data;
496   IS         iscol = a->col, isrow = a->row;
497   int        *r,*c, ierr, i, n = a->m, *vi, *ai = a->i, *aj = a->j;
498   int        nz,shift = a->indexshift,*rout,*cout;
499   Scalar     *x,*b,*tmp, *aa = a->a, *v;
500 
501   PetscFunctionBegin;
502   ierr = VecGetArray(bb,&b);CHKERRQ(ierr);
503   ierr = VecGetArray(xx,&x);CHKERRQ(ierr);
504   tmp  = a->solve_work;
505 
506   ierr = ISGetIndices(isrow,&rout); CHKERRQ(ierr); r = rout;
507   ierr = ISGetIndices(iscol,&cout); CHKERRQ(ierr); c = cout;
508 
509   /* copy the b into temp work space according to permutation */
510   for ( i=0; i<n; i++ ) tmp[i] = b[c[i]];
511 
512   /* forward solve the U^T */
513   for ( i=0; i<n; i++ ) {
514     v   = aa + a->diag[i] + shift;
515     vi  = aj + a->diag[i] + (!shift);
516     nz  = ai[i+1] - a->diag[i] - 1;
517     tmp[i] *= *v++;
518     while (nz--) {
519       tmp[*vi++ + shift] -= (*v++)*tmp[i];
520     }
521   }
522 
523   /* backward solve the L^T */
524   for ( i=n-1; i>=0; i-- ){
525     v   = aa + a->diag[i] - 1 + shift;
526     vi  = aj + a->diag[i] - 1 + shift;
527     nz  = a->diag[i] - ai[i];
528     while (nz--) {
529       tmp[*vi-- + shift] -= (*v--)*tmp[i];
530     }
531   }
532 
533   /* copy tmp into x according to permutation */
534   for ( i=0; i<n; i++ ) x[r[i]] = tmp[i];
535 
536   ierr = ISRestoreIndices(isrow,&rout); CHKERRQ(ierr);
537   ierr = ISRestoreIndices(iscol,&cout); CHKERRQ(ierr);
538   ierr = VecRestoreArray(bb,&b);CHKERRQ(ierr);
539   ierr = VecRestoreArray(xx,&x);CHKERRQ(ierr);
540 
541   PLogFlops(2*a->nz-a->n);
542   PetscFunctionReturn(0);
543 }
544 
545 #undef __FUNC__
546 #define __FUNC__ "MatSolveTransAdd_SeqAIJ"
547 int MatSolveTransAdd_SeqAIJ(Mat A,Vec bb, Vec zz,Vec xx)
548 {
549   Mat_SeqAIJ *a = (Mat_SeqAIJ *) A->data;
550   IS         iscol = a->col, isrow = a->row;
551   int        *r,*c, ierr, i, n = a->m, *vi, *ai = a->i, *aj = a->j;
552   int        nz,shift = a->indexshift, *rout, *cout;
553   Scalar     *x,*b,*tmp, *aa = a->a, *v;
554 
555   PetscFunctionBegin;
556   if (zz != xx) VecCopy(zz,xx);
557 
558   ierr = VecGetArray(bb,&b);CHKERRQ(ierr);
559   ierr = VecGetArray(xx,&x);CHKERRQ(ierr);
560   tmp = a->solve_work;
561 
562   ierr = ISGetIndices(isrow,&rout); CHKERRQ(ierr); r = rout;
563   ierr = ISGetIndices(iscol,&cout); CHKERRQ(ierr); c = cout;
564 
565   /* copy the b into temp work space according to permutation */
566   for ( i=0; i<n; i++ ) tmp[i] = b[c[i]];
567 
568   /* forward solve the U^T */
569   for ( i=0; i<n; i++ ) {
570     v   = aa + a->diag[i] + shift;
571     vi  = aj + a->diag[i] + (!shift);
572     nz  = ai[i+1] - a->diag[i] - 1;
573     tmp[i] *= *v++;
574     while (nz--) {
575       tmp[*vi++ + shift] -= (*v++)*tmp[i];
576     }
577   }
578 
579   /* backward solve the L^T */
580   for ( i=n-1; i>=0; i-- ){
581     v   = aa + a->diag[i] - 1 + shift;
582     vi  = aj + a->diag[i] - 1 + shift;
583     nz  = a->diag[i] - ai[i];
584     while (nz--) {
585       tmp[*vi-- + shift] -= (*v--)*tmp[i];
586     }
587   }
588 
589   /* copy tmp into x according to permutation */
590   for ( i=0; i<n; i++ ) x[r[i]] += tmp[i];
591 
592   ierr = ISRestoreIndices(isrow,&rout); CHKERRQ(ierr);
593   ierr = ISRestoreIndices(iscol,&cout); CHKERRQ(ierr);
594   ierr = VecRestoreArray(bb,&b);CHKERRQ(ierr);
595   ierr = VecRestoreArray(xx,&x);CHKERRQ(ierr);
596 
597   PLogFlops(2*a->nz);
598   PetscFunctionReturn(0);
599 }
600 /* ----------------------------------------------------------------*/
601 
602 #undef __FUNC__
603 #define __FUNC__ "MatILUFactorSymbolic_SeqAIJ"
604 int MatILUFactorSymbolic_SeqAIJ(Mat A,IS isrow,IS iscol,double f,int levels,Mat *fact)
605 {
606   Mat_SeqAIJ *a = (Mat_SeqAIJ *) A->data, *b;
607   IS         isicol;
608   int        *r,*ic, ierr, prow, n = a->m, *ai = a->i, *aj = a->j;
609   int        *ainew,*ajnew, jmax,*fill, *xi, nz, *im,*ajfill,*flev;
610   int        *dloc, idx, row,m,fm, nzf, nzi,len,  realloc = 0;
611   int        incrlev,nnz,i,shift = a->indexshift;
612   PetscTruth col_identity, row_identity;
613 
614   PetscFunctionBegin;
615   ierr = ISInvertPermutation(iscol,&isicol); CHKERRQ(ierr);
616 
617   /* special case that simply copies fill pattern */
618   ISIdentity(isrow,&row_identity); ISIdentity(iscol,&col_identity);
619   if (levels == 0 && row_identity && col_identity) {
620     ierr = MatConvertSameType_SeqAIJ(A,fact,DO_NOT_COPY_VALUES); CHKERRQ(ierr);
621     (*fact)->factor = FACTOR_LU;
622     b               = (Mat_SeqAIJ *) (*fact)->data;
623     if (!b->diag) {
624       ierr = MatMarkDiag_SeqAIJ(*fact); CHKERRQ(ierr);
625     }
626     b->row             = isrow;
627     b->col             = iscol;
628     b->icol            = isicol;
629     b->solve_work      = (Scalar *) PetscMalloc((b->m+1)*sizeof(Scalar));CHKPTRQ(b->solve_work);
630     (*fact)->ops->solve = MatSolve_SeqAIJ_NaturalOrdering;
631     PetscFunctionReturn(0);
632   }
633 
634   ierr = ISGetIndices(isrow,&r); CHKERRQ(ierr);
635   ierr = ISGetIndices(isicol,&ic); CHKERRQ(ierr);
636 
637   /* get new row pointers */
638   ainew = (int *) PetscMalloc( (n+1)*sizeof(int) ); CHKPTRQ(ainew);
639   ainew[0] = -shift;
640   /* don't know how many column pointers are needed so estimate */
641   jmax = (int) (f*(ai[n]+!shift));
642   ajnew = (int *) PetscMalloc( (jmax)*sizeof(int) ); CHKPTRQ(ajnew);
643   /* ajfill is level of fill for each fill entry */
644   ajfill = (int *) PetscMalloc( (jmax)*sizeof(int) ); CHKPTRQ(ajfill);
645   /* fill is a linked list of nonzeros in active row */
646   fill = (int *) PetscMalloc( (n+1)*sizeof(int)); CHKPTRQ(fill);
647   /* im is level for each filled value */
648   im = (int *) PetscMalloc( (n+1)*sizeof(int)); CHKPTRQ(im);
649   /* dloc is location of diagonal in factor */
650   dloc = (int *) PetscMalloc( (n+1)*sizeof(int)); CHKPTRQ(dloc);
651   dloc[0]  = 0;
652   for ( prow=0; prow<n; prow++ ) {
653     /* first copy previous fill into linked list */
654     nzf     = nz  = ai[r[prow]+1] - ai[r[prow]];
655     if (!nz) SETERRQ(PETSC_ERR_MAT_LU_ZRPVT,1,"Empty row in matrix");
656     xi      = aj + ai[r[prow]] + shift;
657     fill[n] = n;
658     while (nz--) {
659       fm  = n;
660       idx = ic[*xi++ + shift];
661       do {
662         m  = fm;
663         fm = fill[m];
664       } while (fm < idx);
665       fill[m]   = idx;
666       fill[idx] = fm;
667       im[idx]   = 0;
668     }
669     nzi = 0;
670     row = fill[n];
671     while ( row < prow ) {
672       incrlev = im[row] + 1;
673       nz      = dloc[row];
674       xi      = ajnew  + ainew[row] + shift + nz;
675       flev    = ajfill + ainew[row] + shift + nz + 1;
676       nnz     = ainew[row+1] - ainew[row] - nz - 1;
677       if (*xi++ + shift != row) {
678         SETERRQ(PETSC_ERR_MAT_LU_ZRPVT,0,"Zero pivot: try running with -pc_ilu_nonzeros_along_diagonal");
679       }
680       fm      = row;
681       while (nnz-- > 0) {
682         idx = *xi++ + shift;
683         if (*flev + incrlev > levels) {
684           flev++;
685           continue;
686         }
687         do {
688           m  = fm;
689           fm = fill[m];
690         } while (fm < idx);
691         if (fm != idx) {
692           im[idx]   = *flev + incrlev;
693           fill[m]   = idx;
694           fill[idx] = fm;
695           fm        = idx;
696           nzf++;
697         } else {
698           if (im[idx] > *flev + incrlev) im[idx] = *flev+incrlev;
699         }
700         flev++;
701       }
702       row = fill[row];
703       nzi++;
704     }
705     /* copy new filled row into permanent storage */
706     ainew[prow+1] = ainew[prow] + nzf;
707     if (ainew[prow+1] > jmax-shift) {
708 
709       /* estimate how much additional space we will need */
710       /* use the strategy suggested by David Hysom <hysom@perch-t.icase.edu> */
711       /* just double the memory each time */
712       /*  maxadd = (int) ((f*(ai[n]+!shift)*(n-prow+5))/n); */
713       int maxadd = jmax;
714       if (maxadd < nzf) maxadd = (n-prow)*(nzf+1);
715       jmax += maxadd;
716 
717       /* allocate a longer ajnew and ajfill */
718       xi = (int *) PetscMalloc( jmax*sizeof(int) );CHKPTRQ(xi);
719       PetscMemcpy(xi,ajnew,(ainew[prow]+shift)*sizeof(int));
720       PetscFree(ajnew);
721       ajnew = xi;
722       xi = (int *) PetscMalloc( jmax*sizeof(int) );CHKPTRQ(xi);
723       PetscMemcpy(xi,ajfill,(ainew[prow]+shift)*sizeof(int));
724       PetscFree(ajfill);
725       ajfill = xi;
726       realloc++; /* count how many times we realloc */
727     }
728     xi          = ajnew + ainew[prow] + shift;
729     flev        = ajfill + ainew[prow] + shift;
730     dloc[prow]  = nzi;
731     fm          = fill[n];
732     while (nzf--) {
733       *xi++   = fm - shift;
734       *flev++ = im[fm];
735       fm      = fill[fm];
736     }
737   }
738   PetscFree(ajfill);
739   ierr = ISRestoreIndices(isrow,&r); CHKERRQ(ierr);
740   ierr = ISRestoreIndices(isicol,&ic); CHKERRQ(ierr);
741   PetscFree(fill); PetscFree(im);
742 
743   {
744     double af = ((double)ainew[n])/((double)ai[n]);
745     PLogInfo(A,"MatILUFactorSymbolic_SeqAIJ:Reallocs %d Fill ratio:given %g needed %g\n",
746              realloc,f,af);
747     PLogInfo(A,"MatILUFactorSymbolic_SeqAIJ:Run with -pc_ilu_fill %g or use \n",af);
748     PLogInfo(A,"MatILUFactorSymbolic_SeqAIJ:PCILUSetFill(pc,%g);\n",af);
749     PLogInfo(A,"MatILUFactorSymbolic_SeqAIJ:for best performance.\n");
750   }
751 
752   /* put together the new matrix */
753   ierr = MatCreateSeqAIJ(A->comm,n,n,0,PETSC_NULL,fact); CHKERRQ(ierr);
754   PLogObjectParent(*fact,isicol);
755   b = (Mat_SeqAIJ *) (*fact)->data;
756   PetscFree(b->imax);
757   b->singlemalloc = 0;
758   len = (ainew[n] + shift)*sizeof(Scalar);
759   /* the next line frees the default space generated by the Create() */
760   PetscFree(b->a); PetscFree(b->ilen);
761   b->a          = (Scalar *) PetscMalloc( len+1 ); CHKPTRQ(b->a);
762   b->j          = ajnew;
763   b->i          = ainew;
764   for ( i=0; i<n; i++ ) dloc[i] += ainew[i];
765   b->diag       = dloc;
766   b->ilen       = 0;
767   b->imax       = 0;
768   b->row        = isrow;
769   b->col        = iscol;
770   b->icol       = isicol;
771   b->solve_work = (Scalar *) PetscMalloc( (n+1)*sizeof(Scalar)); CHKPTRQ(b->solve_work);
772   /* In b structure:  Free imax, ilen, old a, old j.
773      Allocate dloc, solve_work, new a, new j */
774   PLogObjectMemory(*fact,(ainew[n]+shift-n) * (sizeof(int)+sizeof(Scalar)));
775   b->maxnz          = b->nz = ainew[n] + shift;
776   (*fact)->factor   = FACTOR_LU;
777 
778   (*fact)->info.factor_mallocs    = realloc;
779   (*fact)->info.fill_ratio_given  = f;
780   (*fact)->info.fill_ratio_needed = ((double)ainew[n])/((double)ai[prow]);
781   (*fact)->factor                 =  FACTOR_LU;;
782 
783   PetscFunctionReturn(0);
784 }
785 
786 
787 
788 
789