xref: /petsc/src/snes/impls/nasm/nasm.c (revision 8dc331a1884e7d9f3e74ba293e4b2ea0b4ee67ee)
1 #include <petsc-private/snesimpl.h>             /*I   "petscsnes.h"   I*/
2 #include <petscdm.h>
3 
4 typedef struct {
5   PetscInt   n;                   /* local subdomains */
6   SNES       *subsnes;            /* nonlinear solvers for each subdomain */
7   Vec        *x;                  /* solution vectors */
8   Vec        *xl;                 /* solution local vectors */
9   Vec        *y;                  /* step vectors */
10   Vec        *b;                  /* rhs vectors */
11   VecScatter *oscatter;           /* scatter from global space to the subdomain global space */
12   VecScatter *iscatter;           /* scatter from global space to the nonoverlapping subdomain space */
13   VecScatter *gscatter;           /* scatter from global space to the subdomain local space */
14   PCASMType  type;                /* ASM type */
15   PetscBool  usesdm;              /* use the DM for setting up the subproblems */
16   PetscBool  finaljacobian;       /* compute the jacobian of the converged solution */
17 
18   /* logging events */
19   PetscLogEvent eventrestrictinterp;
20   PetscLogEvent eventsubsolve;
21 } SNES_NASM;
22 
23 const char *const SNESNASMTypes[] = {"NONE","RESTRICT","INTERPOLATE","BASIC","PCASMType","PC_ASM_",0};
24 
25 #undef __FUNCT__
26 #define __FUNCT__ "SNESReset_NASM"
27 PetscErrorCode SNESReset_NASM(SNES snes)
28 {
29   SNES_NASM      *nasm = (SNES_NASM*)snes->data;
30   PetscErrorCode ierr;
31   PetscInt       i;
32 
33   PetscFunctionBegin;
34   for (i=0; i<nasm->n; i++) {
35     if (nasm->xl) { ierr = VecDestroy(&nasm->xl[i]);CHKERRQ(ierr); }
36     if (nasm->x) { ierr = VecDestroy(&nasm->x[i]);CHKERRQ(ierr); }
37     if (nasm->y) { ierr = VecDestroy(&nasm->y[i]);CHKERRQ(ierr); }
38     if (nasm->b) { ierr = VecDestroy(&nasm->b[i]);CHKERRQ(ierr); }
39 
40     if (nasm->subsnes) { ierr = SNESDestroy(&nasm->subsnes[i]);CHKERRQ(ierr); }
41     if (nasm->oscatter) { ierr = VecScatterDestroy(&nasm->oscatter[i]);CHKERRQ(ierr); }
42     if (nasm->iscatter) { ierr = VecScatterDestroy(&nasm->iscatter[i]);CHKERRQ(ierr); }
43     if (nasm->gscatter) { ierr = VecScatterDestroy(&nasm->gscatter[i]);CHKERRQ(ierr); }
44   }
45 
46   if (nasm->x) {ierr = PetscFree(nasm->x);CHKERRQ(ierr);}
47   if (nasm->xl) {ierr = PetscFree(nasm->xl);CHKERRQ(ierr);}
48   if (nasm->y) {ierr = PetscFree(nasm->y);CHKERRQ(ierr);}
49   if (nasm->b) {ierr = PetscFree(nasm->b);CHKERRQ(ierr);}
50 
51   if (nasm->subsnes) {ierr = PetscFree(nasm->subsnes);CHKERRQ(ierr);}
52   if (nasm->oscatter) {ierr = PetscFree(nasm->oscatter);CHKERRQ(ierr);}
53   if (nasm->iscatter) {ierr = PetscFree(nasm->iscatter);CHKERRQ(ierr);}
54   if (nasm->gscatter) {ierr = PetscFree(nasm->gscatter);CHKERRQ(ierr);}
55 
56   nasm->eventrestrictinterp = 0;
57   nasm->eventsubsolve = 0;
58   PetscFunctionReturn(0);
59 }
60 
61 #undef __FUNCT__
62 #define __FUNCT__ "SNESDestroy_NASM"
63 PetscErrorCode SNESDestroy_NASM(SNES snes)
64 {
65   PetscErrorCode ierr;
66 
67   PetscFunctionBegin;
68   ierr = SNESReset_NASM(snes);CHKERRQ(ierr);
69   ierr = PetscFree(snes->data);CHKERRQ(ierr);
70   PetscFunctionReturn(0);
71 }
72 
73 #undef __FUNCT__
74 #define __FUNCT__ "DMGlobalToLocalSubDomainDirichletHook_Private"
75 PetscErrorCode DMGlobalToLocalSubDomainDirichletHook_Private(DM dm,Vec g,InsertMode mode,Vec l,void *ctx)
76 {
77   PetscErrorCode ierr;
78   Vec            bcs = (Vec)ctx;
79 
80   PetscFunctionBegin;
81   ierr = VecCopy(bcs,l);CHKERRQ(ierr);
82   PetscFunctionReturn(0);
83 }
84 
85 #undef __FUNCT__
86 #define __FUNCT__ "SNESSetUp_NASM"
87 PetscErrorCode SNESSetUp_NASM(SNES snes)
88 {
89   SNES_NASM      *nasm = (SNES_NASM*)snes->data;
90   PetscErrorCode ierr;
91   DM             dm,subdm;
92   DM             *subdms;
93   PetscInt       i;
94   const char     *optionsprefix;
95   Vec            F;
96   PetscMPIInt    size;
97   KSP            ksp;
98   PC             pc;
99 
100   PetscFunctionBegin;
101   if (!nasm->subsnes) {
102     ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
103     if (dm) {
104       nasm->usesdm = PETSC_TRUE;
105       ierr         = DMCreateDomainDecomposition(dm,&nasm->n,NULL,NULL,NULL,&subdms);CHKERRQ(ierr);
106       if (!subdms) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE,"DM has no default decomposition defined.  Set subsolves manually with SNESNASMSetSubdomains().");
107       ierr = DMCreateDomainDecompositionScatters(dm,nasm->n,subdms,&nasm->iscatter,&nasm->oscatter,&nasm->gscatter);CHKERRQ(ierr);
108 
109       ierr = SNESGetOptionsPrefix(snes, &optionsprefix);CHKERRQ(ierr);
110       ierr = PetscMalloc(nasm->n*sizeof(SNES),&nasm->subsnes);CHKERRQ(ierr);
111       for (i=0; i<nasm->n; i++) {
112         ierr = SNESCreate(PETSC_COMM_SELF,&nasm->subsnes[i]);CHKERRQ(ierr);
113         ierr = SNESAppendOptionsPrefix(nasm->subsnes[i],optionsprefix);CHKERRQ(ierr);
114         ierr = SNESAppendOptionsPrefix(nasm->subsnes[i],"sub_");CHKERRQ(ierr);
115         ierr = SNESSetDM(nasm->subsnes[i],subdms[i]);CHKERRQ(ierr);
116         ierr = MPI_Comm_size(PetscObjectComm((PetscObject)nasm->subsnes[i]),&size);CHKERRQ(ierr);
117         if (size == 1) {
118           ierr = SNESGetKSP(nasm->subsnes[i],&ksp);CHKERRQ(ierr);
119           ierr = KSPGetPC(ksp,&pc);CHKERRQ(ierr);
120           ierr = KSPSetType(ksp,KSPPREONLY);CHKERRQ(ierr);
121           ierr = PCSetType(pc,PCLU);CHKERRQ(ierr);
122         }
123         ierr = SNESSetFromOptions(nasm->subsnes[i]);CHKERRQ(ierr);
124         ierr = DMDestroy(&subdms[i]);CHKERRQ(ierr);
125       }
126       ierr = PetscFree(subdms);CHKERRQ(ierr);
127     } else SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_WRONGSTATE,"Cannot construct local problems automatically without a DM!");
128   } else SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_WRONGSTATE,"Must set subproblems manually if there is no DM!");
129   /* allocate the global vectors */
130   if (!nasm->x) {
131     ierr = PetscMalloc(nasm->n*sizeof(Vec),&nasm->x);CHKERRQ(ierr);
132     ierr = PetscMemzero(nasm->x,nasm->n*sizeof(Vec));CHKERRQ(ierr);
133   }
134   if (!nasm->xl) {
135     ierr = PetscMalloc(nasm->n*sizeof(Vec),&nasm->xl);CHKERRQ(ierr);
136     ierr = PetscMemzero(nasm->xl,nasm->n*sizeof(Vec));CHKERRQ(ierr);
137   }
138   if (!nasm->y) {
139     ierr = PetscMalloc(nasm->n*sizeof(Vec),&nasm->y);CHKERRQ(ierr);
140     ierr = PetscMemzero(nasm->y,nasm->n*sizeof(Vec));CHKERRQ(ierr);
141   }
142   if (!nasm->b) {
143     ierr = PetscMalloc(nasm->n*sizeof(Vec),&nasm->b);CHKERRQ(ierr);
144     ierr = PetscMemzero(nasm->b,nasm->n*sizeof(Vec));CHKERRQ(ierr);
145   }
146 
147   for (i=0; i<nasm->n; i++) {
148     ierr = SNESGetFunction(nasm->subsnes[i],&F,NULL,NULL);CHKERRQ(ierr);
149     if (!nasm->x[i]) {ierr = VecDuplicate(F,&nasm->x[i]);CHKERRQ(ierr);}
150     if (!nasm->y[i]) {ierr = VecDuplicate(F,&nasm->y[i]);CHKERRQ(ierr);}
151     if (!nasm->b[i]) {ierr = VecDuplicate(F,&nasm->b[i]);CHKERRQ(ierr);}
152     if (!nasm->xl[i]) {
153       ierr = SNESGetDM(nasm->subsnes[i],&subdm);CHKERRQ(ierr);
154       ierr = DMCreateLocalVector(subdm,&nasm->xl[i]);CHKERRQ(ierr);
155     }
156     ierr = DMGlobalToLocalHookAdd(subdm,DMGlobalToLocalSubDomainDirichletHook_Private,NULL,nasm->xl[i]);CHKERRQ(ierr);
157   }
158   if (nasm->finaljacobian) {ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);}
159   PetscFunctionReturn(0);
160 }
161 
162 #undef __FUNCT__
163 #define __FUNCT__ "SNESSetFromOptions_NASM"
164 PetscErrorCode SNESSetFromOptions_NASM(SNES snes)
165 {
166   PetscErrorCode    ierr;
167   PCASMType         asmtype;
168   PetscBool         flg,monflg;
169   SNES_NASM         *nasm = (SNES_NASM*)snes->data;
170 
171   PetscFunctionBegin;
172   ierr = PetscOptionsHead("Nonlinear Additive Schwartz options");CHKERRQ(ierr);
173   ierr = PetscOptionsEnum("-snes_nasm_type","Type of restriction/extension","",SNESNASMTypes,(PetscEnum)nasm->type,(PetscEnum*)&asmtype,&flg);CHKERRQ(ierr);
174   if (flg) nasm->type = asmtype;
175   flg    = PETSC_FALSE;
176   monflg = PETSC_TRUE;
177   ierr   = PetscOptionsBool("-snes_nasm_log","Log times for subSNES solves and restriction","",monflg,&monflg,&flg);CHKERRQ(ierr);
178   ierr   = PetscOptionsBool("-snes_nasm_finaljacobian","Compute the global jacobian of the final iterate (for ASPIN)","",nasm->finaljacobian,&nasm->finaljacobian,NULL);CHKERRQ(ierr);
179   if (flg) {
180     ierr = PetscLogEventRegister("SNESNASMSubSolve",((PetscObject)snes)->classid,&nasm->eventsubsolve);CHKERRQ(ierr);
181     ierr = PetscLogEventRegister("SNESNASMRestrict",((PetscObject)snes)->classid,&nasm->eventrestrictinterp);CHKERRQ(ierr);
182   }
183   ierr = PetscOptionsTail();CHKERRQ(ierr);
184   PetscFunctionReturn(0);
185 }
186 
187 #undef __FUNCT__
188 #define __FUNCT__ "SNESView_NASM"
189 PetscErrorCode SNESView_NASM(SNES snes, PetscViewer viewer)
190 {
191   SNES_NASM      *nasm = (SNES_NASM*)snes->data;
192   PetscErrorCode ierr;
193   PetscMPIInt    rank;
194   PetscInt       i,N;
195   PetscBool      iascii,isstring;
196   PetscViewer    sviewer;
197   MPI_Comm       comm;
198 
199   PetscFunctionBegin;
200   ierr = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr);
201   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
202   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
203   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
204   ierr = MPI_Reduce(&nasm->n,&N,1,MPIU_INT,MPIU_SUM,0,comm);CHKERRQ(ierr);
205   if (iascii) {
206     ierr = PetscViewerASCIIPrintf(viewer, "  Nonlinear Additive Schwarz: total subdomain blocks = %D\n",N);CHKERRQ(ierr);
207     ierr = PetscViewerASCIIPrintf(viewer,"  Nonlinear Additive Schwarz: restriction/interpolation type - %s\n",SNESNASMTypes[nasm->type]);CHKERRQ(ierr);
208     ierr = PetscViewerASCIIPrintf(viewer,"  Nonlinear Additive Schwarz: subSNES iterations: %D subKSP iterations: %D\n",SNESNASMTypes[nasm->type]);CHKERRQ(ierr);
209     ierr = PetscViewerASCIISynchronizedAllow(viewer,PETSC_TRUE);CHKERRQ(ierr);
210     ierr = PetscViewerASCIISynchronizedPrintf(viewer,"  [%d] number of local blocks = %D\n",(int)rank,nasm->n);CHKERRQ(ierr);
211     ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
212     ierr = PetscViewerASCIIPrintf(viewer,"  Local SNES objects:\n");CHKERRQ(ierr);
213     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
214     if (!rank) {
215       for (i=0; i<nasm->n; i++) {
216         ierr = PetscViewerGetSingleton(viewer,&sviewer);CHKERRQ(ierr);
217         ierr = SNESView(nasm->subsnes[i],sviewer);CHKERRQ(ierr);
218         ierr = PetscViewerRestoreSingleton(viewer,&sviewer);CHKERRQ(ierr);
219       }
220     }
221     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
222     ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
223     ierr = PetscViewerASCIISynchronizedAllow(viewer,PETSC_FALSE);CHKERRQ(ierr);
224   } else if (isstring) {
225     ierr = PetscViewerStringSPrintf(viewer," blocks=%D,type=%s",N,SNESNASMTypes[nasm->type]);CHKERRQ(ierr);
226     ierr = PetscViewerGetSingleton(viewer,&sviewer);CHKERRQ(ierr);
227     if (nasm->subsnes && !rank) {ierr = SNESView(nasm->subsnes[0],sviewer);CHKERRQ(ierr);}
228     ierr = PetscViewerRestoreSingleton(viewer,&sviewer);CHKERRQ(ierr);
229   }
230   PetscFunctionReturn(0);
231 }
232 
233 #undef __FUNCT__
234 #define __FUNCT__ "SNESNASMSetSubdomains"
235 /*@
236    SNESNASMSetSubdomains - Manually Set the context required to restrict and solve subdomain problems.
237 
238    Not Collective
239 
240    Input Parameters:
241 +  SNES - the SNES context
242 .  n - the number of local subdomains
243 .  subsnes - solvers defined on the local subdomains
244 .  iscatter - scatters into the nonoverlapping portions of the local subdomains
245 .  oscatter - scatters into the overlapping portions of the local subdomains
246 -  gscatter - scatters into the (ghosted) local vector of the local subdomain
247 
248    Level: intermediate
249 
250 .keywords: SNES, NASM
251 
252 .seealso: SNESNASM, SNESNASMGetSubdomains()
253 @*/
254 PetscErrorCode SNESNASMSetSubdomains(SNES snes,PetscInt n,SNES subsnes[],VecScatter iscatter[],VecScatter oscatter[],VecScatter gscatter[])
255 {
256   PetscErrorCode ierr;
257   PetscErrorCode (*f)(SNES,PetscInt,SNES*,VecScatter*,VecScatter*,VecScatter*);
258 
259   PetscFunctionBegin;
260   ierr = PetscObjectQueryFunction((PetscObject)snes,"SNESNASMSetSubdomains_C",&f);CHKERRQ(ierr);
261   ierr = (f)(snes,n,subsnes,iscatter,oscatter,gscatter);CHKERRQ(ierr);
262   PetscFunctionReturn(0);
263 }
264 
265 #undef __FUNCT__
266 #define __FUNCT__ "SNESNASMSetSubdomains_NASM"
267 PetscErrorCode SNESNASMSetSubdomains_NASM(SNES snes,PetscInt n,SNES subsnes[],VecScatter iscatter[],VecScatter oscatter[],VecScatter gscatter[])
268 {
269   PetscInt       i;
270   PetscErrorCode ierr;
271   SNES_NASM      *nasm = (SNES_NASM*)snes->data;
272 
273   PetscFunctionBegin;
274   if (snes->setupcalled) SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_WRONGSTATE,"SNESNASMSetSubdomains() should be called before calling SNESSetUp().");
275 
276   /* tear down the previously set things */
277   ierr = SNESReset(snes);CHKERRQ(ierr);
278 
279   nasm->n = n;
280   if (oscatter) {
281     for (i=0; i<n; i++) {ierr = PetscObjectReference((PetscObject)oscatter[i]);CHKERRQ(ierr);}
282   }
283   if (iscatter) {
284     for (i=0; i<n; i++) {ierr = PetscObjectReference((PetscObject)iscatter[i]);CHKERRQ(ierr);}
285   }
286   if (gscatter) {
287     for (i=0; i<n; i++) {ierr = PetscObjectReference((PetscObject)gscatter[i]);CHKERRQ(ierr);}
288   }
289   if (oscatter) {
290     ierr = PetscMalloc(n*sizeof(IS),&nasm->oscatter);CHKERRQ(ierr);
291     for (i=0; i<n; i++) {
292       nasm->oscatter[i] = oscatter[i];
293     }
294   }
295   if (iscatter) {
296     ierr = PetscMalloc(n*sizeof(IS),&nasm->iscatter);CHKERRQ(ierr);
297     for (i=0; i<n; i++) {
298       nasm->iscatter[i] = iscatter[i];
299     }
300   }
301   if (gscatter) {
302     ierr = PetscMalloc(n*sizeof(IS),&nasm->gscatter);CHKERRQ(ierr);
303     for (i=0; i<n; i++) {
304       nasm->gscatter[i] = gscatter[i];
305     }
306   }
307 
308   if (subsnes) {
309     ierr = PetscMalloc(n*sizeof(SNES),&nasm->subsnes);CHKERRQ(ierr);
310     for (i=0; i<n; i++) {
311       nasm->subsnes[i] = subsnes[i];
312     }
313   }
314   PetscFunctionReturn(0);
315 }
316 
317 #undef __FUNCT__
318 #define __FUNCT__ "SNESNASMGetSubdomains"
319 /*@
320    SNESNASMGetSubdomains - Get the local subdomain context.
321 
322    Not Collective
323 
324    Input Parameters:
325 .  SNES - the SNES context
326 
327    Output Parameters:
328 +  n - the number of local subdomains
329 .  subsnes - solvers defined on the local subdomains
330 .  iscatter - scatters into the nonoverlapping portions of the local subdomains
331 .  oscatter - scatters into the overlapping portions of the local subdomains
332 -  gscatter - scatters into the (ghosted) local vector of the local subdomain
333 
334    Level: intermediate
335 
336 .keywords: SNES, NASM
337 
338 .seealso: SNESNASM, SNESNASMSetSubdomains()
339 @*/
340 PetscErrorCode SNESNASMGetSubdomains(SNES snes,PetscInt *n,SNES *subsnes[],VecScatter *iscatter[],VecScatter *oscatter[],VecScatter *gscatter[])
341 {
342   PetscErrorCode ierr;
343   PetscErrorCode (*f)(SNES,PetscInt*,SNES**,VecScatter**,VecScatter**,VecScatter**);
344 
345   PetscFunctionBegin;
346   ierr = PetscObjectQueryFunction((PetscObject)snes,"SNESNASMGetSubdomains_C",&f);CHKERRQ(ierr);
347   ierr = (f)(snes,n,subsnes,iscatter,oscatter,gscatter);CHKERRQ(ierr);
348   PetscFunctionReturn(0);
349 }
350 
351 #undef __FUNCT__
352 #define __FUNCT__ "SNESNASMGetSubdomains_NASM"
353 PetscErrorCode SNESNASMGetSubdomains_NASM(SNES snes,PetscInt *n,SNES *subsnes[],VecScatter *iscatter[],VecScatter *oscatter[],VecScatter *gscatter[])
354 {
355   SNES_NASM      *nasm = (SNES_NASM*)snes->data;
356 
357   PetscFunctionBegin;
358   if (n) *n = nasm->n;
359   if (oscatter) *oscatter = nasm->oscatter;
360   if (iscatter) *iscatter = nasm->iscatter;
361   if (gscatter) *gscatter = nasm->gscatter;
362   if (subsnes)  *subsnes  = nasm->subsnes;
363   PetscFunctionReturn(0);
364 }
365 
366 #undef __FUNCT__
367 #define __FUNCT__ "SNESNASMGetSubdomainVecs"
368 /*@
369    SNESNASMGetSubdomainVecs - Get the processor-local subdomain vectors
370 
371    Not Collective
372 
373    Input Parameters:
374 .  SNES - the SNES context
375 
376    Output Parameters:
377 +  n - the number of local subdomains
378 .  x - The subdomain solution vector
379 .  y - The subdomain step vector
380 .  b - The subdomain RHS vector
381 -  xl - The subdomain local vectors (ghosted)
382 
383    Level: developer
384 
385 .keywords: SNES, NASM
386 
387 .seealso: SNESNASM, SNESNASMGetSubdomains()
388 @*/
389 PetscErrorCode SNESNASMGetSubdomainVecs(SNES snes,PetscInt *n,Vec **x,Vec **y,Vec **b, Vec **xl)
390 {
391   PetscErrorCode ierr;
392   PetscErrorCode (*f)(SNES,PetscInt*,Vec**,Vec**,Vec**,Vec**);
393 
394   PetscFunctionBegin;
395   ierr = PetscObjectQueryFunction((PetscObject)snes,"SNESNASMGetSubdomainVecs_C",&f);CHKERRQ(ierr);
396   ierr = (f)(snes,n,x,y,b,xl);CHKERRQ(ierr);
397   PetscFunctionReturn(0);
398 }
399 
400 #undef __FUNCT__
401 #define __FUNCT__ "SNESNASMGetSubdomainVecs_NASM"
402 PetscErrorCode SNESNASMGetSubdomainVecs_NASM(SNES snes,PetscInt *n,Vec **x,Vec **y,Vec **b,Vec **xl)
403 {
404   SNES_NASM      *nasm = (SNES_NASM*)snes->data;
405 
406   PetscFunctionBegin;
407   if (n)  *n  = nasm->n;
408   if (x)  *x  = nasm->x;
409   if (y)  *y  = nasm->y;
410   if (b)  *b  = nasm->b;
411   if (xl) *xl = nasm->xl;
412   PetscFunctionReturn(0);
413 }
414 
415 #undef __FUNCT__
416 #define __FUNCT__ "SNESNASMSetComputeFinalJacobian"
417 /*@
418    SNESNASMSetComputeFinalJacobian - Schedules the computation of the global and subdomain jacobians upon convergence
419 
420    Collective on SNES
421 
422    Input Parameters:
423 +  SNES - the SNES context
424 -  flg - indication of whether to compute the jacobians or not
425 
426    Level: developer
427 
428    Notes: This is used almost exclusively in the implementation of ASPIN, where the converged subdomain and global jacobian
429    is needed at each linear iteration.
430 
431 .keywords: SNES, NASM, ASPIN
432 
433 .seealso: SNESNASM, SNESNASMGetSubdomains()
434 @*/
435 PetscErrorCode SNESNASMSetComputeFinalJacobian(SNES snes,PetscBool flg)
436 {
437   PetscErrorCode (*f)(SNES,PetscBool);
438   PetscErrorCode ierr;
439 
440   PetscFunctionBegin;
441   ierr = PetscObjectQueryFunction((PetscObject)snes,"SNESNASMSetComputeFinalJacobian_C",&f);CHKERRQ(ierr);
442   ierr = (f)(snes,flg);CHKERRQ(ierr);
443   PetscFunctionReturn(0);
444 }
445 
446 #undef __FUNCT__
447 #define __FUNCT__ "SNESNASMSetComputeFinalJacobian_NASM"
448 PetscErrorCode SNESNASMSetComputeFinalJacobian_NASM(SNES snes,PetscBool flg)
449 {
450   SNES_NASM      *nasm = (SNES_NASM*)snes->data;
451 
452   PetscFunctionBegin;
453   nasm->finaljacobian = flg;
454   PetscFunctionReturn(0);
455 }
456 
457 #undef __FUNCT__
458 #define __FUNCT__ "SNESNASMSolveLocal_Private"
459 PetscErrorCode SNESNASMSolveLocal_Private(SNES snes,Vec B,Vec Y,Vec X)
460 {
461   SNES_NASM      *nasm = (SNES_NASM*)snes->data;
462   SNES           subsnes;
463   PetscInt       i;
464   PetscErrorCode ierr;
465   Vec            Xlloc,Xl,Bl,Yl;
466   VecScatter     iscat,oscat,gscat;
467   DM             dm,subdm;
468 
469   PetscFunctionBegin;
470   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
471   ierr = VecSet(Y,0);CHKERRQ(ierr);
472   if (nasm->eventrestrictinterp) {ierr = PetscLogEventBegin(nasm->eventrestrictinterp,snes,0,0,0);CHKERRQ(ierr);}
473   for (i=0; i<nasm->n; i++) {
474     /* scatter the solution to the local solution */
475     Xlloc = nasm->xl[i];
476     gscat   = nasm->gscatter[i];
477     oscat   = nasm->oscatter[i];
478     ierr = VecScatterBegin(gscat,X,Xlloc,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
479     if (B) {
480       /* scatter the RHS to the local RHS */
481       Bl   = nasm->b[i];
482       ierr = VecScatterBegin(oscat,B,Bl,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
483     }
484   }
485   if (nasm->eventrestrictinterp) {ierr = PetscLogEventEnd(nasm->eventrestrictinterp,snes,0,0,0);CHKERRQ(ierr);}
486 
487 
488   if (nasm->eventsubsolve) {ierr = PetscLogEventBegin(nasm->eventsubsolve,snes,0,0,0);CHKERRQ(ierr);}
489   for (i=0; i<nasm->n; i++) {
490     Xl    = nasm->x[i];
491     Xlloc = nasm->xl[i];
492     Yl    = nasm->y[i];
493     subsnes = nasm->subsnes[i];
494     ierr    = SNESGetDM(subsnes,&subdm);CHKERRQ(ierr);
495     iscat   = nasm->iscatter[i];
496     oscat   = nasm->oscatter[i];
497     gscat   = nasm->gscatter[i];
498     ierr = VecScatterEnd(gscat,X,Xlloc,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
499     if (B) {
500       Bl   = nasm->b[i];
501       ierr = VecScatterEnd(oscat,B,Bl,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
502     } else Bl = NULL;
503     ierr = DMSubDomainRestrict(dm,oscat,gscat,subdm);CHKERRQ(ierr);
504     ierr = DMLocalToGlobalBegin(subdm,Xlloc,INSERT_VALUES,Xl);CHKERRQ(ierr);
505     ierr = DMLocalToGlobalEnd(subdm,Xlloc,INSERT_VALUES,Xl);CHKERRQ(ierr);
506     ierr = VecCopy(Xl,Yl);CHKERRQ(ierr);
507     ierr = SNESSolve(subsnes,Bl,Xl);CHKERRQ(ierr);
508     ierr = VecAYPX(Yl,-1.0,Xl);CHKERRQ(ierr);
509     if (nasm->type == PC_ASM_BASIC) {
510       ierr = VecScatterBegin(oscat,Yl,Y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
511     } else if (nasm->type == PC_ASM_RESTRICT) {
512       ierr = VecScatterBegin(iscat,Yl,Y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
513     } else SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_WRONGSTATE,"Only basic and restrict types are supported for SNESNASM");
514   }
515   if (nasm->eventsubsolve) {ierr = PetscLogEventEnd(nasm->eventsubsolve,snes,0,0,0);CHKERRQ(ierr);}
516   if (nasm->eventrestrictinterp) {ierr = PetscLogEventBegin(nasm->eventrestrictinterp,snes,0,0,0);CHKERRQ(ierr);}
517   for (i=0; i<nasm->n; i++) {
518     Yl    = nasm->y[i];
519     iscat   = nasm->iscatter[i];
520     oscat   = nasm->oscatter[i];
521     if (nasm->type == PC_ASM_BASIC) {
522       ierr = VecScatterEnd(oscat,Yl,Y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
523     } else if (nasm->type == PC_ASM_RESTRICT) {
524       ierr = VecScatterEnd(iscat,Yl,Y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
525     } else SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_WRONGSTATE,"Only basic and restrict types are supported for SNESNASM");
526   }
527   if (nasm->eventrestrictinterp) {ierr = PetscLogEventEnd(nasm->eventrestrictinterp,snes,0,0,0);CHKERRQ(ierr);}
528   ierr = VecAXPY(X,1.0,Y);CHKERRQ(ierr);
529   PetscFunctionReturn(0);
530 }
531 
532 #undef __FUNCT__
533 #define __FUNCT__ "SNESNASMComputeFinalJacobian_Private"
534 PetscErrorCode SNESNASMComputeFinalJacobian_Private(SNES snes, Vec X)
535 {
536   SNES_NASM      *nasm = (SNES_NASM*)snes->data;
537   SNES           subsnes;
538   PetscInt       i,lag = 1;
539   PetscErrorCode ierr;
540   Vec            Xlloc,Xl,Fl,F;
541   VecScatter     oscat,gscat;
542   DM             dm,subdm;
543   MatStructure   flg = DIFFERENT_NONZERO_PATTERN;
544   PetscFunctionBegin;
545   F = snes->vec_func;
546   if (snes->normtype == SNES_NORM_NONE) {ierr = SNESComputeFunction(snes,X,F);CHKERRQ(ierr);}
547   ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr);
548   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
549   if (nasm->eventrestrictinterp) {ierr = PetscLogEventBegin(nasm->eventrestrictinterp,snes,0,0,0);CHKERRQ(ierr);}
550   for (i=0; i<nasm->n; i++) {
551     Xlloc = nasm->xl[i];
552     Fl    = nasm->subsnes[i]->vec_func;
553     gscat = nasm->gscatter[i];
554     oscat = nasm->oscatter[i];
555     ierr = VecScatterBegin(gscat,X,Xlloc,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
556     ierr = VecScatterBegin(oscat,F,Fl,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
557   }
558   if (nasm->eventrestrictinterp) {ierr = PetscLogEventEnd(nasm->eventrestrictinterp,snes,0,0,0);CHKERRQ(ierr);}
559   for (i=0; i<nasm->n; i++) {
560     Fl      = nasm->subsnes[i]->vec_func;
561     Xl      = nasm->x[i];
562     Xlloc   = nasm->xl[i];
563     subsnes = nasm->subsnes[i];
564     oscat   = nasm->oscatter[i];
565     gscat   = nasm->gscatter[i];
566     ierr = VecScatterEnd(gscat,X,Xlloc,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
567     ierr = VecScatterEnd(oscat,F,Fl,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
568     ierr = SNESGetDM(subsnes,&subdm);CHKERRQ(ierr);
569     ierr = DMSubDomainRestrict(dm,oscat,gscat,subdm);CHKERRQ(ierr);
570     ierr = DMLocalToGlobalBegin(subdm,Xlloc,INSERT_VALUES,Xl);CHKERRQ(ierr);
571     ierr = DMLocalToGlobalEnd(subdm,Xlloc,INSERT_VALUES,Xl);CHKERRQ(ierr);
572 
573     if (subsnes->lagjacobian == -1)    subsnes->lagjacobian = -2;
574     else if (subsnes->lagjacobian > 1) lag = subsnes->lagjacobian;
575     ierr = SNESComputeJacobian(subsnes,Xl,&subsnes->jacobian,&subsnes->jacobian_pre,&flg);CHKERRQ(ierr);
576     if (lag > 1) subsnes->lagjacobian = lag;
577     ierr = KSPSetOperators(subsnes->ksp,subsnes->jacobian,subsnes->jacobian_pre,flg);CHKERRQ(ierr);
578   }
579   PetscFunctionReturn(0);
580 }
581 
582 #undef __FUNCT__
583 #define __FUNCT__ "SNESSolve_NASM"
584 PetscErrorCode SNESSolve_NASM(SNES snes)
585 {
586   Vec            F;
587   Vec            X;
588   Vec            B;
589   Vec            Y;
590   PetscInt       i;
591   PetscReal      fnorm = 0.0;
592   PetscErrorCode ierr;
593   SNESNormType   normtype;
594   SNES_NASM      *nasm = (SNES_NASM*)snes->data;
595 
596   PetscFunctionBegin;
597   X = snes->vec_sol;
598   Y = snes->vec_sol_update;
599   F = snes->vec_func;
600   B = snes->vec_rhs;
601 
602   ierr         = PetscObjectAMSTakeAccess((PetscObject)snes);CHKERRQ(ierr);
603   snes->iter   = 0;
604   snes->norm   = 0.;
605   ierr         = PetscObjectAMSGrantAccess((PetscObject)snes);CHKERRQ(ierr);
606   snes->reason = SNES_CONVERGED_ITERATING;
607   ierr         = SNESGetNormType(snes, &normtype);CHKERRQ(ierr);
608   if (normtype == SNES_NORM_FUNCTION || normtype == SNES_NORM_INITIAL_ONLY || normtype == SNES_NORM_INITIAL_FINAL_ONLY) {
609     /* compute the initial function and preconditioned update delX */
610     if (!snes->vec_func_init_set) {
611       ierr = SNESComputeFunction(snes,X,F);CHKERRQ(ierr);
612       if (snes->domainerror) {
613         snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
614         PetscFunctionReturn(0);
615       }
616     } else snes->vec_func_init_set = PETSC_FALSE;
617 
618     /* convergence test */
619     if (!snes->norm_init_set) {
620       ierr = VecNorm(F, NORM_2, &fnorm);CHKERRQ(ierr); /* fnorm <- ||F||  */
621       if (PetscIsInfOrNanReal(fnorm)) {
622         snes->reason = SNES_DIVERGED_FNORM_NAN;
623         PetscFunctionReturn(0);
624       }
625     } else {
626       fnorm               = snes->norm_init;
627       snes->norm_init_set = PETSC_FALSE;
628     }
629     ierr       = PetscObjectAMSTakeAccess((PetscObject)snes);CHKERRQ(ierr);
630     snes->iter = 0;
631     snes->norm = fnorm;
632     ierr       = PetscObjectAMSGrantAccess((PetscObject)snes);CHKERRQ(ierr);
633     ierr       = SNESLogConvergenceHistory(snes,snes->norm,0);CHKERRQ(ierr);
634     ierr       = SNESMonitor(snes,0,snes->norm);CHKERRQ(ierr);
635 
636     /* set parameter for default relative tolerance convergence test */
637     snes->ttol = fnorm*snes->rtol;
638 
639     /* test convergence */
640     ierr = (*snes->ops->converged)(snes,0,0.0,0.0,fnorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
641     if (snes->reason) PetscFunctionReturn(0);
642   } else {
643     ierr = PetscObjectAMSGrantAccess((PetscObject)snes);CHKERRQ(ierr);
644     ierr = SNESLogConvergenceHistory(snes,snes->norm,0);CHKERRQ(ierr);
645     ierr = SNESMonitor(snes,0,snes->norm);CHKERRQ(ierr);
646   }
647 
648   /* Call general purpose update function */
649   if (snes->ops->update) {
650     ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr);
651   }
652 
653   for (i = 0; i < snes->max_its; i++) {
654     ierr = SNESNASMSolveLocal_Private(snes,B,Y,X);CHKERRQ(ierr);
655     if (normtype == SNES_NORM_FUNCTION || ((i == snes->max_its - 1) && (normtype == SNES_NORM_INITIAL_FINAL_ONLY || normtype == SNES_NORM_FINAL_ONLY))) {
656       ierr = SNESComputeFunction(snes,X,F);CHKERRQ(ierr);
657       if (snes->domainerror) {
658         snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
659         break;
660       }
661       ierr = VecNorm(F, NORM_2, &fnorm);CHKERRQ(ierr); /* fnorm <- ||F||  */
662       if (PetscIsInfOrNanReal(fnorm)) {
663         snes->reason = SNES_DIVERGED_FNORM_NAN;
664         break;
665       }
666     }
667     /* Monitor convergence */
668     ierr       = PetscObjectAMSTakeAccess((PetscObject)snes);CHKERRQ(ierr);
669     snes->iter = i+1;
670     snes->norm = fnorm;
671     ierr       = PetscObjectAMSGrantAccess((PetscObject)snes);CHKERRQ(ierr);
672     ierr       = SNESLogConvergenceHistory(snes,snes->norm,0);CHKERRQ(ierr);
673     ierr       = SNESMonitor(snes,snes->iter,snes->norm);CHKERRQ(ierr);
674     /* Test for convergence */
675     if (normtype == SNES_NORM_FUNCTION) {ierr = (*snes->ops->converged)(snes,snes->iter,0.0,0.0,fnorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);}
676     if (snes->reason) break;
677     /* Call general purpose update function */
678     if (snes->ops->update) {ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr);}
679   }
680   if (nasm->finaljacobian) {ierr = SNESNASMComputeFinalJacobian_Private(snes,X);CHKERRQ(ierr);}
681   if (normtype == SNES_NORM_FUNCTION) {
682     if (i == snes->max_its) {
683       ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",snes->max_its);CHKERRQ(ierr);
684       if (!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT;
685     }
686   } else if (!snes->reason) snes->reason = SNES_CONVERGED_ITS; /* NASM is meant to be used as a preconditioner */
687   PetscFunctionReturn(0);
688 }
689 
690 /*MC
691   SNESNASM - Nonlinear Additive Schwartz
692 
693    Options Database:
694 +  -snes_nasm_log - enable logging events for the communication and solve stages
695 .  -snes_nasm_type <basic,restrict> - type of subdomain update used
696 .  -snes_nasm_finaljacobian - compute the local and global jacobians of the final iterate
697 .  -sub_snes_ - options prefix of the subdomain nonlinear solves
698 .  -sub_ksp_ - options prefix of the subdomain Krylov solver
699 -  -sub_pc_ - options prefix of the subdomain preconditioner
700 
701    Level: advanced
702 
703 .seealso: SNESCreate(), SNES, SNESSetType(), SNESType (for list of available types)
704 M*/
705 
706 #undef __FUNCT__
707 #define __FUNCT__ "SNESCreate_NASM"
708 PETSC_EXTERN PetscErrorCode SNESCreate_NASM(SNES snes)
709 {
710   SNES_NASM      *nasm;
711   PetscErrorCode ierr;
712 
713   PetscFunctionBegin;
714   ierr       = PetscNewLog(snes, SNES_NASM, &nasm);CHKERRQ(ierr);
715   snes->data = (void*)nasm;
716 
717   nasm->n        = PETSC_DECIDE;
718   nasm->subsnes  = 0;
719   nasm->x        = 0;
720   nasm->xl       = 0;
721   nasm->y        = 0;
722   nasm->b        = 0;
723   nasm->oscatter = 0;
724   nasm->iscatter = 0;
725   nasm->gscatter = 0;
726 
727   nasm->type = PC_ASM_BASIC;
728   nasm->finaljacobian = PETSC_FALSE;
729 
730   snes->ops->destroy        = SNESDestroy_NASM;
731   snes->ops->setup          = SNESSetUp_NASM;
732   snes->ops->setfromoptions = SNESSetFromOptions_NASM;
733   snes->ops->view           = SNESView_NASM;
734   snes->ops->solve          = SNESSolve_NASM;
735   snes->ops->reset          = SNESReset_NASM;
736 
737   snes->usesksp = PETSC_FALSE;
738   snes->usespc  = PETSC_FALSE;
739 
740   nasm->eventrestrictinterp = 0;
741   nasm->eventsubsolve       = 0;
742 
743   if (!snes->tolerancesset) {
744     snes->max_its   = 10000;
745     snes->max_funcs = 10000;
746   }
747 
748   ierr = PetscObjectComposeFunction((PetscObject)snes,"SNESNASMSetSubdomains_C",SNESNASMSetSubdomains_NASM);CHKERRQ(ierr);
749   ierr = PetscObjectComposeFunction((PetscObject)snes,"SNESNASMGetSubdomains_C",SNESNASMGetSubdomains_NASM);CHKERRQ(ierr);
750   ierr = PetscObjectComposeFunction((PetscObject)snes,"SNESNASMGetSubdomainVecs_C",SNESNASMGetSubdomainVecs_NASM);CHKERRQ(ierr);
751   ierr = PetscObjectComposeFunction((PetscObject)snes,"SNESNASMSetComputeFinalJacobian_C",SNESNASMSetComputeFinalJacobian_NASM);CHKERRQ(ierr);
752   PetscFunctionReturn(0);
753 }
754 
755