xref: /petsc/src/snes/tutorials/ex19.c (revision d71ae5a4db6382e7f06317b8d368875286fe9008)
1c4762a1bSJed Brown 
2c4762a1bSJed Brown static char help[] = "Nonlinear driven cavity with multigrid in 2d.\n \
3c4762a1bSJed Brown   \n\
4c4762a1bSJed Brown The 2D driven cavity problem is solved in a velocity-vorticity formulation.\n\
5c4762a1bSJed Brown The flow can be driven with the lid or with bouyancy or both:\n\
6c4762a1bSJed Brown   -lidvelocity &ltlid&gt, where &ltlid&gt = dimensionless velocity of lid\n\
7c4762a1bSJed Brown   -grashof &ltgr&gt, where &ltgr&gt = dimensionless temperature gradent\n\
8c4762a1bSJed Brown   -prandtl &ltpr&gt, where &ltpr&gt = dimensionless thermal/momentum diffusity ratio\n\
9c4762a1bSJed Brown  -contours : draw contour plots of solution\n\n";
10c4762a1bSJed Brown /* in HTML, '&lt' = '<' and '&gt' = '>' */
11c4762a1bSJed Brown 
12c4762a1bSJed Brown /*
13c4762a1bSJed Brown       See src/ksp/ksp/tutorials/ex45.c
14c4762a1bSJed Brown */
15c4762a1bSJed Brown 
16c4762a1bSJed Brown /*F-----------------------------------------------------------------------
17c4762a1bSJed Brown 
18c4762a1bSJed Brown     We thank David E. Keyes for contributing the driven cavity discretization within this example code.
19c4762a1bSJed Brown 
20c4762a1bSJed Brown     This problem is modeled by the partial differential equation system
21c4762a1bSJed Brown 
22c4762a1bSJed Brown \begin{eqnarray}
23c4762a1bSJed Brown         - \triangle U - \nabla_y \Omega & = & 0  \\
24c4762a1bSJed Brown         - \triangle V + \nabla_x\Omega & = & 0  \\
25c4762a1bSJed Brown         - \triangle \Omega + \nabla \cdot ([U*\Omega,V*\Omega]) - GR* \nabla_x T & = & 0  \\
26c4762a1bSJed Brown         - \triangle T + PR* \nabla \cdot ([U*T,V*T]) & = & 0
27c4762a1bSJed Brown \end{eqnarray}
28c4762a1bSJed Brown 
29c4762a1bSJed Brown     in the unit square, which is uniformly discretized in each of x and y in this simple encoding.
30c4762a1bSJed Brown 
31c4762a1bSJed Brown     No-slip, rigid-wall Dirichlet conditions are used for $ [U,V]$.
32c4762a1bSJed Brown     Dirichlet conditions are used for Omega, based on the definition of
33c4762a1bSJed Brown     vorticity: $ \Omega = - \nabla_y U + \nabla_x V$, where along each
34c4762a1bSJed Brown     constant coordinate boundary, the tangential derivative is zero.
35c4762a1bSJed Brown     Dirichlet conditions are used for T on the left and right walls,
36c4762a1bSJed Brown     and insulation homogeneous Neumann conditions are used for T on
37c4762a1bSJed Brown     the top and bottom walls.
38c4762a1bSJed Brown 
39c4762a1bSJed Brown     A finite difference approximation with the usual 5-point stencil
40c4762a1bSJed Brown     is used to discretize the boundary value problem to obtain a
41c4762a1bSJed Brown     nonlinear system of equations.  Upwinding is used for the divergence
42c4762a1bSJed Brown     (convective) terms and central for the gradient (source) terms.
43c4762a1bSJed Brown 
44c4762a1bSJed Brown     The Jacobian can be either
45c4762a1bSJed Brown       * formed via finite differencing using coloring (the default), or
46c4762a1bSJed Brown       * applied matrix-free via the option -snes_mf
47c4762a1bSJed Brown         (for larger grid problems this variant may not converge
48c4762a1bSJed Brown         without a preconditioner due to ill-conditioning).
49c4762a1bSJed Brown 
50c4762a1bSJed Brown   ------------------------------------------------------------------------F*/
51c4762a1bSJed Brown 
52c4762a1bSJed Brown /*
53c4762a1bSJed Brown    Include "petscdmda.h" so that we can use distributed arrays (DMDAs).
54c4762a1bSJed Brown    Include "petscsnes.h" so that we can use SNES solvers.  Note that this
55c4762a1bSJed Brown    file automatically includes:
56c4762a1bSJed Brown      petscsys.h       - base PETSc routines   petscvec.h - vectors
57c4762a1bSJed Brown      petscmat.h - matrices
58c4762a1bSJed Brown      petscis.h     - index sets            petscksp.h - Krylov subspace methods
59c4762a1bSJed Brown      petscviewer.h - viewers               petscpc.h  - preconditioners
60c4762a1bSJed Brown      petscksp.h   - linear solvers
61c4762a1bSJed Brown */
62c4762a1bSJed Brown #if defined(PETSC_APPLE_FRAMEWORK)
63c4762a1bSJed Brown   #import <PETSc/petscsnes.h>
64c4762a1bSJed Brown   #import <PETSc/petscdmda.h>
65c4762a1bSJed Brown #else
66c4762a1bSJed Brown   #include <petscsnes.h>
67c4762a1bSJed Brown   #include <petscdm.h>
68c4762a1bSJed Brown   #include <petscdmda.h>
69c4762a1bSJed Brown #endif
70c4762a1bSJed Brown 
71c4762a1bSJed Brown /*
72c4762a1bSJed Brown    User-defined routines and data structures
73c4762a1bSJed Brown */
74c4762a1bSJed Brown typedef struct {
75c4762a1bSJed Brown   PetscScalar u, v, omega, temp;
76c4762a1bSJed Brown } Field;
77c4762a1bSJed Brown 
78c4762a1bSJed Brown PetscErrorCode FormFunctionLocal(DMDALocalInfo *, Field **, Field **, void *);
79c4762a1bSJed Brown 
80c4762a1bSJed Brown typedef struct {
81c4762a1bSJed Brown   PetscReal lidvelocity, prandtl, grashof; /* physical parameters */
82c4762a1bSJed Brown   PetscBool draw_contours;                 /* flag - 1 indicates drawing contours */
83c4762a1bSJed Brown } AppCtx;
84c4762a1bSJed Brown 
85c4762a1bSJed Brown extern PetscErrorCode FormInitialGuess(AppCtx *, DM, Vec);
86c4762a1bSJed Brown extern PetscErrorCode NonlinearGS(SNES, Vec, Vec, void *);
87c4762a1bSJed Brown 
88*d71ae5a4SJacob Faibussowitsch int main(int argc, char **argv)
89*d71ae5a4SJacob Faibussowitsch {
90c4762a1bSJed Brown   AppCtx   user; /* user-defined work context */
91c4762a1bSJed Brown   PetscInt mx, my, its;
92c4762a1bSJed Brown   MPI_Comm comm;
93c4762a1bSJed Brown   SNES     snes;
94c4762a1bSJed Brown   DM       da;
95c4762a1bSJed Brown   Vec      x;
96c4762a1bSJed Brown 
97327415f7SBarry Smith   PetscFunctionBeginUser;
989566063dSJacob Faibussowitsch   PetscCall(PetscInitialize(&argc, &argv, (char *)0, help));
99c4762a1bSJed Brown   comm = PETSC_COMM_WORLD;
1009566063dSJacob Faibussowitsch   PetscCall(SNESCreate(comm, &snes));
101c4762a1bSJed Brown 
102c4762a1bSJed Brown   /*
103c4762a1bSJed Brown       Create distributed array object to manage parallel grid and vectors
104c4762a1bSJed Brown       for principal unknowns (x) and governing residuals (f)
105c4762a1bSJed Brown   */
1069566063dSJacob Faibussowitsch   PetscCall(DMDACreate2d(PETSC_COMM_WORLD, DM_BOUNDARY_NONE, DM_BOUNDARY_NONE, DMDA_STENCIL_STAR, 4, 4, PETSC_DECIDE, PETSC_DECIDE, 4, 1, 0, 0, &da));
1079566063dSJacob Faibussowitsch   PetscCall(DMSetFromOptions(da));
1089566063dSJacob Faibussowitsch   PetscCall(DMSetUp(da));
1099566063dSJacob Faibussowitsch   PetscCall(SNESSetDM(snes, (DM)da));
1109566063dSJacob Faibussowitsch   PetscCall(SNESSetNGS(snes, NonlinearGS, (void *)&user));
111c4762a1bSJed Brown 
1129566063dSJacob Faibussowitsch   PetscCall(DMDAGetInfo(da, 0, &mx, &my, PETSC_IGNORE, PETSC_IGNORE, PETSC_IGNORE, PETSC_IGNORE, PETSC_IGNORE, PETSC_IGNORE, PETSC_IGNORE, PETSC_IGNORE, PETSC_IGNORE, PETSC_IGNORE));
113c4762a1bSJed Brown   /*
114c4762a1bSJed Brown      Problem parameters (velocity of lid, prandtl, and grashof numbers)
115c4762a1bSJed Brown   */
116c4762a1bSJed Brown   user.lidvelocity = 1.0 / (mx * my);
117c4762a1bSJed Brown   user.prandtl     = 1.0;
118c4762a1bSJed Brown   user.grashof     = 1.0;
119c4762a1bSJed Brown 
1209566063dSJacob Faibussowitsch   PetscCall(PetscOptionsGetReal(NULL, NULL, "-lidvelocity", &user.lidvelocity, NULL));
1219566063dSJacob Faibussowitsch   PetscCall(PetscOptionsGetReal(NULL, NULL, "-prandtl", &user.prandtl, NULL));
1229566063dSJacob Faibussowitsch   PetscCall(PetscOptionsGetReal(NULL, NULL, "-grashof", &user.grashof, NULL));
1239566063dSJacob Faibussowitsch   PetscCall(PetscOptionsHasName(NULL, NULL, "-contours", &user.draw_contours));
124c4762a1bSJed Brown 
1259566063dSJacob Faibussowitsch   PetscCall(DMDASetFieldName(da, 0, "x_velocity"));
1269566063dSJacob Faibussowitsch   PetscCall(DMDASetFieldName(da, 1, "y_velocity"));
1279566063dSJacob Faibussowitsch   PetscCall(DMDASetFieldName(da, 2, "Omega"));
1289566063dSJacob Faibussowitsch   PetscCall(DMDASetFieldName(da, 3, "temperature"));
129c4762a1bSJed Brown 
130c4762a1bSJed Brown   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
131c4762a1bSJed Brown      Create user context, set problem data, create vector data structures.
132c4762a1bSJed Brown      Also, compute the initial guess.
133c4762a1bSJed Brown      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
134c4762a1bSJed Brown 
135c4762a1bSJed Brown   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
136c4762a1bSJed Brown      Create nonlinear solver context
137c4762a1bSJed Brown 
138c4762a1bSJed Brown      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1399566063dSJacob Faibussowitsch   PetscCall(DMSetApplicationContext(da, &user));
1409566063dSJacob Faibussowitsch   PetscCall(DMDASNESSetFunctionLocal(da, INSERT_VALUES, (PetscErrorCode(*)(DMDALocalInfo *, void *, void *, void *))FormFunctionLocal, &user));
1419566063dSJacob Faibussowitsch   PetscCall(SNESSetFromOptions(snes));
1429566063dSJacob Faibussowitsch   PetscCall(PetscPrintf(comm, "lid velocity = %g, prandtl # = %g, grashof # = %g\n", (double)user.lidvelocity, (double)user.prandtl, (double)user.grashof));
143c4762a1bSJed Brown 
144c4762a1bSJed Brown   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
145c4762a1bSJed Brown      Solve the nonlinear system
146660278c0SBarry Smith      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1479566063dSJacob Faibussowitsch   PetscCall(DMCreateGlobalVector(da, &x));
1489566063dSJacob Faibussowitsch   PetscCall(FormInitialGuess(&user, da, x));
149c4762a1bSJed Brown 
1509566063dSJacob Faibussowitsch   PetscCall(SNESSolve(snes, NULL, x));
151c4762a1bSJed Brown 
1529566063dSJacob Faibussowitsch   PetscCall(SNESGetIterationNumber(snes, &its));
15363a3b9bcSJacob Faibussowitsch   PetscCall(PetscPrintf(comm, "Number of SNES iterations = %" PetscInt_FMT "\n", its));
154c4762a1bSJed Brown 
155c4762a1bSJed Brown   /*
156c4762a1bSJed Brown      Visualize solution
157c4762a1bSJed Brown   */
1581baa6e33SBarry Smith   if (user.draw_contours) PetscCall(VecView(x, PETSC_VIEWER_DRAW_WORLD));
159c4762a1bSJed Brown 
160c4762a1bSJed Brown   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
161c4762a1bSJed Brown      Free work space.  All PETSc objects should be destroyed when they
162c4762a1bSJed Brown      are no longer needed.
163c4762a1bSJed Brown      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1649566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&x));
1659566063dSJacob Faibussowitsch   PetscCall(DMDestroy(&da));
1669566063dSJacob Faibussowitsch   PetscCall(SNESDestroy(&snes));
1679566063dSJacob Faibussowitsch   PetscCall(PetscFinalize());
168b122ec5aSJacob Faibussowitsch   return 0;
169c4762a1bSJed Brown }
170c4762a1bSJed Brown 
171c4762a1bSJed Brown /* ------------------------------------------------------------------- */
172c4762a1bSJed Brown 
173c4762a1bSJed Brown /*
174c4762a1bSJed Brown    FormInitialGuess - Forms initial approximation.
175c4762a1bSJed Brown 
176c4762a1bSJed Brown    Input Parameters:
177c4762a1bSJed Brown    user - user-defined application context
178c4762a1bSJed Brown    X - vector
179c4762a1bSJed Brown 
180c4762a1bSJed Brown    Output Parameter:
181c4762a1bSJed Brown    X - vector
182c4762a1bSJed Brown */
183*d71ae5a4SJacob Faibussowitsch PetscErrorCode FormInitialGuess(AppCtx *user, DM da, Vec X)
184*d71ae5a4SJacob Faibussowitsch {
185c4762a1bSJed Brown   PetscInt  i, j, mx, xs, ys, xm, ym;
186c4762a1bSJed Brown   PetscReal grashof, dx;
187c4762a1bSJed Brown   Field   **x;
188c4762a1bSJed Brown 
189c4762a1bSJed Brown   PetscFunctionBeginUser;
190c4762a1bSJed Brown   grashof = user->grashof;
191c4762a1bSJed Brown 
1929566063dSJacob Faibussowitsch   PetscCall(DMDAGetInfo(da, 0, &mx, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0));
193c4762a1bSJed Brown   dx = 1.0 / (mx - 1);
194c4762a1bSJed Brown 
195c4762a1bSJed Brown   /*
196c4762a1bSJed Brown      Get local grid boundaries (for 2-dimensional DMDA):
197c4762a1bSJed Brown        xs, ys   - starting grid indices (no ghost points)
198c4762a1bSJed Brown        xm, ym   - widths of local grid (no ghost points)
199c4762a1bSJed Brown   */
2009566063dSJacob Faibussowitsch   PetscCall(DMDAGetCorners(da, &xs, &ys, NULL, &xm, &ym, NULL));
201c4762a1bSJed Brown 
202c4762a1bSJed Brown   /*
203c4762a1bSJed Brown      Get a pointer to vector data.
204c4762a1bSJed Brown        - For default PETSc vectors, VecGetArray() returns a pointer to
205c4762a1bSJed Brown          the data array.  Otherwise, the routine is implementation dependent.
206c4762a1bSJed Brown        - You MUST call VecRestoreArray() when you no longer need access to
207c4762a1bSJed Brown          the array.
208c4762a1bSJed Brown   */
2099566063dSJacob Faibussowitsch   PetscCall(DMDAVecGetArrayWrite(da, X, &x));
210c4762a1bSJed Brown 
211c4762a1bSJed Brown   /*
212c4762a1bSJed Brown      Compute initial guess over the locally owned part of the grid
213c4762a1bSJed Brown      Initial condition is motionless fluid and equilibrium temperature
214c4762a1bSJed Brown   */
215c4762a1bSJed Brown   for (j = ys; j < ys + ym; j++) {
216c4762a1bSJed Brown     for (i = xs; i < xs + xm; i++) {
217c4762a1bSJed Brown       x[j][i].u     = 0.0;
218c4762a1bSJed Brown       x[j][i].v     = 0.0;
219c4762a1bSJed Brown       x[j][i].omega = 0.0;
220c4762a1bSJed Brown       x[j][i].temp  = (grashof > 0) * i * dx;
221c4762a1bSJed Brown     }
222c4762a1bSJed Brown   }
223c4762a1bSJed Brown 
224c4762a1bSJed Brown   /*
225c4762a1bSJed Brown      Restore vector
226c4762a1bSJed Brown   */
2279566063dSJacob Faibussowitsch   PetscCall(DMDAVecRestoreArrayWrite(da, X, &x));
228c4762a1bSJed Brown   PetscFunctionReturn(0);
229c4762a1bSJed Brown }
230c4762a1bSJed Brown 
231*d71ae5a4SJacob Faibussowitsch PetscErrorCode FormFunctionLocal(DMDALocalInfo *info, Field **x, Field **f, void *ptr)
232*d71ae5a4SJacob Faibussowitsch {
233c4762a1bSJed Brown   AppCtx     *user = (AppCtx *)ptr;
234c4762a1bSJed Brown   PetscInt    xints, xinte, yints, yinte, i, j;
235c4762a1bSJed Brown   PetscReal   hx, hy, dhx, dhy, hxdhy, hydhx;
236c4762a1bSJed Brown   PetscReal   grashof, prandtl, lid;
237c4762a1bSJed Brown   PetscScalar u, uxx, uyy, vx, vy, avx, avy, vxp, vxm, vyp, vym;
238c4762a1bSJed Brown 
239c4762a1bSJed Brown   PetscFunctionBeginUser;
240c4762a1bSJed Brown   grashof = user->grashof;
241c4762a1bSJed Brown   prandtl = user->prandtl;
242c4762a1bSJed Brown   lid     = user->lidvelocity;
243c4762a1bSJed Brown 
244c4762a1bSJed Brown   /*
245c4762a1bSJed Brown      Define mesh intervals ratios for uniform grid.
246c4762a1bSJed Brown 
247c4762a1bSJed Brown      Note: FD formulae below are normalized by multiplying through by
248c4762a1bSJed Brown      local volume element (i.e. hx*hy) to obtain coefficients O(1) in two dimensions.
249c4762a1bSJed Brown 
250c4762a1bSJed Brown   */
2519371c9d4SSatish Balay   dhx   = (PetscReal)(info->mx - 1);
2529371c9d4SSatish Balay   dhy   = (PetscReal)(info->my - 1);
2539371c9d4SSatish Balay   hx    = 1.0 / dhx;
2549371c9d4SSatish Balay   hy    = 1.0 / dhy;
2559371c9d4SSatish Balay   hxdhy = hx * dhy;
2569371c9d4SSatish Balay   hydhx = hy * dhx;
257c4762a1bSJed Brown 
2589371c9d4SSatish Balay   xints = info->xs;
2599371c9d4SSatish Balay   xinte = info->xs + info->xm;
2609371c9d4SSatish Balay   yints = info->ys;
2619371c9d4SSatish Balay   yinte = info->ys + info->ym;
262c4762a1bSJed Brown 
263c4762a1bSJed Brown   /* Test whether we are on the bottom edge of the global array */
264c4762a1bSJed Brown   if (yints == 0) {
265c4762a1bSJed Brown     j     = 0;
266c4762a1bSJed Brown     yints = yints + 1;
267c4762a1bSJed Brown     /* bottom edge */
268c4762a1bSJed Brown     for (i = info->xs; i < info->xs + info->xm; i++) {
269c4762a1bSJed Brown       f[j][i].u     = x[j][i].u;
270c4762a1bSJed Brown       f[j][i].v     = x[j][i].v;
271c4762a1bSJed Brown       f[j][i].omega = x[j][i].omega + (x[j + 1][i].u - x[j][i].u) * dhy;
272c4762a1bSJed Brown       f[j][i].temp  = x[j][i].temp - x[j + 1][i].temp;
273c4762a1bSJed Brown     }
274c4762a1bSJed Brown   }
275c4762a1bSJed Brown 
276c4762a1bSJed Brown   /* Test whether we are on the top edge of the global array */
277c4762a1bSJed Brown   if (yinte == info->my) {
278c4762a1bSJed Brown     j     = info->my - 1;
279c4762a1bSJed Brown     yinte = yinte - 1;
280c4762a1bSJed Brown     /* top edge */
281c4762a1bSJed Brown     for (i = info->xs; i < info->xs + info->xm; i++) {
282c4762a1bSJed Brown       f[j][i].u     = x[j][i].u - lid;
283c4762a1bSJed Brown       f[j][i].v     = x[j][i].v;
284c4762a1bSJed Brown       f[j][i].omega = x[j][i].omega + (x[j][i].u - x[j - 1][i].u) * dhy;
285c4762a1bSJed Brown       f[j][i].temp  = x[j][i].temp - x[j - 1][i].temp;
286c4762a1bSJed Brown     }
287c4762a1bSJed Brown   }
288c4762a1bSJed Brown 
289c4762a1bSJed Brown   /* Test whether we are on the left edge of the global array */
290c4762a1bSJed Brown   if (xints == 0) {
291c4762a1bSJed Brown     i     = 0;
292c4762a1bSJed Brown     xints = xints + 1;
293c4762a1bSJed Brown     /* left edge */
294c4762a1bSJed Brown     for (j = info->ys; j < info->ys + info->ym; j++) {
295c4762a1bSJed Brown       f[j][i].u     = x[j][i].u;
296c4762a1bSJed Brown       f[j][i].v     = x[j][i].v;
297c4762a1bSJed Brown       f[j][i].omega = x[j][i].omega - (x[j][i + 1].v - x[j][i].v) * dhx;
298c4762a1bSJed Brown       f[j][i].temp  = x[j][i].temp;
299c4762a1bSJed Brown     }
300c4762a1bSJed Brown   }
301c4762a1bSJed Brown 
302c4762a1bSJed Brown   /* Test whether we are on the right edge of the global array */
303c4762a1bSJed Brown   if (xinte == info->mx) {
304c4762a1bSJed Brown     i     = info->mx - 1;
305c4762a1bSJed Brown     xinte = xinte - 1;
306c4762a1bSJed Brown     /* right edge */
307c4762a1bSJed Brown     for (j = info->ys; j < info->ys + info->ym; j++) {
308c4762a1bSJed Brown       f[j][i].u     = x[j][i].u;
309c4762a1bSJed Brown       f[j][i].v     = x[j][i].v;
310c4762a1bSJed Brown       f[j][i].omega = x[j][i].omega - (x[j][i].v - x[j][i - 1].v) * dhx;
311c4762a1bSJed Brown       f[j][i].temp  = x[j][i].temp - (PetscReal)(grashof > 0);
312c4762a1bSJed Brown     }
313c4762a1bSJed Brown   }
314c4762a1bSJed Brown 
315c4762a1bSJed Brown   /* Compute over the interior points */
316c4762a1bSJed Brown   for (j = yints; j < yinte; j++) {
317c4762a1bSJed Brown     for (i = xints; i < xinte; i++) {
318c4762a1bSJed Brown       /*
319c4762a1bSJed Brown        convective coefficients for upwinding
320c4762a1bSJed Brown       */
3219371c9d4SSatish Balay       vx  = x[j][i].u;
3229371c9d4SSatish Balay       avx = PetscAbsScalar(vx);
3239371c9d4SSatish Balay       vxp = .5 * (vx + avx);
3249371c9d4SSatish Balay       vxm = .5 * (vx - avx);
3259371c9d4SSatish Balay       vy  = x[j][i].v;
3269371c9d4SSatish Balay       avy = PetscAbsScalar(vy);
3279371c9d4SSatish Balay       vyp = .5 * (vy + avy);
3289371c9d4SSatish Balay       vym = .5 * (vy - avy);
329c4762a1bSJed Brown 
330c4762a1bSJed Brown       /* U velocity */
331c4762a1bSJed Brown       u         = x[j][i].u;
332c4762a1bSJed Brown       uxx       = (2.0 * u - x[j][i - 1].u - x[j][i + 1].u) * hydhx;
333c4762a1bSJed Brown       uyy       = (2.0 * u - x[j - 1][i].u - x[j + 1][i].u) * hxdhy;
334c4762a1bSJed Brown       f[j][i].u = uxx + uyy - .5 * (x[j + 1][i].omega - x[j - 1][i].omega) * hx;
335c4762a1bSJed Brown 
336c4762a1bSJed Brown       /* V velocity */
337c4762a1bSJed Brown       u         = x[j][i].v;
338c4762a1bSJed Brown       uxx       = (2.0 * u - x[j][i - 1].v - x[j][i + 1].v) * hydhx;
339c4762a1bSJed Brown       uyy       = (2.0 * u - x[j - 1][i].v - x[j + 1][i].v) * hxdhy;
340c4762a1bSJed Brown       f[j][i].v = uxx + uyy + .5 * (x[j][i + 1].omega - x[j][i - 1].omega) * hy;
341c4762a1bSJed Brown 
342c4762a1bSJed Brown       /* Omega */
343c4762a1bSJed Brown       u             = x[j][i].omega;
344c4762a1bSJed Brown       uxx           = (2.0 * u - x[j][i - 1].omega - x[j][i + 1].omega) * hydhx;
345c4762a1bSJed Brown       uyy           = (2.0 * u - x[j - 1][i].omega - x[j + 1][i].omega) * hxdhy;
3469371c9d4SSatish Balay       f[j][i].omega = uxx + uyy + (vxp * (u - x[j][i - 1].omega) + vxm * (x[j][i + 1].omega - u)) * hy + (vyp * (u - x[j - 1][i].omega) + vym * (x[j + 1][i].omega - u)) * hx - .5 * grashof * (x[j][i + 1].temp - x[j][i - 1].temp) * hy;
347c4762a1bSJed Brown 
348c4762a1bSJed Brown       /* Temperature */
349c4762a1bSJed Brown       u            = x[j][i].temp;
350c4762a1bSJed Brown       uxx          = (2.0 * u - x[j][i - 1].temp - x[j][i + 1].temp) * hydhx;
351c4762a1bSJed Brown       uyy          = (2.0 * u - x[j - 1][i].temp - x[j + 1][i].temp) * hxdhy;
3529371c9d4SSatish Balay       f[j][i].temp = uxx + uyy + prandtl * ((vxp * (u - x[j][i - 1].temp) + vxm * (x[j][i + 1].temp - u)) * hy + (vyp * (u - x[j - 1][i].temp) + vym * (x[j + 1][i].temp - u)) * hx);
353c4762a1bSJed Brown     }
354c4762a1bSJed Brown   }
355c4762a1bSJed Brown 
356c4762a1bSJed Brown   /*
357c4762a1bSJed Brown      Flop count (multiply-adds are counted as 2 operations)
358c4762a1bSJed Brown   */
3599566063dSJacob Faibussowitsch   PetscCall(PetscLogFlops(84.0 * info->ym * info->xm));
360c4762a1bSJed Brown   PetscFunctionReturn(0);
361c4762a1bSJed Brown }
362c4762a1bSJed Brown 
363c4762a1bSJed Brown /*
364c4762a1bSJed Brown     Performs sweeps of point block nonlinear Gauss-Seidel on all the local grid points
365c4762a1bSJed Brown */
366*d71ae5a4SJacob Faibussowitsch PetscErrorCode NonlinearGS(SNES snes, Vec X, Vec B, void *ctx)
367*d71ae5a4SJacob Faibussowitsch {
368c4762a1bSJed Brown   DMDALocalInfo info;
369c4762a1bSJed Brown   Field       **x, **b;
370c4762a1bSJed Brown   Vec           localX, localB;
371c4762a1bSJed Brown   DM            da;
372c4762a1bSJed Brown   PetscInt      xints, xinte, yints, yinte, i, j, k, l;
373c4762a1bSJed Brown   PetscInt      max_its, tot_its;
374c4762a1bSJed Brown   PetscInt      sweeps;
375c4762a1bSJed Brown   PetscReal     rtol, atol, stol;
376c4762a1bSJed Brown   PetscReal     hx, hy, dhx, dhy, hxdhy, hydhx;
377c4762a1bSJed Brown   PetscReal     grashof, prandtl, lid;
378c4762a1bSJed Brown   PetscScalar   u, uxx, uyy, vx, vy, avx, avy, vxp, vxm, vyp, vym;
379c4762a1bSJed Brown   PetscScalar   fu, fv, fomega, ftemp;
380c4762a1bSJed Brown   PetscScalar   dfudu;
381c4762a1bSJed Brown   PetscScalar   dfvdv;
382c4762a1bSJed Brown   PetscScalar   dfodu, dfodv, dfodo;
383c4762a1bSJed Brown   PetscScalar   dftdu, dftdv, dftdt;
384c4762a1bSJed Brown   PetscScalar   yu = 0, yv = 0, yo = 0, yt = 0;
385c4762a1bSJed Brown   PetscScalar   bjiu, bjiv, bjiomega, bjitemp;
386c4762a1bSJed Brown   PetscBool     ptconverged;
387c4762a1bSJed Brown   PetscReal     pfnorm, pfnorm0, pynorm, pxnorm;
388c4762a1bSJed Brown   AppCtx       *user = (AppCtx *)ctx;
389c4762a1bSJed Brown 
390c4762a1bSJed Brown   PetscFunctionBeginUser;
391c4762a1bSJed Brown   grashof = user->grashof;
392c4762a1bSJed Brown   prandtl = user->prandtl;
393c4762a1bSJed Brown   lid     = user->lidvelocity;
394c4762a1bSJed Brown   tot_its = 0;
3959566063dSJacob Faibussowitsch   PetscCall(SNESNGSGetTolerances(snes, &rtol, &atol, &stol, &max_its));
3969566063dSJacob Faibussowitsch   PetscCall(SNESNGSGetSweeps(snes, &sweeps));
3979566063dSJacob Faibussowitsch   PetscCall(SNESGetDM(snes, (DM *)&da));
3989566063dSJacob Faibussowitsch   PetscCall(DMGetLocalVector(da, &localX));
39948a46eb9SPierre Jolivet   if (B) PetscCall(DMGetLocalVector(da, &localB));
400c4762a1bSJed Brown   /*
401c4762a1bSJed Brown      Scatter ghost points to local vector, using the 2-step process
402c4762a1bSJed Brown         DMGlobalToLocalBegin(), DMGlobalToLocalEnd().
403c4762a1bSJed Brown   */
4049566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalBegin(da, X, INSERT_VALUES, localX));
4059566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalEnd(da, X, INSERT_VALUES, localX));
406c4762a1bSJed Brown   if (B) {
4079566063dSJacob Faibussowitsch     PetscCall(DMGlobalToLocalBegin(da, B, INSERT_VALUES, localB));
4089566063dSJacob Faibussowitsch     PetscCall(DMGlobalToLocalEnd(da, B, INSERT_VALUES, localB));
409c4762a1bSJed Brown   }
4109566063dSJacob Faibussowitsch   PetscCall(DMDAGetLocalInfo(da, &info));
4119566063dSJacob Faibussowitsch   PetscCall(DMDAVecGetArrayWrite(da, localX, &x));
41248a46eb9SPierre Jolivet   if (B) PetscCall(DMDAVecGetArrayRead(da, localB, &b));
413c4762a1bSJed Brown   /* looks like a combination of the formfunction / formjacobian routines */
4149371c9d4SSatish Balay   dhx   = (PetscReal)(info.mx - 1);
4159371c9d4SSatish Balay   dhy   = (PetscReal)(info.my - 1);
4169371c9d4SSatish Balay   hx    = 1.0 / dhx;
4179371c9d4SSatish Balay   hy    = 1.0 / dhy;
4189371c9d4SSatish Balay   hxdhy = hx * dhy;
4199371c9d4SSatish Balay   hydhx = hy * dhx;
420c4762a1bSJed Brown 
4219371c9d4SSatish Balay   xints = info.xs;
4229371c9d4SSatish Balay   xinte = info.xs + info.xm;
4239371c9d4SSatish Balay   yints = info.ys;
4249371c9d4SSatish Balay   yinte = info.ys + info.ym;
425c4762a1bSJed Brown 
426c4762a1bSJed Brown   /* Set the boundary conditions on the momentum equations */
427c4762a1bSJed Brown   /* Test whether we are on the bottom edge of the global array */
428c4762a1bSJed Brown   if (yints == 0) {
429c4762a1bSJed Brown     j = 0;
430c4762a1bSJed Brown     /* bottom edge */
431c4762a1bSJed Brown     for (i = info.xs; i < info.xs + info.xm; i++) {
432c4762a1bSJed Brown       if (B) {
433c4762a1bSJed Brown         bjiu = b[j][i].u;
434c4762a1bSJed Brown         bjiv = b[j][i].v;
435c4762a1bSJed Brown       } else {
436c4762a1bSJed Brown         bjiu = 0.0;
437c4762a1bSJed Brown         bjiv = 0.0;
438c4762a1bSJed Brown       }
439c4762a1bSJed Brown       x[j][i].u = 0.0 + bjiu;
440c4762a1bSJed Brown       x[j][i].v = 0.0 + bjiv;
441c4762a1bSJed Brown     }
442c4762a1bSJed Brown   }
443c4762a1bSJed Brown 
444c4762a1bSJed Brown   /* Test whether we are on the top edge of the global array */
445c4762a1bSJed Brown   if (yinte == info.my) {
446c4762a1bSJed Brown     j = info.my - 1;
447c4762a1bSJed Brown     /* top edge */
448c4762a1bSJed Brown     for (i = info.xs; i < info.xs + info.xm; i++) {
449c4762a1bSJed Brown       if (B) {
450c4762a1bSJed Brown         bjiu = b[j][i].u;
451c4762a1bSJed Brown         bjiv = b[j][i].v;
452c4762a1bSJed Brown       } else {
453c4762a1bSJed Brown         bjiu = 0.0;
454c4762a1bSJed Brown         bjiv = 0.0;
455c4762a1bSJed Brown       }
456c4762a1bSJed Brown       x[j][i].u = lid + bjiu;
457c4762a1bSJed Brown       x[j][i].v = bjiv;
458c4762a1bSJed Brown     }
459c4762a1bSJed Brown   }
460c4762a1bSJed Brown 
461c4762a1bSJed Brown   /* Test whether we are on the left edge of the global array */
462c4762a1bSJed Brown   if (xints == 0) {
463c4762a1bSJed Brown     i = 0;
464c4762a1bSJed Brown     /* left edge */
465c4762a1bSJed Brown     for (j = info.ys; j < info.ys + info.ym; j++) {
466c4762a1bSJed Brown       if (B) {
467c4762a1bSJed Brown         bjiu = b[j][i].u;
468c4762a1bSJed Brown         bjiv = b[j][i].v;
469c4762a1bSJed Brown       } else {
470c4762a1bSJed Brown         bjiu = 0.0;
471c4762a1bSJed Brown         bjiv = 0.0;
472c4762a1bSJed Brown       }
473c4762a1bSJed Brown       x[j][i].u = 0.0 + bjiu;
474c4762a1bSJed Brown       x[j][i].v = 0.0 + bjiv;
475c4762a1bSJed Brown     }
476c4762a1bSJed Brown   }
477c4762a1bSJed Brown 
478c4762a1bSJed Brown   /* Test whether we are on the right edge of the global array */
479c4762a1bSJed Brown   if (xinte == info.mx) {
480c4762a1bSJed Brown     i = info.mx - 1;
481c4762a1bSJed Brown     /* right edge */
482c4762a1bSJed Brown     for (j = info.ys; j < info.ys + info.ym; j++) {
483c4762a1bSJed Brown       if (B) {
484c4762a1bSJed Brown         bjiu = b[j][i].u;
485c4762a1bSJed Brown         bjiv = b[j][i].v;
486c4762a1bSJed Brown       } else {
487c4762a1bSJed Brown         bjiu = 0.0;
488c4762a1bSJed Brown         bjiv = 0.0;
489c4762a1bSJed Brown       }
490c4762a1bSJed Brown       x[j][i].u = 0.0 + bjiu;
491c4762a1bSJed Brown       x[j][i].v = 0.0 + bjiv;
492c4762a1bSJed Brown     }
493c4762a1bSJed Brown   }
494c4762a1bSJed Brown 
495c4762a1bSJed Brown   for (k = 0; k < sweeps; k++) {
496c4762a1bSJed Brown     for (j = info.ys; j < info.ys + info.ym; j++) {
497c4762a1bSJed Brown       for (i = info.xs; i < info.xs + info.xm; i++) {
498c4762a1bSJed Brown         ptconverged = PETSC_FALSE;
499c4762a1bSJed Brown         pfnorm0     = 0.0;
500c4762a1bSJed Brown         fu          = 0.0;
501c4762a1bSJed Brown         fv          = 0.0;
502c4762a1bSJed Brown         fomega      = 0.0;
503c4762a1bSJed Brown         ftemp       = 0.0;
504c4762a1bSJed Brown         /*  Run Newton's method on a single grid point */
505c4762a1bSJed Brown         for (l = 0; l < max_its && !ptconverged; l++) {
506c4762a1bSJed Brown           if (B) {
507c4762a1bSJed Brown             bjiu     = b[j][i].u;
508c4762a1bSJed Brown             bjiv     = b[j][i].v;
509c4762a1bSJed Brown             bjiomega = b[j][i].omega;
510c4762a1bSJed Brown             bjitemp  = b[j][i].temp;
511c4762a1bSJed Brown           } else {
512c4762a1bSJed Brown             bjiu     = 0.0;
513c4762a1bSJed Brown             bjiv     = 0.0;
514c4762a1bSJed Brown             bjiomega = 0.0;
515c4762a1bSJed Brown             bjitemp  = 0.0;
516c4762a1bSJed Brown           }
517c4762a1bSJed Brown 
518c4762a1bSJed Brown           if (i != 0 && i != info.mx - 1 && j != 0 && j != info.my - 1) {
519c4762a1bSJed Brown             /* U velocity */
520c4762a1bSJed Brown             u     = x[j][i].u;
521c4762a1bSJed Brown             uxx   = (2.0 * u - x[j][i - 1].u - x[j][i + 1].u) * hydhx;
522c4762a1bSJed Brown             uyy   = (2.0 * u - x[j - 1][i].u - x[j + 1][i].u) * hxdhy;
523c4762a1bSJed Brown             fu    = uxx + uyy - .5 * (x[j + 1][i].omega - x[j - 1][i].omega) * hx - bjiu;
524c4762a1bSJed Brown             dfudu = 2.0 * (hydhx + hxdhy);
525c4762a1bSJed Brown             /* V velocity */
526c4762a1bSJed Brown             u     = x[j][i].v;
527c4762a1bSJed Brown             uxx   = (2.0 * u - x[j][i - 1].v - x[j][i + 1].v) * hydhx;
528c4762a1bSJed Brown             uyy   = (2.0 * u - x[j - 1][i].v - x[j + 1][i].v) * hxdhy;
529c4762a1bSJed Brown             fv    = uxx + uyy + .5 * (x[j][i + 1].omega - x[j][i - 1].omega) * hy - bjiv;
530c4762a1bSJed Brown             dfvdv = 2.0 * (hydhx + hxdhy);
531c4762a1bSJed Brown             /*
532c4762a1bSJed Brown              convective coefficients for upwinding
533c4762a1bSJed Brown              */
5349371c9d4SSatish Balay             vx  = x[j][i].u;
5359371c9d4SSatish Balay             avx = PetscAbsScalar(vx);
5369371c9d4SSatish Balay             vxp = .5 * (vx + avx);
5379371c9d4SSatish Balay             vxm = .5 * (vx - avx);
5389371c9d4SSatish Balay             vy  = x[j][i].v;
5399371c9d4SSatish Balay             avy = PetscAbsScalar(vy);
5409371c9d4SSatish Balay             vyp = .5 * (vy + avy);
5419371c9d4SSatish Balay             vym = .5 * (vy - avy);
542c4762a1bSJed Brown             /* Omega */
543c4762a1bSJed Brown             u      = x[j][i].omega;
544c4762a1bSJed Brown             uxx    = (2.0 * u - x[j][i - 1].omega - x[j][i + 1].omega) * hydhx;
545c4762a1bSJed Brown             uyy    = (2.0 * u - x[j - 1][i].omega - x[j + 1][i].omega) * hxdhy;
5469371c9d4SSatish Balay             fomega = uxx + uyy + (vxp * (u - x[j][i - 1].omega) + vxm * (x[j][i + 1].omega - u)) * hy + (vyp * (u - x[j - 1][i].omega) + vym * (x[j + 1][i].omega - u)) * hx - .5 * grashof * (x[j][i + 1].temp - x[j][i - 1].temp) * hy - bjiomega;
547c4762a1bSJed Brown             /* convective coefficient derivatives */
548c4762a1bSJed Brown             dfodo = 2.0 * (hydhx + hxdhy) + ((vxp - vxm) * hy + (vyp - vym) * hx);
549c4762a1bSJed Brown             if (PetscRealPart(vx) > 0.0) dfodu = (u - x[j][i - 1].omega) * hy;
550c4762a1bSJed Brown             else dfodu = (x[j][i + 1].omega - u) * hy;
551c4762a1bSJed Brown 
552c4762a1bSJed Brown             if (PetscRealPart(vy) > 0.0) dfodv = (u - x[j - 1][i].omega) * hx;
553c4762a1bSJed Brown             else dfodv = (x[j + 1][i].omega - u) * hx;
554c4762a1bSJed Brown 
555c4762a1bSJed Brown             /* Temperature */
556c4762a1bSJed Brown             u     = x[j][i].temp;
557c4762a1bSJed Brown             uxx   = (2.0 * u - x[j][i - 1].temp - x[j][i + 1].temp) * hydhx;
558c4762a1bSJed Brown             uyy   = (2.0 * u - x[j - 1][i].temp - x[j + 1][i].temp) * hxdhy;
559c4762a1bSJed Brown             ftemp = uxx + uyy + prandtl * ((vxp * (u - x[j][i - 1].temp) + vxm * (x[j][i + 1].temp - u)) * hy + (vyp * (u - x[j - 1][i].temp) + vym * (x[j + 1][i].temp - u)) * hx) - bjitemp;
560c4762a1bSJed Brown             dftdt = 2.0 * (hydhx + hxdhy) + prandtl * ((vxp - vxm) * hy + (vyp - vym) * hx);
561c4762a1bSJed Brown             if (PetscRealPart(vx) > 0.0) dftdu = prandtl * (u - x[j][i - 1].temp) * hy;
562c4762a1bSJed Brown             else dftdu = prandtl * (x[j][i + 1].temp - u) * hy;
563c4762a1bSJed Brown 
564c4762a1bSJed Brown             if (PetscRealPart(vy) > 0.0) dftdv = prandtl * (u - x[j - 1][i].temp) * hx;
565c4762a1bSJed Brown             else dftdv = prandtl * (x[j + 1][i].temp - u) * hx;
566c4762a1bSJed Brown 
567c4762a1bSJed Brown             /* invert the system:
568c4762a1bSJed Brown              [ dfu / du     0        0        0    ][yu] = [fu]
569c4762a1bSJed Brown              [     0    dfv / dv     0        0    ][yv]   [fv]
570c4762a1bSJed Brown              [ dfo / du dfo / dv dfo / do     0    ][yo]   [fo]
571c4762a1bSJed Brown              [ dft / du dft / dv     0    dft / dt ][yt]   [ft]
572c4762a1bSJed Brown              by simple back-substitution
573c4762a1bSJed Brown            */
574c4762a1bSJed Brown             yu = fu / dfudu;
575c4762a1bSJed Brown             yv = fv / dfvdv;
576c4762a1bSJed Brown             yo = (fomega - (dfodu * yu + dfodv * yv)) / dfodo;
577c4762a1bSJed Brown             yt = (ftemp - (dftdu * yu + dftdv * yv)) / dftdt;
578c4762a1bSJed Brown 
579c4762a1bSJed Brown             x[j][i].u     = x[j][i].u - yu;
580c4762a1bSJed Brown             x[j][i].v     = x[j][i].v - yv;
581c4762a1bSJed Brown             x[j][i].temp  = x[j][i].temp - yt;
582c4762a1bSJed Brown             x[j][i].omega = x[j][i].omega - yo;
583c4762a1bSJed Brown           }
584c4762a1bSJed Brown           if (i == 0) {
585c4762a1bSJed Brown             fomega        = x[j][i].omega - (x[j][i + 1].v - x[j][i].v) * dhx - bjiomega;
586c4762a1bSJed Brown             ftemp         = x[j][i].temp - bjitemp;
587c4762a1bSJed Brown             yo            = fomega;
588c4762a1bSJed Brown             yt            = ftemp;
589c4762a1bSJed Brown             x[j][i].omega = x[j][i].omega - fomega;
590c4762a1bSJed Brown             x[j][i].temp  = x[j][i].temp - ftemp;
591c4762a1bSJed Brown           }
592c4762a1bSJed Brown           if (i == info.mx - 1) {
593c4762a1bSJed Brown             fomega        = x[j][i].omega - (x[j][i].v - x[j][i - 1].v) * dhx - bjiomega;
594c4762a1bSJed Brown             ftemp         = x[j][i].temp - (PetscReal)(grashof > 0) - bjitemp;
595c4762a1bSJed Brown             yo            = fomega;
596c4762a1bSJed Brown             yt            = ftemp;
597c4762a1bSJed Brown             x[j][i].omega = x[j][i].omega - fomega;
598c4762a1bSJed Brown             x[j][i].temp  = x[j][i].temp - ftemp;
599c4762a1bSJed Brown           }
600c4762a1bSJed Brown           if (j == 0) {
601c4762a1bSJed Brown             fomega        = x[j][i].omega + (x[j + 1][i].u - x[j][i].u) * dhy - bjiomega;
602c4762a1bSJed Brown             ftemp         = x[j][i].temp - x[j + 1][i].temp - bjitemp;
603c4762a1bSJed Brown             yo            = fomega;
604c4762a1bSJed Brown             yt            = ftemp;
605c4762a1bSJed Brown             x[j][i].omega = x[j][i].omega - fomega;
606c4762a1bSJed Brown             x[j][i].temp  = x[j][i].temp - ftemp;
607c4762a1bSJed Brown           }
608c4762a1bSJed Brown           if (j == info.my - 1) {
609c4762a1bSJed Brown             fomega        = x[j][i].omega + (x[j][i].u - x[j - 1][i].u) * dhy - bjiomega;
610c4762a1bSJed Brown             ftemp         = x[j][i].temp - x[j - 1][i].temp - bjitemp;
611c4762a1bSJed Brown             yo            = fomega;
612c4762a1bSJed Brown             yt            = ftemp;
613c4762a1bSJed Brown             x[j][i].omega = x[j][i].omega - fomega;
614c4762a1bSJed Brown             x[j][i].temp  = x[j][i].temp - ftemp;
615c4762a1bSJed Brown           }
616c4762a1bSJed Brown           tot_its++;
617c4762a1bSJed Brown           pfnorm = PetscRealPart(fu * fu + fv * fv + fomega * fomega + ftemp * ftemp);
618c4762a1bSJed Brown           pfnorm = PetscSqrtReal(pfnorm);
619c4762a1bSJed Brown           pynorm = PetscRealPart(yu * yu + yv * yv + yo * yo + yt * yt);
620c4762a1bSJed Brown           pynorm = PetscSqrtReal(pynorm);
621c4762a1bSJed Brown           pxnorm = PetscRealPart(x[j][i].u * x[j][i].u + x[j][i].v * x[j][i].v + x[j][i].omega * x[j][i].omega + x[j][i].temp * x[j][i].temp);
622c4762a1bSJed Brown           pxnorm = PetscSqrtReal(pxnorm);
623c4762a1bSJed Brown           if (l == 0) pfnorm0 = pfnorm;
624c4762a1bSJed Brown           if (rtol * pfnorm0 > pfnorm || atol > pfnorm || pxnorm * stol > pynorm) ptconverged = PETSC_TRUE;
625c4762a1bSJed Brown         }
626c4762a1bSJed Brown       }
627c4762a1bSJed Brown     }
628c4762a1bSJed Brown   }
6299566063dSJacob Faibussowitsch   PetscCall(DMDAVecRestoreArrayWrite(da, localX, &x));
63048a46eb9SPierre Jolivet   if (B) PetscCall(DMDAVecRestoreArrayRead(da, localB, &b));
6319566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalBegin(da, localX, INSERT_VALUES, X));
6329566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalEnd(da, localX, INSERT_VALUES, X));
6339566063dSJacob Faibussowitsch   PetscCall(PetscLogFlops(tot_its * (84.0 + 41.0 + 26.0)));
6349566063dSJacob Faibussowitsch   PetscCall(DMRestoreLocalVector(da, &localX));
63548a46eb9SPierre Jolivet   if (B) PetscCall(DMRestoreLocalVector(da, &localB));
636c4762a1bSJed Brown   PetscFunctionReturn(0);
637c4762a1bSJed Brown }
638c4762a1bSJed Brown 
639c4762a1bSJed Brown /*TEST
640c4762a1bSJed Brown 
641c4762a1bSJed Brown    test:
642c4762a1bSJed Brown       nsize: 2
643c4762a1bSJed Brown       args: -da_refine 3 -snes_monitor_short -pc_type mg -ksp_type fgmres -pc_mg_type full
644c4762a1bSJed Brown       requires: !single
645c4762a1bSJed Brown 
646c4762a1bSJed Brown    test:
647c4762a1bSJed Brown       suffix: 10
648c4762a1bSJed Brown       nsize: 3
649c4762a1bSJed Brown       args: -snes_monitor_short -ksp_monitor_short -pc_type fieldsplit -pc_fieldsplit_type symmetric_multiplicative -snes_view -da_refine 1 -ksp_type fgmres
650c4762a1bSJed Brown       requires: !single
651c4762a1bSJed Brown 
652c4762a1bSJed Brown    test:
653c4762a1bSJed Brown       suffix: 11
654c4762a1bSJed Brown       nsize: 4
655c4762a1bSJed Brown       requires: pastix
656c4762a1bSJed Brown       args: -snes_monitor_short -pc_type redundant -dm_mat_type mpiaij -redundant_pc_factor_mat_solver_type pastix -pc_redundant_number 2 -da_refine 4 -ksp_type fgmres
657c4762a1bSJed Brown 
658c4762a1bSJed Brown    test:
659c4762a1bSJed Brown       suffix: 12
660c4762a1bSJed Brown       nsize: 12
661c4762a1bSJed Brown       requires: pastix
662c4762a1bSJed Brown       args: -snes_monitor_short -pc_type redundant -dm_mat_type mpiaij -redundant_pc_factor_mat_solver_type pastix -pc_redundant_number 5 -da_refine 4 -ksp_type fgmres
663c4762a1bSJed Brown 
664c4762a1bSJed Brown    test:
665c4762a1bSJed Brown       suffix: 13
666c4762a1bSJed Brown       nsize: 3
667c4762a1bSJed Brown       args: -snes_monitor_short -ksp_monitor_short -pc_type fieldsplit -pc_fieldsplit_type multiplicative -snes_view -da_refine 1 -ksp_type fgmres -snes_mf_operator
668c4762a1bSJed Brown       requires: !single
669c4762a1bSJed Brown 
670c4762a1bSJed Brown    test:
671c4762a1bSJed Brown       suffix: 14
672c4762a1bSJed Brown       nsize: 4
673c4762a1bSJed Brown       args: -snes_monitor_short -pc_type mg -dm_mat_type baij -mg_coarse_pc_type bjacobi -da_refine 3 -ksp_type fgmres
674c4762a1bSJed Brown       requires: !single
675c4762a1bSJed Brown 
676c4762a1bSJed Brown    test:
677c4762a1bSJed Brown       suffix: 14_ds
678c4762a1bSJed Brown       nsize: 4
679c4762a1bSJed Brown       args: -snes_converged_reason -pc_type mg -dm_mat_type baij -mg_coarse_pc_type bjacobi -da_refine 3 -ksp_type fgmres -mat_fd_type ds
680c4762a1bSJed Brown       output_file: output/ex19_2.out
681c4762a1bSJed Brown       requires: !single
682c4762a1bSJed Brown 
683c4762a1bSJed Brown    test:
684c4762a1bSJed Brown       suffix: 17
685c4762a1bSJed Brown       args: -snes_monitor_short -ksp_pc_side right
686c4762a1bSJed Brown       requires: !single
687c4762a1bSJed Brown 
688c4762a1bSJed Brown    test:
689c4762a1bSJed Brown       suffix: 18
690798534f6SMatthew G. Knepley       args: -snes_monitor_ksp draw::draw_lg -ksp_pc_side right
691c4762a1bSJed Brown       requires: x !single
692c4762a1bSJed Brown 
693c4762a1bSJed Brown    test:
69441ba4c6cSHeeho Park       suffix: 19
69541ba4c6cSHeeho Park       nsize: 2
69641ba4c6cSHeeho Park       args: -da_refine 3 -snes_monitor_short -pc_type mg -ksp_type fgmres -pc_mg_type full -snes_type newtontrdc
69741ba4c6cSHeeho Park       requires: !single
69841ba4c6cSHeeho Park 
69941ba4c6cSHeeho Park    test:
70041ba4c6cSHeeho Park       suffix: 20
70141ba4c6cSHeeho Park       nsize: 2
70241ba4c6cSHeeho Park       args: -da_refine 3 -snes_monitor_short -pc_type mg -ksp_type fgmres -pc_mg_type full -snes_type newtontrdc -snes_trdc_use_cauchy false
70341ba4c6cSHeeho Park       requires: !single
70441ba4c6cSHeeho Park 
70541ba4c6cSHeeho Park    test:
706c4762a1bSJed Brown       suffix: 2
707c4762a1bSJed Brown       nsize: 4
708c4762a1bSJed Brown       args: -da_refine 3 -snes_converged_reason -pc_type mg -mat_fd_type ds
709c4762a1bSJed Brown       requires: !single
710c4762a1bSJed Brown 
711c4762a1bSJed Brown    test:
712c4762a1bSJed Brown       suffix: 2_bcols1
713c4762a1bSJed Brown       nsize: 4
714c4762a1bSJed Brown       args: -da_refine 3 -snes_converged_reason -pc_type mg -mat_fd_type ds -mat_fd_coloring_bcols
715c4762a1bSJed Brown       output_file: output/ex19_2.out
716c4762a1bSJed Brown       requires: !single
717c4762a1bSJed Brown 
718c4762a1bSJed Brown    test:
719c4762a1bSJed Brown       suffix: 3
720c4762a1bSJed Brown       nsize: 4
721c4762a1bSJed Brown       requires: mumps
722c4762a1bSJed Brown       args: -da_refine 3 -snes_monitor_short -pc_type redundant -dm_mat_type mpiaij -redundant_ksp_type preonly -redundant_pc_factor_mat_solver_type mumps -pc_redundant_number 2
723c4762a1bSJed Brown 
724c4762a1bSJed Brown    test:
725c4762a1bSJed Brown       suffix: 4
726c4762a1bSJed Brown       nsize: 12
727c4762a1bSJed Brown       requires: mumps
728c4762a1bSJed Brown       args: -da_refine 3 -snes_monitor_short -pc_type redundant -dm_mat_type mpiaij -redundant_ksp_type preonly -redundant_pc_factor_mat_solver_type mumps -pc_redundant_number 5
729c4762a1bSJed Brown       output_file: output/ex19_3.out
730c4762a1bSJed Brown 
731c4762a1bSJed Brown    test:
732c4762a1bSJed Brown       suffix: 6
733c4762a1bSJed Brown       args: -snes_monitor_short -ksp_monitor_short -pc_type fieldsplit -snes_view -ksp_type fgmres -da_refine 1
734c4762a1bSJed Brown       requires: !single
735c4762a1bSJed Brown 
736c4762a1bSJed Brown    test:
737c4762a1bSJed Brown       suffix: 7
738c4762a1bSJed Brown       nsize: 3
739c4762a1bSJed Brown       args: -snes_monitor_short -ksp_monitor_short -pc_type fieldsplit -snes_view -da_refine 1 -ksp_type fgmres
740c4762a1bSJed Brown 
741c4762a1bSJed Brown       requires: !single
742c4762a1bSJed Brown    test:
743c4762a1bSJed Brown       suffix: 8
744c4762a1bSJed Brown       args: -snes_monitor_short -ksp_monitor_short -pc_type fieldsplit -pc_fieldsplit_block_size 2 -pc_fieldsplit_0_fields 0,1 -pc_fieldsplit_1_fields 0,1 -pc_fieldsplit_type multiplicative -snes_view -fieldsplit_pc_type lu -da_refine 1 -ksp_type fgmres
745c4762a1bSJed Brown       requires: !single
746c4762a1bSJed Brown 
747c4762a1bSJed Brown    test:
748c4762a1bSJed Brown       suffix: 9
749c4762a1bSJed Brown       nsize: 3
750c4762a1bSJed Brown       args: -snes_monitor_short -ksp_monitor_short -pc_type fieldsplit -pc_fieldsplit_type multiplicative -snes_view -da_refine 1 -ksp_type fgmres
751c4762a1bSJed Brown       requires: !single
752c4762a1bSJed Brown 
753c4762a1bSJed Brown    test:
754c4762a1bSJed Brown       suffix: aspin
755c4762a1bSJed Brown       nsize: 4
756c4762a1bSJed Brown       args: -da_refine 3 -da_overlap 2 -snes_monitor_short -snes_type aspin -grashof 4e4 -lidvelocity 100 -ksp_monitor_short
757c4762a1bSJed Brown       requires: !single
758c4762a1bSJed Brown 
759c4762a1bSJed Brown    test:
760c4762a1bSJed Brown       suffix: bcgsl
761c4762a1bSJed Brown       nsize: 2
762c4762a1bSJed Brown       args: -ksp_type bcgsl -ksp_monitor_short -da_refine 2 -ksp_bcgsl_ell 3 -snes_view
763c4762a1bSJed Brown       requires: !single
764c4762a1bSJed Brown 
765c4762a1bSJed Brown    test:
766c4762a1bSJed Brown       suffix: bcols1
767c4762a1bSJed Brown       nsize: 2
768c4762a1bSJed Brown       args: -da_refine 3 -snes_monitor_short -pc_type mg -ksp_type fgmres -pc_mg_type full -mat_fd_coloring_bcols 1
769c4762a1bSJed Brown       output_file: output/ex19_1.out
770c4762a1bSJed Brown       requires: !single
771c4762a1bSJed Brown 
772c4762a1bSJed Brown    test:
773c4762a1bSJed Brown       suffix: bjacobi
774c4762a1bSJed Brown       nsize: 4
775c4762a1bSJed Brown       args: -da_refine 4 -ksp_type fgmres -pc_type bjacobi -pc_bjacobi_blocks 2 -sub_ksp_type gmres -sub_ksp_max_it 2 -sub_pc_type bjacobi -sub_sub_ksp_type preonly -sub_sub_pc_type ilu -snes_monitor_short
776c4762a1bSJed Brown       requires: !single
777c4762a1bSJed Brown 
778c4762a1bSJed Brown    test:
779c4762a1bSJed Brown       suffix: cgne
780c4762a1bSJed Brown       args: -da_refine 2 -pc_type lu -ksp_type cgne -ksp_monitor_short -ksp_converged_reason -ksp_view -ksp_norm_type unpreconditioned
781c4762a1bSJed Brown       filter: grep -v HERMITIAN
782c4762a1bSJed Brown       requires: !single
783c4762a1bSJed Brown 
784c4762a1bSJed Brown    test:
785c4762a1bSJed Brown       suffix: cgs
786c4762a1bSJed Brown       args: -da_refine 1 -ksp_monitor_short -ksp_type cgs
787c4762a1bSJed Brown       requires: !single
788c4762a1bSJed Brown 
789c4762a1bSJed Brown    test:
790c4762a1bSJed Brown       suffix: composite_fieldsplit
791c4762a1bSJed Brown       args: -ksp_type fgmres -pc_type composite -pc_composite_type MULTIPLICATIVE -pc_composite_pcs fieldsplit,none -sub_0_pc_fieldsplit_block_size 4 -sub_0_pc_fieldsplit_type additive -sub_0_pc_fieldsplit_0_fields 0,1,2 -sub_0_pc_fieldsplit_1_fields 3 -snes_monitor_short -ksp_monitor_short
792c4762a1bSJed Brown       requires: !single
793c4762a1bSJed Brown 
794c4762a1bSJed Brown    test:
795c4762a1bSJed Brown       suffix: composite_fieldsplit_bjacobi
796c4762a1bSJed Brown       args: -ksp_type fgmres -pc_type composite -pc_composite_type MULTIPLICATIVE -pc_composite_pcs fieldsplit,bjacobi -sub_0_pc_fieldsplit_block_size 4 -sub_0_pc_fieldsplit_type additive -sub_0_pc_fieldsplit_0_fields 0,1,2 -sub_0_pc_fieldsplit_1_fields 3 -sub_1_pc_bjacobi_blocks 16 -sub_1_sub_pc_type lu -snes_monitor_short -ksp_monitor_short
797c4762a1bSJed Brown       requires: !single
798c4762a1bSJed Brown 
799c4762a1bSJed Brown    test:
800c4762a1bSJed Brown       suffix: composite_fieldsplit_bjacobi_2
801c4762a1bSJed Brown       nsize: 4
802c4762a1bSJed Brown       args: -ksp_type fgmres -pc_type composite -pc_composite_type MULTIPLICATIVE -pc_composite_pcs fieldsplit,bjacobi -sub_0_pc_fieldsplit_block_size 4 -sub_0_pc_fieldsplit_type additive -sub_0_pc_fieldsplit_0_fields 0,1,2 -sub_0_pc_fieldsplit_1_fields 3 -sub_1_pc_bjacobi_blocks 16 -sub_1_sub_pc_type lu -snes_monitor_short -ksp_monitor_short
803c4762a1bSJed Brown       requires: !single
804c4762a1bSJed Brown 
805c4762a1bSJed Brown    test:
806c4762a1bSJed Brown       suffix: composite_gs_newton
807c4762a1bSJed Brown       nsize: 2
808c4762a1bSJed Brown       args: -da_refine 3 -grashof 4e4 -lidvelocity 100 -snes_monitor_short -snes_type composite -snes_composite_type additiveoptimal -snes_composite_sneses ngs,newtonls -sub_0_snes_max_it 20 -sub_1_pc_type mg
809c4762a1bSJed Brown       requires: !single
810c4762a1bSJed Brown 
811c4762a1bSJed Brown    test:
812c4762a1bSJed Brown       suffix: cuda
813c4762a1bSJed Brown       requires: cuda !single
814c4762a1bSJed Brown       args: -dm_vec_type cuda -dm_mat_type aijcusparse -pc_type none -ksp_type fgmres -snes_monitor_short -snes_rtol 1.e-5
815c4762a1bSJed Brown 
816c4762a1bSJed Brown    test:
817c4762a1bSJed Brown       suffix: draw
818c4762a1bSJed Brown       args: -pc_type fieldsplit -snes_view draw -fieldsplit_x_velocity_pc_type mg -fieldsplit_x_velocity_pc_mg_galerkin pmat -fieldsplit_x_velocity_pc_mg_levels 2 -da_refine 1 -fieldsplit_x_velocity_mg_coarse_pc_type svd
819c4762a1bSJed Brown       requires: x !single
820c4762a1bSJed Brown 
821c4762a1bSJed Brown    test:
822c4762a1bSJed Brown       suffix: drawports
823c4762a1bSJed Brown       args: -snes_monitor_solution draw::draw_ports -da_refine 1
824c4762a1bSJed Brown       output_file: output/ex19_draw.out
825c4762a1bSJed Brown       requires: x !single
826c4762a1bSJed Brown 
827c4762a1bSJed Brown    test:
828c4762a1bSJed Brown       suffix: fas
829c4762a1bSJed Brown       args: -da_refine 4 -snes_monitor_short -snes_type fas -fas_levels_snes_type ngs -fas_levels_snes_ngs_sweeps 3 -fas_levels_snes_ngs_atol 0.0 -fas_levels_snes_ngs_stol 0.0 -grashof 4e4 -snes_fas_smoothup 6 -snes_fas_smoothdown 6 -lidvelocity 100
830c4762a1bSJed Brown       requires: !single
831c4762a1bSJed Brown 
832c4762a1bSJed Brown    test:
833c4762a1bSJed Brown       suffix: fas_full
834c4762a1bSJed Brown       args: -da_refine 4 -snes_monitor_short -snes_type fas -snes_fas_type full -snes_fas_full_downsweep -fas_levels_snes_type ngs -fas_levels_snes_ngs_sweeps 3 -fas_levels_snes_ngs_atol 0.0 -fas_levels_snes_ngs_stol 0.0 -grashof 4e4 -snes_fas_smoothup 6 -snes_fas_smoothdown 6 -lidvelocity 100
835c4762a1bSJed Brown       requires: !single
836c4762a1bSJed Brown 
837c4762a1bSJed Brown    test:
838c4762a1bSJed Brown       suffix: fdcoloring_ds
839c4762a1bSJed Brown       args: -da_refine 3 -snes_converged_reason -pc_type mg -mat_fd_type ds
840c4762a1bSJed Brown       output_file: output/ex19_2.out
841c4762a1bSJed Brown       requires: !single
842c4762a1bSJed Brown 
843c4762a1bSJed Brown    test:
844c4762a1bSJed Brown       suffix: fdcoloring_ds_baij
845c4762a1bSJed Brown       args: -da_refine 3 -snes_converged_reason -pc_type mg -mat_fd_type ds -dm_mat_type baij
846c4762a1bSJed Brown       output_file: output/ex19_2.out
847c4762a1bSJed Brown       requires: !single
848c4762a1bSJed Brown 
849c4762a1bSJed Brown    test:
850c4762a1bSJed Brown       suffix: fdcoloring_ds_bcols1
851c4762a1bSJed Brown       args: -da_refine 3 -snes_converged_reason -pc_type mg -mat_fd_type ds -mat_fd_coloring_bcols 1
852c4762a1bSJed Brown       output_file: output/ex19_2.out
853c4762a1bSJed Brown       requires: !single
854c4762a1bSJed Brown 
855c4762a1bSJed Brown    test:
856c4762a1bSJed Brown       suffix: fdcoloring_wp
857c4762a1bSJed Brown       args: -da_refine 3 -snes_monitor_short -pc_type mg
858c4762a1bSJed Brown       requires: !single
859c4762a1bSJed Brown 
860c4762a1bSJed Brown    test:
861c4762a1bSJed Brown       suffix: fdcoloring_wp_baij
862c4762a1bSJed Brown       args: -da_refine 3 -snes_monitor_short -pc_type mg -dm_mat_type baij
863c4762a1bSJed Brown       output_file: output/ex19_fdcoloring_wp.out
864c4762a1bSJed Brown       requires: !single
865c4762a1bSJed Brown 
866c4762a1bSJed Brown    test:
867c4762a1bSJed Brown       suffix: fdcoloring_wp_bcols1
868c4762a1bSJed Brown       args: -da_refine 3 -snes_monitor_short -pc_type mg -mat_fd_coloring_bcols 1
869c4762a1bSJed Brown       output_file: output/ex19_fdcoloring_wp.out
870c4762a1bSJed Brown       requires: !single
871c4762a1bSJed Brown 
872c4762a1bSJed Brown    test:
873c4762a1bSJed Brown       suffix: fieldsplit_2
874c4762a1bSJed Brown       args: -ksp_type fgmres -pc_type fieldsplit -pc_fieldsplit_block_size 4 -pc_fieldsplit_type additive -pc_fieldsplit_0_fields 0,1,2 -pc_fieldsplit_1_fields 3 -snes_monitor_short -ksp_monitor_short
875c4762a1bSJed Brown       requires: !single
876c4762a1bSJed Brown 
877c4762a1bSJed Brown    test:
878c4762a1bSJed Brown       suffix: fieldsplit_3
879c4762a1bSJed Brown       args: -ksp_type fgmres -pc_type fieldsplit -pc_fieldsplit_block_size 4 -pc_fieldsplit_type additive -pc_fieldsplit_0_fields 0,1,2 -pc_fieldsplit_1_fields 3 -fieldsplit_0_pc_type lu -fieldsplit_1_pc_type lu -snes_monitor_short -ksp_monitor_short
880c4762a1bSJed Brown       requires: !single
881c4762a1bSJed Brown 
882c4762a1bSJed Brown    test:
883c4762a1bSJed Brown       suffix: fieldsplit_4
884c4762a1bSJed Brown       args: -ksp_type fgmres -pc_type fieldsplit -pc_fieldsplit_block_size 4 -pc_fieldsplit_type SCHUR -pc_fieldsplit_0_fields 0,1,2 -pc_fieldsplit_1_fields 3 -fieldsplit_0_pc_type lu -fieldsplit_1_pc_type lu -snes_monitor_short -ksp_monitor_short
885c4762a1bSJed Brown       requires: !single
886c4762a1bSJed Brown 
887c4762a1bSJed Brown    # HYPRE PtAP broken with complex numbers
888c4762a1bSJed Brown    test:
889c4762a1bSJed Brown       suffix: fieldsplit_hypre
890c4762a1bSJed Brown       nsize: 2
891263f2b91SStefano Zampini       requires: hypre mumps !complex !defined(PETSC_HAVE_HYPRE_DEVICE)
892c4762a1bSJed Brown       args: -pc_type fieldsplit -pc_fieldsplit_block_size 4 -pc_fieldsplit_type SCHUR -pc_fieldsplit_0_fields 0,1,2 -pc_fieldsplit_1_fields 3 -fieldsplit_0_pc_type lu -fieldsplit_0_pc_factor_mat_solver_type mumps -fieldsplit_1_pc_type hypre -fieldsplit_1_pc_hypre_type boomeramg -snes_monitor_short -ksp_monitor_short
893c4762a1bSJed Brown 
894c4762a1bSJed Brown    test:
895c4762a1bSJed Brown       suffix: fieldsplit_mumps
896c4762a1bSJed Brown       nsize: 2
897c4762a1bSJed Brown       requires: mumps
898c4762a1bSJed Brown       args: -pc_type fieldsplit -pc_fieldsplit_block_size 4 -pc_fieldsplit_type SCHUR -pc_fieldsplit_0_fields 0,1,2 -pc_fieldsplit_1_fields 3 -fieldsplit_0_pc_type lu -fieldsplit_1_pc_type lu -snes_monitor_short -ksp_monitor_short -fieldsplit_0_pc_factor_mat_solver_type mumps -fieldsplit_1_pc_factor_mat_solver_type mumps
899c4762a1bSJed Brown       output_file: output/ex19_fieldsplit_5.out
900c4762a1bSJed Brown 
901c4762a1bSJed Brown    test:
902c4762a1bSJed Brown       suffix: greedy_coloring
903c4762a1bSJed Brown       nsize: 2
904c4762a1bSJed Brown       args: -da_refine 3 -snes_monitor_short -snes_fd_color -snes_fd_color_use_mat -mat_coloring_type greedy -mat_coloring_weight_type lf -mat_coloring_view> ex19_greedy_coloring.tmp 2>&1
905c4762a1bSJed Brown       requires: !single
906c4762a1bSJed Brown 
907c4762a1bSJed Brown    # HYPRE PtAP broken with complex numbers
908c4762a1bSJed Brown    test:
909c4762a1bSJed Brown       suffix: hypre
910c4762a1bSJed Brown       nsize: 2
911263f2b91SStefano Zampini       requires: hypre !complex !defined(PETSC_HAVE_HYPRE_DEVICE)
912263f2b91SStefano Zampini       args: -da_refine 3 -snes_monitor_short -pc_type hypre -ksp_norm_type unpreconditioned
913c4762a1bSJed Brown 
914263f2b91SStefano Zampini    # ibcgs is broken when using device vectors
915c4762a1bSJed Brown    test:
916c4762a1bSJed Brown       suffix: ibcgs
917c4762a1bSJed Brown       nsize: 2
918c4762a1bSJed Brown       args: -ksp_type ibcgs -ksp_monitor_short -da_refine 2 -snes_view
919c4762a1bSJed Brown       requires: !complex !single
920c4762a1bSJed Brown 
921c4762a1bSJed Brown    test:
922c4762a1bSJed Brown       suffix: kaczmarz
923c4762a1bSJed Brown       nsize: 2
924c4762a1bSJed Brown       args: -pc_type kaczmarz -ksp_monitor_short -snes_monitor_short -snes_view
925c4762a1bSJed Brown       requires: !single
926c4762a1bSJed Brown 
927c4762a1bSJed Brown    test:
928c4762a1bSJed Brown       suffix: klu
929c4762a1bSJed Brown       requires: suitesparse
930c4762a1bSJed Brown       args: -da_grid_x 20 -da_grid_y 20 -pc_type lu -pc_factor_mat_solver_type klu
931c4762a1bSJed Brown       output_file: output/ex19_superlu.out
932c4762a1bSJed Brown 
933c4762a1bSJed Brown    test:
934c4762a1bSJed Brown       suffix: klu_2
935c4762a1bSJed Brown       requires: suitesparse
9364ac6704cSBarry Smith       args: -da_grid_x 20 -da_grid_y 20 -pc_type lu -pc_factor_mat_solver_type klu -pc_factor_mat_ordering_type nd
937c4762a1bSJed Brown       output_file: output/ex19_superlu.out
938c4762a1bSJed Brown 
939c4762a1bSJed Brown    test:
940c4762a1bSJed Brown       suffix: klu_3
941c4762a1bSJed Brown       requires: suitesparse
942c4762a1bSJed Brown       args: -da_grid_x 20 -da_grid_y 20 -pc_type lu -pc_factor_mat_solver_type klu -mat_klu_use_btf 0
943c4762a1bSJed Brown       output_file: output/ex19_superlu.out
944c4762a1bSJed Brown 
945c4762a1bSJed Brown    test:
946c4762a1bSJed Brown       suffix: ml
947c4762a1bSJed Brown       nsize: 2
948c4762a1bSJed Brown       requires: ml
949c4762a1bSJed Brown       args: -da_refine 3 -snes_monitor_short -pc_type ml
950c4762a1bSJed Brown 
951c4762a1bSJed Brown    test:
952c4762a1bSJed Brown       suffix: ngmres_fas
953c4762a1bSJed Brown       args: -da_refine 4 -snes_monitor_short -snes_type ngmres -npc_fas_levels_snes_type ngs -npc_fas_levels_snes_ngs_sweeps 3 -npc_fas_levels_snes_ngs_atol 0.0 -npc_fas_levels_snes_ngs_stol 0.0 -npc_snes_type fas -npc_fas_levels_snes_type ngs -npc_snes_max_it 1 -npc_snes_fas_smoothup 6 -npc_snes_fas_smoothdown 6 -lidvelocity 100 -grashof 4e4
954c4762a1bSJed Brown       requires: !single
955c4762a1bSJed Brown 
956c4762a1bSJed Brown    test:
957c4762a1bSJed Brown       suffix: ngmres_fas_gssecant
958c4762a1bSJed Brown       args: -da_refine 3 -snes_monitor_short -snes_type ngmres -npc_snes_type fas -npc_fas_levels_snes_type ngs -npc_fas_levels_snes_max_it 6 -npc_fas_levels_snes_ngs_secant -npc_fas_levels_snes_ngs_max_it 1 -npc_fas_coarse_snes_max_it 1 -lidvelocity 100 -grashof 4e4
959c4762a1bSJed Brown       requires: !single
960c4762a1bSJed Brown 
961c4762a1bSJed Brown    test:
962c4762a1bSJed Brown       suffix: ngmres_fas_ms
963c4762a1bSJed Brown       nsize: 2
964c4762a1bSJed Brown       args: -snes_grid_sequence 2 -lidvelocity 200 -grashof 1e4 -snes_monitor_short -snes_view -snes_converged_reason -snes_type ngmres -npc_snes_type fas -npc_fas_coarse_snes_type newtonls -npc_fas_coarse_ksp_type preonly -npc_snes_max_it 1
965c4762a1bSJed Brown       requires: !single
966c4762a1bSJed Brown 
967c4762a1bSJed Brown    test:
968c4762a1bSJed Brown       suffix: ngmres_nasm
969c4762a1bSJed Brown       nsize: 4
970c4762a1bSJed Brown       args: -da_refine 4 -da_overlap 2 -snes_monitor_short -snes_type ngmres -snes_max_it 10 -npc_snes_type nasm -npc_snes_nasm_type basic -grashof 4e4 -lidvelocity 100
971c4762a1bSJed Brown       requires: !single
972c4762a1bSJed Brown 
973c4762a1bSJed Brown    test:
974c4762a1bSJed Brown       suffix: ngs
975c4762a1bSJed Brown       args: -snes_type ngs -snes_view -snes_monitor -snes_rtol 1e-4
976c4762a1bSJed Brown       requires: !single
977c4762a1bSJed Brown 
978c4762a1bSJed Brown    test:
979c4762a1bSJed Brown       suffix: ngs_fd
980c4762a1bSJed Brown       args: -snes_type ngs -snes_ngs_secant -snes_view -snes_monitor -snes_rtol 1e-4
981c4762a1bSJed Brown       requires: !single
982c4762a1bSJed Brown 
983c4762a1bSJed Brown    test:
984c4762a1bSJed Brown       suffix: parms
985c4762a1bSJed Brown       nsize: 2
986c4762a1bSJed Brown       requires: parms
987c4762a1bSJed Brown       args: -pc_type parms -ksp_monitor_short -snes_view
988c4762a1bSJed Brown 
989c4762a1bSJed Brown    test:
990c4762a1bSJed Brown       suffix: superlu
991c4762a1bSJed Brown       requires: superlu
992c4762a1bSJed Brown       args: -da_grid_x 20 -da_grid_y 20 -pc_type lu -pc_factor_mat_solver_type superlu
993c4762a1bSJed Brown 
994c4762a1bSJed Brown    test:
995c4762a1bSJed Brown       suffix: superlu_sell
996c4762a1bSJed Brown       requires: superlu
997c4762a1bSJed Brown       args: -da_grid_x 20 -da_grid_y 20 -pc_type lu -pc_factor_mat_solver_type superlu -dm_mat_type sell -pc_factor_mat_ordering_type natural
998c4762a1bSJed Brown       output_file: output/ex19_superlu.out
999c4762a1bSJed Brown 
1000c4762a1bSJed Brown    test:
1001c4762a1bSJed Brown       suffix: superlu_dist
1002c4762a1bSJed Brown       requires: superlu_dist
1003c4762a1bSJed Brown       args: -da_grid_x 20 -da_grid_y 20 -pc_type lu -pc_factor_mat_solver_type superlu_dist
1004c4762a1bSJed Brown       output_file: output/ex19_superlu.out
1005c4762a1bSJed Brown 
1006c4762a1bSJed Brown    test:
1007c4762a1bSJed Brown       suffix: superlu_dist_2
1008c4762a1bSJed Brown       nsize: 2
1009c4762a1bSJed Brown       requires: superlu_dist
1010c4762a1bSJed Brown       args: -da_grid_x 20 -da_grid_y 20 -pc_type lu -pc_factor_mat_solver_type superlu_dist
1011c4762a1bSJed Brown       output_file: output/ex19_superlu.out
1012c4762a1bSJed Brown 
1013c4762a1bSJed Brown    test:
10143e558968SBarry Smith       suffix: superlu_dist_3d
10153e558968SBarry Smith       nsize: 4
10163e558968SBarry Smith       requires: superlu_dist !defined(PETSCTEST_VALGRIND)
10173e558968SBarry Smith       filter: grep -v iam | grep -v openMP
10183e558968SBarry Smith       args: -da_grid_x 20 -da_grid_y 20 -pc_type lu -pc_factor_mat_solver_type superlu_dist -mat_superlu_dist_3d -mat_superlu_dist_d 2 -snes_view -snes_monitor -ksp_monitor
10193e558968SBarry Smith 
10203e558968SBarry Smith    test:
1021c4762a1bSJed Brown       suffix: superlu_equil
1022c4762a1bSJed Brown       requires: superlu
1023c4762a1bSJed Brown       args: -da_grid_x 20 -da_grid_y 20 -{snes,ksp}_monitor_short -pc_type lu -pc_factor_mat_solver_type superlu -mat_superlu_equil
1024c4762a1bSJed Brown 
1025c4762a1bSJed Brown    test:
1026c4762a1bSJed Brown       suffix: superlu_equil_sell
1027c4762a1bSJed Brown       requires: superlu
1028c4762a1bSJed Brown       args: -da_grid_x 20 -da_grid_y 20 -{snes,ksp}_monitor_short -pc_type lu -pc_factor_mat_solver_type superlu -mat_superlu_equil -dm_mat_type sell -pc_factor_mat_ordering_type natural
1029c4762a1bSJed Brown       output_file: output/ex19_superlu_equil.out
1030c4762a1bSJed Brown 
1031c4762a1bSJed Brown    test:
1032c4762a1bSJed Brown       suffix: tcqmr
1033c4762a1bSJed Brown       args: -da_refine 1 -ksp_monitor_short -ksp_type tcqmr
1034c4762a1bSJed Brown       requires: !single
1035c4762a1bSJed Brown 
1036c4762a1bSJed Brown    test:
1037c4762a1bSJed Brown       suffix: tfqmr
1038c4762a1bSJed Brown       args: -da_refine 1 -ksp_monitor_short -ksp_type tfqmr
1039c4762a1bSJed Brown       requires: !single
1040c4762a1bSJed Brown 
1041c4762a1bSJed Brown    test:
1042c4762a1bSJed Brown       suffix: umfpack
1043c4762a1bSJed Brown       requires: suitesparse
10442c7c0729SBarry Smith       args: -da_refine 2 -pc_type lu -pc_factor_mat_solver_type umfpack -snes_view -snes_monitor_short -ksp_monitor_short -pc_factor_mat_ordering_type external
1045c4762a1bSJed Brown 
1046c4762a1bSJed Brown    test:
1047c4762a1bSJed Brown       suffix: tut_1
1048c4762a1bSJed Brown       nsize: 4
1049c4762a1bSJed Brown       requires: !single
1050c4762a1bSJed Brown       args: -da_refine 5 -snes_monitor -ksp_monitor -snes_view
1051c4762a1bSJed Brown 
1052c4762a1bSJed Brown    test:
1053c4762a1bSJed Brown       suffix: tut_2
1054c4762a1bSJed Brown       nsize: 4
1055c4762a1bSJed Brown       requires: !single
1056c4762a1bSJed Brown       args: -da_refine 5 -snes_monitor -ksp_monitor -snes_view -pc_type mg
1057c4762a1bSJed Brown 
1058c4762a1bSJed Brown    # HYPRE PtAP broken with complex numbers
1059c4762a1bSJed Brown    test:
1060c4762a1bSJed Brown       suffix: tut_3
1061c4762a1bSJed Brown       nsize: 4
1062263f2b91SStefano Zampini       requires: hypre !single !complex !defined(PETSC_HAVE_HYPRE_DEVICE)
1063c4762a1bSJed Brown       args: -da_refine 5 -snes_monitor -ksp_monitor -snes_view -pc_type hypre
1064c4762a1bSJed Brown 
1065c4762a1bSJed Brown    test:
1066c4762a1bSJed Brown       suffix: tut_8
1067c4762a1bSJed Brown       nsize: 4
1068c4762a1bSJed Brown       requires: ml !single
1069c4762a1bSJed Brown       args: -da_refine 5 -snes_monitor -ksp_monitor -snes_view -pc_type ml
1070c4762a1bSJed Brown 
1071c4762a1bSJed Brown    test:
1072c4762a1bSJed Brown       suffix: tut_4
1073c4762a1bSJed Brown       nsize: 1
1074c4762a1bSJed Brown       requires: !single
1075c4762a1bSJed Brown       args: -da_refine 5 -log_view
1076c4762a1bSJed Brown       filter: head -n 2
1077c4762a1bSJed Brown       filter_output: head -n 2
1078c4762a1bSJed Brown 
1079c4762a1bSJed Brown    test:
1080c4762a1bSJed Brown       suffix: tut_5
1081c4762a1bSJed Brown       nsize: 1
1082c4762a1bSJed Brown       requires: !single
1083c4762a1bSJed Brown       args: -da_refine 5 -log_view -pc_type mg
1084c4762a1bSJed Brown       filter: head -n 2
1085c4762a1bSJed Brown       filter_output: head -n 2
1086c4762a1bSJed Brown 
1087c4762a1bSJed Brown    test:
1088c4762a1bSJed Brown       suffix: tut_6
1089c4762a1bSJed Brown       nsize: 4
1090c4762a1bSJed Brown       requires: !single
1091c4762a1bSJed Brown       args: -da_refine 5 -log_view
1092c4762a1bSJed Brown       filter: head -n 2
1093c4762a1bSJed Brown       filter_output: head -n 2
1094c4762a1bSJed Brown 
1095c4762a1bSJed Brown    test:
1096c4762a1bSJed Brown       suffix: tut_7
1097c4762a1bSJed Brown       nsize: 4
1098c4762a1bSJed Brown       requires: !single
1099c4762a1bSJed Brown       args: -da_refine 5 -log_view -pc_type mg
1100c4762a1bSJed Brown       filter: head -n 2
1101c4762a1bSJed Brown       filter_output: head -n 2
1102c4762a1bSJed Brown 
1103c4762a1bSJed Brown    test:
1104c4762a1bSJed Brown       suffix: cuda_1
1105c4762a1bSJed Brown       nsize: 1
1106c4762a1bSJed Brown       requires: cuda
110773f7197eSJed Brown       args: -snes_monitor -dm_mat_type seqaijcusparse -dm_vec_type seqcuda -pc_type gamg -pc_gamg_esteig_ksp_max_it 10 -ksp_monitor -mg_levels_ksp_max_it 3
1108c4762a1bSJed Brown 
1109c4762a1bSJed Brown    test:
1110c4762a1bSJed Brown       suffix: cuda_2
1111c4762a1bSJed Brown       nsize: 3
1112c4762a1bSJed Brown       requires: cuda !single
111373f7197eSJed Brown       args: -snes_monitor -dm_mat_type mpiaijcusparse -dm_vec_type mpicuda -pc_type gamg -pc_gamg_esteig_ksp_max_it 10 -ksp_monitor  -mg_levels_ksp_max_it 3
1114c4762a1bSJed Brown 
1115c4762a1bSJed Brown    test:
1116d38ac8baSRichard Tran Mills       suffix: cuda_dm_bind_below
1117d38ac8baSRichard Tran Mills       nsize: 2
1118d38ac8baSRichard Tran Mills       requires: cuda
1119d38ac8baSRichard Tran Mills       args: -dm_mat_type aijcusparse -dm_vec_type cuda -da_refine 3 -pc_type mg -mg_levels_ksp_type chebyshev -mg_levels_pc_type jacobi -log_view -pc_mg_log -dm_bind_below 10000
112017fc1e00SRichard Tran Mills       filter: awk "/Level/ {print \$NF}"
1121d38ac8baSRichard Tran Mills 
1122d38ac8baSRichard Tran Mills    test:
1123d38ac8baSRichard Tran Mills       suffix: viennacl_dm_bind_below
1124d38ac8baSRichard Tran Mills       nsize: 2
1125d38ac8baSRichard Tran Mills       requires: viennacl
1126d38ac8baSRichard Tran Mills       args: -dm_mat_type aijviennacl -dm_vec_type viennacl -da_refine 3 -pc_type mg -mg_levels_ksp_type chebyshev -mg_levels_pc_type jacobi -log_view -pc_mg_log -dm_bind_below 10000
112717fc1e00SRichard Tran Mills       filter: awk "/Level/ {print \$NF}"
1128d38ac8baSRichard Tran Mills 
1129d38ac8baSRichard Tran Mills    test:
1130c4762a1bSJed Brown       suffix: seqbaijmkl
1131c4762a1bSJed Brown       nsize: 1
1132dfd57a17SPierre Jolivet       requires: defined(PETSC_HAVE_MKL_SPARSE_OPTIMIZE)
1133c4762a1bSJed Brown       args: -dm_mat_type baij -snes_monitor -ksp_monitor -snes_view
1134c4762a1bSJed Brown 
1135c4762a1bSJed Brown    test:
1136c4762a1bSJed Brown       suffix: mpibaijmkl
1137c4762a1bSJed Brown       nsize: 2
1138dfd57a17SPierre Jolivet       requires:  defined(PETSC_HAVE_MKL_SPARSE_OPTIMIZE)
1139c4762a1bSJed Brown       args: -dm_mat_type baij -snes_monitor -ksp_monitor -snes_view
1140c4762a1bSJed Brown 
1141c4762a1bSJed Brown    test:
1142c4762a1bSJed Brown      suffix: cpardiso
1143c4762a1bSJed Brown      nsize: 4
1144c4762a1bSJed Brown      requires: mkl_cpardiso
1145c4762a1bSJed Brown      args: -pc_type lu -pc_factor_mat_solver_type mkl_cpardiso -ksp_monitor
1146c4762a1bSJed Brown 
1147c4762a1bSJed Brown    test:
1148c4762a1bSJed Brown      suffix: logviewmemory
1149dfd57a17SPierre Jolivet      requires: defined(PETSC_USE_LOG) !defined(PETSCTEST_VALGRIND)
1150c4762a1bSJed Brown      args: -log_view -log_view_memory -da_refine 4
1151c4762a1bSJed Brown      filter: grep MatFDColorSetUp | wc -w | xargs  -I % sh -c "expr % \> 21"
1152c4762a1bSJed Brown 
1153534f0846SBarry Smith    test:
1154534f0846SBarry Smith      suffix: fs
1155534f0846SBarry Smith      args: -pc_type fieldsplit -da_refine 3  -all_ksp_monitor -fieldsplit_y_velocity_pc_type lu  -fieldsplit_temperature_pc_type lu -fieldsplit_x_velocity_pc_type lu  -snes_view
1156534f0846SBarry Smith 
115771f558e3SSatish Balay    test:
1158a8e42557SLawrence Mitchell      suffix: asm_matconvert
1159a8e42557SLawrence Mitchell      args: -mat_type aij -pc_type asm -pc_asm_sub_mat_type dense -snes_view
1160a8e42557SLawrence Mitchell 
11618bf83915SBarry Smith    test:
11628bf83915SBarry Smith       suffix: euclid
11638bf83915SBarry Smith       nsize: 2
1164263f2b91SStefano Zampini       requires: hypre !single !complex !defined(PETSC_HAVE_HYPRE_MIXEDINT) !defined(PETSC_HAVE_HYPRE_DEVICE)
11658bf83915SBarry Smith       args: -da_refine 2 -ksp_monitor -snes_monitor -snes_view -pc_type hypre -pc_hypre_type euclid
11668bf83915SBarry Smith 
11678bf83915SBarry Smith    test:
11688bf83915SBarry Smith       suffix: euclid_bj
11698bf83915SBarry Smith       nsize: 2
1170263f2b91SStefano Zampini       requires: hypre !single !complex !defined(PETSC_HAVE_HYPRE_MIXEDINT) !defined(PETSC_HAVE_HYPRE_DEVICE)
11718bf83915SBarry Smith       args: -da_refine 2 -ksp_monitor -snes_monitor -snes_view -pc_type hypre -pc_hypre_type euclid -pc_hypre_euclid_bj
11728bf83915SBarry Smith 
11738bf83915SBarry Smith    test:
11748bf83915SBarry Smith       suffix: euclid_droptolerance
11758bf83915SBarry Smith       nsize: 1
1176263f2b91SStefano Zampini       requires: hypre !single !complex !defined(PETSC_HAVE_HYPRE_MIXEDINT) !defined(PETSC_HAVE_HYPRE_DEVICE)
11778bf83915SBarry Smith       args: -da_refine 2 -ksp_monitor -snes_monitor -snes_view -pc_type hypre -pc_hypre_type euclid -pc_hypre_euclid_droptolerance .1
11788bf83915SBarry Smith 
1179660278c0SBarry Smith    test:
1180660278c0SBarry Smith       suffix: failure_size
1181660278c0SBarry Smith       nsize: 1
1182660278c0SBarry Smith       requires: !defined(PETSC_USE_64BIT_INDICES) !defined(PETSCTEST_VALGRIND)
1183660278c0SBarry Smith       args: -da_refine 100 -petsc_ci_portable_error_output -error_output_stdout
118436f0be53SJacob Faibussowitsch       filter: egrep -v "(options_left|memory block|leaked context|not freed before MPI_Finalize|Could be the program crashed)"
1185660278c0SBarry Smith 
1186c4762a1bSJed Brown TEST*/
1187