xref: /petsc/src/snes/impls/fas/fasimpls.h (revision 22c1e704c10839b31eeabd52ee9fb7d359421c3f)
1421d9b32SPeter Brune #ifndef _SNES_FASIMPLS
2421d9b32SPeter Brune #define _SNES_FASIMPLS
3421d9b32SPeter Brune 
4421d9b32SPeter Brune #include <private/snesimpl.h>
5*22c1e704SPeter Brune #include <private/linesearchimpl.h>
6ee78dd50SPeter Brune #include <private/dmimpl.h>
707144faaSPeter Brune #include <petscsnesfas.h>
8421d9b32SPeter Brune 
9421d9b32SPeter Brune typedef struct {
10421d9b32SPeter Brune 
11421d9b32SPeter Brune   /* flags for knowing the global place of this FAS object */
12421d9b32SPeter Brune   PetscInt       level;                        /* level = 0 coarsest level */
13421d9b32SPeter Brune   PetscInt       levels;                       /* if level + 1 = levels; we're the last turtle */
14421d9b32SPeter Brune 
15646217ecSPeter Brune   PetscViewer    monitor;                      /* debuggging output for FAS */
16421d9b32SPeter Brune 
17421d9b32SPeter Brune   /* smoothing objects */
18ee78dd50SPeter Brune   SNES           upsmooth;                     /* the SNES for presmoothing */
19ee78dd50SPeter Brune   SNES           downsmooth;                   /* the SNES for postsmoothing */
20421d9b32SPeter Brune 
21*22c1e704SPeter Brune   LineSearch     linesearch_smooth;            /* the line search for default upsmoothing */
22*22c1e704SPeter Brune   LineSearch     linesearch;                   /* the line search used to stabilize coarse corrections */
23*22c1e704SPeter Brune 
24421d9b32SPeter Brune   /* coarse grid correction objects */
256273346dSPeter Brune   SNES           next;                         /* the SNES instance for the next coarser level in the hierarchy */
266273346dSPeter Brune   SNES           previous;                     /* the SNES instance for the next finer level in the hierarchy */
27421d9b32SPeter Brune   Mat            interpolate;                  /* interpolation */
28efe1f98aSPeter Brune   Mat            inject;                       /* injection operator (unscaled) */
29421d9b32SPeter Brune   Mat            restrct;                      /* restriction operator */
30421d9b32SPeter Brune   Vec            rscale;                       /* the pointwise scaling of the restriction operator */
31421d9b32SPeter Brune 
32ee78dd50SPeter Brune   /* method parameters */
33ee78dd50SPeter Brune   PetscInt       n_cycles;                     /* number of cycles on this level */
3407144faaSPeter Brune   SNESFASType    fastype;                      /* FAS type */
35ee78dd50SPeter Brune   PetscInt       max_up_it;                    /* number of pre-smooths */
36ee78dd50SPeter Brune   PetscInt       max_down_it;                  /* number of post-smooth cycles */
37d1adcc6fSPeter Brune   PetscBool      usedmfornumberoflevels;       /* uses a DM to generate a number of the levels */
386273346dSPeter Brune 
396273346dSPeter Brune   /* Galerkin FAS state */
406273346dSPeter Brune   PetscBool      galerkin;                     /* use Galerkin formation of the coarse problem */
416273346dSPeter Brune   Vec            Xg;                           /* Galerkin solution projection */
426273346dSPeter Brune   Vec            Fg;                           /* Galerkin function projection */
436273346dSPeter Brune 
44421d9b32SPeter Brune } SNES_FAS;
45421d9b32SPeter Brune 
46421d9b32SPeter Brune #endif
47