xref: /petsc/src/ksp/pc/impls/gamg/gamg.c (revision 2de708cb9e330fedcb6a5a982256b519aeb72fbe)
15b89ad90SMark F. Adams /*
20cd22d39SHong Zhang  GAMG geometric-algebric multigrid PC - Mark Adams 2011
35b89ad90SMark F. Adams  */
4af0996ceSBarry Smith #include <petsc/private/matimpl.h>
5389730f3SMark F. Adams #include <../src/ksp/pc/impls/gamg/gamg.h>           /*I "petscpc.h" I*/
618c3aa7eSMark #include <../src/ksp/ksp/impls/cheby/chebyshevimpl.h>    /*I "petscksp.h" I*/
7f96513f1SMatthew G Knepley 
8c9567895SMark #if defined(PETSC_HAVE_CUDA)
9c9567895SMark   #include <cuda_runtime.h>
10c9567895SMark #endif
11c9567895SMark 
12c9567895SMark #if defined(PETSC_HAVE_HIP)
13c9567895SMark   #include <hip/hip_runtime.h>
14c9567895SMark #endif
15c9567895SMark 
160cbbd2e1SMark F. Adams PetscLogEvent petsc_gamg_setup_events[NUM_SET];
174555aa8cSStefano Zampini PetscLogEvent petsc_gamg_setup_matmat_events[PETSC_MG_MAXLEVELS][3];
18fd1112cbSBarry Smith PetscLogEvent PC_GAMGGraph_AGG;
19fd1112cbSBarry Smith PetscLogEvent PC_GAMGGraph_GEO;
200cbbd2e1SMark F. Adams PetscLogEvent PC_GAMGCoarsen_AGG;
210cbbd2e1SMark F. Adams PetscLogEvent PC_GAMGCoarsen_GEO;
220cbbd2e1SMark F. Adams PetscLogEvent PC_GAMGProlongator_AGG;
230cbbd2e1SMark F. Adams PetscLogEvent PC_GAMGProlongator_GEO;
24fd1112cbSBarry Smith PetscLogEvent PC_GAMGOptProlongator_AGG;
250cbbd2e1SMark F. Adams 
26b8fd24d8SMark F. Adams /* #define GAMG_STAGES */
274555aa8cSStefano Zampini #if defined(GAMG_STAGES)
2818c3aa7eSMark static PetscLogStage gamg_stages[PETSC_MG_MAXLEVELS];
29b4fbaa2aSMark F. Adams #endif
30f96513f1SMatthew G Knepley 
310a545947SLisandro Dalcin static PetscFunctionList GAMGList = NULL;
323e3471ccSMark Adams static PetscBool PCGAMGPackageInitialized;
339d5b6da9SMark F. Adams 
34d3d6bff4SMark F. Adams /* ----------------------------------------------------------------------------- */
35d3d6bff4SMark F. Adams PetscErrorCode PCReset_GAMG(PC pc)
36d3d6bff4SMark F. Adams {
3718c3aa7eSMark   PetscErrorCode ierr, level;
38d3d6bff4SMark F. Adams   PC_MG          *mg      = (PC_MG*)pc->data;
39d3d6bff4SMark F. Adams   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
40d3d6bff4SMark F. Adams 
41d3d6bff4SMark F. Adams   PetscFunctionBegin;
4222a233eaSStefano Zampini   ierr = PetscFree(pc_gamg->data);CHKERRQ(ierr);
431c1aac46SBarry Smith   pc_gamg->data_sz = 0;
44878e152fSMark F. Adams   ierr = PetscFree(pc_gamg->orig_data);CHKERRQ(ierr);
4518c3aa7eSMark   for (level = 0; level < PETSC_MG_MAXLEVELS ; level++) {
4618c3aa7eSMark     mg->min_eigen_DinvA[level] = 0;
4718c3aa7eSMark     mg->max_eigen_DinvA[level] = 0;
4818c3aa7eSMark   }
4918c3aa7eSMark   pc_gamg->emin = 0;
5018c3aa7eSMark   pc_gamg->emax = 0;
51a2f3521dSMark F. Adams   PetscFunctionReturn(0);
52a2f3521dSMark F. Adams }
53a2f3521dSMark F. Adams 
545b89ad90SMark F. Adams /* -------------------------------------------------------------------------- */
555b89ad90SMark F. Adams /*
56c238b0ebSToby Isaac    PCGAMGCreateLevel_GAMG: create coarse op with RAP.  repartition and/or reduce number
57a147abb0SMark F. Adams      of active processors.
585b89ad90SMark F. Adams 
595b89ad90SMark F. Adams    Input Parameter:
60a2f3521dSMark F. Adams    . pc - parameters + side effect: coarse data in 'pc_gamg->data' and
61a2f3521dSMark F. Adams           'pc_gamg->data_sz' are changed via repartitioning/reduction.
629d5b6da9SMark F. Adams    . Amat_fine - matrix on this fine (k) level
63c5bfad50SMark F. Adams    . cr_bs - coarse block size
643530afc2SMark F. Adams    In/Output Parameter:
65a2f3521dSMark F. Adams    . a_P_inout - prolongation operator to the next level (k-->k-1)
66afc97cdcSMark F. Adams    . a_nactive_proc - number of active procs
6711e60469SMark F. Adams    Output Parameter:
683530afc2SMark F. Adams    . a_Amat_crs - coarse matrix that is created (k-1)
695b89ad90SMark F. Adams */
705cb416c2SMark F. Adams 
71171cca9aSMark Adams static PetscErrorCode PCGAMGCreateLevel_GAMG(PC pc,Mat Amat_fine,PetscInt cr_bs,Mat *a_P_inout,Mat *a_Amat_crs,PetscMPIInt *a_nactive_proc,IS * Pcolumnperm, PetscBool is_last)
725b89ad90SMark F. Adams {
73a2f3521dSMark F. Adams   PetscErrorCode  ierr;
749d5b6da9SMark F. Adams   PC_MG           *mg         = (PC_MG*)pc->data;
75486a8d0bSJed Brown   PC_GAMG         *pc_gamg    = (PC_GAMG*)mg->innerctx;
76a2f3521dSMark F. Adams   Mat             Cmat,Pold=*a_P_inout;
773b4367a7SBarry Smith   MPI_Comm        comm;
78c5df96a5SBarry Smith   PetscMPIInt     rank,size,new_size,nactive=*a_nactive_proc;
793ae0bb68SMark Adams   PetscInt        ncrs_eq,ncrs,f_bs;
805b89ad90SMark F. Adams 
815b89ad90SMark F. Adams   PetscFunctionBegin;
823b4367a7SBarry Smith   ierr = PetscObjectGetComm((PetscObject)Amat_fine,&comm);CHKERRQ(ierr);
83ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
84ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr);
85c5bfad50SMark F. Adams   ierr = MatGetBlockSize(Amat_fine, &f_bs);CHKERRQ(ierr);
864555aa8cSStefano Zampini   ierr = PetscLogEventBegin(petsc_gamg_setup_matmat_events[pc_gamg->current_level][1],0,0,0,0);CHKERRQ(ierr);
879d5b6da9SMark F. Adams   ierr = MatPtAP(Amat_fine, Pold, MAT_INITIAL_MATRIX, 2.0, &Cmat);CHKERRQ(ierr);
884555aa8cSStefano Zampini   ierr = PetscLogEventEnd(petsc_gamg_setup_matmat_events[pc_gamg->current_level][1],0,0,0,0);CHKERRQ(ierr);
89038e3b61SMark F. Adams 
90ce7c7f2fSMark Adams   if (Pcolumnperm) *Pcolumnperm = NULL;
91ce7c7f2fSMark Adams 
923ae0bb68SMark Adams   /* set 'ncrs' (nodes), 'ncrs_eq' (equations)*/
930298fd71SBarry Smith   ierr = MatGetLocalSize(Cmat, &ncrs_eq, NULL);CHKERRQ(ierr);
943ae0bb68SMark Adams   if (pc_gamg->data_cell_rows>0) {
953ae0bb68SMark Adams     ncrs = pc_gamg->data_sz/pc_gamg->data_cell_cols/pc_gamg->data_cell_rows;
9673911c69SBarry Smith   } else {
973ae0bb68SMark Adams     PetscInt  bs;
983ae0bb68SMark Adams     ierr = MatGetBlockSize(Cmat, &bs);CHKERRQ(ierr);
993ae0bb68SMark Adams     ncrs = ncrs_eq/bs;
1003ae0bb68SMark Adams   }
101c5df96a5SBarry Smith   /* get number of PEs to make active 'new_size', reduce, can be any integer 1-P */
102c9567895SMark   if (pc_gamg->level_reduction_factors[pc_gamg->current_level] == 0 && PetscDefined(HAVE_CUDA) && pc_gamg->current_level==0) { /* 0 turns reducing to 1 process/device on; do for HIP, etc. */
103c9567895SMark #if defined(PETSC_HAVE_CUDA)
104c9567895SMark     PetscShmComm pshmcomm;
105c9567895SMark     PetscMPIInt  locrank;
106c9567895SMark     MPI_Comm     loccomm;
107c9567895SMark     PetscInt     s_nnodes,r_nnodes, new_new_size;
108c9567895SMark     cudaError_t  cerr;
109c9567895SMark     int          devCount;
110c9567895SMark     ierr = PetscShmCommGet(comm,&pshmcomm);CHKERRQ(ierr);
111c9567895SMark     ierr = PetscShmCommGetMpiShmComm(pshmcomm,&loccomm);CHKERRQ(ierr);
11255b25c41SPierre Jolivet     ierr = MPI_Comm_rank(loccomm, &locrank);CHKERRMPI(ierr);
113c9567895SMark     s_nnodes = !locrank;
11455b25c41SPierre Jolivet     ierr = MPI_Allreduce(&s_nnodes,&r_nnodes,1,MPIU_INT,MPI_SUM,comm);CHKERRMPI(ierr);
1152c71b3e2SJacob Faibussowitsch     PetscCheckFalse(size%r_nnodes,PETSC_COMM_SELF,PETSC_ERR_PLIB,"odd number of nodes np=%D nnodes%D",size,r_nnodes);
116c9567895SMark     devCount = 0;
117c9567895SMark     cerr = cudaGetDeviceCount(&devCount);
118c9567895SMark     cudaGetLastError(); /* Reset the last error */
119c9567895SMark     if (cerr == cudaSuccess && devCount >= 1) { /* There are devices, else go to heuristic */
120c9567895SMark       new_new_size = r_nnodes * devCount;
121c9567895SMark       new_size = new_new_size;
1227d3de750SJacob Faibussowitsch       ierr = PetscInfo(pc,"Fine grid with Cuda. %D nodes. Change new active set size %d --> %d (devCount=%d #nodes=%D)\n",r_nnodes,nactive,new_size,devCount,r_nnodes);CHKERRQ(ierr);
123c9567895SMark     } else {
124c9567895SMark       ierr = PetscInfo(pc,"With Cuda but no device. Use heuristics.");CHKERRQ(ierr);
125c9567895SMark       goto HEURISTIC;
126c9567895SMark     }
127c9567895SMark #else
128c9567895SMark     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"should not be here");
129c9567895SMark #endif
130c9567895SMark   } else if (pc_gamg->level_reduction_factors[pc_gamg->current_level] > 0) {
1312c71b3e2SJacob Faibussowitsch     PetscCheckFalse(nactive%pc_gamg->level_reduction_factors[pc_gamg->current_level],PETSC_COMM_SELF,PETSC_ERR_PLIB,"odd number of active process %D wrt reduction factor %D",nactive,pc_gamg->level_reduction_factors[pc_gamg->current_level]);
132c9567895SMark     new_size = nactive/pc_gamg->level_reduction_factors[pc_gamg->current_level];
1337d3de750SJacob Faibussowitsch     ierr = PetscInfo(pc,"Manually setting reduction to %d active processes (%d/%D)\n",new_size,nactive,pc_gamg->level_reduction_factors[pc_gamg->current_level]);CHKERRQ(ierr);
134c9567895SMark   } else if (is_last && !pc_gamg->use_parallel_coarse_grid_solver) {
135c9567895SMark     new_size = 1;
1367d3de750SJacob Faibussowitsch     ierr = PetscInfo(pc,"Force coarsest grid reduction to %d active processes\n",new_size);CHKERRQ(ierr);
137c9567895SMark   } else {
138472110cdSMark F. Adams     PetscInt ncrs_eq_glob;
139c9567895SMark #if defined(PETSC_HAVE_CUDA)
140c9567895SMark     HEURISTIC:
141c9567895SMark #endif
1420298fd71SBarry Smith     ierr     = MatGetSize(Cmat, &ncrs_eq_glob, NULL);CHKERRQ(ierr);
143a90e85d9SMark Adams     new_size = (PetscMPIInt)((float)ncrs_eq_glob/(float)pc_gamg->min_eq_proc + 0.5); /* hardwire min. number of eq/proc */
1447f66b68fSMark Adams     if (!new_size) new_size = 1; /* not likely, posible? */
145c5df96a5SBarry Smith     else if (new_size >= nactive) new_size = nactive; /* no change, rare */
1467d3de750SJacob Faibussowitsch     ierr = PetscInfo(pc,"Coarse grid reduction from %d to %d active processes\n",nactive,new_size);CHKERRQ(ierr);
147a2f3521dSMark F. Adams   }
1482e3501ffSMark Adams   if (new_size==nactive) {
149ef3f0257SMark Adams     *a_Amat_crs = Cmat; /* output - no repartitioning or reduction - could bail here */
150ce7c7f2fSMark Adams     if (new_size < size) {
151ce7c7f2fSMark Adams       /* odd case where multiple coarse grids are on one processor or no coarsening ... */
1527d3de750SJacob Faibussowitsch       ierr = PetscInfo(pc,"reduced grid using same number of processors (%d) as last grid (use larger coarse grid)\n",nactive);CHKERRQ(ierr);
153ce7c7f2fSMark Adams       if (pc_gamg->cpu_pin_coarse_grids) {
154b470e4b4SRichard Tran Mills         ierr = MatBindToCPU(*a_Amat_crs,PETSC_TRUE);CHKERRQ(ierr);
155b470e4b4SRichard Tran Mills         ierr = MatBindToCPU(*a_P_inout,PETSC_TRUE);CHKERRQ(ierr);
156ce7c7f2fSMark Adams       }
157ce7c7f2fSMark Adams     }
158ef3f0257SMark Adams     /* we know that the grid structure can be reused in MatPtAP */
1592e3501ffSMark Adams   } else { /* reduce active processors - we know that the grid structure can NOT be reused in MatPtAP */
160192c0e8bSMark Adams     PetscInt       *counts,*newproc_idx,ii,jj,kk,strideNew,*tidx,ncrs_new,ncrs_eq_new,nloc_old,expand_factor=1,rfactor=1;
161885364a3SMark Adams     IS             is_eq_newproc,is_eq_num,is_eq_num_prim,new_eq_indices;
16271959b99SBarry Smith     nloc_old = ncrs_eq/cr_bs;
1632c71b3e2SJacob Faibussowitsch     PetscCheckFalse(ncrs_eq % cr_bs,PETSC_COMM_SELF,PETSC_ERR_PLIB,"ncrs_eq %D not divisible by cr_bs %D",ncrs_eq,cr_bs);
164ce7c7f2fSMark Adams     /* get new_size and rfactor */
165ce7c7f2fSMark Adams     if (pc_gamg->layout_type==PCGAMG_LAYOUT_SPREAD || !pc_gamg->repart) {
166ce7c7f2fSMark Adams       /* find factor */
167ce7c7f2fSMark Adams       if (new_size == 1) rfactor = size; /* don't modify */
168ce7c7f2fSMark Adams       else {
169ce7c7f2fSMark Adams         PetscReal best_fact = 0.;
170ce7c7f2fSMark Adams         jj = -1;
171ce7c7f2fSMark Adams         for (kk = 1 ; kk <= size ; kk++) {
172ce7c7f2fSMark Adams           if (!(size%kk)) { /* a candidate */
173ce7c7f2fSMark Adams             PetscReal nactpe = (PetscReal)size/(PetscReal)kk, fact = nactpe/(PetscReal)new_size;
174ce7c7f2fSMark Adams             if (fact > 1.0) fact = 1./fact; /* keep fact < 1 */
175ce7c7f2fSMark Adams             if (fact > best_fact) {
176ce7c7f2fSMark Adams               best_fact = fact; jj = kk;
177ce7c7f2fSMark Adams             }
178ce7c7f2fSMark Adams           }
179ce7c7f2fSMark Adams         }
180ce7c7f2fSMark Adams         if (jj != -1) rfactor = jj;
181ce7c7f2fSMark Adams         else rfactor = 1; /* a prime */
182ce7c7f2fSMark Adams         if (pc_gamg->layout_type == PCGAMG_LAYOUT_COMPACT) expand_factor = 1;
183ce7c7f2fSMark Adams         else expand_factor = rfactor;
184ce7c7f2fSMark Adams       }
185ce7c7f2fSMark Adams       new_size = size/rfactor; /* make new size one that is factor */
1864cdfd227SMark       if (new_size==nactive) { /* no repartitioning or reduction, bail out because nested here (rare) */
1874cdfd227SMark         *a_Amat_crs = Cmat;
1887d3de750SJacob Faibussowitsch         ierr = PetscInfo(pc,"Finding factorable processor set stopped reduction: new_size=%d, neq(loc)=%D\n",new_size,ncrs_eq);CHKERRQ(ierr);
189ce7c7f2fSMark Adams         PetscFunctionReturn(0);
190ce7c7f2fSMark Adams       }
191ce7c7f2fSMark Adams     }
1924cdfd227SMark     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET12],0,0,0,0);CHKERRQ(ierr);
193a2f3521dSMark F. Adams     /* make 'is_eq_newproc' */
194785e854fSJed Brown     ierr = PetscMalloc1(size, &counts);CHKERRQ(ierr);
1952e3501ffSMark Adams     if (pc_gamg->repart) {
196a5b23f4aSJose E. Roman       /* Repartition Cmat_{k} and move columns of P^{k}_{k-1} and coordinates of primal part accordingly */
1975a9b9e01SMark F. Adams       Mat      adj;
1987d3de750SJacob Faibussowitsch       ierr = PetscInfo(pc,"Repartition: size (active): %d --> %d, %D local equations, using %s process layout\n",*a_nactive_proc, new_size, ncrs_eq, (pc_gamg->layout_type==PCGAMG_LAYOUT_COMPACT) ? "compact" : "spread");CHKERRQ(ierr);
199a2f3521dSMark F. Adams       /* get 'adj' */
200c5bfad50SMark F. Adams       if (cr_bs == 1) {
201038e3b61SMark F. Adams         ierr = MatConvert(Cmat, MATMPIADJ, MAT_INITIAL_MATRIX, &adj);CHKERRQ(ierr);
202806fa848SBarry Smith       } else {
203a2f3521dSMark F. Adams         /* make a scalar matrix to partition (no Stokes here) */
204eb07cef2SMark F. Adams         Mat               tMat;
205a2f3521dSMark F. Adams         PetscInt          Istart_crs,Iend_crs,ncols,jj,Ii;
206b4fbaa2aSMark F. Adams         const PetscScalar *vals;
207b4fbaa2aSMark F. Adams         const PetscInt    *idx;
208a2f3521dSMark F. Adams         PetscInt          *d_nnz, *o_nnz, M, N;
20939d09545SMark Adams         static PetscInt   llev = 0; /* ugly but just used for debugging */
210d9558ea9SBarry Smith         MatType           mtype;
211b4fbaa2aSMark F. Adams 
212e632b94dSBarry Smith         ierr = PetscMalloc2(ncrs, &d_nnz,ncrs, &o_nnz);CHKERRQ(ierr);
213a2f3521dSMark F. Adams         ierr = MatGetOwnershipRange(Cmat, &Istart_crs, &Iend_crs);CHKERRQ(ierr);
214a2f3521dSMark F. Adams         ierr = MatGetSize(Cmat, &M, &N);CHKERRQ(ierr);
215c5bfad50SMark F. Adams         for (Ii = Istart_crs, jj = 0; Ii < Iend_crs; Ii += cr_bs, jj++) {
2160a545947SLisandro Dalcin           ierr      = MatGetRow(Cmat,Ii,&ncols,NULL,NULL);CHKERRQ(ierr);
217c5bfad50SMark F. Adams           d_nnz[jj] = ncols/cr_bs;
218c5bfad50SMark F. Adams           o_nnz[jj] = ncols/cr_bs;
2190a545947SLisandro Dalcin           ierr      = MatRestoreRow(Cmat,Ii,&ncols,NULL,NULL);CHKERRQ(ierr);
2203ae0bb68SMark Adams           if (d_nnz[jj] > ncrs) d_nnz[jj] = ncrs;
2213ae0bb68SMark Adams           if (o_nnz[jj] > (M/cr_bs-ncrs)) o_nnz[jj] = M/cr_bs-ncrs;
22258471d46SMark F. Adams         }
2236876a03eSMark F. Adams 
224d9558ea9SBarry Smith         ierr = MatGetType(Amat_fine,&mtype);CHKERRQ(ierr);
2253b4367a7SBarry Smith         ierr = MatCreate(comm, &tMat);CHKERRQ(ierr);
2263ae0bb68SMark Adams         ierr = MatSetSizes(tMat, ncrs, ncrs,PETSC_DETERMINE, PETSC_DETERMINE);CHKERRQ(ierr);
227d9558ea9SBarry Smith         ierr = MatSetType(tMat,mtype);CHKERRQ(ierr);
228a2f3521dSMark F. Adams         ierr = MatSeqAIJSetPreallocation(tMat,0,d_nnz);CHKERRQ(ierr);
229a2f3521dSMark F. Adams         ierr = MatMPIAIJSetPreallocation(tMat,0,d_nnz,0,o_nnz);CHKERRQ(ierr);
230e632b94dSBarry Smith         ierr = PetscFree2(d_nnz,o_nnz);CHKERRQ(ierr);
231eb07cef2SMark F. Adams 
232a2f3521dSMark F. Adams         for (ii = Istart_crs; ii < Iend_crs; ii++) {
233c5bfad50SMark F. Adams           PetscInt dest_row = ii/cr_bs;
23422063be5SMark F. Adams           ierr = MatGetRow(Cmat,ii,&ncols,&idx,&vals);CHKERRQ(ierr);
235eb07cef2SMark F. Adams           for (jj = 0; jj < ncols; jj++) {
236c5bfad50SMark F. Adams             PetscInt    dest_col = idx[jj]/cr_bs;
237eb07cef2SMark F. Adams             PetscScalar v        = 1.0;
238eb07cef2SMark F. Adams             ierr = MatSetValues(tMat,1,&dest_row,1,&dest_col,&v,ADD_VALUES);CHKERRQ(ierr);
239eb07cef2SMark F. Adams           }
24022063be5SMark F. Adams           ierr = MatRestoreRow(Cmat,ii,&ncols,&idx,&vals);CHKERRQ(ierr);
241eb07cef2SMark F. Adams         }
242eb07cef2SMark F. Adams         ierr = MatAssemblyBegin(tMat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
243eb07cef2SMark F. Adams         ierr = MatAssemblyEnd(tMat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
244eb07cef2SMark F. Adams 
245b4fbaa2aSMark F. Adams         if (llev++ == -1) {
246b4fbaa2aSMark F. Adams           PetscViewer viewer; char fname[32];
2478caf3d72SBarry Smith           ierr = PetscSNPrintf(fname,sizeof(fname),"part_mat_%D.mat",llev);CHKERRQ(ierr);
2483b4367a7SBarry Smith           PetscViewerBinaryOpen(comm,fname,FILE_MODE_WRITE,&viewer);
249b4fbaa2aSMark F. Adams           ierr = MatView(tMat, viewer);CHKERRQ(ierr);
2503bf036e2SBarry Smith           ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
251b4fbaa2aSMark F. Adams         }
252eb07cef2SMark F. Adams         ierr = MatConvert(tMat, MATMPIADJ, MAT_INITIAL_MATRIX, &adj);CHKERRQ(ierr);
253eb07cef2SMark F. Adams         ierr = MatDestroy(&tMat);CHKERRQ(ierr);
254a2f3521dSMark F. Adams       } /* create 'adj' */
255f150b916SMark F. Adams 
256a2f3521dSMark F. Adams       { /* partition: get newproc_idx */
2575a9b9e01SMark F. Adams         char            prefix[256];
2585a9b9e01SMark F. Adams         const char      *pcpre;
259b4fbaa2aSMark F. Adams         const PetscInt  *is_idx;
260b4fbaa2aSMark F. Adams         MatPartitioning mpart;
261a4b7d37bSMark F. Adams         IS              proc_is;
2622f03bc48SMark F. Adams 
2633b4367a7SBarry Smith         ierr = MatPartitioningCreate(comm, &mpart);CHKERRQ(ierr);
2645ef31b24SMark F. Adams         ierr = MatPartitioningSetAdjacency(mpart, adj);CHKERRQ(ierr);
2659d5b6da9SMark F. Adams         ierr = PCGetOptionsPrefix(pc, &pcpre);CHKERRQ(ierr);
2668caf3d72SBarry Smith         ierr = PetscSNPrintf(prefix,sizeof(prefix),"%spc_gamg_",pcpre ? pcpre : "");CHKERRQ(ierr);
26759a0be82SJed Brown         ierr = PetscObjectSetOptionsPrefix((PetscObject)mpart,prefix);CHKERRQ(ierr);
26811e60469SMark F. Adams         ierr = MatPartitioningSetFromOptions(mpart);CHKERRQ(ierr);
269c5df96a5SBarry Smith         ierr = MatPartitioningSetNParts(mpart, new_size);CHKERRQ(ierr);
270a4b7d37bSMark F. Adams         ierr = MatPartitioningApply(mpart, &proc_is);CHKERRQ(ierr);
27111e60469SMark F. Adams         ierr = MatPartitioningDestroy(&mpart);CHKERRQ(ierr);
2725a9b9e01SMark F. Adams 
2735ef31b24SMark F. Adams         /* collect IS info */
274785e854fSJed Brown         ierr     = PetscMalloc1(ncrs_eq, &newproc_idx);CHKERRQ(ierr);
275a4b7d37bSMark F. Adams         ierr     = ISGetIndices(proc_is, &is_idx);CHKERRQ(ierr);
276a2f3521dSMark F. Adams         for (kk = jj = 0 ; kk < nloc_old ; kk++) {
277c5bfad50SMark F. Adams           for (ii = 0 ; ii < cr_bs ; ii++, jj++) {
278ce7c7f2fSMark Adams             newproc_idx[jj] = is_idx[kk] * expand_factor; /* distribution */
279eb07cef2SMark F. Adams           }
2805ef31b24SMark F. Adams         }
281a4b7d37bSMark F. Adams         ierr = ISRestoreIndices(proc_is, &is_idx);CHKERRQ(ierr);
282a4b7d37bSMark F. Adams         ierr = ISDestroy(&proc_is);CHKERRQ(ierr);
2835ef31b24SMark F. Adams       }
2845ef31b24SMark F. Adams       ierr = MatDestroy(&adj);CHKERRQ(ierr);
2855a9b9e01SMark F. Adams 
2863b4367a7SBarry Smith       ierr = ISCreateGeneral(comm, ncrs_eq, newproc_idx, PETSC_COPY_VALUES, &is_eq_newproc);CHKERRQ(ierr);
2878263b398SMark F. Adams       ierr = PetscFree(newproc_idx);CHKERRQ(ierr);
28831cb4603SMark Adams     } else { /* simple aggregation of parts -- 'is_eq_newproc' */
289ce7c7f2fSMark Adams       PetscInt targetPE;
2902c71b3e2SJacob Faibussowitsch       PetscCheckFalse(new_size==nactive,PETSC_COMM_SELF,PETSC_ERR_PLIB,"new_size==nactive. Should not happen");
2917d3de750SJacob Faibussowitsch       ierr = PetscInfo(pc,"Number of equations (loc) %D with simple aggregation\n",ncrs_eq);CHKERRQ(ierr);
292ce7c7f2fSMark Adams       targetPE = (rank/rfactor)*expand_factor;
2933b4367a7SBarry Smith       ierr     = ISCreateStride(comm, ncrs_eq, targetPE, 0, &is_eq_newproc);CHKERRQ(ierr);
294a2f3521dSMark F. Adams     } /* end simple 'is_eq_newproc' */
295e33ef3b1SMark F. Adams 
29611e60469SMark F. Adams     /*
297a2f3521dSMark F. Adams       Create an index set from the is_eq_newproc index set to indicate the mapping TO
29811e60469SMark F. Adams     */
299a2f3521dSMark F. Adams     ierr = ISPartitioningToNumbering(is_eq_newproc, &is_eq_num);CHKERRQ(ierr);
3007700e67bSMark Adams     is_eq_num_prim = is_eq_num;
30111e60469SMark F. Adams     /*
302a2f3521dSMark F. Adams       Determine how many equations/vertices are assigned to each processor
30311e60469SMark F. Adams     */
304c5df96a5SBarry Smith     ierr        = ISPartitioningCount(is_eq_newproc, size, counts);CHKERRQ(ierr);
305c5df96a5SBarry Smith     ncrs_eq_new = counts[rank];
306a2f3521dSMark F. Adams     ierr        = ISDestroy(&is_eq_newproc);CHKERRQ(ierr);
307ce7c7f2fSMark Adams     ncrs_new = ncrs_eq_new/cr_bs;
308a2f3521dSMark F. Adams 
309a2f3521dSMark F. Adams     ierr = PetscFree(counts);CHKERRQ(ierr);
310885364a3SMark Adams     /* data movement scope -- this could be moved to subclasses so that we don't try to cram all auxilary data into some complex abstracted thing */
311885364a3SMark Adams     {
312885364a3SMark Adams       Vec            src_crd, dest_crd;
313885364a3SMark Adams       const PetscInt *idx,ndata_rows=pc_gamg->data_cell_rows,ndata_cols=pc_gamg->data_cell_cols,node_data_sz=ndata_rows*ndata_cols;
314885364a3SMark Adams       VecScatter     vecscat;
315885364a3SMark Adams       PetscScalar    *array;
316885364a3SMark Adams       IS isscat;
317a2f3521dSMark F. Adams       /* move data (for primal equations only) */
31822063be5SMark F. Adams       /* Create a vector to contain the newly ordered element information */
3193b4367a7SBarry Smith       ierr = VecCreate(comm, &dest_crd);CHKERRQ(ierr);
3203ae0bb68SMark Adams       ierr = VecSetSizes(dest_crd, node_data_sz*ncrs_new, PETSC_DECIDE);CHKERRQ(ierr);
321c0dedaeaSBarry Smith       ierr = VecSetType(dest_crd,VECSTANDARD);CHKERRQ(ierr); /* this is needed! */
32211e60469SMark F. Adams       /*
3239d5b6da9SMark F. Adams         There are 'ndata_rows*ndata_cols' data items per node, (one can think of the vectors of having
324c5bfad50SMark F. Adams         a block size of ...).  Note, ISs are expanded into equation space by 'cr_bs'.
32511e60469SMark F. Adams       */
326854ce69bSBarry Smith       ierr = PetscMalloc1(ncrs*node_data_sz, &tidx);CHKERRQ(ierr);
327a2f3521dSMark F. Adams       ierr = ISGetIndices(is_eq_num_prim, &idx);CHKERRQ(ierr);
3283ae0bb68SMark Adams       for (ii=0,jj=0; ii<ncrs; ii++) {
329c5bfad50SMark F. Adams         PetscInt id = idx[ii*cr_bs]/cr_bs; /* get node back */
330a2f3521dSMark F. Adams         for (kk=0; kk<node_data_sz; kk++, jj++) tidx[jj] = id*node_data_sz + kk;
33111e60469SMark F. Adams       }
332a2f3521dSMark F. Adams       ierr = ISRestoreIndices(is_eq_num_prim, &idx);CHKERRQ(ierr);
3333ae0bb68SMark Adams       ierr = ISCreateGeneral(comm, node_data_sz*ncrs, tidx, PETSC_COPY_VALUES, &isscat);CHKERRQ(ierr);
33492a756f0SMark F. Adams       ierr = PetscFree(tidx);CHKERRQ(ierr);
33511e60469SMark F. Adams       /*
33611e60469SMark F. Adams         Create a vector to contain the original vertex information for each element
33711e60469SMark F. Adams       */
3383ae0bb68SMark Adams       ierr = VecCreateSeq(PETSC_COMM_SELF, node_data_sz*ncrs, &src_crd);CHKERRQ(ierr);
3399d5b6da9SMark F. Adams       for (jj=0; jj<ndata_cols; jj++) {
3403ae0bb68SMark Adams         const PetscInt stride0=ncrs*pc_gamg->data_cell_rows;
3413ae0bb68SMark Adams         for (ii=0; ii<ncrs; ii++) {
3429d5b6da9SMark F. Adams           for (kk=0; kk<ndata_rows; kk++) {
343a2f3521dSMark F. Adams             PetscInt    ix = ii*ndata_rows + kk + jj*stride0, jx = ii*node_data_sz + kk*ndata_cols + jj;
344c8b0795cSMark F. Adams             PetscScalar tt = (PetscScalar)pc_gamg->data[ix];
345676e1743SMark F. Adams             ierr = VecSetValues(src_crd, 1, &jx, &tt, INSERT_VALUES);CHKERRQ(ierr);
346d3d6bff4SMark F. Adams           }
347038e3b61SMark F. Adams         }
348eb07cef2SMark F. Adams       }
349eb07cef2SMark F. Adams       ierr = VecAssemblyBegin(src_crd);CHKERRQ(ierr);
350eb07cef2SMark F. Adams       ierr = VecAssemblyEnd(src_crd);CHKERRQ(ierr);
35111e60469SMark F. Adams       /*
35211e60469SMark F. Adams         Scatter the element vertex information (still in the original vertex ordering)
35311e60469SMark F. Adams         to the correct processor
35411e60469SMark F. Adams       */
3559448b7f1SJunchao Zhang       ierr = VecScatterCreate(src_crd, NULL, dest_crd, isscat, &vecscat);CHKERRQ(ierr);
35611e60469SMark F. Adams       ierr = ISDestroy(&isscat);CHKERRQ(ierr);
35711e60469SMark F. Adams       ierr = VecScatterBegin(vecscat,src_crd,dest_crd,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
35811e60469SMark F. Adams       ierr = VecScatterEnd(vecscat,src_crd,dest_crd,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
35911e60469SMark F. Adams       ierr = VecScatterDestroy(&vecscat);CHKERRQ(ierr);
36011e60469SMark F. Adams       ierr = VecDestroy(&src_crd);CHKERRQ(ierr);
36111e60469SMark F. Adams       /*
36211e60469SMark F. Adams         Put the element vertex data into a new allocation of the gdata->ele
36311e60469SMark F. Adams       */
364c8b0795cSMark F. Adams       ierr = PetscFree(pc_gamg->data);CHKERRQ(ierr);
365578f55a3SPeter Brune       ierr = PetscMalloc1(node_data_sz*ncrs_new, &pc_gamg->data);CHKERRQ(ierr);
3662fa5cd67SKarl Rupp 
3673ae0bb68SMark Adams       pc_gamg->data_sz = node_data_sz*ncrs_new;
3683ae0bb68SMark Adams       strideNew        = ncrs_new*ndata_rows;
3692fa5cd67SKarl Rupp 
37011e60469SMark F. Adams       ierr = VecGetArray(dest_crd, &array);CHKERRQ(ierr);
3719d5b6da9SMark F. Adams       for (jj=0; jj<ndata_cols; jj++) {
3723ae0bb68SMark Adams         for (ii=0; ii<ncrs_new; ii++) {
3739d5b6da9SMark F. Adams           for (kk=0; kk<ndata_rows; kk++) {
374a2f3521dSMark F. Adams             PetscInt ix = ii*ndata_rows + kk + jj*strideNew, jx = ii*node_data_sz + kk*ndata_cols + jj;
375c8b0795cSMark F. Adams             pc_gamg->data[ix] = PetscRealPart(array[jx]);
376d3d6bff4SMark F. Adams           }
377038e3b61SMark F. Adams         }
378038e3b61SMark F. Adams       }
37911e60469SMark F. Adams       ierr = VecRestoreArray(dest_crd, &array);CHKERRQ(ierr);
38011e60469SMark F. Adams       ierr = VecDestroy(&dest_crd);CHKERRQ(ierr);
381885364a3SMark Adams     }
382a2f3521dSMark F. Adams     /* move A and P (columns) with new layout */
3830cbbd2e1SMark F. Adams     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET13],0,0,0,0);CHKERRQ(ierr);
38411e60469SMark F. Adams     /*
3857dae84e0SHong Zhang       Invert for MatCreateSubMatrix
38611e60469SMark F. Adams     */
387a2f3521dSMark F. Adams     ierr = ISInvertPermutation(is_eq_num, ncrs_eq_new, &new_eq_indices);CHKERRQ(ierr);
388a2f3521dSMark F. Adams     ierr = ISSort(new_eq_indices);CHKERRQ(ierr); /* is this needed? */
389c5bfad50SMark F. Adams     ierr = ISSetBlockSize(new_eq_indices, cr_bs);CHKERRQ(ierr);
390a2f3521dSMark F. Adams     if (is_eq_num != is_eq_num_prim) {
391a2f3521dSMark F. Adams       ierr = ISDestroy(&is_eq_num_prim);CHKERRQ(ierr); /* could be same as 'is_eq_num' */
392a2f3521dSMark F. Adams     }
3933cb8563fSToby Isaac     if (Pcolumnperm) {
3943cb8563fSToby Isaac       ierr = PetscObjectReference((PetscObject)new_eq_indices);CHKERRQ(ierr);
3953cb8563fSToby Isaac       *Pcolumnperm = new_eq_indices;
3963cb8563fSToby Isaac     }
397a2f3521dSMark F. Adams     ierr = ISDestroy(&is_eq_num);CHKERRQ(ierr);
3980cbbd2e1SMark F. Adams     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET13],0,0,0,0);CHKERRQ(ierr);
3990cbbd2e1SMark F. Adams     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET14],0,0,0,0);CHKERRQ(ierr);
400a2f3521dSMark F. Adams     /* 'a_Amat_crs' output */
401a2f3521dSMark F. Adams     {
402a2f3521dSMark F. Adams       Mat       mat;
40390db8557SMark Adams       PetscBool flg;
4047dae84e0SHong Zhang       ierr = MatCreateSubMatrix(Cmat, new_eq_indices, new_eq_indices, MAT_INITIAL_MATRIX, &mat);CHKERRQ(ierr);
40590db8557SMark Adams       ierr = MatGetOption(Cmat, MAT_SPD, &flg);CHKERRQ(ierr);
40690db8557SMark Adams       if (flg) {
40790db8557SMark Adams         ierr = MatSetOption(mat, MAT_SPD,PETSC_TRUE);CHKERRQ(ierr);
40890db8557SMark Adams       } else {
40990db8557SMark Adams         ierr = MatGetOption(Cmat, MAT_HERMITIAN, &flg);CHKERRQ(ierr);
41090db8557SMark Adams         if (flg) {
41190db8557SMark Adams           ierr = MatSetOption(mat, MAT_HERMITIAN,PETSC_TRUE);CHKERRQ(ierr);
41290db8557SMark Adams         } else {
41390db8557SMark Adams #if !defined(PETSC_USE_COMPLEX)
41490db8557SMark Adams           ierr = MatGetOption(Cmat, MAT_SYMMETRIC, &flg);CHKERRQ(ierr);
41590db8557SMark Adams           if (flg) {
41690db8557SMark Adams             ierr = MatSetOption(mat, MAT_SYMMETRIC,PETSC_TRUE);CHKERRQ(ierr);
41790db8557SMark Adams           }
41890db8557SMark Adams #endif
41990db8557SMark Adams         }
42090db8557SMark Adams       }
421a2f3521dSMark F. Adams       *a_Amat_crs = mat;
422a2f3521dSMark F. Adams     }
423038e3b61SMark F. Adams     ierr = MatDestroy(&Cmat);CHKERRQ(ierr);
424a2f3521dSMark F. Adams 
4250cbbd2e1SMark F. Adams     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET14],0,0,0,0);CHKERRQ(ierr);
42611e60469SMark F. Adams     /* prolongator */
42711e60469SMark F. Adams     {
42811e60469SMark F. Adams       IS       findices;
429a2f3521dSMark F. Adams       PetscInt Istart,Iend;
430a2f3521dSMark F. Adams       Mat      Pnew;
43162294041SBarry Smith 
432a2f3521dSMark F. Adams       ierr = MatGetOwnershipRange(Pold, &Istart, &Iend);CHKERRQ(ierr);
4330cbbd2e1SMark F. Adams       ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET15],0,0,0,0);CHKERRQ(ierr);
4343b4367a7SBarry Smith       ierr = ISCreateStride(comm,Iend-Istart,Istart,1,&findices);CHKERRQ(ierr);
435c5bfad50SMark F. Adams       ierr = ISSetBlockSize(findices,f_bs);CHKERRQ(ierr);
4367dae84e0SHong Zhang       ierr = MatCreateSubMatrix(Pold, findices, new_eq_indices, MAT_INITIAL_MATRIX, &Pnew);CHKERRQ(ierr);
43711e60469SMark F. Adams       ierr = ISDestroy(&findices);CHKERRQ(ierr);
4381a2c6b5cSJunchao Zhang       ierr = MatSetOption(Pnew,MAT_FORM_EXPLICIT_TRANSPOSE,PETSC_TRUE);CHKERRQ(ierr);
439c5bfad50SMark F. Adams 
4400cbbd2e1SMark F. Adams       ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET15],0,0,0,0);CHKERRQ(ierr);
4413530afc2SMark F. Adams       ierr = MatDestroy(a_P_inout);CHKERRQ(ierr);
442a2f3521dSMark F. Adams 
443a2f3521dSMark F. Adams       /* output - repartitioned */
444a2f3521dSMark F. Adams       *a_P_inout = Pnew;
445e33ef3b1SMark F. Adams     }
446a2f3521dSMark F. Adams     ierr = ISDestroy(&new_eq_indices);CHKERRQ(ierr);
4475b89ad90SMark F. Adams 
448c5df96a5SBarry Smith     *a_nactive_proc = new_size; /* output */
449ce7c7f2fSMark Adams 
450ce7c7f2fSMark Adams     /* pinning on reduced grids, not a bad heuristic and optimization gets folded into process reduction optimization */
451ce7c7f2fSMark Adams     if (pc_gamg->cpu_pin_coarse_grids) {
452ce7c7f2fSMark Adams #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
4538bca76a6SMark Adams       static PetscInt llev = 2;
4547d3de750SJacob Faibussowitsch       ierr = PetscInfo(pc,"Pinning level %D to the CPU\n",llev++);CHKERRQ(ierr);
455ce7c7f2fSMark Adams #endif
456b470e4b4SRichard Tran Mills       ierr = MatBindToCPU(*a_Amat_crs,PETSC_TRUE);CHKERRQ(ierr);
457b470e4b4SRichard Tran Mills       ierr = MatBindToCPU(*a_P_inout,PETSC_TRUE);CHKERRQ(ierr);
458adf5291fSStefano Zampini       if (1) { /* HACK: move this to MatBindCPU_MPIAIJXXX; lvec is created, need to pin it, this is done in MatSetUpMultiply_MPIAIJ. Hack */
459ce7c7f2fSMark Adams         Mat         A = *a_Amat_crs, P = *a_P_inout;
460ce7c7f2fSMark Adams         PetscMPIInt size;
461ffc4695bSBarry Smith         ierr = MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);CHKERRMPI(ierr);
462ce7c7f2fSMark Adams         if (size > 1) {
463ce7c7f2fSMark Adams           Mat_MPIAIJ     *a = (Mat_MPIAIJ*)A->data, *p = (Mat_MPIAIJ*)P->data;
464b470e4b4SRichard Tran Mills           ierr = VecBindToCPU(a->lvec,PETSC_TRUE);CHKERRQ(ierr);
465b470e4b4SRichard Tran Mills           ierr = VecBindToCPU(p->lvec,PETSC_TRUE);CHKERRQ(ierr);
466ce7c7f2fSMark Adams         }
467ce7c7f2fSMark Adams       }
468ce7c7f2fSMark Adams     }
4694cdfd227SMark     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET12],0,0,0,0);CHKERRQ(ierr);
470a2f3521dSMark F. Adams   }
4715b89ad90SMark F. Adams   PetscFunctionReturn(0);
4725b89ad90SMark F. Adams }
4735b89ad90SMark F. Adams 
4744b1575e2SStefano Zampini PetscErrorCode PCGAMGSquareGraph_GAMG(PC a_pc, Mat Gmat1, Mat* Gmat2)
4754b1575e2SStefano Zampini {
4764b1575e2SStefano Zampini   PetscErrorCode ierr;
4774b1575e2SStefano Zampini   const char     *prefix;
4784b1575e2SStefano Zampini   char           addp[32];
4794b1575e2SStefano Zampini   PC_MG          *mg      = (PC_MG*)a_pc->data;
4804b1575e2SStefano Zampini   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
4814b1575e2SStefano Zampini 
4824b1575e2SStefano Zampini   PetscFunctionBegin;
4834b1575e2SStefano Zampini   ierr = PCGetOptionsPrefix(a_pc,&prefix);CHKERRQ(ierr);
4847d3de750SJacob Faibussowitsch   ierr = PetscInfo(a_pc,"Square Graph on level %D\n",pc_gamg->current_level+1);CHKERRQ(ierr);
4854b1575e2SStefano Zampini   ierr = MatProductCreate(Gmat1,Gmat1,NULL,Gmat2);CHKERRQ(ierr);
4864b1575e2SStefano Zampini   ierr = MatSetOptionsPrefix(*Gmat2,prefix);CHKERRQ(ierr);
4874b1575e2SStefano Zampini   ierr = PetscSNPrintf(addp,sizeof(addp),"pc_gamg_square_%d_",pc_gamg->current_level);CHKERRQ(ierr);
4884b1575e2SStefano Zampini   ierr = MatAppendOptionsPrefix(*Gmat2,addp);CHKERRQ(ierr);
489b4da3a1bSStefano Zampini   if ((*Gmat2)->structurally_symmetric) {
490b4da3a1bSStefano Zampini     ierr = MatProductSetType(*Gmat2,MATPRODUCT_AB);CHKERRQ(ierr);
491b4da3a1bSStefano Zampini   } else {
4921a2c6b5cSJunchao Zhang     ierr = MatSetOption(Gmat1,MAT_FORM_EXPLICIT_TRANSPOSE,PETSC_TRUE);CHKERRQ(ierr);
4934b1575e2SStefano Zampini     ierr = MatProductSetType(*Gmat2,MATPRODUCT_AtB);CHKERRQ(ierr);
494b4da3a1bSStefano Zampini   }
4954b1575e2SStefano Zampini   ierr = MatProductSetFromOptions(*Gmat2);CHKERRQ(ierr);
4964555aa8cSStefano Zampini   ierr = PetscLogEventBegin(petsc_gamg_setup_matmat_events[pc_gamg->current_level][0],0,0,0,0);CHKERRQ(ierr);
4974b1575e2SStefano Zampini   ierr = MatProductSymbolic(*Gmat2);CHKERRQ(ierr);
4984555aa8cSStefano Zampini   ierr = PetscLogEventEnd(petsc_gamg_setup_matmat_events[pc_gamg->current_level][0],0,0,0,0);CHKERRQ(ierr);
499b4da3a1bSStefano Zampini   ierr = MatProductClear(*Gmat2);CHKERRQ(ierr);
5004b1575e2SStefano Zampini   /* we only need the sparsity, cheat and tell PETSc the matrix has been assembled */
5014b1575e2SStefano Zampini   (*Gmat2)->assembled = PETSC_TRUE;
5024b1575e2SStefano Zampini   PetscFunctionReturn(0);
5034b1575e2SStefano Zampini }
5044b1575e2SStefano Zampini 
5055b89ad90SMark F. Adams /* -------------------------------------------------------------------------- */
5065b89ad90SMark F. Adams /*
5075b89ad90SMark F. Adams    PCSetUp_GAMG - Prepares for the use of the GAMG preconditioner
5085b89ad90SMark F. Adams                     by setting data structures and options.
5095b89ad90SMark F. Adams 
5105b89ad90SMark F. Adams    Input Parameter:
5115b89ad90SMark F. Adams .  pc - the preconditioner context
5125b89ad90SMark F. Adams 
5135b89ad90SMark F. Adams */
5149d5b6da9SMark F. Adams PetscErrorCode PCSetUp_GAMG(PC pc)
5155b89ad90SMark F. Adams {
5165b89ad90SMark F. Adams   PetscErrorCode ierr;
5179d5b6da9SMark F. Adams   PC_MG          *mg      = (PC_MG*)pc->data;
5185b89ad90SMark F. Adams   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
5192adcac29SMark F. Adams   Mat            Pmat     = pc->pmat;
52018c3aa7eSMark   PetscInt       fine_level,level,level1,bs,M,N,qq,lidx,nASMBlocksArr[PETSC_MG_MAXLEVELS];
5213b4367a7SBarry Smith   MPI_Comm       comm;
522c5df96a5SBarry Smith   PetscMPIInt    rank,size,nactivepe;
52318c3aa7eSMark   Mat            Aarr[PETSC_MG_MAXLEVELS],Parr[PETSC_MG_MAXLEVELS];
52418c3aa7eSMark   IS             *ASMLocalIDsArr[PETSC_MG_MAXLEVELS];
525a2f3521dSMark F. Adams   PetscLogDouble nnz0=0.,nnztot=0.;
526569f4572SMark Adams   MatInfo        info;
527171cca9aSMark Adams   PetscBool      is_last = PETSC_FALSE;
5285ef31b24SMark F. Adams 
5295b89ad90SMark F. Adams   PetscFunctionBegin;
5303b4367a7SBarry Smith   ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
531ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRMPI(ierr);
532ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRMPI(ierr);
533dfd5c07aSMark F. Adams 
5348abdc6daSStefano Zampini   if (pc->setupcalled) {
5358abdc6daSStefano Zampini     if (!pc_gamg->reuse_prol || pc->flag == DIFFERENT_NONZERO_PATTERN) {
536878e152fSMark F. Adams       /* reset everything */
537878e152fSMark F. Adams       ierr = PCReset_MG(pc);CHKERRQ(ierr);
538878e152fSMark F. Adams       pc->setupcalled = 0;
539806fa848SBarry Smith     } else {
54084d3f75bSMark F. Adams       PC_MG_Levels **mglevels = mg->levels;
54103a628feSMark F. Adams       /* just do Galerkin grids */
54258471d46SMark F. Adams       Mat          B,dA,dB;
54358471d46SMark F. Adams 
5449d5b6da9SMark F. Adams       if (pc_gamg->Nlevels > 1) {
5454555aa8cSStefano Zampini         PetscInt gl;
54658471d46SMark F. Adams         /* currently only handle case where mat and pmat are the same on coarser levels */
54723ee1639SBarry Smith         ierr = KSPGetOperators(mglevels[pc_gamg->Nlevels-1]->smoothd,&dA,&dB);CHKERRQ(ierr);
54858471d46SMark F. Adams         /* (re)set to get dirty flag */
54923ee1639SBarry Smith         ierr = KSPSetOperators(mglevels[pc_gamg->Nlevels-1]->smoothd,dA,dB);CHKERRQ(ierr);
55058471d46SMark F. Adams 
5514555aa8cSStefano Zampini         for (level=pc_gamg->Nlevels-2,gl=0; level>=0; level--,gl++) {
5528abdc6daSStefano Zampini           MatReuse reuse = MAT_INITIAL_MATRIX ;
5538abdc6daSStefano Zampini 
5548abdc6daSStefano Zampini           /* matrix structure can change from repartitioning or process reduction but don't know if we have process reduction here. Should fix */
55523ee1639SBarry Smith           ierr = KSPGetOperators(mglevels[level]->smoothd,NULL,&B);CHKERRQ(ierr);
5568abdc6daSStefano Zampini           if (B->product) {
5578abdc6daSStefano Zampini             if (B->product->A == dB && B->product->B == mglevels[level+1]->interpolate) {
5588abdc6daSStefano Zampini               reuse = MAT_REUSE_MATRIX;
55903a628feSMark F. Adams             }
5608abdc6daSStefano Zampini           }
5618abdc6daSStefano Zampini           if (reuse == MAT_INITIAL_MATRIX) { ierr = MatDestroy(&mglevels[level]->A);CHKERRQ(ierr); }
5628abdc6daSStefano Zampini           if (reuse == MAT_REUSE_MATRIX) {
5637d3de750SJacob Faibussowitsch             ierr = PetscInfo(pc,"RAP after first solve, reuse matrix level %D\n",level);CHKERRQ(ierr);
5648abdc6daSStefano Zampini           } else {
5657d3de750SJacob Faibussowitsch             ierr = PetscInfo(pc,"RAP after first solve, new matrix level %D\n",level);CHKERRQ(ierr);
5668abdc6daSStefano Zampini           }
5674555aa8cSStefano Zampini           ierr = PetscLogEventBegin(petsc_gamg_setup_matmat_events[gl][1],0,0,0,0);CHKERRQ(ierr);
5688abdc6daSStefano Zampini           ierr = MatPtAP(dB,mglevels[level+1]->interpolate,reuse,PETSC_DEFAULT,&B);CHKERRQ(ierr);
5694555aa8cSStefano Zampini           ierr = PetscLogEventEnd(petsc_gamg_setup_matmat_events[gl][1],0,0,0,0);CHKERRQ(ierr);
57063b77682SMark Adams           if (reuse == MAT_INITIAL_MATRIX) mglevels[level]->A = B;
57123ee1639SBarry Smith           ierr = KSPSetOperators(mglevels[level]->smoothd,B,B);CHKERRQ(ierr);
57258471d46SMark F. Adams           dB   = B;
57358471d46SMark F. Adams         }
5745f8cf99dSMark F. Adams       }
575d5280255SMark F. Adams 
576d5280255SMark F. Adams       ierr = PCSetUp_MG(pc);CHKERRQ(ierr);
57758471d46SMark F. Adams       PetscFunctionReturn(0);
578eb07cef2SMark F. Adams     }
579878e152fSMark F. Adams   }
580f6536408SMark F. Adams 
581878e152fSMark F. Adams   if (!pc_gamg->data) {
582878e152fSMark F. Adams     if (pc_gamg->orig_data) {
583878e152fSMark F. Adams       ierr = MatGetBlockSize(Pmat, &bs);CHKERRQ(ierr);
5840298fd71SBarry Smith       ierr = MatGetLocalSize(Pmat, &qq, NULL);CHKERRQ(ierr);
5852fa5cd67SKarl Rupp 
586878e152fSMark F. Adams       pc_gamg->data_sz        = (qq/bs)*pc_gamg->orig_data_cell_rows*pc_gamg->orig_data_cell_cols;
587878e152fSMark F. Adams       pc_gamg->data_cell_rows = pc_gamg->orig_data_cell_rows;
588878e152fSMark F. Adams       pc_gamg->data_cell_cols = pc_gamg->orig_data_cell_cols;
5892fa5cd67SKarl Rupp 
590785e854fSJed Brown       ierr = PetscMalloc1(pc_gamg->data_sz, &pc_gamg->data);CHKERRQ(ierr);
591878e152fSMark F. Adams       for (qq=0; qq<pc_gamg->data_sz; qq++) pc_gamg->data[qq] = pc_gamg->orig_data[qq];
592806fa848SBarry Smith     } else {
5932c71b3e2SJacob Faibussowitsch       PetscCheckFalse(!pc_gamg->ops->createdefaultdata,comm,PETSC_ERR_PLIB,"'createdefaultdata' not set(?) need to support NULL data");
5947700e67bSMark Adams       ierr = pc_gamg->ops->createdefaultdata(pc,Pmat);CHKERRQ(ierr);
5959d5b6da9SMark F. Adams     }
596878e152fSMark F. Adams   }
597878e152fSMark F. Adams 
598878e152fSMark F. Adams   /* cache original data for reuse */
5991c1aac46SBarry Smith   if (!pc_gamg->orig_data && (PetscBool)(!pc_gamg->reuse_prol)) {
600785e854fSJed Brown     ierr = PetscMalloc1(pc_gamg->data_sz, &pc_gamg->orig_data);CHKERRQ(ierr);
601878e152fSMark F. Adams     for (qq=0; qq<pc_gamg->data_sz; qq++) pc_gamg->orig_data[qq] = pc_gamg->data[qq];
602878e152fSMark F. Adams     pc_gamg->orig_data_cell_rows = pc_gamg->data_cell_rows;
603878e152fSMark F. Adams     pc_gamg->orig_data_cell_cols = pc_gamg->data_cell_cols;
604878e152fSMark F. Adams   }
605038e3b61SMark F. Adams 
606302f38e8SMark F. Adams   /* get basic dims */
607302f38e8SMark F. Adams   ierr = MatGetBlockSize(Pmat, &bs);CHKERRQ(ierr);
608171cca9aSMark Adams   ierr = MatGetSize(Pmat, &M, &N);CHKERRQ(ierr);
60984d3f75bSMark F. Adams 
610569f4572SMark Adams   ierr = MatGetInfo(Pmat,MAT_GLOBAL_SUM,&info);CHKERRQ(ierr); /* global reduction */
611569f4572SMark Adams   nnz0   = info.nz_used;
612569f4572SMark Adams   nnztot = info.nz_used;
6137d3de750SJacob Faibussowitsch   ierr = PetscInfo(pc,"level %D) N=%D, n data rows=%D, n data cols=%D, nnz/row (ave)=%d, np=%D\n",0,M,pc_gamg->data_cell_rows,pc_gamg->data_cell_cols,(int)(nnz0/(PetscReal)M+0.5),size);CHKERRQ(ierr);
614569f4572SMark Adams 
615a2f3521dSMark F. Adams   /* Get A_i and R_i */
61662294041SBarry Smith   for (level=0, Aarr[0]=Pmat, nactivepe = size; level < (pc_gamg->Nlevels-1) && (!level || M>pc_gamg->coarse_eq_limit); level++) {
6179ab59c8bSMark Adams     pc_gamg->current_level = level;
6182c71b3e2SJacob Faibussowitsch     PetscCheckFalse(level >= PETSC_MG_MAXLEVELS,PETSC_COMM_SELF,PETSC_ERR_PLIB,"Too many levels %D",level);
6195b89ad90SMark F. Adams     level1 = level + 1;
6200cbbd2e1SMark F. Adams     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET1],0,0,0,0);CHKERRQ(ierr);
6214555aa8cSStefano Zampini #if defined(GAMG_STAGES)
622a2f3521dSMark F. Adams     ierr = PetscLogStagePush(gamg_stages[level]);CHKERRQ(ierr);
623b4fbaa2aSMark F. Adams #endif
624c8b0795cSMark F. Adams     { /* construct prolongator */
625725b86d8SJed Brown       Mat              Gmat;
6260cbbd2e1SMark F. Adams       PetscCoarsenData *agg_lists;
6277700e67bSMark Adams       Mat              Prol11;
628c8b0795cSMark F. Adams 
6297700e67bSMark Adams       ierr = pc_gamg->ops->graph(pc,Aarr[level], &Gmat);CHKERRQ(ierr);
6301ab5ffc9SJed Brown       ierr = pc_gamg->ops->coarsen(pc, &Gmat, &agg_lists);CHKERRQ(ierr);
6317700e67bSMark Adams       ierr = pc_gamg->ops->prolongator(pc,Aarr[level],Gmat,agg_lists,&Prol11);CHKERRQ(ierr);
632c8b0795cSMark F. Adams 
633a2f3521dSMark F. Adams       /* could have failed to create new level */
634a2f3521dSMark F. Adams       if (Prol11) {
635f7df55f0SStefano Zampini         const char *prefix;
636f7df55f0SStefano Zampini         char       addp[32];
637f7df55f0SStefano Zampini 
6389d5b6da9SMark F. Adams         /* get new block size of coarse matrices */
6390298fd71SBarry Smith         ierr = MatGetBlockSizes(Prol11, NULL, &bs);CHKERRQ(ierr);
640a2f3521dSMark F. Adams 
641fd1112cbSBarry Smith         if (pc_gamg->ops->optprolongator) {
642c8b0795cSMark F. Adams           /* smooth */
643fd1112cbSBarry Smith           ierr = pc_gamg->ops->optprolongator(pc, Aarr[level], &Prol11);CHKERRQ(ierr);
644c8b0795cSMark F. Adams         }
645c8b0795cSMark F. Adams 
6460c3bc534SBarry Smith         if (pc_gamg->use_aggs_in_asm) {
6471b18a24aSMark Adams           PetscInt bs;
6481b18a24aSMark Adams           ierr = MatGetBlockSizes(Prol11, &bs, NULL);CHKERRQ(ierr);
6490a3c815dSMark Adams           ierr = PetscCDGetASMBlocks(agg_lists, bs, Gmat, &nASMBlocksArr[level], &ASMLocalIDsArr[level]);CHKERRQ(ierr);
650ffc955d6SMark F. Adams         }
651ffc955d6SMark F. Adams 
652f7df55f0SStefano Zampini         ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
653f7df55f0SStefano Zampini         ierr = MatSetOptionsPrefix(Prol11,prefix);CHKERRQ(ierr);
654c9567895SMark         ierr = PetscSNPrintf(addp,sizeof(addp),"pc_gamg_prolongator_%d_",(int)level);CHKERRQ(ierr);
655f7df55f0SStefano Zampini         ierr = MatAppendOptionsPrefix(Prol11,addp);CHKERRQ(ierr);
65691f31d3dSStefano Zampini         /* Always generate the transpose with CUDA
657f7df55f0SStefano Zampini            Such behaviour can be adapted with -pc_gamg_prolongator_ prefixed options */
6581a2c6b5cSJunchao Zhang         ierr = MatSetOption(Prol11,MAT_FORM_EXPLICIT_TRANSPOSE,PETSC_TRUE);CHKERRQ(ierr);
659f7df55f0SStefano Zampini         ierr = MatSetFromOptions(Prol11);CHKERRQ(ierr);
6604bde40a0SMark Adams         Parr[level1] = Prol11;
6614bde40a0SMark Adams       } else Parr[level1] = NULL; /* failed to coarsen */
6624bde40a0SMark Adams 
663a2f3521dSMark F. Adams       ierr = MatDestroy(&Gmat);CHKERRQ(ierr);
66441b27cdeSMark F. Adams       ierr = PetscCDDestroy(agg_lists);CHKERRQ(ierr);
665a2f3521dSMark F. Adams     } /* construct prolongator scope */
6660cbbd2e1SMark F. Adams     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET1],0,0,0,0);CHKERRQ(ierr);
6677f66b68fSMark Adams     if (!level) Aarr[0] = Pmat; /* use Pmat for finest level setup */
668171cca9aSMark Adams     if (!Parr[level1]) { /* failed to coarsen */
6697d3de750SJacob Faibussowitsch       ierr = PetscInfo(pc,"Stop gridding, level %D\n",level);CHKERRQ(ierr);
6704555aa8cSStefano Zampini #if defined(GAMG_STAGES)
671a90e85d9SMark Adams       ierr = PetscLogStagePop();CHKERRQ(ierr);
672a90e85d9SMark Adams #endif
673c8b0795cSMark F. Adams       break;
674c8b0795cSMark F. Adams     }
6750cbbd2e1SMark F. Adams     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET2],0,0,0,0);CHKERRQ(ierr);
676171cca9aSMark Adams     ierr = MatGetSize(Parr[level1], &M, &N);CHKERRQ(ierr); /* N is next M, a loop test variables */
6772c71b3e2SJacob Faibussowitsch     PetscCheckFalse(is_last,PETSC_COMM_SELF,PETSC_ERR_PLIB,"Is last ?");
678171cca9aSMark Adams     if (N <= pc_gamg->coarse_eq_limit) is_last = PETSC_TRUE;
6790e2909e1SMark Adams     if (level1 == pc_gamg->Nlevels-1) is_last = PETSC_TRUE;
680171cca9aSMark Adams     ierr = pc_gamg->ops->createlevel(pc, Aarr[level], bs, &Parr[level1], &Aarr[level1], &nactivepe, NULL, is_last);CHKERRQ(ierr);
681a2f3521dSMark F. Adams 
6820cbbd2e1SMark F. Adams     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET2],0,0,0,0);CHKERRQ(ierr);
683171cca9aSMark Adams     ierr = MatGetSize(Aarr[level1], &M, &N);CHKERRQ(ierr); /* M is loop test variables */
684569f4572SMark Adams     ierr = MatGetInfo(Aarr[level1], MAT_GLOBAL_SUM, &info);CHKERRQ(ierr);
685569f4572SMark Adams     nnztot += info.nz_used;
6867d3de750SJacob Faibussowitsch     ierr = PetscInfo(pc,"%D) N=%D, n data cols=%D, nnz/row (ave)=%d, %D active pes\n",level1,M,pc_gamg->data_cell_cols,(int)(info.nz_used/(PetscReal)M),nactivepe);CHKERRQ(ierr);
687569f4572SMark Adams 
6884555aa8cSStefano Zampini #if defined(GAMG_STAGES)
689b4fbaa2aSMark F. Adams     ierr = PetscLogStagePop();CHKERRQ(ierr);
690b4fbaa2aSMark F. Adams #endif
691a90e85d9SMark Adams     /* stop if one node or one proc -- could pull back for singular problems */
6929ab59c8bSMark Adams     if ((pc_gamg->data_cell_cols && M/pc_gamg->data_cell_cols < 2) || (!pc_gamg->data_cell_cols && M/bs < 2)) {
6937d3de750SJacob Faibussowitsch       ierr =  PetscInfo(pc,"HARD stop of coarsening on level %D.  Grid too small: %D block nodes\n",level,M/bs);CHKERRQ(ierr);
694a90e85d9SMark Adams       level++;
695a90e85d9SMark Adams       break;
696a90e85d9SMark Adams     }
697c8b0795cSMark F. Adams   } /* levels */
698c8b0795cSMark F. Adams   ierr = PetscFree(pc_gamg->data);CHKERRQ(ierr);
699c8b0795cSMark F. Adams 
7007d3de750SJacob Faibussowitsch   ierr = PetscInfo(pc,"%D levels, grid complexity = %g\n",level+1,nnztot/nnz0);CHKERRQ(ierr);
7019d5b6da9SMark F. Adams   pc_gamg->Nlevels = level + 1;
7025b89ad90SMark F. Adams   fine_level       = level;
7030298fd71SBarry Smith   ierr             = PCMGSetLevels(pc,pc_gamg->Nlevels,NULL);CHKERRQ(ierr);
7045b89ad90SMark F. Adams 
70562294041SBarry Smith   if (pc_gamg->Nlevels > 1) { /* don't setup MG if one level */
7060ed2132dSStefano Zampini     PetscErrorCode (*savesetfromoptions[PETSC_MG_MAXLEVELS])(PetscOptionItems*,KSP);
7070ed2132dSStefano Zampini 
708d5280255SMark F. Adams     /* set default smoothers & set operators */
70962294041SBarry Smith     for (lidx = 1, level = pc_gamg->Nlevels-2; lidx <= fine_level; lidx++, level--) {
710ffc955d6SMark F. Adams       KSP smoother;
711ffc955d6SMark F. Adams       PC  subpc;
712a2f3521dSMark F. Adams 
7139d5b6da9SMark F. Adams       ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
714f6536408SMark F. Adams       ierr = KSPGetPC(smoother, &subpc);CHKERRQ(ierr);
715ffc955d6SMark F. Adams 
716a2f3521dSMark F. Adams       ierr = KSPSetNormType(smoother, KSP_NORM_NONE);CHKERRQ(ierr);
717a2f3521dSMark F. Adams       /* set ops */
71823ee1639SBarry Smith       ierr = KSPSetOperators(smoother, Aarr[level], Aarr[level]);CHKERRQ(ierr);
719a2f3521dSMark F. Adams       ierr = PCMGSetInterpolation(pc, lidx, Parr[level+1]);CHKERRQ(ierr);
720a2f3521dSMark F. Adams 
721a2f3521dSMark F. Adams       /* set defaults */
7226c9de887SHong Zhang       ierr = KSPSetType(smoother, KSPCHEBYSHEV);CHKERRQ(ierr);
723a2f3521dSMark F. Adams 
7240c3bc534SBarry Smith       /* set blocks for ASM smoother that uses the 'aggregates' */
7250c3bc534SBarry Smith       if (pc_gamg->use_aggs_in_asm) {
7262d3561bbSSatish Balay         PetscInt sz;
7277a28f3e5SMark Adams         IS       *iss;
728a2f3521dSMark F. Adams 
7292d3561bbSSatish Balay         sz   = nASMBlocksArr[level];
7307a28f3e5SMark Adams         iss  = ASMLocalIDsArr[level];
7310c3bc534SBarry Smith         ierr = PCSetType(subpc, PCASM);CHKERRQ(ierr);
7320a3c815dSMark Adams         ierr = PCASMSetOverlap(subpc, 0);CHKERRQ(ierr);
7330c3bc534SBarry Smith         ierr = PCASMSetType(subpc,PC_ASM_BASIC);CHKERRQ(ierr);
7347f66b68fSMark Adams         if (!sz) {
735ffc955d6SMark F. Adams           IS       is;
7360a3c815dSMark Adams           ierr = ISCreateGeneral(PETSC_COMM_SELF, 0, NULL, PETSC_COPY_VALUES, &is);CHKERRQ(ierr);
7377a28f3e5SMark Adams           ierr = PCASMSetLocalSubdomains(subpc, 1, NULL, &is);CHKERRQ(ierr);
738a94c3b12SMark F. Adams           ierr = ISDestroy(&is);CHKERRQ(ierr);
739806fa848SBarry Smith         } else {
740a94c3b12SMark F. Adams           PetscInt kk;
7417a28f3e5SMark Adams           ierr = PCASMSetLocalSubdomains(subpc, sz, NULL, iss);CHKERRQ(ierr);
742a94c3b12SMark F. Adams           for (kk=0; kk<sz; kk++) {
7437a28f3e5SMark Adams             ierr = ISDestroy(&iss[kk]);CHKERRQ(ierr);
744a94c3b12SMark F. Adams           }
7457a28f3e5SMark Adams           ierr = PetscFree(iss);CHKERRQ(ierr);
746ffc955d6SMark F. Adams         }
7470298fd71SBarry Smith         ASMLocalIDsArr[level] = NULL;
748ffc955d6SMark F. Adams         nASMBlocksArr[level]  = 0;
749806fa848SBarry Smith       } else {
7505f7df010SMark Adams         ierr = PCSetType(subpc, PCJACOBI);CHKERRQ(ierr);
751ffc955d6SMark F. Adams       }
752d5280255SMark F. Adams     }
753d5280255SMark F. Adams     {
754d5280255SMark F. Adams       /* coarse grid */
755d5280255SMark F. Adams       KSP smoother,*k2; PC subpc,pc2; PetscInt ii,first;
756d5280255SMark F. Adams       Mat Lmat = Aarr[(level=pc_gamg->Nlevels-1)]; lidx = 0;
7570ed2132dSStefano Zampini 
758d5280255SMark F. Adams       ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
75923ee1639SBarry Smith       ierr = KSPSetOperators(smoother, Lmat, Lmat);CHKERRQ(ierr);
760cf8ae1d3SMark Adams       if (!pc_gamg->use_parallel_coarse_grid_solver) {
761d5280255SMark F. Adams         ierr = KSPSetNormType(smoother, KSP_NORM_NONE);CHKERRQ(ierr);
762d5280255SMark F. Adams         ierr = KSPGetPC(smoother, &subpc);CHKERRQ(ierr);
763d5280255SMark F. Adams         ierr = PCSetType(subpc, PCBJACOBI);CHKERRQ(ierr);
764d5280255SMark F. Adams         ierr = PCSetUp(subpc);CHKERRQ(ierr);
76571959b99SBarry Smith         ierr = PCBJacobiGetSubKSP(subpc,&ii,&first,&k2);CHKERRQ(ierr);
7662c71b3e2SJacob Faibussowitsch         PetscCheckFalse(ii != 1,PETSC_COMM_SELF,PETSC_ERR_PLIB,"ii %D is not one",ii);
767d5280255SMark F. Adams         ierr = KSPGetPC(k2[0],&pc2);CHKERRQ(ierr);
768d5280255SMark F. Adams         ierr = PCSetType(pc2, PCLU);CHKERRQ(ierr);
7699dbfc187SHong Zhang         ierr = PCFactorSetShiftType(pc2,MAT_SHIFT_INBLOCKS);CHKERRQ(ierr);
7702fb0b348SMark F. Adams         ierr = KSPSetTolerances(k2[0],PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT,1);CHKERRQ(ierr);
77108e36f19SMark Adams         ierr = KSPSetType(k2[0], KSPPREONLY);CHKERRQ(ierr);
772d5280255SMark F. Adams       }
773cf8ae1d3SMark Adams     }
774d5280255SMark F. Adams 
775d5280255SMark F. Adams     /* should be called in PCSetFromOptions_GAMG(), but cannot be called prior to PCMGSetLevels() */
776d5280255SMark F. Adams     ierr = PetscObjectOptionsBegin((PetscObject)pc);CHKERRQ(ierr);
777e55864a3SBarry Smith     ierr = PCSetFromOptions_MG(PetscOptionsObject,pc);CHKERRQ(ierr);
778d5280255SMark F. Adams     ierr = PetscOptionsEnd();CHKERRQ(ierr);
77969aca0b8SBarry Smith     ierr = PCMGSetGalerkin(pc,PC_MG_GALERKIN_EXTERNAL);CHKERRQ(ierr);
780d5280255SMark F. Adams 
78118c3aa7eSMark     /* setup cheby eigen estimates from SA */
7827e6512fdSJed Brown     if (pc_gamg->use_sa_esteig) {
78318c3aa7eSMark       for (lidx = 1, level = pc_gamg->Nlevels-2; level >= 0 ; lidx++, level--) {
78418c3aa7eSMark         KSP       smoother;
78518c3aa7eSMark         PetscBool ischeb;
7860ed2132dSStefano Zampini 
7870ed2132dSStefano Zampini         savesetfromoptions[level] = NULL;
78818c3aa7eSMark         ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
78918c3aa7eSMark         ierr = PetscObjectTypeCompare((PetscObject)smoother,KSPCHEBYSHEV,&ischeb);CHKERRQ(ierr);
79018c3aa7eSMark         if (ischeb) {
79118c3aa7eSMark           KSP_Chebyshev *cheb = (KSP_Chebyshev*)smoother->data;
7920ed2132dSStefano Zampini 
793*2de708cbSJed Brown           // The command line will override these settings because KSPSetFromOptions is called in PCSetUp_MG
7940ed2132dSStefano Zampini           if (mg->max_eigen_DinvA[level] > 0 && cheb->emax == 0.) {
79518c3aa7eSMark             PC        subpc;
79618c3aa7eSMark             PetscBool isjac;
79718c3aa7eSMark             ierr = KSPGetPC(smoother, &subpc);CHKERRQ(ierr);
79818c3aa7eSMark             ierr = PetscObjectTypeCompare((PetscObject)subpc,PCJACOBI,&isjac);CHKERRQ(ierr);
7997e6512fdSJed Brown             if (isjac || pc_gamg->use_sa_esteig_set) {
8007e6512fdSJed Brown               // SA uses Jacobi for P; we use SA estimates if the smoother is also Jacobi or if the user explicitly requested it.
8017e6512fdSJed Brown               // TODO: This should test whether it's the same Jacobi variant (DIAG, ROWSUM, etc.)
80218c3aa7eSMark               PetscReal emax,emin;
8030ed2132dSStefano Zampini 
80418c3aa7eSMark               emin = mg->min_eigen_DinvA[level];
80518c3aa7eSMark               emax = mg->max_eigen_DinvA[level];
8067d3de750SJacob Faibussowitsch               ierr = PetscInfo(pc,"PCSetUp_GAMG: call KSPChebyshevSetEigenvalues on level %D (N=%D) with emax = %g emin = %g\n",level,Aarr[level]->rmap->N,(double)emax,(double)emin);CHKERRQ(ierr);
80718c3aa7eSMark               cheb->emin_computed = emin;
80818c3aa7eSMark               cheb->emax_computed = emax;
80918c3aa7eSMark               ierr = KSPChebyshevSetEigenvalues(smoother, cheb->tform[2]*emin + cheb->tform[3]*emax, cheb->tform[0]*emin + cheb->tform[1]*emax);CHKERRQ(ierr);
8100ed2132dSStefano Zampini 
8110ed2132dSStefano Zampini               /* We have set the eigenvalues and consumed the transformation values
8120ed2132dSStefano Zampini                  prevent from flagging the recomputation of the eigenvalues again in PCSetUp_MG
8130ed2132dSStefano Zampini                  below when setfromoptions will be called again */
8140ed2132dSStefano Zampini               savesetfromoptions[level] = smoother->ops->setfromoptions;
8150ed2132dSStefano Zampini               smoother->ops->setfromoptions = NULL;
81618c3aa7eSMark             }
81718c3aa7eSMark           }
81818c3aa7eSMark         }
81918c3aa7eSMark       }
8200ed2132dSStefano Zampini     }
8210ed2132dSStefano Zampini 
8220ed2132dSStefano Zampini     ierr = PCSetUp_MG(pc);CHKERRQ(ierr);
8230ed2132dSStefano Zampini 
8240ed2132dSStefano Zampini     /* restore Chebyshev smoother for next calls */
8257e6512fdSJed Brown     if (pc_gamg->use_sa_esteig) {
8260ed2132dSStefano Zampini       for (lidx = 1, level = pc_gamg->Nlevels-2; level >= 0 ; lidx++, level--) {
8270ed2132dSStefano Zampini         if (savesetfromoptions[level]) {
8280ed2132dSStefano Zampini           KSP smoother;
8290ed2132dSStefano Zampini           ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
8300ed2132dSStefano Zampini           smoother->ops->setfromoptions = savesetfromoptions[level];
8310ed2132dSStefano Zampini         }
8320ed2132dSStefano Zampini       }
8330ed2132dSStefano Zampini     }
83418c3aa7eSMark 
835d5280255SMark F. Adams     /* clean up */
836d5280255SMark F. Adams     for (level=1; level<pc_gamg->Nlevels; level++) {
837587fa25dSMark F. Adams       ierr = MatDestroy(&Parr[level]);CHKERRQ(ierr);
838587fa25dSMark F. Adams       ierr = MatDestroy(&Aarr[level]);CHKERRQ(ierr);
8395b89ad90SMark F. Adams     }
840806fa848SBarry Smith   } else {
8415f8cf99dSMark F. Adams     KSP smoother;
8420ed2132dSStefano Zampini 
843302440fdSBarry Smith     ierr = PetscInfo(pc,"One level solver used (system is seen as DD). Using default solver.\n");CHKERRQ(ierr);
8449d5b6da9SMark F. Adams     ierr = PCMGGetSmoother(pc, 0, &smoother);CHKERRQ(ierr);
84523ee1639SBarry Smith     ierr = KSPSetOperators(smoother, Aarr[0], Aarr[0]);CHKERRQ(ierr);
8465f8cf99dSMark F. Adams     ierr = KSPSetType(smoother, KSPPREONLY);CHKERRQ(ierr);
8479d5b6da9SMark F. Adams     ierr = PCSetUp_MG(pc);CHKERRQ(ierr);
8485f8cf99dSMark F. Adams   }
8495b89ad90SMark F. Adams   PetscFunctionReturn(0);
8505b89ad90SMark F. Adams }
8515b89ad90SMark F. Adams 
852eb07cef2SMark F. Adams /* ------------------------------------------------------------------------- */
8535b89ad90SMark F. Adams /*
8545b89ad90SMark F. Adams  PCDestroy_GAMG - Destroys the private context for the GAMG preconditioner
8555b89ad90SMark F. Adams    that was created with PCCreate_GAMG().
8565b89ad90SMark F. Adams 
8575b89ad90SMark F. Adams    Input Parameter:
8585b89ad90SMark F. Adams .  pc - the preconditioner context
8595b89ad90SMark F. Adams 
8605b89ad90SMark F. Adams    Application Interface Routine: PCDestroy()
8615b89ad90SMark F. Adams */
8625b89ad90SMark F. Adams PetscErrorCode PCDestroy_GAMG(PC pc)
8635b89ad90SMark F. Adams {
8645b89ad90SMark F. Adams   PetscErrorCode ierr;
8655b89ad90SMark F. Adams   PC_MG          *mg     = (PC_MG*)pc->data;
8665b89ad90SMark F. Adams   PC_GAMG        *pc_gamg= (PC_GAMG*)mg->innerctx;
8675b89ad90SMark F. Adams 
8685b89ad90SMark F. Adams   PetscFunctionBegin;
8695b89ad90SMark F. Adams   ierr = PCReset_GAMG(pc);CHKERRQ(ierr);
8709b8ffb57SJed Brown   if (pc_gamg->ops->destroy) {
8719b8ffb57SJed Brown     ierr = (*pc_gamg->ops->destroy)(pc);CHKERRQ(ierr);
8729b8ffb57SJed Brown   }
8731ab5ffc9SJed Brown   ierr = PetscFree(pc_gamg->ops);CHKERRQ(ierr);
8741ab5ffc9SJed Brown   ierr = PetscFree(pc_gamg->gamg_type_name);CHKERRQ(ierr);
8755b89ad90SMark F. Adams   ierr = PetscFree(pc_gamg);CHKERRQ(ierr);
8765b89ad90SMark F. Adams   ierr = PCDestroy_MG(pc);CHKERRQ(ierr);
8775b89ad90SMark F. Adams   PetscFunctionReturn(0);
8785b89ad90SMark F. Adams }
8795b89ad90SMark F. Adams 
880676e1743SMark F. Adams /*@
881cab9ed1eSBarry Smith    PCGAMGSetProcEqLim - Set number of equations to aim for per process on the coarse grids via processor reduction.
882676e1743SMark F. Adams 
8831cc46a46SBarry Smith    Logically Collective on PC
884676e1743SMark F. Adams 
885676e1743SMark F. Adams    Input Parameters:
8861cc46a46SBarry Smith +  pc - the preconditioner context
8871cc46a46SBarry Smith -  n - the number of equations
888676e1743SMark F. Adams 
889676e1743SMark F. Adams    Options Database Key:
8901cc46a46SBarry Smith .  -pc_gamg_process_eq_limit <limit>
891676e1743SMark F. Adams 
89295452b02SPatrick Sanan    Notes:
89395452b02SPatrick Sanan     GAMG will reduce the number of MPI processes used directly on the coarse grids so that there are around <limit> equations on each process
894cab9ed1eSBarry Smith           that has degrees of freedom
895cab9ed1eSBarry Smith 
896676e1743SMark F. Adams    Level: intermediate
897676e1743SMark F. Adams 
898c9567895SMark .seealso: PCGAMGSetCoarseEqLim(), PCGAMGSetRankReductionFactors()
899676e1743SMark F. Adams @*/
900676e1743SMark F. Adams PetscErrorCode  PCGAMGSetProcEqLim(PC pc, PetscInt n)
901676e1743SMark F. Adams {
902676e1743SMark F. Adams   PetscErrorCode ierr;
903676e1743SMark F. Adams 
904676e1743SMark F. Adams   PetscFunctionBegin;
905676e1743SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
906676e1743SMark F. Adams   ierr = PetscTryMethod(pc,"PCGAMGSetProcEqLim_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
907676e1743SMark F. Adams   PetscFunctionReturn(0);
908676e1743SMark F. Adams }
909676e1743SMark F. Adams 
9101e6b0712SBarry Smith static PetscErrorCode PCGAMGSetProcEqLim_GAMG(PC pc, PetscInt n)
911676e1743SMark F. Adams {
912c20e4228SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
913c20e4228SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
914676e1743SMark F. Adams 
915676e1743SMark F. Adams   PetscFunctionBegin;
9169d5b6da9SMark F. Adams   if (n>0) pc_gamg->min_eq_proc = n;
917676e1743SMark F. Adams   PetscFunctionReturn(0);
918676e1743SMark F. Adams }
919676e1743SMark F. Adams 
920389730f3SMark F. Adams /*@
921cab9ed1eSBarry Smith    PCGAMGSetCoarseEqLim - Set maximum number of equations on coarsest grid.
922389730f3SMark F. Adams 
923389730f3SMark F. Adams  Collective on PC
924389730f3SMark F. Adams 
925389730f3SMark F. Adams    Input Parameters:
9261cc46a46SBarry Smith +  pc - the preconditioner context
9271cc46a46SBarry Smith -  n - maximum number of equations to aim for
928389730f3SMark F. Adams 
929389730f3SMark F. Adams    Options Database Key:
9301cc46a46SBarry Smith .  -pc_gamg_coarse_eq_limit <limit>
931389730f3SMark F. Adams 
93274329af1SBarry Smith    Notes: For example -pc_gamg_coarse_eq_limit 1000 will stop coarsening once the coarse grid
93374329af1SBarry Smith      has less than 1000 unknowns.
93474329af1SBarry Smith 
935389730f3SMark F. Adams    Level: intermediate
936389730f3SMark F. Adams 
937c9567895SMark .seealso: PCGAMGSetProcEqLim(), PCGAMGSetRankReductionFactors()
938389730f3SMark F. Adams @*/
939389730f3SMark F. Adams PetscErrorCode PCGAMGSetCoarseEqLim(PC pc, PetscInt n)
940389730f3SMark F. Adams {
941389730f3SMark F. Adams   PetscErrorCode ierr;
942389730f3SMark F. Adams 
943389730f3SMark F. Adams   PetscFunctionBegin;
944389730f3SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
945389730f3SMark F. Adams   ierr = PetscTryMethod(pc,"PCGAMGSetCoarseEqLim_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
946389730f3SMark F. Adams   PetscFunctionReturn(0);
947389730f3SMark F. Adams }
948389730f3SMark F. Adams 
9491e6b0712SBarry Smith static PetscErrorCode PCGAMGSetCoarseEqLim_GAMG(PC pc, PetscInt n)
950389730f3SMark F. Adams {
951389730f3SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
952389730f3SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
953389730f3SMark F. Adams 
954389730f3SMark F. Adams   PetscFunctionBegin;
9559d5b6da9SMark F. Adams   if (n>0) pc_gamg->coarse_eq_limit = n;
956389730f3SMark F. Adams   PetscFunctionReturn(0);
957389730f3SMark F. Adams }
958389730f3SMark F. Adams 
959676e1743SMark F. Adams /*@
960cab9ed1eSBarry Smith    PCGAMGSetRepartition - Repartition the degrees of freedom across the processors on the coarser grids
961676e1743SMark F. Adams 
962676e1743SMark F. Adams    Collective on PC
963676e1743SMark F. Adams 
964676e1743SMark F. Adams    Input Parameters:
9651cc46a46SBarry Smith +  pc - the preconditioner context
9661cc46a46SBarry Smith -  n - PETSC_TRUE or PETSC_FALSE
967676e1743SMark F. Adams 
968676e1743SMark F. Adams    Options Database Key:
9691cc46a46SBarry Smith .  -pc_gamg_repartition <true,false>
970676e1743SMark F. Adams 
97195452b02SPatrick Sanan    Notes:
97295452b02SPatrick Sanan     this will generally improve the loading balancing of the work on each level
973cab9ed1eSBarry Smith 
974676e1743SMark F. Adams    Level: intermediate
975676e1743SMark F. Adams 
976676e1743SMark F. Adams .seealso: ()
977676e1743SMark F. Adams @*/
978cab9ed1eSBarry Smith PetscErrorCode PCGAMGSetRepartition(PC pc, PetscBool n)
979676e1743SMark F. Adams {
980676e1743SMark F. Adams   PetscErrorCode ierr;
981676e1743SMark F. Adams 
982676e1743SMark F. Adams   PetscFunctionBegin;
983676e1743SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
984cab9ed1eSBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGSetRepartition_C",(PC,PetscBool),(pc,n));CHKERRQ(ierr);
985676e1743SMark F. Adams   PetscFunctionReturn(0);
986676e1743SMark F. Adams }
987676e1743SMark F. Adams 
988cab9ed1eSBarry Smith static PetscErrorCode PCGAMGSetRepartition_GAMG(PC pc, PetscBool n)
989676e1743SMark F. Adams {
990c20e4228SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
991c20e4228SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
992676e1743SMark F. Adams 
993676e1743SMark F. Adams   PetscFunctionBegin;
9949d5b6da9SMark F. Adams   pc_gamg->repart = n;
995676e1743SMark F. Adams   PetscFunctionReturn(0);
996676e1743SMark F. Adams }
997676e1743SMark F. Adams 
998dfd5c07aSMark F. Adams /*@
99918c3aa7eSMark    PCGAMGSetEstEigKSPMaxIt - Set number of KSP iterations in eigen estimator (for Cheby)
100018c3aa7eSMark 
100118c3aa7eSMark    Collective on PC
100218c3aa7eSMark 
100318c3aa7eSMark    Input Parameters:
100418c3aa7eSMark +  pc - the preconditioner context
100518c3aa7eSMark -  n - number of its
100618c3aa7eSMark 
100718c3aa7eSMark    Options Database Key:
100818c3aa7eSMark .  -pc_gamg_esteig_ksp_max_it <its>
100918c3aa7eSMark 
101018c3aa7eSMark    Notes:
101118c3aa7eSMark 
101218c3aa7eSMark    Level: intermediate
101318c3aa7eSMark 
101418c3aa7eSMark .seealso: ()
101518c3aa7eSMark @*/
101618c3aa7eSMark PetscErrorCode PCGAMGSetEstEigKSPMaxIt(PC pc, PetscInt n)
101718c3aa7eSMark {
101818c3aa7eSMark   PetscErrorCode ierr;
101918c3aa7eSMark 
102018c3aa7eSMark   PetscFunctionBegin;
102118c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
102218c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetEstEigKSPMaxIt_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
102318c3aa7eSMark   PetscFunctionReturn(0);
102418c3aa7eSMark }
102518c3aa7eSMark 
102618c3aa7eSMark static PetscErrorCode PCGAMGSetEstEigKSPMaxIt_GAMG(PC pc, PetscInt n)
102718c3aa7eSMark {
102818c3aa7eSMark   PC_MG   *mg      = (PC_MG*)pc->data;
102918c3aa7eSMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
103018c3aa7eSMark 
103118c3aa7eSMark   PetscFunctionBegin;
103218c3aa7eSMark   pc_gamg->esteig_max_it = n;
103318c3aa7eSMark   PetscFunctionReturn(0);
103418c3aa7eSMark }
103518c3aa7eSMark 
103618c3aa7eSMark /*@
10377e6512fdSJed Brown    PCGAMGSetUseSAEstEig - Use eigen estimate from smoothed aggregation for Chebyshev smoother
103818c3aa7eSMark 
103918c3aa7eSMark    Collective on PC
104018c3aa7eSMark 
104118c3aa7eSMark    Input Parameters:
104218c3aa7eSMark +  pc - the preconditioner context
104318c3aa7eSMark -  n - number of its
104418c3aa7eSMark 
104518c3aa7eSMark    Options Database Key:
104618c3aa7eSMark .  -pc_gamg_use_sa_esteig <true,false>
104718c3aa7eSMark 
104818c3aa7eSMark    Notes:
10497e6512fdSJed Brown    Smoothed aggregation constructs the smoothed prolongator $P = (I - \omega D^{-1} A) T$ where $T$ is the tentative prolongator and $D$ is the diagonal of $A$.
10507e6512fdSJed Brown    Eigenvalue estimates (based on a few CG or GMRES iterations) are computed to choose $\omega$ so that this is a stable smoothing operation.
10517e6512fdSJed Brown    If Chebyshev with Jacobi (diagonal) preconditioning is used for smoothing, then the eigenvalue estimates can be reused.
10527e6512fdSJed Brown    This option became default in PETSc 3.17 when the smoother uses Jacobi, otherwise it's off by default.
105318c3aa7eSMark 
10547e6512fdSJed Brown    Level: advanced
105518c3aa7eSMark 
10567e6512fdSJed Brown .seealso: PCGAMGSetEstEigKSPType(), KSPChebyshevSetEigenvalues(), KSPChebyshevEstEigSet()
105718c3aa7eSMark @*/
105818c3aa7eSMark PetscErrorCode PCGAMGSetUseSAEstEig(PC pc, PetscBool n)
105918c3aa7eSMark {
106018c3aa7eSMark   PetscErrorCode ierr;
106118c3aa7eSMark 
106218c3aa7eSMark   PetscFunctionBegin;
106318c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
106418c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetUseSAEstEig_C",(PC,PetscBool),(pc,n));CHKERRQ(ierr);
106518c3aa7eSMark   PetscFunctionReturn(0);
106618c3aa7eSMark }
106718c3aa7eSMark 
10680ed2132dSStefano Zampini static PetscErrorCode PCGAMGSetUseSAEstEig_GAMG(PC pc, PetscBool n)
106918c3aa7eSMark {
107018c3aa7eSMark   PC_MG   *mg      = (PC_MG*)pc->data;
107118c3aa7eSMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
107218c3aa7eSMark 
107318c3aa7eSMark   PetscFunctionBegin;
10747e6512fdSJed Brown   pc_gamg->use_sa_esteig = n;
10757e6512fdSJed Brown   pc_gamg->use_sa_esteig_set = PETSC_TRUE;
107618c3aa7eSMark   PetscFunctionReturn(0);
107718c3aa7eSMark }
107818c3aa7eSMark 
107918c3aa7eSMark /*@C
108018c3aa7eSMark    PCGAMGSetEstEigKSPType - Set type of KSP in eigen estimator (for Cheby)
108118c3aa7eSMark 
108218c3aa7eSMark    Collective on PC
108318c3aa7eSMark 
108418c3aa7eSMark    Input Parameters:
108518c3aa7eSMark +  pc - the preconditioner context
108618c3aa7eSMark -  t - ksp type
108718c3aa7eSMark 
108818c3aa7eSMark    Options Database Key:
108918c3aa7eSMark .  -pc_gamg_esteig_ksp_type <type>
109018c3aa7eSMark 
109118c3aa7eSMark    Notes:
109218c3aa7eSMark 
109318c3aa7eSMark    Level: intermediate
109418c3aa7eSMark 
109518c3aa7eSMark .seealso: ()
109618c3aa7eSMark @*/
109718c3aa7eSMark PetscErrorCode PCGAMGSetEstEigKSPType(PC pc, char t[])
109818c3aa7eSMark {
109918c3aa7eSMark   PetscErrorCode ierr;
110018c3aa7eSMark 
110118c3aa7eSMark   PetscFunctionBegin;
110218c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
110318c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetEstEigKSPType_C",(PC,char[]),(pc,t));CHKERRQ(ierr);
110418c3aa7eSMark   PetscFunctionReturn(0);
110518c3aa7eSMark }
110618c3aa7eSMark 
110718c3aa7eSMark static PetscErrorCode PCGAMGSetEstEigKSPType_GAMG(PC pc, char t[])
110818c3aa7eSMark {
110918c3aa7eSMark   PetscErrorCode ierr;
111018c3aa7eSMark   PC_MG   *mg      = (PC_MG*)pc->data;
111118c3aa7eSMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
111218c3aa7eSMark 
111318c3aa7eSMark   PetscFunctionBegin;
111418c3aa7eSMark   ierr = PetscStrcpy(pc_gamg->esteig_type,t);CHKERRQ(ierr);
111518c3aa7eSMark   PetscFunctionReturn(0);
111618c3aa7eSMark }
111718c3aa7eSMark 
111818c3aa7eSMark /*@
111918c3aa7eSMark    PCGAMGSetEigenvalues - Set eigenvalues
112018c3aa7eSMark 
112118c3aa7eSMark    Collective on PC
112218c3aa7eSMark 
112318c3aa7eSMark    Input Parameters:
112418c3aa7eSMark +  pc - the preconditioner context
112518c3aa7eSMark -  emax - max eigenvalue
112618c3aa7eSMark .  emin - min eigenvalue
112718c3aa7eSMark 
112818c3aa7eSMark    Options Database Key:
112918c3aa7eSMark .  -pc_gamg_eigenvalues
113018c3aa7eSMark 
113118c3aa7eSMark    Level: intermediate
113218c3aa7eSMark 
113318c3aa7eSMark .seealso: PCGAMGSetEstEigKSPMaxIt(), PCGAMGSetUseSAEstEig(), PCGAMGSetEstEigKSPType()
113418c3aa7eSMark @*/
113518c3aa7eSMark PetscErrorCode PCGAMGSetEigenvalues(PC pc, PetscReal emax,PetscReal emin)
113618c3aa7eSMark {
113718c3aa7eSMark   PetscErrorCode ierr;
113818c3aa7eSMark 
113918c3aa7eSMark   PetscFunctionBegin;
114018c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
114118c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetEigenvalues_C",(PC,PetscReal,PetscReal),(pc,emax,emin));CHKERRQ(ierr);
114218c3aa7eSMark   PetscFunctionReturn(0);
114318c3aa7eSMark }
114441ffd417SStefano Zampini 
114518c3aa7eSMark static PetscErrorCode PCGAMGSetEigenvalues_GAMG(PC pc,PetscReal emax,PetscReal emin)
114618c3aa7eSMark {
114718c3aa7eSMark   PC_MG          *mg      = (PC_MG*)pc->data;
114818c3aa7eSMark   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
114918c3aa7eSMark 
115018c3aa7eSMark   PetscFunctionBegin;
11512c71b3e2SJacob Faibussowitsch   PetscCheckFalse(emax <= emin,PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"Maximum eigenvalue must be larger than minimum: max %g min %g",(double)emax,(double)emin);
11522c71b3e2SJacob Faibussowitsch   PetscCheckFalse(emax*emin <= 0.0,PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"Both eigenvalues must be of the same sign: max %g min %g",(double)emax,(double)emin);
115318c3aa7eSMark   pc_gamg->emax = emax;
115418c3aa7eSMark   pc_gamg->emin = emin;
115518c3aa7eSMark 
115618c3aa7eSMark   PetscFunctionReturn(0);
115718c3aa7eSMark }
115818c3aa7eSMark 
115918c3aa7eSMark /*@
1160cab9ed1eSBarry Smith    PCGAMGSetReuseInterpolation - Reuse prolongation when rebuilding algebraic multigrid preconditioner
1161dfd5c07aSMark F. Adams 
1162dfd5c07aSMark F. Adams    Collective on PC
1163dfd5c07aSMark F. Adams 
1164dfd5c07aSMark F. Adams    Input Parameters:
11651cc46a46SBarry Smith +  pc - the preconditioner context
11661cc46a46SBarry Smith -  n - PETSC_TRUE or PETSC_FALSE
1167dfd5c07aSMark F. Adams 
1168dfd5c07aSMark F. Adams    Options Database Key:
11691cc46a46SBarry Smith .  -pc_gamg_reuse_interpolation <true,false>
1170dfd5c07aSMark F. Adams 
1171dfd5c07aSMark F. Adams    Level: intermediate
1172dfd5c07aSMark F. Adams 
117395452b02SPatrick Sanan    Notes:
117495452b02SPatrick Sanan     this may negatively affect the convergence rate of the method on new matrices if the matrix entries change a great deal, but allows
1175cab9ed1eSBarry Smith           rebuilding the preconditioner quicker.
1176cab9ed1eSBarry Smith 
1177dfd5c07aSMark F. Adams .seealso: ()
1178dfd5c07aSMark F. Adams @*/
11791cc46a46SBarry Smith PetscErrorCode PCGAMGSetReuseInterpolation(PC pc, PetscBool n)
1180dfd5c07aSMark F. Adams {
1181dfd5c07aSMark F. Adams   PetscErrorCode ierr;
1182dfd5c07aSMark F. Adams 
1183dfd5c07aSMark F. Adams   PetscFunctionBegin;
1184dfd5c07aSMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
11851cc46a46SBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGSetReuseInterpolation_C",(PC,PetscBool),(pc,n));CHKERRQ(ierr);
1186dfd5c07aSMark F. Adams   PetscFunctionReturn(0);
1187dfd5c07aSMark F. Adams }
1188dfd5c07aSMark F. Adams 
11891cc46a46SBarry Smith static PetscErrorCode PCGAMGSetReuseInterpolation_GAMG(PC pc, PetscBool n)
1190dfd5c07aSMark F. Adams {
1191dfd5c07aSMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1192dfd5c07aSMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1193dfd5c07aSMark F. Adams 
1194dfd5c07aSMark F. Adams   PetscFunctionBegin;
1195dfd5c07aSMark F. Adams   pc_gamg->reuse_prol = n;
1196dfd5c07aSMark F. Adams   PetscFunctionReturn(0);
1197dfd5c07aSMark F. Adams }
1198dfd5c07aSMark F. Adams 
1199ffc955d6SMark F. Adams /*@
1200cab9ed1eSBarry Smith    PCGAMGASMSetUseAggs - Have the PCGAMG smoother on each level use the aggregates defined by the coarsening process as the subdomains for the additive Schwarz preconditioner.
1201ffc955d6SMark F. Adams 
1202ffc955d6SMark F. Adams    Collective on PC
1203ffc955d6SMark F. Adams 
1204ffc955d6SMark F. Adams    Input Parameters:
1205cab9ed1eSBarry Smith +  pc - the preconditioner context
1206cab9ed1eSBarry Smith -  flg - PETSC_TRUE to use aggregates, PETSC_FALSE to not
1207ffc955d6SMark F. Adams 
1208ffc955d6SMark F. Adams    Options Database Key:
1209cab9ed1eSBarry Smith .  -pc_gamg_asm_use_agg
1210ffc955d6SMark F. Adams 
1211ffc955d6SMark F. Adams    Level: intermediate
1212ffc955d6SMark F. Adams 
1213ffc955d6SMark F. Adams .seealso: ()
1214ffc955d6SMark F. Adams @*/
1215cab9ed1eSBarry Smith PetscErrorCode PCGAMGASMSetUseAggs(PC pc, PetscBool flg)
1216ffc955d6SMark F. Adams {
1217ffc955d6SMark F. Adams   PetscErrorCode ierr;
1218ffc955d6SMark F. Adams 
1219ffc955d6SMark F. Adams   PetscFunctionBegin;
1220ffc955d6SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1221cab9ed1eSBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGASMSetUseAggs_C",(PC,PetscBool),(pc,flg));CHKERRQ(ierr);
1222ffc955d6SMark F. Adams   PetscFunctionReturn(0);
1223ffc955d6SMark F. Adams }
1224ffc955d6SMark F. Adams 
1225cab9ed1eSBarry Smith static PetscErrorCode PCGAMGASMSetUseAggs_GAMG(PC pc, PetscBool flg)
1226ffc955d6SMark F. Adams {
1227ffc955d6SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1228ffc955d6SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1229ffc955d6SMark F. Adams 
1230ffc955d6SMark F. Adams   PetscFunctionBegin;
1231cab9ed1eSBarry Smith   pc_gamg->use_aggs_in_asm = flg;
1232ffc955d6SMark F. Adams   PetscFunctionReturn(0);
1233ffc955d6SMark F. Adams }
1234ffc955d6SMark F. Adams 
1235171cca9aSMark Adams /*@
1236cf8ae1d3SMark Adams    PCGAMGSetUseParallelCoarseGridSolve - allow a parallel coarse grid solver
1237171cca9aSMark Adams 
1238171cca9aSMark Adams    Collective on PC
1239171cca9aSMark Adams 
1240171cca9aSMark Adams    Input Parameters:
1241171cca9aSMark Adams +  pc - the preconditioner context
1242cf8ae1d3SMark Adams -  flg - PETSC_TRUE to not force coarse grid onto one processor
1243171cca9aSMark Adams 
1244171cca9aSMark Adams    Options Database Key:
1245cf8ae1d3SMark Adams .  -pc_gamg_use_parallel_coarse_grid_solver
1246171cca9aSMark Adams 
1247171cca9aSMark Adams    Level: intermediate
1248171cca9aSMark Adams 
124939d09545SMark Adams .seealso: PCGAMGSetCoarseGridLayoutType(), PCGAMGSetCpuPinCoarseGrids()
1250171cca9aSMark Adams @*/
1251171cca9aSMark Adams PetscErrorCode PCGAMGSetUseParallelCoarseGridSolve(PC pc, PetscBool flg)
1252171cca9aSMark Adams {
1253171cca9aSMark Adams   PetscErrorCode ierr;
1254171cca9aSMark Adams 
1255171cca9aSMark Adams   PetscFunctionBegin;
1256171cca9aSMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1257171cca9aSMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetUseParallelCoarseGridSolve_C",(PC,PetscBool),(pc,flg));CHKERRQ(ierr);
1258171cca9aSMark Adams   PetscFunctionReturn(0);
1259171cca9aSMark Adams }
1260171cca9aSMark Adams 
1261171cca9aSMark Adams static PetscErrorCode PCGAMGSetUseParallelCoarseGridSolve_GAMG(PC pc, PetscBool flg)
1262171cca9aSMark Adams {
1263171cca9aSMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1264171cca9aSMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1265171cca9aSMark Adams 
1266171cca9aSMark Adams   PetscFunctionBegin;
1267171cca9aSMark Adams   pc_gamg->use_parallel_coarse_grid_solver = flg;
1268ffc955d6SMark F. Adams   PetscFunctionReturn(0);
1269ffc955d6SMark F. Adams }
1270ffc955d6SMark F. Adams 
12714ef23d27SMark F. Adams /*@
1272ce7c7f2fSMark Adams    PCGAMGSetCpuPinCoarseGrids - pin reduced grids to CPU
1273ce7c7f2fSMark Adams 
1274ce7c7f2fSMark Adams    Collective on PC
1275ce7c7f2fSMark Adams 
1276ce7c7f2fSMark Adams    Input Parameters:
1277ce7c7f2fSMark Adams +  pc - the preconditioner context
1278ce7c7f2fSMark Adams -  flg - PETSC_TRUE to pin coarse grids to CPU
1279ce7c7f2fSMark Adams 
1280ce7c7f2fSMark Adams    Options Database Key:
1281ce7c7f2fSMark Adams .  -pc_gamg_cpu_pin_coarse_grids
1282ce7c7f2fSMark Adams 
1283ce7c7f2fSMark Adams    Level: intermediate
1284ce7c7f2fSMark Adams 
128539d09545SMark Adams .seealso: PCGAMGSetCoarseGridLayoutType(), PCGAMGSetUseParallelCoarseGridSolve()
1286ce7c7f2fSMark Adams @*/
1287ce7c7f2fSMark Adams PetscErrorCode PCGAMGSetCpuPinCoarseGrids(PC pc, PetscBool flg)
1288ce7c7f2fSMark Adams {
1289ce7c7f2fSMark Adams   PetscErrorCode ierr;
1290ce7c7f2fSMark Adams 
1291ce7c7f2fSMark Adams   PetscFunctionBegin;
1292ce7c7f2fSMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1293ce7c7f2fSMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetCpuPinCoarseGrids_C",(PC,PetscBool),(pc,flg));CHKERRQ(ierr);
1294ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1295ce7c7f2fSMark Adams }
1296ce7c7f2fSMark Adams 
1297ce7c7f2fSMark Adams static PetscErrorCode PCGAMGSetCpuPinCoarseGrids_GAMG(PC pc, PetscBool flg)
1298ce7c7f2fSMark Adams {
1299ce7c7f2fSMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1300ce7c7f2fSMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1301ce7c7f2fSMark Adams 
1302ce7c7f2fSMark Adams   PetscFunctionBegin;
1303ce7c7f2fSMark Adams   pc_gamg->cpu_pin_coarse_grids = flg;
1304ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1305ce7c7f2fSMark Adams }
1306ce7c7f2fSMark Adams 
1307ce7c7f2fSMark Adams /*@
1308ce7c7f2fSMark Adams    PCGAMGSetCoarseGridLayoutType - place reduce grids on processors with natural order (compact type)
1309ce7c7f2fSMark Adams 
1310ce7c7f2fSMark Adams    Collective on PC
1311ce7c7f2fSMark Adams 
1312ce7c7f2fSMark Adams    Input Parameters:
1313ce7c7f2fSMark Adams +  pc - the preconditioner context
1314ce7c7f2fSMark Adams -  flg - Layout type
1315ce7c7f2fSMark Adams 
1316ce7c7f2fSMark Adams    Options Database Key:
1317ce7c7f2fSMark Adams .  -pc_gamg_coarse_grid_layout_type
1318ce7c7f2fSMark Adams 
1319ce7c7f2fSMark Adams    Level: intermediate
1320ce7c7f2fSMark Adams 
132139d09545SMark Adams .seealso: PCGAMGSetUseParallelCoarseGridSolve(), PCGAMGSetCpuPinCoarseGrids()
1322ce7c7f2fSMark Adams @*/
1323ce7c7f2fSMark Adams PetscErrorCode PCGAMGSetCoarseGridLayoutType(PC pc, PCGAMGLayoutType flg)
1324ce7c7f2fSMark Adams {
1325ce7c7f2fSMark Adams   PetscErrorCode ierr;
1326ce7c7f2fSMark Adams 
1327ce7c7f2fSMark Adams   PetscFunctionBegin;
1328ce7c7f2fSMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1329ce7c7f2fSMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetCoarseGridLayoutType_C",(PC,PCGAMGLayoutType),(pc,flg));CHKERRQ(ierr);
1330ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1331ce7c7f2fSMark Adams }
1332ce7c7f2fSMark Adams 
1333ce7c7f2fSMark Adams static PetscErrorCode PCGAMGSetCoarseGridLayoutType_GAMG(PC pc, PCGAMGLayoutType flg)
1334ce7c7f2fSMark Adams {
1335ce7c7f2fSMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1336ce7c7f2fSMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1337ce7c7f2fSMark Adams 
1338ce7c7f2fSMark Adams   PetscFunctionBegin;
1339ce7c7f2fSMark Adams   pc_gamg->layout_type = flg;
1340ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1341ce7c7f2fSMark Adams }
1342ce7c7f2fSMark Adams 
1343ce7c7f2fSMark Adams /*@
13441cc46a46SBarry Smith    PCGAMGSetNlevels -  Sets the maximum number of levels PCGAMG will use
13454ef23d27SMark F. Adams 
13464ef23d27SMark F. Adams    Not collective on PC
13474ef23d27SMark F. Adams 
13484ef23d27SMark F. Adams    Input Parameters:
13491cc46a46SBarry Smith +  pc - the preconditioner
13501cc46a46SBarry Smith -  n - the maximum number of levels to use
13514ef23d27SMark F. Adams 
13524ef23d27SMark F. Adams    Options Database Key:
13534ef23d27SMark F. Adams .  -pc_mg_levels
13544ef23d27SMark F. Adams 
13554ef23d27SMark F. Adams    Level: intermediate
13564ef23d27SMark F. Adams 
13574ef23d27SMark F. Adams .seealso: ()
13584ef23d27SMark F. Adams @*/
13594ef23d27SMark F. Adams PetscErrorCode PCGAMGSetNlevels(PC pc, PetscInt n)
13604ef23d27SMark F. Adams {
13614ef23d27SMark F. Adams   PetscErrorCode ierr;
13624ef23d27SMark F. Adams 
13634ef23d27SMark F. Adams   PetscFunctionBegin;
13644ef23d27SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
13654ef23d27SMark F. Adams   ierr = PetscTryMethod(pc,"PCGAMGSetNlevels_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
13664ef23d27SMark F. Adams   PetscFunctionReturn(0);
13674ef23d27SMark F. Adams }
13684ef23d27SMark F. Adams 
13691e6b0712SBarry Smith static PetscErrorCode PCGAMGSetNlevels_GAMG(PC pc, PetscInt n)
13704ef23d27SMark F. Adams {
13714ef23d27SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
13724ef23d27SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
13734ef23d27SMark F. Adams 
13744ef23d27SMark F. Adams   PetscFunctionBegin;
13759d5b6da9SMark F. Adams   pc_gamg->Nlevels = n;
13764ef23d27SMark F. Adams   PetscFunctionReturn(0);
13774ef23d27SMark F. Adams }
13784ef23d27SMark F. Adams 
13793542efc5SMark F. Adams /*@
13803542efc5SMark F. Adams    PCGAMGSetThreshold - Relative threshold to use for dropping edges in aggregation graph
13813542efc5SMark F. Adams 
13823542efc5SMark F. Adams    Not collective on PC
13833542efc5SMark F. Adams 
13843542efc5SMark F. Adams    Input Parameters:
13851cc46a46SBarry Smith +  pc - the preconditioner context
1386c9567895SMark .  v - array of threshold values for finest n levels; 0.0 means keep all nonzero entries in the graph; negative means keep even zero entries in the graph
1387055c8bd0SJed Brown -  n - number of threshold values provided in array
13883542efc5SMark F. Adams 
13893542efc5SMark F. Adams    Options Database Key:
13901cc46a46SBarry Smith .  -pc_gamg_threshold <threshold>
13913542efc5SMark F. Adams 
139295452b02SPatrick Sanan    Notes:
1393af3c827dSMark Adams     Increasing the threshold decreases the rate of coarsening. Conversely reducing the threshold increases the rate of coarsening (aggressive coarsening) and thereby reduces the complexity of the coarse grids, and generally results in slower solver converge rates. Reducing coarse grid complexity reduced the complexity of Galerkin coarse grid construction considerably.
1394af3c827dSMark Adams     Before coarsening or aggregating the graph, GAMG removes small values from the graph with this threshold, and thus reducing the coupling in the graph and a different (perhaps better) coarser set of points.
1395cab9ed1eSBarry Smith 
1396055c8bd0SJed Brown     If n is less than the total number of coarsenings (see PCGAMGSetNlevels()), then threshold scaling (see PCGAMGSetThresholdScale()) is used for each successive coarsening.
1397055c8bd0SJed Brown     In this case, PCGAMGSetThresholdScale() must be called before PCGAMGSetThreshold().
1398055c8bd0SJed Brown     If n is greater than the total number of levels, the excess entries in threshold will not be used.
1399055c8bd0SJed Brown 
14003542efc5SMark F. Adams    Level: intermediate
14013542efc5SMark F. Adams 
1402af3c827dSMark Adams .seealso: PCGAMGFilterGraph(), PCGAMGSetSquareGraph()
14033542efc5SMark F. Adams @*/
1404c1eae691SMark Adams PetscErrorCode PCGAMGSetThreshold(PC pc, PetscReal v[], PetscInt n)
14053542efc5SMark F. Adams {
14063542efc5SMark F. Adams   PetscErrorCode ierr;
14073542efc5SMark F. Adams 
14083542efc5SMark F. Adams   PetscFunctionBegin;
14093542efc5SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1410055c8bd0SJed Brown   if (n) PetscValidRealPointer(v,2);
1411c1eae691SMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetThreshold_C",(PC,PetscReal[],PetscInt),(pc,v,n));CHKERRQ(ierr);
14123542efc5SMark F. Adams   PetscFunctionReturn(0);
14133542efc5SMark F. Adams }
14143542efc5SMark F. Adams 
1415c1eae691SMark Adams static PetscErrorCode PCGAMGSetThreshold_GAMG(PC pc, PetscReal v[], PetscInt n)
14163542efc5SMark F. Adams {
1417c20e4228SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1418c20e4228SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1419c1eae691SMark Adams   PetscInt i;
1420c1eae691SMark Adams   PetscFunctionBegin;
1421055c8bd0SJed Brown   for (i=0; i<PetscMin(n,PETSC_MG_MAXLEVELS); i++) pc_gamg->threshold[i] = v[i];
1422055c8bd0SJed Brown   for (; i<PETSC_MG_MAXLEVELS; i++) pc_gamg->threshold[i] = pc_gamg->threshold[i-1]*pc_gamg->threshold_scale;
1423c1eae691SMark Adams   PetscFunctionReturn(0);
1424c1eae691SMark Adams }
1425c1eae691SMark Adams 
1426c1eae691SMark Adams /*@
1427c9567895SMark    PCGAMGSetRankReductionFactors - Set manual schedual for process reduction on coarse grids
1428c9567895SMark 
1429c9567895SMark    Collective on PC
1430c9567895SMark 
1431c9567895SMark    Input Parameters:
1432c9567895SMark +  pc - the preconditioner context
1433c9567895SMark .  v - array of reduction factors. 0 for fist value forces a reduction to one process/device on first level in Cuda
1434c9567895SMark -  n - number of values provided in array
1435c9567895SMark 
1436c9567895SMark    Options Database Key:
1437c9567895SMark .  -pc_gamg_rank_reduction_factors <factors>
1438c9567895SMark 
1439c9567895SMark    Level: intermediate
1440c9567895SMark 
1441c9567895SMark .seealso: PCGAMGSetProcEqLim(), PCGAMGSetCoarseEqLim()
1442c9567895SMark @*/
1443c9567895SMark PetscErrorCode PCGAMGSetRankReductionFactors(PC pc, PetscInt v[], PetscInt n)
1444c9567895SMark {
1445c9567895SMark   PetscErrorCode ierr;
1446c9567895SMark 
1447c9567895SMark   PetscFunctionBegin;
1448c9567895SMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1449c9567895SMark   if (n) PetscValidIntPointer(v,2);
1450c9567895SMark   ierr = PetscTryMethod(pc,"PCGAMGSetRankReductionFactors_C",(PC,PetscInt[],PetscInt),(pc,v,n));CHKERRQ(ierr);
1451c9567895SMark   PetscFunctionReturn(0);
1452c9567895SMark }
1453c9567895SMark 
1454c9567895SMark static PetscErrorCode PCGAMGSetRankReductionFactors_GAMG(PC pc, PetscInt v[], PetscInt n)
1455c9567895SMark {
1456c9567895SMark   PC_MG   *mg      = (PC_MG*)pc->data;
1457c9567895SMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1458c9567895SMark   PetscInt i;
1459c9567895SMark   PetscFunctionBegin;
1460c9567895SMark   for (i=0; i<PetscMin(n,PETSC_MG_MAXLEVELS); i++) pc_gamg->level_reduction_factors[i] = v[i];
1461c9567895SMark   for (; i<PETSC_MG_MAXLEVELS; i++) pc_gamg->level_reduction_factors[i] = -1; /* 0 stop putting one process/device on first level */
1462c9567895SMark   PetscFunctionReturn(0);
1463c9567895SMark }
1464c9567895SMark 
1465c9567895SMark /*@
1466c1eae691SMark Adams    PCGAMGSetThresholdScale - Relative threshold reduction at each level
1467c1eae691SMark Adams 
1468c1eae691SMark Adams    Not collective on PC
1469c1eae691SMark Adams 
1470c1eae691SMark Adams    Input Parameters:
1471c1eae691SMark Adams +  pc - the preconditioner context
1472c1eae691SMark Adams -  scale - the threshold value reduction, ussually < 1.0
1473c1eae691SMark Adams 
1474c1eae691SMark Adams    Options Database Key:
1475c1eae691SMark Adams .  -pc_gamg_threshold_scale <v>
1476c1eae691SMark Adams 
1477055c8bd0SJed Brown    Notes:
1478055c8bd0SJed Brown    The initial threshold (for an arbitrary number of levels starting from the finest) can be set with PCGAMGSetThreshold().
1479055c8bd0SJed Brown    This scaling is used for each subsequent coarsening, but must be called before PCGAMGSetThreshold().
1480055c8bd0SJed Brown 
1481c1eae691SMark Adams    Level: advanced
1482c1eae691SMark Adams 
1483055c8bd0SJed Brown .seealso: PCGAMGSetThreshold()
1484c1eae691SMark Adams @*/
1485c1eae691SMark Adams PetscErrorCode PCGAMGSetThresholdScale(PC pc, PetscReal v)
1486c1eae691SMark Adams {
1487c1eae691SMark Adams   PetscErrorCode ierr;
14883542efc5SMark F. Adams 
14893542efc5SMark F. Adams   PetscFunctionBegin;
1490c1eae691SMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1491c1eae691SMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetThresholdScale_C",(PC,PetscReal),(pc,v));CHKERRQ(ierr);
1492c1eae691SMark Adams   PetscFunctionReturn(0);
1493c1eae691SMark Adams }
1494c1eae691SMark Adams 
1495c1eae691SMark Adams static PetscErrorCode PCGAMGSetThresholdScale_GAMG(PC pc, PetscReal v)
1496c1eae691SMark Adams {
1497c1eae691SMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1498c1eae691SMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1499c1eae691SMark Adams   PetscFunctionBegin;
1500c1eae691SMark Adams   pc_gamg->threshold_scale = v;
15013542efc5SMark F. Adams   PetscFunctionReturn(0);
15023542efc5SMark F. Adams }
15033542efc5SMark F. Adams 
1504e20c40e8SBarry Smith /*@C
1505c60c7ad4SBarry Smith    PCGAMGSetType - Set solution method
1506676e1743SMark F. Adams 
1507676e1743SMark F. Adams    Collective on PC
1508676e1743SMark F. Adams 
1509676e1743SMark F. Adams    Input Parameters:
1510c60c7ad4SBarry Smith +  pc - the preconditioner context
1511c60c7ad4SBarry Smith -  type - PCGAMGAGG, PCGAMGGEO, or PCGAMGCLASSICAL
1512676e1743SMark F. Adams 
1513676e1743SMark F. Adams    Options Database Key:
1514cab9ed1eSBarry Smith .  -pc_gamg_type <agg,geo,classical> - type of algebraic multigrid to apply
1515676e1743SMark F. Adams 
1516676e1743SMark F. Adams    Level: intermediate
1517676e1743SMark F. Adams 
1518cab9ed1eSBarry Smith .seealso: PCGAMGGetType(), PCGAMG, PCGAMGType
1519676e1743SMark F. Adams @*/
152019fd82e9SBarry Smith PetscErrorCode PCGAMGSetType(PC pc, PCGAMGType type)
1521676e1743SMark F. Adams {
1522676e1743SMark F. Adams   PetscErrorCode ierr;
1523676e1743SMark F. Adams 
1524676e1743SMark F. Adams   PetscFunctionBegin;
1525676e1743SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1526806fa848SBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGSetType_C",(PC,PCGAMGType),(pc,type));CHKERRQ(ierr);
1527676e1743SMark F. Adams   PetscFunctionReturn(0);
1528676e1743SMark F. Adams }
1529676e1743SMark F. Adams 
1530e20c40e8SBarry Smith /*@C
1531c60c7ad4SBarry Smith    PCGAMGGetType - Get solution method
1532c60c7ad4SBarry Smith 
1533c60c7ad4SBarry Smith    Collective on PC
1534c60c7ad4SBarry Smith 
1535c60c7ad4SBarry Smith    Input Parameter:
1536c60c7ad4SBarry Smith .  pc - the preconditioner context
1537c60c7ad4SBarry Smith 
1538c60c7ad4SBarry Smith    Output Parameter:
1539c60c7ad4SBarry Smith .  type - the type of algorithm used
1540c60c7ad4SBarry Smith 
1541c60c7ad4SBarry Smith    Level: intermediate
1542c60c7ad4SBarry Smith 
15431c1aac46SBarry Smith .seealso: PCGAMGSetType(), PCGAMGType
1544c60c7ad4SBarry Smith @*/
1545c60c7ad4SBarry Smith PetscErrorCode PCGAMGGetType(PC pc, PCGAMGType *type)
1546c60c7ad4SBarry Smith {
1547c60c7ad4SBarry Smith   PetscErrorCode ierr;
1548c60c7ad4SBarry Smith 
1549c60c7ad4SBarry Smith   PetscFunctionBegin;
1550c60c7ad4SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1551c60c7ad4SBarry Smith   ierr = PetscUseMethod(pc,"PCGAMGGetType_C",(PC,PCGAMGType*),(pc,type));CHKERRQ(ierr);
1552c60c7ad4SBarry Smith   PetscFunctionReturn(0);
1553c60c7ad4SBarry Smith }
1554c60c7ad4SBarry Smith 
1555c60c7ad4SBarry Smith static PetscErrorCode PCGAMGGetType_GAMG(PC pc, PCGAMGType *type)
1556c60c7ad4SBarry Smith {
1557c60c7ad4SBarry Smith   PC_MG          *mg      = (PC_MG*)pc->data;
1558c60c7ad4SBarry Smith   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
1559c60c7ad4SBarry Smith 
1560c60c7ad4SBarry Smith   PetscFunctionBegin;
1561c60c7ad4SBarry Smith   *type = pc_gamg->type;
1562c60c7ad4SBarry Smith   PetscFunctionReturn(0);
1563c60c7ad4SBarry Smith }
1564c60c7ad4SBarry Smith 
15651e6b0712SBarry Smith static PetscErrorCode PCGAMGSetType_GAMG(PC pc, PCGAMGType type)
1566676e1743SMark F. Adams {
15679d5b6da9SMark F. Adams   PetscErrorCode ierr,(*r)(PC);
15681ab5ffc9SJed Brown   PC_MG          *mg      = (PC_MG*)pc->data;
15691ab5ffc9SJed Brown   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
1570676e1743SMark F. Adams 
1571676e1743SMark F. Adams   PetscFunctionBegin;
1572c60c7ad4SBarry Smith   pc_gamg->type = type;
15731c9cd337SJed Brown   ierr = PetscFunctionListFind(GAMGList,type,&r);CHKERRQ(ierr);
15742c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!r,PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown GAMG type %s given",type);
15751ab5ffc9SJed Brown   if (pc_gamg->ops->destroy) {
15761ab5ffc9SJed Brown     ierr = (*pc_gamg->ops->destroy)(pc);CHKERRQ(ierr);
15771ab5ffc9SJed Brown     ierr = PetscMemzero(pc_gamg->ops,sizeof(struct _PCGAMGOps));CHKERRQ(ierr);
1578e616c208SToby Isaac     pc_gamg->ops->createlevel = PCGAMGCreateLevel_GAMG;
15793ae0bb68SMark Adams     /* cleaning up common data in pc_gamg - this should disapear someday */
15803ae0bb68SMark Adams     pc_gamg->data_cell_cols = 0;
15813ae0bb68SMark Adams     pc_gamg->data_cell_rows = 0;
15823ae0bb68SMark Adams     pc_gamg->orig_data_cell_cols = 0;
15833ae0bb68SMark Adams     pc_gamg->orig_data_cell_rows = 0;
15843ae0bb68SMark Adams     ierr = PetscFree(pc_gamg->data);CHKERRQ(ierr);
15853ae0bb68SMark Adams     pc_gamg->data_sz = 0;
15861ab5ffc9SJed Brown   }
15871ab5ffc9SJed Brown   ierr = PetscFree(pc_gamg->gamg_type_name);CHKERRQ(ierr);
15881ab5ffc9SJed Brown   ierr = PetscStrallocpy(type,&pc_gamg->gamg_type_name);CHKERRQ(ierr);
15899d5b6da9SMark F. Adams   ierr = (*r)(pc);CHKERRQ(ierr);
1590676e1743SMark F. Adams   PetscFunctionReturn(0);
1591676e1743SMark F. Adams }
1592676e1743SMark F. Adams 
15935adeb434SBarry Smith static PetscErrorCode PCView_GAMG(PC pc,PetscViewer viewer)
15945adeb434SBarry Smith {
1595c1eae691SMark Adams   PetscErrorCode ierr,i;
15965adeb434SBarry Smith   PC_MG          *mg      = (PC_MG*)pc->data;
15975adeb434SBarry Smith   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
1598e7d4b4cbSMark Adams   PetscReal       gc=0, oc=0;
159990db8557SMark Adams 
16005adeb434SBarry Smith   PetscFunctionBegin;
16015adeb434SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"    GAMG specific options\n");CHKERRQ(ierr);
1602459726d8SSatish Balay   ierr = PetscViewerASCIIPrintf(viewer,"      Threshold for dropping small values in graph on each level =");CHKERRQ(ierr);
1603b3e187dcSStefano Zampini   for (i=0;i<mg->nlevels; i++) {
1604c1eae691SMark Adams     ierr = PetscViewerASCIIPrintf(viewer," %g",(double)pc_gamg->threshold[i]);CHKERRQ(ierr);
1605c1eae691SMark Adams   }
1606459726d8SSatish Balay   ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
1607459726d8SSatish Balay   ierr = PetscViewerASCIIPrintf(viewer,"      Threshold scaling factor for each level not specified = %g\n",(double)pc_gamg->threshold_scale);CHKERRQ(ierr);
1608cab9ed1eSBarry Smith   if (pc_gamg->use_aggs_in_asm) {
1609cab9ed1eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"      Using aggregates from coarsening process to define subdomains for PCASM\n");CHKERRQ(ierr);
1610cab9ed1eSBarry Smith   }
1611171cca9aSMark Adams   if (pc_gamg->use_parallel_coarse_grid_solver) {
1612171cca9aSMark Adams     ierr = PetscViewerASCIIPrintf(viewer,"      Using parallel coarse grid solver (all coarse grid equations not put on one process)\n");CHKERRQ(ierr);
1613171cca9aSMark Adams   }
1614ce7c7f2fSMark Adams #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
1615ce7c7f2fSMark Adams   if (pc_gamg->cpu_pin_coarse_grids) {
1616ce7c7f2fSMark Adams     /* ierr = PetscViewerASCIIPrintf(viewer,"      Pinning coarse grids to the CPU)\n");CHKERRQ(ierr); */
1617ce7c7f2fSMark Adams   }
1618ce7c7f2fSMark Adams #endif
1619ce7c7f2fSMark Adams   /* if (pc_gamg->layout_type==PCGAMG_LAYOUT_COMPACT) { */
1620ce7c7f2fSMark Adams   /*   ierr = PetscViewerASCIIPrintf(viewer,"      Put reduced grids on processes in natural order (ie, 0,1,2...)\n");CHKERRQ(ierr); */
1621ce7c7f2fSMark Adams   /* } else { */
1622ce7c7f2fSMark Adams   /*   ierr = PetscViewerASCIIPrintf(viewer,"      Put reduced grids on whole machine (ie, 0,1*f,2*f...,np-f)\n");CHKERRQ(ierr); */
1623ce7c7f2fSMark Adams   /* } */
16245adeb434SBarry Smith   if (pc_gamg->ops->view) {
16255adeb434SBarry Smith     ierr = (*pc_gamg->ops->view)(pc,viewer);CHKERRQ(ierr);
16265adeb434SBarry Smith   }
1627e7d4b4cbSMark Adams   ierr = PCMGGetGridComplexity(pc,&gc,&oc);CHKERRQ(ierr);
1628e7d4b4cbSMark Adams   ierr = PetscViewerASCIIPrintf(viewer,"      Complexity:    grid = %g    operator = %g\n",gc,oc);CHKERRQ(ierr);
16295adeb434SBarry Smith   PetscFunctionReturn(0);
16305adeb434SBarry Smith }
16315adeb434SBarry Smith 
16324416b707SBarry Smith PetscErrorCode PCSetFromOptions_GAMG(PetscOptionItems *PetscOptionsObject,PC pc)
16335b89ad90SMark F. Adams {
1634676e1743SMark F. Adams   PetscErrorCode ierr;
1635676e1743SMark F. Adams   PC_MG          *mg      = (PC_MG*)pc->data;
1636676e1743SMark F. Adams   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
16377e6512fdSJed Brown   PetscBool      flag;
16383b4367a7SBarry Smith   MPI_Comm       comm;
163918c3aa7eSMark   char           prefix[256],tname[32];
1640c1eae691SMark Adams   PetscInt       i,n;
164114a9496bSBarry Smith   const char     *pcpre;
16420a545947SLisandro Dalcin   static const char *LayoutTypes[] = {"compact","spread","PCGAMGLayoutType","PC_GAMG_LAYOUT",NULL};
16435b89ad90SMark F. Adams   PetscFunctionBegin;
16443b4367a7SBarry Smith   ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
1645e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"GAMG options");CHKERRQ(ierr);
16461a1c1e04SBarry Smith   ierr = PetscOptionsFList("-pc_gamg_type","Type of AMG method","PCGAMGSetType",GAMGList, pc_gamg->gamg_type_name, tname, sizeof(tname), &flag);CHKERRQ(ierr);
1647bd94a7aaSJed Brown   if (flag) {
1648bd94a7aaSJed Brown     ierr = PCGAMGSetType(pc,tname);CHKERRQ(ierr);
16491ab5ffc9SJed Brown   }
165018c3aa7eSMark   ierr = PetscOptionsFList("-pc_gamg_esteig_ksp_type","Krylov method for eigen estimator","PCGAMGSetEstEigKSPType",KSPList,pc_gamg->esteig_type,tname,sizeof(tname),&flag);CHKERRQ(ierr);
165118c3aa7eSMark   if (flag) {
165218c3aa7eSMark     ierr = PCGAMGSetEstEigKSPType(pc,tname);CHKERRQ(ierr);
165318c3aa7eSMark   }
1654cab9ed1eSBarry Smith   ierr = PetscOptionsBool("-pc_gamg_repartition","Repartion coarse grids","PCGAMGSetRepartition",pc_gamg->repart,&pc_gamg->repart,NULL);CHKERRQ(ierr);
16557e6512fdSJed Brown   ierr = PetscOptionsBool("-pc_gamg_use_sa_esteig","Use eigen estimate from Smoothed aggregation for smoother","PCGAMGSetUseSAEstEig",pc_gamg->use_sa_esteig,&pc_gamg->use_sa_esteig,&flag);CHKERRQ(ierr);
16567e6512fdSJed Brown   if (flag) pc_gamg->use_sa_esteig_set = PETSC_TRUE;
16571cc46a46SBarry Smith   ierr = PetscOptionsBool("-pc_gamg_reuse_interpolation","Reuse prolongation operator","PCGAMGReuseInterpolation",pc_gamg->reuse_prol,&pc_gamg->reuse_prol,NULL);CHKERRQ(ierr);
1658a303c832SJed Brown   ierr = PetscOptionsBool("-pc_gamg_asm_use_agg","Use aggregation aggregates for ASM smoother","PCGAMGASMSetUseAggs",pc_gamg->use_aggs_in_asm,&pc_gamg->use_aggs_in_asm,NULL);CHKERRQ(ierr);
1659cf8ae1d3SMark Adams   ierr = PetscOptionsBool("-pc_gamg_use_parallel_coarse_grid_solver","Use parallel coarse grid solver (otherwise put last grid on one process)","PCGAMGSetUseParallelCoarseGridSolve",pc_gamg->use_parallel_coarse_grid_solver,&pc_gamg->use_parallel_coarse_grid_solver,NULL);CHKERRQ(ierr);
1660ce7c7f2fSMark Adams   ierr = PetscOptionsBool("-pc_gamg_cpu_pin_coarse_grids","Pin coarse grids to the CPU","PCGAMGSetCpuPinCoarseGrids",pc_gamg->cpu_pin_coarse_grids,&pc_gamg->cpu_pin_coarse_grids,NULL);CHKERRQ(ierr);
1661a0095786SMark   ierr = PetscOptionsEnum("-pc_gamg_coarse_grid_layout_type","compact: place reduced grids on processes in natural order; spread: distribute to whole machine for more memory bandwidth","PCGAMGSetCoarseGridLayoutType",LayoutTypes,(PetscEnum)pc_gamg->layout_type,(PetscEnum*)&pc_gamg->layout_type,NULL);CHKERRQ(ierr);
166294ae4db5SBarry Smith   ierr = PetscOptionsInt("-pc_gamg_process_eq_limit","Limit (goal) on number of equations per process on coarse grids","PCGAMGSetProcEqLim",pc_gamg->min_eq_proc,&pc_gamg->min_eq_proc,NULL);CHKERRQ(ierr);
166318c3aa7eSMark   ierr = PetscOptionsInt("-pc_gamg_esteig_ksp_max_it","Number of iterations of eigen estimator","PCGAMGSetEstEigKSPMaxIt",pc_gamg->esteig_max_it,&pc_gamg->esteig_max_it,NULL);CHKERRQ(ierr);
166494ae4db5SBarry Smith   ierr = PetscOptionsInt("-pc_gamg_coarse_eq_limit","Limit on number of equations for the coarse grid","PCGAMGSetCoarseEqLim",pc_gamg->coarse_eq_limit,&pc_gamg->coarse_eq_limit,NULL);CHKERRQ(ierr);
1665a303c832SJed Brown   ierr = PetscOptionsReal("-pc_gamg_threshold_scale","Scaling of threshold for each level not specified","PCGAMGSetThresholdScale",pc_gamg->threshold_scale,&pc_gamg->threshold_scale,NULL);CHKERRQ(ierr);
166618c3aa7eSMark   n = PETSC_MG_MAXLEVELS;
1667c1eae691SMark Adams   ierr = PetscOptionsRealArray("-pc_gamg_threshold","Relative threshold to use for dropping edges in aggregation graph","PCGAMGSetThreshold",pc_gamg->threshold,&n,&flag);CHKERRQ(ierr);
166818c3aa7eSMark   if (!flag || n < PETSC_MG_MAXLEVELS) {
1669efd3c5ceSMark Adams     if (!flag) n = 1;
1670c1eae691SMark Adams     i = n;
167118c3aa7eSMark     do {pc_gamg->threshold[i] = pc_gamg->threshold[i-1]*pc_gamg->threshold_scale;} while (++i<PETSC_MG_MAXLEVELS);
1672c1eae691SMark Adams   }
1673c9567895SMark   n = PETSC_MG_MAXLEVELS;
1674c9567895SMark   ierr = PetscOptionsIntArray("-pc_gamg_rank_reduction_factors","Manual schedule of coarse grid reduction factors that overrides internal heuristics (0 for first reduction puts one process/device)","PCGAMGSetRankReductionFactors",pc_gamg->level_reduction_factors,&n,&flag);CHKERRQ(ierr);
1675c9567895SMark   if (!flag) i = 0;
1676c9567895SMark   else i = n;
1677c9567895SMark   do {pc_gamg->level_reduction_factors[i] = -1;} while (++i<PETSC_MG_MAXLEVELS);
167894ae4db5SBarry Smith   ierr = PetscOptionsInt("-pc_mg_levels","Set number of MG levels","PCGAMGSetNlevels",pc_gamg->Nlevels,&pc_gamg->Nlevels,NULL);CHKERRQ(ierr);
167918c3aa7eSMark   {
168018c3aa7eSMark     PetscReal eminmax[2] = {0., 0.};
168118c3aa7eSMark     n = 2;
168218c3aa7eSMark     ierr = PetscOptionsRealArray("-pc_gamg_eigenvalues","extreme eigenvalues for smoothed aggregation","PCGAMGSetEigenvalues",eminmax,&n,&flag);CHKERRQ(ierr);
168318c3aa7eSMark     if (flag) {
16842c71b3e2SJacob Faibussowitsch       PetscCheckFalse(n != 2,PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"-pc_gamg_eigenvalues: must specify 2 parameters, min and max eigenvalues");
168518c3aa7eSMark       ierr = PCGAMGSetEigenvalues(pc, eminmax[1], eminmax[0]);CHKERRQ(ierr);
168618c3aa7eSMark     }
168718c3aa7eSMark   }
1688b7cbab4eSMark Adams   /* set options for subtype */
1689e55864a3SBarry Smith   if (pc_gamg->ops->setfromoptions) {ierr = (*pc_gamg->ops->setfromoptions)(PetscOptionsObject,pc);CHKERRQ(ierr);}
169018c3aa7eSMark 
169114a9496bSBarry Smith   ierr = PCGetOptionsPrefix(pc, &pcpre);CHKERRQ(ierr);
169214a9496bSBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%spc_gamg_",pcpre ? pcpre : "");CHKERRQ(ierr);
1693676e1743SMark F. Adams   ierr = PetscOptionsTail();CHKERRQ(ierr);
16945b89ad90SMark F. Adams   PetscFunctionReturn(0);
16955b89ad90SMark F. Adams }
16965b89ad90SMark F. Adams 
16975b89ad90SMark F. Adams /* -------------------------------------------------------------------------- */
16985b89ad90SMark F. Adams /*MC
16991cc46a46SBarry Smith      PCGAMG - Geometric algebraic multigrid (AMG) preconditioner
17005b89ad90SMark F. Adams 
1701280d9858SJed Brown    Options Database Keys:
1702cab9ed1eSBarry Smith +   -pc_gamg_type <type> - one of agg, geo, or classical
1703cab9ed1eSBarry Smith .   -pc_gamg_repartition  <true,default=false> - repartition the degrees of freedom accross the coarse grids as they are determined
1704cab9ed1eSBarry Smith .   -pc_gamg_reuse_interpolation <true,default=false> - when rebuilding the algebraic multigrid preconditioner reuse the previously computed interpolations
1705cab9ed1eSBarry Smith .   -pc_gamg_asm_use_agg <true,default=false> - use the aggregates from the coasening process to defined the subdomains on each level for the PCASM smoother
1706cab9ed1eSBarry Smith .   -pc_gamg_process_eq_limit <limit, default=50> - GAMG will reduce the number of MPI processes used directly on the coarse grids so that there are around <limit>
1707cab9ed1eSBarry Smith                                         equations on each process that has degrees of freedom
1708cab9ed1eSBarry Smith .   -pc_gamg_coarse_eq_limit <limit, default=50> - Set maximum number of equations on coarsest grid to aim for.
17096008e27bSRichard Tran Mills .   -pc_gamg_threshold[] <thresh,default=0> - Before aggregating the graph GAMG will remove small values from the graph on each level
1710c1eae691SMark Adams -   -pc_gamg_threshold_scale <scale,default=1> - Scaling of threshold on each coarser grid if not specified
1711cab9ed1eSBarry Smith 
1712cab9ed1eSBarry Smith    Options Database Keys for default Aggregation:
1713cab9ed1eSBarry Smith +  -pc_gamg_agg_nsmooths <nsmooth, default=1> - number of smoothing steps to use with smooth aggregation
1714cab9ed1eSBarry Smith .  -pc_gamg_sym_graph <true,default=false> - symmetrize the graph before computing the aggregation
1715cab9ed1eSBarry Smith -  -pc_gamg_square_graph <n,default=1> - number of levels to square the graph before aggregating it
1716cab9ed1eSBarry Smith 
1717db9745e2SBarry Smith    Multigrid options:
1718db9745e2SBarry Smith +  -pc_mg_cycles <v> - v or w, see PCMGSetCycleType()
1719db9745e2SBarry Smith .  -pc_mg_distinct_smoothup - configure the up and down (pre and post) smoothers separately, see PCMGSetDistinctSmoothUp()
1720db9745e2SBarry Smith .  -pc_mg_type <multiplicative> - (one of) additive multiplicative full kascade
1721cab9ed1eSBarry Smith -  -pc_mg_levels <levels> - Number of levels of multigrid to use.
17225b89ad90SMark F. Adams 
172395452b02SPatrick Sanan   Notes:
172495452b02SPatrick Sanan     In order to obtain good performance for PCGAMG for vector valued problems you must
1725db9745e2SBarry Smith        Call MatSetBlockSize() to indicate the number of degrees of freedom per grid point
1726db9745e2SBarry Smith        Call MatSetNearNullSpace() (or PCSetCoordinates() if solving the equations of elasticity) to indicate the near null space of the operator
1727db9745e2SBarry Smith        See the Users Manual Chapter 4 for more details
17281cc46a46SBarry Smith 
17295b89ad90SMark F. Adams   Level: intermediate
1730280d9858SJed Brown 
17311cc46a46SBarry Smith .seealso:  PCCreate(), PCSetType(), MatSetBlockSize(), PCMGType, PCSetCoordinates(), MatSetNearNullSpace(), PCGAMGSetType(), PCGAMGAGG, PCGAMGGEO, PCGAMGCLASSICAL, PCGAMGSetProcEqLim(),
173218c3aa7eSMark            PCGAMGSetCoarseEqLim(), PCGAMGSetRepartition(), PCGAMGRegister(), PCGAMGSetReuseInterpolation(), PCGAMGASMSetUseAggs(), PCGAMGSetUseParallelCoarseGridSolve(), PCGAMGSetNlevels(), PCGAMGSetThreshold(), PCGAMGGetType(), PCGAMGSetReuseInterpolation(), PCGAMGSetUseSAEstEig(), PCGAMGSetEstEigKSPMaxIt(), PCGAMGSetEstEigKSPType()
17335b89ad90SMark F. Adams M*/
1734b2573a8aSBarry Smith 
17358cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_GAMG(PC pc)
17365b89ad90SMark F. Adams {
1737c1eae691SMark Adams   PetscErrorCode ierr,i;
17385b89ad90SMark F. Adams   PC_GAMG        *pc_gamg;
17395b89ad90SMark F. Adams   PC_MG          *mg;
17405b89ad90SMark F. Adams 
17415b89ad90SMark F. Adams   PetscFunctionBegin;
17421c1aac46SBarry Smith    /* register AMG type */
17431c1aac46SBarry Smith   ierr = PCGAMGInitializePackage();CHKERRQ(ierr);
17441c1aac46SBarry Smith 
17455b89ad90SMark F. Adams   /* PCGAMG is an inherited class of PCMG. Initialize pc as PCMG */
17461c1aac46SBarry Smith   ierr = PCSetType(pc, PCMG);CHKERRQ(ierr);
17475b89ad90SMark F. Adams   ierr = PetscObjectChangeTypeName((PetscObject)pc, PCGAMG);CHKERRQ(ierr);
17485b89ad90SMark F. Adams 
17495b89ad90SMark F. Adams   /* create a supporting struct and attach it to pc */
1750b00a9115SJed Brown   ierr         = PetscNewLog(pc,&pc_gamg);CHKERRQ(ierr);
175169aca0b8SBarry Smith   ierr         = PCMGSetGalerkin(pc,PC_MG_GALERKIN_EXTERNAL);CHKERRQ(ierr);
17525b89ad90SMark F. Adams   mg           = (PC_MG*)pc->data;
17535b89ad90SMark F. Adams   mg->innerctx = pc_gamg;
17545b89ad90SMark F. Adams 
1755b00a9115SJed Brown   ierr = PetscNewLog(pc,&pc_gamg->ops);CHKERRQ(ierr);
17561ab5ffc9SJed Brown 
17579d5b6da9SMark F. Adams   /* these should be in subctx but repartitioning needs simple arrays */
17589d5b6da9SMark F. Adams   pc_gamg->data_sz = 0;
17590a545947SLisandro Dalcin   pc_gamg->data    = NULL;
17605b89ad90SMark F. Adams 
17619d5b6da9SMark F. Adams   /* overwrite the pointers of PCMG by the functions of base class PCGAMG */
17625b89ad90SMark F. Adams   pc->ops->setfromoptions = PCSetFromOptions_GAMG;
17635b89ad90SMark F. Adams   pc->ops->setup          = PCSetUp_GAMG;
17645b89ad90SMark F. Adams   pc->ops->reset          = PCReset_GAMG;
17655b89ad90SMark F. Adams   pc->ops->destroy        = PCDestroy_GAMG;
17665adeb434SBarry Smith   mg->view                = PCView_GAMG;
17675b89ad90SMark F. Adams 
176897d33e41SMatthew G. Knepley   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCMGGetLevels_C",PCMGGetLevels_MG);CHKERRQ(ierr);
176997d33e41SMatthew G. Knepley   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCMGSetLevels_C",PCMGSetLevels_MG);CHKERRQ(ierr);
1770bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetProcEqLim_C",PCGAMGSetProcEqLim_GAMG);CHKERRQ(ierr);
1771bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetCoarseEqLim_C",PCGAMGSetCoarseEqLim_GAMG);CHKERRQ(ierr);
1772cab9ed1eSBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetRepartition_C",PCGAMGSetRepartition_GAMG);CHKERRQ(ierr);
177318c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetEstEigKSPType_C",PCGAMGSetEstEigKSPType_GAMG);CHKERRQ(ierr);
177418c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetEstEigKSPMaxIt_C",PCGAMGSetEstEigKSPMaxIt_GAMG);CHKERRQ(ierr);
177518c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetEigenvalues_C",PCGAMGSetEigenvalues_GAMG);CHKERRQ(ierr);
177618c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetUseSAEstEig_C",PCGAMGSetUseSAEstEig_GAMG);CHKERRQ(ierr);
17771cc46a46SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetReuseInterpolation_C",PCGAMGSetReuseInterpolation_GAMG);CHKERRQ(ierr);
1778cab9ed1eSBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGASMSetUseAggs_C",PCGAMGASMSetUseAggs_GAMG);CHKERRQ(ierr);
1779171cca9aSMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetUseParallelCoarseGridSolve_C",PCGAMGSetUseParallelCoarseGridSolve_GAMG);CHKERRQ(ierr);
1780ce7c7f2fSMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetCpuPinCoarseGrids_C",PCGAMGSetCpuPinCoarseGrids_GAMG);CHKERRQ(ierr);
1781ce7c7f2fSMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetCoarseGridLayoutType_C",PCGAMGSetCoarseGridLayoutType_GAMG);CHKERRQ(ierr);
1782bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetThreshold_C",PCGAMGSetThreshold_GAMG);CHKERRQ(ierr);
1783c9567895SMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetRankReductionFactors_C",PCGAMGSetRankReductionFactors_GAMG);CHKERRQ(ierr);
1784c1eae691SMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetThresholdScale_C",PCGAMGSetThresholdScale_GAMG);CHKERRQ(ierr);
1785bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetType_C",PCGAMGSetType_GAMG);CHKERRQ(ierr);
1786c60c7ad4SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGGetType_C",PCGAMGGetType_GAMG);CHKERRQ(ierr);
1787bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetNlevels_C",PCGAMGSetNlevels_GAMG);CHKERRQ(ierr);
17889d5b6da9SMark F. Adams   pc_gamg->repart           = PETSC_FALSE;
1789d3042614SMark Adams   pc_gamg->reuse_prol       = PETSC_FALSE;
17900c3bc534SBarry Smith   pc_gamg->use_aggs_in_asm  = PETSC_FALSE;
1791171cca9aSMark Adams   pc_gamg->use_parallel_coarse_grid_solver = PETSC_FALSE;
1792a0095786SMark   pc_gamg->cpu_pin_coarse_grids = PETSC_FALSE;
1793a0095786SMark   pc_gamg->layout_type      = PCGAMG_LAYOUT_SPREAD;
1794038f3aa4SMark F. Adams   pc_gamg->min_eq_proc      = 50;
179525a145a7SMark Adams   pc_gamg->coarse_eq_limit  = 50;
179618c3aa7eSMark   for (i=0;i<PETSC_MG_MAXLEVELS;i++) pc_gamg->threshold[i] = 0.;
1797c1eae691SMark Adams   pc_gamg->threshold_scale = 1.;
179818c3aa7eSMark   pc_gamg->Nlevels          = PETSC_MG_MAXLEVELS;
17999ab59c8bSMark Adams   pc_gamg->current_level    = 0; /* don't need to init really */
1800d24ecf33SMark   ierr = PetscStrcpy(pc_gamg->esteig_type,NULL);CHKERRQ(ierr);
180118c3aa7eSMark   pc_gamg->esteig_max_it    = 10;
18027e6512fdSJed Brown   pc_gamg->use_sa_esteig    = PETSC_TRUE;
180318c3aa7eSMark   pc_gamg->emin             = 0;
180418c3aa7eSMark   pc_gamg->emax             = 0;
180518c3aa7eSMark 
1806c238b0ebSToby Isaac   pc_gamg->ops->createlevel = PCGAMGCreateLevel_GAMG;
18079d5b6da9SMark F. Adams 
1808bd94a7aaSJed Brown   /* PCSetUp_GAMG assumes that the type has been set, so set it to the default now */
1809bd94a7aaSJed Brown   ierr = PCGAMGSetType(pc,PCGAMGAGG);CHKERRQ(ierr);
18105b89ad90SMark F. Adams   PetscFunctionReturn(0);
18115b89ad90SMark F. Adams }
18123e3471ccSMark Adams 
18133e3471ccSMark Adams /*@C
18143e3471ccSMark Adams  PCGAMGInitializePackage - This function initializes everything in the PCGAMG package. It is called
18158a690491SBarry Smith     from PCInitializePackage().
18163e3471ccSMark Adams 
18173e3471ccSMark Adams  Level: developer
18183e3471ccSMark Adams 
18193e3471ccSMark Adams  .seealso: PetscInitialize()
18203e3471ccSMark Adams @*/
18213e3471ccSMark Adams PetscErrorCode PCGAMGInitializePackage(void)
18223e3471ccSMark Adams {
18233e3471ccSMark Adams   PetscErrorCode ierr;
18244555aa8cSStefano Zampini   PetscInt       l;
18253e3471ccSMark Adams 
18263e3471ccSMark Adams   PetscFunctionBegin;
18273e3471ccSMark Adams   if (PCGAMGPackageInitialized) PetscFunctionReturn(0);
18283e3471ccSMark Adams   PCGAMGPackageInitialized = PETSC_TRUE;
18293e3471ccSMark Adams   ierr = PetscFunctionListAdd(&GAMGList,PCGAMGGEO,PCCreateGAMG_GEO);CHKERRQ(ierr);
18303e3471ccSMark Adams   ierr = PetscFunctionListAdd(&GAMGList,PCGAMGAGG,PCCreateGAMG_AGG);CHKERRQ(ierr);
18318e6d0c30SPeter Brune   ierr = PetscFunctionListAdd(&GAMGList,PCGAMGCLASSICAL,PCCreateGAMG_Classical);CHKERRQ(ierr);
18323e3471ccSMark Adams   ierr = PetscRegisterFinalize(PCGAMGFinalizePackage);CHKERRQ(ierr);
1833c1c463dbSMark Adams 
1834c1c463dbSMark Adams   /* general events */
1835fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGGraph_AGG", 0, &PC_GAMGGraph_AGG);CHKERRQ(ierr);
1836fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGGraph_GEO", PC_CLASSID, &PC_GAMGGraph_GEO);CHKERRQ(ierr);
1837fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGCoarse_AGG", PC_CLASSID, &PC_GAMGCoarsen_AGG);CHKERRQ(ierr);
1838fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGCoarse_GEO", PC_CLASSID, &PC_GAMGCoarsen_GEO);CHKERRQ(ierr);
1839c1c463dbSMark Adams   ierr = PetscLogEventRegister("PCGAMGProl_AGG", PC_CLASSID, &PC_GAMGProlongator_AGG);CHKERRQ(ierr);
1840c1c463dbSMark Adams   ierr = PetscLogEventRegister("PCGAMGProl_GEO", PC_CLASSID, &PC_GAMGProlongator_GEO);CHKERRQ(ierr);
1841fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGPOpt_AGG", PC_CLASSID, &PC_GAMGOptProlongator_AGG);CHKERRQ(ierr);
1842c1c463dbSMark Adams 
18435b89ad90SMark F. Adams   ierr = PetscLogEventRegister("GAMG: createProl", PC_CLASSID, &petsc_gamg_setup_events[SET1]);CHKERRQ(ierr);
18445b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Graph", PC_CLASSID, &petsc_gamg_setup_events[GRAPH]);CHKERRQ(ierr);
18455b89ad90SMark F. Adams   /* PetscLogEventRegister("    G.Mat", PC_CLASSID, &petsc_gamg_setup_events[GRAPH_MAT]); */
18465b89ad90SMark F. Adams   /* PetscLogEventRegister("    G.Filter", PC_CLASSID, &petsc_gamg_setup_events[GRAPH_FILTER]); */
18475b89ad90SMark F. Adams   /* PetscLogEventRegister("    G.Square", PC_CLASSID, &petsc_gamg_setup_events[GRAPH_SQR]); */
18485b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  MIS/Agg", PC_CLASSID, &petsc_gamg_setup_events[SET4]);CHKERRQ(ierr);
18495b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  geo: growSupp", PC_CLASSID, &petsc_gamg_setup_events[SET5]);CHKERRQ(ierr);
18505b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  geo: triangle", PC_CLASSID, &petsc_gamg_setup_events[SET6]);CHKERRQ(ierr);
1851bb235841SBarry Smith   ierr = PetscLogEventRegister("    search-set", PC_CLASSID, &petsc_gamg_setup_events[FIND_V]);CHKERRQ(ierr);
18525b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  SA: col data", PC_CLASSID, &petsc_gamg_setup_events[SET7]);CHKERRQ(ierr);
18535b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  SA: frmProl0", PC_CLASSID, &petsc_gamg_setup_events[SET8]);CHKERRQ(ierr);
18545b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  SA: smooth", PC_CLASSID, &petsc_gamg_setup_events[SET9]);CHKERRQ(ierr);
18555b89ad90SMark F. Adams   ierr = PetscLogEventRegister("GAMG: partLevel", PC_CLASSID, &petsc_gamg_setup_events[SET2]);CHKERRQ(ierr);
18565b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  repartition", PC_CLASSID, &petsc_gamg_setup_events[SET12]);CHKERRQ(ierr);
18575b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Invert-Sort", PC_CLASSID, &petsc_gamg_setup_events[SET13]);CHKERRQ(ierr);
18585b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Move A", PC_CLASSID, &petsc_gamg_setup_events[SET14]);CHKERRQ(ierr);
18595b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Move P", PC_CLASSID, &petsc_gamg_setup_events[SET15]);CHKERRQ(ierr);
18604555aa8cSStefano Zampini   for (l=0;l<PETSC_MG_MAXLEVELS;l++) {
18614555aa8cSStefano Zampini     char ename[32];
18625b89ad90SMark F. Adams 
18634555aa8cSStefano Zampini     ierr = PetscSNPrintf(ename,sizeof(ename),"PCGAMG Squ l%02d",l);CHKERRQ(ierr);
18644555aa8cSStefano Zampini     ierr = PetscLogEventRegister(ename, PC_CLASSID, &petsc_gamg_setup_matmat_events[l][0]);CHKERRQ(ierr);
18654555aa8cSStefano Zampini     ierr = PetscSNPrintf(ename,sizeof(ename),"PCGAMG Gal l%02d",l);CHKERRQ(ierr);
18664555aa8cSStefano Zampini     ierr = PetscLogEventRegister(ename, PC_CLASSID, &petsc_gamg_setup_matmat_events[l][1]);CHKERRQ(ierr);
18674555aa8cSStefano Zampini     ierr = PetscSNPrintf(ename,sizeof(ename),"PCGAMG Opt l%02d",l);CHKERRQ(ierr);
18684555aa8cSStefano Zampini     ierr = PetscLogEventRegister(ename, PC_CLASSID, &petsc_gamg_setup_matmat_events[l][2]);CHKERRQ(ierr);
18694555aa8cSStefano Zampini   }
18705b89ad90SMark F. Adams   /* PetscLogEventRegister(" PL move data", PC_CLASSID, &petsc_gamg_setup_events[SET13]); */
18715b89ad90SMark F. Adams   /* PetscLogEventRegister("GAMG: fix", PC_CLASSID, &petsc_gamg_setup_events[SET10]); */
18725b89ad90SMark F. Adams   /* PetscLogEventRegister("GAMG: set levels", PC_CLASSID, &petsc_gamg_setup_events[SET11]); */
18735b89ad90SMark F. Adams   /* create timer stages */
18744555aa8cSStefano Zampini #if defined(GAMG_STAGES)
18755b89ad90SMark F. Adams   {
18765b89ad90SMark F. Adams     char     str[32];
18775b89ad90SMark F. Adams     PetscInt lidx;
18785b89ad90SMark F. Adams     sprintf(str,"MG Level %d (finest)",0);
18795b89ad90SMark F. Adams     ierr = PetscLogStageRegister(str, &gamg_stages[0]);CHKERRQ(ierr);
18805b89ad90SMark F. Adams     for (lidx=1; lidx<9; lidx++) {
1881c9567895SMark       sprintf(str,"MG Level %d",(int)lidx);
18825b89ad90SMark F. Adams       ierr = PetscLogStageRegister(str, &gamg_stages[lidx]);CHKERRQ(ierr);
18835b89ad90SMark F. Adams     }
18845b89ad90SMark F. Adams   }
18855b89ad90SMark F. Adams #endif
18863e3471ccSMark Adams   PetscFunctionReturn(0);
18873e3471ccSMark Adams }
18883e3471ccSMark Adams 
18893e3471ccSMark Adams /*@C
18901c1aac46SBarry Smith  PCGAMGFinalizePackage - This function frees everything from the PCGAMG package. It is
18911c1aac46SBarry Smith     called from PetscFinalize() automatically.
18923e3471ccSMark Adams 
18933e3471ccSMark Adams  Level: developer
18943e3471ccSMark Adams 
18953e3471ccSMark Adams  .seealso: PetscFinalize()
18963e3471ccSMark Adams @*/
18973e3471ccSMark Adams PetscErrorCode PCGAMGFinalizePackage(void)
18983e3471ccSMark Adams {
18993e3471ccSMark Adams   PetscErrorCode ierr;
19003e3471ccSMark Adams 
19013e3471ccSMark Adams   PetscFunctionBegin;
19023e3471ccSMark Adams   PCGAMGPackageInitialized = PETSC_FALSE;
19033e3471ccSMark Adams   ierr = PetscFunctionListDestroy(&GAMGList);CHKERRQ(ierr);
19043e3471ccSMark Adams   PetscFunctionReturn(0);
19053e3471ccSMark Adams }
1906a36cf38bSToby Isaac 
1907a36cf38bSToby Isaac /*@C
1908a36cf38bSToby Isaac  PCGAMGRegister - Register a PCGAMG implementation.
1909a36cf38bSToby Isaac 
1910a36cf38bSToby Isaac  Input Parameters:
1911a36cf38bSToby Isaac  + type - string that will be used as the name of the GAMG type.
1912a36cf38bSToby Isaac  - create - function for creating the gamg context.
1913a36cf38bSToby Isaac 
1914a36cf38bSToby Isaac   Level: advanced
1915a36cf38bSToby Isaac 
19161c1aac46SBarry Smith  .seealso: PCGAMGType, PCGAMG, PCGAMGSetType()
1917a36cf38bSToby Isaac @*/
1918a36cf38bSToby Isaac PetscErrorCode PCGAMGRegister(PCGAMGType type, PetscErrorCode (*create)(PC))
1919a36cf38bSToby Isaac {
1920a36cf38bSToby Isaac   PetscErrorCode ierr;
1921a36cf38bSToby Isaac 
1922a36cf38bSToby Isaac   PetscFunctionBegin;
1923a36cf38bSToby Isaac   ierr = PCGAMGInitializePackage();CHKERRQ(ierr);
1924a36cf38bSToby Isaac   ierr = PetscFunctionListAdd(&GAMGList,type,create);CHKERRQ(ierr);
1925a36cf38bSToby Isaac   PetscFunctionReturn(0);
1926a36cf38bSToby Isaac }
1927a36cf38bSToby Isaac 
1928