xref: /petsc/src/ksp/pc/impls/gamg/gamg.c (revision e589036e9683f8580551b8f54d59a5f73edfef1f)
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;
1398abdc6daSStefano Zampini     ierr = PetscInfo1(pc,"Force coarsest grid reduction to %D active processes\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 */
1498abdc6daSStefano Zampini     ierr = PetscInfo2(pc,"Coarse grid reduction from %D to %D active processes\n",nactive,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);
434*e589036eSStefano Zampini #if defined(PETSC_HAVE_CUDA)
435*e589036eSStefano Zampini       ierr = MatAIJCUSPARSESetGenerateTranspose(Pnew,PETSC_TRUE);CHKERRQ(ierr);
436*e589036eSStefano Zampini #endif
437c5bfad50SMark F. Adams 
4380cbbd2e1SMark F. Adams #if defined PETSC_GAMG_USE_LOG
4390cbbd2e1SMark F. Adams       ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET15],0,0,0,0);CHKERRQ(ierr);
440ed3f9983SMark F. Adams #endif
4413530afc2SMark F. Adams       ierr = MatDestroy(a_P_inout);CHKERRQ(ierr);
442a2f3521dSMark F. Adams 
443a2f3521dSMark F. Adams       /* output - repartitioned */
444a2f3521dSMark F. Adams       *a_P_inout = Pnew;
445e33ef3b1SMark F. Adams     }
446a2f3521dSMark F. Adams     ierr = ISDestroy(&new_eq_indices);CHKERRQ(ierr);
4475b89ad90SMark F. Adams 
448c5df96a5SBarry Smith     *a_nactive_proc = new_size; /* output */
449ce7c7f2fSMark Adams 
450ce7c7f2fSMark Adams     /* pinning on reduced grids, not a bad heuristic and optimization gets folded into process reduction optimization */
451ce7c7f2fSMark Adams     if (pc_gamg->cpu_pin_coarse_grids) {
452ce7c7f2fSMark Adams #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
4538bca76a6SMark Adams       static PetscInt llev = 2;
45439d09545SMark Adams       ierr = PetscInfo1(pc,"Pinning level %D to the CPU\n",llev++);CHKERRQ(ierr);
455ce7c7f2fSMark Adams #endif
456b470e4b4SRichard Tran Mills       ierr = MatBindToCPU(*a_Amat_crs,PETSC_TRUE);CHKERRQ(ierr);
457b470e4b4SRichard Tran Mills       ierr = MatBindToCPU(*a_P_inout,PETSC_TRUE);CHKERRQ(ierr);
458ce7c7f2fSMark Adams       if (1) { /* lvec is created, need to pin it, this is done in MatSetUpMultiply_MPIAIJ. Hack */
459ce7c7f2fSMark Adams         Mat         A = *a_Amat_crs, P = *a_P_inout;
460ce7c7f2fSMark Adams         PetscMPIInt size;
461ffc4695bSBarry Smith         ierr = MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);CHKERRMPI(ierr);
462ce7c7f2fSMark Adams         if (size > 1) {
463ce7c7f2fSMark Adams           Mat_MPIAIJ     *a = (Mat_MPIAIJ*)A->data, *p = (Mat_MPIAIJ*)P->data;
464b470e4b4SRichard Tran Mills           ierr = VecBindToCPU(a->lvec,PETSC_TRUE);CHKERRQ(ierr);
465b470e4b4SRichard Tran Mills           ierr = VecBindToCPU(p->lvec,PETSC_TRUE);CHKERRQ(ierr);
466ce7c7f2fSMark Adams         }
467ce7c7f2fSMark Adams       }
468ce7c7f2fSMark Adams     }
4694cdfd227SMark #if defined PETSC_GAMG_USE_LOG
4704cdfd227SMark     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET12],0,0,0,0);CHKERRQ(ierr);
4714cdfd227SMark #endif
472a2f3521dSMark F. Adams   }
4735b89ad90SMark F. Adams   PetscFunctionReturn(0);
4745b89ad90SMark F. Adams }
4755b89ad90SMark F. Adams 
4764b1575e2SStefano Zampini PetscErrorCode PCGAMGSquareGraph_GAMG(PC a_pc, Mat Gmat1, Mat* Gmat2)
4774b1575e2SStefano Zampini {
4784b1575e2SStefano Zampini   PetscErrorCode ierr;
4794b1575e2SStefano Zampini   const char     *prefix;
4804b1575e2SStefano Zampini   char           addp[32];
4814b1575e2SStefano Zampini   PC_MG          *mg      = (PC_MG*)a_pc->data;
4824b1575e2SStefano Zampini   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
4834b1575e2SStefano Zampini 
4844b1575e2SStefano Zampini   PetscFunctionBegin;
4854b1575e2SStefano Zampini   ierr = PCGetOptionsPrefix(a_pc,&prefix);CHKERRQ(ierr);
4864b1575e2SStefano Zampini   ierr = PetscInfo1(a_pc,"Square Graph on level %D\n",pc_gamg->current_level+1);CHKERRQ(ierr);
4878abdc6daSStefano Zampini #if defined(PETSC_HAVE_CUDA)
4888abdc6daSStefano Zampini   ierr = MatAIJCUSPARSESetGenerateTranspose(Gmat1,PETSC_TRUE);CHKERRQ(ierr);
4898abdc6daSStefano Zampini #endif
4904b1575e2SStefano Zampini   ierr = MatProductCreate(Gmat1,Gmat1,NULL,Gmat2);CHKERRQ(ierr);
4914b1575e2SStefano Zampini   ierr = MatSetOptionsPrefix(*Gmat2,prefix);CHKERRQ(ierr);
4924b1575e2SStefano Zampini   ierr = PetscSNPrintf(addp,sizeof(addp),"pc_gamg_square_%d_",pc_gamg->current_level);CHKERRQ(ierr);
4934b1575e2SStefano Zampini   ierr = MatAppendOptionsPrefix(*Gmat2,addp);CHKERRQ(ierr);
49443ef1857SStefano Zampini   /* TODO: if we know the matrix is symmetric we can pass MATPRODUCT_AB */
4954b1575e2SStefano Zampini   ierr = MatProductSetType(*Gmat2,MATPRODUCT_AtB);CHKERRQ(ierr);
4964b1575e2SStefano Zampini   ierr = MatProductSetFromOptions(*Gmat2);CHKERRQ(ierr);
4974b1575e2SStefano Zampini   ierr = MatProductSymbolic(*Gmat2);CHKERRQ(ierr);
4984b1575e2SStefano Zampini   /* we only need the sparsity, cheat and tell PETSc the matrix has been assembled */
4994b1575e2SStefano Zampini   (*Gmat2)->assembled = PETSC_TRUE;
5004b1575e2SStefano Zampini   PetscFunctionReturn(0);
5014b1575e2SStefano Zampini }
5024b1575e2SStefano Zampini 
5035b89ad90SMark F. Adams /* -------------------------------------------------------------------------- */
5045b89ad90SMark F. Adams /*
5055b89ad90SMark F. Adams    PCSetUp_GAMG - Prepares for the use of the GAMG preconditioner
5065b89ad90SMark F. Adams                     by setting data structures and options.
5075b89ad90SMark F. Adams 
5085b89ad90SMark F. Adams    Input Parameter:
5095b89ad90SMark F. Adams .  pc - the preconditioner context
5105b89ad90SMark F. Adams 
5115b89ad90SMark F. Adams */
5129d5b6da9SMark F. Adams PetscErrorCode PCSetUp_GAMG(PC pc)
5135b89ad90SMark F. Adams {
5145b89ad90SMark F. Adams   PetscErrorCode ierr;
5159d5b6da9SMark F. Adams   PC_MG          *mg      = (PC_MG*)pc->data;
5165b89ad90SMark F. Adams   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
5172adcac29SMark F. Adams   Mat            Pmat     = pc->pmat;
51818c3aa7eSMark   PetscInt       fine_level,level,level1,bs,M,N,qq,lidx,nASMBlocksArr[PETSC_MG_MAXLEVELS];
5193b4367a7SBarry Smith   MPI_Comm       comm;
520c5df96a5SBarry Smith   PetscMPIInt    rank,size,nactivepe;
52118c3aa7eSMark   Mat            Aarr[PETSC_MG_MAXLEVELS],Parr[PETSC_MG_MAXLEVELS];
52218c3aa7eSMark   IS             *ASMLocalIDsArr[PETSC_MG_MAXLEVELS];
523a2f3521dSMark F. Adams   PetscLogDouble nnz0=0.,nnztot=0.;
524569f4572SMark Adams   MatInfo        info;
525171cca9aSMark Adams   PetscBool      is_last = PETSC_FALSE;
5265ef31b24SMark F. Adams 
5275b89ad90SMark F. Adams   PetscFunctionBegin;
5283b4367a7SBarry Smith   ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
529ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRMPI(ierr);
530ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRMPI(ierr);
531dfd5c07aSMark F. Adams 
5328abdc6daSStefano Zampini   if (pc->setupcalled) {
5338abdc6daSStefano Zampini     if (!pc_gamg->reuse_prol || pc->flag == DIFFERENT_NONZERO_PATTERN) {
534878e152fSMark F. Adams       /* reset everything */
535878e152fSMark F. Adams       ierr = PCReset_MG(pc);CHKERRQ(ierr);
536878e152fSMark F. Adams       pc->setupcalled = 0;
537806fa848SBarry Smith     } else {
53884d3f75bSMark F. Adams       PC_MG_Levels **mglevels = mg->levels;
53903a628feSMark F. Adams       /* just do Galerkin grids */
54058471d46SMark F. Adams       Mat          B,dA,dB;
54158471d46SMark F. Adams 
5429d5b6da9SMark F. Adams       if (pc_gamg->Nlevels > 1) {
54358471d46SMark F. Adams         /* currently only handle case where mat and pmat are the same on coarser levels */
54423ee1639SBarry Smith         ierr = KSPGetOperators(mglevels[pc_gamg->Nlevels-1]->smoothd,&dA,&dB);CHKERRQ(ierr);
54558471d46SMark F. Adams         /* (re)set to get dirty flag */
54623ee1639SBarry Smith         ierr = KSPSetOperators(mglevels[pc_gamg->Nlevels-1]->smoothd,dA,dB);CHKERRQ(ierr);
54758471d46SMark F. Adams 
5482fb0b348SMark F. Adams         for (level=pc_gamg->Nlevels-2; level>=0; level--) {
5498abdc6daSStefano Zampini           MatReuse reuse = MAT_INITIAL_MATRIX ;
5508abdc6daSStefano Zampini 
5518abdc6daSStefano Zampini           /* matrix structure can change from repartitioning or process reduction but don't know if we have process reduction here. Should fix */
55223ee1639SBarry Smith           ierr = KSPGetOperators(mglevels[level]->smoothd,NULL,&B);CHKERRQ(ierr);
5538abdc6daSStefano Zampini           if (B->product) {
5548abdc6daSStefano Zampini             if (B->product->A == dB && B->product->B == mglevels[level+1]->interpolate) {
5558abdc6daSStefano Zampini               reuse = MAT_REUSE_MATRIX;
55603a628feSMark F. Adams             }
5578abdc6daSStefano Zampini           }
5588abdc6daSStefano Zampini           if (reuse == MAT_INITIAL_MATRIX) { ierr = MatDestroy(&mglevels[level]->A);CHKERRQ(ierr); }
5598abdc6daSStefano Zampini           if (reuse == MAT_REUSE_MATRIX) {
5608abdc6daSStefano Zampini             ierr = PetscInfo1(pc,"RAP after first solve, reuse matrix level %D\n",level);CHKERRQ(ierr);
5618abdc6daSStefano Zampini           } else {
5628abdc6daSStefano Zampini             ierr = PetscInfo1(pc,"RAP after first solve, new matrix level %D\n",level);CHKERRQ(ierr);
5638abdc6daSStefano Zampini           }
5648abdc6daSStefano Zampini           ierr = MatPtAP(dB,mglevels[level+1]->interpolate,reuse,PETSC_DEFAULT,&B);CHKERRQ(ierr);
5658abdc6daSStefano Zampini           mglevels[level]->A = B;
56623ee1639SBarry Smith           ierr = KSPSetOperators(mglevels[level]->smoothd,B,B);CHKERRQ(ierr);
56758471d46SMark F. Adams           dB   = B;
56858471d46SMark F. Adams         }
5695f8cf99dSMark F. Adams       }
570d5280255SMark F. Adams 
571d5280255SMark F. Adams       ierr = PCSetUp_MG(pc);CHKERRQ(ierr);
57258471d46SMark F. Adams       PetscFunctionReturn(0);
573eb07cef2SMark F. Adams     }
574878e152fSMark F. Adams   }
575f6536408SMark F. Adams 
576878e152fSMark F. Adams   if (!pc_gamg->data) {
577878e152fSMark F. Adams     if (pc_gamg->orig_data) {
578878e152fSMark F. Adams       ierr = MatGetBlockSize(Pmat, &bs);CHKERRQ(ierr);
5790298fd71SBarry Smith       ierr = MatGetLocalSize(Pmat, &qq, NULL);CHKERRQ(ierr);
5802fa5cd67SKarl Rupp 
581878e152fSMark F. Adams       pc_gamg->data_sz        = (qq/bs)*pc_gamg->orig_data_cell_rows*pc_gamg->orig_data_cell_cols;
582878e152fSMark F. Adams       pc_gamg->data_cell_rows = pc_gamg->orig_data_cell_rows;
583878e152fSMark F. Adams       pc_gamg->data_cell_cols = pc_gamg->orig_data_cell_cols;
5842fa5cd67SKarl Rupp 
585785e854fSJed Brown       ierr = PetscMalloc1(pc_gamg->data_sz, &pc_gamg->data);CHKERRQ(ierr);
586878e152fSMark F. Adams       for (qq=0; qq<pc_gamg->data_sz; qq++) pc_gamg->data[qq] = pc_gamg->orig_data[qq];
587806fa848SBarry Smith     } else {
5881ab5ffc9SJed Brown       if (!pc_gamg->ops->createdefaultdata) SETERRQ(comm,PETSC_ERR_PLIB,"'createdefaultdata' not set(?) need to support NULL data");
5897700e67bSMark Adams       ierr = pc_gamg->ops->createdefaultdata(pc,Pmat);CHKERRQ(ierr);
5909d5b6da9SMark F. Adams     }
591878e152fSMark F. Adams   }
592878e152fSMark F. Adams 
593878e152fSMark F. Adams   /* cache original data for reuse */
5941c1aac46SBarry Smith   if (!pc_gamg->orig_data && (PetscBool)(!pc_gamg->reuse_prol)) {
595785e854fSJed Brown     ierr = PetscMalloc1(pc_gamg->data_sz, &pc_gamg->orig_data);CHKERRQ(ierr);
596878e152fSMark F. Adams     for (qq=0; qq<pc_gamg->data_sz; qq++) pc_gamg->orig_data[qq] = pc_gamg->data[qq];
597878e152fSMark F. Adams     pc_gamg->orig_data_cell_rows = pc_gamg->data_cell_rows;
598878e152fSMark F. Adams     pc_gamg->orig_data_cell_cols = pc_gamg->data_cell_cols;
599878e152fSMark F. Adams   }
600038e3b61SMark F. Adams 
601302f38e8SMark F. Adams   /* get basic dims */
602302f38e8SMark F. Adams   ierr = MatGetBlockSize(Pmat, &bs);CHKERRQ(ierr);
603171cca9aSMark Adams   ierr = MatGetSize(Pmat, &M, &N);CHKERRQ(ierr);
60484d3f75bSMark F. Adams 
605569f4572SMark Adams   ierr = MatGetInfo(Pmat,MAT_GLOBAL_SUM,&info);CHKERRQ(ierr); /* global reduction */
606569f4572SMark Adams   nnz0   = info.nz_used;
607569f4572SMark Adams   nnztot = info.nz_used;
608c9567895SMark   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);
609569f4572SMark Adams 
610a2f3521dSMark F. Adams   /* Get A_i and R_i */
61162294041SBarry Smith   for (level=0, Aarr[0]=Pmat, nactivepe = size; level < (pc_gamg->Nlevels-1) && (!level || M>pc_gamg->coarse_eq_limit); level++) {
6129ab59c8bSMark Adams     pc_gamg->current_level = level;
61318c3aa7eSMark     if (level >= PETSC_MG_MAXLEVELS) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Too many levels %D",level);
6145b89ad90SMark F. Adams     level1 = level + 1;
6150cbbd2e1SMark F. Adams #if defined PETSC_GAMG_USE_LOG
6160cbbd2e1SMark F. Adams     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET1],0,0,0,0);CHKERRQ(ierr);
617a2f3521dSMark F. Adams #if (defined GAMG_STAGES)
618a2f3521dSMark F. Adams     ierr = PetscLogStagePush(gamg_stages[level]);CHKERRQ(ierr);
619b4fbaa2aSMark F. Adams #endif
620a2f3521dSMark F. Adams #endif
621c8b0795cSMark F. Adams     { /* construct prolongator */
622725b86d8SJed Brown       Mat              Gmat;
6230cbbd2e1SMark F. Adams       PetscCoarsenData *agg_lists;
6247700e67bSMark Adams       Mat              Prol11;
625c8b0795cSMark F. Adams 
6267700e67bSMark Adams       ierr = pc_gamg->ops->graph(pc,Aarr[level], &Gmat);CHKERRQ(ierr);
6271ab5ffc9SJed Brown       ierr = pc_gamg->ops->coarsen(pc, &Gmat, &agg_lists);CHKERRQ(ierr);
6287700e67bSMark Adams       ierr = pc_gamg->ops->prolongator(pc,Aarr[level],Gmat,agg_lists,&Prol11);CHKERRQ(ierr);
629c8b0795cSMark F. Adams 
630a2f3521dSMark F. Adams       /* could have failed to create new level */
631a2f3521dSMark F. Adams       if (Prol11) {
632f7df55f0SStefano Zampini         const char *prefix;
633f7df55f0SStefano Zampini         char       addp[32];
634f7df55f0SStefano Zampini 
6359d5b6da9SMark F. Adams         /* get new block size of coarse matrices */
6360298fd71SBarry Smith         ierr = MatGetBlockSizes(Prol11, NULL, &bs);CHKERRQ(ierr);
637a2f3521dSMark F. Adams 
638fd1112cbSBarry Smith         if (pc_gamg->ops->optprolongator) {
639c8b0795cSMark F. Adams           /* smooth */
640fd1112cbSBarry Smith           ierr = pc_gamg->ops->optprolongator(pc, Aarr[level], &Prol11);CHKERRQ(ierr);
641c8b0795cSMark F. Adams         }
642c8b0795cSMark F. Adams 
6430c3bc534SBarry Smith         if (pc_gamg->use_aggs_in_asm) {
6441b18a24aSMark Adams           PetscInt bs;
6451b18a24aSMark Adams           ierr = MatGetBlockSizes(Prol11, &bs, NULL);CHKERRQ(ierr);
6460a3c815dSMark Adams           ierr = PetscCDGetASMBlocks(agg_lists, bs, Gmat, &nASMBlocksArr[level], &ASMLocalIDsArr[level]);CHKERRQ(ierr);
647ffc955d6SMark F. Adams         }
648ffc955d6SMark F. Adams 
649f7df55f0SStefano Zampini         ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
650f7df55f0SStefano Zampini         ierr = MatSetOptionsPrefix(Prol11,prefix);CHKERRQ(ierr);
651c9567895SMark         ierr = PetscSNPrintf(addp,sizeof(addp),"pc_gamg_prolongator_%d_",(int)level);CHKERRQ(ierr);
652f7df55f0SStefano Zampini         ierr = MatAppendOptionsPrefix(Prol11,addp);CHKERRQ(ierr);
65391f31d3dSStefano Zampini         /* Always generate the transpose with CUDA
654f7df55f0SStefano Zampini            Such behaviour can be adapted with -pc_gamg_prolongator_ prefixed options */
655f7df55f0SStefano Zampini #if defined(PETSC_HAVE_CUDA)
656*e589036eSStefano Zampini         ierr = MatAIJCUSPARSESetGenerateTranspose(Prol11,PETSC_TRUE);CHKERRQ(ierr);
657f7df55f0SStefano Zampini #endif
658f7df55f0SStefano Zampini         ierr = MatSetFromOptions(Prol11);CHKERRQ(ierr);
6594bde40a0SMark Adams         Parr[level1] = Prol11;
6604bde40a0SMark Adams       } else Parr[level1] = NULL; /* failed to coarsen */
6614bde40a0SMark Adams 
662a2f3521dSMark F. Adams       ierr = MatDestroy(&Gmat);CHKERRQ(ierr);
66341b27cdeSMark F. Adams       ierr = PetscCDDestroy(agg_lists);CHKERRQ(ierr);
664a2f3521dSMark F. Adams     } /* construct prolongator scope */
6650cbbd2e1SMark F. Adams #if defined PETSC_GAMG_USE_LOG
6660cbbd2e1SMark F. Adams     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET1],0,0,0,0);CHKERRQ(ierr);
667c8b0795cSMark F. Adams #endif
6687f66b68fSMark Adams     if (!level) Aarr[0] = Pmat; /* use Pmat for finest level setup */
669171cca9aSMark Adams     if (!Parr[level1]) { /* failed to coarsen */
670569f4572SMark Adams       ierr =  PetscInfo1(pc,"Stop gridding, level %D\n",level);CHKERRQ(ierr);
67162294041SBarry Smith #if defined PETSC_GAMG_USE_LOG && defined GAMG_STAGES
672a90e85d9SMark Adams       ierr = PetscLogStagePop();CHKERRQ(ierr);
673a90e85d9SMark Adams #endif
674c8b0795cSMark F. Adams       break;
675c8b0795cSMark F. Adams     }
6760cbbd2e1SMark F. Adams #if defined PETSC_GAMG_USE_LOG
6770cbbd2e1SMark F. Adams     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET2],0,0,0,0);CHKERRQ(ierr);
678b4fbaa2aSMark F. Adams #endif
679171cca9aSMark Adams     ierr = MatGetSize(Parr[level1], &M, &N);CHKERRQ(ierr); /* N is next M, a loop test variables */
680c9567895SMark     if (is_last) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Is last ?");
681171cca9aSMark Adams     if (N <= pc_gamg->coarse_eq_limit) is_last = PETSC_TRUE;
6820e2909e1SMark Adams     if (level1 == pc_gamg->Nlevels-1) is_last = PETSC_TRUE;
683171cca9aSMark Adams     ierr = pc_gamg->ops->createlevel(pc, Aarr[level], bs, &Parr[level1], &Aarr[level1], &nactivepe, NULL, is_last);CHKERRQ(ierr);
684a2f3521dSMark F. Adams 
6850cbbd2e1SMark F. Adams #if defined PETSC_GAMG_USE_LOG
6860cbbd2e1SMark F. Adams     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET2],0,0,0,0);CHKERRQ(ierr);
687b4fbaa2aSMark F. Adams #endif
688171cca9aSMark Adams     ierr = MatGetSize(Aarr[level1], &M, &N);CHKERRQ(ierr); /* M is loop test variables */
689569f4572SMark Adams     ierr = MatGetInfo(Aarr[level1], MAT_GLOBAL_SUM, &info);CHKERRQ(ierr);
690569f4572SMark Adams     nnztot += info.nz_used;
691c9567895SMark     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);
692569f4572SMark Adams 
6930cbbd2e1SMark F. Adams #if (defined PETSC_GAMG_USE_LOG && defined GAMG_STAGES)
694b4fbaa2aSMark F. Adams     ierr = PetscLogStagePop();CHKERRQ(ierr);
695b4fbaa2aSMark F. Adams #endif
696a90e85d9SMark Adams     /* stop if one node or one proc -- could pull back for singular problems */
6979ab59c8bSMark Adams     if ((pc_gamg->data_cell_cols && M/pc_gamg->data_cell_cols < 2) || (!pc_gamg->data_cell_cols && M/bs < 2)) {
6989ab59c8bSMark Adams       ierr =  PetscInfo2(pc,"HARD stop of coarsening on level %D.  Grid too small: %D block nodes\n",level,M/bs);CHKERRQ(ierr);
699a90e85d9SMark Adams       level++;
700a90e85d9SMark Adams       break;
701a90e85d9SMark Adams     }
702c8b0795cSMark F. Adams   } /* levels */
703c8b0795cSMark F. Adams   ierr = PetscFree(pc_gamg->data);CHKERRQ(ierr);
704c8b0795cSMark F. Adams 
705569f4572SMark Adams   ierr = PetscInfo2(pc,"%D levels, grid complexity = %g\n",level+1,nnztot/nnz0);CHKERRQ(ierr);
7069d5b6da9SMark F. Adams   pc_gamg->Nlevels = level + 1;
7075b89ad90SMark F. Adams   fine_level       = level;
7080298fd71SBarry Smith   ierr             = PCMGSetLevels(pc,pc_gamg->Nlevels,NULL);CHKERRQ(ierr);
7095b89ad90SMark F. Adams 
71062294041SBarry Smith   if (pc_gamg->Nlevels > 1) { /* don't setup MG if one level */
7110ed2132dSStefano Zampini     PetscErrorCode (*savesetfromoptions[PETSC_MG_MAXLEVELS])(PetscOptionItems*,KSP);
7120ed2132dSStefano Zampini 
713d5280255SMark F. Adams     /* set default smoothers & set operators */
71462294041SBarry Smith     for (lidx = 1, level = pc_gamg->Nlevels-2; lidx <= fine_level; lidx++, level--) {
715ffc955d6SMark F. Adams       KSP smoother;
716ffc955d6SMark F. Adams       PC  subpc;
717a2f3521dSMark F. Adams 
7189d5b6da9SMark F. Adams       ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
719f6536408SMark F. Adams       ierr = KSPGetPC(smoother, &subpc);CHKERRQ(ierr);
720ffc955d6SMark F. Adams 
721a2f3521dSMark F. Adams       ierr = KSPSetNormType(smoother, KSP_NORM_NONE);CHKERRQ(ierr);
722a2f3521dSMark F. Adams       /* set ops */
72323ee1639SBarry Smith       ierr = KSPSetOperators(smoother, Aarr[level], Aarr[level]);CHKERRQ(ierr);
724a2f3521dSMark F. Adams       ierr = PCMGSetInterpolation(pc, lidx, Parr[level+1]);CHKERRQ(ierr);
725a2f3521dSMark F. Adams 
726a2f3521dSMark F. Adams       /* set defaults */
7276c9de887SHong Zhang       ierr = KSPSetType(smoother, KSPCHEBYSHEV);CHKERRQ(ierr);
728a2f3521dSMark F. Adams 
7290c3bc534SBarry Smith       /* set blocks for ASM smoother that uses the 'aggregates' */
7300c3bc534SBarry Smith       if (pc_gamg->use_aggs_in_asm) {
7312d3561bbSSatish Balay         PetscInt sz;
7327a28f3e5SMark Adams         IS       *iss;
733a2f3521dSMark F. Adams 
7342d3561bbSSatish Balay         sz   = nASMBlocksArr[level];
7357a28f3e5SMark Adams         iss  = ASMLocalIDsArr[level];
7360c3bc534SBarry Smith         ierr = PCSetType(subpc, PCASM);CHKERRQ(ierr);
7370a3c815dSMark Adams         ierr = PCASMSetOverlap(subpc, 0);CHKERRQ(ierr);
7380c3bc534SBarry Smith         ierr = PCASMSetType(subpc,PC_ASM_BASIC);CHKERRQ(ierr);
7397f66b68fSMark Adams         if (!sz) {
740ffc955d6SMark F. Adams           IS       is;
7410a3c815dSMark Adams           ierr = ISCreateGeneral(PETSC_COMM_SELF, 0, NULL, PETSC_COPY_VALUES, &is);CHKERRQ(ierr);
7427a28f3e5SMark Adams           ierr = PCASMSetLocalSubdomains(subpc, 1, NULL, &is);CHKERRQ(ierr);
743a94c3b12SMark F. Adams           ierr = ISDestroy(&is);CHKERRQ(ierr);
744806fa848SBarry Smith         } else {
745a94c3b12SMark F. Adams           PetscInt kk;
7467a28f3e5SMark Adams           ierr = PCASMSetLocalSubdomains(subpc, sz, NULL, iss);CHKERRQ(ierr);
747a94c3b12SMark F. Adams           for (kk=0; kk<sz; kk++) {
7487a28f3e5SMark Adams             ierr = ISDestroy(&iss[kk]);CHKERRQ(ierr);
749a94c3b12SMark F. Adams           }
7507a28f3e5SMark Adams           ierr = PetscFree(iss);CHKERRQ(ierr);
751ffc955d6SMark F. Adams         }
7520298fd71SBarry Smith         ASMLocalIDsArr[level] = NULL;
753ffc955d6SMark F. Adams         nASMBlocksArr[level]  = 0;
754806fa848SBarry Smith       } else {
755890ffe84SMark Adams         ierr = PCSetType(subpc, PCSOR);CHKERRQ(ierr);
756ffc955d6SMark F. Adams       }
757d5280255SMark F. Adams     }
758d5280255SMark F. Adams     {
759d5280255SMark F. Adams       /* coarse grid */
760d5280255SMark F. Adams       KSP smoother,*k2; PC subpc,pc2; PetscInt ii,first;
761d5280255SMark F. Adams       Mat Lmat = Aarr[(level=pc_gamg->Nlevels-1)]; lidx = 0;
7620ed2132dSStefano Zampini 
763d5280255SMark F. Adams       ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
76423ee1639SBarry Smith       ierr = KSPSetOperators(smoother, Lmat, Lmat);CHKERRQ(ierr);
765cf8ae1d3SMark Adams       if (!pc_gamg->use_parallel_coarse_grid_solver) {
766d5280255SMark F. Adams         ierr = KSPSetNormType(smoother, KSP_NORM_NONE);CHKERRQ(ierr);
767d5280255SMark F. Adams         ierr = KSPGetPC(smoother, &subpc);CHKERRQ(ierr);
768d5280255SMark F. Adams         ierr = PCSetType(subpc, PCBJACOBI);CHKERRQ(ierr);
769d5280255SMark F. Adams         ierr = PCSetUp(subpc);CHKERRQ(ierr);
77071959b99SBarry Smith         ierr = PCBJacobiGetSubKSP(subpc,&ii,&first,&k2);CHKERRQ(ierr);
77171959b99SBarry Smith         if (ii != 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"ii %D is not one",ii);
772d5280255SMark F. Adams         ierr = KSPGetPC(k2[0],&pc2);CHKERRQ(ierr);
773d5280255SMark F. Adams         ierr = PCSetType(pc2, PCLU);CHKERRQ(ierr);
7749dbfc187SHong Zhang         ierr = PCFactorSetShiftType(pc2,MAT_SHIFT_INBLOCKS);CHKERRQ(ierr);
7752fb0b348SMark F. Adams         ierr = KSPSetTolerances(k2[0],PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT,1);CHKERRQ(ierr);
77608e36f19SMark Adams         ierr = KSPSetType(k2[0], KSPPREONLY);CHKERRQ(ierr);
7775b42dca8SJed Brown         /* This flag gets reset by PCBJacobiGetSubKSP(), but our BJacobi really does the same algorithm everywhere (and in
7785b42dca8SJed Brown          * fact, all but one process will have zero dofs), so we reset the flag to avoid having PCView_BJacobi attempt to
7795b42dca8SJed Brown          * view every subdomain as though they were different. */
7805b42dca8SJed Brown         ((PC_BJacobi*)subpc->data)->same_local_solves = PETSC_TRUE;
781d5280255SMark F. Adams       }
782cf8ae1d3SMark Adams     }
783d5280255SMark F. Adams 
784d5280255SMark F. Adams     /* should be called in PCSetFromOptions_GAMG(), but cannot be called prior to PCMGSetLevels() */
785d5280255SMark F. Adams     ierr = PetscObjectOptionsBegin((PetscObject)pc);CHKERRQ(ierr);
786e55864a3SBarry Smith     ierr = PCSetFromOptions_MG(PetscOptionsObject,pc);CHKERRQ(ierr);
787d5280255SMark F. Adams     ierr = PetscOptionsEnd();CHKERRQ(ierr);
78869aca0b8SBarry Smith     ierr = PCMGSetGalerkin(pc,PC_MG_GALERKIN_EXTERNAL);CHKERRQ(ierr);
789d5280255SMark F. Adams 
79018c3aa7eSMark     /* setup cheby eigen estimates from SA */
7910ed2132dSStefano Zampini     if (pc_gamg->use_sa_esteig==1) {
79218c3aa7eSMark       for (lidx = 1, level = pc_gamg->Nlevels-2; level >= 0 ; lidx++, level--) {
79318c3aa7eSMark         KSP       smoother;
79418c3aa7eSMark         PetscBool ischeb;
7950ed2132dSStefano Zampini 
7960ed2132dSStefano Zampini         savesetfromoptions[level] = NULL;
79718c3aa7eSMark         ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
79818c3aa7eSMark         ierr = PetscObjectTypeCompare((PetscObject)smoother,KSPCHEBYSHEV,&ischeb);CHKERRQ(ierr);
79918c3aa7eSMark         if (ischeb) {
80018c3aa7eSMark           KSP_Chebyshev *cheb = (KSP_Chebyshev*)smoother->data;
8010ed2132dSStefano Zampini 
8020ed2132dSStefano Zampini           ierr = KSPSetFromOptions(smoother);CHKERRQ(ierr); /* let command line emax override using SA's eigenvalues */
8030ed2132dSStefano Zampini           if (mg->max_eigen_DinvA[level] > 0 && cheb->emax == 0.) {
80418c3aa7eSMark             PC        subpc;
80518c3aa7eSMark             PetscBool isjac;
80618c3aa7eSMark             ierr = KSPGetPC(smoother, &subpc);CHKERRQ(ierr);
80718c3aa7eSMark             ierr = PetscObjectTypeCompare((PetscObject)subpc,PCJACOBI,&isjac);CHKERRQ(ierr);
8080ed2132dSStefano Zampini             if (isjac && pc_gamg->use_sa_esteig==1) {
80918c3aa7eSMark               PetscReal emax,emin;
8100ed2132dSStefano Zampini 
81118c3aa7eSMark               emin = mg->min_eigen_DinvA[level];
81218c3aa7eSMark               emax = mg->max_eigen_DinvA[level];
81318c3aa7eSMark               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);
81418c3aa7eSMark               cheb->emin_computed = emin;
81518c3aa7eSMark               cheb->emax_computed = emax;
81618c3aa7eSMark               ierr = KSPChebyshevSetEigenvalues(smoother, cheb->tform[2]*emin + cheb->tform[3]*emax, cheb->tform[0]*emin + cheb->tform[1]*emax);CHKERRQ(ierr);
8170ed2132dSStefano Zampini 
8180ed2132dSStefano Zampini               /* We have set the eigenvalues and consumed the transformation values
8190ed2132dSStefano Zampini                  prevent from flagging the recomputation of the eigenvalues again in PCSetUp_MG
8200ed2132dSStefano Zampini                  below when setfromoptions will be called again */
8210ed2132dSStefano Zampini               savesetfromoptions[level] = smoother->ops->setfromoptions;
8220ed2132dSStefano Zampini               smoother->ops->setfromoptions = NULL;
82318c3aa7eSMark             }
82418c3aa7eSMark           }
82518c3aa7eSMark         }
82618c3aa7eSMark       }
8270ed2132dSStefano Zampini     }
8280ed2132dSStefano Zampini 
8290ed2132dSStefano Zampini     ierr = PCSetUp_MG(pc);CHKERRQ(ierr);
8300ed2132dSStefano Zampini 
8310ed2132dSStefano Zampini     /* restore Chebyshev smoother for next calls */
8320ed2132dSStefano Zampini     if (pc_gamg->use_sa_esteig==1) {
8330ed2132dSStefano Zampini       for (lidx = 1, level = pc_gamg->Nlevels-2; level >= 0 ; lidx++, level--) {
8340ed2132dSStefano Zampini         if (savesetfromoptions[level]) {
8350ed2132dSStefano Zampini           KSP smoother;
8360ed2132dSStefano Zampini           ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
8370ed2132dSStefano Zampini           smoother->ops->setfromoptions = savesetfromoptions[level];
8380ed2132dSStefano Zampini         }
8390ed2132dSStefano Zampini       }
8400ed2132dSStefano Zampini     }
84118c3aa7eSMark 
842d5280255SMark F. Adams     /* clean up */
843d5280255SMark F. Adams     for (level=1; level<pc_gamg->Nlevels; level++) {
844587fa25dSMark F. Adams       ierr = MatDestroy(&Parr[level]);CHKERRQ(ierr);
845587fa25dSMark F. Adams       ierr = MatDestroy(&Aarr[level]);CHKERRQ(ierr);
8465b89ad90SMark F. Adams     }
847806fa848SBarry Smith   } else {
8485f8cf99dSMark F. Adams     KSP smoother;
8490ed2132dSStefano Zampini 
850302440fdSBarry Smith     ierr = PetscInfo(pc,"One level solver used (system is seen as DD). Using default solver.\n");CHKERRQ(ierr);
8519d5b6da9SMark F. Adams     ierr = PCMGGetSmoother(pc, 0, &smoother);CHKERRQ(ierr);
85223ee1639SBarry Smith     ierr = KSPSetOperators(smoother, Aarr[0], Aarr[0]);CHKERRQ(ierr);
8535f8cf99dSMark F. Adams     ierr = KSPSetType(smoother, KSPPREONLY);CHKERRQ(ierr);
8549d5b6da9SMark F. Adams     ierr = PCSetUp_MG(pc);CHKERRQ(ierr);
8555f8cf99dSMark F. Adams   }
8565b89ad90SMark F. Adams   PetscFunctionReturn(0);
8575b89ad90SMark F. Adams }
8585b89ad90SMark F. Adams 
859eb07cef2SMark F. Adams /* ------------------------------------------------------------------------- */
8605b89ad90SMark F. Adams /*
8615b89ad90SMark F. Adams  PCDestroy_GAMG - Destroys the private context for the GAMG preconditioner
8625b89ad90SMark F. Adams    that was created with PCCreate_GAMG().
8635b89ad90SMark F. Adams 
8645b89ad90SMark F. Adams    Input Parameter:
8655b89ad90SMark F. Adams .  pc - the preconditioner context
8665b89ad90SMark F. Adams 
8675b89ad90SMark F. Adams    Application Interface Routine: PCDestroy()
8685b89ad90SMark F. Adams */
8695b89ad90SMark F. Adams PetscErrorCode PCDestroy_GAMG(PC pc)
8705b89ad90SMark F. Adams {
8715b89ad90SMark F. Adams   PetscErrorCode ierr;
8725b89ad90SMark F. Adams   PC_MG          *mg     = (PC_MG*)pc->data;
8735b89ad90SMark F. Adams   PC_GAMG        *pc_gamg= (PC_GAMG*)mg->innerctx;
8745b89ad90SMark F. Adams 
8755b89ad90SMark F. Adams   PetscFunctionBegin;
8765b89ad90SMark F. Adams   ierr = PCReset_GAMG(pc);CHKERRQ(ierr);
8779b8ffb57SJed Brown   if (pc_gamg->ops->destroy) {
8789b8ffb57SJed Brown     ierr = (*pc_gamg->ops->destroy)(pc);CHKERRQ(ierr);
8799b8ffb57SJed Brown   }
8801ab5ffc9SJed Brown   ierr = PetscFree(pc_gamg->ops);CHKERRQ(ierr);
8811ab5ffc9SJed Brown   ierr = PetscFree(pc_gamg->gamg_type_name);CHKERRQ(ierr);
8825b89ad90SMark F. Adams   ierr = PetscFree(pc_gamg);CHKERRQ(ierr);
8835b89ad90SMark F. Adams   ierr = PCDestroy_MG(pc);CHKERRQ(ierr);
8845b89ad90SMark F. Adams   PetscFunctionReturn(0);
8855b89ad90SMark F. Adams }
8865b89ad90SMark F. Adams 
887676e1743SMark F. Adams /*@
888cab9ed1eSBarry Smith    PCGAMGSetProcEqLim - Set number of equations to aim for per process on the coarse grids via processor reduction.
889676e1743SMark F. Adams 
8901cc46a46SBarry Smith    Logically Collective on PC
891676e1743SMark F. Adams 
892676e1743SMark F. Adams    Input Parameters:
8931cc46a46SBarry Smith +  pc - the preconditioner context
8941cc46a46SBarry Smith -  n - the number of equations
895676e1743SMark F. Adams 
896676e1743SMark F. Adams 
897676e1743SMark F. Adams    Options Database Key:
8981cc46a46SBarry Smith .  -pc_gamg_process_eq_limit <limit>
899676e1743SMark F. Adams 
90095452b02SPatrick Sanan    Notes:
90195452b02SPatrick 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
902cab9ed1eSBarry Smith           that has degrees of freedom
903cab9ed1eSBarry Smith 
904676e1743SMark F. Adams    Level: intermediate
905676e1743SMark F. Adams 
906c9567895SMark .seealso: PCGAMGSetCoarseEqLim(), PCGAMGSetRankReductionFactors()
907676e1743SMark F. Adams @*/
908676e1743SMark F. Adams PetscErrorCode  PCGAMGSetProcEqLim(PC pc, PetscInt n)
909676e1743SMark F. Adams {
910676e1743SMark F. Adams   PetscErrorCode ierr;
911676e1743SMark F. Adams 
912676e1743SMark F. Adams   PetscFunctionBegin;
913676e1743SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
914676e1743SMark F. Adams   ierr = PetscTryMethod(pc,"PCGAMGSetProcEqLim_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
915676e1743SMark F. Adams   PetscFunctionReturn(0);
916676e1743SMark F. Adams }
917676e1743SMark F. Adams 
9181e6b0712SBarry Smith static PetscErrorCode PCGAMGSetProcEqLim_GAMG(PC pc, PetscInt n)
919676e1743SMark F. Adams {
920c20e4228SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
921c20e4228SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
922676e1743SMark F. Adams 
923676e1743SMark F. Adams   PetscFunctionBegin;
9249d5b6da9SMark F. Adams   if (n>0) pc_gamg->min_eq_proc = n;
925676e1743SMark F. Adams   PetscFunctionReturn(0);
926676e1743SMark F. Adams }
927676e1743SMark F. Adams 
928389730f3SMark F. Adams /*@
929cab9ed1eSBarry Smith    PCGAMGSetCoarseEqLim - Set maximum number of equations on coarsest grid.
930389730f3SMark F. Adams 
931389730f3SMark F. Adams  Collective on PC
932389730f3SMark F. Adams 
933389730f3SMark F. Adams    Input Parameters:
9341cc46a46SBarry Smith +  pc - the preconditioner context
9351cc46a46SBarry Smith -  n - maximum number of equations to aim for
936389730f3SMark F. Adams 
937389730f3SMark F. Adams    Options Database Key:
9381cc46a46SBarry Smith .  -pc_gamg_coarse_eq_limit <limit>
939389730f3SMark F. Adams 
94074329af1SBarry Smith    Notes: For example -pc_gamg_coarse_eq_limit 1000 will stop coarsening once the coarse grid
94174329af1SBarry Smith      has less than 1000 unknowns.
94274329af1SBarry Smith 
943389730f3SMark F. Adams    Level: intermediate
944389730f3SMark F. Adams 
945c9567895SMark .seealso: PCGAMGSetProcEqLim(), PCGAMGSetRankReductionFactors()
946389730f3SMark F. Adams @*/
947389730f3SMark F. Adams PetscErrorCode PCGAMGSetCoarseEqLim(PC pc, PetscInt n)
948389730f3SMark F. Adams {
949389730f3SMark F. Adams   PetscErrorCode ierr;
950389730f3SMark F. Adams 
951389730f3SMark F. Adams   PetscFunctionBegin;
952389730f3SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
953389730f3SMark F. Adams   ierr = PetscTryMethod(pc,"PCGAMGSetCoarseEqLim_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
954389730f3SMark F. Adams   PetscFunctionReturn(0);
955389730f3SMark F. Adams }
956389730f3SMark F. Adams 
9571e6b0712SBarry Smith static PetscErrorCode PCGAMGSetCoarseEqLim_GAMG(PC pc, PetscInt n)
958389730f3SMark F. Adams {
959389730f3SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
960389730f3SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
961389730f3SMark F. Adams 
962389730f3SMark F. Adams   PetscFunctionBegin;
9639d5b6da9SMark F. Adams   if (n>0) pc_gamg->coarse_eq_limit = n;
964389730f3SMark F. Adams   PetscFunctionReturn(0);
965389730f3SMark F. Adams }
966389730f3SMark F. Adams 
967676e1743SMark F. Adams /*@
968cab9ed1eSBarry Smith    PCGAMGSetRepartition - Repartition the degrees of freedom across the processors on the coarser grids
969676e1743SMark F. Adams 
970676e1743SMark F. Adams    Collective on PC
971676e1743SMark F. Adams 
972676e1743SMark F. Adams    Input Parameters:
9731cc46a46SBarry Smith +  pc - the preconditioner context
9741cc46a46SBarry Smith -  n - PETSC_TRUE or PETSC_FALSE
975676e1743SMark F. Adams 
976676e1743SMark F. Adams    Options Database Key:
9771cc46a46SBarry Smith .  -pc_gamg_repartition <true,false>
978676e1743SMark F. Adams 
97995452b02SPatrick Sanan    Notes:
98095452b02SPatrick Sanan     this will generally improve the loading balancing of the work on each level
981cab9ed1eSBarry Smith 
982676e1743SMark F. Adams    Level: intermediate
983676e1743SMark F. Adams 
984676e1743SMark F. Adams .seealso: ()
985676e1743SMark F. Adams @*/
986cab9ed1eSBarry Smith PetscErrorCode PCGAMGSetRepartition(PC pc, PetscBool n)
987676e1743SMark F. Adams {
988676e1743SMark F. Adams   PetscErrorCode ierr;
989676e1743SMark F. Adams 
990676e1743SMark F. Adams   PetscFunctionBegin;
991676e1743SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
992cab9ed1eSBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGSetRepartition_C",(PC,PetscBool),(pc,n));CHKERRQ(ierr);
993676e1743SMark F. Adams   PetscFunctionReturn(0);
994676e1743SMark F. Adams }
995676e1743SMark F. Adams 
996cab9ed1eSBarry Smith static PetscErrorCode PCGAMGSetRepartition_GAMG(PC pc, PetscBool n)
997676e1743SMark F. Adams {
998c20e4228SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
999c20e4228SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1000676e1743SMark F. Adams 
1001676e1743SMark F. Adams   PetscFunctionBegin;
10029d5b6da9SMark F. Adams   pc_gamg->repart = n;
1003676e1743SMark F. Adams   PetscFunctionReturn(0);
1004676e1743SMark F. Adams }
1005676e1743SMark F. Adams 
1006dfd5c07aSMark F. Adams /*@
100718c3aa7eSMark    PCGAMGSetEstEigKSPMaxIt - Set number of KSP iterations in eigen estimator (for Cheby)
100818c3aa7eSMark 
100918c3aa7eSMark    Collective on PC
101018c3aa7eSMark 
101118c3aa7eSMark    Input Parameters:
101218c3aa7eSMark +  pc - the preconditioner context
101318c3aa7eSMark -  n - number of its
101418c3aa7eSMark 
101518c3aa7eSMark    Options Database Key:
101618c3aa7eSMark .  -pc_gamg_esteig_ksp_max_it <its>
101718c3aa7eSMark 
101818c3aa7eSMark    Notes:
101918c3aa7eSMark 
102018c3aa7eSMark    Level: intermediate
102118c3aa7eSMark 
102218c3aa7eSMark .seealso: ()
102318c3aa7eSMark @*/
102418c3aa7eSMark PetscErrorCode PCGAMGSetEstEigKSPMaxIt(PC pc, PetscInt n)
102518c3aa7eSMark {
102618c3aa7eSMark   PetscErrorCode ierr;
102718c3aa7eSMark 
102818c3aa7eSMark   PetscFunctionBegin;
102918c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
103018c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetEstEigKSPMaxIt_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
103118c3aa7eSMark   PetscFunctionReturn(0);
103218c3aa7eSMark }
103318c3aa7eSMark 
103418c3aa7eSMark static PetscErrorCode PCGAMGSetEstEigKSPMaxIt_GAMG(PC pc, PetscInt n)
103518c3aa7eSMark {
103618c3aa7eSMark   PC_MG   *mg      = (PC_MG*)pc->data;
103718c3aa7eSMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
103818c3aa7eSMark 
103918c3aa7eSMark   PetscFunctionBegin;
104018c3aa7eSMark   pc_gamg->esteig_max_it = n;
104118c3aa7eSMark   PetscFunctionReturn(0);
104218c3aa7eSMark }
104318c3aa7eSMark 
104418c3aa7eSMark /*@
104518c3aa7eSMark    PCGAMGSetUseSAEstEig - Use eigen estimate from smoothed aggregation for Cheby smoother
104618c3aa7eSMark 
104718c3aa7eSMark    Collective on PC
104818c3aa7eSMark 
104918c3aa7eSMark    Input Parameters:
105018c3aa7eSMark +  pc - the preconditioner context
105118c3aa7eSMark -  n - number of its
105218c3aa7eSMark 
105318c3aa7eSMark    Options Database Key:
105418c3aa7eSMark .  -pc_gamg_use_sa_esteig <true,false>
105518c3aa7eSMark 
105618c3aa7eSMark    Notes:
105718c3aa7eSMark 
105818c3aa7eSMark    Level: intermediate
105918c3aa7eSMark 
106018c3aa7eSMark .seealso: ()
106118c3aa7eSMark @*/
106218c3aa7eSMark PetscErrorCode PCGAMGSetUseSAEstEig(PC pc, PetscBool n)
106318c3aa7eSMark {
106418c3aa7eSMark   PetscErrorCode ierr;
106518c3aa7eSMark 
106618c3aa7eSMark   PetscFunctionBegin;
106718c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
106818c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetUseSAEstEig_C",(PC,PetscBool),(pc,n));CHKERRQ(ierr);
106918c3aa7eSMark   PetscFunctionReturn(0);
107018c3aa7eSMark }
107118c3aa7eSMark 
10720ed2132dSStefano Zampini static PetscErrorCode PCGAMGSetUseSAEstEig_GAMG(PC pc, PetscBool n)
107318c3aa7eSMark {
107418c3aa7eSMark   PC_MG   *mg      = (PC_MG*)pc->data;
107518c3aa7eSMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
107618c3aa7eSMark 
107718c3aa7eSMark   PetscFunctionBegin;
107818c3aa7eSMark   pc_gamg->use_sa_esteig = n ? 1 : 0;
107918c3aa7eSMark   PetscFunctionReturn(0);
108018c3aa7eSMark }
108118c3aa7eSMark 
108218c3aa7eSMark /*@C
108318c3aa7eSMark    PCGAMGSetEstEigKSPType - Set type of KSP in eigen estimator (for Cheby)
108418c3aa7eSMark 
108518c3aa7eSMark    Collective on PC
108618c3aa7eSMark 
108718c3aa7eSMark    Input Parameters:
108818c3aa7eSMark +  pc - the preconditioner context
108918c3aa7eSMark -  t - ksp type
109018c3aa7eSMark 
109118c3aa7eSMark    Options Database Key:
109218c3aa7eSMark .  -pc_gamg_esteig_ksp_type <type>
109318c3aa7eSMark 
109418c3aa7eSMark    Notes:
109518c3aa7eSMark 
109618c3aa7eSMark    Level: intermediate
109718c3aa7eSMark 
109818c3aa7eSMark .seealso: ()
109918c3aa7eSMark @*/
110018c3aa7eSMark PetscErrorCode PCGAMGSetEstEigKSPType(PC pc, char t[])
110118c3aa7eSMark {
110218c3aa7eSMark   PetscErrorCode ierr;
110318c3aa7eSMark 
110418c3aa7eSMark   PetscFunctionBegin;
110518c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
110618c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetEstEigKSPType_C",(PC,char[]),(pc,t));CHKERRQ(ierr);
110718c3aa7eSMark   PetscFunctionReturn(0);
110818c3aa7eSMark }
110918c3aa7eSMark 
111018c3aa7eSMark static PetscErrorCode PCGAMGSetEstEigKSPType_GAMG(PC pc, char t[])
111118c3aa7eSMark {
111218c3aa7eSMark   PetscErrorCode ierr;
111318c3aa7eSMark   PC_MG   *mg      = (PC_MG*)pc->data;
111418c3aa7eSMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
111518c3aa7eSMark 
111618c3aa7eSMark   PetscFunctionBegin;
111718c3aa7eSMark   ierr = PetscStrcpy(pc_gamg->esteig_type,t);CHKERRQ(ierr);
111818c3aa7eSMark   PetscFunctionReturn(0);
111918c3aa7eSMark }
112018c3aa7eSMark 
112118c3aa7eSMark /*@
112218c3aa7eSMark    PCGAMGSetEigenvalues - Set eigenvalues
112318c3aa7eSMark 
112418c3aa7eSMark    Collective on PC
112518c3aa7eSMark 
112618c3aa7eSMark    Input Parameters:
112718c3aa7eSMark +  pc - the preconditioner context
112818c3aa7eSMark -  emax - max eigenvalue
112918c3aa7eSMark .  emin - min eigenvalue
113018c3aa7eSMark 
113118c3aa7eSMark    Options Database Key:
113218c3aa7eSMark .  -pc_gamg_eigenvalues
113318c3aa7eSMark 
113418c3aa7eSMark    Level: intermediate
113518c3aa7eSMark 
113618c3aa7eSMark .seealso: PCGAMGSetEstEigKSPMaxIt(), PCGAMGSetUseSAEstEig(), PCGAMGSetEstEigKSPType()
113718c3aa7eSMark @*/
113818c3aa7eSMark PetscErrorCode PCGAMGSetEigenvalues(PC pc, PetscReal emax,PetscReal emin)
113918c3aa7eSMark {
114018c3aa7eSMark   PetscErrorCode ierr;
114118c3aa7eSMark 
114218c3aa7eSMark   PetscFunctionBegin;
114318c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
114418c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetEigenvalues_C",(PC,PetscReal,PetscReal),(pc,emax,emin));CHKERRQ(ierr);
114518c3aa7eSMark   PetscFunctionReturn(0);
114618c3aa7eSMark }
114718c3aa7eSMark static PetscErrorCode PCGAMGSetEigenvalues_GAMG(PC pc,PetscReal emax,PetscReal emin)
114818c3aa7eSMark {
114918c3aa7eSMark   PC_MG          *mg      = (PC_MG*)pc->data;
115018c3aa7eSMark   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
115118c3aa7eSMark 
115218c3aa7eSMark   PetscFunctionBegin;
115318c3aa7eSMark   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);
115418c3aa7eSMark   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);
115518c3aa7eSMark   pc_gamg->emax = emax;
115618c3aa7eSMark   pc_gamg->emin = emin;
115718c3aa7eSMark 
115818c3aa7eSMark   PetscFunctionReturn(0);
115918c3aa7eSMark }
116018c3aa7eSMark 
116118c3aa7eSMark /*@
1162cab9ed1eSBarry Smith    PCGAMGSetReuseInterpolation - Reuse prolongation when rebuilding algebraic multigrid preconditioner
1163dfd5c07aSMark F. Adams 
1164dfd5c07aSMark F. Adams    Collective on PC
1165dfd5c07aSMark F. Adams 
1166dfd5c07aSMark F. Adams    Input Parameters:
11671cc46a46SBarry Smith +  pc - the preconditioner context
11681cc46a46SBarry Smith -  n - PETSC_TRUE or PETSC_FALSE
1169dfd5c07aSMark F. Adams 
1170dfd5c07aSMark F. Adams    Options Database Key:
11711cc46a46SBarry Smith .  -pc_gamg_reuse_interpolation <true,false>
1172dfd5c07aSMark F. Adams 
1173dfd5c07aSMark F. Adams    Level: intermediate
1174dfd5c07aSMark F. Adams 
117595452b02SPatrick Sanan    Notes:
117695452b02SPatrick Sanan     this may negatively affect the convergence rate of the method on new matrices if the matrix entries change a great deal, but allows
1177cab9ed1eSBarry Smith           rebuilding the preconditioner quicker.
1178cab9ed1eSBarry Smith 
1179dfd5c07aSMark F. Adams .seealso: ()
1180dfd5c07aSMark F. Adams @*/
11811cc46a46SBarry Smith PetscErrorCode PCGAMGSetReuseInterpolation(PC pc, PetscBool n)
1182dfd5c07aSMark F. Adams {
1183dfd5c07aSMark F. Adams   PetscErrorCode ierr;
1184dfd5c07aSMark F. Adams 
1185dfd5c07aSMark F. Adams   PetscFunctionBegin;
1186dfd5c07aSMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
11871cc46a46SBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGSetReuseInterpolation_C",(PC,PetscBool),(pc,n));CHKERRQ(ierr);
1188dfd5c07aSMark F. Adams   PetscFunctionReturn(0);
1189dfd5c07aSMark F. Adams }
1190dfd5c07aSMark F. Adams 
11911cc46a46SBarry Smith static PetscErrorCode PCGAMGSetReuseInterpolation_GAMG(PC pc, PetscBool n)
1192dfd5c07aSMark F. Adams {
1193dfd5c07aSMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1194dfd5c07aSMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1195dfd5c07aSMark F. Adams 
1196dfd5c07aSMark F. Adams   PetscFunctionBegin;
1197dfd5c07aSMark F. Adams   pc_gamg->reuse_prol = n;
1198dfd5c07aSMark F. Adams   PetscFunctionReturn(0);
1199dfd5c07aSMark F. Adams }
1200dfd5c07aSMark F. Adams 
1201ffc955d6SMark F. Adams /*@
1202cab9ed1eSBarry 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.
1203ffc955d6SMark F. Adams 
1204ffc955d6SMark F. Adams    Collective on PC
1205ffc955d6SMark F. Adams 
1206ffc955d6SMark F. Adams    Input Parameters:
1207cab9ed1eSBarry Smith +  pc - the preconditioner context
1208cab9ed1eSBarry Smith -  flg - PETSC_TRUE to use aggregates, PETSC_FALSE to not
1209ffc955d6SMark F. Adams 
1210ffc955d6SMark F. Adams    Options Database Key:
1211cab9ed1eSBarry Smith .  -pc_gamg_asm_use_agg
1212ffc955d6SMark F. Adams 
1213ffc955d6SMark F. Adams    Level: intermediate
1214ffc955d6SMark F. Adams 
1215ffc955d6SMark F. Adams .seealso: ()
1216ffc955d6SMark F. Adams @*/
1217cab9ed1eSBarry Smith PetscErrorCode PCGAMGASMSetUseAggs(PC pc, PetscBool flg)
1218ffc955d6SMark F. Adams {
1219ffc955d6SMark F. Adams   PetscErrorCode ierr;
1220ffc955d6SMark F. Adams 
1221ffc955d6SMark F. Adams   PetscFunctionBegin;
1222ffc955d6SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1223cab9ed1eSBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGASMSetUseAggs_C",(PC,PetscBool),(pc,flg));CHKERRQ(ierr);
1224ffc955d6SMark F. Adams   PetscFunctionReturn(0);
1225ffc955d6SMark F. Adams }
1226ffc955d6SMark F. Adams 
1227cab9ed1eSBarry Smith static PetscErrorCode PCGAMGASMSetUseAggs_GAMG(PC pc, PetscBool flg)
1228ffc955d6SMark F. Adams {
1229ffc955d6SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1230ffc955d6SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1231ffc955d6SMark F. Adams 
1232ffc955d6SMark F. Adams   PetscFunctionBegin;
1233cab9ed1eSBarry Smith   pc_gamg->use_aggs_in_asm = flg;
1234ffc955d6SMark F. Adams   PetscFunctionReturn(0);
1235ffc955d6SMark F. Adams }
1236ffc955d6SMark F. Adams 
1237171cca9aSMark Adams /*@
1238cf8ae1d3SMark Adams    PCGAMGSetUseParallelCoarseGridSolve - allow a parallel coarse grid solver
1239171cca9aSMark Adams 
1240171cca9aSMark Adams    Collective on PC
1241171cca9aSMark Adams 
1242171cca9aSMark Adams    Input Parameters:
1243171cca9aSMark Adams +  pc - the preconditioner context
1244cf8ae1d3SMark Adams -  flg - PETSC_TRUE to not force coarse grid onto one processor
1245171cca9aSMark Adams 
1246171cca9aSMark Adams    Options Database Key:
1247cf8ae1d3SMark Adams .  -pc_gamg_use_parallel_coarse_grid_solver
1248171cca9aSMark Adams 
1249171cca9aSMark Adams    Level: intermediate
1250171cca9aSMark Adams 
125139d09545SMark Adams .seealso: PCGAMGSetCoarseGridLayoutType(), PCGAMGSetCpuPinCoarseGrids()
1252171cca9aSMark Adams @*/
1253171cca9aSMark Adams PetscErrorCode PCGAMGSetUseParallelCoarseGridSolve(PC pc, PetscBool flg)
1254171cca9aSMark Adams {
1255171cca9aSMark Adams   PetscErrorCode ierr;
1256171cca9aSMark Adams 
1257171cca9aSMark Adams   PetscFunctionBegin;
1258171cca9aSMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1259171cca9aSMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetUseParallelCoarseGridSolve_C",(PC,PetscBool),(pc,flg));CHKERRQ(ierr);
1260171cca9aSMark Adams   PetscFunctionReturn(0);
1261171cca9aSMark Adams }
1262171cca9aSMark Adams 
1263171cca9aSMark Adams static PetscErrorCode PCGAMGSetUseParallelCoarseGridSolve_GAMG(PC pc, PetscBool flg)
1264171cca9aSMark Adams {
1265171cca9aSMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1266171cca9aSMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1267171cca9aSMark Adams 
1268171cca9aSMark Adams   PetscFunctionBegin;
1269171cca9aSMark Adams   pc_gamg->use_parallel_coarse_grid_solver = flg;
1270ffc955d6SMark F. Adams   PetscFunctionReturn(0);
1271ffc955d6SMark F. Adams }
1272ffc955d6SMark F. Adams 
12734ef23d27SMark F. Adams /*@
1274ce7c7f2fSMark Adams    PCGAMGSetCpuPinCoarseGrids - pin reduced grids to CPU
1275ce7c7f2fSMark Adams 
1276ce7c7f2fSMark Adams    Collective on PC
1277ce7c7f2fSMark Adams 
1278ce7c7f2fSMark Adams    Input Parameters:
1279ce7c7f2fSMark Adams +  pc - the preconditioner context
1280ce7c7f2fSMark Adams -  flg - PETSC_TRUE to pin coarse grids to CPU
1281ce7c7f2fSMark Adams 
1282ce7c7f2fSMark Adams    Options Database Key:
1283ce7c7f2fSMark Adams .  -pc_gamg_cpu_pin_coarse_grids
1284ce7c7f2fSMark Adams 
1285ce7c7f2fSMark Adams    Level: intermediate
1286ce7c7f2fSMark Adams 
128739d09545SMark Adams .seealso: PCGAMGSetCoarseGridLayoutType(), PCGAMGSetUseParallelCoarseGridSolve()
1288ce7c7f2fSMark Adams @*/
1289ce7c7f2fSMark Adams PetscErrorCode PCGAMGSetCpuPinCoarseGrids(PC pc, PetscBool flg)
1290ce7c7f2fSMark Adams {
1291ce7c7f2fSMark Adams   PetscErrorCode ierr;
1292ce7c7f2fSMark Adams 
1293ce7c7f2fSMark Adams   PetscFunctionBegin;
1294ce7c7f2fSMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1295ce7c7f2fSMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetCpuPinCoarseGrids_C",(PC,PetscBool),(pc,flg));CHKERRQ(ierr);
1296ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1297ce7c7f2fSMark Adams }
1298ce7c7f2fSMark Adams 
1299ce7c7f2fSMark Adams static PetscErrorCode PCGAMGSetCpuPinCoarseGrids_GAMG(PC pc, PetscBool flg)
1300ce7c7f2fSMark Adams {
1301ce7c7f2fSMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1302ce7c7f2fSMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1303ce7c7f2fSMark Adams 
1304ce7c7f2fSMark Adams   PetscFunctionBegin;
1305ce7c7f2fSMark Adams   pc_gamg->cpu_pin_coarse_grids = flg;
1306ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1307ce7c7f2fSMark Adams }
1308ce7c7f2fSMark Adams 
1309ce7c7f2fSMark Adams /*@
1310ce7c7f2fSMark Adams    PCGAMGSetCoarseGridLayoutType - place reduce grids on processors with natural order (compact type)
1311ce7c7f2fSMark Adams 
1312ce7c7f2fSMark Adams    Collective on PC
1313ce7c7f2fSMark Adams 
1314ce7c7f2fSMark Adams    Input Parameters:
1315ce7c7f2fSMark Adams +  pc - the preconditioner context
1316ce7c7f2fSMark Adams -  flg - Layout type
1317ce7c7f2fSMark Adams 
1318ce7c7f2fSMark Adams    Options Database Key:
1319ce7c7f2fSMark Adams .  -pc_gamg_coarse_grid_layout_type
1320ce7c7f2fSMark Adams 
1321ce7c7f2fSMark Adams    Level: intermediate
1322ce7c7f2fSMark Adams 
132339d09545SMark Adams .seealso: PCGAMGSetUseParallelCoarseGridSolve(), PCGAMGSetCpuPinCoarseGrids()
1324ce7c7f2fSMark Adams @*/
1325ce7c7f2fSMark Adams PetscErrorCode PCGAMGSetCoarseGridLayoutType(PC pc, PCGAMGLayoutType flg)
1326ce7c7f2fSMark Adams {
1327ce7c7f2fSMark Adams   PetscErrorCode ierr;
1328ce7c7f2fSMark Adams 
1329ce7c7f2fSMark Adams   PetscFunctionBegin;
1330ce7c7f2fSMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1331ce7c7f2fSMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetCoarseGridLayoutType_C",(PC,PCGAMGLayoutType),(pc,flg));CHKERRQ(ierr);
1332ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1333ce7c7f2fSMark Adams }
1334ce7c7f2fSMark Adams 
1335ce7c7f2fSMark Adams static PetscErrorCode PCGAMGSetCoarseGridLayoutType_GAMG(PC pc, PCGAMGLayoutType flg)
1336ce7c7f2fSMark Adams {
1337ce7c7f2fSMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1338ce7c7f2fSMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1339ce7c7f2fSMark Adams 
1340ce7c7f2fSMark Adams   PetscFunctionBegin;
1341ce7c7f2fSMark Adams   pc_gamg->layout_type = flg;
1342ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1343ce7c7f2fSMark Adams }
1344ce7c7f2fSMark Adams 
1345ce7c7f2fSMark Adams /*@
13461cc46a46SBarry Smith    PCGAMGSetNlevels -  Sets the maximum number of levels PCGAMG will use
13474ef23d27SMark F. Adams 
13484ef23d27SMark F. Adams    Not collective on PC
13494ef23d27SMark F. Adams 
13504ef23d27SMark F. Adams    Input Parameters:
13511cc46a46SBarry Smith +  pc - the preconditioner
13521cc46a46SBarry Smith -  n - the maximum number of levels to use
13534ef23d27SMark F. Adams 
13544ef23d27SMark F. Adams    Options Database Key:
13554ef23d27SMark F. Adams .  -pc_mg_levels
13564ef23d27SMark F. Adams 
13574ef23d27SMark F. Adams    Level: intermediate
13584ef23d27SMark F. Adams 
13594ef23d27SMark F. Adams .seealso: ()
13604ef23d27SMark F. Adams @*/
13614ef23d27SMark F. Adams PetscErrorCode PCGAMGSetNlevels(PC pc, PetscInt n)
13624ef23d27SMark F. Adams {
13634ef23d27SMark F. Adams   PetscErrorCode ierr;
13644ef23d27SMark F. Adams 
13654ef23d27SMark F. Adams   PetscFunctionBegin;
13664ef23d27SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
13674ef23d27SMark F. Adams   ierr = PetscTryMethod(pc,"PCGAMGSetNlevels_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
13684ef23d27SMark F. Adams   PetscFunctionReturn(0);
13694ef23d27SMark F. Adams }
13704ef23d27SMark F. Adams 
13711e6b0712SBarry Smith static PetscErrorCode PCGAMGSetNlevels_GAMG(PC pc, PetscInt n)
13724ef23d27SMark F. Adams {
13734ef23d27SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
13744ef23d27SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
13754ef23d27SMark F. Adams 
13764ef23d27SMark F. Adams   PetscFunctionBegin;
13779d5b6da9SMark F. Adams   pc_gamg->Nlevels = n;
13784ef23d27SMark F. Adams   PetscFunctionReturn(0);
13794ef23d27SMark F. Adams }
13804ef23d27SMark F. Adams 
13813542efc5SMark F. Adams /*@
13823542efc5SMark F. Adams    PCGAMGSetThreshold - Relative threshold to use for dropping edges in aggregation graph
13833542efc5SMark F. Adams 
13843542efc5SMark F. Adams    Not collective on PC
13853542efc5SMark F. Adams 
13863542efc5SMark F. Adams    Input Parameters:
13871cc46a46SBarry Smith +  pc - the preconditioner context
1388c9567895SMark .  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
1389055c8bd0SJed Brown -  n - number of threshold values provided in array
13903542efc5SMark F. Adams 
13913542efc5SMark F. Adams    Options Database Key:
13921cc46a46SBarry Smith .  -pc_gamg_threshold <threshold>
13933542efc5SMark F. Adams 
139495452b02SPatrick Sanan    Notes:
1395af3c827dSMark 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.
1396af3c827dSMark 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.
1397cab9ed1eSBarry Smith 
1398055c8bd0SJed Brown     If n is less than the total number of coarsenings (see PCGAMGSetNlevels()), then threshold scaling (see PCGAMGSetThresholdScale()) is used for each successive coarsening.
1399055c8bd0SJed Brown     In this case, PCGAMGSetThresholdScale() must be called before PCGAMGSetThreshold().
1400055c8bd0SJed Brown     If n is greater than the total number of levels, the excess entries in threshold will not be used.
1401055c8bd0SJed Brown 
14023542efc5SMark F. Adams    Level: intermediate
14033542efc5SMark F. Adams 
1404af3c827dSMark Adams .seealso: PCGAMGFilterGraph(), PCGAMGSetSquareGraph()
14053542efc5SMark F. Adams @*/
1406c1eae691SMark Adams PetscErrorCode PCGAMGSetThreshold(PC pc, PetscReal v[], PetscInt n)
14073542efc5SMark F. Adams {
14083542efc5SMark F. Adams   PetscErrorCode ierr;
14093542efc5SMark F. Adams 
14103542efc5SMark F. Adams   PetscFunctionBegin;
14113542efc5SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1412055c8bd0SJed Brown   if (n) PetscValidRealPointer(v,2);
1413c1eae691SMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetThreshold_C",(PC,PetscReal[],PetscInt),(pc,v,n));CHKERRQ(ierr);
14143542efc5SMark F. Adams   PetscFunctionReturn(0);
14153542efc5SMark F. Adams }
14163542efc5SMark F. Adams 
1417c1eae691SMark Adams static PetscErrorCode PCGAMGSetThreshold_GAMG(PC pc, PetscReal v[], PetscInt n)
14183542efc5SMark F. Adams {
1419c20e4228SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1420c20e4228SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1421c1eae691SMark Adams   PetscInt i;
1422c1eae691SMark Adams   PetscFunctionBegin;
1423055c8bd0SJed Brown   for (i=0; i<PetscMin(n,PETSC_MG_MAXLEVELS); i++) pc_gamg->threshold[i] = v[i];
1424055c8bd0SJed Brown   for (; i<PETSC_MG_MAXLEVELS; i++) pc_gamg->threshold[i] = pc_gamg->threshold[i-1]*pc_gamg->threshold_scale;
1425c1eae691SMark Adams   PetscFunctionReturn(0);
1426c1eae691SMark Adams }
1427c1eae691SMark Adams 
1428c1eae691SMark Adams /*@
1429c9567895SMark    PCGAMGSetRankReductionFactors - Set manual schedual for process reduction on coarse grids
1430c9567895SMark 
1431c9567895SMark    Collective on PC
1432c9567895SMark 
1433c9567895SMark    Input Parameters:
1434c9567895SMark +  pc - the preconditioner context
1435c9567895SMark .  v - array of reduction factors. 0 for fist value forces a reduction to one process/device on first level in Cuda
1436c9567895SMark -  n - number of values provided in array
1437c9567895SMark 
1438c9567895SMark    Options Database Key:
1439c9567895SMark .  -pc_gamg_rank_reduction_factors <factors>
1440c9567895SMark 
1441c9567895SMark    Level: intermediate
1442c9567895SMark 
1443c9567895SMark .seealso: PCGAMGSetProcEqLim(), PCGAMGSetCoarseEqLim()
1444c9567895SMark @*/
1445c9567895SMark PetscErrorCode PCGAMGSetRankReductionFactors(PC pc, PetscInt v[], PetscInt n)
1446c9567895SMark {
1447c9567895SMark   PetscErrorCode ierr;
1448c9567895SMark 
1449c9567895SMark   PetscFunctionBegin;
1450c9567895SMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1451c9567895SMark   if (n) PetscValidIntPointer(v,2);
1452c9567895SMark   ierr = PetscTryMethod(pc,"PCGAMGSetRankReductionFactors_C",(PC,PetscInt[],PetscInt),(pc,v,n));CHKERRQ(ierr);
1453c9567895SMark   PetscFunctionReturn(0);
1454c9567895SMark }
1455c9567895SMark 
1456c9567895SMark static PetscErrorCode PCGAMGSetRankReductionFactors_GAMG(PC pc, PetscInt v[], PetscInt n)
1457c9567895SMark {
1458c9567895SMark   PC_MG   *mg      = (PC_MG*)pc->data;
1459c9567895SMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1460c9567895SMark   PetscInt i;
1461c9567895SMark   PetscFunctionBegin;
1462c9567895SMark   for (i=0; i<PetscMin(n,PETSC_MG_MAXLEVELS); i++) pc_gamg->level_reduction_factors[i] = v[i];
1463c9567895SMark   for (; i<PETSC_MG_MAXLEVELS; i++) pc_gamg->level_reduction_factors[i] = -1; /* 0 stop putting one process/device on first level */
1464c9567895SMark   PetscFunctionReturn(0);
1465c9567895SMark }
1466c9567895SMark 
1467c9567895SMark /*@
1468c1eae691SMark Adams    PCGAMGSetThresholdScale - Relative threshold reduction at each level
1469c1eae691SMark Adams 
1470c1eae691SMark Adams    Not collective on PC
1471c1eae691SMark Adams 
1472c1eae691SMark Adams    Input Parameters:
1473c1eae691SMark Adams +  pc - the preconditioner context
1474c1eae691SMark Adams -  scale - the threshold value reduction, ussually < 1.0
1475c1eae691SMark Adams 
1476c1eae691SMark Adams    Options Database Key:
1477c1eae691SMark Adams .  -pc_gamg_threshold_scale <v>
1478c1eae691SMark Adams 
1479055c8bd0SJed Brown    Notes:
1480055c8bd0SJed Brown    The initial threshold (for an arbitrary number of levels starting from the finest) can be set with PCGAMGSetThreshold().
1481055c8bd0SJed Brown    This scaling is used for each subsequent coarsening, but must be called before PCGAMGSetThreshold().
1482055c8bd0SJed Brown 
1483c1eae691SMark Adams    Level: advanced
1484c1eae691SMark Adams 
1485055c8bd0SJed Brown .seealso: PCGAMGSetThreshold()
1486c1eae691SMark Adams @*/
1487c1eae691SMark Adams PetscErrorCode PCGAMGSetThresholdScale(PC pc, PetscReal v)
1488c1eae691SMark Adams {
1489c1eae691SMark Adams   PetscErrorCode ierr;
14903542efc5SMark F. Adams 
14913542efc5SMark F. Adams   PetscFunctionBegin;
1492c1eae691SMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1493c1eae691SMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetThresholdScale_C",(PC,PetscReal),(pc,v));CHKERRQ(ierr);
1494c1eae691SMark Adams   PetscFunctionReturn(0);
1495c1eae691SMark Adams }
1496c1eae691SMark Adams 
1497c1eae691SMark Adams static PetscErrorCode PCGAMGSetThresholdScale_GAMG(PC pc, PetscReal v)
1498c1eae691SMark Adams {
1499c1eae691SMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1500c1eae691SMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1501c1eae691SMark Adams   PetscFunctionBegin;
1502c1eae691SMark Adams   pc_gamg->threshold_scale = v;
15033542efc5SMark F. Adams   PetscFunctionReturn(0);
15043542efc5SMark F. Adams }
15053542efc5SMark F. Adams 
1506e20c40e8SBarry Smith /*@C
1507c60c7ad4SBarry Smith    PCGAMGSetType - Set solution method
1508676e1743SMark F. Adams 
1509676e1743SMark F. Adams    Collective on PC
1510676e1743SMark F. Adams 
1511676e1743SMark F. Adams    Input Parameters:
1512c60c7ad4SBarry Smith +  pc - the preconditioner context
1513c60c7ad4SBarry Smith -  type - PCGAMGAGG, PCGAMGGEO, or PCGAMGCLASSICAL
1514676e1743SMark F. Adams 
1515676e1743SMark F. Adams    Options Database Key:
1516cab9ed1eSBarry Smith .  -pc_gamg_type <agg,geo,classical> - type of algebraic multigrid to apply
1517676e1743SMark F. Adams 
1518676e1743SMark F. Adams    Level: intermediate
1519676e1743SMark F. Adams 
1520cab9ed1eSBarry Smith .seealso: PCGAMGGetType(), PCGAMG, PCGAMGType
1521676e1743SMark F. Adams @*/
152219fd82e9SBarry Smith PetscErrorCode PCGAMGSetType(PC pc, PCGAMGType type)
1523676e1743SMark F. Adams {
1524676e1743SMark F. Adams   PetscErrorCode ierr;
1525676e1743SMark F. Adams 
1526676e1743SMark F. Adams   PetscFunctionBegin;
1527676e1743SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1528806fa848SBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGSetType_C",(PC,PCGAMGType),(pc,type));CHKERRQ(ierr);
1529676e1743SMark F. Adams   PetscFunctionReturn(0);
1530676e1743SMark F. Adams }
1531676e1743SMark F. Adams 
1532e20c40e8SBarry Smith /*@C
1533c60c7ad4SBarry Smith    PCGAMGGetType - Get solution method
1534c60c7ad4SBarry Smith 
1535c60c7ad4SBarry Smith    Collective on PC
1536c60c7ad4SBarry Smith 
1537c60c7ad4SBarry Smith    Input Parameter:
1538c60c7ad4SBarry Smith .  pc - the preconditioner context
1539c60c7ad4SBarry Smith 
1540c60c7ad4SBarry Smith    Output Parameter:
1541c60c7ad4SBarry Smith .  type - the type of algorithm used
1542c60c7ad4SBarry Smith 
1543c60c7ad4SBarry Smith    Level: intermediate
1544c60c7ad4SBarry Smith 
15451c1aac46SBarry Smith .seealso: PCGAMGSetType(), PCGAMGType
1546c60c7ad4SBarry Smith @*/
1547c60c7ad4SBarry Smith PetscErrorCode PCGAMGGetType(PC pc, PCGAMGType *type)
1548c60c7ad4SBarry Smith {
1549c60c7ad4SBarry Smith   PetscErrorCode ierr;
1550c60c7ad4SBarry Smith 
1551c60c7ad4SBarry Smith   PetscFunctionBegin;
1552c60c7ad4SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1553c60c7ad4SBarry Smith   ierr = PetscUseMethod(pc,"PCGAMGGetType_C",(PC,PCGAMGType*),(pc,type));CHKERRQ(ierr);
1554c60c7ad4SBarry Smith   PetscFunctionReturn(0);
1555c60c7ad4SBarry Smith }
1556c60c7ad4SBarry Smith 
1557c60c7ad4SBarry Smith static PetscErrorCode PCGAMGGetType_GAMG(PC pc, PCGAMGType *type)
1558c60c7ad4SBarry Smith {
1559c60c7ad4SBarry Smith   PC_MG          *mg      = (PC_MG*)pc->data;
1560c60c7ad4SBarry Smith   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
1561c60c7ad4SBarry Smith 
1562c60c7ad4SBarry Smith   PetscFunctionBegin;
1563c60c7ad4SBarry Smith   *type = pc_gamg->type;
1564c60c7ad4SBarry Smith   PetscFunctionReturn(0);
1565c60c7ad4SBarry Smith }
1566c60c7ad4SBarry Smith 
15671e6b0712SBarry Smith static PetscErrorCode PCGAMGSetType_GAMG(PC pc, PCGAMGType type)
1568676e1743SMark F. Adams {
15699d5b6da9SMark F. Adams   PetscErrorCode ierr,(*r)(PC);
15701ab5ffc9SJed Brown   PC_MG          *mg      = (PC_MG*)pc->data;
15711ab5ffc9SJed Brown   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
1572676e1743SMark F. Adams 
1573676e1743SMark F. Adams   PetscFunctionBegin;
1574c60c7ad4SBarry Smith   pc_gamg->type = type;
15751c9cd337SJed Brown   ierr = PetscFunctionListFind(GAMGList,type,&r);CHKERRQ(ierr);
15769d5b6da9SMark F. Adams   if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown GAMG type %s given",type);
15771ab5ffc9SJed Brown   if (pc_gamg->ops->destroy) {
15781ab5ffc9SJed Brown     ierr = (*pc_gamg->ops->destroy)(pc);CHKERRQ(ierr);
15791ab5ffc9SJed Brown     ierr = PetscMemzero(pc_gamg->ops,sizeof(struct _PCGAMGOps));CHKERRQ(ierr);
1580e616c208SToby Isaac     pc_gamg->ops->createlevel = PCGAMGCreateLevel_GAMG;
15813ae0bb68SMark Adams     /* cleaning up common data in pc_gamg - this should disapear someday */
15823ae0bb68SMark Adams     pc_gamg->data_cell_cols = 0;
15833ae0bb68SMark Adams     pc_gamg->data_cell_rows = 0;
15843ae0bb68SMark Adams     pc_gamg->orig_data_cell_cols = 0;
15853ae0bb68SMark Adams     pc_gamg->orig_data_cell_rows = 0;
15863ae0bb68SMark Adams     ierr = PetscFree(pc_gamg->data);CHKERRQ(ierr);
15873ae0bb68SMark Adams     pc_gamg->data_sz = 0;
15881ab5ffc9SJed Brown   }
15891ab5ffc9SJed Brown   ierr = PetscFree(pc_gamg->gamg_type_name);CHKERRQ(ierr);
15901ab5ffc9SJed Brown   ierr = PetscStrallocpy(type,&pc_gamg->gamg_type_name);CHKERRQ(ierr);
15919d5b6da9SMark F. Adams   ierr = (*r)(pc);CHKERRQ(ierr);
1592676e1743SMark F. Adams   PetscFunctionReturn(0);
1593676e1743SMark F. Adams }
1594676e1743SMark F. Adams 
15959d766c59SMark Adams /* -------------------------------------------------------------------------- */
15969d766c59SMark Adams /*
15979d766c59SMark Adams    PCMGGetGridComplexity - compute coarse grid complexity of MG hierarchy
15989d766c59SMark Adams 
15999d766c59SMark Adams    Input Parameter:
16009d766c59SMark Adams .  pc - the preconditioner context
16019d766c59SMark Adams 
16029d766c59SMark Adams    Output Parameter:
16039d766c59SMark Adams .  gc - grid complexity = sum_i(nnz_i) / nnz_0
16049d766c59SMark Adams 
16059d766c59SMark Adams    Level: advanced
16069d766c59SMark Adams */
16079d766c59SMark Adams static PetscErrorCode PCMGGetGridComplexity(PC pc, PetscReal *gc)
16089d766c59SMark Adams {
16099d766c59SMark Adams   PetscErrorCode ierr;
16109d766c59SMark Adams   PC_MG          *mg      = (PC_MG*)pc->data;
16119d766c59SMark Adams   PC_MG_Levels   **mglevels = mg->levels;
16123966268fSBarry Smith   PetscInt       lev;
16133966268fSBarry Smith   PetscLogDouble nnz0 = 0, sgc = 0;
16149d766c59SMark Adams   MatInfo        info;
16153966268fSBarry Smith 
16169d766c59SMark Adams   PetscFunctionBegin;
1617dbf6bb8dSprj-   if (!pc->setupcalled) {
1618dbf6bb8dSprj-     *gc = 0;
1619dbf6bb8dSprj-     PetscFunctionReturn(0);
1620dbf6bb8dSprj-   }
16219d766c59SMark Adams   if (!mg->nlevels) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"MG has no levels");
16223966268fSBarry Smith   for (lev=0; lev<mg->nlevels; lev++) {
162362a6e064SMark Adams     Mat dB;
162462a6e064SMark Adams     ierr = KSPGetOperators(mglevels[lev]->smoothd,NULL,&dB);CHKERRQ(ierr);
162562a6e064SMark Adams     ierr = MatGetInfo(dB,MAT_GLOBAL_SUM,&info);CHKERRQ(ierr); /* global reduction */
16263966268fSBarry Smith     sgc += info.nz_used;
16279d766c59SMark Adams     if (lev==mg->nlevels-1) nnz0 = info.nz_used;
16289d766c59SMark Adams   }
16293966268fSBarry Smith   if (nnz0 > 0) *gc = (PetscReal)(sgc/nnz0);
16303966268fSBarry Smith   else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Number for grid points on finest level is not available");
16319d766c59SMark Adams   PetscFunctionReturn(0);
16329d766c59SMark Adams }
16339d766c59SMark Adams 
16345adeb434SBarry Smith static PetscErrorCode PCView_GAMG(PC pc,PetscViewer viewer)
16355adeb434SBarry Smith {
1636c1eae691SMark Adams   PetscErrorCode ierr,i;
16375adeb434SBarry Smith   PC_MG          *mg      = (PC_MG*)pc->data;
16385adeb434SBarry Smith   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
163923b2d91dSMark Adams   PetscReal       gc=0;
16405adeb434SBarry Smith   PetscFunctionBegin;
16415adeb434SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"    GAMG specific options\n");CHKERRQ(ierr);
1642459726d8SSatish Balay   ierr = PetscViewerASCIIPrintf(viewer,"      Threshold for dropping small values in graph on each level =");CHKERRQ(ierr);
1643b3e187dcSStefano Zampini   for (i=0;i<mg->nlevels; i++) {
1644c1eae691SMark Adams     ierr = PetscViewerASCIIPrintf(viewer," %g",(double)pc_gamg->threshold[i]);CHKERRQ(ierr);
1645c1eae691SMark Adams   }
1646459726d8SSatish Balay   ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
1647459726d8SSatish Balay   ierr = PetscViewerASCIIPrintf(viewer,"      Threshold scaling factor for each level not specified = %g\n",(double)pc_gamg->threshold_scale);CHKERRQ(ierr);
1648cab9ed1eSBarry Smith   if (pc_gamg->use_aggs_in_asm) {
1649cab9ed1eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"      Using aggregates from coarsening process to define subdomains for PCASM\n");CHKERRQ(ierr);
1650cab9ed1eSBarry Smith   }
1651171cca9aSMark Adams   if (pc_gamg->use_parallel_coarse_grid_solver) {
1652171cca9aSMark Adams     ierr = PetscViewerASCIIPrintf(viewer,"      Using parallel coarse grid solver (all coarse grid equations not put on one process)\n");CHKERRQ(ierr);
1653171cca9aSMark Adams   }
1654ce7c7f2fSMark Adams #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
1655ce7c7f2fSMark Adams   if (pc_gamg->cpu_pin_coarse_grids) {
1656ce7c7f2fSMark Adams     /* ierr = PetscViewerASCIIPrintf(viewer,"      Pinning coarse grids to the CPU)\n");CHKERRQ(ierr); */
1657ce7c7f2fSMark Adams   }
1658ce7c7f2fSMark Adams #endif
1659ce7c7f2fSMark Adams   /* if (pc_gamg->layout_type==PCGAMG_LAYOUT_COMPACT) { */
1660ce7c7f2fSMark Adams   /*   ierr = PetscViewerASCIIPrintf(viewer,"      Put reduced grids on processes in natural order (ie, 0,1,2...)\n");CHKERRQ(ierr); */
1661ce7c7f2fSMark Adams   /* } else { */
1662ce7c7f2fSMark Adams   /*   ierr = PetscViewerASCIIPrintf(viewer,"      Put reduced grids on whole machine (ie, 0,1*f,2*f...,np-f)\n");CHKERRQ(ierr); */
1663ce7c7f2fSMark Adams   /* } */
16645adeb434SBarry Smith   if (pc_gamg->ops->view) {
16655adeb434SBarry Smith     ierr = (*pc_gamg->ops->view)(pc,viewer);CHKERRQ(ierr);
16665adeb434SBarry Smith   }
16679d766c59SMark Adams   ierr = PCMGGetGridComplexity(pc,&gc);CHKERRQ(ierr);
16689d766c59SMark Adams   ierr = PetscViewerASCIIPrintf(viewer,"      Complexity:    grid = %g\n",gc);CHKERRQ(ierr);
16695adeb434SBarry Smith   PetscFunctionReturn(0);
16705adeb434SBarry Smith }
16715adeb434SBarry Smith 
16724416b707SBarry Smith PetscErrorCode PCSetFromOptions_GAMG(PetscOptionItems *PetscOptionsObject,PC pc)
16735b89ad90SMark F. Adams {
1674676e1743SMark F. Adams   PetscErrorCode ierr;
1675676e1743SMark F. Adams   PC_MG          *mg      = (PC_MG*)pc->data;
1676676e1743SMark F. Adams   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
167718c3aa7eSMark   PetscBool      flag,f2;
16783b4367a7SBarry Smith   MPI_Comm       comm;
167918c3aa7eSMark   char           prefix[256],tname[32];
1680c1eae691SMark Adams   PetscInt       i,n;
168114a9496bSBarry Smith   const char     *pcpre;
16820a545947SLisandro Dalcin   static const char *LayoutTypes[] = {"compact","spread","PCGAMGLayoutType","PC_GAMG_LAYOUT",NULL};
16835b89ad90SMark F. Adams   PetscFunctionBegin;
16843b4367a7SBarry Smith   ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
1685e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"GAMG options");CHKERRQ(ierr);
16861a1c1e04SBarry Smith   ierr = PetscOptionsFList("-pc_gamg_type","Type of AMG method","PCGAMGSetType",GAMGList, pc_gamg->gamg_type_name, tname, sizeof(tname), &flag);CHKERRQ(ierr);
1687bd94a7aaSJed Brown   if (flag) {
1688bd94a7aaSJed Brown     ierr = PCGAMGSetType(pc,tname);CHKERRQ(ierr);
16891ab5ffc9SJed Brown   }
169018c3aa7eSMark   ierr = PetscOptionsFList("-pc_gamg_esteig_ksp_type","Krylov method for eigen estimator","PCGAMGSetEstEigKSPType",KSPList,pc_gamg->esteig_type,tname,sizeof(tname),&flag);CHKERRQ(ierr);
169118c3aa7eSMark   if (flag) {
169218c3aa7eSMark     ierr = PCGAMGSetEstEigKSPType(pc,tname);CHKERRQ(ierr);
169318c3aa7eSMark   }
1694cab9ed1eSBarry Smith   ierr = PetscOptionsBool("-pc_gamg_repartition","Repartion coarse grids","PCGAMGSetRepartition",pc_gamg->repart,&pc_gamg->repart,NULL);CHKERRQ(ierr);
169518c3aa7eSMark   f2 = PETSC_TRUE;
169618c3aa7eSMark   ierr = PetscOptionsBool("-pc_gamg_use_sa_esteig","Use eigen estimate from Smoothed aggregation for smoother","PCGAMGSetUseSAEstEig",f2,&f2,&flag);CHKERRQ(ierr);
169718c3aa7eSMark   if (flag) pc_gamg->use_sa_esteig = f2 ? 1 : 0;
16981cc46a46SBarry Smith   ierr = PetscOptionsBool("-pc_gamg_reuse_interpolation","Reuse prolongation operator","PCGAMGReuseInterpolation",pc_gamg->reuse_prol,&pc_gamg->reuse_prol,NULL);CHKERRQ(ierr);
1699a303c832SJed 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);
1700cf8ae1d3SMark 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);
1701ce7c7f2fSMark 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);
1702a0095786SMark   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);
170394ae4db5SBarry 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);
170418c3aa7eSMark   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);
170594ae4db5SBarry 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);
1706a303c832SJed 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);
170718c3aa7eSMark   n = PETSC_MG_MAXLEVELS;
1708c1eae691SMark Adams   ierr = PetscOptionsRealArray("-pc_gamg_threshold","Relative threshold to use for dropping edges in aggregation graph","PCGAMGSetThreshold",pc_gamg->threshold,&n,&flag);CHKERRQ(ierr);
170918c3aa7eSMark   if (!flag || n < PETSC_MG_MAXLEVELS) {
1710efd3c5ceSMark Adams     if (!flag) n = 1;
1711c1eae691SMark Adams     i = n;
171218c3aa7eSMark     do {pc_gamg->threshold[i] = pc_gamg->threshold[i-1]*pc_gamg->threshold_scale;} while (++i<PETSC_MG_MAXLEVELS);
1713c1eae691SMark Adams   }
1714c9567895SMark   n = PETSC_MG_MAXLEVELS;
1715c9567895SMark   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);
1716c9567895SMark   if (!flag) i = 0;
1717c9567895SMark   else i = n;
1718c9567895SMark   do {pc_gamg->level_reduction_factors[i] = -1;} while (++i<PETSC_MG_MAXLEVELS);
171994ae4db5SBarry Smith   ierr = PetscOptionsInt("-pc_mg_levels","Set number of MG levels","PCGAMGSetNlevels",pc_gamg->Nlevels,&pc_gamg->Nlevels,NULL);CHKERRQ(ierr);
172018c3aa7eSMark   {
172118c3aa7eSMark     PetscReal eminmax[2] = {0., 0.};
172218c3aa7eSMark     n = 2;
172318c3aa7eSMark     ierr = PetscOptionsRealArray("-pc_gamg_eigenvalues","extreme eigenvalues for smoothed aggregation","PCGAMGSetEigenvalues",eminmax,&n,&flag);CHKERRQ(ierr);
172418c3aa7eSMark     if (flag) {
172518c3aa7eSMark       if (n != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"-pc_gamg_eigenvalues: must specify 2 parameters, min and max eigenvalues");
172618c3aa7eSMark       ierr = PCGAMGSetEigenvalues(pc, eminmax[1], eminmax[0]);CHKERRQ(ierr);
172718c3aa7eSMark     }
172818c3aa7eSMark   }
1729b7cbab4eSMark Adams   /* set options for subtype */
1730e55864a3SBarry Smith   if (pc_gamg->ops->setfromoptions) {ierr = (*pc_gamg->ops->setfromoptions)(PetscOptionsObject,pc);CHKERRQ(ierr);}
173118c3aa7eSMark 
173214a9496bSBarry Smith   ierr = PCGetOptionsPrefix(pc, &pcpre);CHKERRQ(ierr);
173314a9496bSBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%spc_gamg_",pcpre ? pcpre : "");CHKERRQ(ierr);
1734676e1743SMark F. Adams   ierr = PetscOptionsTail();CHKERRQ(ierr);
17355b89ad90SMark F. Adams   PetscFunctionReturn(0);
17365b89ad90SMark F. Adams }
17375b89ad90SMark F. Adams 
17385b89ad90SMark F. Adams /* -------------------------------------------------------------------------- */
17395b89ad90SMark F. Adams /*MC
17401cc46a46SBarry Smith      PCGAMG - Geometric algebraic multigrid (AMG) preconditioner
17415b89ad90SMark F. Adams 
1742280d9858SJed Brown    Options Database Keys:
1743cab9ed1eSBarry Smith +   -pc_gamg_type <type> - one of agg, geo, or classical
1744cab9ed1eSBarry Smith .   -pc_gamg_repartition  <true,default=false> - repartition the degrees of freedom accross the coarse grids as they are determined
1745cab9ed1eSBarry Smith .   -pc_gamg_reuse_interpolation <true,default=false> - when rebuilding the algebraic multigrid preconditioner reuse the previously computed interpolations
1746cab9ed1eSBarry 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
1747cab9ed1eSBarry 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>
1748cab9ed1eSBarry Smith                                         equations on each process that has degrees of freedom
1749cab9ed1eSBarry Smith .   -pc_gamg_coarse_eq_limit <limit, default=50> - Set maximum number of equations on coarsest grid to aim for.
17506008e27bSRichard Tran Mills .   -pc_gamg_threshold[] <thresh,default=0> - Before aggregating the graph GAMG will remove small values from the graph on each level
1751c1eae691SMark Adams -   -pc_gamg_threshold_scale <scale,default=1> - Scaling of threshold on each coarser grid if not specified
1752cab9ed1eSBarry Smith 
1753cab9ed1eSBarry Smith    Options Database Keys for default Aggregation:
1754cab9ed1eSBarry Smith +  -pc_gamg_agg_nsmooths <nsmooth, default=1> - number of smoothing steps to use with smooth aggregation
1755cab9ed1eSBarry Smith .  -pc_gamg_sym_graph <true,default=false> - symmetrize the graph before computing the aggregation
1756cab9ed1eSBarry Smith -  -pc_gamg_square_graph <n,default=1> - number of levels to square the graph before aggregating it
1757cab9ed1eSBarry Smith 
1758db9745e2SBarry Smith    Multigrid options:
1759db9745e2SBarry Smith +  -pc_mg_cycles <v> - v or w, see PCMGSetCycleType()
1760db9745e2SBarry Smith .  -pc_mg_distinct_smoothup - configure the up and down (pre and post) smoothers separately, see PCMGSetDistinctSmoothUp()
1761db9745e2SBarry Smith .  -pc_mg_type <multiplicative> - (one of) additive multiplicative full kascade
1762cab9ed1eSBarry Smith -  -pc_mg_levels <levels> - Number of levels of multigrid to use.
17635b89ad90SMark F. Adams 
17641cc46a46SBarry Smith 
176595452b02SPatrick Sanan   Notes:
176695452b02SPatrick Sanan     In order to obtain good performance for PCGAMG for vector valued problems you must
1767db9745e2SBarry Smith        Call MatSetBlockSize() to indicate the number of degrees of freedom per grid point
1768db9745e2SBarry Smith        Call MatSetNearNullSpace() (or PCSetCoordinates() if solving the equations of elasticity) to indicate the near null space of the operator
1769db9745e2SBarry Smith        See the Users Manual Chapter 4 for more details
17701cc46a46SBarry Smith 
17715b89ad90SMark F. Adams   Level: intermediate
1772280d9858SJed Brown 
17731cc46a46SBarry Smith .seealso:  PCCreate(), PCSetType(), MatSetBlockSize(), PCMGType, PCSetCoordinates(), MatSetNearNullSpace(), PCGAMGSetType(), PCGAMGAGG, PCGAMGGEO, PCGAMGCLASSICAL, PCGAMGSetProcEqLim(),
177418c3aa7eSMark            PCGAMGSetCoarseEqLim(), PCGAMGSetRepartition(), PCGAMGRegister(), PCGAMGSetReuseInterpolation(), PCGAMGASMSetUseAggs(), PCGAMGSetUseParallelCoarseGridSolve(), PCGAMGSetNlevels(), PCGAMGSetThreshold(), PCGAMGGetType(), PCGAMGSetReuseInterpolation(), PCGAMGSetUseSAEstEig(), PCGAMGSetEstEigKSPMaxIt(), PCGAMGSetEstEigKSPType()
17755b89ad90SMark F. Adams M*/
1776b2573a8aSBarry Smith 
17778cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_GAMG(PC pc)
17785b89ad90SMark F. Adams {
1779c1eae691SMark Adams   PetscErrorCode ierr,i;
17805b89ad90SMark F. Adams   PC_GAMG        *pc_gamg;
17815b89ad90SMark F. Adams   PC_MG          *mg;
17825b89ad90SMark F. Adams 
17835b89ad90SMark F. Adams   PetscFunctionBegin;
17841c1aac46SBarry Smith    /* register AMG type */
17851c1aac46SBarry Smith   ierr = PCGAMGInitializePackage();CHKERRQ(ierr);
17861c1aac46SBarry Smith 
17875b89ad90SMark F. Adams   /* PCGAMG is an inherited class of PCMG. Initialize pc as PCMG */
17881c1aac46SBarry Smith   ierr = PCSetType(pc, PCMG);CHKERRQ(ierr);
17895b89ad90SMark F. Adams   ierr = PetscObjectChangeTypeName((PetscObject)pc, PCGAMG);CHKERRQ(ierr);
17905b89ad90SMark F. Adams 
17915b89ad90SMark F. Adams   /* create a supporting struct and attach it to pc */
1792b00a9115SJed Brown   ierr         = PetscNewLog(pc,&pc_gamg);CHKERRQ(ierr);
179369aca0b8SBarry Smith   ierr         = PCMGSetGalerkin(pc,PC_MG_GALERKIN_EXTERNAL);CHKERRQ(ierr);
17945b89ad90SMark F. Adams   mg           = (PC_MG*)pc->data;
17955b89ad90SMark F. Adams   mg->innerctx = pc_gamg;
17965b89ad90SMark F. Adams 
1797b00a9115SJed Brown   ierr = PetscNewLog(pc,&pc_gamg->ops);CHKERRQ(ierr);
17981ab5ffc9SJed Brown 
17999d5b6da9SMark F. Adams   /* these should be in subctx but repartitioning needs simple arrays */
18009d5b6da9SMark F. Adams   pc_gamg->data_sz = 0;
18010a545947SLisandro Dalcin   pc_gamg->data    = NULL;
18025b89ad90SMark F. Adams 
18039d5b6da9SMark F. Adams   /* overwrite the pointers of PCMG by the functions of base class PCGAMG */
18045b89ad90SMark F. Adams   pc->ops->setfromoptions = PCSetFromOptions_GAMG;
18055b89ad90SMark F. Adams   pc->ops->setup          = PCSetUp_GAMG;
18065b89ad90SMark F. Adams   pc->ops->reset          = PCReset_GAMG;
18075b89ad90SMark F. Adams   pc->ops->destroy        = PCDestroy_GAMG;
18085adeb434SBarry Smith   mg->view                = PCView_GAMG;
18095b89ad90SMark F. Adams 
181097d33e41SMatthew G. Knepley   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCMGGetLevels_C",PCMGGetLevels_MG);CHKERRQ(ierr);
181197d33e41SMatthew G. Knepley   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCMGSetLevels_C",PCMGSetLevels_MG);CHKERRQ(ierr);
1812bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetProcEqLim_C",PCGAMGSetProcEqLim_GAMG);CHKERRQ(ierr);
1813bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetCoarseEqLim_C",PCGAMGSetCoarseEqLim_GAMG);CHKERRQ(ierr);
1814cab9ed1eSBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetRepartition_C",PCGAMGSetRepartition_GAMG);CHKERRQ(ierr);
181518c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetEstEigKSPType_C",PCGAMGSetEstEigKSPType_GAMG);CHKERRQ(ierr);
181618c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetEstEigKSPMaxIt_C",PCGAMGSetEstEigKSPMaxIt_GAMG);CHKERRQ(ierr);
181718c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetEigenvalues_C",PCGAMGSetEigenvalues_GAMG);CHKERRQ(ierr);
181818c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetUseSAEstEig_C",PCGAMGSetUseSAEstEig_GAMG);CHKERRQ(ierr);
18191cc46a46SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetReuseInterpolation_C",PCGAMGSetReuseInterpolation_GAMG);CHKERRQ(ierr);
1820cab9ed1eSBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGASMSetUseAggs_C",PCGAMGASMSetUseAggs_GAMG);CHKERRQ(ierr);
1821171cca9aSMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetUseParallelCoarseGridSolve_C",PCGAMGSetUseParallelCoarseGridSolve_GAMG);CHKERRQ(ierr);
1822ce7c7f2fSMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetCpuPinCoarseGrids_C",PCGAMGSetCpuPinCoarseGrids_GAMG);CHKERRQ(ierr);
1823ce7c7f2fSMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetCoarseGridLayoutType_C",PCGAMGSetCoarseGridLayoutType_GAMG);CHKERRQ(ierr);
1824bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetThreshold_C",PCGAMGSetThreshold_GAMG);CHKERRQ(ierr);
1825c9567895SMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetRankReductionFactors_C",PCGAMGSetRankReductionFactors_GAMG);CHKERRQ(ierr);
1826c1eae691SMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetThresholdScale_C",PCGAMGSetThresholdScale_GAMG);CHKERRQ(ierr);
1827bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetType_C",PCGAMGSetType_GAMG);CHKERRQ(ierr);
1828c60c7ad4SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGGetType_C",PCGAMGGetType_GAMG);CHKERRQ(ierr);
1829bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetNlevels_C",PCGAMGSetNlevels_GAMG);CHKERRQ(ierr);
18309d5b6da9SMark F. Adams   pc_gamg->repart           = PETSC_FALSE;
1831d3042614SMark Adams   pc_gamg->reuse_prol       = PETSC_FALSE;
18320c3bc534SBarry Smith   pc_gamg->use_aggs_in_asm  = PETSC_FALSE;
1833171cca9aSMark Adams   pc_gamg->use_parallel_coarse_grid_solver = PETSC_FALSE;
1834a0095786SMark   pc_gamg->cpu_pin_coarse_grids = PETSC_FALSE;
1835a0095786SMark   pc_gamg->layout_type      = PCGAMG_LAYOUT_SPREAD;
1836038f3aa4SMark F. Adams   pc_gamg->min_eq_proc      = 50;
183725a145a7SMark Adams   pc_gamg->coarse_eq_limit  = 50;
183818c3aa7eSMark   for (i=0;i<PETSC_MG_MAXLEVELS;i++) pc_gamg->threshold[i] = 0.;
1839c1eae691SMark Adams   pc_gamg->threshold_scale = 1.;
184018c3aa7eSMark   pc_gamg->Nlevels          = PETSC_MG_MAXLEVELS;
18419ab59c8bSMark Adams   pc_gamg->current_level    = 0; /* don't need to init really */
1842d24ecf33SMark   ierr = PetscStrcpy(pc_gamg->esteig_type,NULL);CHKERRQ(ierr);
184318c3aa7eSMark   pc_gamg->esteig_max_it    = 10;
184418c3aa7eSMark   pc_gamg->use_sa_esteig    = -1;
184518c3aa7eSMark   pc_gamg->emin             = 0;
184618c3aa7eSMark   pc_gamg->emax             = 0;
184718c3aa7eSMark 
1848c238b0ebSToby Isaac   pc_gamg->ops->createlevel = PCGAMGCreateLevel_GAMG;
18499d5b6da9SMark F. Adams 
1850bd94a7aaSJed Brown   /* PCSetUp_GAMG assumes that the type has been set, so set it to the default now */
1851bd94a7aaSJed Brown   ierr = PCGAMGSetType(pc,PCGAMGAGG);CHKERRQ(ierr);
18525b89ad90SMark F. Adams   PetscFunctionReturn(0);
18535b89ad90SMark F. Adams }
18543e3471ccSMark Adams 
18553e3471ccSMark Adams /*@C
18563e3471ccSMark Adams  PCGAMGInitializePackage - This function initializes everything in the PCGAMG package. It is called
18578a690491SBarry Smith     from PCInitializePackage().
18583e3471ccSMark Adams 
18593e3471ccSMark Adams  Level: developer
18603e3471ccSMark Adams 
18613e3471ccSMark Adams  .seealso: PetscInitialize()
18623e3471ccSMark Adams @*/
18633e3471ccSMark Adams PetscErrorCode PCGAMGInitializePackage(void)
18643e3471ccSMark Adams {
18653e3471ccSMark Adams   PetscErrorCode ierr;
18663e3471ccSMark Adams 
18673e3471ccSMark Adams   PetscFunctionBegin;
18683e3471ccSMark Adams   if (PCGAMGPackageInitialized) PetscFunctionReturn(0);
18693e3471ccSMark Adams   PCGAMGPackageInitialized = PETSC_TRUE;
18703e3471ccSMark Adams   ierr = PetscFunctionListAdd(&GAMGList,PCGAMGGEO,PCCreateGAMG_GEO);CHKERRQ(ierr);
18713e3471ccSMark Adams   ierr = PetscFunctionListAdd(&GAMGList,PCGAMGAGG,PCCreateGAMG_AGG);CHKERRQ(ierr);
18728e6d0c30SPeter Brune   ierr = PetscFunctionListAdd(&GAMGList,PCGAMGCLASSICAL,PCCreateGAMG_Classical);CHKERRQ(ierr);
18733e3471ccSMark Adams   ierr = PetscRegisterFinalize(PCGAMGFinalizePackage);CHKERRQ(ierr);
1874c1c463dbSMark Adams 
1875c1c463dbSMark Adams   /* general events */
1876fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGGraph_AGG", 0, &PC_GAMGGraph_AGG);CHKERRQ(ierr);
1877fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGGraph_GEO", PC_CLASSID, &PC_GAMGGraph_GEO);CHKERRQ(ierr);
1878fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGCoarse_AGG", PC_CLASSID, &PC_GAMGCoarsen_AGG);CHKERRQ(ierr);
1879fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGCoarse_GEO", PC_CLASSID, &PC_GAMGCoarsen_GEO);CHKERRQ(ierr);
1880c1c463dbSMark Adams   ierr = PetscLogEventRegister("PCGAMGProl_AGG", PC_CLASSID, &PC_GAMGProlongator_AGG);CHKERRQ(ierr);
1881c1c463dbSMark Adams   ierr = PetscLogEventRegister("PCGAMGProl_GEO", PC_CLASSID, &PC_GAMGProlongator_GEO);CHKERRQ(ierr);
1882fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGPOpt_AGG", PC_CLASSID, &PC_GAMGOptProlongator_AGG);CHKERRQ(ierr);
1883c1c463dbSMark Adams 
18845b89ad90SMark F. Adams #if defined PETSC_GAMG_USE_LOG
18855b89ad90SMark F. Adams   ierr = PetscLogEventRegister("GAMG: createProl", PC_CLASSID, &petsc_gamg_setup_events[SET1]);CHKERRQ(ierr);
18865b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Graph", PC_CLASSID, &petsc_gamg_setup_events[GRAPH]);CHKERRQ(ierr);
18875b89ad90SMark F. Adams   /* PetscLogEventRegister("    G.Mat", PC_CLASSID, &petsc_gamg_setup_events[GRAPH_MAT]); */
18885b89ad90SMark F. Adams   /* PetscLogEventRegister("    G.Filter", PC_CLASSID, &petsc_gamg_setup_events[GRAPH_FILTER]); */
18895b89ad90SMark F. Adams   /* PetscLogEventRegister("    G.Square", PC_CLASSID, &petsc_gamg_setup_events[GRAPH_SQR]); */
18905b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  MIS/Agg", PC_CLASSID, &petsc_gamg_setup_events[SET4]);CHKERRQ(ierr);
18915b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  geo: growSupp", PC_CLASSID, &petsc_gamg_setup_events[SET5]);CHKERRQ(ierr);
18925b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  geo: triangle", PC_CLASSID, &petsc_gamg_setup_events[SET6]);CHKERRQ(ierr);
1893bb235841SBarry Smith   ierr = PetscLogEventRegister("    search-set", PC_CLASSID, &petsc_gamg_setup_events[FIND_V]);CHKERRQ(ierr);
18945b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  SA: col data", PC_CLASSID, &petsc_gamg_setup_events[SET7]);CHKERRQ(ierr);
18955b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  SA: frmProl0", PC_CLASSID, &petsc_gamg_setup_events[SET8]);CHKERRQ(ierr);
18965b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  SA: smooth", PC_CLASSID, &petsc_gamg_setup_events[SET9]);CHKERRQ(ierr);
18975b89ad90SMark F. Adams   ierr = PetscLogEventRegister("GAMG: partLevel", PC_CLASSID, &petsc_gamg_setup_events[SET2]);CHKERRQ(ierr);
18985b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  repartition", PC_CLASSID, &petsc_gamg_setup_events[SET12]);CHKERRQ(ierr);
18995b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Invert-Sort", PC_CLASSID, &petsc_gamg_setup_events[SET13]);CHKERRQ(ierr);
19005b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Move A", PC_CLASSID, &petsc_gamg_setup_events[SET14]);CHKERRQ(ierr);
19015b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Move P", PC_CLASSID, &petsc_gamg_setup_events[SET15]);CHKERRQ(ierr);
19025b89ad90SMark F. Adams 
19035b89ad90SMark F. Adams   /* PetscLogEventRegister(" PL move data", PC_CLASSID, &petsc_gamg_setup_events[SET13]); */
19045b89ad90SMark F. Adams   /* PetscLogEventRegister("GAMG: fix", PC_CLASSID, &petsc_gamg_setup_events[SET10]); */
19055b89ad90SMark F. Adams   /* PetscLogEventRegister("GAMG: set levels", PC_CLASSID, &petsc_gamg_setup_events[SET11]); */
19065b89ad90SMark F. Adams   /* create timer stages */
19075b89ad90SMark F. Adams #if defined GAMG_STAGES
19085b89ad90SMark F. Adams   {
19095b89ad90SMark F. Adams     char     str[32];
19105b89ad90SMark F. Adams     PetscInt lidx;
19115b89ad90SMark F. Adams     sprintf(str,"MG Level %d (finest)",0);
19125b89ad90SMark F. Adams     ierr = PetscLogStageRegister(str, &gamg_stages[0]);CHKERRQ(ierr);
19135b89ad90SMark F. Adams     for (lidx=1; lidx<9; lidx++) {
1914c9567895SMark       sprintf(str,"MG Level %d",(int)lidx);
19155b89ad90SMark F. Adams       ierr = PetscLogStageRegister(str, &gamg_stages[lidx]);CHKERRQ(ierr);
19165b89ad90SMark F. Adams     }
19175b89ad90SMark F. Adams   }
19185b89ad90SMark F. Adams #endif
19195b89ad90SMark F. Adams #endif
19203e3471ccSMark Adams   PetscFunctionReturn(0);
19213e3471ccSMark Adams }
19223e3471ccSMark Adams 
19233e3471ccSMark Adams /*@C
19241c1aac46SBarry Smith  PCGAMGFinalizePackage - This function frees everything from the PCGAMG package. It is
19251c1aac46SBarry Smith     called from PetscFinalize() automatically.
19263e3471ccSMark Adams 
19273e3471ccSMark Adams  Level: developer
19283e3471ccSMark Adams 
19293e3471ccSMark Adams  .seealso: PetscFinalize()
19303e3471ccSMark Adams @*/
19313e3471ccSMark Adams PetscErrorCode PCGAMGFinalizePackage(void)
19323e3471ccSMark Adams {
19333e3471ccSMark Adams   PetscErrorCode ierr;
19343e3471ccSMark Adams 
19353e3471ccSMark Adams   PetscFunctionBegin;
19363e3471ccSMark Adams   PCGAMGPackageInitialized = PETSC_FALSE;
19373e3471ccSMark Adams   ierr = PetscFunctionListDestroy(&GAMGList);CHKERRQ(ierr);
19383e3471ccSMark Adams   PetscFunctionReturn(0);
19393e3471ccSMark Adams }
1940a36cf38bSToby Isaac 
1941a36cf38bSToby Isaac /*@C
1942a36cf38bSToby Isaac  PCGAMGRegister - Register a PCGAMG implementation.
1943a36cf38bSToby Isaac 
1944a36cf38bSToby Isaac  Input Parameters:
1945a36cf38bSToby Isaac  + type - string that will be used as the name of the GAMG type.
1946a36cf38bSToby Isaac  - create - function for creating the gamg context.
1947a36cf38bSToby Isaac 
1948a36cf38bSToby Isaac   Level: advanced
1949a36cf38bSToby Isaac 
19501c1aac46SBarry Smith  .seealso: PCGAMGType, PCGAMG, PCGAMGSetType()
1951a36cf38bSToby Isaac @*/
1952a36cf38bSToby Isaac PetscErrorCode PCGAMGRegister(PCGAMGType type, PetscErrorCode (*create)(PC))
1953a36cf38bSToby Isaac {
1954a36cf38bSToby Isaac   PetscErrorCode ierr;
1955a36cf38bSToby Isaac 
1956a36cf38bSToby Isaac   PetscFunctionBegin;
1957a36cf38bSToby Isaac   ierr = PCGAMGInitializePackage();CHKERRQ(ierr);
1958a36cf38bSToby Isaac   ierr = PetscFunctionListAdd(&GAMGList,type,create);CHKERRQ(ierr);
1959a36cf38bSToby Isaac   PetscFunctionReturn(0);
1960a36cf38bSToby Isaac }
1961a36cf38bSToby Isaac 
1962