xref: /petsc/src/ksp/pc/impls/mg/mg.c (revision a06653b4217a6b7095655997faad757ca7c559a5)
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__
1139dcbbd2bSBarry Smith #define __FUNCT__ "PCMGSetLevels"
1144b9ad928SBarry Smith /*@C
11597177400SBarry Smith    PCMGSetLevels - Sets the number of levels to use with MG.
1164b9ad928SBarry Smith    Must be called before any other MG routine.
1174b9ad928SBarry Smith 
118ad4df100SBarry Smith    Logically Collective on PC
1194b9ad928SBarry Smith 
1204b9ad928SBarry Smith    Input Parameters:
1214b9ad928SBarry Smith +  pc - the preconditioner context
1224b9ad928SBarry Smith .  levels - the number of levels
1234b9ad928SBarry Smith -  comms - optional communicators for each level; this is to allow solving the coarser problems
1244b9ad928SBarry Smith            on smaller sets of processors. Use PETSC_NULL_OBJECT for default in Fortran
1254b9ad928SBarry Smith 
1264b9ad928SBarry Smith    Level: intermediate
1274b9ad928SBarry Smith 
1284b9ad928SBarry Smith    Notes:
1294b9ad928SBarry Smith      If the number of levels is one then the multigrid uses the -mg_levels prefix
1304b9ad928SBarry Smith   for setting the level options rather than the -mg_coarse prefix.
1314b9ad928SBarry Smith 
1324b9ad928SBarry Smith .keywords: MG, set, levels, multigrid
1334b9ad928SBarry Smith 
13497177400SBarry Smith .seealso: PCMGSetType(), PCMGGetLevels()
1354b9ad928SBarry Smith @*/
1367087cfbeSBarry Smith PetscErrorCode  PCMGSetLevels(PC pc,PetscInt levels,MPI_Comm *comms)
1374b9ad928SBarry Smith {
138dfbe8321SBarry Smith   PetscErrorCode ierr;
139f3fbd535SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
140f3fbd535SBarry Smith   MPI_Comm       comm = ((PetscObject)pc)->comm;
141f3fbd535SBarry Smith   PC_MG_Levels   **mglevels;
142f3fbd535SBarry Smith   PetscInt       i;
143f3fbd535SBarry Smith   PetscMPIInt    size;
144f3fbd535SBarry Smith   const char     *prefix;
145f3fbd535SBarry Smith   PC             ipc;
1464b9ad928SBarry Smith 
1474b9ad928SBarry Smith   PetscFunctionBegin;
1480700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
149e7e72b3dSBarry Smith   if (mg->nlevels > -1) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ORDER,"Number levels already set for MG\n  make sure that you call PCMGSetLevels() before KSPSetFromOptions()");
150e32f2f54SBarry Smith   if (mg->levels) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Internal error in PETSc, this array should not yet exist");
151c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,levels,2);
152f3fbd535SBarry Smith 
153f3fbd535SBarry Smith   mg->nlevels      = levels;
154218a07d4SBarry Smith   mg->galerkin     = PETSC_FALSE;
155218a07d4SBarry Smith   mg->galerkinused = PETSC_FALSE;
156f3fbd535SBarry Smith 
157f3fbd535SBarry Smith   ierr = PetscMalloc(levels*sizeof(PC_MG*),&mglevels);CHKERRQ(ierr);
158f3fbd535SBarry Smith   ierr = PetscLogObjectMemory(pc,levels*(sizeof(PC_MG*)));CHKERRQ(ierr);
159f3fbd535SBarry Smith 
160f3fbd535SBarry Smith   ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
161f3fbd535SBarry Smith 
162f3fbd535SBarry Smith   for (i=0; i<levels; i++) {
163f3fbd535SBarry Smith     ierr = PetscNewLog(pc,PC_MG_Levels,&mglevels[i]);CHKERRQ(ierr);
164f3fbd535SBarry Smith     mglevels[i]->level           = i;
165f3fbd535SBarry Smith     mglevels[i]->levels          = levels;
166f3fbd535SBarry Smith     mglevels[i]->cycles          = PC_MG_CYCLE_V;
16731567311SBarry Smith     mg->default_smoothu = 1;
16831567311SBarry Smith     mg->default_smoothd = 1;
16963e6d426SJed Brown     mglevels[i]->eventsmoothsetup    = 0;
17063e6d426SJed Brown     mglevels[i]->eventsmoothsolve    = 0;
17163e6d426SJed Brown     mglevels[i]->eventresidual       = 0;
17263e6d426SJed Brown     mglevels[i]->eventinterprestrict = 0;
173f3fbd535SBarry Smith 
174f3fbd535SBarry Smith     if (comms) comm = comms[i];
175f3fbd535SBarry Smith     ierr = KSPCreate(comm,&mglevels[i]->smoothd);CHKERRQ(ierr);
176f3fbd535SBarry Smith     ierr = PetscObjectIncrementTabLevel((PetscObject)mglevels[i]->smoothd,(PetscObject)pc,levels-i);CHKERRQ(ierr);
17731567311SBarry Smith     ierr = KSPSetTolerances(mglevels[i]->smoothd,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT, mg->default_smoothd);CHKERRQ(ierr);
178f3fbd535SBarry Smith     ierr = KSPSetOptionsPrefix(mglevels[i]->smoothd,prefix);CHKERRQ(ierr);
179f3fbd535SBarry Smith 
180f3fbd535SBarry Smith     /* do special stuff for coarse grid */
181f3fbd535SBarry Smith     if (!i && levels > 1) {
182f3fbd535SBarry Smith       ierr = KSPAppendOptionsPrefix(mglevels[0]->smoothd,"mg_coarse_");CHKERRQ(ierr);
183f3fbd535SBarry Smith 
184f3fbd535SBarry Smith       /* coarse solve is (redundant) LU by default */
185f3fbd535SBarry Smith       ierr = KSPSetType(mglevels[0]->smoothd,KSPPREONLY);CHKERRQ(ierr);
186f3fbd535SBarry Smith       ierr = KSPGetPC(mglevels[0]->smoothd,&ipc);CHKERRQ(ierr);
187f3fbd535SBarry Smith       ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
188f3fbd535SBarry Smith       if (size > 1) {
189f3fbd535SBarry Smith         ierr = PCSetType(ipc,PCREDUNDANT);CHKERRQ(ierr);
190f3fbd535SBarry Smith       } else {
191f3fbd535SBarry Smith         ierr = PCSetType(ipc,PCLU);CHKERRQ(ierr);
192f3fbd535SBarry Smith       }
193f3fbd535SBarry Smith 
194f3fbd535SBarry Smith     } else {
195f3fbd535SBarry Smith       char tprefix[128];
196f3fbd535SBarry Smith       sprintf(tprefix,"mg_levels_%d_",(int)i);
197f3fbd535SBarry Smith       ierr = KSPAppendOptionsPrefix(mglevels[i]->smoothd,tprefix);CHKERRQ(ierr);
198f3fbd535SBarry Smith     }
199f3fbd535SBarry Smith     ierr = PetscLogObjectParent(pc,mglevels[i]->smoothd);CHKERRQ(ierr);
200f3fbd535SBarry Smith     mglevels[i]->smoothu    = mglevels[i]->smoothd;
20131567311SBarry Smith     mg->rtol                = 0.0;
20231567311SBarry Smith     mg->abstol              = 0.0;
20331567311SBarry Smith     mg->dtol                = 0.0;
20431567311SBarry Smith     mg->ttol                = 0.0;
20531567311SBarry Smith     mg->cyclesperpcapply    = 1;
206f3fbd535SBarry Smith   }
20731567311SBarry Smith   mg->am          = PC_MG_MULTIPLICATIVE;
208f3fbd535SBarry Smith   mg->levels      = mglevels;
2094b9ad928SBarry Smith   pc->ops->applyrichardson = PCApplyRichardson_MG;
2104b9ad928SBarry Smith   PetscFunctionReturn(0);
2114b9ad928SBarry Smith }
2124b9ad928SBarry Smith 
2134b9ad928SBarry Smith #undef __FUNCT__
214*a06653b4SBarry Smith #define __FUNCT__ "PCReset_MG"
215*a06653b4SBarry Smith PetscErrorCode PCReset_MG(PC pc)
216f3fbd535SBarry Smith {
217f3fbd535SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
218f3fbd535SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
219f3fbd535SBarry Smith   PetscErrorCode ierr;
220f3fbd535SBarry Smith   PetscInt       i,n;
221f3fbd535SBarry Smith 
222f3fbd535SBarry Smith   PetscFunctionBegin;
223f3fbd535SBarry Smith   if (mglevels) {
224f3fbd535SBarry Smith     n = mglevels[0]->levels;
225f3fbd535SBarry Smith     for (i=0; i<n-1; i++) {
226f3fbd535SBarry Smith       if (mglevels[i+1]->r) {ierr = VecDestroy(mglevels[i+1]->r);CHKERRQ(ierr);}
227f3fbd535SBarry Smith       if (mglevels[i]->b) {ierr = VecDestroy(mglevels[i]->b);CHKERRQ(ierr);}
228f3fbd535SBarry Smith       if (mglevels[i]->x) {ierr = VecDestroy(mglevels[i]->x);CHKERRQ(ierr);}
229f3fbd535SBarry Smith       if (mglevels[i+1]->restrct) {ierr = MatDestroy(mglevels[i+1]->restrct);CHKERRQ(ierr);}
230f3fbd535SBarry Smith       if (mglevels[i+1]->interpolate) {ierr = MatDestroy(mglevels[i+1]->interpolate);CHKERRQ(ierr);}
231f3fbd535SBarry Smith     }
232f3fbd535SBarry Smith 
233f3fbd535SBarry Smith     for (i=0; i<n; i++) {
234f3fbd535SBarry Smith       if (mglevels[i]->smoothd != mglevels[i]->smoothu) {
235*a06653b4SBarry Smith 	ierr = KSPReset(mglevels[i]->smoothd);CHKERRQ(ierr);
236f3fbd535SBarry Smith       }
237*a06653b4SBarry Smith       ierr = KSPReset(mglevels[i]->smoothu);CHKERRQ(ierr);
238f3fbd535SBarry Smith     }
239f3fbd535SBarry Smith   }
240c07bf074SBarry Smith   PetscFunctionReturn(0);
241c07bf074SBarry Smith }
242c07bf074SBarry Smith 
243c07bf074SBarry Smith #undef __FUNCT__
244c07bf074SBarry Smith #define __FUNCT__ "PCDestroy_MG"
245c07bf074SBarry Smith PetscErrorCode PCDestroy_MG(PC pc)
246c07bf074SBarry Smith {
247c07bf074SBarry Smith   PetscErrorCode ierr;
248*a06653b4SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
249*a06653b4SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
250*a06653b4SBarry Smith   PetscInt       i,n;
251c07bf074SBarry Smith 
252c07bf074SBarry Smith   PetscFunctionBegin;
253*a06653b4SBarry Smith   ierr = PCReset_MG(pc);CHKERRQ(ierr);
254*a06653b4SBarry Smith   if (mglevels) {
255*a06653b4SBarry Smith     n = mglevels[0]->levels;
256*a06653b4SBarry Smith     for (i=0; i<n; i++) {
257*a06653b4SBarry Smith       if (mglevels[i]->smoothd != mglevels[i]->smoothu) {
258*a06653b4SBarry Smith 	ierr = KSPDestroy(mglevels[i]->smoothd);CHKERRQ(ierr);
259*a06653b4SBarry Smith       }
260*a06653b4SBarry Smith       ierr = KSPDestroy(mglevels[i]->smoothu);CHKERRQ(ierr);
261*a06653b4SBarry Smith       ierr = PetscFree(mglevels[i]);CHKERRQ(ierr);
262*a06653b4SBarry Smith     }
263*a06653b4SBarry Smith     ierr = PetscFree(mg->levels);CHKERRQ(ierr);
264*a06653b4SBarry Smith   }
265c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
266f3fbd535SBarry Smith   PetscFunctionReturn(0);
267f3fbd535SBarry Smith }
268f3fbd535SBarry Smith 
269f3fbd535SBarry Smith 
270f3fbd535SBarry Smith 
27109573ac7SBarry Smith extern PetscErrorCode PCMGACycle_Private(PC,PC_MG_Levels**);
27209573ac7SBarry Smith extern PetscErrorCode PCMGFCycle_Private(PC,PC_MG_Levels**);
27309573ac7SBarry Smith extern PetscErrorCode PCMGKCycle_Private(PC,PC_MG_Levels**);
274f3fbd535SBarry Smith 
275f3fbd535SBarry Smith /*
276f3fbd535SBarry Smith    PCApply_MG - Runs either an additive, multiplicative, Kaskadic
277f3fbd535SBarry Smith              or full cycle of multigrid.
278f3fbd535SBarry Smith 
279f3fbd535SBarry Smith   Note:
280f3fbd535SBarry Smith   A simple wrapper which calls PCMGMCycle(),PCMGACycle(), or PCMGFCycle().
281f3fbd535SBarry Smith */
282f3fbd535SBarry Smith #undef __FUNCT__
283f3fbd535SBarry Smith #define __FUNCT__ "PCApply_MG"
284f3fbd535SBarry Smith static PetscErrorCode PCApply_MG(PC pc,Vec b,Vec x)
285f3fbd535SBarry Smith {
286f3fbd535SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
287f3fbd535SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
288f3fbd535SBarry Smith   PetscErrorCode ierr;
289f3fbd535SBarry Smith   PetscInt       levels = mglevels[0]->levels,i;
290f3fbd535SBarry Smith 
291f3fbd535SBarry Smith   PetscFunctionBegin;
292e1d8e5deSBarry Smith 
293e1d8e5deSBarry Smith   /* When the DM is supplying the matrix then it will not exist until here */
294e1d8e5deSBarry Smith   for (i=0; i<levels-1; i++) {
295e1d8e5deSBarry Smith     if (!mglevels[i]->A) {
296e1d8e5deSBarry Smith       ierr = KSPGetOperators(mglevels[i]->smoothu,&mglevels[i]->A,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
297e1d8e5deSBarry Smith     }
298e1d8e5deSBarry Smith   }
299e1d8e5deSBarry Smith 
300f3fbd535SBarry Smith   mglevels[levels-1]->b = b;
301f3fbd535SBarry Smith   mglevels[levels-1]->x = x;
30231567311SBarry Smith   if (mg->am == PC_MG_MULTIPLICATIVE) {
303f3fbd535SBarry Smith     ierr = VecSet(x,0.0);CHKERRQ(ierr);
30431567311SBarry Smith     for (i=0; i<mg->cyclesperpcapply; i++) {
305f3fbd535SBarry Smith       ierr = PCMGMCycle_Private(pc,mglevels+levels-1,PETSC_NULL);CHKERRQ(ierr);
306f3fbd535SBarry Smith     }
307f3fbd535SBarry Smith   }
30831567311SBarry Smith   else if (mg->am == PC_MG_ADDITIVE) {
30931567311SBarry Smith     ierr = PCMGACycle_Private(pc,mglevels);CHKERRQ(ierr);
310f3fbd535SBarry Smith   }
31131567311SBarry Smith   else if (mg->am == PC_MG_KASKADE) {
31231567311SBarry Smith     ierr = PCMGKCycle_Private(pc,mglevels);CHKERRQ(ierr);
313f3fbd535SBarry Smith   }
314f3fbd535SBarry Smith   else {
315f3fbd535SBarry Smith     ierr = PCMGFCycle_Private(pc,mglevels);CHKERRQ(ierr);
316f3fbd535SBarry Smith   }
317f3fbd535SBarry Smith   PetscFunctionReturn(0);
318f3fbd535SBarry Smith }
319f3fbd535SBarry Smith 
320f3fbd535SBarry Smith 
321f3fbd535SBarry Smith #undef __FUNCT__
322f3fbd535SBarry Smith #define __FUNCT__ "PCSetFromOptions_MG"
323f3fbd535SBarry Smith PetscErrorCode PCSetFromOptions_MG(PC pc)
324f3fbd535SBarry Smith {
325f3fbd535SBarry Smith   PetscErrorCode ierr;
326f3fbd535SBarry Smith   PetscInt       m,levels = 1,cycles;
327ace3abfcSBarry Smith   PetscBool      flg;
328f3fbd535SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
329f3fbd535SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
330f3fbd535SBarry Smith   PCMGType       mgtype;
331f3fbd535SBarry Smith   PCMGCycleType  mgctype;
332f3fbd535SBarry Smith 
333f3fbd535SBarry Smith   PetscFunctionBegin;
334f3fbd535SBarry Smith   ierr = PetscOptionsHead("Multigrid options");CHKERRQ(ierr);
33518aabeadSBarry Smith     if (!mglevels) {
336f3fbd535SBarry Smith       ierr = PetscOptionsInt("-pc_mg_levels","Number of Levels","PCMGSetLevels",levels,&levels,&flg);CHKERRQ(ierr);
337f3fbd535SBarry Smith       ierr = PCMGSetLevels(pc,levels,PETSC_NULL);CHKERRQ(ierr);
338f3fbd535SBarry Smith       mglevels = mg->levels;
339f3fbd535SBarry Smith     }
340f3fbd535SBarry Smith     mgctype = (PCMGCycleType) mglevels[0]->cycles;
341f3fbd535SBarry Smith     ierr = PetscOptionsEnum("-pc_mg_cycle_type","V cycle or for W-cycle","PCMGSetCycleType",PCMGCycleTypes,(PetscEnum)mgctype,(PetscEnum*)&mgctype,&flg);CHKERRQ(ierr);
342f3fbd535SBarry Smith     if (flg) {
343f3fbd535SBarry Smith       ierr = PCMGSetCycleType(pc,mgctype);CHKERRQ(ierr);
344f3fbd535SBarry Smith     };
345f3fbd535SBarry Smith     flg  = PETSC_FALSE;
346acfcf0e5SJed Brown     ierr = PetscOptionsBool("-pc_mg_galerkin","Use Galerkin process to compute coarser operators","PCMGSetGalerkin",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
347f3fbd535SBarry Smith     if (flg) {
348f3fbd535SBarry Smith       ierr = PCMGSetGalerkin(pc);CHKERRQ(ierr);
349f3fbd535SBarry Smith     }
350f3fbd535SBarry Smith     ierr = PetscOptionsInt("-pc_mg_smoothup","Number of post-smoothing steps","PCMGSetNumberSmoothUp",1,&m,&flg);CHKERRQ(ierr);
351f3fbd535SBarry Smith     if (flg) {
352f3fbd535SBarry Smith       ierr = PCMGSetNumberSmoothUp(pc,m);CHKERRQ(ierr);
353f3fbd535SBarry Smith     }
354f3fbd535SBarry Smith     ierr = PetscOptionsInt("-pc_mg_smoothdown","Number of pre-smoothing steps","PCMGSetNumberSmoothDown",1,&m,&flg);CHKERRQ(ierr);
355f3fbd535SBarry Smith     if (flg) {
356f3fbd535SBarry Smith       ierr = PCMGSetNumberSmoothDown(pc,m);CHKERRQ(ierr);
357f3fbd535SBarry Smith     }
35831567311SBarry Smith     mgtype = mg->am;
359f3fbd535SBarry Smith     ierr = PetscOptionsEnum("-pc_mg_type","Multigrid type","PCMGSetType",PCMGTypes,(PetscEnum)mgtype,(PetscEnum*)&mgtype,&flg);CHKERRQ(ierr);
360f3fbd535SBarry Smith     if (flg) {
361f3fbd535SBarry Smith       ierr = PCMGSetType(pc,mgtype);CHKERRQ(ierr);
362f3fbd535SBarry Smith     }
36331567311SBarry Smith     if (mg->am == PC_MG_MULTIPLICATIVE) {
36431567311SBarry Smith       ierr = PetscOptionsInt("-pc_mg_multiplicative_cycles","Number of cycles for each preconditioner step","PCMGSetLevels",mg->cyclesperpcapply,&cycles,&flg);CHKERRQ(ierr);
365f3fbd535SBarry Smith       if (flg) {
366f3fbd535SBarry Smith 	ierr = PCMGMultiplicativeSetCycles(pc,cycles);CHKERRQ(ierr);
367f3fbd535SBarry Smith       }
368f3fbd535SBarry Smith     }
369f3fbd535SBarry Smith     flg  = PETSC_FALSE;
370acfcf0e5SJed Brown     ierr = PetscOptionsBool("-pc_mg_log","Log times for each multigrid level","None",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
371f3fbd535SBarry Smith     if (flg) {
372f3fbd535SBarry Smith       PetscInt i;
373f3fbd535SBarry Smith       char     eventname[128];
37463e6d426SJed Brown       if (!mglevels) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Must set MG levels before calling");
375f3fbd535SBarry Smith       levels = mglevels[0]->levels;
376f3fbd535SBarry Smith       for (i=0; i<levels; i++) {
377f3fbd535SBarry Smith         sprintf(eventname,"MGSetup Level %d",(int)i);
37863e6d426SJed Brown         ierr = PetscLogEventRegister(eventname,((PetscObject)pc)->classid,&mglevels[i]->eventsmoothsetup);CHKERRQ(ierr);
379f3fbd535SBarry Smith         sprintf(eventname,"MGSmooth Level %d",(int)i);
38063e6d426SJed Brown         ierr = PetscLogEventRegister(eventname,((PetscObject)pc)->classid,&mglevels[i]->eventsmoothsolve);CHKERRQ(ierr);
381f3fbd535SBarry Smith         if (i) {
382f3fbd535SBarry Smith           sprintf(eventname,"MGResid Level %d",(int)i);
38363e6d426SJed Brown           ierr = PetscLogEventRegister(eventname,((PetscObject)pc)->classid,&mglevels[i]->eventresidual);CHKERRQ(ierr);
384f3fbd535SBarry Smith           sprintf(eventname,"MGInterp Level %d",(int)i);
38563e6d426SJed Brown           ierr = PetscLogEventRegister(eventname,((PetscObject)pc)->classid,&mglevels[i]->eventinterprestrict);CHKERRQ(ierr);
386f3fbd535SBarry Smith         }
387f3fbd535SBarry Smith       }
388f3fbd535SBarry Smith     }
389f3fbd535SBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
390f3fbd535SBarry Smith   PetscFunctionReturn(0);
391f3fbd535SBarry Smith }
392f3fbd535SBarry Smith 
393f3fbd535SBarry Smith const char *PCMGTypes[] = {"MULTIPLICATIVE","ADDITIVE","FULL","KASKADE","PCMGType","PC_MG",0};
394f3fbd535SBarry Smith const char *PCMGCycleTypes[] = {"invalid","v","w","PCMGCycleType","PC_MG_CYCLE",0};
395f3fbd535SBarry Smith 
396f3fbd535SBarry Smith #undef __FUNCT__
397f3fbd535SBarry Smith #define __FUNCT__ "PCView_MG"
398f3fbd535SBarry Smith PetscErrorCode PCView_MG(PC pc,PetscViewer viewer)
399f3fbd535SBarry Smith {
400f3fbd535SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
401f3fbd535SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
402f3fbd535SBarry Smith   PetscErrorCode ierr;
403f3fbd535SBarry Smith   PetscInt       levels = mglevels[0]->levels,i;
404ace3abfcSBarry Smith   PetscBool      iascii;
405f3fbd535SBarry Smith 
406f3fbd535SBarry Smith   PetscFunctionBegin;
4072692d6eeSBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
408f3fbd535SBarry Smith   if (iascii) {
40931567311SBarry 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);
41031567311SBarry Smith     if (mg->am == PC_MG_MULTIPLICATIVE) {
41131567311SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    Cycles per PCApply=%d\n",mg->cyclesperpcapply);CHKERRQ(ierr);
412f3fbd535SBarry Smith     }
413218a07d4SBarry Smith     if (mg->galerkin) {
414f3fbd535SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    Using Galerkin computed coarse grid matrices\n");CHKERRQ(ierr);
4154f66f45eSBarry Smith     } else {
4164f66f45eSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    Not using Galerkin computed coarse grid matrices\n");CHKERRQ(ierr);
417f3fbd535SBarry Smith     }
418f3fbd535SBarry Smith     for (i=0; i<levels; i++) {
419f3fbd535SBarry Smith       if (!i) {
4202d19a89fSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Coarse grid solver -- level %D smooths=%D --------------------\n",i,mg->default_smoothd);CHKERRQ(ierr);
421f3fbd535SBarry Smith       } else {
42231567311SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Down solver (pre-smoother) on level %D smooths=%D --------------------\n",i,mg->default_smoothd);CHKERRQ(ierr);
423f3fbd535SBarry Smith       }
424f3fbd535SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
425f3fbd535SBarry Smith       ierr = KSPView(mglevels[i]->smoothd,viewer);CHKERRQ(ierr);
426f3fbd535SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
427f3fbd535SBarry Smith       if (i && mglevels[i]->smoothd == mglevels[i]->smoothu) {
428f3fbd535SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Up solver (post-smoother) same as down solver (pre-smoother)\n");CHKERRQ(ierr);
429f3fbd535SBarry Smith       } else if (i){
43031567311SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Up solver (post-smoother) on level %D smooths=%D --------------------\n",i,mg->default_smoothu);CHKERRQ(ierr);
431f3fbd535SBarry Smith         ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
432f3fbd535SBarry Smith         ierr = KSPView(mglevels[i]->smoothu,viewer);CHKERRQ(ierr);
433f3fbd535SBarry Smith         ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
434f3fbd535SBarry Smith       }
435f3fbd535SBarry Smith     }
436f3fbd535SBarry Smith   } else {
43765e19b50SBarry Smith     SETERRQ1(((PetscObject)pc)->comm,PETSC_ERR_SUP,"Viewer type %s not supported for PCMG",((PetscObject)viewer)->type_name);
438f3fbd535SBarry Smith   }
439f3fbd535SBarry Smith   PetscFunctionReturn(0);
440f3fbd535SBarry Smith }
441f3fbd535SBarry Smith 
442f3fbd535SBarry Smith /*
443f3fbd535SBarry Smith     Calls setup for the KSP on each level
444f3fbd535SBarry Smith */
445f3fbd535SBarry Smith #undef __FUNCT__
446f3fbd535SBarry Smith #define __FUNCT__ "PCSetUp_MG"
447f3fbd535SBarry Smith PetscErrorCode PCSetUp_MG(PC pc)
448f3fbd535SBarry Smith {
449f3fbd535SBarry Smith   PC_MG                   *mg = (PC_MG*)pc->data;
450f3fbd535SBarry Smith   PC_MG_Levels            **mglevels = mg->levels;
451f3fbd535SBarry Smith   PetscErrorCode          ierr;
452f3fbd535SBarry Smith   PetscInt                i,n = mglevels[0]->levels;
453f3fbd535SBarry Smith   PC                      cpc,mpc;
454ace3abfcSBarry Smith   PetscBool               preonly,lu,redundant,cholesky,monitor = PETSC_FALSE,dump = PETSC_FALSE,opsset;
455f3fbd535SBarry Smith   PetscViewerASCIIMonitor ascii;
456f3fbd535SBarry Smith   PetscViewer             viewer = PETSC_NULL;
457f3fbd535SBarry Smith   MPI_Comm                comm;
458f3fbd535SBarry Smith   Mat                     dA,dB;
459f3fbd535SBarry Smith   MatStructure            uflag;
460f3fbd535SBarry Smith   Vec                     tvec;
461218a07d4SBarry Smith   DM                      *dms;
462f3fbd535SBarry Smith 
463f3fbd535SBarry Smith   PetscFunctionBegin;
464f3fbd535SBarry Smith 
465f3fbd535SBarry Smith   /* If user did not provide fine grid operators OR operator was not updated since last global KSPSetOperators() */
466f3fbd535SBarry Smith   /* so use those from global PC */
467f3fbd535SBarry Smith   /* Is this what we always want? What if user wants to keep old one? */
468f3fbd535SBarry Smith   ierr = KSPGetOperatorsSet(mglevels[n-1]->smoothd,PETSC_NULL,&opsset);CHKERRQ(ierr);
469f3fbd535SBarry Smith   ierr = KSPGetPC(mglevels[0]->smoothd,&cpc);CHKERRQ(ierr);
470f3fbd535SBarry Smith   ierr = KSPGetPC(mglevels[n-1]->smoothd,&mpc);CHKERRQ(ierr);
4711338a6b9SJed Brown   if (!opsset || ((cpc->setupcalled == 1) && (mpc->setupcalled == 2)) || ((mpc == cpc) && (mpc->setupcalled == 2))) {
472f3fbd535SBarry 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);
473f3fbd535SBarry Smith     ierr = KSPSetOperators(mglevels[n-1]->smoothd,pc->mat,pc->pmat,pc->flag);CHKERRQ(ierr);
474f3fbd535SBarry Smith   }
475f3fbd535SBarry Smith 
4762d2b81a6SBarry Smith   if (pc->dm && !pc->setupcalled) {
4772d2b81a6SBarry Smith     /* construct the interpolation from the DMs */
4782e499ae9SBarry Smith     Mat p;
479218a07d4SBarry Smith     ierr = PetscMalloc(n*sizeof(DM),&dms);CHKERRQ(ierr);
480218a07d4SBarry Smith     dms[n-1] = pc->dm;
481218a07d4SBarry Smith     for (i=n-2; i>-1; i--) {
482218a07d4SBarry Smith       ierr = DMCoarsen(dms[i+1],PETSC_NULL,&dms[i]);CHKERRQ(ierr);
48311629dbeSBarry Smith       ierr = DMSetFunction(dms[i],0);
48411629dbeSBarry Smith       ierr = DMSetInitialGuess(dms[i],0);
48524c3aa18SBarry Smith       if (!mglevels[i+1]->interpolate) {
4862d2b81a6SBarry Smith 	ierr = DMGetInterpolation(dms[i],dms[i+1],&p,PETSC_NULL);CHKERRQ(ierr);
4872d2b81a6SBarry Smith 	ierr = PCMGSetInterpolation(pc,i+1,p);CHKERRQ(ierr);
4882d2b81a6SBarry Smith         ierr = MatDestroy(p);CHKERRQ(ierr);
489218a07d4SBarry Smith       }
49024c3aa18SBarry Smith     }
4912d2b81a6SBarry Smith 
4922d2b81a6SBarry Smith     if (!mg->galerkin) {
493d42688cbSBarry Smith       /* each coarse level gets its DM; finest level does not get DM because it shared the outer PC operators */
4942d2b81a6SBarry Smith       for (i=n-2; i>-1; i--) {
4952e499ae9SBarry Smith         ierr = KSPSetDM(mglevels[i]->smoothd,dms[i]);CHKERRQ(ierr);
4962d2b81a6SBarry Smith       }
4972d2b81a6SBarry Smith     }
4982d2b81a6SBarry Smith 
499218a07d4SBarry Smith     for (i=n-2; i>-1; i--) {
500218a07d4SBarry Smith       ierr = DMDestroy(dms[i]);CHKERRQ(ierr);
501218a07d4SBarry Smith     }
5022d2b81a6SBarry Smith     ierr = PetscFree(dms);CHKERRQ(ierr);
503218a07d4SBarry Smith   }
504218a07d4SBarry Smith 
505218a07d4SBarry Smith   if (mg->galerkin) {
506f3fbd535SBarry Smith     Mat B;
507218a07d4SBarry Smith     mg->galerkinused = PETSC_TRUE;
508f3fbd535SBarry Smith     /* currently only handle case where mat and pmat are the same on coarser levels */
509f3fbd535SBarry Smith     ierr = KSPGetOperators(mglevels[n-1]->smoothd,&dA,&dB,&uflag);CHKERRQ(ierr);
510f3fbd535SBarry Smith     if (!pc->setupcalled) {
511f3fbd535SBarry Smith       for (i=n-2; i>-1; i--) {
512f3fbd535SBarry Smith         ierr = MatPtAP(dB,mglevels[i+1]->interpolate,MAT_INITIAL_MATRIX,1.0,&B);CHKERRQ(ierr);
513f3fbd535SBarry Smith         ierr = KSPSetOperators(mglevels[i]->smoothd,B,B,uflag);CHKERRQ(ierr);
514f3fbd535SBarry Smith 	if (i != n-2) {ierr = PetscObjectDereference((PetscObject)dB);CHKERRQ(ierr);}
515f3fbd535SBarry Smith         dB   = B;
516f3fbd535SBarry Smith       }
517cd9507b2SBarry Smith       if (n > 1) {ierr = PetscObjectDereference((PetscObject)dB);CHKERRQ(ierr);}
518f3fbd535SBarry Smith     } else {
519f3fbd535SBarry Smith       for (i=n-2; i>-1; i--) {
520f3fbd535SBarry Smith         ierr = KSPGetOperators(mglevels[i]->smoothd,PETSC_NULL,&B,PETSC_NULL);CHKERRQ(ierr);
521f3fbd535SBarry Smith         ierr = MatPtAP(dB,mglevels[i+1]->interpolate,MAT_REUSE_MATRIX,1.0,&B);CHKERRQ(ierr);
522f3fbd535SBarry Smith         ierr = KSPSetOperators(mglevels[i]->smoothd,B,B,uflag);CHKERRQ(ierr);
523f3fbd535SBarry Smith         dB   = B;
524f3fbd535SBarry Smith       }
525f3fbd535SBarry Smith     }
526f3fbd535SBarry Smith   }
527f3fbd535SBarry Smith 
528f3fbd535SBarry Smith   if (!pc->setupcalled) {
529acfcf0e5SJed Brown     ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_mg_monitor",&monitor,PETSC_NULL);CHKERRQ(ierr);
530f3fbd535SBarry Smith 
531f3fbd535SBarry Smith     for (i=0; i<n; i++) {
532f3fbd535SBarry Smith       if (monitor) {
533f3fbd535SBarry Smith         ierr = PetscObjectGetComm((PetscObject)mglevels[i]->smoothd,&comm);CHKERRQ(ierr);
534f3fbd535SBarry Smith         ierr = PetscViewerASCIIMonitorCreate(comm,"stdout",n-i,&ascii);CHKERRQ(ierr);
535f3fbd535SBarry Smith         ierr = KSPMonitorSet(mglevels[i]->smoothd,KSPMonitorDefault,ascii,(PetscErrorCode(*)(void*))PetscViewerASCIIMonitorDestroy);CHKERRQ(ierr);
536f3fbd535SBarry Smith       }
537f3fbd535SBarry Smith       ierr = KSPSetFromOptions(mglevels[i]->smoothd);CHKERRQ(ierr);
538f3fbd535SBarry Smith     }
539f3fbd535SBarry Smith     for (i=1; i<n; i++) {
540f3fbd535SBarry Smith       if (mglevels[i]->smoothu && (mglevels[i]->smoothu != mglevels[i]->smoothd)) {
541f3fbd535SBarry Smith         if (monitor) {
542f3fbd535SBarry Smith           ierr = PetscObjectGetComm((PetscObject)mglevels[i]->smoothu,&comm);CHKERRQ(ierr);
543f3fbd535SBarry Smith           ierr = PetscViewerASCIIMonitorCreate(comm,"stdout",n-i,&ascii);CHKERRQ(ierr);
544f3fbd535SBarry Smith           ierr = KSPMonitorSet(mglevels[i]->smoothu,KSPMonitorDefault,ascii,(PetscErrorCode(*)(void*))PetscViewerASCIIMonitorDestroy);CHKERRQ(ierr);
545f3fbd535SBarry Smith         }
546f3fbd535SBarry Smith         ierr = KSPSetFromOptions(mglevels[i]->smoothu);CHKERRQ(ierr);
547f3fbd535SBarry Smith       }
548f3fbd535SBarry Smith     }
549f3fbd535SBarry Smith     for (i=1; i<n; i++) {
550f3fbd535SBarry Smith       if (mglevels[i]->restrct && !mglevels[i]->interpolate) {
551f3fbd535SBarry Smith         ierr = PCMGSetInterpolation(pc,i,mglevels[i]->restrct);CHKERRQ(ierr);
552f3fbd535SBarry Smith       }
553f3fbd535SBarry Smith       if (!mglevels[i]->restrct && mglevels[i]->interpolate) {
554f3fbd535SBarry Smith         ierr = PCMGSetRestriction(pc,i,mglevels[i]->interpolate);CHKERRQ(ierr);
555f3fbd535SBarry Smith       }
556f3fbd535SBarry Smith #if defined(PETSC_USE_DEBUG)
557f3fbd535SBarry Smith       if (!mglevels[i]->restrct || !mglevels[i]->interpolate) {
55865e19b50SBarry Smith         SETERRQ1(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Need to set restriction or interpolation on level %d",(int)i);
559f3fbd535SBarry Smith       }
560f3fbd535SBarry Smith #endif
561f3fbd535SBarry Smith     }
562f3fbd535SBarry Smith     for (i=0; i<n-1; i++) {
563f3fbd535SBarry Smith       if (!mglevels[i]->b) {
564f3fbd535SBarry Smith         Vec *vec;
565f3fbd535SBarry Smith         ierr = KSPGetVecs(mglevels[i]->smoothd,1,&vec,0,PETSC_NULL);CHKERRQ(ierr);
566f3fbd535SBarry Smith         ierr = PCMGSetRhs(pc,i,*vec);CHKERRQ(ierr);
567f3fbd535SBarry Smith         ierr = VecDestroy(*vec);CHKERRQ(ierr);
568f3fbd535SBarry Smith         ierr = PetscFree(vec);CHKERRQ(ierr);
569f3fbd535SBarry Smith       }
570f3fbd535SBarry Smith       if (!mglevels[i]->r && i) {
571f3fbd535SBarry Smith         ierr = VecDuplicate(mglevels[i]->b,&tvec);CHKERRQ(ierr);
572f3fbd535SBarry Smith         ierr = PCMGSetR(pc,i,tvec);CHKERRQ(ierr);
573f3fbd535SBarry Smith         ierr = VecDestroy(tvec);CHKERRQ(ierr);
574f3fbd535SBarry Smith       }
575f3fbd535SBarry Smith       if (!mglevels[i]->x) {
576f3fbd535SBarry Smith         ierr = VecDuplicate(mglevels[i]->b,&tvec);CHKERRQ(ierr);
577f3fbd535SBarry Smith         ierr = PCMGSetX(pc,i,tvec);CHKERRQ(ierr);
578f3fbd535SBarry Smith         ierr = VecDestroy(tvec);CHKERRQ(ierr);
579f3fbd535SBarry Smith       }
580f3fbd535SBarry Smith     }
581f3fbd535SBarry Smith     if (n != 1 && !mglevels[n-1]->r) {
582f3fbd535SBarry Smith       /* PCMGSetR() on the finest level if user did not supply it */
583f3fbd535SBarry Smith       Vec *vec;
584f3fbd535SBarry Smith       ierr = KSPGetVecs(mglevels[n-1]->smoothd,1,&vec,0,PETSC_NULL);CHKERRQ(ierr);
585f3fbd535SBarry Smith       ierr = PCMGSetR(pc,n-1,*vec);CHKERRQ(ierr);
586f3fbd535SBarry Smith       ierr = VecDestroy(*vec);CHKERRQ(ierr);
587f3fbd535SBarry Smith       ierr = PetscFree(vec);CHKERRQ(ierr);
588f3fbd535SBarry Smith     }
589f3fbd535SBarry Smith   }
590f3fbd535SBarry Smith 
591f3fbd535SBarry Smith 
592f3fbd535SBarry Smith   for (i=1; i<n; i++) {
593f3fbd535SBarry Smith     if (mglevels[i]->smoothu == mglevels[i]->smoothd) {
594f3fbd535SBarry Smith       /* if doing only down then initial guess is zero */
595f3fbd535SBarry Smith       ierr = KSPSetInitialGuessNonzero(mglevels[i]->smoothd,PETSC_TRUE);CHKERRQ(ierr);
596f3fbd535SBarry Smith     }
59763e6d426SJed Brown     if (mglevels[i]->eventsmoothsetup) {ierr = PetscLogEventBegin(mglevels[i]->eventsmoothsetup,0,0,0,0);CHKERRQ(ierr);}
598f3fbd535SBarry Smith     ierr = KSPSetUp(mglevels[i]->smoothd);CHKERRQ(ierr);
59963e6d426SJed Brown     if (mglevels[i]->eventsmoothsetup) {ierr = PetscLogEventEnd(mglevels[i]->eventsmoothsetup,0,0,0,0);CHKERRQ(ierr);}
600d42688cbSBarry Smith     if (!mglevels[i]->residual) {
601d42688cbSBarry Smith       Mat mat;
602d42688cbSBarry Smith       ierr = KSPGetOperators(mglevels[i]->smoothd,PETSC_NULL,&mat,PETSC_NULL);CHKERRQ(ierr);
603d42688cbSBarry Smith       ierr = PCMGSetResidual(pc,i,PCMGDefaultResidual,mat);CHKERRQ(ierr);
604d42688cbSBarry Smith     }
605f3fbd535SBarry Smith   }
606f3fbd535SBarry Smith   for (i=1; i<n; i++) {
607f3fbd535SBarry Smith     if (mglevels[i]->smoothu && mglevels[i]->smoothu != mglevels[i]->smoothd) {
608f3fbd535SBarry Smith       Mat          downmat,downpmat;
609f3fbd535SBarry Smith       MatStructure matflag;
610ace3abfcSBarry Smith       PetscBool    opsset;
611f3fbd535SBarry Smith 
612f3fbd535SBarry Smith       /* check if operators have been set for up, if not use down operators to set them */
613f3fbd535SBarry Smith       ierr = KSPGetOperatorsSet(mglevels[i]->smoothu,&opsset,PETSC_NULL);CHKERRQ(ierr);
614f3fbd535SBarry Smith       if (!opsset) {
615f3fbd535SBarry Smith         ierr = KSPGetOperators(mglevels[i]->smoothd,&downmat,&downpmat,&matflag);CHKERRQ(ierr);
616f3fbd535SBarry Smith         ierr = KSPSetOperators(mglevels[i]->smoothu,downmat,downpmat,matflag);CHKERRQ(ierr);
617f3fbd535SBarry Smith       }
618f3fbd535SBarry Smith 
619f3fbd535SBarry Smith       ierr = KSPSetInitialGuessNonzero(mglevels[i]->smoothu,PETSC_TRUE);CHKERRQ(ierr);
62063e6d426SJed Brown       if (mglevels[i]->eventsmoothsetup) {ierr = PetscLogEventBegin(mglevels[i]->eventsmoothsetup,0,0,0,0);CHKERRQ(ierr);}
621f3fbd535SBarry Smith       ierr = KSPSetUp(mglevels[i]->smoothu);CHKERRQ(ierr);
62263e6d426SJed Brown       if (mglevels[i]->eventsmoothsetup) {ierr = PetscLogEventEnd(mglevels[i]->eventsmoothsetup,0,0,0,0);CHKERRQ(ierr);}
623f3fbd535SBarry Smith     }
624f3fbd535SBarry Smith   }
625f3fbd535SBarry Smith 
626f3fbd535SBarry Smith   /*
627f3fbd535SBarry Smith       If coarse solver is not direct method then DO NOT USE preonly
628f3fbd535SBarry Smith   */
629f3fbd535SBarry Smith   ierr = PetscTypeCompare((PetscObject)mglevels[0]->smoothd,KSPPREONLY,&preonly);CHKERRQ(ierr);
630f3fbd535SBarry Smith   if (preonly) {
631f3fbd535SBarry Smith     ierr = PetscTypeCompare((PetscObject)cpc,PCLU,&lu);CHKERRQ(ierr);
632f3fbd535SBarry Smith     ierr = PetscTypeCompare((PetscObject)cpc,PCREDUNDANT,&redundant);CHKERRQ(ierr);
633f3fbd535SBarry Smith     ierr = PetscTypeCompare((PetscObject)cpc,PCCHOLESKY,&cholesky);CHKERRQ(ierr);
634f3fbd535SBarry Smith     if (!lu && !redundant && !cholesky) {
635f3fbd535SBarry Smith       ierr = KSPSetType(mglevels[0]->smoothd,KSPGMRES);CHKERRQ(ierr);
636f3fbd535SBarry Smith     }
637f3fbd535SBarry Smith   }
638f3fbd535SBarry Smith 
639f3fbd535SBarry Smith   if (!pc->setupcalled) {
640f3fbd535SBarry Smith     if (monitor) {
641f3fbd535SBarry Smith       ierr = PetscObjectGetComm((PetscObject)mglevels[0]->smoothd,&comm);CHKERRQ(ierr);
642f3fbd535SBarry Smith       ierr = PetscViewerASCIIMonitorCreate(comm,"stdout",n,&ascii);CHKERRQ(ierr);
643f3fbd535SBarry Smith       ierr = KSPMonitorSet(mglevels[0]->smoothd,KSPMonitorDefault,ascii,(PetscErrorCode(*)(void*))PetscViewerASCIIMonitorDestroy);CHKERRQ(ierr);
644f3fbd535SBarry Smith     }
645f3fbd535SBarry Smith     ierr = KSPSetFromOptions(mglevels[0]->smoothd);CHKERRQ(ierr);
646f3fbd535SBarry Smith   }
647f3fbd535SBarry Smith 
64863e6d426SJed Brown   if (mglevels[0]->eventsmoothsetup) {ierr = PetscLogEventBegin(mglevels[0]->eventsmoothsetup,0,0,0,0);CHKERRQ(ierr);}
649f3fbd535SBarry Smith   ierr = KSPSetUp(mglevels[0]->smoothd);CHKERRQ(ierr);
65063e6d426SJed Brown   if (mglevels[0]->eventsmoothsetup) {ierr = PetscLogEventEnd(mglevels[0]->eventsmoothsetup,0,0,0,0);CHKERRQ(ierr);}
651f3fbd535SBarry Smith 
652f3fbd535SBarry Smith   /*
653f3fbd535SBarry Smith      Dump the interpolation/restriction matrices plus the
654e3c5b3baSBarry Smith    Jacobian/stiffness on each level. This allows MATLAB users to
655f3fbd535SBarry Smith    easily check if the Galerkin condition A_c = R A_f R^T is satisfied.
656f3fbd535SBarry Smith 
657f3fbd535SBarry Smith    Only support one or the other at the same time.
658f3fbd535SBarry Smith   */
659f3fbd535SBarry Smith #if defined(PETSC_USE_SOCKET_VIEWER)
660acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_mg_dump_matlab",&dump,PETSC_NULL);CHKERRQ(ierr);
661f3fbd535SBarry Smith   if (dump) {
662f3fbd535SBarry Smith     viewer = PETSC_VIEWER_SOCKET_(((PetscObject)pc)->comm);
663f3fbd535SBarry Smith   }
664f3fbd535SBarry Smith   dump = PETSC_FALSE;
665f3fbd535SBarry Smith #endif
666acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_mg_dump_binary",&dump,PETSC_NULL);CHKERRQ(ierr);
667f3fbd535SBarry Smith   if (dump) {
668f3fbd535SBarry Smith     viewer = PETSC_VIEWER_BINARY_(((PetscObject)pc)->comm);
669f3fbd535SBarry Smith   }
670f3fbd535SBarry Smith 
671f3fbd535SBarry Smith   if (viewer) {
672f3fbd535SBarry Smith     for (i=1; i<n; i++) {
673f3fbd535SBarry Smith       ierr = MatView(mglevels[i]->restrct,viewer);CHKERRQ(ierr);
674f3fbd535SBarry Smith     }
675f3fbd535SBarry Smith     for (i=0; i<n; i++) {
676f3fbd535SBarry Smith       ierr = KSPGetPC(mglevels[i]->smoothd,&pc);CHKERRQ(ierr);
677f3fbd535SBarry Smith       ierr = MatView(pc->mat,viewer);CHKERRQ(ierr);
678f3fbd535SBarry Smith     }
679f3fbd535SBarry Smith   }
680f3fbd535SBarry Smith   PetscFunctionReturn(0);
681f3fbd535SBarry Smith }
682f3fbd535SBarry Smith 
683f3fbd535SBarry Smith /* -------------------------------------------------------------------------------------*/
684f3fbd535SBarry Smith 
685f3fbd535SBarry Smith #undef __FUNCT__
6869dcbbd2bSBarry Smith #define __FUNCT__ "PCMGGetLevels"
6874b9ad928SBarry Smith /*@
68897177400SBarry Smith    PCMGGetLevels - Gets the number of levels to use with MG.
6894b9ad928SBarry Smith 
6904b9ad928SBarry Smith    Not Collective
6914b9ad928SBarry Smith 
6924b9ad928SBarry Smith    Input Parameter:
6934b9ad928SBarry Smith .  pc - the preconditioner context
6944b9ad928SBarry Smith 
6954b9ad928SBarry Smith    Output parameter:
6964b9ad928SBarry Smith .  levels - the number of levels
6974b9ad928SBarry Smith 
6984b9ad928SBarry Smith    Level: advanced
6994b9ad928SBarry Smith 
7004b9ad928SBarry Smith .keywords: MG, get, levels, multigrid
7014b9ad928SBarry Smith 
70297177400SBarry Smith .seealso: PCMGSetLevels()
7034b9ad928SBarry Smith @*/
7047087cfbeSBarry Smith PetscErrorCode  PCMGGetLevels(PC pc,PetscInt *levels)
7054b9ad928SBarry Smith {
706f3fbd535SBarry Smith   PC_MG *mg = (PC_MG*)pc->data;
7074b9ad928SBarry Smith 
7084b9ad928SBarry Smith   PetscFunctionBegin;
7090700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
7104482741eSBarry Smith   PetscValidIntPointer(levels,2);
711f3fbd535SBarry Smith   *levels = mg->nlevels;
7124b9ad928SBarry Smith   PetscFunctionReturn(0);
7134b9ad928SBarry Smith }
7144b9ad928SBarry Smith 
7154b9ad928SBarry Smith #undef __FUNCT__
7169dcbbd2bSBarry Smith #define __FUNCT__ "PCMGSetType"
7174b9ad928SBarry Smith /*@
71897177400SBarry Smith    PCMGSetType - Determines the form of multigrid to use:
7194b9ad928SBarry Smith    multiplicative, additive, full, or the Kaskade algorithm.
7204b9ad928SBarry Smith 
721ad4df100SBarry Smith    Logically Collective on PC
7224b9ad928SBarry Smith 
7234b9ad928SBarry Smith    Input Parameters:
7244b9ad928SBarry Smith +  pc - the preconditioner context
7259dcbbd2bSBarry Smith -  form - multigrid form, one of PC_MG_MULTIPLICATIVE, PC_MG_ADDITIVE,
7269dcbbd2bSBarry Smith    PC_MG_FULL, PC_MG_KASKADE
7274b9ad928SBarry Smith 
7284b9ad928SBarry Smith    Options Database Key:
7294b9ad928SBarry Smith .  -pc_mg_type <form> - Sets <form>, one of multiplicative,
7304b9ad928SBarry Smith    additive, full, kaskade
7314b9ad928SBarry Smith 
7324b9ad928SBarry Smith    Level: advanced
7334b9ad928SBarry Smith 
7344b9ad928SBarry Smith .keywords: MG, set, method, multiplicative, additive, full, Kaskade, multigrid
7354b9ad928SBarry Smith 
73697177400SBarry Smith .seealso: PCMGSetLevels()
7374b9ad928SBarry Smith @*/
7387087cfbeSBarry Smith PetscErrorCode  PCMGSetType(PC pc,PCMGType form)
7394b9ad928SBarry Smith {
740f3fbd535SBarry Smith   PC_MG                   *mg = (PC_MG*)pc->data;
7414b9ad928SBarry Smith 
7424b9ad928SBarry Smith   PetscFunctionBegin;
7430700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
744c5eb9154SBarry Smith   PetscValidLogicalCollectiveEnum(pc,form,2);
74531567311SBarry Smith   mg->am = form;
7469dcbbd2bSBarry Smith   if (form == PC_MG_MULTIPLICATIVE) pc->ops->applyrichardson = PCApplyRichardson_MG;
7474b9ad928SBarry Smith   else pc->ops->applyrichardson = 0;
7484b9ad928SBarry Smith   PetscFunctionReturn(0);
7494b9ad928SBarry Smith }
7504b9ad928SBarry Smith 
7514b9ad928SBarry Smith #undef __FUNCT__
7520d353602SBarry Smith #define __FUNCT__ "PCMGSetCycleType"
7534b9ad928SBarry Smith /*@
7540d353602SBarry Smith    PCMGSetCycleType - Sets the type cycles to use.  Use PCMGSetCycleTypeOnLevel() for more
7554b9ad928SBarry Smith    complicated cycling.
7564b9ad928SBarry Smith 
757ad4df100SBarry Smith    Logically Collective on PC
7584b9ad928SBarry Smith 
7594b9ad928SBarry Smith    Input Parameters:
760c2be2410SBarry Smith +  pc - the multigrid context
7610d353602SBarry Smith -  PC_MG_CYCLE_V or PC_MG_CYCLE_W
7624b9ad928SBarry Smith 
7634b9ad928SBarry Smith    Options Database Key:
7640d353602SBarry Smith $  -pc_mg_cycle_type v or w
7654b9ad928SBarry Smith 
7664b9ad928SBarry Smith    Level: advanced
7674b9ad928SBarry Smith 
7684b9ad928SBarry Smith .keywords: MG, set, cycles, V-cycle, W-cycle, multigrid
7694b9ad928SBarry Smith 
7700d353602SBarry Smith .seealso: PCMGSetCycleTypeOnLevel()
7714b9ad928SBarry Smith @*/
7727087cfbeSBarry Smith PetscErrorCode  PCMGSetCycleType(PC pc,PCMGCycleType n)
7734b9ad928SBarry Smith {
774f3fbd535SBarry Smith   PC_MG        *mg = (PC_MG*)pc->data;
775f3fbd535SBarry Smith   PC_MG_Levels **mglevels = mg->levels;
77679416396SBarry Smith   PetscInt     i,levels;
7774b9ad928SBarry Smith 
7784b9ad928SBarry Smith   PetscFunctionBegin;
7790700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
780e7e72b3dSBarry Smith   if (!mglevels) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Must set MG levels before calling");
781c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,n,2);
782f3fbd535SBarry Smith   levels = mglevels[0]->levels;
7834b9ad928SBarry Smith 
7844b9ad928SBarry Smith   for (i=0; i<levels; i++) {
785f3fbd535SBarry Smith     mglevels[i]->cycles  = n;
7864b9ad928SBarry Smith   }
7874b9ad928SBarry Smith   PetscFunctionReturn(0);
7884b9ad928SBarry Smith }
7894b9ad928SBarry Smith 
7904b9ad928SBarry Smith #undef __FUNCT__
7918cc2d5dfSBarry Smith #define __FUNCT__ "PCMGMultiplicativeSetCycles"
7928cc2d5dfSBarry Smith /*@
7938cc2d5dfSBarry Smith    PCMGMultiplicativeSetCycles - Sets the number of cycles to use for each preconditioner step
7948cc2d5dfSBarry Smith          of multigrid when PCMGType of PC_MG_MULTIPLICATIVE is used
7958cc2d5dfSBarry Smith 
796ad4df100SBarry Smith    Logically Collective on PC
7978cc2d5dfSBarry Smith 
7988cc2d5dfSBarry Smith    Input Parameters:
7998cc2d5dfSBarry Smith +  pc - the multigrid context
8008cc2d5dfSBarry Smith -  n - number of cycles (default is 1)
8018cc2d5dfSBarry Smith 
8028cc2d5dfSBarry Smith    Options Database Key:
8038cc2d5dfSBarry Smith $  -pc_mg_multiplicative_cycles n
8048cc2d5dfSBarry Smith 
8058cc2d5dfSBarry Smith    Level: advanced
8068cc2d5dfSBarry Smith 
8078cc2d5dfSBarry Smith    Notes: This is not associated with setting a v or w cycle, that is set with PCMGSetCycleType()
8088cc2d5dfSBarry Smith 
8098cc2d5dfSBarry Smith .keywords: MG, set, cycles, V-cycle, W-cycle, multigrid
8108cc2d5dfSBarry Smith 
8118cc2d5dfSBarry Smith .seealso: PCMGSetCycleTypeOnLevel(), PCMGSetCycleType()
8128cc2d5dfSBarry Smith @*/
8137087cfbeSBarry Smith PetscErrorCode  PCMGMultiplicativeSetCycles(PC pc,PetscInt n)
8148cc2d5dfSBarry Smith {
815f3fbd535SBarry Smith   PC_MG        *mg = (PC_MG*)pc->data;
816f3fbd535SBarry Smith   PC_MG_Levels **mglevels = mg->levels;
8178cc2d5dfSBarry Smith   PetscInt     i,levels;
8188cc2d5dfSBarry Smith 
8198cc2d5dfSBarry Smith   PetscFunctionBegin;
8200700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
821e7e72b3dSBarry Smith   if (!mglevels) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Must set MG levels before calling");
822c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,n,2);
823f3fbd535SBarry Smith   levels = mglevels[0]->levels;
8248cc2d5dfSBarry Smith 
8258cc2d5dfSBarry Smith   for (i=0; i<levels; i++) {
82631567311SBarry Smith     mg->cyclesperpcapply  = n;
8278cc2d5dfSBarry Smith   }
8288cc2d5dfSBarry Smith   PetscFunctionReturn(0);
8298cc2d5dfSBarry Smith }
8308cc2d5dfSBarry Smith 
8318cc2d5dfSBarry Smith #undef __FUNCT__
8329dcbbd2bSBarry Smith #define __FUNCT__ "PCMGSetGalerkin"
833c2be2410SBarry Smith /*@
83497177400SBarry Smith    PCMGSetGalerkin - Causes the coarser grid matrices to be computed from the
835c2be2410SBarry Smith       finest grid via the Galerkin process: A_i-1 = r_i * A_i * r_i^t
836c2be2410SBarry Smith 
837ad4df100SBarry Smith    Logically Collective on PC
838c2be2410SBarry Smith 
839c2be2410SBarry Smith    Input Parameters:
8403fc8bf9cSBarry Smith .  pc - the multigrid context
841c2be2410SBarry Smith 
842c2be2410SBarry Smith    Options Database Key:
843c2be2410SBarry Smith $  -pc_mg_galerkin
844c2be2410SBarry Smith 
845c2be2410SBarry Smith    Level: intermediate
846c2be2410SBarry Smith 
847c2be2410SBarry Smith .keywords: MG, set, Galerkin
848c2be2410SBarry Smith 
8493fc8bf9cSBarry Smith .seealso: PCMGGetGalerkin()
8503fc8bf9cSBarry Smith 
851c2be2410SBarry Smith @*/
8527087cfbeSBarry Smith PetscErrorCode  PCMGSetGalerkin(PC pc)
853c2be2410SBarry Smith {
854f3fbd535SBarry Smith   PC_MG        *mg = (PC_MG*)pc->data;
855c2be2410SBarry Smith 
856c2be2410SBarry Smith   PetscFunctionBegin;
8570700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
858218a07d4SBarry Smith   mg->galerkin = PETSC_TRUE;
859c2be2410SBarry Smith   PetscFunctionReturn(0);
860c2be2410SBarry Smith }
861c2be2410SBarry Smith 
862c2be2410SBarry Smith #undef __FUNCT__
8633fc8bf9cSBarry Smith #define __FUNCT__ "PCMGGetGalerkin"
8643fc8bf9cSBarry Smith /*@
8653fc8bf9cSBarry Smith    PCMGGetGalerkin - Checks if Galerkin multigrid is being used, i.e.
8663fc8bf9cSBarry Smith       A_i-1 = r_i * A_i * r_i^t
8673fc8bf9cSBarry Smith 
8683fc8bf9cSBarry Smith    Not Collective
8693fc8bf9cSBarry Smith 
8703fc8bf9cSBarry Smith    Input Parameter:
8713fc8bf9cSBarry Smith .  pc - the multigrid context
8723fc8bf9cSBarry Smith 
8733fc8bf9cSBarry Smith    Output Parameter:
8743fc8bf9cSBarry Smith .  gelerkin - PETSC_TRUE or PETSC_FALSE
8753fc8bf9cSBarry Smith 
8763fc8bf9cSBarry Smith    Options Database Key:
8773fc8bf9cSBarry Smith $  -pc_mg_galerkin
8783fc8bf9cSBarry Smith 
8793fc8bf9cSBarry Smith    Level: intermediate
8803fc8bf9cSBarry Smith 
8813fc8bf9cSBarry Smith .keywords: MG, set, Galerkin
8823fc8bf9cSBarry Smith 
8833fc8bf9cSBarry Smith .seealso: PCMGSetGalerkin()
8843fc8bf9cSBarry Smith 
8853fc8bf9cSBarry Smith @*/
8867087cfbeSBarry Smith PetscErrorCode  PCMGGetGalerkin(PC pc,PetscBool  *galerkin)
8873fc8bf9cSBarry Smith {
888f3fbd535SBarry Smith   PC_MG        *mg = (PC_MG*)pc->data;
8893fc8bf9cSBarry Smith 
8903fc8bf9cSBarry Smith   PetscFunctionBegin;
8910700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
892218a07d4SBarry Smith   *galerkin = mg->galerkin;
8933fc8bf9cSBarry Smith   PetscFunctionReturn(0);
8943fc8bf9cSBarry Smith }
8953fc8bf9cSBarry Smith 
8963fc8bf9cSBarry Smith #undef __FUNCT__
8979dcbbd2bSBarry Smith #define __FUNCT__ "PCMGSetNumberSmoothDown"
8984b9ad928SBarry Smith /*@
89997177400SBarry Smith    PCMGSetNumberSmoothDown - Sets the number of pre-smoothing steps to
90097177400SBarry Smith    use on all levels. Use PCMGGetSmootherDown() to set different
9014b9ad928SBarry Smith    pre-smoothing steps on different levels.
9024b9ad928SBarry Smith 
903ad4df100SBarry Smith    Logically Collective on PC
9044b9ad928SBarry Smith 
9054b9ad928SBarry Smith    Input Parameters:
9064b9ad928SBarry Smith +  mg - the multigrid context
9074b9ad928SBarry Smith -  n - the number of smoothing steps
9084b9ad928SBarry Smith 
9094b9ad928SBarry Smith    Options Database Key:
9104b9ad928SBarry Smith .  -pc_mg_smoothdown <n> - Sets number of pre-smoothing steps
9114b9ad928SBarry Smith 
9124b9ad928SBarry Smith    Level: advanced
9134b9ad928SBarry Smith 
9144b9ad928SBarry Smith .keywords: MG, smooth, down, pre-smoothing, steps, multigrid
9154b9ad928SBarry Smith 
91697177400SBarry Smith .seealso: PCMGSetNumberSmoothUp()
9174b9ad928SBarry Smith @*/
9187087cfbeSBarry Smith PetscErrorCode  PCMGSetNumberSmoothDown(PC pc,PetscInt n)
9194b9ad928SBarry Smith {
920f3fbd535SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
921f3fbd535SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
9226849ba73SBarry Smith   PetscErrorCode ierr;
92379416396SBarry Smith   PetscInt       i,levels;
9244b9ad928SBarry Smith 
9254b9ad928SBarry Smith   PetscFunctionBegin;
9260700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
927e7e72b3dSBarry Smith   if (!mglevels) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Must set MG levels before calling");
928c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,n,2);
929f3fbd535SBarry Smith   levels = mglevels[0]->levels;
9304b9ad928SBarry Smith 
931b05257ddSBarry Smith   for (i=1; i<levels; i++) {
9324b9ad928SBarry Smith     /* make sure smoother up and down are different */
93397177400SBarry Smith     ierr = PCMGGetSmootherUp(pc,i,PETSC_NULL);CHKERRQ(ierr);
934f3fbd535SBarry Smith     ierr = KSPSetTolerances(mglevels[i]->smoothd,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT,n);CHKERRQ(ierr);
93531567311SBarry Smith     mg->default_smoothd = n;
9364b9ad928SBarry Smith   }
9374b9ad928SBarry Smith   PetscFunctionReturn(0);
9384b9ad928SBarry Smith }
9394b9ad928SBarry Smith 
9404b9ad928SBarry Smith #undef __FUNCT__
9419dcbbd2bSBarry Smith #define __FUNCT__ "PCMGSetNumberSmoothUp"
9424b9ad928SBarry Smith /*@
94397177400SBarry Smith    PCMGSetNumberSmoothUp - Sets the number of post-smoothing steps to use
94497177400SBarry Smith    on all levels. Use PCMGGetSmootherUp() to set different numbers of
9454b9ad928SBarry Smith    post-smoothing steps on different levels.
9464b9ad928SBarry Smith 
947ad4df100SBarry Smith    Logically Collective on PC
9484b9ad928SBarry Smith 
9494b9ad928SBarry Smith    Input Parameters:
9504b9ad928SBarry Smith +  mg - the multigrid context
9514b9ad928SBarry Smith -  n - the number of smoothing steps
9524b9ad928SBarry Smith 
9534b9ad928SBarry Smith    Options Database Key:
9544b9ad928SBarry Smith .  -pc_mg_smoothup <n> - Sets number of post-smoothing steps
9554b9ad928SBarry Smith 
9564b9ad928SBarry Smith    Level: advanced
9574b9ad928SBarry Smith 
9584b9ad928SBarry Smith    Note: this does not set a value on the coarsest grid, since we assume that
959a8c7a070SBarry Smith     there is no separate smooth up on the coarsest grid.
9604b9ad928SBarry Smith 
9614b9ad928SBarry Smith .keywords: MG, smooth, up, post-smoothing, steps, multigrid
9624b9ad928SBarry Smith 
96397177400SBarry Smith .seealso: PCMGSetNumberSmoothDown()
9644b9ad928SBarry Smith @*/
9657087cfbeSBarry Smith PetscErrorCode  PCMGSetNumberSmoothUp(PC pc,PetscInt n)
9664b9ad928SBarry Smith {
967f3fbd535SBarry Smith   PC_MG          *mg = (PC_MG*)pc->data;
968f3fbd535SBarry Smith   PC_MG_Levels   **mglevels = mg->levels;
9696849ba73SBarry Smith   PetscErrorCode ierr;
97079416396SBarry Smith   PetscInt       i,levels;
9714b9ad928SBarry Smith 
9724b9ad928SBarry Smith   PetscFunctionBegin;
9730700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
974e7e72b3dSBarry Smith   if (!mglevels) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Must set MG levels before calling");
975c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,n,2);
976f3fbd535SBarry Smith   levels = mglevels[0]->levels;
9774b9ad928SBarry Smith 
9784b9ad928SBarry Smith   for (i=1; i<levels; i++) {
9794b9ad928SBarry Smith     /* make sure smoother up and down are different */
98097177400SBarry Smith     ierr = PCMGGetSmootherUp(pc,i,PETSC_NULL);CHKERRQ(ierr);
981f3fbd535SBarry Smith     ierr = KSPSetTolerances(mglevels[i]->smoothu,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT,n);CHKERRQ(ierr);
98231567311SBarry Smith     mg->default_smoothu = n;
9834b9ad928SBarry Smith   }
9844b9ad928SBarry Smith   PetscFunctionReturn(0);
9854b9ad928SBarry Smith }
9864b9ad928SBarry Smith 
9874b9ad928SBarry Smith /* ----------------------------------------------------------------------------------------*/
9884b9ad928SBarry Smith 
9893b09bd56SBarry Smith /*MC
990ccb205f8SBarry Smith    PCMG - Use multigrid preconditioning. This preconditioner requires you provide additional
9913b09bd56SBarry Smith     information about the coarser grid matrices and restriction/interpolation operators.
9923b09bd56SBarry Smith 
9933b09bd56SBarry Smith    Options Database Keys:
9943b09bd56SBarry Smith +  -pc_mg_levels <nlevels> - number of levels including finest
9950d353602SBarry Smith .  -pc_mg_cycles v or w
99679416396SBarry Smith .  -pc_mg_smoothup <n> - number of smoothing steps after interpolation
9973b09bd56SBarry Smith .  -pc_mg_smoothdown <n> - number of smoothing steps before applying restriction operator
9983b09bd56SBarry Smith .  -pc_mg_type <additive,multiplicative,full,cascade> - multiplicative is the default
9993b09bd56SBarry Smith .  -pc_mg_log - log information about time spent on each level of the solver
10003b09bd56SBarry Smith .  -pc_mg_monitor - print information on the multigrid convergence
100168eff7e6SBarry Smith .  -pc_mg_galerkin - use Galerkin process to compute coarser operators
10023b09bd56SBarry Smith -  -pc_mg_dump_matlab - dumps the matrices for each level and the restriction/interpolation matrices
1003e3c5b3baSBarry Smith                         to the Socket viewer for reading from MATLAB.
10043b09bd56SBarry Smith 
100524c3aa18SBarry 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
10063b09bd56SBarry Smith 
10073b09bd56SBarry Smith    Level: intermediate
10083b09bd56SBarry Smith 
10098f87f92bSBarry Smith    Concepts: multigrid/multilevel
10103b09bd56SBarry Smith 
101124c3aa18SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, PCMGType, PCEXOTIC
10120d353602SBarry Smith            PCMGSetLevels(), PCMGGetLevels(), PCMGSetType(), PCMGSetCycleType(), PCMGSetNumberSmoothDown(),
101397177400SBarry Smith            PCMGSetNumberSmoothUp(), PCMGGetCoarseSolve(), PCMGSetResidual(), PCMGSetInterpolation(),
101497177400SBarry Smith            PCMGSetRestriction(), PCMGGetSmoother(), PCMGGetSmootherUp(), PCMGGetSmootherDown(),
10150d353602SBarry Smith            PCMGSetCycleTypeOnLevel(), PCMGSetRhs(), PCMGSetX(), PCMGSetR()
10163b09bd56SBarry Smith M*/
10173b09bd56SBarry Smith 
10184b9ad928SBarry Smith EXTERN_C_BEGIN
10194b9ad928SBarry Smith #undef __FUNCT__
10204b9ad928SBarry Smith #define __FUNCT__ "PCCreate_MG"
10217087cfbeSBarry Smith PetscErrorCode  PCCreate_MG(PC pc)
10224b9ad928SBarry Smith {
1023f3fbd535SBarry Smith   PC_MG          *mg;
1024f3fbd535SBarry Smith   PetscErrorCode ierr;
1025f3fbd535SBarry Smith 
10264b9ad928SBarry Smith   PetscFunctionBegin;
1027f3fbd535SBarry Smith   ierr        = PetscNewLog(pc,PC_MG,&mg);CHKERRQ(ierr);
1028f3fbd535SBarry Smith   pc->data    = (void*)mg;
1029f3fbd535SBarry Smith   mg->nlevels = -1;
1030f3fbd535SBarry Smith 
10314b9ad928SBarry Smith   pc->ops->apply          = PCApply_MG;
10324b9ad928SBarry Smith   pc->ops->setup          = PCSetUp_MG;
1033*a06653b4SBarry Smith   pc->ops->reset          = PCReset_MG;
10344b9ad928SBarry Smith   pc->ops->destroy        = PCDestroy_MG;
10354b9ad928SBarry Smith   pc->ops->setfromoptions = PCSetFromOptions_MG;
10364b9ad928SBarry Smith   pc->ops->view           = PCView_MG;
10374b9ad928SBarry Smith   PetscFunctionReturn(0);
10384b9ad928SBarry Smith }
10394b9ad928SBarry Smith EXTERN_C_END
1040