xref: /petsc/src/ksp/pc/impls/mg/mg.c (revision 28b400f66ebc7ae0049166a2294dfcd3df27e64b)

/*
    Defines the multigrid preconditioner interface.
*/
#include <petsc/private/pcmgimpl.h>                    /*I "petscksp.h" I*/
#include <petsc/private/kspimpl.h>
#include <petscdm.h>
PETSC_INTERN PetscErrorCode PCPreSolveChangeRHS(PC,PetscBool*);

/*
   Contains the list of registered coarse space construction routines
*/
PetscFunctionList PCMGCoarseList = NULL;

PetscErrorCode PCMGMCycle_Private(PC pc,PC_MG_Levels **mglevelsin,PetscBool transpose,PetscBool matapp,PCRichardsonConvergedReason *reason)
{
  PC_MG          *mg = (PC_MG*)pc->data;
  PC_MG_Levels   *mgc,*mglevels = *mglevelsin;
  PetscInt       cycles = (mglevels->level == 1) ? 1 : (PetscInt) mglevels->cycles;

  PetscFunctionBegin;
  if (mglevels->eventsmoothsolve) CHKERRQ(PetscLogEventBegin(mglevels->eventsmoothsolve,0,0,0,0));
  if (!transpose) {
    if (matapp) {
      CHKERRQ(KSPMatSolve(mglevels->smoothd,mglevels->B,mglevels->X));  /* pre-smooth */
      CHKERRQ(KSPCheckSolve(mglevels->smoothd,pc,NULL));
    } else {
      CHKERRQ(KSPSolve(mglevels->smoothd,mglevels->b,mglevels->x));  /* pre-smooth */
      CHKERRQ(KSPCheckSolve(mglevels->smoothd,pc,mglevels->x));
    }
  } else {
    PetscCheck(!matapp,PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Not supported");
    CHKERRQ(KSPSolveTranspose(mglevels->smoothu,mglevels->b,mglevels->x)); /* transpose of post-smooth */
    CHKERRQ(KSPCheckSolve(mglevels->smoothu,pc,mglevels->x));
  }
  if (mglevels->eventsmoothsolve) CHKERRQ(PetscLogEventEnd(mglevels->eventsmoothsolve,0,0,0,0));
  if (mglevels->level) {  /* not the coarsest grid */
    if (mglevels->eventresidual) CHKERRQ(PetscLogEventBegin(mglevels->eventresidual,0,0,0,0));
    if (matapp && !mglevels->R) {
      CHKERRQ(MatDuplicate(mglevels->B,MAT_DO_NOT_COPY_VALUES,&mglevels->R));
    }
    if (!transpose) {
      if (matapp) CHKERRQ((*mglevels->matresidual)(mglevels->A,mglevels->B,mglevels->X,mglevels->R));
      else CHKERRQ((*mglevels->residual)(mglevels->A,mglevels->b,mglevels->x,mglevels->r));
    } else {
      if (matapp) CHKERRQ((*mglevels->matresidualtranspose)(mglevels->A,mglevels->B,mglevels->X,mglevels->R));
      else CHKERRQ((*mglevels->residualtranspose)(mglevels->A,mglevels->b,mglevels->x,mglevels->r));
    }
    if (mglevels->eventresidual) CHKERRQ(PetscLogEventEnd(mglevels->eventresidual,0,0,0,0));

    /* if on finest level and have convergence criteria set */
    if (mglevels->level == mglevels->levels-1 && mg->ttol && reason) {
      PetscReal rnorm;
      CHKERRQ(VecNorm(mglevels->r,NORM_2,&rnorm));
      if (rnorm <= mg->ttol) {
        if (rnorm < mg->abstol) {
          *reason = PCRICHARDSON_CONVERGED_ATOL;
          CHKERRQ(PetscInfo(pc,"Linear solver has converged. Residual norm %g is less than absolute tolerance %g\n",(double)rnorm,(double)mg->abstol));
        } else {
          *reason = PCRICHARDSON_CONVERGED_RTOL;
          CHKERRQ(PetscInfo(pc,"Linear solver has converged. Residual norm %g is less than relative tolerance times initial residual norm %g\n",(double)rnorm,(double)mg->ttol));
        }
        PetscFunctionReturn(0);
      }
    }

    mgc = *(mglevelsin - 1);
    if (mglevels->eventinterprestrict) CHKERRQ(PetscLogEventBegin(mglevels->eventinterprestrict,0,0,0,0));
    if (!transpose) {
      if (matapp) CHKERRQ(MatMatRestrict(mglevels->restrct,mglevels->R,&mgc->B));
      else CHKERRQ(MatRestrict(mglevels->restrct,mglevels->r,mgc->b));
    } else {
      if (matapp) CHKERRQ(MatMatRestrict(mglevels->interpolate,mglevels->R,&mgc->B));
      else CHKERRQ(MatRestrict(mglevels->interpolate,mglevels->r,mgc->b));
    }
    if (mglevels->eventinterprestrict) CHKERRQ(PetscLogEventEnd(mglevels->eventinterprestrict,0,0,0,0));
    if (matapp) {
      if (!mgc->X) {
        CHKERRQ(MatDuplicate(mgc->B,MAT_DO_NOT_COPY_VALUES,&mgc->X));
      } else {
        CHKERRQ(MatZeroEntries(mgc->X));
      }
    } else {
      CHKERRQ(VecZeroEntries(mgc->x));
    }
    while (cycles--) {
      CHKERRQ(PCMGMCycle_Private(pc,mglevelsin-1,transpose,matapp,reason));
    }
    if (mglevels->eventinterprestrict) CHKERRQ(PetscLogEventBegin(mglevels->eventinterprestrict,0,0,0,0));
    if (!transpose) {
      if (matapp) CHKERRQ(MatMatInterpolateAdd(mglevels->interpolate,mgc->X,mglevels->X,&mglevels->X));
      else CHKERRQ(MatInterpolateAdd(mglevels->interpolate,mgc->x,mglevels->x,mglevels->x));
    } else {
      CHKERRQ(MatInterpolateAdd(mglevels->restrct,mgc->x,mglevels->x,mglevels->x));
    }
    if (mglevels->eventinterprestrict) CHKERRQ(PetscLogEventEnd(mglevels->eventinterprestrict,0,0,0,0));
    if (mglevels->eventsmoothsolve) CHKERRQ(PetscLogEventBegin(mglevels->eventsmoothsolve,0,0,0,0));
    if (!transpose) {
      if (matapp) {
        CHKERRQ(KSPMatSolve(mglevels->smoothu,mglevels->B,mglevels->X));    /* post smooth */
        CHKERRQ(KSPCheckSolve(mglevels->smoothu,pc,NULL));
      } else {
        CHKERRQ(KSPSolve(mglevels->smoothu,mglevels->b,mglevels->x));    /* post smooth */
        CHKERRQ(KSPCheckSolve(mglevels->smoothu,pc,mglevels->x));
      }
    } else {
      PetscCheck(!matapp,PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Not supported");
      CHKERRQ(KSPSolveTranspose(mglevels->smoothd,mglevels->b,mglevels->x));    /* post smooth */
      CHKERRQ(KSPCheckSolve(mglevels->smoothd,pc,mglevels->x));
    }
    if (mglevels->cr) {
      PetscCheck(!matapp,PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Not supported");
      /* TODO Turn on copy and turn off noisy if we have an exact solution
      CHKERRQ(VecCopy(mglevels->x, mglevels->crx));
      CHKERRQ(VecCopy(mglevels->b, mglevels->crb)); */
      CHKERRQ(KSPSetNoisy_Private(mglevels->crx));
      CHKERRQ(KSPSolve(mglevels->cr,mglevels->crb,mglevels->crx));    /* compatible relaxation */
      CHKERRQ(KSPCheckSolve(mglevels->cr,pc,mglevels->crx));
    }
    if (mglevels->eventsmoothsolve) CHKERRQ(PetscLogEventEnd(mglevels->eventsmoothsolve,0,0,0,0));
  }
  PetscFunctionReturn(0);
}

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)
{
  PC_MG          *mg        = (PC_MG*)pc->data;
  PC_MG_Levels   **mglevels = mg->levels;
  PC             tpc;
  PetscBool      changeu,changed;
  PetscInt       levels = mglevels[0]->levels,i;

  PetscFunctionBegin;
  /* When the DM is supplying the matrix then it will not exist until here */
  for (i=0; i<levels; i++) {
    if (!mglevels[i]->A) {
      CHKERRQ(KSPGetOperators(mglevels[i]->smoothu,&mglevels[i]->A,NULL));
      CHKERRQ(PetscObjectReference((PetscObject)mglevels[i]->A));
    }
  }

  CHKERRQ(KSPGetPC(mglevels[levels-1]->smoothd,&tpc));
  CHKERRQ(PCPreSolveChangeRHS(tpc,&changed));
  CHKERRQ(KSPGetPC(mglevels[levels-1]->smoothu,&tpc));
  CHKERRQ(PCPreSolveChangeRHS(tpc,&changeu));
  if (!changed && !changeu) {
    CHKERRQ(VecDestroy(&mglevels[levels-1]->b));
    mglevels[levels-1]->b = b;
  } else { /* if the smoother changes the rhs during PreSolve, we cannot use the input vector */
    if (!mglevels[levels-1]->b) {
      Vec *vec;

      CHKERRQ(KSPCreateVecs(mglevels[levels-1]->smoothd,1,&vec,0,NULL));
      mglevels[levels-1]->b = *vec;
      CHKERRQ(PetscFree(vec));
    }
    CHKERRQ(VecCopy(b,mglevels[levels-1]->b));
  }
  mglevels[levels-1]->x = x;

  mg->rtol   = rtol;
  mg->abstol = abstol;
  mg->dtol   = dtol;
  if (rtol) {
    /* compute initial residual norm for relative convergence test */
    PetscReal rnorm;
    if (zeroguess) {
      CHKERRQ(VecNorm(b,NORM_2,&rnorm));
    } else {
      CHKERRQ((*mglevels[levels-1]->residual)(mglevels[levels-1]->A,b,x,w));
      CHKERRQ(VecNorm(w,NORM_2,&rnorm));
    }
    mg->ttol = PetscMax(rtol*rnorm,abstol);
  } else if (abstol) mg->ttol = abstol;
  else mg->ttol = 0.0;

  /* since smoother is applied to full system, not just residual we need to make sure that smoothers don't
     stop prematurely due to small residual */
  for (i=1; i<levels; i++) {
    CHKERRQ(KSPSetTolerances(mglevels[i]->smoothu,0,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT));
    if (mglevels[i]->smoothu != mglevels[i]->smoothd) {
      /* For Richardson the initial guess is nonzero since it is solving in each cycle the original system not just applying as a preconditioner */
      CHKERRQ(KSPSetInitialGuessNonzero(mglevels[i]->smoothd,PETSC_TRUE));
      CHKERRQ(KSPSetTolerances(mglevels[i]->smoothd,0,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT));
    }
  }

  *reason = (PCRichardsonConvergedReason)0;
  for (i=0; i<its; i++) {
    CHKERRQ(PCMGMCycle_Private(pc,mglevels+levels-1,PETSC_FALSE,PETSC_FALSE,reason));
    if (*reason) break;
  }
  if (!*reason) *reason = PCRICHARDSON_CONVERGED_ITS;
  *outits = i;
  if (!changed && !changeu) mglevels[levels-1]->b = NULL;
  PetscFunctionReturn(0);
}

PetscErrorCode PCReset_MG(PC pc)
{
  PC_MG          *mg        = (PC_MG*)pc->data;
  PC_MG_Levels   **mglevels = mg->levels;
  PetscInt       i,c,n;

  PetscFunctionBegin;
  if (mglevels) {
    n = mglevels[0]->levels;
    for (i=0; i<n-1; i++) {
      CHKERRQ(VecDestroy(&mglevels[i+1]->r));
      CHKERRQ(VecDestroy(&mglevels[i]->b));
      CHKERRQ(VecDestroy(&mglevels[i]->x));
      CHKERRQ(MatDestroy(&mglevels[i+1]->R));
      CHKERRQ(MatDestroy(&mglevels[i]->B));
      CHKERRQ(MatDestroy(&mglevels[i]->X));
      CHKERRQ(VecDestroy(&mglevels[i]->crx));
      CHKERRQ(VecDestroy(&mglevels[i]->crb));
      CHKERRQ(MatDestroy(&mglevels[i+1]->restrct));
      CHKERRQ(MatDestroy(&mglevels[i+1]->interpolate));
      CHKERRQ(MatDestroy(&mglevels[i+1]->inject));
      CHKERRQ(VecDestroy(&mglevels[i+1]->rscale));
    }
    CHKERRQ(VecDestroy(&mglevels[n-1]->crx));
    CHKERRQ(VecDestroy(&mglevels[n-1]->crb));
    /* this is not null only if the smoother on the finest level
       changes the rhs during PreSolve */
    CHKERRQ(VecDestroy(&mglevels[n-1]->b));
    CHKERRQ(MatDestroy(&mglevels[n-1]->B));

    for (i=0; i<n; i++) {
      if (mglevels[i]->coarseSpace) for (c = 0; c < mg->Nc; ++c) CHKERRQ(VecDestroy(&mglevels[i]->coarseSpace[c]));
      CHKERRQ(PetscFree(mglevels[i]->coarseSpace));
      mglevels[i]->coarseSpace = NULL;
      CHKERRQ(MatDestroy(&mglevels[i]->A));
      if (mglevels[i]->smoothd != mglevels[i]->smoothu) {
        CHKERRQ(KSPReset(mglevels[i]->smoothd));
      }
      CHKERRQ(KSPReset(mglevels[i]->smoothu));
      if (mglevels[i]->cr) CHKERRQ(KSPReset(mglevels[i]->cr));
    }
    mg->Nc = 0;
  }
  PetscFunctionReturn(0);
}

/* Implementing CR

We only want to make corrections that ``do not change'' the coarse solution. What we mean by not changing is that if I prolong my coarse solution to the fine grid and then inject that fine solution back to the coarse grid, I get the same answer. Injection is what Brannick calls R. We want the complementary projector to Inj, which we will call S, after Brannick, so that Inj S = 0. Now the orthogonal projector onto the range of Inj^T is

  Inj^T (Inj Inj^T)^{-1} Inj

and if Inj is a VecScatter, as it is now in PETSc, we have

  Inj^T Inj

and

  S = I - Inj^T Inj

since

  Inj S = Inj - (Inj Inj^T) Inj = 0.

Brannick suggests

  A \to S^T A S  \qquad\mathrm{and}\qquad M \to S^T M S

but I do not think his :math:`S^T S = I` is correct. Our S is an orthogonal projector, so :math:`S^T S = S^2 = S`. We will use

  M^{-1} A \to S M^{-1} A S

In fact, since it is somewhat hard in PETSc to do the symmetric application, we will just apply S on the left.

  Check: || Inj P - I ||_F < tol
  Check: In general, Inj Inj^T = I
*/

typedef struct {
  PC       mg;  /* The PCMG object */
  PetscInt l;   /* The multigrid level for this solver */
  Mat      Inj; /* The injection matrix */
  Mat      S;   /* I - Inj^T Inj */
} CRContext;

static PetscErrorCode CRSetup_Private(PC pc)
{
  CRContext     *ctx;
  Mat            It;

  PetscFunctionBeginUser;
  CHKERRQ(PCShellGetContext(pc, &ctx));
  CHKERRQ(PCMGGetInjection(ctx->mg, ctx->l, &It));
  PetscCheck(It,PetscObjectComm((PetscObject) pc), PETSC_ERR_ARG_WRONGSTATE, "CR requires that injection be defined for this PCMG");
  CHKERRQ(MatCreateTranspose(It, &ctx->Inj));
  CHKERRQ(MatCreateNormal(ctx->Inj, &ctx->S));
  CHKERRQ(MatScale(ctx->S, -1.0));
  CHKERRQ(MatShift(ctx->S,  1.0));
  PetscFunctionReturn(0);
}

static PetscErrorCode CRApply_Private(PC pc, Vec x, Vec y)
{
  CRContext     *ctx;

  PetscFunctionBeginUser;
  CHKERRQ(PCShellGetContext(pc, &ctx));
  CHKERRQ(MatMult(ctx->S, x, y));
  PetscFunctionReturn(0);
}

static PetscErrorCode CRDestroy_Private(PC pc)
{
  CRContext     *ctx;

  PetscFunctionBeginUser;
  CHKERRQ(PCShellGetContext(pc, &ctx));
  CHKERRQ(MatDestroy(&ctx->Inj));
  CHKERRQ(MatDestroy(&ctx->S));
  CHKERRQ(PetscFree(ctx));
  CHKERRQ(PCShellSetContext(pc, NULL));
  PetscFunctionReturn(0);
}

static PetscErrorCode CreateCR_Private(PC pc, PetscInt l, PC *cr)
{
  CRContext     *ctx;

  PetscFunctionBeginUser;
  CHKERRQ(PCCreate(PetscObjectComm((PetscObject) pc), cr));
  CHKERRQ(PetscObjectSetName((PetscObject) *cr, "S (complementary projector to injection)"));
  CHKERRQ(PetscCalloc1(1, &ctx));
  ctx->mg = pc;
  ctx->l  = l;
  CHKERRQ(PCSetType(*cr, PCSHELL));
  CHKERRQ(PCShellSetContext(*cr, ctx));
  CHKERRQ(PCShellSetApply(*cr, CRApply_Private));
  CHKERRQ(PCShellSetSetUp(*cr, CRSetup_Private));
  CHKERRQ(PCShellSetDestroy(*cr, CRDestroy_Private));
  PetscFunctionReturn(0);
}

PetscErrorCode PCMGSetLevels_MG(PC pc,PetscInt levels,MPI_Comm *comms)
{
  PC_MG          *mg        = (PC_MG*)pc->data;
  MPI_Comm       comm;
  PC_MG_Levels   **mglevels = mg->levels;
  PCMGType       mgtype     = mg->am;
  PetscInt       mgctype    = (PetscInt) PC_MG_CYCLE_V;
  PetscInt       i;
  PetscMPIInt    size;
  const char     *prefix;
  PC             ipc;
  PetscInt       n;

  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc,PC_CLASSID,1);
  PetscValidLogicalCollectiveInt(pc,levels,2);
  if (mg->nlevels == levels) PetscFunctionReturn(0);
  CHKERRQ(PetscObjectGetComm((PetscObject)pc,&comm));
  if (mglevels) {
    mgctype = mglevels[0]->cycles;
    /* changing the number of levels so free up the previous stuff */
    CHKERRQ(PCReset_MG(pc));
    n    = mglevels[0]->levels;
    for (i=0; i<n; i++) {
      if (mglevels[i]->smoothd != mglevels[i]->smoothu) {
        CHKERRQ(KSPDestroy(&mglevels[i]->smoothd));
      }
      CHKERRQ(KSPDestroy(&mglevels[i]->smoothu));
      CHKERRQ(KSPDestroy(&mglevels[i]->cr));
      CHKERRQ(PetscFree(mglevels[i]));
    }
    CHKERRQ(PetscFree(mg->levels));
  }

  mg->nlevels = levels;

  CHKERRQ(PetscMalloc1(levels,&mglevels));
  CHKERRQ(PetscLogObjectMemory((PetscObject)pc,levels*(sizeof(PC_MG*))));

  CHKERRQ(PCGetOptionsPrefix(pc,&prefix));

  mg->stageApply = 0;
  for (i=0; i<levels; i++) {
    CHKERRQ(PetscNewLog(pc,&mglevels[i]));

    mglevels[i]->level               = i;
    mglevels[i]->levels              = levels;
    mglevels[i]->cycles              = mgctype;
    mg->default_smoothu              = 2;
    mg->default_smoothd              = 2;
    mglevels[i]->eventsmoothsetup    = 0;
    mglevels[i]->eventsmoothsolve    = 0;
    mglevels[i]->eventresidual       = 0;
    mglevels[i]->eventinterprestrict = 0;

    if (comms) comm = comms[i];
    if (comm != MPI_COMM_NULL) {
      CHKERRQ(KSPCreate(comm,&mglevels[i]->smoothd));
      CHKERRQ(KSPSetErrorIfNotConverged(mglevels[i]->smoothd,pc->erroriffailure));
      CHKERRQ(PetscObjectIncrementTabLevel((PetscObject)mglevels[i]->smoothd,(PetscObject)pc,levels-i));
      CHKERRQ(KSPSetOptionsPrefix(mglevels[i]->smoothd,prefix));
      CHKERRQ(PetscObjectComposedDataSetInt((PetscObject) mglevels[i]->smoothd, PetscMGLevelId, mglevels[i]->level));
      if (i || levels == 1) {
        char tprefix[128];

        CHKERRQ(KSPSetType(mglevels[i]->smoothd,KSPCHEBYSHEV));
        CHKERRQ(KSPSetConvergenceTest(mglevels[i]->smoothd,KSPConvergedSkip,NULL,NULL));
        CHKERRQ(KSPSetNormType(mglevels[i]->smoothd,KSP_NORM_NONE));
        CHKERRQ(KSPGetPC(mglevels[i]->smoothd,&ipc));
        CHKERRQ(PCSetType(ipc,PCSOR));
        CHKERRQ(KSPSetTolerances(mglevels[i]->smoothd,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT, mg->default_smoothd));

        CHKERRQ(PetscSNPrintf(tprefix,128,"mg_levels_%d_",(int)i));
        CHKERRQ(KSPAppendOptionsPrefix(mglevels[i]->smoothd,tprefix));
      } else {
        CHKERRQ(KSPAppendOptionsPrefix(mglevels[0]->smoothd,"mg_coarse_"));

        /* coarse solve is (redundant) LU by default; set shifttype NONZERO to avoid annoying zero-pivot in LU preconditioner */
        CHKERRQ(KSPSetType(mglevels[0]->smoothd,KSPPREONLY));
        CHKERRQ(KSPGetPC(mglevels[0]->smoothd,&ipc));
        CHKERRMPI(MPI_Comm_size(comm,&size));
        if (size > 1) {
          CHKERRQ(PCSetType(ipc,PCREDUNDANT));
        } else {
          CHKERRQ(PCSetType(ipc,PCLU));
        }
        CHKERRQ(PCFactorSetShiftType(ipc,MAT_SHIFT_INBLOCKS));
      }
      CHKERRQ(PetscLogObjectParent((PetscObject)pc,(PetscObject)mglevels[i]->smoothd));
    }
    mglevels[i]->smoothu = mglevels[i]->smoothd;
    mg->rtol             = 0.0;
    mg->abstol           = 0.0;
    mg->dtol             = 0.0;
    mg->ttol             = 0.0;
    mg->cyclesperpcapply = 1;
  }
  mg->levels = mglevels;
  CHKERRQ(PCMGSetType(pc,mgtype));
  PetscFunctionReturn(0);
}

/*@C
   PCMGSetLevels - Sets the number of levels to use with MG.
   Must be called before any other MG routine.

   Logically Collective on PC

   Input Parameters:
+  pc - the preconditioner context
.  levels - the number of levels
-  comms - optional communicators for each level; this is to allow solving the coarser problems
           on smaller sets of processes. For processes that are not included in the computation
           you must pass MPI_COMM_NULL. Use comms = NULL to specify that all processes
           should participate in each level of problem.

   Level: intermediate

   Notes:
     If the number of levels is one then the multigrid uses the -mg_levels prefix
     for setting the level options rather than the -mg_coarse prefix.

     You can free the information in comms after this routine is called.

     The array of MPI communicators must contain MPI_COMM_NULL for those ranks that at each level
     are not participating in the coarser solve. For example, with 2 levels and 1 and 2 ranks on
     the two levels, rank 0 in the original communicator will pass in an array of 2 communicators
     of size 2 and 1, while rank 1 in the original communicator will pass in array of 2 communicators
     the first of size 2 and the second of value MPI_COMM_NULL since the rank 1 does not participate
     in the coarse grid solve.

     Since each coarser level may have a new MPI_Comm with fewer ranks than the previous, one
     must take special care in providing the restriction and interpolation operation. We recommend
     providing these as two step operations; first perform a standard restriction or interpolation on
     the full number of ranks for that level and then use an MPI call to copy the resulting vector
     array entries (after calls to VecGetArray()) to the smaller or larger number of ranks, note in both
     cases the MPI calls must be made on the larger of the two communicators. Traditional MPI send and
     recieves or MPI_AlltoAllv() could be used to do the reshuffling of the vector entries.

   Fortran Notes:
     Use comms = PETSC_NULL_MPI_COMM as the equivalent of NULL in the C interface. Note PETSC_NULL_MPI_COMM
     is not MPI_COMM_NULL. It is more like PETSC_NULL_INTEGER, PETSC_NULL_REAL etc.

.seealso: PCMGSetType(), PCMGGetLevels()
@*/
PetscErrorCode PCMGSetLevels(PC pc,PetscInt levels,MPI_Comm *comms)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc,PC_CLASSID,1);
  if (comms) PetscValidPointer(comms,3);
  CHKERRQ(PetscTryMethod(pc,"PCMGSetLevels_C",(PC,PetscInt,MPI_Comm*),(pc,levels,comms)));
  PetscFunctionReturn(0);
}

PetscErrorCode PCDestroy_MG(PC pc)
{
  PC_MG          *mg        = (PC_MG*)pc->data;
  PC_MG_Levels   **mglevels = mg->levels;
  PetscInt       i,n;

  PetscFunctionBegin;
  CHKERRQ(PCReset_MG(pc));
  if (mglevels) {
    n = mglevels[0]->levels;
    for (i=0; i<n; i++) {
      if (mglevels[i]->smoothd != mglevels[i]->smoothu) {
        CHKERRQ(KSPDestroy(&mglevels[i]->smoothd));
      }
      CHKERRQ(KSPDestroy(&mglevels[i]->smoothu));
      CHKERRQ(KSPDestroy(&mglevels[i]->cr));
      CHKERRQ(PetscFree(mglevels[i]));
    }
    CHKERRQ(PetscFree(mg->levels));
  }
  CHKERRQ(PetscFree(pc->data));
  CHKERRQ(PetscObjectComposeFunction((PetscObject)pc,"PCGetInterpolations_C",NULL));
  CHKERRQ(PetscObjectComposeFunction((PetscObject)pc,"PCGetCoarseOperators_C",NULL));
  PetscFunctionReturn(0);
}

/*
   PCApply_MG - Runs either an additive, multiplicative, Kaskadic
             or full cycle of multigrid.

  Note:
  A simple wrapper which calls PCMGMCycle(),PCMGACycle(), or PCMGFCycle().
*/
static PetscErrorCode PCApply_MG_Internal(PC pc,Vec b,Vec x,Mat B,Mat X,PetscBool transpose)
{
  PC_MG          *mg        = (PC_MG*)pc->data;
  PC_MG_Levels   **mglevels = mg->levels;
  PC             tpc;
  PetscInt       levels = mglevels[0]->levels,i;
  PetscBool      changeu,changed,matapp;

  PetscFunctionBegin;
  matapp = (PetscBool)(B && X);
  if (mg->stageApply) CHKERRQ(PetscLogStagePush(mg->stageApply));
  /* When the DM is supplying the matrix then it will not exist until here */
  for (i=0; i<levels; i++) {
    if (!mglevels[i]->A) {
      CHKERRQ(KSPGetOperators(mglevels[i]->smoothu,&mglevels[i]->A,NULL));
      CHKERRQ(PetscObjectReference((PetscObject)mglevels[i]->A));
    }
  }

  CHKERRQ(KSPGetPC(mglevels[levels-1]->smoothd,&tpc));
  CHKERRQ(PCPreSolveChangeRHS(tpc,&changed));
  CHKERRQ(KSPGetPC(mglevels[levels-1]->smoothu,&tpc));
  CHKERRQ(PCPreSolveChangeRHS(tpc,&changeu));
  if (!changeu && !changed) {
    if (matapp) {
      CHKERRQ(MatDestroy(&mglevels[levels-1]->B));
      mglevels[levels-1]->B = B;
    } else {
      CHKERRQ(VecDestroy(&mglevels[levels-1]->b));
      mglevels[levels-1]->b = b;
    }
  } else { /* if the smoother changes the rhs during PreSolve, we cannot use the input vector */
    if (matapp) {
      if (mglevels[levels-1]->B) {
        PetscInt  N1,N2;
        PetscBool flg;

        CHKERRQ(MatGetSize(mglevels[levels-1]->B,NULL,&N1));
        CHKERRQ(MatGetSize(B,NULL,&N2));
        CHKERRQ(PetscObjectTypeCompare((PetscObject)mglevels[levels-1]->B,((PetscObject)B)->type_name,&flg));
        if (N1 != N2 || !flg) {
          CHKERRQ(MatDestroy(&mglevels[levels-1]->B));
        }
      }
      if (!mglevels[levels-1]->B) {
        CHKERRQ(MatDuplicate(B,MAT_COPY_VALUES,&mglevels[levels-1]->B));
      } else {
        CHKERRQ(MatCopy(B,mglevels[levels-1]->B,SAME_NONZERO_PATTERN));
      }
    } else {
      if (!mglevels[levels-1]->b) {
        Vec *vec;

        CHKERRQ(KSPCreateVecs(mglevels[levels-1]->smoothd,1,&vec,0,NULL));
        mglevels[levels-1]->b = *vec;
        CHKERRQ(PetscFree(vec));
      }
      CHKERRQ(VecCopy(b,mglevels[levels-1]->b));
    }
  }
  if (matapp) { mglevels[levels-1]->X = X; }
  else { mglevels[levels-1]->x = x; }

  /* If coarser Xs are present, it means we have already block applied the PC at least once
     Reset operators if sizes/type do no match */
  if (matapp && levels > 1 && mglevels[levels-2]->X) {
    PetscInt  Xc,Bc;
    PetscBool flg;

    CHKERRQ(MatGetSize(mglevels[levels-2]->X,NULL,&Xc));
    CHKERRQ(MatGetSize(mglevels[levels-1]->B,NULL,&Bc));
    CHKERRQ(PetscObjectTypeCompare((PetscObject)mglevels[levels-2]->X,((PetscObject)mglevels[levels-1]->X)->type_name,&flg));
    if (Xc != Bc || !flg) {
      CHKERRQ(MatDestroy(&mglevels[levels-1]->R));
      for (i=0;i<levels-1;i++) {
        CHKERRQ(MatDestroy(&mglevels[i]->R));
        CHKERRQ(MatDestroy(&mglevels[i]->B));
        CHKERRQ(MatDestroy(&mglevels[i]->X));
      }
    }
  }

  if (mg->am == PC_MG_MULTIPLICATIVE) {
    if (matapp) CHKERRQ(MatZeroEntries(X));
    else CHKERRQ(VecZeroEntries(x));
    for (i=0; i<mg->cyclesperpcapply; i++) {
      CHKERRQ(PCMGMCycle_Private(pc,mglevels+levels-1,transpose,matapp,NULL));
    }
  } else if (mg->am == PC_MG_ADDITIVE) {
    CHKERRQ(PCMGACycle_Private(pc,mglevels,transpose,matapp));
  } else if (mg->am == PC_MG_KASKADE) {
    CHKERRQ(PCMGKCycle_Private(pc,mglevels,transpose,matapp));
  } else {
    CHKERRQ(PCMGFCycle_Private(pc,mglevels,transpose,matapp));
  }
  if (mg->stageApply) CHKERRQ(PetscLogStagePop());
  if (!changeu && !changed) {
    if (matapp) { mglevels[levels-1]->B = NULL; }
    else { mglevels[levels-1]->b = NULL; }
  }
  PetscFunctionReturn(0);
}

static PetscErrorCode PCApply_MG(PC pc,Vec b,Vec x)
{
  PetscFunctionBegin;
  CHKERRQ(PCApply_MG_Internal(pc,b,x,NULL,NULL,PETSC_FALSE));
  PetscFunctionReturn(0);
}

static PetscErrorCode PCApplyTranspose_MG(PC pc,Vec b,Vec x)
{
  PetscFunctionBegin;
  CHKERRQ(PCApply_MG_Internal(pc,b,x,NULL,NULL,PETSC_TRUE));
  PetscFunctionReturn(0);
}

static PetscErrorCode PCMatApply_MG(PC pc,Mat b,Mat x)
{
  PetscFunctionBegin;
  CHKERRQ(PCApply_MG_Internal(pc,NULL,NULL,b,x,PETSC_FALSE));
  PetscFunctionReturn(0);
}

PetscErrorCode PCSetFromOptions_MG(PetscOptionItems *PetscOptionsObject,PC pc)
{
  PetscInt         levels,cycles;
  PetscBool        flg, flg2;
  PC_MG            *mg = (PC_MG*)pc->data;
  PC_MG_Levels     **mglevels;
  PCMGType         mgtype;
  PCMGCycleType    mgctype;
  PCMGGalerkinType gtype;

  PetscFunctionBegin;
  levels = PetscMax(mg->nlevels,1);
  CHKERRQ(PetscOptionsHead(PetscOptionsObject,"Multigrid options"));
  CHKERRQ(PetscOptionsInt("-pc_mg_levels","Number of Levels","PCMGSetLevels",levels,&levels,&flg));
  if (!flg && !mg->levels && pc->dm) {
    CHKERRQ(DMGetRefineLevel(pc->dm,&levels));
    levels++;
    mg->usedmfornumberoflevels = PETSC_TRUE;
  }
  CHKERRQ(PCMGSetLevels(pc,levels,NULL));
  mglevels = mg->levels;

  mgctype = (PCMGCycleType) mglevels[0]->cycles;
  CHKERRQ(PetscOptionsEnum("-pc_mg_cycle_type","V cycle or for W-cycle","PCMGSetCycleType",PCMGCycleTypes,(PetscEnum)mgctype,(PetscEnum*)&mgctype,&flg));
  if (flg) {
    CHKERRQ(PCMGSetCycleType(pc,mgctype));
  }
  gtype = mg->galerkin;
  CHKERRQ(PetscOptionsEnum("-pc_mg_galerkin","Use Galerkin process to compute coarser operators","PCMGSetGalerkin",PCMGGalerkinTypes,(PetscEnum)gtype,(PetscEnum*)&gtype,&flg));
  if (flg) {
    CHKERRQ(PCMGSetGalerkin(pc,gtype));
  }
  flg2 = PETSC_FALSE;
  CHKERRQ(PetscOptionsBool("-pc_mg_adapt_interp","Adapt interpolation using some coarse space","PCMGSetAdaptInterpolation",PETSC_FALSE,&flg2,&flg));
  if (flg) CHKERRQ(PCMGSetAdaptInterpolation(pc, flg2));
  CHKERRQ(PetscOptionsInt("-pc_mg_adapt_interp_n","Size of the coarse space for adaptive interpolation","PCMGSetCoarseSpace",mg->Nc,&mg->Nc,&flg));
  CHKERRQ(PetscOptionsEnum("-pc_mg_adapt_interp_coarse_space","Type of coarse space: polynomial, harmonic, eigenvector, generalized_eigenvector","PCMGSetAdaptCoarseSpaceType",PCMGCoarseSpaceTypes,(PetscEnum)mg->coarseSpaceType,(PetscEnum*)&mg->coarseSpaceType,&flg));
  CHKERRQ(PetscOptionsBool("-pc_mg_mesp_monitor","Monitor the multilevel eigensolver","PCMGSetAdaptInterpolation",PETSC_FALSE,&mg->mespMonitor,&flg));
  flg2 = PETSC_FALSE;
  CHKERRQ(PetscOptionsBool("-pc_mg_adapt_cr","Monitor coarse space quality using Compatible Relaxation (CR)","PCMGSetAdaptCR",PETSC_FALSE,&flg2,&flg));
  if (flg) CHKERRQ(PCMGSetAdaptCR(pc, flg2));
  flg = PETSC_FALSE;
  CHKERRQ(PetscOptionsBool("-pc_mg_distinct_smoothup","Create separate smoothup KSP and append the prefix _up","PCMGSetDistinctSmoothUp",PETSC_FALSE,&flg,NULL));
  if (flg) {
    CHKERRQ(PCMGSetDistinctSmoothUp(pc));
  }
  mgtype = mg->am;
  CHKERRQ(PetscOptionsEnum("-pc_mg_type","Multigrid type","PCMGSetType",PCMGTypes,(PetscEnum)mgtype,(PetscEnum*)&mgtype,&flg));
  if (flg) {
    CHKERRQ(PCMGSetType(pc,mgtype));
  }
  if (mg->am == PC_MG_MULTIPLICATIVE) {
    CHKERRQ(PetscOptionsInt("-pc_mg_multiplicative_cycles","Number of cycles for each preconditioner step","PCMGMultiplicativeSetCycles",mg->cyclesperpcapply,&cycles,&flg));
    if (flg) {
      CHKERRQ(PCMGMultiplicativeSetCycles(pc,cycles));
    }
  }
  flg  = PETSC_FALSE;
  CHKERRQ(PetscOptionsBool("-pc_mg_log","Log times for each multigrid level","None",flg,&flg,NULL));
  if (flg) {
    PetscInt i;
    char     eventname[128];

    levels = mglevels[0]->levels;
    for (i=0; i<levels; i++) {
      sprintf(eventname,"MGSetup Level %d",(int)i);
      CHKERRQ(PetscLogEventRegister(eventname,((PetscObject)pc)->classid,&mglevels[i]->eventsmoothsetup));
      sprintf(eventname,"MGSmooth Level %d",(int)i);
      CHKERRQ(PetscLogEventRegister(eventname,((PetscObject)pc)->classid,&mglevels[i]->eventsmoothsolve));
      if (i) {
        sprintf(eventname,"MGResid Level %d",(int)i);
        CHKERRQ(PetscLogEventRegister(eventname,((PetscObject)pc)->classid,&mglevels[i]->eventresidual));
        sprintf(eventname,"MGInterp Level %d",(int)i);
        CHKERRQ(PetscLogEventRegister(eventname,((PetscObject)pc)->classid,&mglevels[i]->eventinterprestrict));
      }
    }

#if defined(PETSC_USE_LOG)
    {
      const char    *sname = "MG Apply";
      PetscStageLog stageLog;
      PetscInt      st;

      CHKERRQ(PetscLogGetStageLog(&stageLog));
      for (st = 0; st < stageLog->numStages; ++st) {
        PetscBool same;

        CHKERRQ(PetscStrcmp(stageLog->stageInfo[st].name, sname, &same));
        if (same) mg->stageApply = st;
      }
      if (!mg->stageApply) {
        CHKERRQ(PetscLogStageRegister(sname, &mg->stageApply));
      }
    }
#endif
  }
  CHKERRQ(PetscOptionsTail());
  /* Check option consistency */
  CHKERRQ(PCMGGetGalerkin(pc, &gtype));
  CHKERRQ(PCMGGetAdaptInterpolation(pc, &flg));
  PetscCheckFalse(flg && (gtype >= PC_MG_GALERKIN_NONE),PetscObjectComm((PetscObject) pc), PETSC_ERR_ARG_INCOMP, "Must use Galerkin coarse operators when adapting the interpolator");
  PetscFunctionReturn(0);
}

const char *const PCMGTypes[] = {"MULTIPLICATIVE","ADDITIVE","FULL","KASKADE","PCMGType","PC_MG",NULL};
const char *const PCMGCycleTypes[] = {"invalid","v","w","PCMGCycleType","PC_MG_CYCLE",NULL};
const char *const PCMGGalerkinTypes[] = {"both","pmat","mat","none","external","PCMGGalerkinType","PC_MG_GALERKIN",NULL};
const char *const PCMGCoarseSpaceTypes[] = {"polynomial","harmonic","eigenvector","generalized_eigenvector","PCMGCoarseSpaceType","PCMG_POLYNOMIAL",NULL};

#include <petscdraw.h>
PetscErrorCode PCView_MG(PC pc,PetscViewer viewer)
{
  PC_MG          *mg        = (PC_MG*)pc->data;
  PC_MG_Levels   **mglevels = mg->levels;
  PetscInt       levels = mglevels ? mglevels[0]->levels : 0,i;
  PetscBool      iascii,isbinary,isdraw;

  PetscFunctionBegin;
  CHKERRQ(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii));
  CHKERRQ(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary));
  CHKERRQ(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw));
  if (iascii) {
    const char *cyclename = levels ? (mglevels[0]->cycles == PC_MG_CYCLE_V ? "v" : "w") : "unknown";
    CHKERRQ(PetscViewerASCIIPrintf(viewer,"  type is %s, levels=%D cycles=%s\n", PCMGTypes[mg->am],levels,cyclename));
    if (mg->am == PC_MG_MULTIPLICATIVE) {
      CHKERRQ(PetscViewerASCIIPrintf(viewer,"    Cycles per PCApply=%d\n",mg->cyclesperpcapply));
    }
    if (mg->galerkin == PC_MG_GALERKIN_BOTH) {
      CHKERRQ(PetscViewerASCIIPrintf(viewer,"    Using Galerkin computed coarse grid matrices\n"));
    } else if (mg->galerkin == PC_MG_GALERKIN_PMAT) {
      CHKERRQ(PetscViewerASCIIPrintf(viewer,"    Using Galerkin computed coarse grid matrices for pmat\n"));
    } else if (mg->galerkin == PC_MG_GALERKIN_MAT) {
      CHKERRQ(PetscViewerASCIIPrintf(viewer,"    Using Galerkin computed coarse grid matrices for mat\n"));
    } else if (mg->galerkin == PC_MG_GALERKIN_EXTERNAL) {
      CHKERRQ(PetscViewerASCIIPrintf(viewer,"    Using externally compute Galerkin coarse grid matrices\n"));
    } else {
      CHKERRQ(PetscViewerASCIIPrintf(viewer,"    Not using Galerkin computed coarse grid matrices\n"));
    }
    if (mg->view) {
      CHKERRQ((*mg->view)(pc,viewer));
    }
    for (i=0; i<levels; i++) {
      if (!i) {
        CHKERRQ(PetscViewerASCIIPrintf(viewer,"Coarse grid solver -- level -------------------------------\n",i));
      } else {
        CHKERRQ(PetscViewerASCIIPrintf(viewer,"Down solver (pre-smoother) on level %D -------------------------------\n",i));
      }
      CHKERRQ(PetscViewerASCIIPushTab(viewer));
      CHKERRQ(KSPView(mglevels[i]->smoothd,viewer));
      CHKERRQ(PetscViewerASCIIPopTab(viewer));
      if (i && mglevels[i]->smoothd == mglevels[i]->smoothu) {
        CHKERRQ(PetscViewerASCIIPrintf(viewer,"Up solver (post-smoother) same as down solver (pre-smoother)\n"));
      } else if (i) {
        CHKERRQ(PetscViewerASCIIPrintf(viewer,"Up solver (post-smoother) on level %D -------------------------------\n",i));
        CHKERRQ(PetscViewerASCIIPushTab(viewer));
        CHKERRQ(KSPView(mglevels[i]->smoothu,viewer));
        CHKERRQ(PetscViewerASCIIPopTab(viewer));
      }
      if (i && mglevels[i]->cr) {
        CHKERRQ(PetscViewerASCIIPrintf(viewer,"CR solver on level %D -------------------------------\n",i));
        CHKERRQ(PetscViewerASCIIPushTab(viewer));
        CHKERRQ(KSPView(mglevels[i]->cr,viewer));
        CHKERRQ(PetscViewerASCIIPopTab(viewer));
      }
    }
  } else if (isbinary) {
    for (i=levels-1; i>=0; i--) {
      CHKERRQ(KSPView(mglevels[i]->smoothd,viewer));
      if (i && mglevels[i]->smoothd != mglevels[i]->smoothu) {
        CHKERRQ(KSPView(mglevels[i]->smoothu,viewer));
      }
    }
  } else if (isdraw) {
    PetscDraw draw;
    PetscReal x,w,y,bottom,th;
    CHKERRQ(PetscViewerDrawGetDraw(viewer,0,&draw));
    CHKERRQ(PetscDrawGetCurrentPoint(draw,&x,&y));
    CHKERRQ(PetscDrawStringGetSize(draw,NULL,&th));
    bottom = y - th;
    for (i=levels-1; i>=0; i--) {
      if (!mglevels[i]->smoothu || (mglevels[i]->smoothu == mglevels[i]->smoothd)) {
        CHKERRQ(PetscDrawPushCurrentPoint(draw,x,bottom));
        CHKERRQ(KSPView(mglevels[i]->smoothd,viewer));
        CHKERRQ(PetscDrawPopCurrentPoint(draw));
      } else {
        w    = 0.5*PetscMin(1.0-x,x);
        CHKERRQ(PetscDrawPushCurrentPoint(draw,x+w,bottom));
        CHKERRQ(KSPView(mglevels[i]->smoothd,viewer));
        CHKERRQ(PetscDrawPopCurrentPoint(draw));
        CHKERRQ(PetscDrawPushCurrentPoint(draw,x-w,bottom));
        CHKERRQ(KSPView(mglevels[i]->smoothu,viewer));
        CHKERRQ(PetscDrawPopCurrentPoint(draw));
      }
      CHKERRQ(PetscDrawGetBoundingBox(draw,NULL,&bottom,NULL,NULL));
      bottom -= th;
    }
  }
  PetscFunctionReturn(0);
}

#include <petsc/private/kspimpl.h>

/*
    Calls setup for the KSP on each level
*/
PetscErrorCode PCSetUp_MG(PC pc)
{
  PC_MG          *mg        = (PC_MG*)pc->data;
  PC_MG_Levels   **mglevels = mg->levels;
  PetscInt       i,n;
  PC             cpc;
  PetscBool      dump = PETSC_FALSE,opsset,use_amat,missinginterpolate = PETSC_FALSE;
  Mat            dA,dB;
  Vec            tvec;
  DM             *dms;
  PetscViewer    viewer = NULL;
  PetscBool      dAeqdB = PETSC_FALSE, needRestricts = PETSC_FALSE, doCR = PETSC_FALSE;

  PetscFunctionBegin;
  PetscCheck(mglevels,PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must set MG levels with PCMGSetLevels() before setting up");
  n = mglevels[0]->levels;
  /* FIX: Move this to PCSetFromOptions_MG? */
  if (mg->usedmfornumberoflevels) {
    PetscInt levels;
    CHKERRQ(DMGetRefineLevel(pc->dm,&levels));
    levels++;
    if (levels > n) { /* the problem is now being solved on a finer grid */
      CHKERRQ(PCMGSetLevels(pc,levels,NULL));
      n        = levels;
      CHKERRQ(PCSetFromOptions(pc)); /* it is bad to call this here, but otherwise will never be called for the new hierarchy */
      mglevels = mg->levels;
    }
  }
  CHKERRQ(KSPGetPC(mglevels[0]->smoothd,&cpc));

  /* If user did not provide fine grid operators OR operator was not updated since last global KSPSetOperators() */
  /* so use those from global PC */
  /* Is this what we always want? What if user wants to keep old one? */
  CHKERRQ(KSPGetOperatorsSet(mglevels[n-1]->smoothd,NULL,&opsset));
  if (opsset) {
    Mat mmat;
    CHKERRQ(KSPGetOperators(mglevels[n-1]->smoothd,NULL,&mmat));
    if (mmat == pc->pmat) opsset = PETSC_FALSE;
  }

  /* Create CR solvers */
  CHKERRQ(PCMGGetAdaptCR(pc, &doCR));
  if (doCR) {
    const char *prefix;

    CHKERRQ(PCGetOptionsPrefix(pc, &prefix));
    for (i = 1; i < n; ++i) {
      PC   ipc, cr;
      char crprefix[128];

      CHKERRQ(KSPCreate(PetscObjectComm((PetscObject) pc), &mglevels[i]->cr));
      CHKERRQ(KSPSetErrorIfNotConverged(mglevels[i]->cr, PETSC_FALSE));
      CHKERRQ(PetscObjectIncrementTabLevel((PetscObject) mglevels[i]->cr, (PetscObject) pc, n-i));
      CHKERRQ(KSPSetOptionsPrefix(mglevels[i]->cr, prefix));
      CHKERRQ(PetscObjectComposedDataSetInt((PetscObject) mglevels[i]->cr, PetscMGLevelId, mglevels[i]->level));
      CHKERRQ(KSPSetType(mglevels[i]->cr, KSPCHEBYSHEV));
      CHKERRQ(KSPSetConvergenceTest(mglevels[i]->cr, KSPConvergedSkip, NULL, NULL));
      CHKERRQ(KSPSetNormType(mglevels[i]->cr, KSP_NORM_PRECONDITIONED));
      CHKERRQ(KSPGetPC(mglevels[i]->cr, &ipc));

      CHKERRQ(PCSetType(ipc, PCCOMPOSITE));
      CHKERRQ(PCCompositeSetType(ipc, PC_COMPOSITE_MULTIPLICATIVE));
      CHKERRQ(PCCompositeAddPCType(ipc, PCSOR));
      CHKERRQ(CreateCR_Private(pc, i, &cr));
      CHKERRQ(PCCompositeAddPC(ipc, cr));
      CHKERRQ(PCDestroy(&cr));

      CHKERRQ(KSPSetTolerances(mglevels[i]->cr, PETSC_DEFAULT, PETSC_DEFAULT, PETSC_DEFAULT, mg->default_smoothd));
      CHKERRQ(KSPSetInitialGuessNonzero(mglevels[i]->cr, PETSC_TRUE));
      CHKERRQ(PetscSNPrintf(crprefix, 128, "mg_levels_%d_cr_", (int) i));
      CHKERRQ(KSPAppendOptionsPrefix(mglevels[i]->cr, crprefix));
      CHKERRQ(PetscLogObjectParent((PetscObject) pc, (PetscObject) mglevels[i]->cr));
    }
  }

  if (!opsset) {
    CHKERRQ(PCGetUseAmat(pc,&use_amat));
    if (use_amat) {
      CHKERRQ(PetscInfo(pc,"Using outer operators to define finest grid operator \n  because PCMGGetSmoother(pc,nlevels-1,&ksp);KSPSetOperators(ksp,...); was not called.\n"));
      CHKERRQ(KSPSetOperators(mglevels[n-1]->smoothd,pc->mat,pc->pmat));
    } else {
      CHKERRQ(PetscInfo(pc,"Using matrix (pmat) operators to define finest grid operator \n  because PCMGGetSmoother(pc,nlevels-1,&ksp);KSPSetOperators(ksp,...); was not called.\n"));
      CHKERRQ(KSPSetOperators(mglevels[n-1]->smoothd,pc->pmat,pc->pmat));
    }
  }

  for (i=n-1; i>0; i--) {
    if (!(mglevels[i]->interpolate || mglevels[i]->restrct)) {
      missinginterpolate = PETSC_TRUE;
      continue;
    }
  }

  CHKERRQ(KSPGetOperators(mglevels[n-1]->smoothd,&dA,&dB));
  if (dA == dB) dAeqdB = PETSC_TRUE;
  if ((mg->galerkin == PC_MG_GALERKIN_NONE) || (((mg->galerkin == PC_MG_GALERKIN_PMAT) || (mg->galerkin == PC_MG_GALERKIN_MAT)) && !dAeqdB)) {
    needRestricts = PETSC_TRUE;  /* user must compute either mat, pmat, or both so must restrict x to coarser levels */
  }

  /*
   Skipping if user has provided all interpolation/restriction needed (since DM might not be able to produce them (when coming from SNES/TS)
   Skipping for galerkin==2 (externally managed hierarchy such as ML and GAMG). Cleaner logic here would be great. Wrap ML/GAMG as DMs?
  */
  if (missinginterpolate && pc->dm && mg->galerkin != PC_MG_GALERKIN_EXTERNAL && !pc->setupcalled) {
        /* construct the interpolation from the DMs */
    Mat p;
    Vec rscale;
    CHKERRQ(PetscMalloc1(n,&dms));
    dms[n-1] = pc->dm;
    /* Separately create them so we do not get DMKSP interference between levels */
    for (i=n-2; i>-1; i--) CHKERRQ(DMCoarsen(dms[i+1],MPI_COMM_NULL,&dms[i]));
        /*
           Force the mat type of coarse level operator to be AIJ because usually we want to use LU for coarse level.
           Notice that it can be overwritten by -mat_type because KSPSetUp() reads command line options.
           But it is safe to use -dm_mat_type.

           The mat type should not be hardcoded like this, we need to find a better way.
    CHKERRQ(DMSetMatType(dms[0],MATAIJ));
    */
    for (i=n-2; i>-1; i--) {
      DMKSP     kdm;
      PetscBool dmhasrestrict, dmhasinject;
      CHKERRQ(KSPSetDM(mglevels[i]->smoothd,dms[i]));
      if (!needRestricts) CHKERRQ(KSPSetDMActive(mglevels[i]->smoothd,PETSC_FALSE));
      if (mglevels[i]->smoothd != mglevels[i]->smoothu) {
        CHKERRQ(KSPSetDM(mglevels[i]->smoothu,dms[i]));
        if (!needRestricts) CHKERRQ(KSPSetDMActive(mglevels[i]->smoothu,PETSC_FALSE));
      }
      if (mglevels[i]->cr) {
        CHKERRQ(KSPSetDM(mglevels[i]->cr,dms[i]));
        if (!needRestricts) CHKERRQ(KSPSetDMActive(mglevels[i]->cr,PETSC_FALSE));
      }
      CHKERRQ(DMGetDMKSPWrite(dms[i],&kdm));
      /* Ugly hack so that the next KSPSetUp() will use the RHS that we set. A better fix is to change dmActive to take
       * a bitwise OR of computing the matrix, RHS, and initial iterate. */
      kdm->ops->computerhs = NULL;
      kdm->rhsctx          = NULL;
      if (!mglevels[i+1]->interpolate) {
        CHKERRQ(DMCreateInterpolation(dms[i],dms[i+1],&p,&rscale));
        CHKERRQ(PCMGSetInterpolation(pc,i+1,p));
        if (rscale) CHKERRQ(PCMGSetRScale(pc,i+1,rscale));
        CHKERRQ(VecDestroy(&rscale));
        CHKERRQ(MatDestroy(&p));
      }
      CHKERRQ(DMHasCreateRestriction(dms[i],&dmhasrestrict));
      if (dmhasrestrict && !mglevels[i+1]->restrct) {
        CHKERRQ(DMCreateRestriction(dms[i],dms[i+1],&p));
        CHKERRQ(PCMGSetRestriction(pc,i+1,p));
        CHKERRQ(MatDestroy(&p));
      }
      CHKERRQ(DMHasCreateInjection(dms[i],&dmhasinject));
      if (dmhasinject && !mglevels[i+1]->inject) {
        CHKERRQ(DMCreateInjection(dms[i],dms[i+1],&p));
        CHKERRQ(PCMGSetInjection(pc,i+1,p));
        CHKERRQ(MatDestroy(&p));
      }
    }

    for (i=n-2; i>-1; i--) CHKERRQ(DMDestroy(&dms[i]));
    CHKERRQ(PetscFree(dms));
  }

  if (pc->dm && !pc->setupcalled) {
    /* finest smoother also gets DM but it is not active, independent of whether galerkin==PC_MG_GALERKIN_EXTERNAL */
    CHKERRQ(KSPSetDM(mglevels[n-1]->smoothd,pc->dm));
    CHKERRQ(KSPSetDMActive(mglevels[n-1]->smoothd,PETSC_FALSE));
    if (mglevels[n-1]->smoothd != mglevels[n-1]->smoothu) {
      CHKERRQ(KSPSetDM(mglevels[n-1]->smoothu,pc->dm));
      CHKERRQ(KSPSetDMActive(mglevels[n-1]->smoothu,PETSC_FALSE));
    }
    if (mglevels[n-1]->cr) {
      CHKERRQ(KSPSetDM(mglevels[n-1]->cr,pc->dm));
      CHKERRQ(KSPSetDMActive(mglevels[n-1]->cr,PETSC_FALSE));
    }
  }

  if (mg->galerkin < PC_MG_GALERKIN_NONE) {
    Mat       A,B;
    PetscBool doA = PETSC_FALSE,doB = PETSC_FALSE;
    MatReuse  reuse = MAT_INITIAL_MATRIX;

    if ((mg->galerkin == PC_MG_GALERKIN_PMAT) || (mg->galerkin == PC_MG_GALERKIN_BOTH)) doB = PETSC_TRUE;
    if ((mg->galerkin == PC_MG_GALERKIN_MAT) || ((mg->galerkin == PC_MG_GALERKIN_BOTH) && (dA != dB))) doA = PETSC_TRUE;
    if (pc->setupcalled) reuse = MAT_REUSE_MATRIX;
    for (i=n-2; i>-1; i--) {
      PetscCheckFalse(!mglevels[i+1]->restrct && !mglevels[i+1]->interpolate,PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must provide interpolation or restriction for each MG level except level 0");
      if (!mglevels[i+1]->interpolate) {
        CHKERRQ(PCMGSetInterpolation(pc,i+1,mglevels[i+1]->restrct));
      }
      if (!mglevels[i+1]->restrct) {
        CHKERRQ(PCMGSetRestriction(pc,i+1,mglevels[i+1]->interpolate));
      }
      if (reuse == MAT_REUSE_MATRIX) {
        CHKERRQ(KSPGetOperators(mglevels[i]->smoothd,&A,&B));
      }
      if (doA) {
        CHKERRQ(MatGalerkin(mglevels[i+1]->restrct,dA,mglevels[i+1]->interpolate,reuse,1.0,&A));
      }
      if (doB) {
        CHKERRQ(MatGalerkin(mglevels[i+1]->restrct,dB,mglevels[i+1]->interpolate,reuse,1.0,&B));
      }
      /* the management of the PetscObjectReference() and PetscObjecDereference() below is rather delicate */
      if (!doA && dAeqdB) {
        if (reuse == MAT_INITIAL_MATRIX) CHKERRQ(PetscObjectReference((PetscObject)B));
        A = B;
      } else if (!doA && reuse == MAT_INITIAL_MATRIX) {
        CHKERRQ(KSPGetOperators(mglevels[i]->smoothd,&A,NULL));
        CHKERRQ(PetscObjectReference((PetscObject)A));
      }
      if (!doB && dAeqdB) {
        if (reuse == MAT_INITIAL_MATRIX) CHKERRQ(PetscObjectReference((PetscObject)A));
        B = A;
      } else if (!doB && reuse == MAT_INITIAL_MATRIX) {
        CHKERRQ(KSPGetOperators(mglevels[i]->smoothd,NULL,&B));
        CHKERRQ(PetscObjectReference((PetscObject)B));
      }
      if (reuse == MAT_INITIAL_MATRIX) {
        CHKERRQ(KSPSetOperators(mglevels[i]->smoothd,A,B));
        CHKERRQ(PetscObjectDereference((PetscObject)A));
        CHKERRQ(PetscObjectDereference((PetscObject)B));
      }
      dA = A;
      dB = B;
    }
  }

  /* Adapt interpolation matrices */
  if (mg->adaptInterpolation) {
    mg->Nc = mg->Nc < 0 ? 6 : mg->Nc; /* Default to 6 modes */
    for (i = 0; i < n; ++i) {
      CHKERRQ(PCMGComputeCoarseSpace_Internal(pc, i, mg->coarseSpaceType, mg->Nc, !i ? NULL : mglevels[i-1]->coarseSpace, &mglevels[i]->coarseSpace));
      if (i) CHKERRQ(PCMGAdaptInterpolator_Internal(pc, i, mglevels[i-1]->smoothu, mglevels[i]->smoothu, mg->Nc, mglevels[i-1]->coarseSpace, mglevels[i]->coarseSpace));
    }
    for (i = n-2; i > -1; --i) {
      CHKERRQ(PCMGRecomputeLevelOperators_Internal(pc, i));
    }
  }

  if (needRestricts && pc->dm) {
    for (i=n-2; i>=0; i--) {
      DM  dmfine,dmcoarse;
      Mat Restrict,Inject;
      Vec rscale;
      CHKERRQ(KSPGetDM(mglevels[i+1]->smoothd,&dmfine));
      CHKERRQ(KSPGetDM(mglevels[i]->smoothd,&dmcoarse));
      CHKERRQ(PCMGGetRestriction(pc,i+1,&Restrict));
      CHKERRQ(PCMGGetRScale(pc,i+1,&rscale));
      CHKERRQ(PCMGGetInjection(pc,i+1,&Inject));
      CHKERRQ(DMRestrict(dmfine,Restrict,rscale,Inject,dmcoarse));
    }
  }

  if (!pc->setupcalled) {
    for (i=0; i<n; i++) {
      CHKERRQ(KSPSetFromOptions(mglevels[i]->smoothd));
    }
    for (i=1; i<n; i++) {
      if (mglevels[i]->smoothu && (mglevels[i]->smoothu != mglevels[i]->smoothd)) {
        CHKERRQ(KSPSetFromOptions(mglevels[i]->smoothu));
      }
      if (mglevels[i]->cr) {
        CHKERRQ(KSPSetFromOptions(mglevels[i]->cr));
      }
    }
    /* insure that if either interpolation or restriction is set the other other one is set */
    for (i=1; i<n; i++) {
      CHKERRQ(PCMGGetInterpolation(pc,i,NULL));
      CHKERRQ(PCMGGetRestriction(pc,i,NULL));
    }
    for (i=0; i<n-1; i++) {
      if (!mglevels[i]->b) {
        Vec *vec;
        CHKERRQ(KSPCreateVecs(mglevels[i]->smoothd,1,&vec,0,NULL));
        CHKERRQ(PCMGSetRhs(pc,i,*vec));
        CHKERRQ(VecDestroy(vec));
        CHKERRQ(PetscFree(vec));
      }
      if (!mglevels[i]->r && i) {
        CHKERRQ(VecDuplicate(mglevels[i]->b,&tvec));
        CHKERRQ(PCMGSetR(pc,i,tvec));
        CHKERRQ(VecDestroy(&tvec));
      }
      if (!mglevels[i]->x) {
        CHKERRQ(VecDuplicate(mglevels[i]->b,&tvec));
        CHKERRQ(PCMGSetX(pc,i,tvec));
        CHKERRQ(VecDestroy(&tvec));
      }
      if (doCR) {
        CHKERRQ(VecDuplicate(mglevels[i]->b,&mglevels[i]->crx));
        CHKERRQ(VecDuplicate(mglevels[i]->b,&mglevels[i]->crb));
        CHKERRQ(VecZeroEntries(mglevels[i]->crb));
      }
    }
    if (n != 1 && !mglevels[n-1]->r) {
      /* PCMGSetR() on the finest level if user did not supply it */
      Vec *vec;
      CHKERRQ(KSPCreateVecs(mglevels[n-1]->smoothd,1,&vec,0,NULL));
      CHKERRQ(PCMGSetR(pc,n-1,*vec));
      CHKERRQ(VecDestroy(vec));
      CHKERRQ(PetscFree(vec));
    }
    if (doCR) {
      CHKERRQ(VecDuplicate(mglevels[n-1]->r, &mglevels[n-1]->crx));
      CHKERRQ(VecDuplicate(mglevels[n-1]->r, &mglevels[n-1]->crb));
      CHKERRQ(VecZeroEntries(mglevels[n-1]->crb));
    }
  }

  if (pc->dm) {
    /* need to tell all the coarser levels to rebuild the matrix using the DM for that level */
    for (i=0; i<n-1; i++) {
      if (mglevels[i]->smoothd->setupstage != KSP_SETUP_NEW) mglevels[i]->smoothd->setupstage = KSP_SETUP_NEWMATRIX;
    }
  }

  for (i=1; i<n; i++) {
    if (mglevels[i]->smoothu == mglevels[i]->smoothd || mg->am == PC_MG_FULL || mg->am == PC_MG_KASKADE || mg->cyclesperpcapply > 1) {
      /* if doing only down then initial guess is zero */
      CHKERRQ(KSPSetInitialGuessNonzero(mglevels[i]->smoothd,PETSC_TRUE));
    }
    if (mglevels[i]->cr) CHKERRQ(KSPSetInitialGuessNonzero(mglevels[i]->cr,PETSC_TRUE));
    if (mglevels[i]->eventsmoothsetup) CHKERRQ(PetscLogEventBegin(mglevels[i]->eventsmoothsetup,0,0,0,0));
    CHKERRQ(KSPSetUp(mglevels[i]->smoothd));
    if (mglevels[i]->smoothd->reason == KSP_DIVERGED_PC_FAILED) {
      pc->failedreason = PC_SUBPC_ERROR;
    }
    if (mglevels[i]->eventsmoothsetup) CHKERRQ(PetscLogEventEnd(mglevels[i]->eventsmoothsetup,0,0,0,0));
    if (!mglevels[i]->residual) {
      Mat mat;
      CHKERRQ(KSPGetOperators(mglevels[i]->smoothd,&mat,NULL));
      CHKERRQ(PCMGSetResidual(pc,i,PCMGResidualDefault,mat));
    }
    if (!mglevels[i]->residualtranspose) {
      Mat mat;
      CHKERRQ(KSPGetOperators(mglevels[i]->smoothd,&mat,NULL));
      CHKERRQ(PCMGSetResidualTranspose(pc,i,PCMGResidualTransposeDefault,mat));
    }
  }
  for (i=1; i<n; i++) {
    if (mglevels[i]->smoothu && mglevels[i]->smoothu != mglevels[i]->smoothd) {
      Mat downmat,downpmat;

      /* check if operators have been set for up, if not use down operators to set them */
      CHKERRQ(KSPGetOperatorsSet(mglevels[i]->smoothu,&opsset,NULL));
      if (!opsset) {
        CHKERRQ(KSPGetOperators(mglevels[i]->smoothd,&downmat,&downpmat));
        CHKERRQ(KSPSetOperators(mglevels[i]->smoothu,downmat,downpmat));
      }

      CHKERRQ(KSPSetInitialGuessNonzero(mglevels[i]->smoothu,PETSC_TRUE));
      if (mglevels[i]->eventsmoothsetup) CHKERRQ(PetscLogEventBegin(mglevels[i]->eventsmoothsetup,0,0,0,0));
      CHKERRQ(KSPSetUp(mglevels[i]->smoothu));
      if (mglevels[i]->smoothu->reason == KSP_DIVERGED_PC_FAILED) {
        pc->failedreason = PC_SUBPC_ERROR;
      }
      if (mglevels[i]->eventsmoothsetup) CHKERRQ(PetscLogEventEnd(mglevels[i]->eventsmoothsetup,0,0,0,0));
    }
    if (mglevels[i]->cr) {
      Mat downmat,downpmat;

      /* check if operators have been set for up, if not use down operators to set them */
      CHKERRQ(KSPGetOperatorsSet(mglevels[i]->cr,&opsset,NULL));
      if (!opsset) {
        CHKERRQ(KSPGetOperators(mglevels[i]->smoothd,&downmat,&downpmat));
        CHKERRQ(KSPSetOperators(mglevels[i]->cr,downmat,downpmat));
      }

      CHKERRQ(KSPSetInitialGuessNonzero(mglevels[i]->cr,PETSC_TRUE));
      if (mglevels[i]->eventsmoothsetup) CHKERRQ(PetscLogEventBegin(mglevels[i]->eventsmoothsetup,0,0,0,0));
      CHKERRQ(KSPSetUp(mglevels[i]->cr));
      if (mglevels[i]->cr->reason == KSP_DIVERGED_PC_FAILED) {
        pc->failedreason = PC_SUBPC_ERROR;
      }
      if (mglevels[i]->eventsmoothsetup) CHKERRQ(PetscLogEventEnd(mglevels[i]->eventsmoothsetup,0,0,0,0));
    }
  }

  if (mglevels[0]->eventsmoothsetup) CHKERRQ(PetscLogEventBegin(mglevels[0]->eventsmoothsetup,0,0,0,0));
  CHKERRQ(KSPSetUp(mglevels[0]->smoothd));
  if (mglevels[0]->smoothd->reason == KSP_DIVERGED_PC_FAILED) {
    pc->failedreason = PC_SUBPC_ERROR;
  }
  if (mglevels[0]->eventsmoothsetup) CHKERRQ(PetscLogEventEnd(mglevels[0]->eventsmoothsetup,0,0,0,0));

  /*
     Dump the interpolation/restriction matrices plus the
   Jacobian/stiffness on each level. This allows MATLAB users to
   easily check if the Galerkin condition A_c = R A_f R^T is satisfied.

   Only support one or the other at the same time.
  */
#if defined(PETSC_USE_SOCKET_VIEWER)
  CHKERRQ(PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_mg_dump_matlab",&dump,NULL));
  if (dump) viewer = PETSC_VIEWER_SOCKET_(PetscObjectComm((PetscObject)pc));
  dump = PETSC_FALSE;
#endif
  CHKERRQ(PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_mg_dump_binary",&dump,NULL));
  if (dump) viewer = PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)pc));

  if (viewer) {
    for (i=1; i<n; i++) {
      CHKERRQ(MatView(mglevels[i]->restrct,viewer));
    }
    for (i=0; i<n; i++) {
      CHKERRQ(KSPGetPC(mglevels[i]->smoothd,&pc));
      CHKERRQ(MatView(pc->mat,viewer));
    }
  }
  PetscFunctionReturn(0);
}

/* -------------------------------------------------------------------------------------*/

PetscErrorCode PCMGGetLevels_MG(PC pc, PetscInt *levels)
{
  PC_MG *mg = (PC_MG *) pc->data;

  PetscFunctionBegin;
  *levels = mg->nlevels;
  PetscFunctionReturn(0);
}

/*@
   PCMGGetLevels - Gets the number of levels to use with MG.

   Not Collective

   Input Parameter:
.  pc - the preconditioner context

   Output parameter:
.  levels - the number of levels

   Level: advanced

.seealso: PCMGSetLevels()
@*/
PetscErrorCode PCMGGetLevels(PC pc,PetscInt *levels)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc,PC_CLASSID,1);
  PetscValidIntPointer(levels,2);
  *levels = 0;
  CHKERRQ(PetscTryMethod(pc,"PCMGGetLevels_C",(PC,PetscInt*),(pc,levels)));
  PetscFunctionReturn(0);
}

/*@
   PCMGGetGridComplexity - compute operator and grid complexity of MG hierarchy

   Input Parameter:
.  pc - the preconditioner context

   Output Parameters:
+  gc - grid complexity = sum_i(n_i) / n_0
-  oc - operator complexity = sum_i(nnz_i) / nnz_0

   Level: advanced

.seealso: PCMGGetLevels()
@*/
PetscErrorCode PCMGGetGridComplexity(PC pc, PetscReal *gc, PetscReal *oc)
{
  PC_MG          *mg      = (PC_MG*)pc->data;
  PC_MG_Levels   **mglevels = mg->levels;
  PetscInt       lev,N;
  PetscLogDouble nnz0 = 0, sgc = 0, soc = 0, n0 = 0;
  MatInfo        info;

  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc,PC_CLASSID,1);
  if (gc) PetscValidRealPointer(gc,2);
  if (oc) PetscValidRealPointer(oc,3);
  if (!pc->setupcalled) {
    if (gc) *gc = 0;
    if (oc) *oc = 0;
    PetscFunctionReturn(0);
  }
  PetscCheck(mg->nlevels > 0,PETSC_COMM_SELF,PETSC_ERR_PLIB,"MG has no levels");
  for (lev=0; lev<mg->nlevels; lev++) {
    Mat dB;
    CHKERRQ(KSPGetOperators(mglevels[lev]->smoothd,NULL,&dB));
    CHKERRQ(MatGetInfo(dB,MAT_GLOBAL_SUM,&info)); /* global reduction */
    CHKERRQ(MatGetSize(dB,&N,NULL));
    sgc += N;
    soc += info.nz_used;
    if (lev==mg->nlevels-1) {nnz0 = info.nz_used; n0 = N;}
  }
  if (n0 > 0 && gc) *gc = (PetscReal)(sgc/n0);
  else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Number for grid points on finest level is not available");
  if (nnz0 > 0 && oc) *oc = (PetscReal)(soc/nnz0);
  PetscFunctionReturn(0);
}

/*@
   PCMGSetType - Determines the form of multigrid to use:
   multiplicative, additive, full, or the Kaskade algorithm.

   Logically Collective on PC

   Input Parameters:
+  pc - the preconditioner context
-  form - multigrid form, one of PC_MG_MULTIPLICATIVE, PC_MG_ADDITIVE,
   PC_MG_FULL, PC_MG_KASKADE

   Options Database Key:
.  -pc_mg_type <form> - Sets <form>, one of multiplicative,
   additive, full, kaskade

   Level: advanced

.seealso: PCMGSetLevels()
@*/
PetscErrorCode  PCMGSetType(PC pc,PCMGType form)
{
  PC_MG *mg = (PC_MG*)pc->data;

  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc,PC_CLASSID,1);
  PetscValidLogicalCollectiveEnum(pc,form,2);
  mg->am = form;
  if (form == PC_MG_MULTIPLICATIVE) pc->ops->applyrichardson = PCApplyRichardson_MG;
  else pc->ops->applyrichardson = NULL;
  PetscFunctionReturn(0);
}

/*@
   PCMGGetType - Determines the form of multigrid to use:
   multiplicative, additive, full, or the Kaskade algorithm.

   Logically Collective on PC

   Input Parameter:
.  pc - the preconditioner context

   Output Parameter:
.  type - one of PC_MG_MULTIPLICATIVE, PC_MG_ADDITIVE,PC_MG_FULL, PC_MG_KASKADE

   Level: advanced

.seealso: PCMGSetLevels()
@*/
PetscErrorCode  PCMGGetType(PC pc,PCMGType *type)
{
  PC_MG *mg = (PC_MG*)pc->data;

  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc,PC_CLASSID,1);
  *type = mg->am;
  PetscFunctionReturn(0);
}

/*@
   PCMGSetCycleType - Sets the type cycles to use.  Use PCMGSetCycleTypeOnLevel() for more
   complicated cycling.

   Logically Collective on PC

   Input Parameters:
+  pc - the multigrid context
-  n - either PC_MG_CYCLE_V or PC_MG_CYCLE_W

   Options Database Key:
.  -pc_mg_cycle_type <v,w> - provide the cycle desired

   Level: advanced

.seealso: PCMGSetCycleTypeOnLevel()
@*/
PetscErrorCode  PCMGSetCycleType(PC pc,PCMGCycleType n)
{
  PC_MG        *mg        = (PC_MG*)pc->data;
  PC_MG_Levels **mglevels = mg->levels;
  PetscInt     i,levels;

  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc,PC_CLASSID,1);
  PetscValidLogicalCollectiveEnum(pc,n,2);
  PetscCheck(mglevels,PetscObjectComm((PetscObject)pc),PETSC_ERR_ORDER,"Must set MG levels with PCMGSetLevels() before calling");
  levels = mglevels[0]->levels;
  for (i=0; i<levels; i++) mglevels[i]->cycles = n;
  PetscFunctionReturn(0);
}

/*@
   PCMGMultiplicativeSetCycles - Sets the number of cycles to use for each preconditioner step
         of multigrid when PCMGType of PC_MG_MULTIPLICATIVE is used

   Logically Collective on PC

   Input Parameters:
+  pc - the multigrid context
-  n - number of cycles (default is 1)

   Options Database Key:
.  -pc_mg_multiplicative_cycles n - set the number of cycles

   Level: advanced

   Notes:
    This is not associated with setting a v or w cycle, that is set with PCMGSetCycleType()

.seealso: PCMGSetCycleTypeOnLevel(), PCMGSetCycleType()
@*/
PetscErrorCode  PCMGMultiplicativeSetCycles(PC pc,PetscInt n)
{
  PC_MG        *mg        = (PC_MG*)pc->data;

  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc,PC_CLASSID,1);
  PetscValidLogicalCollectiveInt(pc,n,2);
  mg->cyclesperpcapply = n;
  PetscFunctionReturn(0);
}

PetscErrorCode PCMGSetGalerkin_MG(PC pc,PCMGGalerkinType use)
{
  PC_MG *mg = (PC_MG*)pc->data;

  PetscFunctionBegin;
  mg->galerkin = use;
  PetscFunctionReturn(0);
}

/*@
   PCMGSetGalerkin - Causes the coarser grid matrices to be computed from the
      finest grid via the Galerkin process: A_i-1 = r_i * A_i * p_i

   Logically Collective on PC

   Input Parameters:
+  pc - the multigrid context
-  use - one of PC_MG_GALERKIN_BOTH,PC_MG_GALERKIN_PMAT,PC_MG_GALERKIN_MAT, or PC_MG_GALERKIN_NONE

   Options Database Key:
.  -pc_mg_galerkin <both,pmat,mat,none> - set the matrices to form via the Galerkin process

   Level: intermediate

   Notes:
    Some codes that use PCMG such as PCGAMG use Galerkin internally while constructing the hierarchy and thus do not
     use the PCMG construction of the coarser grids.

.seealso: PCMGGetGalerkin(), PCMGGalerkinType

@*/
PetscErrorCode PCMGSetGalerkin(PC pc,PCMGGalerkinType use)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc,PC_CLASSID,1);
  CHKERRQ(PetscTryMethod(pc,"PCMGSetGalerkin_C",(PC,PCMGGalerkinType),(pc,use)));
  PetscFunctionReturn(0);
}

/*@
   PCMGGetGalerkin - Checks if Galerkin multigrid is being used, i.e.
      A_i-1 = r_i * A_i * p_i

   Not Collective

   Input Parameter:
.  pc - the multigrid context

   Output Parameter:
.  galerkin - one of PC_MG_GALERKIN_BOTH,PC_MG_GALERKIN_PMAT,PC_MG_GALERKIN_MAT, PC_MG_GALERKIN_NONE, or PC_MG_GALERKIN_EXTERNAL

   Level: intermediate

.seealso: PCMGSetGalerkin(), PCMGGalerkinType

@*/
PetscErrorCode  PCMGGetGalerkin(PC pc,PCMGGalerkinType  *galerkin)
{
  PC_MG *mg = (PC_MG*)pc->data;

  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc,PC_CLASSID,1);
  *galerkin = mg->galerkin;
  PetscFunctionReturn(0);
}

PetscErrorCode PCMGSetAdaptInterpolation_MG(PC pc, PetscBool adapt)
{
  PC_MG *mg = (PC_MG *) pc->data;

  PetscFunctionBegin;
  mg->adaptInterpolation = adapt;
  PetscFunctionReturn(0);
}

PetscErrorCode PCMGGetAdaptInterpolation_MG(PC pc, PetscBool *adapt)
{
  PC_MG *mg = (PC_MG *) pc->data;

  PetscFunctionBegin;
  *adapt = mg->adaptInterpolation;
  PetscFunctionReturn(0);
}

PetscErrorCode PCMGSetAdaptCR_MG(PC pc, PetscBool cr)
{
  PC_MG *mg = (PC_MG *) pc->data;

  PetscFunctionBegin;
  mg->compatibleRelaxation = cr;
  PetscFunctionReturn(0);
}

PetscErrorCode PCMGGetAdaptCR_MG(PC pc, PetscBool *cr)
{
  PC_MG *mg = (PC_MG *) pc->data;

  PetscFunctionBegin;
  *cr = mg->compatibleRelaxation;
  PetscFunctionReturn(0);
}

/*@
  PCMGSetAdaptInterpolation - Adapt the interpolator based upon a vector space which should be accurately captured by the next coarser mesh, and thus accurately interpolated.

  Logically Collective on PC

  Input Parameters:
+ pc    - the multigrid context
- adapt - flag for adaptation of the interpolator

  Options Database Keys:
+ -pc_mg_adapt_interp                     - Turn on adaptation
. -pc_mg_adapt_interp_n <int>             - The number of modes to use, should be divisible by dimension
- -pc_mg_adapt_interp_coarse_space <type> - The type of coarse space: polynomial, harmonic, eigenvector, generalized_eigenvector

  Level: intermediate

.keywords: MG, set, Galerkin
.seealso: PCMGGetAdaptInterpolation(), PCMGSetGalerkin()
@*/
PetscErrorCode PCMGSetAdaptInterpolation(PC pc, PetscBool adapt)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
  CHKERRQ(PetscTryMethod(pc,"PCMGSetAdaptInterpolation_C",(PC,PetscBool),(pc,adapt)));
  PetscFunctionReturn(0);
}

/*@
  PCMGGetAdaptInterpolation - Get the flag to adapt the interpolator based upon a vector space which should be accurately captured by the next coarser mesh, and thus accurately interpolated.

  Not collective

  Input Parameter:
. pc    - the multigrid context

  Output Parameter:
. adapt - flag for adaptation of the interpolator

  Level: intermediate

.keywords: MG, set, Galerkin
.seealso: PCMGSetAdaptInterpolation(), PCMGSetGalerkin()
@*/
PetscErrorCode PCMGGetAdaptInterpolation(PC pc, PetscBool *adapt)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
  PetscValidPointer(adapt, 2);
  CHKERRQ(PetscUseMethod(pc,"PCMGGetAdaptInterpolation_C",(PC,PetscBool*),(pc,adapt)));
  PetscFunctionReturn(0);
}

/*@
  PCMGSetAdaptCR - Monitor the coarse space quality using an auxiliary solve with compatible relaxation.

  Logically Collective on PC

  Input Parameters:
+ pc - the multigrid context
- cr - flag for compatible relaxation

  Options Database Keys:
. -pc_mg_adapt_cr - Turn on compatible relaxation

  Level: intermediate

.keywords: MG, set, Galerkin
.seealso: PCMGGetAdaptCR(), PCMGSetAdaptInterpolation(), PCMGSetGalerkin()
@*/
PetscErrorCode PCMGSetAdaptCR(PC pc, PetscBool cr)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
  CHKERRQ(PetscTryMethod(pc,"PCMGSetAdaptCR_C",(PC,PetscBool),(pc,cr)));
  PetscFunctionReturn(0);
}

/*@
  PCMGGetAdaptCR - Get the flag to monitor coarse space quality using an auxiliary solve with compatible relaxation.

  Not collective

  Input Parameter:
. pc    - the multigrid context

  Output Parameter:
. cr - flag for compatible relaxaion

  Level: intermediate

.keywords: MG, set, Galerkin
.seealso: PCMGSetAdaptCR(), PCMGGetAdaptInterpolation(), PCMGSetGalerkin()
@*/
PetscErrorCode PCMGGetAdaptCR(PC pc, PetscBool *cr)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
  PetscValidPointer(cr, 2);
  CHKERRQ(PetscUseMethod(pc,"PCMGGetAdaptCR_C",(PC,PetscBool*),(pc,cr)));
  PetscFunctionReturn(0);
}

/*@
   PCMGSetNumberSmooth - Sets the number of pre and post-smoothing steps to use
   on all levels.  Use PCMGDistinctSmoothUp() to create separate up and down smoothers if you want different numbers of
   pre- and post-smoothing steps.

   Logically Collective on PC

   Input Parameters:
+  mg - the multigrid context
-  n - the number of smoothing steps

   Options Database Key:
.  -mg_levels_ksp_max_it <n> - Sets number of pre and post-smoothing steps

   Level: advanced

   Notes:
    this does not set a value on the coarsest grid, since we assume that
    there is no separate smooth up on the coarsest grid.

.seealso: PCMGSetDistinctSmoothUp()
@*/
PetscErrorCode  PCMGSetNumberSmooth(PC pc,PetscInt n)
{
  PC_MG          *mg        = (PC_MG*)pc->data;
  PC_MG_Levels   **mglevels = mg->levels;
  PetscInt       i,levels;

  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc,PC_CLASSID,1);
  PetscValidLogicalCollectiveInt(pc,n,2);
  PetscCheck(mglevels,PetscObjectComm((PetscObject)pc),PETSC_ERR_ORDER,"Must set MG levels with PCMGSetLevels() before calling");
  levels = mglevels[0]->levels;

  for (i=1; i<levels; i++) {
    CHKERRQ(KSPSetTolerances(mglevels[i]->smoothu,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT,n));
    CHKERRQ(KSPSetTolerances(mglevels[i]->smoothd,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT,n));
    mg->default_smoothu = n;
    mg->default_smoothd = n;
  }
  PetscFunctionReturn(0);
}

/*@
   PCMGSetDistinctSmoothUp - sets the up (post) smoother to be a separate KSP from the down (pre) smoother on all levels
       and adds the suffix _up to the options name

   Logically Collective on PC

   Input Parameters:
.  pc - the preconditioner context

   Options Database Key:
.  -pc_mg_distinct_smoothup <bool> - use distinct smoothing objects

   Level: advanced

   Notes:
    this does not set a value on the coarsest grid, since we assume that
    there is no separate smooth up on the coarsest grid.

.seealso: PCMGSetNumberSmooth()
@*/
PetscErrorCode  PCMGSetDistinctSmoothUp(PC pc)
{
  PC_MG          *mg        = (PC_MG*)pc->data;
  PC_MG_Levels   **mglevels = mg->levels;
  PetscInt       i,levels;
  KSP            subksp;

  PetscFunctionBegin;
  PetscValidHeaderSpecific(pc,PC_CLASSID,1);
  PetscCheck(mglevels,PetscObjectComm((PetscObject)pc),PETSC_ERR_ORDER,"Must set MG levels with PCMGSetLevels() before calling");
  levels = mglevels[0]->levels;

  for (i=1; i<levels; i++) {
    const char *prefix = NULL;
    /* make sure smoother up and down are different */
    CHKERRQ(PCMGGetSmootherUp(pc,i,&subksp));
    CHKERRQ(KSPGetOptionsPrefix(mglevels[i]->smoothd,&prefix));
    CHKERRQ(KSPSetOptionsPrefix(subksp,prefix));
    CHKERRQ(KSPAppendOptionsPrefix(subksp,"up_"));
  }
  PetscFunctionReturn(0);
}

/* No new matrices are created, and the coarse operator matrices are the references to the original ones */
PetscErrorCode  PCGetInterpolations_MG(PC pc,PetscInt *num_levels,Mat *interpolations[])
{
  PC_MG          *mg        = (PC_MG*)pc->data;
  PC_MG_Levels   **mglevels = mg->levels;
  Mat            *mat;
  PetscInt       l;

  PetscFunctionBegin;
  PetscCheck(mglevels,PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must set MG levels before calling");
  CHKERRQ(PetscMalloc1(mg->nlevels,&mat));
  for (l=1; l< mg->nlevels; l++) {
    mat[l-1] = mglevels[l]->interpolate;
    CHKERRQ(PetscObjectReference((PetscObject)mat[l-1]));
  }
  *num_levels = mg->nlevels;
  *interpolations = mat;
  PetscFunctionReturn(0);
}

/* No new matrices are created, and the coarse operator matrices are the references to the original ones */
PetscErrorCode  PCGetCoarseOperators_MG(PC pc,PetscInt *num_levels,Mat *coarseOperators[])
{
  PC_MG          *mg        = (PC_MG*)pc->data;
  PC_MG_Levels   **mglevels = mg->levels;
  PetscInt       l;
  Mat            *mat;

  PetscFunctionBegin;
  PetscCheck(mglevels,PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must set MG levels before calling");
  CHKERRQ(PetscMalloc1(mg->nlevels,&mat));
  for (l=0; l<mg->nlevels-1; l++) {
    CHKERRQ(KSPGetOperators(mglevels[l]->smoothd,NULL,&(mat[l])));
    CHKERRQ(PetscObjectReference((PetscObject)mat[l]));
  }
  *num_levels = mg->nlevels;
  *coarseOperators = mat;
  PetscFunctionReturn(0);
}

/*@C
  PCMGRegisterCoarseSpaceConstructor -  Adds a method to the PCMG package for coarse space construction.

  Not collective

  Input Parameters:
+ name     - name of the constructor
- function - constructor routine

  Notes:
  Calling sequence for the routine:
$ my_csp(PC pc, PetscInt l, DM dm, KSP smooth, PetscInt Nc, const Vec initGuess[], Vec **coarseSp)
$   pc        - The PC object
$   l         - The multigrid level, 0 is the coarse level
$   dm        - The DM for this level
$   smooth    - The level smoother
$   Nc        - The size of the coarse space
$   initGuess - Basis for an initial guess for the space
$   coarseSp  - A basis for the computed coarse space

  Level: advanced

.seealso: PCMGGetCoarseSpaceConstructor(), PCRegister()
@*/
PetscErrorCode PCMGRegisterCoarseSpaceConstructor(const char name[], PetscErrorCode (*function)(PC, PetscInt, DM, KSP, PetscInt, const Vec[], Vec **))
{
  PetscFunctionBegin;
  CHKERRQ(PCInitializePackage());
  CHKERRQ(PetscFunctionListAdd(&PCMGCoarseList,name,function));
  PetscFunctionReturn(0);
}

/*@C
  PCMGGetCoarseSpaceConstructor -  Returns the given coarse space construction method.

  Not collective

  Input Parameter:
. name     - name of the constructor

  Output Parameter:
. function - constructor routine

  Notes:
  Calling sequence for the routine:
$ my_csp(PC pc, PetscInt l, DM dm, KSP smooth, PetscInt Nc, const Vec initGuess[], Vec **coarseSp)
$   pc        - The PC object
$   l         - The multigrid level, 0 is the coarse level
$   dm        - The DM for this level
$   smooth    - The level smoother
$   Nc        - The size of the coarse space
$   initGuess - Basis for an initial guess for the space
$   coarseSp  - A basis for the computed coarse space

  Level: advanced

.seealso: PCMGRegisterCoarseSpaceConstructor(), PCRegister()
@*/
PetscErrorCode PCMGGetCoarseSpaceConstructor(const char name[], PetscErrorCode (**function)(PC, PetscInt, DM, KSP, PetscInt, const Vec[], Vec **))
{
  PetscFunctionBegin;
  CHKERRQ(PetscFunctionListFind(PCMGCoarseList,name,function));
  PetscFunctionReturn(0);
}

/* ----------------------------------------------------------------------------------------*/

/*MC
   PCMG - Use multigrid preconditioning. This preconditioner requires you provide additional
    information about the coarser grid matrices and restriction/interpolation operators.

   Options Database Keys:
+  -pc_mg_levels <nlevels> - number of levels including finest
.  -pc_mg_cycle_type <v,w> - provide the cycle desired
.  -pc_mg_type <additive,multiplicative,full,kaskade> - multiplicative is the default
.  -pc_mg_log - log information about time spent on each level of the solver
.  -pc_mg_distinct_smoothup - configure up (after interpolation) and down (before restriction) smoothers separately (with different options prefixes)
.  -pc_mg_galerkin <both,pmat,mat,none> - use Galerkin process to compute coarser operators, i.e. Acoarse = R A R'
.  -pc_mg_multiplicative_cycles - number of cycles to use as the preconditioner (defaults to 1)
.  -pc_mg_dump_matlab - dumps the matrices for each level and the restriction/interpolation matrices
                        to the Socket viewer for reading from MATLAB.
-  -pc_mg_dump_binary - dumps the matrices for each level and the restriction/interpolation matrices
                        to the binary output file called binaryoutput

   Notes:
    If one uses a Krylov method such GMRES or CG as the smoother then one must use KSPFGMRES, KSPGCR, or KSPRICHARDSON as the outer Krylov method

       When run with a single level the smoother options are used on that level NOT the coarse grid solver options

       When run with KSPRICHARDSON the convergence test changes slightly if monitor is turned on. The iteration count may change slightly. This
       is because without monitoring the residual norm is computed WITHIN each multigrid cycle on the finest level after the pre-smoothing
       (because the residual has just been computed for the multigrid algorithm and is hence available for free) while with monitoring the
       residual is computed at the end of each cycle.

   Level: intermediate

.seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, PCMGType, PCEXOTIC, PCGAMG, PCML, PCHYPRE
           PCMGSetLevels(), PCMGGetLevels(), PCMGSetType(), PCMGSetCycleType(),
           PCMGSetDistinctSmoothUp(), PCMGGetCoarseSolve(), PCMGSetResidual(), PCMGSetInterpolation(),
           PCMGSetRestriction(), PCMGGetSmoother(), PCMGGetSmootherUp(), PCMGGetSmootherDown(),
           PCMGSetCycleTypeOnLevel(), PCMGSetRhs(), PCMGSetX(), PCMGSetR()
M*/

PETSC_EXTERN PetscErrorCode PCCreate_MG(PC pc)
{
  PC_MG          *mg;

  PetscFunctionBegin;
  CHKERRQ(PetscNewLog(pc,&mg));
  pc->data     = mg;
  mg->nlevels  = -1;
  mg->am       = PC_MG_MULTIPLICATIVE;
  mg->galerkin = PC_MG_GALERKIN_NONE;
  mg->adaptInterpolation = PETSC_FALSE;
  mg->Nc                 = -1;
  mg->eigenvalue         = -1;

  pc->useAmat = PETSC_TRUE;

  pc->ops->apply          = PCApply_MG;
  pc->ops->applytranspose = PCApplyTranspose_MG;
  pc->ops->matapply       = PCMatApply_MG;
  pc->ops->setup          = PCSetUp_MG;
  pc->ops->reset          = PCReset_MG;
  pc->ops->destroy        = PCDestroy_MG;
  pc->ops->setfromoptions = PCSetFromOptions_MG;
  pc->ops->view           = PCView_MG;

  CHKERRQ(PetscObjectComposedDataRegister(&mg->eigenvalue));
  CHKERRQ(PetscObjectComposeFunction((PetscObject)pc,"PCMGSetGalerkin_C",PCMGSetGalerkin_MG));
  CHKERRQ(PetscObjectComposeFunction((PetscObject)pc,"PCMGGetLevels_C",PCMGGetLevels_MG));
  CHKERRQ(PetscObjectComposeFunction((PetscObject)pc,"PCMGSetLevels_C",PCMGSetLevels_MG));
  CHKERRQ(PetscObjectComposeFunction((PetscObject)pc,"PCGetInterpolations_C",PCGetInterpolations_MG));
  CHKERRQ(PetscObjectComposeFunction((PetscObject)pc,"PCGetCoarseOperators_C",PCGetCoarseOperators_MG));
  CHKERRQ(PetscObjectComposeFunction((PetscObject)pc,"PCMGSetAdaptInterpolation_C",PCMGSetAdaptInterpolation_MG));
  CHKERRQ(PetscObjectComposeFunction((PetscObject)pc,"PCMGGetAdaptInterpolation_C",PCMGGetAdaptInterpolation_MG));
  CHKERRQ(PetscObjectComposeFunction((PetscObject)pc,"PCMGSetAdaptCR_C",PCMGSetAdaptCR_MG));
  CHKERRQ(PetscObjectComposeFunction((PetscObject)pc,"PCMGGetAdaptCR_C",PCMGGetAdaptCR_MG));
  PetscFunctionReturn(0);
}