xref: /petsc/src/mat/utils/zerodiag.c (revision 90f02eec332fcca4c33b4e7b21cabed76bf0614e)
1 #ifndef lint
2 static char vcid[] = "$Id: zerodiag.c,v 1.8 1996/08/08 14:44:19 bsmith Exp bsmith $";
3 #endif
4 
5 /*
6     This file contains routines to reorder a matrix so that the diagonal
7     elements are nonzero.
8  */
9 
10 #include "src/mat/matimpl.h"       /*I  "mat.h"  I*/
11 #include <math.h>
12 
13 #define SWAP(a,b) {int _t; _t = a; a = b; b = _t; }
14 
15 /* Given a current row and current permutation, find a column permutation
16    that removes a zero diagonal */
17 int MatZeroFindPre_Private(Mat mat,int prow,int* row,int* col,double repla,
18                            double atol,int* rc,double* rcv )
19 {
20   int      k, nz, repl, *j, kk, nnz, *jj,ierr;
21   Scalar   *v, *vv;
22 
23   ierr = MatGetRow( mat, row[prow], &nz, &j, &v ); CHKERRQ(ierr);
24   for (k=0; k<nz; k++) {
25     if (col[j[k]] < prow && PetscAbsScalar(v[k]) > repla) {
26       /* See if this one will work */
27       repl  = col[j[k]];
28       ierr = MatGetRow( mat, row[repl], &nnz, &jj, &vv ); CHKERRQ(ierr);
29       for (kk=0; kk<nnz; kk++) {
30 	if (col[jj[kk]] == prow && PetscAbsScalar(vv[kk]) > atol) {
31 	  *rcv = PetscAbsScalar(v[k]);
32 	  *rc  = repl;
33           ierr = MatRestoreRow( mat, row[repl], &nnz, &jj, &vv ); CHKERRQ(ierr);
34           ierr = MatRestoreRow( mat, row[prow], &nz, &j, &v ); CHKERRQ(ierr);
35 	  return 1;
36 	}
37       }
38       ierr = MatRestoreRow( mat, row[repl], &nnz, &jj, &vv ); CHKERRQ(ierr);
39     }
40   }
41   ierr = MatRestoreRow( mat, row[prow], &nz, &j, &v ); CHKERRQ(ierr);
42   return 0;
43 }
44 
45 /*@
46     MatReorderForNonzeroDiagonal - Changes matrix ordering to remove
47         zeros from diagonal. This may help in the LU factorization to
48         prevent a zero pivot.
49 
50     Input Parameters:
51 .   mat  - matrix to reorder
52 .   rmap,cmap - row and column permutations.  Usually obtained from
53 .               MatGetReordering().
54 
55     Notes:
56     This is not intended as a replacement for pivoting for matrices that
57     have ``bad'' structure. It is only a stop-gap measure.
58 
59     Algorithm:
60     Column pivoting is used.  Choice of column is made by looking at the
61     non-zero elements in the row.  This algorithm is simple and fast but
62     does NOT guarentee that a non-singular or well conditioned
63     principle submatrix will be produced.
64 @*/
65 int MatReorderForNonzeroDiagonal(Mat mat,double atol,IS ris,IS cis )
66 {
67   int      ierr, prow, k, nz, n, repl, *j, *col, *row, m;
68   Scalar   *v;
69   double   repla;
70 
71   PetscValidHeaderSpecific(mat,MAT_COOKIE);
72   PetscValidHeaderSpecific(ris,IS_COOKIE);
73   PetscValidHeaderSpecific(cis,IS_COOKIE);
74 
75   ierr = ISGetIndices(ris,&row); CHKERRQ(ierr);
76   ierr = ISGetIndices(cis,&col); CHKERRQ(ierr);
77   ierr = MatGetSize(mat,&m,&n); CHKERRQ(ierr);
78 
79   for (prow=0; prow<n; prow++) {
80     ierr = MatGetRow( mat, row[prow], &nz, &j, &v ); CHKERRQ(ierr);
81     for (k=0; k<nz; k++) {if (col[j[k]] == prow) break;}
82     if (k >= nz || PetscAbsScalar(v[k]) <= atol) {
83       /* Element too small or zero; find the best candidate */
84       repl  = prow;
85       repla = (k >= nz) ? 0.0 : PetscAbsScalar(v[k]);
86       for (k=0; k<nz; k++) {
87 	if (col[j[k]] > prow && PetscAbsScalar(v[k]) > repla) {
88 	  repl = col[j[k]];
89 	  repla = PetscAbsScalar(v[k]);
90         }
91       }
92       if (prow == repl) {
93 	    /* Now we need to look for an element that allows us
94 	       to pivot with a previous column.  To do this, we need
95 	       to be sure that we don't introduce a zero in a previous
96 	       diagonal */
97         if (!MatZeroFindPre_Private(mat,prow,row,col,repla,atol,&repl,&repla)){
98 	  SETERRQ(1,"MatReorderForNonzeroDiagonal:Can not reorder matrix");
99 	}
100       }
101       SWAP(col[prow],col[repl]);
102     }
103     ierr = MatRestoreRow( mat, row[prow], &nz, &j, &v ); CHKERRQ(ierr);
104   }
105   ierr = ISRestoreIndices(ris,&row); CHKERRQ(ierr);
106   ierr = ISRestoreIndices(cis,&col); CHKERRQ(ierr);
107   return 0;
108 }
109 
110 
111 
112