xref: /petsc/src/ksp/pc/impls/gamg/gamg.c (revision 1a2c6b5c4ccd6e90882584b05035e103099f6217)
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 PetscLogEvent petsc_gamg_setup_events[NUM_SET];
184555aa8cSStefano Zampini PetscLogEvent petsc_gamg_setup_matmat_events[PETSC_MG_MAXLEVELS][3];
19fd1112cbSBarry Smith PetscLogEvent PC_GAMGGraph_AGG;
20fd1112cbSBarry Smith PetscLogEvent PC_GAMGGraph_GEO;
210cbbd2e1SMark F. Adams PetscLogEvent PC_GAMGCoarsen_AGG;
220cbbd2e1SMark F. Adams PetscLogEvent PC_GAMGCoarsen_GEO;
230cbbd2e1SMark F. Adams PetscLogEvent PC_GAMGProlongator_AGG;
240cbbd2e1SMark F. Adams PetscLogEvent PC_GAMGProlongator_GEO;
25fd1112cbSBarry Smith PetscLogEvent PC_GAMGOptProlongator_AGG;
260cbbd2e1SMark F. Adams 
27b8fd24d8SMark F. Adams /* #define GAMG_STAGES */
284555aa8cSStefano Zampini #if defined(GAMG_STAGES)
2918c3aa7eSMark static PetscLogStage gamg_stages[PETSC_MG_MAXLEVELS];
30b4fbaa2aSMark F. Adams #endif
31f96513f1SMatthew G Knepley 
320a545947SLisandro Dalcin static PetscFunctionList GAMGList = NULL;
333e3471ccSMark Adams static PetscBool PCGAMGPackageInitialized;
349d5b6da9SMark F. Adams 
35d3d6bff4SMark F. Adams /* ----------------------------------------------------------------------------- */
36d3d6bff4SMark F. Adams PetscErrorCode PCReset_GAMG(PC pc)
37d3d6bff4SMark F. Adams {
3818c3aa7eSMark   PetscErrorCode ierr, level;
39d3d6bff4SMark F. Adams   PC_MG          *mg      = (PC_MG*)pc->data;
40d3d6bff4SMark F. Adams   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
41d3d6bff4SMark F. Adams 
42d3d6bff4SMark F. Adams   PetscFunctionBegin;
4322a233eaSStefano Zampini   ierr = PetscFree(pc_gamg->data);CHKERRQ(ierr);
441c1aac46SBarry Smith   pc_gamg->data_sz = 0;
45878e152fSMark F. Adams   ierr = PetscFree(pc_gamg->orig_data);CHKERRQ(ierr);
4618c3aa7eSMark   for (level = 0; level < PETSC_MG_MAXLEVELS ; level++) {
4718c3aa7eSMark     mg->min_eigen_DinvA[level] = 0;
4818c3aa7eSMark     mg->max_eigen_DinvA[level] = 0;
4918c3aa7eSMark   }
5018c3aa7eSMark   pc_gamg->emin = 0;
5118c3aa7eSMark   pc_gamg->emax = 0;
52a2f3521dSMark F. Adams   PetscFunctionReturn(0);
53a2f3521dSMark F. Adams }
54a2f3521dSMark F. Adams 
555b89ad90SMark F. Adams /* -------------------------------------------------------------------------- */
565b89ad90SMark F. Adams /*
57c238b0ebSToby Isaac    PCGAMGCreateLevel_GAMG: create coarse op with RAP.  repartition and/or reduce number
58a147abb0SMark F. Adams      of active processors.
595b89ad90SMark F. Adams 
605b89ad90SMark F. Adams    Input Parameter:
61a2f3521dSMark F. Adams    . pc - parameters + side effect: coarse data in 'pc_gamg->data' and
62a2f3521dSMark F. Adams           'pc_gamg->data_sz' are changed via repartitioning/reduction.
639d5b6da9SMark F. Adams    . Amat_fine - matrix on this fine (k) level
64c5bfad50SMark F. Adams    . cr_bs - coarse block size
653530afc2SMark F. Adams    In/Output Parameter:
66a2f3521dSMark F. Adams    . a_P_inout - prolongation operator to the next level (k-->k-1)
67afc97cdcSMark F. Adams    . a_nactive_proc - number of active procs
6811e60469SMark F. Adams    Output Parameter:
693530afc2SMark F. Adams    . a_Amat_crs - coarse matrix that is created (k-1)
705b89ad90SMark F. Adams */
715cb416c2SMark F. Adams 
72171cca9aSMark 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)
735b89ad90SMark F. Adams {
74a2f3521dSMark F. Adams   PetscErrorCode  ierr;
759d5b6da9SMark F. Adams   PC_MG           *mg         = (PC_MG*)pc->data;
76486a8d0bSJed Brown   PC_GAMG         *pc_gamg    = (PC_GAMG*)mg->innerctx;
77a2f3521dSMark F. Adams   Mat             Cmat,Pold=*a_P_inout;
783b4367a7SBarry Smith   MPI_Comm        comm;
79c5df96a5SBarry Smith   PetscMPIInt     rank,size,new_size,nactive=*a_nactive_proc;
803ae0bb68SMark Adams   PetscInt        ncrs_eq,ncrs,f_bs;
815b89ad90SMark F. Adams 
825b89ad90SMark F. Adams   PetscFunctionBegin;
833b4367a7SBarry Smith   ierr = PetscObjectGetComm((PetscObject)Amat_fine,&comm);CHKERRQ(ierr);
84ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
85ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr);
86c5bfad50SMark F. Adams   ierr = MatGetBlockSize(Amat_fine, &f_bs);CHKERRQ(ierr);
874555aa8cSStefano Zampini   ierr = PetscLogEventBegin(petsc_gamg_setup_matmat_events[pc_gamg->current_level][1],0,0,0,0);CHKERRQ(ierr);
889d5b6da9SMark F. Adams   ierr = MatPtAP(Amat_fine, Pold, MAT_INITIAL_MATRIX, 2.0, &Cmat);CHKERRQ(ierr);
894555aa8cSStefano Zampini   ierr = PetscLogEventEnd(petsc_gamg_setup_matmat_events[pc_gamg->current_level][1],0,0,0,0);CHKERRQ(ierr);
90038e3b61SMark F. Adams 
91ce7c7f2fSMark Adams   if (Pcolumnperm) *Pcolumnperm = NULL;
92ce7c7f2fSMark Adams 
933ae0bb68SMark Adams   /* set 'ncrs' (nodes), 'ncrs_eq' (equations)*/
940298fd71SBarry Smith   ierr = MatGetLocalSize(Cmat, &ncrs_eq, NULL);CHKERRQ(ierr);
953ae0bb68SMark Adams   if (pc_gamg->data_cell_rows>0) {
963ae0bb68SMark Adams     ncrs = pc_gamg->data_sz/pc_gamg->data_cell_cols/pc_gamg->data_cell_rows;
9773911c69SBarry Smith   } else {
983ae0bb68SMark Adams     PetscInt  bs;
993ae0bb68SMark Adams     ierr = MatGetBlockSize(Cmat, &bs);CHKERRQ(ierr);
1003ae0bb68SMark Adams     ncrs = ncrs_eq/bs;
1013ae0bb68SMark Adams   }
102c5df96a5SBarry Smith   /* get number of PEs to make active 'new_size', reduce, can be any integer 1-P */
103c9567895SMark   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. */
104c9567895SMark #if defined(PETSC_HAVE_CUDA)
105c9567895SMark     PetscShmComm pshmcomm;
106c9567895SMark     PetscMPIInt  locrank;
107c9567895SMark     MPI_Comm     loccomm;
108c9567895SMark     PetscInt     s_nnodes,r_nnodes, new_new_size;
109c9567895SMark     cudaError_t  cerr;
110c9567895SMark     int          devCount;
111c9567895SMark     ierr = PetscShmCommGet(comm,&pshmcomm);CHKERRQ(ierr);
112c9567895SMark     ierr = PetscShmCommGetMpiShmComm(pshmcomm,&loccomm);CHKERRQ(ierr);
11355b25c41SPierre Jolivet     ierr = MPI_Comm_rank(loccomm, &locrank);CHKERRMPI(ierr);
114c9567895SMark     s_nnodes = !locrank;
11555b25c41SPierre Jolivet     ierr = MPI_Allreduce(&s_nnodes,&r_nnodes,1,MPIU_INT,MPI_SUM,comm);CHKERRMPI(ierr);
116c9567895SMark     if (size%r_nnodes) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_PLIB,"odd number of nodes np=%D nnodes%D",size,r_nnodes);
117c9567895SMark     devCount = 0;
118c9567895SMark     cerr = cudaGetDeviceCount(&devCount);
119c9567895SMark     cudaGetLastError(); /* Reset the last error */
120c9567895SMark     if (cerr == cudaSuccess && devCount >= 1) { /* There are devices, else go to heuristic */
121c9567895SMark       new_new_size = r_nnodes * devCount;
122c9567895SMark       new_size = new_new_size;
123adf5291fSStefano Zampini       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);
124c9567895SMark     } else {
125c9567895SMark       ierr = PetscInfo(pc,"With Cuda but no device. Use heuristics.");CHKERRQ(ierr);
126c9567895SMark       goto HEURISTIC;
127c9567895SMark     }
128c9567895SMark #else
129c9567895SMark     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"should not be here");
130c9567895SMark #endif
131c9567895SMark   } else if (pc_gamg->level_reduction_factors[pc_gamg->current_level] > 0) {
132c9567895SMark     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]);
133c9567895SMark     new_size = nactive/pc_gamg->level_reduction_factors[pc_gamg->current_level];
134adf5291fSStefano Zampini     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);
135c9567895SMark   } else if (is_last && !pc_gamg->use_parallel_coarse_grid_solver) {
136c9567895SMark     new_size = 1;
137adf5291fSStefano Zampini     ierr = PetscInfo1(pc,"Force coarsest grid reduction to %d active processes\n",new_size);CHKERRQ(ierr);
138c9567895SMark   } else {
139472110cdSMark F. Adams     PetscInt ncrs_eq_glob;
140c9567895SMark #if defined(PETSC_HAVE_CUDA)
141c9567895SMark     HEURISTIC:
142c9567895SMark #endif
1430298fd71SBarry Smith     ierr     = MatGetSize(Cmat, &ncrs_eq_glob, NULL);CHKERRQ(ierr);
144a90e85d9SMark Adams     new_size = (PetscMPIInt)((float)ncrs_eq_glob/(float)pc_gamg->min_eq_proc + 0.5); /* hardwire min. number of eq/proc */
1457f66b68fSMark Adams     if (!new_size) new_size = 1; /* not likely, posible? */
146c5df96a5SBarry Smith     else if (new_size >= nactive) new_size = nactive; /* no change, rare */
147adf5291fSStefano Zampini     ierr = PetscInfo2(pc,"Coarse grid reduction from %d to %d active processes\n",nactive,new_size);CHKERRQ(ierr);
148a2f3521dSMark F. Adams   }
1492e3501ffSMark Adams   if (new_size==nactive) {
150ef3f0257SMark Adams     *a_Amat_crs = Cmat; /* output - no repartitioning or reduction - could bail here */
151ce7c7f2fSMark Adams     if (new_size < size) {
152ce7c7f2fSMark Adams       /* odd case where multiple coarse grids are on one processor or no coarsening ... */
153adf5291fSStefano Zampini       ierr = PetscInfo1(pc,"reduced grid using same number of processors (%d) as last grid (use larger coarse grid)\n",nactive);CHKERRQ(ierr);
154ce7c7f2fSMark Adams       if (pc_gamg->cpu_pin_coarse_grids) {
155b470e4b4SRichard Tran Mills         ierr = MatBindToCPU(*a_Amat_crs,PETSC_TRUE);CHKERRQ(ierr);
156b470e4b4SRichard Tran Mills         ierr = MatBindToCPU(*a_P_inout,PETSC_TRUE);CHKERRQ(ierr);
157ce7c7f2fSMark Adams       }
158ce7c7f2fSMark Adams     }
159ef3f0257SMark Adams     /* we know that the grid structure can be reused in MatPtAP */
1602e3501ffSMark Adams   } else { /* reduce active processors - we know that the grid structure can NOT be reused in MatPtAP */
161192c0e8bSMark Adams     PetscInt       *counts,*newproc_idx,ii,jj,kk,strideNew,*tidx,ncrs_new,ncrs_eq_new,nloc_old,expand_factor=1,rfactor=1;
162885364a3SMark Adams     IS             is_eq_newproc,is_eq_num,is_eq_num_prim,new_eq_indices;
16371959b99SBarry Smith     nloc_old = ncrs_eq/cr_bs;
16471959b99SBarry 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);
165ce7c7f2fSMark Adams     /* get new_size and rfactor */
166ce7c7f2fSMark Adams     if (pc_gamg->layout_type==PCGAMG_LAYOUT_SPREAD || !pc_gamg->repart) {
167ce7c7f2fSMark Adams       /* find factor */
168ce7c7f2fSMark Adams       if (new_size == 1) rfactor = size; /* don't modify */
169ce7c7f2fSMark Adams       else {
170ce7c7f2fSMark Adams         PetscReal best_fact = 0.;
171ce7c7f2fSMark Adams         jj = -1;
172ce7c7f2fSMark Adams         for (kk = 1 ; kk <= size ; kk++) {
173ce7c7f2fSMark Adams           if (!(size%kk)) { /* a candidate */
174ce7c7f2fSMark Adams             PetscReal nactpe = (PetscReal)size/(PetscReal)kk, fact = nactpe/(PetscReal)new_size;
175ce7c7f2fSMark Adams             if (fact > 1.0) fact = 1./fact; /* keep fact < 1 */
176ce7c7f2fSMark Adams             if (fact > best_fact) {
177ce7c7f2fSMark Adams               best_fact = fact; jj = kk;
178ce7c7f2fSMark Adams             }
179ce7c7f2fSMark Adams           }
180ce7c7f2fSMark Adams         }
181ce7c7f2fSMark Adams         if (jj != -1) rfactor = jj;
182ce7c7f2fSMark Adams         else rfactor = 1; /* a prime */
183ce7c7f2fSMark Adams         if (pc_gamg->layout_type == PCGAMG_LAYOUT_COMPACT) expand_factor = 1;
184ce7c7f2fSMark Adams         else expand_factor = rfactor;
185ce7c7f2fSMark Adams       }
186ce7c7f2fSMark Adams       new_size = size/rfactor; /* make new size one that is factor */
1874cdfd227SMark       if (new_size==nactive) { /* no repartitioning or reduction, bail out because nested here (rare) */
1884cdfd227SMark         *a_Amat_crs = Cmat;
189adf5291fSStefano Zampini         ierr = PetscInfo2(pc,"Finding factorable processor set stopped reduction: new_size=%d, neq(loc)=%D\n",new_size,ncrs_eq);CHKERRQ(ierr);
190ce7c7f2fSMark Adams         PetscFunctionReturn(0);
191ce7c7f2fSMark Adams       }
192ce7c7f2fSMark Adams     }
1934cdfd227SMark     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET12],0,0,0,0);CHKERRQ(ierr);
194a2f3521dSMark F. Adams     /* make 'is_eq_newproc' */
195785e854fSJed Brown     ierr = PetscMalloc1(size, &counts);CHKERRQ(ierr);
1962e3501ffSMark Adams     if (pc_gamg->repart) {
197a2f3521dSMark F. Adams       /* Repartition Cmat_{k} and move colums of P^{k}_{k-1} and coordinates of primal part accordingly */
1985a9b9e01SMark F. Adams       Mat      adj;
199adf5291fSStefano Zampini       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);
200a2f3521dSMark F. Adams       /* get 'adj' */
201c5bfad50SMark F. Adams       if (cr_bs == 1) {
202038e3b61SMark F. Adams         ierr = MatConvert(Cmat, MATMPIADJ, MAT_INITIAL_MATRIX, &adj);CHKERRQ(ierr);
203806fa848SBarry Smith       } else {
204a2f3521dSMark F. Adams         /* make a scalar matrix to partition (no Stokes here) */
205eb07cef2SMark F. Adams         Mat               tMat;
206a2f3521dSMark F. Adams         PetscInt          Istart_crs,Iend_crs,ncols,jj,Ii;
207b4fbaa2aSMark F. Adams         const PetscScalar *vals;
208b4fbaa2aSMark F. Adams         const PetscInt    *idx;
209a2f3521dSMark F. Adams         PetscInt          *d_nnz, *o_nnz, M, N;
21039d09545SMark Adams         static PetscInt   llev = 0; /* ugly but just used for debugging */
211d9558ea9SBarry Smith         MatType           mtype;
212b4fbaa2aSMark F. Adams 
213e632b94dSBarry Smith         ierr = PetscMalloc2(ncrs, &d_nnz,ncrs, &o_nnz);CHKERRQ(ierr);
214a2f3521dSMark F. Adams         ierr = MatGetOwnershipRange(Cmat, &Istart_crs, &Iend_crs);CHKERRQ(ierr);
215a2f3521dSMark F. Adams         ierr = MatGetSize(Cmat, &M, &N);CHKERRQ(ierr);
216c5bfad50SMark F. Adams         for (Ii = Istart_crs, jj = 0; Ii < Iend_crs; Ii += cr_bs, jj++) {
2170a545947SLisandro Dalcin           ierr      = MatGetRow(Cmat,Ii,&ncols,NULL,NULL);CHKERRQ(ierr);
218c5bfad50SMark F. Adams           d_nnz[jj] = ncols/cr_bs;
219c5bfad50SMark F. Adams           o_nnz[jj] = ncols/cr_bs;
2200a545947SLisandro Dalcin           ierr      = MatRestoreRow(Cmat,Ii,&ncols,NULL,NULL);CHKERRQ(ierr);
2213ae0bb68SMark Adams           if (d_nnz[jj] > ncrs) d_nnz[jj] = ncrs;
2223ae0bb68SMark Adams           if (o_nnz[jj] > (M/cr_bs-ncrs)) o_nnz[jj] = M/cr_bs-ncrs;
22358471d46SMark F. Adams         }
2246876a03eSMark F. Adams 
225d9558ea9SBarry Smith         ierr = MatGetType(Amat_fine,&mtype);CHKERRQ(ierr);
2263b4367a7SBarry Smith         ierr = MatCreate(comm, &tMat);CHKERRQ(ierr);
2273ae0bb68SMark Adams         ierr = MatSetSizes(tMat, ncrs, ncrs,PETSC_DETERMINE, PETSC_DETERMINE);CHKERRQ(ierr);
228d9558ea9SBarry Smith         ierr = MatSetType(tMat,mtype);CHKERRQ(ierr);
229a2f3521dSMark F. Adams         ierr = MatSeqAIJSetPreallocation(tMat,0,d_nnz);CHKERRQ(ierr);
230a2f3521dSMark F. Adams         ierr = MatMPIAIJSetPreallocation(tMat,0,d_nnz,0,o_nnz);CHKERRQ(ierr);
231e632b94dSBarry Smith         ierr = PetscFree2(d_nnz,o_nnz);CHKERRQ(ierr);
232eb07cef2SMark F. Adams 
233a2f3521dSMark F. Adams         for (ii = Istart_crs; ii < Iend_crs; ii++) {
234c5bfad50SMark F. Adams           PetscInt dest_row = ii/cr_bs;
23522063be5SMark F. Adams           ierr = MatGetRow(Cmat,ii,&ncols,&idx,&vals);CHKERRQ(ierr);
236eb07cef2SMark F. Adams           for (jj = 0; jj < ncols; jj++) {
237c5bfad50SMark F. Adams             PetscInt    dest_col = idx[jj]/cr_bs;
238eb07cef2SMark F. Adams             PetscScalar v        = 1.0;
239eb07cef2SMark F. Adams             ierr = MatSetValues(tMat,1,&dest_row,1,&dest_col,&v,ADD_VALUES);CHKERRQ(ierr);
240eb07cef2SMark F. Adams           }
24122063be5SMark F. Adams           ierr = MatRestoreRow(Cmat,ii,&ncols,&idx,&vals);CHKERRQ(ierr);
242eb07cef2SMark F. Adams         }
243eb07cef2SMark F. Adams         ierr = MatAssemblyBegin(tMat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
244eb07cef2SMark F. Adams         ierr = MatAssemblyEnd(tMat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
245eb07cef2SMark F. Adams 
246b4fbaa2aSMark F. Adams         if (llev++ == -1) {
247b4fbaa2aSMark F. Adams           PetscViewer viewer; char fname[32];
2488caf3d72SBarry Smith           ierr = PetscSNPrintf(fname,sizeof(fname),"part_mat_%D.mat",llev);CHKERRQ(ierr);
2493b4367a7SBarry Smith           PetscViewerBinaryOpen(comm,fname,FILE_MODE_WRITE,&viewer);
250b4fbaa2aSMark F. Adams           ierr = MatView(tMat, viewer);CHKERRQ(ierr);
2513bf036e2SBarry Smith           ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
252b4fbaa2aSMark F. Adams         }
253eb07cef2SMark F. Adams         ierr = MatConvert(tMat, MATMPIADJ, MAT_INITIAL_MATRIX, &adj);CHKERRQ(ierr);
254eb07cef2SMark F. Adams         ierr = MatDestroy(&tMat);CHKERRQ(ierr);
255a2f3521dSMark F. Adams       } /* create 'adj' */
256f150b916SMark F. Adams 
257a2f3521dSMark F. Adams       { /* partition: get newproc_idx */
2585a9b9e01SMark F. Adams         char            prefix[256];
2595a9b9e01SMark F. Adams         const char      *pcpre;
260b4fbaa2aSMark F. Adams         const PetscInt  *is_idx;
261b4fbaa2aSMark F. Adams         MatPartitioning mpart;
262a4b7d37bSMark F. Adams         IS              proc_is;
2632f03bc48SMark F. Adams 
2643b4367a7SBarry Smith         ierr = MatPartitioningCreate(comm, &mpart);CHKERRQ(ierr);
2655ef31b24SMark F. Adams         ierr = MatPartitioningSetAdjacency(mpart, adj);CHKERRQ(ierr);
2669d5b6da9SMark F. Adams         ierr = PCGetOptionsPrefix(pc, &pcpre);CHKERRQ(ierr);
2678caf3d72SBarry Smith         ierr = PetscSNPrintf(prefix,sizeof(prefix),"%spc_gamg_",pcpre ? pcpre : "");CHKERRQ(ierr);
26859a0be82SJed Brown         ierr = PetscObjectSetOptionsPrefix((PetscObject)mpart,prefix);CHKERRQ(ierr);
26911e60469SMark F. Adams         ierr = MatPartitioningSetFromOptions(mpart);CHKERRQ(ierr);
270c5df96a5SBarry Smith         ierr = MatPartitioningSetNParts(mpart, new_size);CHKERRQ(ierr);
271a4b7d37bSMark F. Adams         ierr = MatPartitioningApply(mpart, &proc_is);CHKERRQ(ierr);
27211e60469SMark F. Adams         ierr = MatPartitioningDestroy(&mpart);CHKERRQ(ierr);
2735a9b9e01SMark F. Adams 
2745ef31b24SMark F. Adams         /* collect IS info */
275785e854fSJed Brown         ierr     = PetscMalloc1(ncrs_eq, &newproc_idx);CHKERRQ(ierr);
276a4b7d37bSMark F. Adams         ierr     = ISGetIndices(proc_is, &is_idx);CHKERRQ(ierr);
277a2f3521dSMark F. Adams         for (kk = jj = 0 ; kk < nloc_old ; kk++) {
278c5bfad50SMark F. Adams           for (ii = 0 ; ii < cr_bs ; ii++, jj++) {
279ce7c7f2fSMark Adams             newproc_idx[jj] = is_idx[kk] * expand_factor; /* distribution */
280eb07cef2SMark F. Adams           }
2815ef31b24SMark F. Adams         }
282a4b7d37bSMark F. Adams         ierr = ISRestoreIndices(proc_is, &is_idx);CHKERRQ(ierr);
283a4b7d37bSMark F. Adams         ierr = ISDestroy(&proc_is);CHKERRQ(ierr);
2845ef31b24SMark F. Adams       }
2855ef31b24SMark F. Adams       ierr = MatDestroy(&adj);CHKERRQ(ierr);
2865a9b9e01SMark F. Adams 
2873b4367a7SBarry Smith       ierr = ISCreateGeneral(comm, ncrs_eq, newproc_idx, PETSC_COPY_VALUES, &is_eq_newproc);CHKERRQ(ierr);
2888263b398SMark F. Adams       ierr = PetscFree(newproc_idx);CHKERRQ(ierr);
28931cb4603SMark Adams     } else { /* simple aggregation of parts -- 'is_eq_newproc' */
290ce7c7f2fSMark Adams       PetscInt targetPE;
2914cdfd227SMark       if (new_size==nactive) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"new_size==nactive. Should not happen");
292302440fdSBarry Smith       ierr = PetscInfo1(pc,"Number of equations (loc) %D with simple aggregation\n",ncrs_eq);CHKERRQ(ierr);
293ce7c7f2fSMark Adams       targetPE = (rank/rfactor)*expand_factor;
2943b4367a7SBarry Smith       ierr     = ISCreateStride(comm, ncrs_eq, targetPE, 0, &is_eq_newproc);CHKERRQ(ierr);
295a2f3521dSMark F. Adams     } /* end simple 'is_eq_newproc' */
296e33ef3b1SMark F. Adams 
29711e60469SMark F. Adams     /*
298a2f3521dSMark F. Adams       Create an index set from the is_eq_newproc index set to indicate the mapping TO
29911e60469SMark F. Adams     */
300a2f3521dSMark F. Adams     ierr = ISPartitioningToNumbering(is_eq_newproc, &is_eq_num);CHKERRQ(ierr);
3017700e67bSMark Adams     is_eq_num_prim = is_eq_num;
30211e60469SMark F. Adams     /*
303a2f3521dSMark F. Adams       Determine how many equations/vertices are assigned to each processor
30411e60469SMark F. Adams     */
305c5df96a5SBarry Smith     ierr        = ISPartitioningCount(is_eq_newproc, size, counts);CHKERRQ(ierr);
306c5df96a5SBarry Smith     ncrs_eq_new = counts[rank];
307a2f3521dSMark F. Adams     ierr        = ISDestroy(&is_eq_newproc);CHKERRQ(ierr);
308ce7c7f2fSMark Adams     ncrs_new = ncrs_eq_new/cr_bs;
309a2f3521dSMark F. Adams 
310a2f3521dSMark F. Adams     ierr = PetscFree(counts);CHKERRQ(ierr);
311885364a3SMark 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 */
312885364a3SMark Adams     {
313885364a3SMark Adams       Vec            src_crd, dest_crd;
314885364a3SMark 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;
315885364a3SMark Adams       VecScatter     vecscat;
316885364a3SMark Adams       PetscScalar    *array;
317885364a3SMark Adams       IS isscat;
318a2f3521dSMark F. Adams       /* move data (for primal equations only) */
31922063be5SMark F. Adams       /* Create a vector to contain the newly ordered element information */
3203b4367a7SBarry Smith       ierr = VecCreate(comm, &dest_crd);CHKERRQ(ierr);
3213ae0bb68SMark Adams       ierr = VecSetSizes(dest_crd, node_data_sz*ncrs_new, PETSC_DECIDE);CHKERRQ(ierr);
322c0dedaeaSBarry Smith       ierr = VecSetType(dest_crd,VECSTANDARD);CHKERRQ(ierr); /* this is needed! */
32311e60469SMark F. Adams       /*
3249d5b6da9SMark F. Adams         There are 'ndata_rows*ndata_cols' data items per node, (one can think of the vectors of having
325c5bfad50SMark F. Adams         a block size of ...).  Note, ISs are expanded into equation space by 'cr_bs'.
32611e60469SMark F. Adams       */
327854ce69bSBarry Smith       ierr = PetscMalloc1(ncrs*node_data_sz, &tidx);CHKERRQ(ierr);
328a2f3521dSMark F. Adams       ierr = ISGetIndices(is_eq_num_prim, &idx);CHKERRQ(ierr);
3293ae0bb68SMark Adams       for (ii=0,jj=0; ii<ncrs; ii++) {
330c5bfad50SMark F. Adams         PetscInt id = idx[ii*cr_bs]/cr_bs; /* get node back */
331a2f3521dSMark F. Adams         for (kk=0; kk<node_data_sz; kk++, jj++) tidx[jj] = id*node_data_sz + kk;
33211e60469SMark F. Adams       }
333a2f3521dSMark F. Adams       ierr = ISRestoreIndices(is_eq_num_prim, &idx);CHKERRQ(ierr);
3343ae0bb68SMark Adams       ierr = ISCreateGeneral(comm, node_data_sz*ncrs, tidx, PETSC_COPY_VALUES, &isscat);CHKERRQ(ierr);
33592a756f0SMark F. Adams       ierr = PetscFree(tidx);CHKERRQ(ierr);
33611e60469SMark F. Adams       /*
33711e60469SMark F. Adams         Create a vector to contain the original vertex information for each element
33811e60469SMark F. Adams       */
3393ae0bb68SMark Adams       ierr = VecCreateSeq(PETSC_COMM_SELF, node_data_sz*ncrs, &src_crd);CHKERRQ(ierr);
3409d5b6da9SMark F. Adams       for (jj=0; jj<ndata_cols; jj++) {
3413ae0bb68SMark Adams         const PetscInt stride0=ncrs*pc_gamg->data_cell_rows;
3423ae0bb68SMark Adams         for (ii=0; ii<ncrs; ii++) {
3439d5b6da9SMark F. Adams           for (kk=0; kk<ndata_rows; kk++) {
344a2f3521dSMark F. Adams             PetscInt    ix = ii*ndata_rows + kk + jj*stride0, jx = ii*node_data_sz + kk*ndata_cols + jj;
345c8b0795cSMark F. Adams             PetscScalar tt = (PetscScalar)pc_gamg->data[ix];
346676e1743SMark F. Adams             ierr = VecSetValues(src_crd, 1, &jx, &tt, INSERT_VALUES);CHKERRQ(ierr);
347d3d6bff4SMark F. Adams           }
348038e3b61SMark F. Adams         }
349eb07cef2SMark F. Adams       }
350eb07cef2SMark F. Adams       ierr = VecAssemblyBegin(src_crd);CHKERRQ(ierr);
351eb07cef2SMark F. Adams       ierr = VecAssemblyEnd(src_crd);CHKERRQ(ierr);
35211e60469SMark F. Adams       /*
35311e60469SMark F. Adams         Scatter the element vertex information (still in the original vertex ordering)
35411e60469SMark F. Adams         to the correct processor
35511e60469SMark F. Adams       */
3569448b7f1SJunchao Zhang       ierr = VecScatterCreate(src_crd, NULL, dest_crd, isscat, &vecscat);CHKERRQ(ierr);
35711e60469SMark F. Adams       ierr = ISDestroy(&isscat);CHKERRQ(ierr);
35811e60469SMark F. Adams       ierr = VecScatterBegin(vecscat,src_crd,dest_crd,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
35911e60469SMark F. Adams       ierr = VecScatterEnd(vecscat,src_crd,dest_crd,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
36011e60469SMark F. Adams       ierr = VecScatterDestroy(&vecscat);CHKERRQ(ierr);
36111e60469SMark F. Adams       ierr = VecDestroy(&src_crd);CHKERRQ(ierr);
36211e60469SMark F. Adams       /*
36311e60469SMark F. Adams         Put the element vertex data into a new allocation of the gdata->ele
36411e60469SMark F. Adams       */
365c8b0795cSMark F. Adams       ierr = PetscFree(pc_gamg->data);CHKERRQ(ierr);
366578f55a3SPeter Brune       ierr = PetscMalloc1(node_data_sz*ncrs_new, &pc_gamg->data);CHKERRQ(ierr);
3672fa5cd67SKarl Rupp 
3683ae0bb68SMark Adams       pc_gamg->data_sz = node_data_sz*ncrs_new;
3693ae0bb68SMark Adams       strideNew        = ncrs_new*ndata_rows;
3702fa5cd67SKarl Rupp 
37111e60469SMark F. Adams       ierr = VecGetArray(dest_crd, &array);CHKERRQ(ierr);
3729d5b6da9SMark F. Adams       for (jj=0; jj<ndata_cols; jj++) {
3733ae0bb68SMark Adams         for (ii=0; ii<ncrs_new; ii++) {
3749d5b6da9SMark F. Adams           for (kk=0; kk<ndata_rows; kk++) {
375a2f3521dSMark F. Adams             PetscInt ix = ii*ndata_rows + kk + jj*strideNew, jx = ii*node_data_sz + kk*ndata_cols + jj;
376c8b0795cSMark F. Adams             pc_gamg->data[ix] = PetscRealPart(array[jx]);
377d3d6bff4SMark F. Adams           }
378038e3b61SMark F. Adams         }
379038e3b61SMark F. Adams       }
38011e60469SMark F. Adams       ierr = VecRestoreArray(dest_crd, &array);CHKERRQ(ierr);
38111e60469SMark F. Adams       ierr = VecDestroy(&dest_crd);CHKERRQ(ierr);
382885364a3SMark Adams     }
383a2f3521dSMark F. Adams     /* move A and P (columns) with new layout */
3840cbbd2e1SMark F. Adams     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET13],0,0,0,0);CHKERRQ(ierr);
38511e60469SMark F. Adams     /*
3867dae84e0SHong Zhang       Invert for MatCreateSubMatrix
38711e60469SMark F. Adams     */
388a2f3521dSMark F. Adams     ierr = ISInvertPermutation(is_eq_num, ncrs_eq_new, &new_eq_indices);CHKERRQ(ierr);
389a2f3521dSMark F. Adams     ierr = ISSort(new_eq_indices);CHKERRQ(ierr); /* is this needed? */
390c5bfad50SMark F. Adams     ierr = ISSetBlockSize(new_eq_indices, cr_bs);CHKERRQ(ierr);
391a2f3521dSMark F. Adams     if (is_eq_num != is_eq_num_prim) {
392a2f3521dSMark F. Adams       ierr = ISDestroy(&is_eq_num_prim);CHKERRQ(ierr); /* could be same as 'is_eq_num' */
393a2f3521dSMark F. Adams     }
3943cb8563fSToby Isaac     if (Pcolumnperm) {
3953cb8563fSToby Isaac       ierr = PetscObjectReference((PetscObject)new_eq_indices);CHKERRQ(ierr);
3963cb8563fSToby Isaac       *Pcolumnperm = new_eq_indices;
3973cb8563fSToby Isaac     }
398a2f3521dSMark F. Adams     ierr = ISDestroy(&is_eq_num);CHKERRQ(ierr);
3990cbbd2e1SMark F. Adams     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET13],0,0,0,0);CHKERRQ(ierr);
4000cbbd2e1SMark F. Adams     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET14],0,0,0,0);CHKERRQ(ierr);
401a2f3521dSMark F. Adams     /* 'a_Amat_crs' output */
402a2f3521dSMark F. Adams     {
403a2f3521dSMark F. Adams       Mat mat;
4047dae84e0SHong Zhang       ierr        = MatCreateSubMatrix(Cmat, new_eq_indices, new_eq_indices, MAT_INITIAL_MATRIX, &mat);CHKERRQ(ierr);
405a2f3521dSMark F. Adams       *a_Amat_crs = mat;
406a2f3521dSMark F. Adams     }
407038e3b61SMark F. Adams     ierr = MatDestroy(&Cmat);CHKERRQ(ierr);
408a2f3521dSMark F. Adams 
4090cbbd2e1SMark F. Adams     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET14],0,0,0,0);CHKERRQ(ierr);
41011e60469SMark F. Adams     /* prolongator */
41111e60469SMark F. Adams     {
41211e60469SMark F. Adams       IS       findices;
413a2f3521dSMark F. Adams       PetscInt Istart,Iend;
414a2f3521dSMark F. Adams       Mat      Pnew;
41562294041SBarry Smith 
416a2f3521dSMark F. Adams       ierr = MatGetOwnershipRange(Pold, &Istart, &Iend);CHKERRQ(ierr);
4170cbbd2e1SMark F. Adams       ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET15],0,0,0,0);CHKERRQ(ierr);
4183b4367a7SBarry Smith       ierr = ISCreateStride(comm,Iend-Istart,Istart,1,&findices);CHKERRQ(ierr);
419c5bfad50SMark F. Adams       ierr = ISSetBlockSize(findices,f_bs);CHKERRQ(ierr);
4207dae84e0SHong Zhang       ierr = MatCreateSubMatrix(Pold, findices, new_eq_indices, MAT_INITIAL_MATRIX, &Pnew);CHKERRQ(ierr);
42111e60469SMark F. Adams       ierr = ISDestroy(&findices);CHKERRQ(ierr);
422*1a2c6b5cSJunchao Zhang       ierr = MatSetOption(Pnew,MAT_FORM_EXPLICIT_TRANSPOSE,PETSC_TRUE);CHKERRQ(ierr);
423c5bfad50SMark F. Adams 
4240cbbd2e1SMark F. Adams       ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET15],0,0,0,0);CHKERRQ(ierr);
4253530afc2SMark F. Adams       ierr = MatDestroy(a_P_inout);CHKERRQ(ierr);
426a2f3521dSMark F. Adams 
427a2f3521dSMark F. Adams       /* output - repartitioned */
428a2f3521dSMark F. Adams       *a_P_inout = Pnew;
429e33ef3b1SMark F. Adams     }
430a2f3521dSMark F. Adams     ierr = ISDestroy(&new_eq_indices);CHKERRQ(ierr);
4315b89ad90SMark F. Adams 
432c5df96a5SBarry Smith     *a_nactive_proc = new_size; /* output */
433ce7c7f2fSMark Adams 
434ce7c7f2fSMark Adams     /* pinning on reduced grids, not a bad heuristic and optimization gets folded into process reduction optimization */
435ce7c7f2fSMark Adams     if (pc_gamg->cpu_pin_coarse_grids) {
436ce7c7f2fSMark Adams #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
4378bca76a6SMark Adams       static PetscInt llev = 2;
43839d09545SMark Adams       ierr = PetscInfo1(pc,"Pinning level %D to the CPU\n",llev++);CHKERRQ(ierr);
439ce7c7f2fSMark Adams #endif
440b470e4b4SRichard Tran Mills       ierr = MatBindToCPU(*a_Amat_crs,PETSC_TRUE);CHKERRQ(ierr);
441b470e4b4SRichard Tran Mills       ierr = MatBindToCPU(*a_P_inout,PETSC_TRUE);CHKERRQ(ierr);
442adf5291fSStefano Zampini       if (1) { /* HACK: move this to MatBindCPU_MPIAIJXXX; lvec is created, need to pin it, this is done in MatSetUpMultiply_MPIAIJ. Hack */
443ce7c7f2fSMark Adams         Mat         A = *a_Amat_crs, P = *a_P_inout;
444ce7c7f2fSMark Adams         PetscMPIInt size;
445ffc4695bSBarry Smith         ierr = MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);CHKERRMPI(ierr);
446ce7c7f2fSMark Adams         if (size > 1) {
447ce7c7f2fSMark Adams           Mat_MPIAIJ     *a = (Mat_MPIAIJ*)A->data, *p = (Mat_MPIAIJ*)P->data;
448b470e4b4SRichard Tran Mills           ierr = VecBindToCPU(a->lvec,PETSC_TRUE);CHKERRQ(ierr);
449b470e4b4SRichard Tran Mills           ierr = VecBindToCPU(p->lvec,PETSC_TRUE);CHKERRQ(ierr);
450ce7c7f2fSMark Adams         }
451ce7c7f2fSMark Adams       }
452ce7c7f2fSMark Adams     }
4534cdfd227SMark     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET12],0,0,0,0);CHKERRQ(ierr);
454a2f3521dSMark F. Adams   }
4555b89ad90SMark F. Adams   PetscFunctionReturn(0);
4565b89ad90SMark F. Adams }
4575b89ad90SMark F. Adams 
4584b1575e2SStefano Zampini PetscErrorCode PCGAMGSquareGraph_GAMG(PC a_pc, Mat Gmat1, Mat* Gmat2)
4594b1575e2SStefano Zampini {
4604b1575e2SStefano Zampini   PetscErrorCode ierr;
4614b1575e2SStefano Zampini   const char     *prefix;
4624b1575e2SStefano Zampini   char           addp[32];
4634b1575e2SStefano Zampini   PC_MG          *mg      = (PC_MG*)a_pc->data;
4644b1575e2SStefano Zampini   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
4654b1575e2SStefano Zampini 
4664b1575e2SStefano Zampini   PetscFunctionBegin;
4674b1575e2SStefano Zampini   ierr = PCGetOptionsPrefix(a_pc,&prefix);CHKERRQ(ierr);
4684b1575e2SStefano Zampini   ierr = PetscInfo1(a_pc,"Square Graph on level %D\n",pc_gamg->current_level+1);CHKERRQ(ierr);
4694b1575e2SStefano Zampini   ierr = MatProductCreate(Gmat1,Gmat1,NULL,Gmat2);CHKERRQ(ierr);
4704b1575e2SStefano Zampini   ierr = MatSetOptionsPrefix(*Gmat2,prefix);CHKERRQ(ierr);
4714b1575e2SStefano Zampini   ierr = PetscSNPrintf(addp,sizeof(addp),"pc_gamg_square_%d_",pc_gamg->current_level);CHKERRQ(ierr);
4724b1575e2SStefano Zampini   ierr = MatAppendOptionsPrefix(*Gmat2,addp);CHKERRQ(ierr);
473b4da3a1bSStefano Zampini   if ((*Gmat2)->structurally_symmetric) {
474b4da3a1bSStefano Zampini     ierr = MatProductSetType(*Gmat2,MATPRODUCT_AB);CHKERRQ(ierr);
475b4da3a1bSStefano Zampini   } else {
476*1a2c6b5cSJunchao Zhang     ierr = MatSetOption(Gmat1,MAT_FORM_EXPLICIT_TRANSPOSE,PETSC_TRUE);CHKERRQ(ierr);
4774b1575e2SStefano Zampini     ierr = MatProductSetType(*Gmat2,MATPRODUCT_AtB);CHKERRQ(ierr);
478b4da3a1bSStefano Zampini   }
4794b1575e2SStefano Zampini   ierr = MatProductSetFromOptions(*Gmat2);CHKERRQ(ierr);
4804555aa8cSStefano Zampini   ierr = PetscLogEventBegin(petsc_gamg_setup_matmat_events[pc_gamg->current_level][0],0,0,0,0);CHKERRQ(ierr);
4814b1575e2SStefano Zampini   ierr = MatProductSymbolic(*Gmat2);CHKERRQ(ierr);
4824555aa8cSStefano Zampini   ierr = PetscLogEventEnd(petsc_gamg_setup_matmat_events[pc_gamg->current_level][0],0,0,0,0);CHKERRQ(ierr);
483b4da3a1bSStefano Zampini   ierr = MatProductClear(*Gmat2);CHKERRQ(ierr);
4844b1575e2SStefano Zampini   /* we only need the sparsity, cheat and tell PETSc the matrix has been assembled */
4854b1575e2SStefano Zampini   (*Gmat2)->assembled = PETSC_TRUE;
4864b1575e2SStefano Zampini   PetscFunctionReturn(0);
4874b1575e2SStefano Zampini }
4884b1575e2SStefano Zampini 
4895b89ad90SMark F. Adams /* -------------------------------------------------------------------------- */
4905b89ad90SMark F. Adams /*
4915b89ad90SMark F. Adams    PCSetUp_GAMG - Prepares for the use of the GAMG preconditioner
4925b89ad90SMark F. Adams                     by setting data structures and options.
4935b89ad90SMark F. Adams 
4945b89ad90SMark F. Adams    Input Parameter:
4955b89ad90SMark F. Adams .  pc - the preconditioner context
4965b89ad90SMark F. Adams 
4975b89ad90SMark F. Adams */
4989d5b6da9SMark F. Adams PetscErrorCode PCSetUp_GAMG(PC pc)
4995b89ad90SMark F. Adams {
5005b89ad90SMark F. Adams   PetscErrorCode ierr;
5019d5b6da9SMark F. Adams   PC_MG          *mg      = (PC_MG*)pc->data;
5025b89ad90SMark F. Adams   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
5032adcac29SMark F. Adams   Mat            Pmat     = pc->pmat;
50418c3aa7eSMark   PetscInt       fine_level,level,level1,bs,M,N,qq,lidx,nASMBlocksArr[PETSC_MG_MAXLEVELS];
5053b4367a7SBarry Smith   MPI_Comm       comm;
506c5df96a5SBarry Smith   PetscMPIInt    rank,size,nactivepe;
50718c3aa7eSMark   Mat            Aarr[PETSC_MG_MAXLEVELS],Parr[PETSC_MG_MAXLEVELS];
50818c3aa7eSMark   IS             *ASMLocalIDsArr[PETSC_MG_MAXLEVELS];
509a2f3521dSMark F. Adams   PetscLogDouble nnz0=0.,nnztot=0.;
510569f4572SMark Adams   MatInfo        info;
511171cca9aSMark Adams   PetscBool      is_last = PETSC_FALSE;
5125ef31b24SMark F. Adams 
5135b89ad90SMark F. Adams   PetscFunctionBegin;
5143b4367a7SBarry Smith   ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
515ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRMPI(ierr);
516ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRMPI(ierr);
517dfd5c07aSMark F. Adams 
5188abdc6daSStefano Zampini   if (pc->setupcalled) {
5198abdc6daSStefano Zampini     if (!pc_gamg->reuse_prol || pc->flag == DIFFERENT_NONZERO_PATTERN) {
520878e152fSMark F. Adams       /* reset everything */
521878e152fSMark F. Adams       ierr = PCReset_MG(pc);CHKERRQ(ierr);
522878e152fSMark F. Adams       pc->setupcalled = 0;
523806fa848SBarry Smith     } else {
52484d3f75bSMark F. Adams       PC_MG_Levels **mglevels = mg->levels;
52503a628feSMark F. Adams       /* just do Galerkin grids */
52658471d46SMark F. Adams       Mat          B,dA,dB;
52758471d46SMark F. Adams 
5289d5b6da9SMark F. Adams       if (pc_gamg->Nlevels > 1) {
5294555aa8cSStefano Zampini         PetscInt gl;
53058471d46SMark F. Adams         /* currently only handle case where mat and pmat are the same on coarser levels */
53123ee1639SBarry Smith         ierr = KSPGetOperators(mglevels[pc_gamg->Nlevels-1]->smoothd,&dA,&dB);CHKERRQ(ierr);
53258471d46SMark F. Adams         /* (re)set to get dirty flag */
53323ee1639SBarry Smith         ierr = KSPSetOperators(mglevels[pc_gamg->Nlevels-1]->smoothd,dA,dB);CHKERRQ(ierr);
53458471d46SMark F. Adams 
5354555aa8cSStefano Zampini         for (level=pc_gamg->Nlevels-2,gl=0; level>=0; level--,gl++) {
5368abdc6daSStefano Zampini           MatReuse reuse = MAT_INITIAL_MATRIX ;
5378abdc6daSStefano Zampini 
5388abdc6daSStefano Zampini           /* matrix structure can change from repartitioning or process reduction but don't know if we have process reduction here. Should fix */
53923ee1639SBarry Smith           ierr = KSPGetOperators(mglevels[level]->smoothd,NULL,&B);CHKERRQ(ierr);
5408abdc6daSStefano Zampini           if (B->product) {
5418abdc6daSStefano Zampini             if (B->product->A == dB && B->product->B == mglevels[level+1]->interpolate) {
5428abdc6daSStefano Zampini               reuse = MAT_REUSE_MATRIX;
54303a628feSMark F. Adams             }
5448abdc6daSStefano Zampini           }
5458abdc6daSStefano Zampini           if (reuse == MAT_INITIAL_MATRIX) { ierr = MatDestroy(&mglevels[level]->A);CHKERRQ(ierr); }
5468abdc6daSStefano Zampini           if (reuse == MAT_REUSE_MATRIX) {
5478abdc6daSStefano Zampini             ierr = PetscInfo1(pc,"RAP after first solve, reuse matrix level %D\n",level);CHKERRQ(ierr);
5488abdc6daSStefano Zampini           } else {
5498abdc6daSStefano Zampini             ierr = PetscInfo1(pc,"RAP after first solve, new matrix level %D\n",level);CHKERRQ(ierr);
5508abdc6daSStefano Zampini           }
5514555aa8cSStefano Zampini           ierr = PetscLogEventBegin(petsc_gamg_setup_matmat_events[gl][1],0,0,0,0);CHKERRQ(ierr);
5528abdc6daSStefano Zampini           ierr = MatPtAP(dB,mglevels[level+1]->interpolate,reuse,PETSC_DEFAULT,&B);CHKERRQ(ierr);
5534555aa8cSStefano Zampini           ierr = PetscLogEventEnd(petsc_gamg_setup_matmat_events[gl][1],0,0,0,0);CHKERRQ(ierr);
5548abdc6daSStefano Zampini           mglevels[level]->A = B;
55523ee1639SBarry Smith           ierr = KSPSetOperators(mglevels[level]->smoothd,B,B);CHKERRQ(ierr);
55658471d46SMark F. Adams           dB   = B;
55758471d46SMark F. Adams         }
5585f8cf99dSMark F. Adams       }
559d5280255SMark F. Adams 
560d5280255SMark F. Adams       ierr = PCSetUp_MG(pc);CHKERRQ(ierr);
56158471d46SMark F. Adams       PetscFunctionReturn(0);
562eb07cef2SMark F. Adams     }
563878e152fSMark F. Adams   }
564f6536408SMark F. Adams 
565878e152fSMark F. Adams   if (!pc_gamg->data) {
566878e152fSMark F. Adams     if (pc_gamg->orig_data) {
567878e152fSMark F. Adams       ierr = MatGetBlockSize(Pmat, &bs);CHKERRQ(ierr);
5680298fd71SBarry Smith       ierr = MatGetLocalSize(Pmat, &qq, NULL);CHKERRQ(ierr);
5692fa5cd67SKarl Rupp 
570878e152fSMark F. Adams       pc_gamg->data_sz        = (qq/bs)*pc_gamg->orig_data_cell_rows*pc_gamg->orig_data_cell_cols;
571878e152fSMark F. Adams       pc_gamg->data_cell_rows = pc_gamg->orig_data_cell_rows;
572878e152fSMark F. Adams       pc_gamg->data_cell_cols = pc_gamg->orig_data_cell_cols;
5732fa5cd67SKarl Rupp 
574785e854fSJed Brown       ierr = PetscMalloc1(pc_gamg->data_sz, &pc_gamg->data);CHKERRQ(ierr);
575878e152fSMark F. Adams       for (qq=0; qq<pc_gamg->data_sz; qq++) pc_gamg->data[qq] = pc_gamg->orig_data[qq];
576806fa848SBarry Smith     } else {
5771ab5ffc9SJed Brown       if (!pc_gamg->ops->createdefaultdata) SETERRQ(comm,PETSC_ERR_PLIB,"'createdefaultdata' not set(?) need to support NULL data");
5787700e67bSMark Adams       ierr = pc_gamg->ops->createdefaultdata(pc,Pmat);CHKERRQ(ierr);
5799d5b6da9SMark F. Adams     }
580878e152fSMark F. Adams   }
581878e152fSMark F. Adams 
582878e152fSMark F. Adams   /* cache original data for reuse */
5831c1aac46SBarry Smith   if (!pc_gamg->orig_data && (PetscBool)(!pc_gamg->reuse_prol)) {
584785e854fSJed Brown     ierr = PetscMalloc1(pc_gamg->data_sz, &pc_gamg->orig_data);CHKERRQ(ierr);
585878e152fSMark F. Adams     for (qq=0; qq<pc_gamg->data_sz; qq++) pc_gamg->orig_data[qq] = pc_gamg->data[qq];
586878e152fSMark F. Adams     pc_gamg->orig_data_cell_rows = pc_gamg->data_cell_rows;
587878e152fSMark F. Adams     pc_gamg->orig_data_cell_cols = pc_gamg->data_cell_cols;
588878e152fSMark F. Adams   }
589038e3b61SMark F. Adams 
590302f38e8SMark F. Adams   /* get basic dims */
591302f38e8SMark F. Adams   ierr = MatGetBlockSize(Pmat, &bs);CHKERRQ(ierr);
592171cca9aSMark Adams   ierr = MatGetSize(Pmat, &M, &N);CHKERRQ(ierr);
59384d3f75bSMark F. Adams 
594569f4572SMark Adams   ierr = MatGetInfo(Pmat,MAT_GLOBAL_SUM,&info);CHKERRQ(ierr); /* global reduction */
595569f4572SMark Adams   nnz0   = info.nz_used;
596569f4572SMark Adams   nnztot = info.nz_used;
597c9567895SMark   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);
598569f4572SMark Adams 
599a2f3521dSMark F. Adams   /* Get A_i and R_i */
60062294041SBarry Smith   for (level=0, Aarr[0]=Pmat, nactivepe = size; level < (pc_gamg->Nlevels-1) && (!level || M>pc_gamg->coarse_eq_limit); level++) {
6019ab59c8bSMark Adams     pc_gamg->current_level = level;
60218c3aa7eSMark     if (level >= PETSC_MG_MAXLEVELS) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Too many levels %D",level);
6035b89ad90SMark F. Adams     level1 = level + 1;
6040cbbd2e1SMark F. Adams     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET1],0,0,0,0);CHKERRQ(ierr);
6054555aa8cSStefano Zampini #if defined(GAMG_STAGES)
606a2f3521dSMark F. Adams     ierr = PetscLogStagePush(gamg_stages[level]);CHKERRQ(ierr);
607b4fbaa2aSMark F. Adams #endif
608c8b0795cSMark F. Adams     { /* construct prolongator */
609725b86d8SJed Brown       Mat              Gmat;
6100cbbd2e1SMark F. Adams       PetscCoarsenData *agg_lists;
6117700e67bSMark Adams       Mat              Prol11;
612c8b0795cSMark F. Adams 
6137700e67bSMark Adams       ierr = pc_gamg->ops->graph(pc,Aarr[level], &Gmat);CHKERRQ(ierr);
6141ab5ffc9SJed Brown       ierr = pc_gamg->ops->coarsen(pc, &Gmat, &agg_lists);CHKERRQ(ierr);
6157700e67bSMark Adams       ierr = pc_gamg->ops->prolongator(pc,Aarr[level],Gmat,agg_lists,&Prol11);CHKERRQ(ierr);
616c8b0795cSMark F. Adams 
617a2f3521dSMark F. Adams       /* could have failed to create new level */
618a2f3521dSMark F. Adams       if (Prol11) {
619f7df55f0SStefano Zampini         const char *prefix;
620f7df55f0SStefano Zampini         char       addp[32];
621f7df55f0SStefano Zampini 
6229d5b6da9SMark F. Adams         /* get new block size of coarse matrices */
6230298fd71SBarry Smith         ierr = MatGetBlockSizes(Prol11, NULL, &bs);CHKERRQ(ierr);
624a2f3521dSMark F. Adams 
625fd1112cbSBarry Smith         if (pc_gamg->ops->optprolongator) {
626c8b0795cSMark F. Adams           /* smooth */
627fd1112cbSBarry Smith           ierr = pc_gamg->ops->optprolongator(pc, Aarr[level], &Prol11);CHKERRQ(ierr);
628c8b0795cSMark F. Adams         }
629c8b0795cSMark F. Adams 
6300c3bc534SBarry Smith         if (pc_gamg->use_aggs_in_asm) {
6311b18a24aSMark Adams           PetscInt bs;
6321b18a24aSMark Adams           ierr = MatGetBlockSizes(Prol11, &bs, NULL);CHKERRQ(ierr);
6330a3c815dSMark Adams           ierr = PetscCDGetASMBlocks(agg_lists, bs, Gmat, &nASMBlocksArr[level], &ASMLocalIDsArr[level]);CHKERRQ(ierr);
634ffc955d6SMark F. Adams         }
635ffc955d6SMark F. Adams 
636f7df55f0SStefano Zampini         ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
637f7df55f0SStefano Zampini         ierr = MatSetOptionsPrefix(Prol11,prefix);CHKERRQ(ierr);
638c9567895SMark         ierr = PetscSNPrintf(addp,sizeof(addp),"pc_gamg_prolongator_%d_",(int)level);CHKERRQ(ierr);
639f7df55f0SStefano Zampini         ierr = MatAppendOptionsPrefix(Prol11,addp);CHKERRQ(ierr);
64091f31d3dSStefano Zampini         /* Always generate the transpose with CUDA
641f7df55f0SStefano Zampini            Such behaviour can be adapted with -pc_gamg_prolongator_ prefixed options */
642*1a2c6b5cSJunchao Zhang         ierr = MatSetOption(Prol11,MAT_FORM_EXPLICIT_TRANSPOSE,PETSC_TRUE);CHKERRQ(ierr);
643f7df55f0SStefano Zampini         ierr = MatSetFromOptions(Prol11);CHKERRQ(ierr);
6444bde40a0SMark Adams         Parr[level1] = Prol11;
6454bde40a0SMark Adams       } else Parr[level1] = NULL; /* failed to coarsen */
6464bde40a0SMark Adams 
647a2f3521dSMark F. Adams       ierr = MatDestroy(&Gmat);CHKERRQ(ierr);
64841b27cdeSMark F. Adams       ierr = PetscCDDestroy(agg_lists);CHKERRQ(ierr);
649a2f3521dSMark F. Adams     } /* construct prolongator scope */
6500cbbd2e1SMark F. Adams     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET1],0,0,0,0);CHKERRQ(ierr);
6517f66b68fSMark Adams     if (!level) Aarr[0] = Pmat; /* use Pmat for finest level setup */
652171cca9aSMark Adams     if (!Parr[level1]) { /* failed to coarsen */
653569f4572SMark Adams       ierr = PetscInfo1(pc,"Stop gridding, level %D\n",level);CHKERRQ(ierr);
6544555aa8cSStefano Zampini #if defined(GAMG_STAGES)
655a90e85d9SMark Adams       ierr = PetscLogStagePop();CHKERRQ(ierr);
656a90e85d9SMark Adams #endif
657c8b0795cSMark F. Adams       break;
658c8b0795cSMark F. Adams     }
6590cbbd2e1SMark F. Adams     ierr = PetscLogEventBegin(petsc_gamg_setup_events[SET2],0,0,0,0);CHKERRQ(ierr);
660171cca9aSMark Adams     ierr = MatGetSize(Parr[level1], &M, &N);CHKERRQ(ierr); /* N is next M, a loop test variables */
661c9567895SMark     if (is_last) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Is last ?");
662171cca9aSMark Adams     if (N <= pc_gamg->coarse_eq_limit) is_last = PETSC_TRUE;
6630e2909e1SMark Adams     if (level1 == pc_gamg->Nlevels-1) is_last = PETSC_TRUE;
664171cca9aSMark Adams     ierr = pc_gamg->ops->createlevel(pc, Aarr[level], bs, &Parr[level1], &Aarr[level1], &nactivepe, NULL, is_last);CHKERRQ(ierr);
665a2f3521dSMark F. Adams 
6660cbbd2e1SMark F. Adams     ierr = PetscLogEventEnd(petsc_gamg_setup_events[SET2],0,0,0,0);CHKERRQ(ierr);
667171cca9aSMark Adams     ierr = MatGetSize(Aarr[level1], &M, &N);CHKERRQ(ierr); /* M is loop test variables */
668569f4572SMark Adams     ierr = MatGetInfo(Aarr[level1], MAT_GLOBAL_SUM, &info);CHKERRQ(ierr);
669569f4572SMark Adams     nnztot += info.nz_used;
670c9567895SMark     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);
671569f4572SMark Adams 
6724555aa8cSStefano Zampini #if defined(GAMG_STAGES)
673b4fbaa2aSMark F. Adams     ierr = PetscLogStagePop();CHKERRQ(ierr);
674b4fbaa2aSMark F. Adams #endif
675a90e85d9SMark Adams     /* stop if one node or one proc -- could pull back for singular problems */
6769ab59c8bSMark Adams     if ((pc_gamg->data_cell_cols && M/pc_gamg->data_cell_cols < 2) || (!pc_gamg->data_cell_cols && M/bs < 2)) {
6779ab59c8bSMark Adams       ierr =  PetscInfo2(pc,"HARD stop of coarsening on level %D.  Grid too small: %D block nodes\n",level,M/bs);CHKERRQ(ierr);
678a90e85d9SMark Adams       level++;
679a90e85d9SMark Adams       break;
680a90e85d9SMark Adams     }
681c8b0795cSMark F. Adams   } /* levels */
682c8b0795cSMark F. Adams   ierr = PetscFree(pc_gamg->data);CHKERRQ(ierr);
683c8b0795cSMark F. Adams 
684569f4572SMark Adams   ierr = PetscInfo2(pc,"%D levels, grid complexity = %g\n",level+1,nnztot/nnz0);CHKERRQ(ierr);
6859d5b6da9SMark F. Adams   pc_gamg->Nlevels = level + 1;
6865b89ad90SMark F. Adams   fine_level       = level;
6870298fd71SBarry Smith   ierr             = PCMGSetLevels(pc,pc_gamg->Nlevels,NULL);CHKERRQ(ierr);
6885b89ad90SMark F. Adams 
68962294041SBarry Smith   if (pc_gamg->Nlevels > 1) { /* don't setup MG if one level */
6900ed2132dSStefano Zampini     PetscErrorCode (*savesetfromoptions[PETSC_MG_MAXLEVELS])(PetscOptionItems*,KSP);
6910ed2132dSStefano Zampini 
692d5280255SMark F. Adams     /* set default smoothers & set operators */
69362294041SBarry Smith     for (lidx = 1, level = pc_gamg->Nlevels-2; lidx <= fine_level; lidx++, level--) {
694ffc955d6SMark F. Adams       KSP smoother;
695ffc955d6SMark F. Adams       PC  subpc;
696a2f3521dSMark F. Adams 
6979d5b6da9SMark F. Adams       ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
698f6536408SMark F. Adams       ierr = KSPGetPC(smoother, &subpc);CHKERRQ(ierr);
699ffc955d6SMark F. Adams 
700a2f3521dSMark F. Adams       ierr = KSPSetNormType(smoother, KSP_NORM_NONE);CHKERRQ(ierr);
701a2f3521dSMark F. Adams       /* set ops */
70223ee1639SBarry Smith       ierr = KSPSetOperators(smoother, Aarr[level], Aarr[level]);CHKERRQ(ierr);
703a2f3521dSMark F. Adams       ierr = PCMGSetInterpolation(pc, lidx, Parr[level+1]);CHKERRQ(ierr);
704a2f3521dSMark F. Adams 
705a2f3521dSMark F. Adams       /* set defaults */
7066c9de887SHong Zhang       ierr = KSPSetType(smoother, KSPCHEBYSHEV);CHKERRQ(ierr);
707a2f3521dSMark F. Adams 
7080c3bc534SBarry Smith       /* set blocks for ASM smoother that uses the 'aggregates' */
7090c3bc534SBarry Smith       if (pc_gamg->use_aggs_in_asm) {
7102d3561bbSSatish Balay         PetscInt sz;
7117a28f3e5SMark Adams         IS       *iss;
712a2f3521dSMark F. Adams 
7132d3561bbSSatish Balay         sz   = nASMBlocksArr[level];
7147a28f3e5SMark Adams         iss  = ASMLocalIDsArr[level];
7150c3bc534SBarry Smith         ierr = PCSetType(subpc, PCASM);CHKERRQ(ierr);
7160a3c815dSMark Adams         ierr = PCASMSetOverlap(subpc, 0);CHKERRQ(ierr);
7170c3bc534SBarry Smith         ierr = PCASMSetType(subpc,PC_ASM_BASIC);CHKERRQ(ierr);
7187f66b68fSMark Adams         if (!sz) {
719ffc955d6SMark F. Adams           IS       is;
7200a3c815dSMark Adams           ierr = ISCreateGeneral(PETSC_COMM_SELF, 0, NULL, PETSC_COPY_VALUES, &is);CHKERRQ(ierr);
7217a28f3e5SMark Adams           ierr = PCASMSetLocalSubdomains(subpc, 1, NULL, &is);CHKERRQ(ierr);
722a94c3b12SMark F. Adams           ierr = ISDestroy(&is);CHKERRQ(ierr);
723806fa848SBarry Smith         } else {
724a94c3b12SMark F. Adams           PetscInt kk;
7257a28f3e5SMark Adams           ierr = PCASMSetLocalSubdomains(subpc, sz, NULL, iss);CHKERRQ(ierr);
726a94c3b12SMark F. Adams           for (kk=0; kk<sz; kk++) {
7277a28f3e5SMark Adams             ierr = ISDestroy(&iss[kk]);CHKERRQ(ierr);
728a94c3b12SMark F. Adams           }
7297a28f3e5SMark Adams           ierr = PetscFree(iss);CHKERRQ(ierr);
730ffc955d6SMark F. Adams         }
7310298fd71SBarry Smith         ASMLocalIDsArr[level] = NULL;
732ffc955d6SMark F. Adams         nASMBlocksArr[level]  = 0;
733806fa848SBarry Smith       } else {
734890ffe84SMark Adams         ierr = PCSetType(subpc, PCSOR);CHKERRQ(ierr);
735ffc955d6SMark F. Adams       }
736d5280255SMark F. Adams     }
737d5280255SMark F. Adams     {
738d5280255SMark F. Adams       /* coarse grid */
739d5280255SMark F. Adams       KSP smoother,*k2; PC subpc,pc2; PetscInt ii,first;
740d5280255SMark F. Adams       Mat Lmat = Aarr[(level=pc_gamg->Nlevels-1)]; lidx = 0;
7410ed2132dSStefano Zampini 
742d5280255SMark F. Adams       ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
74323ee1639SBarry Smith       ierr = KSPSetOperators(smoother, Lmat, Lmat);CHKERRQ(ierr);
744cf8ae1d3SMark Adams       if (!pc_gamg->use_parallel_coarse_grid_solver) {
745d5280255SMark F. Adams         ierr = KSPSetNormType(smoother, KSP_NORM_NONE);CHKERRQ(ierr);
746d5280255SMark F. Adams         ierr = KSPGetPC(smoother, &subpc);CHKERRQ(ierr);
747d5280255SMark F. Adams         ierr = PCSetType(subpc, PCBJACOBI);CHKERRQ(ierr);
748d5280255SMark F. Adams         ierr = PCSetUp(subpc);CHKERRQ(ierr);
74971959b99SBarry Smith         ierr = PCBJacobiGetSubKSP(subpc,&ii,&first,&k2);CHKERRQ(ierr);
75071959b99SBarry Smith         if (ii != 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"ii %D is not one",ii);
751d5280255SMark F. Adams         ierr = KSPGetPC(k2[0],&pc2);CHKERRQ(ierr);
752d5280255SMark F. Adams         ierr = PCSetType(pc2, PCLU);CHKERRQ(ierr);
7539dbfc187SHong Zhang         ierr = PCFactorSetShiftType(pc2,MAT_SHIFT_INBLOCKS);CHKERRQ(ierr);
7542fb0b348SMark F. Adams         ierr = KSPSetTolerances(k2[0],PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT,1);CHKERRQ(ierr);
75508e36f19SMark Adams         ierr = KSPSetType(k2[0], KSPPREONLY);CHKERRQ(ierr);
7565b42dca8SJed Brown         /* This flag gets reset by PCBJacobiGetSubKSP(), but our BJacobi really does the same algorithm everywhere (and in
7575b42dca8SJed Brown          * fact, all but one process will have zero dofs), so we reset the flag to avoid having PCView_BJacobi attempt to
7585b42dca8SJed Brown          * view every subdomain as though they were different. */
7595b42dca8SJed Brown         ((PC_BJacobi*)subpc->data)->same_local_solves = PETSC_TRUE;
760d5280255SMark F. Adams       }
761cf8ae1d3SMark Adams     }
762d5280255SMark F. Adams 
763d5280255SMark F. Adams     /* should be called in PCSetFromOptions_GAMG(), but cannot be called prior to PCMGSetLevels() */
764d5280255SMark F. Adams     ierr = PetscObjectOptionsBegin((PetscObject)pc);CHKERRQ(ierr);
765e55864a3SBarry Smith     ierr = PCSetFromOptions_MG(PetscOptionsObject,pc);CHKERRQ(ierr);
766d5280255SMark F. Adams     ierr = PetscOptionsEnd();CHKERRQ(ierr);
76769aca0b8SBarry Smith     ierr = PCMGSetGalerkin(pc,PC_MG_GALERKIN_EXTERNAL);CHKERRQ(ierr);
768d5280255SMark F. Adams 
76918c3aa7eSMark     /* setup cheby eigen estimates from SA */
7700ed2132dSStefano Zampini     if (pc_gamg->use_sa_esteig==1) {
77118c3aa7eSMark       for (lidx = 1, level = pc_gamg->Nlevels-2; level >= 0 ; lidx++, level--) {
77218c3aa7eSMark         KSP       smoother;
77318c3aa7eSMark         PetscBool ischeb;
7740ed2132dSStefano Zampini 
7750ed2132dSStefano Zampini         savesetfromoptions[level] = NULL;
77618c3aa7eSMark         ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
77718c3aa7eSMark         ierr = PetscObjectTypeCompare((PetscObject)smoother,KSPCHEBYSHEV,&ischeb);CHKERRQ(ierr);
77818c3aa7eSMark         if (ischeb) {
77918c3aa7eSMark           KSP_Chebyshev *cheb = (KSP_Chebyshev*)smoother->data;
7800ed2132dSStefano Zampini 
7810ed2132dSStefano Zampini           ierr = KSPSetFromOptions(smoother);CHKERRQ(ierr); /* let command line emax override using SA's eigenvalues */
7820ed2132dSStefano Zampini           if (mg->max_eigen_DinvA[level] > 0 && cheb->emax == 0.) {
78318c3aa7eSMark             PC        subpc;
78418c3aa7eSMark             PetscBool isjac;
78518c3aa7eSMark             ierr = KSPGetPC(smoother, &subpc);CHKERRQ(ierr);
78618c3aa7eSMark             ierr = PetscObjectTypeCompare((PetscObject)subpc,PCJACOBI,&isjac);CHKERRQ(ierr);
7870ed2132dSStefano Zampini             if (isjac && pc_gamg->use_sa_esteig==1) {
78818c3aa7eSMark               PetscReal emax,emin;
7890ed2132dSStefano Zampini 
79018c3aa7eSMark               emin = mg->min_eigen_DinvA[level];
79118c3aa7eSMark               emax = mg->max_eigen_DinvA[level];
79218c3aa7eSMark               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);
79318c3aa7eSMark               cheb->emin_computed = emin;
79418c3aa7eSMark               cheb->emax_computed = emax;
79518c3aa7eSMark               ierr = KSPChebyshevSetEigenvalues(smoother, cheb->tform[2]*emin + cheb->tform[3]*emax, cheb->tform[0]*emin + cheb->tform[1]*emax);CHKERRQ(ierr);
7960ed2132dSStefano Zampini 
7970ed2132dSStefano Zampini               /* We have set the eigenvalues and consumed the transformation values
7980ed2132dSStefano Zampini                  prevent from flagging the recomputation of the eigenvalues again in PCSetUp_MG
7990ed2132dSStefano Zampini                  below when setfromoptions will be called again */
8000ed2132dSStefano Zampini               savesetfromoptions[level] = smoother->ops->setfromoptions;
8010ed2132dSStefano Zampini               smoother->ops->setfromoptions = NULL;
80218c3aa7eSMark             }
80318c3aa7eSMark           }
80418c3aa7eSMark         }
80518c3aa7eSMark       }
8060ed2132dSStefano Zampini     }
8070ed2132dSStefano Zampini 
8080ed2132dSStefano Zampini     ierr = PCSetUp_MG(pc);CHKERRQ(ierr);
8090ed2132dSStefano Zampini 
8100ed2132dSStefano Zampini     /* restore Chebyshev smoother for next calls */
8110ed2132dSStefano Zampini     if (pc_gamg->use_sa_esteig==1) {
8120ed2132dSStefano Zampini       for (lidx = 1, level = pc_gamg->Nlevels-2; level >= 0 ; lidx++, level--) {
8130ed2132dSStefano Zampini         if (savesetfromoptions[level]) {
8140ed2132dSStefano Zampini           KSP smoother;
8150ed2132dSStefano Zampini           ierr = PCMGGetSmoother(pc, lidx, &smoother);CHKERRQ(ierr);
8160ed2132dSStefano Zampini           smoother->ops->setfromoptions = savesetfromoptions[level];
8170ed2132dSStefano Zampini         }
8180ed2132dSStefano Zampini       }
8190ed2132dSStefano Zampini     }
82018c3aa7eSMark 
821d5280255SMark F. Adams     /* clean up */
822d5280255SMark F. Adams     for (level=1; level<pc_gamg->Nlevels; level++) {
823587fa25dSMark F. Adams       ierr = MatDestroy(&Parr[level]);CHKERRQ(ierr);
824587fa25dSMark F. Adams       ierr = MatDestroy(&Aarr[level]);CHKERRQ(ierr);
8255b89ad90SMark F. Adams     }
826806fa848SBarry Smith   } else {
8275f8cf99dSMark F. Adams     KSP smoother;
8280ed2132dSStefano Zampini 
829302440fdSBarry Smith     ierr = PetscInfo(pc,"One level solver used (system is seen as DD). Using default solver.\n");CHKERRQ(ierr);
8309d5b6da9SMark F. Adams     ierr = PCMGGetSmoother(pc, 0, &smoother);CHKERRQ(ierr);
83123ee1639SBarry Smith     ierr = KSPSetOperators(smoother, Aarr[0], Aarr[0]);CHKERRQ(ierr);
8325f8cf99dSMark F. Adams     ierr = KSPSetType(smoother, KSPPREONLY);CHKERRQ(ierr);
8339d5b6da9SMark F. Adams     ierr = PCSetUp_MG(pc);CHKERRQ(ierr);
8345f8cf99dSMark F. Adams   }
8355b89ad90SMark F. Adams   PetscFunctionReturn(0);
8365b89ad90SMark F. Adams }
8375b89ad90SMark F. Adams 
838eb07cef2SMark F. Adams /* ------------------------------------------------------------------------- */
8395b89ad90SMark F. Adams /*
8405b89ad90SMark F. Adams  PCDestroy_GAMG - Destroys the private context for the GAMG preconditioner
8415b89ad90SMark F. Adams    that was created with PCCreate_GAMG().
8425b89ad90SMark F. Adams 
8435b89ad90SMark F. Adams    Input Parameter:
8445b89ad90SMark F. Adams .  pc - the preconditioner context
8455b89ad90SMark F. Adams 
8465b89ad90SMark F. Adams    Application Interface Routine: PCDestroy()
8475b89ad90SMark F. Adams */
8485b89ad90SMark F. Adams PetscErrorCode PCDestroy_GAMG(PC pc)
8495b89ad90SMark F. Adams {
8505b89ad90SMark F. Adams   PetscErrorCode ierr;
8515b89ad90SMark F. Adams   PC_MG          *mg     = (PC_MG*)pc->data;
8525b89ad90SMark F. Adams   PC_GAMG        *pc_gamg= (PC_GAMG*)mg->innerctx;
8535b89ad90SMark F. Adams 
8545b89ad90SMark F. Adams   PetscFunctionBegin;
8555b89ad90SMark F. Adams   ierr = PCReset_GAMG(pc);CHKERRQ(ierr);
8569b8ffb57SJed Brown   if (pc_gamg->ops->destroy) {
8579b8ffb57SJed Brown     ierr = (*pc_gamg->ops->destroy)(pc);CHKERRQ(ierr);
8589b8ffb57SJed Brown   }
8591ab5ffc9SJed Brown   ierr = PetscFree(pc_gamg->ops);CHKERRQ(ierr);
8601ab5ffc9SJed Brown   ierr = PetscFree(pc_gamg->gamg_type_name);CHKERRQ(ierr);
8615b89ad90SMark F. Adams   ierr = PetscFree(pc_gamg);CHKERRQ(ierr);
8625b89ad90SMark F. Adams   ierr = PCDestroy_MG(pc);CHKERRQ(ierr);
8635b89ad90SMark F. Adams   PetscFunctionReturn(0);
8645b89ad90SMark F. Adams }
8655b89ad90SMark F. Adams 
866676e1743SMark F. Adams /*@
867cab9ed1eSBarry Smith    PCGAMGSetProcEqLim - Set number of equations to aim for per process on the coarse grids via processor reduction.
868676e1743SMark F. Adams 
8691cc46a46SBarry Smith    Logically Collective on PC
870676e1743SMark F. Adams 
871676e1743SMark F. Adams    Input Parameters:
8721cc46a46SBarry Smith +  pc - the preconditioner context
8731cc46a46SBarry Smith -  n - the number of equations
874676e1743SMark F. Adams 
875676e1743SMark F. Adams 
876676e1743SMark F. Adams    Options Database Key:
8771cc46a46SBarry Smith .  -pc_gamg_process_eq_limit <limit>
878676e1743SMark F. Adams 
87995452b02SPatrick Sanan    Notes:
88095452b02SPatrick 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
881cab9ed1eSBarry Smith           that has degrees of freedom
882cab9ed1eSBarry Smith 
883676e1743SMark F. Adams    Level: intermediate
884676e1743SMark F. Adams 
885c9567895SMark .seealso: PCGAMGSetCoarseEqLim(), PCGAMGSetRankReductionFactors()
886676e1743SMark F. Adams @*/
887676e1743SMark F. Adams PetscErrorCode  PCGAMGSetProcEqLim(PC pc, PetscInt n)
888676e1743SMark F. Adams {
889676e1743SMark F. Adams   PetscErrorCode ierr;
890676e1743SMark F. Adams 
891676e1743SMark F. Adams   PetscFunctionBegin;
892676e1743SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
893676e1743SMark F. Adams   ierr = PetscTryMethod(pc,"PCGAMGSetProcEqLim_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
894676e1743SMark F. Adams   PetscFunctionReturn(0);
895676e1743SMark F. Adams }
896676e1743SMark F. Adams 
8971e6b0712SBarry Smith static PetscErrorCode PCGAMGSetProcEqLim_GAMG(PC pc, PetscInt n)
898676e1743SMark F. Adams {
899c20e4228SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
900c20e4228SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
901676e1743SMark F. Adams 
902676e1743SMark F. Adams   PetscFunctionBegin;
9039d5b6da9SMark F. Adams   if (n>0) pc_gamg->min_eq_proc = n;
904676e1743SMark F. Adams   PetscFunctionReturn(0);
905676e1743SMark F. Adams }
906676e1743SMark F. Adams 
907389730f3SMark F. Adams /*@
908cab9ed1eSBarry Smith    PCGAMGSetCoarseEqLim - Set maximum number of equations on coarsest grid.
909389730f3SMark F. Adams 
910389730f3SMark F. Adams  Collective on PC
911389730f3SMark F. Adams 
912389730f3SMark F. Adams    Input Parameters:
9131cc46a46SBarry Smith +  pc - the preconditioner context
9141cc46a46SBarry Smith -  n - maximum number of equations to aim for
915389730f3SMark F. Adams 
916389730f3SMark F. Adams    Options Database Key:
9171cc46a46SBarry Smith .  -pc_gamg_coarse_eq_limit <limit>
918389730f3SMark F. Adams 
91974329af1SBarry Smith    Notes: For example -pc_gamg_coarse_eq_limit 1000 will stop coarsening once the coarse grid
92074329af1SBarry Smith      has less than 1000 unknowns.
92174329af1SBarry Smith 
922389730f3SMark F. Adams    Level: intermediate
923389730f3SMark F. Adams 
924c9567895SMark .seealso: PCGAMGSetProcEqLim(), PCGAMGSetRankReductionFactors()
925389730f3SMark F. Adams @*/
926389730f3SMark F. Adams PetscErrorCode PCGAMGSetCoarseEqLim(PC pc, PetscInt n)
927389730f3SMark F. Adams {
928389730f3SMark F. Adams   PetscErrorCode ierr;
929389730f3SMark F. Adams 
930389730f3SMark F. Adams   PetscFunctionBegin;
931389730f3SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
932389730f3SMark F. Adams   ierr = PetscTryMethod(pc,"PCGAMGSetCoarseEqLim_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
933389730f3SMark F. Adams   PetscFunctionReturn(0);
934389730f3SMark F. Adams }
935389730f3SMark F. Adams 
9361e6b0712SBarry Smith static PetscErrorCode PCGAMGSetCoarseEqLim_GAMG(PC pc, PetscInt n)
937389730f3SMark F. Adams {
938389730f3SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
939389730f3SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
940389730f3SMark F. Adams 
941389730f3SMark F. Adams   PetscFunctionBegin;
9429d5b6da9SMark F. Adams   if (n>0) pc_gamg->coarse_eq_limit = n;
943389730f3SMark F. Adams   PetscFunctionReturn(0);
944389730f3SMark F. Adams }
945389730f3SMark F. Adams 
946676e1743SMark F. Adams /*@
947cab9ed1eSBarry Smith    PCGAMGSetRepartition - Repartition the degrees of freedom across the processors on the coarser grids
948676e1743SMark F. Adams 
949676e1743SMark F. Adams    Collective on PC
950676e1743SMark F. Adams 
951676e1743SMark F. Adams    Input Parameters:
9521cc46a46SBarry Smith +  pc - the preconditioner context
9531cc46a46SBarry Smith -  n - PETSC_TRUE or PETSC_FALSE
954676e1743SMark F. Adams 
955676e1743SMark F. Adams    Options Database Key:
9561cc46a46SBarry Smith .  -pc_gamg_repartition <true,false>
957676e1743SMark F. Adams 
95895452b02SPatrick Sanan    Notes:
95995452b02SPatrick Sanan     this will generally improve the loading balancing of the work on each level
960cab9ed1eSBarry Smith 
961676e1743SMark F. Adams    Level: intermediate
962676e1743SMark F. Adams 
963676e1743SMark F. Adams .seealso: ()
964676e1743SMark F. Adams @*/
965cab9ed1eSBarry Smith PetscErrorCode PCGAMGSetRepartition(PC pc, PetscBool n)
966676e1743SMark F. Adams {
967676e1743SMark F. Adams   PetscErrorCode ierr;
968676e1743SMark F. Adams 
969676e1743SMark F. Adams   PetscFunctionBegin;
970676e1743SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
971cab9ed1eSBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGSetRepartition_C",(PC,PetscBool),(pc,n));CHKERRQ(ierr);
972676e1743SMark F. Adams   PetscFunctionReturn(0);
973676e1743SMark F. Adams }
974676e1743SMark F. Adams 
975cab9ed1eSBarry Smith static PetscErrorCode PCGAMGSetRepartition_GAMG(PC pc, PetscBool n)
976676e1743SMark F. Adams {
977c20e4228SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
978c20e4228SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
979676e1743SMark F. Adams 
980676e1743SMark F. Adams   PetscFunctionBegin;
9819d5b6da9SMark F. Adams   pc_gamg->repart = n;
982676e1743SMark F. Adams   PetscFunctionReturn(0);
983676e1743SMark F. Adams }
984676e1743SMark F. Adams 
985dfd5c07aSMark F. Adams /*@
98618c3aa7eSMark    PCGAMGSetEstEigKSPMaxIt - Set number of KSP iterations in eigen estimator (for Cheby)
98718c3aa7eSMark 
98818c3aa7eSMark    Collective on PC
98918c3aa7eSMark 
99018c3aa7eSMark    Input Parameters:
99118c3aa7eSMark +  pc - the preconditioner context
99218c3aa7eSMark -  n - number of its
99318c3aa7eSMark 
99418c3aa7eSMark    Options Database Key:
99518c3aa7eSMark .  -pc_gamg_esteig_ksp_max_it <its>
99618c3aa7eSMark 
99718c3aa7eSMark    Notes:
99818c3aa7eSMark 
99918c3aa7eSMark    Level: intermediate
100018c3aa7eSMark 
100118c3aa7eSMark .seealso: ()
100218c3aa7eSMark @*/
100318c3aa7eSMark PetscErrorCode PCGAMGSetEstEigKSPMaxIt(PC pc, PetscInt n)
100418c3aa7eSMark {
100518c3aa7eSMark   PetscErrorCode ierr;
100618c3aa7eSMark 
100718c3aa7eSMark   PetscFunctionBegin;
100818c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
100918c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetEstEigKSPMaxIt_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
101018c3aa7eSMark   PetscFunctionReturn(0);
101118c3aa7eSMark }
101218c3aa7eSMark 
101318c3aa7eSMark static PetscErrorCode PCGAMGSetEstEigKSPMaxIt_GAMG(PC pc, PetscInt n)
101418c3aa7eSMark {
101518c3aa7eSMark   PC_MG   *mg      = (PC_MG*)pc->data;
101618c3aa7eSMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
101718c3aa7eSMark 
101818c3aa7eSMark   PetscFunctionBegin;
101918c3aa7eSMark   pc_gamg->esteig_max_it = n;
102018c3aa7eSMark   PetscFunctionReturn(0);
102118c3aa7eSMark }
102218c3aa7eSMark 
102318c3aa7eSMark /*@
102418c3aa7eSMark    PCGAMGSetUseSAEstEig - Use eigen estimate from smoothed aggregation for Cheby smoother
102518c3aa7eSMark 
102618c3aa7eSMark    Collective on PC
102718c3aa7eSMark 
102818c3aa7eSMark    Input Parameters:
102918c3aa7eSMark +  pc - the preconditioner context
103018c3aa7eSMark -  n - number of its
103118c3aa7eSMark 
103218c3aa7eSMark    Options Database Key:
103318c3aa7eSMark .  -pc_gamg_use_sa_esteig <true,false>
103418c3aa7eSMark 
103518c3aa7eSMark    Notes:
103618c3aa7eSMark 
103718c3aa7eSMark    Level: intermediate
103818c3aa7eSMark 
103918c3aa7eSMark .seealso: ()
104018c3aa7eSMark @*/
104118c3aa7eSMark PetscErrorCode PCGAMGSetUseSAEstEig(PC pc, PetscBool n)
104218c3aa7eSMark {
104318c3aa7eSMark   PetscErrorCode ierr;
104418c3aa7eSMark 
104518c3aa7eSMark   PetscFunctionBegin;
104618c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
104718c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetUseSAEstEig_C",(PC,PetscBool),(pc,n));CHKERRQ(ierr);
104818c3aa7eSMark   PetscFunctionReturn(0);
104918c3aa7eSMark }
105018c3aa7eSMark 
10510ed2132dSStefano Zampini static PetscErrorCode PCGAMGSetUseSAEstEig_GAMG(PC pc, PetscBool n)
105218c3aa7eSMark {
105318c3aa7eSMark   PC_MG   *mg      = (PC_MG*)pc->data;
105418c3aa7eSMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
105518c3aa7eSMark 
105618c3aa7eSMark   PetscFunctionBegin;
105718c3aa7eSMark   pc_gamg->use_sa_esteig = n ? 1 : 0;
105818c3aa7eSMark   PetscFunctionReturn(0);
105918c3aa7eSMark }
106018c3aa7eSMark 
106118c3aa7eSMark /*@C
106218c3aa7eSMark    PCGAMGSetEstEigKSPType - Set type of KSP in eigen estimator (for Cheby)
106318c3aa7eSMark 
106418c3aa7eSMark    Collective on PC
106518c3aa7eSMark 
106618c3aa7eSMark    Input Parameters:
106718c3aa7eSMark +  pc - the preconditioner context
106818c3aa7eSMark -  t - ksp type
106918c3aa7eSMark 
107018c3aa7eSMark    Options Database Key:
107118c3aa7eSMark .  -pc_gamg_esteig_ksp_type <type>
107218c3aa7eSMark 
107318c3aa7eSMark    Notes:
107418c3aa7eSMark 
107518c3aa7eSMark    Level: intermediate
107618c3aa7eSMark 
107718c3aa7eSMark .seealso: ()
107818c3aa7eSMark @*/
107918c3aa7eSMark PetscErrorCode PCGAMGSetEstEigKSPType(PC pc, char t[])
108018c3aa7eSMark {
108118c3aa7eSMark   PetscErrorCode ierr;
108218c3aa7eSMark 
108318c3aa7eSMark   PetscFunctionBegin;
108418c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
108518c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetEstEigKSPType_C",(PC,char[]),(pc,t));CHKERRQ(ierr);
108618c3aa7eSMark   PetscFunctionReturn(0);
108718c3aa7eSMark }
108818c3aa7eSMark 
108918c3aa7eSMark static PetscErrorCode PCGAMGSetEstEigKSPType_GAMG(PC pc, char t[])
109018c3aa7eSMark {
109118c3aa7eSMark   PetscErrorCode ierr;
109218c3aa7eSMark   PC_MG   *mg      = (PC_MG*)pc->data;
109318c3aa7eSMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
109418c3aa7eSMark 
109518c3aa7eSMark   PetscFunctionBegin;
109618c3aa7eSMark   ierr = PetscStrcpy(pc_gamg->esteig_type,t);CHKERRQ(ierr);
109718c3aa7eSMark   PetscFunctionReturn(0);
109818c3aa7eSMark }
109918c3aa7eSMark 
110018c3aa7eSMark /*@
110118c3aa7eSMark    PCGAMGSetEigenvalues - Set eigenvalues
110218c3aa7eSMark 
110318c3aa7eSMark    Collective on PC
110418c3aa7eSMark 
110518c3aa7eSMark    Input Parameters:
110618c3aa7eSMark +  pc - the preconditioner context
110718c3aa7eSMark -  emax - max eigenvalue
110818c3aa7eSMark .  emin - min eigenvalue
110918c3aa7eSMark 
111018c3aa7eSMark    Options Database Key:
111118c3aa7eSMark .  -pc_gamg_eigenvalues
111218c3aa7eSMark 
111318c3aa7eSMark    Level: intermediate
111418c3aa7eSMark 
111518c3aa7eSMark .seealso: PCGAMGSetEstEigKSPMaxIt(), PCGAMGSetUseSAEstEig(), PCGAMGSetEstEigKSPType()
111618c3aa7eSMark @*/
111718c3aa7eSMark PetscErrorCode PCGAMGSetEigenvalues(PC pc, PetscReal emax,PetscReal emin)
111818c3aa7eSMark {
111918c3aa7eSMark   PetscErrorCode ierr;
112018c3aa7eSMark 
112118c3aa7eSMark   PetscFunctionBegin;
112218c3aa7eSMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
112318c3aa7eSMark   ierr = PetscTryMethod(pc,"PCGAMGSetEigenvalues_C",(PC,PetscReal,PetscReal),(pc,emax,emin));CHKERRQ(ierr);
112418c3aa7eSMark   PetscFunctionReturn(0);
112518c3aa7eSMark }
112618c3aa7eSMark static PetscErrorCode PCGAMGSetEigenvalues_GAMG(PC pc,PetscReal emax,PetscReal emin)
112718c3aa7eSMark {
112818c3aa7eSMark   PC_MG          *mg      = (PC_MG*)pc->data;
112918c3aa7eSMark   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
113018c3aa7eSMark 
113118c3aa7eSMark   PetscFunctionBegin;
113218c3aa7eSMark   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);
113318c3aa7eSMark   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);
113418c3aa7eSMark   pc_gamg->emax = emax;
113518c3aa7eSMark   pc_gamg->emin = emin;
113618c3aa7eSMark 
113718c3aa7eSMark   PetscFunctionReturn(0);
113818c3aa7eSMark }
113918c3aa7eSMark 
114018c3aa7eSMark /*@
1141cab9ed1eSBarry Smith    PCGAMGSetReuseInterpolation - Reuse prolongation when rebuilding algebraic multigrid preconditioner
1142dfd5c07aSMark F. Adams 
1143dfd5c07aSMark F. Adams    Collective on PC
1144dfd5c07aSMark F. Adams 
1145dfd5c07aSMark F. Adams    Input Parameters:
11461cc46a46SBarry Smith +  pc - the preconditioner context
11471cc46a46SBarry Smith -  n - PETSC_TRUE or PETSC_FALSE
1148dfd5c07aSMark F. Adams 
1149dfd5c07aSMark F. Adams    Options Database Key:
11501cc46a46SBarry Smith .  -pc_gamg_reuse_interpolation <true,false>
1151dfd5c07aSMark F. Adams 
1152dfd5c07aSMark F. Adams    Level: intermediate
1153dfd5c07aSMark F. Adams 
115495452b02SPatrick Sanan    Notes:
115595452b02SPatrick Sanan     this may negatively affect the convergence rate of the method on new matrices if the matrix entries change a great deal, but allows
1156cab9ed1eSBarry Smith           rebuilding the preconditioner quicker.
1157cab9ed1eSBarry Smith 
1158dfd5c07aSMark F. Adams .seealso: ()
1159dfd5c07aSMark F. Adams @*/
11601cc46a46SBarry Smith PetscErrorCode PCGAMGSetReuseInterpolation(PC pc, PetscBool n)
1161dfd5c07aSMark F. Adams {
1162dfd5c07aSMark F. Adams   PetscErrorCode ierr;
1163dfd5c07aSMark F. Adams 
1164dfd5c07aSMark F. Adams   PetscFunctionBegin;
1165dfd5c07aSMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
11661cc46a46SBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGSetReuseInterpolation_C",(PC,PetscBool),(pc,n));CHKERRQ(ierr);
1167dfd5c07aSMark F. Adams   PetscFunctionReturn(0);
1168dfd5c07aSMark F. Adams }
1169dfd5c07aSMark F. Adams 
11701cc46a46SBarry Smith static PetscErrorCode PCGAMGSetReuseInterpolation_GAMG(PC pc, PetscBool n)
1171dfd5c07aSMark F. Adams {
1172dfd5c07aSMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1173dfd5c07aSMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1174dfd5c07aSMark F. Adams 
1175dfd5c07aSMark F. Adams   PetscFunctionBegin;
1176dfd5c07aSMark F. Adams   pc_gamg->reuse_prol = n;
1177dfd5c07aSMark F. Adams   PetscFunctionReturn(0);
1178dfd5c07aSMark F. Adams }
1179dfd5c07aSMark F. Adams 
1180ffc955d6SMark F. Adams /*@
1181cab9ed1eSBarry 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.
1182ffc955d6SMark F. Adams 
1183ffc955d6SMark F. Adams    Collective on PC
1184ffc955d6SMark F. Adams 
1185ffc955d6SMark F. Adams    Input Parameters:
1186cab9ed1eSBarry Smith +  pc - the preconditioner context
1187cab9ed1eSBarry Smith -  flg - PETSC_TRUE to use aggregates, PETSC_FALSE to not
1188ffc955d6SMark F. Adams 
1189ffc955d6SMark F. Adams    Options Database Key:
1190cab9ed1eSBarry Smith .  -pc_gamg_asm_use_agg
1191ffc955d6SMark F. Adams 
1192ffc955d6SMark F. Adams    Level: intermediate
1193ffc955d6SMark F. Adams 
1194ffc955d6SMark F. Adams .seealso: ()
1195ffc955d6SMark F. Adams @*/
1196cab9ed1eSBarry Smith PetscErrorCode PCGAMGASMSetUseAggs(PC pc, PetscBool flg)
1197ffc955d6SMark F. Adams {
1198ffc955d6SMark F. Adams   PetscErrorCode ierr;
1199ffc955d6SMark F. Adams 
1200ffc955d6SMark F. Adams   PetscFunctionBegin;
1201ffc955d6SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1202cab9ed1eSBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGASMSetUseAggs_C",(PC,PetscBool),(pc,flg));CHKERRQ(ierr);
1203ffc955d6SMark F. Adams   PetscFunctionReturn(0);
1204ffc955d6SMark F. Adams }
1205ffc955d6SMark F. Adams 
1206cab9ed1eSBarry Smith static PetscErrorCode PCGAMGASMSetUseAggs_GAMG(PC pc, PetscBool flg)
1207ffc955d6SMark F. Adams {
1208ffc955d6SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1209ffc955d6SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1210ffc955d6SMark F. Adams 
1211ffc955d6SMark F. Adams   PetscFunctionBegin;
1212cab9ed1eSBarry Smith   pc_gamg->use_aggs_in_asm = flg;
1213ffc955d6SMark F. Adams   PetscFunctionReturn(0);
1214ffc955d6SMark F. Adams }
1215ffc955d6SMark F. Adams 
1216171cca9aSMark Adams /*@
1217cf8ae1d3SMark Adams    PCGAMGSetUseParallelCoarseGridSolve - allow a parallel coarse grid solver
1218171cca9aSMark Adams 
1219171cca9aSMark Adams    Collective on PC
1220171cca9aSMark Adams 
1221171cca9aSMark Adams    Input Parameters:
1222171cca9aSMark Adams +  pc - the preconditioner context
1223cf8ae1d3SMark Adams -  flg - PETSC_TRUE to not force coarse grid onto one processor
1224171cca9aSMark Adams 
1225171cca9aSMark Adams    Options Database Key:
1226cf8ae1d3SMark Adams .  -pc_gamg_use_parallel_coarse_grid_solver
1227171cca9aSMark Adams 
1228171cca9aSMark Adams    Level: intermediate
1229171cca9aSMark Adams 
123039d09545SMark Adams .seealso: PCGAMGSetCoarseGridLayoutType(), PCGAMGSetCpuPinCoarseGrids()
1231171cca9aSMark Adams @*/
1232171cca9aSMark Adams PetscErrorCode PCGAMGSetUseParallelCoarseGridSolve(PC pc, PetscBool flg)
1233171cca9aSMark Adams {
1234171cca9aSMark Adams   PetscErrorCode ierr;
1235171cca9aSMark Adams 
1236171cca9aSMark Adams   PetscFunctionBegin;
1237171cca9aSMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1238171cca9aSMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetUseParallelCoarseGridSolve_C",(PC,PetscBool),(pc,flg));CHKERRQ(ierr);
1239171cca9aSMark Adams   PetscFunctionReturn(0);
1240171cca9aSMark Adams }
1241171cca9aSMark Adams 
1242171cca9aSMark Adams static PetscErrorCode PCGAMGSetUseParallelCoarseGridSolve_GAMG(PC pc, PetscBool flg)
1243171cca9aSMark Adams {
1244171cca9aSMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1245171cca9aSMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1246171cca9aSMark Adams 
1247171cca9aSMark Adams   PetscFunctionBegin;
1248171cca9aSMark Adams   pc_gamg->use_parallel_coarse_grid_solver = flg;
1249ffc955d6SMark F. Adams   PetscFunctionReturn(0);
1250ffc955d6SMark F. Adams }
1251ffc955d6SMark F. Adams 
12524ef23d27SMark F. Adams /*@
1253ce7c7f2fSMark Adams    PCGAMGSetCpuPinCoarseGrids - pin reduced grids to CPU
1254ce7c7f2fSMark Adams 
1255ce7c7f2fSMark Adams    Collective on PC
1256ce7c7f2fSMark Adams 
1257ce7c7f2fSMark Adams    Input Parameters:
1258ce7c7f2fSMark Adams +  pc - the preconditioner context
1259ce7c7f2fSMark Adams -  flg - PETSC_TRUE to pin coarse grids to CPU
1260ce7c7f2fSMark Adams 
1261ce7c7f2fSMark Adams    Options Database Key:
1262ce7c7f2fSMark Adams .  -pc_gamg_cpu_pin_coarse_grids
1263ce7c7f2fSMark Adams 
1264ce7c7f2fSMark Adams    Level: intermediate
1265ce7c7f2fSMark Adams 
126639d09545SMark Adams .seealso: PCGAMGSetCoarseGridLayoutType(), PCGAMGSetUseParallelCoarseGridSolve()
1267ce7c7f2fSMark Adams @*/
1268ce7c7f2fSMark Adams PetscErrorCode PCGAMGSetCpuPinCoarseGrids(PC pc, PetscBool flg)
1269ce7c7f2fSMark Adams {
1270ce7c7f2fSMark Adams   PetscErrorCode ierr;
1271ce7c7f2fSMark Adams 
1272ce7c7f2fSMark Adams   PetscFunctionBegin;
1273ce7c7f2fSMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1274ce7c7f2fSMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetCpuPinCoarseGrids_C",(PC,PetscBool),(pc,flg));CHKERRQ(ierr);
1275ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1276ce7c7f2fSMark Adams }
1277ce7c7f2fSMark Adams 
1278ce7c7f2fSMark Adams static PetscErrorCode PCGAMGSetCpuPinCoarseGrids_GAMG(PC pc, PetscBool flg)
1279ce7c7f2fSMark Adams {
1280ce7c7f2fSMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1281ce7c7f2fSMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1282ce7c7f2fSMark Adams 
1283ce7c7f2fSMark Adams   PetscFunctionBegin;
1284ce7c7f2fSMark Adams   pc_gamg->cpu_pin_coarse_grids = flg;
1285ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1286ce7c7f2fSMark Adams }
1287ce7c7f2fSMark Adams 
1288ce7c7f2fSMark Adams /*@
1289ce7c7f2fSMark Adams    PCGAMGSetCoarseGridLayoutType - place reduce grids on processors with natural order (compact type)
1290ce7c7f2fSMark Adams 
1291ce7c7f2fSMark Adams    Collective on PC
1292ce7c7f2fSMark Adams 
1293ce7c7f2fSMark Adams    Input Parameters:
1294ce7c7f2fSMark Adams +  pc - the preconditioner context
1295ce7c7f2fSMark Adams -  flg - Layout type
1296ce7c7f2fSMark Adams 
1297ce7c7f2fSMark Adams    Options Database Key:
1298ce7c7f2fSMark Adams .  -pc_gamg_coarse_grid_layout_type
1299ce7c7f2fSMark Adams 
1300ce7c7f2fSMark Adams    Level: intermediate
1301ce7c7f2fSMark Adams 
130239d09545SMark Adams .seealso: PCGAMGSetUseParallelCoarseGridSolve(), PCGAMGSetCpuPinCoarseGrids()
1303ce7c7f2fSMark Adams @*/
1304ce7c7f2fSMark Adams PetscErrorCode PCGAMGSetCoarseGridLayoutType(PC pc, PCGAMGLayoutType flg)
1305ce7c7f2fSMark Adams {
1306ce7c7f2fSMark Adams   PetscErrorCode ierr;
1307ce7c7f2fSMark Adams 
1308ce7c7f2fSMark Adams   PetscFunctionBegin;
1309ce7c7f2fSMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1310ce7c7f2fSMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetCoarseGridLayoutType_C",(PC,PCGAMGLayoutType),(pc,flg));CHKERRQ(ierr);
1311ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1312ce7c7f2fSMark Adams }
1313ce7c7f2fSMark Adams 
1314ce7c7f2fSMark Adams static PetscErrorCode PCGAMGSetCoarseGridLayoutType_GAMG(PC pc, PCGAMGLayoutType flg)
1315ce7c7f2fSMark Adams {
1316ce7c7f2fSMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1317ce7c7f2fSMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1318ce7c7f2fSMark Adams 
1319ce7c7f2fSMark Adams   PetscFunctionBegin;
1320ce7c7f2fSMark Adams   pc_gamg->layout_type = flg;
1321ce7c7f2fSMark Adams   PetscFunctionReturn(0);
1322ce7c7f2fSMark Adams }
1323ce7c7f2fSMark Adams 
1324ce7c7f2fSMark Adams /*@
13251cc46a46SBarry Smith    PCGAMGSetNlevels -  Sets the maximum number of levels PCGAMG will use
13264ef23d27SMark F. Adams 
13274ef23d27SMark F. Adams    Not collective on PC
13284ef23d27SMark F. Adams 
13294ef23d27SMark F. Adams    Input Parameters:
13301cc46a46SBarry Smith +  pc - the preconditioner
13311cc46a46SBarry Smith -  n - the maximum number of levels to use
13324ef23d27SMark F. Adams 
13334ef23d27SMark F. Adams    Options Database Key:
13344ef23d27SMark F. Adams .  -pc_mg_levels
13354ef23d27SMark F. Adams 
13364ef23d27SMark F. Adams    Level: intermediate
13374ef23d27SMark F. Adams 
13384ef23d27SMark F. Adams .seealso: ()
13394ef23d27SMark F. Adams @*/
13404ef23d27SMark F. Adams PetscErrorCode PCGAMGSetNlevels(PC pc, PetscInt n)
13414ef23d27SMark F. Adams {
13424ef23d27SMark F. Adams   PetscErrorCode ierr;
13434ef23d27SMark F. Adams 
13444ef23d27SMark F. Adams   PetscFunctionBegin;
13454ef23d27SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
13464ef23d27SMark F. Adams   ierr = PetscTryMethod(pc,"PCGAMGSetNlevels_C",(PC,PetscInt),(pc,n));CHKERRQ(ierr);
13474ef23d27SMark F. Adams   PetscFunctionReturn(0);
13484ef23d27SMark F. Adams }
13494ef23d27SMark F. Adams 
13501e6b0712SBarry Smith static PetscErrorCode PCGAMGSetNlevels_GAMG(PC pc, PetscInt n)
13514ef23d27SMark F. Adams {
13524ef23d27SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
13534ef23d27SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
13544ef23d27SMark F. Adams 
13554ef23d27SMark F. Adams   PetscFunctionBegin;
13569d5b6da9SMark F. Adams   pc_gamg->Nlevels = n;
13574ef23d27SMark F. Adams   PetscFunctionReturn(0);
13584ef23d27SMark F. Adams }
13594ef23d27SMark F. Adams 
13603542efc5SMark F. Adams /*@
13613542efc5SMark F. Adams    PCGAMGSetThreshold - Relative threshold to use for dropping edges in aggregation graph
13623542efc5SMark F. Adams 
13633542efc5SMark F. Adams    Not collective on PC
13643542efc5SMark F. Adams 
13653542efc5SMark F. Adams    Input Parameters:
13661cc46a46SBarry Smith +  pc - the preconditioner context
1367c9567895SMark .  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
1368055c8bd0SJed Brown -  n - number of threshold values provided in array
13693542efc5SMark F. Adams 
13703542efc5SMark F. Adams    Options Database Key:
13711cc46a46SBarry Smith .  -pc_gamg_threshold <threshold>
13723542efc5SMark F. Adams 
137395452b02SPatrick Sanan    Notes:
1374af3c827dSMark 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.
1375af3c827dSMark 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.
1376cab9ed1eSBarry Smith 
1377055c8bd0SJed Brown     If n is less than the total number of coarsenings (see PCGAMGSetNlevels()), then threshold scaling (see PCGAMGSetThresholdScale()) is used for each successive coarsening.
1378055c8bd0SJed Brown     In this case, PCGAMGSetThresholdScale() must be called before PCGAMGSetThreshold().
1379055c8bd0SJed Brown     If n is greater than the total number of levels, the excess entries in threshold will not be used.
1380055c8bd0SJed Brown 
13813542efc5SMark F. Adams    Level: intermediate
13823542efc5SMark F. Adams 
1383af3c827dSMark Adams .seealso: PCGAMGFilterGraph(), PCGAMGSetSquareGraph()
13843542efc5SMark F. Adams @*/
1385c1eae691SMark Adams PetscErrorCode PCGAMGSetThreshold(PC pc, PetscReal v[], PetscInt n)
13863542efc5SMark F. Adams {
13873542efc5SMark F. Adams   PetscErrorCode ierr;
13883542efc5SMark F. Adams 
13893542efc5SMark F. Adams   PetscFunctionBegin;
13903542efc5SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1391055c8bd0SJed Brown   if (n) PetscValidRealPointer(v,2);
1392c1eae691SMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetThreshold_C",(PC,PetscReal[],PetscInt),(pc,v,n));CHKERRQ(ierr);
13933542efc5SMark F. Adams   PetscFunctionReturn(0);
13943542efc5SMark F. Adams }
13953542efc5SMark F. Adams 
1396c1eae691SMark Adams static PetscErrorCode PCGAMGSetThreshold_GAMG(PC pc, PetscReal v[], PetscInt n)
13973542efc5SMark F. Adams {
1398c20e4228SMark F. Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1399c20e4228SMark F. Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1400c1eae691SMark Adams   PetscInt i;
1401c1eae691SMark Adams   PetscFunctionBegin;
1402055c8bd0SJed Brown   for (i=0; i<PetscMin(n,PETSC_MG_MAXLEVELS); i++) pc_gamg->threshold[i] = v[i];
1403055c8bd0SJed Brown   for (; i<PETSC_MG_MAXLEVELS; i++) pc_gamg->threshold[i] = pc_gamg->threshold[i-1]*pc_gamg->threshold_scale;
1404c1eae691SMark Adams   PetscFunctionReturn(0);
1405c1eae691SMark Adams }
1406c1eae691SMark Adams 
1407c1eae691SMark Adams /*@
1408c9567895SMark    PCGAMGSetRankReductionFactors - Set manual schedual for process reduction on coarse grids
1409c9567895SMark 
1410c9567895SMark    Collective on PC
1411c9567895SMark 
1412c9567895SMark    Input Parameters:
1413c9567895SMark +  pc - the preconditioner context
1414c9567895SMark .  v - array of reduction factors. 0 for fist value forces a reduction to one process/device on first level in Cuda
1415c9567895SMark -  n - number of values provided in array
1416c9567895SMark 
1417c9567895SMark    Options Database Key:
1418c9567895SMark .  -pc_gamg_rank_reduction_factors <factors>
1419c9567895SMark 
1420c9567895SMark    Level: intermediate
1421c9567895SMark 
1422c9567895SMark .seealso: PCGAMGSetProcEqLim(), PCGAMGSetCoarseEqLim()
1423c9567895SMark @*/
1424c9567895SMark PetscErrorCode PCGAMGSetRankReductionFactors(PC pc, PetscInt v[], PetscInt n)
1425c9567895SMark {
1426c9567895SMark   PetscErrorCode ierr;
1427c9567895SMark 
1428c9567895SMark   PetscFunctionBegin;
1429c9567895SMark   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1430c9567895SMark   if (n) PetscValidIntPointer(v,2);
1431c9567895SMark   ierr = PetscTryMethod(pc,"PCGAMGSetRankReductionFactors_C",(PC,PetscInt[],PetscInt),(pc,v,n));CHKERRQ(ierr);
1432c9567895SMark   PetscFunctionReturn(0);
1433c9567895SMark }
1434c9567895SMark 
1435c9567895SMark static PetscErrorCode PCGAMGSetRankReductionFactors_GAMG(PC pc, PetscInt v[], PetscInt n)
1436c9567895SMark {
1437c9567895SMark   PC_MG   *mg      = (PC_MG*)pc->data;
1438c9567895SMark   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1439c9567895SMark   PetscInt i;
1440c9567895SMark   PetscFunctionBegin;
1441c9567895SMark   for (i=0; i<PetscMin(n,PETSC_MG_MAXLEVELS); i++) pc_gamg->level_reduction_factors[i] = v[i];
1442c9567895SMark   for (; i<PETSC_MG_MAXLEVELS; i++) pc_gamg->level_reduction_factors[i] = -1; /* 0 stop putting one process/device on first level */
1443c9567895SMark   PetscFunctionReturn(0);
1444c9567895SMark }
1445c9567895SMark 
1446c9567895SMark /*@
1447c1eae691SMark Adams    PCGAMGSetThresholdScale - Relative threshold reduction at each level
1448c1eae691SMark Adams 
1449c1eae691SMark Adams    Not collective on PC
1450c1eae691SMark Adams 
1451c1eae691SMark Adams    Input Parameters:
1452c1eae691SMark Adams +  pc - the preconditioner context
1453c1eae691SMark Adams -  scale - the threshold value reduction, ussually < 1.0
1454c1eae691SMark Adams 
1455c1eae691SMark Adams    Options Database Key:
1456c1eae691SMark Adams .  -pc_gamg_threshold_scale <v>
1457c1eae691SMark Adams 
1458055c8bd0SJed Brown    Notes:
1459055c8bd0SJed Brown    The initial threshold (for an arbitrary number of levels starting from the finest) can be set with PCGAMGSetThreshold().
1460055c8bd0SJed Brown    This scaling is used for each subsequent coarsening, but must be called before PCGAMGSetThreshold().
1461055c8bd0SJed Brown 
1462c1eae691SMark Adams    Level: advanced
1463c1eae691SMark Adams 
1464055c8bd0SJed Brown .seealso: PCGAMGSetThreshold()
1465c1eae691SMark Adams @*/
1466c1eae691SMark Adams PetscErrorCode PCGAMGSetThresholdScale(PC pc, PetscReal v)
1467c1eae691SMark Adams {
1468c1eae691SMark Adams   PetscErrorCode ierr;
14693542efc5SMark F. Adams 
14703542efc5SMark F. Adams   PetscFunctionBegin;
1471c1eae691SMark Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1472c1eae691SMark Adams   ierr = PetscTryMethod(pc,"PCGAMGSetThresholdScale_C",(PC,PetscReal),(pc,v));CHKERRQ(ierr);
1473c1eae691SMark Adams   PetscFunctionReturn(0);
1474c1eae691SMark Adams }
1475c1eae691SMark Adams 
1476c1eae691SMark Adams static PetscErrorCode PCGAMGSetThresholdScale_GAMG(PC pc, PetscReal v)
1477c1eae691SMark Adams {
1478c1eae691SMark Adams   PC_MG   *mg      = (PC_MG*)pc->data;
1479c1eae691SMark Adams   PC_GAMG *pc_gamg = (PC_GAMG*)mg->innerctx;
1480c1eae691SMark Adams   PetscFunctionBegin;
1481c1eae691SMark Adams   pc_gamg->threshold_scale = v;
14823542efc5SMark F. Adams   PetscFunctionReturn(0);
14833542efc5SMark F. Adams }
14843542efc5SMark F. Adams 
1485e20c40e8SBarry Smith /*@C
1486c60c7ad4SBarry Smith    PCGAMGSetType - Set solution method
1487676e1743SMark F. Adams 
1488676e1743SMark F. Adams    Collective on PC
1489676e1743SMark F. Adams 
1490676e1743SMark F. Adams    Input Parameters:
1491c60c7ad4SBarry Smith +  pc - the preconditioner context
1492c60c7ad4SBarry Smith -  type - PCGAMGAGG, PCGAMGGEO, or PCGAMGCLASSICAL
1493676e1743SMark F. Adams 
1494676e1743SMark F. Adams    Options Database Key:
1495cab9ed1eSBarry Smith .  -pc_gamg_type <agg,geo,classical> - type of algebraic multigrid to apply
1496676e1743SMark F. Adams 
1497676e1743SMark F. Adams    Level: intermediate
1498676e1743SMark F. Adams 
1499cab9ed1eSBarry Smith .seealso: PCGAMGGetType(), PCGAMG, PCGAMGType
1500676e1743SMark F. Adams @*/
150119fd82e9SBarry Smith PetscErrorCode PCGAMGSetType(PC pc, PCGAMGType type)
1502676e1743SMark F. Adams {
1503676e1743SMark F. Adams   PetscErrorCode ierr;
1504676e1743SMark F. Adams 
1505676e1743SMark F. Adams   PetscFunctionBegin;
1506676e1743SMark F. Adams   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1507806fa848SBarry Smith   ierr = PetscTryMethod(pc,"PCGAMGSetType_C",(PC,PCGAMGType),(pc,type));CHKERRQ(ierr);
1508676e1743SMark F. Adams   PetscFunctionReturn(0);
1509676e1743SMark F. Adams }
1510676e1743SMark F. Adams 
1511e20c40e8SBarry Smith /*@C
1512c60c7ad4SBarry Smith    PCGAMGGetType - Get solution method
1513c60c7ad4SBarry Smith 
1514c60c7ad4SBarry Smith    Collective on PC
1515c60c7ad4SBarry Smith 
1516c60c7ad4SBarry Smith    Input Parameter:
1517c60c7ad4SBarry Smith .  pc - the preconditioner context
1518c60c7ad4SBarry Smith 
1519c60c7ad4SBarry Smith    Output Parameter:
1520c60c7ad4SBarry Smith .  type - the type of algorithm used
1521c60c7ad4SBarry Smith 
1522c60c7ad4SBarry Smith    Level: intermediate
1523c60c7ad4SBarry Smith 
15241c1aac46SBarry Smith .seealso: PCGAMGSetType(), PCGAMGType
1525c60c7ad4SBarry Smith @*/
1526c60c7ad4SBarry Smith PetscErrorCode PCGAMGGetType(PC pc, PCGAMGType *type)
1527c60c7ad4SBarry Smith {
1528c60c7ad4SBarry Smith   PetscErrorCode ierr;
1529c60c7ad4SBarry Smith 
1530c60c7ad4SBarry Smith   PetscFunctionBegin;
1531c60c7ad4SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1532c60c7ad4SBarry Smith   ierr = PetscUseMethod(pc,"PCGAMGGetType_C",(PC,PCGAMGType*),(pc,type));CHKERRQ(ierr);
1533c60c7ad4SBarry Smith   PetscFunctionReturn(0);
1534c60c7ad4SBarry Smith }
1535c60c7ad4SBarry Smith 
1536c60c7ad4SBarry Smith static PetscErrorCode PCGAMGGetType_GAMG(PC pc, PCGAMGType *type)
1537c60c7ad4SBarry Smith {
1538c60c7ad4SBarry Smith   PC_MG          *mg      = (PC_MG*)pc->data;
1539c60c7ad4SBarry Smith   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
1540c60c7ad4SBarry Smith 
1541c60c7ad4SBarry Smith   PetscFunctionBegin;
1542c60c7ad4SBarry Smith   *type = pc_gamg->type;
1543c60c7ad4SBarry Smith   PetscFunctionReturn(0);
1544c60c7ad4SBarry Smith }
1545c60c7ad4SBarry Smith 
15461e6b0712SBarry Smith static PetscErrorCode PCGAMGSetType_GAMG(PC pc, PCGAMGType type)
1547676e1743SMark F. Adams {
15489d5b6da9SMark F. Adams   PetscErrorCode ierr,(*r)(PC);
15491ab5ffc9SJed Brown   PC_MG          *mg      = (PC_MG*)pc->data;
15501ab5ffc9SJed Brown   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
1551676e1743SMark F. Adams 
1552676e1743SMark F. Adams   PetscFunctionBegin;
1553c60c7ad4SBarry Smith   pc_gamg->type = type;
15541c9cd337SJed Brown   ierr = PetscFunctionListFind(GAMGList,type,&r);CHKERRQ(ierr);
15559d5b6da9SMark F. Adams   if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown GAMG type %s given",type);
15561ab5ffc9SJed Brown   if (pc_gamg->ops->destroy) {
15571ab5ffc9SJed Brown     ierr = (*pc_gamg->ops->destroy)(pc);CHKERRQ(ierr);
15581ab5ffc9SJed Brown     ierr = PetscMemzero(pc_gamg->ops,sizeof(struct _PCGAMGOps));CHKERRQ(ierr);
1559e616c208SToby Isaac     pc_gamg->ops->createlevel = PCGAMGCreateLevel_GAMG;
15603ae0bb68SMark Adams     /* cleaning up common data in pc_gamg - this should disapear someday */
15613ae0bb68SMark Adams     pc_gamg->data_cell_cols = 0;
15623ae0bb68SMark Adams     pc_gamg->data_cell_rows = 0;
15633ae0bb68SMark Adams     pc_gamg->orig_data_cell_cols = 0;
15643ae0bb68SMark Adams     pc_gamg->orig_data_cell_rows = 0;
15653ae0bb68SMark Adams     ierr = PetscFree(pc_gamg->data);CHKERRQ(ierr);
15663ae0bb68SMark Adams     pc_gamg->data_sz = 0;
15671ab5ffc9SJed Brown   }
15681ab5ffc9SJed Brown   ierr = PetscFree(pc_gamg->gamg_type_name);CHKERRQ(ierr);
15691ab5ffc9SJed Brown   ierr = PetscStrallocpy(type,&pc_gamg->gamg_type_name);CHKERRQ(ierr);
15709d5b6da9SMark F. Adams   ierr = (*r)(pc);CHKERRQ(ierr);
1571676e1743SMark F. Adams   PetscFunctionReturn(0);
1572676e1743SMark F. Adams }
1573676e1743SMark F. Adams 
15749d766c59SMark Adams /* -------------------------------------------------------------------------- */
15759d766c59SMark Adams /*
15769d766c59SMark Adams    PCMGGetGridComplexity - compute coarse grid complexity of MG hierarchy
15779d766c59SMark Adams 
15789d766c59SMark Adams    Input Parameter:
15799d766c59SMark Adams .  pc - the preconditioner context
15809d766c59SMark Adams 
15819d766c59SMark Adams    Output Parameter:
15829d766c59SMark Adams .  gc - grid complexity = sum_i(nnz_i) / nnz_0
15839d766c59SMark Adams 
15849d766c59SMark Adams    Level: advanced
15859d766c59SMark Adams */
15869d766c59SMark Adams static PetscErrorCode PCMGGetGridComplexity(PC pc, PetscReal *gc)
15879d766c59SMark Adams {
15889d766c59SMark Adams   PetscErrorCode ierr;
15899d766c59SMark Adams   PC_MG          *mg      = (PC_MG*)pc->data;
15909d766c59SMark Adams   PC_MG_Levels   **mglevels = mg->levels;
15913966268fSBarry Smith   PetscInt       lev;
15923966268fSBarry Smith   PetscLogDouble nnz0 = 0, sgc = 0;
15939d766c59SMark Adams   MatInfo        info;
15943966268fSBarry Smith 
15959d766c59SMark Adams   PetscFunctionBegin;
1596dbf6bb8dSprj-   if (!pc->setupcalled) {
1597dbf6bb8dSprj-     *gc = 0;
1598dbf6bb8dSprj-     PetscFunctionReturn(0);
1599dbf6bb8dSprj-   }
16009d766c59SMark Adams   if (!mg->nlevels) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"MG has no levels");
16013966268fSBarry Smith   for (lev=0; lev<mg->nlevels; lev++) {
160262a6e064SMark Adams     Mat dB;
160362a6e064SMark Adams     ierr = KSPGetOperators(mglevels[lev]->smoothd,NULL,&dB);CHKERRQ(ierr);
160462a6e064SMark Adams     ierr = MatGetInfo(dB,MAT_GLOBAL_SUM,&info);CHKERRQ(ierr); /* global reduction */
16053966268fSBarry Smith     sgc += info.nz_used;
16069d766c59SMark Adams     if (lev==mg->nlevels-1) nnz0 = info.nz_used;
16079d766c59SMark Adams   }
16083966268fSBarry Smith   if (nnz0 > 0) *gc = (PetscReal)(sgc/nnz0);
16093966268fSBarry Smith   else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Number for grid points on finest level is not available");
16109d766c59SMark Adams   PetscFunctionReturn(0);
16119d766c59SMark Adams }
16129d766c59SMark Adams 
16135adeb434SBarry Smith static PetscErrorCode PCView_GAMG(PC pc,PetscViewer viewer)
16145adeb434SBarry Smith {
1615c1eae691SMark Adams   PetscErrorCode ierr,i;
16165adeb434SBarry Smith   PC_MG          *mg      = (PC_MG*)pc->data;
16175adeb434SBarry Smith   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
161823b2d91dSMark Adams   PetscReal       gc=0;
16195adeb434SBarry Smith   PetscFunctionBegin;
16205adeb434SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"    GAMG specific options\n");CHKERRQ(ierr);
1621459726d8SSatish Balay   ierr = PetscViewerASCIIPrintf(viewer,"      Threshold for dropping small values in graph on each level =");CHKERRQ(ierr);
1622b3e187dcSStefano Zampini   for (i=0;i<mg->nlevels; i++) {
1623c1eae691SMark Adams     ierr = PetscViewerASCIIPrintf(viewer," %g",(double)pc_gamg->threshold[i]);CHKERRQ(ierr);
1624c1eae691SMark Adams   }
1625459726d8SSatish Balay   ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
1626459726d8SSatish Balay   ierr = PetscViewerASCIIPrintf(viewer,"      Threshold scaling factor for each level not specified = %g\n",(double)pc_gamg->threshold_scale);CHKERRQ(ierr);
1627cab9ed1eSBarry Smith   if (pc_gamg->use_aggs_in_asm) {
1628cab9ed1eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"      Using aggregates from coarsening process to define subdomains for PCASM\n");CHKERRQ(ierr);
1629cab9ed1eSBarry Smith   }
1630171cca9aSMark Adams   if (pc_gamg->use_parallel_coarse_grid_solver) {
1631171cca9aSMark Adams     ierr = PetscViewerASCIIPrintf(viewer,"      Using parallel coarse grid solver (all coarse grid equations not put on one process)\n");CHKERRQ(ierr);
1632171cca9aSMark Adams   }
1633ce7c7f2fSMark Adams #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
1634ce7c7f2fSMark Adams   if (pc_gamg->cpu_pin_coarse_grids) {
1635ce7c7f2fSMark Adams     /* ierr = PetscViewerASCIIPrintf(viewer,"      Pinning coarse grids to the CPU)\n");CHKERRQ(ierr); */
1636ce7c7f2fSMark Adams   }
1637ce7c7f2fSMark Adams #endif
1638ce7c7f2fSMark Adams   /* if (pc_gamg->layout_type==PCGAMG_LAYOUT_COMPACT) { */
1639ce7c7f2fSMark Adams   /*   ierr = PetscViewerASCIIPrintf(viewer,"      Put reduced grids on processes in natural order (ie, 0,1,2...)\n");CHKERRQ(ierr); */
1640ce7c7f2fSMark Adams   /* } else { */
1641ce7c7f2fSMark Adams   /*   ierr = PetscViewerASCIIPrintf(viewer,"      Put reduced grids on whole machine (ie, 0,1*f,2*f...,np-f)\n");CHKERRQ(ierr); */
1642ce7c7f2fSMark Adams   /* } */
16435adeb434SBarry Smith   if (pc_gamg->ops->view) {
16445adeb434SBarry Smith     ierr = (*pc_gamg->ops->view)(pc,viewer);CHKERRQ(ierr);
16455adeb434SBarry Smith   }
16469d766c59SMark Adams   ierr = PCMGGetGridComplexity(pc,&gc);CHKERRQ(ierr);
16479d766c59SMark Adams   ierr = PetscViewerASCIIPrintf(viewer,"      Complexity:    grid = %g\n",gc);CHKERRQ(ierr);
16485adeb434SBarry Smith   PetscFunctionReturn(0);
16495adeb434SBarry Smith }
16505adeb434SBarry Smith 
16514416b707SBarry Smith PetscErrorCode PCSetFromOptions_GAMG(PetscOptionItems *PetscOptionsObject,PC pc)
16525b89ad90SMark F. Adams {
1653676e1743SMark F. Adams   PetscErrorCode ierr;
1654676e1743SMark F. Adams   PC_MG          *mg      = (PC_MG*)pc->data;
1655676e1743SMark F. Adams   PC_GAMG        *pc_gamg = (PC_GAMG*)mg->innerctx;
165618c3aa7eSMark   PetscBool      flag,f2;
16573b4367a7SBarry Smith   MPI_Comm       comm;
165818c3aa7eSMark   char           prefix[256],tname[32];
1659c1eae691SMark Adams   PetscInt       i,n;
166014a9496bSBarry Smith   const char     *pcpre;
16610a545947SLisandro Dalcin   static const char *LayoutTypes[] = {"compact","spread","PCGAMGLayoutType","PC_GAMG_LAYOUT",NULL};
16625b89ad90SMark F. Adams   PetscFunctionBegin;
16633b4367a7SBarry Smith   ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
1664e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"GAMG options");CHKERRQ(ierr);
16651a1c1e04SBarry Smith   ierr = PetscOptionsFList("-pc_gamg_type","Type of AMG method","PCGAMGSetType",GAMGList, pc_gamg->gamg_type_name, tname, sizeof(tname), &flag);CHKERRQ(ierr);
1666bd94a7aaSJed Brown   if (flag) {
1667bd94a7aaSJed Brown     ierr = PCGAMGSetType(pc,tname);CHKERRQ(ierr);
16681ab5ffc9SJed Brown   }
166918c3aa7eSMark   ierr = PetscOptionsFList("-pc_gamg_esteig_ksp_type","Krylov method for eigen estimator","PCGAMGSetEstEigKSPType",KSPList,pc_gamg->esteig_type,tname,sizeof(tname),&flag);CHKERRQ(ierr);
167018c3aa7eSMark   if (flag) {
167118c3aa7eSMark     ierr = PCGAMGSetEstEigKSPType(pc,tname);CHKERRQ(ierr);
167218c3aa7eSMark   }
1673cab9ed1eSBarry Smith   ierr = PetscOptionsBool("-pc_gamg_repartition","Repartion coarse grids","PCGAMGSetRepartition",pc_gamg->repart,&pc_gamg->repart,NULL);CHKERRQ(ierr);
167418c3aa7eSMark   f2 = PETSC_TRUE;
167518c3aa7eSMark   ierr = PetscOptionsBool("-pc_gamg_use_sa_esteig","Use eigen estimate from Smoothed aggregation for smoother","PCGAMGSetUseSAEstEig",f2,&f2,&flag);CHKERRQ(ierr);
167618c3aa7eSMark   if (flag) pc_gamg->use_sa_esteig = f2 ? 1 : 0;
16771cc46a46SBarry Smith   ierr = PetscOptionsBool("-pc_gamg_reuse_interpolation","Reuse prolongation operator","PCGAMGReuseInterpolation",pc_gamg->reuse_prol,&pc_gamg->reuse_prol,NULL);CHKERRQ(ierr);
1678a303c832SJed 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);
1679cf8ae1d3SMark 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);
1680ce7c7f2fSMark 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);
1681a0095786SMark   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);
168294ae4db5SBarry 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);
168318c3aa7eSMark   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);
168494ae4db5SBarry 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);
1685a303c832SJed 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);
168618c3aa7eSMark   n = PETSC_MG_MAXLEVELS;
1687c1eae691SMark Adams   ierr = PetscOptionsRealArray("-pc_gamg_threshold","Relative threshold to use for dropping edges in aggregation graph","PCGAMGSetThreshold",pc_gamg->threshold,&n,&flag);CHKERRQ(ierr);
168818c3aa7eSMark   if (!flag || n < PETSC_MG_MAXLEVELS) {
1689efd3c5ceSMark Adams     if (!flag) n = 1;
1690c1eae691SMark Adams     i = n;
169118c3aa7eSMark     do {pc_gamg->threshold[i] = pc_gamg->threshold[i-1]*pc_gamg->threshold_scale;} while (++i<PETSC_MG_MAXLEVELS);
1692c1eae691SMark Adams   }
1693c9567895SMark   n = PETSC_MG_MAXLEVELS;
1694c9567895SMark   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);
1695c9567895SMark   if (!flag) i = 0;
1696c9567895SMark   else i = n;
1697c9567895SMark   do {pc_gamg->level_reduction_factors[i] = -1;} while (++i<PETSC_MG_MAXLEVELS);
169894ae4db5SBarry Smith   ierr = PetscOptionsInt("-pc_mg_levels","Set number of MG levels","PCGAMGSetNlevels",pc_gamg->Nlevels,&pc_gamg->Nlevels,NULL);CHKERRQ(ierr);
169918c3aa7eSMark   {
170018c3aa7eSMark     PetscReal eminmax[2] = {0., 0.};
170118c3aa7eSMark     n = 2;
170218c3aa7eSMark     ierr = PetscOptionsRealArray("-pc_gamg_eigenvalues","extreme eigenvalues for smoothed aggregation","PCGAMGSetEigenvalues",eminmax,&n,&flag);CHKERRQ(ierr);
170318c3aa7eSMark     if (flag) {
170418c3aa7eSMark       if (n != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"-pc_gamg_eigenvalues: must specify 2 parameters, min and max eigenvalues");
170518c3aa7eSMark       ierr = PCGAMGSetEigenvalues(pc, eminmax[1], eminmax[0]);CHKERRQ(ierr);
170618c3aa7eSMark     }
170718c3aa7eSMark   }
1708b7cbab4eSMark Adams   /* set options for subtype */
1709e55864a3SBarry Smith   if (pc_gamg->ops->setfromoptions) {ierr = (*pc_gamg->ops->setfromoptions)(PetscOptionsObject,pc);CHKERRQ(ierr);}
171018c3aa7eSMark 
171114a9496bSBarry Smith   ierr = PCGetOptionsPrefix(pc, &pcpre);CHKERRQ(ierr);
171214a9496bSBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%spc_gamg_",pcpre ? pcpre : "");CHKERRQ(ierr);
1713676e1743SMark F. Adams   ierr = PetscOptionsTail();CHKERRQ(ierr);
17145b89ad90SMark F. Adams   PetscFunctionReturn(0);
17155b89ad90SMark F. Adams }
17165b89ad90SMark F. Adams 
17175b89ad90SMark F. Adams /* -------------------------------------------------------------------------- */
17185b89ad90SMark F. Adams /*MC
17191cc46a46SBarry Smith      PCGAMG - Geometric algebraic multigrid (AMG) preconditioner
17205b89ad90SMark F. Adams 
1721280d9858SJed Brown    Options Database Keys:
1722cab9ed1eSBarry Smith +   -pc_gamg_type <type> - one of agg, geo, or classical
1723cab9ed1eSBarry Smith .   -pc_gamg_repartition  <true,default=false> - repartition the degrees of freedom accross the coarse grids as they are determined
1724cab9ed1eSBarry Smith .   -pc_gamg_reuse_interpolation <true,default=false> - when rebuilding the algebraic multigrid preconditioner reuse the previously computed interpolations
1725cab9ed1eSBarry 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
1726cab9ed1eSBarry 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>
1727cab9ed1eSBarry Smith                                         equations on each process that has degrees of freedom
1728cab9ed1eSBarry Smith .   -pc_gamg_coarse_eq_limit <limit, default=50> - Set maximum number of equations on coarsest grid to aim for.
17296008e27bSRichard Tran Mills .   -pc_gamg_threshold[] <thresh,default=0> - Before aggregating the graph GAMG will remove small values from the graph on each level
1730c1eae691SMark Adams -   -pc_gamg_threshold_scale <scale,default=1> - Scaling of threshold on each coarser grid if not specified
1731cab9ed1eSBarry Smith 
1732cab9ed1eSBarry Smith    Options Database Keys for default Aggregation:
1733cab9ed1eSBarry Smith +  -pc_gamg_agg_nsmooths <nsmooth, default=1> - number of smoothing steps to use with smooth aggregation
1734cab9ed1eSBarry Smith .  -pc_gamg_sym_graph <true,default=false> - symmetrize the graph before computing the aggregation
1735cab9ed1eSBarry Smith -  -pc_gamg_square_graph <n,default=1> - number of levels to square the graph before aggregating it
1736cab9ed1eSBarry Smith 
1737db9745e2SBarry Smith    Multigrid options:
1738db9745e2SBarry Smith +  -pc_mg_cycles <v> - v or w, see PCMGSetCycleType()
1739db9745e2SBarry Smith .  -pc_mg_distinct_smoothup - configure the up and down (pre and post) smoothers separately, see PCMGSetDistinctSmoothUp()
1740db9745e2SBarry Smith .  -pc_mg_type <multiplicative> - (one of) additive multiplicative full kascade
1741cab9ed1eSBarry Smith -  -pc_mg_levels <levels> - Number of levels of multigrid to use.
17425b89ad90SMark F. Adams 
17431cc46a46SBarry Smith 
174495452b02SPatrick Sanan   Notes:
174595452b02SPatrick Sanan     In order to obtain good performance for PCGAMG for vector valued problems you must
1746db9745e2SBarry Smith        Call MatSetBlockSize() to indicate the number of degrees of freedom per grid point
1747db9745e2SBarry Smith        Call MatSetNearNullSpace() (or PCSetCoordinates() if solving the equations of elasticity) to indicate the near null space of the operator
1748db9745e2SBarry Smith        See the Users Manual Chapter 4 for more details
17491cc46a46SBarry Smith 
17505b89ad90SMark F. Adams   Level: intermediate
1751280d9858SJed Brown 
17521cc46a46SBarry Smith .seealso:  PCCreate(), PCSetType(), MatSetBlockSize(), PCMGType, PCSetCoordinates(), MatSetNearNullSpace(), PCGAMGSetType(), PCGAMGAGG, PCGAMGGEO, PCGAMGCLASSICAL, PCGAMGSetProcEqLim(),
175318c3aa7eSMark            PCGAMGSetCoarseEqLim(), PCGAMGSetRepartition(), PCGAMGRegister(), PCGAMGSetReuseInterpolation(), PCGAMGASMSetUseAggs(), PCGAMGSetUseParallelCoarseGridSolve(), PCGAMGSetNlevels(), PCGAMGSetThreshold(), PCGAMGGetType(), PCGAMGSetReuseInterpolation(), PCGAMGSetUseSAEstEig(), PCGAMGSetEstEigKSPMaxIt(), PCGAMGSetEstEigKSPType()
17545b89ad90SMark F. Adams M*/
1755b2573a8aSBarry Smith 
17568cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_GAMG(PC pc)
17575b89ad90SMark F. Adams {
1758c1eae691SMark Adams   PetscErrorCode ierr,i;
17595b89ad90SMark F. Adams   PC_GAMG        *pc_gamg;
17605b89ad90SMark F. Adams   PC_MG          *mg;
17615b89ad90SMark F. Adams 
17625b89ad90SMark F. Adams   PetscFunctionBegin;
17631c1aac46SBarry Smith    /* register AMG type */
17641c1aac46SBarry Smith   ierr = PCGAMGInitializePackage();CHKERRQ(ierr);
17651c1aac46SBarry Smith 
17665b89ad90SMark F. Adams   /* PCGAMG is an inherited class of PCMG. Initialize pc as PCMG */
17671c1aac46SBarry Smith   ierr = PCSetType(pc, PCMG);CHKERRQ(ierr);
17685b89ad90SMark F. Adams   ierr = PetscObjectChangeTypeName((PetscObject)pc, PCGAMG);CHKERRQ(ierr);
17695b89ad90SMark F. Adams 
17705b89ad90SMark F. Adams   /* create a supporting struct and attach it to pc */
1771b00a9115SJed Brown   ierr         = PetscNewLog(pc,&pc_gamg);CHKERRQ(ierr);
177269aca0b8SBarry Smith   ierr         = PCMGSetGalerkin(pc,PC_MG_GALERKIN_EXTERNAL);CHKERRQ(ierr);
17735b89ad90SMark F. Adams   mg           = (PC_MG*)pc->data;
17745b89ad90SMark F. Adams   mg->innerctx = pc_gamg;
17755b89ad90SMark F. Adams 
1776b00a9115SJed Brown   ierr = PetscNewLog(pc,&pc_gamg->ops);CHKERRQ(ierr);
17771ab5ffc9SJed Brown 
17789d5b6da9SMark F. Adams   /* these should be in subctx but repartitioning needs simple arrays */
17799d5b6da9SMark F. Adams   pc_gamg->data_sz = 0;
17800a545947SLisandro Dalcin   pc_gamg->data    = NULL;
17815b89ad90SMark F. Adams 
17829d5b6da9SMark F. Adams   /* overwrite the pointers of PCMG by the functions of base class PCGAMG */
17835b89ad90SMark F. Adams   pc->ops->setfromoptions = PCSetFromOptions_GAMG;
17845b89ad90SMark F. Adams   pc->ops->setup          = PCSetUp_GAMG;
17855b89ad90SMark F. Adams   pc->ops->reset          = PCReset_GAMG;
17865b89ad90SMark F. Adams   pc->ops->destroy        = PCDestroy_GAMG;
17875adeb434SBarry Smith   mg->view                = PCView_GAMG;
17885b89ad90SMark F. Adams 
178997d33e41SMatthew G. Knepley   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCMGGetLevels_C",PCMGGetLevels_MG);CHKERRQ(ierr);
179097d33e41SMatthew G. Knepley   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCMGSetLevels_C",PCMGSetLevels_MG);CHKERRQ(ierr);
1791bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetProcEqLim_C",PCGAMGSetProcEqLim_GAMG);CHKERRQ(ierr);
1792bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetCoarseEqLim_C",PCGAMGSetCoarseEqLim_GAMG);CHKERRQ(ierr);
1793cab9ed1eSBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetRepartition_C",PCGAMGSetRepartition_GAMG);CHKERRQ(ierr);
179418c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetEstEigKSPType_C",PCGAMGSetEstEigKSPType_GAMG);CHKERRQ(ierr);
179518c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetEstEigKSPMaxIt_C",PCGAMGSetEstEigKSPMaxIt_GAMG);CHKERRQ(ierr);
179618c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetEigenvalues_C",PCGAMGSetEigenvalues_GAMG);CHKERRQ(ierr);
179718c3aa7eSMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetUseSAEstEig_C",PCGAMGSetUseSAEstEig_GAMG);CHKERRQ(ierr);
17981cc46a46SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetReuseInterpolation_C",PCGAMGSetReuseInterpolation_GAMG);CHKERRQ(ierr);
1799cab9ed1eSBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGASMSetUseAggs_C",PCGAMGASMSetUseAggs_GAMG);CHKERRQ(ierr);
1800171cca9aSMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetUseParallelCoarseGridSolve_C",PCGAMGSetUseParallelCoarseGridSolve_GAMG);CHKERRQ(ierr);
1801ce7c7f2fSMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetCpuPinCoarseGrids_C",PCGAMGSetCpuPinCoarseGrids_GAMG);CHKERRQ(ierr);
1802ce7c7f2fSMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetCoarseGridLayoutType_C",PCGAMGSetCoarseGridLayoutType_GAMG);CHKERRQ(ierr);
1803bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetThreshold_C",PCGAMGSetThreshold_GAMG);CHKERRQ(ierr);
1804c9567895SMark   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetRankReductionFactors_C",PCGAMGSetRankReductionFactors_GAMG);CHKERRQ(ierr);
1805c1eae691SMark Adams   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetThresholdScale_C",PCGAMGSetThresholdScale_GAMG);CHKERRQ(ierr);
1806bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetType_C",PCGAMGSetType_GAMG);CHKERRQ(ierr);
1807c60c7ad4SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGGetType_C",PCGAMGGetType_GAMG);CHKERRQ(ierr);
1808bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGAMGSetNlevels_C",PCGAMGSetNlevels_GAMG);CHKERRQ(ierr);
18099d5b6da9SMark F. Adams   pc_gamg->repart           = PETSC_FALSE;
1810d3042614SMark Adams   pc_gamg->reuse_prol       = PETSC_FALSE;
18110c3bc534SBarry Smith   pc_gamg->use_aggs_in_asm  = PETSC_FALSE;
1812171cca9aSMark Adams   pc_gamg->use_parallel_coarse_grid_solver = PETSC_FALSE;
1813a0095786SMark   pc_gamg->cpu_pin_coarse_grids = PETSC_FALSE;
1814a0095786SMark   pc_gamg->layout_type      = PCGAMG_LAYOUT_SPREAD;
1815038f3aa4SMark F. Adams   pc_gamg->min_eq_proc      = 50;
181625a145a7SMark Adams   pc_gamg->coarse_eq_limit  = 50;
181718c3aa7eSMark   for (i=0;i<PETSC_MG_MAXLEVELS;i++) pc_gamg->threshold[i] = 0.;
1818c1eae691SMark Adams   pc_gamg->threshold_scale = 1.;
181918c3aa7eSMark   pc_gamg->Nlevels          = PETSC_MG_MAXLEVELS;
18209ab59c8bSMark Adams   pc_gamg->current_level    = 0; /* don't need to init really */
1821d24ecf33SMark   ierr = PetscStrcpy(pc_gamg->esteig_type,NULL);CHKERRQ(ierr);
182218c3aa7eSMark   pc_gamg->esteig_max_it    = 10;
182318c3aa7eSMark   pc_gamg->use_sa_esteig    = -1;
182418c3aa7eSMark   pc_gamg->emin             = 0;
182518c3aa7eSMark   pc_gamg->emax             = 0;
182618c3aa7eSMark 
1827c238b0ebSToby Isaac   pc_gamg->ops->createlevel = PCGAMGCreateLevel_GAMG;
18289d5b6da9SMark F. Adams 
1829bd94a7aaSJed Brown   /* PCSetUp_GAMG assumes that the type has been set, so set it to the default now */
1830bd94a7aaSJed Brown   ierr = PCGAMGSetType(pc,PCGAMGAGG);CHKERRQ(ierr);
18315b89ad90SMark F. Adams   PetscFunctionReturn(0);
18325b89ad90SMark F. Adams }
18333e3471ccSMark Adams 
18343e3471ccSMark Adams /*@C
18353e3471ccSMark Adams  PCGAMGInitializePackage - This function initializes everything in the PCGAMG package. It is called
18368a690491SBarry Smith     from PCInitializePackage().
18373e3471ccSMark Adams 
18383e3471ccSMark Adams  Level: developer
18393e3471ccSMark Adams 
18403e3471ccSMark Adams  .seealso: PetscInitialize()
18413e3471ccSMark Adams @*/
18423e3471ccSMark Adams PetscErrorCode PCGAMGInitializePackage(void)
18433e3471ccSMark Adams {
18443e3471ccSMark Adams   PetscErrorCode ierr;
18454555aa8cSStefano Zampini   PetscInt       l;
18463e3471ccSMark Adams 
18473e3471ccSMark Adams   PetscFunctionBegin;
18483e3471ccSMark Adams   if (PCGAMGPackageInitialized) PetscFunctionReturn(0);
18493e3471ccSMark Adams   PCGAMGPackageInitialized = PETSC_TRUE;
18503e3471ccSMark Adams   ierr = PetscFunctionListAdd(&GAMGList,PCGAMGGEO,PCCreateGAMG_GEO);CHKERRQ(ierr);
18513e3471ccSMark Adams   ierr = PetscFunctionListAdd(&GAMGList,PCGAMGAGG,PCCreateGAMG_AGG);CHKERRQ(ierr);
18528e6d0c30SPeter Brune   ierr = PetscFunctionListAdd(&GAMGList,PCGAMGCLASSICAL,PCCreateGAMG_Classical);CHKERRQ(ierr);
18533e3471ccSMark Adams   ierr = PetscRegisterFinalize(PCGAMGFinalizePackage);CHKERRQ(ierr);
1854c1c463dbSMark Adams 
1855c1c463dbSMark Adams   /* general events */
1856fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGGraph_AGG", 0, &PC_GAMGGraph_AGG);CHKERRQ(ierr);
1857fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGGraph_GEO", PC_CLASSID, &PC_GAMGGraph_GEO);CHKERRQ(ierr);
1858fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGCoarse_AGG", PC_CLASSID, &PC_GAMGCoarsen_AGG);CHKERRQ(ierr);
1859fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGCoarse_GEO", PC_CLASSID, &PC_GAMGCoarsen_GEO);CHKERRQ(ierr);
1860c1c463dbSMark Adams   ierr = PetscLogEventRegister("PCGAMGProl_AGG", PC_CLASSID, &PC_GAMGProlongator_AGG);CHKERRQ(ierr);
1861c1c463dbSMark Adams   ierr = PetscLogEventRegister("PCGAMGProl_GEO", PC_CLASSID, &PC_GAMGProlongator_GEO);CHKERRQ(ierr);
1862fd1112cbSBarry Smith   ierr = PetscLogEventRegister("PCGAMGPOpt_AGG", PC_CLASSID, &PC_GAMGOptProlongator_AGG);CHKERRQ(ierr);
1863c1c463dbSMark Adams 
18645b89ad90SMark F. Adams   ierr = PetscLogEventRegister("GAMG: createProl", PC_CLASSID, &petsc_gamg_setup_events[SET1]);CHKERRQ(ierr);
18655b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Graph", PC_CLASSID, &petsc_gamg_setup_events[GRAPH]);CHKERRQ(ierr);
18665b89ad90SMark F. Adams   /* PetscLogEventRegister("    G.Mat", PC_CLASSID, &petsc_gamg_setup_events[GRAPH_MAT]); */
18675b89ad90SMark F. Adams   /* PetscLogEventRegister("    G.Filter", PC_CLASSID, &petsc_gamg_setup_events[GRAPH_FILTER]); */
18685b89ad90SMark F. Adams   /* PetscLogEventRegister("    G.Square", PC_CLASSID, &petsc_gamg_setup_events[GRAPH_SQR]); */
18695b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  MIS/Agg", PC_CLASSID, &petsc_gamg_setup_events[SET4]);CHKERRQ(ierr);
18705b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  geo: growSupp", PC_CLASSID, &petsc_gamg_setup_events[SET5]);CHKERRQ(ierr);
18715b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  geo: triangle", PC_CLASSID, &petsc_gamg_setup_events[SET6]);CHKERRQ(ierr);
1872bb235841SBarry Smith   ierr = PetscLogEventRegister("    search-set", PC_CLASSID, &petsc_gamg_setup_events[FIND_V]);CHKERRQ(ierr);
18735b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  SA: col data", PC_CLASSID, &petsc_gamg_setup_events[SET7]);CHKERRQ(ierr);
18745b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  SA: frmProl0", PC_CLASSID, &petsc_gamg_setup_events[SET8]);CHKERRQ(ierr);
18755b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  SA: smooth", PC_CLASSID, &petsc_gamg_setup_events[SET9]);CHKERRQ(ierr);
18765b89ad90SMark F. Adams   ierr = PetscLogEventRegister("GAMG: partLevel", PC_CLASSID, &petsc_gamg_setup_events[SET2]);CHKERRQ(ierr);
18775b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  repartition", PC_CLASSID, &petsc_gamg_setup_events[SET12]);CHKERRQ(ierr);
18785b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Invert-Sort", PC_CLASSID, &petsc_gamg_setup_events[SET13]);CHKERRQ(ierr);
18795b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Move A", PC_CLASSID, &petsc_gamg_setup_events[SET14]);CHKERRQ(ierr);
18805b89ad90SMark F. Adams   ierr = PetscLogEventRegister("  Move P", PC_CLASSID, &petsc_gamg_setup_events[SET15]);CHKERRQ(ierr);
18814555aa8cSStefano Zampini   for (l=0;l<PETSC_MG_MAXLEVELS;l++) {
18824555aa8cSStefano Zampini     char ename[32];
18835b89ad90SMark F. Adams 
18844555aa8cSStefano Zampini     ierr = PetscSNPrintf(ename,sizeof(ename),"PCGAMG Squ l%02d",l);CHKERRQ(ierr);
18854555aa8cSStefano Zampini     ierr = PetscLogEventRegister(ename, PC_CLASSID, &petsc_gamg_setup_matmat_events[l][0]);CHKERRQ(ierr);
18864555aa8cSStefano Zampini     ierr = PetscSNPrintf(ename,sizeof(ename),"PCGAMG Gal l%02d",l);CHKERRQ(ierr);
18874555aa8cSStefano Zampini     ierr = PetscLogEventRegister(ename, PC_CLASSID, &petsc_gamg_setup_matmat_events[l][1]);CHKERRQ(ierr);
18884555aa8cSStefano Zampini     ierr = PetscSNPrintf(ename,sizeof(ename),"PCGAMG Opt l%02d",l);CHKERRQ(ierr);
18894555aa8cSStefano Zampini     ierr = PetscLogEventRegister(ename, PC_CLASSID, &petsc_gamg_setup_matmat_events[l][2]);CHKERRQ(ierr);
18904555aa8cSStefano Zampini   }
18915b89ad90SMark F. Adams   /* PetscLogEventRegister(" PL move data", PC_CLASSID, &petsc_gamg_setup_events[SET13]); */
18925b89ad90SMark F. Adams   /* PetscLogEventRegister("GAMG: fix", PC_CLASSID, &petsc_gamg_setup_events[SET10]); */
18935b89ad90SMark F. Adams   /* PetscLogEventRegister("GAMG: set levels", PC_CLASSID, &petsc_gamg_setup_events[SET11]); */
18945b89ad90SMark F. Adams   /* create timer stages */
18954555aa8cSStefano Zampini #if defined(GAMG_STAGES)
18965b89ad90SMark F. Adams   {
18975b89ad90SMark F. Adams     char     str[32];
18985b89ad90SMark F. Adams     PetscInt lidx;
18995b89ad90SMark F. Adams     sprintf(str,"MG Level %d (finest)",0);
19005b89ad90SMark F. Adams     ierr = PetscLogStageRegister(str, &gamg_stages[0]);CHKERRQ(ierr);
19015b89ad90SMark F. Adams     for (lidx=1; lidx<9; lidx++) {
1902c9567895SMark       sprintf(str,"MG Level %d",(int)lidx);
19035b89ad90SMark F. Adams       ierr = PetscLogStageRegister(str, &gamg_stages[lidx]);CHKERRQ(ierr);
19045b89ad90SMark F. Adams     }
19055b89ad90SMark F. Adams   }
19065b89ad90SMark F. Adams #endif
19073e3471ccSMark Adams   PetscFunctionReturn(0);
19083e3471ccSMark Adams }
19093e3471ccSMark Adams 
19103e3471ccSMark Adams /*@C
19111c1aac46SBarry Smith  PCGAMGFinalizePackage - This function frees everything from the PCGAMG package. It is
19121c1aac46SBarry Smith     called from PetscFinalize() automatically.
19133e3471ccSMark Adams 
19143e3471ccSMark Adams  Level: developer
19153e3471ccSMark Adams 
19163e3471ccSMark Adams  .seealso: PetscFinalize()
19173e3471ccSMark Adams @*/
19183e3471ccSMark Adams PetscErrorCode PCGAMGFinalizePackage(void)
19193e3471ccSMark Adams {
19203e3471ccSMark Adams   PetscErrorCode ierr;
19213e3471ccSMark Adams 
19223e3471ccSMark Adams   PetscFunctionBegin;
19233e3471ccSMark Adams   PCGAMGPackageInitialized = PETSC_FALSE;
19243e3471ccSMark Adams   ierr = PetscFunctionListDestroy(&GAMGList);CHKERRQ(ierr);
19253e3471ccSMark Adams   PetscFunctionReturn(0);
19263e3471ccSMark Adams }
1927a36cf38bSToby Isaac 
1928a36cf38bSToby Isaac /*@C
1929a36cf38bSToby Isaac  PCGAMGRegister - Register a PCGAMG implementation.
1930a36cf38bSToby Isaac 
1931a36cf38bSToby Isaac  Input Parameters:
1932a36cf38bSToby Isaac  + type - string that will be used as the name of the GAMG type.
1933a36cf38bSToby Isaac  - create - function for creating the gamg context.
1934a36cf38bSToby Isaac 
1935a36cf38bSToby Isaac   Level: advanced
1936a36cf38bSToby Isaac 
19371c1aac46SBarry Smith  .seealso: PCGAMGType, PCGAMG, PCGAMGSetType()
1938a36cf38bSToby Isaac @*/
1939a36cf38bSToby Isaac PetscErrorCode PCGAMGRegister(PCGAMGType type, PetscErrorCode (*create)(PC))
1940a36cf38bSToby Isaac {
1941a36cf38bSToby Isaac   PetscErrorCode ierr;
1942a36cf38bSToby Isaac 
1943a36cf38bSToby Isaac   PetscFunctionBegin;
1944a36cf38bSToby Isaac   ierr = PCGAMGInitializePackage();CHKERRQ(ierr);
1945a36cf38bSToby Isaac   ierr = PetscFunctionListAdd(&GAMGList,type,create);CHKERRQ(ierr);
1946a36cf38bSToby Isaac   PetscFunctionReturn(0);
1947a36cf38bSToby Isaac }
1948a36cf38bSToby Isaac 
1949