xref: /petsc/src/snes/interface/snes.c (revision af60355ffa61bb6d9b134d60223b49fcb34c9cbc)
19b94acceSBarry Smith 
2c6db04a5SJed Brown #include <private/snesimpl.h>      /*I "petscsnes.h"  I*/
39b94acceSBarry Smith 
4ace3abfcSBarry Smith PetscBool  SNESRegisterAllCalled = PETSC_FALSE;
58ba1e511SMatthew Knepley PetscFList SNESList              = PETSC_NULL;
68ba1e511SMatthew Knepley 
78ba1e511SMatthew Knepley /* Logging support */
87087cfbeSBarry Smith PetscClassId  SNES_CLASSID;
9166c7f25SBarry Smith PetscLogEvent  SNES_Solve, SNES_LineSearch, SNES_FunctionEval, SNES_JacobianEval;
10a09944afSBarry Smith 
11a09944afSBarry Smith #undef __FUNCT__
12cab2e9ccSBarry Smith #define __FUNCT__ "SNESDMComputeJacobian"
13cab2e9ccSBarry Smith /*
14cab2e9ccSBarry Smith     Translates from a SNES call to a DM call in computing a Jacobian
15cab2e9ccSBarry Smith */
16cab2e9ccSBarry Smith PetscErrorCode SNESDMComputeJacobian(SNES snes,Vec X,Mat *J,Mat *B,MatStructure *flag,void *ptr)
17cab2e9ccSBarry Smith {
18cab2e9ccSBarry Smith   PetscErrorCode ierr;
19cab2e9ccSBarry Smith   DM             dm;
20cab2e9ccSBarry Smith 
21cab2e9ccSBarry Smith   PetscFunctionBegin;
22cab2e9ccSBarry Smith   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
23cab2e9ccSBarry Smith   ierr = DMComputeJacobian(dm,X,*J,*B,flag);CHKERRQ(ierr);
24cab2e9ccSBarry Smith   PetscFunctionReturn(0);
25cab2e9ccSBarry Smith }
26cab2e9ccSBarry Smith 
27cab2e9ccSBarry Smith #undef __FUNCT__
28e113a28aSBarry Smith #define __FUNCT__ "SNESSetErrorIfNotConverged"
29e113a28aSBarry Smith /*@
30e113a28aSBarry Smith    SNESSetErrorIfNotConverged - Causes SNESSolve() to generate an error if the solver has not converged.
31e113a28aSBarry Smith 
323f9fe445SBarry Smith    Logically Collective on SNES
33e113a28aSBarry Smith 
34e113a28aSBarry Smith    Input Parameters:
35e113a28aSBarry Smith +  snes - iterative context obtained from SNESCreate()
36e113a28aSBarry Smith -  flg - PETSC_TRUE indicates you want the error generated
37e113a28aSBarry Smith 
38e113a28aSBarry Smith    Options database keys:
39e113a28aSBarry Smith .  -snes_error_if_not_converged : this takes an optional truth value (0/1/no/yes/true/false)
40e113a28aSBarry Smith 
41e113a28aSBarry Smith    Level: intermediate
42e113a28aSBarry Smith 
43e113a28aSBarry Smith    Notes:
44e113a28aSBarry Smith     Normally PETSc continues if a linear solver fails to converge, you can call SNESGetConvergedReason() after a SNESSolve()
45e113a28aSBarry Smith     to determine if it has converged.
46e113a28aSBarry Smith 
47e113a28aSBarry Smith .keywords: SNES, set, initial guess, nonzero
48e113a28aSBarry Smith 
49e113a28aSBarry Smith .seealso: SNESGetErrorIfNotConverged(), KSPGetErrorIfNotConverged(), KSPSetErrorIFNotConverged()
50e113a28aSBarry Smith @*/
517087cfbeSBarry Smith PetscErrorCode  SNESSetErrorIfNotConverged(SNES snes,PetscBool  flg)
52e113a28aSBarry Smith {
53e113a28aSBarry Smith   PetscFunctionBegin;
54e113a28aSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
55acfcf0e5SJed Brown   PetscValidLogicalCollectiveBool(snes,flg,2);
56e113a28aSBarry Smith   snes->errorifnotconverged = flg;
57e113a28aSBarry Smith   PetscFunctionReturn(0);
58e113a28aSBarry Smith }
59e113a28aSBarry Smith 
60e113a28aSBarry Smith #undef __FUNCT__
61e113a28aSBarry Smith #define __FUNCT__ "SNESGetErrorIfNotConverged"
62e113a28aSBarry Smith /*@
63e113a28aSBarry Smith    SNESGetErrorIfNotConverged - Will SNESSolve() generate an error if the solver does not converge?
64e113a28aSBarry Smith 
65e113a28aSBarry Smith    Not Collective
66e113a28aSBarry Smith 
67e113a28aSBarry Smith    Input Parameter:
68e113a28aSBarry Smith .  snes - iterative context obtained from SNESCreate()
69e113a28aSBarry Smith 
70e113a28aSBarry Smith    Output Parameter:
71e113a28aSBarry Smith .  flag - PETSC_TRUE if it will generate an error, else PETSC_FALSE
72e113a28aSBarry Smith 
73e113a28aSBarry Smith    Level: intermediate
74e113a28aSBarry Smith 
75e113a28aSBarry Smith .keywords: SNES, set, initial guess, nonzero
76e113a28aSBarry Smith 
77e113a28aSBarry Smith .seealso:  SNESSetErrorIfNotConverged(), KSPGetErrorIfNotConverged(), KSPSetErrorIFNotConverged()
78e113a28aSBarry Smith @*/
797087cfbeSBarry Smith PetscErrorCode  SNESGetErrorIfNotConverged(SNES snes,PetscBool  *flag)
80e113a28aSBarry Smith {
81e113a28aSBarry Smith   PetscFunctionBegin;
82e113a28aSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
83e113a28aSBarry Smith   PetscValidPointer(flag,2);
84e113a28aSBarry Smith   *flag = snes->errorifnotconverged;
85e113a28aSBarry Smith   PetscFunctionReturn(0);
86e113a28aSBarry Smith }
87e113a28aSBarry Smith 
88e113a28aSBarry Smith #undef __FUNCT__
894936397dSBarry Smith #define __FUNCT__ "SNESSetFunctionDomainError"
90e725d27bSBarry Smith /*@
914936397dSBarry Smith    SNESSetFunctionDomainError - tells SNES that the input vector to your FormFunction is not
924936397dSBarry Smith      in the functions domain. For example, negative pressure.
934936397dSBarry Smith 
943f9fe445SBarry Smith    Logically Collective on SNES
954936397dSBarry Smith 
964936397dSBarry Smith    Input Parameters:
974936397dSBarry Smith .  SNES - the SNES context
984936397dSBarry Smith 
9928529972SSatish Balay    Level: advanced
1004936397dSBarry Smith 
1014936397dSBarry Smith .keywords: SNES, view
1024936397dSBarry Smith 
1034936397dSBarry Smith .seealso: SNESCreate(), SNESSetFunction()
1044936397dSBarry Smith @*/
1057087cfbeSBarry Smith PetscErrorCode  SNESSetFunctionDomainError(SNES snes)
1064936397dSBarry Smith {
1074936397dSBarry Smith   PetscFunctionBegin;
1080700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1094936397dSBarry Smith   snes->domainerror = PETSC_TRUE;
1104936397dSBarry Smith   PetscFunctionReturn(0);
1114936397dSBarry Smith }
1124936397dSBarry Smith 
1134936397dSBarry Smith #undef __FUNCT__
1144a2ae208SSatish Balay #define __FUNCT__ "SNESView"
1157e2c5f70SBarry Smith /*@C
1169b94acceSBarry Smith    SNESView - Prints the SNES data structure.
1179b94acceSBarry Smith 
1184c49b128SBarry Smith    Collective on SNES
119fee21e36SBarry Smith 
120c7afd0dbSLois Curfman McInnes    Input Parameters:
121c7afd0dbSLois Curfman McInnes +  SNES - the SNES context
122c7afd0dbSLois Curfman McInnes -  viewer - visualization context
123c7afd0dbSLois Curfman McInnes 
1249b94acceSBarry Smith    Options Database Key:
125c8a8ba5cSLois Curfman McInnes .  -snes_view - Calls SNESView() at end of SNESSolve()
1269b94acceSBarry Smith 
1279b94acceSBarry Smith    Notes:
1289b94acceSBarry Smith    The available visualization contexts include
129b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
130b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
131c8a8ba5cSLois Curfman McInnes          output where only the first processor opens
132c8a8ba5cSLois Curfman McInnes          the file.  All other processors send their
133c8a8ba5cSLois Curfman McInnes          data to the first processor to print.
1349b94acceSBarry Smith 
1353e081fefSLois Curfman McInnes    The user can open an alternative visualization context with
136b0a32e0cSBarry Smith    PetscViewerASCIIOpen() - output to a specified file.
1379b94acceSBarry Smith 
13836851e7fSLois Curfman McInnes    Level: beginner
13936851e7fSLois Curfman McInnes 
1409b94acceSBarry Smith .keywords: SNES, view
1419b94acceSBarry Smith 
142b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1439b94acceSBarry Smith @*/
1447087cfbeSBarry Smith PetscErrorCode  SNESView(SNES snes,PetscViewer viewer)
1459b94acceSBarry Smith {
146fa9f3622SBarry Smith   SNESKSPEW           *kctx;
147dfbe8321SBarry Smith   PetscErrorCode      ierr;
14894b7f48cSBarry Smith   KSP                 ksp;
149ace3abfcSBarry Smith   PetscBool           iascii,isstring;
1509b94acceSBarry Smith 
1513a40ed3dSBarry Smith   PetscFunctionBegin;
1520700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1533050cee2SBarry Smith   if (!viewer) {
1547adad957SLisandro Dalcin     ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&viewer);CHKERRQ(ierr);
1553050cee2SBarry Smith   }
1560700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
157c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,viewer,2);
15874679c65SBarry Smith 
1592692d6eeSBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1602692d6eeSBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
16132077d6dSBarry Smith   if (iascii) {
162317d6ea6SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)snes,viewer,"SNES Object");CHKERRQ(ierr);
163e7788613SBarry Smith     if (snes->ops->view) {
164b0a32e0cSBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
165e7788613SBarry Smith       ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr);
166b0a32e0cSBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1670ef38995SBarry Smith     }
16877431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum iterations=%D, maximum function evaluations=%D\n",snes->max_its,snes->max_funcs);CHKERRQ(ierr);
169a83599f4SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  tolerances: relative=%G, absolute=%G, solution=%G\n",
17070441072SBarry Smith                  snes->rtol,snes->abstol,snes->xtol);CHKERRQ(ierr);
17177431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",snes->linear_its);CHKERRQ(ierr);
17277431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  total number of function evaluations=%D\n",snes->nfuncs);CHKERRQ(ierr);
1739b94acceSBarry Smith     if (snes->ksp_ewconv) {
174fa9f3622SBarry Smith       kctx = (SNESKSPEW *)snes->kspconvctx;
1759b94acceSBarry Smith       if (kctx) {
17677431f27SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Eisenstat-Walker computation of KSP relative tolerance (version %D)\n",kctx->version);CHKERRQ(ierr);
177a83599f4SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"    rtol_0=%G, rtol_max=%G, threshold=%G\n",kctx->rtol_0,kctx->rtol_max,kctx->threshold);CHKERRQ(ierr);
178a83599f4SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"    gamma=%G, alpha=%G, alpha2=%G\n",kctx->gamma,kctx->alpha,kctx->alpha2);CHKERRQ(ierr);
1799b94acceSBarry Smith       }
1809b94acceSBarry Smith     }
181eb1f6c34SBarry Smith     if (snes->lagpreconditioner == -1) {
182eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioned is never rebuilt\n");CHKERRQ(ierr);
183eb1f6c34SBarry Smith     } else if (snes->lagpreconditioner > 1) {
184eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioned is rebuilt every %D new Jacobians\n",snes->lagpreconditioner);CHKERRQ(ierr);
185eb1f6c34SBarry Smith     }
186eb1f6c34SBarry Smith     if (snes->lagjacobian == -1) {
187eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Jacobian is never rebuilt\n");CHKERRQ(ierr);
188eb1f6c34SBarry Smith     } else if (snes->lagjacobian > 1) {
18942f4f86dSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Jacobian is rebuilt every %D SNES iterations\n",snes->lagjacobian);CHKERRQ(ierr);
190eb1f6c34SBarry Smith     }
1910f5bd95cSBarry Smith   } else if (isstring) {
192317d6ea6SBarry Smith     const char *type;
193454a90a3SBarry Smith     ierr = SNESGetType(snes,&type);CHKERRQ(ierr);
194b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr);
19519bcc07fSBarry Smith   }
19642f4f86dSBarry Smith   if (snes->pc && snes->usespc) {
1974a0c5b0cSMatthew G Knepley     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1984a0c5b0cSMatthew G Knepley     ierr = SNESView(snes->pc, viewer);CHKERRQ(ierr);
1994a0c5b0cSMatthew G Knepley     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2004a0c5b0cSMatthew G Knepley   }
2012c155ee1SBarry Smith   if (snes->usesksp) {
2022c155ee1SBarry Smith     ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
203b0a32e0cSBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
20494b7f48cSBarry Smith     ierr = KSPView(ksp,viewer);CHKERRQ(ierr);
205b0a32e0cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2062c155ee1SBarry Smith   }
2073a40ed3dSBarry Smith   PetscFunctionReturn(0);
2089b94acceSBarry Smith }
2099b94acceSBarry Smith 
21076b2cf59SMatthew Knepley /*
21176b2cf59SMatthew Knepley   We retain a list of functions that also take SNES command
21276b2cf59SMatthew Knepley   line options. These are called at the end SNESSetFromOptions()
21376b2cf59SMatthew Knepley */
21476b2cf59SMatthew Knepley #define MAXSETFROMOPTIONS 5
215a7cc72afSBarry Smith static PetscInt numberofsetfromoptions;
2166849ba73SBarry Smith static PetscErrorCode (*othersetfromoptions[MAXSETFROMOPTIONS])(SNES);
21776b2cf59SMatthew Knepley 
218e74ef692SMatthew Knepley #undef __FUNCT__
219e74ef692SMatthew Knepley #define __FUNCT__ "SNESAddOptionsChecker"
220ac226902SBarry Smith /*@C
22176b2cf59SMatthew Knepley   SNESAddOptionsChecker - Adds an additional function to check for SNES options.
22276b2cf59SMatthew Knepley 
22376b2cf59SMatthew Knepley   Not Collective
22476b2cf59SMatthew Knepley 
22576b2cf59SMatthew Knepley   Input Parameter:
22676b2cf59SMatthew Knepley . snescheck - function that checks for options
22776b2cf59SMatthew Knepley 
22876b2cf59SMatthew Knepley   Level: developer
22976b2cf59SMatthew Knepley 
23076b2cf59SMatthew Knepley .seealso: SNESSetFromOptions()
23176b2cf59SMatthew Knepley @*/
2327087cfbeSBarry Smith PetscErrorCode  SNESAddOptionsChecker(PetscErrorCode (*snescheck)(SNES))
23376b2cf59SMatthew Knepley {
23476b2cf59SMatthew Knepley   PetscFunctionBegin;
23576b2cf59SMatthew Knepley   if (numberofsetfromoptions >= MAXSETFROMOPTIONS) {
236e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "Too many options checkers, only %D allowed", MAXSETFROMOPTIONS);
23776b2cf59SMatthew Knepley   }
23876b2cf59SMatthew Knepley   othersetfromoptions[numberofsetfromoptions++] = snescheck;
23976b2cf59SMatthew Knepley   PetscFunctionReturn(0);
24076b2cf59SMatthew Knepley }
24176b2cf59SMatthew Knepley 
2427087cfbeSBarry Smith extern PetscErrorCode  SNESDefaultMatrixFreeCreate2(SNES,Vec,Mat*);
243aa3661deSLisandro Dalcin 
244aa3661deSLisandro Dalcin #undef __FUNCT__
245aa3661deSLisandro Dalcin #define __FUNCT__ "SNESSetUpMatrixFree_Private"
246ace3abfcSBarry Smith static PetscErrorCode SNESSetUpMatrixFree_Private(SNES snes, PetscBool  hasOperator, PetscInt version)
247aa3661deSLisandro Dalcin {
248aa3661deSLisandro Dalcin   Mat            J;
249aa3661deSLisandro Dalcin   KSP            ksp;
250aa3661deSLisandro Dalcin   PC             pc;
251ace3abfcSBarry Smith   PetscBool      match;
252aa3661deSLisandro Dalcin   PetscErrorCode ierr;
253aa3661deSLisandro Dalcin 
254aa3661deSLisandro Dalcin   PetscFunctionBegin;
2550700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
256aa3661deSLisandro Dalcin 
25798613b67SLisandro Dalcin   if(!snes->vec_func && (snes->jacobian || snes->jacobian_pre)) {
25898613b67SLisandro Dalcin     Mat A = snes->jacobian, B = snes->jacobian_pre;
25998613b67SLisandro Dalcin     ierr = MatGetVecs(A ? A : B, PETSC_NULL,&snes->vec_func);CHKERRQ(ierr);
26098613b67SLisandro Dalcin   }
26198613b67SLisandro Dalcin 
262aa3661deSLisandro Dalcin   if (version == 1) {
263aa3661deSLisandro Dalcin     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
26498613b67SLisandro Dalcin     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
2659c6ac3b3SBarry Smith     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
266aa3661deSLisandro Dalcin   } else if (version == 2) {
267e32f2f54SBarry Smith     if (!snes->vec_func) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"SNESSetFunction() must be called first");
26882a7e548SBarry Smith #if !defined(PETSC_USE_COMPLEX) && !defined(PETSC_USE_REAL_SINGLE) && !defined(PETSC_USE_REAL___FLOAT128)
269aa3661deSLisandro Dalcin     ierr = SNESDefaultMatrixFreeCreate2(snes,snes->vec_func,&J);CHKERRQ(ierr);
270aa3661deSLisandro Dalcin #else
271e32f2f54SBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP, "matrix-free operator rutines (version 2)");
272aa3661deSLisandro Dalcin #endif
273a8248277SBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "matrix-free operator rutines, only version 1 and 2");
274aa3661deSLisandro Dalcin 
275aa3661deSLisandro Dalcin   ierr = PetscInfo1(snes,"Setting default matrix-free operator routines (version %D)\n", version);CHKERRQ(ierr);
276d3462f78SMatthew Knepley   if (hasOperator) {
277aa3661deSLisandro Dalcin     /* This version replaces the user provided Jacobian matrix with a
278aa3661deSLisandro Dalcin        matrix-free version but still employs the user-provided preconditioner matrix. */
279aa3661deSLisandro Dalcin     ierr = SNESSetJacobian(snes,J,0,0,0);CHKERRQ(ierr);
280aa3661deSLisandro Dalcin   } else {
281aa3661deSLisandro Dalcin     /* This version replaces both the user-provided Jacobian and the user-
282aa3661deSLisandro Dalcin        provided preconditioner matrix with the default matrix free version. */
283aa3661deSLisandro Dalcin     ierr = SNESSetJacobian(snes,J,J,MatMFFDComputeJacobian,snes->funP);CHKERRQ(ierr);
284aa3661deSLisandro Dalcin     /* Force no preconditioner */
285aa3661deSLisandro Dalcin     ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
286aa3661deSLisandro Dalcin     ierr = KSPGetPC(ksp,&pc);CHKERRQ(ierr);
287aa3661deSLisandro Dalcin     ierr = PetscTypeCompare((PetscObject)pc,PCSHELL,&match);CHKERRQ(ierr);
288aa3661deSLisandro Dalcin     if (!match) {
289aa3661deSLisandro Dalcin       ierr = PetscInfo(snes,"Setting default matrix-free preconditioner routines\nThat is no preconditioner is being used\n");CHKERRQ(ierr);
290aa3661deSLisandro Dalcin       ierr = PCSetType(pc,PCNONE);CHKERRQ(ierr);
291aa3661deSLisandro Dalcin     }
292aa3661deSLisandro Dalcin   }
2936bf464f9SBarry Smith   ierr = MatDestroy(&J);CHKERRQ(ierr);
294aa3661deSLisandro Dalcin   PetscFunctionReturn(0);
295aa3661deSLisandro Dalcin }
296aa3661deSLisandro Dalcin 
2974a2ae208SSatish Balay #undef __FUNCT__
2984a2ae208SSatish Balay #define __FUNCT__ "SNESSetFromOptions"
2999b94acceSBarry Smith /*@
30094b7f48cSBarry Smith    SNESSetFromOptions - Sets various SNES and KSP parameters from user options.
3019b94acceSBarry Smith 
302c7afd0dbSLois Curfman McInnes    Collective on SNES
303c7afd0dbSLois Curfman McInnes 
3049b94acceSBarry Smith    Input Parameter:
3059b94acceSBarry Smith .  snes - the SNES context
3069b94acceSBarry Smith 
30736851e7fSLois Curfman McInnes    Options Database Keys:
308ea630c6eSPeter Brune +  -snes_type <type> - ls, tr, ngmres, ncg, richardson, qn, vi, fas
30982738288SBarry Smith .  -snes_stol - convergence tolerance in terms of the norm
31082738288SBarry Smith                 of the change in the solution between steps
31170441072SBarry Smith .  -snes_atol <abstol> - absolute tolerance of residual norm
312b39c3a46SLois Curfman McInnes .  -snes_rtol <rtol> - relative decrease in tolerance norm from initial
313b39c3a46SLois Curfman McInnes .  -snes_max_it <max_it> - maximum number of iterations
314b39c3a46SLois Curfman McInnes .  -snes_max_funcs <max_funcs> - maximum number of function evaluations
31550ffb88aSMatthew Knepley .  -snes_max_fail <max_fail> - maximum number of failures
316ddf469c8SBarry Smith .  -snes_max_linear_solve_fail - number of linear solver failures before SNESSolve() stops
317a8054027SBarry Smith .  -snes_lag_preconditioner <lag> - how often preconditioner is rebuilt (use -1 to never rebuild)
318e35cf81dSBarry Smith .  -snes_lag_jacobian <lag> - how often Jacobian is rebuilt (use -1 to never rebuild)
319b39c3a46SLois Curfman McInnes .  -snes_trtol <trtol> - trust region tolerance
3202492ecdbSBarry Smith .  -snes_no_convergence_test - skip convergence test in nonlinear
32182738288SBarry Smith                                solver; hence iterations will continue until max_it
3221fbbfb26SLois Curfman McInnes                                or some other criterion is reached. Saves expense
32382738288SBarry Smith                                of convergence test
324e8105e01SRichard Katz .  -snes_monitor <optional filename> - prints residual norm at each iteration. if no
325e8105e01SRichard Katz                                        filename given prints to stdout
326a6570f20SBarry Smith .  -snes_monitor_solution - plots solution at each iteration
327a6570f20SBarry Smith .  -snes_monitor_residual - plots residual (not its norm) at each iteration
328a6570f20SBarry Smith .  -snes_monitor_solution_update - plots update to solution at each iteration
329a6570f20SBarry Smith .  -snes_monitor_draw - plots residual norm at each iteration
330e24b481bSBarry Smith .  -snes_fd - use finite differences to compute Jacobian; very slow, only for testing
3315968eb51SBarry Smith .  -snes_mf_ksp_monitor - if using matrix-free multiply then print h at each KSP iteration
332fee2055bSBarry Smith -  -snes_converged_reason - print the reason for convergence/divergence after each solve
33382738288SBarry Smith 
33482738288SBarry Smith     Options Database for Eisenstat-Walker method:
335fa9f3622SBarry Smith +  -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence
3364b27c08aSLois Curfman McInnes .  -snes_ksp_ew_version ver - version of  Eisenstat-Walker method
33736851e7fSLois Curfman McInnes .  -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0
33836851e7fSLois Curfman McInnes .  -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax
33936851e7fSLois Curfman McInnes .  -snes_ksp_ew_gamma <gamma> - Sets gamma
34036851e7fSLois Curfman McInnes .  -snes_ksp_ew_alpha <alpha> - Sets alpha
34136851e7fSLois Curfman McInnes .  -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2
34236851e7fSLois Curfman McInnes -  -snes_ksp_ew_threshold <threshold> - Sets threshold
34382738288SBarry Smith 
34411ca99fdSLois Curfman McInnes    Notes:
34511ca99fdSLois Curfman McInnes    To see all options, run your program with the -help option or consult
3460598bfebSBarry Smith    the <A href="../../docs/manual.pdf#nameddest=ch_snes">SNES chapter of the users manual</A>.
34783e2fdc7SBarry Smith 
34836851e7fSLois Curfman McInnes    Level: beginner
34936851e7fSLois Curfman McInnes 
3509b94acceSBarry Smith .keywords: SNES, nonlinear, set, options, database
3519b94acceSBarry Smith 
35269ed319cSSatish Balay .seealso: SNESSetOptionsPrefix()
3539b94acceSBarry Smith @*/
3547087cfbeSBarry Smith PetscErrorCode  SNESSetFromOptions(SNES snes)
3559b94acceSBarry Smith {
356ea630c6eSPeter Brune   PetscBool               flg,set,mf,mf_operator,pcset;
357efd51863SBarry Smith   PetscInt                i,indx,lag,mf_version,grids;
358aa3661deSLisandro Dalcin   MatStructure            matflag;
35985385478SLisandro Dalcin   const char              *deft = SNESLS;
36085385478SLisandro Dalcin   const char              *convtests[] = {"default","skip"};
36185385478SLisandro Dalcin   SNESKSPEW               *kctx = NULL;
362e8105e01SRichard Katz   char                    type[256], monfilename[PETSC_MAX_PATH_LEN];
36351e86f29SPeter Brune   const char              *optionsprefix;
364649052a6SBarry Smith   PetscViewer             monviewer;
36585385478SLisandro Dalcin   PetscErrorCode          ierr;
3669b94acceSBarry Smith 
3673a40ed3dSBarry Smith   PetscFunctionBegin;
3680700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
369ca161407SBarry Smith 
370186905e3SBarry Smith   if (!SNESRegisterAllCalled) {ierr = SNESRegisterAll(PETSC_NULL);CHKERRQ(ierr);}
3713194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)snes);CHKERRQ(ierr);
3727adad957SLisandro Dalcin     if (((PetscObject)snes)->type_name) { deft = ((PetscObject)snes)->type_name; }
373b0a32e0cSBarry Smith     ierr = PetscOptionsList("-snes_type","Nonlinear solver method","SNESSetType",SNESList,deft,type,256,&flg);CHKERRQ(ierr);
374d64ed03dSBarry Smith     if (flg) {
375186905e3SBarry Smith       ierr = SNESSetType(snes,type);CHKERRQ(ierr);
3767adad957SLisandro Dalcin     } else if (!((PetscObject)snes)->type_name) {
377186905e3SBarry Smith       ierr = SNESSetType(snes,deft);CHKERRQ(ierr);
378d64ed03dSBarry Smith     }
37990d69ab7SBarry Smith     /* not used here, but called so will go into help messaage */
380909c8a9fSBarry Smith     ierr = PetscOptionsName("-snes_view","Print detailed information on solver used","SNESView",0);CHKERRQ(ierr);
38193c39befSBarry Smith 
38257034d6fSHong Zhang     ierr = PetscOptionsReal("-snes_stol","Stop if step length less than","SNESSetTolerances",snes->xtol,&snes->xtol,0);CHKERRQ(ierr);
38357034d6fSHong Zhang     ierr = PetscOptionsReal("-snes_atol","Stop if function norm less than","SNESSetTolerances",snes->abstol,&snes->abstol,0);CHKERRQ(ierr);
384186905e3SBarry Smith 
38557034d6fSHong Zhang     ierr = PetscOptionsReal("-snes_rtol","Stop if decrease in function norm less than","SNESSetTolerances",snes->rtol,&snes->rtol,0);CHKERRQ(ierr);
386b0a32e0cSBarry Smith     ierr = PetscOptionsInt("-snes_max_it","Maximum iterations","SNESSetTolerances",snes->max_its,&snes->max_its,PETSC_NULL);CHKERRQ(ierr);
387b0a32e0cSBarry Smith     ierr = PetscOptionsInt("-snes_max_funcs","Maximum function evaluations","SNESSetTolerances",snes->max_funcs,&snes->max_funcs,PETSC_NULL);CHKERRQ(ierr);
38850ffb88aSMatthew Knepley     ierr = PetscOptionsInt("-snes_max_fail","Maximum failures","SNESSetTolerances",snes->maxFailures,&snes->maxFailures,PETSC_NULL);CHKERRQ(ierr);
389ddf469c8SBarry Smith     ierr = PetscOptionsInt("-snes_max_linear_solve_fail","Maximum failures in linear solves allowed","SNESSetMaxLinearSolveFailures",snes->maxLinearSolveFailures,&snes->maxLinearSolveFailures,PETSC_NULL);CHKERRQ(ierr);
390acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_error_if_not_converged","Generate error if solver does not converge","SNESSetErrorIfNotConverged",snes->errorifnotconverged,&snes->errorifnotconverged,PETSC_NULL);CHKERRQ(ierr);
39185385478SLisandro Dalcin 
392a8054027SBarry Smith     ierr = PetscOptionsInt("-snes_lag_preconditioner","How often to rebuild preconditioner","SNESSetLagPreconditioner",snes->lagpreconditioner,&lag,&flg);CHKERRQ(ierr);
393a8054027SBarry Smith     if (flg) {
394a8054027SBarry Smith       ierr = SNESSetLagPreconditioner(snes,lag);CHKERRQ(ierr);
395a8054027SBarry Smith     }
396e35cf81dSBarry Smith     ierr = PetscOptionsInt("-snes_lag_jacobian","How often to rebuild Jacobian","SNESSetLagJacobian",snes->lagjacobian,&lag,&flg);CHKERRQ(ierr);
397e35cf81dSBarry Smith     if (flg) {
398e35cf81dSBarry Smith       ierr = SNESSetLagJacobian(snes,lag);CHKERRQ(ierr);
399e35cf81dSBarry Smith     }
400efd51863SBarry Smith     ierr = PetscOptionsInt("-snes_grid_sequence","Use grid sequencing to generate initial guess","SNESSetGridSequence",snes->gridsequence,&grids,&flg);CHKERRQ(ierr);
401efd51863SBarry Smith     if (flg) {
402efd51863SBarry Smith       ierr = SNESSetGridSequence(snes,grids);CHKERRQ(ierr);
403efd51863SBarry Smith     }
404a8054027SBarry Smith 
40585385478SLisandro Dalcin     ierr = PetscOptionsEList("-snes_convergence_test","Convergence test","SNESSetConvergenceTest",convtests,2,"default",&indx,&flg);CHKERRQ(ierr);
40685385478SLisandro Dalcin     if (flg) {
40785385478SLisandro Dalcin       switch (indx) {
4087f7931b9SBarry Smith       case 0: ierr = SNESSetConvergenceTest(snes,SNESDefaultConverged,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); break;
4097f7931b9SBarry Smith       case 1: ierr = SNESSetConvergenceTest(snes,SNESSkipConverged,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);    break;
41085385478SLisandro Dalcin       }
41185385478SLisandro Dalcin     }
41285385478SLisandro Dalcin 
413acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_converged_reason","Print reason for converged or diverged","SNESSolve",snes->printreason,&snes->printreason,PETSC_NULL);CHKERRQ(ierr);
414186905e3SBarry Smith 
41585385478SLisandro Dalcin     kctx = (SNESKSPEW *)snes->kspconvctx;
41685385478SLisandro Dalcin 
417acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_ksp_ew","Use Eisentat-Walker linear system convergence test","SNESKSPSetUseEW",snes->ksp_ewconv,&snes->ksp_ewconv,PETSC_NULL);CHKERRQ(ierr);
418186905e3SBarry Smith 
419fa9f3622SBarry Smith     ierr = PetscOptionsInt("-snes_ksp_ew_version","Version 1, 2 or 3","SNESKSPSetParametersEW",kctx->version,&kctx->version,0);CHKERRQ(ierr);
420fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_rtol0","0 <= rtol0 < 1","SNESKSPSetParametersEW",kctx->rtol_0,&kctx->rtol_0,0);CHKERRQ(ierr);
421fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_rtolmax","0 <= rtolmax < 1","SNESKSPSetParametersEW",kctx->rtol_max,&kctx->rtol_max,0);CHKERRQ(ierr);
422fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_gamma","0 <= gamma <= 1","SNESKSPSetParametersEW",kctx->gamma,&kctx->gamma,0);CHKERRQ(ierr);
423fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_alpha","1 < alpha <= 2","SNESKSPSetParametersEW",kctx->alpha,&kctx->alpha,0);CHKERRQ(ierr);
424fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_alpha2","alpha2","SNESKSPSetParametersEW",kctx->alpha2,&kctx->alpha2,0);CHKERRQ(ierr);
425fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_threshold","0 < threshold < 1","SNESKSPSetParametersEW",kctx->threshold,&kctx->threshold,0);CHKERRQ(ierr);
426186905e3SBarry Smith 
42790d69ab7SBarry Smith     flg  = PETSC_FALSE;
428acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_cancel","Remove all monitors","SNESMonitorCancel",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
429a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorCancel(snes);CHKERRQ(ierr);}
430eabae89aSBarry Smith 
431a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_monitor","Monitor norm of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
432e8105e01SRichard Katz     if (flg) {
433649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
434649052a6SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
435e8105e01SRichard Katz     }
436eabae89aSBarry Smith 
437b271bb04SBarry Smith     ierr = PetscOptionsString("-snes_monitor_range","Monitor range of elements of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
438b271bb04SBarry Smith     if (flg) {
439b271bb04SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorRange,0,0);CHKERRQ(ierr);
440b271bb04SBarry Smith     }
441b271bb04SBarry Smith 
442a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_ratiomonitor","Monitor ratios of norms of function","SNESMonitorSetRatio","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
443eabae89aSBarry Smith     if (flg) {
444649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
445f1bef1bcSMatthew Knepley       ierr = SNESMonitorSetRatio(snes,monviewer);CHKERRQ(ierr);
446e8105e01SRichard Katz     }
447eabae89aSBarry Smith 
448a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_monitor_short","Monitor norm of function (fewer digits)","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
449eabae89aSBarry Smith     if (flg) {
450649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
451649052a6SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorDefaultShort,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
452eabae89aSBarry Smith     }
453eabae89aSBarry Smith 
4545180491cSLisandro Dalcin     ierr = PetscOptionsString("-snes_monitor_python","Use Python function","SNESMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
4555180491cSLisandro Dalcin     if (flg) {ierr = PetscPythonMonitorSet((PetscObject)snes,monfilename);CHKERRQ(ierr);}
4565180491cSLisandro Dalcin 
45790d69ab7SBarry Smith     flg  = PETSC_FALSE;
458acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_solution","Plot solution at each iteration","SNESMonitorSolution",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
459a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolution,0,0);CHKERRQ(ierr);}
46090d69ab7SBarry Smith     flg  = PETSC_FALSE;
461acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_solution_update","Plot correction at each iteration","SNESMonitorSolutionUpdate",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
462a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolutionUpdate,0,0);CHKERRQ(ierr);}
46390d69ab7SBarry Smith     flg  = PETSC_FALSE;
464acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_residual","Plot residual at each iteration","SNESMonitorResidual",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
465a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorResidual,0,0);CHKERRQ(ierr);}
46690d69ab7SBarry Smith     flg  = PETSC_FALSE;
467acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_draw","Plot function norm at each iteration","SNESMonitorLG",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
468a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorLG,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);}
46990d69ab7SBarry Smith     flg  = PETSC_FALSE;
470acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_range_draw","Plot function range at each iteration","SNESMonitorLG",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
471b271bb04SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorLGRange,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);}
472e24b481bSBarry Smith 
47390d69ab7SBarry Smith     flg  = PETSC_FALSE;
474acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_fd","Use finite differences (slow) to compute Jacobian","SNESDefaultComputeJacobian",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
4754b27c08aSLois Curfman McInnes     if (flg) {
476186905e3SBarry Smith       ierr = SNESSetJacobian(snes,snes->jacobian,snes->jacobian_pre,SNESDefaultComputeJacobian,snes->funP);CHKERRQ(ierr);
477ae15b995SBarry Smith       ierr = PetscInfo(snes,"Setting default finite difference Jacobian matrix\n");CHKERRQ(ierr);
4789b94acceSBarry Smith     }
479639f9d9dSBarry Smith 
480aa3661deSLisandro Dalcin     mf = mf_operator = PETSC_FALSE;
481aa3661deSLisandro Dalcin     flg = PETSC_FALSE;
482acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_mf_operator","Use a Matrix-Free Jacobian with user-provided preconditioner matrix","MatCreateSNESMF",PETSC_FALSE,&mf_operator,&flg);CHKERRQ(ierr);
483a8248277SBarry Smith     if (flg && mf_operator) {
484a8248277SBarry Smith       snes->mf_operator = PETSC_TRUE;
485a8248277SBarry Smith       mf = PETSC_TRUE;
486a8248277SBarry Smith     }
487aa3661deSLisandro Dalcin     flg = PETSC_FALSE;
488acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_mf","Use a Matrix-Free Jacobian with no preconditioner matrix","MatCreateSNESMF",PETSC_FALSE,&mf,&flg);CHKERRQ(ierr);
489aa3661deSLisandro Dalcin     if (!flg && mf_operator) mf = PETSC_TRUE;
490aa3661deSLisandro Dalcin     mf_version = 1;
491aa3661deSLisandro Dalcin     ierr = PetscOptionsInt("-snes_mf_version","Matrix-Free routines version 1 or 2","None",mf_version,&mf_version,0);CHKERRQ(ierr);
492aa3661deSLisandro Dalcin 
493ea630c6eSPeter Brune     /* line search options */
494ea630c6eSPeter Brune     ierr = PetscOptionsReal("-snes_ls_alpha","Constant function norm must decrease by","None",snes->ls_alpha,&snes->ls_alpha,0);CHKERRQ(ierr);
495ea630c6eSPeter Brune     ierr = PetscOptionsReal("-snes_ls_maxstep","Step must be less than","None",snes->maxstep,&snes->maxstep,0);CHKERRQ(ierr);
496ea630c6eSPeter Brune     ierr = PetscOptionsReal("-snes_ls_steptol","Minimum lambda allowed","None",snes->steptol,&snes->steptol,0);CHKERRQ(ierr);
497ea630c6eSPeter Brune     ierr = PetscOptionsReal("-snes_ls_damping","Damping parameter","SNES",snes->damping,&snes->damping,&flg);CHKERRQ(ierr);
498*af60355fSPeter Brune     ierr = PetscOptionsInt("-snes_ls_it"      ,"Line search iterations","SNES",snes->ls_its,&snes->ls_its,&flg);CHKERRQ(ierr);
499ea630c6eSPeter Brune     ierr = PetscOptionsBool("-snes_ls_monitor","Print progress of line searches","SNESLineSearchSetMonitor",snes->ls_monitor ? PETSC_TRUE : PETSC_FALSE,&flg,&set);CHKERRQ(ierr);
500ea630c6eSPeter Brune     if (set) {ierr = SNESLineSearchSetMonitor(snes,flg);CHKERRQ(ierr);}
50115f5eeeaSPeter Brune     ierr = PetscOptionsEnum("-snes_ls","Line search used","SNESLineSearchSet",SNESLineSearchTypes,(PetscEnum)snes->ls_type,(PetscEnum*)&indx,&flg);CHKERRQ(ierr);
50215f5eeeaSPeter Brune     if (flg) {
503ea630c6eSPeter Brune       ierr = SNESLineSearchSetType(snes,(SNESLineSearchType)indx);CHKERRQ(ierr);
50415f5eeeaSPeter Brune     }
5058e3fc8c0SJed Brown     flg = snes->ops->precheckstep == SNESLineSearchPreCheckPicard ? PETSC_TRUE : PETSC_FALSE;
5068e3fc8c0SJed Brown     ierr = PetscOptionsBool("-snes_ls_precheck_picard","Use a correction that sometimes improves convergence of Picard iteration","SNESLineSearchPreCheckPicard",flg,&flg,&set);CHKERRQ(ierr);
5078e3fc8c0SJed Brown     if (set) {
5088e3fc8c0SJed Brown       if (flg) {
5098e3fc8c0SJed Brown         snes->precheck_picard_angle = 10.; /* correction only active if angle is less than 10 degrees */
5108e3fc8c0SJed Brown         ierr = PetscOptionsReal("-snes_ls_precheck_picard_angle","Maximum angle at which to activate the correction","none",snes->precheck_picard_angle,&snes->precheck_picard_angle,PETSC_NULL);CHKERRQ(ierr);
5118e3fc8c0SJed Brown         ierr = SNESLineSearchSetPreCheck(snes,SNESLineSearchPreCheckPicard,&snes->precheck_picard_angle);CHKERRQ(ierr);
5128e3fc8c0SJed Brown       } else {
5138e3fc8c0SJed Brown         ierr = SNESLineSearchSetPreCheck(snes,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
5148e3fc8c0SJed Brown       }
5158e3fc8c0SJed Brown     }
5168e3fc8c0SJed Brown 
51776b2cf59SMatthew Knepley     for(i = 0; i < numberofsetfromoptions; i++) {
51876b2cf59SMatthew Knepley       ierr = (*othersetfromoptions[i])(snes);CHKERRQ(ierr);
51976b2cf59SMatthew Knepley     }
52076b2cf59SMatthew Knepley 
521e7788613SBarry Smith     if (snes->ops->setfromoptions) {
522e7788613SBarry Smith       ierr = (*snes->ops->setfromoptions)(snes);CHKERRQ(ierr);
523639f9d9dSBarry Smith     }
5245d973c19SBarry Smith 
5255d973c19SBarry Smith     /* process any options handlers added with PetscObjectAddOptionsHandler() */
5265d973c19SBarry Smith     ierr = PetscObjectProcessOptionsHandlers((PetscObject)snes);CHKERRQ(ierr);
527b0a32e0cSBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
5284bbc92c1SBarry Smith 
529aa3661deSLisandro Dalcin   if (mf) { ierr = SNESSetUpMatrixFree_Private(snes, mf_operator, mf_version);CHKERRQ(ierr); }
5301cee3971SBarry Smith 
5311cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
532aa3661deSLisandro Dalcin   ierr = KSPGetOperators(snes->ksp,PETSC_NULL,PETSC_NULL,&matflag);
533aa3661deSLisandro Dalcin   ierr = KSPSetOperators(snes->ksp,snes->jacobian,snes->jacobian_pre,matflag);CHKERRQ(ierr);
53485385478SLisandro Dalcin   ierr = KSPSetFromOptions(snes->ksp);CHKERRQ(ierr);
53593993e2dSLois Curfman McInnes 
53651e86f29SPeter Brune   /* if someone has set the SNES PC type, create it. */
53751e86f29SPeter Brune   ierr = SNESGetOptionsPrefix(snes, &optionsprefix);CHKERRQ(ierr);
53851e86f29SPeter Brune   ierr = PetscOptionsHasName(optionsprefix, "-npc_snes_type", &pcset);CHKERRQ(ierr);
53951e86f29SPeter Brune   if (pcset && (!snes->pc)) {
54051e86f29SPeter Brune     ierr = SNESGetPC(snes, &snes->pc);CHKERRQ(ierr);
54151e86f29SPeter Brune   }
54251e86f29SPeter Brune 
5434a0c5b0cSMatthew G Knepley   if (snes->pc) {
5444a0c5b0cSMatthew G Knepley     ierr = SNESSetOptionsPrefix(snes->pc, "npc_");CHKERRQ(ierr);
5454a0c5b0cSMatthew G Knepley     ierr = SNESSetDM(snes->pc, snes->dm);CHKERRQ(ierr);
5464a0c5b0cSMatthew G Knepley     /* Should we make a duplicate vector and matrix? Leave the DM to make it? */
5474a0c5b0cSMatthew G Knepley     ierr = SNESSetFunction(snes->pc, snes->vec_func, snes->ops->computefunction, snes->funP);CHKERRQ(ierr);
5484a0c5b0cSMatthew G Knepley     ierr = SNESSetJacobian(snes->pc, snes->jacobian, snes->jacobian_pre, snes->ops->computejacobian, snes->jacP);CHKERRQ(ierr);
5494a0c5b0cSMatthew G Knepley     ierr = SNESSetFromOptions(snes->pc);CHKERRQ(ierr);
5504a0c5b0cSMatthew G Knepley   }
5513a40ed3dSBarry Smith   PetscFunctionReturn(0);
5529b94acceSBarry Smith }
5539b94acceSBarry Smith 
554d25893d9SBarry Smith #undef __FUNCT__
555d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeApplicationContext"
556d25893d9SBarry Smith /*@
557d25893d9SBarry Smith    SNESSetComputeApplicationContext - Sets an optional function to compute a user-defined context for
558d25893d9SBarry Smith    the nonlinear solvers.
559d25893d9SBarry Smith 
560d25893d9SBarry Smith    Logically Collective on SNES
561d25893d9SBarry Smith 
562d25893d9SBarry Smith    Input Parameters:
563d25893d9SBarry Smith +  snes - the SNES context
564d25893d9SBarry Smith .  compute - function to compute the context
565d25893d9SBarry Smith -  destroy - function to destroy the context
566d25893d9SBarry Smith 
567d25893d9SBarry Smith    Level: intermediate
568d25893d9SBarry Smith 
569d25893d9SBarry Smith .keywords: SNES, nonlinear, set, application, context
570d25893d9SBarry Smith 
571d25893d9SBarry Smith .seealso: SNESGetApplicationContext(), SNESSetComputeApplicationContext(), SNESGetApplicationContext()
572d25893d9SBarry Smith @*/
573d25893d9SBarry Smith PetscErrorCode  SNESSetComputeApplicationContext(SNES snes,PetscErrorCode (*compute)(SNES,void**),PetscErrorCode (*destroy)(void**))
574d25893d9SBarry Smith {
575d25893d9SBarry Smith   PetscFunctionBegin;
576d25893d9SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
577d25893d9SBarry Smith   snes->ops->usercompute = compute;
578d25893d9SBarry Smith   snes->ops->userdestroy = destroy;
579d25893d9SBarry Smith   PetscFunctionReturn(0);
580d25893d9SBarry Smith }
581a847f771SSatish Balay 
5824a2ae208SSatish Balay #undef __FUNCT__
5834a2ae208SSatish Balay #define __FUNCT__ "SNESSetApplicationContext"
584b07ff414SBarry Smith /*@
5859b94acceSBarry Smith    SNESSetApplicationContext - Sets the optional user-defined context for
5869b94acceSBarry Smith    the nonlinear solvers.
5879b94acceSBarry Smith 
5883f9fe445SBarry Smith    Logically Collective on SNES
589fee21e36SBarry Smith 
590c7afd0dbSLois Curfman McInnes    Input Parameters:
591c7afd0dbSLois Curfman McInnes +  snes - the SNES context
592c7afd0dbSLois Curfman McInnes -  usrP - optional user context
593c7afd0dbSLois Curfman McInnes 
59436851e7fSLois Curfman McInnes    Level: intermediate
59536851e7fSLois Curfman McInnes 
5969b94acceSBarry Smith .keywords: SNES, nonlinear, set, application, context
5979b94acceSBarry Smith 
598d25893d9SBarry Smith .seealso: SNESGetApplicationContext(), SNESSetApplicationContext()
5999b94acceSBarry Smith @*/
6007087cfbeSBarry Smith PetscErrorCode  SNESSetApplicationContext(SNES snes,void *usrP)
6019b94acceSBarry Smith {
6021b2093e4SBarry Smith   PetscErrorCode ierr;
603b07ff414SBarry Smith   KSP            ksp;
6041b2093e4SBarry Smith 
6053a40ed3dSBarry Smith   PetscFunctionBegin;
6060700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
607b07ff414SBarry Smith   ierr       = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
608b07ff414SBarry Smith   ierr       = KSPSetApplicationContext(ksp,usrP);CHKERRQ(ierr);
6099b94acceSBarry Smith   snes->user = usrP;
6103a40ed3dSBarry Smith   PetscFunctionReturn(0);
6119b94acceSBarry Smith }
61274679c65SBarry Smith 
6134a2ae208SSatish Balay #undef __FUNCT__
6144a2ae208SSatish Balay #define __FUNCT__ "SNESGetApplicationContext"
615b07ff414SBarry Smith /*@
6169b94acceSBarry Smith    SNESGetApplicationContext - Gets the user-defined context for the
6179b94acceSBarry Smith    nonlinear solvers.
6189b94acceSBarry Smith 
619c7afd0dbSLois Curfman McInnes    Not Collective
620c7afd0dbSLois Curfman McInnes 
6219b94acceSBarry Smith    Input Parameter:
6229b94acceSBarry Smith .  snes - SNES context
6239b94acceSBarry Smith 
6249b94acceSBarry Smith    Output Parameter:
6259b94acceSBarry Smith .  usrP - user context
6269b94acceSBarry Smith 
62736851e7fSLois Curfman McInnes    Level: intermediate
62836851e7fSLois Curfman McInnes 
6299b94acceSBarry Smith .keywords: SNES, nonlinear, get, application, context
6309b94acceSBarry Smith 
6319b94acceSBarry Smith .seealso: SNESSetApplicationContext()
6329b94acceSBarry Smith @*/
633e71120c6SJed Brown PetscErrorCode  SNESGetApplicationContext(SNES snes,void *usrP)
6349b94acceSBarry Smith {
6353a40ed3dSBarry Smith   PetscFunctionBegin;
6360700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
637e71120c6SJed Brown   *(void**)usrP = snes->user;
6383a40ed3dSBarry Smith   PetscFunctionReturn(0);
6399b94acceSBarry Smith }
64074679c65SBarry Smith 
6414a2ae208SSatish Balay #undef __FUNCT__
6424a2ae208SSatish Balay #define __FUNCT__ "SNESGetIterationNumber"
6439b94acceSBarry Smith /*@
644c8228a4eSBarry Smith    SNESGetIterationNumber - Gets the number of nonlinear iterations completed
645c8228a4eSBarry Smith    at this time.
6469b94acceSBarry Smith 
647c7afd0dbSLois Curfman McInnes    Not Collective
648c7afd0dbSLois Curfman McInnes 
6499b94acceSBarry Smith    Input Parameter:
6509b94acceSBarry Smith .  snes - SNES context
6519b94acceSBarry Smith 
6529b94acceSBarry Smith    Output Parameter:
6539b94acceSBarry Smith .  iter - iteration number
6549b94acceSBarry Smith 
655c8228a4eSBarry Smith    Notes:
656c8228a4eSBarry Smith    For example, during the computation of iteration 2 this would return 1.
657c8228a4eSBarry Smith 
658c8228a4eSBarry Smith    This is useful for using lagged Jacobians (where one does not recompute the
65908405cd6SLois Curfman McInnes    Jacobian at each SNES iteration). For example, the code
66008405cd6SLois Curfman McInnes .vb
66108405cd6SLois Curfman McInnes       ierr = SNESGetIterationNumber(snes,&it);
66208405cd6SLois Curfman McInnes       if (!(it % 2)) {
66308405cd6SLois Curfman McInnes         [compute Jacobian here]
66408405cd6SLois Curfman McInnes       }
66508405cd6SLois Curfman McInnes .ve
666c8228a4eSBarry Smith    can be used in your ComputeJacobian() function to cause the Jacobian to be
66708405cd6SLois Curfman McInnes    recomputed every second SNES iteration.
668c8228a4eSBarry Smith 
66936851e7fSLois Curfman McInnes    Level: intermediate
67036851e7fSLois Curfman McInnes 
6712b668275SBarry Smith .keywords: SNES, nonlinear, get, iteration, number,
6722b668275SBarry Smith 
673b850b91aSLisandro Dalcin .seealso:   SNESGetFunctionNorm(), SNESGetLinearSolveIterations()
6749b94acceSBarry Smith @*/
6757087cfbeSBarry Smith PetscErrorCode  SNESGetIterationNumber(SNES snes,PetscInt* iter)
6769b94acceSBarry Smith {
6773a40ed3dSBarry Smith   PetscFunctionBegin;
6780700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
6794482741eSBarry Smith   PetscValidIntPointer(iter,2);
6809b94acceSBarry Smith   *iter = snes->iter;
6813a40ed3dSBarry Smith   PetscFunctionReturn(0);
6829b94acceSBarry Smith }
68374679c65SBarry Smith 
6844a2ae208SSatish Balay #undef __FUNCT__
6854a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunctionNorm"
6869b94acceSBarry Smith /*@
6879b94acceSBarry Smith    SNESGetFunctionNorm - Gets the norm of the current function that was set
6889b94acceSBarry Smith    with SNESSSetFunction().
6899b94acceSBarry Smith 
690c7afd0dbSLois Curfman McInnes    Collective on SNES
691c7afd0dbSLois Curfman McInnes 
6929b94acceSBarry Smith    Input Parameter:
6939b94acceSBarry Smith .  snes - SNES context
6949b94acceSBarry Smith 
6959b94acceSBarry Smith    Output Parameter:
6969b94acceSBarry Smith .  fnorm - 2-norm of function
6979b94acceSBarry Smith 
69836851e7fSLois Curfman McInnes    Level: intermediate
69936851e7fSLois Curfman McInnes 
7009b94acceSBarry Smith .keywords: SNES, nonlinear, get, function, norm
701a86d99e1SLois Curfman McInnes 
702b850b91aSLisandro Dalcin .seealso: SNESGetFunction(), SNESGetIterationNumber(), SNESGetLinearSolveIterations()
7039b94acceSBarry Smith @*/
7047087cfbeSBarry Smith PetscErrorCode  SNESGetFunctionNorm(SNES snes,PetscReal *fnorm)
7059b94acceSBarry Smith {
7063a40ed3dSBarry Smith   PetscFunctionBegin;
7070700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
7084482741eSBarry Smith   PetscValidScalarPointer(fnorm,2);
7099b94acceSBarry Smith   *fnorm = snes->norm;
7103a40ed3dSBarry Smith   PetscFunctionReturn(0);
7119b94acceSBarry Smith }
71274679c65SBarry Smith 
7134a2ae208SSatish Balay #undef __FUNCT__
714b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetNonlinearStepFailures"
7159b94acceSBarry Smith /*@
716b850b91aSLisandro Dalcin    SNESGetNonlinearStepFailures - Gets the number of unsuccessful steps
7179b94acceSBarry Smith    attempted by the nonlinear solver.
7189b94acceSBarry Smith 
719c7afd0dbSLois Curfman McInnes    Not Collective
720c7afd0dbSLois Curfman McInnes 
7219b94acceSBarry Smith    Input Parameter:
7229b94acceSBarry Smith .  snes - SNES context
7239b94acceSBarry Smith 
7249b94acceSBarry Smith    Output Parameter:
7259b94acceSBarry Smith .  nfails - number of unsuccessful steps attempted
7269b94acceSBarry Smith 
727c96a6f78SLois Curfman McInnes    Notes:
728c96a6f78SLois Curfman McInnes    This counter is reset to zero for each successive call to SNESSolve().
729c96a6f78SLois Curfman McInnes 
73036851e7fSLois Curfman McInnes    Level: intermediate
73136851e7fSLois Curfman McInnes 
7329b94acceSBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps
73358ebbce7SBarry Smith 
734e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(),
73558ebbce7SBarry Smith           SNESSetMaxNonlinearStepFailures(), SNESGetMaxNonlinearStepFailures()
7369b94acceSBarry Smith @*/
7377087cfbeSBarry Smith PetscErrorCode  SNESGetNonlinearStepFailures(SNES snes,PetscInt* nfails)
7389b94acceSBarry Smith {
7393a40ed3dSBarry Smith   PetscFunctionBegin;
7400700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
7414482741eSBarry Smith   PetscValidIntPointer(nfails,2);
74250ffb88aSMatthew Knepley   *nfails = snes->numFailures;
74350ffb88aSMatthew Knepley   PetscFunctionReturn(0);
74450ffb88aSMatthew Knepley }
74550ffb88aSMatthew Knepley 
74650ffb88aSMatthew Knepley #undef __FUNCT__
747b850b91aSLisandro Dalcin #define __FUNCT__ "SNESSetMaxNonlinearStepFailures"
74850ffb88aSMatthew Knepley /*@
749b850b91aSLisandro Dalcin    SNESSetMaxNonlinearStepFailures - Sets the maximum number of unsuccessful steps
75050ffb88aSMatthew Knepley    attempted by the nonlinear solver before it gives up.
75150ffb88aSMatthew Knepley 
75250ffb88aSMatthew Knepley    Not Collective
75350ffb88aSMatthew Knepley 
75450ffb88aSMatthew Knepley    Input Parameters:
75550ffb88aSMatthew Knepley +  snes     - SNES context
75650ffb88aSMatthew Knepley -  maxFails - maximum of unsuccessful steps
75750ffb88aSMatthew Knepley 
75850ffb88aSMatthew Knepley    Level: intermediate
75950ffb88aSMatthew Knepley 
76050ffb88aSMatthew Knepley .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps
76158ebbce7SBarry Smith 
762e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(),
76358ebbce7SBarry Smith           SNESGetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures()
76450ffb88aSMatthew Knepley @*/
7657087cfbeSBarry Smith PetscErrorCode  SNESSetMaxNonlinearStepFailures(SNES snes, PetscInt maxFails)
76650ffb88aSMatthew Knepley {
76750ffb88aSMatthew Knepley   PetscFunctionBegin;
7680700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
76950ffb88aSMatthew Knepley   snes->maxFailures = maxFails;
77050ffb88aSMatthew Knepley   PetscFunctionReturn(0);
77150ffb88aSMatthew Knepley }
77250ffb88aSMatthew Knepley 
77350ffb88aSMatthew Knepley #undef __FUNCT__
774b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetMaxNonlinearStepFailures"
77550ffb88aSMatthew Knepley /*@
776b850b91aSLisandro Dalcin    SNESGetMaxNonlinearStepFailures - Gets the maximum number of unsuccessful steps
77750ffb88aSMatthew Knepley    attempted by the nonlinear solver before it gives up.
77850ffb88aSMatthew Knepley 
77950ffb88aSMatthew Knepley    Not Collective
78050ffb88aSMatthew Knepley 
78150ffb88aSMatthew Knepley    Input Parameter:
78250ffb88aSMatthew Knepley .  snes     - SNES context
78350ffb88aSMatthew Knepley 
78450ffb88aSMatthew Knepley    Output Parameter:
78550ffb88aSMatthew Knepley .  maxFails - maximum of unsuccessful steps
78650ffb88aSMatthew Knepley 
78750ffb88aSMatthew Knepley    Level: intermediate
78850ffb88aSMatthew Knepley 
78950ffb88aSMatthew Knepley .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps
79058ebbce7SBarry Smith 
791e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(),
79258ebbce7SBarry Smith           SNESSetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures()
79358ebbce7SBarry Smith 
79450ffb88aSMatthew Knepley @*/
7957087cfbeSBarry Smith PetscErrorCode  SNESGetMaxNonlinearStepFailures(SNES snes, PetscInt *maxFails)
79650ffb88aSMatthew Knepley {
79750ffb88aSMatthew Knepley   PetscFunctionBegin;
7980700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
7994482741eSBarry Smith   PetscValidIntPointer(maxFails,2);
80050ffb88aSMatthew Knepley   *maxFails = snes->maxFailures;
8013a40ed3dSBarry Smith   PetscFunctionReturn(0);
8029b94acceSBarry Smith }
803a847f771SSatish Balay 
8044a2ae208SSatish Balay #undef __FUNCT__
8052541af92SBarry Smith #define __FUNCT__ "SNESGetNumberFunctionEvals"
8062541af92SBarry Smith /*@
8072541af92SBarry Smith    SNESGetNumberFunctionEvals - Gets the number of user provided function evaluations
8082541af92SBarry Smith      done by SNES.
8092541af92SBarry Smith 
8102541af92SBarry Smith    Not Collective
8112541af92SBarry Smith 
8122541af92SBarry Smith    Input Parameter:
8132541af92SBarry Smith .  snes     - SNES context
8142541af92SBarry Smith 
8152541af92SBarry Smith    Output Parameter:
8162541af92SBarry Smith .  nfuncs - number of evaluations
8172541af92SBarry Smith 
8182541af92SBarry Smith    Level: intermediate
8192541af92SBarry Smith 
8202541af92SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps
82158ebbce7SBarry Smith 
822e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures()
8232541af92SBarry Smith @*/
8247087cfbeSBarry Smith PetscErrorCode  SNESGetNumberFunctionEvals(SNES snes, PetscInt *nfuncs)
8252541af92SBarry Smith {
8262541af92SBarry Smith   PetscFunctionBegin;
8270700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
8282541af92SBarry Smith   PetscValidIntPointer(nfuncs,2);
8292541af92SBarry Smith   *nfuncs = snes->nfuncs;
8302541af92SBarry Smith   PetscFunctionReturn(0);
8312541af92SBarry Smith }
8322541af92SBarry Smith 
8332541af92SBarry Smith #undef __FUNCT__
8343d4c4710SBarry Smith #define __FUNCT__ "SNESGetLinearSolveFailures"
8353d4c4710SBarry Smith /*@
8363d4c4710SBarry Smith    SNESGetLinearSolveFailures - Gets the number of failed (non-converged)
8373d4c4710SBarry Smith    linear solvers.
8383d4c4710SBarry Smith 
8393d4c4710SBarry Smith    Not Collective
8403d4c4710SBarry Smith 
8413d4c4710SBarry Smith    Input Parameter:
8423d4c4710SBarry Smith .  snes - SNES context
8433d4c4710SBarry Smith 
8443d4c4710SBarry Smith    Output Parameter:
8453d4c4710SBarry Smith .  nfails - number of failed solves
8463d4c4710SBarry Smith 
8473d4c4710SBarry Smith    Notes:
8483d4c4710SBarry Smith    This counter is reset to zero for each successive call to SNESSolve().
8493d4c4710SBarry Smith 
8503d4c4710SBarry Smith    Level: intermediate
8513d4c4710SBarry Smith 
8523d4c4710SBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps
85358ebbce7SBarry Smith 
854e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures()
8553d4c4710SBarry Smith @*/
8567087cfbeSBarry Smith PetscErrorCode  SNESGetLinearSolveFailures(SNES snes,PetscInt* nfails)
8573d4c4710SBarry Smith {
8583d4c4710SBarry Smith   PetscFunctionBegin;
8590700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
8603d4c4710SBarry Smith   PetscValidIntPointer(nfails,2);
8613d4c4710SBarry Smith   *nfails = snes->numLinearSolveFailures;
8623d4c4710SBarry Smith   PetscFunctionReturn(0);
8633d4c4710SBarry Smith }
8643d4c4710SBarry Smith 
8653d4c4710SBarry Smith #undef __FUNCT__
8663d4c4710SBarry Smith #define __FUNCT__ "SNESSetMaxLinearSolveFailures"
8673d4c4710SBarry Smith /*@
8683d4c4710SBarry Smith    SNESSetMaxLinearSolveFailures - the number of failed linear solve attempts
8693d4c4710SBarry Smith    allowed before SNES returns with a diverged reason of SNES_DIVERGED_LINEAR_SOLVE
8703d4c4710SBarry Smith 
8713f9fe445SBarry Smith    Logically Collective on SNES
8723d4c4710SBarry Smith 
8733d4c4710SBarry Smith    Input Parameters:
8743d4c4710SBarry Smith +  snes     - SNES context
8753d4c4710SBarry Smith -  maxFails - maximum allowed linear solve failures
8763d4c4710SBarry Smith 
8773d4c4710SBarry Smith    Level: intermediate
8783d4c4710SBarry Smith 
879a6796414SBarry Smith    Notes: By default this is 0; that is SNES returns on the first failed linear solve
8803d4c4710SBarry Smith 
8813d4c4710SBarry Smith .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps
8823d4c4710SBarry Smith 
88358ebbce7SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations()
8843d4c4710SBarry Smith @*/
8857087cfbeSBarry Smith PetscErrorCode  SNESSetMaxLinearSolveFailures(SNES snes, PetscInt maxFails)
8863d4c4710SBarry Smith {
8873d4c4710SBarry Smith   PetscFunctionBegin;
8880700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
889c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxFails,2);
8903d4c4710SBarry Smith   snes->maxLinearSolveFailures = maxFails;
8913d4c4710SBarry Smith   PetscFunctionReturn(0);
8923d4c4710SBarry Smith }
8933d4c4710SBarry Smith 
8943d4c4710SBarry Smith #undef __FUNCT__
8953d4c4710SBarry Smith #define __FUNCT__ "SNESGetMaxLinearSolveFailures"
8963d4c4710SBarry Smith /*@
8973d4c4710SBarry Smith    SNESGetMaxLinearSolveFailures - gets the maximum number of linear solve failures that
8983d4c4710SBarry Smith      are allowed before SNES terminates
8993d4c4710SBarry Smith 
9003d4c4710SBarry Smith    Not Collective
9013d4c4710SBarry Smith 
9023d4c4710SBarry Smith    Input Parameter:
9033d4c4710SBarry Smith .  snes     - SNES context
9043d4c4710SBarry Smith 
9053d4c4710SBarry Smith    Output Parameter:
9063d4c4710SBarry Smith .  maxFails - maximum of unsuccessful solves allowed
9073d4c4710SBarry Smith 
9083d4c4710SBarry Smith    Level: intermediate
9093d4c4710SBarry Smith 
9103d4c4710SBarry Smith    Notes: By default this is 1; that is SNES returns on the first failed linear solve
9113d4c4710SBarry Smith 
9123d4c4710SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps
9133d4c4710SBarry Smith 
914e1c61ce8SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(),
9153d4c4710SBarry Smith @*/
9167087cfbeSBarry Smith PetscErrorCode  SNESGetMaxLinearSolveFailures(SNES snes, PetscInt *maxFails)
9173d4c4710SBarry Smith {
9183d4c4710SBarry Smith   PetscFunctionBegin;
9190700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
9203d4c4710SBarry Smith   PetscValidIntPointer(maxFails,2);
9213d4c4710SBarry Smith   *maxFails = snes->maxLinearSolveFailures;
9223d4c4710SBarry Smith   PetscFunctionReturn(0);
9233d4c4710SBarry Smith }
9243d4c4710SBarry Smith 
9253d4c4710SBarry Smith #undef __FUNCT__
926b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetLinearSolveIterations"
927c96a6f78SLois Curfman McInnes /*@
928b850b91aSLisandro Dalcin    SNESGetLinearSolveIterations - Gets the total number of linear iterations
929c96a6f78SLois Curfman McInnes    used by the nonlinear solver.
930c96a6f78SLois Curfman McInnes 
931c7afd0dbSLois Curfman McInnes    Not Collective
932c7afd0dbSLois Curfman McInnes 
933c96a6f78SLois Curfman McInnes    Input Parameter:
934c96a6f78SLois Curfman McInnes .  snes - SNES context
935c96a6f78SLois Curfman McInnes 
936c96a6f78SLois Curfman McInnes    Output Parameter:
937c96a6f78SLois Curfman McInnes .  lits - number of linear iterations
938c96a6f78SLois Curfman McInnes 
939c96a6f78SLois Curfman McInnes    Notes:
940c96a6f78SLois Curfman McInnes    This counter is reset to zero for each successive call to SNESSolve().
941c96a6f78SLois Curfman McInnes 
94236851e7fSLois Curfman McInnes    Level: intermediate
94336851e7fSLois Curfman McInnes 
944c96a6f78SLois Curfman McInnes .keywords: SNES, nonlinear, get, number, linear, iterations
9452b668275SBarry Smith 
9468c7482ecSBarry Smith .seealso:  SNESGetIterationNumber(), SNESGetFunctionNorm(), SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures()
947c96a6f78SLois Curfman McInnes @*/
9487087cfbeSBarry Smith PetscErrorCode  SNESGetLinearSolveIterations(SNES snes,PetscInt* lits)
949c96a6f78SLois Curfman McInnes {
9503a40ed3dSBarry Smith   PetscFunctionBegin;
9510700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
9524482741eSBarry Smith   PetscValidIntPointer(lits,2);
953c96a6f78SLois Curfman McInnes   *lits = snes->linear_its;
9543a40ed3dSBarry Smith   PetscFunctionReturn(0);
955c96a6f78SLois Curfman McInnes }
956c96a6f78SLois Curfman McInnes 
9574a2ae208SSatish Balay #undef __FUNCT__
95894b7f48cSBarry Smith #define __FUNCT__ "SNESGetKSP"
95952baeb72SSatish Balay /*@
96094b7f48cSBarry Smith    SNESGetKSP - Returns the KSP context for a SNES solver.
9619b94acceSBarry Smith 
96294b7f48cSBarry Smith    Not Collective, but if SNES object is parallel, then KSP object is parallel
963c7afd0dbSLois Curfman McInnes 
9649b94acceSBarry Smith    Input Parameter:
9659b94acceSBarry Smith .  snes - the SNES context
9669b94acceSBarry Smith 
9679b94acceSBarry Smith    Output Parameter:
96894b7f48cSBarry Smith .  ksp - the KSP context
9699b94acceSBarry Smith 
9709b94acceSBarry Smith    Notes:
97194b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
9729b94acceSBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
9732999313aSBarry Smith    PC contexts as well.
9749b94acceSBarry Smith 
97536851e7fSLois Curfman McInnes    Level: beginner
97636851e7fSLois Curfman McInnes 
97794b7f48cSBarry Smith .keywords: SNES, nonlinear, get, KSP, context
9789b94acceSBarry Smith 
9792999313aSBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP()
9809b94acceSBarry Smith @*/
9817087cfbeSBarry Smith PetscErrorCode  SNESGetKSP(SNES snes,KSP *ksp)
9829b94acceSBarry Smith {
9831cee3971SBarry Smith   PetscErrorCode ierr;
9841cee3971SBarry Smith 
9853a40ed3dSBarry Smith   PetscFunctionBegin;
9860700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
9874482741eSBarry Smith   PetscValidPointer(ksp,2);
9881cee3971SBarry Smith 
9891cee3971SBarry Smith   if (!snes->ksp) {
9901cee3971SBarry Smith     ierr = KSPCreate(((PetscObject)snes)->comm,&snes->ksp);CHKERRQ(ierr);
9911cee3971SBarry Smith     ierr = PetscObjectIncrementTabLevel((PetscObject)snes->ksp,(PetscObject)snes,1);CHKERRQ(ierr);
9921cee3971SBarry Smith     ierr = PetscLogObjectParent(snes,snes->ksp);CHKERRQ(ierr);
9931cee3971SBarry Smith   }
99494b7f48cSBarry Smith   *ksp = snes->ksp;
9953a40ed3dSBarry Smith   PetscFunctionReturn(0);
9969b94acceSBarry Smith }
99782bf6240SBarry Smith 
9984a2ae208SSatish Balay #undef __FUNCT__
9992999313aSBarry Smith #define __FUNCT__ "SNESSetKSP"
10002999313aSBarry Smith /*@
10012999313aSBarry Smith    SNESSetKSP - Sets a KSP context for the SNES object to use
10022999313aSBarry Smith 
10032999313aSBarry Smith    Not Collective, but the SNES and KSP objects must live on the same MPI_Comm
10042999313aSBarry Smith 
10052999313aSBarry Smith    Input Parameters:
10062999313aSBarry Smith +  snes - the SNES context
10072999313aSBarry Smith -  ksp - the KSP context
10082999313aSBarry Smith 
10092999313aSBarry Smith    Notes:
10102999313aSBarry Smith    The SNES object already has its KSP object, you can obtain with SNESGetKSP()
10112999313aSBarry Smith    so this routine is rarely needed.
10122999313aSBarry Smith 
10132999313aSBarry Smith    The KSP object that is already in the SNES object has its reference count
10142999313aSBarry Smith    decreased by one.
10152999313aSBarry Smith 
10162999313aSBarry Smith    Level: developer
10172999313aSBarry Smith 
10182999313aSBarry Smith .keywords: SNES, nonlinear, get, KSP, context
10192999313aSBarry Smith 
10202999313aSBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP()
10212999313aSBarry Smith @*/
10227087cfbeSBarry Smith PetscErrorCode  SNESSetKSP(SNES snes,KSP ksp)
10232999313aSBarry Smith {
10242999313aSBarry Smith   PetscErrorCode ierr;
10252999313aSBarry Smith 
10262999313aSBarry Smith   PetscFunctionBegin;
10270700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
10280700a824SBarry Smith   PetscValidHeaderSpecific(ksp,KSP_CLASSID,2);
10292999313aSBarry Smith   PetscCheckSameComm(snes,1,ksp,2);
10307dcf0eaaSdalcinl   ierr = PetscObjectReference((PetscObject)ksp);CHKERRQ(ierr);
1031906ed7ccSBarry Smith   if (snes->ksp) {ierr = PetscObjectDereference((PetscObject)snes->ksp);CHKERRQ(ierr);}
10322999313aSBarry Smith   snes->ksp = ksp;
10332999313aSBarry Smith   PetscFunctionReturn(0);
10342999313aSBarry Smith }
10352999313aSBarry Smith 
10367adad957SLisandro Dalcin #if 0
10372999313aSBarry Smith #undef __FUNCT__
10384a2ae208SSatish Balay #define __FUNCT__ "SNESPublish_Petsc"
10396849ba73SBarry Smith static PetscErrorCode SNESPublish_Petsc(PetscObject obj)
1040e24b481bSBarry Smith {
1041e24b481bSBarry Smith   PetscFunctionBegin;
1042e24b481bSBarry Smith   PetscFunctionReturn(0);
1043e24b481bSBarry Smith }
10447adad957SLisandro Dalcin #endif
1045e24b481bSBarry Smith 
10469b94acceSBarry Smith /* -----------------------------------------------------------*/
10474a2ae208SSatish Balay #undef __FUNCT__
10484a2ae208SSatish Balay #define __FUNCT__ "SNESCreate"
104952baeb72SSatish Balay /*@
10509b94acceSBarry Smith    SNESCreate - Creates a nonlinear solver context.
10519b94acceSBarry Smith 
1052c7afd0dbSLois Curfman McInnes    Collective on MPI_Comm
1053c7afd0dbSLois Curfman McInnes 
1054c7afd0dbSLois Curfman McInnes    Input Parameters:
1055906ed7ccSBarry Smith .  comm - MPI communicator
10569b94acceSBarry Smith 
10579b94acceSBarry Smith    Output Parameter:
10589b94acceSBarry Smith .  outsnes - the new SNES context
10599b94acceSBarry Smith 
1060c7afd0dbSLois Curfman McInnes    Options Database Keys:
1061c7afd0dbSLois Curfman McInnes +   -snes_mf - Activates default matrix-free Jacobian-vector products,
1062c7afd0dbSLois Curfman McInnes                and no preconditioning matrix
1063c7afd0dbSLois Curfman McInnes .   -snes_mf_operator - Activates default matrix-free Jacobian-vector
1064c7afd0dbSLois Curfman McInnes                products, and a user-provided preconditioning matrix
1065c7afd0dbSLois Curfman McInnes                as set by SNESSetJacobian()
1066c7afd0dbSLois Curfman McInnes -   -snes_fd - Uses (slow!) finite differences to compute Jacobian
1067c1f60f51SBarry Smith 
106836851e7fSLois Curfman McInnes    Level: beginner
106936851e7fSLois Curfman McInnes 
10709b94acceSBarry Smith .keywords: SNES, nonlinear, create, context
10719b94acceSBarry Smith 
1072a8054027SBarry Smith .seealso: SNESSolve(), SNESDestroy(), SNES, SNESSetLagPreconditioner()
1073a8054027SBarry Smith 
10749b94acceSBarry Smith @*/
10757087cfbeSBarry Smith PetscErrorCode  SNESCreate(MPI_Comm comm,SNES *outsnes)
10769b94acceSBarry Smith {
1077dfbe8321SBarry Smith   PetscErrorCode      ierr;
10789b94acceSBarry Smith   SNES                snes;
1079fa9f3622SBarry Smith   SNESKSPEW           *kctx;
108037fcc0dbSBarry Smith 
10813a40ed3dSBarry Smith   PetscFunctionBegin;
1082ed1caa07SMatthew Knepley   PetscValidPointer(outsnes,2);
10838ba1e511SMatthew Knepley   *outsnes = PETSC_NULL;
10848ba1e511SMatthew Knepley #ifndef PETSC_USE_DYNAMIC_LIBRARIES
10858ba1e511SMatthew Knepley   ierr = SNESInitializePackage(PETSC_NULL);CHKERRQ(ierr);
10868ba1e511SMatthew Knepley #endif
10878ba1e511SMatthew Knepley 
10883194b578SJed Brown   ierr = PetscHeaderCreate(snes,_p_SNES,struct _SNESOps,SNES_CLASSID,0,"SNES","Nonlinear solver","SNES",comm,SNESDestroy,SNESView);CHKERRQ(ierr);
10897adad957SLisandro Dalcin 
109085385478SLisandro Dalcin   snes->ops->converged    = SNESDefaultConverged;
10912c155ee1SBarry Smith   snes->usesksp           = PETSC_TRUE;
10929b94acceSBarry Smith   snes->max_its           = 50;
10939750a799SBarry Smith   snes->max_funcs	  = 10000;
10949b94acceSBarry Smith   snes->norm		  = 0.0;
1095b4874afaSBarry Smith   snes->rtol		  = 1.e-8;
1096b4874afaSBarry Smith   snes->ttol              = 0.0;
109770441072SBarry Smith   snes->abstol		  = 1.e-50;
10989b94acceSBarry Smith   snes->xtol		  = 1.e-8;
10994b27c08aSLois Curfman McInnes   snes->deltatol	  = 1.e-12;
11009b94acceSBarry Smith   snes->nfuncs            = 0;
110150ffb88aSMatthew Knepley   snes->numFailures       = 0;
110250ffb88aSMatthew Knepley   snes->maxFailures       = 1;
11037a00f4a9SLois Curfman McInnes   snes->linear_its        = 0;
1104e35cf81dSBarry Smith   snes->lagjacobian       = 1;
1105a8054027SBarry Smith   snes->lagpreconditioner = 1;
1106639f9d9dSBarry Smith   snes->numbermonitors    = 0;
11079b94acceSBarry Smith   snes->data              = 0;
11084dc4c822SBarry Smith   snes->setupcalled       = PETSC_FALSE;
1109186905e3SBarry Smith   snes->ksp_ewconv        = PETSC_FALSE;
11106f24a144SLois Curfman McInnes   snes->nwork             = 0;
111158c9b817SLisandro Dalcin   snes->work              = 0;
111258c9b817SLisandro Dalcin   snes->nvwork            = 0;
111358c9b817SLisandro Dalcin   snes->vwork             = 0;
1114758f92a0SBarry Smith   snes->conv_hist_len     = 0;
1115758f92a0SBarry Smith   snes->conv_hist_max     = 0;
1116758f92a0SBarry Smith   snes->conv_hist         = PETSC_NULL;
1117758f92a0SBarry Smith   snes->conv_hist_its     = PETSC_NULL;
1118758f92a0SBarry Smith   snes->conv_hist_reset   = PETSC_TRUE;
1119184914b5SBarry Smith   snes->reason            = SNES_CONVERGED_ITERATING;
11209b94acceSBarry Smith 
1121ea630c6eSPeter Brune   /* initialize the line search options */
1122ea630c6eSPeter Brune   snes->ls_type           = SNES_LS_BASIC;
1123*af60355fSPeter Brune   snes->ls_its            = 1;
1124ea630c6eSPeter Brune   snes->damping           = 1.0;
1125ea630c6eSPeter Brune   snes->maxstep           = 1e8;
1126ea630c6eSPeter Brune   snes->steptol           = 1e-12;
1127ea630c6eSPeter Brune   snes->ls_alpha          = 1e-4;
1128ea630c6eSPeter Brune   snes->ls_monitor        = PETSC_NULL;
1129ea630c6eSPeter Brune 
1130ea630c6eSPeter Brune   snes->ops->linesearch   = PETSC_NULL;
1131ea630c6eSPeter Brune   snes->precheck          = PETSC_NULL;
1132ea630c6eSPeter Brune   snes->ops->precheckstep = PETSC_NULL;
1133ea630c6eSPeter Brune   snes->postcheck         = PETSC_NULL;
1134ea630c6eSPeter Brune   snes->ops->postcheckstep= PETSC_NULL;
1135ea630c6eSPeter Brune 
11363d4c4710SBarry Smith   snes->numLinearSolveFailures = 0;
11373d4c4710SBarry Smith   snes->maxLinearSolveFailures = 1;
11383d4c4710SBarry Smith 
11399b94acceSBarry Smith   /* Create context to compute Eisenstat-Walker relative tolerance for KSP */
114038f2d2fdSLisandro Dalcin   ierr = PetscNewLog(snes,SNESKSPEW,&kctx);CHKERRQ(ierr);
11419b94acceSBarry Smith   snes->kspconvctx  = (void*)kctx;
11429b94acceSBarry Smith   kctx->version     = 2;
11439b94acceSBarry Smith   kctx->rtol_0      = .3; /* Eisenstat and Walker suggest rtol_0=.5, but
11449b94acceSBarry Smith                              this was too large for some test cases */
114575567043SBarry Smith   kctx->rtol_last   = 0.0;
11469b94acceSBarry Smith   kctx->rtol_max    = .9;
11479b94acceSBarry Smith   kctx->gamma       = 1.0;
114871f87433Sdalcinl   kctx->alpha       = .5*(1.0 + sqrt(5.0));
114971f87433Sdalcinl   kctx->alpha2      = kctx->alpha;
11509b94acceSBarry Smith   kctx->threshold   = .1;
115175567043SBarry Smith   kctx->lresid_last = 0.0;
115275567043SBarry Smith   kctx->norm_last   = 0.0;
11539b94acceSBarry Smith 
11549b94acceSBarry Smith   *outsnes = snes;
11553a40ed3dSBarry Smith   PetscFunctionReturn(0);
11569b94acceSBarry Smith }
11579b94acceSBarry Smith 
11584a2ae208SSatish Balay #undef __FUNCT__
11594a2ae208SSatish Balay #define __FUNCT__ "SNESSetFunction"
11609b94acceSBarry Smith /*@C
11619b94acceSBarry Smith    SNESSetFunction - Sets the function evaluation routine and function
11629b94acceSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
11639b94acceSBarry Smith    equations.
11649b94acceSBarry Smith 
11653f9fe445SBarry Smith    Logically Collective on SNES
1166fee21e36SBarry Smith 
1167c7afd0dbSLois Curfman McInnes    Input Parameters:
1168c7afd0dbSLois Curfman McInnes +  snes - the SNES context
1169c7afd0dbSLois Curfman McInnes .  r - vector to store function value
1170de044059SHong Zhang .  func - function evaluation routine
1171c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined context for private data for the
1172c7afd0dbSLois Curfman McInnes          function evaluation routine (may be PETSC_NULL)
11739b94acceSBarry Smith 
1174c7afd0dbSLois Curfman McInnes    Calling sequence of func:
11758d76a1e5SLois Curfman McInnes $    func (SNES snes,Vec x,Vec f,void *ctx);
1176c7afd0dbSLois Curfman McInnes 
1177313e4042SLois Curfman McInnes .  f - function vector
1178c7afd0dbSLois Curfman McInnes -  ctx - optional user-defined function context
11799b94acceSBarry Smith 
11809b94acceSBarry Smith    Notes:
11819b94acceSBarry Smith    The Newton-like methods typically solve linear systems of the form
11829b94acceSBarry Smith $      f'(x) x = -f(x),
1183c7afd0dbSLois Curfman McInnes    where f'(x) denotes the Jacobian matrix and f(x) is the function.
11849b94acceSBarry Smith 
118536851e7fSLois Curfman McInnes    Level: beginner
118636851e7fSLois Curfman McInnes 
11879b94acceSBarry Smith .keywords: SNES, nonlinear, set, function
11889b94acceSBarry Smith 
1189a86d99e1SLois Curfman McInnes .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian()
11909b94acceSBarry Smith @*/
11917087cfbeSBarry Smith PetscErrorCode  SNESSetFunction(SNES snes,Vec r,PetscErrorCode (*func)(SNES,Vec,Vec,void*),void *ctx)
11929b94acceSBarry Smith {
119385385478SLisandro Dalcin   PetscErrorCode ierr;
11943a40ed3dSBarry Smith   PetscFunctionBegin;
11950700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1196d2a683ecSLisandro Dalcin   if (r) {
1197d2a683ecSLisandro Dalcin     PetscValidHeaderSpecific(r,VEC_CLASSID,2);
1198d2a683ecSLisandro Dalcin     PetscCheckSameComm(snes,1,r,2);
119985385478SLisandro Dalcin     ierr = PetscObjectReference((PetscObject)r);CHKERRQ(ierr);
12006bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr);
120185385478SLisandro Dalcin     snes->vec_func = r;
1202d2a683ecSLisandro Dalcin   } else if (!snes->vec_func && snes->dm) {
1203d2a683ecSLisandro Dalcin     ierr = DMCreateGlobalVector(snes->dm,&snes->vec_func);CHKERRQ(ierr);
1204d2a683ecSLisandro Dalcin   }
1205d2a683ecSLisandro Dalcin   if (func) snes->ops->computefunction = func;
1206d2a683ecSLisandro Dalcin   if (ctx)  snes->funP                 = ctx;
12073a40ed3dSBarry Smith   PetscFunctionReturn(0);
12089b94acceSBarry Smith }
12099b94acceSBarry Smith 
1210d25893d9SBarry Smith #undef __FUNCT__
1211d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeInitialGuess"
1212d25893d9SBarry Smith /*@C
1213d25893d9SBarry Smith    SNESSetComputeInitialGuess - Sets a routine used to compute an initial guess for the problem
1214d25893d9SBarry Smith 
1215d25893d9SBarry Smith    Logically Collective on SNES
1216d25893d9SBarry Smith 
1217d25893d9SBarry Smith    Input Parameters:
1218d25893d9SBarry Smith +  snes - the SNES context
1219d25893d9SBarry Smith .  func - function evaluation routine
1220d25893d9SBarry Smith -  ctx - [optional] user-defined context for private data for the
1221d25893d9SBarry Smith          function evaluation routine (may be PETSC_NULL)
1222d25893d9SBarry Smith 
1223d25893d9SBarry Smith    Calling sequence of func:
1224d25893d9SBarry Smith $    func (SNES snes,Vec x,void *ctx);
1225d25893d9SBarry Smith 
1226d25893d9SBarry Smith .  f - function vector
1227d25893d9SBarry Smith -  ctx - optional user-defined function context
1228d25893d9SBarry Smith 
1229d25893d9SBarry Smith    Level: intermediate
1230d25893d9SBarry Smith 
1231d25893d9SBarry Smith .keywords: SNES, nonlinear, set, function
1232d25893d9SBarry Smith 
1233d25893d9SBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian()
1234d25893d9SBarry Smith @*/
1235d25893d9SBarry Smith PetscErrorCode  SNESSetComputeInitialGuess(SNES snes,PetscErrorCode (*func)(SNES,Vec,void*),void *ctx)
1236d25893d9SBarry Smith {
1237d25893d9SBarry Smith   PetscFunctionBegin;
1238d25893d9SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1239d25893d9SBarry Smith   if (func) snes->ops->computeinitialguess = func;
1240d25893d9SBarry Smith   if (ctx)  snes->initialguessP            = ctx;
1241d25893d9SBarry Smith   PetscFunctionReturn(0);
1242d25893d9SBarry Smith }
1243d25893d9SBarry Smith 
12443ab0aad5SBarry Smith /* --------------------------------------------------------------- */
12453ab0aad5SBarry Smith #undef __FUNCT__
12461096aae1SMatthew Knepley #define __FUNCT__ "SNESGetRhs"
12471096aae1SMatthew Knepley /*@C
12481096aae1SMatthew Knepley    SNESGetRhs - Gets the vector for solving F(x) = rhs. If rhs is not set
12491096aae1SMatthew Knepley    it assumes a zero right hand side.
12501096aae1SMatthew Knepley 
12513f9fe445SBarry Smith    Logically Collective on SNES
12521096aae1SMatthew Knepley 
12531096aae1SMatthew Knepley    Input Parameter:
12541096aae1SMatthew Knepley .  snes - the SNES context
12551096aae1SMatthew Knepley 
12561096aae1SMatthew Knepley    Output Parameter:
1257bc08b0f1SBarry Smith .  rhs - the right hand side vector or PETSC_NULL if the right hand side vector is null
12581096aae1SMatthew Knepley 
12591096aae1SMatthew Knepley    Level: intermediate
12601096aae1SMatthew Knepley 
12611096aae1SMatthew Knepley .keywords: SNES, nonlinear, get, function, right hand side
12621096aae1SMatthew Knepley 
126385385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
12641096aae1SMatthew Knepley @*/
12657087cfbeSBarry Smith PetscErrorCode  SNESGetRhs(SNES snes,Vec *rhs)
12661096aae1SMatthew Knepley {
12671096aae1SMatthew Knepley   PetscFunctionBegin;
12680700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
12691096aae1SMatthew Knepley   PetscValidPointer(rhs,2);
127085385478SLisandro Dalcin   *rhs = snes->vec_rhs;
12711096aae1SMatthew Knepley   PetscFunctionReturn(0);
12721096aae1SMatthew Knepley }
12731096aae1SMatthew Knepley 
12741096aae1SMatthew Knepley #undef __FUNCT__
12754a2ae208SSatish Balay #define __FUNCT__ "SNESComputeFunction"
12769b94acceSBarry Smith /*@
127736851e7fSLois Curfman McInnes    SNESComputeFunction - Calls the function that has been set with
12789b94acceSBarry Smith                          SNESSetFunction().
12799b94acceSBarry Smith 
1280c7afd0dbSLois Curfman McInnes    Collective on SNES
1281c7afd0dbSLois Curfman McInnes 
12829b94acceSBarry Smith    Input Parameters:
1283c7afd0dbSLois Curfman McInnes +  snes - the SNES context
1284c7afd0dbSLois Curfman McInnes -  x - input vector
12859b94acceSBarry Smith 
12869b94acceSBarry Smith    Output Parameter:
12873638b69dSLois Curfman McInnes .  y - function vector, as set by SNESSetFunction()
12889b94acceSBarry Smith 
12891bffabb2SLois Curfman McInnes    Notes:
129036851e7fSLois Curfman McInnes    SNESComputeFunction() is typically used within nonlinear solvers
129136851e7fSLois Curfman McInnes    implementations, so most users would not generally call this routine
129236851e7fSLois Curfman McInnes    themselves.
129336851e7fSLois Curfman McInnes 
129436851e7fSLois Curfman McInnes    Level: developer
129536851e7fSLois Curfman McInnes 
12969b94acceSBarry Smith .keywords: SNES, nonlinear, compute, function
12979b94acceSBarry Smith 
1298a86d99e1SLois Curfman McInnes .seealso: SNESSetFunction(), SNESGetFunction()
12999b94acceSBarry Smith @*/
13007087cfbeSBarry Smith PetscErrorCode  SNESComputeFunction(SNES snes,Vec x,Vec y)
13019b94acceSBarry Smith {
1302dfbe8321SBarry Smith   PetscErrorCode ierr;
13039b94acceSBarry Smith 
13043a40ed3dSBarry Smith   PetscFunctionBegin;
13050700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
13060700a824SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
13070700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
1308c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,x,2);
1309c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,y,3);
1310184914b5SBarry Smith 
1311d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr);
1312e7788613SBarry Smith   if (snes->ops->computefunction) {
1313d64ed03dSBarry Smith     PetscStackPush("SNES user function");
131439d508bbSBarry Smith     ierr = (*snes->ops->computefunction)(snes,x,y,snes->funP);CHKERRQ(ierr);
1315d64ed03dSBarry Smith     PetscStackPop;
131673250ac0SBarry Smith   } else if (snes->dm) {
1317644e2e5bSBarry Smith     ierr = DMComputeFunction(snes->dm,x,y);CHKERRQ(ierr);
1318c90fad12SPeter Brune   } else if (snes->vec_rhs) {
1319c90fad12SPeter Brune     ierr = MatMult(snes->jacobian, x, y);CHKERRQ(ierr);
1320644e2e5bSBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetFunction() or SNESSetDM() before SNESComputeFunction(), likely called from SNESSolve().");
132185385478SLisandro Dalcin   if (snes->vec_rhs) {
132285385478SLisandro Dalcin     ierr = VecAXPY(y,-1.0,snes->vec_rhs);CHKERRQ(ierr);
13233ab0aad5SBarry Smith   }
1324ae3c334cSLois Curfman McInnes   snes->nfuncs++;
1325d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr);
13263a40ed3dSBarry Smith   PetscFunctionReturn(0);
13279b94acceSBarry Smith }
13289b94acceSBarry Smith 
13294a2ae208SSatish Balay #undef __FUNCT__
13304a2ae208SSatish Balay #define __FUNCT__ "SNESComputeJacobian"
133162fef451SLois Curfman McInnes /*@
133262fef451SLois Curfman McInnes    SNESComputeJacobian - Computes the Jacobian matrix that has been
133362fef451SLois Curfman McInnes    set with SNESSetJacobian().
133462fef451SLois Curfman McInnes 
1335c7afd0dbSLois Curfman McInnes    Collective on SNES and Mat
1336c7afd0dbSLois Curfman McInnes 
133762fef451SLois Curfman McInnes    Input Parameters:
1338c7afd0dbSLois Curfman McInnes +  snes - the SNES context
1339c7afd0dbSLois Curfman McInnes -  x - input vector
134062fef451SLois Curfman McInnes 
134162fef451SLois Curfman McInnes    Output Parameters:
1342c7afd0dbSLois Curfman McInnes +  A - Jacobian matrix
134362fef451SLois Curfman McInnes .  B - optional preconditioning matrix
13442b668275SBarry Smith -  flag - flag indicating matrix structure (one of, SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER)
1345fee21e36SBarry Smith 
1346e35cf81dSBarry Smith   Options Database Keys:
1347e35cf81dSBarry Smith +    -snes_lag_preconditioner <lag>
1348693365a8SJed Brown .    -snes_lag_jacobian <lag>
1349693365a8SJed Brown .    -snes_compare_explicit - Compare the computed Jacobian to the finite difference Jacobian and output the differences
1350693365a8SJed Brown .    -snes_compare_explicit_draw  - Compare the computed Jacobian to the finite difference Jacobian and draw the result
1351693365a8SJed Brown .    -snes_compare_explicit_contour  - Compare the computed Jacobian to the finite difference Jacobian and draw a contour plot with the result
1352693365a8SJed Brown -    -snes_compare_operator  - Make the comparison options above use the operator instead of the preconditioning matrix
1353e35cf81dSBarry Smith 
135462fef451SLois Curfman McInnes    Notes:
135562fef451SLois Curfman McInnes    Most users should not need to explicitly call this routine, as it
135662fef451SLois Curfman McInnes    is used internally within the nonlinear solvers.
135762fef451SLois Curfman McInnes 
135894b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
1359dc5a77f8SLois Curfman McInnes    flag parameter.
136062fef451SLois Curfman McInnes 
136136851e7fSLois Curfman McInnes    Level: developer
136236851e7fSLois Curfman McInnes 
136362fef451SLois Curfman McInnes .keywords: SNES, compute, Jacobian, matrix
136462fef451SLois Curfman McInnes 
1365e35cf81dSBarry Smith .seealso:  SNESSetJacobian(), KSPSetOperators(), MatStructure, SNESSetLagPreconditioner(), SNESSetLagJacobian()
136662fef451SLois Curfman McInnes @*/
13677087cfbeSBarry Smith PetscErrorCode  SNESComputeJacobian(SNES snes,Vec X,Mat *A,Mat *B,MatStructure *flg)
13689b94acceSBarry Smith {
1369dfbe8321SBarry Smith   PetscErrorCode ierr;
1370ace3abfcSBarry Smith   PetscBool      flag;
13713a40ed3dSBarry Smith 
13723a40ed3dSBarry Smith   PetscFunctionBegin;
13730700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
13740700a824SBarry Smith   PetscValidHeaderSpecific(X,VEC_CLASSID,2);
13754482741eSBarry Smith   PetscValidPointer(flg,5);
1376c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,X,2);
1377e7788613SBarry Smith   if (!snes->ops->computejacobian) PetscFunctionReturn(0);
1378ebd3b9afSBarry Smith 
1379ebd3b9afSBarry Smith   /* make sure that MatAssemblyBegin/End() is called on A matrix if it is matrix free */
1380ebd3b9afSBarry Smith 
1381fe3ffe1eSBarry Smith   if (snes->lagjacobian == -2) {
1382fe3ffe1eSBarry Smith     snes->lagjacobian = -1;
1383fe3ffe1eSBarry Smith     ierr = PetscInfo(snes,"Recomputing Jacobian/preconditioner because lag is -2 (means compute Jacobian, but then never again) \n");CHKERRQ(ierr);
1384fe3ffe1eSBarry Smith   } else if (snes->lagjacobian == -1) {
1385e35cf81dSBarry Smith     *flg = SAME_PRECONDITIONER;
1386e35cf81dSBarry Smith     ierr = PetscInfo(snes,"Reusing Jacobian/preconditioner because lag is -1\n");CHKERRQ(ierr);
1387ebd3b9afSBarry Smith     ierr = PetscTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr);
1388ebd3b9afSBarry Smith     if (flag) {
1389ebd3b9afSBarry Smith       ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1390ebd3b9afSBarry Smith       ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1391ebd3b9afSBarry Smith     }
1392e35cf81dSBarry Smith     PetscFunctionReturn(0);
1393e35cf81dSBarry Smith   } else if (snes->lagjacobian > 1 && snes->iter % snes->lagjacobian) {
1394e35cf81dSBarry Smith     *flg = SAME_PRECONDITIONER;
1395e35cf81dSBarry Smith     ierr = PetscInfo2(snes,"Reusing Jacobian/preconditioner because lag is %D and SNES iteration is %D\n",snes->lagjacobian,snes->iter);CHKERRQ(ierr);
1396ebd3b9afSBarry Smith     ierr = PetscTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr);
1397ebd3b9afSBarry Smith     if (flag) {
1398ebd3b9afSBarry Smith       ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1399ebd3b9afSBarry Smith       ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1400ebd3b9afSBarry Smith     }
1401e35cf81dSBarry Smith     PetscFunctionReturn(0);
1402e35cf81dSBarry Smith   }
1403e35cf81dSBarry Smith 
1404c4fc05e7SBarry Smith   *flg = DIFFERENT_NONZERO_PATTERN;
1405e35cf81dSBarry Smith   ierr = PetscLogEventBegin(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr);
1406d64ed03dSBarry Smith   PetscStackPush("SNES user Jacobian function");
1407e7788613SBarry Smith   ierr = (*snes->ops->computejacobian)(snes,X,A,B,flg,snes->jacP);CHKERRQ(ierr);
1408d64ed03dSBarry Smith   PetscStackPop;
1409d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr);
1410a8054027SBarry Smith 
14113b4f5425SBarry Smith   if (snes->lagpreconditioner == -2) {
14123b4f5425SBarry Smith     ierr = PetscInfo(snes,"Rebuilding preconditioner exactly once since lag is -2\n");CHKERRQ(ierr);
14133b4f5425SBarry Smith     snes->lagpreconditioner = -1;
14143b4f5425SBarry Smith   } else if (snes->lagpreconditioner == -1) {
1415a8054027SBarry Smith     *flg = SAME_PRECONDITIONER;
1416a8054027SBarry Smith     ierr = PetscInfo(snes,"Reusing preconditioner because lag is -1\n");CHKERRQ(ierr);
1417a8054027SBarry Smith   } else if (snes->lagpreconditioner > 1 && snes->iter % snes->lagpreconditioner) {
1418a8054027SBarry Smith     *flg = SAME_PRECONDITIONER;
1419a8054027SBarry Smith     ierr = PetscInfo2(snes,"Reusing preconditioner because lag is %D and SNES iteration is %D\n",snes->lagpreconditioner,snes->iter);CHKERRQ(ierr);
1420a8054027SBarry Smith   }
1421a8054027SBarry Smith 
14226d84be18SBarry Smith   /* make sure user returned a correct Jacobian and preconditioner */
14230700a824SBarry Smith   /* PetscValidHeaderSpecific(*A,MAT_CLASSID,3);
14240700a824SBarry Smith     PetscValidHeaderSpecific(*B,MAT_CLASSID,4);   */
1425693365a8SJed Brown   {
1426693365a8SJed Brown     PetscBool flag = PETSC_FALSE,flag_draw = PETSC_FALSE,flag_contour = PETSC_FALSE,flag_operator = PETSC_FALSE;
1427693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit",&flag,PETSC_NULL);CHKERRQ(ierr);
1428693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw",&flag_draw,PETSC_NULL);CHKERRQ(ierr);
1429693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw_contour",&flag_contour,PETSC_NULL);CHKERRQ(ierr);
1430693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_operator",&flag_operator,PETSC_NULL);CHKERRQ(ierr);
1431693365a8SJed Brown     if (flag || flag_draw || flag_contour) {
1432693365a8SJed Brown       Mat Bexp_mine = PETSC_NULL,Bexp,FDexp;
1433693365a8SJed Brown       MatStructure mstruct;
1434693365a8SJed Brown       PetscViewer vdraw,vstdout;
14356b3a5b13SJed Brown       PetscBool flg;
1436693365a8SJed Brown       if (flag_operator) {
1437693365a8SJed Brown         ierr = MatComputeExplicitOperator(*A,&Bexp_mine);CHKERRQ(ierr);
1438693365a8SJed Brown         Bexp = Bexp_mine;
1439693365a8SJed Brown       } else {
1440693365a8SJed Brown         /* See if the preconditioning matrix can be viewed and added directly */
1441693365a8SJed Brown         ierr = PetscTypeCompareAny((PetscObject)*B,&flg,MATSEQAIJ,MATMPIAIJ,MATSEQDENSE,MATMPIDENSE,MATSEQBAIJ,MATMPIBAIJ,MATSEQSBAIJ,MATMPIBAIJ,"");CHKERRQ(ierr);
1442693365a8SJed Brown         if (flg) Bexp = *B;
1443693365a8SJed Brown         else {
1444693365a8SJed Brown           /* If the "preconditioning" matrix is itself MATSHELL or some other type without direct support */
1445693365a8SJed Brown           ierr = MatComputeExplicitOperator(*B,&Bexp_mine);CHKERRQ(ierr);
1446693365a8SJed Brown           Bexp = Bexp_mine;
1447693365a8SJed Brown         }
1448693365a8SJed Brown       }
1449693365a8SJed Brown       ierr = MatConvert(Bexp,MATSAME,MAT_INITIAL_MATRIX,&FDexp);CHKERRQ(ierr);
1450693365a8SJed Brown       ierr = SNESDefaultComputeJacobian(snes,X,&FDexp,&FDexp,&mstruct,NULL);CHKERRQ(ierr);
1451693365a8SJed Brown       ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&vstdout);CHKERRQ(ierr);
1452693365a8SJed Brown       if (flag_draw || flag_contour) {
1453693365a8SJed Brown         ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,0,"Explicit Jacobians",PETSC_DECIDE,PETSC_DECIDE,300,300,&vdraw);CHKERRQ(ierr);
1454693365a8SJed Brown         if (flag_contour) {ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);}
1455693365a8SJed Brown       } else vdraw = PETSC_NULL;
1456693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Explicit %s\n",flag_operator?"Jacobian":"preconditioning Jacobian");CHKERRQ(ierr);
1457693365a8SJed Brown       if (flag) {ierr = MatView(Bexp,vstdout);CHKERRQ(ierr);}
1458693365a8SJed Brown       if (vdraw) {ierr = MatView(Bexp,vdraw);CHKERRQ(ierr);}
1459693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Finite difference Jacobian\n");CHKERRQ(ierr);
1460693365a8SJed Brown       if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);}
1461693365a8SJed Brown       if (vdraw) {ierr = MatView(FDexp,vdraw);CHKERRQ(ierr);}
1462693365a8SJed Brown       ierr = MatAYPX(FDexp,-1.0,Bexp,SAME_NONZERO_PATTERN);CHKERRQ(ierr);
1463693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"User-provided matrix minus finite difference Jacobian\n");CHKERRQ(ierr);
1464693365a8SJed Brown       if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);}
1465693365a8SJed Brown       if (vdraw) {              /* Always use contour for the difference */
1466693365a8SJed Brown         ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);
1467693365a8SJed Brown         ierr = MatView(FDexp,vdraw);CHKERRQ(ierr);
1468693365a8SJed Brown         ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);
1469693365a8SJed Brown       }
1470693365a8SJed Brown       if (flag_contour) {ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);}
1471693365a8SJed Brown       ierr = PetscViewerDestroy(&vdraw);CHKERRQ(ierr);
1472693365a8SJed Brown       ierr = MatDestroy(&Bexp_mine);CHKERRQ(ierr);
1473693365a8SJed Brown       ierr = MatDestroy(&FDexp);CHKERRQ(ierr);
1474693365a8SJed Brown     }
1475693365a8SJed Brown   }
14763a40ed3dSBarry Smith   PetscFunctionReturn(0);
14779b94acceSBarry Smith }
14789b94acceSBarry Smith 
14794a2ae208SSatish Balay #undef __FUNCT__
14804a2ae208SSatish Balay #define __FUNCT__ "SNESSetJacobian"
14819b94acceSBarry Smith /*@C
14829b94acceSBarry Smith    SNESSetJacobian - Sets the function to compute Jacobian as well as the
1483044dda88SLois Curfman McInnes    location to store the matrix.
14849b94acceSBarry Smith 
14853f9fe445SBarry Smith    Logically Collective on SNES and Mat
1486c7afd0dbSLois Curfman McInnes 
14879b94acceSBarry Smith    Input Parameters:
1488c7afd0dbSLois Curfman McInnes +  snes - the SNES context
14899b94acceSBarry Smith .  A - Jacobian matrix
14909b94acceSBarry Smith .  B - preconditioner matrix (usually same as the Jacobian)
1491efd51863SBarry Smith .  func - Jacobian evaluation routine (if PETSC_NULL then SNES retains any previously set value)
1492c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined context for private data for the
1493efd51863SBarry Smith          Jacobian evaluation routine (may be PETSC_NULL) (if PETSC_NULL then SNES retains any previously set value)
14949b94acceSBarry Smith 
14959b94acceSBarry Smith    Calling sequence of func:
14968d76a1e5SLois Curfman McInnes $     func (SNES snes,Vec x,Mat *A,Mat *B,int *flag,void *ctx);
14979b94acceSBarry Smith 
1498c7afd0dbSLois Curfman McInnes +  x - input vector
14999b94acceSBarry Smith .  A - Jacobian matrix
15009b94acceSBarry Smith .  B - preconditioner matrix, usually the same as A
1501ac21db08SLois Curfman McInnes .  flag - flag indicating information about the preconditioner matrix
15022b668275SBarry Smith    structure (same as flag in KSPSetOperators()), one of SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER
1503c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined Jacobian context
15049b94acceSBarry Smith 
15059b94acceSBarry Smith    Notes:
150694b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the flag
15072cd2dfdcSLois Curfman McInnes    output parameter in the routine func().  Be sure to read this information!
1508ac21db08SLois Curfman McInnes 
1509ac21db08SLois Curfman McInnes    The routine func() takes Mat * as the matrix arguments rather than Mat.
15109b94acceSBarry Smith    This allows the Jacobian evaluation routine to replace A and/or B with a
15119b94acceSBarry Smith    completely new new matrix structure (not just different matrix elements)
15129b94acceSBarry Smith    when appropriate, for instance, if the nonzero structure is changing
15139b94acceSBarry Smith    throughout the global iterations.
15149b94acceSBarry Smith 
151516913363SBarry Smith    If the A matrix and B matrix are different you must call MatAssemblyBegin/End() on
151616913363SBarry Smith    each matrix.
151716913363SBarry Smith 
1518a8a26c1eSJed Brown    If using SNESDefaultComputeJacobianColor() to assemble a Jacobian, the ctx argument
1519a8a26c1eSJed Brown    must be a MatFDColoring.
1520a8a26c1eSJed Brown 
1521c3cc8fd1SJed Brown    Other defect-correction schemes can be used by computing a different matrix in place of the Jacobian.  One common
1522c3cc8fd1SJed Brown    example is to use the "Picard linearization" which only differentiates through the highest order parts of each term.
1523c3cc8fd1SJed Brown 
152436851e7fSLois Curfman McInnes    Level: beginner
152536851e7fSLois Curfman McInnes 
15269b94acceSBarry Smith .keywords: SNES, nonlinear, set, Jacobian, matrix
15279b94acceSBarry Smith 
15283ec795f1SBarry Smith .seealso: KSPSetOperators(), SNESSetFunction(), MatMFFDComputeJacobian(), SNESDefaultComputeJacobianColor(), MatStructure
15299b94acceSBarry Smith @*/
15307087cfbeSBarry Smith PetscErrorCode  SNESSetJacobian(SNES snes,Mat A,Mat B,PetscErrorCode (*func)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *ctx)
15319b94acceSBarry Smith {
1532dfbe8321SBarry Smith   PetscErrorCode ierr;
15333a7fca6bSBarry Smith 
15343a40ed3dSBarry Smith   PetscFunctionBegin;
15350700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
15360700a824SBarry Smith   if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2);
15370700a824SBarry Smith   if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3);
1538c9780b6fSBarry Smith   if (A) PetscCheckSameComm(snes,1,A,2);
153906975374SJed Brown   if (B) PetscCheckSameComm(snes,1,B,3);
1540e7788613SBarry Smith   if (func) snes->ops->computejacobian = func;
15413a7fca6bSBarry Smith   if (ctx)  snes->jacP                 = ctx;
15423a7fca6bSBarry Smith   if (A) {
15437dcf0eaaSdalcinl     ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
15446bf464f9SBarry Smith     ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr);
15459b94acceSBarry Smith     snes->jacobian = A;
15463a7fca6bSBarry Smith   }
15473a7fca6bSBarry Smith   if (B) {
15487dcf0eaaSdalcinl     ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
15496bf464f9SBarry Smith     ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr);
15509b94acceSBarry Smith     snes->jacobian_pre = B;
15513a7fca6bSBarry Smith   }
15523a40ed3dSBarry Smith   PetscFunctionReturn(0);
15539b94acceSBarry Smith }
155462fef451SLois Curfman McInnes 
15554a2ae208SSatish Balay #undef __FUNCT__
15564a2ae208SSatish Balay #define __FUNCT__ "SNESGetJacobian"
1557c2aafc4cSSatish Balay /*@C
1558b4fd4287SBarry Smith    SNESGetJacobian - Returns the Jacobian matrix and optionally the user
1559b4fd4287SBarry Smith    provided context for evaluating the Jacobian.
1560b4fd4287SBarry Smith 
1561c7afd0dbSLois Curfman McInnes    Not Collective, but Mat object will be parallel if SNES object is
1562c7afd0dbSLois Curfman McInnes 
1563b4fd4287SBarry Smith    Input Parameter:
1564b4fd4287SBarry Smith .  snes - the nonlinear solver context
1565b4fd4287SBarry Smith 
1566b4fd4287SBarry Smith    Output Parameters:
1567c7afd0dbSLois Curfman McInnes +  A - location to stash Jacobian matrix (or PETSC_NULL)
1568b4fd4287SBarry Smith .  B - location to stash preconditioner matrix (or PETSC_NULL)
156970e92668SMatthew Knepley .  func - location to put Jacobian function (or PETSC_NULL)
157070e92668SMatthew Knepley -  ctx - location to stash Jacobian ctx (or PETSC_NULL)
1571fee21e36SBarry Smith 
157236851e7fSLois Curfman McInnes    Level: advanced
157336851e7fSLois Curfman McInnes 
1574b4fd4287SBarry Smith .seealso: SNESSetJacobian(), SNESComputeJacobian()
1575b4fd4287SBarry Smith @*/
15767087cfbeSBarry Smith PetscErrorCode  SNESGetJacobian(SNES snes,Mat *A,Mat *B,PetscErrorCode (**func)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **ctx)
1577b4fd4287SBarry Smith {
15783a40ed3dSBarry Smith   PetscFunctionBegin;
15790700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1580b4fd4287SBarry Smith   if (A)    *A    = snes->jacobian;
1581b4fd4287SBarry Smith   if (B)    *B    = snes->jacobian_pre;
1582e7788613SBarry Smith   if (func) *func = snes->ops->computejacobian;
158370e92668SMatthew Knepley   if (ctx)  *ctx  = snes->jacP;
15843a40ed3dSBarry Smith   PetscFunctionReturn(0);
1585b4fd4287SBarry Smith }
1586b4fd4287SBarry Smith 
15879b94acceSBarry Smith /* ----- Routines to initialize and destroy a nonlinear solver ---- */
15889b94acceSBarry Smith 
15894a2ae208SSatish Balay #undef __FUNCT__
15904a2ae208SSatish Balay #define __FUNCT__ "SNESSetUp"
15919b94acceSBarry Smith /*@
15929b94acceSBarry Smith    SNESSetUp - Sets up the internal data structures for the later use
1593272ac6f2SLois Curfman McInnes    of a nonlinear solver.
15949b94acceSBarry Smith 
1595fee21e36SBarry Smith    Collective on SNES
1596fee21e36SBarry Smith 
1597c7afd0dbSLois Curfman McInnes    Input Parameters:
159870e92668SMatthew Knepley .  snes - the SNES context
1599c7afd0dbSLois Curfman McInnes 
1600272ac6f2SLois Curfman McInnes    Notes:
1601272ac6f2SLois Curfman McInnes    For basic use of the SNES solvers the user need not explicitly call
1602272ac6f2SLois Curfman McInnes    SNESSetUp(), since these actions will automatically occur during
1603272ac6f2SLois Curfman McInnes    the call to SNESSolve().  However, if one wishes to control this
1604272ac6f2SLois Curfman McInnes    phase separately, SNESSetUp() should be called after SNESCreate()
1605272ac6f2SLois Curfman McInnes    and optional routines of the form SNESSetXXX(), but before SNESSolve().
1606272ac6f2SLois Curfman McInnes 
160736851e7fSLois Curfman McInnes    Level: advanced
160836851e7fSLois Curfman McInnes 
16099b94acceSBarry Smith .keywords: SNES, nonlinear, setup
16109b94acceSBarry Smith 
16119b94acceSBarry Smith .seealso: SNESCreate(), SNESSolve(), SNESDestroy()
16129b94acceSBarry Smith @*/
16137087cfbeSBarry Smith PetscErrorCode  SNESSetUp(SNES snes)
16149b94acceSBarry Smith {
1615dfbe8321SBarry Smith   PetscErrorCode ierr;
16163a40ed3dSBarry Smith 
16173a40ed3dSBarry Smith   PetscFunctionBegin;
16180700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
16194dc4c822SBarry Smith   if (snes->setupcalled) PetscFunctionReturn(0);
16209b94acceSBarry Smith 
16217adad957SLisandro Dalcin   if (!((PetscObject)snes)->type_name) {
162285385478SLisandro Dalcin     ierr = SNESSetType(snes,SNESLS);CHKERRQ(ierr);
162385385478SLisandro Dalcin   }
162485385478SLisandro Dalcin 
1625c9b9fda1SJed Brown   if (!snes->vec_func) {
1626c9b9fda1SJed Brown     if (snes->vec_rhs) {
1627c9b9fda1SJed Brown       ierr = VecDuplicate(snes->vec_rhs,&snes->vec_func);CHKERRQ(ierr);
1628c9b9fda1SJed Brown     } else if (snes->vec_sol) {
1629c9b9fda1SJed Brown       ierr = VecDuplicate(snes->vec_sol,&snes->vec_func);CHKERRQ(ierr);
1630c9b9fda1SJed Brown     } else if (snes->dm) {
1631efd51863SBarry Smith       ierr = DMCreateGlobalVector(snes->dm,&snes->vec_func);CHKERRQ(ierr);
1632efd51863SBarry Smith     }
1633c9b9fda1SJed Brown   }
163417186662SBarry Smith   if (snes->vec_func == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be function vector");
163558c9b817SLisandro Dalcin   if (snes->vec_rhs  == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be right hand side vector");
163658c9b817SLisandro Dalcin 
163758c9b817SLisandro Dalcin   if (!snes->vec_sol_update /* && snes->vec_sol */) {
163858c9b817SLisandro Dalcin     ierr = VecDuplicate(snes->vec_sol,&snes->vec_sol_update);CHKERRQ(ierr);
163958c9b817SLisandro Dalcin     ierr = PetscLogObjectParent(snes,snes->vec_sol_update);CHKERRQ(ierr);
164058c9b817SLisandro Dalcin   }
164158c9b817SLisandro Dalcin 
1642ef8dffc7SBarry Smith   if (!snes->ops->computejacobian && snes->dm) {
1643ef8dffc7SBarry Smith     Mat J;
1644ef8dffc7SBarry Smith     ierr = DMGetMatrix(snes->dm,MATAIJ,&J);CHKERRQ(ierr);
1645cab2e9ccSBarry Smith     ierr = SNESSetJacobian(snes,J,J,SNESDMComputeJacobian,PETSC_NULL);CHKERRQ(ierr);
1646cab2e9ccSBarry Smith     ierr = MatDestroy(&J);CHKERRQ(ierr);
16472ef29e96SBarry Smith   } else if (!snes->jacobian && snes->ops->computejacobian == MatMFFDComputeJacobian) {
1648a8248277SBarry Smith     Mat J;
1649a8248277SBarry Smith     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
1650a8248277SBarry Smith     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
1651a8248277SBarry Smith     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
1652a8248277SBarry Smith     ierr = SNESSetJacobian(snes,J,J,MatMFFDComputeJacobian,snes->funP);CHKERRQ(ierr);
1653a8248277SBarry Smith     ierr = MatDestroy(&J);CHKERRQ(ierr);
1654a8248277SBarry Smith   } else if (snes->dm && snes->mf_operator && !snes->jacobian_pre && !snes->jacobian) {
1655a8248277SBarry Smith     Mat J,B;
1656a8248277SBarry Smith     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
1657a8248277SBarry Smith     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
1658a8248277SBarry Smith     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
1659a8248277SBarry Smith     ierr = DMGetMatrix(snes->dm,MATAIJ,&B);CHKERRQ(ierr);
1660a8248277SBarry Smith     ierr = SNESSetJacobian(snes,J,B,SNESDMComputeJacobian,snes->funP);CHKERRQ(ierr);
1661a8248277SBarry Smith     ierr = MatDestroy(&J);CHKERRQ(ierr);
1662a8248277SBarry Smith     ierr = MatDestroy(&B);CHKERRQ(ierr);
1663efd51863SBarry Smith   } else if (snes->dm && !snes->jacobian_pre){
1664efd51863SBarry Smith     Mat J;
1665efd51863SBarry Smith     ierr = DMGetMatrix(snes->dm,MATAIJ,&J);CHKERRQ(ierr);
16663cbb28f5SBarry Smith     ierr = SNESSetJacobian(snes,J,J,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
1667efd51863SBarry Smith     ierr = MatDestroy(&J);CHKERRQ(ierr);
1668ef8dffc7SBarry Smith   }
1669cfaf3a74SBarry Smith   if (!snes->ops->computefunction && !snes->dm) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_ARG_WRONGSTATE,"Must provide a residual function with SNESSetFunction() or call SNESSetDM()");
1670c9b9fda1SJed Brown   if (!snes->vec_func) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_ARG_WRONGSTATE,"Must provide a vector when calling SNESSetFunction() or call SNESSetDM()");
1671efd51863SBarry Smith 
1672b710008aSBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes, &snes->ksp);CHKERRQ(ierr);}
1673b710008aSBarry Smith 
1674d25893d9SBarry Smith   if (snes->ops->usercompute && !snes->user) {
1675d25893d9SBarry Smith     ierr = (*snes->ops->usercompute)(snes,(void**)&snes->user);CHKERRQ(ierr);
1676d25893d9SBarry Smith   }
1677d25893d9SBarry Smith 
1678410397dcSLisandro Dalcin   if (snes->ops->setup) {
1679410397dcSLisandro Dalcin     ierr = (*snes->ops->setup)(snes);CHKERRQ(ierr);
1680410397dcSLisandro Dalcin   }
168158c9b817SLisandro Dalcin 
16827aaed0d8SBarry Smith   snes->setupcalled = PETSC_TRUE;
16833a40ed3dSBarry Smith   PetscFunctionReturn(0);
16849b94acceSBarry Smith }
16859b94acceSBarry Smith 
16864a2ae208SSatish Balay #undef __FUNCT__
168737596af1SLisandro Dalcin #define __FUNCT__ "SNESReset"
168837596af1SLisandro Dalcin /*@
168937596af1SLisandro Dalcin    SNESReset - Resets a SNES context to the snessetupcalled = 0 state and removes any allocated Vecs and Mats
169037596af1SLisandro Dalcin 
169137596af1SLisandro Dalcin    Collective on SNES
169237596af1SLisandro Dalcin 
169337596af1SLisandro Dalcin    Input Parameter:
169437596af1SLisandro Dalcin .  snes - iterative context obtained from SNESCreate()
169537596af1SLisandro Dalcin 
1696d25893d9SBarry Smith    Level: intermediate
1697d25893d9SBarry Smith 
1698d25893d9SBarry Smith    Notes: Also calls the application context destroy routine set with SNESSetComputeApplicationContext()
169937596af1SLisandro Dalcin 
170037596af1SLisandro Dalcin .keywords: SNES, destroy
170137596af1SLisandro Dalcin 
170237596af1SLisandro Dalcin .seealso: SNESCreate(), SNESSetUp(), SNESSolve()
170337596af1SLisandro Dalcin @*/
170437596af1SLisandro Dalcin PetscErrorCode  SNESReset(SNES snes)
170537596af1SLisandro Dalcin {
170637596af1SLisandro Dalcin   PetscErrorCode ierr;
170737596af1SLisandro Dalcin 
170837596af1SLisandro Dalcin   PetscFunctionBegin;
170937596af1SLisandro Dalcin   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1710d25893d9SBarry Smith   if (snes->ops->userdestroy && snes->user) {
1711d25893d9SBarry Smith     ierr       = (*snes->ops->userdestroy)((void**)&snes->user);CHKERRQ(ierr);
1712d25893d9SBarry Smith     snes->user = PETSC_NULL;
1713d25893d9SBarry Smith   }
17148a23116dSBarry Smith   if (snes->pc) {
17158a23116dSBarry Smith     ierr = SNESReset(snes->pc);CHKERRQ(ierr);
17168a23116dSBarry Smith   }
17178a23116dSBarry Smith 
171837596af1SLisandro Dalcin   if (snes->ops->reset) {
171937596af1SLisandro Dalcin     ierr = (*snes->ops->reset)(snes);CHKERRQ(ierr);
172037596af1SLisandro Dalcin   }
172137596af1SLisandro Dalcin   if (snes->ksp) {ierr = KSPReset(snes->ksp);CHKERRQ(ierr);}
17226bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr);
17236bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr);
17246bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_sol_update);CHKERRQ(ierr);
17256bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr);
17266bf464f9SBarry Smith   ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr);
17276bf464f9SBarry Smith   ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr);
172837596af1SLisandro Dalcin   if (snes->work) {ierr = VecDestroyVecs(snes->nwork,&snes->work);CHKERRQ(ierr);}
172937596af1SLisandro Dalcin   if (snes->vwork) {ierr = VecDestroyVecs(snes->nvwork,&snes->vwork);CHKERRQ(ierr);}
173037596af1SLisandro Dalcin   snes->nwork = snes->nvwork = 0;
173137596af1SLisandro Dalcin   snes->setupcalled = PETSC_FALSE;
173237596af1SLisandro Dalcin   PetscFunctionReturn(0);
173337596af1SLisandro Dalcin }
173437596af1SLisandro Dalcin 
173537596af1SLisandro Dalcin #undef __FUNCT__
17364a2ae208SSatish Balay #define __FUNCT__ "SNESDestroy"
173752baeb72SSatish Balay /*@
17389b94acceSBarry Smith    SNESDestroy - Destroys the nonlinear solver context that was created
17399b94acceSBarry Smith    with SNESCreate().
17409b94acceSBarry Smith 
1741c7afd0dbSLois Curfman McInnes    Collective on SNES
1742c7afd0dbSLois Curfman McInnes 
17439b94acceSBarry Smith    Input Parameter:
17449b94acceSBarry Smith .  snes - the SNES context
17459b94acceSBarry Smith 
174636851e7fSLois Curfman McInnes    Level: beginner
174736851e7fSLois Curfman McInnes 
17489b94acceSBarry Smith .keywords: SNES, nonlinear, destroy
17499b94acceSBarry Smith 
175063a78c88SLois Curfman McInnes .seealso: SNESCreate(), SNESSolve()
17519b94acceSBarry Smith @*/
17526bf464f9SBarry Smith PetscErrorCode  SNESDestroy(SNES *snes)
17539b94acceSBarry Smith {
17546849ba73SBarry Smith   PetscErrorCode ierr;
17553a40ed3dSBarry Smith 
17563a40ed3dSBarry Smith   PetscFunctionBegin;
17576bf464f9SBarry Smith   if (!*snes) PetscFunctionReturn(0);
17586bf464f9SBarry Smith   PetscValidHeaderSpecific((*snes),SNES_CLASSID,1);
17596bf464f9SBarry Smith   if (--((PetscObject)(*snes))->refct > 0) {*snes = 0; PetscFunctionReturn(0);}
1760d4bb536fSBarry Smith 
17616bf464f9SBarry Smith   ierr = SNESReset((*snes));CHKERRQ(ierr);
17628a23116dSBarry Smith   ierr = SNESDestroy(&(*snes)->pc);CHKERRQ(ierr);
17636b8b9a38SLisandro Dalcin 
1764be0abb6dSBarry Smith   /* if memory was published with AMS then destroy it */
17656bf464f9SBarry Smith   ierr = PetscObjectDepublish((*snes));CHKERRQ(ierr);
17666bf464f9SBarry Smith   if ((*snes)->ops->destroy) {ierr = (*((*snes))->ops->destroy)((*snes));CHKERRQ(ierr);}
17676d4c513bSLisandro Dalcin 
17686bf464f9SBarry Smith   ierr = DMDestroy(&(*snes)->dm);CHKERRQ(ierr);
17696bf464f9SBarry Smith   ierr = KSPDestroy(&(*snes)->ksp);CHKERRQ(ierr);
17706b8b9a38SLisandro Dalcin 
17716bf464f9SBarry Smith   ierr = PetscFree((*snes)->kspconvctx);CHKERRQ(ierr);
17726bf464f9SBarry Smith   if ((*snes)->ops->convergeddestroy) {
17736bf464f9SBarry Smith     ierr = (*(*snes)->ops->convergeddestroy)((*snes)->cnvP);CHKERRQ(ierr);
17746b8b9a38SLisandro Dalcin   }
17756bf464f9SBarry Smith   if ((*snes)->conv_malloc) {
17766bf464f9SBarry Smith     ierr = PetscFree((*snes)->conv_hist);CHKERRQ(ierr);
17776bf464f9SBarry Smith     ierr = PetscFree((*snes)->conv_hist_its);CHKERRQ(ierr);
177858c9b817SLisandro Dalcin   }
1779ea630c6eSPeter Brune   ierr = PetscViewerDestroy(&(*snes)->ls_monitor);CHKERRQ(ierr);
17806bf464f9SBarry Smith   ierr = SNESMonitorCancel((*snes));CHKERRQ(ierr);
1781a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(snes);CHKERRQ(ierr);
17823a40ed3dSBarry Smith  PetscFunctionReturn(0);
17839b94acceSBarry Smith }
17849b94acceSBarry Smith 
17859b94acceSBarry Smith /* ----------- Routines to set solver parameters ---------- */
17869b94acceSBarry Smith 
17874a2ae208SSatish Balay #undef __FUNCT__
1788a8054027SBarry Smith #define __FUNCT__ "SNESSetLagPreconditioner"
1789a8054027SBarry Smith /*@
1790a8054027SBarry Smith    SNESSetLagPreconditioner - Determines when the preconditioner is rebuilt in the nonlinear solve.
1791a8054027SBarry Smith 
17923f9fe445SBarry Smith    Logically Collective on SNES
1793a8054027SBarry Smith 
1794a8054027SBarry Smith    Input Parameters:
1795a8054027SBarry Smith +  snes - the SNES context
1796a8054027SBarry Smith -  lag - -1 indicates NEVER rebuild, 1 means rebuild every time the Jacobian is computed within a single nonlinear solve, 2 means every second time
17973b4f5425SBarry Smith          the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that
1798a8054027SBarry Smith 
1799a8054027SBarry Smith    Options Database Keys:
1800a8054027SBarry Smith .    -snes_lag_preconditioner <lag>
1801a8054027SBarry Smith 
1802a8054027SBarry Smith    Notes:
1803a8054027SBarry Smith    The default is 1
1804a8054027SBarry Smith    The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
1805a8054027SBarry Smith    If  -1 is used before the very first nonlinear solve the preconditioner is still built because there is no previous preconditioner to use
1806a8054027SBarry Smith 
1807a8054027SBarry Smith    Level: intermediate
1808a8054027SBarry Smith 
1809a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
1810a8054027SBarry Smith 
1811e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian()
1812a8054027SBarry Smith 
1813a8054027SBarry Smith @*/
18147087cfbeSBarry Smith PetscErrorCode  SNESSetLagPreconditioner(SNES snes,PetscInt lag)
1815a8054027SBarry Smith {
1816a8054027SBarry Smith   PetscFunctionBegin;
18170700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1818e32f2f54SBarry Smith   if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater");
1819e32f2f54SBarry Smith   if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0");
1820c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,lag,2);
1821a8054027SBarry Smith   snes->lagpreconditioner = lag;
1822a8054027SBarry Smith   PetscFunctionReturn(0);
1823a8054027SBarry Smith }
1824a8054027SBarry Smith 
1825a8054027SBarry Smith #undef __FUNCT__
1826efd51863SBarry Smith #define __FUNCT__ "SNESSetGridSequence"
1827efd51863SBarry Smith /*@
1828efd51863SBarry Smith    SNESSetGridSequence - sets the number of steps of grid sequencing that SNES does
1829efd51863SBarry Smith 
1830efd51863SBarry Smith    Logically Collective on SNES
1831efd51863SBarry Smith 
1832efd51863SBarry Smith    Input Parameters:
1833efd51863SBarry Smith +  snes - the SNES context
1834efd51863SBarry Smith -  steps - the number of refinements to do, defaults to 0
1835efd51863SBarry Smith 
1836efd51863SBarry Smith    Options Database Keys:
1837efd51863SBarry Smith .    -snes_grid_sequence <steps>
1838efd51863SBarry Smith 
1839efd51863SBarry Smith    Level: intermediate
1840efd51863SBarry Smith 
1841efd51863SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
1842efd51863SBarry Smith 
1843efd51863SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian()
1844efd51863SBarry Smith 
1845efd51863SBarry Smith @*/
1846efd51863SBarry Smith PetscErrorCode  SNESSetGridSequence(SNES snes,PetscInt steps)
1847efd51863SBarry Smith {
1848efd51863SBarry Smith   PetscFunctionBegin;
1849efd51863SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1850efd51863SBarry Smith   PetscValidLogicalCollectiveInt(snes,steps,2);
1851efd51863SBarry Smith   snes->gridsequence = steps;
1852efd51863SBarry Smith   PetscFunctionReturn(0);
1853efd51863SBarry Smith }
1854efd51863SBarry Smith 
1855efd51863SBarry Smith #undef __FUNCT__
1856a8054027SBarry Smith #define __FUNCT__ "SNESGetLagPreconditioner"
1857a8054027SBarry Smith /*@
1858a8054027SBarry Smith    SNESGetLagPreconditioner - Indicates how often the preconditioner is rebuilt
1859a8054027SBarry Smith 
18603f9fe445SBarry Smith    Not Collective
1861a8054027SBarry Smith 
1862a8054027SBarry Smith    Input Parameter:
1863a8054027SBarry Smith .  snes - the SNES context
1864a8054027SBarry Smith 
1865a8054027SBarry Smith    Output Parameter:
1866a8054027SBarry Smith .   lag - -1 indicates NEVER rebuild, 1 means rebuild every time the Jacobian is computed within a single nonlinear solve, 2 means every second time
18673b4f5425SBarry Smith          the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that
1868a8054027SBarry Smith 
1869a8054027SBarry Smith    Options Database Keys:
1870a8054027SBarry Smith .    -snes_lag_preconditioner <lag>
1871a8054027SBarry Smith 
1872a8054027SBarry Smith    Notes:
1873a8054027SBarry Smith    The default is 1
1874a8054027SBarry Smith    The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
1875a8054027SBarry Smith 
1876a8054027SBarry Smith    Level: intermediate
1877a8054027SBarry Smith 
1878a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
1879a8054027SBarry Smith 
1880a8054027SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagPreconditioner()
1881a8054027SBarry Smith 
1882a8054027SBarry Smith @*/
18837087cfbeSBarry Smith PetscErrorCode  SNESGetLagPreconditioner(SNES snes,PetscInt *lag)
1884a8054027SBarry Smith {
1885a8054027SBarry Smith   PetscFunctionBegin;
18860700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1887a8054027SBarry Smith   *lag = snes->lagpreconditioner;
1888a8054027SBarry Smith   PetscFunctionReturn(0);
1889a8054027SBarry Smith }
1890a8054027SBarry Smith 
1891a8054027SBarry Smith #undef __FUNCT__
1892e35cf81dSBarry Smith #define __FUNCT__ "SNESSetLagJacobian"
1893e35cf81dSBarry Smith /*@
1894e35cf81dSBarry Smith    SNESSetLagJacobian - Determines when the Jacobian is rebuilt in the nonlinear solve. See SNESSetLagPreconditioner() for determining how
1895e35cf81dSBarry Smith      often the preconditioner is rebuilt.
1896e35cf81dSBarry Smith 
18973f9fe445SBarry Smith    Logically Collective on SNES
1898e35cf81dSBarry Smith 
1899e35cf81dSBarry Smith    Input Parameters:
1900e35cf81dSBarry Smith +  snes - the SNES context
1901e35cf81dSBarry Smith -  lag - -1 indicates NEVER rebuild, 1 means rebuild every time the Jacobian is computed within a single nonlinear solve, 2 means every second time
1902fe3ffe1eSBarry Smith          the Jacobian is built etc. -2 means rebuild at next chance but then never again
1903e35cf81dSBarry Smith 
1904e35cf81dSBarry Smith    Options Database Keys:
1905e35cf81dSBarry Smith .    -snes_lag_jacobian <lag>
1906e35cf81dSBarry Smith 
1907e35cf81dSBarry Smith    Notes:
1908e35cf81dSBarry Smith    The default is 1
1909e35cf81dSBarry Smith    The Jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
1910fe3ffe1eSBarry Smith    If  -1 is used before the very first nonlinear solve the CODE WILL FAIL! because no Jacobian is used, use -2 to indicate you want it recomputed
1911fe3ffe1eSBarry Smith    at the next Newton step but never again (unless it is reset to another value)
1912e35cf81dSBarry Smith 
1913e35cf81dSBarry Smith    Level: intermediate
1914e35cf81dSBarry Smith 
1915e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
1916e35cf81dSBarry Smith 
1917e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagPreconditioner(), SNESGetLagJacobian()
1918e35cf81dSBarry Smith 
1919e35cf81dSBarry Smith @*/
19207087cfbeSBarry Smith PetscErrorCode  SNESSetLagJacobian(SNES snes,PetscInt lag)
1921e35cf81dSBarry Smith {
1922e35cf81dSBarry Smith   PetscFunctionBegin;
19230700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1924e32f2f54SBarry Smith   if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater");
1925e32f2f54SBarry Smith   if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0");
1926c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,lag,2);
1927e35cf81dSBarry Smith   snes->lagjacobian = lag;
1928e35cf81dSBarry Smith   PetscFunctionReturn(0);
1929e35cf81dSBarry Smith }
1930e35cf81dSBarry Smith 
1931e35cf81dSBarry Smith #undef __FUNCT__
1932e35cf81dSBarry Smith #define __FUNCT__ "SNESGetLagJacobian"
1933e35cf81dSBarry Smith /*@
1934e35cf81dSBarry Smith    SNESGetLagJacobian - Indicates how often the Jacobian is rebuilt. See SNESGetLagPreconditioner() to determine when the preconditioner is rebuilt
1935e35cf81dSBarry Smith 
19363f9fe445SBarry Smith    Not Collective
1937e35cf81dSBarry Smith 
1938e35cf81dSBarry Smith    Input Parameter:
1939e35cf81dSBarry Smith .  snes - the SNES context
1940e35cf81dSBarry Smith 
1941e35cf81dSBarry Smith    Output Parameter:
1942e35cf81dSBarry Smith .   lag - -1 indicates NEVER rebuild, 1 means rebuild every time the Jacobian is computed within a single nonlinear solve, 2 means every second time
1943e35cf81dSBarry Smith          the Jacobian is built etc.
1944e35cf81dSBarry Smith 
1945e35cf81dSBarry Smith    Options Database Keys:
1946e35cf81dSBarry Smith .    -snes_lag_jacobian <lag>
1947e35cf81dSBarry Smith 
1948e35cf81dSBarry Smith    Notes:
1949e35cf81dSBarry Smith    The default is 1
1950e35cf81dSBarry Smith    The jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
1951e35cf81dSBarry Smith 
1952e35cf81dSBarry Smith    Level: intermediate
1953e35cf81dSBarry Smith 
1954e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
1955e35cf81dSBarry Smith 
1956e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagJacobian(), SNESSetLagPreconditioner(), SNESGetLagPreconditioner()
1957e35cf81dSBarry Smith 
1958e35cf81dSBarry Smith @*/
19597087cfbeSBarry Smith PetscErrorCode  SNESGetLagJacobian(SNES snes,PetscInt *lag)
1960e35cf81dSBarry Smith {
1961e35cf81dSBarry Smith   PetscFunctionBegin;
19620700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1963e35cf81dSBarry Smith   *lag = snes->lagjacobian;
1964e35cf81dSBarry Smith   PetscFunctionReturn(0);
1965e35cf81dSBarry Smith }
1966e35cf81dSBarry Smith 
1967e35cf81dSBarry Smith #undef __FUNCT__
19684a2ae208SSatish Balay #define __FUNCT__ "SNESSetTolerances"
19699b94acceSBarry Smith /*@
1970d7a720efSLois Curfman McInnes    SNESSetTolerances - Sets various parameters used in convergence tests.
19719b94acceSBarry Smith 
19723f9fe445SBarry Smith    Logically Collective on SNES
1973c7afd0dbSLois Curfman McInnes 
19749b94acceSBarry Smith    Input Parameters:
1975c7afd0dbSLois Curfman McInnes +  snes - the SNES context
197670441072SBarry Smith .  abstol - absolute convergence tolerance
197733174efeSLois Curfman McInnes .  rtol - relative convergence tolerance
197833174efeSLois Curfman McInnes .  stol -  convergence tolerance in terms of the norm
197933174efeSLois Curfman McInnes            of the change in the solution between steps
198033174efeSLois Curfman McInnes .  maxit - maximum number of iterations
1981c7afd0dbSLois Curfman McInnes -  maxf - maximum number of function evaluations
1982fee21e36SBarry Smith 
198333174efeSLois Curfman McInnes    Options Database Keys:
198470441072SBarry Smith +    -snes_atol <abstol> - Sets abstol
1985c7afd0dbSLois Curfman McInnes .    -snes_rtol <rtol> - Sets rtol
1986c7afd0dbSLois Curfman McInnes .    -snes_stol <stol> - Sets stol
1987c7afd0dbSLois Curfman McInnes .    -snes_max_it <maxit> - Sets maxit
1988c7afd0dbSLois Curfman McInnes -    -snes_max_funcs <maxf> - Sets maxf
19899b94acceSBarry Smith 
1990d7a720efSLois Curfman McInnes    Notes:
19919b94acceSBarry Smith    The default maximum number of iterations is 50.
19929b94acceSBarry Smith    The default maximum number of function evaluations is 1000.
19939b94acceSBarry Smith 
199436851e7fSLois Curfman McInnes    Level: intermediate
199536851e7fSLois Curfman McInnes 
199633174efeSLois Curfman McInnes .keywords: SNES, nonlinear, set, convergence, tolerances
19979b94acceSBarry Smith 
19982492ecdbSBarry Smith .seealso: SNESSetTrustRegionTolerance()
19999b94acceSBarry Smith @*/
20007087cfbeSBarry Smith PetscErrorCode  SNESSetTolerances(SNES snes,PetscReal abstol,PetscReal rtol,PetscReal stol,PetscInt maxit,PetscInt maxf)
20019b94acceSBarry Smith {
20023a40ed3dSBarry Smith   PetscFunctionBegin;
20030700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2004c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,abstol,2);
2005c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol,3);
2006c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,stol,4);
2007c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxit,5);
2008c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxf,6);
2009c5eb9154SBarry Smith 
2010ab54825eSJed Brown   if (abstol != PETSC_DEFAULT) {
2011ab54825eSJed Brown     if (abstol < 0.0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Absolute tolerance %G must be non-negative",abstol);
2012ab54825eSJed Brown     snes->abstol = abstol;
2013ab54825eSJed Brown   }
2014ab54825eSJed Brown   if (rtol != PETSC_DEFAULT) {
2015ab54825eSJed Brown     if (rtol < 0.0 || 1.0 <= rtol) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Relative tolerance %G must be non-negative and less than 1.0",rtol);
2016ab54825eSJed Brown     snes->rtol = rtol;
2017ab54825eSJed Brown   }
2018ab54825eSJed Brown   if (stol != PETSC_DEFAULT) {
2019ab54825eSJed Brown     if (stol < 0.0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Step tolerance %G must be non-negative",stol);
2020ab54825eSJed Brown     snes->xtol = stol;
2021ab54825eSJed Brown   }
2022ab54825eSJed Brown   if (maxit != PETSC_DEFAULT) {
2023ab54825eSJed Brown     if (maxit < 0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of iterations %D must be non-negative",maxit);
2024ab54825eSJed Brown     snes->max_its = maxit;
2025ab54825eSJed Brown   }
2026ab54825eSJed Brown   if (maxf != PETSC_DEFAULT) {
2027ab54825eSJed Brown     if (maxf < 0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of function evaluations %D must be non-negative",maxf);
2028ab54825eSJed Brown     snes->max_funcs = maxf;
2029ab54825eSJed Brown   }
20303a40ed3dSBarry Smith   PetscFunctionReturn(0);
20319b94acceSBarry Smith }
20329b94acceSBarry Smith 
20334a2ae208SSatish Balay #undef __FUNCT__
20344a2ae208SSatish Balay #define __FUNCT__ "SNESGetTolerances"
20359b94acceSBarry Smith /*@
203633174efeSLois Curfman McInnes    SNESGetTolerances - Gets various parameters used in convergence tests.
203733174efeSLois Curfman McInnes 
2038c7afd0dbSLois Curfman McInnes    Not Collective
2039c7afd0dbSLois Curfman McInnes 
204033174efeSLois Curfman McInnes    Input Parameters:
2041c7afd0dbSLois Curfman McInnes +  snes - the SNES context
204285385478SLisandro Dalcin .  atol - absolute convergence tolerance
204333174efeSLois Curfman McInnes .  rtol - relative convergence tolerance
204433174efeSLois Curfman McInnes .  stol -  convergence tolerance in terms of the norm
204533174efeSLois Curfman McInnes            of the change in the solution between steps
204633174efeSLois Curfman McInnes .  maxit - maximum number of iterations
2047c7afd0dbSLois Curfman McInnes -  maxf - maximum number of function evaluations
2048fee21e36SBarry Smith 
204933174efeSLois Curfman McInnes    Notes:
205033174efeSLois Curfman McInnes    The user can specify PETSC_NULL for any parameter that is not needed.
205133174efeSLois Curfman McInnes 
205236851e7fSLois Curfman McInnes    Level: intermediate
205336851e7fSLois Curfman McInnes 
205433174efeSLois Curfman McInnes .keywords: SNES, nonlinear, get, convergence, tolerances
205533174efeSLois Curfman McInnes 
205633174efeSLois Curfman McInnes .seealso: SNESSetTolerances()
205733174efeSLois Curfman McInnes @*/
20587087cfbeSBarry Smith PetscErrorCode  SNESGetTolerances(SNES snes,PetscReal *atol,PetscReal *rtol,PetscReal *stol,PetscInt *maxit,PetscInt *maxf)
205933174efeSLois Curfman McInnes {
20603a40ed3dSBarry Smith   PetscFunctionBegin;
20610700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
206285385478SLisandro Dalcin   if (atol)  *atol  = snes->abstol;
206333174efeSLois Curfman McInnes   if (rtol)  *rtol  = snes->rtol;
206433174efeSLois Curfman McInnes   if (stol)  *stol  = snes->xtol;
206533174efeSLois Curfman McInnes   if (maxit) *maxit = snes->max_its;
206633174efeSLois Curfman McInnes   if (maxf)  *maxf  = snes->max_funcs;
20673a40ed3dSBarry Smith   PetscFunctionReturn(0);
206833174efeSLois Curfman McInnes }
206933174efeSLois Curfman McInnes 
20704a2ae208SSatish Balay #undef __FUNCT__
20714a2ae208SSatish Balay #define __FUNCT__ "SNESSetTrustRegionTolerance"
207233174efeSLois Curfman McInnes /*@
20739b94acceSBarry Smith    SNESSetTrustRegionTolerance - Sets the trust region parameter tolerance.
20749b94acceSBarry Smith 
20753f9fe445SBarry Smith    Logically Collective on SNES
2076fee21e36SBarry Smith 
2077c7afd0dbSLois Curfman McInnes    Input Parameters:
2078c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2079c7afd0dbSLois Curfman McInnes -  tol - tolerance
2080c7afd0dbSLois Curfman McInnes 
20819b94acceSBarry Smith    Options Database Key:
2082c7afd0dbSLois Curfman McInnes .  -snes_trtol <tol> - Sets tol
20839b94acceSBarry Smith 
208436851e7fSLois Curfman McInnes    Level: intermediate
208536851e7fSLois Curfman McInnes 
20869b94acceSBarry Smith .keywords: SNES, nonlinear, set, trust region, tolerance
20879b94acceSBarry Smith 
20882492ecdbSBarry Smith .seealso: SNESSetTolerances()
20899b94acceSBarry Smith @*/
20907087cfbeSBarry Smith PetscErrorCode  SNESSetTrustRegionTolerance(SNES snes,PetscReal tol)
20919b94acceSBarry Smith {
20923a40ed3dSBarry Smith   PetscFunctionBegin;
20930700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2094c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,tol,2);
20959b94acceSBarry Smith   snes->deltatol = tol;
20963a40ed3dSBarry Smith   PetscFunctionReturn(0);
20979b94acceSBarry Smith }
20989b94acceSBarry Smith 
2099df9fa365SBarry Smith /*
2100df9fa365SBarry Smith    Duplicate the lg monitors for SNES from KSP; for some reason with
2101df9fa365SBarry Smith    dynamic libraries things don't work under Sun4 if we just use
2102df9fa365SBarry Smith    macros instead of functions
2103df9fa365SBarry Smith */
21044a2ae208SSatish Balay #undef __FUNCT__
2105a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLG"
21067087cfbeSBarry Smith PetscErrorCode  SNESMonitorLG(SNES snes,PetscInt it,PetscReal norm,void *ctx)
2107ce1608b8SBarry Smith {
2108dfbe8321SBarry Smith   PetscErrorCode ierr;
2109ce1608b8SBarry Smith 
2110ce1608b8SBarry Smith   PetscFunctionBegin;
21110700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2112a6570f20SBarry Smith   ierr = KSPMonitorLG((KSP)snes,it,norm,ctx);CHKERRQ(ierr);
2113ce1608b8SBarry Smith   PetscFunctionReturn(0);
2114ce1608b8SBarry Smith }
2115ce1608b8SBarry Smith 
21164a2ae208SSatish Balay #undef __FUNCT__
2117a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGCreate"
21187087cfbeSBarry Smith PetscErrorCode  SNESMonitorLGCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw)
2119df9fa365SBarry Smith {
2120dfbe8321SBarry Smith   PetscErrorCode ierr;
2121df9fa365SBarry Smith 
2122df9fa365SBarry Smith   PetscFunctionBegin;
2123a6570f20SBarry Smith   ierr = KSPMonitorLGCreate(host,label,x,y,m,n,draw);CHKERRQ(ierr);
2124df9fa365SBarry Smith   PetscFunctionReturn(0);
2125df9fa365SBarry Smith }
2126df9fa365SBarry Smith 
21274a2ae208SSatish Balay #undef __FUNCT__
2128a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGDestroy"
21296bf464f9SBarry Smith PetscErrorCode  SNESMonitorLGDestroy(PetscDrawLG *draw)
2130df9fa365SBarry Smith {
2131dfbe8321SBarry Smith   PetscErrorCode ierr;
2132df9fa365SBarry Smith 
2133df9fa365SBarry Smith   PetscFunctionBegin;
2134a6570f20SBarry Smith   ierr = KSPMonitorLGDestroy(draw);CHKERRQ(ierr);
2135df9fa365SBarry Smith   PetscFunctionReturn(0);
2136df9fa365SBarry Smith }
2137df9fa365SBarry Smith 
21387087cfbeSBarry Smith extern PetscErrorCode  SNESMonitorRange_Private(SNES,PetscInt,PetscReal*);
2139b271bb04SBarry Smith #undef __FUNCT__
2140b271bb04SBarry Smith #define __FUNCT__ "SNESMonitorLGRange"
21417087cfbeSBarry Smith PetscErrorCode  SNESMonitorLGRange(SNES snes,PetscInt n,PetscReal rnorm,void *monctx)
2142b271bb04SBarry Smith {
2143b271bb04SBarry Smith   PetscDrawLG      lg;
2144b271bb04SBarry Smith   PetscErrorCode   ierr;
2145b271bb04SBarry Smith   PetscReal        x,y,per;
2146b271bb04SBarry Smith   PetscViewer      v = (PetscViewer)monctx;
2147b271bb04SBarry Smith   static PetscReal prev; /* should be in the context */
2148b271bb04SBarry Smith   PetscDraw        draw;
2149b271bb04SBarry Smith   PetscFunctionBegin;
2150b271bb04SBarry Smith   if (!monctx) {
2151b271bb04SBarry Smith     MPI_Comm    comm;
2152b271bb04SBarry Smith 
2153b271bb04SBarry Smith     ierr   = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr);
2154b271bb04SBarry Smith     v      = PETSC_VIEWER_DRAW_(comm);
2155b271bb04SBarry Smith   }
2156b271bb04SBarry Smith   ierr   = PetscViewerDrawGetDrawLG(v,0,&lg);CHKERRQ(ierr);
2157b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
2158b271bb04SBarry Smith   ierr   = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
2159b271bb04SBarry Smith   ierr   = PetscDrawSetTitle(draw,"Residual norm");CHKERRQ(ierr);
2160b271bb04SBarry Smith   x = (PetscReal) n;
2161b271bb04SBarry Smith   if (rnorm > 0.0) y = log10(rnorm); else y = -15.0;
2162b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
2163b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
2164b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
2165b271bb04SBarry Smith   }
2166b271bb04SBarry Smith 
2167b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,1,&lg);CHKERRQ(ierr);
2168b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
2169b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
2170b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"% elemts > .2*max elemt");CHKERRQ(ierr);
2171b271bb04SBarry Smith   ierr =  SNESMonitorRange_Private(snes,n,&per);CHKERRQ(ierr);
2172b271bb04SBarry Smith   x = (PetscReal) n;
2173b271bb04SBarry Smith   y = 100.0*per;
2174b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
2175b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
2176b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
2177b271bb04SBarry Smith   }
2178b271bb04SBarry Smith 
2179b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,2,&lg);CHKERRQ(ierr);
2180b271bb04SBarry Smith   if (!n) {prev = rnorm;ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
2181b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
2182b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm");CHKERRQ(ierr);
2183b271bb04SBarry Smith   x = (PetscReal) n;
2184b271bb04SBarry Smith   y = (prev - rnorm)/prev;
2185b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
2186b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
2187b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
2188b271bb04SBarry Smith   }
2189b271bb04SBarry Smith 
2190b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,3,&lg);CHKERRQ(ierr);
2191b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
2192b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
2193b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm*(% > .2 max)");CHKERRQ(ierr);
2194b271bb04SBarry Smith   x = (PetscReal) n;
2195b271bb04SBarry Smith   y = (prev - rnorm)/(prev*per);
2196b271bb04SBarry Smith   if (n > 2) { /*skip initial crazy value */
2197b271bb04SBarry Smith     ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
2198b271bb04SBarry Smith   }
2199b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
2200b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
2201b271bb04SBarry Smith   }
2202b271bb04SBarry Smith   prev = rnorm;
2203b271bb04SBarry Smith   PetscFunctionReturn(0);
2204b271bb04SBarry Smith }
2205b271bb04SBarry Smith 
2206b271bb04SBarry Smith #undef __FUNCT__
2207b271bb04SBarry Smith #define __FUNCT__ "SNESMonitorLGRangeCreate"
22087087cfbeSBarry Smith PetscErrorCode  SNESMonitorLGRangeCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw)
2209b271bb04SBarry Smith {
2210b271bb04SBarry Smith   PetscErrorCode ierr;
2211b271bb04SBarry Smith 
2212b271bb04SBarry Smith   PetscFunctionBegin;
2213b271bb04SBarry Smith   ierr = KSPMonitorLGCreate(host,label,x,y,m,n,draw);CHKERRQ(ierr);
2214b271bb04SBarry Smith   PetscFunctionReturn(0);
2215b271bb04SBarry Smith }
2216b271bb04SBarry Smith 
2217b271bb04SBarry Smith #undef __FUNCT__
2218b271bb04SBarry Smith #define __FUNCT__ "SNESMonitorLGRangeDestroy"
22196bf464f9SBarry Smith PetscErrorCode  SNESMonitorLGRangeDestroy(PetscDrawLG *draw)
2220b271bb04SBarry Smith {
2221b271bb04SBarry Smith   PetscErrorCode ierr;
2222b271bb04SBarry Smith 
2223b271bb04SBarry Smith   PetscFunctionBegin;
2224b271bb04SBarry Smith   ierr = KSPMonitorLGDestroy(draw);CHKERRQ(ierr);
2225b271bb04SBarry Smith   PetscFunctionReturn(0);
2226b271bb04SBarry Smith }
2227b271bb04SBarry Smith 
22287a03ce2fSLisandro Dalcin #undef __FUNCT__
22297a03ce2fSLisandro Dalcin #define __FUNCT__ "SNESMonitor"
2230228d79bcSJed Brown /*@
2231228d79bcSJed Brown    SNESMonitor - runs the user provided monitor routines, if they exist
2232228d79bcSJed Brown 
2233228d79bcSJed Brown    Collective on SNES
2234228d79bcSJed Brown 
2235228d79bcSJed Brown    Input Parameters:
2236228d79bcSJed Brown +  snes - nonlinear solver context obtained from SNESCreate()
2237228d79bcSJed Brown .  iter - iteration number
2238228d79bcSJed Brown -  rnorm - relative norm of the residual
2239228d79bcSJed Brown 
2240228d79bcSJed Brown    Notes:
2241228d79bcSJed Brown    This routine is called by the SNES implementations.
2242228d79bcSJed Brown    It does not typically need to be called by the user.
2243228d79bcSJed Brown 
2244228d79bcSJed Brown    Level: developer
2245228d79bcSJed Brown 
2246228d79bcSJed Brown .seealso: SNESMonitorSet()
2247228d79bcSJed Brown @*/
22487a03ce2fSLisandro Dalcin PetscErrorCode  SNESMonitor(SNES snes,PetscInt iter,PetscReal rnorm)
22497a03ce2fSLisandro Dalcin {
22507a03ce2fSLisandro Dalcin   PetscErrorCode ierr;
22517a03ce2fSLisandro Dalcin   PetscInt       i,n = snes->numbermonitors;
22527a03ce2fSLisandro Dalcin 
22537a03ce2fSLisandro Dalcin   PetscFunctionBegin;
22547a03ce2fSLisandro Dalcin   for (i=0; i<n; i++) {
22557a03ce2fSLisandro Dalcin     ierr = (*snes->monitor[i])(snes,iter,rnorm,snes->monitorcontext[i]);CHKERRQ(ierr);
22567a03ce2fSLisandro Dalcin   }
22577a03ce2fSLisandro Dalcin   PetscFunctionReturn(0);
22587a03ce2fSLisandro Dalcin }
22597a03ce2fSLisandro Dalcin 
22609b94acceSBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
22619b94acceSBarry Smith 
22624a2ae208SSatish Balay #undef __FUNCT__
2263a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorSet"
22649b94acceSBarry Smith /*@C
2265a6570f20SBarry Smith    SNESMonitorSet - Sets an ADDITIONAL function that is to be used at every
22669b94acceSBarry Smith    iteration of the nonlinear solver to display the iteration's
22679b94acceSBarry Smith    progress.
22689b94acceSBarry Smith 
22693f9fe445SBarry Smith    Logically Collective on SNES
2270fee21e36SBarry Smith 
2271c7afd0dbSLois Curfman McInnes    Input Parameters:
2272c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2273c7afd0dbSLois Curfman McInnes .  func - monitoring routine
2274b8a78c4aSBarry Smith .  mctx - [optional] user-defined context for private data for the
2275e8105e01SRichard Katz           monitor routine (use PETSC_NULL if no context is desired)
2276b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
2277b3006f0bSLois Curfman McInnes           (may be PETSC_NULL)
22789b94acceSBarry Smith 
2279c7afd0dbSLois Curfman McInnes    Calling sequence of func:
2280a7cc72afSBarry Smith $     int func(SNES snes,PetscInt its, PetscReal norm,void *mctx)
2281c7afd0dbSLois Curfman McInnes 
2282c7afd0dbSLois Curfman McInnes +    snes - the SNES context
2283c7afd0dbSLois Curfman McInnes .    its - iteration number
2284c7afd0dbSLois Curfman McInnes .    norm - 2-norm function value (may be estimated)
228540a0c1c6SLois Curfman McInnes -    mctx - [optional] monitoring context
22869b94acceSBarry Smith 
22879665c990SLois Curfman McInnes    Options Database Keys:
2288a6570f20SBarry Smith +    -snes_monitor        - sets SNESMonitorDefault()
2289a6570f20SBarry Smith .    -snes_monitor_draw    - sets line graph monitor,
2290a6570f20SBarry Smith                             uses SNESMonitorLGCreate()
2291cca6129bSJed Brown -    -snes_monitor_cancel - cancels all monitors that have
2292c7afd0dbSLois Curfman McInnes                             been hardwired into a code by
2293a6570f20SBarry Smith                             calls to SNESMonitorSet(), but
2294c7afd0dbSLois Curfman McInnes                             does not cancel those set via
2295c7afd0dbSLois Curfman McInnes                             the options database.
22969665c990SLois Curfman McInnes 
2297639f9d9dSBarry Smith    Notes:
22986bc08f3fSLois Curfman McInnes    Several different monitoring routines may be set by calling
2299a6570f20SBarry Smith    SNESMonitorSet() multiple times; all will be called in the
23006bc08f3fSLois Curfman McInnes    order in which they were set.
2301639f9d9dSBarry Smith 
2302025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each SNES object
2303025f1a04SBarry Smith 
230436851e7fSLois Curfman McInnes    Level: intermediate
230536851e7fSLois Curfman McInnes 
23069b94acceSBarry Smith .keywords: SNES, nonlinear, set, monitor
23079b94acceSBarry Smith 
2308a6570f20SBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorCancel()
23099b94acceSBarry Smith @*/
2310c2efdce3SBarry Smith PetscErrorCode  SNESMonitorSet(SNES snes,PetscErrorCode (*monitor)(SNES,PetscInt,PetscReal,void*),void *mctx,PetscErrorCode (*monitordestroy)(void**))
23119b94acceSBarry Smith {
2312b90d0a6eSBarry Smith   PetscInt       i;
2313649052a6SBarry Smith   PetscErrorCode ierr;
2314b90d0a6eSBarry Smith 
23153a40ed3dSBarry Smith   PetscFunctionBegin;
23160700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
231717186662SBarry Smith   if (snes->numbermonitors >= MAXSNESMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
2318b90d0a6eSBarry Smith   for (i=0; i<snes->numbermonitors;i++) {
2319649052a6SBarry Smith     if (monitor == snes->monitor[i] && monitordestroy == snes->monitordestroy[i] && mctx == snes->monitorcontext[i]) {
2320649052a6SBarry Smith       if (monitordestroy) {
2321c2efdce3SBarry Smith         ierr = (*monitordestroy)(&mctx);CHKERRQ(ierr);
2322649052a6SBarry Smith       }
2323b90d0a6eSBarry Smith       PetscFunctionReturn(0);
2324b90d0a6eSBarry Smith     }
2325b90d0a6eSBarry Smith   }
2326b90d0a6eSBarry Smith   snes->monitor[snes->numbermonitors]           = monitor;
2327b8a78c4aSBarry Smith   snes->monitordestroy[snes->numbermonitors]    = monitordestroy;
2328639f9d9dSBarry Smith   snes->monitorcontext[snes->numbermonitors++]  = (void*)mctx;
23293a40ed3dSBarry Smith   PetscFunctionReturn(0);
23309b94acceSBarry Smith }
23319b94acceSBarry Smith 
23324a2ae208SSatish Balay #undef __FUNCT__
2333a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorCancel"
23345cd90555SBarry Smith /*@C
2335a6570f20SBarry Smith    SNESMonitorCancel - Clears all the monitor functions for a SNES object.
23365cd90555SBarry Smith 
23373f9fe445SBarry Smith    Logically Collective on SNES
2338c7afd0dbSLois Curfman McInnes 
23395cd90555SBarry Smith    Input Parameters:
23405cd90555SBarry Smith .  snes - the SNES context
23415cd90555SBarry Smith 
23421a480d89SAdministrator    Options Database Key:
2343a6570f20SBarry Smith .  -snes_monitor_cancel - cancels all monitors that have been hardwired
2344a6570f20SBarry Smith     into a code by calls to SNESMonitorSet(), but does not cancel those
2345c7afd0dbSLois Curfman McInnes     set via the options database
23465cd90555SBarry Smith 
23475cd90555SBarry Smith    Notes:
23485cd90555SBarry Smith    There is no way to clear one specific monitor from a SNES object.
23495cd90555SBarry Smith 
235036851e7fSLois Curfman McInnes    Level: intermediate
235136851e7fSLois Curfman McInnes 
23525cd90555SBarry Smith .keywords: SNES, nonlinear, set, monitor
23535cd90555SBarry Smith 
2354a6570f20SBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorSet()
23555cd90555SBarry Smith @*/
23567087cfbeSBarry Smith PetscErrorCode  SNESMonitorCancel(SNES snes)
23575cd90555SBarry Smith {
2358d952e501SBarry Smith   PetscErrorCode ierr;
2359d952e501SBarry Smith   PetscInt       i;
2360d952e501SBarry Smith 
23615cd90555SBarry Smith   PetscFunctionBegin;
23620700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2363d952e501SBarry Smith   for (i=0; i<snes->numbermonitors; i++) {
2364d952e501SBarry Smith     if (snes->monitordestroy[i]) {
23653c4aec1bSBarry Smith       ierr = (*snes->monitordestroy[i])(&snes->monitorcontext[i]);CHKERRQ(ierr);
2366d952e501SBarry Smith     }
2367d952e501SBarry Smith   }
23685cd90555SBarry Smith   snes->numbermonitors = 0;
23695cd90555SBarry Smith   PetscFunctionReturn(0);
23705cd90555SBarry Smith }
23715cd90555SBarry Smith 
23724a2ae208SSatish Balay #undef __FUNCT__
23734a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceTest"
23749b94acceSBarry Smith /*@C
23759b94acceSBarry Smith    SNESSetConvergenceTest - Sets the function that is to be used
23769b94acceSBarry Smith    to test for convergence of the nonlinear iterative solution.
23779b94acceSBarry Smith 
23783f9fe445SBarry Smith    Logically Collective on SNES
2379fee21e36SBarry Smith 
2380c7afd0dbSLois Curfman McInnes    Input Parameters:
2381c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2382c7afd0dbSLois Curfman McInnes .  func - routine to test for convergence
23837f7931b9SBarry Smith .  cctx - [optional] context for private data for the convergence routine  (may be PETSC_NULL)
23847f7931b9SBarry Smith -  destroy - [optional] destructor for the context (may be PETSC_NULL; PETSC_NULL_FUNCTION in Fortran)
23859b94acceSBarry Smith 
2386c7afd0dbSLois Curfman McInnes    Calling sequence of func:
238706ee9f85SBarry Smith $     PetscErrorCode func (SNES snes,PetscInt it,PetscReal xnorm,PetscReal gnorm,PetscReal f,SNESConvergedReason *reason,void *cctx)
2388c7afd0dbSLois Curfman McInnes 
2389c7afd0dbSLois Curfman McInnes +    snes - the SNES context
239006ee9f85SBarry Smith .    it - current iteration (0 is the first and is before any Newton step)
2391c7afd0dbSLois Curfman McInnes .    cctx - [optional] convergence context
2392184914b5SBarry Smith .    reason - reason for convergence/divergence
2393c7afd0dbSLois Curfman McInnes .    xnorm - 2-norm of current iterate
23944b27c08aSLois Curfman McInnes .    gnorm - 2-norm of current step
23954b27c08aSLois Curfman McInnes -    f - 2-norm of function
23969b94acceSBarry Smith 
239736851e7fSLois Curfman McInnes    Level: advanced
239836851e7fSLois Curfman McInnes 
23999b94acceSBarry Smith .keywords: SNES, nonlinear, set, convergence, test
24009b94acceSBarry Smith 
240185385478SLisandro Dalcin .seealso: SNESDefaultConverged(), SNESSkipConverged()
24029b94acceSBarry Smith @*/
24037087cfbeSBarry Smith PetscErrorCode  SNESSetConvergenceTest(SNES snes,PetscErrorCode (*func)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void *cctx,PetscErrorCode (*destroy)(void*))
24049b94acceSBarry Smith {
24057f7931b9SBarry Smith   PetscErrorCode ierr;
24067f7931b9SBarry Smith 
24073a40ed3dSBarry Smith   PetscFunctionBegin;
24080700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
240985385478SLisandro Dalcin   if (!func) func = SNESSkipConverged;
24107f7931b9SBarry Smith   if (snes->ops->convergeddestroy) {
24117f7931b9SBarry Smith     ierr = (*snes->ops->convergeddestroy)(snes->cnvP);CHKERRQ(ierr);
24127f7931b9SBarry Smith   }
241385385478SLisandro Dalcin   snes->ops->converged        = func;
24147f7931b9SBarry Smith   snes->ops->convergeddestroy = destroy;
241585385478SLisandro Dalcin   snes->cnvP                  = cctx;
24163a40ed3dSBarry Smith   PetscFunctionReturn(0);
24179b94acceSBarry Smith }
24189b94acceSBarry Smith 
24194a2ae208SSatish Balay #undef __FUNCT__
24204a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergedReason"
242152baeb72SSatish Balay /*@
2422184914b5SBarry Smith    SNESGetConvergedReason - Gets the reason the SNES iteration was stopped.
2423184914b5SBarry Smith 
2424184914b5SBarry Smith    Not Collective
2425184914b5SBarry Smith 
2426184914b5SBarry Smith    Input Parameter:
2427184914b5SBarry Smith .  snes - the SNES context
2428184914b5SBarry Smith 
2429184914b5SBarry Smith    Output Parameter:
24304d0a8057SBarry Smith .  reason - negative value indicates diverged, positive value converged, see SNESConvergedReason or the
2431184914b5SBarry Smith             manual pages for the individual convergence tests for complete lists
2432184914b5SBarry Smith 
2433184914b5SBarry Smith    Level: intermediate
2434184914b5SBarry Smith 
2435184914b5SBarry Smith    Notes: Can only be called after the call the SNESSolve() is complete.
2436184914b5SBarry Smith 
2437184914b5SBarry Smith .keywords: SNES, nonlinear, set, convergence, test
2438184914b5SBarry Smith 
243985385478SLisandro Dalcin .seealso: SNESSetConvergenceTest(), SNESConvergedReason
2440184914b5SBarry Smith @*/
24417087cfbeSBarry Smith PetscErrorCode  SNESGetConvergedReason(SNES snes,SNESConvergedReason *reason)
2442184914b5SBarry Smith {
2443184914b5SBarry Smith   PetscFunctionBegin;
24440700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
24454482741eSBarry Smith   PetscValidPointer(reason,2);
2446184914b5SBarry Smith   *reason = snes->reason;
2447184914b5SBarry Smith   PetscFunctionReturn(0);
2448184914b5SBarry Smith }
2449184914b5SBarry Smith 
24504a2ae208SSatish Balay #undef __FUNCT__
24514a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceHistory"
2452c9005455SLois Curfman McInnes /*@
2453c9005455SLois Curfman McInnes    SNESSetConvergenceHistory - Sets the array used to hold the convergence history.
2454c9005455SLois Curfman McInnes 
24553f9fe445SBarry Smith    Logically Collective on SNES
2456fee21e36SBarry Smith 
2457c7afd0dbSLois Curfman McInnes    Input Parameters:
2458c7afd0dbSLois Curfman McInnes +  snes - iterative context obtained from SNESCreate()
24598c7482ecSBarry Smith .  a   - array to hold history, this array will contain the function norms computed at each step
2460cd5578b5SBarry Smith .  its - integer array holds the number of linear iterations for each solve.
2461758f92a0SBarry Smith .  na  - size of a and its
246264731454SLois Curfman McInnes -  reset - PETSC_TRUE indicates each new nonlinear solve resets the history counter to zero,
2463758f92a0SBarry Smith            else it continues storing new values for new nonlinear solves after the old ones
2464c7afd0dbSLois Curfman McInnes 
2465308dcc3eSBarry Smith    Notes:
2466308dcc3eSBarry Smith    If 'a' and 'its' are PETSC_NULL then space is allocated for the history. If 'na' PETSC_DECIDE or PETSC_DEFAULT then a
2467308dcc3eSBarry Smith    default array of length 10000 is allocated.
2468308dcc3eSBarry Smith 
2469c9005455SLois Curfman McInnes    This routine is useful, e.g., when running a code for purposes
2470c9005455SLois Curfman McInnes    of accurate performance monitoring, when no I/O should be done
2471c9005455SLois Curfman McInnes    during the section of code that is being timed.
2472c9005455SLois Curfman McInnes 
247336851e7fSLois Curfman McInnes    Level: intermediate
247436851e7fSLois Curfman McInnes 
2475c9005455SLois Curfman McInnes .keywords: SNES, set, convergence, history
2476758f92a0SBarry Smith 
247708405cd6SLois Curfman McInnes .seealso: SNESGetConvergenceHistory()
2478758f92a0SBarry Smith 
2479c9005455SLois Curfman McInnes @*/
24807087cfbeSBarry Smith PetscErrorCode  SNESSetConvergenceHistory(SNES snes,PetscReal a[],PetscInt its[],PetscInt na,PetscBool  reset)
2481c9005455SLois Curfman McInnes {
2482308dcc3eSBarry Smith   PetscErrorCode ierr;
2483308dcc3eSBarry Smith 
24843a40ed3dSBarry Smith   PetscFunctionBegin;
24850700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
24864482741eSBarry Smith   if (na)  PetscValidScalarPointer(a,2);
2487a562a398SLisandro Dalcin   if (its) PetscValidIntPointer(its,3);
2488308dcc3eSBarry Smith   if (na == PETSC_DECIDE || na == PETSC_DEFAULT || !a) {
2489308dcc3eSBarry Smith     if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000;
2490308dcc3eSBarry Smith     ierr = PetscMalloc(na*sizeof(PetscReal),&a);CHKERRQ(ierr);
2491308dcc3eSBarry Smith     ierr = PetscMalloc(na*sizeof(PetscInt),&its);CHKERRQ(ierr);
2492308dcc3eSBarry Smith     snes->conv_malloc   = PETSC_TRUE;
2493308dcc3eSBarry Smith   }
2494c9005455SLois Curfman McInnes   snes->conv_hist       = a;
2495758f92a0SBarry Smith   snes->conv_hist_its   = its;
2496758f92a0SBarry Smith   snes->conv_hist_max   = na;
2497a12bc48fSLisandro Dalcin   snes->conv_hist_len   = 0;
2498758f92a0SBarry Smith   snes->conv_hist_reset = reset;
2499758f92a0SBarry Smith   PetscFunctionReturn(0);
2500758f92a0SBarry Smith }
2501758f92a0SBarry Smith 
2502308dcc3eSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
2503c6db04a5SJed Brown #include <engine.h>   /* MATLAB include file */
2504c6db04a5SJed Brown #include <mex.h>      /* MATLAB include file */
2505308dcc3eSBarry Smith EXTERN_C_BEGIN
2506308dcc3eSBarry Smith #undef __FUNCT__
2507308dcc3eSBarry Smith #define __FUNCT__ "SNESGetConvergenceHistoryMatlab"
2508308dcc3eSBarry Smith mxArray *SNESGetConvergenceHistoryMatlab(SNES snes)
2509308dcc3eSBarry Smith {
2510308dcc3eSBarry Smith   mxArray        *mat;
2511308dcc3eSBarry Smith   PetscInt       i;
2512308dcc3eSBarry Smith   PetscReal      *ar;
2513308dcc3eSBarry Smith 
2514308dcc3eSBarry Smith   PetscFunctionBegin;
2515308dcc3eSBarry Smith   mat  = mxCreateDoubleMatrix(snes->conv_hist_len,1,mxREAL);
2516308dcc3eSBarry Smith   ar   = (PetscReal*) mxGetData(mat);
2517308dcc3eSBarry Smith   for (i=0; i<snes->conv_hist_len; i++) {
2518308dcc3eSBarry Smith     ar[i] = snes->conv_hist[i];
2519308dcc3eSBarry Smith   }
2520308dcc3eSBarry Smith   PetscFunctionReturn(mat);
2521308dcc3eSBarry Smith }
2522308dcc3eSBarry Smith EXTERN_C_END
2523308dcc3eSBarry Smith #endif
2524308dcc3eSBarry Smith 
2525308dcc3eSBarry Smith 
25264a2ae208SSatish Balay #undef __FUNCT__
25274a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergenceHistory"
25280c4c9dddSBarry Smith /*@C
2529758f92a0SBarry Smith    SNESGetConvergenceHistory - Gets the array used to hold the convergence history.
2530758f92a0SBarry Smith 
25313f9fe445SBarry Smith    Not Collective
2532758f92a0SBarry Smith 
2533758f92a0SBarry Smith    Input Parameter:
2534758f92a0SBarry Smith .  snes - iterative context obtained from SNESCreate()
2535758f92a0SBarry Smith 
2536758f92a0SBarry Smith    Output Parameters:
2537758f92a0SBarry Smith .  a   - array to hold history
2538758f92a0SBarry Smith .  its - integer array holds the number of linear iterations (or
2539758f92a0SBarry Smith          negative if not converged) for each solve.
2540758f92a0SBarry Smith -  na  - size of a and its
2541758f92a0SBarry Smith 
2542758f92a0SBarry Smith    Notes:
2543758f92a0SBarry Smith     The calling sequence for this routine in Fortran is
2544758f92a0SBarry Smith $   call SNESGetConvergenceHistory(SNES snes, integer na, integer ierr)
2545758f92a0SBarry Smith 
2546758f92a0SBarry Smith    This routine is useful, e.g., when running a code for purposes
2547758f92a0SBarry Smith    of accurate performance monitoring, when no I/O should be done
2548758f92a0SBarry Smith    during the section of code that is being timed.
2549758f92a0SBarry Smith 
2550758f92a0SBarry Smith    Level: intermediate
2551758f92a0SBarry Smith 
2552758f92a0SBarry Smith .keywords: SNES, get, convergence, history
2553758f92a0SBarry Smith 
2554758f92a0SBarry Smith .seealso: SNESSetConvergencHistory()
2555758f92a0SBarry Smith 
2556758f92a0SBarry Smith @*/
25577087cfbeSBarry Smith PetscErrorCode  SNESGetConvergenceHistory(SNES snes,PetscReal *a[],PetscInt *its[],PetscInt *na)
2558758f92a0SBarry Smith {
2559758f92a0SBarry Smith   PetscFunctionBegin;
25600700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2561758f92a0SBarry Smith   if (a)   *a   = snes->conv_hist;
2562758f92a0SBarry Smith   if (its) *its = snes->conv_hist_its;
2563758f92a0SBarry Smith   if (na)  *na  = snes->conv_hist_len;
25643a40ed3dSBarry Smith   PetscFunctionReturn(0);
2565c9005455SLois Curfman McInnes }
2566c9005455SLois Curfman McInnes 
2567e74ef692SMatthew Knepley #undef __FUNCT__
2568e74ef692SMatthew Knepley #define __FUNCT__ "SNESSetUpdate"
2569ac226902SBarry Smith /*@C
257076b2cf59SMatthew Knepley   SNESSetUpdate - Sets the general-purpose update function called
2571eec8f646SJed Brown   at the beginning of every iteration of the nonlinear solve. Specifically
25727e4bb74cSBarry Smith   it is called just before the Jacobian is "evaluated".
257376b2cf59SMatthew Knepley 
25743f9fe445SBarry Smith   Logically Collective on SNES
257576b2cf59SMatthew Knepley 
257676b2cf59SMatthew Knepley   Input Parameters:
257776b2cf59SMatthew Knepley . snes - The nonlinear solver context
257876b2cf59SMatthew Knepley . func - The function
257976b2cf59SMatthew Knepley 
258076b2cf59SMatthew Knepley   Calling sequence of func:
2581b5d30489SBarry Smith . func (SNES snes, PetscInt step);
258276b2cf59SMatthew Knepley 
258376b2cf59SMatthew Knepley . step - The current step of the iteration
258476b2cf59SMatthew Knepley 
2585fe97e370SBarry Smith   Level: advanced
2586fe97e370SBarry Smith 
2587fe97e370SBarry Smith   Note: This is NOT what one uses to update the ghost points before a function evaluation, that should be done at the beginning of your FormFunction()
2588fe97e370SBarry Smith         This is not used by most users.
258976b2cf59SMatthew Knepley 
259076b2cf59SMatthew Knepley .keywords: SNES, update
2591b5d30489SBarry Smith 
259285385478SLisandro Dalcin .seealso SNESDefaultUpdate(), SNESSetJacobian(), SNESSolve()
259376b2cf59SMatthew Knepley @*/
25947087cfbeSBarry Smith PetscErrorCode  SNESSetUpdate(SNES snes, PetscErrorCode (*func)(SNES, PetscInt))
259576b2cf59SMatthew Knepley {
259676b2cf59SMatthew Knepley   PetscFunctionBegin;
25970700a824SBarry Smith   PetscValidHeaderSpecific(snes, SNES_CLASSID,1);
2598e7788613SBarry Smith   snes->ops->update = func;
259976b2cf59SMatthew Knepley   PetscFunctionReturn(0);
260076b2cf59SMatthew Knepley }
260176b2cf59SMatthew Knepley 
2602e74ef692SMatthew Knepley #undef __FUNCT__
2603e74ef692SMatthew Knepley #define __FUNCT__ "SNESDefaultUpdate"
260476b2cf59SMatthew Knepley /*@
260576b2cf59SMatthew Knepley   SNESDefaultUpdate - The default update function which does nothing.
260676b2cf59SMatthew Knepley 
260776b2cf59SMatthew Knepley   Not collective
260876b2cf59SMatthew Knepley 
260976b2cf59SMatthew Knepley   Input Parameters:
261076b2cf59SMatthew Knepley . snes - The nonlinear solver context
261176b2cf59SMatthew Knepley . step - The current step of the iteration
261276b2cf59SMatthew Knepley 
2613205452f4SMatthew Knepley   Level: intermediate
2614205452f4SMatthew Knepley 
261576b2cf59SMatthew Knepley .keywords: SNES, update
2616a6570f20SBarry Smith .seealso SNESSetUpdate(), SNESDefaultRhsBC(), SNESDefaultShortolutionBC()
261776b2cf59SMatthew Knepley @*/
26187087cfbeSBarry Smith PetscErrorCode  SNESDefaultUpdate(SNES snes, PetscInt step)
261976b2cf59SMatthew Knepley {
262076b2cf59SMatthew Knepley   PetscFunctionBegin;
262176b2cf59SMatthew Knepley   PetscFunctionReturn(0);
262276b2cf59SMatthew Knepley }
262376b2cf59SMatthew Knepley 
26244a2ae208SSatish Balay #undef __FUNCT__
26254a2ae208SSatish Balay #define __FUNCT__ "SNESScaleStep_Private"
26269b94acceSBarry Smith /*
26279b94acceSBarry Smith    SNESScaleStep_Private - Scales a step so that its length is less than the
26289b94acceSBarry Smith    positive parameter delta.
26299b94acceSBarry Smith 
26309b94acceSBarry Smith     Input Parameters:
2631c7afd0dbSLois Curfman McInnes +   snes - the SNES context
26329b94acceSBarry Smith .   y - approximate solution of linear system
26339b94acceSBarry Smith .   fnorm - 2-norm of current function
2634c7afd0dbSLois Curfman McInnes -   delta - trust region size
26359b94acceSBarry Smith 
26369b94acceSBarry Smith     Output Parameters:
2637c7afd0dbSLois Curfman McInnes +   gpnorm - predicted function norm at the new point, assuming local
26389b94acceSBarry Smith     linearization.  The value is zero if the step lies within the trust
26399b94acceSBarry Smith     region, and exceeds zero otherwise.
2640c7afd0dbSLois Curfman McInnes -   ynorm - 2-norm of the step
26419b94acceSBarry Smith 
26429b94acceSBarry Smith     Note:
26434b27c08aSLois Curfman McInnes     For non-trust region methods such as SNESLS, the parameter delta
26449b94acceSBarry Smith     is set to be the maximum allowable step size.
26459b94acceSBarry Smith 
26469b94acceSBarry Smith .keywords: SNES, nonlinear, scale, step
26479b94acceSBarry Smith */
2648dfbe8321SBarry Smith PetscErrorCode SNESScaleStep_Private(SNES snes,Vec y,PetscReal *fnorm,PetscReal *delta,PetscReal *gpnorm,PetscReal *ynorm)
26499b94acceSBarry Smith {
2650064f8208SBarry Smith   PetscReal      nrm;
2651ea709b57SSatish Balay   PetscScalar    cnorm;
2652dfbe8321SBarry Smith   PetscErrorCode ierr;
26533a40ed3dSBarry Smith 
26543a40ed3dSBarry Smith   PetscFunctionBegin;
26550700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
26560700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,2);
2657c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,y,2);
2658184914b5SBarry Smith 
2659064f8208SBarry Smith   ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr);
2660064f8208SBarry Smith   if (nrm > *delta) {
2661064f8208SBarry Smith      nrm = *delta/nrm;
2662064f8208SBarry Smith      *gpnorm = (1.0 - nrm)*(*fnorm);
2663064f8208SBarry Smith      cnorm = nrm;
26642dcb1b2aSMatthew Knepley      ierr = VecScale(y,cnorm);CHKERRQ(ierr);
26659b94acceSBarry Smith      *ynorm = *delta;
26669b94acceSBarry Smith   } else {
26679b94acceSBarry Smith      *gpnorm = 0.0;
2668064f8208SBarry Smith      *ynorm = nrm;
26699b94acceSBarry Smith   }
26703a40ed3dSBarry Smith   PetscFunctionReturn(0);
26719b94acceSBarry Smith }
26729b94acceSBarry Smith 
26734a2ae208SSatish Balay #undef __FUNCT__
26744a2ae208SSatish Balay #define __FUNCT__ "SNESSolve"
26756ce558aeSBarry Smith /*@C
2676f69a0ea3SMatthew Knepley    SNESSolve - Solves a nonlinear system F(x) = b.
2677f69a0ea3SMatthew Knepley    Call SNESSolve() after calling SNESCreate() and optional routines of the form SNESSetXXX().
26789b94acceSBarry Smith 
2679c7afd0dbSLois Curfman McInnes    Collective on SNES
2680c7afd0dbSLois Curfman McInnes 
2681b2002411SLois Curfman McInnes    Input Parameters:
2682c7afd0dbSLois Curfman McInnes +  snes - the SNES context
26833cebf274SJed Brown .  b - the constant part of the equation F(x) = b, or PETSC_NULL to use zero.
268485385478SLisandro Dalcin -  x - the solution vector.
26859b94acceSBarry Smith 
2686b2002411SLois Curfman McInnes    Notes:
26878ddd3da0SLois Curfman McInnes    The user should initialize the vector,x, with the initial guess
26888ddd3da0SLois Curfman McInnes    for the nonlinear solve prior to calling SNESSolve.  In particular,
26898ddd3da0SLois Curfman McInnes    to employ an initial guess of zero, the user should explicitly set
26908ddd3da0SLois Curfman McInnes    this vector to zero by calling VecSet().
26918ddd3da0SLois Curfman McInnes 
269236851e7fSLois Curfman McInnes    Level: beginner
269336851e7fSLois Curfman McInnes 
26949b94acceSBarry Smith .keywords: SNES, nonlinear, solve
26959b94acceSBarry Smith 
269685385478SLisandro Dalcin .seealso: SNESCreate(), SNESDestroy(), SNESSetFunction(), SNESSetJacobian()
26979b94acceSBarry Smith @*/
26987087cfbeSBarry Smith PetscErrorCode  SNESSolve(SNES snes,Vec b,Vec x)
26999b94acceSBarry Smith {
2700dfbe8321SBarry Smith   PetscErrorCode ierr;
2701ace3abfcSBarry Smith   PetscBool      flg;
2702eabae89aSBarry Smith   char           filename[PETSC_MAX_PATH_LEN];
2703eabae89aSBarry Smith   PetscViewer    viewer;
2704efd51863SBarry Smith   PetscInt       grid;
2705052efed2SBarry Smith 
27063a40ed3dSBarry Smith   PetscFunctionBegin;
27070700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
27080700a824SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,3);
2709f69a0ea3SMatthew Knepley   PetscCheckSameComm(snes,1,x,3);
27100700a824SBarry Smith   if (b) PetscValidHeaderSpecific(b,VEC_CLASSID,2);
271185385478SLisandro Dalcin   if (b) PetscCheckSameComm(snes,1,b,2);
271285385478SLisandro Dalcin 
2713a8248277SBarry Smith   for (grid=0; grid<snes->gridsequence; grid++) {ierr = PetscViewerASCIIPushTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm));CHKERRQ(ierr);}
2714efd51863SBarry Smith   for (grid=0; grid<snes->gridsequence+1; grid++) {
2715efd51863SBarry Smith 
271685385478SLisandro Dalcin     /* set solution vector */
2717efd51863SBarry Smith     if (!grid) {ierr = PetscObjectReference((PetscObject)x);CHKERRQ(ierr);}
27186bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr);
271985385478SLisandro Dalcin     snes->vec_sol = x;
272085385478SLisandro Dalcin     /* set afine vector if provided */
272185385478SLisandro Dalcin     if (b) { ierr = PetscObjectReference((PetscObject)b);CHKERRQ(ierr); }
27226bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr);
272385385478SLisandro Dalcin     snes->vec_rhs = b;
272485385478SLisandro Dalcin 
272570e92668SMatthew Knepley     ierr = SNESSetUp(snes);CHKERRQ(ierr);
27263f149594SLisandro Dalcin 
2727d25893d9SBarry Smith     if (!grid && snes->ops->computeinitialguess) {
2728d25893d9SBarry Smith       ierr = (*snes->ops->computeinitialguess)(snes,snes->vec_sol,snes->initialguessP);CHKERRQ(ierr);
2729d25893d9SBarry Smith     }
2730d25893d9SBarry Smith 
2731abc0a331SBarry Smith     if (snes->conv_hist_reset) snes->conv_hist_len = 0;
273250ffb88aSMatthew Knepley     snes->nfuncs = 0; snes->linear_its = 0; snes->numFailures = 0;
2733d5e45103SBarry Smith 
27343f149594SLisandro Dalcin     ierr = PetscLogEventBegin(SNES_Solve,snes,0,0,0);CHKERRQ(ierr);
27354936397dSBarry Smith     ierr = (*snes->ops->solve)(snes);CHKERRQ(ierr);
273685385478SLisandro Dalcin     ierr = PetscLogEventEnd(SNES_Solve,snes,0,0,0);CHKERRQ(ierr);
27374936397dSBarry Smith     if (snes->domainerror){
27384936397dSBarry Smith       snes->reason      = SNES_DIVERGED_FUNCTION_DOMAIN;
27394936397dSBarry Smith       snes->domainerror = PETSC_FALSE;
27404936397dSBarry Smith     }
274117186662SBarry Smith     if (!snes->reason) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Internal error, solver returned without setting converged reason");
27423f149594SLisandro Dalcin 
27437adad957SLisandro Dalcin     ierr = PetscOptionsGetString(((PetscObject)snes)->prefix,"-snes_view",filename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
2744eabae89aSBarry Smith     if (flg && !PetscPreLoadingOn) {
27457adad957SLisandro Dalcin       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,filename,&viewer);CHKERRQ(ierr);
2746eabae89aSBarry Smith       ierr = SNESView(snes,viewer);CHKERRQ(ierr);
27476bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
2748eabae89aSBarry Smith     }
2749eabae89aSBarry Smith 
275090d69ab7SBarry Smith     flg  = PETSC_FALSE;
2751acfcf0e5SJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_test_local_min",&flg,PETSC_NULL);CHKERRQ(ierr);
2752da9b6338SBarry Smith     if (flg && !PetscPreLoadingOn) { ierr = SNESTestLocalMin(snes);CHKERRQ(ierr); }
27535968eb51SBarry Smith     if (snes->printreason) {
2754a8248277SBarry Smith       ierr = PetscViewerASCIIAddTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),((PetscObject)snes)->tablevel);CHKERRQ(ierr);
27555968eb51SBarry Smith       if (snes->reason > 0) {
2756a8248277SBarry Smith         ierr = PetscViewerASCIIPrintf(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),"Nonlinear solve converged due to %s\n",SNESConvergedReasons[snes->reason]);CHKERRQ(ierr);
27575968eb51SBarry Smith       } else {
2758a8248277SBarry Smith         ierr = PetscViewerASCIIPrintf(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),"Nonlinear solve did not converge due to %s\n",SNESConvergedReasons[snes->reason]);CHKERRQ(ierr);
27595968eb51SBarry Smith       }
2760a8248277SBarry Smith       ierr = PetscViewerASCIISubtractTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),((PetscObject)snes)->tablevel);CHKERRQ(ierr);
27615968eb51SBarry Smith     }
27625968eb51SBarry Smith 
2763e113a28aSBarry Smith     if (snes->errorifnotconverged && snes->reason < 0) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_NOT_CONVERGED,"SNESSolve has not converged");
2764efd51863SBarry Smith     if (grid <  snes->gridsequence) {
2765efd51863SBarry Smith       DM  fine;
2766efd51863SBarry Smith       Vec xnew;
2767efd51863SBarry Smith       Mat interp;
2768efd51863SBarry Smith 
2769efd51863SBarry Smith       ierr = DMRefine(snes->dm,((PetscObject)snes)->comm,&fine);CHKERRQ(ierr);
2770efd51863SBarry Smith       ierr = DMGetInterpolation(snes->dm,fine,&interp,PETSC_NULL);CHKERRQ(ierr);
2771efd51863SBarry Smith       ierr = DMCreateGlobalVector(fine,&xnew);CHKERRQ(ierr);
2772efd51863SBarry Smith       ierr = MatInterpolate(interp,x,xnew);CHKERRQ(ierr);
2773efd51863SBarry Smith       ierr = MatDestroy(&interp);CHKERRQ(ierr);
2774efd51863SBarry Smith       x    = xnew;
2775efd51863SBarry Smith 
2776efd51863SBarry Smith       ierr = SNESReset(snes);CHKERRQ(ierr);
2777efd51863SBarry Smith       ierr = SNESSetDM(snes,fine);CHKERRQ(ierr);
2778efd51863SBarry Smith       ierr = DMDestroy(&fine);CHKERRQ(ierr);
2779a8248277SBarry Smith       ierr = PetscViewerASCIIPopTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm));CHKERRQ(ierr);
2780efd51863SBarry Smith     }
2781efd51863SBarry Smith   }
27823a40ed3dSBarry Smith   PetscFunctionReturn(0);
27839b94acceSBarry Smith }
27849b94acceSBarry Smith 
27859b94acceSBarry Smith /* --------- Internal routines for SNES Package --------- */
27869b94acceSBarry Smith 
27874a2ae208SSatish Balay #undef __FUNCT__
27884a2ae208SSatish Balay #define __FUNCT__ "SNESSetType"
278982bf6240SBarry Smith /*@C
27904b0e389bSBarry Smith    SNESSetType - Sets the method for the nonlinear solver.
27919b94acceSBarry Smith 
2792fee21e36SBarry Smith    Collective on SNES
2793fee21e36SBarry Smith 
2794c7afd0dbSLois Curfman McInnes    Input Parameters:
2795c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2796454a90a3SBarry Smith -  type - a known method
2797c7afd0dbSLois Curfman McInnes 
2798c7afd0dbSLois Curfman McInnes    Options Database Key:
2799454a90a3SBarry Smith .  -snes_type <type> - Sets the method; use -help for a list
2800c7afd0dbSLois Curfman McInnes    of available methods (for instance, ls or tr)
2801ae12b187SLois Curfman McInnes 
28029b94acceSBarry Smith    Notes:
2803e090d566SSatish Balay    See "petsc/include/petscsnes.h" for available methods (for instance)
28044b27c08aSLois Curfman McInnes +    SNESLS - Newton's method with line search
2805c7afd0dbSLois Curfman McInnes      (systems of nonlinear equations)
28064b27c08aSLois Curfman McInnes .    SNESTR - Newton's method with trust region
2807c7afd0dbSLois Curfman McInnes      (systems of nonlinear equations)
28089b94acceSBarry Smith 
2809ae12b187SLois Curfman McInnes   Normally, it is best to use the SNESSetFromOptions() command and then
2810ae12b187SLois Curfman McInnes   set the SNES solver type from the options database rather than by using
2811ae12b187SLois Curfman McInnes   this routine.  Using the options database provides the user with
2812ae12b187SLois Curfman McInnes   maximum flexibility in evaluating the many nonlinear solvers.
2813ae12b187SLois Curfman McInnes   The SNESSetType() routine is provided for those situations where it
2814ae12b187SLois Curfman McInnes   is necessary to set the nonlinear solver independently of the command
2815ae12b187SLois Curfman McInnes   line or options database.  This might be the case, for example, when
2816ae12b187SLois Curfman McInnes   the choice of solver changes during the execution of the program,
2817ae12b187SLois Curfman McInnes   and the user's application is taking responsibility for choosing the
2818b0a32e0cSBarry Smith   appropriate method.
281936851e7fSLois Curfman McInnes 
282036851e7fSLois Curfman McInnes   Level: intermediate
2821a703fe33SLois Curfman McInnes 
2822454a90a3SBarry Smith .keywords: SNES, set, type
2823435da068SBarry Smith 
2824435da068SBarry Smith .seealso: SNESType, SNESCreate()
2825435da068SBarry Smith 
28269b94acceSBarry Smith @*/
28277087cfbeSBarry Smith PetscErrorCode  SNESSetType(SNES snes,const SNESType type)
28289b94acceSBarry Smith {
2829dfbe8321SBarry Smith   PetscErrorCode ierr,(*r)(SNES);
2830ace3abfcSBarry Smith   PetscBool      match;
28313a40ed3dSBarry Smith 
28323a40ed3dSBarry Smith   PetscFunctionBegin;
28330700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
28344482741eSBarry Smith   PetscValidCharPointer(type,2);
283582bf6240SBarry Smith 
28366831982aSBarry Smith   ierr = PetscTypeCompare((PetscObject)snes,type,&match);CHKERRQ(ierr);
28370f5bd95cSBarry Smith   if (match) PetscFunctionReturn(0);
283892ff6ae8SBarry Smith 
28394b91b6eaSBarry Smith   ierr =  PetscFListFind(SNESList,((PetscObject)snes)->comm,type,PETSC_TRUE,(void (**)(void)) &r);CHKERRQ(ierr);
2840e32f2f54SBarry Smith   if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested SNES type %s",type);
284175396ef9SLisandro Dalcin   /* Destroy the previous private SNES context */
284275396ef9SLisandro Dalcin   if (snes->ops->destroy) { ierr = (*(snes)->ops->destroy)(snes);CHKERRQ(ierr); }
284375396ef9SLisandro Dalcin   /* Reinitialize function pointers in SNESOps structure */
284475396ef9SLisandro Dalcin   snes->ops->setup          = 0;
284575396ef9SLisandro Dalcin   snes->ops->solve          = 0;
284675396ef9SLisandro Dalcin   snes->ops->view           = 0;
284775396ef9SLisandro Dalcin   snes->ops->setfromoptions = 0;
284875396ef9SLisandro Dalcin   snes->ops->destroy        = 0;
284975396ef9SLisandro Dalcin   /* Call the SNESCreate_XXX routine for this particular Nonlinear solver */
285075396ef9SLisandro Dalcin   snes->setupcalled = PETSC_FALSE;
2851454a90a3SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)snes,type);CHKERRQ(ierr);
285203bfa161SLisandro Dalcin   ierr = (*r)(snes);CHKERRQ(ierr);
28539fb22e1aSBarry Smith #if defined(PETSC_HAVE_AMS)
28549fb22e1aSBarry Smith   if (PetscAMSPublishAll) {
28559fb22e1aSBarry Smith     ierr = PetscObjectAMSPublish((PetscObject)snes);CHKERRQ(ierr);
28569fb22e1aSBarry Smith   }
28579fb22e1aSBarry Smith #endif
28583a40ed3dSBarry Smith   PetscFunctionReturn(0);
28599b94acceSBarry Smith }
28609b94acceSBarry Smith 
2861a847f771SSatish Balay 
28629b94acceSBarry Smith /* --------------------------------------------------------------------- */
28634a2ae208SSatish Balay #undef __FUNCT__
28644a2ae208SSatish Balay #define __FUNCT__ "SNESRegisterDestroy"
286552baeb72SSatish Balay /*@
28669b94acceSBarry Smith    SNESRegisterDestroy - Frees the list of nonlinear solvers that were
2867f1af5d2fSBarry Smith    registered by SNESRegisterDynamic().
28689b94acceSBarry Smith 
2869fee21e36SBarry Smith    Not Collective
2870fee21e36SBarry Smith 
287136851e7fSLois Curfman McInnes    Level: advanced
287236851e7fSLois Curfman McInnes 
28739b94acceSBarry Smith .keywords: SNES, nonlinear, register, destroy
28749b94acceSBarry Smith 
28759b94acceSBarry Smith .seealso: SNESRegisterAll(), SNESRegisterAll()
28769b94acceSBarry Smith @*/
28777087cfbeSBarry Smith PetscErrorCode  SNESRegisterDestroy(void)
28789b94acceSBarry Smith {
2879dfbe8321SBarry Smith   PetscErrorCode ierr;
288082bf6240SBarry Smith 
28813a40ed3dSBarry Smith   PetscFunctionBegin;
28821441b1d3SBarry Smith   ierr = PetscFListDestroy(&SNESList);CHKERRQ(ierr);
28834c49b128SBarry Smith   SNESRegisterAllCalled = PETSC_FALSE;
28843a40ed3dSBarry Smith   PetscFunctionReturn(0);
28859b94acceSBarry Smith }
28869b94acceSBarry Smith 
28874a2ae208SSatish Balay #undef __FUNCT__
28884a2ae208SSatish Balay #define __FUNCT__ "SNESGetType"
28899b94acceSBarry Smith /*@C
28909a28b0a6SLois Curfman McInnes    SNESGetType - Gets the SNES method type and name (as a string).
28919b94acceSBarry Smith 
2892c7afd0dbSLois Curfman McInnes    Not Collective
2893c7afd0dbSLois Curfman McInnes 
28949b94acceSBarry Smith    Input Parameter:
28954b0e389bSBarry Smith .  snes - nonlinear solver context
28969b94acceSBarry Smith 
28979b94acceSBarry Smith    Output Parameter:
28983a7fca6bSBarry Smith .  type - SNES method (a character string)
28999b94acceSBarry Smith 
290036851e7fSLois Curfman McInnes    Level: intermediate
290136851e7fSLois Curfman McInnes 
2902454a90a3SBarry Smith .keywords: SNES, nonlinear, get, type, name
29039b94acceSBarry Smith @*/
29047087cfbeSBarry Smith PetscErrorCode  SNESGetType(SNES snes,const SNESType *type)
29059b94acceSBarry Smith {
29063a40ed3dSBarry Smith   PetscFunctionBegin;
29070700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
29084482741eSBarry Smith   PetscValidPointer(type,2);
29097adad957SLisandro Dalcin   *type = ((PetscObject)snes)->type_name;
29103a40ed3dSBarry Smith   PetscFunctionReturn(0);
29119b94acceSBarry Smith }
29129b94acceSBarry Smith 
29134a2ae208SSatish Balay #undef __FUNCT__
29144a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolution"
291552baeb72SSatish Balay /*@
29169b94acceSBarry Smith    SNESGetSolution - Returns the vector where the approximate solution is
29179b94acceSBarry Smith    stored.
29189b94acceSBarry Smith 
2919c7afd0dbSLois Curfman McInnes    Not Collective, but Vec is parallel if SNES is parallel
2920c7afd0dbSLois Curfman McInnes 
29219b94acceSBarry Smith    Input Parameter:
29229b94acceSBarry Smith .  snes - the SNES context
29239b94acceSBarry Smith 
29249b94acceSBarry Smith    Output Parameter:
29259b94acceSBarry Smith .  x - the solution
29269b94acceSBarry Smith 
292770e92668SMatthew Knepley    Level: intermediate
292836851e7fSLois Curfman McInnes 
29299b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution
29309b94acceSBarry Smith 
293185385478SLisandro Dalcin .seealso:  SNESGetSolutionUpdate(), SNESGetFunction()
29329b94acceSBarry Smith @*/
29337087cfbeSBarry Smith PetscErrorCode  SNESGetSolution(SNES snes,Vec *x)
29349b94acceSBarry Smith {
29353a40ed3dSBarry Smith   PetscFunctionBegin;
29360700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
29374482741eSBarry Smith   PetscValidPointer(x,2);
293885385478SLisandro Dalcin   *x = snes->vec_sol;
293970e92668SMatthew Knepley   PetscFunctionReturn(0);
294070e92668SMatthew Knepley }
294170e92668SMatthew Knepley 
294270e92668SMatthew Knepley #undef __FUNCT__
29434a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolutionUpdate"
294452baeb72SSatish Balay /*@
29459b94acceSBarry Smith    SNESGetSolutionUpdate - Returns the vector where the solution update is
29469b94acceSBarry Smith    stored.
29479b94acceSBarry Smith 
2948c7afd0dbSLois Curfman McInnes    Not Collective, but Vec is parallel if SNES is parallel
2949c7afd0dbSLois Curfman McInnes 
29509b94acceSBarry Smith    Input Parameter:
29519b94acceSBarry Smith .  snes - the SNES context
29529b94acceSBarry Smith 
29539b94acceSBarry Smith    Output Parameter:
29549b94acceSBarry Smith .  x - the solution update
29559b94acceSBarry Smith 
295636851e7fSLois Curfman McInnes    Level: advanced
295736851e7fSLois Curfman McInnes 
29589b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution, update
29599b94acceSBarry Smith 
296085385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction()
29619b94acceSBarry Smith @*/
29627087cfbeSBarry Smith PetscErrorCode  SNESGetSolutionUpdate(SNES snes,Vec *x)
29639b94acceSBarry Smith {
29643a40ed3dSBarry Smith   PetscFunctionBegin;
29650700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
29664482741eSBarry Smith   PetscValidPointer(x,2);
296785385478SLisandro Dalcin   *x = snes->vec_sol_update;
29683a40ed3dSBarry Smith   PetscFunctionReturn(0);
29699b94acceSBarry Smith }
29709b94acceSBarry Smith 
29714a2ae208SSatish Balay #undef __FUNCT__
29724a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunction"
29739b94acceSBarry Smith /*@C
29743638b69dSLois Curfman McInnes    SNESGetFunction - Returns the vector where the function is stored.
29759b94acceSBarry Smith 
2976c7afd0dbSLois Curfman McInnes    Not Collective, but Vec is parallel if SNES is parallel
2977c7afd0dbSLois Curfman McInnes 
29789b94acceSBarry Smith    Input Parameter:
29799b94acceSBarry Smith .  snes - the SNES context
29809b94acceSBarry Smith 
29819b94acceSBarry Smith    Output Parameter:
29827bf4e008SBarry Smith +  r - the function (or PETSC_NULL)
298370e92668SMatthew Knepley .  func - the function (or PETSC_NULL)
298470e92668SMatthew Knepley -  ctx - the function context (or PETSC_NULL)
29859b94acceSBarry Smith 
298636851e7fSLois Curfman McInnes    Level: advanced
298736851e7fSLois Curfman McInnes 
2988a86d99e1SLois Curfman McInnes .keywords: SNES, nonlinear, get, function
29899b94acceSBarry Smith 
29904b27c08aSLois Curfman McInnes .seealso: SNESSetFunction(), SNESGetSolution()
29919b94acceSBarry Smith @*/
29927087cfbeSBarry Smith PetscErrorCode  SNESGetFunction(SNES snes,Vec *r,PetscErrorCode (**func)(SNES,Vec,Vec,void*),void **ctx)
29939b94acceSBarry Smith {
29943a40ed3dSBarry Smith   PetscFunctionBegin;
29950700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
299685385478SLisandro Dalcin   if (r)    *r    = snes->vec_func;
2997e7788613SBarry Smith   if (func) *func = snes->ops->computefunction;
299870e92668SMatthew Knepley   if (ctx)  *ctx  = snes->funP;
29993a40ed3dSBarry Smith   PetscFunctionReturn(0);
30009b94acceSBarry Smith }
30019b94acceSBarry Smith 
30024a2ae208SSatish Balay #undef __FUNCT__
30034a2ae208SSatish Balay #define __FUNCT__ "SNESSetOptionsPrefix"
30043c7409f5SSatish Balay /*@C
30053c7409f5SSatish Balay    SNESSetOptionsPrefix - Sets the prefix used for searching for all
3006d850072dSLois Curfman McInnes    SNES options in the database.
30073c7409f5SSatish Balay 
30083f9fe445SBarry Smith    Logically Collective on SNES
3009fee21e36SBarry Smith 
3010c7afd0dbSLois Curfman McInnes    Input Parameter:
3011c7afd0dbSLois Curfman McInnes +  snes - the SNES context
3012c7afd0dbSLois Curfman McInnes -  prefix - the prefix to prepend to all option names
3013c7afd0dbSLois Curfman McInnes 
3014d850072dSLois Curfman McInnes    Notes:
3015a83b1b31SSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
3016c7afd0dbSLois Curfman McInnes    The first character of all runtime options is AUTOMATICALLY the hyphen.
3017d850072dSLois Curfman McInnes 
301836851e7fSLois Curfman McInnes    Level: advanced
301936851e7fSLois Curfman McInnes 
30203c7409f5SSatish Balay .keywords: SNES, set, options, prefix, database
3021a86d99e1SLois Curfman McInnes 
3022a86d99e1SLois Curfman McInnes .seealso: SNESSetFromOptions()
30233c7409f5SSatish Balay @*/
30247087cfbeSBarry Smith PetscErrorCode  SNESSetOptionsPrefix(SNES snes,const char prefix[])
30253c7409f5SSatish Balay {
3026dfbe8321SBarry Smith   PetscErrorCode ierr;
30273c7409f5SSatish Balay 
30283a40ed3dSBarry Smith   PetscFunctionBegin;
30290700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3030639f9d9dSBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
30311cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
303294b7f48cSBarry Smith   ierr = KSPSetOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr);
30333a40ed3dSBarry Smith   PetscFunctionReturn(0);
30343c7409f5SSatish Balay }
30353c7409f5SSatish Balay 
30364a2ae208SSatish Balay #undef __FUNCT__
30374a2ae208SSatish Balay #define __FUNCT__ "SNESAppendOptionsPrefix"
30383c7409f5SSatish Balay /*@C
3039f525115eSLois Curfman McInnes    SNESAppendOptionsPrefix - Appends to the prefix used for searching for all
3040d850072dSLois Curfman McInnes    SNES options in the database.
30413c7409f5SSatish Balay 
30423f9fe445SBarry Smith    Logically Collective on SNES
3043fee21e36SBarry Smith 
3044c7afd0dbSLois Curfman McInnes    Input Parameters:
3045c7afd0dbSLois Curfman McInnes +  snes - the SNES context
3046c7afd0dbSLois Curfman McInnes -  prefix - the prefix to prepend to all option names
3047c7afd0dbSLois Curfman McInnes 
3048d850072dSLois Curfman McInnes    Notes:
3049a83b1b31SSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
3050c7afd0dbSLois Curfman McInnes    The first character of all runtime options is AUTOMATICALLY the hyphen.
3051d850072dSLois Curfman McInnes 
305236851e7fSLois Curfman McInnes    Level: advanced
305336851e7fSLois Curfman McInnes 
30543c7409f5SSatish Balay .keywords: SNES, append, options, prefix, database
3055a86d99e1SLois Curfman McInnes 
3056a86d99e1SLois Curfman McInnes .seealso: SNESGetOptionsPrefix()
30573c7409f5SSatish Balay @*/
30587087cfbeSBarry Smith PetscErrorCode  SNESAppendOptionsPrefix(SNES snes,const char prefix[])
30593c7409f5SSatish Balay {
3060dfbe8321SBarry Smith   PetscErrorCode ierr;
30613c7409f5SSatish Balay 
30623a40ed3dSBarry Smith   PetscFunctionBegin;
30630700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3064639f9d9dSBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
30651cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
306694b7f48cSBarry Smith   ierr = KSPAppendOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr);
30673a40ed3dSBarry Smith   PetscFunctionReturn(0);
30683c7409f5SSatish Balay }
30693c7409f5SSatish Balay 
30704a2ae208SSatish Balay #undef __FUNCT__
30714a2ae208SSatish Balay #define __FUNCT__ "SNESGetOptionsPrefix"
30729ab63eb5SSatish Balay /*@C
30733c7409f5SSatish Balay    SNESGetOptionsPrefix - Sets the prefix used for searching for all
30743c7409f5SSatish Balay    SNES options in the database.
30753c7409f5SSatish Balay 
3076c7afd0dbSLois Curfman McInnes    Not Collective
3077c7afd0dbSLois Curfman McInnes 
30783c7409f5SSatish Balay    Input Parameter:
30793c7409f5SSatish Balay .  snes - the SNES context
30803c7409f5SSatish Balay 
30813c7409f5SSatish Balay    Output Parameter:
30823c7409f5SSatish Balay .  prefix - pointer to the prefix string used
30833c7409f5SSatish Balay 
30844ef407dbSRichard Tran Mills    Notes: On the fortran side, the user should pass in a string 'prefix' of
30859ab63eb5SSatish Balay    sufficient length to hold the prefix.
30869ab63eb5SSatish Balay 
308736851e7fSLois Curfman McInnes    Level: advanced
308836851e7fSLois Curfman McInnes 
30893c7409f5SSatish Balay .keywords: SNES, get, options, prefix, database
3090a86d99e1SLois Curfman McInnes 
3091a86d99e1SLois Curfman McInnes .seealso: SNESAppendOptionsPrefix()
30923c7409f5SSatish Balay @*/
30937087cfbeSBarry Smith PetscErrorCode  SNESGetOptionsPrefix(SNES snes,const char *prefix[])
30943c7409f5SSatish Balay {
3095dfbe8321SBarry Smith   PetscErrorCode ierr;
30963c7409f5SSatish Balay 
30973a40ed3dSBarry Smith   PetscFunctionBegin;
30980700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3099639f9d9dSBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
31003a40ed3dSBarry Smith   PetscFunctionReturn(0);
31013c7409f5SSatish Balay }
31023c7409f5SSatish Balay 
3103b2002411SLois Curfman McInnes 
31044a2ae208SSatish Balay #undef __FUNCT__
31054a2ae208SSatish Balay #define __FUNCT__ "SNESRegister"
31063cea93caSBarry Smith /*@C
31073cea93caSBarry Smith   SNESRegister - See SNESRegisterDynamic()
31083cea93caSBarry Smith 
31097f6c08e0SMatthew Knepley   Level: advanced
31103cea93caSBarry Smith @*/
31117087cfbeSBarry Smith PetscErrorCode  SNESRegister(const char sname[],const char path[],const char name[],PetscErrorCode (*function)(SNES))
3112b2002411SLois Curfman McInnes {
3113e2d1d2b7SBarry Smith   char           fullname[PETSC_MAX_PATH_LEN];
3114dfbe8321SBarry Smith   PetscErrorCode ierr;
3115b2002411SLois Curfman McInnes 
3116b2002411SLois Curfman McInnes   PetscFunctionBegin;
3117b0a32e0cSBarry Smith   ierr = PetscFListConcat(path,name,fullname);CHKERRQ(ierr);
3118c134de8dSSatish Balay   ierr = PetscFListAdd(&SNESList,sname,fullname,(void (*)(void))function);CHKERRQ(ierr);
3119b2002411SLois Curfman McInnes   PetscFunctionReturn(0);
3120b2002411SLois Curfman McInnes }
3121da9b6338SBarry Smith 
3122da9b6338SBarry Smith #undef __FUNCT__
3123da9b6338SBarry Smith #define __FUNCT__ "SNESTestLocalMin"
31247087cfbeSBarry Smith PetscErrorCode  SNESTestLocalMin(SNES snes)
3125da9b6338SBarry Smith {
3126dfbe8321SBarry Smith   PetscErrorCode ierr;
312777431f27SBarry Smith   PetscInt       N,i,j;
3128da9b6338SBarry Smith   Vec            u,uh,fh;
3129da9b6338SBarry Smith   PetscScalar    value;
3130da9b6338SBarry Smith   PetscReal      norm;
3131da9b6338SBarry Smith 
3132da9b6338SBarry Smith   PetscFunctionBegin;
3133da9b6338SBarry Smith   ierr = SNESGetSolution(snes,&u);CHKERRQ(ierr);
3134da9b6338SBarry Smith   ierr = VecDuplicate(u,&uh);CHKERRQ(ierr);
3135da9b6338SBarry Smith   ierr = VecDuplicate(u,&fh);CHKERRQ(ierr);
3136da9b6338SBarry Smith 
3137da9b6338SBarry Smith   /* currently only works for sequential */
3138da9b6338SBarry Smith   ierr = PetscPrintf(PETSC_COMM_WORLD,"Testing FormFunction() for local min\n");
3139da9b6338SBarry Smith   ierr = VecGetSize(u,&N);CHKERRQ(ierr);
3140da9b6338SBarry Smith   for (i=0; i<N; i++) {
3141da9b6338SBarry Smith     ierr = VecCopy(u,uh);CHKERRQ(ierr);
314277431f27SBarry Smith     ierr  = PetscPrintf(PETSC_COMM_WORLD,"i = %D\n",i);CHKERRQ(ierr);
3143da9b6338SBarry Smith     for (j=-10; j<11; j++) {
3144ccae9161SBarry Smith       value = PetscSign(j)*exp(PetscAbs(j)-10.0);
3145da9b6338SBarry Smith       ierr  = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr);
31463ab0aad5SBarry Smith       ierr  = SNESComputeFunction(snes,uh,fh);CHKERRQ(ierr);
3147da9b6338SBarry Smith       ierr  = VecNorm(fh,NORM_2,&norm);CHKERRQ(ierr);
314877431f27SBarry Smith       ierr  = PetscPrintf(PETSC_COMM_WORLD,"       j norm %D %18.16e\n",j,norm);CHKERRQ(ierr);
3149da9b6338SBarry Smith       value = -value;
3150da9b6338SBarry Smith       ierr  = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr);
3151da9b6338SBarry Smith     }
3152da9b6338SBarry Smith   }
31536bf464f9SBarry Smith   ierr = VecDestroy(&uh);CHKERRQ(ierr);
31546bf464f9SBarry Smith   ierr = VecDestroy(&fh);CHKERRQ(ierr);
3155da9b6338SBarry Smith   PetscFunctionReturn(0);
3156da9b6338SBarry Smith }
315771f87433Sdalcinl 
315871f87433Sdalcinl #undef __FUNCT__
3159fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetUseEW"
316071f87433Sdalcinl /*@
3161fa9f3622SBarry Smith    SNESKSPSetUseEW - Sets SNES use Eisenstat-Walker method for
316271f87433Sdalcinl    computing relative tolerance for linear solvers within an inexact
316371f87433Sdalcinl    Newton method.
316471f87433Sdalcinl 
31653f9fe445SBarry Smith    Logically Collective on SNES
316671f87433Sdalcinl 
316771f87433Sdalcinl    Input Parameters:
316871f87433Sdalcinl +  snes - SNES context
316971f87433Sdalcinl -  flag - PETSC_TRUE or PETSC_FALSE
317071f87433Sdalcinl 
317164ba62caSBarry Smith     Options Database:
317264ba62caSBarry Smith +  -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence
317364ba62caSBarry Smith .  -snes_ksp_ew_version ver - version of  Eisenstat-Walker method
317464ba62caSBarry Smith .  -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0
317564ba62caSBarry Smith .  -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax
317664ba62caSBarry Smith .  -snes_ksp_ew_gamma <gamma> - Sets gamma
317764ba62caSBarry Smith .  -snes_ksp_ew_alpha <alpha> - Sets alpha
317864ba62caSBarry Smith .  -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2
317964ba62caSBarry Smith -  -snes_ksp_ew_threshold <threshold> - Sets threshold
318064ba62caSBarry Smith 
318171f87433Sdalcinl    Notes:
318271f87433Sdalcinl    Currently, the default is to use a constant relative tolerance for
318371f87433Sdalcinl    the inner linear solvers.  Alternatively, one can use the
318471f87433Sdalcinl    Eisenstat-Walker method, where the relative convergence tolerance
318571f87433Sdalcinl    is reset at each Newton iteration according progress of the nonlinear
318671f87433Sdalcinl    solver.
318771f87433Sdalcinl 
318871f87433Sdalcinl    Level: advanced
318971f87433Sdalcinl 
319071f87433Sdalcinl    Reference:
319171f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
319271f87433Sdalcinl    inexact Newton method", SISC 17 (1), pp.16-32, 1996.
319371f87433Sdalcinl 
319471f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton
319571f87433Sdalcinl 
3196fa9f3622SBarry Smith .seealso: SNESKSPGetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW()
319771f87433Sdalcinl @*/
31987087cfbeSBarry Smith PetscErrorCode  SNESKSPSetUseEW(SNES snes,PetscBool  flag)
319971f87433Sdalcinl {
320071f87433Sdalcinl   PetscFunctionBegin;
32010700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3202acfcf0e5SJed Brown   PetscValidLogicalCollectiveBool(snes,flag,2);
320371f87433Sdalcinl   snes->ksp_ewconv = flag;
320471f87433Sdalcinl   PetscFunctionReturn(0);
320571f87433Sdalcinl }
320671f87433Sdalcinl 
320771f87433Sdalcinl #undef __FUNCT__
3208fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetUseEW"
320971f87433Sdalcinl /*@
3210fa9f3622SBarry Smith    SNESKSPGetUseEW - Gets if SNES is using Eisenstat-Walker method
321171f87433Sdalcinl    for computing relative tolerance for linear solvers within an
321271f87433Sdalcinl    inexact Newton method.
321371f87433Sdalcinl 
321471f87433Sdalcinl    Not Collective
321571f87433Sdalcinl 
321671f87433Sdalcinl    Input Parameter:
321771f87433Sdalcinl .  snes - SNES context
321871f87433Sdalcinl 
321971f87433Sdalcinl    Output Parameter:
322071f87433Sdalcinl .  flag - PETSC_TRUE or PETSC_FALSE
322171f87433Sdalcinl 
322271f87433Sdalcinl    Notes:
322371f87433Sdalcinl    Currently, the default is to use a constant relative tolerance for
322471f87433Sdalcinl    the inner linear solvers.  Alternatively, one can use the
322571f87433Sdalcinl    Eisenstat-Walker method, where the relative convergence tolerance
322671f87433Sdalcinl    is reset at each Newton iteration according progress of the nonlinear
322771f87433Sdalcinl    solver.
322871f87433Sdalcinl 
322971f87433Sdalcinl    Level: advanced
323071f87433Sdalcinl 
323171f87433Sdalcinl    Reference:
323271f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
323371f87433Sdalcinl    inexact Newton method", SISC 17 (1), pp.16-32, 1996.
323471f87433Sdalcinl 
323571f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton
323671f87433Sdalcinl 
3237fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW()
323871f87433Sdalcinl @*/
32397087cfbeSBarry Smith PetscErrorCode  SNESKSPGetUseEW(SNES snes, PetscBool  *flag)
324071f87433Sdalcinl {
324171f87433Sdalcinl   PetscFunctionBegin;
32420700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
324371f87433Sdalcinl   PetscValidPointer(flag,2);
324471f87433Sdalcinl   *flag = snes->ksp_ewconv;
324571f87433Sdalcinl   PetscFunctionReturn(0);
324671f87433Sdalcinl }
324771f87433Sdalcinl 
324871f87433Sdalcinl #undef __FUNCT__
3249fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetParametersEW"
325071f87433Sdalcinl /*@
3251fa9f3622SBarry Smith    SNESKSPSetParametersEW - Sets parameters for Eisenstat-Walker
325271f87433Sdalcinl    convergence criteria for the linear solvers within an inexact
325371f87433Sdalcinl    Newton method.
325471f87433Sdalcinl 
32553f9fe445SBarry Smith    Logically Collective on SNES
325671f87433Sdalcinl 
325771f87433Sdalcinl    Input Parameters:
325871f87433Sdalcinl +    snes - SNES context
325971f87433Sdalcinl .    version - version 1, 2 (default is 2) or 3
326071f87433Sdalcinl .    rtol_0 - initial relative tolerance (0 <= rtol_0 < 1)
326171f87433Sdalcinl .    rtol_max - maximum relative tolerance (0 <= rtol_max < 1)
326271f87433Sdalcinl .    gamma - multiplicative factor for version 2 rtol computation
326371f87433Sdalcinl              (0 <= gamma2 <= 1)
326471f87433Sdalcinl .    alpha - power for version 2 rtol computation (1 < alpha <= 2)
326571f87433Sdalcinl .    alpha2 - power for safeguard
326671f87433Sdalcinl -    threshold - threshold for imposing safeguard (0 < threshold < 1)
326771f87433Sdalcinl 
326871f87433Sdalcinl    Note:
326971f87433Sdalcinl    Version 3 was contributed by Luis Chacon, June 2006.
327071f87433Sdalcinl 
327171f87433Sdalcinl    Use PETSC_DEFAULT to retain the default for any of the parameters.
327271f87433Sdalcinl 
327371f87433Sdalcinl    Level: advanced
327471f87433Sdalcinl 
327571f87433Sdalcinl    Reference:
327671f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
327771f87433Sdalcinl    inexact Newton method", Utah State University Math. Stat. Dept. Res.
327871f87433Sdalcinl    Report 6/94/75, June, 1994, to appear in SIAM J. Sci. Comput.
327971f87433Sdalcinl 
328071f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, set, parameters
328171f87433Sdalcinl 
3282fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPGetParametersEW()
328371f87433Sdalcinl @*/
32847087cfbeSBarry Smith PetscErrorCode  SNESKSPSetParametersEW(SNES snes,PetscInt version,PetscReal rtol_0,PetscReal rtol_max,
328571f87433Sdalcinl 							    PetscReal gamma,PetscReal alpha,PetscReal alpha2,PetscReal threshold)
328671f87433Sdalcinl {
3287fa9f3622SBarry Smith   SNESKSPEW *kctx;
328871f87433Sdalcinl   PetscFunctionBegin;
32890700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3290fa9f3622SBarry Smith   kctx = (SNESKSPEW*)snes->kspconvctx;
3291e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing");
3292c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,version,2);
3293c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol_0,3);
3294c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol_max,4);
3295c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,gamma,5);
3296c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,alpha,6);
3297c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,alpha2,7);
3298c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,threshold,8);
329971f87433Sdalcinl 
330071f87433Sdalcinl   if (version != PETSC_DEFAULT)   kctx->version   = version;
330171f87433Sdalcinl   if (rtol_0 != PETSC_DEFAULT)    kctx->rtol_0    = rtol_0;
330271f87433Sdalcinl   if (rtol_max != PETSC_DEFAULT)  kctx->rtol_max  = rtol_max;
330371f87433Sdalcinl   if (gamma != PETSC_DEFAULT)     kctx->gamma     = gamma;
330471f87433Sdalcinl   if (alpha != PETSC_DEFAULT)     kctx->alpha     = alpha;
330571f87433Sdalcinl   if (alpha2 != PETSC_DEFAULT)    kctx->alpha2    = alpha2;
330671f87433Sdalcinl   if (threshold != PETSC_DEFAULT) kctx->threshold = threshold;
330771f87433Sdalcinl 
330871f87433Sdalcinl   if (kctx->version < 1 || kctx->version > 3) {
3309e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 and 3 are supported: %D",kctx->version);
331071f87433Sdalcinl   }
331171f87433Sdalcinl   if (kctx->rtol_0 < 0.0 || kctx->rtol_0 >= 1.0) {
3312e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_0 < 1.0: %G",kctx->rtol_0);
331371f87433Sdalcinl   }
331471f87433Sdalcinl   if (kctx->rtol_max < 0.0 || kctx->rtol_max >= 1.0) {
3315e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_max (%G) < 1.0\n",kctx->rtol_max);
331671f87433Sdalcinl   }
331771f87433Sdalcinl   if (kctx->gamma < 0.0 || kctx->gamma > 1.0) {
3318e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= gamma (%G) <= 1.0\n",kctx->gamma);
331971f87433Sdalcinl   }
332071f87433Sdalcinl   if (kctx->alpha <= 1.0 || kctx->alpha > 2.0) {
3321e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"1.0 < alpha (%G) <= 2.0\n",kctx->alpha);
332271f87433Sdalcinl   }
332371f87433Sdalcinl   if (kctx->threshold <= 0.0 || kctx->threshold >= 1.0) {
3324e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 < threshold (%G) < 1.0\n",kctx->threshold);
332571f87433Sdalcinl   }
332671f87433Sdalcinl   PetscFunctionReturn(0);
332771f87433Sdalcinl }
332871f87433Sdalcinl 
332971f87433Sdalcinl #undef __FUNCT__
3330fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetParametersEW"
333171f87433Sdalcinl /*@
3332fa9f3622SBarry Smith    SNESKSPGetParametersEW - Gets parameters for Eisenstat-Walker
333371f87433Sdalcinl    convergence criteria for the linear solvers within an inexact
333471f87433Sdalcinl    Newton method.
333571f87433Sdalcinl 
333671f87433Sdalcinl    Not Collective
333771f87433Sdalcinl 
333871f87433Sdalcinl    Input Parameters:
333971f87433Sdalcinl      snes - SNES context
334071f87433Sdalcinl 
334171f87433Sdalcinl    Output Parameters:
334271f87433Sdalcinl +    version - version 1, 2 (default is 2) or 3
334371f87433Sdalcinl .    rtol_0 - initial relative tolerance (0 <= rtol_0 < 1)
334471f87433Sdalcinl .    rtol_max - maximum relative tolerance (0 <= rtol_max < 1)
334571f87433Sdalcinl .    gamma - multiplicative factor for version 2 rtol computation
334671f87433Sdalcinl              (0 <= gamma2 <= 1)
334771f87433Sdalcinl .    alpha - power for version 2 rtol computation (1 < alpha <= 2)
334871f87433Sdalcinl .    alpha2 - power for safeguard
334971f87433Sdalcinl -    threshold - threshold for imposing safeguard (0 < threshold < 1)
335071f87433Sdalcinl 
335171f87433Sdalcinl    Level: advanced
335271f87433Sdalcinl 
335371f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, get, parameters
335471f87433Sdalcinl 
3355fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPSetParametersEW()
335671f87433Sdalcinl @*/
33577087cfbeSBarry Smith PetscErrorCode  SNESKSPGetParametersEW(SNES snes,PetscInt *version,PetscReal *rtol_0,PetscReal *rtol_max,
335871f87433Sdalcinl 							    PetscReal *gamma,PetscReal *alpha,PetscReal *alpha2,PetscReal *threshold)
335971f87433Sdalcinl {
3360fa9f3622SBarry Smith   SNESKSPEW *kctx;
336171f87433Sdalcinl   PetscFunctionBegin;
33620700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3363fa9f3622SBarry Smith   kctx = (SNESKSPEW*)snes->kspconvctx;
3364e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing");
336571f87433Sdalcinl   if(version)   *version   = kctx->version;
336671f87433Sdalcinl   if(rtol_0)    *rtol_0    = kctx->rtol_0;
336771f87433Sdalcinl   if(rtol_max)  *rtol_max  = kctx->rtol_max;
336871f87433Sdalcinl   if(gamma)     *gamma     = kctx->gamma;
336971f87433Sdalcinl   if(alpha)     *alpha     = kctx->alpha;
337071f87433Sdalcinl   if(alpha2)    *alpha2    = kctx->alpha2;
337171f87433Sdalcinl   if(threshold) *threshold = kctx->threshold;
337271f87433Sdalcinl   PetscFunctionReturn(0);
337371f87433Sdalcinl }
337471f87433Sdalcinl 
337571f87433Sdalcinl #undef __FUNCT__
3376fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PreSolve"
3377fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PreSolve(SNES snes, KSP ksp, Vec b, Vec x)
337871f87433Sdalcinl {
337971f87433Sdalcinl   PetscErrorCode ierr;
3380fa9f3622SBarry Smith   SNESKSPEW      *kctx = (SNESKSPEW*)snes->kspconvctx;
338171f87433Sdalcinl   PetscReal      rtol=PETSC_DEFAULT,stol;
338271f87433Sdalcinl 
338371f87433Sdalcinl   PetscFunctionBegin;
3384e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists");
338571f87433Sdalcinl   if (!snes->iter) { /* first time in, so use the original user rtol */
338671f87433Sdalcinl     rtol = kctx->rtol_0;
338771f87433Sdalcinl   } else {
338871f87433Sdalcinl     if (kctx->version == 1) {
338971f87433Sdalcinl       rtol = (snes->norm - kctx->lresid_last)/kctx->norm_last;
339071f87433Sdalcinl       if (rtol < 0.0) rtol = -rtol;
339171f87433Sdalcinl       stol = pow(kctx->rtol_last,kctx->alpha2);
339271f87433Sdalcinl       if (stol > kctx->threshold) rtol = PetscMax(rtol,stol);
339371f87433Sdalcinl     } else if (kctx->version == 2) {
339471f87433Sdalcinl       rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha);
339571f87433Sdalcinl       stol = kctx->gamma * pow(kctx->rtol_last,kctx->alpha);
339671f87433Sdalcinl       if (stol > kctx->threshold) rtol = PetscMax(rtol,stol);
339771f87433Sdalcinl     } else if (kctx->version == 3) {/* contributed by Luis Chacon, June 2006. */
339871f87433Sdalcinl       rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha);
339971f87433Sdalcinl       /* safeguard: avoid sharp decrease of rtol */
340071f87433Sdalcinl       stol = kctx->gamma*pow(kctx->rtol_last,kctx->alpha);
340171f87433Sdalcinl       stol = PetscMax(rtol,stol);
340271f87433Sdalcinl       rtol = PetscMin(kctx->rtol_0,stol);
340371f87433Sdalcinl       /* safeguard: avoid oversolving */
340471f87433Sdalcinl       stol = kctx->gamma*(snes->ttol)/snes->norm;
340571f87433Sdalcinl       stol = PetscMax(rtol,stol);
340671f87433Sdalcinl       rtol = PetscMin(kctx->rtol_0,stol);
3407e32f2f54SBarry Smith     } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 or 3 are supported: %D",kctx->version);
340871f87433Sdalcinl   }
340971f87433Sdalcinl   /* safeguard: avoid rtol greater than one */
341071f87433Sdalcinl   rtol = PetscMin(rtol,kctx->rtol_max);
341171f87433Sdalcinl   ierr = KSPSetTolerances(ksp,rtol,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT);CHKERRQ(ierr);
341271f87433Sdalcinl   ierr = PetscInfo3(snes,"iter %D, Eisenstat-Walker (version %D) KSP rtol=%G\n",snes->iter,kctx->version,rtol);CHKERRQ(ierr);
341371f87433Sdalcinl   PetscFunctionReturn(0);
341471f87433Sdalcinl }
341571f87433Sdalcinl 
341671f87433Sdalcinl #undef __FUNCT__
3417fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PostSolve"
3418fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PostSolve(SNES snes, KSP ksp, Vec b, Vec x)
341971f87433Sdalcinl {
342071f87433Sdalcinl   PetscErrorCode ierr;
3421fa9f3622SBarry Smith   SNESKSPEW      *kctx = (SNESKSPEW*)snes->kspconvctx;
342271f87433Sdalcinl   PCSide         pcside;
342371f87433Sdalcinl   Vec            lres;
342471f87433Sdalcinl 
342571f87433Sdalcinl   PetscFunctionBegin;
3426e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists");
342771f87433Sdalcinl   ierr = KSPGetTolerances(ksp,&kctx->rtol_last,0,0,0);CHKERRQ(ierr);
342871f87433Sdalcinl   ierr = SNESGetFunctionNorm(snes,&kctx->norm_last);CHKERRQ(ierr);
342971f87433Sdalcinl   if (kctx->version == 1) {
3430b037da10SBarry Smith     ierr = KSPGetPCSide(ksp,&pcside);CHKERRQ(ierr);
343171f87433Sdalcinl     if (pcside == PC_RIGHT) { /* XXX Should we also test KSP_UNPRECONDITIONED_NORM ? */
343271f87433Sdalcinl       /* KSP residual is true linear residual */
343371f87433Sdalcinl       ierr = KSPGetResidualNorm(ksp,&kctx->lresid_last);CHKERRQ(ierr);
343471f87433Sdalcinl     } else {
343571f87433Sdalcinl       /* KSP residual is preconditioned residual */
343671f87433Sdalcinl       /* compute true linear residual norm */
343771f87433Sdalcinl       ierr = VecDuplicate(b,&lres);CHKERRQ(ierr);
343871f87433Sdalcinl       ierr = MatMult(snes->jacobian,x,lres);CHKERRQ(ierr);
343971f87433Sdalcinl       ierr = VecAYPX(lres,-1.0,b);CHKERRQ(ierr);
344071f87433Sdalcinl       ierr = VecNorm(lres,NORM_2,&kctx->lresid_last);CHKERRQ(ierr);
34416bf464f9SBarry Smith       ierr = VecDestroy(&lres);CHKERRQ(ierr);
344271f87433Sdalcinl     }
344371f87433Sdalcinl   }
344471f87433Sdalcinl   PetscFunctionReturn(0);
344571f87433Sdalcinl }
344671f87433Sdalcinl 
344771f87433Sdalcinl #undef __FUNCT__
344871f87433Sdalcinl #define __FUNCT__ "SNES_KSPSolve"
344971f87433Sdalcinl PetscErrorCode SNES_KSPSolve(SNES snes, KSP ksp, Vec b, Vec x)
345071f87433Sdalcinl {
345171f87433Sdalcinl   PetscErrorCode ierr;
345271f87433Sdalcinl 
345371f87433Sdalcinl   PetscFunctionBegin;
3454fa9f3622SBarry Smith   if (snes->ksp_ewconv) { ierr = SNESKSPEW_PreSolve(snes,ksp,b,x);CHKERRQ(ierr);  }
345571f87433Sdalcinl   ierr = KSPSolve(ksp,b,x);CHKERRQ(ierr);
3456fa9f3622SBarry Smith   if (snes->ksp_ewconv) { ierr = SNESKSPEW_PostSolve(snes,ksp,b,x);CHKERRQ(ierr); }
345771f87433Sdalcinl   PetscFunctionReturn(0);
345871f87433Sdalcinl }
34596c699258SBarry Smith 
34606c699258SBarry Smith #undef __FUNCT__
34616c699258SBarry Smith #define __FUNCT__ "SNESSetDM"
34626c699258SBarry Smith /*@
34636c699258SBarry Smith    SNESSetDM - Sets the DM that may be used by some preconditioners
34646c699258SBarry Smith 
34653f9fe445SBarry Smith    Logically Collective on SNES
34666c699258SBarry Smith 
34676c699258SBarry Smith    Input Parameters:
34686c699258SBarry Smith +  snes - the preconditioner context
34696c699258SBarry Smith -  dm - the dm
34706c699258SBarry Smith 
34716c699258SBarry Smith    Level: intermediate
34726c699258SBarry Smith 
34736c699258SBarry Smith 
34746c699258SBarry Smith .seealso: SNESGetDM(), KSPSetDM(), KSPGetDM()
34756c699258SBarry Smith @*/
34767087cfbeSBarry Smith PetscErrorCode  SNESSetDM(SNES snes,DM dm)
34776c699258SBarry Smith {
34786c699258SBarry Smith   PetscErrorCode ierr;
3479345fed2cSBarry Smith   KSP            ksp;
34806c699258SBarry Smith 
34816c699258SBarry Smith   PetscFunctionBegin;
34820700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3483d0660788SBarry Smith   if (dm) {ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);}
34846bf464f9SBarry Smith   ierr = DMDestroy(&snes->dm);CHKERRQ(ierr);
34856c699258SBarry Smith   snes->dm = dm;
3486345fed2cSBarry Smith   ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
3487345fed2cSBarry Smith   ierr = KSPSetDM(ksp,dm);CHKERRQ(ierr);
3488f22f69f0SBarry Smith   ierr = KSPSetDMActive(ksp,PETSC_FALSE);CHKERRQ(ierr);
34892c155ee1SBarry Smith   if (snes->pc) {
34902c155ee1SBarry Smith     ierr = SNESSetDM(snes->pc, snes->dm);CHKERRQ(ierr);
34912c155ee1SBarry Smith   }
34926c699258SBarry Smith   PetscFunctionReturn(0);
34936c699258SBarry Smith }
34946c699258SBarry Smith 
34956c699258SBarry Smith #undef __FUNCT__
34966c699258SBarry Smith #define __FUNCT__ "SNESGetDM"
34976c699258SBarry Smith /*@
34986c699258SBarry Smith    SNESGetDM - Gets the DM that may be used by some preconditioners
34996c699258SBarry Smith 
35003f9fe445SBarry Smith    Not Collective but DM obtained is parallel on SNES
35016c699258SBarry Smith 
35026c699258SBarry Smith    Input Parameter:
35036c699258SBarry Smith . snes - the preconditioner context
35046c699258SBarry Smith 
35056c699258SBarry Smith    Output Parameter:
35066c699258SBarry Smith .  dm - the dm
35076c699258SBarry Smith 
35086c699258SBarry Smith    Level: intermediate
35096c699258SBarry Smith 
35106c699258SBarry Smith 
35116c699258SBarry Smith .seealso: SNESSetDM(), KSPSetDM(), KSPGetDM()
35126c699258SBarry Smith @*/
35137087cfbeSBarry Smith PetscErrorCode  SNESGetDM(SNES snes,DM *dm)
35146c699258SBarry Smith {
35156c699258SBarry Smith   PetscFunctionBegin;
35160700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
35176c699258SBarry Smith   *dm = snes->dm;
35186c699258SBarry Smith   PetscFunctionReturn(0);
35196c699258SBarry Smith }
35200807856dSBarry Smith 
352131823bd8SMatthew G Knepley #undef __FUNCT__
352231823bd8SMatthew G Knepley #define __FUNCT__ "SNESSetPC"
352331823bd8SMatthew G Knepley /*@
3524fd4b34e9SJed Brown   SNESSetPC - Sets the nonlinear preconditioner to be used.
352531823bd8SMatthew G Knepley 
352631823bd8SMatthew G Knepley   Collective on SNES
352731823bd8SMatthew G Knepley 
352831823bd8SMatthew G Knepley   Input Parameters:
352931823bd8SMatthew G Knepley + snes - iterative context obtained from SNESCreate()
353031823bd8SMatthew G Knepley - pc   - the preconditioner object
353131823bd8SMatthew G Knepley 
353231823bd8SMatthew G Knepley   Notes:
353331823bd8SMatthew G Knepley   Use SNESGetPC() to retrieve the preconditioner context (for example,
353431823bd8SMatthew G Knepley   to configure it using the API).
353531823bd8SMatthew G Knepley 
353631823bd8SMatthew G Knepley   Level: developer
353731823bd8SMatthew G Knepley 
353831823bd8SMatthew G Knepley .keywords: SNES, set, precondition
353931823bd8SMatthew G Knepley .seealso: SNESGetPC()
354031823bd8SMatthew G Knepley @*/
354131823bd8SMatthew G Knepley PetscErrorCode SNESSetPC(SNES snes, SNES pc)
354231823bd8SMatthew G Knepley {
354331823bd8SMatthew G Knepley   PetscErrorCode ierr;
354431823bd8SMatthew G Knepley 
354531823bd8SMatthew G Knepley   PetscFunctionBegin;
354631823bd8SMatthew G Knepley   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
354731823bd8SMatthew G Knepley   PetscValidHeaderSpecific(pc, SNES_CLASSID, 2);
354831823bd8SMatthew G Knepley   PetscCheckSameComm(snes, 1, pc, 2);
354931823bd8SMatthew G Knepley   ierr = PetscObjectReference((PetscObject) pc);CHKERRQ(ierr);
3550bf11d3b6SBarry Smith   ierr = SNESDestroy(&snes->pc);CHKERRQ(ierr);
355131823bd8SMatthew G Knepley   snes->pc = pc;
355231823bd8SMatthew G Knepley   ierr = PetscLogObjectParent(snes, snes->pc);CHKERRQ(ierr);
355331823bd8SMatthew G Knepley   PetscFunctionReturn(0);
355431823bd8SMatthew G Knepley }
355531823bd8SMatthew G Knepley 
355631823bd8SMatthew G Knepley #undef __FUNCT__
355731823bd8SMatthew G Knepley #define __FUNCT__ "SNESGetPC"
355831823bd8SMatthew G Knepley /*@
3559fd4b34e9SJed Brown   SNESGetPC - Returns a pointer to the nonlinear preconditioning context set with SNESSetPC().
356031823bd8SMatthew G Knepley 
356131823bd8SMatthew G Knepley   Not Collective
356231823bd8SMatthew G Knepley 
356331823bd8SMatthew G Knepley   Input Parameter:
356431823bd8SMatthew G Knepley . snes - iterative context obtained from SNESCreate()
356531823bd8SMatthew G Knepley 
356631823bd8SMatthew G Knepley   Output Parameter:
356731823bd8SMatthew G Knepley . pc - preconditioner context
356831823bd8SMatthew G Knepley 
356931823bd8SMatthew G Knepley   Level: developer
357031823bd8SMatthew G Knepley 
357131823bd8SMatthew G Knepley .keywords: SNES, get, preconditioner
357231823bd8SMatthew G Knepley .seealso: SNESSetPC()
357331823bd8SMatthew G Knepley @*/
357431823bd8SMatthew G Knepley PetscErrorCode SNESGetPC(SNES snes, SNES *pc)
357531823bd8SMatthew G Knepley {
357631823bd8SMatthew G Knepley   PetscErrorCode ierr;
357731823bd8SMatthew G Knepley 
357831823bd8SMatthew G Knepley   PetscFunctionBegin;
357931823bd8SMatthew G Knepley   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
358031823bd8SMatthew G Knepley   PetscValidPointer(pc, 2);
358131823bd8SMatthew G Knepley   if (!snes->pc) {
358231823bd8SMatthew G Knepley     ierr = SNESCreate(((PetscObject) snes)->comm, &snes->pc);CHKERRQ(ierr);
35834a0c5b0cSMatthew G Knepley     ierr = PetscObjectIncrementTabLevel((PetscObject) snes->pc, (PetscObject) snes, 1);CHKERRQ(ierr);
358431823bd8SMatthew G Knepley     ierr = PetscLogObjectParent(snes, snes->pc);CHKERRQ(ierr);
358531823bd8SMatthew G Knepley   }
358631823bd8SMatthew G Knepley   *pc = snes->pc;
358731823bd8SMatthew G Knepley   PetscFunctionReturn(0);
358831823bd8SMatthew G Knepley }
358931823bd8SMatthew G Knepley 
359069b4f73cSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
3591c6db04a5SJed Brown #include <mex.h>
359269b4f73cSBarry Smith 
35938f6e6473SBarry Smith typedef struct {char *funcname; mxArray *ctx;} SNESMatlabContext;
35948f6e6473SBarry Smith 
35950807856dSBarry Smith #undef __FUNCT__
35960807856dSBarry Smith #define __FUNCT__ "SNESComputeFunction_Matlab"
35970807856dSBarry Smith /*
35980807856dSBarry Smith    SNESComputeFunction_Matlab - Calls the function that has been set with
35990807856dSBarry Smith                          SNESSetFunctionMatlab().
36000807856dSBarry Smith 
36010807856dSBarry Smith    Collective on SNES
36020807856dSBarry Smith 
36030807856dSBarry Smith    Input Parameters:
36040807856dSBarry Smith +  snes - the SNES context
36050807856dSBarry Smith -  x - input vector
36060807856dSBarry Smith 
36070807856dSBarry Smith    Output Parameter:
36080807856dSBarry Smith .  y - function vector, as set by SNESSetFunction()
36090807856dSBarry Smith 
36100807856dSBarry Smith    Notes:
36110807856dSBarry Smith    SNESComputeFunction() is typically used within nonlinear solvers
36120807856dSBarry Smith    implementations, so most users would not generally call this routine
36130807856dSBarry Smith    themselves.
36140807856dSBarry Smith 
36150807856dSBarry Smith    Level: developer
36160807856dSBarry Smith 
36170807856dSBarry Smith .keywords: SNES, nonlinear, compute, function
36180807856dSBarry Smith 
36190807856dSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction()
362061b2408cSBarry Smith */
36217087cfbeSBarry Smith PetscErrorCode  SNESComputeFunction_Matlab(SNES snes,Vec x,Vec y, void *ctx)
36220807856dSBarry Smith {
3623e650e774SBarry Smith   PetscErrorCode    ierr;
36248f6e6473SBarry Smith   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
36258f6e6473SBarry Smith   int               nlhs = 1,nrhs = 5;
36268f6e6473SBarry Smith   mxArray	    *plhs[1],*prhs[5];
362791621f2eSBarry Smith   long long int     lx = 0,ly = 0,ls = 0;
3628e650e774SBarry Smith 
36290807856dSBarry Smith   PetscFunctionBegin;
36300807856dSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
36310807856dSBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
36320807856dSBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
36330807856dSBarry Smith   PetscCheckSameComm(snes,1,x,2);
36340807856dSBarry Smith   PetscCheckSameComm(snes,1,y,3);
36350807856dSBarry Smith 
36360807856dSBarry Smith   /* call Matlab function in ctx with arguments x and y */
3637e650e774SBarry Smith 
363891621f2eSBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
3639e650e774SBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
3640e650e774SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(x));CHKERRQ(ierr);
364191621f2eSBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
364291621f2eSBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)lx);
364391621f2eSBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)ly);
36448f6e6473SBarry Smith   prhs[3] =  mxCreateString(sctx->funcname);
36458f6e6473SBarry Smith   prhs[4] =  sctx->ctx;
3646b807a863SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeFunctionInternal");CHKERRQ(ierr);
3647e650e774SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
3648e650e774SBarry Smith   mxDestroyArray(prhs[0]);
3649e650e774SBarry Smith   mxDestroyArray(prhs[1]);
3650e650e774SBarry Smith   mxDestroyArray(prhs[2]);
36518f6e6473SBarry Smith   mxDestroyArray(prhs[3]);
3652e650e774SBarry Smith   mxDestroyArray(plhs[0]);
36530807856dSBarry Smith   PetscFunctionReturn(0);
36540807856dSBarry Smith }
36550807856dSBarry Smith 
36560807856dSBarry Smith 
36570807856dSBarry Smith #undef __FUNCT__
36580807856dSBarry Smith #define __FUNCT__ "SNESSetFunctionMatlab"
365961b2408cSBarry Smith /*
36600807856dSBarry Smith    SNESSetFunctionMatlab - Sets the function evaluation routine and function
36610807856dSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
3662e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
36630807856dSBarry Smith 
36640807856dSBarry Smith    Logically Collective on SNES
36650807856dSBarry Smith 
36660807856dSBarry Smith    Input Parameters:
36670807856dSBarry Smith +  snes - the SNES context
36680807856dSBarry Smith .  r - vector to store function value
36690807856dSBarry Smith -  func - function evaluation routine
36700807856dSBarry Smith 
36710807856dSBarry Smith    Calling sequence of func:
367261b2408cSBarry Smith $    func (SNES snes,Vec x,Vec f,void *ctx);
36730807856dSBarry Smith 
36740807856dSBarry Smith 
36750807856dSBarry Smith    Notes:
36760807856dSBarry Smith    The Newton-like methods typically solve linear systems of the form
36770807856dSBarry Smith $      f'(x) x = -f(x),
36780807856dSBarry Smith    where f'(x) denotes the Jacobian matrix and f(x) is the function.
36790807856dSBarry Smith 
36800807856dSBarry Smith    Level: beginner
36810807856dSBarry Smith 
36820807856dSBarry Smith .keywords: SNES, nonlinear, set, function
36830807856dSBarry Smith 
36840807856dSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
368561b2408cSBarry Smith */
36867087cfbeSBarry Smith PetscErrorCode  SNESSetFunctionMatlab(SNES snes,Vec r,const char *func,mxArray *ctx)
36870807856dSBarry Smith {
36880807856dSBarry Smith   PetscErrorCode    ierr;
36898f6e6473SBarry Smith   SNESMatlabContext *sctx;
36900807856dSBarry Smith 
36910807856dSBarry Smith   PetscFunctionBegin;
36928f6e6473SBarry Smith   /* currently sctx is memory bleed */
36938f6e6473SBarry Smith   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
36948f6e6473SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
36958f6e6473SBarry Smith   /*
36968f6e6473SBarry Smith      This should work, but it doesn't
36978f6e6473SBarry Smith   sctx->ctx = ctx;
36988f6e6473SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
36998f6e6473SBarry Smith   */
37008f6e6473SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
37018f6e6473SBarry Smith   ierr = SNESSetFunction(snes,r,SNESComputeFunction_Matlab,sctx);CHKERRQ(ierr);
37020807856dSBarry Smith   PetscFunctionReturn(0);
37030807856dSBarry Smith }
370469b4f73cSBarry Smith 
370561b2408cSBarry Smith #undef __FUNCT__
370661b2408cSBarry Smith #define __FUNCT__ "SNESComputeJacobian_Matlab"
370761b2408cSBarry Smith /*
370861b2408cSBarry Smith    SNESComputeJacobian_Matlab - Calls the function that has been set with
370961b2408cSBarry Smith                          SNESSetJacobianMatlab().
371061b2408cSBarry Smith 
371161b2408cSBarry Smith    Collective on SNES
371261b2408cSBarry Smith 
371361b2408cSBarry Smith    Input Parameters:
371461b2408cSBarry Smith +  snes - the SNES context
371561b2408cSBarry Smith .  x - input vector
371661b2408cSBarry Smith .  A, B - the matrices
371761b2408cSBarry Smith -  ctx - user context
371861b2408cSBarry Smith 
371961b2408cSBarry Smith    Output Parameter:
372061b2408cSBarry Smith .  flag - structure of the matrix
372161b2408cSBarry Smith 
372261b2408cSBarry Smith    Level: developer
372361b2408cSBarry Smith 
372461b2408cSBarry Smith .keywords: SNES, nonlinear, compute, function
372561b2408cSBarry Smith 
372661b2408cSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction()
372761b2408cSBarry Smith @*/
37287087cfbeSBarry Smith PetscErrorCode  SNESComputeJacobian_Matlab(SNES snes,Vec x,Mat *A,Mat *B,MatStructure *flag, void *ctx)
372961b2408cSBarry Smith {
373061b2408cSBarry Smith   PetscErrorCode    ierr;
373161b2408cSBarry Smith   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
373261b2408cSBarry Smith   int               nlhs = 2,nrhs = 6;
373361b2408cSBarry Smith   mxArray	    *plhs[2],*prhs[6];
373461b2408cSBarry Smith   long long int     lx = 0,lA = 0,ls = 0, lB = 0;
373561b2408cSBarry Smith 
373661b2408cSBarry Smith   PetscFunctionBegin;
373761b2408cSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
373861b2408cSBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
373961b2408cSBarry Smith 
374061b2408cSBarry Smith   /* call Matlab function in ctx with arguments x and y */
374161b2408cSBarry Smith 
374261b2408cSBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
374361b2408cSBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
374461b2408cSBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(x));CHKERRQ(ierr);
374561b2408cSBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(x));CHKERRQ(ierr);
374661b2408cSBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
374761b2408cSBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)lx);
374861b2408cSBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lA);
374961b2408cSBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lB);
375061b2408cSBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
375161b2408cSBarry Smith   prhs[5] =  sctx->ctx;
3752b807a863SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeJacobianInternal");CHKERRQ(ierr);
375361b2408cSBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
375461b2408cSBarry Smith   *flag   =  (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr);
375561b2408cSBarry Smith   mxDestroyArray(prhs[0]);
375661b2408cSBarry Smith   mxDestroyArray(prhs[1]);
375761b2408cSBarry Smith   mxDestroyArray(prhs[2]);
375861b2408cSBarry Smith   mxDestroyArray(prhs[3]);
375961b2408cSBarry Smith   mxDestroyArray(prhs[4]);
376061b2408cSBarry Smith   mxDestroyArray(plhs[0]);
376161b2408cSBarry Smith   mxDestroyArray(plhs[1]);
376261b2408cSBarry Smith   PetscFunctionReturn(0);
376361b2408cSBarry Smith }
376461b2408cSBarry Smith 
376561b2408cSBarry Smith 
376661b2408cSBarry Smith #undef __FUNCT__
376761b2408cSBarry Smith #define __FUNCT__ "SNESSetJacobianMatlab"
376861b2408cSBarry Smith /*
376961b2408cSBarry Smith    SNESSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
377061b2408cSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
3771e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
377261b2408cSBarry Smith 
377361b2408cSBarry Smith    Logically Collective on SNES
377461b2408cSBarry Smith 
377561b2408cSBarry Smith    Input Parameters:
377661b2408cSBarry Smith +  snes - the SNES context
377761b2408cSBarry Smith .  A,B - Jacobian matrices
377861b2408cSBarry Smith .  func - function evaluation routine
377961b2408cSBarry Smith -  ctx - user context
378061b2408cSBarry Smith 
378161b2408cSBarry Smith    Calling sequence of func:
378261b2408cSBarry Smith $    flag = func (SNES snes,Vec x,Mat A,Mat B,void *ctx);
378361b2408cSBarry Smith 
378461b2408cSBarry Smith 
378561b2408cSBarry Smith    Level: developer
378661b2408cSBarry Smith 
378761b2408cSBarry Smith .keywords: SNES, nonlinear, set, function
378861b2408cSBarry Smith 
378961b2408cSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
379061b2408cSBarry Smith */
37917087cfbeSBarry Smith PetscErrorCode  SNESSetJacobianMatlab(SNES snes,Mat A,Mat B,const char *func,mxArray *ctx)
379261b2408cSBarry Smith {
379361b2408cSBarry Smith   PetscErrorCode    ierr;
379461b2408cSBarry Smith   SNESMatlabContext *sctx;
379561b2408cSBarry Smith 
379661b2408cSBarry Smith   PetscFunctionBegin;
379761b2408cSBarry Smith   /* currently sctx is memory bleed */
379861b2408cSBarry Smith   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
379961b2408cSBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
380061b2408cSBarry Smith   /*
380161b2408cSBarry Smith      This should work, but it doesn't
380261b2408cSBarry Smith   sctx->ctx = ctx;
380361b2408cSBarry Smith   mexMakeArrayPersistent(sctx->ctx);
380461b2408cSBarry Smith   */
380561b2408cSBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
380661b2408cSBarry Smith   ierr = SNESSetJacobian(snes,A,B,SNESComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
380761b2408cSBarry Smith   PetscFunctionReturn(0);
380861b2408cSBarry Smith }
380969b4f73cSBarry Smith 
3810f9eb7ae2SShri Abhyankar #undef __FUNCT__
3811f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitor_Matlab"
3812f9eb7ae2SShri Abhyankar /*
3813f9eb7ae2SShri Abhyankar    SNESMonitor_Matlab - Calls the function that has been set with SNESMonitorSetMatlab().
3814f9eb7ae2SShri Abhyankar 
3815f9eb7ae2SShri Abhyankar    Collective on SNES
3816f9eb7ae2SShri Abhyankar 
3817f9eb7ae2SShri Abhyankar .seealso: SNESSetFunction(), SNESGetFunction()
3818f9eb7ae2SShri Abhyankar @*/
38197087cfbeSBarry Smith PetscErrorCode  SNESMonitor_Matlab(SNES snes,PetscInt it, PetscReal fnorm, void *ctx)
3820f9eb7ae2SShri Abhyankar {
3821f9eb7ae2SShri Abhyankar   PetscErrorCode  ierr;
382248f37e70SShri Abhyankar   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
3823f9eb7ae2SShri Abhyankar   int             nlhs = 1,nrhs = 6;
3824f9eb7ae2SShri Abhyankar   mxArray	  *plhs[1],*prhs[6];
3825f9eb7ae2SShri Abhyankar   long long int   lx = 0,ls = 0;
3826f9eb7ae2SShri Abhyankar   Vec             x=snes->vec_sol;
3827f9eb7ae2SShri Abhyankar 
3828f9eb7ae2SShri Abhyankar   PetscFunctionBegin;
3829f9eb7ae2SShri Abhyankar   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3830f9eb7ae2SShri Abhyankar 
3831f9eb7ae2SShri Abhyankar   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
3832f9eb7ae2SShri Abhyankar   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
3833f9eb7ae2SShri Abhyankar   prhs[0] =  mxCreateDoubleScalar((double)ls);
3834f9eb7ae2SShri Abhyankar   prhs[1] =  mxCreateDoubleScalar((double)it);
3835f9eb7ae2SShri Abhyankar   prhs[2] =  mxCreateDoubleScalar((double)fnorm);
3836f9eb7ae2SShri Abhyankar   prhs[3] =  mxCreateDoubleScalar((double)lx);
3837f9eb7ae2SShri Abhyankar   prhs[4] =  mxCreateString(sctx->funcname);
3838f9eb7ae2SShri Abhyankar   prhs[5] =  sctx->ctx;
3839f9eb7ae2SShri Abhyankar   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESMonitorInternal");CHKERRQ(ierr);
3840f9eb7ae2SShri Abhyankar   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
3841f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[0]);
3842f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[1]);
3843f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[2]);
3844f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[3]);
3845f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[4]);
3846f9eb7ae2SShri Abhyankar   mxDestroyArray(plhs[0]);
3847f9eb7ae2SShri Abhyankar   PetscFunctionReturn(0);
3848f9eb7ae2SShri Abhyankar }
3849f9eb7ae2SShri Abhyankar 
3850f9eb7ae2SShri Abhyankar 
3851f9eb7ae2SShri Abhyankar #undef __FUNCT__
3852f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitorSetMatlab"
3853f9eb7ae2SShri Abhyankar /*
3854e3c5b3baSBarry Smith    SNESMonitorSetMatlab - Sets the monitor function from MATLAB
3855f9eb7ae2SShri Abhyankar 
3856f9eb7ae2SShri Abhyankar    Level: developer
3857f9eb7ae2SShri Abhyankar 
3858f9eb7ae2SShri Abhyankar .keywords: SNES, nonlinear, set, function
3859f9eb7ae2SShri Abhyankar 
3860f9eb7ae2SShri Abhyankar .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
3861f9eb7ae2SShri Abhyankar */
38627087cfbeSBarry Smith PetscErrorCode  SNESMonitorSetMatlab(SNES snes,const char *func,mxArray *ctx)
3863f9eb7ae2SShri Abhyankar {
3864f9eb7ae2SShri Abhyankar   PetscErrorCode    ierr;
3865f9eb7ae2SShri Abhyankar   SNESMatlabContext *sctx;
3866f9eb7ae2SShri Abhyankar 
3867f9eb7ae2SShri Abhyankar   PetscFunctionBegin;
3868f9eb7ae2SShri Abhyankar   /* currently sctx is memory bleed */
3869f9eb7ae2SShri Abhyankar   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
3870f9eb7ae2SShri Abhyankar   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
3871f9eb7ae2SShri Abhyankar   /*
3872f9eb7ae2SShri Abhyankar      This should work, but it doesn't
3873f9eb7ae2SShri Abhyankar   sctx->ctx = ctx;
3874f9eb7ae2SShri Abhyankar   mexMakeArrayPersistent(sctx->ctx);
3875f9eb7ae2SShri Abhyankar   */
3876f9eb7ae2SShri Abhyankar   sctx->ctx = mxDuplicateArray(ctx);
3877f9eb7ae2SShri Abhyankar   ierr = SNESMonitorSet(snes,SNESMonitor_Matlab,sctx,PETSC_NULL);CHKERRQ(ierr);
3878f9eb7ae2SShri Abhyankar   PetscFunctionReturn(0);
3879f9eb7ae2SShri Abhyankar }
3880f9eb7ae2SShri Abhyankar 
388169b4f73cSBarry Smith #endif
3882