xref: /petsc/src/ksp/pc/impls/gamg/gamg.c (revision 91f31d3dcede4f2d1ea8b9afdcbf27266d6f6776)
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*/
65b42dca8SJed Brown #include <../src/ksp/pc/impls/bjacobi/bjacobi.h> /* Hack to access same_local_solves */
718c3aa7eSMark #include <../src/ksp/ksp/impls/cheby/chebyshevimpl.h>    /*I "petscksp.h" I*/
8f96513f1SMatthew G Knepley 
9c9567895SMark #if defined(PETSC_HAVE_CUDA)
10c9567895SMark   #include <cuda_runtime.h>
11c9567895SMark #endif
12c9567895SMark 
13c9567895SMark #if defined(PETSC_HAVE_HIP)
14c9567895SMark   #include <hip/hip_runtime.h>
15c9567895SMark #endif
16c9567895SMark 
170cbbd2e1SMark F. Adams #if defined PETSC_GAMG_USE_LOG
180cbbd2e1SMark F. Adams PetscLogEvent petsc_gamg_setup_events[NUM_SET];
19b4fbaa2aSMark F. Adams #endif
200cbbd2e1SMark F. Adams 
210cbbd2e1SMark F. Adams #if defined PETSC_USE_LOG
22fd1112cbSBarry Smith PetscLogEvent PC_GAMGGraph_AGG;
23fd1112cbSBarry Smith PetscLogEvent PC_GAMGGraph_GEO;
240cbbd2e1SMark F. Adams PetscLogEvent PC_GAMGCoarsen_AGG;
250cbbd2e1SMark F. Adams PetscLogEvent PC_GAMGCoarsen_GEO;
260cbbd2e1SMark F. Adams PetscLogEvent PC_GAMGProlongator_AGG;
270cbbd2e1SMark F. Adams PetscLogEvent PC_GAMGProlongator_GEO;
28fd1112cbSBarry Smith PetscLogEvent PC_GAMGOptProlongator_AGG;
290cbbd2e1SMark F. Adams #endif
300cbbd2e1SMark F. Adams 
31b8fd24d8SMark F. Adams /* #define GAMG_STAGES */
320cbbd2e1SMark F. Adams #if (defined PETSC_GAMG_USE_LOG && defined GAMG_STAGES)
3318c3aa7eSMark static PetscLogStage gamg_stages[PETSC_MG_MAXLEVELS];
34b4fbaa2aSMark F. Adams #endif
35f96513f1SMatthew G Knepley 
360a545947SLisandro Dalcin static PetscFunctionList GAMGList = NULL;
373e3471ccSMark Adams static PetscBool PCGAMGPackageInitialized;
389d5b6da9SMark F. Adams 
39d3d6bff4SMark F. Adams /* ----------------------------------------------------------------------------- */
40d3d6bff4SMark F. Adams PetscErrorCode PCReset_GAMG(PC pc)
41d3d6bff4SMark F. Adams {
4218c3aa7eSMark   PetscErrorCode ierr, level;
43d3d6bff4SMark F. Adams   PC_MG          *mg      = (PC_MG*)pc->data;
44d3d6bff4SMark F. Adams   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
45d3d6bff4SMark F. Adams 
46d3d6bff4SMark F. Adams   PetscFunctionBegin;
4722a233eaSStefano Zampini   ierr = PetscFree(pc_gamg->data);CHKERRQ(ierr);
481c1aac46SBarry Smith   pc_gamg->data_sz = 0;
49878e152fSMark F. Adams   ierr = PetscFree(pc_gamg->orig_data);CHKERRQ(ierr);
5018c3aa7eSMark   for (level = 0; level < PETSC_MG_MAXLEVELS ; level++) {
5118c3aa7eSMark     mg->min_eigen_DinvA[level] = 0;
5218c3aa7eSMark     mg->max_eigen_DinvA[level] = 0;
5318c3aa7eSMark   }
5418c3aa7eSMark   pc_gamg->emin = 0;
5518c3aa7eSMark   pc_gamg->emax = 0;
56a2f3521dSMark F. Adams   PetscFunctionReturn(0);
57a2f3521dSMark F. Adams }
58a2f3521dSMark F. Adams 
595b89ad90SMark F. Adams /* -------------------------------------------------------------------------- */
605b89ad90SMark F. Adams /*
61c238b0ebSToby Isaac    PCGAMGCreateLevel_GAMG: create coarse op with RAP.  repartition and/or reduce number
62a147abb0SMark F. Adams      of active processors.
635b89ad90SMark F. Adams 
645b89ad90SMark F. Adams    Input Parameter:
65a2f3521dSMark F. Adams    . pc - parameters + side effect: coarse data in 'pc_gamg->data' and
66a2f3521dSMark F. Adams           'pc_gamg->data_sz' are changed via repartitioning/reduction.
679d5b6da9SMark F. Adams    . Amat_fine - matrix on this fine (k) level
68c5bfad50SMark F. Adams    . cr_bs - coarse block size
693530afc2SMark F. Adams    In/Output Parameter:
70a2f3521dSMark F. Adams    . a_P_inout - prolongation operator to the next level (k-->k-1)
71afc97cdcSMark F. Adams    . a_nactive_proc - number of active procs
7211e60469SMark F. Adams    Output Parameter:
733530afc2SMark F. Adams    . a_Amat_crs - coarse matrix that is created (k-1)
745b89ad90SMark F. Adams */
755cb416c2SMark F. Adams 
76171cca9aSMark 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)
775b89ad90SMark F. Adams {
78a2f3521dSMark F. Adams   PetscErrorCode  ierr;
799d5b6da9SMark F. Adams   PC_MG           *mg         = (PC_MG*)pc->data;
80486a8d0bSJed Brown   PC_GAMG         *pc_gamg    = (PC_GAMG*)mg->innerctx;
81a2f3521dSMark F. Adams   Mat             Cmat,Pold=*a_P_inout;
823b4367a7SBarry Smith   MPI_Comm        comm;
83c5df96a5SBarry Smith   PetscMPIInt     rank,size,new_size,nactive=*a_nactive_proc;
843ae0bb68SMark Adams   PetscInt        ncrs_eq,ncrs,f_bs;
855b89ad90SMark F. Adams 
865b89ad90SMark F. Adams   PetscFunctionBegin;
873b4367a7SBarry Smith   ierr = PetscObjectGetComm((PetscObject)Amat_fine,&comm);CHKERRQ(ierr);
88ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
89ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr);
90c5bfad50SMark F. Adams   ierr = MatGetBlockSize(Amat_fine, &f_bs);CHKERRQ(ierr);
919d5b6da9SMark F. Adams   ierr = MatPtAP(Amat_fine, Pold, MAT_INITIAL_MATRIX, 2.0, &Cmat);CHKERRQ(ierr);
92038e3b61SMark F. Adams 
93ce7c7f2fSMark Adams   if (Pcolumnperm) *Pcolumnperm = NULL;
94ce7c7f2fSMark Adams 
953ae0bb68SMark Adams   /* set 'ncrs' (nodes), 'ncrs_eq' (equations)*/
960298fd71SBarry Smith   ierr = MatGetLocalSize(Cmat, &ncrs_eq, NULL);CHKERRQ(ierr);
973ae0bb68SMark Adams   if (pc_gamg->data_cell_rows>0) {
983ae0bb68SMark Adams     ncrs = pc_gamg->data_sz/pc_gamg->data_cell_cols/pc_gamg->data_cell_rows;
9973911c69SBarry Smith   } else {
1003ae0bb68SMark Adams     PetscInt  bs;
1013ae0bb68SMark Adams     ierr = MatGetBlockSize(Cmat, &bs);CHKERRQ(ierr);
1023ae0bb68SMark Adams     ncrs = ncrs_eq/bs;
1033ae0bb68SMark Adams   }
104c5df96a5SBarry Smith   /* get number of PEs to make active 'new_size', reduce, can be any integer 1-P */
105c9567895SMark   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. */
106c9567895SMark #if defined(PETSC_HAVE_CUDA)
107c9567895SMark     PetscShmComm pshmcomm;
108c9567895SMark     PetscMPIInt  locrank;
109c9567895SMark     MPI_Comm     loccomm;
110c9567895SMark     PetscInt     s_nnodes,r_nnodes, new_new_size;
111c9567895SMark     cudaError_t  cerr;
112c9567895SMark     int          devCount;
113c9567895SMark     ierr = PetscShmCommGet(comm,&pshmcomm);CHKERRQ(ierr);
114c9567895SMark     ierr = PetscShmCommGetMpiShmComm(pshmcomm,&loccomm);CHKERRQ(ierr);
115c9567895SMark     ierr = MPI_Comm_rank(loccomm, &locrank);CHKERRQ(ierr);
116c9567895SMark     s_nnodes = !locrank;
117c9567895SMark     ierr = MPI_Allreduce(&s_nnodes,&r_nnodes,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(ierr);
118c9567895SMark     if (size%r_nnodes) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_PLIB,"odd number of nodes np=%D nnodes%D",size,r_nnodes);
119c9567895SMark     devCount = 0;
120c9567895SMark     cerr = cudaGetDeviceCount(&devCount);
121c9567895SMark     cudaGetLastError(); /* Reset the last error */
122c9567895SMark     if (cerr == cudaSuccess && devCount >= 1) { /* There are devices, else go to heuristic */
123c9567895SMark       new_new_size = r_nnodes * devCount;
124c9567895SMark       new_size = new_new_size;
125c9567895SMark       ierr = PetscInfo5(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);
126c9567895SMark     } else {
127c9567895SMark       ierr = PetscInfo(pc,"With Cuda but no device. Use heuristics.");CHKERRQ(ierr);
128c9567895SMark       goto HEURISTIC;
129c9567895SMark     }
130c9567895SMark #else
131c9567895SMark     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"should not be here");
132c9567895SMark #endif
133c9567895SMark   } else if (pc_gamg->level_reduction_factors[pc_gamg->current_level] > 0) {
134c9567895SMark     if (nactive%pc_gamg->level_reduction_factors[pc_gamg->current_level]) SETERRQ2(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]);
135c9567895SMark     new_size = nactive/pc_gamg->level_reduction_factors[pc_gamg->current_level];
136c9567895SMark     ierr = PetscInfo3(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);
137c9567895SMark   } else if (is_last && !pc_gamg->use_parallel_coarse_grid_solver) {
138c9567895SMark     new_size = 1;
139c9567895SMark     ierr = PetscInfo1(pc,"Force coarsest grid reduction to %D active processoes\n",new_size);CHKERRQ(ierr);
140c9567895SMark   } else {
141472110cdSMark F. Adams     PetscInt ncrs_eq_glob;
142c9567895SMark #if defined(PETSC_HAVE_CUDA)
143c9567895SMark     HEURISTIC:
144c9567895SMark #endif
1450298fd71SBarry Smith     ierr     = MatGetSize(Cmat, &ncrs_eq_glob, NULL);CHKERRQ(ierr);
146a90e85d9SMark Adams     new_size = (PetscMPIInt)((float)ncrs_eq_glob/(float)pc_gamg->min_eq_proc + 0.5); /* hardwire min. number of eq/proc */
1477f66b68fSMark Adams     if (!new_size) new_size = 1; /* not likely, posible? */
148c5df96a5SBarry Smith     else if (new_size >= nactive) new_size = nactive; /* no change, rare */
149c9567895SMark     ierr = PetscInfo1(pc,"Coarse grid reduction to %D active processoes\n",new_size);CHKERRQ(ierr);
150a2f3521dSMark F. Adams   }
1512e3501ffSMark Adams   if (new_size==nactive) {
152ef3f0257SMark Adams     *a_Amat_crs = Cmat; /* output - no repartitioning or reduction - could bail here */
153ce7c7f2fSMark Adams     if (new_size < size) {
154ce7c7f2fSMark Adams       /* odd case where multiple coarse grids are on one processor or no coarsening ... */
155c9567895SMark       ierr = PetscInfo1(pc,"reduced grid using same number of processors (%D) as last grid (use larger coarse grid)\n",nactive);CHKERRQ(ierr);
156ce7c7f2fSMark Adams       if (pc_gamg->cpu_pin_coarse_grids) {
157b470e4b4SRichard Tran Mills         ierr = MatBindToCPU(*a_Amat_crs,PETSC_TRUE);CHKERRQ(ierr);
158b470e4b4SRichard Tran Mills         ierr = MatBindToCPU(*a_P_inout,PETSC_TRUE);CHKERRQ(ierr);
159ce7c7f2fSMark Adams       }
160ce7c7f2fSMark Adams     }
161ef3f0257SMark Adams     /* we know that the grid structure can be reused in MatPtAP */
1622e3501ffSMark Adams   } else { /* reduce active processors - we know that the grid structure can NOT be reused in MatPtAP */
163192c0e8bSMark Adams     PetscInt       *counts,*newproc_idx,ii,jj,kk,strideNew,*tidx,ncrs_new,ncrs_eq_new,nloc_old,expand_factor=1,rfactor=1;
164885364a3SMark Adams     IS             is_eq_newproc,is_eq_num,is_eq_num_prim,new_eq_indices;
16571959b99SBarry Smith     nloc_old = ncrs_eq/cr_bs;
16671959b99SBarry Smith     if (ncrs_eq % cr_bs) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_PLIB,"ncrs_eq %D not divisible by cr_bs %D",ncrs_eq,cr_bs);
167ce7c7f2fSMark Adams     /* get new_size and rfactor */
168ce7c7f2fSMark Adams     if (pc_gamg->layout_type==PCGAMG_LAYOUT_SPREAD || !pc_gamg->repart) {
169ce7c7f2fSMark Adams       /* find factor */
170ce7c7f2fSMark Adams       if (new_size == 1) rfactor = size; /* don't modify */
171ce7c7f2fSMark Adams       else {
172ce7c7f2fSMark Adams         PetscReal best_fact = 0.;
173ce7c7f2fSMark Adams         jj = -1;
174ce7c7f2fSMark Adams         for (kk = 1 ; kk <= size ; kk++) {
175ce7c7f2fSMark Adams           if (!(size%kk)) { /* a candidate */
176ce7c7f2fSMark Adams             PetscReal nactpe = (PetscReal)size/(PetscReal)kk, fact = nactpe/(PetscReal)new_size;
177ce7c7f2fSMark Adams             if (fact > 1.0) fact = 1./fact; /* keep fact < 1 */
178ce7c7f2fSMark Adams             if (fact > best_fact) {
179ce7c7f2fSMark Adams               best_fact = fact; jj = kk;
180ce7c7f2fSMark Adams             }
181ce7c7f2fSMark Adams           }
182ce7c7f2fSMark Adams         }
183ce7c7f2fSMark Adams         if (jj != -1) rfactor = jj;
184ce7c7f2fSMark Adams         else rfactor = 1; /* a prime */
185ce7c7f2fSMark Adams         if (pc_gamg->layout_type == PCGAMG_LAYOUT_COMPACT) expand_factor = 1;
186ce7c7f2fSMark Adams         else expand_factor = rfactor;
187ce7c7f2fSMark Adams       }
188ce7c7f2fSMark Adams       new_size = size/rfactor; /* make new size one that is factor */
1894cdfd227SMark       if (new_size==nactive) { /* no repartitioning or reduction, bail out because nested here (rare) */
1904cdfd227SMark         *a_Amat_crs = Cmat;
191c9567895SMark         ierr = PetscInfo2(pc,"Finding factorable processor set stopped reduction: new_size=%D, neq(loc)=%D\n",new_size,ncrs_eq);CHKERRQ(ierr);
192ce7c7f2fSMark Adams         PetscFunctionReturn(0);
193ce7c7f2fSMark Adams       }
194ce7c7f2fSMark Adams     }
1954cdfd227SMark #if defined PETSC_GAMG_USE_LOG
1964cdfd227SMark     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET12],0,0,0,0);CHKERRQ(ierr);
1974cdfd227SMark #endif
198a2f3521dSMark F. Adams     /* make 'is_eq_newproc' */
199785e854fSJed Brown     ierr = PetscMalloc1(size, &counts);CHKERRQ(ierr);
2002e3501ffSMark Adams     if (pc_gamg->repart) {
201a2f3521dSMark F. Adams       /* Repartition Cmat_{k} and move colums of P^{k}_{k-1} and coordinates of primal part accordingly */
2025a9b9e01SMark F. Adams       Mat      adj;
203c9567895SMark       ierr = PetscInfo4(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);
204a2f3521dSMark F. Adams       /* get 'adj' */
205c5bfad50SMark F. Adams       if (cr_bs == 1) {
206038e3b61SMark F. Adams         ierr = MatConvert(Cmat, MATMPIADJ, MAT_INITIAL_MATRIX, &adj);CHKERRQ(ierr);
207806fa848SBarry Smith       } else {
208a2f3521dSMark F. Adams         /* make a scalar matrix to partition (no Stokes here) */
209eb07cef2SMark F. Adams         Mat               tMat;
210a2f3521dSMark F. Adams         PetscInt          Istart_crs,Iend_crs,ncols,jj,Ii;
211b4fbaa2aSMark F. Adams         const PetscScalar *vals;
212b4fbaa2aSMark F. Adams         const PetscInt    *idx;
213a2f3521dSMark F. Adams         PetscInt          *d_nnz, *o_nnz, M, N;
21439d09545SMark Adams         static PetscInt   llev = 0; /* ugly but just used for debugging */
215d9558ea9SBarry Smith         MatType           mtype;
216b4fbaa2aSMark F. Adams 
217e632b94dSBarry Smith         ierr = PetscMalloc2(ncrs, &d_nnz,ncrs, &o_nnz);CHKERRQ(ierr);
218a2f3521dSMark F. Adams         ierr = MatGetOwnershipRange(Cmat, &Istart_crs, &Iend_crs);CHKERRQ(ierr);
219a2f3521dSMark F. Adams         ierr = MatGetSize(Cmat, &M, &N);CHKERRQ(ierr);
220c5bfad50SMark F. Adams         for (Ii = Istart_crs, jj = 0; Ii < Iend_crs; Ii += cr_bs, jj++) {
2210a545947SLisandro Dalcin           ierr      = MatGetRow(Cmat,Ii,&ncols,NULL,NULL);CHKERRQ(ierr);
222c5bfad50SMark F. Adams           d_nnz[jj] = ncols/cr_bs;
223c5bfad50SMark F. Adams           o_nnz[jj] = ncols/cr_bs;
2240a545947SLisandro Dalcin           ierr      = MatRestoreRow(Cmat,Ii,&ncols,NULL,NULL);CHKERRQ(ierr);
2253ae0bb68SMark Adams           if (d_nnz[jj] > ncrs) d_nnz[jj] = ncrs;
2263ae0bb68SMark Adams           if (o_nnz[jj] > (M/cr_bs-ncrs)) o_nnz[jj] = M/cr_bs-ncrs;
22758471d46SMark F. Adams         }
2286876a03eSMark F. Adams 
229d9558ea9SBarry Smith         ierr = MatGetType(Amat_fine,&mtype);CHKERRQ(ierr);
2303b4367a7SBarry Smith         ierr = MatCreate(comm, &tMat);CHKERRQ(ierr);
2313ae0bb68SMark Adams         ierr = MatSetSizes(tMat, ncrs, ncrs,PETSC_DETERMINE, PETSC_DETERMINE);CHKERRQ(ierr);
232d9558ea9SBarry Smith         ierr = MatSetType(tMat,mtype);CHKERRQ(ierr);
233a2f3521dSMark F. Adams         ierr = MatSeqAIJSetPreallocation(tMat,0,d_nnz);CHKERRQ(ierr);
234a2f3521dSMark F. Adams         ierr = MatMPIAIJSetPreallocation(tMat,0,d_nnz,0,o_nnz);CHKERRQ(ierr);
235e632b94dSBarry Smith         ierr = PetscFree2(d_nnz,o_nnz);CHKERRQ(ierr);
236eb07cef2SMark F. Adams 
237a2f3521dSMark F. Adams         for (ii = Istart_crs; ii < Iend_crs; ii++) {
238c5bfad50SMark F. Adams           PetscInt dest_row = ii/cr_bs;
23922063be5SMark F. Adams           ierr = MatGetRow(Cmat,ii,&ncols,&idx,&vals);CHKERRQ(ierr);
240eb07cef2SMark F. Adams           for (jj = 0; jj < ncols; jj++) {
241c5bfad50SMark F. Adams             PetscInt    dest_col = idx[jj]/cr_bs;
242eb07cef2SMark F. Adams             PetscScalar v        = 1.0;
243eb07cef2SMark F. Adams             ierr = MatSetValues(tMat,1,&dest_row,1,&dest_col,&v,ADD_VALUES);CHKERRQ(ierr);
244eb07cef2SMark F. Adams           }
24522063be5SMark F. Adams           ierr = MatRestoreRow(Cmat,ii,&ncols,&idx,&vals);CHKERRQ(ierr);
246eb07cef2SMark F. Adams         }
247eb07cef2SMark F. Adams         ierr = MatAssemblyBegin(tMat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
248eb07cef2SMark F. Adams         ierr = MatAssemblyEnd(tMat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
249eb07cef2SMark F. Adams 
250b4fbaa2aSMark F. Adams         if (llev++ == -1) {
251b4fbaa2aSMark F. Adams           PetscViewer viewer; char fname[32];
2528caf3d72SBarry Smith           ierr = PetscSNPrintf(fname,sizeof(fname),"part_mat_%D.mat",llev);CHKERRQ(ierr);
2533b4367a7SBarry Smith           PetscViewerBinaryOpen(comm,fname,FILE_MODE_WRITE,&viewer);
254b4fbaa2aSMark F. Adams           ierr = MatView(tMat, viewer);CHKERRQ(ierr);
2553bf036e2SBarry Smith           ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
256b4fbaa2aSMark F. Adams         }
257eb07cef2SMark F. Adams         ierr = MatConvert(tMat, MATMPIADJ, MAT_INITIAL_MATRIX, &adj);CHKERRQ(ierr);
258eb07cef2SMark F. Adams         ierr = MatDestroy(&tMat);CHKERRQ(ierr);
259a2f3521dSMark F. Adams       } /* create 'adj' */
260f150b916SMark F. Adams 
261a2f3521dSMark F. Adams       { /* partition: get newproc_idx */
2625a9b9e01SMark F. Adams         char            prefix[256];
2635a9b9e01SMark F. Adams         const char      *pcpre;
264b4fbaa2aSMark F. Adams         const PetscInt  *is_idx;
265b4fbaa2aSMark F. Adams         MatPartitioning mpart;
266a4b7d37bSMark F. Adams         IS              proc_is;
2672f03bc48SMark F. Adams 
2683b4367a7SBarry Smith         ierr = MatPartitioningCreate(comm, &mpart);CHKERRQ(ierr);
2695ef31b24SMark F. Adams         ierr = MatPartitioningSetAdjacency(mpart, adj);CHKERRQ(ierr);
2709d5b6da9SMark F. Adams         ierr = PCGetOptionsPrefix(pc, &pcpre);CHKERRQ(ierr);
2718caf3d72SBarry Smith         ierr = PetscSNPrintf(prefix,sizeof(prefix),"%spc_gamg_",pcpre ? pcpre : "");CHKERRQ(ierr);
27259a0be82SJed Brown         ierr = PetscObjectSetOptionsPrefix((PetscObject)mpart,prefix);CHKERRQ(ierr);
27311e60469SMark F. Adams         ierr = MatPartitioningSetFromOptions(mpart);CHKERRQ(ierr);
274c5df96a5SBarry Smith         ierr = MatPartitioningSetNParts(mpart, new_size);CHKERRQ(ierr);
275a4b7d37bSMark F. Adams         ierr = MatPartitioningApply(mpart, &proc_is);CHKERRQ(ierr);
27611e60469SMark F. Adams         ierr = MatPartitioningDestroy(&mpart);CHKERRQ(ierr);
2775a9b9e01SMark F. Adams 
2785ef31b24SMark F. Adams         /* collect IS info */
279785e854fSJed Brown         ierr     = PetscMalloc1(ncrs_eq, &newproc_idx);CHKERRQ(ierr);
280a4b7d37bSMark F. Adams         ierr     = ISGetIndices(proc_is, &is_idx);CHKERRQ(ierr);
281a2f3521dSMark F. Adams         for (kk = jj = 0 ; kk < nloc_old ; kk++) {
282c5bfad50SMark F. Adams           for (ii = 0 ; ii < cr_bs ; ii++, jj++) {
283ce7c7f2fSMark Adams             newproc_idx[jj] = is_idx[kk] * expand_factor; /* distribution */
284eb07cef2SMark F. Adams           }
2855ef31b24SMark F. Adams         }
286a4b7d37bSMark F. Adams         ierr = ISRestoreIndices(proc_is, &is_idx);CHKERRQ(ierr);
287a4b7d37bSMark F. Adams         ierr = ISDestroy(&proc_is);CHKERRQ(ierr);
2885ef31b24SMark F. Adams       }
2895ef31b24SMark F. Adams       ierr = MatDestroy(&adj);CHKERRQ(ierr);
2905a9b9e01SMark F. Adams 
2913b4367a7SBarry Smith       ierr = ISCreateGeneral(comm, ncrs_eq, newproc_idx, PETSC_COPY_VALUES, &is_eq_newproc);CHKERRQ(ierr);
2928263b398SMark F. Adams       ierr = PetscFree(newproc_idx);CHKERRQ(ierr);
29331cb4603SMark Adams     } else { /* simple aggregation of parts -- 'is_eq_newproc' */
294ce7c7f2fSMark Adams       PetscInt targetPE;
2954cdfd227SMark       if (new_size==nactive) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"new_size==nactive. Should not happen");
296302440fdSBarry Smith       ierr = PetscInfo1(pc,"Number of equations (loc) %D with simple aggregation\n",ncrs_eq);CHKERRQ(ierr);
297ce7c7f2fSMark Adams       targetPE = (rank/rfactor)*expand_factor;
2983b4367a7SBarry Smith       ierr     = ISCreateStride(comm, ncrs_eq, targetPE, 0, &is_eq_newproc);CHKERRQ(ierr);
299a2f3521dSMark F. Adams     } /* end simple 'is_eq_newproc' */
300e33ef3b1SMark F. Adams 
30111e60469SMark F. Adams     /*
302a2f3521dSMark F. Adams       Create an index set from the is_eq_newproc index set to indicate the mapping TO
30311e60469SMark F. Adams     */
304a2f3521dSMark F. Adams     ierr = ISPartitioningToNumbering(is_eq_newproc, &is_eq_num);CHKERRQ(ierr);
3057700e67bSMark Adams     is_eq_num_prim = is_eq_num;
30611e60469SMark F. Adams     /*
307a2f3521dSMark F. Adams       Determine how many equations/vertices are assigned to each processor
30811e60469SMark F. Adams     */
309c5df96a5SBarry Smith     ierr        = ISPartitioningCount(is_eq_newproc, size, counts);CHKERRQ(ierr);
310c5df96a5SBarry Smith     ncrs_eq_new = counts[rank];
311a2f3521dSMark F. Adams     ierr        = ISDestroy(&is_eq_newproc);CHKERRQ(ierr);
312ce7c7f2fSMark Adams     ncrs_new = ncrs_eq_new/cr_bs;
313a2f3521dSMark F. Adams 
314a2f3521dSMark F. Adams     ierr = PetscFree(counts);CHKERRQ(ierr);
315885364a3SMark 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 */
316885364a3SMark Adams     {
317885364a3SMark Adams       Vec            src_crd, dest_crd;
318885364a3SMark 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;
319885364a3SMark Adams       VecScatter     vecscat;
320885364a3SMark Adams       PetscScalar    *array;
321885364a3SMark Adams       IS isscat;
322a2f3521dSMark F. Adams       /* move data (for primal equations only) */
32322063be5SMark F. Adams       /* Create a vector to contain the newly ordered element information */
3243b4367a7SBarry Smith       ierr = VecCreate(comm, &dest_crd);CHKERRQ(ierr);
3253ae0bb68SMark Adams       ierr = VecSetSizes(dest_crd, node_data_sz*ncrs_new, PETSC_DECIDE);CHKERRQ(ierr);
326c0dedaeaSBarry Smith       ierr = VecSetType(dest_crd,VECSTANDARD);CHKERRQ(ierr); /* this is needed! */
32711e60469SMark F. Adams       /*
3289d5b6da9SMark F. Adams         There are 'ndata_rows*ndata_cols' data items per node, (one can think of the vectors of having
329c5bfad50SMark F. Adams         a block size of ...).  Note, ISs are expanded into equation space by 'cr_bs'.
33011e60469SMark F. Adams       */
331854ce69bSBarry Smith       ierr = PetscMalloc1(ncrs*node_data_sz, &tidx);CHKERRQ(ierr);
332a2f3521dSMark F. Adams       ierr = ISGetIndices(is_eq_num_prim, &idx);CHKERRQ(ierr);
3333ae0bb68SMark Adams       for (ii=0,jj=0; ii<ncrs; ii++) {
334c5bfad50SMark F. Adams         PetscInt id = idx[ii*cr_bs]/cr_bs; /* get node back */
335a2f3521dSMark F. Adams         for (kk=0; kk<node_data_sz; kk++, jj++) tidx[jj] = id*node_data_sz + kk;
33611e60469SMark F. Adams       }
337a2f3521dSMark F. Adams       ierr = ISRestoreIndices(is_eq_num_prim, &idx);CHKERRQ(ierr);
3383ae0bb68SMark Adams       ierr = ISCreateGeneral(comm, node_data_sz*ncrs, tidx, PETSC_COPY_VALUES, &isscat);CHKERRQ(ierr);
33992a756f0SMark F. Adams       ierr = PetscFree(tidx);CHKERRQ(ierr);
34011e60469SMark F. Adams       /*
34111e60469SMark F. Adams         Create a vector to contain the original vertex information for each element
34211e60469SMark F. Adams       */
3433ae0bb68SMark Adams       ierr = VecCreateSeq(PETSC_COMM_SELF, node_data_sz*ncrs, &src_crd);CHKERRQ(ierr);
3449d5b6da9SMark F. Adams       for (jj=0; jj<ndata_cols; jj++) {
3453ae0bb68SMark Adams         const PetscInt stride0=ncrs*pc_gamg->data_cell_rows;
3463ae0bb68SMark Adams         for (ii=0; ii<ncrs; ii++) {
3479d5b6da9SMark F. Adams           for (kk=0; kk<ndata_rows; kk++) {
348a2f3521dSMark F. Adams             PetscInt    ix = ii*ndata_rows + kk + jj*stride0, jx = ii*node_data_sz + kk*ndata_cols + jj;
349c8b0795cSMark F. Adams             PetscScalar tt = (PetscScalar)pc_gamg->data[ix];
350676e1743SMark F. Adams             ierr = VecSetValues(src_crd, 1, &jx, &tt, INSERT_VALUES);CHKERRQ(ierr);
351d3d6bff4SMark F. Adams           }
352038e3b61SMark F. Adams         }
353eb07cef2SMark F. Adams       }
354eb07cef2SMark F. Adams       ierr = VecAssemblyBegin(src_crd);CHKERRQ(ierr);
355eb07cef2SMark F. Adams       ierr = VecAssemblyEnd(src_crd);CHKERRQ(ierr);
35611e60469SMark F. Adams       /*
35711e60469SMark F. Adams         Scatter the element vertex information (still in the original vertex ordering)
35811e60469SMark F. Adams         to the correct processor
35911e60469SMark F. Adams       */
3609448b7f1SJunchao Zhang       ierr = VecScatterCreate(src_crd, NULL, dest_crd, isscat, &vecscat);CHKERRQ(ierr);
36111e60469SMark F. Adams       ierr = ISDestroy(&isscat);CHKERRQ(ierr);
36211e60469SMark F. Adams       ierr = VecScatterBegin(vecscat,src_crd,dest_crd,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
36311e60469SMark F. Adams       ierr = VecScatterEnd(vecscat,src_crd,dest_crd,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
36411e60469SMark F. Adams       ierr = VecScatterDestroy(&vecscat);CHKERRQ(ierr);
36511e60469SMark F. Adams       ierr = VecDestroy(&src_crd);CHKERRQ(ierr);
36611e60469SMark F. Adams       /*
36711e60469SMark F. Adams         Put the element vertex data into a new allocation of the gdata->ele
36811e60469SMark F. Adams       */
369c8b0795cSMark F. Adams       ierr = PetscFree(pc_gamg->data);CHKERRQ(ierr);
370578f55a3SPeter Brune       ierr = PetscMalloc1(node_data_sz*ncrs_new, &pc_gamg->data);CHKERRQ(ierr);
3712fa5cd67SKarl Rupp 
3723ae0bb68SMark Adams       pc_gamg->data_sz = node_data_sz*ncrs_new;
3733ae0bb68SMark Adams       strideNew        = ncrs_new*ndata_rows;
3742fa5cd67SKarl Rupp 
37511e60469SMark F. Adams       ierr = VecGetArray(dest_crd, &array);CHKERRQ(ierr);
3769d5b6da9SMark F. Adams       for (jj=0; jj<ndata_cols; jj++) {
3773ae0bb68SMark Adams         for (ii=0; ii<ncrs_new; ii++) {
3789d5b6da9SMark F. Adams           for (kk=0; kk<ndata_rows; kk++) {
379a2f3521dSMark F. Adams             PetscInt ix = ii*ndata_rows + kk + jj*strideNew, jx = ii*node_data_sz + kk*ndata_cols + jj;
380c8b0795cSMark F. Adams             pc_gamg->data[ix] = PetscRealPart(array[jx]);
381d3d6bff4SMark F. Adams           }
382038e3b61SMark F. Adams         }
383038e3b61SMark F. Adams       }
38411e60469SMark F. Adams       ierr = VecRestoreArray(dest_crd, &array);CHKERRQ(ierr);
38511e60469SMark F. Adams       ierr = VecDestroy(&dest_crd);CHKERRQ(ierr);
386885364a3SMark Adams     }
387a2f3521dSMark F. Adams     /* move A and P (columns) with new layout */
3880cbbd2e1SMark F. Adams #if defined PETSC_GAMG_USE_LOG
3890cbbd2e1SMark F. Adams     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET13],0,0,0,0);CHKERRQ(ierr);
390ed3f9983SMark F. Adams #endif
39111e60469SMark F. Adams     /*
3927dae84e0SHong Zhang       Invert for MatCreateSubMatrix
39311e60469SMark F. Adams     */
394a2f3521dSMark F. Adams     ierr = ISInvertPermutation(is_eq_num, ncrs_eq_new, &new_eq_indices);CHKERRQ(ierr);
395a2f3521dSMark F. Adams     ierr = ISSort(new_eq_indices);CHKERRQ(ierr); /* is this needed? */
396c5bfad50SMark F. Adams     ierr = ISSetBlockSize(new_eq_indices, cr_bs);CHKERRQ(ierr);
397a2f3521dSMark F. Adams     if (is_eq_num != is_eq_num_prim) {
398a2f3521dSMark F. Adams       ierr = ISDestroy(&is_eq_num_prim);CHKERRQ(ierr); /* could be same as 'is_eq_num' */
399a2f3521dSMark F. Adams     }
4003cb8563fSToby Isaac     if (Pcolumnperm) {
4013cb8563fSToby Isaac       ierr = PetscObjectReference((PetscObject)new_eq_indices);CHKERRQ(ierr);
4023cb8563fSToby Isaac       *Pcolumnperm = new_eq_indices;
4033cb8563fSToby Isaac     }
404a2f3521dSMark F. Adams     ierr = ISDestroy(&is_eq_num);CHKERRQ(ierr);
4050cbbd2e1SMark F. Adams #if defined PETSC_GAMG_USE_LOG
4060cbbd2e1SMark F. Adams     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET13],0,0,0,0);CHKERRQ(ierr);
4070cbbd2e1SMark F. Adams     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET14],0,0,0,0);CHKERRQ(ierr);
408ed3f9983SMark F. Adams #endif
409a2f3521dSMark F. Adams     /* 'a_Amat_crs' output */
410a2f3521dSMark F. Adams     {
411a2f3521dSMark F. Adams       Mat mat;
4127dae84e0SHong Zhang       ierr        = MatCreateSubMatrix(Cmat, new_eq_indices, new_eq_indices, MAT_INITIAL_MATRIX, &mat);CHKERRQ(ierr);
413a2f3521dSMark F. Adams       *a_Amat_crs = mat;
414a2f3521dSMark F. Adams     }
415038e3b61SMark F. Adams     ierr = MatDestroy(&Cmat);CHKERRQ(ierr);
416a2f3521dSMark F. Adams 
4170cbbd2e1SMark F. Adams #if defined PETSC_GAMG_USE_LOG
4180cbbd2e1SMark F. Adams     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET14],0,0,0,0);CHKERRQ(ierr);
419ed3f9983SMark F. Adams #endif
42011e60469SMark F. Adams     /* prolongator */
42111e60469SMark F. Adams     {
42211e60469SMark F. Adams       IS       findices;
423a2f3521dSMark F. Adams       PetscInt Istart,Iend;
424a2f3521dSMark F. Adams       Mat      Pnew;
42562294041SBarry Smith 
426a2f3521dSMark F. Adams       ierr = MatGetOwnershipRange(Pold, &Istart, &Iend);CHKERRQ(ierr);
4270cbbd2e1SMark F. Adams #if defined PETSC_GAMG_USE_LOG
4280cbbd2e1SMark F. Adams       ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET15],0,0,0,0);CHKERRQ(ierr);
429ed3f9983SMark F. Adams #endif
4303b4367a7SBarry Smith       ierr = ISCreateStride(comm,Iend-Istart,Istart,1,&findices);CHKERRQ(ierr);
431c5bfad50SMark F. Adams       ierr = ISSetBlockSize(findices,f_bs);CHKERRQ(ierr);
4327dae84e0SHong Zhang       ierr = MatCreateSubMatrix(Pold, findices, new_eq_indices, MAT_INITIAL_MATRIX, &Pnew);CHKERRQ(ierr);
43311e60469SMark F. Adams       ierr = ISDestroy(&findices);CHKERRQ(ierr);
434c5bfad50SMark F. Adams 
4350cbbd2e1SMark F. Adams #if defined PETSC_GAMG_USE_LOG
4360cbbd2e1SMark F. Adams       ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET15],0,0,0,0);CHKERRQ(ierr);
437ed3f9983SMark F. Adams #endif
4383530afc2SMark F. Adams       ierr = MatDestroy(a_P_inout);CHKERRQ(ierr);
439a2f3521dSMark F. Adams 
440a2f3521dSMark F. Adams       /* output - repartitioned */
441a2f3521dSMark F. Adams       *a_P_inout = Pnew;
442e33ef3b1SMark F. Adams     }
443a2f3521dSMark F. Adams     ierr = ISDestroy(&new_eq_indices);CHKERRQ(ierr);
4445b89ad90SMark F. Adams 
445c5df96a5SBarry Smith     *a_nactive_proc = new_size; /* output */
446ce7c7f2fSMark Adams 
447ce7c7f2fSMark Adams     /* pinning on reduced grids, not a bad heuristic and optimization gets folded into process reduction optimization */
448ce7c7f2fSMark Adams     if (pc_gamg->cpu_pin_coarse_grids) {
449ce7c7f2fSMark Adams #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
4508bca76a6SMark Adams       static PetscInt llev = 2;
45139d09545SMark Adams       ierr = PetscInfo1(pc,"Pinning level %D to the CPU\n",llev++);CHKERRQ(ierr);
452ce7c7f2fSMark Adams #endif
453b470e4b4SRichard Tran Mills       ierr = MatBindToCPU(*a_Amat_crs,PETSC_TRUE);CHKERRQ(ierr);
454b470e4b4SRichard Tran Mills       ierr = MatBindToCPU(*a_P_inout,PETSC_TRUE);CHKERRQ(ierr);
455ce7c7f2fSMark Adams       if (1) { /* lvec is created, need to pin it, this is done in MatSetUpMultiply_MPIAIJ. Hack */
456ce7c7f2fSMark Adams         Mat         A = *a_Amat_crs, P = *a_P_inout;
457ce7c7f2fSMark Adams         PetscMPIInt size;
458ffc4695bSBarry Smith         ierr = MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);CHKERRMPI(ierr);
459ce7c7f2fSMark Adams         if (size > 1) {
460ce7c7f2fSMark Adams           Mat_MPIAIJ     *a = (Mat_MPIAIJ*)A->data, *p = (Mat_MPIAIJ*)P->data;
461b470e4b4SRichard Tran Mills           ierr = VecBindToCPU(a->lvec,PETSC_TRUE);CHKERRQ(ierr);
462b470e4b4SRichard Tran Mills           ierr = VecBindToCPU(p->lvec,PETSC_TRUE);CHKERRQ(ierr);
463ce7c7f2fSMark Adams         }
464ce7c7f2fSMark Adams       }
465ce7c7f2fSMark Adams     }
4664cdfd227SMark #if defined PETSC_GAMG_USE_LOG
4674cdfd227SMark     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET12],0,0,0,0);CHKERRQ(ierr);
4684cdfd227SMark #endif
469a2f3521dSMark F. Adams   }
4705b89ad90SMark F. Adams   PetscFunctionReturn(0);
4715b89ad90SMark F. Adams }
4725b89ad90SMark F. Adams 
4734b1575e2SStefano Zampini PetscErrorCode PCGAMGSquareGraph_GAMG(PC a_pc, Mat Gmat1, Mat* Gmat2)
4744b1575e2SStefano Zampini {
4754b1575e2SStefano Zampini   PetscErrorCode ierr;
4764b1575e2SStefano Zampini   const char     *prefix;
4774b1575e2SStefano Zampini   char           addp[32];
4784b1575e2SStefano Zampini   PC_MG          *mg      = (PC_MG*)a_pc->data;
4794b1575e2SStefano Zampini   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
4804b1575e2SStefano Zampini 
4814b1575e2SStefano Zampini   PetscFunctionBegin;
4824b1575e2SStefano Zampini   ierr = PCGetOptionsPrefix(a_pc,&prefix);CHKERRQ(ierr);
4834b1575e2SStefano Zampini   ierr = PetscInfo1(a_pc,"Square Graph on level %D\n",pc_gamg->current_level+1);CHKERRQ(ierr);
4844b1575e2SStefano Zampini   ierr = MatProductCreate(Gmat1,Gmat1,NULL,Gmat2);CHKERRQ(ierr);
4854b1575e2SStefano Zampini   ierr = MatSetOptionsPrefix(*Gmat2,prefix);CHKERRQ(ierr);
4864b1575e2SStefano Zampini   ierr = PetscSNPrintf(addp,sizeof(addp),"pc_gamg_square_%d_",pc_gamg->current_level);CHKERRQ(ierr);
4874b1575e2SStefano Zampini   ierr = MatAppendOptionsPrefix(*Gmat2,addp);CHKERRQ(ierr);
4884b1575e2SStefano Zampini   ierr = MatProductSetType(*Gmat2,MATPRODUCT_AtB);CHKERRQ(ierr);
4894b1575e2SStefano Zampini   ierr = MatProductSetFromOptions(*Gmat2);CHKERRQ(ierr);
4904b1575e2SStefano Zampini   ierr = MatProductSymbolic(*Gmat2);CHKERRQ(ierr);
4914b1575e2SStefano Zampini   /* we only need the sparsity, cheat and tell PETSc the matrix has been assembled */
4924b1575e2SStefano Zampini   (*Gmat2)->assembled = PETSC_TRUE;
4934b1575e2SStefano Zampini   PetscFunctionReturn(0);
4944b1575e2SStefano Zampini }
4954b1575e2SStefano Zampini 
4965b89ad90SMark F. Adams /* -------------------------------------------------------------------------- */
4975b89ad90SMark F. Adams /*
4985b89ad90SMark F. Adams    PCSetUp_GAMG - Prepares for the use of the GAMG preconditioner
4995b89ad90SMark F. Adams                     by setting data structures and options.
5005b89ad90SMark F. Adams 
5015b89ad90SMark F. Adams    Input Parameter:
5025b89ad90SMark F. Adams .  pc - the preconditioner context
5035b89ad90SMark F. Adams 
5045b89ad90SMark F. Adams */
5059d5b6da9SMark F. Adams PetscErrorCode PCSetUp_GAMG(PC pc)
5065b89ad90SMark F. Adams {
5075b89ad90SMark F. Adams   PetscErrorCode ierr;
5089d5b6da9SMark F. Adams   PC_MG          *mg      = (PC_MG*)pc->data;
5095b89ad90SMark F. Adams   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
5102adcac29SMark F. Adams   Mat            Pmat     = pc->pmat;
51118c3aa7eSMark   PetscInt       fine_level,level,level1,bs,M,N,qq,lidx,nASMBlocksArr[PETSC_MG_MAXLEVELS];
5123b4367a7SBarry Smith   MPI_Comm       comm;
513c5df96a5SBarry Smith   PetscMPIInt    rank,size,nactivepe;
51418c3aa7eSMark   Mat            Aarr[PETSC_MG_MAXLEVELS],Parr[PETSC_MG_MAXLEVELS];
51518c3aa7eSMark   IS             *ASMLocalIDsArr[PETSC_MG_MAXLEVELS];
516a2f3521dSMark F. Adams   PetscLogDouble nnz0=0.,nnztot=0.;
517569f4572SMark Adams   MatInfo        info;
518171cca9aSMark Adams   PetscBool      is_last = PETSC_FALSE;
5195ef31b24SMark F. Adams 
5205b89ad90SMark F. Adams   PetscFunctionBegin;
5213b4367a7SBarry Smith   ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
522ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRMPI(ierr);
523ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRMPI(ierr);
524dfd5c07aSMark F. Adams 
52584d3f75bSMark F. Adams   if (pc_gamg->setup_count++ > 0) {
5261c1aac46SBarry Smith     if ((PetscBool)(!pc_gamg->reuse_prol)) {
527878e152fSMark F. Adams       /* reset everything */
528878e152fSMark F. Adams       ierr = PCReset_MG(pc);CHKERRQ(ierr);
529878e152fSMark F. Adams       pc->setupcalled = 0;
530806fa848SBarry Smith     } else {
53184d3f75bSMark F. Adams       PC_MG_Levels **mglevels = mg->levels;
53203a628feSMark F. Adams       /* just do Galerkin grids */
53358471d46SMark F. Adams       Mat          B,dA,dB;
53458471d46SMark F. Adams 
53571959b99SBarry Smith       if (!pc->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"PCSetUp() has not been called yet");
5369d5b6da9SMark F. Adams       if (pc_gamg->Nlevels > 1) {
53758471d46SMark F. Adams         /* currently only handle case where mat and pmat are the same on coarser levels */
53823ee1639SBarry Smith         ierr = KSPGetOperators(mglevels[pc_gamg->Nlevels-1]->smoothd,&dA,&dB);CHKERRQ(ierr);
53958471d46SMark F. Adams         /* (re)set to get dirty flag */
54023ee1639SBarry Smith         ierr = KSPSetOperators(mglevels[pc_gamg->Nlevels-1]->smoothd,dA,dB);CHKERRQ(ierr);
54158471d46SMark F. Adams 
5422fb0b348SMark F. Adams         for (level=pc_gamg->Nlevels-2; level>=0; level--) {
543ef3f0257SMark Adams           /* 2nd solve, matrix structure can change from repartitioning or process reduction but don't know if we have process reduction here. Should fix */
544ef3f0257SMark Adams           if (pc_gamg->setup_count==2 /* && pc_gamg->repart||reduction */) {
545ef3f0257SMark Adams             ierr = PetscInfo2(pc,"new RAP after first solve level %D, %D setup\n",level,pc_gamg->setup_count);CHKERRQ(ierr);
546ef3f0257SMark Adams             ierr = MatPtAP(dB,mglevels[level+1]->interpolate,MAT_INITIAL_MATRIX,2.0,&B);CHKERRQ(ierr);
547084a8fe3SJed Brown             ierr = MatDestroy(&mglevels[level]->A);CHKERRQ(ierr);
54803a628feSMark F. Adams             mglevels[level]->A = B;
549806fa848SBarry Smith           } else {
550ef3f0257SMark Adams             ierr = PetscInfo2(pc,"RAP after first solve reusing matrix level %D, %D setup\n",level,pc_gamg->setup_count);CHKERRQ(ierr);
55123ee1639SBarry Smith             ierr = KSPGetOperators(mglevels[level]->smoothd,NULL,&B);CHKERRQ(ierr);
55258471d46SMark F. Adams             ierr = MatPtAP(dB,mglevels[level+1]->interpolate,MAT_REUSE_MATRIX,1.0,&B);CHKERRQ(ierr);
55303a628feSMark F. Adams           }
55423ee1639SBarry Smith           ierr = KSPSetOperators(mglevels[level]->smoothd,B,B);CHKERRQ(ierr);
55558471d46SMark F. Adams           dB   = B;
55658471d46SMark F. Adams         }
5575f8cf99dSMark F. Adams       }
558d5280255SMark F. Adams 
559d5280255SMark F. Adams       ierr = PCSetUp_MG(pc);CHKERRQ(ierr);
56058471d46SMark F. Adams       PetscFunctionReturn(0);
561eb07cef2SMark F. Adams     }
562878e152fSMark F. Adams   }
563f6536408SMark F. Adams 
564878e152fSMark F. Adams   if (!pc_gamg->data) {
565878e152fSMark F. Adams     if (pc_gamg->orig_data) {
566878e152fSMark F. Adams       ierr = MatGetBlockSize(Pmat, &bs);CHKERRQ(ierr);
5670298fd71SBarry Smith       ierr = MatGetLocalSize(Pmat, &qq, NULL);CHKERRQ(ierr);
5682fa5cd67SKarl Rupp 
569878e152fSMark F. Adams       pc_gamg->data_sz        = (qq/bs)*pc_gamg->orig_data_cell_rows*pc_gamg->orig_data_cell_cols;
570878e152fSMark F. Adams       pc_gamg->data_cell_rows = pc_gamg->orig_data_cell_rows;
571878e152fSMark F. Adams       pc_gamg->data_cell_cols = pc_gamg->orig_data_cell_cols;
5722fa5cd67SKarl Rupp 
573785e854fSJed Brown       ierr = PetscMalloc1(pc_gamg->data_sz, &pc_gamg->data);CHKERRQ(ierr);
574878e152fSMark F. Adams       for (qq=0; qq<pc_gamg->data_sz; qq++) pc_gamg->data[qq] = pc_gamg->orig_data[qq];
575806fa848SBarry Smith     } else {
5761ab5ffc9SJed Brown       if (!pc_gamg->ops->createdefaultdata) SETERRQ(comm,PETSC_ERR_PLIB,"'createdefaultdata' not set(?) need to support NULL data");
5777700e67bSMark Adams       ierr = pc_gamg->ops->createdefaultdata(pc,Pmat);CHKERRQ(ierr);
5789d5b6da9SMark F. Adams     }
579878e152fSMark F. Adams   }
580878e152fSMark F. Adams 
581878e152fSMark F. Adams   /* cache original data for reuse */
5821c1aac46SBarry Smith   if (!pc_gamg->orig_data && (PetscBool)(!pc_gamg->reuse_prol)) {
583785e854fSJed Brown     ierr = PetscMalloc1(pc_gamg->data_sz, &pc_gamg->orig_data);CHKERRQ(ierr);
584878e152fSMark F. Adams     for (qq=0; qq<pc_gamg->data_sz; qq++) pc_gamg->orig_data[qq] = pc_gamg->data[qq];
585878e152fSMark F. Adams     pc_gamg->orig_data_cell_rows = pc_gamg->data_cell_rows;
586878e152fSMark F. Adams     pc_gamg->orig_data_cell_cols = pc_gamg->data_cell_cols;
587878e152fSMark F. Adams   }
588038e3b61SMark F. Adams 
589302f38e8SMark F. Adams   /* get basic dims */
590302f38e8SMark F. Adams   ierr = MatGetBlockSize(Pmat, &bs);CHKERRQ(ierr);
591171cca9aSMark Adams   ierr = MatGetSize(Pmat, &M, &N);CHKERRQ(ierr);
59284d3f75bSMark F. Adams 
593569f4572SMark Adams   ierr = MatGetInfo(Pmat,MAT_GLOBAL_SUM,&info);CHKERRQ(ierr); /* global reduction */
594569f4572SMark Adams   nnz0   = info.nz_used;
595569f4572SMark Adams   nnztot = info.nz_used;
596c9567895SMark   ierr = PetscInfo6(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);
597569f4572SMark Adams 
598a2f3521dSMark F. Adams   /* Get A_i and R_i */
59962294041SBarry Smith   for (level=0, Aarr[0]=Pmat, nactivepe = size; level < (pc_gamg->Nlevels-1) && (!level || M>pc_gamg->coarse_eq_limit); level++) {
6009ab59c8bSMark Adams     pc_gamg->current_level = level;
60118c3aa7eSMark     if (level >= PETSC_MG_MAXLEVELS) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Too many levels %D",level);
6025b89ad90SMark F. Adams     level1 = level + 1;
6030cbbd2e1SMark F. Adams #if defined PETSC_GAMG_USE_LOG
6040cbbd2e1SMark F. Adams     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET1],0,0,0,0);CHKERRQ(ierr);
605a2f3521dSMark F. Adams #if (defined GAMG_STAGES)
606a2f3521dSMark F. Adams     ierr = PetscLogStagePush(gamg_stages[level]);CHKERRQ(ierr);
607b4fbaa2aSMark F. Adams #endif
608a2f3521dSMark F. Adams #endif
609c8b0795cSMark F. Adams     { /* construct prolongator */
610725b86d8SJed Brown       Mat              Gmat;
6110cbbd2e1SMark F. Adams       PetscCoarsenData *agg_lists;
6127700e67bSMark Adams       Mat              Prol11;
613c8b0795cSMark F. Adams 
6147700e67bSMark Adams       ierr = pc_gamg->ops->graph(pc,Aarr[level], &Gmat);CHKERRQ(ierr);
6151ab5ffc9SJed Brown       ierr = pc_gamg->ops->coarsen(pc, &Gmat, &agg_lists);CHKERRQ(ierr);
6167700e67bSMark Adams       ierr = pc_gamg->ops->prolongator(pc,Aarr[level],Gmat,agg_lists,&Prol11);CHKERRQ(ierr);
617c8b0795cSMark F. Adams 
618a2f3521dSMark F. Adams       /* could have failed to create new level */
619a2f3521dSMark F. Adams       if (Prol11) {
620f7df55f0SStefano Zampini         const char *prefix;
621f7df55f0SStefano Zampini         char       addp[32];
622f7df55f0SStefano Zampini 
6239d5b6da9SMark F. Adams         /* get new block size of coarse matrices */
6240298fd71SBarry Smith         ierr = MatGetBlockSizes(Prol11, NULL, &bs);CHKERRQ(ierr);
625a2f3521dSMark F. Adams 
626fd1112cbSBarry Smith         if (pc_gamg->ops->optprolongator) {
627c8b0795cSMark F. Adams           /* smooth */
628fd1112cbSBarry Smith           ierr = pc_gamg->ops->optprolongator(pc, Aarr[level], &Prol11);CHKERRQ(ierr);
629c8b0795cSMark F. Adams         }
630c8b0795cSMark F. Adams 
6310c3bc534SBarry Smith         if (pc_gamg->use_aggs_in_asm) {
6321b18a24aSMark Adams           PetscInt bs;
6331b18a24aSMark Adams           ierr = MatGetBlockSizes(Prol11, &bs, NULL);CHKERRQ(ierr);
6340a3c815dSMark Adams           ierr = PetscCDGetASMBlocks(agg_lists, bs, Gmat, &nASMBlocksArr[level], &ASMLocalIDsArr[level]);CHKERRQ(ierr);
635ffc955d6SMark F. Adams         }
636ffc955d6SMark F. Adams 
637f7df55f0SStefano Zampini         ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
638f7df55f0SStefano Zampini         ierr = MatSetOptionsPrefix(Prol11,prefix);CHKERRQ(ierr);
639c9567895SMark         ierr = PetscSNPrintf(addp,sizeof(addp),"pc_gamg_prolongator_%d_",(int)level);CHKERRQ(ierr);
640f7df55f0SStefano Zampini         ierr = MatAppendOptionsPrefix(Prol11,addp);CHKERRQ(ierr);
641*91f31d3dSStefano Zampini         /* Always generate the transpose with CUDA
642f7df55f0SStefano Zampini            Such behaviour can be adapted with -pc_gamg_prolongator_ prefixed options */
643f7df55f0SStefano Zampini #if defined(PETSC_HAVE_CUDA)
644f7df55f0SStefano Zampini         {
645f7df55f0SStefano Zampini           PetscBool ismpiaij;
646f7df55f0SStefano Zampini 
647f7df55f0SStefano Zampini           ierr = PetscObjectBaseTypeCompare((PetscObject)Prol11,MATMPIAIJ,&ismpiaij);CHKERRQ(ierr);
648f7df55f0SStefano Zampini           if (ismpiaij) {
649f7df55f0SStefano Zampini             Mat Prol_d,Prol_o;
650f7df55f0SStefano Zampini 
651f7df55f0SStefano Zampini             ierr = MatMPIAIJGetSeqAIJ(Prol11,&Prol_d,&Prol_o,NULL);CHKERRQ(ierr);
652*91f31d3dSStefano Zampini             ierr = MatSeqAIJCUSPARSESetGenerateTranspose(Prol_d,PETSC_TRUE);CHKERRQ(ierr);
653*91f31d3dSStefano Zampini             ierr = MatSeqAIJCUSPARSESetGenerateTranspose(Prol_o,PETSC_TRUE);CHKERRQ(ierr);
654f7df55f0SStefano Zampini           } else {
655*91f31d3dSStefano Zampini             ierr = MatSeqAIJCUSPARSESetGenerateTranspose(Prol11,PETSC_TRUE);CHKERRQ(ierr);
656f7df55f0SStefano Zampini           }
657f7df55f0SStefano Zampini         }
658f7df55f0SStefano Zampini #endif
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 #if defined PETSC_GAMG_USE_LOG
6670cbbd2e1SMark F. Adams     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET1],0,0,0,0);CHKERRQ(ierr);
668c8b0795cSMark F. Adams #endif
6697f66b68fSMark Adams     if (!level) Aarr[0] = Pmat; /* use Pmat for finest level setup */
670171cca9aSMark Adams     if (!Parr[level1]) { /* failed to coarsen */
671569f4572SMark Adams       ierr =  PetscInfo1(pc,"Stop gridding, level %D\n",level);CHKERRQ(ierr);
67262294041SBarry Smith #if defined PETSC_GAMG_USE_LOG && defined GAMG_STAGES
673a90e85d9SMark Adams       ierr = PetscLogStagePop();CHKERRQ(ierr);
674a90e85d9SMark Adams #endif
675c8b0795cSMark F. Adams       break;
676c8b0795cSMark F. Adams     }
6770cbbd2e1SMark F. Adams #if defined PETSC_GAMG_USE_LOG
6780cbbd2e1SMark F. Adams     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET2],0,0,0,0);CHKERRQ(ierr);
679b4fbaa2aSMark F. Adams #endif
680171cca9aSMark Adams     ierr = MatGetSize(Parr[level1], &M, &N);CHKERRQ(ierr); /* N is next M, a loop test variables */
681c9567895SMark     if (is_last) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Is last ?");
682171cca9aSMark Adams     if (N <= pc_gamg->coarse_eq_limit) is_last = PETSC_TRUE;
6830e2909e1SMark Adams     if (level1 == pc_gamg->Nlevels-1) is_last = PETSC_TRUE;
684171cca9aSMark Adams     ierr = pc_gamg->ops->createlevel(pc, Aarr[level], bs, &Parr[level1], &Aarr[level1], &nactivepe, NULL, is_last);CHKERRQ(ierr);
685a2f3521dSMark F. Adams 
6860cbbd2e1SMark F. Adams #if defined PETSC_GAMG_USE_LOG
6870cbbd2e1SMark F. Adams     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET2],0,0,0,0);CHKERRQ(ierr);
688b4fbaa2aSMark F. Adams #endif
689171cca9aSMark Adams     ierr = MatGetSize(Aarr[level1], &M, &N);CHKERRQ(ierr); /* M is loop test variables */
690569f4572SMark Adams     ierr = MatGetInfo(Aarr[level1], MAT_GLOBAL_SUM, &info);CHKERRQ(ierr);
691569f4572SMark Adams     nnztot += info.nz_used;
692c9567895SMark     ierr = PetscInfo5(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);
693569f4572SMark Adams 
6940cbbd2e1SMark F. Adams #if (defined PETSC_GAMG_USE_LOG && defined GAMG_STAGES)
695b4fbaa2aSMark F. Adams     ierr = PetscLogStagePop();CHKERRQ(ierr);
696b4fbaa2aSMark F. Adams #endif
697a90e85d9SMark Adams     /* stop if one node or one proc -- could pull back for singular problems */
6989ab59c8bSMark Adams     if ((pc_gamg->data_cell_cols && M/pc_gamg->data_cell_cols < 2) || (!pc_gamg->data_cell_cols && M/bs < 2)) {
6999ab59c8bSMark Adams       ierr =  PetscInfo2(pc,"HARD stop of coarsening on level %D.  Grid too small: %D block nodes\n",level,M/bs);CHKERRQ(ierr);
700a90e85d9SMark Adams       level++;
701a90e85d9SMark Adams       break;
702a90e85d9SMark Adams     }
703c8b0795cSMark F. Adams   } /* levels */
704c8b0795cSMark F. Adams   ierr = PetscFree(pc_gamg->data);CHKERRQ(ierr);
705c8b0795cSMark F. Adams 
706569f4572SMark Adams   ierr = PetscInfo2(pc,"%D levels, grid complexity = %g\n",level+1,nnztot/nnz0);CHKERRQ(ierr);
7079d5b6da9SMark F. Adams   pc_gamg->Nlevels = level + 1;
7085b89ad90SMark F. Adams   fine_level       = level;
7090298fd71SBarry Smith   ierr             = PCMGSetLevels(pc,pc_gamg->Nlevels,NULL);CHKERRQ(ierr);
7105b89ad90SMark F. Adams 
71162294041SBarry Smith   if (pc_gamg->Nlevels > 1) { /* don't setup MG if one level */
7120ed2132dSStefano Zampini     PetscErrorCode (*savesetfromoptions[PETSC_MG_MAXLEVELS])(PetscOptionItems*,KSP);
7130ed2132dSStefano Zampini 
714d5280255SMark F. Adams     /* set default smoothers & set operators */
71562294041SBarry Smith     for (lidx = 1, level = pc_gamg->Nlevels-2; lidx <= fine_level; lidx++, level--) {
716ffc955d6SMark F. Adams       KSP smoother;
717ffc955d6SMark F. Adams       PC  subpc;
718a2f3521dSMark F. Adams 
7199d5b6da9SMark F. Adams       ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
720f6536408SMark F. Adams       ierr = KSPGetPC(smoother, &subpc);CHKERRQ(ierr);
721ffc955d6SMark F. Adams 
722a2f3521dSMark F. Adams       ierr = KSPSetNormType(smoother, KSP_NORM_NONE);CHKERRQ(ierr);
723a2f3521dSMark F. Adams       /* set ops */
72423ee1639SBarry Smith       ierr = KSPSetOperators(smoother, Aarr[level], Aarr[level]);CHKERRQ(ierr);
725a2f3521dSMark F. Adams       ierr = PCMGSetInterpolation(pc, lidx, Parr[level+1]);CHKERRQ(ierr);
726a2f3521dSMark F. Adams 
727a2f3521dSMark F. Adams       /* set defaults */
7286c9de887SHong Zhang       ierr = KSPSetType(smoother, KSPCHEBYSHEV);CHKERRQ(ierr);
729a2f3521dSMark F. Adams 
7300c3bc534SBarry Smith       /* set blocks for ASM smoother that uses the 'aggregates' */
7310c3bc534SBarry Smith       if (pc_gamg->use_aggs_in_asm) {
7322d3561bbSSatish Balay         PetscInt sz;
7337a28f3e5SMark Adams         IS       *iss;
734a2f3521dSMark F. Adams 
7352d3561bbSSatish Balay         sz   = nASMBlocksArr[level];
7367a28f3e5SMark Adams         iss  = ASMLocalIDsArr[level];
7370c3bc534SBarry Smith         ierr = PCSetType(subpc, PCASM);CHKERRQ(ierr);
7380a3c815dSMark Adams         ierr = PCASMSetOverlap(subpc, 0);CHKERRQ(ierr);
7390c3bc534SBarry Smith         ierr = PCASMSetType(subpc,PC_ASM_BASIC);CHKERRQ(ierr);
7407f66b68fSMark Adams         if (!sz) {
741ffc955d6SMark F. Adams           IS       is;
7420a3c815dSMark Adams           ierr = ISCreateGeneral(PETSC_COMM_SELF, 0, NULL, PETSC_COPY_VALUES, &is);CHKERRQ(ierr);
7437a28f3e5SMark Adams           ierr = PCASMSetLocalSubdomains(subpc, 1, NULL, &is);CHKERRQ(ierr);
744a94c3b12SMark F. Adams           ierr = ISDestroy(&is);CHKERRQ(ierr);
745806fa848SBarry Smith         } else {
746a94c3b12SMark F. Adams           PetscInt kk;
7477a28f3e5SMark Adams           ierr = PCASMSetLocalSubdomains(subpc, sz, NULL, iss);CHKERRQ(ierr);
748a94c3b12SMark F. Adams           for (kk=0; kk<sz; kk++) {
7497a28f3e5SMark Adams             ierr = ISDestroy(&iss[kk]);CHKERRQ(ierr);
750a94c3b12SMark F. Adams           }
7517a28f3e5SMark Adams           ierr = PetscFree(iss);CHKERRQ(ierr);
752ffc955d6SMark F. Adams         }
7530298fd71SBarry Smith         ASMLocalIDsArr[level] = NULL;
754ffc955d6SMark F. Adams         nASMBlocksArr[level]  = 0;
755806fa848SBarry Smith       } else {
756890ffe84SMark Adams         ierr = PCSetType(subpc, PCSOR);CHKERRQ(ierr);
757ffc955d6SMark F. Adams       }
758d5280255SMark F. Adams     }
759d5280255SMark F. Adams     {
760d5280255SMark F. Adams       /* coarse grid */
761d5280255SMark F. Adams       KSP smoother,*k2; PC subpc,pc2; PetscInt ii,first;
762d5280255SMark F. Adams       Mat Lmat = Aarr[(level=pc_gamg->Nlevels-1)]; lidx = 0;
7630ed2132dSStefano Zampini 
764d5280255SMark F. Adams       ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
76523ee1639SBarry Smith       ierr = KSPSetOperators(smoother, Lmat, Lmat);CHKERRQ(ierr);
766cf8ae1d3SMark Adams       if (!pc_gamg->use_parallel_coarse_grid_solver) {
767d5280255SMark F. Adams         ierr = KSPSetNormType(smoother, KSP_NORM_NONE);CHKERRQ(ierr);
768d5280255SMark F. Adams         ierr = KSPGetPC(smoother, &subpc);CHKERRQ(ierr);
769d5280255SMark F. Adams         ierr = PCSetType(subpc, PCBJACOBI);CHKERRQ(ierr);
770d5280255SMark F. Adams         ierr = PCSetUp(subpc);CHKERRQ(ierr);
77171959b99SBarry Smith         ierr = PCBJacobiGetSubKSP(subpc,&ii,&first,&k2);CHKERRQ(ierr);
77271959b99SBarry Smith         if (ii != 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"ii %D is not one",ii);
773d5280255SMark F. Adams         ierr = KSPGetPC(k2[0],&pc2);CHKERRQ(ierr);
774d5280255SMark F. Adams         ierr = PCSetType(pc2, PCLU);CHKERRQ(ierr);
7759dbfc187SHong Zhang         ierr = PCFactorSetShiftType(pc2,MAT_SHIFT_INBLOCKS);CHKERRQ(ierr);
7762fb0b348SMark F. Adams         ierr = KSPSetTolerances(k2[0],PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT,1);CHKERRQ(ierr);
77708e36f19SMark Adams         ierr = KSPSetType(k2[0], KSPPREONLY);CHKERRQ(ierr);
7785b42dca8SJed Brown         /* This flag gets reset by PCBJacobiGetSubKSP(), but our BJacobi really does the same algorithm everywhere (and in
7795b42dca8SJed Brown          * fact, all but one process will have zero dofs), so we reset the flag to avoid having PCView_BJacobi attempt to
7805b42dca8SJed Brown          * view every subdomain as though they were different. */
7815b42dca8SJed Brown         ((PC_BJacobi*)subpc->data)->same_local_solves = PETSC_TRUE;
782d5280255SMark F. Adams       }
783cf8ae1d3SMark Adams     }
784d5280255SMark F. Adams 
785d5280255SMark F. Adams     /* should be called in PCSetFromOptions_GAMG(), but cannot be called prior to PCMGSetLevels() */
786d5280255SMark F. Adams     ierr = PetscObjectOptionsBegin((PetscObject)pc);CHKERRQ(ierr);
787e55864a3SBarry Smith     ierr = PCSetFromOptions_MG(PetscOptionsObject,pc);CHKERRQ(ierr);
788d5280255SMark F. Adams     ierr = PetscOptionsEnd();CHKERRQ(ierr);
78969aca0b8SBarry Smith     ierr = PCMGSetGalerkin(pc,PC_MG_GALERKIN_EXTERNAL);CHKERRQ(ierr);
790d5280255SMark F. Adams 
79118c3aa7eSMark     /* setup cheby eigen estimates from SA */
7920ed2132dSStefano Zampini     if (pc_gamg->use_sa_esteig==1) {
79318c3aa7eSMark       for (lidx = 1, level = pc_gamg->Nlevels-2; level >= 0 ; lidx++, level--) {
79418c3aa7eSMark         KSP       smoother;
79518c3aa7eSMark         PetscBool ischeb;
7960ed2132dSStefano Zampini 
7970ed2132dSStefano Zampini         savesetfromoptions[level] = NULL;
79818c3aa7eSMark         ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
79918c3aa7eSMark         ierr = PetscObjectTypeCompare((PetscObject)smoother,KSPCHEBYSHEV,&ischeb);CHKERRQ(ierr);
80018c3aa7eSMark         if (ischeb) {
80118c3aa7eSMark           KSP_Chebyshev *cheb = (KSP_Chebyshev*)smoother->data;
8020ed2132dSStefano Zampini 
8030ed2132dSStefano Zampini           ierr = KSPSetFromOptions(smoother);CHKERRQ(ierr); /* let command line emax override using SA's eigenvalues */
8040ed2132dSStefano Zampini           if (mg->max_eigen_DinvA[level] > 0 && cheb->emax == 0.) {
80518c3aa7eSMark             PC        subpc;
80618c3aa7eSMark             PetscBool isjac;
80718c3aa7eSMark             ierr = KSPGetPC(smoother, &subpc);CHKERRQ(ierr);
80818c3aa7eSMark             ierr = PetscObjectTypeCompare((PetscObject)subpc,PCJACOBI,&isjac);CHKERRQ(ierr);
8090ed2132dSStefano Zampini             if (isjac && pc_gamg->use_sa_esteig==1) {
81018c3aa7eSMark               PetscReal emax,emin;
8110ed2132dSStefano Zampini 
81218c3aa7eSMark               emin = mg->min_eigen_DinvA[level];
81318c3aa7eSMark               emax = mg->max_eigen_DinvA[level];
81418c3aa7eSMark               ierr = PetscInfo4(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);
81518c3aa7eSMark               cheb->emin_computed = emin;
81618c3aa7eSMark               cheb->emax_computed = emax;
81718c3aa7eSMark               ierr = KSPChebyshevSetEigenvalues(smoother, cheb->tform[2]*emin + cheb->tform[3]*emax, cheb->tform[0]*emin + cheb->tform[1]*emax);CHKERRQ(ierr);
8180ed2132dSStefano Zampini 
8190ed2132dSStefano Zampini               /* We have set the eigenvalues and consumed the transformation values
8200ed2132dSStefano Zampini                  prevent from flagging the recomputation of the eigenvalues again in PCSetUp_MG
8210ed2132dSStefano Zampini                  below when setfromoptions will be called again */
8220ed2132dSStefano Zampini               savesetfromoptions[level] = smoother->ops->setfromoptions;
8230ed2132dSStefano Zampini               smoother->ops->setfromoptions = NULL;
82418c3aa7eSMark             }
82518c3aa7eSMark           }
82618c3aa7eSMark         }
82718c3aa7eSMark       }
8280ed2132dSStefano Zampini     }
8290ed2132dSStefano Zampini 
8300ed2132dSStefano Zampini     ierr = PCSetUp_MG(pc);CHKERRQ(ierr);
8310ed2132dSStefano Zampini 
8320ed2132dSStefano Zampini     /* restore Chebyshev smoother for next calls */
8330ed2132dSStefano Zampini     if (pc_gamg->use_sa_esteig==1) {
8340ed2132dSStefano Zampini       for (lidx = 1, level = pc_gamg->Nlevels-2; level >= 0 ; lidx++, level--) {
8350ed2132dSStefano Zampini         if (savesetfromoptions[level]) {
8360ed2132dSStefano Zampini           KSP smoother;
8370ed2132dSStefano Zampini           ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
8380ed2132dSStefano Zampini           smoother->ops->setfromoptions = savesetfromoptions[level];
8390ed2132dSStefano Zampini         }
8400ed2132dSStefano Zampini       }
8410ed2132dSStefano Zampini     }
84218c3aa7eSMark 
843d5280255SMark F. Adams     /* clean up */
844d5280255SMark F. Adams     for (level=1; level<pc_gamg->Nlevels; level++) {
845587fa25dSMark F. Adams       ierr = MatDestroy(&Parr[level]);CHKERRQ(ierr);
846587fa25dSMark F. Adams       ierr = MatDestroy(&Aarr[level]);CHKERRQ(ierr);
8475b89ad90SMark F. Adams     }
848806fa848SBarry Smith   } else {
8495f8cf99dSMark F. Adams     KSP smoother;
8500ed2132dSStefano Zampini 
851302440fdSBarry Smith     ierr = PetscInfo(pc,"One level solver used (system is seen as DD). Using default solver.\n");CHKERRQ(ierr);
8529d5b6da9SMark F. Adams     ierr = PCMGGetSmoother(pc, 0, &smoother);CHKERRQ(ierr);
85323ee1639SBarry Smith     ierr = KSPSetOperators(smoother, Aarr[0], Aarr[0]);CHKERRQ(ierr);
8545f8cf99dSMark F. Adams     ierr = KSPSetType(smoother, KSPPREONLY);CHKERRQ(ierr);
8559d5b6da9SMark F. Adams     ierr = PCSetUp_MG(pc);CHKERRQ(ierr);
8565f8cf99dSMark F. Adams   }
8575b89ad90SMark F. Adams   PetscFunctionReturn(0);
8585b89ad90SMark F. Adams }
8595b89ad90SMark F. Adams 
860eb07cef2SMark F. Adams /* ------------------------------------------------------------------------- */
8615b89ad90SMark F. Adams /*
8625b89ad90SMark F. Adams  PCDestroy_GAMG - Destroys the private context for the GAMG preconditioner
8635b89ad90SMark F. Adams    that was created with PCCreate_GAMG().
8645b89ad90SMark F. Adams 
8655b89ad90SMark F. Adams    Input Parameter:
8665b89ad90SMark F. Adams .  pc - the preconditioner context
8675b89ad90SMark F. Adams 
8685b89ad90SMark F. Adams    Application Interface Routine: PCDestroy()
8695b89ad90SMark F. Adams */
8705b89ad90SMark F. Adams PetscErrorCode PCDestroy_GAMG(PC pc)
8715b89ad90SMark F. Adams {
8725b89ad90SMark F. Adams   PetscErrorCode ierr;
8735b89ad90SMark F. Adams   PC_MG          *mg     = (PC_MG*)pc->data;
8745b89ad90SMark F. Adams   PC_GAMG        *pc_gamg= (PC_GAMG*)mg->innerctx;
8755b89ad90SMark F. Adams 
8765b89ad90SMark F. Adams   PetscFunctionBegin;
8775b89ad90SMark F. Adams   ierr = PCReset_GAMG(pc);CHKERRQ(ierr);
8789b8ffb57SJed Brown   if (pc_gamg->ops->destroy) {
8799b8ffb57SJed Brown     ierr = (*pc_gamg->ops->destroy)(pc);CHKERRQ(ierr);
8809b8ffb57SJed Brown   }
8811ab5ffc9SJed Brown   ierr = PetscFree(pc_gamg->ops);CHKERRQ(ierr);
8821ab5ffc9SJed Brown   ierr = PetscFree(pc_gamg->gamg_type_name);CHKERRQ(ierr);
8835b89ad90SMark F. Adams   ierr = PetscFree(pc_gamg);CHKERRQ(ierr);
8845b89ad90SMark F. Adams   ierr = PCDestroy_MG(pc);CHKERRQ(ierr);
8855b89ad90SMark F. Adams   PetscFunctionReturn(0);
8865b89ad90SMark F. Adams }
8875b89ad90SMark F. Adams 
888676e1743SMark F. Adams /*@
889cab9ed1eSBarry Smith    PCGAMGSetProcEqLim - Set number of equations to aim for per process on the coarse grids via processor reduction.
890676e1743SMark F. Adams 
8911cc46a46SBarry Smith    Logically Collective on PC
892676e1743SMark F. Adams 
893676e1743SMark F. Adams    Input Parameters:
8941cc46a46SBarry Smith +  pc - the preconditioner context
8951cc46a46SBarry Smith -  n - the number of equations
896676e1743SMark F. Adams 
897676e1743SMark F. Adams 
898676e1743SMark F. Adams    Options Database Key:
8991cc46a46SBarry Smith .  -pc_gamg_process_eq_limit <limit>
900676e1743SMark F. Adams 
90195452b02SPatrick Sanan    Notes:
90295452b02SPatrick 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
903cab9ed1eSBarry Smith           that has degrees of freedom
904cab9ed1eSBarry Smith 
905676e1743SMark F. Adams    Level: intermediate
906676e1743SMark F. Adams 
907c9567895SMark .seealso: PCGAMGSetCoarseEqLim(), PCGAMGSetRankReductionFactors()
908676e1743SMark F. Adams @*/
909676e1743SMark F. Adams PetscErrorCode  PCGAMGSetProcEqLim(PC pc, PetscInt n)
910676e1743SMark F. Adams {
911676e1743SMark F. Adams   PetscErrorCode ierr;
912676e1743SMark F. Adams 
913676e1743SMark F. Adams   PetscFunctionBegin;
914676e1743SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
915676e1743SMark F. Adams   ierr = PetscTryMethod(pc,"PCGAMGSetProcEqLim_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
916676e1743SMark F. Adams   PetscFunctionReturn(0);
917676e1743SMark F. Adams }
918676e1743SMark F. Adams 
9191e6b0712SBarry Smith static PetscErrorCode PCGAMGSetProcEqLim_GAMG(PC pc, PetscInt n)
920676e1743SMark F. Adams {
921c20e4228SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
922c20e4228SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
923676e1743SMark F. Adams 
924676e1743SMark F. Adams   PetscFunctionBegin;
9259d5b6da9SMark F. Adams   if (n>0) pc_gamg->min_eq_proc = n;
926676e1743SMark F. Adams   PetscFunctionReturn(0);
927676e1743SMark F. Adams }
928676e1743SMark F. Adams 
929389730f3SMark F. Adams /*@
930cab9ed1eSBarry Smith    PCGAMGSetCoarseEqLim - Set maximum number of equations on coarsest grid.
931389730f3SMark F. Adams 
932389730f3SMark F. Adams  Collective on PC
933389730f3SMark F. Adams 
934389730f3SMark F. Adams    Input Parameters:
9351cc46a46SBarry Smith +  pc - the preconditioner context
9361cc46a46SBarry Smith -  n - maximum number of equations to aim for
937389730f3SMark F. Adams 
938389730f3SMark F. Adams    Options Database Key:
9391cc46a46SBarry Smith .  -pc_gamg_coarse_eq_limit <limit>
940389730f3SMark F. Adams 
94174329af1SBarry Smith    Notes: For example -pc_gamg_coarse_eq_limit 1000 will stop coarsening once the coarse grid
94274329af1SBarry Smith      has less than 1000 unknowns.
94374329af1SBarry Smith 
944389730f3SMark F. Adams    Level: intermediate
945389730f3SMark F. Adams 
946c9567895SMark .seealso: PCGAMGSetProcEqLim(), PCGAMGSetRankReductionFactors()
947389730f3SMark F. Adams @*/
948389730f3SMark F. Adams PetscErrorCode PCGAMGSetCoarseEqLim(PC pc, PetscInt n)
949389730f3SMark F. Adams {
950389730f3SMark F. Adams   PetscErrorCode ierr;
951389730f3SMark F. Adams 
952389730f3SMark F. Adams   PetscFunctionBegin;
953389730f3SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
954389730f3SMark F. Adams   ierr = PetscTryMethod(pc,"PCGAMGSetCoarseEqLim_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
955389730f3SMark F. Adams   PetscFunctionReturn(0);
956389730f3SMark F. Adams }
957389730f3SMark F. Adams 
9581e6b0712SBarry Smith static PetscErrorCode PCGAMGSetCoarseEqLim_GAMG(PC pc, PetscInt n)
959389730f3SMark F. Adams {
960389730f3SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
961389730f3SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
962389730f3SMark F. Adams 
963389730f3SMark F. Adams   PetscFunctionBegin;
9649d5b6da9SMark F. Adams   if (n>0) pc_gamg->coarse_eq_limit = n;
965389730f3SMark F. Adams   PetscFunctionReturn(0);
966389730f3SMark F. Adams }
967389730f3SMark F. Adams 
968676e1743SMark F. Adams /*@
969cab9ed1eSBarry Smith    PCGAMGSetRepartition - Repartition the degrees of freedom across the processors on the coarser grids
970676e1743SMark F. Adams 
971676e1743SMark F. Adams    Collective on PC
972676e1743SMark F. Adams 
973676e1743SMark F. Adams    Input Parameters:
9741cc46a46SBarry Smith +  pc - the preconditioner context
9751cc46a46SBarry Smith -  n - PETSC_TRUE or PETSC_FALSE
976676e1743SMark F. Adams 
977676e1743SMark F. Adams    Options Database Key:
9781cc46a46SBarry Smith .  -pc_gamg_repartition <true,false>
979676e1743SMark F. Adams 
98095452b02SPatrick Sanan    Notes:
98195452b02SPatrick Sanan     this will generally improve the loading balancing of the work on each level
982cab9ed1eSBarry Smith 
983676e1743SMark F. Adams    Level: intermediate
984676e1743SMark F. Adams 
985676e1743SMark F. Adams .seealso: ()
986676e1743SMark F. Adams @*/
987cab9ed1eSBarry Smith PetscErrorCode PCGAMGSetRepartition(PC pc, PetscBool n)
988676e1743SMark F. Adams {
989676e1743SMark F. Adams   PetscErrorCode ierr;
990676e1743SMark F. Adams 
991676e1743SMark F. Adams   PetscFunctionBegin;
992676e1743SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
993cab9ed1eSBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGSetRepartition_C",(PC,PetscBool),(pc,n));CHKERRQ(ierr);
994676e1743SMark F. Adams   PetscFunctionReturn(0);
995676e1743SMark F. Adams }
996676e1743SMark F. Adams 
997cab9ed1eSBarry Smith static PetscErrorCode PCGAMGSetRepartition_GAMG(PC pc, PetscBool n)
998676e1743SMark F. Adams {
999c20e4228SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1000c20e4228SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1001676e1743SMark F. Adams 
1002676e1743SMark F. Adams   PetscFunctionBegin;
10039d5b6da9SMark F. Adams   pc_gamg->repart = n;
1004676e1743SMark F. Adams   PetscFunctionReturn(0);
1005676e1743SMark F. Adams }
1006676e1743SMark F. Adams 
1007dfd5c07aSMark F. Adams /*@
100818c3aa7eSMark    PCGAMGSetEstEigKSPMaxIt - Set number of KSP iterations in eigen estimator (for Cheby)
100918c3aa7eSMark 
101018c3aa7eSMark    Collective on PC
101118c3aa7eSMark 
101218c3aa7eSMark    Input Parameters:
101318c3aa7eSMark +  pc - the preconditioner context
101418c3aa7eSMark -  n - number of its
101518c3aa7eSMark 
101618c3aa7eSMark    Options Database Key:
101718c3aa7eSMark .  -pc_gamg_esteig_ksp_max_it <its>
101818c3aa7eSMark 
101918c3aa7eSMark    Notes:
102018c3aa7eSMark 
102118c3aa7eSMark    Level: intermediate
102218c3aa7eSMark 
102318c3aa7eSMark .seealso: ()
102418c3aa7eSMark @*/
102518c3aa7eSMark PetscErrorCode PCGAMGSetEstEigKSPMaxIt(PC pc, PetscInt n)
102618c3aa7eSMark {
102718c3aa7eSMark   PetscErrorCode ierr;
102818c3aa7eSMark 
102918c3aa7eSMark   PetscFunctionBegin;
103018c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
103118c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetEstEigKSPMaxIt_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
103218c3aa7eSMark   PetscFunctionReturn(0);
103318c3aa7eSMark }
103418c3aa7eSMark 
103518c3aa7eSMark static PetscErrorCode PCGAMGSetEstEigKSPMaxIt_GAMG(PC pc, PetscInt n)
103618c3aa7eSMark {
103718c3aa7eSMark   PC_MG   *mg      = (PC_MG*)pc->data;
103818c3aa7eSMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
103918c3aa7eSMark 
104018c3aa7eSMark   PetscFunctionBegin;
104118c3aa7eSMark   pc_gamg->esteig_max_it = n;
104218c3aa7eSMark   PetscFunctionReturn(0);
104318c3aa7eSMark }
104418c3aa7eSMark 
104518c3aa7eSMark /*@
104618c3aa7eSMark    PCGAMGSetUseSAEstEig - Use eigen estimate from smoothed aggregation for Cheby smoother
104718c3aa7eSMark 
104818c3aa7eSMark    Collective on PC
104918c3aa7eSMark 
105018c3aa7eSMark    Input Parameters:
105118c3aa7eSMark +  pc - the preconditioner context
105218c3aa7eSMark -  n - number of its
105318c3aa7eSMark 
105418c3aa7eSMark    Options Database Key:
105518c3aa7eSMark .  -pc_gamg_use_sa_esteig <true,false>
105618c3aa7eSMark 
105718c3aa7eSMark    Notes:
105818c3aa7eSMark 
105918c3aa7eSMark    Level: intermediate
106018c3aa7eSMark 
106118c3aa7eSMark .seealso: ()
106218c3aa7eSMark @*/
106318c3aa7eSMark PetscErrorCode PCGAMGSetUseSAEstEig(PC pc, PetscBool n)
106418c3aa7eSMark {
106518c3aa7eSMark   PetscErrorCode ierr;
106618c3aa7eSMark 
106718c3aa7eSMark   PetscFunctionBegin;
106818c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
106918c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetUseSAEstEig_C",(PC,PetscBool),(pc,n));CHKERRQ(ierr);
107018c3aa7eSMark   PetscFunctionReturn(0);
107118c3aa7eSMark }
107218c3aa7eSMark 
10730ed2132dSStefano Zampini static PetscErrorCode PCGAMGSetUseSAEstEig_GAMG(PC pc, PetscBool n)
107418c3aa7eSMark {
107518c3aa7eSMark   PC_MG   *mg      = (PC_MG*)pc->data;
107618c3aa7eSMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
107718c3aa7eSMark 
107818c3aa7eSMark   PetscFunctionBegin;
107918c3aa7eSMark   pc_gamg->use_sa_esteig = n ? 1 : 0;
108018c3aa7eSMark   PetscFunctionReturn(0);
108118c3aa7eSMark }
108218c3aa7eSMark 
108318c3aa7eSMark /*@C
108418c3aa7eSMark    PCGAMGSetEstEigKSPType - Set type of KSP in eigen estimator (for Cheby)
108518c3aa7eSMark 
108618c3aa7eSMark    Collective on PC
108718c3aa7eSMark 
108818c3aa7eSMark    Input Parameters:
108918c3aa7eSMark +  pc - the preconditioner context
109018c3aa7eSMark -  t - ksp type
109118c3aa7eSMark 
109218c3aa7eSMark    Options Database Key:
109318c3aa7eSMark .  -pc_gamg_esteig_ksp_type <type>
109418c3aa7eSMark 
109518c3aa7eSMark    Notes:
109618c3aa7eSMark 
109718c3aa7eSMark    Level: intermediate
109818c3aa7eSMark 
109918c3aa7eSMark .seealso: ()
110018c3aa7eSMark @*/
110118c3aa7eSMark PetscErrorCode PCGAMGSetEstEigKSPType(PC pc, char t[])
110218c3aa7eSMark {
110318c3aa7eSMark   PetscErrorCode ierr;
110418c3aa7eSMark 
110518c3aa7eSMark   PetscFunctionBegin;
110618c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
110718c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetEstEigKSPType_C",(PC,char[]),(pc,t));CHKERRQ(ierr);
110818c3aa7eSMark   PetscFunctionReturn(0);
110918c3aa7eSMark }
111018c3aa7eSMark 
111118c3aa7eSMark static PetscErrorCode PCGAMGSetEstEigKSPType_GAMG(PC pc, char t[])
111218c3aa7eSMark {
111318c3aa7eSMark   PetscErrorCode ierr;
111418c3aa7eSMark   PC_MG   *mg      = (PC_MG*)pc->data;
111518c3aa7eSMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
111618c3aa7eSMark 
111718c3aa7eSMark   PetscFunctionBegin;
111818c3aa7eSMark   ierr = PetscStrcpy(pc_gamg->esteig_type,t);CHKERRQ(ierr);
111918c3aa7eSMark   PetscFunctionReturn(0);
112018c3aa7eSMark }
112118c3aa7eSMark 
112218c3aa7eSMark /*@
112318c3aa7eSMark    PCGAMGSetEigenvalues - Set eigenvalues
112418c3aa7eSMark 
112518c3aa7eSMark    Collective on PC
112618c3aa7eSMark 
112718c3aa7eSMark    Input Parameters:
112818c3aa7eSMark +  pc - the preconditioner context
112918c3aa7eSMark -  emax - max eigenvalue
113018c3aa7eSMark .  emin - min eigenvalue
113118c3aa7eSMark 
113218c3aa7eSMark    Options Database Key:
113318c3aa7eSMark .  -pc_gamg_eigenvalues
113418c3aa7eSMark 
113518c3aa7eSMark    Level: intermediate
113618c3aa7eSMark 
113718c3aa7eSMark .seealso: PCGAMGSetEstEigKSPMaxIt(), PCGAMGSetUseSAEstEig(), PCGAMGSetEstEigKSPType()
113818c3aa7eSMark @*/
113918c3aa7eSMark PetscErrorCode PCGAMGSetEigenvalues(PC pc, PetscReal emax,PetscReal emin)
114018c3aa7eSMark {
114118c3aa7eSMark   PetscErrorCode ierr;
114218c3aa7eSMark 
114318c3aa7eSMark   PetscFunctionBegin;
114418c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
114518c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetEigenvalues_C",(PC,PetscReal,PetscReal),(pc,emax,emin));CHKERRQ(ierr);
114618c3aa7eSMark   PetscFunctionReturn(0);
114718c3aa7eSMark }
114818c3aa7eSMark static PetscErrorCode PCGAMGSetEigenvalues_GAMG(PC pc,PetscReal emax,PetscReal emin)
114918c3aa7eSMark {
115018c3aa7eSMark   PC_MG          *mg      = (PC_MG*)pc->data;
115118c3aa7eSMark   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
115218c3aa7eSMark 
115318c3aa7eSMark   PetscFunctionBegin;
115418c3aa7eSMark   if (emax <= emin) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"Maximum eigenvalue must be larger than minimum: max %g min %g",(double)emax,(double)emin);
115518c3aa7eSMark   if (emax*emin <= 0.0) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"Both eigenvalues must be of the same sign: max %g min %g",(double)emax,(double)emin);
115618c3aa7eSMark   pc_gamg->emax = emax;
115718c3aa7eSMark   pc_gamg->emin = emin;
115818c3aa7eSMark 
115918c3aa7eSMark   PetscFunctionReturn(0);
116018c3aa7eSMark }
116118c3aa7eSMark 
116218c3aa7eSMark /*@
1163cab9ed1eSBarry Smith    PCGAMGSetReuseInterpolation - Reuse prolongation when rebuilding algebraic multigrid preconditioner
1164dfd5c07aSMark F. Adams 
1165dfd5c07aSMark F. Adams    Collective on PC
1166dfd5c07aSMark F. Adams 
1167dfd5c07aSMark F. Adams    Input Parameters:
11681cc46a46SBarry Smith +  pc - the preconditioner context
11691cc46a46SBarry Smith -  n - PETSC_TRUE or PETSC_FALSE
1170dfd5c07aSMark F. Adams 
1171dfd5c07aSMark F. Adams    Options Database Key:
11721cc46a46SBarry Smith .  -pc_gamg_reuse_interpolation <true,false>
1173dfd5c07aSMark F. Adams 
1174dfd5c07aSMark F. Adams    Level: intermediate
1175dfd5c07aSMark F. Adams 
117695452b02SPatrick Sanan    Notes:
117795452b02SPatrick Sanan     this may negatively affect the convergence rate of the method on new matrices if the matrix entries change a great deal, but allows
1178cab9ed1eSBarry Smith           rebuilding the preconditioner quicker.
1179cab9ed1eSBarry Smith 
1180dfd5c07aSMark F. Adams .seealso: ()
1181dfd5c07aSMark F. Adams @*/
11821cc46a46SBarry Smith PetscErrorCode PCGAMGSetReuseInterpolation(PC pc, PetscBool n)
1183dfd5c07aSMark F. Adams {
1184dfd5c07aSMark F. Adams   PetscErrorCode ierr;
1185dfd5c07aSMark F. Adams 
1186dfd5c07aSMark F. Adams   PetscFunctionBegin;
1187dfd5c07aSMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
11881cc46a46SBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGSetReuseInterpolation_C",(PC,PetscBool),(pc,n));CHKERRQ(ierr);
1189dfd5c07aSMark F. Adams   PetscFunctionReturn(0);
1190dfd5c07aSMark F. Adams }
1191dfd5c07aSMark F. Adams 
11921cc46a46SBarry Smith static PetscErrorCode PCGAMGSetReuseInterpolation_GAMG(PC pc, PetscBool n)
1193dfd5c07aSMark F. Adams {
1194dfd5c07aSMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1195dfd5c07aSMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1196dfd5c07aSMark F. Adams 
1197dfd5c07aSMark F. Adams   PetscFunctionBegin;
1198dfd5c07aSMark F. Adams   pc_gamg->reuse_prol = n;
1199dfd5c07aSMark F. Adams   PetscFunctionReturn(0);
1200dfd5c07aSMark F. Adams }
1201dfd5c07aSMark F. Adams 
1202ffc955d6SMark F. Adams /*@
1203cab9ed1eSBarry 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.
1204ffc955d6SMark F. Adams 
1205ffc955d6SMark F. Adams    Collective on PC
1206ffc955d6SMark F. Adams 
1207ffc955d6SMark F. Adams    Input Parameters:
1208cab9ed1eSBarry Smith +  pc - the preconditioner context
1209cab9ed1eSBarry Smith -  flg - PETSC_TRUE to use aggregates, PETSC_FALSE to not
1210ffc955d6SMark F. Adams 
1211ffc955d6SMark F. Adams    Options Database Key:
1212cab9ed1eSBarry Smith .  -pc_gamg_asm_use_agg
1213ffc955d6SMark F. Adams 
1214ffc955d6SMark F. Adams    Level: intermediate
1215ffc955d6SMark F. Adams 
1216ffc955d6SMark F. Adams .seealso: ()
1217ffc955d6SMark F. Adams @*/
1218cab9ed1eSBarry Smith PetscErrorCode PCGAMGASMSetUseAggs(PC pc, PetscBool flg)
1219ffc955d6SMark F. Adams {
1220ffc955d6SMark F. Adams   PetscErrorCode ierr;
1221ffc955d6SMark F. Adams 
1222ffc955d6SMark F. Adams   PetscFunctionBegin;
1223ffc955d6SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1224cab9ed1eSBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGASMSetUseAggs_C",(PC,PetscBool),(pc,flg));CHKERRQ(ierr);
1225ffc955d6SMark F. Adams   PetscFunctionReturn(0);
1226ffc955d6SMark F. Adams }
1227ffc955d6SMark F. Adams 
1228cab9ed1eSBarry Smith static PetscErrorCode PCGAMGASMSetUseAggs_GAMG(PC pc, PetscBool flg)
1229ffc955d6SMark F. Adams {
1230ffc955d6SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1231ffc955d6SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1232ffc955d6SMark F. Adams 
1233ffc955d6SMark F. Adams   PetscFunctionBegin;
1234cab9ed1eSBarry Smith   pc_gamg->use_aggs_in_asm = flg;
1235ffc955d6SMark F. Adams   PetscFunctionReturn(0);
1236ffc955d6SMark F. Adams }
1237ffc955d6SMark F. Adams 
1238171cca9aSMark Adams /*@
1239cf8ae1d3SMark Adams    PCGAMGSetUseParallelCoarseGridSolve - allow a parallel coarse grid solver
1240171cca9aSMark Adams 
1241171cca9aSMark Adams    Collective on PC
1242171cca9aSMark Adams 
1243171cca9aSMark Adams    Input Parameters:
1244171cca9aSMark Adams +  pc - the preconditioner context
1245cf8ae1d3SMark Adams -  flg - PETSC_TRUE to not force coarse grid onto one processor
1246171cca9aSMark Adams 
1247171cca9aSMark Adams    Options Database Key:
1248cf8ae1d3SMark Adams .  -pc_gamg_use_parallel_coarse_grid_solver
1249171cca9aSMark Adams 
1250171cca9aSMark Adams    Level: intermediate
1251171cca9aSMark Adams 
125239d09545SMark Adams .seealso: PCGAMGSetCoarseGridLayoutType(), PCGAMGSetCpuPinCoarseGrids()
1253171cca9aSMark Adams @*/
1254171cca9aSMark Adams PetscErrorCode PCGAMGSetUseParallelCoarseGridSolve(PC pc, PetscBool flg)
1255171cca9aSMark Adams {
1256171cca9aSMark Adams   PetscErrorCode ierr;
1257171cca9aSMark Adams 
1258171cca9aSMark Adams   PetscFunctionBegin;
1259171cca9aSMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1260171cca9aSMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetUseParallelCoarseGridSolve_C",(PC,PetscBool),(pc,flg));CHKERRQ(ierr);
1261171cca9aSMark Adams   PetscFunctionReturn(0);
1262171cca9aSMark Adams }
1263171cca9aSMark Adams 
1264171cca9aSMark Adams static PetscErrorCode PCGAMGSetUseParallelCoarseGridSolve_GAMG(PC pc, PetscBool flg)
1265171cca9aSMark Adams {
1266171cca9aSMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1267171cca9aSMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1268171cca9aSMark Adams 
1269171cca9aSMark Adams   PetscFunctionBegin;
1270171cca9aSMark Adams   pc_gamg->use_parallel_coarse_grid_solver = flg;
1271ffc955d6SMark F. Adams   PetscFunctionReturn(0);
1272ffc955d6SMark F. Adams }
1273ffc955d6SMark F. Adams 
12744ef23d27SMark F. Adams /*@
1275ce7c7f2fSMark Adams    PCGAMGSetCpuPinCoarseGrids - pin reduced grids to CPU
1276ce7c7f2fSMark Adams 
1277ce7c7f2fSMark Adams    Collective on PC
1278ce7c7f2fSMark Adams 
1279ce7c7f2fSMark Adams    Input Parameters:
1280ce7c7f2fSMark Adams +  pc - the preconditioner context
1281ce7c7f2fSMark Adams -  flg - PETSC_TRUE to pin coarse grids to CPU
1282ce7c7f2fSMark Adams 
1283ce7c7f2fSMark Adams    Options Database Key:
1284ce7c7f2fSMark Adams .  -pc_gamg_cpu_pin_coarse_grids
1285ce7c7f2fSMark Adams 
1286ce7c7f2fSMark Adams    Level: intermediate
1287ce7c7f2fSMark Adams 
128839d09545SMark Adams .seealso: PCGAMGSetCoarseGridLayoutType(), PCGAMGSetUseParallelCoarseGridSolve()
1289ce7c7f2fSMark Adams @*/
1290ce7c7f2fSMark Adams PetscErrorCode PCGAMGSetCpuPinCoarseGrids(PC pc, PetscBool flg)
1291ce7c7f2fSMark Adams {
1292ce7c7f2fSMark Adams   PetscErrorCode ierr;
1293ce7c7f2fSMark Adams 
1294ce7c7f2fSMark Adams   PetscFunctionBegin;
1295ce7c7f2fSMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1296ce7c7f2fSMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetCpuPinCoarseGrids_C",(PC,PetscBool),(pc,flg));CHKERRQ(ierr);
1297ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1298ce7c7f2fSMark Adams }
1299ce7c7f2fSMark Adams 
1300ce7c7f2fSMark Adams static PetscErrorCode PCGAMGSetCpuPinCoarseGrids_GAMG(PC pc, PetscBool flg)
1301ce7c7f2fSMark Adams {
1302ce7c7f2fSMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1303ce7c7f2fSMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1304ce7c7f2fSMark Adams 
1305ce7c7f2fSMark Adams   PetscFunctionBegin;
1306ce7c7f2fSMark Adams   pc_gamg->cpu_pin_coarse_grids = flg;
1307ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1308ce7c7f2fSMark Adams }
1309ce7c7f2fSMark Adams 
1310ce7c7f2fSMark Adams /*@
1311ce7c7f2fSMark Adams    PCGAMGSetCoarseGridLayoutType - place reduce grids on processors with natural order (compact type)
1312ce7c7f2fSMark Adams 
1313ce7c7f2fSMark Adams    Collective on PC
1314ce7c7f2fSMark Adams 
1315ce7c7f2fSMark Adams    Input Parameters:
1316ce7c7f2fSMark Adams +  pc - the preconditioner context
1317ce7c7f2fSMark Adams -  flg - Layout type
1318ce7c7f2fSMark Adams 
1319ce7c7f2fSMark Adams    Options Database Key:
1320ce7c7f2fSMark Adams .  -pc_gamg_coarse_grid_layout_type
1321ce7c7f2fSMark Adams 
1322ce7c7f2fSMark Adams    Level: intermediate
1323ce7c7f2fSMark Adams 
132439d09545SMark Adams .seealso: PCGAMGSetUseParallelCoarseGridSolve(), PCGAMGSetCpuPinCoarseGrids()
1325ce7c7f2fSMark Adams @*/
1326ce7c7f2fSMark Adams PetscErrorCode PCGAMGSetCoarseGridLayoutType(PC pc, PCGAMGLayoutType flg)
1327ce7c7f2fSMark Adams {
1328ce7c7f2fSMark Adams   PetscErrorCode ierr;
1329ce7c7f2fSMark Adams 
1330ce7c7f2fSMark Adams   PetscFunctionBegin;
1331ce7c7f2fSMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1332ce7c7f2fSMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetCoarseGridLayoutType_C",(PC,PCGAMGLayoutType),(pc,flg));CHKERRQ(ierr);
1333ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1334ce7c7f2fSMark Adams }
1335ce7c7f2fSMark Adams 
1336ce7c7f2fSMark Adams static PetscErrorCode PCGAMGSetCoarseGridLayoutType_GAMG(PC pc, PCGAMGLayoutType flg)
1337ce7c7f2fSMark Adams {
1338ce7c7f2fSMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1339ce7c7f2fSMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1340ce7c7f2fSMark Adams 
1341ce7c7f2fSMark Adams   PetscFunctionBegin;
1342ce7c7f2fSMark Adams   pc_gamg->layout_type = flg;
1343ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1344ce7c7f2fSMark Adams }
1345ce7c7f2fSMark Adams 
1346ce7c7f2fSMark Adams /*@
13471cc46a46SBarry Smith    PCGAMGSetNlevels -  Sets the maximum number of levels PCGAMG will use
13484ef23d27SMark F. Adams 
13494ef23d27SMark F. Adams    Not collective on PC
13504ef23d27SMark F. Adams 
13514ef23d27SMark F. Adams    Input Parameters:
13521cc46a46SBarry Smith +  pc - the preconditioner
13531cc46a46SBarry Smith -  n - the maximum number of levels to use
13544ef23d27SMark F. Adams 
13554ef23d27SMark F. Adams    Options Database Key:
13564ef23d27SMark F. Adams .  -pc_mg_levels
13574ef23d27SMark F. Adams 
13584ef23d27SMark F. Adams    Level: intermediate
13594ef23d27SMark F. Adams 
13604ef23d27SMark F. Adams .seealso: ()
13614ef23d27SMark F. Adams @*/
13624ef23d27SMark F. Adams PetscErrorCode PCGAMGSetNlevels(PC pc, PetscInt n)
13634ef23d27SMark F. Adams {
13644ef23d27SMark F. Adams   PetscErrorCode ierr;
13654ef23d27SMark F. Adams 
13664ef23d27SMark F. Adams   PetscFunctionBegin;
13674ef23d27SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
13684ef23d27SMark F. Adams   ierr = PetscTryMethod(pc,"PCGAMGSetNlevels_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
13694ef23d27SMark F. Adams   PetscFunctionReturn(0);
13704ef23d27SMark F. Adams }
13714ef23d27SMark F. Adams 
13721e6b0712SBarry Smith static PetscErrorCode PCGAMGSetNlevels_GAMG(PC pc, PetscInt n)
13734ef23d27SMark F. Adams {
13744ef23d27SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
13754ef23d27SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
13764ef23d27SMark F. Adams 
13774ef23d27SMark F. Adams   PetscFunctionBegin;
13789d5b6da9SMark F. Adams   pc_gamg->Nlevels = n;
13794ef23d27SMark F. Adams   PetscFunctionReturn(0);
13804ef23d27SMark F. Adams }
13814ef23d27SMark F. Adams 
13823542efc5SMark F. Adams /*@
13833542efc5SMark F. Adams    PCGAMGSetThreshold - Relative threshold to use for dropping edges in aggregation graph
13843542efc5SMark F. Adams 
13853542efc5SMark F. Adams    Not collective on PC
13863542efc5SMark F. Adams 
13873542efc5SMark F. Adams    Input Parameters:
13881cc46a46SBarry Smith +  pc - the preconditioner context
1389c9567895SMark .  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
1390055c8bd0SJed Brown -  n - number of threshold values provided in array
13913542efc5SMark F. Adams 
13923542efc5SMark F. Adams    Options Database Key:
13931cc46a46SBarry Smith .  -pc_gamg_threshold <threshold>
13943542efc5SMark F. Adams 
139595452b02SPatrick Sanan    Notes:
1396af3c827dSMark 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.
1397af3c827dSMark 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.
1398cab9ed1eSBarry Smith 
1399055c8bd0SJed Brown     If n is less than the total number of coarsenings (see PCGAMGSetNlevels()), then threshold scaling (see PCGAMGSetThresholdScale()) is used for each successive coarsening.
1400055c8bd0SJed Brown     In this case, PCGAMGSetThresholdScale() must be called before PCGAMGSetThreshold().
1401055c8bd0SJed Brown     If n is greater than the total number of levels, the excess entries in threshold will not be used.
1402055c8bd0SJed Brown 
14033542efc5SMark F. Adams    Level: intermediate
14043542efc5SMark F. Adams 
1405af3c827dSMark Adams .seealso: PCGAMGFilterGraph(), PCGAMGSetSquareGraph()
14063542efc5SMark F. Adams @*/
1407c1eae691SMark Adams PetscErrorCode PCGAMGSetThreshold(PC pc, PetscReal v[], PetscInt n)
14083542efc5SMark F. Adams {
14093542efc5SMark F. Adams   PetscErrorCode ierr;
14103542efc5SMark F. Adams 
14113542efc5SMark F. Adams   PetscFunctionBegin;
14123542efc5SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1413055c8bd0SJed Brown   if (n) PetscValidRealPointer(v,2);
1414c1eae691SMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetThreshold_C",(PC,PetscReal[],PetscInt),(pc,v,n));CHKERRQ(ierr);
14153542efc5SMark F. Adams   PetscFunctionReturn(0);
14163542efc5SMark F. Adams }
14173542efc5SMark F. Adams 
1418c1eae691SMark Adams static PetscErrorCode PCGAMGSetThreshold_GAMG(PC pc, PetscReal v[], PetscInt n)
14193542efc5SMark F. Adams {
1420c20e4228SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1421c20e4228SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1422c1eae691SMark Adams   PetscInt i;
1423c1eae691SMark Adams   PetscFunctionBegin;
1424055c8bd0SJed Brown   for (i=0; i<PetscMin(n,PETSC_MG_MAXLEVELS); i++) pc_gamg->threshold[i] = v[i];
1425055c8bd0SJed Brown   for (; i<PETSC_MG_MAXLEVELS; i++) pc_gamg->threshold[i] = pc_gamg->threshold[i-1]*pc_gamg->threshold_scale;
1426c1eae691SMark Adams   PetscFunctionReturn(0);
1427c1eae691SMark Adams }
1428c1eae691SMark Adams 
1429c1eae691SMark Adams /*@
1430c9567895SMark    PCGAMGSetRankReductionFactors - Set manual schedual for process reduction on coarse grids
1431c9567895SMark 
1432c9567895SMark    Collective on PC
1433c9567895SMark 
1434c9567895SMark    Input Parameters:
1435c9567895SMark +  pc - the preconditioner context
1436c9567895SMark .  v - array of reduction factors. 0 for fist value forces a reduction to one process/device on first level in Cuda
1437c9567895SMark -  n - number of values provided in array
1438c9567895SMark 
1439c9567895SMark    Options Database Key:
1440c9567895SMark .  -pc_gamg_rank_reduction_factors <factors>
1441c9567895SMark 
1442c9567895SMark    Level: intermediate
1443c9567895SMark 
1444c9567895SMark .seealso: PCGAMGSetProcEqLim(), PCGAMGSetCoarseEqLim()
1445c9567895SMark @*/
1446c9567895SMark PetscErrorCode PCGAMGSetRankReductionFactors(PC pc, PetscInt v[], PetscInt n)
1447c9567895SMark {
1448c9567895SMark   PetscErrorCode ierr;
1449c9567895SMark 
1450c9567895SMark   PetscFunctionBegin;
1451c9567895SMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1452c9567895SMark   if (n) PetscValidIntPointer(v,2);
1453c9567895SMark   ierr = PetscTryMethod(pc,"PCGAMGSetRankReductionFactors_C",(PC,PetscInt[],PetscInt),(pc,v,n));CHKERRQ(ierr);
1454c9567895SMark   PetscFunctionReturn(0);
1455c9567895SMark }
1456c9567895SMark 
1457c9567895SMark static PetscErrorCode PCGAMGSetRankReductionFactors_GAMG(PC pc, PetscInt v[], PetscInt n)
1458c9567895SMark {
1459c9567895SMark   PC_MG   *mg      = (PC_MG*)pc->data;
1460c9567895SMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1461c9567895SMark   PetscInt i;
1462c9567895SMark   PetscFunctionBegin;
1463c9567895SMark   for (i=0; i<PetscMin(n,PETSC_MG_MAXLEVELS); i++) pc_gamg->level_reduction_factors[i] = v[i];
1464c9567895SMark   for (; i<PETSC_MG_MAXLEVELS; i++) pc_gamg->level_reduction_factors[i] = -1; /* 0 stop putting one process/device on first level */
1465c9567895SMark   PetscFunctionReturn(0);
1466c9567895SMark }
1467c9567895SMark 
1468c9567895SMark /*@
1469c1eae691SMark Adams    PCGAMGSetThresholdScale - Relative threshold reduction at each level
1470c1eae691SMark Adams 
1471c1eae691SMark Adams    Not collective on PC
1472c1eae691SMark Adams 
1473c1eae691SMark Adams    Input Parameters:
1474c1eae691SMark Adams +  pc - the preconditioner context
1475c1eae691SMark Adams -  scale - the threshold value reduction, ussually < 1.0
1476c1eae691SMark Adams 
1477c1eae691SMark Adams    Options Database Key:
1478c1eae691SMark Adams .  -pc_gamg_threshold_scale <v>
1479c1eae691SMark Adams 
1480055c8bd0SJed Brown    Notes:
1481055c8bd0SJed Brown    The initial threshold (for an arbitrary number of levels starting from the finest) can be set with PCGAMGSetThreshold().
1482055c8bd0SJed Brown    This scaling is used for each subsequent coarsening, but must be called before PCGAMGSetThreshold().
1483055c8bd0SJed Brown 
1484c1eae691SMark Adams    Level: advanced
1485c1eae691SMark Adams 
1486055c8bd0SJed Brown .seealso: PCGAMGSetThreshold()
1487c1eae691SMark Adams @*/
1488c1eae691SMark Adams PetscErrorCode PCGAMGSetThresholdScale(PC pc, PetscReal v)
1489c1eae691SMark Adams {
1490c1eae691SMark Adams   PetscErrorCode ierr;
14913542efc5SMark F. Adams 
14923542efc5SMark F. Adams   PetscFunctionBegin;
1493c1eae691SMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1494c1eae691SMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetThresholdScale_C",(PC,PetscReal),(pc,v));CHKERRQ(ierr);
1495c1eae691SMark Adams   PetscFunctionReturn(0);
1496c1eae691SMark Adams }
1497c1eae691SMark Adams 
1498c1eae691SMark Adams static PetscErrorCode PCGAMGSetThresholdScale_GAMG(PC pc, PetscReal v)
1499c1eae691SMark Adams {
1500c1eae691SMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1501c1eae691SMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1502c1eae691SMark Adams   PetscFunctionBegin;
1503c1eae691SMark Adams   pc_gamg->threshold_scale = v;
15043542efc5SMark F. Adams   PetscFunctionReturn(0);
15053542efc5SMark F. Adams }
15063542efc5SMark F. Adams 
1507e20c40e8SBarry Smith /*@C
1508c60c7ad4SBarry Smith    PCGAMGSetType - Set solution method
1509676e1743SMark F. Adams 
1510676e1743SMark F. Adams    Collective on PC
1511676e1743SMark F. Adams 
1512676e1743SMark F. Adams    Input Parameters:
1513c60c7ad4SBarry Smith +  pc - the preconditioner context
1514c60c7ad4SBarry Smith -  type - PCGAMGAGG, PCGAMGGEO, or PCGAMGCLASSICAL
1515676e1743SMark F. Adams 
1516676e1743SMark F. Adams    Options Database Key:
1517cab9ed1eSBarry Smith .  -pc_gamg_type <agg,geo,classical> - type of algebraic multigrid to apply
1518676e1743SMark F. Adams 
1519676e1743SMark F. Adams    Level: intermediate
1520676e1743SMark F. Adams 
1521cab9ed1eSBarry Smith .seealso: PCGAMGGetType(), PCGAMG, PCGAMGType
1522676e1743SMark F. Adams @*/
152319fd82e9SBarry Smith PetscErrorCode PCGAMGSetType(PC pc, PCGAMGType type)
1524676e1743SMark F. Adams {
1525676e1743SMark F. Adams   PetscErrorCode ierr;
1526676e1743SMark F. Adams 
1527676e1743SMark F. Adams   PetscFunctionBegin;
1528676e1743SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1529806fa848SBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGSetType_C",(PC,PCGAMGType),(pc,type));CHKERRQ(ierr);
1530676e1743SMark F. Adams   PetscFunctionReturn(0);
1531676e1743SMark F. Adams }
1532676e1743SMark F. Adams 
1533e20c40e8SBarry Smith /*@C
1534c60c7ad4SBarry Smith    PCGAMGGetType - Get solution method
1535c60c7ad4SBarry Smith 
1536c60c7ad4SBarry Smith    Collective on PC
1537c60c7ad4SBarry Smith 
1538c60c7ad4SBarry Smith    Input Parameter:
1539c60c7ad4SBarry Smith .  pc - the preconditioner context
1540c60c7ad4SBarry Smith 
1541c60c7ad4SBarry Smith    Output Parameter:
1542c60c7ad4SBarry Smith .  type - the type of algorithm used
1543c60c7ad4SBarry Smith 
1544c60c7ad4SBarry Smith    Level: intermediate
1545c60c7ad4SBarry Smith 
15461c1aac46SBarry Smith .seealso: PCGAMGSetType(), PCGAMGType
1547c60c7ad4SBarry Smith @*/
1548c60c7ad4SBarry Smith PetscErrorCode PCGAMGGetType(PC pc, PCGAMGType *type)
1549c60c7ad4SBarry Smith {
1550c60c7ad4SBarry Smith   PetscErrorCode ierr;
1551c60c7ad4SBarry Smith 
1552c60c7ad4SBarry Smith   PetscFunctionBegin;
1553c60c7ad4SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1554c60c7ad4SBarry Smith   ierr = PetscUseMethod(pc,"PCGAMGGetType_C",(PC,PCGAMGType*),(pc,type));CHKERRQ(ierr);
1555c60c7ad4SBarry Smith   PetscFunctionReturn(0);
1556c60c7ad4SBarry Smith }
1557c60c7ad4SBarry Smith 
1558c60c7ad4SBarry Smith static PetscErrorCode PCGAMGGetType_GAMG(PC pc, PCGAMGType *type)
1559c60c7ad4SBarry Smith {
1560c60c7ad4SBarry Smith   PC_MG          *mg      = (PC_MG*)pc->data;
1561c60c7ad4SBarry Smith   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
1562c60c7ad4SBarry Smith 
1563c60c7ad4SBarry Smith   PetscFunctionBegin;
1564c60c7ad4SBarry Smith   *type = pc_gamg->type;
1565c60c7ad4SBarry Smith   PetscFunctionReturn(0);
1566c60c7ad4SBarry Smith }
1567c60c7ad4SBarry Smith 
15681e6b0712SBarry Smith static PetscErrorCode PCGAMGSetType_GAMG(PC pc, PCGAMGType type)
1569676e1743SMark F. Adams {
15709d5b6da9SMark F. Adams   PetscErrorCode ierr,(*r)(PC);
15711ab5ffc9SJed Brown   PC_MG          *mg      = (PC_MG*)pc->data;
15721ab5ffc9SJed Brown   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
1573676e1743SMark F. Adams 
1574676e1743SMark F. Adams   PetscFunctionBegin;
1575c60c7ad4SBarry Smith   pc_gamg->type = type;
15761c9cd337SJed Brown   ierr = PetscFunctionListFind(GAMGList,type,&r);CHKERRQ(ierr);
15779d5b6da9SMark F. Adams   if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown GAMG type %s given",type);
15781ab5ffc9SJed Brown   if (pc_gamg->ops->destroy) {
15791ab5ffc9SJed Brown     ierr = (*pc_gamg->ops->destroy)(pc);CHKERRQ(ierr);
15801ab5ffc9SJed Brown     ierr = PetscMemzero(pc_gamg->ops,sizeof(struct _PCGAMGOps));CHKERRQ(ierr);
1581e616c208SToby Isaac     pc_gamg->ops->createlevel = PCGAMGCreateLevel_GAMG;
15823ae0bb68SMark Adams     /* cleaning up common data in pc_gamg - this should disapear someday */
15833ae0bb68SMark Adams     pc_gamg->data_cell_cols = 0;
15843ae0bb68SMark Adams     pc_gamg->data_cell_rows = 0;
15853ae0bb68SMark Adams     pc_gamg->orig_data_cell_cols = 0;
15863ae0bb68SMark Adams     pc_gamg->orig_data_cell_rows = 0;
15873ae0bb68SMark Adams     ierr = PetscFree(pc_gamg->data);CHKERRQ(ierr);
15883ae0bb68SMark Adams     pc_gamg->data_sz = 0;
15891ab5ffc9SJed Brown   }
15901ab5ffc9SJed Brown   ierr = PetscFree(pc_gamg->gamg_type_name);CHKERRQ(ierr);
15911ab5ffc9SJed Brown   ierr = PetscStrallocpy(type,&pc_gamg->gamg_type_name);CHKERRQ(ierr);
15929d5b6da9SMark F. Adams   ierr = (*r)(pc);CHKERRQ(ierr);
1593676e1743SMark F. Adams   PetscFunctionReturn(0);
1594676e1743SMark F. Adams }
1595676e1743SMark F. Adams 
15969d766c59SMark Adams /* -------------------------------------------------------------------------- */
15979d766c59SMark Adams /*
15989d766c59SMark Adams    PCMGGetGridComplexity - compute coarse grid complexity of MG hierarchy
15999d766c59SMark Adams 
16009d766c59SMark Adams    Input Parameter:
16019d766c59SMark Adams .  pc - the preconditioner context
16029d766c59SMark Adams 
16039d766c59SMark Adams    Output Parameter:
16049d766c59SMark Adams .  gc - grid complexity = sum_i(nnz_i) / nnz_0
16059d766c59SMark Adams 
16069d766c59SMark Adams    Level: advanced
16079d766c59SMark Adams */
16089d766c59SMark Adams static PetscErrorCode PCMGGetGridComplexity(PC pc, PetscReal *gc)
16099d766c59SMark Adams {
16109d766c59SMark Adams   PetscErrorCode ierr;
16119d766c59SMark Adams   PC_MG          *mg      = (PC_MG*)pc->data;
16129d766c59SMark Adams   PC_MG_Levels   **mglevels = mg->levels;
16133966268fSBarry Smith   PetscInt       lev;
16143966268fSBarry Smith   PetscLogDouble nnz0 = 0, sgc = 0;
16159d766c59SMark Adams   MatInfo        info;
16163966268fSBarry Smith 
16179d766c59SMark Adams   PetscFunctionBegin;
1618dbf6bb8dSprj-   if (!pc->setupcalled) {
1619dbf6bb8dSprj-     *gc = 0;
1620dbf6bb8dSprj-     PetscFunctionReturn(0);
1621dbf6bb8dSprj-   }
16229d766c59SMark Adams   if (!mg->nlevels) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"MG has no levels");
16233966268fSBarry Smith   for (lev=0; lev<mg->nlevels; lev++) {
162462a6e064SMark Adams     Mat dB;
162562a6e064SMark Adams     ierr = KSPGetOperators(mglevels[lev]->smoothd,NULL,&dB);CHKERRQ(ierr);
162662a6e064SMark Adams     ierr = MatGetInfo(dB,MAT_GLOBAL_SUM,&info);CHKERRQ(ierr); /* global reduction */
16273966268fSBarry Smith     sgc += info.nz_used;
16289d766c59SMark Adams     if (lev==mg->nlevels-1) nnz0 = info.nz_used;
16299d766c59SMark Adams   }
16303966268fSBarry Smith   if (nnz0 > 0) *gc = (PetscReal)(sgc/nnz0);
16313966268fSBarry Smith   else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Number for grid points on finest level is not available");
16329d766c59SMark Adams   PetscFunctionReturn(0);
16339d766c59SMark Adams }
16349d766c59SMark Adams 
16355adeb434SBarry Smith static PetscErrorCode PCView_GAMG(PC pc,PetscViewer viewer)
16365adeb434SBarry Smith {
1637c1eae691SMark Adams   PetscErrorCode ierr,i;
16385adeb434SBarry Smith   PC_MG          *mg      = (PC_MG*)pc->data;
16395adeb434SBarry Smith   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
164023b2d91dSMark Adams   PetscReal       gc=0;
16415adeb434SBarry Smith   PetscFunctionBegin;
16425adeb434SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"    GAMG specific options\n");CHKERRQ(ierr);
1643459726d8SSatish Balay   ierr = PetscViewerASCIIPrintf(viewer,"      Threshold for dropping small values in graph on each level =");CHKERRQ(ierr);
1644c1eae691SMark Adams   for (i=0;i<pc_gamg->current_level;i++) {
1645c1eae691SMark Adams     ierr = PetscViewerASCIIPrintf(viewer," %g",(double)pc_gamg->threshold[i]);CHKERRQ(ierr);
1646c1eae691SMark Adams   }
1647459726d8SSatish Balay   ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
1648459726d8SSatish Balay   ierr = PetscViewerASCIIPrintf(viewer,"      Threshold scaling factor for each level not specified = %g\n",(double)pc_gamg->threshold_scale);CHKERRQ(ierr);
1649cab9ed1eSBarry Smith   if (pc_gamg->use_aggs_in_asm) {
1650cab9ed1eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"      Using aggregates from coarsening process to define subdomains for PCASM\n");CHKERRQ(ierr);
1651cab9ed1eSBarry Smith   }
1652171cca9aSMark Adams   if (pc_gamg->use_parallel_coarse_grid_solver) {
1653171cca9aSMark Adams     ierr = PetscViewerASCIIPrintf(viewer,"      Using parallel coarse grid solver (all coarse grid equations not put on one process)\n");CHKERRQ(ierr);
1654171cca9aSMark Adams   }
1655ce7c7f2fSMark Adams #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
1656ce7c7f2fSMark Adams   if (pc_gamg->cpu_pin_coarse_grids) {
1657ce7c7f2fSMark Adams     /* ierr = PetscViewerASCIIPrintf(viewer,"      Pinning coarse grids to the CPU)\n");CHKERRQ(ierr); */
1658ce7c7f2fSMark Adams   }
1659ce7c7f2fSMark Adams #endif
1660ce7c7f2fSMark Adams   /* if (pc_gamg->layout_type==PCGAMG_LAYOUT_COMPACT) { */
1661ce7c7f2fSMark Adams   /*   ierr = PetscViewerASCIIPrintf(viewer,"      Put reduced grids on processes in natural order (ie, 0,1,2...)\n");CHKERRQ(ierr); */
1662ce7c7f2fSMark Adams   /* } else { */
1663ce7c7f2fSMark Adams   /*   ierr = PetscViewerASCIIPrintf(viewer,"      Put reduced grids on whole machine (ie, 0,1*f,2*f...,np-f)\n");CHKERRQ(ierr); */
1664ce7c7f2fSMark Adams   /* } */
16655adeb434SBarry Smith   if (pc_gamg->ops->view) {
16665adeb434SBarry Smith     ierr = (*pc_gamg->ops->view)(pc,viewer);CHKERRQ(ierr);
16675adeb434SBarry Smith   }
16689d766c59SMark Adams   ierr = PCMGGetGridComplexity(pc,&gc);CHKERRQ(ierr);
16699d766c59SMark Adams   ierr = PetscViewerASCIIPrintf(viewer,"      Complexity:    grid = %g\n",gc);CHKERRQ(ierr);
16705adeb434SBarry Smith   PetscFunctionReturn(0);
16715adeb434SBarry Smith }
16725adeb434SBarry Smith 
16734416b707SBarry Smith PetscErrorCode PCSetFromOptions_GAMG(PetscOptionItems *PetscOptionsObject,PC pc)
16745b89ad90SMark F. Adams {
1675676e1743SMark F. Adams   PetscErrorCode ierr;
1676676e1743SMark F. Adams   PC_MG          *mg      = (PC_MG*)pc->data;
1677676e1743SMark F. Adams   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
167818c3aa7eSMark   PetscBool      flag,f2;
16793b4367a7SBarry Smith   MPI_Comm       comm;
168018c3aa7eSMark   char           prefix[256],tname[32];
1681c1eae691SMark Adams   PetscInt       i,n;
168214a9496bSBarry Smith   const char     *pcpre;
16830a545947SLisandro Dalcin   static const char *LayoutTypes[] = {"compact","spread","PCGAMGLayoutType","PC_GAMG_LAYOUT",NULL};
16845b89ad90SMark F. Adams   PetscFunctionBegin;
16853b4367a7SBarry Smith   ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
1686e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"GAMG options");CHKERRQ(ierr);
16871a1c1e04SBarry Smith   ierr = PetscOptionsFList("-pc_gamg_type","Type of AMG method","PCGAMGSetType",GAMGList, pc_gamg->gamg_type_name, tname, sizeof(tname), &flag);CHKERRQ(ierr);
1688bd94a7aaSJed Brown   if (flag) {
1689bd94a7aaSJed Brown     ierr = PCGAMGSetType(pc,tname);CHKERRQ(ierr);
16901ab5ffc9SJed Brown   }
169118c3aa7eSMark   ierr = PetscOptionsFList("-pc_gamg_esteig_ksp_type","Krylov method for eigen estimator","PCGAMGSetEstEigKSPType",KSPList,pc_gamg->esteig_type,tname,sizeof(tname),&flag);CHKERRQ(ierr);
169218c3aa7eSMark   if (flag) {
169318c3aa7eSMark     ierr = PCGAMGSetEstEigKSPType(pc,tname);CHKERRQ(ierr);
169418c3aa7eSMark   }
1695cab9ed1eSBarry Smith   ierr = PetscOptionsBool("-pc_gamg_repartition","Repartion coarse grids","PCGAMGSetRepartition",pc_gamg->repart,&pc_gamg->repart,NULL);CHKERRQ(ierr);
169618c3aa7eSMark   f2 = PETSC_TRUE;
169718c3aa7eSMark   ierr = PetscOptionsBool("-pc_gamg_use_sa_esteig","Use eigen estimate from Smoothed aggregation for smoother","PCGAMGSetUseSAEstEig",f2,&f2,&flag);CHKERRQ(ierr);
169818c3aa7eSMark   if (flag) pc_gamg->use_sa_esteig = f2 ? 1 : 0;
16991cc46a46SBarry Smith   ierr = PetscOptionsBool("-pc_gamg_reuse_interpolation","Reuse prolongation operator","PCGAMGReuseInterpolation",pc_gamg->reuse_prol,&pc_gamg->reuse_prol,NULL);CHKERRQ(ierr);
1700a303c832SJed 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);
1701cf8ae1d3SMark 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);
1702ce7c7f2fSMark 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);
1703a0095786SMark   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);
170494ae4db5SBarry 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);
170518c3aa7eSMark   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);
170694ae4db5SBarry 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);
1707a303c832SJed 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);
170818c3aa7eSMark   n = PETSC_MG_MAXLEVELS;
1709c1eae691SMark Adams   ierr = PetscOptionsRealArray("-pc_gamg_threshold","Relative threshold to use for dropping edges in aggregation graph","PCGAMGSetThreshold",pc_gamg->threshold,&n,&flag);CHKERRQ(ierr);
171018c3aa7eSMark   if (!flag || n < PETSC_MG_MAXLEVELS) {
1711efd3c5ceSMark Adams     if (!flag) n = 1;
1712c1eae691SMark Adams     i = n;
171318c3aa7eSMark     do {pc_gamg->threshold[i] = pc_gamg->threshold[i-1]*pc_gamg->threshold_scale;} while (++i<PETSC_MG_MAXLEVELS);
1714c1eae691SMark Adams   }
1715c9567895SMark   n = PETSC_MG_MAXLEVELS;
1716c9567895SMark   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);
1717c9567895SMark   if (!flag) i = 0;
1718c9567895SMark   else i = n;
1719c9567895SMark   do {pc_gamg->level_reduction_factors[i] = -1;} while (++i<PETSC_MG_MAXLEVELS);
172094ae4db5SBarry Smith   ierr = PetscOptionsInt("-pc_mg_levels","Set number of MG levels","PCGAMGSetNlevels",pc_gamg->Nlevels,&pc_gamg->Nlevels,NULL);CHKERRQ(ierr);
172118c3aa7eSMark   {
172218c3aa7eSMark     PetscReal eminmax[2] = {0., 0.};
172318c3aa7eSMark     n = 2;
172418c3aa7eSMark     ierr = PetscOptionsRealArray("-pc_gamg_eigenvalues","extreme eigenvalues for smoothed aggregation","PCGAMGSetEigenvalues",eminmax,&n,&flag);CHKERRQ(ierr);
172518c3aa7eSMark     if (flag) {
172618c3aa7eSMark       if (n != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"-pc_gamg_eigenvalues: must specify 2 parameters, min and max eigenvalues");
172718c3aa7eSMark       ierr = PCGAMGSetEigenvalues(pc, eminmax[1], eminmax[0]);CHKERRQ(ierr);
172818c3aa7eSMark     }
172918c3aa7eSMark   }
1730b7cbab4eSMark Adams   /* set options for subtype */
1731e55864a3SBarry Smith   if (pc_gamg->ops->setfromoptions) {ierr = (*pc_gamg->ops->setfromoptions)(PetscOptionsObject,pc);CHKERRQ(ierr);}
173218c3aa7eSMark 
173314a9496bSBarry Smith   ierr = PCGetOptionsPrefix(pc, &pcpre);CHKERRQ(ierr);
173414a9496bSBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%spc_gamg_",pcpre ? pcpre : "");CHKERRQ(ierr);
1735676e1743SMark F. Adams   ierr = PetscOptionsTail();CHKERRQ(ierr);
17365b89ad90SMark F. Adams   PetscFunctionReturn(0);
17375b89ad90SMark F. Adams }
17385b89ad90SMark F. Adams 
17395b89ad90SMark F. Adams /* -------------------------------------------------------------------------- */
17405b89ad90SMark F. Adams /*MC
17411cc46a46SBarry Smith      PCGAMG - Geometric algebraic multigrid (AMG) preconditioner
17425b89ad90SMark F. Adams 
1743280d9858SJed Brown    Options Database Keys:
1744cab9ed1eSBarry Smith +   -pc_gamg_type <type> - one of agg, geo, or classical
1745cab9ed1eSBarry Smith .   -pc_gamg_repartition  <true,default=false> - repartition the degrees of freedom accross the coarse grids as they are determined
1746cab9ed1eSBarry Smith .   -pc_gamg_reuse_interpolation <true,default=false> - when rebuilding the algebraic multigrid preconditioner reuse the previously computed interpolations
1747cab9ed1eSBarry 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
1748cab9ed1eSBarry 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>
1749cab9ed1eSBarry Smith                                         equations on each process that has degrees of freedom
1750cab9ed1eSBarry Smith .   -pc_gamg_coarse_eq_limit <limit, default=50> - Set maximum number of equations on coarsest grid to aim for.
17516008e27bSRichard Tran Mills .   -pc_gamg_threshold[] <thresh,default=0> - Before aggregating the graph GAMG will remove small values from the graph on each level
1752c1eae691SMark Adams -   -pc_gamg_threshold_scale <scale,default=1> - Scaling of threshold on each coarser grid if not specified
1753cab9ed1eSBarry Smith 
1754cab9ed1eSBarry Smith    Options Database Keys for default Aggregation:
1755cab9ed1eSBarry Smith +  -pc_gamg_agg_nsmooths <nsmooth, default=1> - number of smoothing steps to use with smooth aggregation
1756cab9ed1eSBarry Smith .  -pc_gamg_sym_graph <true,default=false> - symmetrize the graph before computing the aggregation
1757cab9ed1eSBarry Smith -  -pc_gamg_square_graph <n,default=1> - number of levels to square the graph before aggregating it
1758cab9ed1eSBarry Smith 
1759db9745e2SBarry Smith    Multigrid options:
1760db9745e2SBarry Smith +  -pc_mg_cycles <v> - v or w, see PCMGSetCycleType()
1761db9745e2SBarry Smith .  -pc_mg_distinct_smoothup - configure the up and down (pre and post) smoothers separately, see PCMGSetDistinctSmoothUp()
1762db9745e2SBarry Smith .  -pc_mg_type <multiplicative> - (one of) additive multiplicative full kascade
1763cab9ed1eSBarry Smith -  -pc_mg_levels <levels> - Number of levels of multigrid to use.
17645b89ad90SMark F. Adams 
17651cc46a46SBarry Smith 
176695452b02SPatrick Sanan   Notes:
176795452b02SPatrick Sanan     In order to obtain good performance for PCGAMG for vector valued problems you must
1768db9745e2SBarry Smith        Call MatSetBlockSize() to indicate the number of degrees of freedom per grid point
1769db9745e2SBarry Smith        Call MatSetNearNullSpace() (or PCSetCoordinates() if solving the equations of elasticity) to indicate the near null space of the operator
1770db9745e2SBarry Smith        See the Users Manual Chapter 4 for more details
17711cc46a46SBarry Smith 
17725b89ad90SMark F. Adams   Level: intermediate
1773280d9858SJed Brown 
17741cc46a46SBarry Smith .seealso:  PCCreate(), PCSetType(), MatSetBlockSize(), PCMGType, PCSetCoordinates(), MatSetNearNullSpace(), PCGAMGSetType(), PCGAMGAGG, PCGAMGGEO, PCGAMGCLASSICAL, PCGAMGSetProcEqLim(),
177518c3aa7eSMark            PCGAMGSetCoarseEqLim(), PCGAMGSetRepartition(), PCGAMGRegister(), PCGAMGSetReuseInterpolation(), PCGAMGASMSetUseAggs(), PCGAMGSetUseParallelCoarseGridSolve(), PCGAMGSetNlevels(), PCGAMGSetThreshold(), PCGAMGGetType(), PCGAMGSetReuseInterpolation(), PCGAMGSetUseSAEstEig(), PCGAMGSetEstEigKSPMaxIt(), PCGAMGSetEstEigKSPType()
17765b89ad90SMark F. Adams M*/
1777b2573a8aSBarry Smith 
17788cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_GAMG(PC pc)
17795b89ad90SMark F. Adams {
1780c1eae691SMark Adams   PetscErrorCode ierr,i;
17815b89ad90SMark F. Adams   PC_GAMG        *pc_gamg;
17825b89ad90SMark F. Adams   PC_MG          *mg;
17835b89ad90SMark F. Adams 
17845b89ad90SMark F. Adams   PetscFunctionBegin;
17851c1aac46SBarry Smith    /* register AMG type */
17861c1aac46SBarry Smith   ierr = PCGAMGInitializePackage();CHKERRQ(ierr);
17871c1aac46SBarry Smith 
17885b89ad90SMark F. Adams   /* PCGAMG is an inherited class of PCMG. Initialize pc as PCMG */
17891c1aac46SBarry Smith   ierr = PCSetType(pc, PCMG);CHKERRQ(ierr);
17905b89ad90SMark F. Adams   ierr = PetscObjectChangeTypeName((PetscObject)pc, PCGAMG);CHKERRQ(ierr);
17915b89ad90SMark F. Adams 
17925b89ad90SMark F. Adams   /* create a supporting struct and attach it to pc */
1793b00a9115SJed Brown   ierr         = PetscNewLog(pc,&pc_gamg);CHKERRQ(ierr);
179469aca0b8SBarry Smith   ierr         = PCMGSetGalerkin(pc,PC_MG_GALERKIN_EXTERNAL);CHKERRQ(ierr);
17955b89ad90SMark F. Adams   mg           = (PC_MG*)pc->data;
17965b89ad90SMark F. Adams   mg->innerctx = pc_gamg;
17975b89ad90SMark F. Adams 
1798b00a9115SJed Brown   ierr = PetscNewLog(pc,&pc_gamg->ops);CHKERRQ(ierr);
17991ab5ffc9SJed Brown 
18009d5b6da9SMark F. Adams   pc_gamg->setup_count = 0;
18019d5b6da9SMark F. Adams   /* these should be in subctx but repartitioning needs simple arrays */
18029d5b6da9SMark F. Adams   pc_gamg->data_sz = 0;
18030a545947SLisandro Dalcin   pc_gamg->data    = NULL;
18045b89ad90SMark F. Adams 
18059d5b6da9SMark F. Adams   /* overwrite the pointers of PCMG by the functions of base class PCGAMG */
18065b89ad90SMark F. Adams   pc->ops->setfromoptions = PCSetFromOptions_GAMG;
18075b89ad90SMark F. Adams   pc->ops->setup          = PCSetUp_GAMG;
18085b89ad90SMark F. Adams   pc->ops->reset          = PCReset_GAMG;
18095b89ad90SMark F. Adams   pc->ops->destroy        = PCDestroy_GAMG;
18105adeb434SBarry Smith   mg->view                = PCView_GAMG;
18115b89ad90SMark F. Adams 
181297d33e41SMatthew G. Knepley   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCMGGetLevels_C",PCMGGetLevels_MG);CHKERRQ(ierr);
181397d33e41SMatthew G. Knepley   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCMGSetLevels_C",PCMGSetLevels_MG);CHKERRQ(ierr);
1814bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetProcEqLim_C",PCGAMGSetProcEqLim_GAMG);CHKERRQ(ierr);
1815bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetCoarseEqLim_C",PCGAMGSetCoarseEqLim_GAMG);CHKERRQ(ierr);
1816cab9ed1eSBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetRepartition_C",PCGAMGSetRepartition_GAMG);CHKERRQ(ierr);
181718c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetEstEigKSPType_C",PCGAMGSetEstEigKSPType_GAMG);CHKERRQ(ierr);
181818c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetEstEigKSPMaxIt_C",PCGAMGSetEstEigKSPMaxIt_GAMG);CHKERRQ(ierr);
181918c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetEigenvalues_C",PCGAMGSetEigenvalues_GAMG);CHKERRQ(ierr);
182018c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetUseSAEstEig_C",PCGAMGSetUseSAEstEig_GAMG);CHKERRQ(ierr);
18211cc46a46SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetReuseInterpolation_C",PCGAMGSetReuseInterpolation_GAMG);CHKERRQ(ierr);
1822cab9ed1eSBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGASMSetUseAggs_C",PCGAMGASMSetUseAggs_GAMG);CHKERRQ(ierr);
1823171cca9aSMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetUseParallelCoarseGridSolve_C",PCGAMGSetUseParallelCoarseGridSolve_GAMG);CHKERRQ(ierr);
1824ce7c7f2fSMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetCpuPinCoarseGrids_C",PCGAMGSetCpuPinCoarseGrids_GAMG);CHKERRQ(ierr);
1825ce7c7f2fSMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetCoarseGridLayoutType_C",PCGAMGSetCoarseGridLayoutType_GAMG);CHKERRQ(ierr);
1826bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetThreshold_C",PCGAMGSetThreshold_GAMG);CHKERRQ(ierr);
1827c9567895SMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetRankReductionFactors_C",PCGAMGSetRankReductionFactors_GAMG);CHKERRQ(ierr);
1828c1eae691SMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetThresholdScale_C",PCGAMGSetThresholdScale_GAMG);CHKERRQ(ierr);
1829bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetType_C",PCGAMGSetType_GAMG);CHKERRQ(ierr);
1830c60c7ad4SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGGetType_C",PCGAMGGetType_GAMG);CHKERRQ(ierr);
1831bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetNlevels_C",PCGAMGSetNlevels_GAMG);CHKERRQ(ierr);
18329d5b6da9SMark F. Adams   pc_gamg->repart           = PETSC_FALSE;
1833d3042614SMark Adams   pc_gamg->reuse_prol       = PETSC_FALSE;
18340c3bc534SBarry Smith   pc_gamg->use_aggs_in_asm  = PETSC_FALSE;
1835171cca9aSMark Adams   pc_gamg->use_parallel_coarse_grid_solver = PETSC_FALSE;
1836a0095786SMark   pc_gamg->cpu_pin_coarse_grids = PETSC_FALSE;
1837a0095786SMark   pc_gamg->layout_type      = PCGAMG_LAYOUT_SPREAD;
1838038f3aa4SMark F. Adams   pc_gamg->min_eq_proc      = 50;
183925a145a7SMark Adams   pc_gamg->coarse_eq_limit  = 50;
184018c3aa7eSMark   for (i=0;i<PETSC_MG_MAXLEVELS;i++) pc_gamg->threshold[i] = 0.;
1841c1eae691SMark Adams   pc_gamg->threshold_scale = 1.;
184218c3aa7eSMark   pc_gamg->Nlevels          = PETSC_MG_MAXLEVELS;
18439ab59c8bSMark Adams   pc_gamg->current_level    = 0; /* don't need to init really */
1844d24ecf33SMark   ierr = PetscStrcpy(pc_gamg->esteig_type,NULL);CHKERRQ(ierr);
184518c3aa7eSMark   pc_gamg->esteig_max_it    = 10;
184618c3aa7eSMark   pc_gamg->use_sa_esteig    = -1;
184718c3aa7eSMark   pc_gamg->emin             = 0;
184818c3aa7eSMark   pc_gamg->emax             = 0;
184918c3aa7eSMark 
1850c238b0ebSToby Isaac   pc_gamg->ops->createlevel = PCGAMGCreateLevel_GAMG;
18519d5b6da9SMark F. Adams 
1852bd94a7aaSJed Brown   /* PCSetUp_GAMG assumes that the type has been set, so set it to the default now */
1853bd94a7aaSJed Brown   ierr = PCGAMGSetType(pc,PCGAMGAGG);CHKERRQ(ierr);
18545b89ad90SMark F. Adams   PetscFunctionReturn(0);
18555b89ad90SMark F. Adams }
18563e3471ccSMark Adams 
18573e3471ccSMark Adams /*@C
18583e3471ccSMark Adams  PCGAMGInitializePackage - This function initializes everything in the PCGAMG package. It is called
18598a690491SBarry Smith     from PCInitializePackage().
18603e3471ccSMark Adams 
18613e3471ccSMark Adams  Level: developer
18623e3471ccSMark Adams 
18633e3471ccSMark Adams  .seealso: PetscInitialize()
18643e3471ccSMark Adams @*/
18653e3471ccSMark Adams PetscErrorCode PCGAMGInitializePackage(void)
18663e3471ccSMark Adams {
18673e3471ccSMark Adams   PetscErrorCode ierr;
18683e3471ccSMark Adams 
18693e3471ccSMark Adams   PetscFunctionBegin;
18703e3471ccSMark Adams   if (PCGAMGPackageInitialized) PetscFunctionReturn(0);
18713e3471ccSMark Adams   PCGAMGPackageInitialized = PETSC_TRUE;
18723e3471ccSMark Adams   ierr = PetscFunctionListAdd(&GAMGList,PCGAMGGEO,PCCreateGAMG_GEO);CHKERRQ(ierr);
18733e3471ccSMark Adams   ierr = PetscFunctionListAdd(&GAMGList,PCGAMGAGG,PCCreateGAMG_AGG);CHKERRQ(ierr);
18748e6d0c30SPeter Brune   ierr = PetscFunctionListAdd(&GAMGList,PCGAMGCLASSICAL,PCCreateGAMG_Classical);CHKERRQ(ierr);
18753e3471ccSMark Adams   ierr = PetscRegisterFinalize(PCGAMGFinalizePackage);CHKERRQ(ierr);
1876c1c463dbSMark Adams 
1877c1c463dbSMark Adams   /* general events */
1878fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGGraph_AGG", 0, &PC_GAMGGraph_AGG);CHKERRQ(ierr);
1879fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGGraph_GEO", PC_CLASSID, &PC_GAMGGraph_GEO);CHKERRQ(ierr);
1880fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGCoarse_AGG", PC_CLASSID, &PC_GAMGCoarsen_AGG);CHKERRQ(ierr);
1881fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGCoarse_GEO", PC_CLASSID, &PC_GAMGCoarsen_GEO);CHKERRQ(ierr);
1882c1c463dbSMark Adams   ierr = PetscLogEventRegister("PCGAMGProl_AGG", PC_CLASSID, &PC_GAMGProlongator_AGG);CHKERRQ(ierr);
1883c1c463dbSMark Adams   ierr = PetscLogEventRegister("PCGAMGProl_GEO", PC_CLASSID, &PC_GAMGProlongator_GEO);CHKERRQ(ierr);
1884fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGPOpt_AGG", PC_CLASSID, &PC_GAMGOptProlongator_AGG);CHKERRQ(ierr);
1885c1c463dbSMark Adams 
18865b89ad90SMark F. Adams #if defined PETSC_GAMG_USE_LOG
18875b89ad90SMark F. Adams   ierr = PetscLogEventRegister("GAMG: createProl", PC_CLASSID, &petsc_gamg_setup_events[SET1]);CHKERRQ(ierr);
18885b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Graph", PC_CLASSID, &petsc_gamg_setup_events[GRAPH]);CHKERRQ(ierr);
18895b89ad90SMark F. Adams   /* PetscLogEventRegister("    G.Mat", PC_CLASSID, &petsc_gamg_setup_events[GRAPH_MAT]); */
18905b89ad90SMark F. Adams   /* PetscLogEventRegister("    G.Filter", PC_CLASSID, &petsc_gamg_setup_events[GRAPH_FILTER]); */
18915b89ad90SMark F. Adams   /* PetscLogEventRegister("    G.Square", PC_CLASSID, &petsc_gamg_setup_events[GRAPH_SQR]); */
18925b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  MIS/Agg", PC_CLASSID, &petsc_gamg_setup_events[SET4]);CHKERRQ(ierr);
18935b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  geo: growSupp", PC_CLASSID, &petsc_gamg_setup_events[SET5]);CHKERRQ(ierr);
18945b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  geo: triangle", PC_CLASSID, &petsc_gamg_setup_events[SET6]);CHKERRQ(ierr);
1895bb235841SBarry Smith   ierr = PetscLogEventRegister("    search-set", PC_CLASSID, &petsc_gamg_setup_events[FIND_V]);CHKERRQ(ierr);
18965b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  SA: col data", PC_CLASSID, &petsc_gamg_setup_events[SET7]);CHKERRQ(ierr);
18975b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  SA: frmProl0", PC_CLASSID, &petsc_gamg_setup_events[SET8]);CHKERRQ(ierr);
18985b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  SA: smooth", PC_CLASSID, &petsc_gamg_setup_events[SET9]);CHKERRQ(ierr);
18995b89ad90SMark F. Adams   ierr = PetscLogEventRegister("GAMG: partLevel", PC_CLASSID, &petsc_gamg_setup_events[SET2]);CHKERRQ(ierr);
19005b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  repartition", PC_CLASSID, &petsc_gamg_setup_events[SET12]);CHKERRQ(ierr);
19015b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Invert-Sort", PC_CLASSID, &petsc_gamg_setup_events[SET13]);CHKERRQ(ierr);
19025b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Move A", PC_CLASSID, &petsc_gamg_setup_events[SET14]);CHKERRQ(ierr);
19035b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Move P", PC_CLASSID, &petsc_gamg_setup_events[SET15]);CHKERRQ(ierr);
19045b89ad90SMark F. Adams 
19055b89ad90SMark F. Adams   /* PetscLogEventRegister(" PL move data", PC_CLASSID, &petsc_gamg_setup_events[SET13]); */
19065b89ad90SMark F. Adams   /* PetscLogEventRegister("GAMG: fix", PC_CLASSID, &petsc_gamg_setup_events[SET10]); */
19075b89ad90SMark F. Adams   /* PetscLogEventRegister("GAMG: set levels", PC_CLASSID, &petsc_gamg_setup_events[SET11]); */
19085b89ad90SMark F. Adams   /* create timer stages */
19095b89ad90SMark F. Adams #if defined GAMG_STAGES
19105b89ad90SMark F. Adams   {
19115b89ad90SMark F. Adams     char     str[32];
19125b89ad90SMark F. Adams     PetscInt lidx;
19135b89ad90SMark F. Adams     sprintf(str,"MG Level %d (finest)",0);
19145b89ad90SMark F. Adams     ierr = PetscLogStageRegister(str, &gamg_stages[0]);CHKERRQ(ierr);
19155b89ad90SMark F. Adams     for (lidx=1; lidx<9; lidx++) {
1916c9567895SMark       sprintf(str,"MG Level %d",(int)lidx);
19175b89ad90SMark F. Adams       ierr = PetscLogStageRegister(str, &gamg_stages[lidx]);CHKERRQ(ierr);
19185b89ad90SMark F. Adams     }
19195b89ad90SMark F. Adams   }
19205b89ad90SMark F. Adams #endif
19215b89ad90SMark F. Adams #endif
19223e3471ccSMark Adams   PetscFunctionReturn(0);
19233e3471ccSMark Adams }
19243e3471ccSMark Adams 
19253e3471ccSMark Adams /*@C
19261c1aac46SBarry Smith  PCGAMGFinalizePackage - This function frees everything from the PCGAMG package. It is
19271c1aac46SBarry Smith     called from PetscFinalize() automatically.
19283e3471ccSMark Adams 
19293e3471ccSMark Adams  Level: developer
19303e3471ccSMark Adams 
19313e3471ccSMark Adams  .seealso: PetscFinalize()
19323e3471ccSMark Adams @*/
19333e3471ccSMark Adams PetscErrorCode PCGAMGFinalizePackage(void)
19343e3471ccSMark Adams {
19353e3471ccSMark Adams   PetscErrorCode ierr;
19363e3471ccSMark Adams 
19373e3471ccSMark Adams   PetscFunctionBegin;
19383e3471ccSMark Adams   PCGAMGPackageInitialized = PETSC_FALSE;
19393e3471ccSMark Adams   ierr = PetscFunctionListDestroy(&GAMGList);CHKERRQ(ierr);
19403e3471ccSMark Adams   PetscFunctionReturn(0);
19413e3471ccSMark Adams }
1942a36cf38bSToby Isaac 
1943a36cf38bSToby Isaac /*@C
1944a36cf38bSToby Isaac  PCGAMGRegister - Register a PCGAMG implementation.
1945a36cf38bSToby Isaac 
1946a36cf38bSToby Isaac  Input Parameters:
1947a36cf38bSToby Isaac  + type - string that will be used as the name of the GAMG type.
1948a36cf38bSToby Isaac  - create - function for creating the gamg context.
1949a36cf38bSToby Isaac 
1950a36cf38bSToby Isaac   Level: advanced
1951a36cf38bSToby Isaac 
19521c1aac46SBarry Smith  .seealso: PCGAMGType, PCGAMG, PCGAMGSetType()
1953a36cf38bSToby Isaac @*/
1954a36cf38bSToby Isaac PetscErrorCode PCGAMGRegister(PCGAMGType type, PetscErrorCode (*create)(PC))
1955a36cf38bSToby Isaac {
1956a36cf38bSToby Isaac   PetscErrorCode ierr;
1957a36cf38bSToby Isaac 
1958a36cf38bSToby Isaac   PetscFunctionBegin;
1959a36cf38bSToby Isaac   ierr = PCGAMGInitializePackage();CHKERRQ(ierr);
1960a36cf38bSToby Isaac   ierr = PetscFunctionListAdd(&GAMGList,type,create);CHKERRQ(ierr);
1961a36cf38bSToby Isaac   PetscFunctionReturn(0);
1962a36cf38bSToby Isaac }
1963a36cf38bSToby Isaac 
1964