xref: /petsc/src/ksp/pc/impls/gamg/util.c (revision 85cd606915cc53921e9430660df9856b29923438)
16618991cSMark Adams /*
26618991cSMark Adams  GAMG geometric-algebric multigrid PC - Mark Adams 2011
36618991cSMark Adams  */
46618991cSMark Adams #include <petsc/private/matimpl.h>
56618991cSMark Adams #include <../src/ksp/pc/impls/gamg/gamg.h>           /*I "petscpc.h" I*/
6*85cd6069SMark Adams #include <petsc/private/kspimpl.h>
76618991cSMark Adams 
86618991cSMark Adams /*
96618991cSMark Adams    Produces a set of block column indices of the matrix row, one for each block represented in the original row
106618991cSMark Adams 
116618991cSMark Adams    n - the number of block indices in cc[]
126618991cSMark Adams    cc - the block indices (must be large enough to contain the indices)
136618991cSMark Adams */
149fbee547SJacob Faibussowitsch static inline PetscErrorCode MatCollapseRow(Mat Amat,PetscInt row,PetscInt bs,PetscInt *n,PetscInt *cc)
156618991cSMark Adams {
166618991cSMark Adams   PetscInt       cnt = -1,nidx,j;
176618991cSMark Adams   const PetscInt *idx;
186618991cSMark Adams   PetscErrorCode ierr;
196618991cSMark Adams 
206618991cSMark Adams   PetscFunctionBegin;
216618991cSMark Adams   ierr = MatGetRow(Amat,row,&nidx,&idx,NULL);CHKERRQ(ierr);
226618991cSMark Adams   if (nidx) {
236618991cSMark Adams     cnt = 0;
246618991cSMark Adams     cc[cnt] = idx[0]/bs;
256618991cSMark Adams     for (j=1; j<nidx; j++) {
266618991cSMark Adams       if (cc[cnt] < idx[j]/bs) cc[++cnt] = idx[j]/bs;
276618991cSMark Adams     }
286618991cSMark Adams   }
296618991cSMark Adams   ierr = MatRestoreRow(Amat,row,&nidx,&idx,NULL);CHKERRQ(ierr);
306618991cSMark Adams   *n = cnt+1;
316618991cSMark Adams   PetscFunctionReturn(0);
326618991cSMark Adams }
336618991cSMark Adams 
346618991cSMark Adams /*
356618991cSMark Adams     Produces a set of block column indices of the matrix block row, one for each block represented in the original set of rows
366618991cSMark Adams 
376618991cSMark Adams     ncollapsed - the number of block indices
386618991cSMark Adams     collapsed - the block indices (must be large enough to contain the indices)
396618991cSMark Adams */
409fbee547SJacob Faibussowitsch static inline PetscErrorCode MatCollapseRows(Mat Amat,PetscInt start,PetscInt bs,PetscInt *w0,PetscInt *w1,PetscInt *w2,PetscInt *ncollapsed,PetscInt **collapsed)
416618991cSMark Adams {
426618991cSMark Adams   PetscInt       i,nprev,*cprev = w0,ncur = 0,*ccur = w1,*merged = w2,*cprevtmp;
436618991cSMark Adams   PetscErrorCode ierr;
446618991cSMark Adams 
456618991cSMark Adams   PetscFunctionBegin;
466618991cSMark Adams   ierr = MatCollapseRow(Amat,start,bs,&nprev,cprev);CHKERRQ(ierr);
476618991cSMark Adams   for (i=start+1; i<start+bs; i++) {
486618991cSMark Adams     ierr  = MatCollapseRow(Amat,i,bs,&ncur,ccur);CHKERRQ(ierr);
496618991cSMark Adams     ierr  = PetscMergeIntArray(nprev,cprev,ncur,ccur,&nprev,&merged);CHKERRQ(ierr);
506618991cSMark Adams     cprevtmp = cprev; cprev = merged; merged = cprevtmp;
516618991cSMark Adams   }
526618991cSMark Adams   *ncollapsed = nprev;
536618991cSMark Adams   if (collapsed) *collapsed  = cprev;
546618991cSMark Adams   PetscFunctionReturn(0);
556618991cSMark Adams }
566618991cSMark Adams 
576618991cSMark Adams /* -------------------------------------------------------------------------- */
586618991cSMark Adams /*
596618991cSMark Adams    PCGAMGCreateGraph - create simple scaled scalar graph from matrix
606618991cSMark Adams 
616618991cSMark Adams  Input Parameter:
626618991cSMark Adams  . Amat - matrix
636618991cSMark Adams  Output Parameter:
646618991cSMark Adams  . a_Gmaat - eoutput scalar graph (symmetric?)
656618991cSMark Adams  */
666618991cSMark Adams PetscErrorCode PCGAMGCreateGraph(Mat Amat, Mat *a_Gmat)
676618991cSMark Adams {
686618991cSMark Adams   PetscErrorCode ierr;
69f42dcbb3SMark Adams   PetscInt       Istart,Iend,Ii,jj,kk,ncols,nloc,NN,MM,bs;
706618991cSMark Adams   MPI_Comm       comm;
716618991cSMark Adams   Mat            Gmat;
72*85cd6069SMark Adams   PetscBool      ismpiaij,isseqaij;
736618991cSMark Adams 
746618991cSMark Adams   PetscFunctionBegin;
756618991cSMark Adams   ierr = PetscObjectGetComm((PetscObject)Amat,&comm);CHKERRQ(ierr);
766618991cSMark Adams   ierr = MatGetOwnershipRange(Amat, &Istart, &Iend);CHKERRQ(ierr);
776618991cSMark Adams   ierr = MatGetSize(Amat, &MM, &NN);CHKERRQ(ierr);
786618991cSMark Adams   ierr = MatGetBlockSize(Amat, &bs);CHKERRQ(ierr);
796618991cSMark Adams   nloc = (Iend-Istart)/bs;
806618991cSMark Adams 
81*85cd6069SMark Adams   ierr = PetscObjectBaseTypeCompare((PetscObject)Amat,MATSEQAIJ,&isseqaij);CHKERRQ(ierr);
82*85cd6069SMark Adams   ierr = PetscObjectBaseTypeCompare((PetscObject)Amat,MATMPIAIJ,&ismpiaij);CHKERRQ(ierr);
83*85cd6069SMark Adams   PetscCheckFalse(!isseqaij && !ismpiaij,PETSC_COMM_WORLD,PETSC_ERR_USER,"Require (MPI)AIJ matrix type");
846618991cSMark Adams   ierr = PetscLogEventBegin(petsc_gamg_setup_events[GRAPH],0,0,0,0);CHKERRQ(ierr);
856618991cSMark Adams 
8643ef1857SStefano Zampini   /* TODO GPU: these calls are potentially expensive if matrices are large and we want to use the GPU */
8743ef1857SStefano Zampini   /* A solution consists in providing a new API, MatAIJGetCollapsedAIJ, and each class can provide a fast
8843ef1857SStefano Zampini      implementation */
89*85cd6069SMark Adams   ierr = MatViewFromOptions(Amat, NULL, "-g_mat_view");CHKERRQ(ierr);
90*85cd6069SMark Adams   if (bs > 1 && (isseqaij || ((Mat_MPIAIJ*)Amat->data)->garray)) {
91*85cd6069SMark Adams     PetscInt  *d_nnz, *o_nnz;
92*85cd6069SMark Adams     Mat       a, b, c;
93*85cd6069SMark Adams     MatScalar *aa,val,AA[4096];
94*85cd6069SMark Adams     PetscInt  *aj,*ai,AJ[4096],nc;
95*85cd6069SMark Adams     ierr = PetscInfo(Amat,"New bs>1 PCGAMGCreateGraph. nloc=%D\n",nloc);CHKERRQ(ierr);
96*85cd6069SMark Adams     if (isseqaij) {
97*85cd6069SMark Adams       a = Amat; b = NULL;
98*85cd6069SMark Adams     }
99*85cd6069SMark Adams     else {
100*85cd6069SMark Adams       Mat_MPIAIJ *d = (Mat_MPIAIJ*)Amat->data;
101*85cd6069SMark Adams       a = d->A; b = d->B;
102*85cd6069SMark Adams     }
103*85cd6069SMark Adams     ierr = PetscMalloc2(nloc, &d_nnz,isseqaij ? 0 : nloc, &o_nnz);CHKERRQ(ierr);
104*85cd6069SMark Adams     for (c=a, kk=0 ; c && kk<2 ; c=b, kk++){
105*85cd6069SMark Adams       PetscInt       *nnz = (c==a) ? d_nnz : o_nnz, nmax=0;
106*85cd6069SMark Adams       const PetscInt *cols;
107*85cd6069SMark Adams       for (PetscInt brow=0,jj,ok=1,j0; brow < nloc*bs; brow += bs) { // block rows
108*85cd6069SMark Adams         ierr = MatGetRow(c,brow,&jj,&cols,NULL);CHKERRQ(ierr);
109*85cd6069SMark Adams         nnz[brow/bs] = jj/bs;
110*85cd6069SMark Adams         if (jj%bs) ok = 0;
111*85cd6069SMark Adams         if (cols) j0 = cols[0];
112*85cd6069SMark Adams         else j0 = -1;
113*85cd6069SMark Adams         ierr = MatRestoreRow(c,brow,&jj,&cols,NULL);CHKERRQ(ierr);
114*85cd6069SMark Adams         if (nnz[brow/bs]>nmax) nmax = nnz[brow/bs];
115*85cd6069SMark Adams         for (PetscInt ii=1; ii < bs && nnz[brow/bs] ; ii++) { // check for non-dense blocks
116*85cd6069SMark Adams           ierr = MatGetRow(c,brow+ii,&jj,&cols,NULL);CHKERRQ(ierr);
117*85cd6069SMark Adams           if (jj%bs) ok = 0;
118*85cd6069SMark Adams           if (j0 != cols[0]) ok = 0;
119*85cd6069SMark Adams           if (nnz[brow/bs] != jj/bs) ok = 0;
120*85cd6069SMark Adams           ierr = MatRestoreRow(c,brow+11,&jj,&cols,NULL);CHKERRQ(ierr);
121*85cd6069SMark Adams         }
122*85cd6069SMark Adams         if (!ok) {
123*85cd6069SMark Adams           ierr = PetscFree2(d_nnz,o_nnz);CHKERRQ(ierr);
124*85cd6069SMark Adams           goto old_bs;
125*85cd6069SMark Adams         }
126*85cd6069SMark Adams       }
127*85cd6069SMark Adams       PetscCheck(nmax<4096,PETSC_COMM_SELF,PETSC_ERR_USER,"Buffer %D too small %D.",nmax,4096);
128*85cd6069SMark Adams     }
129*85cd6069SMark Adams     ierr = MatCreate(comm, &Gmat);CHKERRQ(ierr);
130*85cd6069SMark Adams     ierr = MatSetSizes(Gmat,nloc,nloc,PETSC_DETERMINE,PETSC_DETERMINE);CHKERRQ(ierr);
131*85cd6069SMark Adams     ierr = MatSetBlockSizes(Gmat, 1, 1);CHKERRQ(ierr);
132*85cd6069SMark Adams     ierr = MatSetType(Gmat, MATAIJ);CHKERRQ(ierr);
133*85cd6069SMark Adams     ierr = MatSeqAIJSetPreallocation(Gmat,0,d_nnz);CHKERRQ(ierr);
134*85cd6069SMark Adams     ierr = MatMPIAIJSetPreallocation(Gmat,0,d_nnz,0,o_nnz);CHKERRQ(ierr);
135*85cd6069SMark Adams     ierr = PetscFree2(d_nnz,o_nnz);CHKERRQ(ierr);
136*85cd6069SMark Adams     // diag
137*85cd6069SMark Adams     for (PetscInt brow=0,n,grow; brow < nloc*bs; brow += bs) { // block rows
138*85cd6069SMark Adams       Mat_SeqAIJ *aseq  = (Mat_SeqAIJ*)a->data;
139*85cd6069SMark Adams       ai = aseq->i;
140*85cd6069SMark Adams       n  = ai[brow+1] - ai[brow];
141*85cd6069SMark Adams       aj = aseq->j + ai[brow];
142*85cd6069SMark Adams       for (int k=0; k<n; k += bs) { // block columns
143*85cd6069SMark Adams         AJ[k/bs] = aj[k]/bs + Istart/bs; // diag starts at (Istart,Istart)
144*85cd6069SMark Adams         val = 0;
145*85cd6069SMark Adams         for (int ii=0; ii<bs; ii++) { // rows in block
146*85cd6069SMark Adams           aa = aseq->a + ai[brow+ii] + k;
147*85cd6069SMark Adams           for (int jj=0; jj<bs; jj++) { // columns in block
148*85cd6069SMark Adams             val += PetscAbs(PetscRealPart(aa[jj])); // a sort of norm
149*85cd6069SMark Adams           }
150*85cd6069SMark Adams         }
151*85cd6069SMark Adams         AA[k/bs] = val;
152*85cd6069SMark Adams       }
153*85cd6069SMark Adams       grow = Istart/bs + brow/bs;
154*85cd6069SMark Adams       ierr = MatSetValues(Gmat,1,&grow,n/bs,AJ,AA,INSERT_VALUES);CHKERRQ(ierr);
155*85cd6069SMark Adams     }
156*85cd6069SMark Adams     // off-diag
157*85cd6069SMark Adams     if (ismpiaij) {
158*85cd6069SMark Adams       Mat_MPIAIJ        *aij = (Mat_MPIAIJ*)Amat->data;
159*85cd6069SMark Adams       const PetscScalar *vals;
160*85cd6069SMark Adams       const PetscInt    *cols, *garray = aij->garray;
161*85cd6069SMark Adams       PetscCheck(garray,PETSC_COMM_SELF,PETSC_ERR_USER,"No garray ?");
162*85cd6069SMark Adams       for (PetscInt brow=0,grow; brow < nloc*bs; brow += bs) { // block rows
163*85cd6069SMark Adams         ierr = MatGetRow(b,brow,&ncols,&cols,NULL);CHKERRQ(ierr);
164*85cd6069SMark Adams         for (int k=0,cidx=0; k<ncols; k += bs,cidx++) {
165*85cd6069SMark Adams           AA[k/bs] = 0;
166*85cd6069SMark Adams           AJ[cidx] = garray[cols[k]]/bs;
167*85cd6069SMark Adams         }
168*85cd6069SMark Adams         nc = ncols/bs;
169*85cd6069SMark Adams         ierr = MatRestoreRow(b,brow,&ncols,&cols,NULL);CHKERRQ(ierr);
170*85cd6069SMark Adams         for (int ii=0; ii<bs; ii++) { // rows in block
171*85cd6069SMark Adams           ierr = MatGetRow(b,brow+ii,&ncols,&cols,&vals);CHKERRQ(ierr);
172*85cd6069SMark Adams           for (int k=0; k<ncols; k += bs) {
173*85cd6069SMark Adams             for (int jj=0; jj<bs; jj++) { // cols in block
174*85cd6069SMark Adams               AA[k/bs] += PetscAbs(PetscRealPart(vals[k+jj]));
175*85cd6069SMark Adams             }
176*85cd6069SMark Adams           }
177*85cd6069SMark Adams           ierr = MatRestoreRow(b,brow+ii,&ncols,&cols,&vals);CHKERRQ(ierr);
178*85cd6069SMark Adams         }
179*85cd6069SMark Adams         grow = Istart/bs + brow/bs;
180*85cd6069SMark Adams         ierr = MatSetValues(Gmat,1,&grow,nc,AJ,AA,INSERT_VALUES);CHKERRQ(ierr);
181*85cd6069SMark Adams       }
182*85cd6069SMark Adams     }
183*85cd6069SMark Adams     ierr = MatAssemblyBegin(Gmat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
184*85cd6069SMark Adams     ierr = MatAssemblyEnd(Gmat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
185*85cd6069SMark Adams     ierr = MatViewFromOptions(Gmat, NULL, "-g_mat_view");CHKERRQ(ierr);
186*85cd6069SMark Adams   } else if (bs > 1) {
1876618991cSMark Adams     const PetscScalar *vals;
1886618991cSMark Adams     const PetscInt    *idx;
189f42dcbb3SMark Adams     PetscInt          *d_nnz, *o_nnz,*w0,*w1,*w2;
1906618991cSMark Adams 
191*85cd6069SMark Adams old_bs:
1926618991cSMark Adams     /*
1936618991cSMark Adams        Determine the preallocation needed for the scalar matrix derived from the vector matrix.
1946618991cSMark Adams     */
1956618991cSMark Adams 
196*85cd6069SMark Adams     ierr = PetscInfo(Amat,"OLD bs>1 PCGAMGCreateGraph\n");CHKERRQ(ierr);
1974099cc6bSBarry Smith     ierr = PetscObjectBaseTypeCompare((PetscObject)Amat,MATSEQAIJ,&isseqaij);CHKERRQ(ierr);
1984099cc6bSBarry Smith     ierr = PetscObjectBaseTypeCompare((PetscObject)Amat,MATMPIAIJ,&ismpiaij);CHKERRQ(ierr);
1996618991cSMark Adams     ierr = PetscMalloc2(nloc, &d_nnz,isseqaij ? 0 : nloc, &o_nnz);CHKERRQ(ierr);
2006618991cSMark Adams 
2016618991cSMark Adams     if (isseqaij) {
2026618991cSMark Adams       PetscInt max_d_nnz;
2036618991cSMark Adams 
2046618991cSMark Adams       /*
2056618991cSMark Adams           Determine exact preallocation count for (sequential) scalar matrix
2066618991cSMark Adams       */
2076618991cSMark Adams       ierr = MatSeqAIJGetMaxRowNonzeros(Amat,&max_d_nnz);CHKERRQ(ierr);
2082f613bf5SBarry Smith       max_d_nnz = PetscMin(nloc,bs*max_d_nnz);
2096618991cSMark Adams       ierr = PetscMalloc3(max_d_nnz, &w0,max_d_nnz, &w1,max_d_nnz, &w2);CHKERRQ(ierr);
2106618991cSMark Adams       for (Ii = 0, jj = 0; Ii < Iend; Ii += bs, jj++) {
2116618991cSMark Adams         ierr = MatCollapseRows(Amat,Ii,bs,w0,w1,w2,&d_nnz[jj],NULL);CHKERRQ(ierr);
2126618991cSMark Adams       }
2136618991cSMark Adams       ierr = PetscFree3(w0,w1,w2);CHKERRQ(ierr);
2146618991cSMark Adams 
2156618991cSMark Adams     } else if (ismpiaij) {
2166618991cSMark Adams       Mat            Daij,Oaij;
2176618991cSMark Adams       const PetscInt *garray;
2186618991cSMark Adams       PetscInt       max_d_nnz;
2196618991cSMark Adams 
2206618991cSMark Adams       ierr = MatMPIAIJGetSeqAIJ(Amat,&Daij,&Oaij,&garray);CHKERRQ(ierr);
2216618991cSMark Adams 
2226618991cSMark Adams       /*
2236618991cSMark Adams           Determine exact preallocation count for diagonal block portion of scalar matrix
2246618991cSMark Adams       */
2256618991cSMark Adams       ierr = MatSeqAIJGetMaxRowNonzeros(Daij,&max_d_nnz);CHKERRQ(ierr);
2262f613bf5SBarry Smith       max_d_nnz = PetscMin(nloc,bs*max_d_nnz);
2276618991cSMark Adams       ierr = PetscMalloc3(max_d_nnz, &w0,max_d_nnz, &w1,max_d_nnz, &w2);CHKERRQ(ierr);
2286618991cSMark Adams       for (Ii = 0, jj = 0; Ii < Iend - Istart; Ii += bs, jj++) {
2296618991cSMark Adams         ierr = MatCollapseRows(Daij,Ii,bs,w0,w1,w2,&d_nnz[jj],NULL);CHKERRQ(ierr);
2306618991cSMark Adams       }
2316618991cSMark Adams       ierr = PetscFree3(w0,w1,w2);CHKERRQ(ierr);
2326618991cSMark Adams 
2336618991cSMark Adams       /*
2346618991cSMark Adams          Over estimate (usually grossly over), preallocation count for off-diagonal portion of scalar matrix
2356618991cSMark Adams       */
2366618991cSMark Adams       for (Ii = 0, jj = 0; Ii < Iend - Istart; Ii += bs, jj++) {
2376618991cSMark Adams         o_nnz[jj] = 0;
2386618991cSMark Adams         for (kk=0; kk<bs; kk++) { /* rows that get collapsed to a single row */
2390a545947SLisandro Dalcin           ierr = MatGetRow(Oaij,Ii+kk,&ncols,NULL,NULL);CHKERRQ(ierr);
2406618991cSMark Adams           o_nnz[jj] += ncols;
2410a545947SLisandro Dalcin           ierr = MatRestoreRow(Oaij,Ii+kk,&ncols,NULL,NULL);CHKERRQ(ierr);
2426618991cSMark Adams         }
2436618991cSMark Adams         if (o_nnz[jj] > (NN/bs-nloc)) o_nnz[jj] = NN/bs-nloc;
2446618991cSMark Adams       }
2456618991cSMark Adams 
246b817416eSBarry Smith     } else SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"Require AIJ matrix type");
2476618991cSMark Adams 
248359038b3SMark Adams     /* get scalar copy (norms) of matrix */
2496618991cSMark Adams     ierr = MatCreate(comm, &Gmat);CHKERRQ(ierr);
2506618991cSMark Adams     ierr = MatSetSizes(Gmat,nloc,nloc,PETSC_DETERMINE,PETSC_DETERMINE);CHKERRQ(ierr);
2516618991cSMark Adams     ierr = MatSetBlockSizes(Gmat, 1, 1);CHKERRQ(ierr);
2520e263c94SMark     ierr = MatSetType(Gmat, MATAIJ);CHKERRQ(ierr);
2536618991cSMark Adams     ierr = MatSeqAIJSetPreallocation(Gmat,0,d_nnz);CHKERRQ(ierr);
2546618991cSMark Adams     ierr = MatMPIAIJSetPreallocation(Gmat,0,d_nnz,0,o_nnz);CHKERRQ(ierr);
2556618991cSMark Adams     ierr = PetscFree2(d_nnz,o_nnz);CHKERRQ(ierr);
2566618991cSMark Adams 
2576618991cSMark Adams     for (Ii = Istart; Ii < Iend; Ii++) {
2586618991cSMark Adams       PetscInt dest_row = Ii/bs;
2596618991cSMark Adams       ierr = MatGetRow(Amat,Ii,&ncols,&idx,&vals);CHKERRQ(ierr);
2606618991cSMark Adams       for (jj=0; jj<ncols; jj++) {
2616618991cSMark Adams         PetscInt    dest_col = idx[jj]/bs;
2626618991cSMark Adams         PetscScalar sv       = PetscAbs(PetscRealPart(vals[jj]));
2636618991cSMark Adams         ierr = MatSetValues(Gmat,1,&dest_row,1,&dest_col,&sv,ADD_VALUES);CHKERRQ(ierr);
2646618991cSMark Adams       }
2656618991cSMark Adams       ierr = MatRestoreRow(Amat,Ii,&ncols,&idx,&vals);CHKERRQ(ierr);
2666618991cSMark Adams     }
2676618991cSMark Adams     ierr = MatAssemblyBegin(Gmat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
2686618991cSMark Adams     ierr = MatAssemblyEnd(Gmat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
269*85cd6069SMark Adams     ierr = MatViewFromOptions(Gmat, NULL, "-g_mat_view");CHKERRQ(ierr);
2706618991cSMark Adams   } else {
2716618991cSMark Adams     /* just copy scalar matrix - abs() not taken here but scaled later */
2726618991cSMark Adams     ierr = MatDuplicate(Amat, MAT_COPY_VALUES, &Gmat);CHKERRQ(ierr);
2736618991cSMark Adams   }
27436c1b609SStefano Zampini   ierr = MatPropagateSymmetryOptions(Amat, Gmat);CHKERRQ(ierr);
2756618991cSMark Adams 
2766618991cSMark Adams   ierr = PetscLogEventEnd(petsc_gamg_setup_events[GRAPH],0,0,0,0);CHKERRQ(ierr);
2776618991cSMark Adams 
2786618991cSMark Adams   *a_Gmat = Gmat;
2796618991cSMark Adams   PetscFunctionReturn(0);
2806618991cSMark Adams }
2816618991cSMark Adams 
2826618991cSMark Adams /* -------------------------------------------------------------------------- */
283a37438d7SBarry Smith /*@C
284a37438d7SBarry Smith    PCGAMGFilterGraph - filter (remove zero and possibly small values from the) graph and make it symmetric if requested
285a37438d7SBarry Smith 
286a37438d7SBarry Smith    Collective on Mat
2876618991cSMark Adams 
288d8d19677SJose E. Roman    Input Parameters:
289a37438d7SBarry Smith +   a_Gmat - the graph
290fd292e60Sprj- .   vfilter - threshold parameter [0,1)
291a37438d7SBarry Smith -   symm - make the result symmetric
292a37438d7SBarry Smith 
293a37438d7SBarry Smith    Level: developer
294a37438d7SBarry Smith 
29595452b02SPatrick Sanan    Notes:
29695452b02SPatrick Sanan     This is called before graph coarsers are called.
297a37438d7SBarry Smith 
298a37438d7SBarry Smith .seealso: PCGAMGSetThreshold()
299a37438d7SBarry Smith @*/
3006618991cSMark Adams PetscErrorCode PCGAMGFilterGraph(Mat *a_Gmat,PetscReal vfilter,PetscBool symm)
3016618991cSMark Adams {
3026618991cSMark Adams   PetscErrorCode    ierr;
3036618991cSMark Adams   PetscInt          Istart,Iend,Ii,jj,ncols,nnz0,nnz1, NN, MM, nloc;
3046618991cSMark Adams   PetscMPIInt       rank;
3058783e15bSStefano Zampini   Mat               Gmat  = *a_Gmat, tGmat;
3066618991cSMark Adams   MPI_Comm          comm;
3076618991cSMark Adams   const PetscScalar *vals;
3086618991cSMark Adams   const PetscInt    *idx;
3096618991cSMark Adams   PetscInt          *d_nnz, *o_nnz;
3106618991cSMark Adams   Vec               diag;
3116618991cSMark Adams 
3126618991cSMark Adams   PetscFunctionBegin;
31327436d3eSMark Adams   ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET16],0,0,0,0);CHKERRQ(ierr);
3146618991cSMark Adams 
31543ef1857SStefano Zampini   /* TODO GPU: optimization proposal, each class provides fast implementation of this
31643ef1857SStefano Zampini      procedure via MatAbs API */
3176618991cSMark Adams   if (vfilter < 0.0 && !symm) {
3186618991cSMark Adams     /* Just use the provided matrix as the graph but make all values positive */
3196618991cSMark Adams     MatInfo     info;
3206618991cSMark Adams     PetscScalar *avals;
321359038b3SMark Adams     PetscBool isaij,ismpiaij;
3224099cc6bSBarry Smith     ierr = PetscObjectBaseTypeCompare((PetscObject)Gmat,MATSEQAIJ,&isaij);CHKERRQ(ierr);
3234099cc6bSBarry Smith     ierr = PetscObjectBaseTypeCompare((PetscObject)Gmat,MATMPIAIJ,&ismpiaij);CHKERRQ(ierr);
3242c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!isaij && !ismpiaij,PETSC_COMM_WORLD,PETSC_ERR_USER,"Require (MPI)AIJ matrix type");
325359038b3SMark Adams     if (isaij) {
3266618991cSMark Adams       ierr = MatGetInfo(Gmat,MAT_LOCAL,&info);CHKERRQ(ierr);
3276618991cSMark Adams       ierr = MatSeqAIJGetArray(Gmat,&avals);CHKERRQ(ierr);
3286618991cSMark Adams       for (jj = 0; jj<info.nz_used; jj++) avals[jj] = PetscAbsScalar(avals[jj]);
3296618991cSMark Adams       ierr = MatSeqAIJRestoreArray(Gmat,&avals);CHKERRQ(ierr);
3306618991cSMark Adams     } else {
331359038b3SMark Adams       Mat_MPIAIJ  *aij = (Mat_MPIAIJ*)Gmat->data;
3326618991cSMark Adams       ierr = MatGetInfo(aij->A,MAT_LOCAL,&info);CHKERRQ(ierr);
3336618991cSMark Adams       ierr = MatSeqAIJGetArray(aij->A,&avals);CHKERRQ(ierr);
3346618991cSMark Adams       for (jj = 0; jj<info.nz_used; jj++) avals[jj] = PetscAbsScalar(avals[jj]);
3356618991cSMark Adams       ierr = MatSeqAIJRestoreArray(aij->A,&avals);CHKERRQ(ierr);
3366618991cSMark Adams       ierr = MatGetInfo(aij->B,MAT_LOCAL,&info);CHKERRQ(ierr);
3376618991cSMark Adams       ierr = MatSeqAIJGetArray(aij->B,&avals);CHKERRQ(ierr);
3386618991cSMark Adams       for (jj = 0; jj<info.nz_used; jj++) avals[jj] = PetscAbsScalar(avals[jj]);
3396618991cSMark Adams       ierr = MatSeqAIJRestoreArray(aij->B,&avals);CHKERRQ(ierr);
3406618991cSMark Adams     }
34127436d3eSMark Adams     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET16],0,0,0,0);CHKERRQ(ierr);
3426618991cSMark Adams     PetscFunctionReturn(0);
3436618991cSMark Adams   }
3446618991cSMark Adams 
34543ef1857SStefano Zampini   /* TODO GPU: this can be called when filter = 0 -> Probably provide MatAIJThresholdCompress that compresses the entries below a threshold?
34643ef1857SStefano Zampini                Also, if the matrix is symmetric, can we skip this
34743ef1857SStefano Zampini                operation? It can be very expensive on large matrices. */
3486618991cSMark Adams   ierr = PetscObjectGetComm((PetscObject)Gmat,&comm);CHKERRQ(ierr);
349ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRMPI(ierr);
3506618991cSMark Adams   ierr = MatGetOwnershipRange(Gmat, &Istart, &Iend);CHKERRQ(ierr);
3516618991cSMark Adams   nloc = Iend - Istart;
3526618991cSMark Adams   ierr = MatGetSize(Gmat, &MM, &NN);CHKERRQ(ierr);
3536618991cSMark Adams 
3546618991cSMark Adams   if (symm) {
3558783e15bSStefano Zampini     Mat matTrans;
3566618991cSMark Adams     ierr = MatTranspose(Gmat, MAT_INITIAL_MATRIX, &matTrans);CHKERRQ(ierr);
3578783e15bSStefano Zampini     ierr = MatAXPY(Gmat, 1.0, matTrans, Gmat->structurally_symmetric ? SAME_NONZERO_PATTERN : DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);
3588783e15bSStefano Zampini     ierr = MatDestroy(&matTrans);CHKERRQ(ierr);
3596618991cSMark Adams   }
3606618991cSMark Adams 
3618783e15bSStefano Zampini   /* scale Gmat for all values between -1 and 1 */
3628783e15bSStefano Zampini   ierr = MatCreateVecs(Gmat, &diag, NULL);CHKERRQ(ierr);
3638783e15bSStefano Zampini   ierr = MatGetDiagonal(Gmat, diag);CHKERRQ(ierr);
3648783e15bSStefano Zampini   ierr = VecReciprocal(diag);CHKERRQ(ierr);
3658783e15bSStefano Zampini   ierr = VecSqrtAbs(diag);CHKERRQ(ierr);
3668783e15bSStefano Zampini   ierr = MatDiagonalScale(Gmat, diag, diag);CHKERRQ(ierr);
3678783e15bSStefano Zampini   ierr = VecDestroy(&diag);CHKERRQ(ierr);
3688783e15bSStefano Zampini 
3696618991cSMark Adams   /* Determine upper bound on nonzeros needed in new filtered matrix */
3706618991cSMark Adams   ierr = PetscMalloc2(nloc, &d_nnz,nloc, &o_nnz);CHKERRQ(ierr);
3716618991cSMark Adams   for (Ii = Istart, jj = 0; Ii < Iend; Ii++, jj++) {
3726618991cSMark Adams     ierr      = MatGetRow(Gmat,Ii,&ncols,NULL,NULL);CHKERRQ(ierr);
3736618991cSMark Adams     d_nnz[jj] = ncols;
3746618991cSMark Adams     o_nnz[jj] = ncols;
3756618991cSMark Adams     ierr      = MatRestoreRow(Gmat,Ii,&ncols,NULL,NULL);CHKERRQ(ierr);
3766618991cSMark Adams     if (d_nnz[jj] > nloc) d_nnz[jj] = nloc;
3776618991cSMark Adams     if (o_nnz[jj] > (MM-nloc)) o_nnz[jj] = MM - nloc;
3786618991cSMark Adams   }
3796618991cSMark Adams   ierr = MatCreate(comm, &tGmat);CHKERRQ(ierr);
3806618991cSMark Adams   ierr = MatSetSizes(tGmat,nloc,nloc,MM,MM);CHKERRQ(ierr);
3816618991cSMark Adams   ierr = MatSetBlockSizes(tGmat, 1, 1);CHKERRQ(ierr);
3820e263c94SMark   ierr = MatSetType(tGmat, MATAIJ);CHKERRQ(ierr);
3836618991cSMark Adams   ierr = MatSeqAIJSetPreallocation(tGmat,0,d_nnz);CHKERRQ(ierr);
3846618991cSMark Adams   ierr = MatMPIAIJSetPreallocation(tGmat,0,d_nnz,0,o_nnz);CHKERRQ(ierr);
3856618991cSMark Adams   ierr = MatSetOption(tGmat,MAT_NO_OFF_PROC_ENTRIES,PETSC_TRUE);CHKERRQ(ierr);
3868783e15bSStefano Zampini   ierr = PetscFree2(d_nnz,o_nnz);CHKERRQ(ierr);
3876618991cSMark Adams 
3886618991cSMark Adams   for (Ii = Istart, nnz0 = nnz1 = 0; Ii < Iend; Ii++) {
3896618991cSMark Adams     ierr = MatGetRow(Gmat,Ii,&ncols,&idx,&vals);CHKERRQ(ierr);
3906618991cSMark Adams     for (jj=0; jj<ncols; jj++,nnz0++) {
3916618991cSMark Adams       PetscScalar sv = PetscAbs(PetscRealPart(vals[jj]));
3926618991cSMark Adams       if (PetscRealPart(sv) > vfilter) {
3936618991cSMark Adams         nnz1++;
3948783e15bSStefano Zampini         ierr = MatSetValues(tGmat,1,&Ii,1,&idx[jj],&sv,INSERT_VALUES);CHKERRQ(ierr);
3956618991cSMark Adams       }
3966618991cSMark Adams     }
3976618991cSMark Adams     ierr = MatRestoreRow(Gmat,Ii,&ncols,&idx,&vals);CHKERRQ(ierr);
3986618991cSMark Adams   }
3996618991cSMark Adams   ierr = MatAssemblyBegin(tGmat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
4006618991cSMark Adams   ierr = MatAssemblyEnd(tGmat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
40136c1b609SStefano Zampini   if (symm) {
40236c1b609SStefano Zampini     ierr = MatSetOption(tGmat,MAT_SYMMETRIC,PETSC_TRUE);CHKERRQ(ierr);
40336c1b609SStefano Zampini   } else {
40436c1b609SStefano Zampini     ierr = MatPropagateSymmetryOptions(Gmat,tGmat);CHKERRQ(ierr);
40536c1b609SStefano Zampini   }
40627436d3eSMark Adams   ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET16],0,0,0,0);CHKERRQ(ierr);
4076618991cSMark Adams 
4086618991cSMark Adams #if defined(PETSC_USE_INFO)
4096618991cSMark Adams   {
4106618991cSMark Adams     double t1 = (!nnz0) ? 1. : 100.*(double)nnz1/(double)nnz0, t2 = (!nloc) ? 1. : (double)nnz0/(double)nloc;
4117d3de750SJacob Faibussowitsch     ierr = PetscInfo(*a_Gmat,"\t %g%% nnz after filtering, with threshold %g, %g nnz ave. (N=%D)\n",t1,vfilter,t2,MM);CHKERRQ(ierr);
4126618991cSMark Adams   }
4136618991cSMark Adams #endif
4146618991cSMark Adams   ierr    = MatDestroy(&Gmat);CHKERRQ(ierr);
4156618991cSMark Adams   *a_Gmat = tGmat;
4166618991cSMark Adams   PetscFunctionReturn(0);
4176618991cSMark Adams }
4186618991cSMark Adams 
4196618991cSMark Adams /* -------------------------------------------------------------------------- */
4206618991cSMark Adams /*
421b817416eSBarry Smith    PCGAMGGetDataWithGhosts - hacks into Mat MPIAIJ so this must have size > 1
4226618991cSMark Adams 
4236618991cSMark Adams    Input Parameter:
4246618991cSMark Adams    . Gmat - MPIAIJ matrix for scattters
4256618991cSMark Adams    . data_sz - number of data terms per node (# cols in output)
4266618991cSMark Adams    . data_in[nloc*data_sz] - column oriented data
4276618991cSMark Adams    Output Parameter:
4286618991cSMark Adams    . a_stride - numbrt of rows of output
4296618991cSMark Adams    . a_data_out[stride*data_sz] - output data with ghosts
4306618991cSMark Adams */
4316618991cSMark Adams PetscErrorCode PCGAMGGetDataWithGhosts(Mat Gmat,PetscInt data_sz,PetscReal data_in[],PetscInt *a_stride,PetscReal **a_data_out)
4326618991cSMark Adams {
4336618991cSMark Adams   PetscErrorCode ierr;
4346618991cSMark Adams   Vec            tmp_crds;
4356618991cSMark Adams   Mat_MPIAIJ     *mpimat = (Mat_MPIAIJ*)Gmat->data;
4366618991cSMark Adams   PetscInt       nnodes,num_ghosts,dir,kk,jj,my0,Iend,nloc;
4376618991cSMark Adams   PetscScalar    *data_arr;
4386618991cSMark Adams   PetscReal      *datas;
4396618991cSMark Adams   PetscBool      isMPIAIJ;
4406618991cSMark Adams 
4416618991cSMark Adams   PetscFunctionBegin;
4424099cc6bSBarry Smith   ierr      = PetscObjectBaseTypeCompare((PetscObject)Gmat, MATMPIAIJ, &isMPIAIJ);CHKERRQ(ierr);
4436618991cSMark Adams   ierr      = MatGetOwnershipRange(Gmat, &my0, &Iend);CHKERRQ(ierr);
4446618991cSMark Adams   nloc      = Iend - my0;
4456618991cSMark Adams   ierr      = VecGetLocalSize(mpimat->lvec, &num_ghosts);CHKERRQ(ierr);
4466618991cSMark Adams   nnodes    = num_ghosts + nloc;
4476618991cSMark Adams   *a_stride = nnodes;
4480a545947SLisandro Dalcin   ierr      = MatCreateVecs(Gmat, &tmp_crds, NULL);CHKERRQ(ierr);
4496618991cSMark Adams 
4506618991cSMark Adams   ierr = PetscMalloc1(data_sz*nnodes, &datas);CHKERRQ(ierr);
4516618991cSMark Adams   for (dir=0; dir<data_sz; dir++) {
4526618991cSMark Adams     /* set local, and global */
4536618991cSMark Adams     for (kk=0; kk<nloc; kk++) {
4546618991cSMark Adams       PetscInt    gid = my0 + kk;
4556618991cSMark Adams       PetscScalar crd = (PetscScalar)data_in[dir*nloc + kk]; /* col oriented */
4566618991cSMark Adams       datas[dir*nnodes + kk] = PetscRealPart(crd);
4576618991cSMark Adams 
4586618991cSMark Adams       ierr = VecSetValues(tmp_crds, 1, &gid, &crd, INSERT_VALUES);CHKERRQ(ierr);
4596618991cSMark Adams     }
4606618991cSMark Adams     ierr = VecAssemblyBegin(tmp_crds);CHKERRQ(ierr);
4616618991cSMark Adams     ierr = VecAssemblyEnd(tmp_crds);CHKERRQ(ierr);
4626618991cSMark Adams     /* get ghost datas */
4636618991cSMark Adams     ierr = VecScatterBegin(mpimat->Mvctx,tmp_crds,mpimat->lvec,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
4646618991cSMark Adams     ierr = VecScatterEnd(mpimat->Mvctx,tmp_crds,mpimat->lvec,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
4656618991cSMark Adams     ierr = VecGetArray(mpimat->lvec, &data_arr);CHKERRQ(ierr);
4666618991cSMark Adams     for (kk=nloc,jj=0;jj<num_ghosts;kk++,jj++) datas[dir*nnodes + kk] = PetscRealPart(data_arr[jj]);
4676618991cSMark Adams     ierr = VecRestoreArray(mpimat->lvec, &data_arr);CHKERRQ(ierr);
4686618991cSMark Adams   }
4696618991cSMark Adams   ierr        = VecDestroy(&tmp_crds);CHKERRQ(ierr);
4706618991cSMark Adams   *a_data_out = datas;
4716618991cSMark Adams   PetscFunctionReturn(0);
4726618991cSMark Adams }
4736618991cSMark Adams 
4741943db53SBarry Smith PetscErrorCode PCGAMGHashTableCreate(PetscInt a_size, PCGAMGHashTable *a_tab)
4756618991cSMark Adams {
4766618991cSMark Adams   PetscErrorCode ierr;
4776618991cSMark Adams   PetscInt       kk;
4786618991cSMark Adams 
4796618991cSMark Adams   PetscFunctionBegin;
4806618991cSMark Adams   a_tab->size = a_size;
4818f3cd775SBarry Smith   ierr = PetscMalloc2(a_size, &a_tab->table,a_size, &a_tab->data);CHKERRQ(ierr);
4826618991cSMark Adams   for (kk=0; kk<a_size; kk++) a_tab->table[kk] = -1;
4836618991cSMark Adams   PetscFunctionReturn(0);
4846618991cSMark Adams }
4856618991cSMark Adams 
4861943db53SBarry Smith PetscErrorCode PCGAMGHashTableDestroy(PCGAMGHashTable *a_tab)
4876618991cSMark Adams {
4886618991cSMark Adams   PetscErrorCode ierr;
4896618991cSMark Adams 
4906618991cSMark Adams   PetscFunctionBegin;
4918f3cd775SBarry Smith   ierr = PetscFree2(a_tab->table,a_tab->data);CHKERRQ(ierr);
4926618991cSMark Adams   PetscFunctionReturn(0);
4936618991cSMark Adams }
4946618991cSMark Adams 
4951943db53SBarry Smith PetscErrorCode PCGAMGHashTableAdd(PCGAMGHashTable *a_tab, PetscInt a_key, PetscInt a_data)
4966618991cSMark Adams {
4976618991cSMark Adams   PetscInt kk,idx;
4986618991cSMark Adams 
4996618991cSMark Adams   PetscFunctionBegin;
5002c71b3e2SJacob Faibussowitsch   PetscCheckFalse(a_key<0,PETSC_COMM_SELF,PETSC_ERR_USER,"Negative key %D.",a_key);
5018f3cd775SBarry Smith   for (kk = 0, idx = GAMG_HASH(a_key); kk < a_tab->size; kk++, idx = (idx==(a_tab->size-1)) ? 0 : idx + 1) {
5026618991cSMark Adams     if (a_tab->table[idx] == a_key) {
5036618991cSMark Adams       /* exists */
5046618991cSMark Adams       a_tab->data[idx] = a_data;
5056618991cSMark Adams       break;
5066618991cSMark Adams     } else if (a_tab->table[idx] == -1) {
5076618991cSMark Adams       /* add */
5086618991cSMark Adams       a_tab->table[idx] = a_key;
5096618991cSMark Adams       a_tab->data[idx]  = a_data;
5106618991cSMark Adams       break;
5116618991cSMark Adams     }
5126618991cSMark Adams   }
5136618991cSMark Adams   if (kk==a_tab->size) {
5146618991cSMark Adams     /* this is not to efficient, waiting until completely full */
5156618991cSMark Adams     PetscInt       oldsize = a_tab->size, new_size = 2*a_tab->size + 5, *oldtable = a_tab->table, *olddata = a_tab->data;
5166618991cSMark Adams     PetscErrorCode ierr;
5176618991cSMark Adams 
5186618991cSMark Adams     a_tab->size = new_size;
5198f3cd775SBarry Smith     ierr = PetscMalloc2(a_tab->size, &a_tab->table,a_tab->size, &a_tab->data);CHKERRQ(ierr);
5206618991cSMark Adams     for (kk=0;kk<a_tab->size;kk++) a_tab->table[kk] = -1;
5216618991cSMark Adams     for (kk=0;kk<oldsize;kk++) {
5226618991cSMark Adams       if (oldtable[kk] != -1) {
5231943db53SBarry Smith         ierr = PCGAMGHashTableAdd(a_tab, oldtable[kk], olddata[kk]);CHKERRQ(ierr);
5246618991cSMark Adams        }
5256618991cSMark Adams     }
5268f3cd775SBarry Smith     ierr = PetscFree2(oldtable,olddata);CHKERRQ(ierr);
5271943db53SBarry Smith     ierr = PCGAMGHashTableAdd(a_tab, a_key, a_data);CHKERRQ(ierr);
5286618991cSMark Adams   }
5296618991cSMark Adams   PetscFunctionReturn(0);
5306618991cSMark Adams }
531