Actual source code: snesimpl.h

  1: #ifndef __SNESIMPL_H

  4: #include <petscsnes.h>
  5: #include <petsc/private/petscimpl.h>

  7: PETSC_EXTERN PetscBool SNESRegisterAllCalled;
  8: PETSC_EXTERN PetscErrorCode SNESRegisterAll(void);

 10: typedef struct _SNESOps *SNESOps;

 12: struct _SNESOps {
 13:   PetscErrorCode (*computeinitialguess)(SNES,Vec,void*);
 14:   PetscErrorCode (*computescaling)(Vec,Vec,void*);
 15:   PetscErrorCode (*update)(SNES, PetscInt);                     /* General purpose function for update */
 16:   PetscErrorCode (*converged)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
 17:   PetscErrorCode (*convergeddestroy)(void*);
 18:   PetscErrorCode (*setup)(SNES);                                /* routine to set up the nonlinear solver */
 19:   PetscErrorCode (*solve)(SNES);                                /* actual nonlinear solver */
 20:   PetscErrorCode (*view)(SNES,PetscViewer);
 21:   PetscErrorCode (*setfromoptions)(PetscOptionItems*,SNES);                       /* sets options from database */
 22:   PetscErrorCode (*destroy)(SNES);
 23:   PetscErrorCode (*reset)(SNES);
 24:   PetscErrorCode (*usercompute)(SNES,void**);
 25:   PetscErrorCode (*userdestroy)(void**);
 26:   PetscErrorCode (*computevariablebounds)(SNES,Vec,Vec);        /* user provided routine to set box constrained variable bounds */
 27:   PetscErrorCode (*computepfunction)(SNES,Vec,Vec,void*);
 28:   PetscErrorCode (*computepjacobian)(SNES,Vec,Mat,Mat,void*);
 29:   PetscErrorCode (*load)(SNES,PetscViewer);
 30: };

 32: /*
 33:    Nonlinear solver context
 34:  */
 35: #define MAXSNESMONITORS 5
 36: #define MAXSNESREASONVIEWS 5

 38: struct _p_SNES {
 39:   PETSCHEADER(struct _SNESOps);
 40:   DM        dm;
 41:   PetscBool dmAuto;             /* SNES created currently used DM automatically */
 42:   SNES      npc;
 43:   PCSide    npcside;
 44:   PetscBool usesnpc;            /* type can use a nonlinear preconditioner */

 46:   /*  ------------------------ User-provided stuff -------------------------------*/
 47:   void  *user;                   /* user-defined context */

 49:   Vec  vec_rhs;                  /* If non-null, solve F(x) = rhs */
 50:   Vec  vec_sol;                  /* pointer to solution */

 52:   Vec  vec_func;                 /* pointer to function */

 54:   Mat  jacobian;                 /* Jacobian matrix */
 55:   Mat  jacobian_pre;             /* preconditioner matrix */
 56:   Mat  picard;                   /* copy of preconditioner matrix needed for Picard with -snes_mf_operator */
 57:   void *initialguessP;           /* user-defined initial guess context */
 58:   KSP  ksp;                      /* linear solver context */
 59:   SNESLineSearch linesearch;     /* line search context */
 60:   PetscBool usesksp;
 61:   MatStructure matstruct;        /* Used by Picard solver */

 63:   Vec  vec_sol_update;           /* pointer to solution update */

 65:   Vec  scaling;                  /* scaling vector */
 66:   void *scaP;                    /* scaling context */

 68:   PetscReal precheck_picard_angle; /* For use with SNESLineSearchPreCheckPicard */

 70:   /* ------------------------Time stepping hooks-----------------------------------*/

 72:   /* ---------------- PETSc-provided (or user-provided) stuff ---------------------*/

 74:   PetscErrorCode      (*monitor[MAXSNESMONITORS])(SNES,PetscInt,PetscReal,void*); /* monitor routine */
 75:   PetscErrorCode      (*monitordestroy[MAXSNESMONITORS])(void**);                 /* monitor context destroy routine */
 76:   void                *monitorcontext[MAXSNESMONITORS];                           /* monitor context */
 77:   PetscInt            numbermonitors;                                             /* number of monitors */
 78:   void                *cnvP;                                                      /* convergence context */
 79:   SNESConvergedReason reason;                                                     /* converged reason */
 80:   PetscErrorCode      (*reasonview[MAXSNESREASONVIEWS])(SNES,void*);              /* snes converged reason view */
 81:   PetscErrorCode      (*reasonviewdestroy[MAXSNESREASONVIEWS])(void**);           /* reason view context destroy routine */
 82:   void                *reasonviewcontext[MAXSNESREASONVIEWS];                     /* reason view context */
 83:   PetscInt            numberreasonviews;                                          /* number of reason views */
 84:   PetscBool           errorifnotconverged;

 86:   /* --- Routines and data that are unique to each particular solver --- */

 88:   PetscBool      setupcalled;                /* true if setup has been called */
 89:   void           *data;                      /* implementation-specific data */

 91:   /* --------------------------  Parameters -------------------------------------- */

 93:   PetscInt    max_its;            /* max number of iterations */
 94:   PetscInt    max_funcs;          /* max number of function evals */
 95:   PetscInt    nfuncs;             /* number of function evaluations */
 96:   PetscInt    iter;               /* global iteration number */
 97:   PetscInt    linear_its;         /* total number of linear solver iterations */
 98:   PetscReal   norm;               /* residual norm of current iterate */
 99:   PetscReal   ynorm;              /* update norm of current iterate */
100:   PetscReal   xnorm;              /* solution norm of current iterate */
101:   PetscReal   rtol;               /* relative tolerance */
102:   PetscReal   divtol;             /* relative divergence tolerance */
103:   PetscReal   abstol;             /* absolute tolerance */
104:   PetscReal   stol;               /* step length tolerance*/
105:   PetscReal   deltatol;           /* trust region convergence tolerance */
106:   PetscBool   forceiteration;     /* Force SNES to take at least one iteration regardless of the initial residual norm */
107:   PetscInt    lagpreconditioner;  /* SNESSetLagPreconditioner() */
108:   PetscInt    lagjacobian;        /* SNESSetLagJacobian() */
109:   PetscInt    jac_iter;           /* The present iteration of the Jacobian lagging */
110:   PetscBool   lagjac_persist;     /* The jac_iter persists until reset */
111:   PetscInt    pre_iter;           /* The present iteration of the Preconditioner lagging */
112:   PetscBool   lagpre_persist;     /* The pre_iter persists until reset */
113:   PetscInt    gridsequence;       /* number of grid sequence steps to take; defaults to zero */

115:   PetscBool   tolerancesset;      /* SNESSetTolerances() called and tolerances should persist through SNESCreate_XXX()*/

117:   PetscBool   vec_func_init_set;  /* the initial function has been set */

119:   SNESNormSchedule normschedule;  /* Norm computation type for SNES instance */
120:   SNESFunctionType functype;      /* Function type for the SNES instance */

122:   /* ------------------------ Default work-area management ---------------------- */

124:   PetscInt    nwork;
125:   Vec         *work;

127:   /* ------------------------- Miscellaneous Information ------------------------ */

129:   PetscInt    setfromoptionscalled;
130:   PetscReal   *conv_hist;         /* If !0, stores function norm (or
131:                                     gradient norm) at each iteration */
132:   PetscInt    *conv_hist_its;     /* linear iterations for each Newton step */
133:   PetscInt    conv_hist_len;      /* size of convergence history array */
134:   PetscInt    conv_hist_max;      /* actual amount of data in conv_history */
135:   PetscBool   conv_hist_reset;    /* reset counter for each new SNES solve */
136:   PetscBool   conv_hist_alloc;
137:   PetscBool    counters_reset;    /* reset counter for each new SNES solve */

139:   /* the next two are used for failures in the line search; they should be put elsewhere */
140:   PetscInt    numFailures;        /* number of unsuccessful step attempts */
141:   PetscInt    maxFailures;        /* maximum number of unsuccessful step attempts */

143:   PetscInt    numLinearSolveFailures;
144:   PetscInt    maxLinearSolveFailures;

146:   PetscBool   domainerror;       /* set with SNESSetFunctionDomainError() */
147:   PetscBool   jacobiandomainerror; /* set with SNESSetJacobianDomainError() */
148:   PetscBool   checkjacdomainerror; /* if or not check Jacobian domain error after Jacobian evaluations */

150:   PetscBool   ksp_ewconv;        /* flag indicating use of Eisenstat-Walker KSP convergence criteria */
151:   void        *kspconvctx;       /* Eisenstat-Walker KSP convergence context */

153:   /* SNESConvergedDefault context: split it off into a separate var/struct to be passed as context to SNESConvergedDefault? */
154:   PetscReal   ttol;              /* rtol*initial_residual_norm */
155:   PetscReal   rnorm0;            /* initial residual norm (used for divergence testing) */

157:   Vec         *vwork;            /* more work vectors for Jacobian approx */
158:   PetscInt    nvwork;

160:   PetscBool   mf;               /* -snes_mf was used on this snes */
161:   PetscBool   mf_operator;      /* -snes_mf_operator was used on this snes */
162:   PetscInt    mf_version;       /* The version of snes_mf used */

164:   PetscReal   vizerotolerance;   /* tolerance for considering an x[] value to be on the bound */
165:   Vec         xl,xu;             /* upper and lower bounds for box constrained VI problems */
166:   PetscInt    ntruebounds;       /* number of non-infinite bounds set for VI box constraints */
167:   PetscBool   usersetbounds;     /* bounds have been set via SNESVISetVariableBounds(), rather than via computevariablebounds() callback. */

169:   PetscBool   alwayscomputesfinalresidual;  /* Does SNESSolve_XXX always compute the value of the residual at the final
170:                                              * solution and put it in vec_func?  Used inside SNESSolve_FAS to determine
171:                                              * if the final residual must be computed before restricting or prolonging
172:                                              * it. */

174: };

176: typedef struct _p_DMSNES *DMSNES;
177: typedef struct _DMSNESOps *DMSNESOps;
178: struct _DMSNESOps {
179:   PetscErrorCode (*computefunction)(SNES,Vec,Vec,void*);
180:   PetscErrorCode (*computemffunction)(SNES,Vec,Vec,void*);
181:   PetscErrorCode (*computejacobian)(SNES,Vec,Mat,Mat,void*);

183:   /* objective */
184:   PetscErrorCode (*computeobjective)(SNES,Vec,PetscReal*,void*);

186:   /* Picard iteration functions */
187:   PetscErrorCode (*computepfunction)(SNES,Vec,Vec,void*);
188:   PetscErrorCode (*computepjacobian)(SNES,Vec,Mat,Mat,void*);

190:   /* User-defined smoother */
191:   PetscErrorCode (*computegs)(SNES,Vec,Vec,void*);

193:   PetscErrorCode (*destroy)(DMSNES);
194:   PetscErrorCode (*duplicate)(DMSNES,DMSNES);
195: };

197: struct _p_DMSNES {
198:   PETSCHEADER(struct _DMSNESOps);
199:   void *functionctx;
200:   void *mffunctionctx;
201:   void *gsctx;
202:   void *pctx;
203:   void *jacobianctx;
204:   void *objectivectx;

206:   void *data;

208:   /* This is NOT reference counted. The DM on which this context was first created is cached here to implement one-way
209:    * copy-on-write. When DMGetDMSNESWrite() sees a request using a different DM, it makes a copy. Thus, if a user
210:    * only interacts directly with one level, e.g., using SNESSetFunction(), then SNESSetUp_FAS() is called to build
211:    * coarse levels, then the user changes the routine with another call to SNESSetFunction(), it automatically
212:    * propagates to all the levels. If instead, they get out a specific level and set the function on that level,
213:    * subsequent changes to the original level will no longer propagate to that level.
214:    */
215:   DM originaldm;
216: };
217: PETSC_EXTERN PetscErrorCode DMGetDMSNES(DM,DMSNES*);
218: PETSC_EXTERN PetscErrorCode DMSNESView(DMSNES,PetscViewer);
219: PETSC_EXTERN PetscErrorCode DMSNESLoad(DMSNES,PetscViewer);
220: PETSC_EXTERN PetscErrorCode DMGetDMSNESWrite(DM,DMSNES*);

222: /* Context for Eisenstat-Walker convergence criteria for KSP solvers */
223: typedef struct {
224:   PetscInt  version;             /* flag indicating version 1 or 2 of test */
225:   PetscReal rtol_0;              /* initial rtol */
226:   PetscReal rtol_last;           /* last rtol */
227:   PetscReal rtol_max;            /* maximum rtol */
228:   PetscReal gamma;               /* mult. factor for version 2 rtol computation */
229:   PetscReal alpha;               /* power for version 2 rtol computation */
230:   PetscReal alpha2;              /* power for safeguard */
231:   PetscReal threshold;           /* threshold for imposing safeguard */
232:   PetscReal lresid_last;         /* linear residual from last iteration */
233:   PetscReal norm_last;           /* function norm from last iteration */
234:   PetscReal norm_first;          /* function norm from the beginning of the first iteration. */
235: } SNESKSPEW;

237: PETSC_STATIC_INLINE PetscErrorCode SNESLogConvergenceHistory(SNES snes,PetscReal res,PetscInt its)
238: {

242:   PetscObjectSAWsTakeAccess((PetscObject)snes);
243:   if (snes->conv_hist && snes->conv_hist_max > snes->conv_hist_len) {
244:     if (snes->conv_hist)     snes->conv_hist[snes->conv_hist_len]     = res;
245:     if (snes->conv_hist_its) snes->conv_hist_its[snes->conv_hist_len] = its;
246:     snes->conv_hist_len++;
247:   }
248:   PetscObjectSAWsGrantAccess((PetscObject)snes);
249:   return(0);
250: }

252: PETSC_EXTERN PetscErrorCode SNESVIProjectOntoBounds(SNES,Vec);
253: PETSC_INTERN PetscErrorCode SNESVICheckLocalMin_Private(SNES,Mat,Vec,Vec,PetscReal,PetscBool*);
254: PETSC_INTERN PetscErrorCode SNESReset_VI(SNES);
255: PETSC_INTERN PetscErrorCode SNESDestroy_VI(SNES);
256: PETSC_INTERN PetscErrorCode SNESView_VI(SNES,PetscViewer);
257: PETSC_INTERN PetscErrorCode SNESSetFromOptions_VI(PetscOptionItems*,SNES);
258: PETSC_INTERN PetscErrorCode SNESSetUp_VI(SNES);
259: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*SNESVIComputeVariableBoundsFunction)(SNES,Vec,Vec);
260: PETSC_INTERN PetscErrorCode SNESVISetComputeVariableBounds_VI(SNES,SNESVIComputeVariableBoundsFunction);
261: PETSC_INTERN PetscErrorCode SNESVISetVariableBounds_VI(SNES,Vec,Vec);
262: PETSC_INTERN PetscErrorCode SNESConvergedDefault_VI(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);

264: PetscErrorCode SNESScaleStep_Private(SNES,Vec,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
265: PETSC_EXTERN PetscErrorCode DMSNESCheck_Internal(SNES,DM,Vec);

267: PETSC_EXTERN PetscLogEvent SNES_Solve;
268: PETSC_EXTERN PetscLogEvent SNES_Setup;
269: PETSC_EXTERN PetscLogEvent SNES_LineSearch;
270: PETSC_EXTERN PetscLogEvent SNES_FunctionEval;
271: PETSC_EXTERN PetscLogEvent SNES_JacobianEval;
272: PETSC_EXTERN PetscLogEvent SNES_NGSEval;
273: PETSC_EXTERN PetscLogEvent SNES_NGSFuncEval;
274: PETSC_EXTERN PetscLogEvent SNES_NPCSolve;
275: PETSC_EXTERN PetscLogEvent SNES_ObjectiveEval;

277: PETSC_INTERN PetscBool SNEScite;
278: PETSC_INTERN const char SNESCitation[];

280: /*
281:     Either generate an error or mark as diverged when a real from a SNES function norm is Nan or Inf.
282:     domainerror is reset here, once reason is set, to allow subsequent iterations to be feasible (e.g. line search).
283: */
284: #define SNESCheckFunctionNorm(snes,beta) do { \
285:   if (PetscIsInfOrNanReal(beta)) {\
286:     if (snes->errorifnotconverged) SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_NOT_CONVERGED,"SNESSolve has not converged due to Nan or Inf norm");\
287:     else {\
288:       PetscBool domainerror;\
289:       PetscErrorCode MPIU_Allreduce(&snes->domainerror,&domainerror,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)snes));\
290:       if (domainerror)  {\
291:         snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;\
292:         snes->domainerror = PETSC_FALSE;\
293:       } else snes->reason = SNES_DIVERGED_FNORM_NAN;\
294:       return(0);\
295:     }\
296:   } } while (0)

298: #define SNESCheckJacobianDomainerror(snes) do { \
299:   if (snes->checkjacdomainerror) {\
300:     PetscBool domainerror;\
301:     PetscErrorCode MPIU_Allreduce(&snes->jacobiandomainerror,&domainerror,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)snes));\
302:     if (domainerror) {\
303:       snes->reason = SNES_DIVERGED_JACOBIAN_DOMAIN;\
304:       if (snes->errorifnotconverged) SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_NOT_CONVERGED,"SNESSolve has not converged due to Jacobian domain error");\
305:       return(0);\
306:     }\
307:   } } while (0)

309: #define SNESCheckKSPSolve(snes)\
310:   do {\
311:     KSPConvergedReason kspreason; \
313:     PetscInt lits;                                                      \
314:     KSPGetIterationNumber(snes->ksp,&lits);        \
315:     snes->linear_its += lits;                                           \
316:     KSPGetConvergedReason(snes->ksp,&kspreason);\
317:     if (kspreason < 0) {\
318:       if (kspreason == KSP_DIVERGED_NANORINF) {\
319:         PetscBool domainerror;\
320:         MPIU_Allreduce(&snes->domainerror,&domainerror,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)snes));\
321:         if (domainerror)  snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;\
322:         else              snes->reason = SNES_DIVERGED_LINEAR_SOLVE;                  \
323:         return(0);\
324:       } else {\
325:         if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) {\
326:           PetscInfo3(snes,"iter=%D, number linear solve failures %D greater than current SNES allowed %D, stopping solve\n",snes->iter,snes->numLinearSolveFailures,snes->maxLinearSolveFailures);\
327:           snes->reason = SNES_DIVERGED_LINEAR_SOLVE;\
328:           return(0);\
329:         }\
330:       }\
331:     }\
332:   } while (0)

334: #endif