xref: /petsc/src/snes/interface/snes.c (revision ab54825eba4f48f343332086291212fbb7233871)
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) {
189eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Jacobian is rebuilt every %D Newton 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   }
19694b7f48cSBarry Smith   ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
1974a0c5b0cSMatthew G Knepley   if (snes->pc) {
1984a0c5b0cSMatthew G Knepley     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1994a0c5b0cSMatthew G Knepley     ierr = SNESView(snes->pc, viewer);CHKERRQ(ierr);
2004a0c5b0cSMatthew G Knepley     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2014a0c5b0cSMatthew G Knepley   }
202b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
20394b7f48cSBarry Smith   ierr = KSPView(ksp,viewer);CHKERRQ(ierr);
204b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2053a40ed3dSBarry Smith   PetscFunctionReturn(0);
2069b94acceSBarry Smith }
2079b94acceSBarry Smith 
20876b2cf59SMatthew Knepley /*
20976b2cf59SMatthew Knepley   We retain a list of functions that also take SNES command
21076b2cf59SMatthew Knepley   line options. These are called at the end SNESSetFromOptions()
21176b2cf59SMatthew Knepley */
21276b2cf59SMatthew Knepley #define MAXSETFROMOPTIONS 5
213a7cc72afSBarry Smith static PetscInt numberofsetfromoptions;
2146849ba73SBarry Smith static PetscErrorCode (*othersetfromoptions[MAXSETFROMOPTIONS])(SNES);
21576b2cf59SMatthew Knepley 
216e74ef692SMatthew Knepley #undef __FUNCT__
217e74ef692SMatthew Knepley #define __FUNCT__ "SNESAddOptionsChecker"
218ac226902SBarry Smith /*@C
21976b2cf59SMatthew Knepley   SNESAddOptionsChecker - Adds an additional function to check for SNES options.
22076b2cf59SMatthew Knepley 
22176b2cf59SMatthew Knepley   Not Collective
22276b2cf59SMatthew Knepley 
22376b2cf59SMatthew Knepley   Input Parameter:
22476b2cf59SMatthew Knepley . snescheck - function that checks for options
22576b2cf59SMatthew Knepley 
22676b2cf59SMatthew Knepley   Level: developer
22776b2cf59SMatthew Knepley 
22876b2cf59SMatthew Knepley .seealso: SNESSetFromOptions()
22976b2cf59SMatthew Knepley @*/
2307087cfbeSBarry Smith PetscErrorCode  SNESAddOptionsChecker(PetscErrorCode (*snescheck)(SNES))
23176b2cf59SMatthew Knepley {
23276b2cf59SMatthew Knepley   PetscFunctionBegin;
23376b2cf59SMatthew Knepley   if (numberofsetfromoptions >= MAXSETFROMOPTIONS) {
234e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "Too many options checkers, only %D allowed", MAXSETFROMOPTIONS);
23576b2cf59SMatthew Knepley   }
23676b2cf59SMatthew Knepley   othersetfromoptions[numberofsetfromoptions++] = snescheck;
23776b2cf59SMatthew Knepley   PetscFunctionReturn(0);
23876b2cf59SMatthew Knepley }
23976b2cf59SMatthew Knepley 
2407087cfbeSBarry Smith extern PetscErrorCode  SNESDefaultMatrixFreeCreate2(SNES,Vec,Mat*);
241aa3661deSLisandro Dalcin 
242aa3661deSLisandro Dalcin #undef __FUNCT__
243aa3661deSLisandro Dalcin #define __FUNCT__ "SNESSetUpMatrixFree_Private"
244ace3abfcSBarry Smith static PetscErrorCode SNESSetUpMatrixFree_Private(SNES snes, PetscBool  hasOperator, PetscInt version)
245aa3661deSLisandro Dalcin {
246aa3661deSLisandro Dalcin   Mat            J;
247aa3661deSLisandro Dalcin   KSP            ksp;
248aa3661deSLisandro Dalcin   PC             pc;
249ace3abfcSBarry Smith   PetscBool      match;
250aa3661deSLisandro Dalcin   PetscErrorCode ierr;
251aa3661deSLisandro Dalcin 
252aa3661deSLisandro Dalcin   PetscFunctionBegin;
2530700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
254aa3661deSLisandro Dalcin 
25598613b67SLisandro Dalcin   if(!snes->vec_func && (snes->jacobian || snes->jacobian_pre)) {
25698613b67SLisandro Dalcin     Mat A = snes->jacobian, B = snes->jacobian_pre;
25798613b67SLisandro Dalcin     ierr = MatGetVecs(A ? A : B, PETSC_NULL,&snes->vec_func);CHKERRQ(ierr);
25898613b67SLisandro Dalcin   }
25998613b67SLisandro Dalcin 
260aa3661deSLisandro Dalcin   if (version == 1) {
261aa3661deSLisandro Dalcin     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
26298613b67SLisandro Dalcin     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
2639c6ac3b3SBarry Smith     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
264aa3661deSLisandro Dalcin   } else if (version == 2) {
265e32f2f54SBarry Smith     if (!snes->vec_func) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"SNESSetFunction() must be called first");
266ce63c4c1SBarry Smith #if !defined(PETSC_USE_COMPLEX) && !defined(PETSC_USE_REAL_SINGLE) && !defined(PETSC_USE_REAL___FLOAT128) && !defined(PETSC_USE_REAL_LONG_DOUBLE)
267aa3661deSLisandro Dalcin     ierr = SNESDefaultMatrixFreeCreate2(snes,snes->vec_func,&J);CHKERRQ(ierr);
268aa3661deSLisandro Dalcin #else
269e32f2f54SBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP, "matrix-free operator rutines (version 2)");
270aa3661deSLisandro Dalcin #endif
271a8248277SBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "matrix-free operator rutines, only version 1 and 2");
272aa3661deSLisandro Dalcin 
273aa3661deSLisandro Dalcin   ierr = PetscInfo1(snes,"Setting default matrix-free operator routines (version %D)\n", version);CHKERRQ(ierr);
274d3462f78SMatthew Knepley   if (hasOperator) {
275aa3661deSLisandro Dalcin     /* This version replaces the user provided Jacobian matrix with a
276aa3661deSLisandro Dalcin        matrix-free version but still employs the user-provided preconditioner matrix. */
277aa3661deSLisandro Dalcin     ierr = SNESSetJacobian(snes,J,0,0,0);CHKERRQ(ierr);
278aa3661deSLisandro Dalcin   } else {
279aa3661deSLisandro Dalcin     /* This version replaces both the user-provided Jacobian and the user-
280aa3661deSLisandro Dalcin        provided preconditioner matrix with the default matrix free version. */
281aa3661deSLisandro Dalcin     ierr = SNESSetJacobian(snes,J,J,MatMFFDComputeJacobian,snes->funP);CHKERRQ(ierr);
282aa3661deSLisandro Dalcin     /* Force no preconditioner */
283aa3661deSLisandro Dalcin     ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
284aa3661deSLisandro Dalcin     ierr = KSPGetPC(ksp,&pc);CHKERRQ(ierr);
285aa3661deSLisandro Dalcin     ierr = PetscTypeCompare((PetscObject)pc,PCSHELL,&match);CHKERRQ(ierr);
286aa3661deSLisandro Dalcin     if (!match) {
287aa3661deSLisandro Dalcin       ierr = PetscInfo(snes,"Setting default matrix-free preconditioner routines\nThat is no preconditioner is being used\n");CHKERRQ(ierr);
288aa3661deSLisandro Dalcin       ierr = PCSetType(pc,PCNONE);CHKERRQ(ierr);
289aa3661deSLisandro Dalcin     }
290aa3661deSLisandro Dalcin   }
2916bf464f9SBarry Smith   ierr = MatDestroy(&J);CHKERRQ(ierr);
292aa3661deSLisandro Dalcin   PetscFunctionReturn(0);
293aa3661deSLisandro Dalcin }
294aa3661deSLisandro Dalcin 
2954a2ae208SSatish Balay #undef __FUNCT__
2964a2ae208SSatish Balay #define __FUNCT__ "SNESSetFromOptions"
2979b94acceSBarry Smith /*@
29894b7f48cSBarry Smith    SNESSetFromOptions - Sets various SNES and KSP parameters from user options.
2999b94acceSBarry Smith 
300c7afd0dbSLois Curfman McInnes    Collective on SNES
301c7afd0dbSLois Curfman McInnes 
3029b94acceSBarry Smith    Input Parameter:
3039b94acceSBarry Smith .  snes - the SNES context
3049b94acceSBarry Smith 
30536851e7fSLois Curfman McInnes    Options Database Keys:
3066831982aSBarry Smith +  -snes_type <type> - ls, tr, umls, umtr, test
30782738288SBarry Smith .  -snes_stol - convergence tolerance in terms of the norm
30882738288SBarry Smith                 of the change in the solution between steps
30970441072SBarry Smith .  -snes_atol <abstol> - absolute tolerance of residual norm
310b39c3a46SLois Curfman McInnes .  -snes_rtol <rtol> - relative decrease in tolerance norm from initial
311b39c3a46SLois Curfman McInnes .  -snes_max_it <max_it> - maximum number of iterations
312b39c3a46SLois Curfman McInnes .  -snes_max_funcs <max_funcs> - maximum number of function evaluations
31350ffb88aSMatthew Knepley .  -snes_max_fail <max_fail> - maximum number of failures
314ddf469c8SBarry Smith .  -snes_max_linear_solve_fail - number of linear solver failures before SNESSolve() stops
315a8054027SBarry Smith .  -snes_lag_preconditioner <lag> - how often preconditioner is rebuilt (use -1 to never rebuild)
316e35cf81dSBarry Smith .  -snes_lag_jacobian <lag> - how often Jacobian is rebuilt (use -1 to never rebuild)
317b39c3a46SLois Curfman McInnes .  -snes_trtol <trtol> - trust region tolerance
3182492ecdbSBarry Smith .  -snes_no_convergence_test - skip convergence test in nonlinear
31982738288SBarry Smith                                solver; hence iterations will continue until max_it
3201fbbfb26SLois Curfman McInnes                                or some other criterion is reached. Saves expense
32182738288SBarry Smith                                of convergence test
322e8105e01SRichard Katz .  -snes_monitor <optional filename> - prints residual norm at each iteration. if no
323e8105e01SRichard Katz                                        filename given prints to stdout
324a6570f20SBarry Smith .  -snes_monitor_solution - plots solution at each iteration
325a6570f20SBarry Smith .  -snes_monitor_residual - plots residual (not its norm) at each iteration
326a6570f20SBarry Smith .  -snes_monitor_solution_update - plots update to solution at each iteration
327a6570f20SBarry Smith .  -snes_monitor_draw - plots residual norm at each iteration
328e24b481bSBarry Smith .  -snes_fd - use finite differences to compute Jacobian; very slow, only for testing
3295968eb51SBarry Smith .  -snes_mf_ksp_monitor - if using matrix-free multiply then print h at each KSP iteration
330fee2055bSBarry Smith -  -snes_converged_reason - print the reason for convergence/divergence after each solve
33182738288SBarry Smith 
33282738288SBarry Smith     Options Database for Eisenstat-Walker method:
333fa9f3622SBarry Smith +  -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence
3344b27c08aSLois Curfman McInnes .  -snes_ksp_ew_version ver - version of  Eisenstat-Walker method
33536851e7fSLois Curfman McInnes .  -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0
33636851e7fSLois Curfman McInnes .  -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax
33736851e7fSLois Curfman McInnes .  -snes_ksp_ew_gamma <gamma> - Sets gamma
33836851e7fSLois Curfman McInnes .  -snes_ksp_ew_alpha <alpha> - Sets alpha
33936851e7fSLois Curfman McInnes .  -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2
34036851e7fSLois Curfman McInnes -  -snes_ksp_ew_threshold <threshold> - Sets threshold
34182738288SBarry Smith 
34211ca99fdSLois Curfman McInnes    Notes:
34311ca99fdSLois Curfman McInnes    To see all options, run your program with the -help option or consult
3440598bfebSBarry Smith    the <A href="../../docs/manual.pdf#nameddest=ch_snes">SNES chapter of the users manual</A>.
34583e2fdc7SBarry Smith 
34636851e7fSLois Curfman McInnes    Level: beginner
34736851e7fSLois Curfman McInnes 
3489b94acceSBarry Smith .keywords: SNES, nonlinear, set, options, database
3499b94acceSBarry Smith 
35069ed319cSSatish Balay .seealso: SNESSetOptionsPrefix()
3519b94acceSBarry Smith @*/
3527087cfbeSBarry Smith PetscErrorCode  SNESSetFromOptions(SNES snes)
3539b94acceSBarry Smith {
354ace3abfcSBarry Smith   PetscBool               flg,mf,mf_operator;
355efd51863SBarry Smith   PetscInt                i,indx,lag,mf_version,grids;
356aa3661deSLisandro Dalcin   MatStructure            matflag;
35785385478SLisandro Dalcin   const char              *deft = SNESLS;
35885385478SLisandro Dalcin   const char              *convtests[] = {"default","skip"};
35985385478SLisandro Dalcin   SNESKSPEW               *kctx = NULL;
360e8105e01SRichard Katz   char                    type[256], monfilename[PETSC_MAX_PATH_LEN];
361649052a6SBarry Smith   PetscViewer             monviewer;
36285385478SLisandro Dalcin   PetscErrorCode          ierr;
3639b94acceSBarry Smith 
3643a40ed3dSBarry Smith   PetscFunctionBegin;
3650700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
366ca161407SBarry Smith 
367186905e3SBarry Smith   if (!SNESRegisterAllCalled) {ierr = SNESRegisterAll(PETSC_NULL);CHKERRQ(ierr);}
3683194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)snes);CHKERRQ(ierr);
3697adad957SLisandro Dalcin     if (((PetscObject)snes)->type_name) { deft = ((PetscObject)snes)->type_name; }
370b0a32e0cSBarry Smith     ierr = PetscOptionsList("-snes_type","Nonlinear solver method","SNESSetType",SNESList,deft,type,256,&flg);CHKERRQ(ierr);
371d64ed03dSBarry Smith     if (flg) {
372186905e3SBarry Smith       ierr = SNESSetType(snes,type);CHKERRQ(ierr);
3737adad957SLisandro Dalcin     } else if (!((PetscObject)snes)->type_name) {
374186905e3SBarry Smith       ierr = SNESSetType(snes,deft);CHKERRQ(ierr);
375d64ed03dSBarry Smith     }
37690d69ab7SBarry Smith     /* not used here, but called so will go into help messaage */
377909c8a9fSBarry Smith     ierr = PetscOptionsName("-snes_view","Print detailed information on solver used","SNESView",0);CHKERRQ(ierr);
37893c39befSBarry Smith 
37957034d6fSHong Zhang     ierr = PetscOptionsReal("-snes_stol","Stop if step length less than","SNESSetTolerances",snes->xtol,&snes->xtol,0);CHKERRQ(ierr);
38057034d6fSHong Zhang     ierr = PetscOptionsReal("-snes_atol","Stop if function norm less than","SNESSetTolerances",snes->abstol,&snes->abstol,0);CHKERRQ(ierr);
381186905e3SBarry Smith 
38257034d6fSHong Zhang     ierr = PetscOptionsReal("-snes_rtol","Stop if decrease in function norm less than","SNESSetTolerances",snes->rtol,&snes->rtol,0);CHKERRQ(ierr);
383b0a32e0cSBarry Smith     ierr = PetscOptionsInt("-snes_max_it","Maximum iterations","SNESSetTolerances",snes->max_its,&snes->max_its,PETSC_NULL);CHKERRQ(ierr);
384b0a32e0cSBarry Smith     ierr = PetscOptionsInt("-snes_max_funcs","Maximum function evaluations","SNESSetTolerances",snes->max_funcs,&snes->max_funcs,PETSC_NULL);CHKERRQ(ierr);
38550ffb88aSMatthew Knepley     ierr = PetscOptionsInt("-snes_max_fail","Maximum failures","SNESSetTolerances",snes->maxFailures,&snes->maxFailures,PETSC_NULL);CHKERRQ(ierr);
386ddf469c8SBarry Smith     ierr = PetscOptionsInt("-snes_max_linear_solve_fail","Maximum failures in linear solves allowed","SNESSetMaxLinearSolveFailures",snes->maxLinearSolveFailures,&snes->maxLinearSolveFailures,PETSC_NULL);CHKERRQ(ierr);
387acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_error_if_not_converged","Generate error if solver does not converge","SNESSetErrorIfNotConverged",snes->errorifnotconverged,&snes->errorifnotconverged,PETSC_NULL);CHKERRQ(ierr);
38885385478SLisandro Dalcin 
389a8054027SBarry Smith     ierr = PetscOptionsInt("-snes_lag_preconditioner","How often to rebuild preconditioner","SNESSetLagPreconditioner",snes->lagpreconditioner,&lag,&flg);CHKERRQ(ierr);
390a8054027SBarry Smith     if (flg) {
391a8054027SBarry Smith       ierr = SNESSetLagPreconditioner(snes,lag);CHKERRQ(ierr);
392a8054027SBarry Smith     }
393e35cf81dSBarry Smith     ierr = PetscOptionsInt("-snes_lag_jacobian","How often to rebuild Jacobian","SNESSetLagJacobian",snes->lagjacobian,&lag,&flg);CHKERRQ(ierr);
394e35cf81dSBarry Smith     if (flg) {
395e35cf81dSBarry Smith       ierr = SNESSetLagJacobian(snes,lag);CHKERRQ(ierr);
396e35cf81dSBarry Smith     }
397efd51863SBarry Smith     ierr = PetscOptionsInt("-snes_grid_sequence","Use grid sequencing to generate initial guess","SNESSetGridSequence",snes->gridsequence,&grids,&flg);CHKERRQ(ierr);
398efd51863SBarry Smith     if (flg) {
399efd51863SBarry Smith       ierr = SNESSetGridSequence(snes,grids);CHKERRQ(ierr);
400efd51863SBarry Smith     }
401a8054027SBarry Smith 
40285385478SLisandro Dalcin     ierr = PetscOptionsEList("-snes_convergence_test","Convergence test","SNESSetConvergenceTest",convtests,2,"default",&indx,&flg);CHKERRQ(ierr);
40385385478SLisandro Dalcin     if (flg) {
40485385478SLisandro Dalcin       switch (indx) {
4057f7931b9SBarry Smith       case 0: ierr = SNESSetConvergenceTest(snes,SNESDefaultConverged,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); break;
4067f7931b9SBarry Smith       case 1: ierr = SNESSetConvergenceTest(snes,SNESSkipConverged,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);    break;
40785385478SLisandro Dalcin       }
40885385478SLisandro Dalcin     }
40985385478SLisandro Dalcin 
410acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_converged_reason","Print reason for converged or diverged","SNESSolve",snes->printreason,&snes->printreason,PETSC_NULL);CHKERRQ(ierr);
411186905e3SBarry Smith 
41285385478SLisandro Dalcin     kctx = (SNESKSPEW *)snes->kspconvctx;
41385385478SLisandro Dalcin 
414acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_ksp_ew","Use Eisentat-Walker linear system convergence test","SNESKSPSetUseEW",snes->ksp_ewconv,&snes->ksp_ewconv,PETSC_NULL);CHKERRQ(ierr);
415186905e3SBarry Smith 
416fa9f3622SBarry Smith     ierr = PetscOptionsInt("-snes_ksp_ew_version","Version 1, 2 or 3","SNESKSPSetParametersEW",kctx->version,&kctx->version,0);CHKERRQ(ierr);
417fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_rtol0","0 <= rtol0 < 1","SNESKSPSetParametersEW",kctx->rtol_0,&kctx->rtol_0,0);CHKERRQ(ierr);
418fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_rtolmax","0 <= rtolmax < 1","SNESKSPSetParametersEW",kctx->rtol_max,&kctx->rtol_max,0);CHKERRQ(ierr);
419fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_gamma","0 <= gamma <= 1","SNESKSPSetParametersEW",kctx->gamma,&kctx->gamma,0);CHKERRQ(ierr);
420fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_alpha","1 < alpha <= 2","SNESKSPSetParametersEW",kctx->alpha,&kctx->alpha,0);CHKERRQ(ierr);
421fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_alpha2","alpha2","SNESKSPSetParametersEW",kctx->alpha2,&kctx->alpha2,0);CHKERRQ(ierr);
422fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_threshold","0 < threshold < 1","SNESKSPSetParametersEW",kctx->threshold,&kctx->threshold,0);CHKERRQ(ierr);
423186905e3SBarry Smith 
42490d69ab7SBarry Smith     flg  = PETSC_FALSE;
425acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_cancel","Remove all monitors","SNESMonitorCancel",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
426a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorCancel(snes);CHKERRQ(ierr);}
427eabae89aSBarry Smith 
428a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_monitor","Monitor norm of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
429e8105e01SRichard Katz     if (flg) {
430649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
431649052a6SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
432e8105e01SRichard Katz     }
433eabae89aSBarry Smith 
434b271bb04SBarry Smith     ierr = PetscOptionsString("-snes_monitor_range","Monitor range of elements of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
435b271bb04SBarry Smith     if (flg) {
436b271bb04SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorRange,0,0);CHKERRQ(ierr);
437b271bb04SBarry Smith     }
438b271bb04SBarry Smith 
439a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_ratiomonitor","Monitor ratios of norms of function","SNESMonitorSetRatio","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
440eabae89aSBarry Smith     if (flg) {
441649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
442f1bef1bcSMatthew Knepley       ierr = SNESMonitorSetRatio(snes,monviewer);CHKERRQ(ierr);
443e8105e01SRichard Katz     }
444eabae89aSBarry Smith 
445a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_monitor_short","Monitor norm of function (fewer digits)","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
446eabae89aSBarry Smith     if (flg) {
447649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
448649052a6SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorDefaultShort,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
449eabae89aSBarry Smith     }
450eabae89aSBarry Smith 
4515180491cSLisandro Dalcin     ierr = PetscOptionsString("-snes_monitor_python","Use Python function","SNESMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
4525180491cSLisandro Dalcin     if (flg) {ierr = PetscPythonMonitorSet((PetscObject)snes,monfilename);CHKERRQ(ierr);}
4535180491cSLisandro Dalcin 
45490d69ab7SBarry Smith     flg  = PETSC_FALSE;
455acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_solution","Plot solution at each iteration","SNESMonitorSolution",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
456a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolution,0,0);CHKERRQ(ierr);}
45790d69ab7SBarry Smith     flg  = PETSC_FALSE;
458acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_solution_update","Plot correction at each iteration","SNESMonitorSolutionUpdate",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
459a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolutionUpdate,0,0);CHKERRQ(ierr);}
46090d69ab7SBarry Smith     flg  = PETSC_FALSE;
461acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_residual","Plot residual at each iteration","SNESMonitorResidual",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
462a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorResidual,0,0);CHKERRQ(ierr);}
46390d69ab7SBarry Smith     flg  = PETSC_FALSE;
464acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_draw","Plot function norm at each iteration","SNESMonitorLG",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
465a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorLG,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);}
46690d69ab7SBarry Smith     flg  = PETSC_FALSE;
467acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_range_draw","Plot function range at each iteration","SNESMonitorLG",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
468b271bb04SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorLGRange,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);}
469e24b481bSBarry Smith 
47090d69ab7SBarry Smith     flg  = PETSC_FALSE;
471acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_fd","Use finite differences (slow) to compute Jacobian","SNESDefaultComputeJacobian",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
4724b27c08aSLois Curfman McInnes     if (flg) {
473186905e3SBarry Smith       ierr = SNESSetJacobian(snes,snes->jacobian,snes->jacobian_pre,SNESDefaultComputeJacobian,snes->funP);CHKERRQ(ierr);
474ae15b995SBarry Smith       ierr = PetscInfo(snes,"Setting default finite difference Jacobian matrix\n");CHKERRQ(ierr);
4759b94acceSBarry Smith     }
476639f9d9dSBarry Smith 
477aa3661deSLisandro Dalcin     mf = mf_operator = PETSC_FALSE;
478aa3661deSLisandro Dalcin     flg = PETSC_FALSE;
479acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_mf_operator","Use a Matrix-Free Jacobian with user-provided preconditioner matrix","MatCreateSNESMF",PETSC_FALSE,&mf_operator,&flg);CHKERRQ(ierr);
480a8248277SBarry Smith     if (flg && mf_operator) {
481a8248277SBarry Smith       snes->mf_operator = PETSC_TRUE;
482a8248277SBarry Smith       mf = PETSC_TRUE;
483a8248277SBarry Smith     }
484aa3661deSLisandro Dalcin     flg = PETSC_FALSE;
485acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_mf","Use a Matrix-Free Jacobian with no preconditioner matrix","MatCreateSNESMF",PETSC_FALSE,&mf,&flg);CHKERRQ(ierr);
486aa3661deSLisandro Dalcin     if (!flg && mf_operator) mf = PETSC_TRUE;
487aa3661deSLisandro Dalcin     mf_version = 1;
488aa3661deSLisandro Dalcin     ierr = PetscOptionsInt("-snes_mf_version","Matrix-Free routines version 1 or 2","None",mf_version,&mf_version,0);CHKERRQ(ierr);
489aa3661deSLisandro Dalcin 
49076b2cf59SMatthew Knepley     for(i = 0; i < numberofsetfromoptions; i++) {
49176b2cf59SMatthew Knepley       ierr = (*othersetfromoptions[i])(snes);CHKERRQ(ierr);
49276b2cf59SMatthew Knepley     }
49376b2cf59SMatthew Knepley 
494e7788613SBarry Smith     if (snes->ops->setfromoptions) {
495e7788613SBarry Smith       ierr = (*snes->ops->setfromoptions)(snes);CHKERRQ(ierr);
496639f9d9dSBarry Smith     }
4975d973c19SBarry Smith 
4985d973c19SBarry Smith     /* process any options handlers added with PetscObjectAddOptionsHandler() */
4995d973c19SBarry Smith     ierr = PetscObjectProcessOptionsHandlers((PetscObject)snes);CHKERRQ(ierr);
500b0a32e0cSBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
5014bbc92c1SBarry Smith 
502aa3661deSLisandro Dalcin   if (mf) { ierr = SNESSetUpMatrixFree_Private(snes, mf_operator, mf_version);CHKERRQ(ierr); }
5031cee3971SBarry Smith 
5041cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
505aa3661deSLisandro Dalcin   ierr = KSPGetOperators(snes->ksp,PETSC_NULL,PETSC_NULL,&matflag);
506aa3661deSLisandro Dalcin   ierr = KSPSetOperators(snes->ksp,snes->jacobian,snes->jacobian_pre,matflag);CHKERRQ(ierr);
50785385478SLisandro Dalcin   ierr = KSPSetFromOptions(snes->ksp);CHKERRQ(ierr);
50893993e2dSLois Curfman McInnes 
5094a0c5b0cSMatthew G Knepley   if (snes->pc) {
5104a0c5b0cSMatthew G Knepley     ierr = SNESSetOptionsPrefix(snes->pc, "npc_");CHKERRQ(ierr);
5114a0c5b0cSMatthew G Knepley     ierr = SNESSetDM(snes->pc, snes->dm);CHKERRQ(ierr);
5124a0c5b0cSMatthew G Knepley     /* Should we make a duplicate vector and matrix? Leave the DM to make it? */
5134a0c5b0cSMatthew G Knepley     ierr = SNESSetFunction(snes->pc, snes->vec_func, snes->ops->computefunction, snes->funP);CHKERRQ(ierr);
5144a0c5b0cSMatthew G Knepley     ierr = SNESSetJacobian(snes->pc, snes->jacobian, snes->jacobian_pre, snes->ops->computejacobian, snes->jacP);CHKERRQ(ierr);
5154a0c5b0cSMatthew G Knepley     ierr = SNESSetFromOptions(snes->pc);CHKERRQ(ierr);
5164a0c5b0cSMatthew G Knepley   }
5173a40ed3dSBarry Smith   PetscFunctionReturn(0);
5189b94acceSBarry Smith }
5199b94acceSBarry Smith 
520d25893d9SBarry Smith #undef __FUNCT__
521d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeApplicationContext"
522d25893d9SBarry Smith /*@
523d25893d9SBarry Smith    SNESSetComputeApplicationContext - Sets an optional function to compute a user-defined context for
524d25893d9SBarry Smith    the nonlinear solvers.
525d25893d9SBarry Smith 
526d25893d9SBarry Smith    Logically Collective on SNES
527d25893d9SBarry Smith 
528d25893d9SBarry Smith    Input Parameters:
529d25893d9SBarry Smith +  snes - the SNES context
530d25893d9SBarry Smith .  compute - function to compute the context
531d25893d9SBarry Smith -  destroy - function to destroy the context
532d25893d9SBarry Smith 
533d25893d9SBarry Smith    Level: intermediate
534d25893d9SBarry Smith 
535d25893d9SBarry Smith .keywords: SNES, nonlinear, set, application, context
536d25893d9SBarry Smith 
537d25893d9SBarry Smith .seealso: SNESGetApplicationContext(), SNESSetComputeApplicationContext(), SNESGetApplicationContext()
538d25893d9SBarry Smith @*/
539d25893d9SBarry Smith PetscErrorCode  SNESSetComputeApplicationContext(SNES snes,PetscErrorCode (*compute)(SNES,void**),PetscErrorCode (*destroy)(void**))
540d25893d9SBarry Smith {
541d25893d9SBarry Smith   PetscFunctionBegin;
542d25893d9SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
543d25893d9SBarry Smith   snes->ops->usercompute = compute;
544d25893d9SBarry Smith   snes->ops->userdestroy = destroy;
545d25893d9SBarry Smith   PetscFunctionReturn(0);
546d25893d9SBarry Smith }
547a847f771SSatish Balay 
5484a2ae208SSatish Balay #undef __FUNCT__
5494a2ae208SSatish Balay #define __FUNCT__ "SNESSetApplicationContext"
550b07ff414SBarry Smith /*@
5519b94acceSBarry Smith    SNESSetApplicationContext - Sets the optional user-defined context for
5529b94acceSBarry Smith    the nonlinear solvers.
5539b94acceSBarry Smith 
5543f9fe445SBarry Smith    Logically Collective on SNES
555fee21e36SBarry Smith 
556c7afd0dbSLois Curfman McInnes    Input Parameters:
557c7afd0dbSLois Curfman McInnes +  snes - the SNES context
558c7afd0dbSLois Curfman McInnes -  usrP - optional user context
559c7afd0dbSLois Curfman McInnes 
56036851e7fSLois Curfman McInnes    Level: intermediate
56136851e7fSLois Curfman McInnes 
5629b94acceSBarry Smith .keywords: SNES, nonlinear, set, application, context
5639b94acceSBarry Smith 
564d25893d9SBarry Smith .seealso: SNESGetApplicationContext(), SNESSetApplicationContext()
5659b94acceSBarry Smith @*/
5667087cfbeSBarry Smith PetscErrorCode  SNESSetApplicationContext(SNES snes,void *usrP)
5679b94acceSBarry Smith {
5681b2093e4SBarry Smith   PetscErrorCode ierr;
569b07ff414SBarry Smith   KSP            ksp;
5701b2093e4SBarry Smith 
5713a40ed3dSBarry Smith   PetscFunctionBegin;
5720700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
573b07ff414SBarry Smith   ierr       = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
574b07ff414SBarry Smith   ierr       = KSPSetApplicationContext(ksp,usrP);CHKERRQ(ierr);
5759b94acceSBarry Smith   snes->user = usrP;
5763a40ed3dSBarry Smith   PetscFunctionReturn(0);
5779b94acceSBarry Smith }
57874679c65SBarry Smith 
5794a2ae208SSatish Balay #undef __FUNCT__
5804a2ae208SSatish Balay #define __FUNCT__ "SNESGetApplicationContext"
581b07ff414SBarry Smith /*@
5829b94acceSBarry Smith    SNESGetApplicationContext - Gets the user-defined context for the
5839b94acceSBarry Smith    nonlinear solvers.
5849b94acceSBarry Smith 
585c7afd0dbSLois Curfman McInnes    Not Collective
586c7afd0dbSLois Curfman McInnes 
5879b94acceSBarry Smith    Input Parameter:
5889b94acceSBarry Smith .  snes - SNES context
5899b94acceSBarry Smith 
5909b94acceSBarry Smith    Output Parameter:
5919b94acceSBarry Smith .  usrP - user context
5929b94acceSBarry Smith 
59336851e7fSLois Curfman McInnes    Level: intermediate
59436851e7fSLois Curfman McInnes 
5959b94acceSBarry Smith .keywords: SNES, nonlinear, get, application, context
5969b94acceSBarry Smith 
5979b94acceSBarry Smith .seealso: SNESSetApplicationContext()
5989b94acceSBarry Smith @*/
599e71120c6SJed Brown PetscErrorCode  SNESGetApplicationContext(SNES snes,void *usrP)
6009b94acceSBarry Smith {
6013a40ed3dSBarry Smith   PetscFunctionBegin;
6020700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
603e71120c6SJed Brown   *(void**)usrP = snes->user;
6043a40ed3dSBarry Smith   PetscFunctionReturn(0);
6059b94acceSBarry Smith }
60674679c65SBarry Smith 
6074a2ae208SSatish Balay #undef __FUNCT__
6084a2ae208SSatish Balay #define __FUNCT__ "SNESGetIterationNumber"
6099b94acceSBarry Smith /*@
610c8228a4eSBarry Smith    SNESGetIterationNumber - Gets the number of nonlinear iterations completed
611c8228a4eSBarry Smith    at this time.
6129b94acceSBarry Smith 
613c7afd0dbSLois Curfman McInnes    Not Collective
614c7afd0dbSLois Curfman McInnes 
6159b94acceSBarry Smith    Input Parameter:
6169b94acceSBarry Smith .  snes - SNES context
6179b94acceSBarry Smith 
6189b94acceSBarry Smith    Output Parameter:
6199b94acceSBarry Smith .  iter - iteration number
6209b94acceSBarry Smith 
621c8228a4eSBarry Smith    Notes:
622c8228a4eSBarry Smith    For example, during the computation of iteration 2 this would return 1.
623c8228a4eSBarry Smith 
624c8228a4eSBarry Smith    This is useful for using lagged Jacobians (where one does not recompute the
62508405cd6SLois Curfman McInnes    Jacobian at each SNES iteration). For example, the code
62608405cd6SLois Curfman McInnes .vb
62708405cd6SLois Curfman McInnes       ierr = SNESGetIterationNumber(snes,&it);
62808405cd6SLois Curfman McInnes       if (!(it % 2)) {
62908405cd6SLois Curfman McInnes         [compute Jacobian here]
63008405cd6SLois Curfman McInnes       }
63108405cd6SLois Curfman McInnes .ve
632c8228a4eSBarry Smith    can be used in your ComputeJacobian() function to cause the Jacobian to be
63308405cd6SLois Curfman McInnes    recomputed every second SNES iteration.
634c8228a4eSBarry Smith 
63536851e7fSLois Curfman McInnes    Level: intermediate
63636851e7fSLois Curfman McInnes 
6372b668275SBarry Smith .keywords: SNES, nonlinear, get, iteration, number,
6382b668275SBarry Smith 
639b850b91aSLisandro Dalcin .seealso:   SNESGetFunctionNorm(), SNESGetLinearSolveIterations()
6409b94acceSBarry Smith @*/
6417087cfbeSBarry Smith PetscErrorCode  SNESGetIterationNumber(SNES snes,PetscInt* iter)
6429b94acceSBarry Smith {
6433a40ed3dSBarry Smith   PetscFunctionBegin;
6440700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
6454482741eSBarry Smith   PetscValidIntPointer(iter,2);
6469b94acceSBarry Smith   *iter = snes->iter;
6473a40ed3dSBarry Smith   PetscFunctionReturn(0);
6489b94acceSBarry Smith }
64974679c65SBarry Smith 
6504a2ae208SSatish Balay #undef __FUNCT__
6514a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunctionNorm"
6529b94acceSBarry Smith /*@
6539b94acceSBarry Smith    SNESGetFunctionNorm - Gets the norm of the current function that was set
6549b94acceSBarry Smith    with SNESSSetFunction().
6559b94acceSBarry Smith 
656c7afd0dbSLois Curfman McInnes    Collective on SNES
657c7afd0dbSLois Curfman McInnes 
6589b94acceSBarry Smith    Input Parameter:
6599b94acceSBarry Smith .  snes - SNES context
6609b94acceSBarry Smith 
6619b94acceSBarry Smith    Output Parameter:
6629b94acceSBarry Smith .  fnorm - 2-norm of function
6639b94acceSBarry Smith 
66436851e7fSLois Curfman McInnes    Level: intermediate
66536851e7fSLois Curfman McInnes 
6669b94acceSBarry Smith .keywords: SNES, nonlinear, get, function, norm
667a86d99e1SLois Curfman McInnes 
668b850b91aSLisandro Dalcin .seealso: SNESGetFunction(), SNESGetIterationNumber(), SNESGetLinearSolveIterations()
6699b94acceSBarry Smith @*/
6707087cfbeSBarry Smith PetscErrorCode  SNESGetFunctionNorm(SNES snes,PetscReal *fnorm)
6719b94acceSBarry Smith {
6723a40ed3dSBarry Smith   PetscFunctionBegin;
6730700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
6744482741eSBarry Smith   PetscValidScalarPointer(fnorm,2);
6759b94acceSBarry Smith   *fnorm = snes->norm;
6763a40ed3dSBarry Smith   PetscFunctionReturn(0);
6779b94acceSBarry Smith }
67874679c65SBarry Smith 
6794a2ae208SSatish Balay #undef __FUNCT__
680b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetNonlinearStepFailures"
6819b94acceSBarry Smith /*@
682b850b91aSLisandro Dalcin    SNESGetNonlinearStepFailures - Gets the number of unsuccessful steps
6839b94acceSBarry Smith    attempted by the nonlinear solver.
6849b94acceSBarry Smith 
685c7afd0dbSLois Curfman McInnes    Not Collective
686c7afd0dbSLois Curfman McInnes 
6879b94acceSBarry Smith    Input Parameter:
6889b94acceSBarry Smith .  snes - SNES context
6899b94acceSBarry Smith 
6909b94acceSBarry Smith    Output Parameter:
6919b94acceSBarry Smith .  nfails - number of unsuccessful steps attempted
6929b94acceSBarry Smith 
693c96a6f78SLois Curfman McInnes    Notes:
694c96a6f78SLois Curfman McInnes    This counter is reset to zero for each successive call to SNESSolve().
695c96a6f78SLois Curfman McInnes 
69636851e7fSLois Curfman McInnes    Level: intermediate
69736851e7fSLois Curfman McInnes 
6989b94acceSBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps
69958ebbce7SBarry Smith 
700e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(),
70158ebbce7SBarry Smith           SNESSetMaxNonlinearStepFailures(), SNESGetMaxNonlinearStepFailures()
7029b94acceSBarry Smith @*/
7037087cfbeSBarry Smith PetscErrorCode  SNESGetNonlinearStepFailures(SNES snes,PetscInt* nfails)
7049b94acceSBarry Smith {
7053a40ed3dSBarry Smith   PetscFunctionBegin;
7060700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
7074482741eSBarry Smith   PetscValidIntPointer(nfails,2);
70850ffb88aSMatthew Knepley   *nfails = snes->numFailures;
70950ffb88aSMatthew Knepley   PetscFunctionReturn(0);
71050ffb88aSMatthew Knepley }
71150ffb88aSMatthew Knepley 
71250ffb88aSMatthew Knepley #undef __FUNCT__
713b850b91aSLisandro Dalcin #define __FUNCT__ "SNESSetMaxNonlinearStepFailures"
71450ffb88aSMatthew Knepley /*@
715b850b91aSLisandro Dalcin    SNESSetMaxNonlinearStepFailures - Sets the maximum number of unsuccessful steps
71650ffb88aSMatthew Knepley    attempted by the nonlinear solver before it gives up.
71750ffb88aSMatthew Knepley 
71850ffb88aSMatthew Knepley    Not Collective
71950ffb88aSMatthew Knepley 
72050ffb88aSMatthew Knepley    Input Parameters:
72150ffb88aSMatthew Knepley +  snes     - SNES context
72250ffb88aSMatthew Knepley -  maxFails - maximum of unsuccessful steps
72350ffb88aSMatthew Knepley 
72450ffb88aSMatthew Knepley    Level: intermediate
72550ffb88aSMatthew Knepley 
72650ffb88aSMatthew Knepley .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps
72758ebbce7SBarry Smith 
728e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(),
72958ebbce7SBarry Smith           SNESGetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures()
73050ffb88aSMatthew Knepley @*/
7317087cfbeSBarry Smith PetscErrorCode  SNESSetMaxNonlinearStepFailures(SNES snes, PetscInt maxFails)
73250ffb88aSMatthew Knepley {
73350ffb88aSMatthew Knepley   PetscFunctionBegin;
7340700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
73550ffb88aSMatthew Knepley   snes->maxFailures = maxFails;
73650ffb88aSMatthew Knepley   PetscFunctionReturn(0);
73750ffb88aSMatthew Knepley }
73850ffb88aSMatthew Knepley 
73950ffb88aSMatthew Knepley #undef __FUNCT__
740b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetMaxNonlinearStepFailures"
74150ffb88aSMatthew Knepley /*@
742b850b91aSLisandro Dalcin    SNESGetMaxNonlinearStepFailures - Gets the maximum number of unsuccessful steps
74350ffb88aSMatthew Knepley    attempted by the nonlinear solver before it gives up.
74450ffb88aSMatthew Knepley 
74550ffb88aSMatthew Knepley    Not Collective
74650ffb88aSMatthew Knepley 
74750ffb88aSMatthew Knepley    Input Parameter:
74850ffb88aSMatthew Knepley .  snes     - SNES context
74950ffb88aSMatthew Knepley 
75050ffb88aSMatthew Knepley    Output Parameter:
75150ffb88aSMatthew Knepley .  maxFails - maximum of unsuccessful steps
75250ffb88aSMatthew Knepley 
75350ffb88aSMatthew Knepley    Level: intermediate
75450ffb88aSMatthew Knepley 
75550ffb88aSMatthew Knepley .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps
75658ebbce7SBarry Smith 
757e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(),
75858ebbce7SBarry Smith           SNESSetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures()
75958ebbce7SBarry Smith 
76050ffb88aSMatthew Knepley @*/
7617087cfbeSBarry Smith PetscErrorCode  SNESGetMaxNonlinearStepFailures(SNES snes, PetscInt *maxFails)
76250ffb88aSMatthew Knepley {
76350ffb88aSMatthew Knepley   PetscFunctionBegin;
7640700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
7654482741eSBarry Smith   PetscValidIntPointer(maxFails,2);
76650ffb88aSMatthew Knepley   *maxFails = snes->maxFailures;
7673a40ed3dSBarry Smith   PetscFunctionReturn(0);
7689b94acceSBarry Smith }
769a847f771SSatish Balay 
7704a2ae208SSatish Balay #undef __FUNCT__
7712541af92SBarry Smith #define __FUNCT__ "SNESGetNumberFunctionEvals"
7722541af92SBarry Smith /*@
7732541af92SBarry Smith    SNESGetNumberFunctionEvals - Gets the number of user provided function evaluations
7742541af92SBarry Smith      done by SNES.
7752541af92SBarry Smith 
7762541af92SBarry Smith    Not Collective
7772541af92SBarry Smith 
7782541af92SBarry Smith    Input Parameter:
7792541af92SBarry Smith .  snes     - SNES context
7802541af92SBarry Smith 
7812541af92SBarry Smith    Output Parameter:
7822541af92SBarry Smith .  nfuncs - number of evaluations
7832541af92SBarry Smith 
7842541af92SBarry Smith    Level: intermediate
7852541af92SBarry Smith 
7862541af92SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps
78758ebbce7SBarry Smith 
788e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures()
7892541af92SBarry Smith @*/
7907087cfbeSBarry Smith PetscErrorCode  SNESGetNumberFunctionEvals(SNES snes, PetscInt *nfuncs)
7912541af92SBarry Smith {
7922541af92SBarry Smith   PetscFunctionBegin;
7930700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
7942541af92SBarry Smith   PetscValidIntPointer(nfuncs,2);
7952541af92SBarry Smith   *nfuncs = snes->nfuncs;
7962541af92SBarry Smith   PetscFunctionReturn(0);
7972541af92SBarry Smith }
7982541af92SBarry Smith 
7992541af92SBarry Smith #undef __FUNCT__
8003d4c4710SBarry Smith #define __FUNCT__ "SNESGetLinearSolveFailures"
8013d4c4710SBarry Smith /*@
8023d4c4710SBarry Smith    SNESGetLinearSolveFailures - Gets the number of failed (non-converged)
8033d4c4710SBarry Smith    linear solvers.
8043d4c4710SBarry Smith 
8053d4c4710SBarry Smith    Not Collective
8063d4c4710SBarry Smith 
8073d4c4710SBarry Smith    Input Parameter:
8083d4c4710SBarry Smith .  snes - SNES context
8093d4c4710SBarry Smith 
8103d4c4710SBarry Smith    Output Parameter:
8113d4c4710SBarry Smith .  nfails - number of failed solves
8123d4c4710SBarry Smith 
8133d4c4710SBarry Smith    Notes:
8143d4c4710SBarry Smith    This counter is reset to zero for each successive call to SNESSolve().
8153d4c4710SBarry Smith 
8163d4c4710SBarry Smith    Level: intermediate
8173d4c4710SBarry Smith 
8183d4c4710SBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps
81958ebbce7SBarry Smith 
820e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures()
8213d4c4710SBarry Smith @*/
8227087cfbeSBarry Smith PetscErrorCode  SNESGetLinearSolveFailures(SNES snes,PetscInt* nfails)
8233d4c4710SBarry Smith {
8243d4c4710SBarry Smith   PetscFunctionBegin;
8250700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
8263d4c4710SBarry Smith   PetscValidIntPointer(nfails,2);
8273d4c4710SBarry Smith   *nfails = snes->numLinearSolveFailures;
8283d4c4710SBarry Smith   PetscFunctionReturn(0);
8293d4c4710SBarry Smith }
8303d4c4710SBarry Smith 
8313d4c4710SBarry Smith #undef __FUNCT__
8323d4c4710SBarry Smith #define __FUNCT__ "SNESSetMaxLinearSolveFailures"
8333d4c4710SBarry Smith /*@
8343d4c4710SBarry Smith    SNESSetMaxLinearSolveFailures - the number of failed linear solve attempts
8353d4c4710SBarry Smith    allowed before SNES returns with a diverged reason of SNES_DIVERGED_LINEAR_SOLVE
8363d4c4710SBarry Smith 
8373f9fe445SBarry Smith    Logically Collective on SNES
8383d4c4710SBarry Smith 
8393d4c4710SBarry Smith    Input Parameters:
8403d4c4710SBarry Smith +  snes     - SNES context
8413d4c4710SBarry Smith -  maxFails - maximum allowed linear solve failures
8423d4c4710SBarry Smith 
8433d4c4710SBarry Smith    Level: intermediate
8443d4c4710SBarry Smith 
845a6796414SBarry Smith    Notes: By default this is 0; that is SNES returns on the first failed linear solve
8463d4c4710SBarry Smith 
8473d4c4710SBarry Smith .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps
8483d4c4710SBarry Smith 
84958ebbce7SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations()
8503d4c4710SBarry Smith @*/
8517087cfbeSBarry Smith PetscErrorCode  SNESSetMaxLinearSolveFailures(SNES snes, PetscInt maxFails)
8523d4c4710SBarry Smith {
8533d4c4710SBarry Smith   PetscFunctionBegin;
8540700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
855c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxFails,2);
8563d4c4710SBarry Smith   snes->maxLinearSolveFailures = maxFails;
8573d4c4710SBarry Smith   PetscFunctionReturn(0);
8583d4c4710SBarry Smith }
8593d4c4710SBarry Smith 
8603d4c4710SBarry Smith #undef __FUNCT__
8613d4c4710SBarry Smith #define __FUNCT__ "SNESGetMaxLinearSolveFailures"
8623d4c4710SBarry Smith /*@
8633d4c4710SBarry Smith    SNESGetMaxLinearSolveFailures - gets the maximum number of linear solve failures that
8643d4c4710SBarry Smith      are allowed before SNES terminates
8653d4c4710SBarry Smith 
8663d4c4710SBarry Smith    Not Collective
8673d4c4710SBarry Smith 
8683d4c4710SBarry Smith    Input Parameter:
8693d4c4710SBarry Smith .  snes     - SNES context
8703d4c4710SBarry Smith 
8713d4c4710SBarry Smith    Output Parameter:
8723d4c4710SBarry Smith .  maxFails - maximum of unsuccessful solves allowed
8733d4c4710SBarry Smith 
8743d4c4710SBarry Smith    Level: intermediate
8753d4c4710SBarry Smith 
8763d4c4710SBarry Smith    Notes: By default this is 1; that is SNES returns on the first failed linear solve
8773d4c4710SBarry Smith 
8783d4c4710SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps
8793d4c4710SBarry Smith 
880e1c61ce8SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(),
8813d4c4710SBarry Smith @*/
8827087cfbeSBarry Smith PetscErrorCode  SNESGetMaxLinearSolveFailures(SNES snes, PetscInt *maxFails)
8833d4c4710SBarry Smith {
8843d4c4710SBarry Smith   PetscFunctionBegin;
8850700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
8863d4c4710SBarry Smith   PetscValidIntPointer(maxFails,2);
8873d4c4710SBarry Smith   *maxFails = snes->maxLinearSolveFailures;
8883d4c4710SBarry Smith   PetscFunctionReturn(0);
8893d4c4710SBarry Smith }
8903d4c4710SBarry Smith 
8913d4c4710SBarry Smith #undef __FUNCT__
892b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetLinearSolveIterations"
893c96a6f78SLois Curfman McInnes /*@
894b850b91aSLisandro Dalcin    SNESGetLinearSolveIterations - Gets the total number of linear iterations
895c96a6f78SLois Curfman McInnes    used by the nonlinear solver.
896c96a6f78SLois Curfman McInnes 
897c7afd0dbSLois Curfman McInnes    Not Collective
898c7afd0dbSLois Curfman McInnes 
899c96a6f78SLois Curfman McInnes    Input Parameter:
900c96a6f78SLois Curfman McInnes .  snes - SNES context
901c96a6f78SLois Curfman McInnes 
902c96a6f78SLois Curfman McInnes    Output Parameter:
903c96a6f78SLois Curfman McInnes .  lits - number of linear iterations
904c96a6f78SLois Curfman McInnes 
905c96a6f78SLois Curfman McInnes    Notes:
906c96a6f78SLois Curfman McInnes    This counter is reset to zero for each successive call to SNESSolve().
907c96a6f78SLois Curfman McInnes 
90836851e7fSLois Curfman McInnes    Level: intermediate
90936851e7fSLois Curfman McInnes 
910c96a6f78SLois Curfman McInnes .keywords: SNES, nonlinear, get, number, linear, iterations
9112b668275SBarry Smith 
9128c7482ecSBarry Smith .seealso:  SNESGetIterationNumber(), SNESGetFunctionNorm(), SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures()
913c96a6f78SLois Curfman McInnes @*/
9147087cfbeSBarry Smith PetscErrorCode  SNESGetLinearSolveIterations(SNES snes,PetscInt* lits)
915c96a6f78SLois Curfman McInnes {
9163a40ed3dSBarry Smith   PetscFunctionBegin;
9170700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
9184482741eSBarry Smith   PetscValidIntPointer(lits,2);
919c96a6f78SLois Curfman McInnes   *lits = snes->linear_its;
9203a40ed3dSBarry Smith   PetscFunctionReturn(0);
921c96a6f78SLois Curfman McInnes }
922c96a6f78SLois Curfman McInnes 
9234a2ae208SSatish Balay #undef __FUNCT__
92494b7f48cSBarry Smith #define __FUNCT__ "SNESGetKSP"
92552baeb72SSatish Balay /*@
92694b7f48cSBarry Smith    SNESGetKSP - Returns the KSP context for a SNES solver.
9279b94acceSBarry Smith 
92894b7f48cSBarry Smith    Not Collective, but if SNES object is parallel, then KSP object is parallel
929c7afd0dbSLois Curfman McInnes 
9309b94acceSBarry Smith    Input Parameter:
9319b94acceSBarry Smith .  snes - the SNES context
9329b94acceSBarry Smith 
9339b94acceSBarry Smith    Output Parameter:
93494b7f48cSBarry Smith .  ksp - the KSP context
9359b94acceSBarry Smith 
9369b94acceSBarry Smith    Notes:
93794b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
9389b94acceSBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
9392999313aSBarry Smith    PC contexts as well.
9409b94acceSBarry Smith 
94136851e7fSLois Curfman McInnes    Level: beginner
94236851e7fSLois Curfman McInnes 
94394b7f48cSBarry Smith .keywords: SNES, nonlinear, get, KSP, context
9449b94acceSBarry Smith 
9452999313aSBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP()
9469b94acceSBarry Smith @*/
9477087cfbeSBarry Smith PetscErrorCode  SNESGetKSP(SNES snes,KSP *ksp)
9489b94acceSBarry Smith {
9491cee3971SBarry Smith   PetscErrorCode ierr;
9501cee3971SBarry Smith 
9513a40ed3dSBarry Smith   PetscFunctionBegin;
9520700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
9534482741eSBarry Smith   PetscValidPointer(ksp,2);
9541cee3971SBarry Smith 
9551cee3971SBarry Smith   if (!snes->ksp) {
9561cee3971SBarry Smith     ierr = KSPCreate(((PetscObject)snes)->comm,&snes->ksp);CHKERRQ(ierr);
9571cee3971SBarry Smith     ierr = PetscObjectIncrementTabLevel((PetscObject)snes->ksp,(PetscObject)snes,1);CHKERRQ(ierr);
9581cee3971SBarry Smith     ierr = PetscLogObjectParent(snes,snes->ksp);CHKERRQ(ierr);
9591cee3971SBarry Smith   }
96094b7f48cSBarry Smith   *ksp = snes->ksp;
9613a40ed3dSBarry Smith   PetscFunctionReturn(0);
9629b94acceSBarry Smith }
96382bf6240SBarry Smith 
9644a2ae208SSatish Balay #undef __FUNCT__
9652999313aSBarry Smith #define __FUNCT__ "SNESSetKSP"
9662999313aSBarry Smith /*@
9672999313aSBarry Smith    SNESSetKSP - Sets a KSP context for the SNES object to use
9682999313aSBarry Smith 
9692999313aSBarry Smith    Not Collective, but the SNES and KSP objects must live on the same MPI_Comm
9702999313aSBarry Smith 
9712999313aSBarry Smith    Input Parameters:
9722999313aSBarry Smith +  snes - the SNES context
9732999313aSBarry Smith -  ksp - the KSP context
9742999313aSBarry Smith 
9752999313aSBarry Smith    Notes:
9762999313aSBarry Smith    The SNES object already has its KSP object, you can obtain with SNESGetKSP()
9772999313aSBarry Smith    so this routine is rarely needed.
9782999313aSBarry Smith 
9792999313aSBarry Smith    The KSP object that is already in the SNES object has its reference count
9802999313aSBarry Smith    decreased by one.
9812999313aSBarry Smith 
9822999313aSBarry Smith    Level: developer
9832999313aSBarry Smith 
9842999313aSBarry Smith .keywords: SNES, nonlinear, get, KSP, context
9852999313aSBarry Smith 
9862999313aSBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP()
9872999313aSBarry Smith @*/
9887087cfbeSBarry Smith PetscErrorCode  SNESSetKSP(SNES snes,KSP ksp)
9892999313aSBarry Smith {
9902999313aSBarry Smith   PetscErrorCode ierr;
9912999313aSBarry Smith 
9922999313aSBarry Smith   PetscFunctionBegin;
9930700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
9940700a824SBarry Smith   PetscValidHeaderSpecific(ksp,KSP_CLASSID,2);
9952999313aSBarry Smith   PetscCheckSameComm(snes,1,ksp,2);
9967dcf0eaaSdalcinl   ierr = PetscObjectReference((PetscObject)ksp);CHKERRQ(ierr);
997906ed7ccSBarry Smith   if (snes->ksp) {ierr = PetscObjectDereference((PetscObject)snes->ksp);CHKERRQ(ierr);}
9982999313aSBarry Smith   snes->ksp = ksp;
9992999313aSBarry Smith   PetscFunctionReturn(0);
10002999313aSBarry Smith }
10012999313aSBarry Smith 
10027adad957SLisandro Dalcin #if 0
10032999313aSBarry Smith #undef __FUNCT__
10044a2ae208SSatish Balay #define __FUNCT__ "SNESPublish_Petsc"
10056849ba73SBarry Smith static PetscErrorCode SNESPublish_Petsc(PetscObject obj)
1006e24b481bSBarry Smith {
1007e24b481bSBarry Smith   PetscFunctionBegin;
1008e24b481bSBarry Smith   PetscFunctionReturn(0);
1009e24b481bSBarry Smith }
10107adad957SLisandro Dalcin #endif
1011e24b481bSBarry Smith 
10129b94acceSBarry Smith /* -----------------------------------------------------------*/
10134a2ae208SSatish Balay #undef __FUNCT__
10144a2ae208SSatish Balay #define __FUNCT__ "SNESCreate"
101552baeb72SSatish Balay /*@
10169b94acceSBarry Smith    SNESCreate - Creates a nonlinear solver context.
10179b94acceSBarry Smith 
1018c7afd0dbSLois Curfman McInnes    Collective on MPI_Comm
1019c7afd0dbSLois Curfman McInnes 
1020c7afd0dbSLois Curfman McInnes    Input Parameters:
1021906ed7ccSBarry Smith .  comm - MPI communicator
10229b94acceSBarry Smith 
10239b94acceSBarry Smith    Output Parameter:
10249b94acceSBarry Smith .  outsnes - the new SNES context
10259b94acceSBarry Smith 
1026c7afd0dbSLois Curfman McInnes    Options Database Keys:
1027c7afd0dbSLois Curfman McInnes +   -snes_mf - Activates default matrix-free Jacobian-vector products,
1028c7afd0dbSLois Curfman McInnes                and no preconditioning matrix
1029c7afd0dbSLois Curfman McInnes .   -snes_mf_operator - Activates default matrix-free Jacobian-vector
1030c7afd0dbSLois Curfman McInnes                products, and a user-provided preconditioning matrix
1031c7afd0dbSLois Curfman McInnes                as set by SNESSetJacobian()
1032c7afd0dbSLois Curfman McInnes -   -snes_fd - Uses (slow!) finite differences to compute Jacobian
1033c1f60f51SBarry Smith 
103436851e7fSLois Curfman McInnes    Level: beginner
103536851e7fSLois Curfman McInnes 
10369b94acceSBarry Smith .keywords: SNES, nonlinear, create, context
10379b94acceSBarry Smith 
1038a8054027SBarry Smith .seealso: SNESSolve(), SNESDestroy(), SNES, SNESSetLagPreconditioner()
1039a8054027SBarry Smith 
10409b94acceSBarry Smith @*/
10417087cfbeSBarry Smith PetscErrorCode  SNESCreate(MPI_Comm comm,SNES *outsnes)
10429b94acceSBarry Smith {
1043dfbe8321SBarry Smith   PetscErrorCode      ierr;
10449b94acceSBarry Smith   SNES                snes;
1045fa9f3622SBarry Smith   SNESKSPEW           *kctx;
104637fcc0dbSBarry Smith 
10473a40ed3dSBarry Smith   PetscFunctionBegin;
1048ed1caa07SMatthew Knepley   PetscValidPointer(outsnes,2);
10498ba1e511SMatthew Knepley   *outsnes = PETSC_NULL;
10508ba1e511SMatthew Knepley #ifndef PETSC_USE_DYNAMIC_LIBRARIES
10518ba1e511SMatthew Knepley   ierr = SNESInitializePackage(PETSC_NULL);CHKERRQ(ierr);
10528ba1e511SMatthew Knepley #endif
10538ba1e511SMatthew Knepley 
10543194b578SJed Brown   ierr = PetscHeaderCreate(snes,_p_SNES,struct _SNESOps,SNES_CLASSID,0,"SNES","Nonlinear solver","SNES",comm,SNESDestroy,SNESView);CHKERRQ(ierr);
10557adad957SLisandro Dalcin 
105685385478SLisandro Dalcin   snes->ops->converged    = SNESDefaultConverged;
10579b94acceSBarry Smith   snes->max_its           = 50;
10589750a799SBarry Smith   snes->max_funcs	  = 10000;
10599b94acceSBarry Smith   snes->norm		  = 0.0;
1060b4874afaSBarry Smith   snes->rtol		  = 1.e-8;
1061b4874afaSBarry Smith   snes->ttol              = 0.0;
106270441072SBarry Smith   snes->abstol		  = 1.e-50;
10639b94acceSBarry Smith   snes->xtol		  = 1.e-8;
10644b27c08aSLois Curfman McInnes   snes->deltatol	  = 1.e-12;
10659b94acceSBarry Smith   snes->nfuncs            = 0;
106650ffb88aSMatthew Knepley   snes->numFailures       = 0;
106750ffb88aSMatthew Knepley   snes->maxFailures       = 1;
10687a00f4a9SLois Curfman McInnes   snes->linear_its        = 0;
1069e35cf81dSBarry Smith   snes->lagjacobian       = 1;
1070a8054027SBarry Smith   snes->lagpreconditioner = 1;
1071639f9d9dSBarry Smith   snes->numbermonitors    = 0;
10729b94acceSBarry Smith   snes->data              = 0;
10734dc4c822SBarry Smith   snes->setupcalled       = PETSC_FALSE;
1074186905e3SBarry Smith   snes->ksp_ewconv        = PETSC_FALSE;
10756f24a144SLois Curfman McInnes   snes->nwork             = 0;
107658c9b817SLisandro Dalcin   snes->work              = 0;
107758c9b817SLisandro Dalcin   snes->nvwork            = 0;
107858c9b817SLisandro Dalcin   snes->vwork             = 0;
1079758f92a0SBarry Smith   snes->conv_hist_len     = 0;
1080758f92a0SBarry Smith   snes->conv_hist_max     = 0;
1081758f92a0SBarry Smith   snes->conv_hist         = PETSC_NULL;
1082758f92a0SBarry Smith   snes->conv_hist_its     = PETSC_NULL;
1083758f92a0SBarry Smith   snes->conv_hist_reset   = PETSC_TRUE;
1084184914b5SBarry Smith   snes->reason            = SNES_CONVERGED_ITERATING;
10859b94acceSBarry Smith 
10863d4c4710SBarry Smith   snes->numLinearSolveFailures = 0;
10873d4c4710SBarry Smith   snes->maxLinearSolveFailures = 1;
10883d4c4710SBarry Smith 
10899b94acceSBarry Smith   /* Create context to compute Eisenstat-Walker relative tolerance for KSP */
109038f2d2fdSLisandro Dalcin   ierr = PetscNewLog(snes,SNESKSPEW,&kctx);CHKERRQ(ierr);
10919b94acceSBarry Smith   snes->kspconvctx  = (void*)kctx;
10929b94acceSBarry Smith   kctx->version     = 2;
10939b94acceSBarry Smith   kctx->rtol_0      = .3; /* Eisenstat and Walker suggest rtol_0=.5, but
10949b94acceSBarry Smith                              this was too large for some test cases */
109575567043SBarry Smith   kctx->rtol_last   = 0.0;
10969b94acceSBarry Smith   kctx->rtol_max    = .9;
10979b94acceSBarry Smith   kctx->gamma       = 1.0;
109871f87433Sdalcinl   kctx->alpha       = .5*(1.0 + sqrt(5.0));
109971f87433Sdalcinl   kctx->alpha2      = kctx->alpha;
11009b94acceSBarry Smith   kctx->threshold   = .1;
110175567043SBarry Smith   kctx->lresid_last = 0.0;
110275567043SBarry Smith   kctx->norm_last   = 0.0;
11039b94acceSBarry Smith 
11049b94acceSBarry Smith   *outsnes = snes;
11053a40ed3dSBarry Smith   PetscFunctionReturn(0);
11069b94acceSBarry Smith }
11079b94acceSBarry Smith 
11084a2ae208SSatish Balay #undef __FUNCT__
11094a2ae208SSatish Balay #define __FUNCT__ "SNESSetFunction"
11109b94acceSBarry Smith /*@C
11119b94acceSBarry Smith    SNESSetFunction - Sets the function evaluation routine and function
11129b94acceSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
11139b94acceSBarry Smith    equations.
11149b94acceSBarry Smith 
11153f9fe445SBarry Smith    Logically Collective on SNES
1116fee21e36SBarry Smith 
1117c7afd0dbSLois Curfman McInnes    Input Parameters:
1118c7afd0dbSLois Curfman McInnes +  snes - the SNES context
1119c7afd0dbSLois Curfman McInnes .  r - vector to store function value
1120de044059SHong Zhang .  func - function evaluation routine
1121c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined context for private data for the
1122c7afd0dbSLois Curfman McInnes          function evaluation routine (may be PETSC_NULL)
11239b94acceSBarry Smith 
1124c7afd0dbSLois Curfman McInnes    Calling sequence of func:
11258d76a1e5SLois Curfman McInnes $    func (SNES snes,Vec x,Vec f,void *ctx);
1126c7afd0dbSLois Curfman McInnes 
1127313e4042SLois Curfman McInnes .  f - function vector
1128c7afd0dbSLois Curfman McInnes -  ctx - optional user-defined function context
11299b94acceSBarry Smith 
11309b94acceSBarry Smith    Notes:
11319b94acceSBarry Smith    The Newton-like methods typically solve linear systems of the form
11329b94acceSBarry Smith $      f'(x) x = -f(x),
1133c7afd0dbSLois Curfman McInnes    where f'(x) denotes the Jacobian matrix and f(x) is the function.
11349b94acceSBarry Smith 
113536851e7fSLois Curfman McInnes    Level: beginner
113636851e7fSLois Curfman McInnes 
11379b94acceSBarry Smith .keywords: SNES, nonlinear, set, function
11389b94acceSBarry Smith 
1139a86d99e1SLois Curfman McInnes .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian()
11409b94acceSBarry Smith @*/
11417087cfbeSBarry Smith PetscErrorCode  SNESSetFunction(SNES snes,Vec r,PetscErrorCode (*func)(SNES,Vec,Vec,void*),void *ctx)
11429b94acceSBarry Smith {
114385385478SLisandro Dalcin   PetscErrorCode ierr;
11443a40ed3dSBarry Smith   PetscFunctionBegin;
11450700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1146d2a683ecSLisandro Dalcin   if (r) {
1147d2a683ecSLisandro Dalcin     PetscValidHeaderSpecific(r,VEC_CLASSID,2);
1148d2a683ecSLisandro Dalcin     PetscCheckSameComm(snes,1,r,2);
114985385478SLisandro Dalcin     ierr = PetscObjectReference((PetscObject)r);CHKERRQ(ierr);
11506bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr);
115185385478SLisandro Dalcin     snes->vec_func = r;
1152d2a683ecSLisandro Dalcin   } else if (!snes->vec_func && snes->dm) {
1153d2a683ecSLisandro Dalcin     ierr = DMCreateGlobalVector(snes->dm,&snes->vec_func);CHKERRQ(ierr);
1154d2a683ecSLisandro Dalcin   }
1155d2a683ecSLisandro Dalcin   if (func) snes->ops->computefunction = func;
1156d2a683ecSLisandro Dalcin   if (ctx)  snes->funP                 = ctx;
11573a40ed3dSBarry Smith   PetscFunctionReturn(0);
11589b94acceSBarry Smith }
11599b94acceSBarry Smith 
1160d25893d9SBarry Smith #undef __FUNCT__
1161d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeInitialGuess"
1162d25893d9SBarry Smith /*@C
1163d25893d9SBarry Smith    SNESSetComputeInitialGuess - Sets a routine used to compute an initial guess for the problem
1164d25893d9SBarry Smith 
1165d25893d9SBarry Smith    Logically Collective on SNES
1166d25893d9SBarry Smith 
1167d25893d9SBarry Smith    Input Parameters:
1168d25893d9SBarry Smith +  snes - the SNES context
1169d25893d9SBarry Smith .  func - function evaluation routine
1170d25893d9SBarry Smith -  ctx - [optional] user-defined context for private data for the
1171d25893d9SBarry Smith          function evaluation routine (may be PETSC_NULL)
1172d25893d9SBarry Smith 
1173d25893d9SBarry Smith    Calling sequence of func:
1174d25893d9SBarry Smith $    func (SNES snes,Vec x,void *ctx);
1175d25893d9SBarry Smith 
1176d25893d9SBarry Smith .  f - function vector
1177d25893d9SBarry Smith -  ctx - optional user-defined function context
1178d25893d9SBarry Smith 
1179d25893d9SBarry Smith    Level: intermediate
1180d25893d9SBarry Smith 
1181d25893d9SBarry Smith .keywords: SNES, nonlinear, set, function
1182d25893d9SBarry Smith 
1183d25893d9SBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian()
1184d25893d9SBarry Smith @*/
1185d25893d9SBarry Smith PetscErrorCode  SNESSetComputeInitialGuess(SNES snes,PetscErrorCode (*func)(SNES,Vec,void*),void *ctx)
1186d25893d9SBarry Smith {
1187d25893d9SBarry Smith   PetscFunctionBegin;
1188d25893d9SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1189d25893d9SBarry Smith   if (func) snes->ops->computeinitialguess = func;
1190d25893d9SBarry Smith   if (ctx)  snes->initialguessP            = ctx;
1191d25893d9SBarry Smith   PetscFunctionReturn(0);
1192d25893d9SBarry Smith }
1193d25893d9SBarry Smith 
11943ab0aad5SBarry Smith /* --------------------------------------------------------------- */
11953ab0aad5SBarry Smith #undef __FUNCT__
11961096aae1SMatthew Knepley #define __FUNCT__ "SNESGetRhs"
11971096aae1SMatthew Knepley /*@C
11981096aae1SMatthew Knepley    SNESGetRhs - Gets the vector for solving F(x) = rhs. If rhs is not set
11991096aae1SMatthew Knepley    it assumes a zero right hand side.
12001096aae1SMatthew Knepley 
12013f9fe445SBarry Smith    Logically Collective on SNES
12021096aae1SMatthew Knepley 
12031096aae1SMatthew Knepley    Input Parameter:
12041096aae1SMatthew Knepley .  snes - the SNES context
12051096aae1SMatthew Knepley 
12061096aae1SMatthew Knepley    Output Parameter:
1207bc08b0f1SBarry Smith .  rhs - the right hand side vector or PETSC_NULL if the right hand side vector is null
12081096aae1SMatthew Knepley 
12091096aae1SMatthew Knepley    Level: intermediate
12101096aae1SMatthew Knepley 
12111096aae1SMatthew Knepley .keywords: SNES, nonlinear, get, function, right hand side
12121096aae1SMatthew Knepley 
121385385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
12141096aae1SMatthew Knepley @*/
12157087cfbeSBarry Smith PetscErrorCode  SNESGetRhs(SNES snes,Vec *rhs)
12161096aae1SMatthew Knepley {
12171096aae1SMatthew Knepley   PetscFunctionBegin;
12180700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
12191096aae1SMatthew Knepley   PetscValidPointer(rhs,2);
122085385478SLisandro Dalcin   *rhs = snes->vec_rhs;
12211096aae1SMatthew Knepley   PetscFunctionReturn(0);
12221096aae1SMatthew Knepley }
12231096aae1SMatthew Knepley 
12241096aae1SMatthew Knepley #undef __FUNCT__
12254a2ae208SSatish Balay #define __FUNCT__ "SNESComputeFunction"
12269b94acceSBarry Smith /*@
122736851e7fSLois Curfman McInnes    SNESComputeFunction - Calls the function that has been set with
12289b94acceSBarry Smith                          SNESSetFunction().
12299b94acceSBarry Smith 
1230c7afd0dbSLois Curfman McInnes    Collective on SNES
1231c7afd0dbSLois Curfman McInnes 
12329b94acceSBarry Smith    Input Parameters:
1233c7afd0dbSLois Curfman McInnes +  snes - the SNES context
1234c7afd0dbSLois Curfman McInnes -  x - input vector
12359b94acceSBarry Smith 
12369b94acceSBarry Smith    Output Parameter:
12373638b69dSLois Curfman McInnes .  y - function vector, as set by SNESSetFunction()
12389b94acceSBarry Smith 
12391bffabb2SLois Curfman McInnes    Notes:
124036851e7fSLois Curfman McInnes    SNESComputeFunction() is typically used within nonlinear solvers
124136851e7fSLois Curfman McInnes    implementations, so most users would not generally call this routine
124236851e7fSLois Curfman McInnes    themselves.
124336851e7fSLois Curfman McInnes 
124436851e7fSLois Curfman McInnes    Level: developer
124536851e7fSLois Curfman McInnes 
12469b94acceSBarry Smith .keywords: SNES, nonlinear, compute, function
12479b94acceSBarry Smith 
1248a86d99e1SLois Curfman McInnes .seealso: SNESSetFunction(), SNESGetFunction()
12499b94acceSBarry Smith @*/
12507087cfbeSBarry Smith PetscErrorCode  SNESComputeFunction(SNES snes,Vec x,Vec y)
12519b94acceSBarry Smith {
1252dfbe8321SBarry Smith   PetscErrorCode ierr;
12539b94acceSBarry Smith 
12543a40ed3dSBarry Smith   PetscFunctionBegin;
12550700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
12560700a824SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
12570700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
1258c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,x,2);
1259c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,y,3);
1260184914b5SBarry Smith 
1261d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr);
1262e7788613SBarry Smith   if (snes->ops->computefunction) {
1263d64ed03dSBarry Smith     PetscStackPush("SNES user function");
126439d508bbSBarry Smith     ierr = (*snes->ops->computefunction)(snes,x,y,snes->funP);CHKERRQ(ierr);
1265d64ed03dSBarry Smith     PetscStackPop;
126685385478SLisandro Dalcin   } else if (snes->vec_rhs) {
12671096aae1SMatthew Knepley     ierr = MatMult(snes->jacobian, x, y);CHKERRQ(ierr);
126873250ac0SBarry Smith   } else if (snes->dm) {
1269644e2e5bSBarry Smith     ierr = DMComputeFunction(snes->dm,x,y);CHKERRQ(ierr);
1270644e2e5bSBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetFunction() or SNESSetDM() before SNESComputeFunction(), likely called from SNESSolve().");
127185385478SLisandro Dalcin   if (snes->vec_rhs) {
127285385478SLisandro Dalcin     ierr = VecAXPY(y,-1.0,snes->vec_rhs);CHKERRQ(ierr);
12733ab0aad5SBarry Smith   }
1274ae3c334cSLois Curfman McInnes   snes->nfuncs++;
1275d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr);
12763a40ed3dSBarry Smith   PetscFunctionReturn(0);
12779b94acceSBarry Smith }
12789b94acceSBarry Smith 
12794a2ae208SSatish Balay #undef __FUNCT__
12804a2ae208SSatish Balay #define __FUNCT__ "SNESComputeJacobian"
128162fef451SLois Curfman McInnes /*@
128262fef451SLois Curfman McInnes    SNESComputeJacobian - Computes the Jacobian matrix that has been
128362fef451SLois Curfman McInnes    set with SNESSetJacobian().
128462fef451SLois Curfman McInnes 
1285c7afd0dbSLois Curfman McInnes    Collective on SNES and Mat
1286c7afd0dbSLois Curfman McInnes 
128762fef451SLois Curfman McInnes    Input Parameters:
1288c7afd0dbSLois Curfman McInnes +  snes - the SNES context
1289c7afd0dbSLois Curfman McInnes -  x - input vector
129062fef451SLois Curfman McInnes 
129162fef451SLois Curfman McInnes    Output Parameters:
1292c7afd0dbSLois Curfman McInnes +  A - Jacobian matrix
129362fef451SLois Curfman McInnes .  B - optional preconditioning matrix
12942b668275SBarry Smith -  flag - flag indicating matrix structure (one of, SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER)
1295fee21e36SBarry Smith 
1296e35cf81dSBarry Smith   Options Database Keys:
1297e35cf81dSBarry Smith +    -snes_lag_preconditioner <lag>
1298693365a8SJed Brown .    -snes_lag_jacobian <lag>
1299693365a8SJed Brown .    -snes_compare_explicit - Compare the computed Jacobian to the finite difference Jacobian and output the differences
1300693365a8SJed Brown .    -snes_compare_explicit_draw  - Compare the computed Jacobian to the finite difference Jacobian and draw the result
1301693365a8SJed Brown .    -snes_compare_explicit_contour  - Compare the computed Jacobian to the finite difference Jacobian and draw a contour plot with the result
1302693365a8SJed Brown -    -snes_compare_operator  - Make the comparison options above use the operator instead of the preconditioning matrix
1303e35cf81dSBarry Smith 
130462fef451SLois Curfman McInnes    Notes:
130562fef451SLois Curfman McInnes    Most users should not need to explicitly call this routine, as it
130662fef451SLois Curfman McInnes    is used internally within the nonlinear solvers.
130762fef451SLois Curfman McInnes 
130894b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
1309dc5a77f8SLois Curfman McInnes    flag parameter.
131062fef451SLois Curfman McInnes 
131136851e7fSLois Curfman McInnes    Level: developer
131236851e7fSLois Curfman McInnes 
131362fef451SLois Curfman McInnes .keywords: SNES, compute, Jacobian, matrix
131462fef451SLois Curfman McInnes 
1315e35cf81dSBarry Smith .seealso:  SNESSetJacobian(), KSPSetOperators(), MatStructure, SNESSetLagPreconditioner(), SNESSetLagJacobian()
131662fef451SLois Curfman McInnes @*/
13177087cfbeSBarry Smith PetscErrorCode  SNESComputeJacobian(SNES snes,Vec X,Mat *A,Mat *B,MatStructure *flg)
13189b94acceSBarry Smith {
1319dfbe8321SBarry Smith   PetscErrorCode ierr;
1320ace3abfcSBarry Smith   PetscBool      flag;
13213a40ed3dSBarry Smith 
13223a40ed3dSBarry Smith   PetscFunctionBegin;
13230700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
13240700a824SBarry Smith   PetscValidHeaderSpecific(X,VEC_CLASSID,2);
13254482741eSBarry Smith   PetscValidPointer(flg,5);
1326c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,X,2);
1327e7788613SBarry Smith   if (!snes->ops->computejacobian) PetscFunctionReturn(0);
1328ebd3b9afSBarry Smith 
1329ebd3b9afSBarry Smith   /* make sure that MatAssemblyBegin/End() is called on A matrix if it is matrix free */
1330ebd3b9afSBarry Smith 
1331fe3ffe1eSBarry Smith   if (snes->lagjacobian == -2) {
1332fe3ffe1eSBarry Smith     snes->lagjacobian = -1;
1333fe3ffe1eSBarry Smith     ierr = PetscInfo(snes,"Recomputing Jacobian/preconditioner because lag is -2 (means compute Jacobian, but then never again) \n");CHKERRQ(ierr);
1334fe3ffe1eSBarry Smith   } else if (snes->lagjacobian == -1) {
1335e35cf81dSBarry Smith     *flg = SAME_PRECONDITIONER;
1336e35cf81dSBarry Smith     ierr = PetscInfo(snes,"Reusing Jacobian/preconditioner because lag is -1\n");CHKERRQ(ierr);
1337ebd3b9afSBarry Smith     ierr = PetscTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr);
1338ebd3b9afSBarry Smith     if (flag) {
1339ebd3b9afSBarry Smith       ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1340ebd3b9afSBarry Smith       ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1341ebd3b9afSBarry Smith     }
1342e35cf81dSBarry Smith     PetscFunctionReturn(0);
1343e35cf81dSBarry Smith   } else if (snes->lagjacobian > 1 && snes->iter % snes->lagjacobian) {
1344e35cf81dSBarry Smith     *flg = SAME_PRECONDITIONER;
1345e35cf81dSBarry Smith     ierr = PetscInfo2(snes,"Reusing Jacobian/preconditioner because lag is %D and SNES iteration is %D\n",snes->lagjacobian,snes->iter);CHKERRQ(ierr);
1346ebd3b9afSBarry Smith     ierr = PetscTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr);
1347ebd3b9afSBarry Smith     if (flag) {
1348ebd3b9afSBarry Smith       ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1349ebd3b9afSBarry Smith       ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1350ebd3b9afSBarry Smith     }
1351e35cf81dSBarry Smith     PetscFunctionReturn(0);
1352e35cf81dSBarry Smith   }
1353e35cf81dSBarry Smith 
1354c4fc05e7SBarry Smith   *flg = DIFFERENT_NONZERO_PATTERN;
1355e35cf81dSBarry Smith   ierr = PetscLogEventBegin(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr);
1356d64ed03dSBarry Smith   PetscStackPush("SNES user Jacobian function");
1357e7788613SBarry Smith   ierr = (*snes->ops->computejacobian)(snes,X,A,B,flg,snes->jacP);CHKERRQ(ierr);
1358d64ed03dSBarry Smith   PetscStackPop;
1359d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr);
1360a8054027SBarry Smith 
13613b4f5425SBarry Smith   if (snes->lagpreconditioner == -2) {
13623b4f5425SBarry Smith     ierr = PetscInfo(snes,"Rebuilding preconditioner exactly once since lag is -2\n");CHKERRQ(ierr);
13633b4f5425SBarry Smith     snes->lagpreconditioner = -1;
13643b4f5425SBarry Smith   } else if (snes->lagpreconditioner == -1) {
1365a8054027SBarry Smith     *flg = SAME_PRECONDITIONER;
1366a8054027SBarry Smith     ierr = PetscInfo(snes,"Reusing preconditioner because lag is -1\n");CHKERRQ(ierr);
1367a8054027SBarry Smith   } else if (snes->lagpreconditioner > 1 && snes->iter % snes->lagpreconditioner) {
1368a8054027SBarry Smith     *flg = SAME_PRECONDITIONER;
1369a8054027SBarry Smith     ierr = PetscInfo2(snes,"Reusing preconditioner because lag is %D and SNES iteration is %D\n",snes->lagpreconditioner,snes->iter);CHKERRQ(ierr);
1370a8054027SBarry Smith   }
1371a8054027SBarry Smith 
13726d84be18SBarry Smith   /* make sure user returned a correct Jacobian and preconditioner */
13730700a824SBarry Smith   /* PetscValidHeaderSpecific(*A,MAT_CLASSID,3);
13740700a824SBarry Smith     PetscValidHeaderSpecific(*B,MAT_CLASSID,4);   */
1375693365a8SJed Brown   {
1376693365a8SJed Brown     PetscBool flag = PETSC_FALSE,flag_draw = PETSC_FALSE,flag_contour = PETSC_FALSE,flag_operator = PETSC_FALSE;
1377693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit",&flag,PETSC_NULL);CHKERRQ(ierr);
1378693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw",&flag_draw,PETSC_NULL);CHKERRQ(ierr);
1379693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw_contour",&flag_contour,PETSC_NULL);CHKERRQ(ierr);
1380693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_operator",&flag_operator,PETSC_NULL);CHKERRQ(ierr);
1381693365a8SJed Brown     if (flag || flag_draw || flag_contour) {
1382693365a8SJed Brown       Mat Bexp_mine = PETSC_NULL,Bexp,FDexp;
1383693365a8SJed Brown       MatStructure mstruct;
1384693365a8SJed Brown       PetscViewer vdraw,vstdout;
13856b3a5b13SJed Brown       PetscBool flg;
1386693365a8SJed Brown       if (flag_operator) {
1387693365a8SJed Brown         ierr = MatComputeExplicitOperator(*A,&Bexp_mine);CHKERRQ(ierr);
1388693365a8SJed Brown         Bexp = Bexp_mine;
1389693365a8SJed Brown       } else {
1390693365a8SJed Brown         /* See if the preconditioning matrix can be viewed and added directly */
1391693365a8SJed Brown         ierr = PetscTypeCompareAny((PetscObject)*B,&flg,MATSEQAIJ,MATMPIAIJ,MATSEQDENSE,MATMPIDENSE,MATSEQBAIJ,MATMPIBAIJ,MATSEQSBAIJ,MATMPIBAIJ,"");CHKERRQ(ierr);
1392693365a8SJed Brown         if (flg) Bexp = *B;
1393693365a8SJed Brown         else {
1394693365a8SJed Brown           /* If the "preconditioning" matrix is itself MATSHELL or some other type without direct support */
1395693365a8SJed Brown           ierr = MatComputeExplicitOperator(*B,&Bexp_mine);CHKERRQ(ierr);
1396693365a8SJed Brown           Bexp = Bexp_mine;
1397693365a8SJed Brown         }
1398693365a8SJed Brown       }
1399693365a8SJed Brown       ierr = MatConvert(Bexp,MATSAME,MAT_INITIAL_MATRIX,&FDexp);CHKERRQ(ierr);
1400693365a8SJed Brown       ierr = SNESDefaultComputeJacobian(snes,X,&FDexp,&FDexp,&mstruct,NULL);CHKERRQ(ierr);
1401693365a8SJed Brown       ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&vstdout);CHKERRQ(ierr);
1402693365a8SJed Brown       if (flag_draw || flag_contour) {
1403693365a8SJed Brown         ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,0,"Explicit Jacobians",PETSC_DECIDE,PETSC_DECIDE,300,300,&vdraw);CHKERRQ(ierr);
1404693365a8SJed Brown         if (flag_contour) {ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);}
1405693365a8SJed Brown       } else vdraw = PETSC_NULL;
1406693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Explicit %s\n",flag_operator?"Jacobian":"preconditioning Jacobian");CHKERRQ(ierr);
1407693365a8SJed Brown       if (flag) {ierr = MatView(Bexp,vstdout);CHKERRQ(ierr);}
1408693365a8SJed Brown       if (vdraw) {ierr = MatView(Bexp,vdraw);CHKERRQ(ierr);}
1409693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Finite difference Jacobian\n");CHKERRQ(ierr);
1410693365a8SJed Brown       if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);}
1411693365a8SJed Brown       if (vdraw) {ierr = MatView(FDexp,vdraw);CHKERRQ(ierr);}
1412693365a8SJed Brown       ierr = MatAYPX(FDexp,-1.0,Bexp,SAME_NONZERO_PATTERN);CHKERRQ(ierr);
1413693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"User-provided matrix minus finite difference Jacobian\n");CHKERRQ(ierr);
1414693365a8SJed Brown       if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);}
1415693365a8SJed Brown       if (vdraw) {              /* Always use contour for the difference */
1416693365a8SJed Brown         ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);
1417693365a8SJed Brown         ierr = MatView(FDexp,vdraw);CHKERRQ(ierr);
1418693365a8SJed Brown         ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);
1419693365a8SJed Brown       }
1420693365a8SJed Brown       if (flag_contour) {ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);}
1421693365a8SJed Brown       ierr = PetscViewerDestroy(&vdraw);CHKERRQ(ierr);
1422693365a8SJed Brown       ierr = MatDestroy(&Bexp_mine);CHKERRQ(ierr);
1423693365a8SJed Brown       ierr = MatDestroy(&FDexp);CHKERRQ(ierr);
1424693365a8SJed Brown     }
1425693365a8SJed Brown   }
14263a40ed3dSBarry Smith   PetscFunctionReturn(0);
14279b94acceSBarry Smith }
14289b94acceSBarry Smith 
14294a2ae208SSatish Balay #undef __FUNCT__
14304a2ae208SSatish Balay #define __FUNCT__ "SNESSetJacobian"
14319b94acceSBarry Smith /*@C
14329b94acceSBarry Smith    SNESSetJacobian - Sets the function to compute Jacobian as well as the
1433044dda88SLois Curfman McInnes    location to store the matrix.
14349b94acceSBarry Smith 
14353f9fe445SBarry Smith    Logically Collective on SNES and Mat
1436c7afd0dbSLois Curfman McInnes 
14379b94acceSBarry Smith    Input Parameters:
1438c7afd0dbSLois Curfman McInnes +  snes - the SNES context
14399b94acceSBarry Smith .  A - Jacobian matrix
14409b94acceSBarry Smith .  B - preconditioner matrix (usually same as the Jacobian)
1441efd51863SBarry Smith .  func - Jacobian evaluation routine (if PETSC_NULL then SNES retains any previously set value)
1442c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined context for private data for the
1443efd51863SBarry Smith          Jacobian evaluation routine (may be PETSC_NULL) (if PETSC_NULL then SNES retains any previously set value)
14449b94acceSBarry Smith 
14459b94acceSBarry Smith    Calling sequence of func:
14468d76a1e5SLois Curfman McInnes $     func (SNES snes,Vec x,Mat *A,Mat *B,int *flag,void *ctx);
14479b94acceSBarry Smith 
1448c7afd0dbSLois Curfman McInnes +  x - input vector
14499b94acceSBarry Smith .  A - Jacobian matrix
14509b94acceSBarry Smith .  B - preconditioner matrix, usually the same as A
1451ac21db08SLois Curfman McInnes .  flag - flag indicating information about the preconditioner matrix
14522b668275SBarry Smith    structure (same as flag in KSPSetOperators()), one of SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER
1453c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined Jacobian context
14549b94acceSBarry Smith 
14559b94acceSBarry Smith    Notes:
145694b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the flag
14572cd2dfdcSLois Curfman McInnes    output parameter in the routine func().  Be sure to read this information!
1458ac21db08SLois Curfman McInnes 
1459ac21db08SLois Curfman McInnes    The routine func() takes Mat * as the matrix arguments rather than Mat.
14609b94acceSBarry Smith    This allows the Jacobian evaluation routine to replace A and/or B with a
14619b94acceSBarry Smith    completely new new matrix structure (not just different matrix elements)
14629b94acceSBarry Smith    when appropriate, for instance, if the nonzero structure is changing
14639b94acceSBarry Smith    throughout the global iterations.
14649b94acceSBarry Smith 
146516913363SBarry Smith    If the A matrix and B matrix are different you must call MatAssemblyBegin/End() on
146616913363SBarry Smith    each matrix.
146716913363SBarry Smith 
1468a8a26c1eSJed Brown    If using SNESDefaultComputeJacobianColor() to assemble a Jacobian, the ctx argument
1469a8a26c1eSJed Brown    must be a MatFDColoring.
1470a8a26c1eSJed Brown 
147136851e7fSLois Curfman McInnes    Level: beginner
147236851e7fSLois Curfman McInnes 
14739b94acceSBarry Smith .keywords: SNES, nonlinear, set, Jacobian, matrix
14749b94acceSBarry Smith 
14753ec795f1SBarry Smith .seealso: KSPSetOperators(), SNESSetFunction(), MatMFFDComputeJacobian(), SNESDefaultComputeJacobianColor(), MatStructure
14769b94acceSBarry Smith @*/
14777087cfbeSBarry Smith PetscErrorCode  SNESSetJacobian(SNES snes,Mat A,Mat B,PetscErrorCode (*func)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *ctx)
14789b94acceSBarry Smith {
1479dfbe8321SBarry Smith   PetscErrorCode ierr;
14803a7fca6bSBarry Smith 
14813a40ed3dSBarry Smith   PetscFunctionBegin;
14820700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
14830700a824SBarry Smith   if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2);
14840700a824SBarry Smith   if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3);
1485c9780b6fSBarry Smith   if (A) PetscCheckSameComm(snes,1,A,2);
148606975374SJed Brown   if (B) PetscCheckSameComm(snes,1,B,3);
1487e7788613SBarry Smith   if (func) snes->ops->computejacobian = func;
14883a7fca6bSBarry Smith   if (ctx)  snes->jacP                 = ctx;
14893a7fca6bSBarry Smith   if (A) {
14907dcf0eaaSdalcinl     ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
14916bf464f9SBarry Smith     ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr);
14929b94acceSBarry Smith     snes->jacobian = A;
14933a7fca6bSBarry Smith   }
14943a7fca6bSBarry Smith   if (B) {
14957dcf0eaaSdalcinl     ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
14966bf464f9SBarry Smith     ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr);
14979b94acceSBarry Smith     snes->jacobian_pre = B;
14983a7fca6bSBarry Smith   }
14993a40ed3dSBarry Smith   PetscFunctionReturn(0);
15009b94acceSBarry Smith }
150162fef451SLois Curfman McInnes 
15024a2ae208SSatish Balay #undef __FUNCT__
15034a2ae208SSatish Balay #define __FUNCT__ "SNESGetJacobian"
1504c2aafc4cSSatish Balay /*@C
1505b4fd4287SBarry Smith    SNESGetJacobian - Returns the Jacobian matrix and optionally the user
1506b4fd4287SBarry Smith    provided context for evaluating the Jacobian.
1507b4fd4287SBarry Smith 
1508c7afd0dbSLois Curfman McInnes    Not Collective, but Mat object will be parallel if SNES object is
1509c7afd0dbSLois Curfman McInnes 
1510b4fd4287SBarry Smith    Input Parameter:
1511b4fd4287SBarry Smith .  snes - the nonlinear solver context
1512b4fd4287SBarry Smith 
1513b4fd4287SBarry Smith    Output Parameters:
1514c7afd0dbSLois Curfman McInnes +  A - location to stash Jacobian matrix (or PETSC_NULL)
1515b4fd4287SBarry Smith .  B - location to stash preconditioner matrix (or PETSC_NULL)
151670e92668SMatthew Knepley .  func - location to put Jacobian function (or PETSC_NULL)
151770e92668SMatthew Knepley -  ctx - location to stash Jacobian ctx (or PETSC_NULL)
1518fee21e36SBarry Smith 
151936851e7fSLois Curfman McInnes    Level: advanced
152036851e7fSLois Curfman McInnes 
1521b4fd4287SBarry Smith .seealso: SNESSetJacobian(), SNESComputeJacobian()
1522b4fd4287SBarry Smith @*/
15237087cfbeSBarry Smith PetscErrorCode  SNESGetJacobian(SNES snes,Mat *A,Mat *B,PetscErrorCode (**func)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **ctx)
1524b4fd4287SBarry Smith {
15253a40ed3dSBarry Smith   PetscFunctionBegin;
15260700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1527b4fd4287SBarry Smith   if (A)    *A    = snes->jacobian;
1528b4fd4287SBarry Smith   if (B)    *B    = snes->jacobian_pre;
1529e7788613SBarry Smith   if (func) *func = snes->ops->computejacobian;
153070e92668SMatthew Knepley   if (ctx)  *ctx  = snes->jacP;
15313a40ed3dSBarry Smith   PetscFunctionReturn(0);
1532b4fd4287SBarry Smith }
1533b4fd4287SBarry Smith 
15349b94acceSBarry Smith /* ----- Routines to initialize and destroy a nonlinear solver ---- */
15359b94acceSBarry Smith 
15364a2ae208SSatish Balay #undef __FUNCT__
15374a2ae208SSatish Balay #define __FUNCT__ "SNESSetUp"
15389b94acceSBarry Smith /*@
15399b94acceSBarry Smith    SNESSetUp - Sets up the internal data structures for the later use
1540272ac6f2SLois Curfman McInnes    of a nonlinear solver.
15419b94acceSBarry Smith 
1542fee21e36SBarry Smith    Collective on SNES
1543fee21e36SBarry Smith 
1544c7afd0dbSLois Curfman McInnes    Input Parameters:
154570e92668SMatthew Knepley .  snes - the SNES context
1546c7afd0dbSLois Curfman McInnes 
1547272ac6f2SLois Curfman McInnes    Notes:
1548272ac6f2SLois Curfman McInnes    For basic use of the SNES solvers the user need not explicitly call
1549272ac6f2SLois Curfman McInnes    SNESSetUp(), since these actions will automatically occur during
1550272ac6f2SLois Curfman McInnes    the call to SNESSolve().  However, if one wishes to control this
1551272ac6f2SLois Curfman McInnes    phase separately, SNESSetUp() should be called after SNESCreate()
1552272ac6f2SLois Curfman McInnes    and optional routines of the form SNESSetXXX(), but before SNESSolve().
1553272ac6f2SLois Curfman McInnes 
155436851e7fSLois Curfman McInnes    Level: advanced
155536851e7fSLois Curfman McInnes 
15569b94acceSBarry Smith .keywords: SNES, nonlinear, setup
15579b94acceSBarry Smith 
15589b94acceSBarry Smith .seealso: SNESCreate(), SNESSolve(), SNESDestroy()
15599b94acceSBarry Smith @*/
15607087cfbeSBarry Smith PetscErrorCode  SNESSetUp(SNES snes)
15619b94acceSBarry Smith {
1562dfbe8321SBarry Smith   PetscErrorCode ierr;
15633a40ed3dSBarry Smith 
15643a40ed3dSBarry Smith   PetscFunctionBegin;
15650700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
15664dc4c822SBarry Smith   if (snes->setupcalled) PetscFunctionReturn(0);
15679b94acceSBarry Smith 
15687adad957SLisandro Dalcin   if (!((PetscObject)snes)->type_name) {
156985385478SLisandro Dalcin     ierr = SNESSetType(snes,SNESLS);CHKERRQ(ierr);
157085385478SLisandro Dalcin   }
157185385478SLisandro Dalcin 
1572c9b9fda1SJed Brown   if (!snes->vec_func) {
1573c9b9fda1SJed Brown     if (snes->vec_rhs) {
1574c9b9fda1SJed Brown       ierr = VecDuplicate(snes->vec_rhs,&snes->vec_func);CHKERRQ(ierr);
1575c9b9fda1SJed Brown     } else if (snes->vec_sol) {
1576c9b9fda1SJed Brown       ierr = VecDuplicate(snes->vec_sol,&snes->vec_func);CHKERRQ(ierr);
1577c9b9fda1SJed Brown     } else if (snes->dm) {
1578efd51863SBarry Smith       ierr = DMCreateGlobalVector(snes->dm,&snes->vec_func);CHKERRQ(ierr);
1579efd51863SBarry Smith     }
1580c9b9fda1SJed Brown   }
158117186662SBarry Smith   if (snes->vec_func == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be function vector");
158258c9b817SLisandro Dalcin   if (snes->vec_rhs  == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be right hand side vector");
158358c9b817SLisandro Dalcin 
158458c9b817SLisandro Dalcin   if (!snes->vec_sol_update /* && snes->vec_sol */) {
158558c9b817SLisandro Dalcin     ierr = VecDuplicate(snes->vec_sol,&snes->vec_sol_update);CHKERRQ(ierr);
158658c9b817SLisandro Dalcin     ierr = PetscLogObjectParent(snes,snes->vec_sol_update);CHKERRQ(ierr);
158758c9b817SLisandro Dalcin   }
158858c9b817SLisandro Dalcin 
1589ef8dffc7SBarry Smith   if (!snes->ops->computejacobian && snes->dm) {
1590ef8dffc7SBarry Smith     Mat J;
1591ef8dffc7SBarry Smith     ierr = DMGetMatrix(snes->dm,MATAIJ,&J);CHKERRQ(ierr);
1592cab2e9ccSBarry Smith     ierr = SNESSetJacobian(snes,J,J,SNESDMComputeJacobian,PETSC_NULL);CHKERRQ(ierr);
1593cab2e9ccSBarry Smith     ierr = MatDestroy(&J);CHKERRQ(ierr);
15942ef29e96SBarry Smith   } else if (!snes->jacobian && snes->ops->computejacobian == MatMFFDComputeJacobian) {
1595a8248277SBarry Smith     Mat J;
1596a8248277SBarry Smith     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
1597a8248277SBarry Smith     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
1598a8248277SBarry Smith     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
1599a8248277SBarry Smith     ierr = SNESSetJacobian(snes,J,J,MatMFFDComputeJacobian,snes->funP);CHKERRQ(ierr);
1600a8248277SBarry Smith     ierr = MatDestroy(&J);CHKERRQ(ierr);
1601a8248277SBarry Smith   } else if (snes->dm && snes->mf_operator && !snes->jacobian_pre && !snes->jacobian) {
1602a8248277SBarry Smith     Mat J,B;
1603a8248277SBarry Smith     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
1604a8248277SBarry Smith     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
1605a8248277SBarry Smith     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
1606a8248277SBarry Smith     ierr = DMGetMatrix(snes->dm,MATAIJ,&B);CHKERRQ(ierr);
1607a8248277SBarry Smith     ierr = SNESSetJacobian(snes,J,B,SNESDMComputeJacobian,snes->funP);CHKERRQ(ierr);
1608a8248277SBarry Smith     ierr = MatDestroy(&J);CHKERRQ(ierr);
1609a8248277SBarry Smith     ierr = MatDestroy(&B);CHKERRQ(ierr);
1610efd51863SBarry Smith   } else if (snes->dm && !snes->jacobian_pre){
1611efd51863SBarry Smith     Mat J;
1612efd51863SBarry Smith     ierr = DMGetMatrix(snes->dm,MATAIJ,&J);CHKERRQ(ierr);
16133cbb28f5SBarry Smith     ierr = SNESSetJacobian(snes,J,J,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
1614efd51863SBarry Smith     ierr = MatDestroy(&J);CHKERRQ(ierr);
1615ef8dffc7SBarry Smith   }
1616cfaf3a74SBarry 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()");
1617c9b9fda1SJed Brown   if (!snes->vec_func) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_ARG_WRONGSTATE,"Must provide a vector when calling SNESSetFunction() or call SNESSetDM()");
1618efd51863SBarry Smith 
1619b710008aSBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes, &snes->ksp);CHKERRQ(ierr);}
1620b710008aSBarry Smith 
1621d25893d9SBarry Smith   if (snes->ops->usercompute && !snes->user) {
1622d25893d9SBarry Smith     ierr = (*snes->ops->usercompute)(snes,(void**)&snes->user);CHKERRQ(ierr);
1623d25893d9SBarry Smith   }
1624d25893d9SBarry Smith 
1625410397dcSLisandro Dalcin   if (snes->ops->setup) {
1626410397dcSLisandro Dalcin     ierr = (*snes->ops->setup)(snes);CHKERRQ(ierr);
1627410397dcSLisandro Dalcin   }
162858c9b817SLisandro Dalcin 
16297aaed0d8SBarry Smith   snes->setupcalled = PETSC_TRUE;
16303a40ed3dSBarry Smith   PetscFunctionReturn(0);
16319b94acceSBarry Smith }
16329b94acceSBarry Smith 
16334a2ae208SSatish Balay #undef __FUNCT__
163437596af1SLisandro Dalcin #define __FUNCT__ "SNESReset"
163537596af1SLisandro Dalcin /*@
163637596af1SLisandro Dalcin    SNESReset - Resets a SNES context to the snessetupcalled = 0 state and removes any allocated Vecs and Mats
163737596af1SLisandro Dalcin 
163837596af1SLisandro Dalcin    Collective on SNES
163937596af1SLisandro Dalcin 
164037596af1SLisandro Dalcin    Input Parameter:
164137596af1SLisandro Dalcin .  snes - iterative context obtained from SNESCreate()
164237596af1SLisandro Dalcin 
1643d25893d9SBarry Smith    Level: intermediate
1644d25893d9SBarry Smith 
1645d25893d9SBarry Smith    Notes: Also calls the application context destroy routine set with SNESSetComputeApplicationContext()
164637596af1SLisandro Dalcin 
164737596af1SLisandro Dalcin .keywords: SNES, destroy
164837596af1SLisandro Dalcin 
164937596af1SLisandro Dalcin .seealso: SNESCreate(), SNESSetUp(), SNESSolve()
165037596af1SLisandro Dalcin @*/
165137596af1SLisandro Dalcin PetscErrorCode  SNESReset(SNES snes)
165237596af1SLisandro Dalcin {
165337596af1SLisandro Dalcin   PetscErrorCode ierr;
165437596af1SLisandro Dalcin 
165537596af1SLisandro Dalcin   PetscFunctionBegin;
165637596af1SLisandro Dalcin   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1657d25893d9SBarry Smith   if (snes->ops->userdestroy && snes->user) {
1658d25893d9SBarry Smith     ierr       = (*snes->ops->userdestroy)((void**)&snes->user);CHKERRQ(ierr);
1659d25893d9SBarry Smith     snes->user = PETSC_NULL;
1660d25893d9SBarry Smith   }
166137596af1SLisandro Dalcin   if (snes->ops->reset) {
166237596af1SLisandro Dalcin     ierr = (*snes->ops->reset)(snes);CHKERRQ(ierr);
166337596af1SLisandro Dalcin   }
166437596af1SLisandro Dalcin   if (snes->ksp) {ierr = KSPReset(snes->ksp);CHKERRQ(ierr);}
16656bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr);
16666bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr);
16676bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_sol_update);CHKERRQ(ierr);
16686bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr);
16696bf464f9SBarry Smith   ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr);
16706bf464f9SBarry Smith   ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr);
167137596af1SLisandro Dalcin   if (snes->work) {ierr = VecDestroyVecs(snes->nwork,&snes->work);CHKERRQ(ierr);}
167237596af1SLisandro Dalcin   if (snes->vwork) {ierr = VecDestroyVecs(snes->nvwork,&snes->vwork);CHKERRQ(ierr);}
167337596af1SLisandro Dalcin   snes->nwork = snes->nvwork = 0;
167437596af1SLisandro Dalcin   snes->setupcalled = PETSC_FALSE;
167537596af1SLisandro Dalcin   PetscFunctionReturn(0);
167637596af1SLisandro Dalcin }
167737596af1SLisandro Dalcin 
167837596af1SLisandro Dalcin #undef __FUNCT__
16794a2ae208SSatish Balay #define __FUNCT__ "SNESDestroy"
168052baeb72SSatish Balay /*@
16819b94acceSBarry Smith    SNESDestroy - Destroys the nonlinear solver context that was created
16829b94acceSBarry Smith    with SNESCreate().
16839b94acceSBarry Smith 
1684c7afd0dbSLois Curfman McInnes    Collective on SNES
1685c7afd0dbSLois Curfman McInnes 
16869b94acceSBarry Smith    Input Parameter:
16879b94acceSBarry Smith .  snes - the SNES context
16889b94acceSBarry Smith 
168936851e7fSLois Curfman McInnes    Level: beginner
169036851e7fSLois Curfman McInnes 
16919b94acceSBarry Smith .keywords: SNES, nonlinear, destroy
16929b94acceSBarry Smith 
169363a78c88SLois Curfman McInnes .seealso: SNESCreate(), SNESSolve()
16949b94acceSBarry Smith @*/
16956bf464f9SBarry Smith PetscErrorCode  SNESDestroy(SNES *snes)
16969b94acceSBarry Smith {
16976849ba73SBarry Smith   PetscErrorCode ierr;
16983a40ed3dSBarry Smith 
16993a40ed3dSBarry Smith   PetscFunctionBegin;
17006bf464f9SBarry Smith   if (!*snes) PetscFunctionReturn(0);
17016bf464f9SBarry Smith   PetscValidHeaderSpecific((*snes),SNES_CLASSID,1);
17026bf464f9SBarry Smith   if (--((PetscObject)(*snes))->refct > 0) {*snes = 0; PetscFunctionReturn(0);}
1703d4bb536fSBarry Smith 
17046bf464f9SBarry Smith   ierr = SNESReset((*snes));CHKERRQ(ierr);
17056b8b9a38SLisandro Dalcin 
1706be0abb6dSBarry Smith   /* if memory was published with AMS then destroy it */
17076bf464f9SBarry Smith   ierr = PetscObjectDepublish((*snes));CHKERRQ(ierr);
17086bf464f9SBarry Smith   if ((*snes)->ops->destroy) {ierr = (*((*snes))->ops->destroy)((*snes));CHKERRQ(ierr);}
17096d4c513bSLisandro Dalcin 
17106bf464f9SBarry Smith   ierr = DMDestroy(&(*snes)->dm);CHKERRQ(ierr);
17116bf464f9SBarry Smith   ierr = KSPDestroy(&(*snes)->ksp);CHKERRQ(ierr);
17126b8b9a38SLisandro Dalcin 
17136bf464f9SBarry Smith   ierr = PetscFree((*snes)->kspconvctx);CHKERRQ(ierr);
17146bf464f9SBarry Smith   if ((*snes)->ops->convergeddestroy) {
17156bf464f9SBarry Smith     ierr = (*(*snes)->ops->convergeddestroy)((*snes)->cnvP);CHKERRQ(ierr);
17166b8b9a38SLisandro Dalcin   }
17176bf464f9SBarry Smith   if ((*snes)->conv_malloc) {
17186bf464f9SBarry Smith     ierr = PetscFree((*snes)->conv_hist);CHKERRQ(ierr);
17196bf464f9SBarry Smith     ierr = PetscFree((*snes)->conv_hist_its);CHKERRQ(ierr);
172058c9b817SLisandro Dalcin   }
17216bf464f9SBarry Smith   ierr = SNESMonitorCancel((*snes));CHKERRQ(ierr);
1722a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(snes);CHKERRQ(ierr);
17233a40ed3dSBarry Smith   PetscFunctionReturn(0);
17249b94acceSBarry Smith }
17259b94acceSBarry Smith 
17269b94acceSBarry Smith /* ----------- Routines to set solver parameters ---------- */
17279b94acceSBarry Smith 
17284a2ae208SSatish Balay #undef __FUNCT__
1729a8054027SBarry Smith #define __FUNCT__ "SNESSetLagPreconditioner"
1730a8054027SBarry Smith /*@
1731a8054027SBarry Smith    SNESSetLagPreconditioner - Determines when the preconditioner is rebuilt in the nonlinear solve.
1732a8054027SBarry Smith 
17333f9fe445SBarry Smith    Logically Collective on SNES
1734a8054027SBarry Smith 
1735a8054027SBarry Smith    Input Parameters:
1736a8054027SBarry Smith +  snes - the SNES context
1737a8054027SBarry 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
17383b4f5425SBarry Smith          the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that
1739a8054027SBarry Smith 
1740a8054027SBarry Smith    Options Database Keys:
1741a8054027SBarry Smith .    -snes_lag_preconditioner <lag>
1742a8054027SBarry Smith 
1743a8054027SBarry Smith    Notes:
1744a8054027SBarry Smith    The default is 1
1745a8054027SBarry Smith    The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
1746a8054027SBarry Smith    If  -1 is used before the very first nonlinear solve the preconditioner is still built because there is no previous preconditioner to use
1747a8054027SBarry Smith 
1748a8054027SBarry Smith    Level: intermediate
1749a8054027SBarry Smith 
1750a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
1751a8054027SBarry Smith 
1752e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian()
1753a8054027SBarry Smith 
1754a8054027SBarry Smith @*/
17557087cfbeSBarry Smith PetscErrorCode  SNESSetLagPreconditioner(SNES snes,PetscInt lag)
1756a8054027SBarry Smith {
1757a8054027SBarry Smith   PetscFunctionBegin;
17580700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1759e32f2f54SBarry Smith   if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater");
1760e32f2f54SBarry Smith   if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0");
1761c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,lag,2);
1762a8054027SBarry Smith   snes->lagpreconditioner = lag;
1763a8054027SBarry Smith   PetscFunctionReturn(0);
1764a8054027SBarry Smith }
1765a8054027SBarry Smith 
1766a8054027SBarry Smith #undef __FUNCT__
1767efd51863SBarry Smith #define __FUNCT__ "SNESSetGridSequence"
1768efd51863SBarry Smith /*@
1769efd51863SBarry Smith    SNESSetGridSequence - sets the number of steps of grid sequencing that SNES does
1770efd51863SBarry Smith 
1771efd51863SBarry Smith    Logically Collective on SNES
1772efd51863SBarry Smith 
1773efd51863SBarry Smith    Input Parameters:
1774efd51863SBarry Smith +  snes - the SNES context
1775efd51863SBarry Smith -  steps - the number of refinements to do, defaults to 0
1776efd51863SBarry Smith 
1777efd51863SBarry Smith    Options Database Keys:
1778efd51863SBarry Smith .    -snes_grid_sequence <steps>
1779efd51863SBarry Smith 
1780efd51863SBarry Smith    Level: intermediate
1781efd51863SBarry Smith 
1782efd51863SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
1783efd51863SBarry Smith 
1784efd51863SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian()
1785efd51863SBarry Smith 
1786efd51863SBarry Smith @*/
1787efd51863SBarry Smith PetscErrorCode  SNESSetGridSequence(SNES snes,PetscInt steps)
1788efd51863SBarry Smith {
1789efd51863SBarry Smith   PetscFunctionBegin;
1790efd51863SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1791efd51863SBarry Smith   PetscValidLogicalCollectiveInt(snes,steps,2);
1792efd51863SBarry Smith   snes->gridsequence = steps;
1793efd51863SBarry Smith   PetscFunctionReturn(0);
1794efd51863SBarry Smith }
1795efd51863SBarry Smith 
1796efd51863SBarry Smith #undef __FUNCT__
1797a8054027SBarry Smith #define __FUNCT__ "SNESGetLagPreconditioner"
1798a8054027SBarry Smith /*@
1799a8054027SBarry Smith    SNESGetLagPreconditioner - Indicates how often the preconditioner is rebuilt
1800a8054027SBarry Smith 
18013f9fe445SBarry Smith    Not Collective
1802a8054027SBarry Smith 
1803a8054027SBarry Smith    Input Parameter:
1804a8054027SBarry Smith .  snes - the SNES context
1805a8054027SBarry Smith 
1806a8054027SBarry Smith    Output Parameter:
1807a8054027SBarry 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
18083b4f5425SBarry Smith          the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that
1809a8054027SBarry Smith 
1810a8054027SBarry Smith    Options Database Keys:
1811a8054027SBarry Smith .    -snes_lag_preconditioner <lag>
1812a8054027SBarry Smith 
1813a8054027SBarry Smith    Notes:
1814a8054027SBarry Smith    The default is 1
1815a8054027SBarry Smith    The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
1816a8054027SBarry Smith 
1817a8054027SBarry Smith    Level: intermediate
1818a8054027SBarry Smith 
1819a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
1820a8054027SBarry Smith 
1821a8054027SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagPreconditioner()
1822a8054027SBarry Smith 
1823a8054027SBarry Smith @*/
18247087cfbeSBarry Smith PetscErrorCode  SNESGetLagPreconditioner(SNES snes,PetscInt *lag)
1825a8054027SBarry Smith {
1826a8054027SBarry Smith   PetscFunctionBegin;
18270700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1828a8054027SBarry Smith   *lag = snes->lagpreconditioner;
1829a8054027SBarry Smith   PetscFunctionReturn(0);
1830a8054027SBarry Smith }
1831a8054027SBarry Smith 
1832a8054027SBarry Smith #undef __FUNCT__
1833e35cf81dSBarry Smith #define __FUNCT__ "SNESSetLagJacobian"
1834e35cf81dSBarry Smith /*@
1835e35cf81dSBarry Smith    SNESSetLagJacobian - Determines when the Jacobian is rebuilt in the nonlinear solve. See SNESSetLagPreconditioner() for determining how
1836e35cf81dSBarry Smith      often the preconditioner is rebuilt.
1837e35cf81dSBarry Smith 
18383f9fe445SBarry Smith    Logically Collective on SNES
1839e35cf81dSBarry Smith 
1840e35cf81dSBarry Smith    Input Parameters:
1841e35cf81dSBarry Smith +  snes - the SNES context
1842e35cf81dSBarry 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
1843fe3ffe1eSBarry Smith          the Jacobian is built etc. -2 means rebuild at next chance but then never again
1844e35cf81dSBarry Smith 
1845e35cf81dSBarry Smith    Options Database Keys:
1846e35cf81dSBarry Smith .    -snes_lag_jacobian <lag>
1847e35cf81dSBarry Smith 
1848e35cf81dSBarry Smith    Notes:
1849e35cf81dSBarry Smith    The default is 1
1850e35cf81dSBarry Smith    The Jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
1851fe3ffe1eSBarry 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
1852fe3ffe1eSBarry Smith    at the next Newton step but never again (unless it is reset to another value)
1853e35cf81dSBarry Smith 
1854e35cf81dSBarry Smith    Level: intermediate
1855e35cf81dSBarry Smith 
1856e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
1857e35cf81dSBarry Smith 
1858e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagPreconditioner(), SNESGetLagJacobian()
1859e35cf81dSBarry Smith 
1860e35cf81dSBarry Smith @*/
18617087cfbeSBarry Smith PetscErrorCode  SNESSetLagJacobian(SNES snes,PetscInt lag)
1862e35cf81dSBarry Smith {
1863e35cf81dSBarry Smith   PetscFunctionBegin;
18640700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1865e32f2f54SBarry Smith   if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater");
1866e32f2f54SBarry Smith   if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0");
1867c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,lag,2);
1868e35cf81dSBarry Smith   snes->lagjacobian = lag;
1869e35cf81dSBarry Smith   PetscFunctionReturn(0);
1870e35cf81dSBarry Smith }
1871e35cf81dSBarry Smith 
1872e35cf81dSBarry Smith #undef __FUNCT__
1873e35cf81dSBarry Smith #define __FUNCT__ "SNESGetLagJacobian"
1874e35cf81dSBarry Smith /*@
1875e35cf81dSBarry Smith    SNESGetLagJacobian - Indicates how often the Jacobian is rebuilt. See SNESGetLagPreconditioner() to determine when the preconditioner is rebuilt
1876e35cf81dSBarry Smith 
18773f9fe445SBarry Smith    Not Collective
1878e35cf81dSBarry Smith 
1879e35cf81dSBarry Smith    Input Parameter:
1880e35cf81dSBarry Smith .  snes - the SNES context
1881e35cf81dSBarry Smith 
1882e35cf81dSBarry Smith    Output Parameter:
1883e35cf81dSBarry 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
1884e35cf81dSBarry Smith          the Jacobian is built etc.
1885e35cf81dSBarry Smith 
1886e35cf81dSBarry Smith    Options Database Keys:
1887e35cf81dSBarry Smith .    -snes_lag_jacobian <lag>
1888e35cf81dSBarry Smith 
1889e35cf81dSBarry Smith    Notes:
1890e35cf81dSBarry Smith    The default is 1
1891e35cf81dSBarry Smith    The jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
1892e35cf81dSBarry Smith 
1893e35cf81dSBarry Smith    Level: intermediate
1894e35cf81dSBarry Smith 
1895e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
1896e35cf81dSBarry Smith 
1897e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagJacobian(), SNESSetLagPreconditioner(), SNESGetLagPreconditioner()
1898e35cf81dSBarry Smith 
1899e35cf81dSBarry Smith @*/
19007087cfbeSBarry Smith PetscErrorCode  SNESGetLagJacobian(SNES snes,PetscInt *lag)
1901e35cf81dSBarry Smith {
1902e35cf81dSBarry Smith   PetscFunctionBegin;
19030700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1904e35cf81dSBarry Smith   *lag = snes->lagjacobian;
1905e35cf81dSBarry Smith   PetscFunctionReturn(0);
1906e35cf81dSBarry Smith }
1907e35cf81dSBarry Smith 
1908e35cf81dSBarry Smith #undef __FUNCT__
19094a2ae208SSatish Balay #define __FUNCT__ "SNESSetTolerances"
19109b94acceSBarry Smith /*@
1911d7a720efSLois Curfman McInnes    SNESSetTolerances - Sets various parameters used in convergence tests.
19129b94acceSBarry Smith 
19133f9fe445SBarry Smith    Logically Collective on SNES
1914c7afd0dbSLois Curfman McInnes 
19159b94acceSBarry Smith    Input Parameters:
1916c7afd0dbSLois Curfman McInnes +  snes - the SNES context
191770441072SBarry Smith .  abstol - absolute convergence tolerance
191833174efeSLois Curfman McInnes .  rtol - relative convergence tolerance
191933174efeSLois Curfman McInnes .  stol -  convergence tolerance in terms of the norm
192033174efeSLois Curfman McInnes            of the change in the solution between steps
192133174efeSLois Curfman McInnes .  maxit - maximum number of iterations
1922c7afd0dbSLois Curfman McInnes -  maxf - maximum number of function evaluations
1923fee21e36SBarry Smith 
192433174efeSLois Curfman McInnes    Options Database Keys:
192570441072SBarry Smith +    -snes_atol <abstol> - Sets abstol
1926c7afd0dbSLois Curfman McInnes .    -snes_rtol <rtol> - Sets rtol
1927c7afd0dbSLois Curfman McInnes .    -snes_stol <stol> - Sets stol
1928c7afd0dbSLois Curfman McInnes .    -snes_max_it <maxit> - Sets maxit
1929c7afd0dbSLois Curfman McInnes -    -snes_max_funcs <maxf> - Sets maxf
19309b94acceSBarry Smith 
1931d7a720efSLois Curfman McInnes    Notes:
19329b94acceSBarry Smith    The default maximum number of iterations is 50.
19339b94acceSBarry Smith    The default maximum number of function evaluations is 1000.
19349b94acceSBarry Smith 
193536851e7fSLois Curfman McInnes    Level: intermediate
193636851e7fSLois Curfman McInnes 
193733174efeSLois Curfman McInnes .keywords: SNES, nonlinear, set, convergence, tolerances
19389b94acceSBarry Smith 
19392492ecdbSBarry Smith .seealso: SNESSetTrustRegionTolerance()
19409b94acceSBarry Smith @*/
19417087cfbeSBarry Smith PetscErrorCode  SNESSetTolerances(SNES snes,PetscReal abstol,PetscReal rtol,PetscReal stol,PetscInt maxit,PetscInt maxf)
19429b94acceSBarry Smith {
19433a40ed3dSBarry Smith   PetscFunctionBegin;
19440700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1945c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,abstol,2);
1946c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol,3);
1947c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,stol,4);
1948c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxit,5);
1949c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxf,6);
1950c5eb9154SBarry Smith 
1951*ab54825eSJed Brown   if (abstol != PETSC_DEFAULT) {
1952*ab54825eSJed Brown     if (abstol < 0.0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Absolute tolerance %G must be non-negative",abstol);
1953*ab54825eSJed Brown     snes->abstol = abstol;
1954*ab54825eSJed Brown   }
1955*ab54825eSJed Brown   if (rtol != PETSC_DEFAULT) {
1956*ab54825eSJed 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);
1957*ab54825eSJed Brown     snes->rtol = rtol;
1958*ab54825eSJed Brown   }
1959*ab54825eSJed Brown   if (stol != PETSC_DEFAULT) {
1960*ab54825eSJed Brown     if (stol < 0.0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Step tolerance %G must be non-negative",stol);
1961*ab54825eSJed Brown     snes->xtol = stol;
1962*ab54825eSJed Brown   }
1963*ab54825eSJed Brown   if (maxit != PETSC_DEFAULT) {
1964*ab54825eSJed Brown     if (maxit < 0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of iterations %D must be non-negative",maxit);
1965*ab54825eSJed Brown     snes->max_its = maxit;
1966*ab54825eSJed Brown   }
1967*ab54825eSJed Brown   if (maxf != PETSC_DEFAULT) {
1968*ab54825eSJed Brown     if (maxf < 0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of function evaluations %D must be non-negative",maxf);
1969*ab54825eSJed Brown     snes->max_funcs = maxf;
1970*ab54825eSJed Brown   }
19713a40ed3dSBarry Smith   PetscFunctionReturn(0);
19729b94acceSBarry Smith }
19739b94acceSBarry Smith 
19744a2ae208SSatish Balay #undef __FUNCT__
19754a2ae208SSatish Balay #define __FUNCT__ "SNESGetTolerances"
19769b94acceSBarry Smith /*@
197733174efeSLois Curfman McInnes    SNESGetTolerances - Gets various parameters used in convergence tests.
197833174efeSLois Curfman McInnes 
1979c7afd0dbSLois Curfman McInnes    Not Collective
1980c7afd0dbSLois Curfman McInnes 
198133174efeSLois Curfman McInnes    Input Parameters:
1982c7afd0dbSLois Curfman McInnes +  snes - the SNES context
198385385478SLisandro Dalcin .  atol - absolute convergence tolerance
198433174efeSLois Curfman McInnes .  rtol - relative convergence tolerance
198533174efeSLois Curfman McInnes .  stol -  convergence tolerance in terms of the norm
198633174efeSLois Curfman McInnes            of the change in the solution between steps
198733174efeSLois Curfman McInnes .  maxit - maximum number of iterations
1988c7afd0dbSLois Curfman McInnes -  maxf - maximum number of function evaluations
1989fee21e36SBarry Smith 
199033174efeSLois Curfman McInnes    Notes:
199133174efeSLois Curfman McInnes    The user can specify PETSC_NULL for any parameter that is not needed.
199233174efeSLois Curfman McInnes 
199336851e7fSLois Curfman McInnes    Level: intermediate
199436851e7fSLois Curfman McInnes 
199533174efeSLois Curfman McInnes .keywords: SNES, nonlinear, get, convergence, tolerances
199633174efeSLois Curfman McInnes 
199733174efeSLois Curfman McInnes .seealso: SNESSetTolerances()
199833174efeSLois Curfman McInnes @*/
19997087cfbeSBarry Smith PetscErrorCode  SNESGetTolerances(SNES snes,PetscReal *atol,PetscReal *rtol,PetscReal *stol,PetscInt *maxit,PetscInt *maxf)
200033174efeSLois Curfman McInnes {
20013a40ed3dSBarry Smith   PetscFunctionBegin;
20020700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
200385385478SLisandro Dalcin   if (atol)  *atol  = snes->abstol;
200433174efeSLois Curfman McInnes   if (rtol)  *rtol  = snes->rtol;
200533174efeSLois Curfman McInnes   if (stol)  *stol  = snes->xtol;
200633174efeSLois Curfman McInnes   if (maxit) *maxit = snes->max_its;
200733174efeSLois Curfman McInnes   if (maxf)  *maxf  = snes->max_funcs;
20083a40ed3dSBarry Smith   PetscFunctionReturn(0);
200933174efeSLois Curfman McInnes }
201033174efeSLois Curfman McInnes 
20114a2ae208SSatish Balay #undef __FUNCT__
20124a2ae208SSatish Balay #define __FUNCT__ "SNESSetTrustRegionTolerance"
201333174efeSLois Curfman McInnes /*@
20149b94acceSBarry Smith    SNESSetTrustRegionTolerance - Sets the trust region parameter tolerance.
20159b94acceSBarry Smith 
20163f9fe445SBarry Smith    Logically Collective on SNES
2017fee21e36SBarry Smith 
2018c7afd0dbSLois Curfman McInnes    Input Parameters:
2019c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2020c7afd0dbSLois Curfman McInnes -  tol - tolerance
2021c7afd0dbSLois Curfman McInnes 
20229b94acceSBarry Smith    Options Database Key:
2023c7afd0dbSLois Curfman McInnes .  -snes_trtol <tol> - Sets tol
20249b94acceSBarry Smith 
202536851e7fSLois Curfman McInnes    Level: intermediate
202636851e7fSLois Curfman McInnes 
20279b94acceSBarry Smith .keywords: SNES, nonlinear, set, trust region, tolerance
20289b94acceSBarry Smith 
20292492ecdbSBarry Smith .seealso: SNESSetTolerances()
20309b94acceSBarry Smith @*/
20317087cfbeSBarry Smith PetscErrorCode  SNESSetTrustRegionTolerance(SNES snes,PetscReal tol)
20329b94acceSBarry Smith {
20333a40ed3dSBarry Smith   PetscFunctionBegin;
20340700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2035c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,tol,2);
20369b94acceSBarry Smith   snes->deltatol = tol;
20373a40ed3dSBarry Smith   PetscFunctionReturn(0);
20389b94acceSBarry Smith }
20399b94acceSBarry Smith 
2040df9fa365SBarry Smith /*
2041df9fa365SBarry Smith    Duplicate the lg monitors for SNES from KSP; for some reason with
2042df9fa365SBarry Smith    dynamic libraries things don't work under Sun4 if we just use
2043df9fa365SBarry Smith    macros instead of functions
2044df9fa365SBarry Smith */
20454a2ae208SSatish Balay #undef __FUNCT__
2046a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLG"
20477087cfbeSBarry Smith PetscErrorCode  SNESMonitorLG(SNES snes,PetscInt it,PetscReal norm,void *ctx)
2048ce1608b8SBarry Smith {
2049dfbe8321SBarry Smith   PetscErrorCode ierr;
2050ce1608b8SBarry Smith 
2051ce1608b8SBarry Smith   PetscFunctionBegin;
20520700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2053a6570f20SBarry Smith   ierr = KSPMonitorLG((KSP)snes,it,norm,ctx);CHKERRQ(ierr);
2054ce1608b8SBarry Smith   PetscFunctionReturn(0);
2055ce1608b8SBarry Smith }
2056ce1608b8SBarry Smith 
20574a2ae208SSatish Balay #undef __FUNCT__
2058a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGCreate"
20597087cfbeSBarry Smith PetscErrorCode  SNESMonitorLGCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw)
2060df9fa365SBarry Smith {
2061dfbe8321SBarry Smith   PetscErrorCode ierr;
2062df9fa365SBarry Smith 
2063df9fa365SBarry Smith   PetscFunctionBegin;
2064a6570f20SBarry Smith   ierr = KSPMonitorLGCreate(host,label,x,y,m,n,draw);CHKERRQ(ierr);
2065df9fa365SBarry Smith   PetscFunctionReturn(0);
2066df9fa365SBarry Smith }
2067df9fa365SBarry Smith 
20684a2ae208SSatish Balay #undef __FUNCT__
2069a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGDestroy"
20706bf464f9SBarry Smith PetscErrorCode  SNESMonitorLGDestroy(PetscDrawLG *draw)
2071df9fa365SBarry Smith {
2072dfbe8321SBarry Smith   PetscErrorCode ierr;
2073df9fa365SBarry Smith 
2074df9fa365SBarry Smith   PetscFunctionBegin;
2075a6570f20SBarry Smith   ierr = KSPMonitorLGDestroy(draw);CHKERRQ(ierr);
2076df9fa365SBarry Smith   PetscFunctionReturn(0);
2077df9fa365SBarry Smith }
2078df9fa365SBarry Smith 
20797087cfbeSBarry Smith extern PetscErrorCode  SNESMonitorRange_Private(SNES,PetscInt,PetscReal*);
2080b271bb04SBarry Smith #undef __FUNCT__
2081b271bb04SBarry Smith #define __FUNCT__ "SNESMonitorLGRange"
20827087cfbeSBarry Smith PetscErrorCode  SNESMonitorLGRange(SNES snes,PetscInt n,PetscReal rnorm,void *monctx)
2083b271bb04SBarry Smith {
2084b271bb04SBarry Smith   PetscDrawLG      lg;
2085b271bb04SBarry Smith   PetscErrorCode   ierr;
2086b271bb04SBarry Smith   PetscReal        x,y,per;
2087b271bb04SBarry Smith   PetscViewer      v = (PetscViewer)monctx;
2088b271bb04SBarry Smith   static PetscReal prev; /* should be in the context */
2089b271bb04SBarry Smith   PetscDraw        draw;
2090b271bb04SBarry Smith   PetscFunctionBegin;
2091b271bb04SBarry Smith   if (!monctx) {
2092b271bb04SBarry Smith     MPI_Comm    comm;
2093b271bb04SBarry Smith 
2094b271bb04SBarry Smith     ierr   = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr);
2095b271bb04SBarry Smith     v      = PETSC_VIEWER_DRAW_(comm);
2096b271bb04SBarry Smith   }
2097b271bb04SBarry Smith   ierr   = PetscViewerDrawGetDrawLG(v,0,&lg);CHKERRQ(ierr);
2098b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
2099b271bb04SBarry Smith   ierr   = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
2100b271bb04SBarry Smith   ierr   = PetscDrawSetTitle(draw,"Residual norm");CHKERRQ(ierr);
2101b271bb04SBarry Smith   x = (PetscReal) n;
2102b271bb04SBarry Smith   if (rnorm > 0.0) y = log10(rnorm); else y = -15.0;
2103b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
2104b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
2105b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
2106b271bb04SBarry Smith   }
2107b271bb04SBarry Smith 
2108b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,1,&lg);CHKERRQ(ierr);
2109b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
2110b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
2111b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"% elemts > .2*max elemt");CHKERRQ(ierr);
2112b271bb04SBarry Smith   ierr =  SNESMonitorRange_Private(snes,n,&per);CHKERRQ(ierr);
2113b271bb04SBarry Smith   x = (PetscReal) n;
2114b271bb04SBarry Smith   y = 100.0*per;
2115b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
2116b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
2117b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
2118b271bb04SBarry Smith   }
2119b271bb04SBarry Smith 
2120b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,2,&lg);CHKERRQ(ierr);
2121b271bb04SBarry Smith   if (!n) {prev = rnorm;ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
2122b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
2123b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm");CHKERRQ(ierr);
2124b271bb04SBarry Smith   x = (PetscReal) n;
2125b271bb04SBarry Smith   y = (prev - rnorm)/prev;
2126b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
2127b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
2128b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
2129b271bb04SBarry Smith   }
2130b271bb04SBarry Smith 
2131b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,3,&lg);CHKERRQ(ierr);
2132b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
2133b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
2134b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm*(% > .2 max)");CHKERRQ(ierr);
2135b271bb04SBarry Smith   x = (PetscReal) n;
2136b271bb04SBarry Smith   y = (prev - rnorm)/(prev*per);
2137b271bb04SBarry Smith   if (n > 2) { /*skip initial crazy value */
2138b271bb04SBarry Smith     ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
2139b271bb04SBarry Smith   }
2140b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
2141b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
2142b271bb04SBarry Smith   }
2143b271bb04SBarry Smith   prev = rnorm;
2144b271bb04SBarry Smith   PetscFunctionReturn(0);
2145b271bb04SBarry Smith }
2146b271bb04SBarry Smith 
2147b271bb04SBarry Smith #undef __FUNCT__
2148b271bb04SBarry Smith #define __FUNCT__ "SNESMonitorLGRangeCreate"
21497087cfbeSBarry Smith PetscErrorCode  SNESMonitorLGRangeCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw)
2150b271bb04SBarry Smith {
2151b271bb04SBarry Smith   PetscErrorCode ierr;
2152b271bb04SBarry Smith 
2153b271bb04SBarry Smith   PetscFunctionBegin;
2154b271bb04SBarry Smith   ierr = KSPMonitorLGCreate(host,label,x,y,m,n,draw);CHKERRQ(ierr);
2155b271bb04SBarry Smith   PetscFunctionReturn(0);
2156b271bb04SBarry Smith }
2157b271bb04SBarry Smith 
2158b271bb04SBarry Smith #undef __FUNCT__
2159b271bb04SBarry Smith #define __FUNCT__ "SNESMonitorLGRangeDestroy"
21606bf464f9SBarry Smith PetscErrorCode  SNESMonitorLGRangeDestroy(PetscDrawLG *draw)
2161b271bb04SBarry Smith {
2162b271bb04SBarry Smith   PetscErrorCode ierr;
2163b271bb04SBarry Smith 
2164b271bb04SBarry Smith   PetscFunctionBegin;
2165b271bb04SBarry Smith   ierr = KSPMonitorLGDestroy(draw);CHKERRQ(ierr);
2166b271bb04SBarry Smith   PetscFunctionReturn(0);
2167b271bb04SBarry Smith }
2168b271bb04SBarry Smith 
21697a03ce2fSLisandro Dalcin #undef __FUNCT__
21707a03ce2fSLisandro Dalcin #define __FUNCT__ "SNESMonitor"
21717a03ce2fSLisandro Dalcin /*
21727a03ce2fSLisandro Dalcin      Runs the user provided monitor routines, if they exists.
21737a03ce2fSLisandro Dalcin */
21747a03ce2fSLisandro Dalcin PetscErrorCode  SNESMonitor(SNES snes,PetscInt iter,PetscReal rnorm)
21757a03ce2fSLisandro Dalcin {
21767a03ce2fSLisandro Dalcin   PetscErrorCode ierr;
21777a03ce2fSLisandro Dalcin   PetscInt       i,n = snes->numbermonitors;
21787a03ce2fSLisandro Dalcin 
21797a03ce2fSLisandro Dalcin   PetscFunctionBegin;
21807a03ce2fSLisandro Dalcin   for (i=0; i<n; i++) {
21817a03ce2fSLisandro Dalcin     ierr = (*snes->monitor[i])(snes,iter,rnorm,snes->monitorcontext[i]);CHKERRQ(ierr);
21827a03ce2fSLisandro Dalcin   }
21837a03ce2fSLisandro Dalcin   PetscFunctionReturn(0);
21847a03ce2fSLisandro Dalcin }
21857a03ce2fSLisandro Dalcin 
21869b94acceSBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
21879b94acceSBarry Smith 
21884a2ae208SSatish Balay #undef __FUNCT__
2189a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorSet"
21909b94acceSBarry Smith /*@C
2191a6570f20SBarry Smith    SNESMonitorSet - Sets an ADDITIONAL function that is to be used at every
21929b94acceSBarry Smith    iteration of the nonlinear solver to display the iteration's
21939b94acceSBarry Smith    progress.
21949b94acceSBarry Smith 
21953f9fe445SBarry Smith    Logically Collective on SNES
2196fee21e36SBarry Smith 
2197c7afd0dbSLois Curfman McInnes    Input Parameters:
2198c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2199c7afd0dbSLois Curfman McInnes .  func - monitoring routine
2200b8a78c4aSBarry Smith .  mctx - [optional] user-defined context for private data for the
2201e8105e01SRichard Katz           monitor routine (use PETSC_NULL if no context is desired)
2202b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
2203b3006f0bSLois Curfman McInnes           (may be PETSC_NULL)
22049b94acceSBarry Smith 
2205c7afd0dbSLois Curfman McInnes    Calling sequence of func:
2206a7cc72afSBarry Smith $     int func(SNES snes,PetscInt its, PetscReal norm,void *mctx)
2207c7afd0dbSLois Curfman McInnes 
2208c7afd0dbSLois Curfman McInnes +    snes - the SNES context
2209c7afd0dbSLois Curfman McInnes .    its - iteration number
2210c7afd0dbSLois Curfman McInnes .    norm - 2-norm function value (may be estimated)
221140a0c1c6SLois Curfman McInnes -    mctx - [optional] monitoring context
22129b94acceSBarry Smith 
22139665c990SLois Curfman McInnes    Options Database Keys:
2214a6570f20SBarry Smith +    -snes_monitor        - sets SNESMonitorDefault()
2215a6570f20SBarry Smith .    -snes_monitor_draw    - sets line graph monitor,
2216a6570f20SBarry Smith                             uses SNESMonitorLGCreate()
2217cca6129bSJed Brown -    -snes_monitor_cancel - cancels all monitors that have
2218c7afd0dbSLois Curfman McInnes                             been hardwired into a code by
2219a6570f20SBarry Smith                             calls to SNESMonitorSet(), but
2220c7afd0dbSLois Curfman McInnes                             does not cancel those set via
2221c7afd0dbSLois Curfman McInnes                             the options database.
22229665c990SLois Curfman McInnes 
2223639f9d9dSBarry Smith    Notes:
22246bc08f3fSLois Curfman McInnes    Several different monitoring routines may be set by calling
2225a6570f20SBarry Smith    SNESMonitorSet() multiple times; all will be called in the
22266bc08f3fSLois Curfman McInnes    order in which they were set.
2227639f9d9dSBarry Smith 
2228025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each SNES object
2229025f1a04SBarry Smith 
223036851e7fSLois Curfman McInnes    Level: intermediate
223136851e7fSLois Curfman McInnes 
22329b94acceSBarry Smith .keywords: SNES, nonlinear, set, monitor
22339b94acceSBarry Smith 
2234a6570f20SBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorCancel()
22359b94acceSBarry Smith @*/
2236c2efdce3SBarry Smith PetscErrorCode  SNESMonitorSet(SNES snes,PetscErrorCode (*monitor)(SNES,PetscInt,PetscReal,void*),void *mctx,PetscErrorCode (*monitordestroy)(void**))
22379b94acceSBarry Smith {
2238b90d0a6eSBarry Smith   PetscInt       i;
2239649052a6SBarry Smith   PetscErrorCode ierr;
2240b90d0a6eSBarry Smith 
22413a40ed3dSBarry Smith   PetscFunctionBegin;
22420700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
224317186662SBarry Smith   if (snes->numbermonitors >= MAXSNESMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
2244b90d0a6eSBarry Smith   for (i=0; i<snes->numbermonitors;i++) {
2245649052a6SBarry Smith     if (monitor == snes->monitor[i] && monitordestroy == snes->monitordestroy[i] && mctx == snes->monitorcontext[i]) {
2246649052a6SBarry Smith       if (monitordestroy) {
2247c2efdce3SBarry Smith         ierr = (*monitordestroy)(&mctx);CHKERRQ(ierr);
2248649052a6SBarry Smith       }
2249b90d0a6eSBarry Smith       PetscFunctionReturn(0);
2250b90d0a6eSBarry Smith     }
2251b90d0a6eSBarry Smith   }
2252b90d0a6eSBarry Smith   snes->monitor[snes->numbermonitors]           = monitor;
2253b8a78c4aSBarry Smith   snes->monitordestroy[snes->numbermonitors]    = monitordestroy;
2254639f9d9dSBarry Smith   snes->monitorcontext[snes->numbermonitors++]  = (void*)mctx;
22553a40ed3dSBarry Smith   PetscFunctionReturn(0);
22569b94acceSBarry Smith }
22579b94acceSBarry Smith 
22584a2ae208SSatish Balay #undef __FUNCT__
2259a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorCancel"
22605cd90555SBarry Smith /*@C
2261a6570f20SBarry Smith    SNESMonitorCancel - Clears all the monitor functions for a SNES object.
22625cd90555SBarry Smith 
22633f9fe445SBarry Smith    Logically Collective on SNES
2264c7afd0dbSLois Curfman McInnes 
22655cd90555SBarry Smith    Input Parameters:
22665cd90555SBarry Smith .  snes - the SNES context
22675cd90555SBarry Smith 
22681a480d89SAdministrator    Options Database Key:
2269a6570f20SBarry Smith .  -snes_monitor_cancel - cancels all monitors that have been hardwired
2270a6570f20SBarry Smith     into a code by calls to SNESMonitorSet(), but does not cancel those
2271c7afd0dbSLois Curfman McInnes     set via the options database
22725cd90555SBarry Smith 
22735cd90555SBarry Smith    Notes:
22745cd90555SBarry Smith    There is no way to clear one specific monitor from a SNES object.
22755cd90555SBarry Smith 
227636851e7fSLois Curfman McInnes    Level: intermediate
227736851e7fSLois Curfman McInnes 
22785cd90555SBarry Smith .keywords: SNES, nonlinear, set, monitor
22795cd90555SBarry Smith 
2280a6570f20SBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorSet()
22815cd90555SBarry Smith @*/
22827087cfbeSBarry Smith PetscErrorCode  SNESMonitorCancel(SNES snes)
22835cd90555SBarry Smith {
2284d952e501SBarry Smith   PetscErrorCode ierr;
2285d952e501SBarry Smith   PetscInt       i;
2286d952e501SBarry Smith 
22875cd90555SBarry Smith   PetscFunctionBegin;
22880700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2289d952e501SBarry Smith   for (i=0; i<snes->numbermonitors; i++) {
2290d952e501SBarry Smith     if (snes->monitordestroy[i]) {
22913c4aec1bSBarry Smith       ierr = (*snes->monitordestroy[i])(&snes->monitorcontext[i]);CHKERRQ(ierr);
2292d952e501SBarry Smith     }
2293d952e501SBarry Smith   }
22945cd90555SBarry Smith   snes->numbermonitors = 0;
22955cd90555SBarry Smith   PetscFunctionReturn(0);
22965cd90555SBarry Smith }
22975cd90555SBarry Smith 
22984a2ae208SSatish Balay #undef __FUNCT__
22994a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceTest"
23009b94acceSBarry Smith /*@C
23019b94acceSBarry Smith    SNESSetConvergenceTest - Sets the function that is to be used
23029b94acceSBarry Smith    to test for convergence of the nonlinear iterative solution.
23039b94acceSBarry Smith 
23043f9fe445SBarry Smith    Logically Collective on SNES
2305fee21e36SBarry Smith 
2306c7afd0dbSLois Curfman McInnes    Input Parameters:
2307c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2308c7afd0dbSLois Curfman McInnes .  func - routine to test for convergence
23097f7931b9SBarry Smith .  cctx - [optional] context for private data for the convergence routine  (may be PETSC_NULL)
23107f7931b9SBarry Smith -  destroy - [optional] destructor for the context (may be PETSC_NULL; PETSC_NULL_FUNCTION in Fortran)
23119b94acceSBarry Smith 
2312c7afd0dbSLois Curfman McInnes    Calling sequence of func:
231306ee9f85SBarry Smith $     PetscErrorCode func (SNES snes,PetscInt it,PetscReal xnorm,PetscReal gnorm,PetscReal f,SNESConvergedReason *reason,void *cctx)
2314c7afd0dbSLois Curfman McInnes 
2315c7afd0dbSLois Curfman McInnes +    snes - the SNES context
231606ee9f85SBarry Smith .    it - current iteration (0 is the first and is before any Newton step)
2317c7afd0dbSLois Curfman McInnes .    cctx - [optional] convergence context
2318184914b5SBarry Smith .    reason - reason for convergence/divergence
2319c7afd0dbSLois Curfman McInnes .    xnorm - 2-norm of current iterate
23204b27c08aSLois Curfman McInnes .    gnorm - 2-norm of current step
23214b27c08aSLois Curfman McInnes -    f - 2-norm of function
23229b94acceSBarry Smith 
232336851e7fSLois Curfman McInnes    Level: advanced
232436851e7fSLois Curfman McInnes 
23259b94acceSBarry Smith .keywords: SNES, nonlinear, set, convergence, test
23269b94acceSBarry Smith 
232785385478SLisandro Dalcin .seealso: SNESDefaultConverged(), SNESSkipConverged()
23289b94acceSBarry Smith @*/
23297087cfbeSBarry Smith PetscErrorCode  SNESSetConvergenceTest(SNES snes,PetscErrorCode (*func)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void *cctx,PetscErrorCode (*destroy)(void*))
23309b94acceSBarry Smith {
23317f7931b9SBarry Smith   PetscErrorCode ierr;
23327f7931b9SBarry Smith 
23333a40ed3dSBarry Smith   PetscFunctionBegin;
23340700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
233585385478SLisandro Dalcin   if (!func) func = SNESSkipConverged;
23367f7931b9SBarry Smith   if (snes->ops->convergeddestroy) {
23377f7931b9SBarry Smith     ierr = (*snes->ops->convergeddestroy)(snes->cnvP);CHKERRQ(ierr);
23387f7931b9SBarry Smith   }
233985385478SLisandro Dalcin   snes->ops->converged        = func;
23407f7931b9SBarry Smith   snes->ops->convergeddestroy = destroy;
234185385478SLisandro Dalcin   snes->cnvP                  = cctx;
23423a40ed3dSBarry Smith   PetscFunctionReturn(0);
23439b94acceSBarry Smith }
23449b94acceSBarry Smith 
23454a2ae208SSatish Balay #undef __FUNCT__
23464a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergedReason"
234752baeb72SSatish Balay /*@
2348184914b5SBarry Smith    SNESGetConvergedReason - Gets the reason the SNES iteration was stopped.
2349184914b5SBarry Smith 
2350184914b5SBarry Smith    Not Collective
2351184914b5SBarry Smith 
2352184914b5SBarry Smith    Input Parameter:
2353184914b5SBarry Smith .  snes - the SNES context
2354184914b5SBarry Smith 
2355184914b5SBarry Smith    Output Parameter:
23564d0a8057SBarry Smith .  reason - negative value indicates diverged, positive value converged, see SNESConvergedReason or the
2357184914b5SBarry Smith             manual pages for the individual convergence tests for complete lists
2358184914b5SBarry Smith 
2359184914b5SBarry Smith    Level: intermediate
2360184914b5SBarry Smith 
2361184914b5SBarry Smith    Notes: Can only be called after the call the SNESSolve() is complete.
2362184914b5SBarry Smith 
2363184914b5SBarry Smith .keywords: SNES, nonlinear, set, convergence, test
2364184914b5SBarry Smith 
236585385478SLisandro Dalcin .seealso: SNESSetConvergenceTest(), SNESConvergedReason
2366184914b5SBarry Smith @*/
23677087cfbeSBarry Smith PetscErrorCode  SNESGetConvergedReason(SNES snes,SNESConvergedReason *reason)
2368184914b5SBarry Smith {
2369184914b5SBarry Smith   PetscFunctionBegin;
23700700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
23714482741eSBarry Smith   PetscValidPointer(reason,2);
2372184914b5SBarry Smith   *reason = snes->reason;
2373184914b5SBarry Smith   PetscFunctionReturn(0);
2374184914b5SBarry Smith }
2375184914b5SBarry Smith 
23764a2ae208SSatish Balay #undef __FUNCT__
23774a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceHistory"
2378c9005455SLois Curfman McInnes /*@
2379c9005455SLois Curfman McInnes    SNESSetConvergenceHistory - Sets the array used to hold the convergence history.
2380c9005455SLois Curfman McInnes 
23813f9fe445SBarry Smith    Logically Collective on SNES
2382fee21e36SBarry Smith 
2383c7afd0dbSLois Curfman McInnes    Input Parameters:
2384c7afd0dbSLois Curfman McInnes +  snes - iterative context obtained from SNESCreate()
23858c7482ecSBarry Smith .  a   - array to hold history, this array will contain the function norms computed at each step
2386cd5578b5SBarry Smith .  its - integer array holds the number of linear iterations for each solve.
2387758f92a0SBarry Smith .  na  - size of a and its
238864731454SLois Curfman McInnes -  reset - PETSC_TRUE indicates each new nonlinear solve resets the history counter to zero,
2389758f92a0SBarry Smith            else it continues storing new values for new nonlinear solves after the old ones
2390c7afd0dbSLois Curfman McInnes 
2391308dcc3eSBarry Smith    Notes:
2392308dcc3eSBarry Smith    If 'a' and 'its' are PETSC_NULL then space is allocated for the history. If 'na' PETSC_DECIDE or PETSC_DEFAULT then a
2393308dcc3eSBarry Smith    default array of length 10000 is allocated.
2394308dcc3eSBarry Smith 
2395c9005455SLois Curfman McInnes    This routine is useful, e.g., when running a code for purposes
2396c9005455SLois Curfman McInnes    of accurate performance monitoring, when no I/O should be done
2397c9005455SLois Curfman McInnes    during the section of code that is being timed.
2398c9005455SLois Curfman McInnes 
239936851e7fSLois Curfman McInnes    Level: intermediate
240036851e7fSLois Curfman McInnes 
2401c9005455SLois Curfman McInnes .keywords: SNES, set, convergence, history
2402758f92a0SBarry Smith 
240308405cd6SLois Curfman McInnes .seealso: SNESGetConvergenceHistory()
2404758f92a0SBarry Smith 
2405c9005455SLois Curfman McInnes @*/
24067087cfbeSBarry Smith PetscErrorCode  SNESSetConvergenceHistory(SNES snes,PetscReal a[],PetscInt its[],PetscInt na,PetscBool  reset)
2407c9005455SLois Curfman McInnes {
2408308dcc3eSBarry Smith   PetscErrorCode ierr;
2409308dcc3eSBarry Smith 
24103a40ed3dSBarry Smith   PetscFunctionBegin;
24110700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
24124482741eSBarry Smith   if (na)  PetscValidScalarPointer(a,2);
2413a562a398SLisandro Dalcin   if (its) PetscValidIntPointer(its,3);
2414308dcc3eSBarry Smith   if (na == PETSC_DECIDE || na == PETSC_DEFAULT || !a) {
2415308dcc3eSBarry Smith     if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000;
2416308dcc3eSBarry Smith     ierr = PetscMalloc(na*sizeof(PetscReal),&a);CHKERRQ(ierr);
2417308dcc3eSBarry Smith     ierr = PetscMalloc(na*sizeof(PetscInt),&its);CHKERRQ(ierr);
2418308dcc3eSBarry Smith     snes->conv_malloc   = PETSC_TRUE;
2419308dcc3eSBarry Smith   }
2420c9005455SLois Curfman McInnes   snes->conv_hist       = a;
2421758f92a0SBarry Smith   snes->conv_hist_its   = its;
2422758f92a0SBarry Smith   snes->conv_hist_max   = na;
2423a12bc48fSLisandro Dalcin   snes->conv_hist_len   = 0;
2424758f92a0SBarry Smith   snes->conv_hist_reset = reset;
2425758f92a0SBarry Smith   PetscFunctionReturn(0);
2426758f92a0SBarry Smith }
2427758f92a0SBarry Smith 
2428308dcc3eSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
2429c6db04a5SJed Brown #include <engine.h>   /* MATLAB include file */
2430c6db04a5SJed Brown #include <mex.h>      /* MATLAB include file */
2431308dcc3eSBarry Smith EXTERN_C_BEGIN
2432308dcc3eSBarry Smith #undef __FUNCT__
2433308dcc3eSBarry Smith #define __FUNCT__ "SNESGetConvergenceHistoryMatlab"
2434308dcc3eSBarry Smith mxArray *SNESGetConvergenceHistoryMatlab(SNES snes)
2435308dcc3eSBarry Smith {
2436308dcc3eSBarry Smith   mxArray        *mat;
2437308dcc3eSBarry Smith   PetscInt       i;
2438308dcc3eSBarry Smith   PetscReal      *ar;
2439308dcc3eSBarry Smith 
2440308dcc3eSBarry Smith   PetscFunctionBegin;
2441308dcc3eSBarry Smith   mat  = mxCreateDoubleMatrix(snes->conv_hist_len,1,mxREAL);
2442308dcc3eSBarry Smith   ar   = (PetscReal*) mxGetData(mat);
2443308dcc3eSBarry Smith   for (i=0; i<snes->conv_hist_len; i++) {
2444308dcc3eSBarry Smith     ar[i] = snes->conv_hist[i];
2445308dcc3eSBarry Smith   }
2446308dcc3eSBarry Smith   PetscFunctionReturn(mat);
2447308dcc3eSBarry Smith }
2448308dcc3eSBarry Smith EXTERN_C_END
2449308dcc3eSBarry Smith #endif
2450308dcc3eSBarry Smith 
2451308dcc3eSBarry Smith 
24524a2ae208SSatish Balay #undef __FUNCT__
24534a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergenceHistory"
24540c4c9dddSBarry Smith /*@C
2455758f92a0SBarry Smith    SNESGetConvergenceHistory - Gets the array used to hold the convergence history.
2456758f92a0SBarry Smith 
24573f9fe445SBarry Smith    Not Collective
2458758f92a0SBarry Smith 
2459758f92a0SBarry Smith    Input Parameter:
2460758f92a0SBarry Smith .  snes - iterative context obtained from SNESCreate()
2461758f92a0SBarry Smith 
2462758f92a0SBarry Smith    Output Parameters:
2463758f92a0SBarry Smith .  a   - array to hold history
2464758f92a0SBarry Smith .  its - integer array holds the number of linear iterations (or
2465758f92a0SBarry Smith          negative if not converged) for each solve.
2466758f92a0SBarry Smith -  na  - size of a and its
2467758f92a0SBarry Smith 
2468758f92a0SBarry Smith    Notes:
2469758f92a0SBarry Smith     The calling sequence for this routine in Fortran is
2470758f92a0SBarry Smith $   call SNESGetConvergenceHistory(SNES snes, integer na, integer ierr)
2471758f92a0SBarry Smith 
2472758f92a0SBarry Smith    This routine is useful, e.g., when running a code for purposes
2473758f92a0SBarry Smith    of accurate performance monitoring, when no I/O should be done
2474758f92a0SBarry Smith    during the section of code that is being timed.
2475758f92a0SBarry Smith 
2476758f92a0SBarry Smith    Level: intermediate
2477758f92a0SBarry Smith 
2478758f92a0SBarry Smith .keywords: SNES, get, convergence, history
2479758f92a0SBarry Smith 
2480758f92a0SBarry Smith .seealso: SNESSetConvergencHistory()
2481758f92a0SBarry Smith 
2482758f92a0SBarry Smith @*/
24837087cfbeSBarry Smith PetscErrorCode  SNESGetConvergenceHistory(SNES snes,PetscReal *a[],PetscInt *its[],PetscInt *na)
2484758f92a0SBarry Smith {
2485758f92a0SBarry Smith   PetscFunctionBegin;
24860700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2487758f92a0SBarry Smith   if (a)   *a   = snes->conv_hist;
2488758f92a0SBarry Smith   if (its) *its = snes->conv_hist_its;
2489758f92a0SBarry Smith   if (na)  *na  = snes->conv_hist_len;
24903a40ed3dSBarry Smith   PetscFunctionReturn(0);
2491c9005455SLois Curfman McInnes }
2492c9005455SLois Curfman McInnes 
2493e74ef692SMatthew Knepley #undef __FUNCT__
2494e74ef692SMatthew Knepley #define __FUNCT__ "SNESSetUpdate"
2495ac226902SBarry Smith /*@C
249676b2cf59SMatthew Knepley   SNESSetUpdate - Sets the general-purpose update function called
2497eec8f646SJed Brown   at the beginning of every iteration of the nonlinear solve. Specifically
24987e4bb74cSBarry Smith   it is called just before the Jacobian is "evaluated".
249976b2cf59SMatthew Knepley 
25003f9fe445SBarry Smith   Logically Collective on SNES
250176b2cf59SMatthew Knepley 
250276b2cf59SMatthew Knepley   Input Parameters:
250376b2cf59SMatthew Knepley . snes - The nonlinear solver context
250476b2cf59SMatthew Knepley . func - The function
250576b2cf59SMatthew Knepley 
250676b2cf59SMatthew Knepley   Calling sequence of func:
2507b5d30489SBarry Smith . func (SNES snes, PetscInt step);
250876b2cf59SMatthew Knepley 
250976b2cf59SMatthew Knepley . step - The current step of the iteration
251076b2cf59SMatthew Knepley 
2511fe97e370SBarry Smith   Level: advanced
2512fe97e370SBarry Smith 
2513fe97e370SBarry 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()
2514fe97e370SBarry Smith         This is not used by most users.
251576b2cf59SMatthew Knepley 
251676b2cf59SMatthew Knepley .keywords: SNES, update
2517b5d30489SBarry Smith 
251885385478SLisandro Dalcin .seealso SNESDefaultUpdate(), SNESSetJacobian(), SNESSolve()
251976b2cf59SMatthew Knepley @*/
25207087cfbeSBarry Smith PetscErrorCode  SNESSetUpdate(SNES snes, PetscErrorCode (*func)(SNES, PetscInt))
252176b2cf59SMatthew Knepley {
252276b2cf59SMatthew Knepley   PetscFunctionBegin;
25230700a824SBarry Smith   PetscValidHeaderSpecific(snes, SNES_CLASSID,1);
2524e7788613SBarry Smith   snes->ops->update = func;
252576b2cf59SMatthew Knepley   PetscFunctionReturn(0);
252676b2cf59SMatthew Knepley }
252776b2cf59SMatthew Knepley 
2528e74ef692SMatthew Knepley #undef __FUNCT__
2529e74ef692SMatthew Knepley #define __FUNCT__ "SNESDefaultUpdate"
253076b2cf59SMatthew Knepley /*@
253176b2cf59SMatthew Knepley   SNESDefaultUpdate - The default update function which does nothing.
253276b2cf59SMatthew Knepley 
253376b2cf59SMatthew Knepley   Not collective
253476b2cf59SMatthew Knepley 
253576b2cf59SMatthew Knepley   Input Parameters:
253676b2cf59SMatthew Knepley . snes - The nonlinear solver context
253776b2cf59SMatthew Knepley . step - The current step of the iteration
253876b2cf59SMatthew Knepley 
2539205452f4SMatthew Knepley   Level: intermediate
2540205452f4SMatthew Knepley 
254176b2cf59SMatthew Knepley .keywords: SNES, update
2542a6570f20SBarry Smith .seealso SNESSetUpdate(), SNESDefaultRhsBC(), SNESDefaultShortolutionBC()
254376b2cf59SMatthew Knepley @*/
25447087cfbeSBarry Smith PetscErrorCode  SNESDefaultUpdate(SNES snes, PetscInt step)
254576b2cf59SMatthew Knepley {
254676b2cf59SMatthew Knepley   PetscFunctionBegin;
254776b2cf59SMatthew Knepley   PetscFunctionReturn(0);
254876b2cf59SMatthew Knepley }
254976b2cf59SMatthew Knepley 
25504a2ae208SSatish Balay #undef __FUNCT__
25514a2ae208SSatish Balay #define __FUNCT__ "SNESScaleStep_Private"
25529b94acceSBarry Smith /*
25539b94acceSBarry Smith    SNESScaleStep_Private - Scales a step so that its length is less than the
25549b94acceSBarry Smith    positive parameter delta.
25559b94acceSBarry Smith 
25569b94acceSBarry Smith     Input Parameters:
2557c7afd0dbSLois Curfman McInnes +   snes - the SNES context
25589b94acceSBarry Smith .   y - approximate solution of linear system
25599b94acceSBarry Smith .   fnorm - 2-norm of current function
2560c7afd0dbSLois Curfman McInnes -   delta - trust region size
25619b94acceSBarry Smith 
25629b94acceSBarry Smith     Output Parameters:
2563c7afd0dbSLois Curfman McInnes +   gpnorm - predicted function norm at the new point, assuming local
25649b94acceSBarry Smith     linearization.  The value is zero if the step lies within the trust
25659b94acceSBarry Smith     region, and exceeds zero otherwise.
2566c7afd0dbSLois Curfman McInnes -   ynorm - 2-norm of the step
25679b94acceSBarry Smith 
25689b94acceSBarry Smith     Note:
25694b27c08aSLois Curfman McInnes     For non-trust region methods such as SNESLS, the parameter delta
25709b94acceSBarry Smith     is set to be the maximum allowable step size.
25719b94acceSBarry Smith 
25729b94acceSBarry Smith .keywords: SNES, nonlinear, scale, step
25739b94acceSBarry Smith */
2574dfbe8321SBarry Smith PetscErrorCode SNESScaleStep_Private(SNES snes,Vec y,PetscReal *fnorm,PetscReal *delta,PetscReal *gpnorm,PetscReal *ynorm)
25759b94acceSBarry Smith {
2576064f8208SBarry Smith   PetscReal      nrm;
2577ea709b57SSatish Balay   PetscScalar    cnorm;
2578dfbe8321SBarry Smith   PetscErrorCode ierr;
25793a40ed3dSBarry Smith 
25803a40ed3dSBarry Smith   PetscFunctionBegin;
25810700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
25820700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,2);
2583c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,y,2);
2584184914b5SBarry Smith 
2585064f8208SBarry Smith   ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr);
2586064f8208SBarry Smith   if (nrm > *delta) {
2587064f8208SBarry Smith      nrm = *delta/nrm;
2588064f8208SBarry Smith      *gpnorm = (1.0 - nrm)*(*fnorm);
2589064f8208SBarry Smith      cnorm = nrm;
25902dcb1b2aSMatthew Knepley      ierr = VecScale(y,cnorm);CHKERRQ(ierr);
25919b94acceSBarry Smith      *ynorm = *delta;
25929b94acceSBarry Smith   } else {
25939b94acceSBarry Smith      *gpnorm = 0.0;
2594064f8208SBarry Smith      *ynorm = nrm;
25959b94acceSBarry Smith   }
25963a40ed3dSBarry Smith   PetscFunctionReturn(0);
25979b94acceSBarry Smith }
25989b94acceSBarry Smith 
25994a2ae208SSatish Balay #undef __FUNCT__
26004a2ae208SSatish Balay #define __FUNCT__ "SNESSolve"
26016ce558aeSBarry Smith /*@C
2602f69a0ea3SMatthew Knepley    SNESSolve - Solves a nonlinear system F(x) = b.
2603f69a0ea3SMatthew Knepley    Call SNESSolve() after calling SNESCreate() and optional routines of the form SNESSetXXX().
26049b94acceSBarry Smith 
2605c7afd0dbSLois Curfman McInnes    Collective on SNES
2606c7afd0dbSLois Curfman McInnes 
2607b2002411SLois Curfman McInnes    Input Parameters:
2608c7afd0dbSLois Curfman McInnes +  snes - the SNES context
26093cebf274SJed Brown .  b - the constant part of the equation F(x) = b, or PETSC_NULL to use zero.
261085385478SLisandro Dalcin -  x - the solution vector.
26119b94acceSBarry Smith 
2612b2002411SLois Curfman McInnes    Notes:
26138ddd3da0SLois Curfman McInnes    The user should initialize the vector,x, with the initial guess
26148ddd3da0SLois Curfman McInnes    for the nonlinear solve prior to calling SNESSolve.  In particular,
26158ddd3da0SLois Curfman McInnes    to employ an initial guess of zero, the user should explicitly set
26168ddd3da0SLois Curfman McInnes    this vector to zero by calling VecSet().
26178ddd3da0SLois Curfman McInnes 
261836851e7fSLois Curfman McInnes    Level: beginner
261936851e7fSLois Curfman McInnes 
26209b94acceSBarry Smith .keywords: SNES, nonlinear, solve
26219b94acceSBarry Smith 
262285385478SLisandro Dalcin .seealso: SNESCreate(), SNESDestroy(), SNESSetFunction(), SNESSetJacobian()
26239b94acceSBarry Smith @*/
26247087cfbeSBarry Smith PetscErrorCode  SNESSolve(SNES snes,Vec b,Vec x)
26259b94acceSBarry Smith {
2626dfbe8321SBarry Smith   PetscErrorCode ierr;
2627ace3abfcSBarry Smith   PetscBool      flg;
2628eabae89aSBarry Smith   char           filename[PETSC_MAX_PATH_LEN];
2629eabae89aSBarry Smith   PetscViewer    viewer;
2630efd51863SBarry Smith   PetscInt       grid;
2631052efed2SBarry Smith 
26323a40ed3dSBarry Smith   PetscFunctionBegin;
26330700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
26340700a824SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,3);
2635f69a0ea3SMatthew Knepley   PetscCheckSameComm(snes,1,x,3);
26360700a824SBarry Smith   if (b) PetscValidHeaderSpecific(b,VEC_CLASSID,2);
263785385478SLisandro Dalcin   if (b) PetscCheckSameComm(snes,1,b,2);
263885385478SLisandro Dalcin 
2639a8248277SBarry Smith   for (grid=0; grid<snes->gridsequence; grid++) {ierr = PetscViewerASCIIPushTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm));CHKERRQ(ierr);}
2640efd51863SBarry Smith   for (grid=0; grid<snes->gridsequence+1; grid++) {
2641efd51863SBarry Smith 
264285385478SLisandro Dalcin     /* set solution vector */
2643efd51863SBarry Smith     if (!grid) {ierr = PetscObjectReference((PetscObject)x);CHKERRQ(ierr);}
26446bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr);
264585385478SLisandro Dalcin     snes->vec_sol = x;
264685385478SLisandro Dalcin     /* set afine vector if provided */
264785385478SLisandro Dalcin     if (b) { ierr = PetscObjectReference((PetscObject)b);CHKERRQ(ierr); }
26486bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr);
264985385478SLisandro Dalcin     snes->vec_rhs = b;
265085385478SLisandro Dalcin 
265170e92668SMatthew Knepley     ierr = SNESSetUp(snes);CHKERRQ(ierr);
26523f149594SLisandro Dalcin 
2653d25893d9SBarry Smith     if (!grid && snes->ops->computeinitialguess) {
2654d25893d9SBarry Smith       ierr = (*snes->ops->computeinitialguess)(snes,snes->vec_sol,snes->initialguessP);CHKERRQ(ierr);
2655d25893d9SBarry Smith     }
2656d25893d9SBarry Smith 
2657abc0a331SBarry Smith     if (snes->conv_hist_reset) snes->conv_hist_len = 0;
265850ffb88aSMatthew Knepley     snes->nfuncs = 0; snes->linear_its = 0; snes->numFailures = 0;
2659d5e45103SBarry Smith 
26603f149594SLisandro Dalcin     ierr = PetscLogEventBegin(SNES_Solve,snes,0,0,0);CHKERRQ(ierr);
26614936397dSBarry Smith     ierr = (*snes->ops->solve)(snes);CHKERRQ(ierr);
266285385478SLisandro Dalcin     ierr = PetscLogEventEnd(SNES_Solve,snes,0,0,0);CHKERRQ(ierr);
26634936397dSBarry Smith     if (snes->domainerror){
26644936397dSBarry Smith       snes->reason      = SNES_DIVERGED_FUNCTION_DOMAIN;
26654936397dSBarry Smith       snes->domainerror = PETSC_FALSE;
26664936397dSBarry Smith     }
266717186662SBarry Smith     if (!snes->reason) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Internal error, solver returned without setting converged reason");
26683f149594SLisandro Dalcin 
26697adad957SLisandro Dalcin     ierr = PetscOptionsGetString(((PetscObject)snes)->prefix,"-snes_view",filename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
2670eabae89aSBarry Smith     if (flg && !PetscPreLoadingOn) {
26717adad957SLisandro Dalcin       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,filename,&viewer);CHKERRQ(ierr);
2672eabae89aSBarry Smith       ierr = SNESView(snes,viewer);CHKERRQ(ierr);
26736bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
2674eabae89aSBarry Smith     }
2675eabae89aSBarry Smith 
267690d69ab7SBarry Smith     flg  = PETSC_FALSE;
2677acfcf0e5SJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_test_local_min",&flg,PETSC_NULL);CHKERRQ(ierr);
2678da9b6338SBarry Smith     if (flg && !PetscPreLoadingOn) { ierr = SNESTestLocalMin(snes);CHKERRQ(ierr); }
26795968eb51SBarry Smith     if (snes->printreason) {
2680a8248277SBarry Smith       ierr = PetscViewerASCIIAddTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),((PetscObject)snes)->tablevel);CHKERRQ(ierr);
26815968eb51SBarry Smith       if (snes->reason > 0) {
2682a8248277SBarry Smith         ierr = PetscViewerASCIIPrintf(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),"Nonlinear solve converged due to %s\n",SNESConvergedReasons[snes->reason]);CHKERRQ(ierr);
26835968eb51SBarry Smith       } else {
2684a8248277SBarry Smith         ierr = PetscViewerASCIIPrintf(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),"Nonlinear solve did not converge due to %s\n",SNESConvergedReasons[snes->reason]);CHKERRQ(ierr);
26855968eb51SBarry Smith       }
2686a8248277SBarry Smith       ierr = PetscViewerASCIISubtractTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),((PetscObject)snes)->tablevel);CHKERRQ(ierr);
26875968eb51SBarry Smith     }
26885968eb51SBarry Smith 
2689e113a28aSBarry Smith     if (snes->errorifnotconverged && snes->reason < 0) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_NOT_CONVERGED,"SNESSolve has not converged");
2690efd51863SBarry Smith     if (grid <  snes->gridsequence) {
2691efd51863SBarry Smith       DM  fine;
2692efd51863SBarry Smith       Vec xnew;
2693efd51863SBarry Smith       Mat interp;
2694efd51863SBarry Smith 
2695efd51863SBarry Smith       ierr = DMRefine(snes->dm,((PetscObject)snes)->comm,&fine);CHKERRQ(ierr);
2696efd51863SBarry Smith       ierr = DMGetInterpolation(snes->dm,fine,&interp,PETSC_NULL);CHKERRQ(ierr);
2697efd51863SBarry Smith       ierr = DMCreateGlobalVector(fine,&xnew);CHKERRQ(ierr);
2698efd51863SBarry Smith       ierr = MatInterpolate(interp,x,xnew);CHKERRQ(ierr);
2699efd51863SBarry Smith       ierr = MatDestroy(&interp);CHKERRQ(ierr);
2700efd51863SBarry Smith       x    = xnew;
2701efd51863SBarry Smith 
2702efd51863SBarry Smith       ierr = SNESReset(snes);CHKERRQ(ierr);
2703efd51863SBarry Smith       ierr = SNESSetDM(snes,fine);CHKERRQ(ierr);
2704efd51863SBarry Smith       ierr = DMDestroy(&fine);CHKERRQ(ierr);
2705a8248277SBarry Smith       ierr = PetscViewerASCIIPopTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm));CHKERRQ(ierr);
2706efd51863SBarry Smith     }
2707efd51863SBarry Smith   }
27083a40ed3dSBarry Smith   PetscFunctionReturn(0);
27099b94acceSBarry Smith }
27109b94acceSBarry Smith 
27119b94acceSBarry Smith /* --------- Internal routines for SNES Package --------- */
27129b94acceSBarry Smith 
27134a2ae208SSatish Balay #undef __FUNCT__
27144a2ae208SSatish Balay #define __FUNCT__ "SNESSetType"
271582bf6240SBarry Smith /*@C
27164b0e389bSBarry Smith    SNESSetType - Sets the method for the nonlinear solver.
27179b94acceSBarry Smith 
2718fee21e36SBarry Smith    Collective on SNES
2719fee21e36SBarry Smith 
2720c7afd0dbSLois Curfman McInnes    Input Parameters:
2721c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2722454a90a3SBarry Smith -  type - a known method
2723c7afd0dbSLois Curfman McInnes 
2724c7afd0dbSLois Curfman McInnes    Options Database Key:
2725454a90a3SBarry Smith .  -snes_type <type> - Sets the method; use -help for a list
2726c7afd0dbSLois Curfman McInnes    of available methods (for instance, ls or tr)
2727ae12b187SLois Curfman McInnes 
27289b94acceSBarry Smith    Notes:
2729e090d566SSatish Balay    See "petsc/include/petscsnes.h" for available methods (for instance)
27304b27c08aSLois Curfman McInnes +    SNESLS - Newton's method with line search
2731c7afd0dbSLois Curfman McInnes      (systems of nonlinear equations)
27324b27c08aSLois Curfman McInnes .    SNESTR - Newton's method with trust region
2733c7afd0dbSLois Curfman McInnes      (systems of nonlinear equations)
27349b94acceSBarry Smith 
2735ae12b187SLois Curfman McInnes   Normally, it is best to use the SNESSetFromOptions() command and then
2736ae12b187SLois Curfman McInnes   set the SNES solver type from the options database rather than by using
2737ae12b187SLois Curfman McInnes   this routine.  Using the options database provides the user with
2738ae12b187SLois Curfman McInnes   maximum flexibility in evaluating the many nonlinear solvers.
2739ae12b187SLois Curfman McInnes   The SNESSetType() routine is provided for those situations where it
2740ae12b187SLois Curfman McInnes   is necessary to set the nonlinear solver independently of the command
2741ae12b187SLois Curfman McInnes   line or options database.  This might be the case, for example, when
2742ae12b187SLois Curfman McInnes   the choice of solver changes during the execution of the program,
2743ae12b187SLois Curfman McInnes   and the user's application is taking responsibility for choosing the
2744b0a32e0cSBarry Smith   appropriate method.
274536851e7fSLois Curfman McInnes 
274636851e7fSLois Curfman McInnes   Level: intermediate
2747a703fe33SLois Curfman McInnes 
2748454a90a3SBarry Smith .keywords: SNES, set, type
2749435da068SBarry Smith 
2750435da068SBarry Smith .seealso: SNESType, SNESCreate()
2751435da068SBarry Smith 
27529b94acceSBarry Smith @*/
27537087cfbeSBarry Smith PetscErrorCode  SNESSetType(SNES snes,const SNESType type)
27549b94acceSBarry Smith {
2755dfbe8321SBarry Smith   PetscErrorCode ierr,(*r)(SNES);
2756ace3abfcSBarry Smith   PetscBool      match;
27573a40ed3dSBarry Smith 
27583a40ed3dSBarry Smith   PetscFunctionBegin;
27590700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
27604482741eSBarry Smith   PetscValidCharPointer(type,2);
276182bf6240SBarry Smith 
27626831982aSBarry Smith   ierr = PetscTypeCompare((PetscObject)snes,type,&match);CHKERRQ(ierr);
27630f5bd95cSBarry Smith   if (match) PetscFunctionReturn(0);
276492ff6ae8SBarry Smith 
27654b91b6eaSBarry Smith   ierr =  PetscFListFind(SNESList,((PetscObject)snes)->comm,type,PETSC_TRUE,(void (**)(void)) &r);CHKERRQ(ierr);
2766e32f2f54SBarry Smith   if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested SNES type %s",type);
276775396ef9SLisandro Dalcin   /* Destroy the previous private SNES context */
276875396ef9SLisandro Dalcin   if (snes->ops->destroy) { ierr = (*(snes)->ops->destroy)(snes);CHKERRQ(ierr); }
276975396ef9SLisandro Dalcin   /* Reinitialize function pointers in SNESOps structure */
277075396ef9SLisandro Dalcin   snes->ops->setup          = 0;
277175396ef9SLisandro Dalcin   snes->ops->solve          = 0;
277275396ef9SLisandro Dalcin   snes->ops->view           = 0;
277375396ef9SLisandro Dalcin   snes->ops->setfromoptions = 0;
277475396ef9SLisandro Dalcin   snes->ops->destroy        = 0;
277575396ef9SLisandro Dalcin   /* Call the SNESCreate_XXX routine for this particular Nonlinear solver */
277675396ef9SLisandro Dalcin   snes->setupcalled = PETSC_FALSE;
2777454a90a3SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)snes,type);CHKERRQ(ierr);
277803bfa161SLisandro Dalcin   ierr = (*r)(snes);CHKERRQ(ierr);
27799fb22e1aSBarry Smith #if defined(PETSC_HAVE_AMS)
27809fb22e1aSBarry Smith   if (PetscAMSPublishAll) {
27819fb22e1aSBarry Smith     ierr = PetscObjectAMSPublish((PetscObject)snes);CHKERRQ(ierr);
27829fb22e1aSBarry Smith   }
27839fb22e1aSBarry Smith #endif
27843a40ed3dSBarry Smith   PetscFunctionReturn(0);
27859b94acceSBarry Smith }
27869b94acceSBarry Smith 
2787a847f771SSatish Balay 
27889b94acceSBarry Smith /* --------------------------------------------------------------------- */
27894a2ae208SSatish Balay #undef __FUNCT__
27904a2ae208SSatish Balay #define __FUNCT__ "SNESRegisterDestroy"
279152baeb72SSatish Balay /*@
27929b94acceSBarry Smith    SNESRegisterDestroy - Frees the list of nonlinear solvers that were
2793f1af5d2fSBarry Smith    registered by SNESRegisterDynamic().
27949b94acceSBarry Smith 
2795fee21e36SBarry Smith    Not Collective
2796fee21e36SBarry Smith 
279736851e7fSLois Curfman McInnes    Level: advanced
279836851e7fSLois Curfman McInnes 
27999b94acceSBarry Smith .keywords: SNES, nonlinear, register, destroy
28009b94acceSBarry Smith 
28019b94acceSBarry Smith .seealso: SNESRegisterAll(), SNESRegisterAll()
28029b94acceSBarry Smith @*/
28037087cfbeSBarry Smith PetscErrorCode  SNESRegisterDestroy(void)
28049b94acceSBarry Smith {
2805dfbe8321SBarry Smith   PetscErrorCode ierr;
280682bf6240SBarry Smith 
28073a40ed3dSBarry Smith   PetscFunctionBegin;
28081441b1d3SBarry Smith   ierr = PetscFListDestroy(&SNESList);CHKERRQ(ierr);
28094c49b128SBarry Smith   SNESRegisterAllCalled = PETSC_FALSE;
28103a40ed3dSBarry Smith   PetscFunctionReturn(0);
28119b94acceSBarry Smith }
28129b94acceSBarry Smith 
28134a2ae208SSatish Balay #undef __FUNCT__
28144a2ae208SSatish Balay #define __FUNCT__ "SNESGetType"
28159b94acceSBarry Smith /*@C
28169a28b0a6SLois Curfman McInnes    SNESGetType - Gets the SNES method type and name (as a string).
28179b94acceSBarry Smith 
2818c7afd0dbSLois Curfman McInnes    Not Collective
2819c7afd0dbSLois Curfman McInnes 
28209b94acceSBarry Smith    Input Parameter:
28214b0e389bSBarry Smith .  snes - nonlinear solver context
28229b94acceSBarry Smith 
28239b94acceSBarry Smith    Output Parameter:
28243a7fca6bSBarry Smith .  type - SNES method (a character string)
28259b94acceSBarry Smith 
282636851e7fSLois Curfman McInnes    Level: intermediate
282736851e7fSLois Curfman McInnes 
2828454a90a3SBarry Smith .keywords: SNES, nonlinear, get, type, name
28299b94acceSBarry Smith @*/
28307087cfbeSBarry Smith PetscErrorCode  SNESGetType(SNES snes,const SNESType *type)
28319b94acceSBarry Smith {
28323a40ed3dSBarry Smith   PetscFunctionBegin;
28330700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
28344482741eSBarry Smith   PetscValidPointer(type,2);
28357adad957SLisandro Dalcin   *type = ((PetscObject)snes)->type_name;
28363a40ed3dSBarry Smith   PetscFunctionReturn(0);
28379b94acceSBarry Smith }
28389b94acceSBarry Smith 
28394a2ae208SSatish Balay #undef __FUNCT__
28404a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolution"
284152baeb72SSatish Balay /*@
28429b94acceSBarry Smith    SNESGetSolution - Returns the vector where the approximate solution is
28439b94acceSBarry Smith    stored.
28449b94acceSBarry Smith 
2845c7afd0dbSLois Curfman McInnes    Not Collective, but Vec is parallel if SNES is parallel
2846c7afd0dbSLois Curfman McInnes 
28479b94acceSBarry Smith    Input Parameter:
28489b94acceSBarry Smith .  snes - the SNES context
28499b94acceSBarry Smith 
28509b94acceSBarry Smith    Output Parameter:
28519b94acceSBarry Smith .  x - the solution
28529b94acceSBarry Smith 
285370e92668SMatthew Knepley    Level: intermediate
285436851e7fSLois Curfman McInnes 
28559b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution
28569b94acceSBarry Smith 
285785385478SLisandro Dalcin .seealso:  SNESGetSolutionUpdate(), SNESGetFunction()
28589b94acceSBarry Smith @*/
28597087cfbeSBarry Smith PetscErrorCode  SNESGetSolution(SNES snes,Vec *x)
28609b94acceSBarry Smith {
28613a40ed3dSBarry Smith   PetscFunctionBegin;
28620700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
28634482741eSBarry Smith   PetscValidPointer(x,2);
286485385478SLisandro Dalcin   *x = snes->vec_sol;
286570e92668SMatthew Knepley   PetscFunctionReturn(0);
286670e92668SMatthew Knepley }
286770e92668SMatthew Knepley 
286870e92668SMatthew Knepley #undef __FUNCT__
28694a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolutionUpdate"
287052baeb72SSatish Balay /*@
28719b94acceSBarry Smith    SNESGetSolutionUpdate - Returns the vector where the solution update is
28729b94acceSBarry Smith    stored.
28739b94acceSBarry Smith 
2874c7afd0dbSLois Curfman McInnes    Not Collective, but Vec is parallel if SNES is parallel
2875c7afd0dbSLois Curfman McInnes 
28769b94acceSBarry Smith    Input Parameter:
28779b94acceSBarry Smith .  snes - the SNES context
28789b94acceSBarry Smith 
28799b94acceSBarry Smith    Output Parameter:
28809b94acceSBarry Smith .  x - the solution update
28819b94acceSBarry Smith 
288236851e7fSLois Curfman McInnes    Level: advanced
288336851e7fSLois Curfman McInnes 
28849b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution, update
28859b94acceSBarry Smith 
288685385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction()
28879b94acceSBarry Smith @*/
28887087cfbeSBarry Smith PetscErrorCode  SNESGetSolutionUpdate(SNES snes,Vec *x)
28899b94acceSBarry Smith {
28903a40ed3dSBarry Smith   PetscFunctionBegin;
28910700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
28924482741eSBarry Smith   PetscValidPointer(x,2);
289385385478SLisandro Dalcin   *x = snes->vec_sol_update;
28943a40ed3dSBarry Smith   PetscFunctionReturn(0);
28959b94acceSBarry Smith }
28969b94acceSBarry Smith 
28974a2ae208SSatish Balay #undef __FUNCT__
28984a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunction"
28999b94acceSBarry Smith /*@C
29003638b69dSLois Curfman McInnes    SNESGetFunction - Returns the vector where the function is stored.
29019b94acceSBarry Smith 
2902c7afd0dbSLois Curfman McInnes    Not Collective, but Vec is parallel if SNES is parallel
2903c7afd0dbSLois Curfman McInnes 
29049b94acceSBarry Smith    Input Parameter:
29059b94acceSBarry Smith .  snes - the SNES context
29069b94acceSBarry Smith 
29079b94acceSBarry Smith    Output Parameter:
29087bf4e008SBarry Smith +  r - the function (or PETSC_NULL)
290970e92668SMatthew Knepley .  func - the function (or PETSC_NULL)
291070e92668SMatthew Knepley -  ctx - the function context (or PETSC_NULL)
29119b94acceSBarry Smith 
291236851e7fSLois Curfman McInnes    Level: advanced
291336851e7fSLois Curfman McInnes 
2914a86d99e1SLois Curfman McInnes .keywords: SNES, nonlinear, get, function
29159b94acceSBarry Smith 
29164b27c08aSLois Curfman McInnes .seealso: SNESSetFunction(), SNESGetSolution()
29179b94acceSBarry Smith @*/
29187087cfbeSBarry Smith PetscErrorCode  SNESGetFunction(SNES snes,Vec *r,PetscErrorCode (**func)(SNES,Vec,Vec,void*),void **ctx)
29199b94acceSBarry Smith {
29203a40ed3dSBarry Smith   PetscFunctionBegin;
29210700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
292285385478SLisandro Dalcin   if (r)    *r    = snes->vec_func;
2923e7788613SBarry Smith   if (func) *func = snes->ops->computefunction;
292470e92668SMatthew Knepley   if (ctx)  *ctx  = snes->funP;
29253a40ed3dSBarry Smith   PetscFunctionReturn(0);
29269b94acceSBarry Smith }
29279b94acceSBarry Smith 
29284a2ae208SSatish Balay #undef __FUNCT__
29294a2ae208SSatish Balay #define __FUNCT__ "SNESSetOptionsPrefix"
29303c7409f5SSatish Balay /*@C
29313c7409f5SSatish Balay    SNESSetOptionsPrefix - Sets the prefix used for searching for all
2932d850072dSLois Curfman McInnes    SNES options in the database.
29333c7409f5SSatish Balay 
29343f9fe445SBarry Smith    Logically Collective on SNES
2935fee21e36SBarry Smith 
2936c7afd0dbSLois Curfman McInnes    Input Parameter:
2937c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2938c7afd0dbSLois Curfman McInnes -  prefix - the prefix to prepend to all option names
2939c7afd0dbSLois Curfman McInnes 
2940d850072dSLois Curfman McInnes    Notes:
2941a83b1b31SSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
2942c7afd0dbSLois Curfman McInnes    The first character of all runtime options is AUTOMATICALLY the hyphen.
2943d850072dSLois Curfman McInnes 
294436851e7fSLois Curfman McInnes    Level: advanced
294536851e7fSLois Curfman McInnes 
29463c7409f5SSatish Balay .keywords: SNES, set, options, prefix, database
2947a86d99e1SLois Curfman McInnes 
2948a86d99e1SLois Curfman McInnes .seealso: SNESSetFromOptions()
29493c7409f5SSatish Balay @*/
29507087cfbeSBarry Smith PetscErrorCode  SNESSetOptionsPrefix(SNES snes,const char prefix[])
29513c7409f5SSatish Balay {
2952dfbe8321SBarry Smith   PetscErrorCode ierr;
29533c7409f5SSatish Balay 
29543a40ed3dSBarry Smith   PetscFunctionBegin;
29550700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2956639f9d9dSBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
29571cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
295894b7f48cSBarry Smith   ierr = KSPSetOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr);
29593a40ed3dSBarry Smith   PetscFunctionReturn(0);
29603c7409f5SSatish Balay }
29613c7409f5SSatish Balay 
29624a2ae208SSatish Balay #undef __FUNCT__
29634a2ae208SSatish Balay #define __FUNCT__ "SNESAppendOptionsPrefix"
29643c7409f5SSatish Balay /*@C
2965f525115eSLois Curfman McInnes    SNESAppendOptionsPrefix - Appends to the prefix used for searching for all
2966d850072dSLois Curfman McInnes    SNES options in the database.
29673c7409f5SSatish Balay 
29683f9fe445SBarry Smith    Logically Collective on SNES
2969fee21e36SBarry Smith 
2970c7afd0dbSLois Curfman McInnes    Input Parameters:
2971c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2972c7afd0dbSLois Curfman McInnes -  prefix - the prefix to prepend to all option names
2973c7afd0dbSLois Curfman McInnes 
2974d850072dSLois Curfman McInnes    Notes:
2975a83b1b31SSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
2976c7afd0dbSLois Curfman McInnes    The first character of all runtime options is AUTOMATICALLY the hyphen.
2977d850072dSLois Curfman McInnes 
297836851e7fSLois Curfman McInnes    Level: advanced
297936851e7fSLois Curfman McInnes 
29803c7409f5SSatish Balay .keywords: SNES, append, options, prefix, database
2981a86d99e1SLois Curfman McInnes 
2982a86d99e1SLois Curfman McInnes .seealso: SNESGetOptionsPrefix()
29833c7409f5SSatish Balay @*/
29847087cfbeSBarry Smith PetscErrorCode  SNESAppendOptionsPrefix(SNES snes,const char prefix[])
29853c7409f5SSatish Balay {
2986dfbe8321SBarry Smith   PetscErrorCode ierr;
29873c7409f5SSatish Balay 
29883a40ed3dSBarry Smith   PetscFunctionBegin;
29890700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2990639f9d9dSBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
29911cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
299294b7f48cSBarry Smith   ierr = KSPAppendOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr);
29933a40ed3dSBarry Smith   PetscFunctionReturn(0);
29943c7409f5SSatish Balay }
29953c7409f5SSatish Balay 
29964a2ae208SSatish Balay #undef __FUNCT__
29974a2ae208SSatish Balay #define __FUNCT__ "SNESGetOptionsPrefix"
29989ab63eb5SSatish Balay /*@C
29993c7409f5SSatish Balay    SNESGetOptionsPrefix - Sets the prefix used for searching for all
30003c7409f5SSatish Balay    SNES options in the database.
30013c7409f5SSatish Balay 
3002c7afd0dbSLois Curfman McInnes    Not Collective
3003c7afd0dbSLois Curfman McInnes 
30043c7409f5SSatish Balay    Input Parameter:
30053c7409f5SSatish Balay .  snes - the SNES context
30063c7409f5SSatish Balay 
30073c7409f5SSatish Balay    Output Parameter:
30083c7409f5SSatish Balay .  prefix - pointer to the prefix string used
30093c7409f5SSatish Balay 
30104ef407dbSRichard Tran Mills    Notes: On the fortran side, the user should pass in a string 'prefix' of
30119ab63eb5SSatish Balay    sufficient length to hold the prefix.
30129ab63eb5SSatish Balay 
301336851e7fSLois Curfman McInnes    Level: advanced
301436851e7fSLois Curfman McInnes 
30153c7409f5SSatish Balay .keywords: SNES, get, options, prefix, database
3016a86d99e1SLois Curfman McInnes 
3017a86d99e1SLois Curfman McInnes .seealso: SNESAppendOptionsPrefix()
30183c7409f5SSatish Balay @*/
30197087cfbeSBarry Smith PetscErrorCode  SNESGetOptionsPrefix(SNES snes,const char *prefix[])
30203c7409f5SSatish Balay {
3021dfbe8321SBarry Smith   PetscErrorCode ierr;
30223c7409f5SSatish Balay 
30233a40ed3dSBarry Smith   PetscFunctionBegin;
30240700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3025639f9d9dSBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
30263a40ed3dSBarry Smith   PetscFunctionReturn(0);
30273c7409f5SSatish Balay }
30283c7409f5SSatish Balay 
3029b2002411SLois Curfman McInnes 
30304a2ae208SSatish Balay #undef __FUNCT__
30314a2ae208SSatish Balay #define __FUNCT__ "SNESRegister"
30323cea93caSBarry Smith /*@C
30333cea93caSBarry Smith   SNESRegister - See SNESRegisterDynamic()
30343cea93caSBarry Smith 
30357f6c08e0SMatthew Knepley   Level: advanced
30363cea93caSBarry Smith @*/
30377087cfbeSBarry Smith PetscErrorCode  SNESRegister(const char sname[],const char path[],const char name[],PetscErrorCode (*function)(SNES))
3038b2002411SLois Curfman McInnes {
3039e2d1d2b7SBarry Smith   char           fullname[PETSC_MAX_PATH_LEN];
3040dfbe8321SBarry Smith   PetscErrorCode ierr;
3041b2002411SLois Curfman McInnes 
3042b2002411SLois Curfman McInnes   PetscFunctionBegin;
3043b0a32e0cSBarry Smith   ierr = PetscFListConcat(path,name,fullname);CHKERRQ(ierr);
3044c134de8dSSatish Balay   ierr = PetscFListAdd(&SNESList,sname,fullname,(void (*)(void))function);CHKERRQ(ierr);
3045b2002411SLois Curfman McInnes   PetscFunctionReturn(0);
3046b2002411SLois Curfman McInnes }
3047da9b6338SBarry Smith 
3048da9b6338SBarry Smith #undef __FUNCT__
3049da9b6338SBarry Smith #define __FUNCT__ "SNESTestLocalMin"
30507087cfbeSBarry Smith PetscErrorCode  SNESTestLocalMin(SNES snes)
3051da9b6338SBarry Smith {
3052dfbe8321SBarry Smith   PetscErrorCode ierr;
305377431f27SBarry Smith   PetscInt       N,i,j;
3054da9b6338SBarry Smith   Vec            u,uh,fh;
3055da9b6338SBarry Smith   PetscScalar    value;
3056da9b6338SBarry Smith   PetscReal      norm;
3057da9b6338SBarry Smith 
3058da9b6338SBarry Smith   PetscFunctionBegin;
3059da9b6338SBarry Smith   ierr = SNESGetSolution(snes,&u);CHKERRQ(ierr);
3060da9b6338SBarry Smith   ierr = VecDuplicate(u,&uh);CHKERRQ(ierr);
3061da9b6338SBarry Smith   ierr = VecDuplicate(u,&fh);CHKERRQ(ierr);
3062da9b6338SBarry Smith 
3063da9b6338SBarry Smith   /* currently only works for sequential */
3064da9b6338SBarry Smith   ierr = PetscPrintf(PETSC_COMM_WORLD,"Testing FormFunction() for local min\n");
3065da9b6338SBarry Smith   ierr = VecGetSize(u,&N);CHKERRQ(ierr);
3066da9b6338SBarry Smith   for (i=0; i<N; i++) {
3067da9b6338SBarry Smith     ierr = VecCopy(u,uh);CHKERRQ(ierr);
306877431f27SBarry Smith     ierr  = PetscPrintf(PETSC_COMM_WORLD,"i = %D\n",i);CHKERRQ(ierr);
3069da9b6338SBarry Smith     for (j=-10; j<11; j++) {
3070ccae9161SBarry Smith       value = PetscSign(j)*exp(PetscAbs(j)-10.0);
3071da9b6338SBarry Smith       ierr  = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr);
30723ab0aad5SBarry Smith       ierr  = SNESComputeFunction(snes,uh,fh);CHKERRQ(ierr);
3073da9b6338SBarry Smith       ierr  = VecNorm(fh,NORM_2,&norm);CHKERRQ(ierr);
307477431f27SBarry Smith       ierr  = PetscPrintf(PETSC_COMM_WORLD,"       j norm %D %18.16e\n",j,norm);CHKERRQ(ierr);
3075da9b6338SBarry Smith       value = -value;
3076da9b6338SBarry Smith       ierr  = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr);
3077da9b6338SBarry Smith     }
3078da9b6338SBarry Smith   }
30796bf464f9SBarry Smith   ierr = VecDestroy(&uh);CHKERRQ(ierr);
30806bf464f9SBarry Smith   ierr = VecDestroy(&fh);CHKERRQ(ierr);
3081da9b6338SBarry Smith   PetscFunctionReturn(0);
3082da9b6338SBarry Smith }
308371f87433Sdalcinl 
308471f87433Sdalcinl #undef __FUNCT__
3085fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetUseEW"
308671f87433Sdalcinl /*@
3087fa9f3622SBarry Smith    SNESKSPSetUseEW - Sets SNES use Eisenstat-Walker method for
308871f87433Sdalcinl    computing relative tolerance for linear solvers within an inexact
308971f87433Sdalcinl    Newton method.
309071f87433Sdalcinl 
30913f9fe445SBarry Smith    Logically Collective on SNES
309271f87433Sdalcinl 
309371f87433Sdalcinl    Input Parameters:
309471f87433Sdalcinl +  snes - SNES context
309571f87433Sdalcinl -  flag - PETSC_TRUE or PETSC_FALSE
309671f87433Sdalcinl 
309764ba62caSBarry Smith     Options Database:
309864ba62caSBarry Smith +  -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence
309964ba62caSBarry Smith .  -snes_ksp_ew_version ver - version of  Eisenstat-Walker method
310064ba62caSBarry Smith .  -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0
310164ba62caSBarry Smith .  -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax
310264ba62caSBarry Smith .  -snes_ksp_ew_gamma <gamma> - Sets gamma
310364ba62caSBarry Smith .  -snes_ksp_ew_alpha <alpha> - Sets alpha
310464ba62caSBarry Smith .  -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2
310564ba62caSBarry Smith -  -snes_ksp_ew_threshold <threshold> - Sets threshold
310664ba62caSBarry Smith 
310771f87433Sdalcinl    Notes:
310871f87433Sdalcinl    Currently, the default is to use a constant relative tolerance for
310971f87433Sdalcinl    the inner linear solvers.  Alternatively, one can use the
311071f87433Sdalcinl    Eisenstat-Walker method, where the relative convergence tolerance
311171f87433Sdalcinl    is reset at each Newton iteration according progress of the nonlinear
311271f87433Sdalcinl    solver.
311371f87433Sdalcinl 
311471f87433Sdalcinl    Level: advanced
311571f87433Sdalcinl 
311671f87433Sdalcinl    Reference:
311771f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
311871f87433Sdalcinl    inexact Newton method", SISC 17 (1), pp.16-32, 1996.
311971f87433Sdalcinl 
312071f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton
312171f87433Sdalcinl 
3122fa9f3622SBarry Smith .seealso: SNESKSPGetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW()
312371f87433Sdalcinl @*/
31247087cfbeSBarry Smith PetscErrorCode  SNESKSPSetUseEW(SNES snes,PetscBool  flag)
312571f87433Sdalcinl {
312671f87433Sdalcinl   PetscFunctionBegin;
31270700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3128acfcf0e5SJed Brown   PetscValidLogicalCollectiveBool(snes,flag,2);
312971f87433Sdalcinl   snes->ksp_ewconv = flag;
313071f87433Sdalcinl   PetscFunctionReturn(0);
313171f87433Sdalcinl }
313271f87433Sdalcinl 
313371f87433Sdalcinl #undef __FUNCT__
3134fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetUseEW"
313571f87433Sdalcinl /*@
3136fa9f3622SBarry Smith    SNESKSPGetUseEW - Gets if SNES is using Eisenstat-Walker method
313771f87433Sdalcinl    for computing relative tolerance for linear solvers within an
313871f87433Sdalcinl    inexact Newton method.
313971f87433Sdalcinl 
314071f87433Sdalcinl    Not Collective
314171f87433Sdalcinl 
314271f87433Sdalcinl    Input Parameter:
314371f87433Sdalcinl .  snes - SNES context
314471f87433Sdalcinl 
314571f87433Sdalcinl    Output Parameter:
314671f87433Sdalcinl .  flag - PETSC_TRUE or PETSC_FALSE
314771f87433Sdalcinl 
314871f87433Sdalcinl    Notes:
314971f87433Sdalcinl    Currently, the default is to use a constant relative tolerance for
315071f87433Sdalcinl    the inner linear solvers.  Alternatively, one can use the
315171f87433Sdalcinl    Eisenstat-Walker method, where the relative convergence tolerance
315271f87433Sdalcinl    is reset at each Newton iteration according progress of the nonlinear
315371f87433Sdalcinl    solver.
315471f87433Sdalcinl 
315571f87433Sdalcinl    Level: advanced
315671f87433Sdalcinl 
315771f87433Sdalcinl    Reference:
315871f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
315971f87433Sdalcinl    inexact Newton method", SISC 17 (1), pp.16-32, 1996.
316071f87433Sdalcinl 
316171f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton
316271f87433Sdalcinl 
3163fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW()
316471f87433Sdalcinl @*/
31657087cfbeSBarry Smith PetscErrorCode  SNESKSPGetUseEW(SNES snes, PetscBool  *flag)
316671f87433Sdalcinl {
316771f87433Sdalcinl   PetscFunctionBegin;
31680700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
316971f87433Sdalcinl   PetscValidPointer(flag,2);
317071f87433Sdalcinl   *flag = snes->ksp_ewconv;
317171f87433Sdalcinl   PetscFunctionReturn(0);
317271f87433Sdalcinl }
317371f87433Sdalcinl 
317471f87433Sdalcinl #undef __FUNCT__
3175fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetParametersEW"
317671f87433Sdalcinl /*@
3177fa9f3622SBarry Smith    SNESKSPSetParametersEW - Sets parameters for Eisenstat-Walker
317871f87433Sdalcinl    convergence criteria for the linear solvers within an inexact
317971f87433Sdalcinl    Newton method.
318071f87433Sdalcinl 
31813f9fe445SBarry Smith    Logically Collective on SNES
318271f87433Sdalcinl 
318371f87433Sdalcinl    Input Parameters:
318471f87433Sdalcinl +    snes - SNES context
318571f87433Sdalcinl .    version - version 1, 2 (default is 2) or 3
318671f87433Sdalcinl .    rtol_0 - initial relative tolerance (0 <= rtol_0 < 1)
318771f87433Sdalcinl .    rtol_max - maximum relative tolerance (0 <= rtol_max < 1)
318871f87433Sdalcinl .    gamma - multiplicative factor for version 2 rtol computation
318971f87433Sdalcinl              (0 <= gamma2 <= 1)
319071f87433Sdalcinl .    alpha - power for version 2 rtol computation (1 < alpha <= 2)
319171f87433Sdalcinl .    alpha2 - power for safeguard
319271f87433Sdalcinl -    threshold - threshold for imposing safeguard (0 < threshold < 1)
319371f87433Sdalcinl 
319471f87433Sdalcinl    Note:
319571f87433Sdalcinl    Version 3 was contributed by Luis Chacon, June 2006.
319671f87433Sdalcinl 
319771f87433Sdalcinl    Use PETSC_DEFAULT to retain the default for any of the parameters.
319871f87433Sdalcinl 
319971f87433Sdalcinl    Level: advanced
320071f87433Sdalcinl 
320171f87433Sdalcinl    Reference:
320271f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
320371f87433Sdalcinl    inexact Newton method", Utah State University Math. Stat. Dept. Res.
320471f87433Sdalcinl    Report 6/94/75, June, 1994, to appear in SIAM J. Sci. Comput.
320571f87433Sdalcinl 
320671f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, set, parameters
320771f87433Sdalcinl 
3208fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPGetParametersEW()
320971f87433Sdalcinl @*/
32107087cfbeSBarry Smith PetscErrorCode  SNESKSPSetParametersEW(SNES snes,PetscInt version,PetscReal rtol_0,PetscReal rtol_max,
321171f87433Sdalcinl 							    PetscReal gamma,PetscReal alpha,PetscReal alpha2,PetscReal threshold)
321271f87433Sdalcinl {
3213fa9f3622SBarry Smith   SNESKSPEW *kctx;
321471f87433Sdalcinl   PetscFunctionBegin;
32150700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3216fa9f3622SBarry Smith   kctx = (SNESKSPEW*)snes->kspconvctx;
3217e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing");
3218c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,version,2);
3219c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol_0,3);
3220c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol_max,4);
3221c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,gamma,5);
3222c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,alpha,6);
3223c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,alpha2,7);
3224c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,threshold,8);
322571f87433Sdalcinl 
322671f87433Sdalcinl   if (version != PETSC_DEFAULT)   kctx->version   = version;
322771f87433Sdalcinl   if (rtol_0 != PETSC_DEFAULT)    kctx->rtol_0    = rtol_0;
322871f87433Sdalcinl   if (rtol_max != PETSC_DEFAULT)  kctx->rtol_max  = rtol_max;
322971f87433Sdalcinl   if (gamma != PETSC_DEFAULT)     kctx->gamma     = gamma;
323071f87433Sdalcinl   if (alpha != PETSC_DEFAULT)     kctx->alpha     = alpha;
323171f87433Sdalcinl   if (alpha2 != PETSC_DEFAULT)    kctx->alpha2    = alpha2;
323271f87433Sdalcinl   if (threshold != PETSC_DEFAULT) kctx->threshold = threshold;
323371f87433Sdalcinl 
323471f87433Sdalcinl   if (kctx->version < 1 || kctx->version > 3) {
3235e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 and 3 are supported: %D",kctx->version);
323671f87433Sdalcinl   }
323771f87433Sdalcinl   if (kctx->rtol_0 < 0.0 || kctx->rtol_0 >= 1.0) {
3238e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_0 < 1.0: %G",kctx->rtol_0);
323971f87433Sdalcinl   }
324071f87433Sdalcinl   if (kctx->rtol_max < 0.0 || kctx->rtol_max >= 1.0) {
3241e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_max (%G) < 1.0\n",kctx->rtol_max);
324271f87433Sdalcinl   }
324371f87433Sdalcinl   if (kctx->gamma < 0.0 || kctx->gamma > 1.0) {
3244e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= gamma (%G) <= 1.0\n",kctx->gamma);
324571f87433Sdalcinl   }
324671f87433Sdalcinl   if (kctx->alpha <= 1.0 || kctx->alpha > 2.0) {
3247e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"1.0 < alpha (%G) <= 2.0\n",kctx->alpha);
324871f87433Sdalcinl   }
324971f87433Sdalcinl   if (kctx->threshold <= 0.0 || kctx->threshold >= 1.0) {
3250e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 < threshold (%G) < 1.0\n",kctx->threshold);
325171f87433Sdalcinl   }
325271f87433Sdalcinl   PetscFunctionReturn(0);
325371f87433Sdalcinl }
325471f87433Sdalcinl 
325571f87433Sdalcinl #undef __FUNCT__
3256fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetParametersEW"
325771f87433Sdalcinl /*@
3258fa9f3622SBarry Smith    SNESKSPGetParametersEW - Gets parameters for Eisenstat-Walker
325971f87433Sdalcinl    convergence criteria for the linear solvers within an inexact
326071f87433Sdalcinl    Newton method.
326171f87433Sdalcinl 
326271f87433Sdalcinl    Not Collective
326371f87433Sdalcinl 
326471f87433Sdalcinl    Input Parameters:
326571f87433Sdalcinl      snes - SNES context
326671f87433Sdalcinl 
326771f87433Sdalcinl    Output Parameters:
326871f87433Sdalcinl +    version - version 1, 2 (default is 2) or 3
326971f87433Sdalcinl .    rtol_0 - initial relative tolerance (0 <= rtol_0 < 1)
327071f87433Sdalcinl .    rtol_max - maximum relative tolerance (0 <= rtol_max < 1)
327171f87433Sdalcinl .    gamma - multiplicative factor for version 2 rtol computation
327271f87433Sdalcinl              (0 <= gamma2 <= 1)
327371f87433Sdalcinl .    alpha - power for version 2 rtol computation (1 < alpha <= 2)
327471f87433Sdalcinl .    alpha2 - power for safeguard
327571f87433Sdalcinl -    threshold - threshold for imposing safeguard (0 < threshold < 1)
327671f87433Sdalcinl 
327771f87433Sdalcinl    Level: advanced
327871f87433Sdalcinl 
327971f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, get, parameters
328071f87433Sdalcinl 
3281fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPSetParametersEW()
328271f87433Sdalcinl @*/
32837087cfbeSBarry Smith PetscErrorCode  SNESKSPGetParametersEW(SNES snes,PetscInt *version,PetscReal *rtol_0,PetscReal *rtol_max,
328471f87433Sdalcinl 							    PetscReal *gamma,PetscReal *alpha,PetscReal *alpha2,PetscReal *threshold)
328571f87433Sdalcinl {
3286fa9f3622SBarry Smith   SNESKSPEW *kctx;
328771f87433Sdalcinl   PetscFunctionBegin;
32880700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3289fa9f3622SBarry Smith   kctx = (SNESKSPEW*)snes->kspconvctx;
3290e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing");
329171f87433Sdalcinl   if(version)   *version   = kctx->version;
329271f87433Sdalcinl   if(rtol_0)    *rtol_0    = kctx->rtol_0;
329371f87433Sdalcinl   if(rtol_max)  *rtol_max  = kctx->rtol_max;
329471f87433Sdalcinl   if(gamma)     *gamma     = kctx->gamma;
329571f87433Sdalcinl   if(alpha)     *alpha     = kctx->alpha;
329671f87433Sdalcinl   if(alpha2)    *alpha2    = kctx->alpha2;
329771f87433Sdalcinl   if(threshold) *threshold = kctx->threshold;
329871f87433Sdalcinl   PetscFunctionReturn(0);
329971f87433Sdalcinl }
330071f87433Sdalcinl 
330171f87433Sdalcinl #undef __FUNCT__
3302fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PreSolve"
3303fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PreSolve(SNES snes, KSP ksp, Vec b, Vec x)
330471f87433Sdalcinl {
330571f87433Sdalcinl   PetscErrorCode ierr;
3306fa9f3622SBarry Smith   SNESKSPEW      *kctx = (SNESKSPEW*)snes->kspconvctx;
330771f87433Sdalcinl   PetscReal      rtol=PETSC_DEFAULT,stol;
330871f87433Sdalcinl 
330971f87433Sdalcinl   PetscFunctionBegin;
3310e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists");
331171f87433Sdalcinl   if (!snes->iter) { /* first time in, so use the original user rtol */
331271f87433Sdalcinl     rtol = kctx->rtol_0;
331371f87433Sdalcinl   } else {
331471f87433Sdalcinl     if (kctx->version == 1) {
331571f87433Sdalcinl       rtol = (snes->norm - kctx->lresid_last)/kctx->norm_last;
331671f87433Sdalcinl       if (rtol < 0.0) rtol = -rtol;
331771f87433Sdalcinl       stol = pow(kctx->rtol_last,kctx->alpha2);
331871f87433Sdalcinl       if (stol > kctx->threshold) rtol = PetscMax(rtol,stol);
331971f87433Sdalcinl     } else if (kctx->version == 2) {
332071f87433Sdalcinl       rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha);
332171f87433Sdalcinl       stol = kctx->gamma * pow(kctx->rtol_last,kctx->alpha);
332271f87433Sdalcinl       if (stol > kctx->threshold) rtol = PetscMax(rtol,stol);
332371f87433Sdalcinl     } else if (kctx->version == 3) {/* contributed by Luis Chacon, June 2006. */
332471f87433Sdalcinl       rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha);
332571f87433Sdalcinl       /* safeguard: avoid sharp decrease of rtol */
332671f87433Sdalcinl       stol = kctx->gamma*pow(kctx->rtol_last,kctx->alpha);
332771f87433Sdalcinl       stol = PetscMax(rtol,stol);
332871f87433Sdalcinl       rtol = PetscMin(kctx->rtol_0,stol);
332971f87433Sdalcinl       /* safeguard: avoid oversolving */
333071f87433Sdalcinl       stol = kctx->gamma*(snes->ttol)/snes->norm;
333171f87433Sdalcinl       stol = PetscMax(rtol,stol);
333271f87433Sdalcinl       rtol = PetscMin(kctx->rtol_0,stol);
3333e32f2f54SBarry Smith     } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 or 3 are supported: %D",kctx->version);
333471f87433Sdalcinl   }
333571f87433Sdalcinl   /* safeguard: avoid rtol greater than one */
333671f87433Sdalcinl   rtol = PetscMin(rtol,kctx->rtol_max);
333771f87433Sdalcinl   ierr = KSPSetTolerances(ksp,rtol,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT);CHKERRQ(ierr);
333871f87433Sdalcinl   ierr = PetscInfo3(snes,"iter %D, Eisenstat-Walker (version %D) KSP rtol=%G\n",snes->iter,kctx->version,rtol);CHKERRQ(ierr);
333971f87433Sdalcinl   PetscFunctionReturn(0);
334071f87433Sdalcinl }
334171f87433Sdalcinl 
334271f87433Sdalcinl #undef __FUNCT__
3343fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PostSolve"
3344fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PostSolve(SNES snes, KSP ksp, Vec b, Vec x)
334571f87433Sdalcinl {
334671f87433Sdalcinl   PetscErrorCode ierr;
3347fa9f3622SBarry Smith   SNESKSPEW      *kctx = (SNESKSPEW*)snes->kspconvctx;
334871f87433Sdalcinl   PCSide         pcside;
334971f87433Sdalcinl   Vec            lres;
335071f87433Sdalcinl 
335171f87433Sdalcinl   PetscFunctionBegin;
3352e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists");
335371f87433Sdalcinl   ierr = KSPGetTolerances(ksp,&kctx->rtol_last,0,0,0);CHKERRQ(ierr);
335471f87433Sdalcinl   ierr = SNESGetFunctionNorm(snes,&kctx->norm_last);CHKERRQ(ierr);
335571f87433Sdalcinl   if (kctx->version == 1) {
3356b037da10SBarry Smith     ierr = KSPGetPCSide(ksp,&pcside);CHKERRQ(ierr);
335771f87433Sdalcinl     if (pcside == PC_RIGHT) { /* XXX Should we also test KSP_UNPRECONDITIONED_NORM ? */
335871f87433Sdalcinl       /* KSP residual is true linear residual */
335971f87433Sdalcinl       ierr = KSPGetResidualNorm(ksp,&kctx->lresid_last);CHKERRQ(ierr);
336071f87433Sdalcinl     } else {
336171f87433Sdalcinl       /* KSP residual is preconditioned residual */
336271f87433Sdalcinl       /* compute true linear residual norm */
336371f87433Sdalcinl       ierr = VecDuplicate(b,&lres);CHKERRQ(ierr);
336471f87433Sdalcinl       ierr = MatMult(snes->jacobian,x,lres);CHKERRQ(ierr);
336571f87433Sdalcinl       ierr = VecAYPX(lres,-1.0,b);CHKERRQ(ierr);
336671f87433Sdalcinl       ierr = VecNorm(lres,NORM_2,&kctx->lresid_last);CHKERRQ(ierr);
33676bf464f9SBarry Smith       ierr = VecDestroy(&lres);CHKERRQ(ierr);
336871f87433Sdalcinl     }
336971f87433Sdalcinl   }
337071f87433Sdalcinl   PetscFunctionReturn(0);
337171f87433Sdalcinl }
337271f87433Sdalcinl 
337371f87433Sdalcinl #undef __FUNCT__
337471f87433Sdalcinl #define __FUNCT__ "SNES_KSPSolve"
337571f87433Sdalcinl PetscErrorCode SNES_KSPSolve(SNES snes, KSP ksp, Vec b, Vec x)
337671f87433Sdalcinl {
337771f87433Sdalcinl   PetscErrorCode ierr;
337871f87433Sdalcinl 
337971f87433Sdalcinl   PetscFunctionBegin;
3380fa9f3622SBarry Smith   if (snes->ksp_ewconv) { ierr = SNESKSPEW_PreSolve(snes,ksp,b,x);CHKERRQ(ierr);  }
338171f87433Sdalcinl   ierr = KSPSolve(ksp,b,x);CHKERRQ(ierr);
3382fa9f3622SBarry Smith   if (snes->ksp_ewconv) { ierr = SNESKSPEW_PostSolve(snes,ksp,b,x);CHKERRQ(ierr); }
338371f87433Sdalcinl   PetscFunctionReturn(0);
338471f87433Sdalcinl }
33856c699258SBarry Smith 
33866c699258SBarry Smith #undef __FUNCT__
33876c699258SBarry Smith #define __FUNCT__ "SNESSetDM"
33886c699258SBarry Smith /*@
33896c699258SBarry Smith    SNESSetDM - Sets the DM that may be used by some preconditioners
33906c699258SBarry Smith 
33913f9fe445SBarry Smith    Logically Collective on SNES
33926c699258SBarry Smith 
33936c699258SBarry Smith    Input Parameters:
33946c699258SBarry Smith +  snes - the preconditioner context
33956c699258SBarry Smith -  dm - the dm
33966c699258SBarry Smith 
33976c699258SBarry Smith    Level: intermediate
33986c699258SBarry Smith 
33996c699258SBarry Smith 
34006c699258SBarry Smith .seealso: SNESGetDM(), KSPSetDM(), KSPGetDM()
34016c699258SBarry Smith @*/
34027087cfbeSBarry Smith PetscErrorCode  SNESSetDM(SNES snes,DM dm)
34036c699258SBarry Smith {
34046c699258SBarry Smith   PetscErrorCode ierr;
3405345fed2cSBarry Smith   KSP            ksp;
34066c699258SBarry Smith 
34076c699258SBarry Smith   PetscFunctionBegin;
34080700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3409d0660788SBarry Smith   if (dm) {ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);}
34106bf464f9SBarry Smith   ierr = DMDestroy(&snes->dm);CHKERRQ(ierr);
34116c699258SBarry Smith   snes->dm = dm;
3412345fed2cSBarry Smith   ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
3413345fed2cSBarry Smith   ierr = KSPSetDM(ksp,dm);CHKERRQ(ierr);
3414f22f69f0SBarry Smith   ierr = KSPSetDMActive(ksp,PETSC_FALSE);CHKERRQ(ierr);
34156c699258SBarry Smith   PetscFunctionReturn(0);
34166c699258SBarry Smith }
34176c699258SBarry Smith 
34186c699258SBarry Smith #undef __FUNCT__
34196c699258SBarry Smith #define __FUNCT__ "SNESGetDM"
34206c699258SBarry Smith /*@
34216c699258SBarry Smith    SNESGetDM - Gets the DM that may be used by some preconditioners
34226c699258SBarry Smith 
34233f9fe445SBarry Smith    Not Collective but DM obtained is parallel on SNES
34246c699258SBarry Smith 
34256c699258SBarry Smith    Input Parameter:
34266c699258SBarry Smith . snes - the preconditioner context
34276c699258SBarry Smith 
34286c699258SBarry Smith    Output Parameter:
34296c699258SBarry Smith .  dm - the dm
34306c699258SBarry Smith 
34316c699258SBarry Smith    Level: intermediate
34326c699258SBarry Smith 
34336c699258SBarry Smith 
34346c699258SBarry Smith .seealso: SNESSetDM(), KSPSetDM(), KSPGetDM()
34356c699258SBarry Smith @*/
34367087cfbeSBarry Smith PetscErrorCode  SNESGetDM(SNES snes,DM *dm)
34376c699258SBarry Smith {
34386c699258SBarry Smith   PetscFunctionBegin;
34390700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
34406c699258SBarry Smith   *dm = snes->dm;
34416c699258SBarry Smith   PetscFunctionReturn(0);
34426c699258SBarry Smith }
34430807856dSBarry Smith 
344431823bd8SMatthew G Knepley #undef __FUNCT__
344531823bd8SMatthew G Knepley #define __FUNCT__ "SNESSetPC"
344631823bd8SMatthew G Knepley /*@
3447fd4b34e9SJed Brown   SNESSetPC - Sets the nonlinear preconditioner to be used.
344831823bd8SMatthew G Knepley 
344931823bd8SMatthew G Knepley   Collective on SNES
345031823bd8SMatthew G Knepley 
345131823bd8SMatthew G Knepley   Input Parameters:
345231823bd8SMatthew G Knepley + snes - iterative context obtained from SNESCreate()
345331823bd8SMatthew G Knepley - pc   - the preconditioner object
345431823bd8SMatthew G Knepley 
345531823bd8SMatthew G Knepley   Notes:
345631823bd8SMatthew G Knepley   Use SNESGetPC() to retrieve the preconditioner context (for example,
345731823bd8SMatthew G Knepley   to configure it using the API).
345831823bd8SMatthew G Knepley 
345931823bd8SMatthew G Knepley   Level: developer
346031823bd8SMatthew G Knepley 
346131823bd8SMatthew G Knepley .keywords: SNES, set, precondition
346231823bd8SMatthew G Knepley .seealso: SNESGetPC()
346331823bd8SMatthew G Knepley @*/
346431823bd8SMatthew G Knepley PetscErrorCode SNESSetPC(SNES snes, SNES pc)
346531823bd8SMatthew G Knepley {
346631823bd8SMatthew G Knepley   PetscErrorCode ierr;
346731823bd8SMatthew G Knepley 
346831823bd8SMatthew G Knepley   PetscFunctionBegin;
346931823bd8SMatthew G Knepley   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
347031823bd8SMatthew G Knepley   PetscValidHeaderSpecific(pc, SNES_CLASSID, 2);
347131823bd8SMatthew G Knepley   PetscCheckSameComm(snes, 1, pc, 2);
347231823bd8SMatthew G Knepley   ierr = PetscObjectReference((PetscObject) pc);CHKERRQ(ierr);
3473bf11d3b6SBarry Smith   ierr = SNESDestroy(&snes->pc);CHKERRQ(ierr);
347431823bd8SMatthew G Knepley   snes->pc = pc;
347531823bd8SMatthew G Knepley   ierr = PetscLogObjectParent(snes, snes->pc);CHKERRQ(ierr);
347631823bd8SMatthew G Knepley   PetscFunctionReturn(0);
347731823bd8SMatthew G Knepley }
347831823bd8SMatthew G Knepley 
347931823bd8SMatthew G Knepley #undef __FUNCT__
348031823bd8SMatthew G Knepley #define __FUNCT__ "SNESGetPC"
348131823bd8SMatthew G Knepley /*@
3482fd4b34e9SJed Brown   SNESGetPC - Returns a pointer to the nonlinear preconditioning context set with SNESSetPC().
348331823bd8SMatthew G Knepley 
348431823bd8SMatthew G Knepley   Not Collective
348531823bd8SMatthew G Knepley 
348631823bd8SMatthew G Knepley   Input Parameter:
348731823bd8SMatthew G Knepley . snes - iterative context obtained from SNESCreate()
348831823bd8SMatthew G Knepley 
348931823bd8SMatthew G Knepley   Output Parameter:
349031823bd8SMatthew G Knepley . pc - preconditioner context
349131823bd8SMatthew G Knepley 
349231823bd8SMatthew G Knepley   Level: developer
349331823bd8SMatthew G Knepley 
349431823bd8SMatthew G Knepley .keywords: SNES, get, preconditioner
349531823bd8SMatthew G Knepley .seealso: SNESSetPC()
349631823bd8SMatthew G Knepley @*/
349731823bd8SMatthew G Knepley PetscErrorCode SNESGetPC(SNES snes, SNES *pc)
349831823bd8SMatthew G Knepley {
349931823bd8SMatthew G Knepley   PetscErrorCode ierr;
350031823bd8SMatthew G Knepley 
350131823bd8SMatthew G Knepley   PetscFunctionBegin;
350231823bd8SMatthew G Knepley   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
350331823bd8SMatthew G Knepley   PetscValidPointer(pc, 2);
350431823bd8SMatthew G Knepley   if (!snes->pc) {
350531823bd8SMatthew G Knepley     ierr = SNESCreate(((PetscObject) snes)->comm, &snes->pc);CHKERRQ(ierr);
35064a0c5b0cSMatthew G Knepley     ierr = PetscObjectIncrementTabLevel((PetscObject) snes->pc, (PetscObject) snes, 1);CHKERRQ(ierr);
350731823bd8SMatthew G Knepley     ierr = PetscLogObjectParent(snes, snes->pc);CHKERRQ(ierr);
350831823bd8SMatthew G Knepley   }
350931823bd8SMatthew G Knepley   *pc = snes->pc;
351031823bd8SMatthew G Knepley   PetscFunctionReturn(0);
351131823bd8SMatthew G Knepley }
351231823bd8SMatthew G Knepley 
351369b4f73cSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
3514c6db04a5SJed Brown #include <mex.h>
351569b4f73cSBarry Smith 
35168f6e6473SBarry Smith typedef struct {char *funcname; mxArray *ctx;} SNESMatlabContext;
35178f6e6473SBarry Smith 
35180807856dSBarry Smith #undef __FUNCT__
35190807856dSBarry Smith #define __FUNCT__ "SNESComputeFunction_Matlab"
35200807856dSBarry Smith /*
35210807856dSBarry Smith    SNESComputeFunction_Matlab - Calls the function that has been set with
35220807856dSBarry Smith                          SNESSetFunctionMatlab().
35230807856dSBarry Smith 
35240807856dSBarry Smith    Collective on SNES
35250807856dSBarry Smith 
35260807856dSBarry Smith    Input Parameters:
35270807856dSBarry Smith +  snes - the SNES context
35280807856dSBarry Smith -  x - input vector
35290807856dSBarry Smith 
35300807856dSBarry Smith    Output Parameter:
35310807856dSBarry Smith .  y - function vector, as set by SNESSetFunction()
35320807856dSBarry Smith 
35330807856dSBarry Smith    Notes:
35340807856dSBarry Smith    SNESComputeFunction() is typically used within nonlinear solvers
35350807856dSBarry Smith    implementations, so most users would not generally call this routine
35360807856dSBarry Smith    themselves.
35370807856dSBarry Smith 
35380807856dSBarry Smith    Level: developer
35390807856dSBarry Smith 
35400807856dSBarry Smith .keywords: SNES, nonlinear, compute, function
35410807856dSBarry Smith 
35420807856dSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction()
354361b2408cSBarry Smith */
35447087cfbeSBarry Smith PetscErrorCode  SNESComputeFunction_Matlab(SNES snes,Vec x,Vec y, void *ctx)
35450807856dSBarry Smith {
3546e650e774SBarry Smith   PetscErrorCode    ierr;
35478f6e6473SBarry Smith   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
35488f6e6473SBarry Smith   int               nlhs = 1,nrhs = 5;
35498f6e6473SBarry Smith   mxArray	    *plhs[1],*prhs[5];
355091621f2eSBarry Smith   long long int     lx = 0,ly = 0,ls = 0;
3551e650e774SBarry Smith 
35520807856dSBarry Smith   PetscFunctionBegin;
35530807856dSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
35540807856dSBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
35550807856dSBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
35560807856dSBarry Smith   PetscCheckSameComm(snes,1,x,2);
35570807856dSBarry Smith   PetscCheckSameComm(snes,1,y,3);
35580807856dSBarry Smith 
35590807856dSBarry Smith   /* call Matlab function in ctx with arguments x and y */
3560e650e774SBarry Smith 
356191621f2eSBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
3562e650e774SBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
3563e650e774SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(x));CHKERRQ(ierr);
356491621f2eSBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
356591621f2eSBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)lx);
356691621f2eSBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)ly);
35678f6e6473SBarry Smith   prhs[3] =  mxCreateString(sctx->funcname);
35688f6e6473SBarry Smith   prhs[4] =  sctx->ctx;
3569b807a863SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeFunctionInternal");CHKERRQ(ierr);
3570e650e774SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
3571e650e774SBarry Smith   mxDestroyArray(prhs[0]);
3572e650e774SBarry Smith   mxDestroyArray(prhs[1]);
3573e650e774SBarry Smith   mxDestroyArray(prhs[2]);
35748f6e6473SBarry Smith   mxDestroyArray(prhs[3]);
3575e650e774SBarry Smith   mxDestroyArray(plhs[0]);
35760807856dSBarry Smith   PetscFunctionReturn(0);
35770807856dSBarry Smith }
35780807856dSBarry Smith 
35790807856dSBarry Smith 
35800807856dSBarry Smith #undef __FUNCT__
35810807856dSBarry Smith #define __FUNCT__ "SNESSetFunctionMatlab"
358261b2408cSBarry Smith /*
35830807856dSBarry Smith    SNESSetFunctionMatlab - Sets the function evaluation routine and function
35840807856dSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
3585e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
35860807856dSBarry Smith 
35870807856dSBarry Smith    Logically Collective on SNES
35880807856dSBarry Smith 
35890807856dSBarry Smith    Input Parameters:
35900807856dSBarry Smith +  snes - the SNES context
35910807856dSBarry Smith .  r - vector to store function value
35920807856dSBarry Smith -  func - function evaluation routine
35930807856dSBarry Smith 
35940807856dSBarry Smith    Calling sequence of func:
359561b2408cSBarry Smith $    func (SNES snes,Vec x,Vec f,void *ctx);
35960807856dSBarry Smith 
35970807856dSBarry Smith 
35980807856dSBarry Smith    Notes:
35990807856dSBarry Smith    The Newton-like methods typically solve linear systems of the form
36000807856dSBarry Smith $      f'(x) x = -f(x),
36010807856dSBarry Smith    where f'(x) denotes the Jacobian matrix and f(x) is the function.
36020807856dSBarry Smith 
36030807856dSBarry Smith    Level: beginner
36040807856dSBarry Smith 
36050807856dSBarry Smith .keywords: SNES, nonlinear, set, function
36060807856dSBarry Smith 
36070807856dSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
360861b2408cSBarry Smith */
36097087cfbeSBarry Smith PetscErrorCode  SNESSetFunctionMatlab(SNES snes,Vec r,const char *func,mxArray *ctx)
36100807856dSBarry Smith {
36110807856dSBarry Smith   PetscErrorCode    ierr;
36128f6e6473SBarry Smith   SNESMatlabContext *sctx;
36130807856dSBarry Smith 
36140807856dSBarry Smith   PetscFunctionBegin;
36158f6e6473SBarry Smith   /* currently sctx is memory bleed */
36168f6e6473SBarry Smith   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
36178f6e6473SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
36188f6e6473SBarry Smith   /*
36198f6e6473SBarry Smith      This should work, but it doesn't
36208f6e6473SBarry Smith   sctx->ctx = ctx;
36218f6e6473SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
36228f6e6473SBarry Smith   */
36238f6e6473SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
36248f6e6473SBarry Smith   ierr = SNESSetFunction(snes,r,SNESComputeFunction_Matlab,sctx);CHKERRQ(ierr);
36250807856dSBarry Smith   PetscFunctionReturn(0);
36260807856dSBarry Smith }
362769b4f73cSBarry Smith 
362861b2408cSBarry Smith #undef __FUNCT__
362961b2408cSBarry Smith #define __FUNCT__ "SNESComputeJacobian_Matlab"
363061b2408cSBarry Smith /*
363161b2408cSBarry Smith    SNESComputeJacobian_Matlab - Calls the function that has been set with
363261b2408cSBarry Smith                          SNESSetJacobianMatlab().
363361b2408cSBarry Smith 
363461b2408cSBarry Smith    Collective on SNES
363561b2408cSBarry Smith 
363661b2408cSBarry Smith    Input Parameters:
363761b2408cSBarry Smith +  snes - the SNES context
363861b2408cSBarry Smith .  x - input vector
363961b2408cSBarry Smith .  A, B - the matrices
364061b2408cSBarry Smith -  ctx - user context
364161b2408cSBarry Smith 
364261b2408cSBarry Smith    Output Parameter:
364361b2408cSBarry Smith .  flag - structure of the matrix
364461b2408cSBarry Smith 
364561b2408cSBarry Smith    Level: developer
364661b2408cSBarry Smith 
364761b2408cSBarry Smith .keywords: SNES, nonlinear, compute, function
364861b2408cSBarry Smith 
364961b2408cSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction()
365061b2408cSBarry Smith @*/
36517087cfbeSBarry Smith PetscErrorCode  SNESComputeJacobian_Matlab(SNES snes,Vec x,Mat *A,Mat *B,MatStructure *flag, void *ctx)
365261b2408cSBarry Smith {
365361b2408cSBarry Smith   PetscErrorCode    ierr;
365461b2408cSBarry Smith   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
365561b2408cSBarry Smith   int               nlhs = 2,nrhs = 6;
365661b2408cSBarry Smith   mxArray	    *plhs[2],*prhs[6];
365761b2408cSBarry Smith   long long int     lx = 0,lA = 0,ls = 0, lB = 0;
365861b2408cSBarry Smith 
365961b2408cSBarry Smith   PetscFunctionBegin;
366061b2408cSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
366161b2408cSBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
366261b2408cSBarry Smith 
366361b2408cSBarry Smith   /* call Matlab function in ctx with arguments x and y */
366461b2408cSBarry Smith 
366561b2408cSBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
366661b2408cSBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
366761b2408cSBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(x));CHKERRQ(ierr);
366861b2408cSBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(x));CHKERRQ(ierr);
366961b2408cSBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
367061b2408cSBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)lx);
367161b2408cSBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lA);
367261b2408cSBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lB);
367361b2408cSBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
367461b2408cSBarry Smith   prhs[5] =  sctx->ctx;
3675b807a863SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeJacobianInternal");CHKERRQ(ierr);
367661b2408cSBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
367761b2408cSBarry Smith   *flag   =  (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr);
367861b2408cSBarry Smith   mxDestroyArray(prhs[0]);
367961b2408cSBarry Smith   mxDestroyArray(prhs[1]);
368061b2408cSBarry Smith   mxDestroyArray(prhs[2]);
368161b2408cSBarry Smith   mxDestroyArray(prhs[3]);
368261b2408cSBarry Smith   mxDestroyArray(prhs[4]);
368361b2408cSBarry Smith   mxDestroyArray(plhs[0]);
368461b2408cSBarry Smith   mxDestroyArray(plhs[1]);
368561b2408cSBarry Smith   PetscFunctionReturn(0);
368661b2408cSBarry Smith }
368761b2408cSBarry Smith 
368861b2408cSBarry Smith 
368961b2408cSBarry Smith #undef __FUNCT__
369061b2408cSBarry Smith #define __FUNCT__ "SNESSetJacobianMatlab"
369161b2408cSBarry Smith /*
369261b2408cSBarry Smith    SNESSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
369361b2408cSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
3694e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
369561b2408cSBarry Smith 
369661b2408cSBarry Smith    Logically Collective on SNES
369761b2408cSBarry Smith 
369861b2408cSBarry Smith    Input Parameters:
369961b2408cSBarry Smith +  snes - the SNES context
370061b2408cSBarry Smith .  A,B - Jacobian matrices
370161b2408cSBarry Smith .  func - function evaluation routine
370261b2408cSBarry Smith -  ctx - user context
370361b2408cSBarry Smith 
370461b2408cSBarry Smith    Calling sequence of func:
370561b2408cSBarry Smith $    flag = func (SNES snes,Vec x,Mat A,Mat B,void *ctx);
370661b2408cSBarry Smith 
370761b2408cSBarry Smith 
370861b2408cSBarry Smith    Level: developer
370961b2408cSBarry Smith 
371061b2408cSBarry Smith .keywords: SNES, nonlinear, set, function
371161b2408cSBarry Smith 
371261b2408cSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
371361b2408cSBarry Smith */
37147087cfbeSBarry Smith PetscErrorCode  SNESSetJacobianMatlab(SNES snes,Mat A,Mat B,const char *func,mxArray *ctx)
371561b2408cSBarry Smith {
371661b2408cSBarry Smith   PetscErrorCode    ierr;
371761b2408cSBarry Smith   SNESMatlabContext *sctx;
371861b2408cSBarry Smith 
371961b2408cSBarry Smith   PetscFunctionBegin;
372061b2408cSBarry Smith   /* currently sctx is memory bleed */
372161b2408cSBarry Smith   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
372261b2408cSBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
372361b2408cSBarry Smith   /*
372461b2408cSBarry Smith      This should work, but it doesn't
372561b2408cSBarry Smith   sctx->ctx = ctx;
372661b2408cSBarry Smith   mexMakeArrayPersistent(sctx->ctx);
372761b2408cSBarry Smith   */
372861b2408cSBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
372961b2408cSBarry Smith   ierr = SNESSetJacobian(snes,A,B,SNESComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
373061b2408cSBarry Smith   PetscFunctionReturn(0);
373161b2408cSBarry Smith }
373269b4f73cSBarry Smith 
3733f9eb7ae2SShri Abhyankar #undef __FUNCT__
3734f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitor_Matlab"
3735f9eb7ae2SShri Abhyankar /*
3736f9eb7ae2SShri Abhyankar    SNESMonitor_Matlab - Calls the function that has been set with SNESMonitorSetMatlab().
3737f9eb7ae2SShri Abhyankar 
3738f9eb7ae2SShri Abhyankar    Collective on SNES
3739f9eb7ae2SShri Abhyankar 
3740f9eb7ae2SShri Abhyankar .seealso: SNESSetFunction(), SNESGetFunction()
3741f9eb7ae2SShri Abhyankar @*/
37427087cfbeSBarry Smith PetscErrorCode  SNESMonitor_Matlab(SNES snes,PetscInt it, PetscReal fnorm, void *ctx)
3743f9eb7ae2SShri Abhyankar {
3744f9eb7ae2SShri Abhyankar   PetscErrorCode  ierr;
374548f37e70SShri Abhyankar   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
3746f9eb7ae2SShri Abhyankar   int             nlhs = 1,nrhs = 6;
3747f9eb7ae2SShri Abhyankar   mxArray	  *plhs[1],*prhs[6];
3748f9eb7ae2SShri Abhyankar   long long int   lx = 0,ls = 0;
3749f9eb7ae2SShri Abhyankar   Vec             x=snes->vec_sol;
3750f9eb7ae2SShri Abhyankar 
3751f9eb7ae2SShri Abhyankar   PetscFunctionBegin;
3752f9eb7ae2SShri Abhyankar   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3753f9eb7ae2SShri Abhyankar 
3754f9eb7ae2SShri Abhyankar   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
3755f9eb7ae2SShri Abhyankar   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
3756f9eb7ae2SShri Abhyankar   prhs[0] =  mxCreateDoubleScalar((double)ls);
3757f9eb7ae2SShri Abhyankar   prhs[1] =  mxCreateDoubleScalar((double)it);
3758f9eb7ae2SShri Abhyankar   prhs[2] =  mxCreateDoubleScalar((double)fnorm);
3759f9eb7ae2SShri Abhyankar   prhs[3] =  mxCreateDoubleScalar((double)lx);
3760f9eb7ae2SShri Abhyankar   prhs[4] =  mxCreateString(sctx->funcname);
3761f9eb7ae2SShri Abhyankar   prhs[5] =  sctx->ctx;
3762f9eb7ae2SShri Abhyankar   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESMonitorInternal");CHKERRQ(ierr);
3763f9eb7ae2SShri Abhyankar   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
3764f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[0]);
3765f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[1]);
3766f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[2]);
3767f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[3]);
3768f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[4]);
3769f9eb7ae2SShri Abhyankar   mxDestroyArray(plhs[0]);
3770f9eb7ae2SShri Abhyankar   PetscFunctionReturn(0);
3771f9eb7ae2SShri Abhyankar }
3772f9eb7ae2SShri Abhyankar 
3773f9eb7ae2SShri Abhyankar 
3774f9eb7ae2SShri Abhyankar #undef __FUNCT__
3775f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitorSetMatlab"
3776f9eb7ae2SShri Abhyankar /*
3777e3c5b3baSBarry Smith    SNESMonitorSetMatlab - Sets the monitor function from MATLAB
3778f9eb7ae2SShri Abhyankar 
3779f9eb7ae2SShri Abhyankar    Level: developer
3780f9eb7ae2SShri Abhyankar 
3781f9eb7ae2SShri Abhyankar .keywords: SNES, nonlinear, set, function
3782f9eb7ae2SShri Abhyankar 
3783f9eb7ae2SShri Abhyankar .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
3784f9eb7ae2SShri Abhyankar */
37857087cfbeSBarry Smith PetscErrorCode  SNESMonitorSetMatlab(SNES snes,const char *func,mxArray *ctx)
3786f9eb7ae2SShri Abhyankar {
3787f9eb7ae2SShri Abhyankar   PetscErrorCode    ierr;
3788f9eb7ae2SShri Abhyankar   SNESMatlabContext *sctx;
3789f9eb7ae2SShri Abhyankar 
3790f9eb7ae2SShri Abhyankar   PetscFunctionBegin;
3791f9eb7ae2SShri Abhyankar   /* currently sctx is memory bleed */
3792f9eb7ae2SShri Abhyankar   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
3793f9eb7ae2SShri Abhyankar   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
3794f9eb7ae2SShri Abhyankar   /*
3795f9eb7ae2SShri Abhyankar      This should work, but it doesn't
3796f9eb7ae2SShri Abhyankar   sctx->ctx = ctx;
3797f9eb7ae2SShri Abhyankar   mexMakeArrayPersistent(sctx->ctx);
3798f9eb7ae2SShri Abhyankar   */
3799f9eb7ae2SShri Abhyankar   sctx->ctx = mxDuplicateArray(ctx);
3800f9eb7ae2SShri Abhyankar   ierr = SNESMonitorSet(snes,SNESMonitor_Matlab,sctx,PETSC_NULL);CHKERRQ(ierr);
3801f9eb7ae2SShri Abhyankar   PetscFunctionReturn(0);
3802f9eb7ae2SShri Abhyankar }
3803f9eb7ae2SShri Abhyankar 
380469b4f73cSBarry Smith #endif
3805