xref: /petsc/src/ksp/pc/impls/mg/mg.c (revision 89cce641326674dee6eed3a03bd1210b0b453d6c)
1dba47a55SKris Buschelman 
24b9ad928SBarry Smith /*
34b9ad928SBarry Smith     Defines the multigrid preconditioner interface.
44b9ad928SBarry Smith */
5c6db04a5SJed Brown #include <../src/ksp/pc/impls/mg/mgimpl.h>                    /*I "petscpcmg.h" I*/
64b9ad928SBarry Smith 
74b9ad928SBarry Smith 
84b9ad928SBarry Smith #undef __FUNCT__
99dcbbd2bSBarry Smith #define __FUNCT__ "PCMGMCycle_Private"
1031567311SBarry Smith PetscErrorCode PCMGMCycle_Private(PC pc,PC_MG_Levels **mglevelsin,PCRichardsonConvergedReason *reason)
114b9ad928SBarry Smith {
1231567311SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
1331567311SBarry Smith   PC_MG_Levels   *mgc,*mglevels = *mglevelsin;
146849ba73SBarry Smith   PetscErrorCode ierr;
1531567311SBarry Smith   PetscInt       cycles = (mglevels->level == 1) ? 1 : (PetscInt) mglevels->cycles;
164b9ad928SBarry Smith 
174b9ad928SBarry Smith   PetscFunctionBegin;
184b9ad928SBarry Smith 
1963e6d426SJed Brown   if (mglevels->eventsmoothsolve) {ierr = PetscLogEventBegin(mglevels->eventsmoothsolve,0,0,0,0);CHKERRQ(ierr);}
2031567311SBarry Smith   ierr = KSPSolve(mglevels->smoothd,mglevels->b,mglevels->x);CHKERRQ(ierr);  /* pre-smooth */
2163e6d426SJed Brown   if (mglevels->eventsmoothsolve) {ierr = PetscLogEventEnd(mglevels->eventsmoothsolve,0,0,0,0);CHKERRQ(ierr);}
2231567311SBarry Smith   if (mglevels->level) {  /* not the coarsest grid */
2363e6d426SJed Brown     if (mglevels->eventresidual) {ierr = PetscLogEventBegin(mglevels->eventresidual,0,0,0,0);CHKERRQ(ierr);}
2431567311SBarry Smith     ierr = (*mglevels->residual)(mglevels->A,mglevels->b,mglevels->x,mglevels->r);CHKERRQ(ierr);
2563e6d426SJed Brown     if (mglevels->eventresidual) {ierr = PetscLogEventEnd(mglevels->eventresidual,0,0,0,0);CHKERRQ(ierr);}
264b9ad928SBarry Smith 
274b9ad928SBarry Smith     /* if on finest level and have convergence criteria set */
2831567311SBarry Smith     if (mglevels->level == mglevels->levels-1 && mg->ttol && reason) {
294b9ad928SBarry Smith       PetscReal rnorm;
3031567311SBarry Smith       ierr = VecNorm(mglevels->r,NORM_2,&rnorm);CHKERRQ(ierr);
314b9ad928SBarry Smith       if (rnorm <= mg->ttol) {
3270441072SBarry Smith         if (rnorm < mg->abstol) {
334d0a8057SBarry Smith           *reason = PCRICHARDSON_CONVERGED_ATOL;
341e2582c4SBarry Smith           ierr = PetscInfo2(pc,"Linear solver has converged. Residual norm %G is less than absolute tolerance %G\n",rnorm,mg->abstol);CHKERRQ(ierr);
354b9ad928SBarry Smith         } else {
364d0a8057SBarry Smith           *reason = PCRICHARDSON_CONVERGED_RTOL;
371e2582c4SBarry Smith           ierr = PetscInfo2(pc,"Linear solver has converged. Residual norm %G is less than relative tolerance times initial residual norm %G\n",rnorm,mg->ttol);CHKERRQ(ierr);
384b9ad928SBarry Smith         }
394b9ad928SBarry Smith         PetscFunctionReturn(0);
404b9ad928SBarry Smith       }
414b9ad928SBarry Smith     }
424b9ad928SBarry Smith 
4331567311SBarry Smith     mgc = *(mglevelsin - 1);
4463e6d426SJed Brown     if (mglevels->eventinterprestrict) {ierr = PetscLogEventBegin(mglevels->eventinterprestrict,0,0,0,0);CHKERRQ(ierr);}
4531567311SBarry Smith     ierr = MatRestrict(mglevels->restrct,mglevels->r,mgc->b);CHKERRQ(ierr);
4663e6d426SJed Brown     if (mglevels->eventinterprestrict) {ierr = PetscLogEventEnd(mglevels->eventinterprestrict,0,0,0,0);CHKERRQ(ierr);}
47efb30889SBarry Smith     ierr = VecSet(mgc->x,0.0);CHKERRQ(ierr);
484b9ad928SBarry Smith     while (cycles--) {
4931567311SBarry Smith       ierr = PCMGMCycle_Private(pc,mglevelsin-1,reason);CHKERRQ(ierr);
504b9ad928SBarry Smith     }
5163e6d426SJed Brown     if (mglevels->eventinterprestrict) {ierr = PetscLogEventBegin(mglevels->eventinterprestrict,0,0,0,0);CHKERRQ(ierr);}
5231567311SBarry Smith     ierr = MatInterpolateAdd(mglevels->interpolate,mgc->x,mglevels->x,mglevels->x);CHKERRQ(ierr);
5363e6d426SJed Brown     if (mglevels->eventinterprestrict) {ierr = PetscLogEventEnd(mglevels->eventinterprestrict,0,0,0,0);CHKERRQ(ierr);}
5463e6d426SJed Brown     if (mglevels->eventsmoothsolve) {ierr = PetscLogEventBegin(mglevels->eventsmoothsolve,0,0,0,0);CHKERRQ(ierr);}
5531567311SBarry Smith     ierr = KSPSolve(mglevels->smoothu,mglevels->b,mglevels->x);CHKERRQ(ierr);    /* post smooth */
5663e6d426SJed Brown     if (mglevels->eventsmoothsolve) {ierr = PetscLogEventEnd(mglevels->eventsmoothsolve,0,0,0,0);CHKERRQ(ierr);}
574b9ad928SBarry Smith   }
584b9ad928SBarry Smith   PetscFunctionReturn(0);
594b9ad928SBarry Smith }
604b9ad928SBarry Smith 
614b9ad928SBarry Smith #undef __FUNCT__
624b9ad928SBarry Smith #define __FUNCT__ "PCApplyRichardson_MG"
63ace3abfcSBarry Smith static PetscErrorCode PCApplyRichardson_MG(PC pc,Vec b,Vec x,Vec w,PetscReal rtol,PetscReal abstol, PetscReal dtol,PetscInt its,PetscBool  zeroguess,PetscInt *outits,PCRichardsonConvergedReason *reason)
644b9ad928SBarry Smith {
65f3fbd535SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
66f3fbd535SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
67dfbe8321SBarry Smith   PetscErrorCode ierr;
68f3fbd535SBarry Smith   PetscInt       levels = mglevels[0]->levels,i;
694b9ad928SBarry Smith 
704b9ad928SBarry Smith   PetscFunctionBegin;
71f3fbd535SBarry Smith   mglevels[levels-1]->b    = b;
72f3fbd535SBarry Smith   mglevels[levels-1]->x    = x;
734b9ad928SBarry Smith 
7431567311SBarry Smith   mg->rtol = rtol;
7531567311SBarry Smith   mg->abstol = abstol;
7631567311SBarry Smith   mg->dtol = dtol;
774b9ad928SBarry Smith   if (rtol) {
784b9ad928SBarry Smith     /* compute initial residual norm for relative convergence test */
794b9ad928SBarry Smith     PetscReal rnorm;
807319c654SBarry Smith     if (zeroguess) {
817319c654SBarry Smith       ierr               = VecNorm(b,NORM_2,&rnorm);CHKERRQ(ierr);
827319c654SBarry Smith     } else {
83f3fbd535SBarry Smith       ierr               = (*mglevels[levels-1]->residual)(mglevels[levels-1]->A,b,x,w);CHKERRQ(ierr);
844b9ad928SBarry Smith       ierr               = VecNorm(w,NORM_2,&rnorm);CHKERRQ(ierr);
857319c654SBarry Smith     }
8631567311SBarry Smith     mg->ttol = PetscMax(rtol*rnorm,abstol);
8770441072SBarry Smith   } else if (abstol) {
8831567311SBarry Smith     mg->ttol = abstol;
894b9ad928SBarry Smith   } else {
9031567311SBarry Smith     mg->ttol = 0.0;
914b9ad928SBarry Smith   }
924b9ad928SBarry Smith 
934d0a8057SBarry Smith   /* since smoother is applied to full system, not just residual we need to make sure that smoothers don't
944d0a8057SBarry Smith      stop prematurely do to small residual */
954d0a8057SBarry Smith   for (i=1; i<levels; i++) {
96f3fbd535SBarry Smith     ierr = KSPSetTolerances(mglevels[i]->smoothu,0,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT);CHKERRQ(ierr);
97f3fbd535SBarry Smith     if (mglevels[i]->smoothu != mglevels[i]->smoothd) {
98f3fbd535SBarry Smith       ierr = KSPSetTolerances(mglevels[i]->smoothd,0,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT);CHKERRQ(ierr);
994b9ad928SBarry Smith     }
1004d0a8057SBarry Smith   }
1014d0a8057SBarry Smith 
1024d0a8057SBarry Smith   *reason = (PCRichardsonConvergedReason)0;
1034d0a8057SBarry Smith   for (i=0; i<its; i++) {
104f3fbd535SBarry Smith     ierr = PCMGMCycle_Private(pc,mglevels+levels-1,reason);CHKERRQ(ierr);
1054d0a8057SBarry Smith     if (*reason) break;
1064d0a8057SBarry Smith   }
1074d0a8057SBarry Smith   if (!*reason) *reason = PCRICHARDSON_CONVERGED_ITS;
1084d0a8057SBarry Smith   *outits = i;
1094b9ad928SBarry Smith   PetscFunctionReturn(0);
1104b9ad928SBarry Smith }
1114b9ad928SBarry Smith 
1124b9ad928SBarry Smith #undef __FUNCT__
1133aeaf226SBarry Smith #define __FUNCT__ "PCReset_MG"
1143aeaf226SBarry Smith PetscErrorCode PCReset_MG(PC pc)
1153aeaf226SBarry Smith {
1163aeaf226SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
1173aeaf226SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
1183aeaf226SBarry Smith   PetscErrorCode ierr;
1193aeaf226SBarry Smith   PetscInt       i,n;
1203aeaf226SBarry Smith 
1213aeaf226SBarry Smith   PetscFunctionBegin;
1223aeaf226SBarry Smith   if (mglevels) {
1233aeaf226SBarry Smith     n = mglevels[0]->levels;
1243aeaf226SBarry Smith     for (i=0; i<n-1; i++) {
1253aeaf226SBarry Smith       ierr = VecDestroy(&mglevels[i+1]->r);CHKERRQ(ierr);
1263aeaf226SBarry Smith       ierr = VecDestroy(&mglevels[i]->b);CHKERRQ(ierr);
1273aeaf226SBarry Smith       ierr = VecDestroy(&mglevels[i]->x);CHKERRQ(ierr);
1283aeaf226SBarry Smith       ierr = MatDestroy(&mglevels[i+1]->restrct);CHKERRQ(ierr);
1293aeaf226SBarry Smith       ierr = MatDestroy(&mglevels[i+1]->interpolate);CHKERRQ(ierr);
13073250ac0SBarry Smith       ierr = VecDestroy(&mglevels[i+1]->rscale);CHKERRQ(ierr);
1313aeaf226SBarry Smith     }
1323aeaf226SBarry Smith 
1333aeaf226SBarry Smith     for (i=0; i<n; i++) {
1343aeaf226SBarry Smith       ierr = MatDestroy(&mglevels[i]->A);CHKERRQ(ierr);
1353aeaf226SBarry Smith       if (mglevels[i]->smoothd != mglevels[i]->smoothu) {
1363aeaf226SBarry Smith 	ierr = KSPReset(mglevels[i]->smoothd);CHKERRQ(ierr);
1373aeaf226SBarry Smith       }
1383aeaf226SBarry Smith       ierr = KSPReset(mglevels[i]->smoothu);CHKERRQ(ierr);
1393aeaf226SBarry Smith     }
1403aeaf226SBarry Smith   }
1413aeaf226SBarry Smith   PetscFunctionReturn(0);
1423aeaf226SBarry Smith }
1433aeaf226SBarry Smith 
1443aeaf226SBarry Smith #undef __FUNCT__
1459dcbbd2bSBarry Smith #define __FUNCT__ "PCMGSetLevels"
1464b9ad928SBarry Smith /*@C
14797177400SBarry Smith    PCMGSetLevels - Sets the number of levels to use with MG.
1484b9ad928SBarry Smith    Must be called before any other MG routine.
1494b9ad928SBarry Smith 
150ad4df100SBarry Smith    Logically Collective on PC
1514b9ad928SBarry Smith 
1524b9ad928SBarry Smith    Input Parameters:
1534b9ad928SBarry Smith +  pc - the preconditioner context
1544b9ad928SBarry Smith .  levels - the number of levels
1554b9ad928SBarry Smith -  comms - optional communicators for each level; this is to allow solving the coarser problems
1564b9ad928SBarry Smith            on smaller sets of processors. Use PETSC_NULL_OBJECT for default in Fortran
1574b9ad928SBarry Smith 
1584b9ad928SBarry Smith    Level: intermediate
1594b9ad928SBarry Smith 
1604b9ad928SBarry Smith    Notes:
1614b9ad928SBarry Smith      If the number of levels is one then the multigrid uses the -mg_levels prefix
1624b9ad928SBarry Smith   for setting the level options rather than the -mg_coarse prefix.
1634b9ad928SBarry Smith 
1644b9ad928SBarry Smith .keywords: MG, set, levels, multigrid
1654b9ad928SBarry Smith 
16697177400SBarry Smith .seealso: PCMGSetType(), PCMGGetLevels()
1674b9ad928SBarry Smith @*/
1687087cfbeSBarry Smith PetscErrorCode  PCMGSetLevels(PC pc,PetscInt levels,MPI_Comm *comms)
1694b9ad928SBarry Smith {
170dfbe8321SBarry Smith   PetscErrorCode ierr;
171f3fbd535SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
172f3fbd535SBarry Smith   MPI_Comm       comm = ((PetscObject)pc)->comm;
1733aeaf226SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
174f3fbd535SBarry Smith   PetscInt       i;
175f3fbd535SBarry Smith   PetscMPIInt    size;
176f3fbd535SBarry Smith   const char     *prefix;
177f3fbd535SBarry Smith   PC             ipc;
1783aeaf226SBarry Smith   PetscInt       n;
1794b9ad928SBarry Smith 
1804b9ad928SBarry Smith   PetscFunctionBegin;
1810700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
182548767e0SJed Brown   PetscValidLogicalCollectiveInt(pc,levels,2);
183548767e0SJed Brown   if (mg->nlevels == levels) PetscFunctionReturn(0);
1843aeaf226SBarry Smith   if (mglevels) {
1853aeaf226SBarry Smith     /* changing the number of levels so free up the previous stuff */
1863aeaf226SBarry Smith     ierr = PCReset_MG(pc);CHKERRQ(ierr);
1873aeaf226SBarry Smith     n = mglevels[0]->levels;
1883aeaf226SBarry Smith     for (i=0; i<n; i++) {
1893aeaf226SBarry Smith       if (mglevels[i]->smoothd != mglevels[i]->smoothu) {
1903aeaf226SBarry Smith 	ierr = KSPDestroy(&mglevels[i]->smoothd);CHKERRQ(ierr);
1913aeaf226SBarry Smith       }
1923aeaf226SBarry Smith       ierr = KSPDestroy(&mglevels[i]->smoothu);CHKERRQ(ierr);
1933aeaf226SBarry Smith       ierr = PetscFree(mglevels[i]);CHKERRQ(ierr);
1943aeaf226SBarry Smith     }
1953aeaf226SBarry Smith     ierr = PetscFree(mg->levels);CHKERRQ(ierr);
1963aeaf226SBarry Smith   }
197f3fbd535SBarry Smith 
198f3fbd535SBarry Smith   mg->nlevels      = levels;
199218a07d4SBarry Smith   mg->galerkin     = PETSC_FALSE;
200218a07d4SBarry Smith   mg->galerkinused = PETSC_FALSE;
201f3fbd535SBarry Smith 
202f3fbd535SBarry Smith   ierr = PetscMalloc(levels*sizeof(PC_MG*),&mglevels);CHKERRQ(ierr);
203f3fbd535SBarry Smith   ierr = PetscLogObjectMemory(pc,levels*(sizeof(PC_MG*)));CHKERRQ(ierr);
204f3fbd535SBarry Smith 
205f3fbd535SBarry Smith   ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
206f3fbd535SBarry Smith 
207f3fbd535SBarry Smith   for (i=0; i<levels; i++) {
208f3fbd535SBarry Smith     ierr = PetscNewLog(pc,PC_MG_Levels,&mglevels[i]);CHKERRQ(ierr);
209f3fbd535SBarry Smith     mglevels[i]->level           = i;
210f3fbd535SBarry Smith     mglevels[i]->levels          = levels;
211f3fbd535SBarry Smith     mglevels[i]->cycles          = PC_MG_CYCLE_V;
21231567311SBarry Smith     mg->default_smoothu = 1;
21331567311SBarry Smith     mg->default_smoothd = 1;
21463e6d426SJed Brown     mglevels[i]->eventsmoothsetup    = 0;
21563e6d426SJed Brown     mglevels[i]->eventsmoothsolve    = 0;
21663e6d426SJed Brown     mglevels[i]->eventresidual       = 0;
21763e6d426SJed Brown     mglevels[i]->eventinterprestrict = 0;
218f3fbd535SBarry Smith 
219f3fbd535SBarry Smith     if (comms) comm = comms[i];
220f3fbd535SBarry Smith     ierr = KSPCreate(comm,&mglevels[i]->smoothd);CHKERRQ(ierr);
221f3fbd535SBarry Smith     ierr = PetscObjectIncrementTabLevel((PetscObject)mglevels[i]->smoothd,(PetscObject)pc,levels-i);CHKERRQ(ierr);
22231567311SBarry Smith     ierr = KSPSetTolerances(mglevels[i]->smoothd,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT, mg->default_smoothd);CHKERRQ(ierr);
223f3fbd535SBarry Smith     ierr = KSPSetOptionsPrefix(mglevels[i]->smoothd,prefix);CHKERRQ(ierr);
224f3fbd535SBarry Smith 
225f3fbd535SBarry Smith     /* do special stuff for coarse grid */
226f3fbd535SBarry Smith     if (!i && levels > 1) {
227f3fbd535SBarry Smith       ierr = KSPAppendOptionsPrefix(mglevels[0]->smoothd,"mg_coarse_");CHKERRQ(ierr);
228f3fbd535SBarry Smith 
229f3fbd535SBarry Smith       /* coarse solve is (redundant) LU by default */
230f3fbd535SBarry Smith       ierr = KSPSetType(mglevels[0]->smoothd,KSPPREONLY);CHKERRQ(ierr);
231f3fbd535SBarry Smith       ierr = KSPGetPC(mglevels[0]->smoothd,&ipc);CHKERRQ(ierr);
232f3fbd535SBarry Smith       ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
233f3fbd535SBarry Smith       if (size > 1) {
234f3fbd535SBarry Smith         ierr = PCSetType(ipc,PCREDUNDANT);CHKERRQ(ierr);
235f3fbd535SBarry Smith       } else {
236f3fbd535SBarry Smith         ierr = PCSetType(ipc,PCLU);CHKERRQ(ierr);
237f3fbd535SBarry Smith       }
238f3fbd535SBarry Smith 
239f3fbd535SBarry Smith     } else {
240f3fbd535SBarry Smith       char tprefix[128];
241f3fbd535SBarry Smith       sprintf(tprefix,"mg_levels_%d_",(int)i);
242f3fbd535SBarry Smith       ierr = KSPAppendOptionsPrefix(mglevels[i]->smoothd,tprefix);CHKERRQ(ierr);
243f3fbd535SBarry Smith     }
244f3fbd535SBarry Smith     ierr = PetscLogObjectParent(pc,mglevels[i]->smoothd);CHKERRQ(ierr);
245f3fbd535SBarry Smith     mglevels[i]->smoothu    = mglevels[i]->smoothd;
24631567311SBarry Smith     mg->rtol                = 0.0;
24731567311SBarry Smith     mg->abstol              = 0.0;
24831567311SBarry Smith     mg->dtol                = 0.0;
24931567311SBarry Smith     mg->ttol                = 0.0;
25031567311SBarry Smith     mg->cyclesperpcapply    = 1;
251f3fbd535SBarry Smith   }
25231567311SBarry Smith   mg->am          = PC_MG_MULTIPLICATIVE;
253f3fbd535SBarry Smith   mg->levels      = mglevels;
2544b9ad928SBarry Smith   pc->ops->applyrichardson = PCApplyRichardson_MG;
2554b9ad928SBarry Smith   PetscFunctionReturn(0);
2564b9ad928SBarry Smith }
2574b9ad928SBarry Smith 
258c07bf074SBarry Smith 
259c07bf074SBarry Smith #undef __FUNCT__
260c07bf074SBarry Smith #define __FUNCT__ "PCDestroy_MG"
261c07bf074SBarry Smith PetscErrorCode PCDestroy_MG(PC pc)
262c07bf074SBarry Smith {
263c07bf074SBarry Smith   PetscErrorCode ierr;
264a06653b4SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
265a06653b4SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
266a06653b4SBarry Smith   PetscInt       i,n;
267c07bf074SBarry Smith 
268c07bf074SBarry Smith   PetscFunctionBegin;
269a06653b4SBarry Smith   ierr = PCReset_MG(pc);CHKERRQ(ierr);
270a06653b4SBarry Smith   if (mglevels) {
271a06653b4SBarry Smith     n = mglevels[0]->levels;
272a06653b4SBarry Smith     for (i=0; i<n; i++) {
273a06653b4SBarry Smith       if (mglevels[i]->smoothd != mglevels[i]->smoothu) {
2746bf464f9SBarry Smith 	ierr = KSPDestroy(&mglevels[i]->smoothd);CHKERRQ(ierr);
275a06653b4SBarry Smith       }
2766bf464f9SBarry Smith       ierr = KSPDestroy(&mglevels[i]->smoothu);CHKERRQ(ierr);
277a06653b4SBarry Smith       ierr = PetscFree(mglevels[i]);CHKERRQ(ierr);
278a06653b4SBarry Smith     }
279a06653b4SBarry Smith     ierr = PetscFree(mg->levels);CHKERRQ(ierr);
280a06653b4SBarry Smith   }
281c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
282f3fbd535SBarry Smith   PetscFunctionReturn(0);
283f3fbd535SBarry Smith }
284f3fbd535SBarry Smith 
285f3fbd535SBarry Smith 
286f3fbd535SBarry Smith 
28709573ac7SBarry Smith extern PetscErrorCode PCMGACycle_Private(PC,PC_MG_Levels**);
28809573ac7SBarry Smith extern PetscErrorCode PCMGFCycle_Private(PC,PC_MG_Levels**);
28909573ac7SBarry Smith extern PetscErrorCode PCMGKCycle_Private(PC,PC_MG_Levels**);
290f3fbd535SBarry Smith 
291f3fbd535SBarry Smith /*
292f3fbd535SBarry Smith    PCApply_MG - Runs either an additive, multiplicative, Kaskadic
293f3fbd535SBarry Smith              or full cycle of multigrid.
294f3fbd535SBarry Smith 
295f3fbd535SBarry Smith   Note:
296f3fbd535SBarry Smith   A simple wrapper which calls PCMGMCycle(),PCMGACycle(), or PCMGFCycle().
297f3fbd535SBarry Smith */
298f3fbd535SBarry Smith #undef __FUNCT__
299f3fbd535SBarry Smith #define __FUNCT__ "PCApply_MG"
300f3fbd535SBarry Smith static PetscErrorCode PCApply_MG(PC pc,Vec b,Vec x)
301f3fbd535SBarry Smith {
302f3fbd535SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
303f3fbd535SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
304f3fbd535SBarry Smith   PetscErrorCode ierr;
305f3fbd535SBarry Smith   PetscInt       levels = mglevels[0]->levels,i;
306f3fbd535SBarry Smith 
307f3fbd535SBarry Smith   PetscFunctionBegin;
308e1d8e5deSBarry Smith 
309e1d8e5deSBarry Smith   /* When the DM is supplying the matrix then it will not exist until here */
310298cc208SBarry Smith   for (i=0; i<levels; i++) {
311e1d8e5deSBarry Smith     if (!mglevels[i]->A) {
312e1d8e5deSBarry Smith       ierr = KSPGetOperators(mglevels[i]->smoothu,&mglevels[i]->A,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
313298cc208SBarry Smith       ierr = PetscObjectReference((PetscObject)mglevels[i]->A);CHKERRQ(ierr);
314e1d8e5deSBarry Smith     }
315e1d8e5deSBarry Smith   }
316e1d8e5deSBarry Smith 
317f3fbd535SBarry Smith   mglevels[levels-1]->b = b;
318f3fbd535SBarry Smith   mglevels[levels-1]->x = x;
31931567311SBarry Smith   if (mg->am == PC_MG_MULTIPLICATIVE) {
320f3fbd535SBarry Smith     ierr = VecSet(x,0.0);CHKERRQ(ierr);
32131567311SBarry Smith     for (i=0; i<mg->cyclesperpcapply; i++) {
322f3fbd535SBarry Smith       ierr = PCMGMCycle_Private(pc,mglevels+levels-1,PETSC_NULL);CHKERRQ(ierr);
323f3fbd535SBarry Smith     }
324f3fbd535SBarry Smith   }
32531567311SBarry Smith   else if (mg->am == PC_MG_ADDITIVE) {
32631567311SBarry Smith     ierr = PCMGACycle_Private(pc,mglevels);CHKERRQ(ierr);
327f3fbd535SBarry Smith   }
32831567311SBarry Smith   else if (mg->am == PC_MG_KASKADE) {
32931567311SBarry Smith     ierr = PCMGKCycle_Private(pc,mglevels);CHKERRQ(ierr);
330f3fbd535SBarry Smith   }
331f3fbd535SBarry Smith   else {
332f3fbd535SBarry Smith     ierr = PCMGFCycle_Private(pc,mglevels);CHKERRQ(ierr);
333f3fbd535SBarry Smith   }
334f3fbd535SBarry Smith   PetscFunctionReturn(0);
335f3fbd535SBarry Smith }
336f3fbd535SBarry Smith 
337f3fbd535SBarry Smith 
338f3fbd535SBarry Smith #undef __FUNCT__
339f3fbd535SBarry Smith #define __FUNCT__ "PCSetFromOptions_MG"
340f3fbd535SBarry Smith PetscErrorCode PCSetFromOptions_MG(PC pc)
341f3fbd535SBarry Smith {
342f3fbd535SBarry Smith   PetscErrorCode ierr;
343f3fbd535SBarry Smith   PetscInt       m,levels = 1,cycles;
344ace3abfcSBarry Smith   PetscBool      flg;
345f3fbd535SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
346f3fbd535SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
347f3fbd535SBarry Smith   PCMGType       mgtype;
348f3fbd535SBarry Smith   PCMGCycleType  mgctype;
349f3fbd535SBarry Smith 
350f3fbd535SBarry Smith   PetscFunctionBegin;
351f3fbd535SBarry Smith   ierr = PetscOptionsHead("Multigrid options");CHKERRQ(ierr);
3523aeaf226SBarry Smith     if (!mg->levels) {
353f3fbd535SBarry Smith       ierr = PetscOptionsInt("-pc_mg_levels","Number of Levels","PCMGSetLevels",levels,&levels,&flg);CHKERRQ(ierr);
354eb3f98d2SBarry Smith       if (!flg && pc->dm) {
355eb3f98d2SBarry Smith         ierr = DMGetRefineLevel(pc->dm,&levels);CHKERRQ(ierr);
356eb3f98d2SBarry Smith         levels++;
3573aeaf226SBarry Smith         mg->usedmfornumberoflevels = PETSC_TRUE;
358eb3f98d2SBarry Smith       }
359f3fbd535SBarry Smith       ierr = PCMGSetLevels(pc,levels,PETSC_NULL);CHKERRQ(ierr);
360f3fbd535SBarry Smith     }
3613aeaf226SBarry Smith     mglevels = mg->levels;
3623aeaf226SBarry Smith 
363f3fbd535SBarry Smith     mgctype = (PCMGCycleType) mglevels[0]->cycles;
364f3fbd535SBarry Smith     ierr = PetscOptionsEnum("-pc_mg_cycle_type","V cycle or for W-cycle","PCMGSetCycleType",PCMGCycleTypes,(PetscEnum)mgctype,(PetscEnum*)&mgctype,&flg);CHKERRQ(ierr);
365f3fbd535SBarry Smith     if (flg) {
366f3fbd535SBarry Smith       ierr = PCMGSetCycleType(pc,mgctype);CHKERRQ(ierr);
367f3fbd535SBarry Smith     };
368f3fbd535SBarry Smith     flg  = PETSC_FALSE;
369acfcf0e5SJed Brown     ierr = PetscOptionsBool("-pc_mg_galerkin","Use Galerkin process to compute coarser operators","PCMGSetGalerkin",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
370f3fbd535SBarry Smith     if (flg) {
371f3fbd535SBarry Smith       ierr = PCMGSetGalerkin(pc);CHKERRQ(ierr);
372f3fbd535SBarry Smith     }
373f3fbd535SBarry Smith     ierr = PetscOptionsInt("-pc_mg_smoothup","Number of post-smoothing steps","PCMGSetNumberSmoothUp",1,&m,&flg);CHKERRQ(ierr);
374f3fbd535SBarry Smith     if (flg) {
375f3fbd535SBarry Smith       ierr = PCMGSetNumberSmoothUp(pc,m);CHKERRQ(ierr);
376f3fbd535SBarry Smith     }
377f3fbd535SBarry Smith     ierr = PetscOptionsInt("-pc_mg_smoothdown","Number of pre-smoothing steps","PCMGSetNumberSmoothDown",1,&m,&flg);CHKERRQ(ierr);
378f3fbd535SBarry Smith     if (flg) {
379f3fbd535SBarry Smith       ierr = PCMGSetNumberSmoothDown(pc,m);CHKERRQ(ierr);
380f3fbd535SBarry Smith     }
38131567311SBarry Smith     mgtype = mg->am;
382f3fbd535SBarry Smith     ierr = PetscOptionsEnum("-pc_mg_type","Multigrid type","PCMGSetType",PCMGTypes,(PetscEnum)mgtype,(PetscEnum*)&mgtype,&flg);CHKERRQ(ierr);
383f3fbd535SBarry Smith     if (flg) {
384f3fbd535SBarry Smith       ierr = PCMGSetType(pc,mgtype);CHKERRQ(ierr);
385f3fbd535SBarry Smith     }
38631567311SBarry Smith     if (mg->am == PC_MG_MULTIPLICATIVE) {
38731567311SBarry Smith       ierr = PetscOptionsInt("-pc_mg_multiplicative_cycles","Number of cycles for each preconditioner step","PCMGSetLevels",mg->cyclesperpcapply,&cycles,&flg);CHKERRQ(ierr);
388f3fbd535SBarry Smith       if (flg) {
389f3fbd535SBarry Smith 	ierr = PCMGMultiplicativeSetCycles(pc,cycles);CHKERRQ(ierr);
390f3fbd535SBarry Smith       }
391f3fbd535SBarry Smith     }
392f3fbd535SBarry Smith     flg  = PETSC_FALSE;
393acfcf0e5SJed Brown     ierr = PetscOptionsBool("-pc_mg_log","Log times for each multigrid level","None",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
394f3fbd535SBarry Smith     if (flg) {
395f3fbd535SBarry Smith       PetscInt i;
396f3fbd535SBarry Smith       char     eventname[128];
39763e6d426SJed Brown       if (!mglevels) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Must set MG levels before calling");
398f3fbd535SBarry Smith       levels = mglevels[0]->levels;
399f3fbd535SBarry Smith       for (i=0; i<levels; i++) {
400f3fbd535SBarry Smith         sprintf(eventname,"MGSetup Level %d",(int)i);
40163e6d426SJed Brown         ierr = PetscLogEventRegister(eventname,((PetscObject)pc)->classid,&mglevels[i]->eventsmoothsetup);CHKERRQ(ierr);
402f3fbd535SBarry Smith         sprintf(eventname,"MGSmooth Level %d",(int)i);
40363e6d426SJed Brown         ierr = PetscLogEventRegister(eventname,((PetscObject)pc)->classid,&mglevels[i]->eventsmoothsolve);CHKERRQ(ierr);
404f3fbd535SBarry Smith         if (i) {
405f3fbd535SBarry Smith           sprintf(eventname,"MGResid Level %d",(int)i);
40663e6d426SJed Brown           ierr = PetscLogEventRegister(eventname,((PetscObject)pc)->classid,&mglevels[i]->eventresidual);CHKERRQ(ierr);
407f3fbd535SBarry Smith           sprintf(eventname,"MGInterp Level %d",(int)i);
40863e6d426SJed Brown           ierr = PetscLogEventRegister(eventname,((PetscObject)pc)->classid,&mglevels[i]->eventinterprestrict);CHKERRQ(ierr);
409f3fbd535SBarry Smith         }
410f3fbd535SBarry Smith       }
411f3fbd535SBarry Smith     }
412f3fbd535SBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
413f3fbd535SBarry Smith   PetscFunctionReturn(0);
414f3fbd535SBarry Smith }
415f3fbd535SBarry Smith 
416f3fbd535SBarry Smith const char *PCMGTypes[] = {"MULTIPLICATIVE","ADDITIVE","FULL","KASKADE","PCMGType","PC_MG",0};
417f3fbd535SBarry Smith const char *PCMGCycleTypes[] = {"invalid","v","w","PCMGCycleType","PC_MG_CYCLE",0};
418f3fbd535SBarry Smith 
419f3fbd535SBarry Smith #undef __FUNCT__
420f3fbd535SBarry Smith #define __FUNCT__ "PCView_MG"
421f3fbd535SBarry Smith PetscErrorCode PCView_MG(PC pc,PetscViewer viewer)
422f3fbd535SBarry Smith {
423f3fbd535SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
424f3fbd535SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
425f3fbd535SBarry Smith   PetscErrorCode ierr;
426f3fbd535SBarry Smith   PetscInt       levels = mglevels[0]->levels,i;
427ace3abfcSBarry Smith   PetscBool      iascii;
428f3fbd535SBarry Smith 
429f3fbd535SBarry Smith   PetscFunctionBegin;
4302692d6eeSBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
431f3fbd535SBarry Smith   if (iascii) {
43231567311SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  MG: type is %s, levels=%D cycles=%s\n", PCMGTypes[mg->am],levels,(mglevels[0]->cycles == PC_MG_CYCLE_V) ? "v" : "w");CHKERRQ(ierr);
43331567311SBarry Smith     if (mg->am == PC_MG_MULTIPLICATIVE) {
43431567311SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    Cycles per PCApply=%d\n",mg->cyclesperpcapply);CHKERRQ(ierr);
435f3fbd535SBarry Smith     }
436218a07d4SBarry Smith     if (mg->galerkin) {
437f3fbd535SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    Using Galerkin computed coarse grid matrices\n");CHKERRQ(ierr);
4384f66f45eSBarry Smith     } else {
4394f66f45eSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    Not using Galerkin computed coarse grid matrices\n");CHKERRQ(ierr);
440f3fbd535SBarry Smith     }
441f3fbd535SBarry Smith     for (i=0; i<levels; i++) {
442f3fbd535SBarry Smith       if (!i) {
443*89cce641SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Coarse grid solver -- level -------------------------------\n",i);CHKERRQ(ierr);
444f3fbd535SBarry Smith       } else {
445*89cce641SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Down solver (pre-smoother) on level %D -------------------------------\n",i);CHKERRQ(ierr);
446f3fbd535SBarry Smith       }
447f3fbd535SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
448f3fbd535SBarry Smith       ierr = KSPView(mglevels[i]->smoothd,viewer);CHKERRQ(ierr);
449f3fbd535SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
450f3fbd535SBarry Smith       if (i && mglevels[i]->smoothd == mglevels[i]->smoothu) {
451f3fbd535SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Up solver (post-smoother) same as down solver (pre-smoother)\n");CHKERRQ(ierr);
452f3fbd535SBarry Smith       } else if (i){
453*89cce641SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Up solver (post-smoother) on level %D -------------------------------\n",i);CHKERRQ(ierr);
454f3fbd535SBarry Smith         ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
455f3fbd535SBarry Smith         ierr = KSPView(mglevels[i]->smoothu,viewer);CHKERRQ(ierr);
456f3fbd535SBarry Smith         ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
457f3fbd535SBarry Smith       }
458f3fbd535SBarry Smith     }
459649052a6SBarry Smith   } else SETERRQ1(((PetscObject)pc)->comm,PETSC_ERR_SUP,"Viewer type %s not supported for PCMG",((PetscObject)viewer)->type_name);
460f3fbd535SBarry Smith   PetscFunctionReturn(0);
461f3fbd535SBarry Smith }
462f3fbd535SBarry Smith 
463cab2e9ccSBarry Smith #include <private/dmimpl.h>
464cab2e9ccSBarry Smith #include <private/kspimpl.h>
465cab2e9ccSBarry Smith 
466f3fbd535SBarry Smith /*
467f3fbd535SBarry Smith     Calls setup for the KSP on each level
468f3fbd535SBarry Smith */
469f3fbd535SBarry Smith #undef __FUNCT__
470f3fbd535SBarry Smith #define __FUNCT__ "PCSetUp_MG"
471f3fbd535SBarry Smith PetscErrorCode PCSetUp_MG(PC pc)
472f3fbd535SBarry Smith {
473f3fbd535SBarry Smith   PC_MG                   *mg = (PC_MG*)pc->data;
474f3fbd535SBarry Smith   PC_MG_Levels            **mglevels = mg->levels;
475f3fbd535SBarry Smith   PetscErrorCode          ierr;
476f3fbd535SBarry Smith   PetscInt                i,n = mglevels[0]->levels;
477f3fbd535SBarry Smith   PC                      cpc,mpc;
478649052a6SBarry Smith   PetscBool               preonly,lu,redundant,cholesky,svd,dump = PETSC_FALSE,opsset;
479f3fbd535SBarry Smith   Mat                     dA,dB;
480f3fbd535SBarry Smith   MatStructure            uflag;
481f3fbd535SBarry Smith   Vec                     tvec;
482218a07d4SBarry Smith   DM                      *dms;
483649052a6SBarry Smith   PetscViewer             viewer = 0;
484f3fbd535SBarry Smith 
485f3fbd535SBarry Smith   PetscFunctionBegin;
4863aeaf226SBarry Smith   if (mg->usedmfornumberoflevels) {
4873aeaf226SBarry Smith     PetscInt levels;
4883aeaf226SBarry Smith     ierr = DMGetRefineLevel(pc->dm,&levels);CHKERRQ(ierr);
4893aeaf226SBarry Smith     levels++;
4903aeaf226SBarry Smith     if (levels > n) { /* the problem is now being solved on a finer grid */
4913aeaf226SBarry Smith       ierr = PCMGSetLevels(pc,levels,PETSC_NULL);CHKERRQ(ierr);
4923aeaf226SBarry Smith       n    = levels;
4933aeaf226SBarry Smith       ierr = PCSetFromOptions(pc);CHKERRQ(ierr);  /* it is bad to call this here, but otherwise will never be called for the new hierarchy */
4943aeaf226SBarry Smith       mglevels =  mg->levels;
4953aeaf226SBarry Smith     }
4963aeaf226SBarry Smith   }
4973aeaf226SBarry Smith 
498f3fbd535SBarry Smith 
499f3fbd535SBarry Smith   /* If user did not provide fine grid operators OR operator was not updated since last global KSPSetOperators() */
500f3fbd535SBarry Smith   /* so use those from global PC */
501f3fbd535SBarry Smith   /* Is this what we always want? What if user wants to keep old one? */
502f3fbd535SBarry Smith   ierr = KSPGetOperatorsSet(mglevels[n-1]->smoothd,PETSC_NULL,&opsset);CHKERRQ(ierr);
503f3fbd535SBarry Smith   ierr = KSPGetPC(mglevels[0]->smoothd,&cpc);CHKERRQ(ierr);
504f3fbd535SBarry Smith   ierr = KSPGetPC(mglevels[n-1]->smoothd,&mpc);CHKERRQ(ierr);
5051338a6b9SJed Brown   if (!opsset || ((cpc->setupcalled == 1) && (mpc->setupcalled == 2)) || ((mpc == cpc) && (mpc->setupcalled == 2))) {
506f3fbd535SBarry Smith     ierr = PetscInfo(pc,"Using outer operators to define finest grid operator \n  because PCMGGetSmoother(pc,nlevels-1,&ksp);KSPSetOperators(ksp,...); was not called.\n");CHKERRQ(ierr);
507f3fbd535SBarry Smith     ierr = KSPSetOperators(mglevels[n-1]->smoothd,pc->mat,pc->pmat,pc->flag);CHKERRQ(ierr);
508f3fbd535SBarry Smith   }
509f3fbd535SBarry Smith 
5102d2b81a6SBarry Smith   if (pc->dm && !pc->setupcalled) {
5112d2b81a6SBarry Smith     /* construct the interpolation from the DMs */
5122e499ae9SBarry Smith     Mat p;
51373250ac0SBarry Smith     Vec rscale;
514218a07d4SBarry Smith     ierr = PetscMalloc(n*sizeof(DM),&dms);CHKERRQ(ierr);
515218a07d4SBarry Smith     dms[n-1] = pc->dm;
516218a07d4SBarry Smith     for (i=n-2; i>-1; i--) {
517218a07d4SBarry Smith       ierr = DMCoarsen(dms[i+1],PETSC_NULL,&dms[i]);CHKERRQ(ierr);
5183c0c59f3SBarry Smith       ierr = KSPSetDM(mglevels[i]->smoothd,dms[i]);CHKERRQ(ierr);
5193c0c59f3SBarry Smith       if (mg->galerkin) {ierr = KSPSetDMActive(mglevels[i]->smoothd,PETSC_FALSE);CHKERRQ(ierr);}
52011629dbeSBarry Smith       ierr = DMSetFunction(dms[i],0);
52111629dbeSBarry Smith       ierr = DMSetInitialGuess(dms[i],0);
52224c3aa18SBarry Smith       if (!mglevels[i+1]->interpolate) {
52373250ac0SBarry Smith 	ierr = DMGetInterpolation(dms[i],dms[i+1],&p,&rscale);CHKERRQ(ierr);
5242d2b81a6SBarry Smith 	ierr = PCMGSetInterpolation(pc,i+1,p);CHKERRQ(ierr);
52500ac8be1SBarry Smith 	if (rscale) {ierr = PCMGSetRScale(pc,i+1,rscale);CHKERRQ(ierr);}
52673250ac0SBarry Smith         ierr = VecDestroy(&rscale);CHKERRQ(ierr);
5276bf464f9SBarry Smith         ierr = MatDestroy(&p);CHKERRQ(ierr);
528218a07d4SBarry Smith       }
52924c3aa18SBarry Smith     }
5302d2b81a6SBarry Smith 
531218a07d4SBarry Smith     for (i=n-2; i>-1; i--) {
5326bf464f9SBarry Smith       ierr = DMDestroy(&dms[i]);CHKERRQ(ierr);
533218a07d4SBarry Smith     }
5342d2b81a6SBarry Smith     ierr = PetscFree(dms);CHKERRQ(ierr);
535cab2e9ccSBarry Smith 
536cab2e9ccSBarry Smith     /* finest smoother also gets DM but it is not active */
537cab2e9ccSBarry Smith     ierr = KSPSetDM(mglevels[n-1]->smoothd,pc->dm);CHKERRQ(ierr);
538cab2e9ccSBarry Smith     ierr = KSPSetDMActive(mglevels[n-1]->smoothd,PETSC_FALSE);CHKERRQ(ierr);
539218a07d4SBarry Smith   }
540218a07d4SBarry Smith 
541218a07d4SBarry Smith   if (mg->galerkin) {
542f3fbd535SBarry Smith     Mat B;
543218a07d4SBarry Smith     mg->galerkinused = PETSC_TRUE;
544f3fbd535SBarry Smith     /* currently only handle case where mat and pmat are the same on coarser levels */
545f3fbd535SBarry Smith     ierr = KSPGetOperators(mglevels[n-1]->smoothd,&dA,&dB,&uflag);CHKERRQ(ierr);
546f3fbd535SBarry Smith     if (!pc->setupcalled) {
547f3fbd535SBarry Smith       for (i=n-2; i>-1; i--) {
548f3fbd535SBarry Smith         ierr = MatPtAP(dB,mglevels[i+1]->interpolate,MAT_INITIAL_MATRIX,1.0,&B);CHKERRQ(ierr);
549f3fbd535SBarry Smith         ierr = KSPSetOperators(mglevels[i]->smoothd,B,B,uflag);CHKERRQ(ierr);
550f3fbd535SBarry Smith 	if (i != n-2) {ierr = PetscObjectDereference((PetscObject)dB);CHKERRQ(ierr);}
551f3fbd535SBarry Smith         dB   = B;
552f3fbd535SBarry Smith       }
553cd9507b2SBarry Smith       if (n > 1) {ierr = PetscObjectDereference((PetscObject)dB);CHKERRQ(ierr);}
554f3fbd535SBarry Smith     } else {
555f3fbd535SBarry Smith       for (i=n-2; i>-1; i--) {
556f3fbd535SBarry Smith         ierr = KSPGetOperators(mglevels[i]->smoothd,PETSC_NULL,&B,PETSC_NULL);CHKERRQ(ierr);
557f3fbd535SBarry Smith         ierr = MatPtAP(dB,mglevels[i+1]->interpolate,MAT_REUSE_MATRIX,1.0,&B);CHKERRQ(ierr);
558f3fbd535SBarry Smith         ierr = KSPSetOperators(mglevels[i]->smoothd,B,B,uflag);CHKERRQ(ierr);
559f3fbd535SBarry Smith         dB   = B;
560f3fbd535SBarry Smith       }
561f3fbd535SBarry Smith     }
562cab2e9ccSBarry Smith   } else if (pc->dm && pc->dm->x) {
563cab2e9ccSBarry Smith     /* need to restrict Jacobian location to coarser meshes for evaluation */
564cab2e9ccSBarry Smith     for (i=n-2;i>-1; i--) {
565cab2e9ccSBarry Smith       if (!mglevels[i]->smoothd->dm->x) {
566cab2e9ccSBarry Smith         Vec *vecs;
567cab2e9ccSBarry Smith         ierr = KSPGetVecs(mglevels[i]->smoothd,1,&vecs,0,PETSC_NULL);CHKERRQ(ierr);
568cab2e9ccSBarry Smith         mglevels[i]->smoothd->dm->x = vecs[0];
569cab2e9ccSBarry Smith         ierr = PetscFree(vecs);CHKERRQ(ierr);
570cab2e9ccSBarry Smith       }
571cab2e9ccSBarry Smith       ierr = MatRestrict(mglevels[i+1]->interpolate,mglevels[i+1]->smoothd->dm->x,mglevels[i]->smoothd->dm->x);CHKERRQ(ierr);
57273250ac0SBarry Smith       ierr = VecPointwiseMult(mglevels[i]->smoothd->dm->x,mglevels[i]->smoothd->dm->x,mglevels[i+1]->rscale);CHKERRQ(ierr);
573cab2e9ccSBarry Smith     }
574f3fbd535SBarry Smith   }
575f3fbd535SBarry Smith 
576f3fbd535SBarry Smith   if (!pc->setupcalled) {
577f3fbd535SBarry Smith     for (i=0; i<n; i++) {
578f3fbd535SBarry Smith       ierr = KSPSetFromOptions(mglevels[i]->smoothd);CHKERRQ(ierr);
579f3fbd535SBarry Smith     }
580f3fbd535SBarry Smith     for (i=1; i<n; i++) {
581f3fbd535SBarry Smith       if (mglevels[i]->smoothu && (mglevels[i]->smoothu != mglevels[i]->smoothd)) {
582f3fbd535SBarry Smith         ierr = KSPSetFromOptions(mglevels[i]->smoothu);CHKERRQ(ierr);
583f3fbd535SBarry Smith       }
584f3fbd535SBarry Smith     }
585f3fbd535SBarry Smith     for (i=1; i<n; i++) {
586f3fbd535SBarry Smith       if (mglevels[i]->restrct && !mglevels[i]->interpolate) {
587f3fbd535SBarry Smith         ierr = PCMGSetInterpolation(pc,i,mglevels[i]->restrct);CHKERRQ(ierr);
588f3fbd535SBarry Smith       }
589f3fbd535SBarry Smith       if (!mglevels[i]->restrct && mglevels[i]->interpolate) {
590f3fbd535SBarry Smith         ierr = PCMGSetRestriction(pc,i,mglevels[i]->interpolate);CHKERRQ(ierr);
591f3fbd535SBarry Smith       }
592f3fbd535SBarry Smith #if defined(PETSC_USE_DEBUG)
593f3fbd535SBarry Smith       if (!mglevels[i]->restrct || !mglevels[i]->interpolate) {
59465e19b50SBarry Smith         SETERRQ1(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Need to set restriction or interpolation on level %d",(int)i);
595f3fbd535SBarry Smith       }
596f3fbd535SBarry Smith #endif
597f3fbd535SBarry Smith     }
598f3fbd535SBarry Smith     for (i=0; i<n-1; i++) {
599f3fbd535SBarry Smith       if (!mglevels[i]->b) {
600f3fbd535SBarry Smith         Vec *vec;
601f3fbd535SBarry Smith         ierr = KSPGetVecs(mglevels[i]->smoothd,1,&vec,0,PETSC_NULL);CHKERRQ(ierr);
602f3fbd535SBarry Smith         ierr = PCMGSetRhs(pc,i,*vec);CHKERRQ(ierr);
6036bf464f9SBarry Smith         ierr = VecDestroy(vec);CHKERRQ(ierr);
604f3fbd535SBarry Smith         ierr = PetscFree(vec);CHKERRQ(ierr);
605f3fbd535SBarry Smith       }
606f3fbd535SBarry Smith       if (!mglevels[i]->r && i) {
607f3fbd535SBarry Smith         ierr = VecDuplicate(mglevels[i]->b,&tvec);CHKERRQ(ierr);
608f3fbd535SBarry Smith         ierr = PCMGSetR(pc,i,tvec);CHKERRQ(ierr);
6096bf464f9SBarry Smith         ierr = VecDestroy(&tvec);CHKERRQ(ierr);
610f3fbd535SBarry Smith       }
611f3fbd535SBarry Smith       if (!mglevels[i]->x) {
612f3fbd535SBarry Smith         ierr = VecDuplicate(mglevels[i]->b,&tvec);CHKERRQ(ierr);
613f3fbd535SBarry Smith         ierr = PCMGSetX(pc,i,tvec);CHKERRQ(ierr);
6146bf464f9SBarry Smith         ierr = VecDestroy(&tvec);CHKERRQ(ierr);
615f3fbd535SBarry Smith       }
616f3fbd535SBarry Smith     }
617f3fbd535SBarry Smith     if (n != 1 && !mglevels[n-1]->r) {
618f3fbd535SBarry Smith       /* PCMGSetR() on the finest level if user did not supply it */
619f3fbd535SBarry Smith       Vec *vec;
620f3fbd535SBarry Smith       ierr = KSPGetVecs(mglevels[n-1]->smoothd,1,&vec,0,PETSC_NULL);CHKERRQ(ierr);
621f3fbd535SBarry Smith       ierr = PCMGSetR(pc,n-1,*vec);CHKERRQ(ierr);
6226bf464f9SBarry Smith       ierr = VecDestroy(vec);CHKERRQ(ierr);
623f3fbd535SBarry Smith       ierr = PetscFree(vec);CHKERRQ(ierr);
624f3fbd535SBarry Smith     }
625f3fbd535SBarry Smith   }
626f3fbd535SBarry Smith 
627f3fbd535SBarry Smith 
628f3fbd535SBarry Smith   for (i=1; i<n; i++) {
629f3fbd535SBarry Smith     if (mglevels[i]->smoothu == mglevels[i]->smoothd) {
630f3fbd535SBarry Smith       /* if doing only down then initial guess is zero */
631f3fbd535SBarry Smith       ierr = KSPSetInitialGuessNonzero(mglevels[i]->smoothd,PETSC_TRUE);CHKERRQ(ierr);
632f3fbd535SBarry Smith     }
63363e6d426SJed Brown     if (mglevels[i]->eventsmoothsetup) {ierr = PetscLogEventBegin(mglevels[i]->eventsmoothsetup,0,0,0,0);CHKERRQ(ierr);}
634f3fbd535SBarry Smith     ierr = KSPSetUp(mglevels[i]->smoothd);CHKERRQ(ierr);
63563e6d426SJed Brown     if (mglevels[i]->eventsmoothsetup) {ierr = PetscLogEventEnd(mglevels[i]->eventsmoothsetup,0,0,0,0);CHKERRQ(ierr);}
636d42688cbSBarry Smith     if (!mglevels[i]->residual) {
637d42688cbSBarry Smith       Mat mat;
638d42688cbSBarry Smith       ierr = KSPGetOperators(mglevels[i]->smoothd,PETSC_NULL,&mat,PETSC_NULL);CHKERRQ(ierr);
639d42688cbSBarry Smith       ierr = PCMGSetResidual(pc,i,PCMGDefaultResidual,mat);CHKERRQ(ierr);
640d42688cbSBarry Smith     }
641f3fbd535SBarry Smith   }
642f3fbd535SBarry Smith   for (i=1; i<n; i++) {
643f3fbd535SBarry Smith     if (mglevels[i]->smoothu && mglevels[i]->smoothu != mglevels[i]->smoothd) {
644f3fbd535SBarry Smith       Mat          downmat,downpmat;
645f3fbd535SBarry Smith       MatStructure matflag;
646ace3abfcSBarry Smith       PetscBool    opsset;
647f3fbd535SBarry Smith 
648f3fbd535SBarry Smith       /* check if operators have been set for up, if not use down operators to set them */
649f3fbd535SBarry Smith       ierr = KSPGetOperatorsSet(mglevels[i]->smoothu,&opsset,PETSC_NULL);CHKERRQ(ierr);
650f3fbd535SBarry Smith       if (!opsset) {
651f3fbd535SBarry Smith         ierr = KSPGetOperators(mglevels[i]->smoothd,&downmat,&downpmat,&matflag);CHKERRQ(ierr);
652f3fbd535SBarry Smith         ierr = KSPSetOperators(mglevels[i]->smoothu,downmat,downpmat,matflag);CHKERRQ(ierr);
653f3fbd535SBarry Smith       }
654f3fbd535SBarry Smith 
655f3fbd535SBarry Smith       ierr = KSPSetInitialGuessNonzero(mglevels[i]->smoothu,PETSC_TRUE);CHKERRQ(ierr);
65663e6d426SJed Brown       if (mglevels[i]->eventsmoothsetup) {ierr = PetscLogEventBegin(mglevels[i]->eventsmoothsetup,0,0,0,0);CHKERRQ(ierr);}
657f3fbd535SBarry Smith       ierr = KSPSetUp(mglevels[i]->smoothu);CHKERRQ(ierr);
65863e6d426SJed Brown       if (mglevels[i]->eventsmoothsetup) {ierr = PetscLogEventEnd(mglevels[i]->eventsmoothsetup,0,0,0,0);CHKERRQ(ierr);}
659f3fbd535SBarry Smith     }
660f3fbd535SBarry Smith   }
661f3fbd535SBarry Smith 
662f3fbd535SBarry Smith   /*
663f3fbd535SBarry Smith       If coarse solver is not direct method then DO NOT USE preonly
664f3fbd535SBarry Smith   */
665f3fbd535SBarry Smith   ierr = PetscTypeCompare((PetscObject)mglevels[0]->smoothd,KSPPREONLY,&preonly);CHKERRQ(ierr);
666f3fbd535SBarry Smith   if (preonly) {
667f3fbd535SBarry Smith     ierr = PetscTypeCompare((PetscObject)cpc,PCLU,&lu);CHKERRQ(ierr);
668f3fbd535SBarry Smith     ierr = PetscTypeCompare((PetscObject)cpc,PCREDUNDANT,&redundant);CHKERRQ(ierr);
669f3fbd535SBarry Smith     ierr = PetscTypeCompare((PetscObject)cpc,PCCHOLESKY,&cholesky);CHKERRQ(ierr);
670fd1303e9SJungho Lee     ierr = PetscTypeCompare((PetscObject)cpc,PCSVD,&svd);CHKERRQ(ierr);
671fd1303e9SJungho Lee     if (!lu && !redundant && !cholesky && !svd) {
672f3fbd535SBarry Smith       ierr = KSPSetType(mglevels[0]->smoothd,KSPGMRES);CHKERRQ(ierr);
673f3fbd535SBarry Smith     }
674f3fbd535SBarry Smith   }
675f3fbd535SBarry Smith 
676f3fbd535SBarry Smith   if (!pc->setupcalled) {
677f3fbd535SBarry Smith     ierr = KSPSetFromOptions(mglevels[0]->smoothd);CHKERRQ(ierr);
678f3fbd535SBarry Smith   }
679f3fbd535SBarry Smith 
68063e6d426SJed Brown   if (mglevels[0]->eventsmoothsetup) {ierr = PetscLogEventBegin(mglevels[0]->eventsmoothsetup,0,0,0,0);CHKERRQ(ierr);}
681f3fbd535SBarry Smith   ierr = KSPSetUp(mglevels[0]->smoothd);CHKERRQ(ierr);
68263e6d426SJed Brown   if (mglevels[0]->eventsmoothsetup) {ierr = PetscLogEventEnd(mglevels[0]->eventsmoothsetup,0,0,0,0);CHKERRQ(ierr);}
683f3fbd535SBarry Smith 
684f3fbd535SBarry Smith   /*
685f3fbd535SBarry Smith      Dump the interpolation/restriction matrices plus the
686e3c5b3baSBarry Smith    Jacobian/stiffness on each level. This allows MATLAB users to
687f3fbd535SBarry Smith    easily check if the Galerkin condition A_c = R A_f R^T is satisfied.
688f3fbd535SBarry Smith 
689f3fbd535SBarry Smith    Only support one or the other at the same time.
690f3fbd535SBarry Smith   */
691f3fbd535SBarry Smith #if defined(PETSC_USE_SOCKET_VIEWER)
692acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_mg_dump_matlab",&dump,PETSC_NULL);CHKERRQ(ierr);
693f3fbd535SBarry Smith   if (dump) {
694f3fbd535SBarry Smith     viewer = PETSC_VIEWER_SOCKET_(((PetscObject)pc)->comm);
695f3fbd535SBarry Smith   }
696f3fbd535SBarry Smith   dump = PETSC_FALSE;
697f3fbd535SBarry Smith #endif
698acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_mg_dump_binary",&dump,PETSC_NULL);CHKERRQ(ierr);
699f3fbd535SBarry Smith   if (dump) {
700f3fbd535SBarry Smith     viewer = PETSC_VIEWER_BINARY_(((PetscObject)pc)->comm);
701f3fbd535SBarry Smith   }
702f3fbd535SBarry Smith 
703f3fbd535SBarry Smith   if (viewer) {
704f3fbd535SBarry Smith     for (i=1; i<n; i++) {
705f3fbd535SBarry Smith       ierr = MatView(mglevels[i]->restrct,viewer);CHKERRQ(ierr);
706f3fbd535SBarry Smith     }
707f3fbd535SBarry Smith     for (i=0; i<n; i++) {
708f3fbd535SBarry Smith       ierr = KSPGetPC(mglevels[i]->smoothd,&pc);CHKERRQ(ierr);
709f3fbd535SBarry Smith       ierr = MatView(pc->mat,viewer);CHKERRQ(ierr);
710f3fbd535SBarry Smith     }
711f3fbd535SBarry Smith   }
712f3fbd535SBarry Smith   PetscFunctionReturn(0);
713f3fbd535SBarry Smith }
714f3fbd535SBarry Smith 
715f3fbd535SBarry Smith /* -------------------------------------------------------------------------------------*/
716f3fbd535SBarry Smith 
717f3fbd535SBarry Smith #undef __FUNCT__
7189dcbbd2bSBarry Smith #define __FUNCT__ "PCMGGetLevels"
7194b9ad928SBarry Smith /*@
72097177400SBarry Smith    PCMGGetLevels - Gets the number of levels to use with MG.
7214b9ad928SBarry Smith 
7224b9ad928SBarry Smith    Not Collective
7234b9ad928SBarry Smith 
7244b9ad928SBarry Smith    Input Parameter:
7254b9ad928SBarry Smith .  pc - the preconditioner context
7264b9ad928SBarry Smith 
7274b9ad928SBarry Smith    Output parameter:
7284b9ad928SBarry Smith .  levels - the number of levels
7294b9ad928SBarry Smith 
7304b9ad928SBarry Smith    Level: advanced
7314b9ad928SBarry Smith 
7324b9ad928SBarry Smith .keywords: MG, get, levels, multigrid
7334b9ad928SBarry Smith 
73497177400SBarry Smith .seealso: PCMGSetLevels()
7354b9ad928SBarry Smith @*/
7367087cfbeSBarry Smith PetscErrorCode  PCMGGetLevels(PC pc,PetscInt *levels)
7374b9ad928SBarry Smith {
738f3fbd535SBarry Smith   PC_MG *mg = (PC_MG*)pc->data;
7394b9ad928SBarry Smith 
7404b9ad928SBarry Smith   PetscFunctionBegin;
7410700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
7424482741eSBarry Smith   PetscValidIntPointer(levels,2);
743f3fbd535SBarry Smith   *levels = mg->nlevels;
7444b9ad928SBarry Smith   PetscFunctionReturn(0);
7454b9ad928SBarry Smith }
7464b9ad928SBarry Smith 
7474b9ad928SBarry Smith #undef __FUNCT__
7489dcbbd2bSBarry Smith #define __FUNCT__ "PCMGSetType"
7494b9ad928SBarry Smith /*@
75097177400SBarry Smith    PCMGSetType - Determines the form of multigrid to use:
7514b9ad928SBarry Smith    multiplicative, additive, full, or the Kaskade algorithm.
7524b9ad928SBarry Smith 
753ad4df100SBarry Smith    Logically Collective on PC
7544b9ad928SBarry Smith 
7554b9ad928SBarry Smith    Input Parameters:
7564b9ad928SBarry Smith +  pc - the preconditioner context
7579dcbbd2bSBarry Smith -  form - multigrid form, one of PC_MG_MULTIPLICATIVE, PC_MG_ADDITIVE,
7589dcbbd2bSBarry Smith    PC_MG_FULL, PC_MG_KASKADE
7594b9ad928SBarry Smith 
7604b9ad928SBarry Smith    Options Database Key:
7614b9ad928SBarry Smith .  -pc_mg_type <form> - Sets <form>, one of multiplicative,
7624b9ad928SBarry Smith    additive, full, kaskade
7634b9ad928SBarry Smith 
7644b9ad928SBarry Smith    Level: advanced
7654b9ad928SBarry Smith 
7664b9ad928SBarry Smith .keywords: MG, set, method, multiplicative, additive, full, Kaskade, multigrid
7674b9ad928SBarry Smith 
76897177400SBarry Smith .seealso: PCMGSetLevels()
7694b9ad928SBarry Smith @*/
7707087cfbeSBarry Smith PetscErrorCode  PCMGSetType(PC pc,PCMGType form)
7714b9ad928SBarry Smith {
772f3fbd535SBarry Smith   PC_MG                   *mg = (PC_MG*)pc->data;
7734b9ad928SBarry Smith 
7744b9ad928SBarry Smith   PetscFunctionBegin;
7750700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
776c5eb9154SBarry Smith   PetscValidLogicalCollectiveEnum(pc,form,2);
77731567311SBarry Smith   mg->am = form;
7789dcbbd2bSBarry Smith   if (form == PC_MG_MULTIPLICATIVE) pc->ops->applyrichardson = PCApplyRichardson_MG;
7794b9ad928SBarry Smith   else pc->ops->applyrichardson = 0;
7804b9ad928SBarry Smith   PetscFunctionReturn(0);
7814b9ad928SBarry Smith }
7824b9ad928SBarry Smith 
7834b9ad928SBarry Smith #undef __FUNCT__
7840d353602SBarry Smith #define __FUNCT__ "PCMGSetCycleType"
7854b9ad928SBarry Smith /*@
7860d353602SBarry Smith    PCMGSetCycleType - Sets the type cycles to use.  Use PCMGSetCycleTypeOnLevel() for more
7874b9ad928SBarry Smith    complicated cycling.
7884b9ad928SBarry Smith 
789ad4df100SBarry Smith    Logically Collective on PC
7904b9ad928SBarry Smith 
7914b9ad928SBarry Smith    Input Parameters:
792c2be2410SBarry Smith +  pc - the multigrid context
7930d353602SBarry Smith -  PC_MG_CYCLE_V or PC_MG_CYCLE_W
7944b9ad928SBarry Smith 
7954b9ad928SBarry Smith    Options Database Key:
7960d353602SBarry Smith $  -pc_mg_cycle_type v or w
7974b9ad928SBarry Smith 
7984b9ad928SBarry Smith    Level: advanced
7994b9ad928SBarry Smith 
8004b9ad928SBarry Smith .keywords: MG, set, cycles, V-cycle, W-cycle, multigrid
8014b9ad928SBarry Smith 
8020d353602SBarry Smith .seealso: PCMGSetCycleTypeOnLevel()
8034b9ad928SBarry Smith @*/
8047087cfbeSBarry Smith PetscErrorCode  PCMGSetCycleType(PC pc,PCMGCycleType n)
8054b9ad928SBarry Smith {
806f3fbd535SBarry Smith   PC_MG        *mg = (PC_MG*)pc->data;
807f3fbd535SBarry Smith   PC_MG_Levels **mglevels = mg->levels;
80879416396SBarry Smith   PetscInt     i,levels;
8094b9ad928SBarry Smith 
8104b9ad928SBarry Smith   PetscFunctionBegin;
8110700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
812e7e72b3dSBarry Smith   if (!mglevels) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Must set MG levels before calling");
813c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,n,2);
814f3fbd535SBarry Smith   levels = mglevels[0]->levels;
8154b9ad928SBarry Smith 
8164b9ad928SBarry Smith   for (i=0; i<levels; i++) {
817f3fbd535SBarry Smith     mglevels[i]->cycles  = n;
8184b9ad928SBarry Smith   }
8194b9ad928SBarry Smith   PetscFunctionReturn(0);
8204b9ad928SBarry Smith }
8214b9ad928SBarry Smith 
8224b9ad928SBarry Smith #undef __FUNCT__
8238cc2d5dfSBarry Smith #define __FUNCT__ "PCMGMultiplicativeSetCycles"
8248cc2d5dfSBarry Smith /*@
8258cc2d5dfSBarry Smith    PCMGMultiplicativeSetCycles - Sets the number of cycles to use for each preconditioner step
8268cc2d5dfSBarry Smith          of multigrid when PCMGType of PC_MG_MULTIPLICATIVE is used
8278cc2d5dfSBarry Smith 
828ad4df100SBarry Smith    Logically Collective on PC
8298cc2d5dfSBarry Smith 
8308cc2d5dfSBarry Smith    Input Parameters:
8318cc2d5dfSBarry Smith +  pc - the multigrid context
8328cc2d5dfSBarry Smith -  n - number of cycles (default is 1)
8338cc2d5dfSBarry Smith 
8348cc2d5dfSBarry Smith    Options Database Key:
8358cc2d5dfSBarry Smith $  -pc_mg_multiplicative_cycles n
8368cc2d5dfSBarry Smith 
8378cc2d5dfSBarry Smith    Level: advanced
8388cc2d5dfSBarry Smith 
8398cc2d5dfSBarry Smith    Notes: This is not associated with setting a v or w cycle, that is set with PCMGSetCycleType()
8408cc2d5dfSBarry Smith 
8418cc2d5dfSBarry Smith .keywords: MG, set, cycles, V-cycle, W-cycle, multigrid
8428cc2d5dfSBarry Smith 
8438cc2d5dfSBarry Smith .seealso: PCMGSetCycleTypeOnLevel(), PCMGSetCycleType()
8448cc2d5dfSBarry Smith @*/
8457087cfbeSBarry Smith PetscErrorCode  PCMGMultiplicativeSetCycles(PC pc,PetscInt n)
8468cc2d5dfSBarry Smith {
847f3fbd535SBarry Smith   PC_MG        *mg = (PC_MG*)pc->data;
848f3fbd535SBarry Smith   PC_MG_Levels **mglevels = mg->levels;
8498cc2d5dfSBarry Smith   PetscInt     i,levels;
8508cc2d5dfSBarry Smith 
8518cc2d5dfSBarry Smith   PetscFunctionBegin;
8520700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
853e7e72b3dSBarry Smith   if (!mglevels) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Must set MG levels before calling");
854c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,n,2);
855f3fbd535SBarry Smith   levels = mglevels[0]->levels;
8568cc2d5dfSBarry Smith 
8578cc2d5dfSBarry Smith   for (i=0; i<levels; i++) {
85831567311SBarry Smith     mg->cyclesperpcapply  = n;
8598cc2d5dfSBarry Smith   }
8608cc2d5dfSBarry Smith   PetscFunctionReturn(0);
8618cc2d5dfSBarry Smith }
8628cc2d5dfSBarry Smith 
8638cc2d5dfSBarry Smith #undef __FUNCT__
8649dcbbd2bSBarry Smith #define __FUNCT__ "PCMGSetGalerkin"
865c2be2410SBarry Smith /*@
86697177400SBarry Smith    PCMGSetGalerkin - Causes the coarser grid matrices to be computed from the
867c2be2410SBarry Smith       finest grid via the Galerkin process: A_i-1 = r_i * A_i * r_i^t
868c2be2410SBarry Smith 
869ad4df100SBarry Smith    Logically Collective on PC
870c2be2410SBarry Smith 
871c2be2410SBarry Smith    Input Parameters:
8723fc8bf9cSBarry Smith .  pc - the multigrid context
873c2be2410SBarry Smith 
874c2be2410SBarry Smith    Options Database Key:
875c2be2410SBarry Smith $  -pc_mg_galerkin
876c2be2410SBarry Smith 
877c2be2410SBarry Smith    Level: intermediate
878c2be2410SBarry Smith 
879c2be2410SBarry Smith .keywords: MG, set, Galerkin
880c2be2410SBarry Smith 
8813fc8bf9cSBarry Smith .seealso: PCMGGetGalerkin()
8823fc8bf9cSBarry Smith 
883c2be2410SBarry Smith @*/
8847087cfbeSBarry Smith PetscErrorCode  PCMGSetGalerkin(PC pc)
885c2be2410SBarry Smith {
886f3fbd535SBarry Smith   PC_MG        *mg = (PC_MG*)pc->data;
887c2be2410SBarry Smith 
888c2be2410SBarry Smith   PetscFunctionBegin;
8890700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
890218a07d4SBarry Smith   mg->galerkin = PETSC_TRUE;
891c2be2410SBarry Smith   PetscFunctionReturn(0);
892c2be2410SBarry Smith }
893c2be2410SBarry Smith 
894c2be2410SBarry Smith #undef __FUNCT__
8953fc8bf9cSBarry Smith #define __FUNCT__ "PCMGGetGalerkin"
8963fc8bf9cSBarry Smith /*@
8973fc8bf9cSBarry Smith    PCMGGetGalerkin - Checks if Galerkin multigrid is being used, i.e.
8983fc8bf9cSBarry Smith       A_i-1 = r_i * A_i * r_i^t
8993fc8bf9cSBarry Smith 
9003fc8bf9cSBarry Smith    Not Collective
9013fc8bf9cSBarry Smith 
9023fc8bf9cSBarry Smith    Input Parameter:
9033fc8bf9cSBarry Smith .  pc - the multigrid context
9043fc8bf9cSBarry Smith 
9053fc8bf9cSBarry Smith    Output Parameter:
9063fc8bf9cSBarry Smith .  gelerkin - PETSC_TRUE or PETSC_FALSE
9073fc8bf9cSBarry Smith 
9083fc8bf9cSBarry Smith    Options Database Key:
9093fc8bf9cSBarry Smith $  -pc_mg_galerkin
9103fc8bf9cSBarry Smith 
9113fc8bf9cSBarry Smith    Level: intermediate
9123fc8bf9cSBarry Smith 
9133fc8bf9cSBarry Smith .keywords: MG, set, Galerkin
9143fc8bf9cSBarry Smith 
9153fc8bf9cSBarry Smith .seealso: PCMGSetGalerkin()
9163fc8bf9cSBarry Smith 
9173fc8bf9cSBarry Smith @*/
9187087cfbeSBarry Smith PetscErrorCode  PCMGGetGalerkin(PC pc,PetscBool  *galerkin)
9193fc8bf9cSBarry Smith {
920f3fbd535SBarry Smith   PC_MG        *mg = (PC_MG*)pc->data;
9213fc8bf9cSBarry Smith 
9223fc8bf9cSBarry Smith   PetscFunctionBegin;
9230700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
924218a07d4SBarry Smith   *galerkin = mg->galerkin;
9253fc8bf9cSBarry Smith   PetscFunctionReturn(0);
9263fc8bf9cSBarry Smith }
9273fc8bf9cSBarry Smith 
9283fc8bf9cSBarry Smith #undef __FUNCT__
9299dcbbd2bSBarry Smith #define __FUNCT__ "PCMGSetNumberSmoothDown"
9304b9ad928SBarry Smith /*@
93197177400SBarry Smith    PCMGSetNumberSmoothDown - Sets the number of pre-smoothing steps to
93297177400SBarry Smith    use on all levels. Use PCMGGetSmootherDown() to set different
9334b9ad928SBarry Smith    pre-smoothing steps on different levels.
9344b9ad928SBarry Smith 
935ad4df100SBarry Smith    Logically Collective on PC
9364b9ad928SBarry Smith 
9374b9ad928SBarry Smith    Input Parameters:
9384b9ad928SBarry Smith +  mg - the multigrid context
9394b9ad928SBarry Smith -  n - the number of smoothing steps
9404b9ad928SBarry Smith 
9414b9ad928SBarry Smith    Options Database Key:
9424b9ad928SBarry Smith .  -pc_mg_smoothdown <n> - Sets number of pre-smoothing steps
9434b9ad928SBarry Smith 
9444b9ad928SBarry Smith    Level: advanced
9454b9ad928SBarry Smith 
9464b9ad928SBarry Smith .keywords: MG, smooth, down, pre-smoothing, steps, multigrid
9474b9ad928SBarry Smith 
94897177400SBarry Smith .seealso: PCMGSetNumberSmoothUp()
9494b9ad928SBarry Smith @*/
9507087cfbeSBarry Smith PetscErrorCode  PCMGSetNumberSmoothDown(PC pc,PetscInt n)
9514b9ad928SBarry Smith {
952f3fbd535SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
953f3fbd535SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
9546849ba73SBarry Smith   PetscErrorCode ierr;
95579416396SBarry Smith   PetscInt       i,levels;
9564b9ad928SBarry Smith 
9574b9ad928SBarry Smith   PetscFunctionBegin;
9580700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
959e7e72b3dSBarry Smith   if (!mglevels) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Must set MG levels before calling");
960c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,n,2);
961f3fbd535SBarry Smith   levels = mglevels[0]->levels;
9624b9ad928SBarry Smith 
963b05257ddSBarry Smith   for (i=1; i<levels; i++) {
9644b9ad928SBarry Smith     /* make sure smoother up and down are different */
96597177400SBarry Smith     ierr = PCMGGetSmootherUp(pc,i,PETSC_NULL);CHKERRQ(ierr);
966f3fbd535SBarry Smith     ierr = KSPSetTolerances(mglevels[i]->smoothd,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT,n);CHKERRQ(ierr);
96731567311SBarry Smith     mg->default_smoothd = n;
9684b9ad928SBarry Smith   }
9694b9ad928SBarry Smith   PetscFunctionReturn(0);
9704b9ad928SBarry Smith }
9714b9ad928SBarry Smith 
9724b9ad928SBarry Smith #undef __FUNCT__
9739dcbbd2bSBarry Smith #define __FUNCT__ "PCMGSetNumberSmoothUp"
9744b9ad928SBarry Smith /*@
97597177400SBarry Smith    PCMGSetNumberSmoothUp - Sets the number of post-smoothing steps to use
97697177400SBarry Smith    on all levels. Use PCMGGetSmootherUp() to set different numbers of
9774b9ad928SBarry Smith    post-smoothing steps on different levels.
9784b9ad928SBarry Smith 
979ad4df100SBarry Smith    Logically Collective on PC
9804b9ad928SBarry Smith 
9814b9ad928SBarry Smith    Input Parameters:
9824b9ad928SBarry Smith +  mg - the multigrid context
9834b9ad928SBarry Smith -  n - the number of smoothing steps
9844b9ad928SBarry Smith 
9854b9ad928SBarry Smith    Options Database Key:
9864b9ad928SBarry Smith .  -pc_mg_smoothup <n> - Sets number of post-smoothing steps
9874b9ad928SBarry Smith 
9884b9ad928SBarry Smith    Level: advanced
9894b9ad928SBarry Smith 
9904b9ad928SBarry Smith    Note: this does not set a value on the coarsest grid, since we assume that
991a8c7a070SBarry Smith     there is no separate smooth up on the coarsest grid.
9924b9ad928SBarry Smith 
9934b9ad928SBarry Smith .keywords: MG, smooth, up, post-smoothing, steps, multigrid
9944b9ad928SBarry Smith 
99597177400SBarry Smith .seealso: PCMGSetNumberSmoothDown()
9964b9ad928SBarry Smith @*/
9977087cfbeSBarry Smith PetscErrorCode  PCMGSetNumberSmoothUp(PC pc,PetscInt n)
9984b9ad928SBarry Smith {
999f3fbd535SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
1000f3fbd535SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
10016849ba73SBarry Smith   PetscErrorCode ierr;
100279416396SBarry Smith   PetscInt       i,levels;
10034b9ad928SBarry Smith 
10044b9ad928SBarry Smith   PetscFunctionBegin;
10050700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1006e7e72b3dSBarry Smith   if (!mglevels) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Must set MG levels before calling");
1007c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,n,2);
1008f3fbd535SBarry Smith   levels = mglevels[0]->levels;
10094b9ad928SBarry Smith 
10104b9ad928SBarry Smith   for (i=1; i<levels; i++) {
10114b9ad928SBarry Smith     /* make sure smoother up and down are different */
101297177400SBarry Smith     ierr = PCMGGetSmootherUp(pc,i,PETSC_NULL);CHKERRQ(ierr);
1013f3fbd535SBarry Smith     ierr = KSPSetTolerances(mglevels[i]->smoothu,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT,n);CHKERRQ(ierr);
101431567311SBarry Smith     mg->default_smoothu = n;
10154b9ad928SBarry Smith   }
10164b9ad928SBarry Smith   PetscFunctionReturn(0);
10174b9ad928SBarry Smith }
10184b9ad928SBarry Smith 
10194b9ad928SBarry Smith /* ----------------------------------------------------------------------------------------*/
10204b9ad928SBarry Smith 
10213b09bd56SBarry Smith /*MC
1022ccb205f8SBarry Smith    PCMG - Use multigrid preconditioning. This preconditioner requires you provide additional
10233b09bd56SBarry Smith     information about the coarser grid matrices and restriction/interpolation operators.
10243b09bd56SBarry Smith 
10253b09bd56SBarry Smith    Options Database Keys:
10263b09bd56SBarry Smith +  -pc_mg_levels <nlevels> - number of levels including finest
10270d353602SBarry Smith .  -pc_mg_cycles v or w
102879416396SBarry Smith .  -pc_mg_smoothup <n> - number of smoothing steps after interpolation
10293b09bd56SBarry Smith .  -pc_mg_smoothdown <n> - number of smoothing steps before applying restriction operator
10303b09bd56SBarry Smith .  -pc_mg_type <additive,multiplicative,full,cascade> - multiplicative is the default
10313b09bd56SBarry Smith .  -pc_mg_log - log information about time spent on each level of the solver
10323b09bd56SBarry Smith .  -pc_mg_monitor - print information on the multigrid convergence
103368eff7e6SBarry Smith .  -pc_mg_galerkin - use Galerkin process to compute coarser operators
10343b09bd56SBarry Smith -  -pc_mg_dump_matlab - dumps the matrices for each level and the restriction/interpolation matrices
1035e3c5b3baSBarry Smith                         to the Socket viewer for reading from MATLAB.
10363b09bd56SBarry Smith 
103724c3aa18SBarry Smith    Notes: By default this uses GMRES on the fine grid smoother so this should be used with KSPFGMRES or the smoother changed to not use GMRES
10383b09bd56SBarry Smith 
10393b09bd56SBarry Smith    Level: intermediate
10403b09bd56SBarry Smith 
10418f87f92bSBarry Smith    Concepts: multigrid/multilevel
10423b09bd56SBarry Smith 
104324c3aa18SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, PCMGType, PCEXOTIC
10440d353602SBarry Smith            PCMGSetLevels(), PCMGGetLevels(), PCMGSetType(), PCMGSetCycleType(), PCMGSetNumberSmoothDown(),
104597177400SBarry Smith            PCMGSetNumberSmoothUp(), PCMGGetCoarseSolve(), PCMGSetResidual(), PCMGSetInterpolation(),
104697177400SBarry Smith            PCMGSetRestriction(), PCMGGetSmoother(), PCMGGetSmootherUp(), PCMGGetSmootherDown(),
10470d353602SBarry Smith            PCMGSetCycleTypeOnLevel(), PCMGSetRhs(), PCMGSetX(), PCMGSetR()
10483b09bd56SBarry Smith M*/
10493b09bd56SBarry Smith 
10504b9ad928SBarry Smith EXTERN_C_BEGIN
10514b9ad928SBarry Smith #undef __FUNCT__
10524b9ad928SBarry Smith #define __FUNCT__ "PCCreate_MG"
10537087cfbeSBarry Smith PetscErrorCode  PCCreate_MG(PC pc)
10544b9ad928SBarry Smith {
1055f3fbd535SBarry Smith   PC_MG          *mg;
1056f3fbd535SBarry Smith   PetscErrorCode ierr;
1057f3fbd535SBarry Smith 
10584b9ad928SBarry Smith   PetscFunctionBegin;
1059f3fbd535SBarry Smith   ierr        = PetscNewLog(pc,PC_MG,&mg);CHKERRQ(ierr);
1060f3fbd535SBarry Smith   pc->data    = (void*)mg;
1061f3fbd535SBarry Smith   mg->nlevels = -1;
1062f3fbd535SBarry Smith 
10634b9ad928SBarry Smith   pc->ops->apply          = PCApply_MG;
10644b9ad928SBarry Smith   pc->ops->setup          = PCSetUp_MG;
1065a06653b4SBarry Smith   pc->ops->reset          = PCReset_MG;
10664b9ad928SBarry Smith   pc->ops->destroy        = PCDestroy_MG;
10674b9ad928SBarry Smith   pc->ops->setfromoptions = PCSetFromOptions_MG;
10684b9ad928SBarry Smith   pc->ops->view           = PCView_MG;
10694b9ad928SBarry Smith   PetscFunctionReturn(0);
10704b9ad928SBarry Smith }
10714b9ad928SBarry Smith EXTERN_C_END
1072