xref: /petsc/src/snes/tutorials/ex59.c (revision 9371c9d470a9602b6d10a8bf50c9b2280a79e45a)
1 
2 static const char help[] = "Tries to solve u`` + u^{2} = f for an easy case and an impossible case.\n\n";
3 
4 /*
5        This example was contributed by Peter Graf to show how SNES fails when given a nonlinear problem with no solution.
6 
7        Run with -n 14 to see fail to converge and -n 15 to see convergence
8 
9        The option -second_order uses a different discretization of the Neumann boundary condition and always converges
10 
11 */
12 
13 #include <petscsnes.h>
14 
15 PetscBool second_order = PETSC_FALSE;
16 #define X0DOT -2.0
17 #define X1    5.0
18 #define KPOW  2.0
19 const PetscScalar sperturb = 1.1;
20 
21 /*
22    User-defined routines
23 */
24 PetscErrorCode FormJacobian(SNES, Vec, Mat, Mat, void *);
25 PetscErrorCode FormFunction(SNES, Vec, Vec, void *);
26 
27 int main(int argc, char **argv) {
28   SNES              snes;    /* SNES context */
29   Vec               x, r, F; /* vectors */
30   Mat               J;       /* Jacobian */
31   PetscInt          it, n = 11, i;
32   PetscReal         h, xp = 0.0;
33   PetscScalar       v;
34   const PetscScalar a = X0DOT;
35   const PetscScalar b = X1;
36   const PetscScalar k = KPOW;
37   PetscScalar       v2;
38   PetscScalar      *xx;
39 
40   PetscFunctionBeginUser;
41   PetscCall(PetscInitialize(&argc, &argv, (char *)0, help));
42   PetscCall(PetscOptionsGetInt(NULL, NULL, "-n", &n, NULL));
43   PetscCall(PetscOptionsGetBool(NULL, NULL, "-second_order", &second_order, NULL));
44   h = 1.0 / (n - 1);
45 
46   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
47      Create nonlinear solver context
48      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
49 
50   PetscCall(SNESCreate(PETSC_COMM_WORLD, &snes));
51 
52   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
53      Create vector data structures; set function evaluation routine
54      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
55 
56   PetscCall(VecCreate(PETSC_COMM_SELF, &x));
57   PetscCall(VecSetSizes(x, PETSC_DECIDE, n));
58   PetscCall(VecSetFromOptions(x));
59   PetscCall(VecDuplicate(x, &r));
60   PetscCall(VecDuplicate(x, &F));
61 
62   PetscCall(SNESSetFunction(snes, r, FormFunction, (void *)F));
63 
64   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
65      Create matrix data structures; set Jacobian evaluation routine
66      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
67 
68   PetscCall(MatCreateSeqAIJ(PETSC_COMM_SELF, n, n, 3, NULL, &J));
69 
70   /*
71      Note that in this case we create separate matrices for the Jacobian
72      and preconditioner matrix.  Both of these are computed in the
73      routine FormJacobian()
74   */
75   /*  PetscCall(SNESSetJacobian(snes,NULL,JPrec,FormJacobian,0)); */
76   PetscCall(SNESSetJacobian(snes, J, J, FormJacobian, 0));
77   /*  PetscCall(SNESSetJacobian(snes,J,JPrec,FormJacobian,0)); */
78 
79   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
80      Customize nonlinear solver; set runtime options
81    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
82 
83   PetscCall(SNESSetFromOptions(snes));
84 
85   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
86      Initialize application:
87      Store right-hand-side of PDE and exact solution
88    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
89 
90   /* set right hand side and initial guess to be exact solution of continuim problem */
91 #define SQR(x) ((x) * (x))
92   xp = 0.0;
93   for (i = 0; i < n; i++) {
94     v = k * (k - 1.) * (b - a) * PetscPowScalar(xp, k - 2.) + SQR(a * xp) + SQR(b - a) * PetscPowScalar(xp, 2. * k) + 2. * a * (b - a) * PetscPowScalar(xp, k + 1.);
95     PetscCall(VecSetValues(F, 1, &i, &v, INSERT_VALUES));
96     v2 = a * xp + (b - a) * PetscPowScalar(xp, k);
97     PetscCall(VecSetValues(x, 1, &i, &v2, INSERT_VALUES));
98     xp += h;
99   }
100 
101   /* perturb initial guess */
102   PetscCall(VecGetArray(x, &xx));
103   for (i = 0; i < n; i++) {
104     v2 = xx[i] * sperturb;
105     PetscCall(VecSetValues(x, 1, &i, &v2, INSERT_VALUES));
106   }
107   PetscCall(VecRestoreArray(x, &xx));
108 
109   PetscCall(SNESSolve(snes, NULL, x));
110   PetscCall(SNESGetIterationNumber(snes, &it));
111   PetscCall(PetscPrintf(PETSC_COMM_SELF, "SNES iterations = %" PetscInt_FMT "\n\n", it));
112 
113   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
114      Free work space.  All PETSc objects should be destroyed when they
115      are no longer needed.
116    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
117 
118   PetscCall(VecDestroy(&x));
119   PetscCall(VecDestroy(&r));
120   PetscCall(VecDestroy(&F));
121   PetscCall(MatDestroy(&J));
122   PetscCall(SNESDestroy(&snes));
123   PetscCall(PetscFinalize());
124   return 0;
125 }
126 
127 PetscErrorCode FormFunction(SNES snes, Vec x, Vec f, void *dummy) {
128   const PetscScalar *xx;
129   PetscScalar       *ff, *FF, d, d2;
130   PetscInt           i, n;
131 
132   PetscCall(VecGetArrayRead(x, &xx));
133   PetscCall(VecGetArray(f, &ff));
134   PetscCall(VecGetArray((Vec)dummy, &FF));
135   PetscCall(VecGetSize(x, &n));
136   d  = (PetscReal)(n - 1);
137   d2 = d * d;
138 
139   if (second_order) ff[0] = d * (0.5 * d * (-xx[2] + 4. * xx[1] - 3. * xx[0]) - X0DOT);
140   else ff[0] = d * (d * (xx[1] - xx[0]) - X0DOT);
141 
142   for (i = 1; i < n - 1; i++) ff[i] = d2 * (xx[i - 1] - 2. * xx[i] + xx[i + 1]) + xx[i] * xx[i] - FF[i];
143 
144   ff[n - 1] = d * d * (xx[n - 1] - X1);
145   PetscCall(VecRestoreArrayRead(x, &xx));
146   PetscCall(VecRestoreArray(f, &ff));
147   PetscCall(VecRestoreArray((Vec)dummy, &FF));
148   return 0;
149 }
150 
151 PetscErrorCode FormJacobian(SNES snes, Vec x, Mat jac, Mat prejac, void *dummy) {
152   const PetscScalar *xx;
153   PetscScalar        A[3], d, d2;
154   PetscInt           i, n, j[3];
155 
156   PetscCall(VecGetSize(x, &n));
157   PetscCall(VecGetArrayRead(x, &xx));
158   d  = (PetscReal)(n - 1);
159   d2 = d * d;
160 
161   i = 0;
162   if (second_order) {
163     j[0] = 0;
164     j[1] = 1;
165     j[2] = 2;
166     A[0] = -3. * d * d * 0.5;
167     A[1] = 4. * d * d * 0.5;
168     A[2] = -1. * d * d * 0.5;
169     PetscCall(MatSetValues(prejac, 1, &i, 3, j, A, INSERT_VALUES));
170   } else {
171     j[0] = 0;
172     j[1] = 1;
173     A[0] = -d * d;
174     A[1] = d * d;
175     PetscCall(MatSetValues(prejac, 1, &i, 2, j, A, INSERT_VALUES));
176   }
177   for (i = 1; i < n - 1; i++) {
178     j[0] = i - 1;
179     j[1] = i;
180     j[2] = i + 1;
181     A[0] = d2;
182     A[1] = -2. * d2 + 2. * xx[i];
183     A[2] = d2;
184     PetscCall(MatSetValues(prejac, 1, &i, 3, j, A, INSERT_VALUES));
185   }
186 
187   i    = n - 1;
188   A[0] = d * d;
189   PetscCall(MatSetValues(prejac, 1, &i, 1, &i, &A[0], INSERT_VALUES));
190 
191   PetscCall(MatAssemblyBegin(jac, MAT_FINAL_ASSEMBLY));
192   PetscCall(MatAssemblyEnd(jac, MAT_FINAL_ASSEMBLY));
193   PetscCall(MatAssemblyBegin(prejac, MAT_FINAL_ASSEMBLY));
194   PetscCall(MatAssemblyEnd(prejac, MAT_FINAL_ASSEMBLY));
195 
196   PetscCall(VecRestoreArrayRead(x, &xx));
197   return 0;
198 }
199 
200 /*TEST
201 
202    test:
203       args: -n 14 -snes_monitor_short -snes_converged_reason
204       requires: !single
205 
206    test:
207       suffix: 2
208       args: -n 15 -snes_monitor_short -snes_converged_reason
209       requires: !single
210 
211    test:
212       suffix: 3
213       args: -n 14 -second_order -snes_monitor_short -snes_converged_reason
214       requires: !single
215 
216 TEST*/
217