xref: /petsc/src/snes/interface/snes.c (revision c3cc8fd1f0d334b4584c8eefd7d6ef2f1c52c8de)
19b94acceSBarry Smith 
2c6db04a5SJed Brown #include <private/snesimpl.h>      /*I "petscsnes.h"  I*/
39b94acceSBarry Smith 
4ace3abfcSBarry Smith PetscBool  SNESRegisterAllCalled = PETSC_FALSE;
58ba1e511SMatthew Knepley PetscFList SNESList              = PETSC_NULL;
68ba1e511SMatthew Knepley 
78ba1e511SMatthew Knepley /* Logging support */
87087cfbeSBarry Smith PetscClassId  SNES_CLASSID;
9166c7f25SBarry Smith PetscLogEvent  SNES_Solve, SNES_LineSearch, SNES_FunctionEval, SNES_JacobianEval;
10a09944afSBarry Smith 
11a09944afSBarry Smith #undef __FUNCT__
12cab2e9ccSBarry Smith #define __FUNCT__ "SNESDMComputeJacobian"
13cab2e9ccSBarry Smith /*
14cab2e9ccSBarry Smith     Translates from a SNES call to a DM call in computing a Jacobian
15cab2e9ccSBarry Smith */
16cab2e9ccSBarry Smith PetscErrorCode SNESDMComputeJacobian(SNES snes,Vec X,Mat *J,Mat *B,MatStructure *flag,void *ptr)
17cab2e9ccSBarry Smith {
18cab2e9ccSBarry Smith   PetscErrorCode ierr;
19cab2e9ccSBarry Smith   DM             dm;
20cab2e9ccSBarry Smith 
21cab2e9ccSBarry Smith   PetscFunctionBegin;
22cab2e9ccSBarry Smith   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
23cab2e9ccSBarry Smith   ierr = DMComputeJacobian(dm,X,*J,*B,flag);CHKERRQ(ierr);
24cab2e9ccSBarry Smith   PetscFunctionReturn(0);
25cab2e9ccSBarry Smith }
26cab2e9ccSBarry Smith 
27cab2e9ccSBarry Smith #undef __FUNCT__
28e113a28aSBarry Smith #define __FUNCT__ "SNESSetErrorIfNotConverged"
29e113a28aSBarry Smith /*@
30e113a28aSBarry Smith    SNESSetErrorIfNotConverged - Causes SNESSolve() to generate an error if the solver has not converged.
31e113a28aSBarry Smith 
323f9fe445SBarry Smith    Logically Collective on SNES
33e113a28aSBarry Smith 
34e113a28aSBarry Smith    Input Parameters:
35e113a28aSBarry Smith +  snes - iterative context obtained from SNESCreate()
36e113a28aSBarry Smith -  flg - PETSC_TRUE indicates you want the error generated
37e113a28aSBarry Smith 
38e113a28aSBarry Smith    Options database keys:
39e113a28aSBarry Smith .  -snes_error_if_not_converged : this takes an optional truth value (0/1/no/yes/true/false)
40e113a28aSBarry Smith 
41e113a28aSBarry Smith    Level: intermediate
42e113a28aSBarry Smith 
43e113a28aSBarry Smith    Notes:
44e113a28aSBarry Smith     Normally PETSc continues if a linear solver fails to converge, you can call SNESGetConvergedReason() after a SNESSolve()
45e113a28aSBarry Smith     to determine if it has converged.
46e113a28aSBarry Smith 
47e113a28aSBarry Smith .keywords: SNES, set, initial guess, nonzero
48e113a28aSBarry Smith 
49e113a28aSBarry Smith .seealso: SNESGetErrorIfNotConverged(), KSPGetErrorIfNotConverged(), KSPSetErrorIFNotConverged()
50e113a28aSBarry Smith @*/
517087cfbeSBarry Smith PetscErrorCode  SNESSetErrorIfNotConverged(SNES snes,PetscBool  flg)
52e113a28aSBarry Smith {
53e113a28aSBarry Smith   PetscFunctionBegin;
54e113a28aSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
55acfcf0e5SJed Brown   PetscValidLogicalCollectiveBool(snes,flg,2);
56e113a28aSBarry Smith   snes->errorifnotconverged = flg;
57e113a28aSBarry Smith   PetscFunctionReturn(0);
58e113a28aSBarry Smith }
59e113a28aSBarry Smith 
60e113a28aSBarry Smith #undef __FUNCT__
61e113a28aSBarry Smith #define __FUNCT__ "SNESGetErrorIfNotConverged"
62e113a28aSBarry Smith /*@
63e113a28aSBarry Smith    SNESGetErrorIfNotConverged - Will SNESSolve() generate an error if the solver does not converge?
64e113a28aSBarry Smith 
65e113a28aSBarry Smith    Not Collective
66e113a28aSBarry Smith 
67e113a28aSBarry Smith    Input Parameter:
68e113a28aSBarry Smith .  snes - iterative context obtained from SNESCreate()
69e113a28aSBarry Smith 
70e113a28aSBarry Smith    Output Parameter:
71e113a28aSBarry Smith .  flag - PETSC_TRUE if it will generate an error, else PETSC_FALSE
72e113a28aSBarry Smith 
73e113a28aSBarry Smith    Level: intermediate
74e113a28aSBarry Smith 
75e113a28aSBarry Smith .keywords: SNES, set, initial guess, nonzero
76e113a28aSBarry Smith 
77e113a28aSBarry Smith .seealso:  SNESSetErrorIfNotConverged(), KSPGetErrorIfNotConverged(), KSPSetErrorIFNotConverged()
78e113a28aSBarry Smith @*/
797087cfbeSBarry Smith PetscErrorCode  SNESGetErrorIfNotConverged(SNES snes,PetscBool  *flag)
80e113a28aSBarry Smith {
81e113a28aSBarry Smith   PetscFunctionBegin;
82e113a28aSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
83e113a28aSBarry Smith   PetscValidPointer(flag,2);
84e113a28aSBarry Smith   *flag = snes->errorifnotconverged;
85e113a28aSBarry Smith   PetscFunctionReturn(0);
86e113a28aSBarry Smith }
87e113a28aSBarry Smith 
88e113a28aSBarry Smith #undef __FUNCT__
894936397dSBarry Smith #define __FUNCT__ "SNESSetFunctionDomainError"
90e725d27bSBarry Smith /*@
914936397dSBarry Smith    SNESSetFunctionDomainError - tells SNES that the input vector to your FormFunction is not
924936397dSBarry Smith      in the functions domain. For example, negative pressure.
934936397dSBarry Smith 
943f9fe445SBarry Smith    Logically Collective on SNES
954936397dSBarry Smith 
964936397dSBarry Smith    Input Parameters:
974936397dSBarry Smith .  SNES - the SNES context
984936397dSBarry Smith 
9928529972SSatish Balay    Level: advanced
1004936397dSBarry Smith 
1014936397dSBarry Smith .keywords: SNES, view
1024936397dSBarry Smith 
1034936397dSBarry Smith .seealso: SNESCreate(), SNESSetFunction()
1044936397dSBarry Smith @*/
1057087cfbeSBarry Smith PetscErrorCode  SNESSetFunctionDomainError(SNES snes)
1064936397dSBarry Smith {
1074936397dSBarry Smith   PetscFunctionBegin;
1080700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1094936397dSBarry Smith   snes->domainerror = PETSC_TRUE;
1104936397dSBarry Smith   PetscFunctionReturn(0);
1114936397dSBarry Smith }
1124936397dSBarry Smith 
1134936397dSBarry Smith #undef __FUNCT__
1144a2ae208SSatish Balay #define __FUNCT__ "SNESView"
1157e2c5f70SBarry Smith /*@C
1169b94acceSBarry Smith    SNESView - Prints the SNES data structure.
1179b94acceSBarry Smith 
1184c49b128SBarry Smith    Collective on SNES
119fee21e36SBarry Smith 
120c7afd0dbSLois Curfman McInnes    Input Parameters:
121c7afd0dbSLois Curfman McInnes +  SNES - the SNES context
122c7afd0dbSLois Curfman McInnes -  viewer - visualization context
123c7afd0dbSLois Curfman McInnes 
1249b94acceSBarry Smith    Options Database Key:
125c8a8ba5cSLois Curfman McInnes .  -snes_view - Calls SNESView() at end of SNESSolve()
1269b94acceSBarry Smith 
1279b94acceSBarry Smith    Notes:
1289b94acceSBarry Smith    The available visualization contexts include
129b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
130b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
131c8a8ba5cSLois Curfman McInnes          output where only the first processor opens
132c8a8ba5cSLois Curfman McInnes          the file.  All other processors send their
133c8a8ba5cSLois Curfman McInnes          data to the first processor to print.
1349b94acceSBarry Smith 
1353e081fefSLois Curfman McInnes    The user can open an alternative visualization context with
136b0a32e0cSBarry Smith    PetscViewerASCIIOpen() - output to a specified file.
1379b94acceSBarry Smith 
13836851e7fSLois Curfman McInnes    Level: beginner
13936851e7fSLois Curfman McInnes 
1409b94acceSBarry Smith .keywords: SNES, view
1419b94acceSBarry Smith 
142b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1439b94acceSBarry Smith @*/
1447087cfbeSBarry Smith PetscErrorCode  SNESView(SNES snes,PetscViewer viewer)
1459b94acceSBarry Smith {
146fa9f3622SBarry Smith   SNESKSPEW           *kctx;
147dfbe8321SBarry Smith   PetscErrorCode      ierr;
14894b7f48cSBarry Smith   KSP                 ksp;
149ace3abfcSBarry Smith   PetscBool           iascii,isstring;
1509b94acceSBarry Smith 
1513a40ed3dSBarry Smith   PetscFunctionBegin;
1520700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1533050cee2SBarry Smith   if (!viewer) {
1547adad957SLisandro Dalcin     ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&viewer);CHKERRQ(ierr);
1553050cee2SBarry Smith   }
1560700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
157c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,viewer,2);
15874679c65SBarry Smith 
1592692d6eeSBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1602692d6eeSBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
16132077d6dSBarry Smith   if (iascii) {
162317d6ea6SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)snes,viewer,"SNES Object");CHKERRQ(ierr);
163e7788613SBarry Smith     if (snes->ops->view) {
164b0a32e0cSBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
165e7788613SBarry Smith       ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr);
166b0a32e0cSBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1670ef38995SBarry Smith     }
16877431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum iterations=%D, maximum function evaluations=%D\n",snes->max_its,snes->max_funcs);CHKERRQ(ierr);
169a83599f4SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  tolerances: relative=%G, absolute=%G, solution=%G\n",
17070441072SBarry Smith                  snes->rtol,snes->abstol,snes->xtol);CHKERRQ(ierr);
17177431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",snes->linear_its);CHKERRQ(ierr);
17277431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  total number of function evaluations=%D\n",snes->nfuncs);CHKERRQ(ierr);
1739b94acceSBarry Smith     if (snes->ksp_ewconv) {
174fa9f3622SBarry Smith       kctx = (SNESKSPEW *)snes->kspconvctx;
1759b94acceSBarry Smith       if (kctx) {
17677431f27SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Eisenstat-Walker computation of KSP relative tolerance (version %D)\n",kctx->version);CHKERRQ(ierr);
177a83599f4SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"    rtol_0=%G, rtol_max=%G, threshold=%G\n",kctx->rtol_0,kctx->rtol_max,kctx->threshold);CHKERRQ(ierr);
178a83599f4SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"    gamma=%G, alpha=%G, alpha2=%G\n",kctx->gamma,kctx->alpha,kctx->alpha2);CHKERRQ(ierr);
1799b94acceSBarry Smith       }
1809b94acceSBarry Smith     }
181eb1f6c34SBarry Smith     if (snes->lagpreconditioner == -1) {
182eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioned is never rebuilt\n");CHKERRQ(ierr);
183eb1f6c34SBarry Smith     } else if (snes->lagpreconditioner > 1) {
184eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioned is rebuilt every %D new Jacobians\n",snes->lagpreconditioner);CHKERRQ(ierr);
185eb1f6c34SBarry Smith     }
186eb1f6c34SBarry Smith     if (snes->lagjacobian == -1) {
187eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Jacobian is never rebuilt\n");CHKERRQ(ierr);
188eb1f6c34SBarry Smith     } else if (snes->lagjacobian > 1) {
18942f4f86dSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Jacobian is rebuilt every %D SNES iterations\n",snes->lagjacobian);CHKERRQ(ierr);
190eb1f6c34SBarry Smith     }
1910f5bd95cSBarry Smith   } else if (isstring) {
192317d6ea6SBarry Smith     const char *type;
193454a90a3SBarry Smith     ierr = SNESGetType(snes,&type);CHKERRQ(ierr);
194b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr);
19519bcc07fSBarry Smith   }
19642f4f86dSBarry Smith   if (snes->pc && snes->usespc) {
1974a0c5b0cSMatthew G Knepley     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1984a0c5b0cSMatthew G Knepley     ierr = SNESView(snes->pc, viewer);CHKERRQ(ierr);
1994a0c5b0cSMatthew G Knepley     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2004a0c5b0cSMatthew G Knepley   }
2012c155ee1SBarry Smith   if (snes->usesksp) {
2022c155ee1SBarry Smith     ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
203b0a32e0cSBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
20494b7f48cSBarry Smith     ierr = KSPView(ksp,viewer);CHKERRQ(ierr);
205b0a32e0cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2062c155ee1SBarry Smith   }
2073a40ed3dSBarry Smith   PetscFunctionReturn(0);
2089b94acceSBarry Smith }
2099b94acceSBarry Smith 
21076b2cf59SMatthew Knepley /*
21176b2cf59SMatthew Knepley   We retain a list of functions that also take SNES command
21276b2cf59SMatthew Knepley   line options. These are called at the end SNESSetFromOptions()
21376b2cf59SMatthew Knepley */
21476b2cf59SMatthew Knepley #define MAXSETFROMOPTIONS 5
215a7cc72afSBarry Smith static PetscInt numberofsetfromoptions;
2166849ba73SBarry Smith static PetscErrorCode (*othersetfromoptions[MAXSETFROMOPTIONS])(SNES);
21776b2cf59SMatthew Knepley 
218e74ef692SMatthew Knepley #undef __FUNCT__
219e74ef692SMatthew Knepley #define __FUNCT__ "SNESAddOptionsChecker"
220ac226902SBarry Smith /*@C
22176b2cf59SMatthew Knepley   SNESAddOptionsChecker - Adds an additional function to check for SNES options.
22276b2cf59SMatthew Knepley 
22376b2cf59SMatthew Knepley   Not Collective
22476b2cf59SMatthew Knepley 
22576b2cf59SMatthew Knepley   Input Parameter:
22676b2cf59SMatthew Knepley . snescheck - function that checks for options
22776b2cf59SMatthew Knepley 
22876b2cf59SMatthew Knepley   Level: developer
22976b2cf59SMatthew Knepley 
23076b2cf59SMatthew Knepley .seealso: SNESSetFromOptions()
23176b2cf59SMatthew Knepley @*/
2327087cfbeSBarry Smith PetscErrorCode  SNESAddOptionsChecker(PetscErrorCode (*snescheck)(SNES))
23376b2cf59SMatthew Knepley {
23476b2cf59SMatthew Knepley   PetscFunctionBegin;
23576b2cf59SMatthew Knepley   if (numberofsetfromoptions >= MAXSETFROMOPTIONS) {
236e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "Too many options checkers, only %D allowed", MAXSETFROMOPTIONS);
23776b2cf59SMatthew Knepley   }
23876b2cf59SMatthew Knepley   othersetfromoptions[numberofsetfromoptions++] = snescheck;
23976b2cf59SMatthew Knepley   PetscFunctionReturn(0);
24076b2cf59SMatthew Knepley }
24176b2cf59SMatthew Knepley 
2427087cfbeSBarry Smith extern PetscErrorCode  SNESDefaultMatrixFreeCreate2(SNES,Vec,Mat*);
243aa3661deSLisandro Dalcin 
244aa3661deSLisandro Dalcin #undef __FUNCT__
245aa3661deSLisandro Dalcin #define __FUNCT__ "SNESSetUpMatrixFree_Private"
246ace3abfcSBarry Smith static PetscErrorCode SNESSetUpMatrixFree_Private(SNES snes, PetscBool  hasOperator, PetscInt version)
247aa3661deSLisandro Dalcin {
248aa3661deSLisandro Dalcin   Mat            J;
249aa3661deSLisandro Dalcin   KSP            ksp;
250aa3661deSLisandro Dalcin   PC             pc;
251ace3abfcSBarry Smith   PetscBool      match;
252aa3661deSLisandro Dalcin   PetscErrorCode ierr;
253aa3661deSLisandro Dalcin 
254aa3661deSLisandro Dalcin   PetscFunctionBegin;
2550700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
256aa3661deSLisandro Dalcin 
25798613b67SLisandro Dalcin   if(!snes->vec_func && (snes->jacobian || snes->jacobian_pre)) {
25898613b67SLisandro Dalcin     Mat A = snes->jacobian, B = snes->jacobian_pre;
25998613b67SLisandro Dalcin     ierr = MatGetVecs(A ? A : B, PETSC_NULL,&snes->vec_func);CHKERRQ(ierr);
26098613b67SLisandro Dalcin   }
26198613b67SLisandro Dalcin 
262aa3661deSLisandro Dalcin   if (version == 1) {
263aa3661deSLisandro Dalcin     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
26498613b67SLisandro Dalcin     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
2659c6ac3b3SBarry Smith     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
266aa3661deSLisandro Dalcin   } else if (version == 2) {
267e32f2f54SBarry Smith     if (!snes->vec_func) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"SNESSetFunction() must be called first");
268ce63c4c1SBarry Smith #if !defined(PETSC_USE_COMPLEX) && !defined(PETSC_USE_REAL_SINGLE) && !defined(PETSC_USE_REAL___FLOAT128) && !defined(PETSC_USE_REAL_LONG_DOUBLE)
269aa3661deSLisandro Dalcin     ierr = SNESDefaultMatrixFreeCreate2(snes,snes->vec_func,&J);CHKERRQ(ierr);
270aa3661deSLisandro Dalcin #else
271e32f2f54SBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP, "matrix-free operator rutines (version 2)");
272aa3661deSLisandro Dalcin #endif
273a8248277SBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "matrix-free operator rutines, only version 1 and 2");
274aa3661deSLisandro Dalcin 
275aa3661deSLisandro Dalcin   ierr = PetscInfo1(snes,"Setting default matrix-free operator routines (version %D)\n", version);CHKERRQ(ierr);
276d3462f78SMatthew Knepley   if (hasOperator) {
277aa3661deSLisandro Dalcin     /* This version replaces the user provided Jacobian matrix with a
278aa3661deSLisandro Dalcin        matrix-free version but still employs the user-provided preconditioner matrix. */
279aa3661deSLisandro Dalcin     ierr = SNESSetJacobian(snes,J,0,0,0);CHKERRQ(ierr);
280aa3661deSLisandro Dalcin   } else {
281aa3661deSLisandro Dalcin     /* This version replaces both the user-provided Jacobian and the user-
282aa3661deSLisandro Dalcin        provided preconditioner matrix with the default matrix free version. */
283aa3661deSLisandro Dalcin     ierr = SNESSetJacobian(snes,J,J,MatMFFDComputeJacobian,snes->funP);CHKERRQ(ierr);
284aa3661deSLisandro Dalcin     /* Force no preconditioner */
285aa3661deSLisandro Dalcin     ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
286aa3661deSLisandro Dalcin     ierr = KSPGetPC(ksp,&pc);CHKERRQ(ierr);
287aa3661deSLisandro Dalcin     ierr = PetscTypeCompare((PetscObject)pc,PCSHELL,&match);CHKERRQ(ierr);
288aa3661deSLisandro Dalcin     if (!match) {
289aa3661deSLisandro Dalcin       ierr = PetscInfo(snes,"Setting default matrix-free preconditioner routines\nThat is no preconditioner is being used\n");CHKERRQ(ierr);
290aa3661deSLisandro Dalcin       ierr = PCSetType(pc,PCNONE);CHKERRQ(ierr);
291aa3661deSLisandro Dalcin     }
292aa3661deSLisandro Dalcin   }
2936bf464f9SBarry Smith   ierr = MatDestroy(&J);CHKERRQ(ierr);
294aa3661deSLisandro Dalcin   PetscFunctionReturn(0);
295aa3661deSLisandro Dalcin }
296aa3661deSLisandro Dalcin 
2974a2ae208SSatish Balay #undef __FUNCT__
2984a2ae208SSatish Balay #define __FUNCT__ "SNESSetFromOptions"
2999b94acceSBarry Smith /*@
30094b7f48cSBarry Smith    SNESSetFromOptions - Sets various SNES and KSP parameters from user options.
3019b94acceSBarry Smith 
302c7afd0dbSLois Curfman McInnes    Collective on SNES
303c7afd0dbSLois Curfman McInnes 
3049b94acceSBarry Smith    Input Parameter:
3059b94acceSBarry Smith .  snes - the SNES context
3069b94acceSBarry Smith 
30736851e7fSLois Curfman McInnes    Options Database Keys:
3086831982aSBarry Smith +  -snes_type <type> - ls, tr, umls, umtr, test
30982738288SBarry Smith .  -snes_stol - convergence tolerance in terms of the norm
31082738288SBarry Smith                 of the change in the solution between steps
31170441072SBarry Smith .  -snes_atol <abstol> - absolute tolerance of residual norm
312b39c3a46SLois Curfman McInnes .  -snes_rtol <rtol> - relative decrease in tolerance norm from initial
313b39c3a46SLois Curfman McInnes .  -snes_max_it <max_it> - maximum number of iterations
314b39c3a46SLois Curfman McInnes .  -snes_max_funcs <max_funcs> - maximum number of function evaluations
31550ffb88aSMatthew Knepley .  -snes_max_fail <max_fail> - maximum number of failures
316ddf469c8SBarry Smith .  -snes_max_linear_solve_fail - number of linear solver failures before SNESSolve() stops
317a8054027SBarry Smith .  -snes_lag_preconditioner <lag> - how often preconditioner is rebuilt (use -1 to never rebuild)
318e35cf81dSBarry Smith .  -snes_lag_jacobian <lag> - how often Jacobian is rebuilt (use -1 to never rebuild)
319b39c3a46SLois Curfman McInnes .  -snes_trtol <trtol> - trust region tolerance
3202492ecdbSBarry Smith .  -snes_no_convergence_test - skip convergence test in nonlinear
32182738288SBarry Smith                                solver; hence iterations will continue until max_it
3221fbbfb26SLois Curfman McInnes                                or some other criterion is reached. Saves expense
32382738288SBarry Smith                                of convergence test
324e8105e01SRichard Katz .  -snes_monitor <optional filename> - prints residual norm at each iteration. if no
325e8105e01SRichard Katz                                        filename given prints to stdout
326a6570f20SBarry Smith .  -snes_monitor_solution - plots solution at each iteration
327a6570f20SBarry Smith .  -snes_monitor_residual - plots residual (not its norm) at each iteration
328a6570f20SBarry Smith .  -snes_monitor_solution_update - plots update to solution at each iteration
329a6570f20SBarry Smith .  -snes_monitor_draw - plots residual norm at each iteration
330e24b481bSBarry Smith .  -snes_fd - use finite differences to compute Jacobian; very slow, only for testing
3315968eb51SBarry Smith .  -snes_mf_ksp_monitor - if using matrix-free multiply then print h at each KSP iteration
332fee2055bSBarry Smith -  -snes_converged_reason - print the reason for convergence/divergence after each solve
33382738288SBarry Smith 
33482738288SBarry Smith     Options Database for Eisenstat-Walker method:
335fa9f3622SBarry Smith +  -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence
3364b27c08aSLois Curfman McInnes .  -snes_ksp_ew_version ver - version of  Eisenstat-Walker method
33736851e7fSLois Curfman McInnes .  -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0
33836851e7fSLois Curfman McInnes .  -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax
33936851e7fSLois Curfman McInnes .  -snes_ksp_ew_gamma <gamma> - Sets gamma
34036851e7fSLois Curfman McInnes .  -snes_ksp_ew_alpha <alpha> - Sets alpha
34136851e7fSLois Curfman McInnes .  -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2
34236851e7fSLois Curfman McInnes -  -snes_ksp_ew_threshold <threshold> - Sets threshold
34382738288SBarry Smith 
34411ca99fdSLois Curfman McInnes    Notes:
34511ca99fdSLois Curfman McInnes    To see all options, run your program with the -help option or consult
3460598bfebSBarry Smith    the <A href="../../docs/manual.pdf#nameddest=ch_snes">SNES chapter of the users manual</A>.
34783e2fdc7SBarry Smith 
34836851e7fSLois Curfman McInnes    Level: beginner
34936851e7fSLois Curfman McInnes 
3509b94acceSBarry Smith .keywords: SNES, nonlinear, set, options, database
3519b94acceSBarry Smith 
35269ed319cSSatish Balay .seealso: SNESSetOptionsPrefix()
3539b94acceSBarry Smith @*/
3547087cfbeSBarry Smith PetscErrorCode  SNESSetFromOptions(SNES snes)
3559b94acceSBarry Smith {
356ace3abfcSBarry Smith   PetscBool               flg,mf,mf_operator;
357efd51863SBarry Smith   PetscInt                i,indx,lag,mf_version,grids;
358aa3661deSLisandro Dalcin   MatStructure            matflag;
35985385478SLisandro Dalcin   const char              *deft = SNESLS;
36085385478SLisandro Dalcin   const char              *convtests[] = {"default","skip"};
36185385478SLisandro Dalcin   SNESKSPEW               *kctx = NULL;
362e8105e01SRichard Katz   char                    type[256], monfilename[PETSC_MAX_PATH_LEN];
363649052a6SBarry Smith   PetscViewer             monviewer;
36485385478SLisandro Dalcin   PetscErrorCode          ierr;
3659b94acceSBarry Smith 
3663a40ed3dSBarry Smith   PetscFunctionBegin;
3670700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
368ca161407SBarry Smith 
369186905e3SBarry Smith   if (!SNESRegisterAllCalled) {ierr = SNESRegisterAll(PETSC_NULL);CHKERRQ(ierr);}
3703194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)snes);CHKERRQ(ierr);
3717adad957SLisandro Dalcin     if (((PetscObject)snes)->type_name) { deft = ((PetscObject)snes)->type_name; }
372b0a32e0cSBarry Smith     ierr = PetscOptionsList("-snes_type","Nonlinear solver method","SNESSetType",SNESList,deft,type,256,&flg);CHKERRQ(ierr);
373d64ed03dSBarry Smith     if (flg) {
374186905e3SBarry Smith       ierr = SNESSetType(snes,type);CHKERRQ(ierr);
3757adad957SLisandro Dalcin     } else if (!((PetscObject)snes)->type_name) {
376186905e3SBarry Smith       ierr = SNESSetType(snes,deft);CHKERRQ(ierr);
377d64ed03dSBarry Smith     }
37890d69ab7SBarry Smith     /* not used here, but called so will go into help messaage */
379909c8a9fSBarry Smith     ierr = PetscOptionsName("-snes_view","Print detailed information on solver used","SNESView",0);CHKERRQ(ierr);
38093c39befSBarry Smith 
38157034d6fSHong Zhang     ierr = PetscOptionsReal("-snes_stol","Stop if step length less than","SNESSetTolerances",snes->xtol,&snes->xtol,0);CHKERRQ(ierr);
38257034d6fSHong Zhang     ierr = PetscOptionsReal("-snes_atol","Stop if function norm less than","SNESSetTolerances",snes->abstol,&snes->abstol,0);CHKERRQ(ierr);
383186905e3SBarry Smith 
38457034d6fSHong Zhang     ierr = PetscOptionsReal("-snes_rtol","Stop if decrease in function norm less than","SNESSetTolerances",snes->rtol,&snes->rtol,0);CHKERRQ(ierr);
385b0a32e0cSBarry Smith     ierr = PetscOptionsInt("-snes_max_it","Maximum iterations","SNESSetTolerances",snes->max_its,&snes->max_its,PETSC_NULL);CHKERRQ(ierr);
386b0a32e0cSBarry Smith     ierr = PetscOptionsInt("-snes_max_funcs","Maximum function evaluations","SNESSetTolerances",snes->max_funcs,&snes->max_funcs,PETSC_NULL);CHKERRQ(ierr);
38750ffb88aSMatthew Knepley     ierr = PetscOptionsInt("-snes_max_fail","Maximum failures","SNESSetTolerances",snes->maxFailures,&snes->maxFailures,PETSC_NULL);CHKERRQ(ierr);
388ddf469c8SBarry Smith     ierr = PetscOptionsInt("-snes_max_linear_solve_fail","Maximum failures in linear solves allowed","SNESSetMaxLinearSolveFailures",snes->maxLinearSolveFailures,&snes->maxLinearSolveFailures,PETSC_NULL);CHKERRQ(ierr);
389acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_error_if_not_converged","Generate error if solver does not converge","SNESSetErrorIfNotConverged",snes->errorifnotconverged,&snes->errorifnotconverged,PETSC_NULL);CHKERRQ(ierr);
39085385478SLisandro Dalcin 
391a8054027SBarry Smith     ierr = PetscOptionsInt("-snes_lag_preconditioner","How often to rebuild preconditioner","SNESSetLagPreconditioner",snes->lagpreconditioner,&lag,&flg);CHKERRQ(ierr);
392a8054027SBarry Smith     if (flg) {
393a8054027SBarry Smith       ierr = SNESSetLagPreconditioner(snes,lag);CHKERRQ(ierr);
394a8054027SBarry Smith     }
395e35cf81dSBarry Smith     ierr = PetscOptionsInt("-snes_lag_jacobian","How often to rebuild Jacobian","SNESSetLagJacobian",snes->lagjacobian,&lag,&flg);CHKERRQ(ierr);
396e35cf81dSBarry Smith     if (flg) {
397e35cf81dSBarry Smith       ierr = SNESSetLagJacobian(snes,lag);CHKERRQ(ierr);
398e35cf81dSBarry Smith     }
399efd51863SBarry Smith     ierr = PetscOptionsInt("-snes_grid_sequence","Use grid sequencing to generate initial guess","SNESSetGridSequence",snes->gridsequence,&grids,&flg);CHKERRQ(ierr);
400efd51863SBarry Smith     if (flg) {
401efd51863SBarry Smith       ierr = SNESSetGridSequence(snes,grids);CHKERRQ(ierr);
402efd51863SBarry Smith     }
403a8054027SBarry Smith 
40485385478SLisandro Dalcin     ierr = PetscOptionsEList("-snes_convergence_test","Convergence test","SNESSetConvergenceTest",convtests,2,"default",&indx,&flg);CHKERRQ(ierr);
40585385478SLisandro Dalcin     if (flg) {
40685385478SLisandro Dalcin       switch (indx) {
4077f7931b9SBarry Smith       case 0: ierr = SNESSetConvergenceTest(snes,SNESDefaultConverged,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); break;
4087f7931b9SBarry Smith       case 1: ierr = SNESSetConvergenceTest(snes,SNESSkipConverged,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);    break;
40985385478SLisandro Dalcin       }
41085385478SLisandro Dalcin     }
41185385478SLisandro Dalcin 
412acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_converged_reason","Print reason for converged or diverged","SNESSolve",snes->printreason,&snes->printreason,PETSC_NULL);CHKERRQ(ierr);
413186905e3SBarry Smith 
41485385478SLisandro Dalcin     kctx = (SNESKSPEW *)snes->kspconvctx;
41585385478SLisandro Dalcin 
416acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_ksp_ew","Use Eisentat-Walker linear system convergence test","SNESKSPSetUseEW",snes->ksp_ewconv,&snes->ksp_ewconv,PETSC_NULL);CHKERRQ(ierr);
417186905e3SBarry Smith 
418fa9f3622SBarry Smith     ierr = PetscOptionsInt("-snes_ksp_ew_version","Version 1, 2 or 3","SNESKSPSetParametersEW",kctx->version,&kctx->version,0);CHKERRQ(ierr);
419fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_rtol0","0 <= rtol0 < 1","SNESKSPSetParametersEW",kctx->rtol_0,&kctx->rtol_0,0);CHKERRQ(ierr);
420fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_rtolmax","0 <= rtolmax < 1","SNESKSPSetParametersEW",kctx->rtol_max,&kctx->rtol_max,0);CHKERRQ(ierr);
421fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_gamma","0 <= gamma <= 1","SNESKSPSetParametersEW",kctx->gamma,&kctx->gamma,0);CHKERRQ(ierr);
422fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_alpha","1 < alpha <= 2","SNESKSPSetParametersEW",kctx->alpha,&kctx->alpha,0);CHKERRQ(ierr);
423fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_alpha2","alpha2","SNESKSPSetParametersEW",kctx->alpha2,&kctx->alpha2,0);CHKERRQ(ierr);
424fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_threshold","0 < threshold < 1","SNESKSPSetParametersEW",kctx->threshold,&kctx->threshold,0);CHKERRQ(ierr);
425186905e3SBarry Smith 
42690d69ab7SBarry Smith     flg  = PETSC_FALSE;
427acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_cancel","Remove all monitors","SNESMonitorCancel",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
428a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorCancel(snes);CHKERRQ(ierr);}
429eabae89aSBarry Smith 
430a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_monitor","Monitor norm of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
431e8105e01SRichard Katz     if (flg) {
432649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
433649052a6SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
434e8105e01SRichard Katz     }
435eabae89aSBarry Smith 
436b271bb04SBarry Smith     ierr = PetscOptionsString("-snes_monitor_range","Monitor range of elements of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
437b271bb04SBarry Smith     if (flg) {
438b271bb04SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorRange,0,0);CHKERRQ(ierr);
439b271bb04SBarry Smith     }
440b271bb04SBarry Smith 
441a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_ratiomonitor","Monitor ratios of norms of function","SNESMonitorSetRatio","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
442eabae89aSBarry Smith     if (flg) {
443649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
444f1bef1bcSMatthew Knepley       ierr = SNESMonitorSetRatio(snes,monviewer);CHKERRQ(ierr);
445e8105e01SRichard Katz     }
446eabae89aSBarry Smith 
447a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_monitor_short","Monitor norm of function (fewer digits)","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
448eabae89aSBarry Smith     if (flg) {
449649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
450649052a6SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorDefaultShort,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
451eabae89aSBarry Smith     }
452eabae89aSBarry Smith 
4535180491cSLisandro Dalcin     ierr = PetscOptionsString("-snes_monitor_python","Use Python function","SNESMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
4545180491cSLisandro Dalcin     if (flg) {ierr = PetscPythonMonitorSet((PetscObject)snes,monfilename);CHKERRQ(ierr);}
4555180491cSLisandro Dalcin 
45690d69ab7SBarry Smith     flg  = PETSC_FALSE;
457acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_solution","Plot solution at each iteration","SNESMonitorSolution",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
458a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolution,0,0);CHKERRQ(ierr);}
45990d69ab7SBarry Smith     flg  = PETSC_FALSE;
460acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_solution_update","Plot correction at each iteration","SNESMonitorSolutionUpdate",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
461a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolutionUpdate,0,0);CHKERRQ(ierr);}
46290d69ab7SBarry Smith     flg  = PETSC_FALSE;
463acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_residual","Plot residual at each iteration","SNESMonitorResidual",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
464a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorResidual,0,0);CHKERRQ(ierr);}
46590d69ab7SBarry Smith     flg  = PETSC_FALSE;
466acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_draw","Plot function norm at each iteration","SNESMonitorLG",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
467a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorLG,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);}
46890d69ab7SBarry Smith     flg  = PETSC_FALSE;
469acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_range_draw","Plot function range at each iteration","SNESMonitorLG",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
470b271bb04SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorLGRange,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);}
471e24b481bSBarry Smith 
47290d69ab7SBarry Smith     flg  = PETSC_FALSE;
473acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_fd","Use finite differences (slow) to compute Jacobian","SNESDefaultComputeJacobian",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
4744b27c08aSLois Curfman McInnes     if (flg) {
475186905e3SBarry Smith       ierr = SNESSetJacobian(snes,snes->jacobian,snes->jacobian_pre,SNESDefaultComputeJacobian,snes->funP);CHKERRQ(ierr);
476ae15b995SBarry Smith       ierr = PetscInfo(snes,"Setting default finite difference Jacobian matrix\n");CHKERRQ(ierr);
4779b94acceSBarry Smith     }
478639f9d9dSBarry Smith 
479aa3661deSLisandro Dalcin     mf = mf_operator = PETSC_FALSE;
480aa3661deSLisandro Dalcin     flg = PETSC_FALSE;
481acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_mf_operator","Use a Matrix-Free Jacobian with user-provided preconditioner matrix","MatCreateSNESMF",PETSC_FALSE,&mf_operator,&flg);CHKERRQ(ierr);
482a8248277SBarry Smith     if (flg && mf_operator) {
483a8248277SBarry Smith       snes->mf_operator = PETSC_TRUE;
484a8248277SBarry Smith       mf = PETSC_TRUE;
485a8248277SBarry Smith     }
486aa3661deSLisandro Dalcin     flg = PETSC_FALSE;
487acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_mf","Use a Matrix-Free Jacobian with no preconditioner matrix","MatCreateSNESMF",PETSC_FALSE,&mf,&flg);CHKERRQ(ierr);
488aa3661deSLisandro Dalcin     if (!flg && mf_operator) mf = PETSC_TRUE;
489aa3661deSLisandro Dalcin     mf_version = 1;
490aa3661deSLisandro Dalcin     ierr = PetscOptionsInt("-snes_mf_version","Matrix-Free routines version 1 or 2","None",mf_version,&mf_version,0);CHKERRQ(ierr);
491aa3661deSLisandro Dalcin 
49276b2cf59SMatthew Knepley     for(i = 0; i < numberofsetfromoptions; i++) {
49376b2cf59SMatthew Knepley       ierr = (*othersetfromoptions[i])(snes);CHKERRQ(ierr);
49476b2cf59SMatthew Knepley     }
49576b2cf59SMatthew Knepley 
496e7788613SBarry Smith     if (snes->ops->setfromoptions) {
497e7788613SBarry Smith       ierr = (*snes->ops->setfromoptions)(snes);CHKERRQ(ierr);
498639f9d9dSBarry Smith     }
4995d973c19SBarry Smith 
5005d973c19SBarry Smith     /* process any options handlers added with PetscObjectAddOptionsHandler() */
5015d973c19SBarry Smith     ierr = PetscObjectProcessOptionsHandlers((PetscObject)snes);CHKERRQ(ierr);
502b0a32e0cSBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
5034bbc92c1SBarry Smith 
504aa3661deSLisandro Dalcin   if (mf) { ierr = SNESSetUpMatrixFree_Private(snes, mf_operator, mf_version);CHKERRQ(ierr); }
5051cee3971SBarry Smith 
5061cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
507aa3661deSLisandro Dalcin   ierr = KSPGetOperators(snes->ksp,PETSC_NULL,PETSC_NULL,&matflag);
508aa3661deSLisandro Dalcin   ierr = KSPSetOperators(snes->ksp,snes->jacobian,snes->jacobian_pre,matflag);CHKERRQ(ierr);
50985385478SLisandro Dalcin   ierr = KSPSetFromOptions(snes->ksp);CHKERRQ(ierr);
51093993e2dSLois Curfman McInnes 
5114a0c5b0cSMatthew G Knepley   if (snes->pc) {
5124a0c5b0cSMatthew G Knepley     ierr = SNESSetOptionsPrefix(snes->pc, "npc_");CHKERRQ(ierr);
5134a0c5b0cSMatthew G Knepley     ierr = SNESSetDM(snes->pc, snes->dm);CHKERRQ(ierr);
5144a0c5b0cSMatthew G Knepley     /* Should we make a duplicate vector and matrix? Leave the DM to make it? */
5154a0c5b0cSMatthew G Knepley     ierr = SNESSetFunction(snes->pc, snes->vec_func, snes->ops->computefunction, snes->funP);CHKERRQ(ierr);
5164a0c5b0cSMatthew G Knepley     ierr = SNESSetJacobian(snes->pc, snes->jacobian, snes->jacobian_pre, snes->ops->computejacobian, snes->jacP);CHKERRQ(ierr);
5174a0c5b0cSMatthew G Knepley     ierr = SNESSetFromOptions(snes->pc);CHKERRQ(ierr);
5184a0c5b0cSMatthew G Knepley   }
5193a40ed3dSBarry Smith   PetscFunctionReturn(0);
5209b94acceSBarry Smith }
5219b94acceSBarry Smith 
522d25893d9SBarry Smith #undef __FUNCT__
523d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeApplicationContext"
524d25893d9SBarry Smith /*@
525d25893d9SBarry Smith    SNESSetComputeApplicationContext - Sets an optional function to compute a user-defined context for
526d25893d9SBarry Smith    the nonlinear solvers.
527d25893d9SBarry Smith 
528d25893d9SBarry Smith    Logically Collective on SNES
529d25893d9SBarry Smith 
530d25893d9SBarry Smith    Input Parameters:
531d25893d9SBarry Smith +  snes - the SNES context
532d25893d9SBarry Smith .  compute - function to compute the context
533d25893d9SBarry Smith -  destroy - function to destroy the context
534d25893d9SBarry Smith 
535d25893d9SBarry Smith    Level: intermediate
536d25893d9SBarry Smith 
537d25893d9SBarry Smith .keywords: SNES, nonlinear, set, application, context
538d25893d9SBarry Smith 
539d25893d9SBarry Smith .seealso: SNESGetApplicationContext(), SNESSetComputeApplicationContext(), SNESGetApplicationContext()
540d25893d9SBarry Smith @*/
541d25893d9SBarry Smith PetscErrorCode  SNESSetComputeApplicationContext(SNES snes,PetscErrorCode (*compute)(SNES,void**),PetscErrorCode (*destroy)(void**))
542d25893d9SBarry Smith {
543d25893d9SBarry Smith   PetscFunctionBegin;
544d25893d9SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
545d25893d9SBarry Smith   snes->ops->usercompute = compute;
546d25893d9SBarry Smith   snes->ops->userdestroy = destroy;
547d25893d9SBarry Smith   PetscFunctionReturn(0);
548d25893d9SBarry Smith }
549a847f771SSatish Balay 
5504a2ae208SSatish Balay #undef __FUNCT__
5514a2ae208SSatish Balay #define __FUNCT__ "SNESSetApplicationContext"
552b07ff414SBarry Smith /*@
5539b94acceSBarry Smith    SNESSetApplicationContext - Sets the optional user-defined context for
5549b94acceSBarry Smith    the nonlinear solvers.
5559b94acceSBarry Smith 
5563f9fe445SBarry Smith    Logically Collective on SNES
557fee21e36SBarry Smith 
558c7afd0dbSLois Curfman McInnes    Input Parameters:
559c7afd0dbSLois Curfman McInnes +  snes - the SNES context
560c7afd0dbSLois Curfman McInnes -  usrP - optional user context
561c7afd0dbSLois Curfman McInnes 
56236851e7fSLois Curfman McInnes    Level: intermediate
56336851e7fSLois Curfman McInnes 
5649b94acceSBarry Smith .keywords: SNES, nonlinear, set, application, context
5659b94acceSBarry Smith 
566d25893d9SBarry Smith .seealso: SNESGetApplicationContext(), SNESSetApplicationContext()
5679b94acceSBarry Smith @*/
5687087cfbeSBarry Smith PetscErrorCode  SNESSetApplicationContext(SNES snes,void *usrP)
5699b94acceSBarry Smith {
5701b2093e4SBarry Smith   PetscErrorCode ierr;
571b07ff414SBarry Smith   KSP            ksp;
5721b2093e4SBarry Smith 
5733a40ed3dSBarry Smith   PetscFunctionBegin;
5740700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
575b07ff414SBarry Smith   ierr       = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
576b07ff414SBarry Smith   ierr       = KSPSetApplicationContext(ksp,usrP);CHKERRQ(ierr);
5779b94acceSBarry Smith   snes->user = usrP;
5783a40ed3dSBarry Smith   PetscFunctionReturn(0);
5799b94acceSBarry Smith }
58074679c65SBarry Smith 
5814a2ae208SSatish Balay #undef __FUNCT__
5824a2ae208SSatish Balay #define __FUNCT__ "SNESGetApplicationContext"
583b07ff414SBarry Smith /*@
5849b94acceSBarry Smith    SNESGetApplicationContext - Gets the user-defined context for the
5859b94acceSBarry Smith    nonlinear solvers.
5869b94acceSBarry Smith 
587c7afd0dbSLois Curfman McInnes    Not Collective
588c7afd0dbSLois Curfman McInnes 
5899b94acceSBarry Smith    Input Parameter:
5909b94acceSBarry Smith .  snes - SNES context
5919b94acceSBarry Smith 
5929b94acceSBarry Smith    Output Parameter:
5939b94acceSBarry Smith .  usrP - user context
5949b94acceSBarry Smith 
59536851e7fSLois Curfman McInnes    Level: intermediate
59636851e7fSLois Curfman McInnes 
5979b94acceSBarry Smith .keywords: SNES, nonlinear, get, application, context
5989b94acceSBarry Smith 
5999b94acceSBarry Smith .seealso: SNESSetApplicationContext()
6009b94acceSBarry Smith @*/
601e71120c6SJed Brown PetscErrorCode  SNESGetApplicationContext(SNES snes,void *usrP)
6029b94acceSBarry Smith {
6033a40ed3dSBarry Smith   PetscFunctionBegin;
6040700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
605e71120c6SJed Brown   *(void**)usrP = snes->user;
6063a40ed3dSBarry Smith   PetscFunctionReturn(0);
6079b94acceSBarry Smith }
60874679c65SBarry Smith 
6094a2ae208SSatish Balay #undef __FUNCT__
6104a2ae208SSatish Balay #define __FUNCT__ "SNESGetIterationNumber"
6119b94acceSBarry Smith /*@
612c8228a4eSBarry Smith    SNESGetIterationNumber - Gets the number of nonlinear iterations completed
613c8228a4eSBarry Smith    at this time.
6149b94acceSBarry Smith 
615c7afd0dbSLois Curfman McInnes    Not Collective
616c7afd0dbSLois Curfman McInnes 
6179b94acceSBarry Smith    Input Parameter:
6189b94acceSBarry Smith .  snes - SNES context
6199b94acceSBarry Smith 
6209b94acceSBarry Smith    Output Parameter:
6219b94acceSBarry Smith .  iter - iteration number
6229b94acceSBarry Smith 
623c8228a4eSBarry Smith    Notes:
624c8228a4eSBarry Smith    For example, during the computation of iteration 2 this would return 1.
625c8228a4eSBarry Smith 
626c8228a4eSBarry Smith    This is useful for using lagged Jacobians (where one does not recompute the
62708405cd6SLois Curfman McInnes    Jacobian at each SNES iteration). For example, the code
62808405cd6SLois Curfman McInnes .vb
62908405cd6SLois Curfman McInnes       ierr = SNESGetIterationNumber(snes,&it);
63008405cd6SLois Curfman McInnes       if (!(it % 2)) {
63108405cd6SLois Curfman McInnes         [compute Jacobian here]
63208405cd6SLois Curfman McInnes       }
63308405cd6SLois Curfman McInnes .ve
634c8228a4eSBarry Smith    can be used in your ComputeJacobian() function to cause the Jacobian to be
63508405cd6SLois Curfman McInnes    recomputed every second SNES iteration.
636c8228a4eSBarry Smith 
63736851e7fSLois Curfman McInnes    Level: intermediate
63836851e7fSLois Curfman McInnes 
6392b668275SBarry Smith .keywords: SNES, nonlinear, get, iteration, number,
6402b668275SBarry Smith 
641b850b91aSLisandro Dalcin .seealso:   SNESGetFunctionNorm(), SNESGetLinearSolveIterations()
6429b94acceSBarry Smith @*/
6437087cfbeSBarry Smith PetscErrorCode  SNESGetIterationNumber(SNES snes,PetscInt* iter)
6449b94acceSBarry Smith {
6453a40ed3dSBarry Smith   PetscFunctionBegin;
6460700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
6474482741eSBarry Smith   PetscValidIntPointer(iter,2);
6489b94acceSBarry Smith   *iter = snes->iter;
6493a40ed3dSBarry Smith   PetscFunctionReturn(0);
6509b94acceSBarry Smith }
65174679c65SBarry Smith 
6524a2ae208SSatish Balay #undef __FUNCT__
6534a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunctionNorm"
6549b94acceSBarry Smith /*@
6559b94acceSBarry Smith    SNESGetFunctionNorm - Gets the norm of the current function that was set
6569b94acceSBarry Smith    with SNESSSetFunction().
6579b94acceSBarry Smith 
658c7afd0dbSLois Curfman McInnes    Collective on SNES
659c7afd0dbSLois Curfman McInnes 
6609b94acceSBarry Smith    Input Parameter:
6619b94acceSBarry Smith .  snes - SNES context
6629b94acceSBarry Smith 
6639b94acceSBarry Smith    Output Parameter:
6649b94acceSBarry Smith .  fnorm - 2-norm of function
6659b94acceSBarry Smith 
66636851e7fSLois Curfman McInnes    Level: intermediate
66736851e7fSLois Curfman McInnes 
6689b94acceSBarry Smith .keywords: SNES, nonlinear, get, function, norm
669a86d99e1SLois Curfman McInnes 
670b850b91aSLisandro Dalcin .seealso: SNESGetFunction(), SNESGetIterationNumber(), SNESGetLinearSolveIterations()
6719b94acceSBarry Smith @*/
6727087cfbeSBarry Smith PetscErrorCode  SNESGetFunctionNorm(SNES snes,PetscReal *fnorm)
6739b94acceSBarry Smith {
6743a40ed3dSBarry Smith   PetscFunctionBegin;
6750700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
6764482741eSBarry Smith   PetscValidScalarPointer(fnorm,2);
6779b94acceSBarry Smith   *fnorm = snes->norm;
6783a40ed3dSBarry Smith   PetscFunctionReturn(0);
6799b94acceSBarry Smith }
68074679c65SBarry Smith 
6814a2ae208SSatish Balay #undef __FUNCT__
682b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetNonlinearStepFailures"
6839b94acceSBarry Smith /*@
684b850b91aSLisandro Dalcin    SNESGetNonlinearStepFailures - Gets the number of unsuccessful steps
6859b94acceSBarry Smith    attempted by the nonlinear solver.
6869b94acceSBarry Smith 
687c7afd0dbSLois Curfman McInnes    Not Collective
688c7afd0dbSLois Curfman McInnes 
6899b94acceSBarry Smith    Input Parameter:
6909b94acceSBarry Smith .  snes - SNES context
6919b94acceSBarry Smith 
6929b94acceSBarry Smith    Output Parameter:
6939b94acceSBarry Smith .  nfails - number of unsuccessful steps attempted
6949b94acceSBarry Smith 
695c96a6f78SLois Curfman McInnes    Notes:
696c96a6f78SLois Curfman McInnes    This counter is reset to zero for each successive call to SNESSolve().
697c96a6f78SLois Curfman McInnes 
69836851e7fSLois Curfman McInnes    Level: intermediate
69936851e7fSLois Curfman McInnes 
7009b94acceSBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps
70158ebbce7SBarry Smith 
702e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(),
70358ebbce7SBarry Smith           SNESSetMaxNonlinearStepFailures(), SNESGetMaxNonlinearStepFailures()
7049b94acceSBarry Smith @*/
7057087cfbeSBarry Smith PetscErrorCode  SNESGetNonlinearStepFailures(SNES snes,PetscInt* nfails)
7069b94acceSBarry Smith {
7073a40ed3dSBarry Smith   PetscFunctionBegin;
7080700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
7094482741eSBarry Smith   PetscValidIntPointer(nfails,2);
71050ffb88aSMatthew Knepley   *nfails = snes->numFailures;
71150ffb88aSMatthew Knepley   PetscFunctionReturn(0);
71250ffb88aSMatthew Knepley }
71350ffb88aSMatthew Knepley 
71450ffb88aSMatthew Knepley #undef __FUNCT__
715b850b91aSLisandro Dalcin #define __FUNCT__ "SNESSetMaxNonlinearStepFailures"
71650ffb88aSMatthew Knepley /*@
717b850b91aSLisandro Dalcin    SNESSetMaxNonlinearStepFailures - Sets the maximum number of unsuccessful steps
71850ffb88aSMatthew Knepley    attempted by the nonlinear solver before it gives up.
71950ffb88aSMatthew Knepley 
72050ffb88aSMatthew Knepley    Not Collective
72150ffb88aSMatthew Knepley 
72250ffb88aSMatthew Knepley    Input Parameters:
72350ffb88aSMatthew Knepley +  snes     - SNES context
72450ffb88aSMatthew Knepley -  maxFails - maximum of unsuccessful steps
72550ffb88aSMatthew Knepley 
72650ffb88aSMatthew Knepley    Level: intermediate
72750ffb88aSMatthew Knepley 
72850ffb88aSMatthew Knepley .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps
72958ebbce7SBarry Smith 
730e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(),
73158ebbce7SBarry Smith           SNESGetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures()
73250ffb88aSMatthew Knepley @*/
7337087cfbeSBarry Smith PetscErrorCode  SNESSetMaxNonlinearStepFailures(SNES snes, PetscInt maxFails)
73450ffb88aSMatthew Knepley {
73550ffb88aSMatthew Knepley   PetscFunctionBegin;
7360700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
73750ffb88aSMatthew Knepley   snes->maxFailures = maxFails;
73850ffb88aSMatthew Knepley   PetscFunctionReturn(0);
73950ffb88aSMatthew Knepley }
74050ffb88aSMatthew Knepley 
74150ffb88aSMatthew Knepley #undef __FUNCT__
742b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetMaxNonlinearStepFailures"
74350ffb88aSMatthew Knepley /*@
744b850b91aSLisandro Dalcin    SNESGetMaxNonlinearStepFailures - Gets the maximum number of unsuccessful steps
74550ffb88aSMatthew Knepley    attempted by the nonlinear solver before it gives up.
74650ffb88aSMatthew Knepley 
74750ffb88aSMatthew Knepley    Not Collective
74850ffb88aSMatthew Knepley 
74950ffb88aSMatthew Knepley    Input Parameter:
75050ffb88aSMatthew Knepley .  snes     - SNES context
75150ffb88aSMatthew Knepley 
75250ffb88aSMatthew Knepley    Output Parameter:
75350ffb88aSMatthew Knepley .  maxFails - maximum of unsuccessful steps
75450ffb88aSMatthew Knepley 
75550ffb88aSMatthew Knepley    Level: intermediate
75650ffb88aSMatthew Knepley 
75750ffb88aSMatthew Knepley .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps
75858ebbce7SBarry Smith 
759e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(),
76058ebbce7SBarry Smith           SNESSetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures()
76158ebbce7SBarry Smith 
76250ffb88aSMatthew Knepley @*/
7637087cfbeSBarry Smith PetscErrorCode  SNESGetMaxNonlinearStepFailures(SNES snes, PetscInt *maxFails)
76450ffb88aSMatthew Knepley {
76550ffb88aSMatthew Knepley   PetscFunctionBegin;
7660700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
7674482741eSBarry Smith   PetscValidIntPointer(maxFails,2);
76850ffb88aSMatthew Knepley   *maxFails = snes->maxFailures;
7693a40ed3dSBarry Smith   PetscFunctionReturn(0);
7709b94acceSBarry Smith }
771a847f771SSatish Balay 
7724a2ae208SSatish Balay #undef __FUNCT__
7732541af92SBarry Smith #define __FUNCT__ "SNESGetNumberFunctionEvals"
7742541af92SBarry Smith /*@
7752541af92SBarry Smith    SNESGetNumberFunctionEvals - Gets the number of user provided function evaluations
7762541af92SBarry Smith      done by SNES.
7772541af92SBarry Smith 
7782541af92SBarry Smith    Not Collective
7792541af92SBarry Smith 
7802541af92SBarry Smith    Input Parameter:
7812541af92SBarry Smith .  snes     - SNES context
7822541af92SBarry Smith 
7832541af92SBarry Smith    Output Parameter:
7842541af92SBarry Smith .  nfuncs - number of evaluations
7852541af92SBarry Smith 
7862541af92SBarry Smith    Level: intermediate
7872541af92SBarry Smith 
7882541af92SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps
78958ebbce7SBarry Smith 
790e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures()
7912541af92SBarry Smith @*/
7927087cfbeSBarry Smith PetscErrorCode  SNESGetNumberFunctionEvals(SNES snes, PetscInt *nfuncs)
7932541af92SBarry Smith {
7942541af92SBarry Smith   PetscFunctionBegin;
7950700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
7962541af92SBarry Smith   PetscValidIntPointer(nfuncs,2);
7972541af92SBarry Smith   *nfuncs = snes->nfuncs;
7982541af92SBarry Smith   PetscFunctionReturn(0);
7992541af92SBarry Smith }
8002541af92SBarry Smith 
8012541af92SBarry Smith #undef __FUNCT__
8023d4c4710SBarry Smith #define __FUNCT__ "SNESGetLinearSolveFailures"
8033d4c4710SBarry Smith /*@
8043d4c4710SBarry Smith    SNESGetLinearSolveFailures - Gets the number of failed (non-converged)
8053d4c4710SBarry Smith    linear solvers.
8063d4c4710SBarry Smith 
8073d4c4710SBarry Smith    Not Collective
8083d4c4710SBarry Smith 
8093d4c4710SBarry Smith    Input Parameter:
8103d4c4710SBarry Smith .  snes - SNES context
8113d4c4710SBarry Smith 
8123d4c4710SBarry Smith    Output Parameter:
8133d4c4710SBarry Smith .  nfails - number of failed solves
8143d4c4710SBarry Smith 
8153d4c4710SBarry Smith    Notes:
8163d4c4710SBarry Smith    This counter is reset to zero for each successive call to SNESSolve().
8173d4c4710SBarry Smith 
8183d4c4710SBarry Smith    Level: intermediate
8193d4c4710SBarry Smith 
8203d4c4710SBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps
82158ebbce7SBarry Smith 
822e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures()
8233d4c4710SBarry Smith @*/
8247087cfbeSBarry Smith PetscErrorCode  SNESGetLinearSolveFailures(SNES snes,PetscInt* nfails)
8253d4c4710SBarry Smith {
8263d4c4710SBarry Smith   PetscFunctionBegin;
8270700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
8283d4c4710SBarry Smith   PetscValidIntPointer(nfails,2);
8293d4c4710SBarry Smith   *nfails = snes->numLinearSolveFailures;
8303d4c4710SBarry Smith   PetscFunctionReturn(0);
8313d4c4710SBarry Smith }
8323d4c4710SBarry Smith 
8333d4c4710SBarry Smith #undef __FUNCT__
8343d4c4710SBarry Smith #define __FUNCT__ "SNESSetMaxLinearSolveFailures"
8353d4c4710SBarry Smith /*@
8363d4c4710SBarry Smith    SNESSetMaxLinearSolveFailures - the number of failed linear solve attempts
8373d4c4710SBarry Smith    allowed before SNES returns with a diverged reason of SNES_DIVERGED_LINEAR_SOLVE
8383d4c4710SBarry Smith 
8393f9fe445SBarry Smith    Logically Collective on SNES
8403d4c4710SBarry Smith 
8413d4c4710SBarry Smith    Input Parameters:
8423d4c4710SBarry Smith +  snes     - SNES context
8433d4c4710SBarry Smith -  maxFails - maximum allowed linear solve failures
8443d4c4710SBarry Smith 
8453d4c4710SBarry Smith    Level: intermediate
8463d4c4710SBarry Smith 
847a6796414SBarry Smith    Notes: By default this is 0; that is SNES returns on the first failed linear solve
8483d4c4710SBarry Smith 
8493d4c4710SBarry Smith .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps
8503d4c4710SBarry Smith 
85158ebbce7SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations()
8523d4c4710SBarry Smith @*/
8537087cfbeSBarry Smith PetscErrorCode  SNESSetMaxLinearSolveFailures(SNES snes, PetscInt maxFails)
8543d4c4710SBarry Smith {
8553d4c4710SBarry Smith   PetscFunctionBegin;
8560700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
857c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxFails,2);
8583d4c4710SBarry Smith   snes->maxLinearSolveFailures = maxFails;
8593d4c4710SBarry Smith   PetscFunctionReturn(0);
8603d4c4710SBarry Smith }
8613d4c4710SBarry Smith 
8623d4c4710SBarry Smith #undef __FUNCT__
8633d4c4710SBarry Smith #define __FUNCT__ "SNESGetMaxLinearSolveFailures"
8643d4c4710SBarry Smith /*@
8653d4c4710SBarry Smith    SNESGetMaxLinearSolveFailures - gets the maximum number of linear solve failures that
8663d4c4710SBarry Smith      are allowed before SNES terminates
8673d4c4710SBarry Smith 
8683d4c4710SBarry Smith    Not Collective
8693d4c4710SBarry Smith 
8703d4c4710SBarry Smith    Input Parameter:
8713d4c4710SBarry Smith .  snes     - SNES context
8723d4c4710SBarry Smith 
8733d4c4710SBarry Smith    Output Parameter:
8743d4c4710SBarry Smith .  maxFails - maximum of unsuccessful solves allowed
8753d4c4710SBarry Smith 
8763d4c4710SBarry Smith    Level: intermediate
8773d4c4710SBarry Smith 
8783d4c4710SBarry Smith    Notes: By default this is 1; that is SNES returns on the first failed linear solve
8793d4c4710SBarry Smith 
8803d4c4710SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps
8813d4c4710SBarry Smith 
882e1c61ce8SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(),
8833d4c4710SBarry Smith @*/
8847087cfbeSBarry Smith PetscErrorCode  SNESGetMaxLinearSolveFailures(SNES snes, PetscInt *maxFails)
8853d4c4710SBarry Smith {
8863d4c4710SBarry Smith   PetscFunctionBegin;
8870700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
8883d4c4710SBarry Smith   PetscValidIntPointer(maxFails,2);
8893d4c4710SBarry Smith   *maxFails = snes->maxLinearSolveFailures;
8903d4c4710SBarry Smith   PetscFunctionReturn(0);
8913d4c4710SBarry Smith }
8923d4c4710SBarry Smith 
8933d4c4710SBarry Smith #undef __FUNCT__
894b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetLinearSolveIterations"
895c96a6f78SLois Curfman McInnes /*@
896b850b91aSLisandro Dalcin    SNESGetLinearSolveIterations - Gets the total number of linear iterations
897c96a6f78SLois Curfman McInnes    used by the nonlinear solver.
898c96a6f78SLois Curfman McInnes 
899c7afd0dbSLois Curfman McInnes    Not Collective
900c7afd0dbSLois Curfman McInnes 
901c96a6f78SLois Curfman McInnes    Input Parameter:
902c96a6f78SLois Curfman McInnes .  snes - SNES context
903c96a6f78SLois Curfman McInnes 
904c96a6f78SLois Curfman McInnes    Output Parameter:
905c96a6f78SLois Curfman McInnes .  lits - number of linear iterations
906c96a6f78SLois Curfman McInnes 
907c96a6f78SLois Curfman McInnes    Notes:
908c96a6f78SLois Curfman McInnes    This counter is reset to zero for each successive call to SNESSolve().
909c96a6f78SLois Curfman McInnes 
91036851e7fSLois Curfman McInnes    Level: intermediate
91136851e7fSLois Curfman McInnes 
912c96a6f78SLois Curfman McInnes .keywords: SNES, nonlinear, get, number, linear, iterations
9132b668275SBarry Smith 
9148c7482ecSBarry Smith .seealso:  SNESGetIterationNumber(), SNESGetFunctionNorm(), SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures()
915c96a6f78SLois Curfman McInnes @*/
9167087cfbeSBarry Smith PetscErrorCode  SNESGetLinearSolveIterations(SNES snes,PetscInt* lits)
917c96a6f78SLois Curfman McInnes {
9183a40ed3dSBarry Smith   PetscFunctionBegin;
9190700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
9204482741eSBarry Smith   PetscValidIntPointer(lits,2);
921c96a6f78SLois Curfman McInnes   *lits = snes->linear_its;
9223a40ed3dSBarry Smith   PetscFunctionReturn(0);
923c96a6f78SLois Curfman McInnes }
924c96a6f78SLois Curfman McInnes 
9254a2ae208SSatish Balay #undef __FUNCT__
92694b7f48cSBarry Smith #define __FUNCT__ "SNESGetKSP"
92752baeb72SSatish Balay /*@
92894b7f48cSBarry Smith    SNESGetKSP - Returns the KSP context for a SNES solver.
9299b94acceSBarry Smith 
93094b7f48cSBarry Smith    Not Collective, but if SNES object is parallel, then KSP object is parallel
931c7afd0dbSLois Curfman McInnes 
9329b94acceSBarry Smith    Input Parameter:
9339b94acceSBarry Smith .  snes - the SNES context
9349b94acceSBarry Smith 
9359b94acceSBarry Smith    Output Parameter:
93694b7f48cSBarry Smith .  ksp - the KSP context
9379b94acceSBarry Smith 
9389b94acceSBarry Smith    Notes:
93994b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
9409b94acceSBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
9412999313aSBarry Smith    PC contexts as well.
9429b94acceSBarry Smith 
94336851e7fSLois Curfman McInnes    Level: beginner
94436851e7fSLois Curfman McInnes 
94594b7f48cSBarry Smith .keywords: SNES, nonlinear, get, KSP, context
9469b94acceSBarry Smith 
9472999313aSBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP()
9489b94acceSBarry Smith @*/
9497087cfbeSBarry Smith PetscErrorCode  SNESGetKSP(SNES snes,KSP *ksp)
9509b94acceSBarry Smith {
9511cee3971SBarry Smith   PetscErrorCode ierr;
9521cee3971SBarry Smith 
9533a40ed3dSBarry Smith   PetscFunctionBegin;
9540700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
9554482741eSBarry Smith   PetscValidPointer(ksp,2);
9561cee3971SBarry Smith 
9571cee3971SBarry Smith   if (!snes->ksp) {
9581cee3971SBarry Smith     ierr = KSPCreate(((PetscObject)snes)->comm,&snes->ksp);CHKERRQ(ierr);
9591cee3971SBarry Smith     ierr = PetscObjectIncrementTabLevel((PetscObject)snes->ksp,(PetscObject)snes,1);CHKERRQ(ierr);
9601cee3971SBarry Smith     ierr = PetscLogObjectParent(snes,snes->ksp);CHKERRQ(ierr);
9611cee3971SBarry Smith   }
96294b7f48cSBarry Smith   *ksp = snes->ksp;
9633a40ed3dSBarry Smith   PetscFunctionReturn(0);
9649b94acceSBarry Smith }
96582bf6240SBarry Smith 
9664a2ae208SSatish Balay #undef __FUNCT__
9672999313aSBarry Smith #define __FUNCT__ "SNESSetKSP"
9682999313aSBarry Smith /*@
9692999313aSBarry Smith    SNESSetKSP - Sets a KSP context for the SNES object to use
9702999313aSBarry Smith 
9712999313aSBarry Smith    Not Collective, but the SNES and KSP objects must live on the same MPI_Comm
9722999313aSBarry Smith 
9732999313aSBarry Smith    Input Parameters:
9742999313aSBarry Smith +  snes - the SNES context
9752999313aSBarry Smith -  ksp - the KSP context
9762999313aSBarry Smith 
9772999313aSBarry Smith    Notes:
9782999313aSBarry Smith    The SNES object already has its KSP object, you can obtain with SNESGetKSP()
9792999313aSBarry Smith    so this routine is rarely needed.
9802999313aSBarry Smith 
9812999313aSBarry Smith    The KSP object that is already in the SNES object has its reference count
9822999313aSBarry Smith    decreased by one.
9832999313aSBarry Smith 
9842999313aSBarry Smith    Level: developer
9852999313aSBarry Smith 
9862999313aSBarry Smith .keywords: SNES, nonlinear, get, KSP, context
9872999313aSBarry Smith 
9882999313aSBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP()
9892999313aSBarry Smith @*/
9907087cfbeSBarry Smith PetscErrorCode  SNESSetKSP(SNES snes,KSP ksp)
9912999313aSBarry Smith {
9922999313aSBarry Smith   PetscErrorCode ierr;
9932999313aSBarry Smith 
9942999313aSBarry Smith   PetscFunctionBegin;
9950700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
9960700a824SBarry Smith   PetscValidHeaderSpecific(ksp,KSP_CLASSID,2);
9972999313aSBarry Smith   PetscCheckSameComm(snes,1,ksp,2);
9987dcf0eaaSdalcinl   ierr = PetscObjectReference((PetscObject)ksp);CHKERRQ(ierr);
999906ed7ccSBarry Smith   if (snes->ksp) {ierr = PetscObjectDereference((PetscObject)snes->ksp);CHKERRQ(ierr);}
10002999313aSBarry Smith   snes->ksp = ksp;
10012999313aSBarry Smith   PetscFunctionReturn(0);
10022999313aSBarry Smith }
10032999313aSBarry Smith 
10047adad957SLisandro Dalcin #if 0
10052999313aSBarry Smith #undef __FUNCT__
10064a2ae208SSatish Balay #define __FUNCT__ "SNESPublish_Petsc"
10076849ba73SBarry Smith static PetscErrorCode SNESPublish_Petsc(PetscObject obj)
1008e24b481bSBarry Smith {
1009e24b481bSBarry Smith   PetscFunctionBegin;
1010e24b481bSBarry Smith   PetscFunctionReturn(0);
1011e24b481bSBarry Smith }
10127adad957SLisandro Dalcin #endif
1013e24b481bSBarry Smith 
10149b94acceSBarry Smith /* -----------------------------------------------------------*/
10154a2ae208SSatish Balay #undef __FUNCT__
10164a2ae208SSatish Balay #define __FUNCT__ "SNESCreate"
101752baeb72SSatish Balay /*@
10189b94acceSBarry Smith    SNESCreate - Creates a nonlinear solver context.
10199b94acceSBarry Smith 
1020c7afd0dbSLois Curfman McInnes    Collective on MPI_Comm
1021c7afd0dbSLois Curfman McInnes 
1022c7afd0dbSLois Curfman McInnes    Input Parameters:
1023906ed7ccSBarry Smith .  comm - MPI communicator
10249b94acceSBarry Smith 
10259b94acceSBarry Smith    Output Parameter:
10269b94acceSBarry Smith .  outsnes - the new SNES context
10279b94acceSBarry Smith 
1028c7afd0dbSLois Curfman McInnes    Options Database Keys:
1029c7afd0dbSLois Curfman McInnes +   -snes_mf - Activates default matrix-free Jacobian-vector products,
1030c7afd0dbSLois Curfman McInnes                and no preconditioning matrix
1031c7afd0dbSLois Curfman McInnes .   -snes_mf_operator - Activates default matrix-free Jacobian-vector
1032c7afd0dbSLois Curfman McInnes                products, and a user-provided preconditioning matrix
1033c7afd0dbSLois Curfman McInnes                as set by SNESSetJacobian()
1034c7afd0dbSLois Curfman McInnes -   -snes_fd - Uses (slow!) finite differences to compute Jacobian
1035c1f60f51SBarry Smith 
103636851e7fSLois Curfman McInnes    Level: beginner
103736851e7fSLois Curfman McInnes 
10389b94acceSBarry Smith .keywords: SNES, nonlinear, create, context
10399b94acceSBarry Smith 
1040a8054027SBarry Smith .seealso: SNESSolve(), SNESDestroy(), SNES, SNESSetLagPreconditioner()
1041a8054027SBarry Smith 
10429b94acceSBarry Smith @*/
10437087cfbeSBarry Smith PetscErrorCode  SNESCreate(MPI_Comm comm,SNES *outsnes)
10449b94acceSBarry Smith {
1045dfbe8321SBarry Smith   PetscErrorCode      ierr;
10469b94acceSBarry Smith   SNES                snes;
1047fa9f3622SBarry Smith   SNESKSPEW           *kctx;
104837fcc0dbSBarry Smith 
10493a40ed3dSBarry Smith   PetscFunctionBegin;
1050ed1caa07SMatthew Knepley   PetscValidPointer(outsnes,2);
10518ba1e511SMatthew Knepley   *outsnes = PETSC_NULL;
10528ba1e511SMatthew Knepley #ifndef PETSC_USE_DYNAMIC_LIBRARIES
10538ba1e511SMatthew Knepley   ierr = SNESInitializePackage(PETSC_NULL);CHKERRQ(ierr);
10548ba1e511SMatthew Knepley #endif
10558ba1e511SMatthew Knepley 
10563194b578SJed Brown   ierr = PetscHeaderCreate(snes,_p_SNES,struct _SNESOps,SNES_CLASSID,0,"SNES","Nonlinear solver","SNES",comm,SNESDestroy,SNESView);CHKERRQ(ierr);
10577adad957SLisandro Dalcin 
105885385478SLisandro Dalcin   snes->ops->converged    = SNESDefaultConverged;
10592c155ee1SBarry Smith   snes->usesksp           = PETSC_TRUE;
10609b94acceSBarry Smith   snes->max_its           = 50;
10619750a799SBarry Smith   snes->max_funcs	  = 10000;
10629b94acceSBarry Smith   snes->norm		  = 0.0;
1063b4874afaSBarry Smith   snes->rtol		  = 1.e-8;
1064b4874afaSBarry Smith   snes->ttol              = 0.0;
106570441072SBarry Smith   snes->abstol		  = 1.e-50;
10669b94acceSBarry Smith   snes->xtol		  = 1.e-8;
10674b27c08aSLois Curfman McInnes   snes->deltatol	  = 1.e-12;
10689b94acceSBarry Smith   snes->nfuncs            = 0;
106950ffb88aSMatthew Knepley   snes->numFailures       = 0;
107050ffb88aSMatthew Knepley   snes->maxFailures       = 1;
10717a00f4a9SLois Curfman McInnes   snes->linear_its        = 0;
1072e35cf81dSBarry Smith   snes->lagjacobian       = 1;
1073a8054027SBarry Smith   snes->lagpreconditioner = 1;
1074639f9d9dSBarry Smith   snes->numbermonitors    = 0;
10759b94acceSBarry Smith   snes->data              = 0;
10764dc4c822SBarry Smith   snes->setupcalled       = PETSC_FALSE;
1077186905e3SBarry Smith   snes->ksp_ewconv        = PETSC_FALSE;
10786f24a144SLois Curfman McInnes   snes->nwork             = 0;
107958c9b817SLisandro Dalcin   snes->work              = 0;
108058c9b817SLisandro Dalcin   snes->nvwork            = 0;
108158c9b817SLisandro Dalcin   snes->vwork             = 0;
1082758f92a0SBarry Smith   snes->conv_hist_len     = 0;
1083758f92a0SBarry Smith   snes->conv_hist_max     = 0;
1084758f92a0SBarry Smith   snes->conv_hist         = PETSC_NULL;
1085758f92a0SBarry Smith   snes->conv_hist_its     = PETSC_NULL;
1086758f92a0SBarry Smith   snes->conv_hist_reset   = PETSC_TRUE;
1087184914b5SBarry Smith   snes->reason            = SNES_CONVERGED_ITERATING;
10889b94acceSBarry Smith 
10893d4c4710SBarry Smith   snes->numLinearSolveFailures = 0;
10903d4c4710SBarry Smith   snes->maxLinearSolveFailures = 1;
10913d4c4710SBarry Smith 
10929b94acceSBarry Smith   /* Create context to compute Eisenstat-Walker relative tolerance for KSP */
109338f2d2fdSLisandro Dalcin   ierr = PetscNewLog(snes,SNESKSPEW,&kctx);CHKERRQ(ierr);
10949b94acceSBarry Smith   snes->kspconvctx  = (void*)kctx;
10959b94acceSBarry Smith   kctx->version     = 2;
10969b94acceSBarry Smith   kctx->rtol_0      = .3; /* Eisenstat and Walker suggest rtol_0=.5, but
10979b94acceSBarry Smith                              this was too large for some test cases */
109875567043SBarry Smith   kctx->rtol_last   = 0.0;
10999b94acceSBarry Smith   kctx->rtol_max    = .9;
11009b94acceSBarry Smith   kctx->gamma       = 1.0;
110171f87433Sdalcinl   kctx->alpha       = .5*(1.0 + sqrt(5.0));
110271f87433Sdalcinl   kctx->alpha2      = kctx->alpha;
11039b94acceSBarry Smith   kctx->threshold   = .1;
110475567043SBarry Smith   kctx->lresid_last = 0.0;
110575567043SBarry Smith   kctx->norm_last   = 0.0;
11069b94acceSBarry Smith 
11079b94acceSBarry Smith   *outsnes = snes;
11083a40ed3dSBarry Smith   PetscFunctionReturn(0);
11099b94acceSBarry Smith }
11109b94acceSBarry Smith 
11114a2ae208SSatish Balay #undef __FUNCT__
11124a2ae208SSatish Balay #define __FUNCT__ "SNESSetFunction"
11139b94acceSBarry Smith /*@C
11149b94acceSBarry Smith    SNESSetFunction - Sets the function evaluation routine and function
11159b94acceSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
11169b94acceSBarry Smith    equations.
11179b94acceSBarry Smith 
11183f9fe445SBarry Smith    Logically Collective on SNES
1119fee21e36SBarry Smith 
1120c7afd0dbSLois Curfman McInnes    Input Parameters:
1121c7afd0dbSLois Curfman McInnes +  snes - the SNES context
1122c7afd0dbSLois Curfman McInnes .  r - vector to store function value
1123de044059SHong Zhang .  func - function evaluation routine
1124c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined context for private data for the
1125c7afd0dbSLois Curfman McInnes          function evaluation routine (may be PETSC_NULL)
11269b94acceSBarry Smith 
1127c7afd0dbSLois Curfman McInnes    Calling sequence of func:
11288d76a1e5SLois Curfman McInnes $    func (SNES snes,Vec x,Vec f,void *ctx);
1129c7afd0dbSLois Curfman McInnes 
1130313e4042SLois Curfman McInnes .  f - function vector
1131c7afd0dbSLois Curfman McInnes -  ctx - optional user-defined function context
11329b94acceSBarry Smith 
11339b94acceSBarry Smith    Notes:
11349b94acceSBarry Smith    The Newton-like methods typically solve linear systems of the form
11359b94acceSBarry Smith $      f'(x) x = -f(x),
1136c7afd0dbSLois Curfman McInnes    where f'(x) denotes the Jacobian matrix and f(x) is the function.
11379b94acceSBarry Smith 
113836851e7fSLois Curfman McInnes    Level: beginner
113936851e7fSLois Curfman McInnes 
11409b94acceSBarry Smith .keywords: SNES, nonlinear, set, function
11419b94acceSBarry Smith 
1142a86d99e1SLois Curfman McInnes .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian()
11439b94acceSBarry Smith @*/
11447087cfbeSBarry Smith PetscErrorCode  SNESSetFunction(SNES snes,Vec r,PetscErrorCode (*func)(SNES,Vec,Vec,void*),void *ctx)
11459b94acceSBarry Smith {
114685385478SLisandro Dalcin   PetscErrorCode ierr;
11473a40ed3dSBarry Smith   PetscFunctionBegin;
11480700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1149d2a683ecSLisandro Dalcin   if (r) {
1150d2a683ecSLisandro Dalcin     PetscValidHeaderSpecific(r,VEC_CLASSID,2);
1151d2a683ecSLisandro Dalcin     PetscCheckSameComm(snes,1,r,2);
115285385478SLisandro Dalcin     ierr = PetscObjectReference((PetscObject)r);CHKERRQ(ierr);
11536bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr);
115485385478SLisandro Dalcin     snes->vec_func = r;
1155d2a683ecSLisandro Dalcin   } else if (!snes->vec_func && snes->dm) {
1156d2a683ecSLisandro Dalcin     ierr = DMCreateGlobalVector(snes->dm,&snes->vec_func);CHKERRQ(ierr);
1157d2a683ecSLisandro Dalcin   }
1158d2a683ecSLisandro Dalcin   if (func) snes->ops->computefunction = func;
1159d2a683ecSLisandro Dalcin   if (ctx)  snes->funP                 = ctx;
11603a40ed3dSBarry Smith   PetscFunctionReturn(0);
11619b94acceSBarry Smith }
11629b94acceSBarry Smith 
1163d25893d9SBarry Smith #undef __FUNCT__
1164d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeInitialGuess"
1165d25893d9SBarry Smith /*@C
1166d25893d9SBarry Smith    SNESSetComputeInitialGuess - Sets a routine used to compute an initial guess for the problem
1167d25893d9SBarry Smith 
1168d25893d9SBarry Smith    Logically Collective on SNES
1169d25893d9SBarry Smith 
1170d25893d9SBarry Smith    Input Parameters:
1171d25893d9SBarry Smith +  snes - the SNES context
1172d25893d9SBarry Smith .  func - function evaluation routine
1173d25893d9SBarry Smith -  ctx - [optional] user-defined context for private data for the
1174d25893d9SBarry Smith          function evaluation routine (may be PETSC_NULL)
1175d25893d9SBarry Smith 
1176d25893d9SBarry Smith    Calling sequence of func:
1177d25893d9SBarry Smith $    func (SNES snes,Vec x,void *ctx);
1178d25893d9SBarry Smith 
1179d25893d9SBarry Smith .  f - function vector
1180d25893d9SBarry Smith -  ctx - optional user-defined function context
1181d25893d9SBarry Smith 
1182d25893d9SBarry Smith    Level: intermediate
1183d25893d9SBarry Smith 
1184d25893d9SBarry Smith .keywords: SNES, nonlinear, set, function
1185d25893d9SBarry Smith 
1186d25893d9SBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian()
1187d25893d9SBarry Smith @*/
1188d25893d9SBarry Smith PetscErrorCode  SNESSetComputeInitialGuess(SNES snes,PetscErrorCode (*func)(SNES,Vec,void*),void *ctx)
1189d25893d9SBarry Smith {
1190d25893d9SBarry Smith   PetscFunctionBegin;
1191d25893d9SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1192d25893d9SBarry Smith   if (func) snes->ops->computeinitialguess = func;
1193d25893d9SBarry Smith   if (ctx)  snes->initialguessP            = ctx;
1194d25893d9SBarry Smith   PetscFunctionReturn(0);
1195d25893d9SBarry Smith }
1196d25893d9SBarry Smith 
11973ab0aad5SBarry Smith /* --------------------------------------------------------------- */
11983ab0aad5SBarry Smith #undef __FUNCT__
11991096aae1SMatthew Knepley #define __FUNCT__ "SNESGetRhs"
12001096aae1SMatthew Knepley /*@C
12011096aae1SMatthew Knepley    SNESGetRhs - Gets the vector for solving F(x) = rhs. If rhs is not set
12021096aae1SMatthew Knepley    it assumes a zero right hand side.
12031096aae1SMatthew Knepley 
12043f9fe445SBarry Smith    Logically Collective on SNES
12051096aae1SMatthew Knepley 
12061096aae1SMatthew Knepley    Input Parameter:
12071096aae1SMatthew Knepley .  snes - the SNES context
12081096aae1SMatthew Knepley 
12091096aae1SMatthew Knepley    Output Parameter:
1210bc08b0f1SBarry Smith .  rhs - the right hand side vector or PETSC_NULL if the right hand side vector is null
12111096aae1SMatthew Knepley 
12121096aae1SMatthew Knepley    Level: intermediate
12131096aae1SMatthew Knepley 
12141096aae1SMatthew Knepley .keywords: SNES, nonlinear, get, function, right hand side
12151096aae1SMatthew Knepley 
121685385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
12171096aae1SMatthew Knepley @*/
12187087cfbeSBarry Smith PetscErrorCode  SNESGetRhs(SNES snes,Vec *rhs)
12191096aae1SMatthew Knepley {
12201096aae1SMatthew Knepley   PetscFunctionBegin;
12210700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
12221096aae1SMatthew Knepley   PetscValidPointer(rhs,2);
122385385478SLisandro Dalcin   *rhs = snes->vec_rhs;
12241096aae1SMatthew Knepley   PetscFunctionReturn(0);
12251096aae1SMatthew Knepley }
12261096aae1SMatthew Knepley 
12271096aae1SMatthew Knepley #undef __FUNCT__
12284a2ae208SSatish Balay #define __FUNCT__ "SNESComputeFunction"
12299b94acceSBarry Smith /*@
123036851e7fSLois Curfman McInnes    SNESComputeFunction - Calls the function that has been set with
12319b94acceSBarry Smith                          SNESSetFunction().
12329b94acceSBarry Smith 
1233c7afd0dbSLois Curfman McInnes    Collective on SNES
1234c7afd0dbSLois Curfman McInnes 
12359b94acceSBarry Smith    Input Parameters:
1236c7afd0dbSLois Curfman McInnes +  snes - the SNES context
1237c7afd0dbSLois Curfman McInnes -  x - input vector
12389b94acceSBarry Smith 
12399b94acceSBarry Smith    Output Parameter:
12403638b69dSLois Curfman McInnes .  y - function vector, as set by SNESSetFunction()
12419b94acceSBarry Smith 
12421bffabb2SLois Curfman McInnes    Notes:
124336851e7fSLois Curfman McInnes    SNESComputeFunction() is typically used within nonlinear solvers
124436851e7fSLois Curfman McInnes    implementations, so most users would not generally call this routine
124536851e7fSLois Curfman McInnes    themselves.
124636851e7fSLois Curfman McInnes 
124736851e7fSLois Curfman McInnes    Level: developer
124836851e7fSLois Curfman McInnes 
12499b94acceSBarry Smith .keywords: SNES, nonlinear, compute, function
12509b94acceSBarry Smith 
1251a86d99e1SLois Curfman McInnes .seealso: SNESSetFunction(), SNESGetFunction()
12529b94acceSBarry Smith @*/
12537087cfbeSBarry Smith PetscErrorCode  SNESComputeFunction(SNES snes,Vec x,Vec y)
12549b94acceSBarry Smith {
1255dfbe8321SBarry Smith   PetscErrorCode ierr;
12569b94acceSBarry Smith 
12573a40ed3dSBarry Smith   PetscFunctionBegin;
12580700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
12590700a824SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
12600700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
1261c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,x,2);
1262c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,y,3);
1263184914b5SBarry Smith 
1264d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr);
1265e7788613SBarry Smith   if (snes->ops->computefunction) {
1266d64ed03dSBarry Smith     PetscStackPush("SNES user function");
126739d508bbSBarry Smith     ierr = (*snes->ops->computefunction)(snes,x,y,snes->funP);CHKERRQ(ierr);
1268d64ed03dSBarry Smith     PetscStackPop;
126985385478SLisandro Dalcin   } else if (snes->vec_rhs) {
12701096aae1SMatthew Knepley     ierr = MatMult(snes->jacobian, x, y);CHKERRQ(ierr);
127173250ac0SBarry Smith   } else if (snes->dm) {
1272644e2e5bSBarry Smith     ierr = DMComputeFunction(snes->dm,x,y);CHKERRQ(ierr);
1273644e2e5bSBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetFunction() or SNESSetDM() before SNESComputeFunction(), likely called from SNESSolve().");
127485385478SLisandro Dalcin   if (snes->vec_rhs) {
127585385478SLisandro Dalcin     ierr = VecAXPY(y,-1.0,snes->vec_rhs);CHKERRQ(ierr);
12763ab0aad5SBarry Smith   }
1277ae3c334cSLois Curfman McInnes   snes->nfuncs++;
1278d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr);
12793a40ed3dSBarry Smith   PetscFunctionReturn(0);
12809b94acceSBarry Smith }
12819b94acceSBarry Smith 
12824a2ae208SSatish Balay #undef __FUNCT__
12834a2ae208SSatish Balay #define __FUNCT__ "SNESComputeJacobian"
128462fef451SLois Curfman McInnes /*@
128562fef451SLois Curfman McInnes    SNESComputeJacobian - Computes the Jacobian matrix that has been
128662fef451SLois Curfman McInnes    set with SNESSetJacobian().
128762fef451SLois Curfman McInnes 
1288c7afd0dbSLois Curfman McInnes    Collective on SNES and Mat
1289c7afd0dbSLois Curfman McInnes 
129062fef451SLois Curfman McInnes    Input Parameters:
1291c7afd0dbSLois Curfman McInnes +  snes - the SNES context
1292c7afd0dbSLois Curfman McInnes -  x - input vector
129362fef451SLois Curfman McInnes 
129462fef451SLois Curfman McInnes    Output Parameters:
1295c7afd0dbSLois Curfman McInnes +  A - Jacobian matrix
129662fef451SLois Curfman McInnes .  B - optional preconditioning matrix
12972b668275SBarry Smith -  flag - flag indicating matrix structure (one of, SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER)
1298fee21e36SBarry Smith 
1299e35cf81dSBarry Smith   Options Database Keys:
1300e35cf81dSBarry Smith +    -snes_lag_preconditioner <lag>
1301693365a8SJed Brown .    -snes_lag_jacobian <lag>
1302693365a8SJed Brown .    -snes_compare_explicit - Compare the computed Jacobian to the finite difference Jacobian and output the differences
1303693365a8SJed Brown .    -snes_compare_explicit_draw  - Compare the computed Jacobian to the finite difference Jacobian and draw the result
1304693365a8SJed Brown .    -snes_compare_explicit_contour  - Compare the computed Jacobian to the finite difference Jacobian and draw a contour plot with the result
1305693365a8SJed Brown -    -snes_compare_operator  - Make the comparison options above use the operator instead of the preconditioning matrix
1306e35cf81dSBarry Smith 
130762fef451SLois Curfman McInnes    Notes:
130862fef451SLois Curfman McInnes    Most users should not need to explicitly call this routine, as it
130962fef451SLois Curfman McInnes    is used internally within the nonlinear solvers.
131062fef451SLois Curfman McInnes 
131194b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
1312dc5a77f8SLois Curfman McInnes    flag parameter.
131362fef451SLois Curfman McInnes 
131436851e7fSLois Curfman McInnes    Level: developer
131536851e7fSLois Curfman McInnes 
131662fef451SLois Curfman McInnes .keywords: SNES, compute, Jacobian, matrix
131762fef451SLois Curfman McInnes 
1318e35cf81dSBarry Smith .seealso:  SNESSetJacobian(), KSPSetOperators(), MatStructure, SNESSetLagPreconditioner(), SNESSetLagJacobian()
131962fef451SLois Curfman McInnes @*/
13207087cfbeSBarry Smith PetscErrorCode  SNESComputeJacobian(SNES snes,Vec X,Mat *A,Mat *B,MatStructure *flg)
13219b94acceSBarry Smith {
1322dfbe8321SBarry Smith   PetscErrorCode ierr;
1323ace3abfcSBarry Smith   PetscBool      flag;
13243a40ed3dSBarry Smith 
13253a40ed3dSBarry Smith   PetscFunctionBegin;
13260700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
13270700a824SBarry Smith   PetscValidHeaderSpecific(X,VEC_CLASSID,2);
13284482741eSBarry Smith   PetscValidPointer(flg,5);
1329c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,X,2);
1330e7788613SBarry Smith   if (!snes->ops->computejacobian) PetscFunctionReturn(0);
1331ebd3b9afSBarry Smith 
1332ebd3b9afSBarry Smith   /* make sure that MatAssemblyBegin/End() is called on A matrix if it is matrix free */
1333ebd3b9afSBarry Smith 
1334fe3ffe1eSBarry Smith   if (snes->lagjacobian == -2) {
1335fe3ffe1eSBarry Smith     snes->lagjacobian = -1;
1336fe3ffe1eSBarry Smith     ierr = PetscInfo(snes,"Recomputing Jacobian/preconditioner because lag is -2 (means compute Jacobian, but then never again) \n");CHKERRQ(ierr);
1337fe3ffe1eSBarry Smith   } else if (snes->lagjacobian == -1) {
1338e35cf81dSBarry Smith     *flg = SAME_PRECONDITIONER;
1339e35cf81dSBarry Smith     ierr = PetscInfo(snes,"Reusing Jacobian/preconditioner because lag is -1\n");CHKERRQ(ierr);
1340ebd3b9afSBarry Smith     ierr = PetscTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr);
1341ebd3b9afSBarry Smith     if (flag) {
1342ebd3b9afSBarry Smith       ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1343ebd3b9afSBarry Smith       ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1344ebd3b9afSBarry Smith     }
1345e35cf81dSBarry Smith     PetscFunctionReturn(0);
1346e35cf81dSBarry Smith   } else if (snes->lagjacobian > 1 && snes->iter % snes->lagjacobian) {
1347e35cf81dSBarry Smith     *flg = SAME_PRECONDITIONER;
1348e35cf81dSBarry Smith     ierr = PetscInfo2(snes,"Reusing Jacobian/preconditioner because lag is %D and SNES iteration is %D\n",snes->lagjacobian,snes->iter);CHKERRQ(ierr);
1349ebd3b9afSBarry Smith     ierr = PetscTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr);
1350ebd3b9afSBarry Smith     if (flag) {
1351ebd3b9afSBarry Smith       ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1352ebd3b9afSBarry Smith       ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1353ebd3b9afSBarry Smith     }
1354e35cf81dSBarry Smith     PetscFunctionReturn(0);
1355e35cf81dSBarry Smith   }
1356e35cf81dSBarry Smith 
1357c4fc05e7SBarry Smith   *flg = DIFFERENT_NONZERO_PATTERN;
1358e35cf81dSBarry Smith   ierr = PetscLogEventBegin(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr);
1359d64ed03dSBarry Smith   PetscStackPush("SNES user Jacobian function");
1360e7788613SBarry Smith   ierr = (*snes->ops->computejacobian)(snes,X,A,B,flg,snes->jacP);CHKERRQ(ierr);
1361d64ed03dSBarry Smith   PetscStackPop;
1362d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr);
1363a8054027SBarry Smith 
13643b4f5425SBarry Smith   if (snes->lagpreconditioner == -2) {
13653b4f5425SBarry Smith     ierr = PetscInfo(snes,"Rebuilding preconditioner exactly once since lag is -2\n");CHKERRQ(ierr);
13663b4f5425SBarry Smith     snes->lagpreconditioner = -1;
13673b4f5425SBarry Smith   } else if (snes->lagpreconditioner == -1) {
1368a8054027SBarry Smith     *flg = SAME_PRECONDITIONER;
1369a8054027SBarry Smith     ierr = PetscInfo(snes,"Reusing preconditioner because lag is -1\n");CHKERRQ(ierr);
1370a8054027SBarry Smith   } else if (snes->lagpreconditioner > 1 && snes->iter % snes->lagpreconditioner) {
1371a8054027SBarry Smith     *flg = SAME_PRECONDITIONER;
1372a8054027SBarry Smith     ierr = PetscInfo2(snes,"Reusing preconditioner because lag is %D and SNES iteration is %D\n",snes->lagpreconditioner,snes->iter);CHKERRQ(ierr);
1373a8054027SBarry Smith   }
1374a8054027SBarry Smith 
13756d84be18SBarry Smith   /* make sure user returned a correct Jacobian and preconditioner */
13760700a824SBarry Smith   /* PetscValidHeaderSpecific(*A,MAT_CLASSID,3);
13770700a824SBarry Smith     PetscValidHeaderSpecific(*B,MAT_CLASSID,4);   */
1378693365a8SJed Brown   {
1379693365a8SJed Brown     PetscBool flag = PETSC_FALSE,flag_draw = PETSC_FALSE,flag_contour = PETSC_FALSE,flag_operator = PETSC_FALSE;
1380693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit",&flag,PETSC_NULL);CHKERRQ(ierr);
1381693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw",&flag_draw,PETSC_NULL);CHKERRQ(ierr);
1382693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw_contour",&flag_contour,PETSC_NULL);CHKERRQ(ierr);
1383693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_operator",&flag_operator,PETSC_NULL);CHKERRQ(ierr);
1384693365a8SJed Brown     if (flag || flag_draw || flag_contour) {
1385693365a8SJed Brown       Mat Bexp_mine = PETSC_NULL,Bexp,FDexp;
1386693365a8SJed Brown       MatStructure mstruct;
1387693365a8SJed Brown       PetscViewer vdraw,vstdout;
13886b3a5b13SJed Brown       PetscBool flg;
1389693365a8SJed Brown       if (flag_operator) {
1390693365a8SJed Brown         ierr = MatComputeExplicitOperator(*A,&Bexp_mine);CHKERRQ(ierr);
1391693365a8SJed Brown         Bexp = Bexp_mine;
1392693365a8SJed Brown       } else {
1393693365a8SJed Brown         /* See if the preconditioning matrix can be viewed and added directly */
1394693365a8SJed Brown         ierr = PetscTypeCompareAny((PetscObject)*B,&flg,MATSEQAIJ,MATMPIAIJ,MATSEQDENSE,MATMPIDENSE,MATSEQBAIJ,MATMPIBAIJ,MATSEQSBAIJ,MATMPIBAIJ,"");CHKERRQ(ierr);
1395693365a8SJed Brown         if (flg) Bexp = *B;
1396693365a8SJed Brown         else {
1397693365a8SJed Brown           /* If the "preconditioning" matrix is itself MATSHELL or some other type without direct support */
1398693365a8SJed Brown           ierr = MatComputeExplicitOperator(*B,&Bexp_mine);CHKERRQ(ierr);
1399693365a8SJed Brown           Bexp = Bexp_mine;
1400693365a8SJed Brown         }
1401693365a8SJed Brown       }
1402693365a8SJed Brown       ierr = MatConvert(Bexp,MATSAME,MAT_INITIAL_MATRIX,&FDexp);CHKERRQ(ierr);
1403693365a8SJed Brown       ierr = SNESDefaultComputeJacobian(snes,X,&FDexp,&FDexp,&mstruct,NULL);CHKERRQ(ierr);
1404693365a8SJed Brown       ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&vstdout);CHKERRQ(ierr);
1405693365a8SJed Brown       if (flag_draw || flag_contour) {
1406693365a8SJed Brown         ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,0,"Explicit Jacobians",PETSC_DECIDE,PETSC_DECIDE,300,300,&vdraw);CHKERRQ(ierr);
1407693365a8SJed Brown         if (flag_contour) {ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);}
1408693365a8SJed Brown       } else vdraw = PETSC_NULL;
1409693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Explicit %s\n",flag_operator?"Jacobian":"preconditioning Jacobian");CHKERRQ(ierr);
1410693365a8SJed Brown       if (flag) {ierr = MatView(Bexp,vstdout);CHKERRQ(ierr);}
1411693365a8SJed Brown       if (vdraw) {ierr = MatView(Bexp,vdraw);CHKERRQ(ierr);}
1412693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Finite difference Jacobian\n");CHKERRQ(ierr);
1413693365a8SJed Brown       if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);}
1414693365a8SJed Brown       if (vdraw) {ierr = MatView(FDexp,vdraw);CHKERRQ(ierr);}
1415693365a8SJed Brown       ierr = MatAYPX(FDexp,-1.0,Bexp,SAME_NONZERO_PATTERN);CHKERRQ(ierr);
1416693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"User-provided matrix minus finite difference Jacobian\n");CHKERRQ(ierr);
1417693365a8SJed Brown       if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);}
1418693365a8SJed Brown       if (vdraw) {              /* Always use contour for the difference */
1419693365a8SJed Brown         ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);
1420693365a8SJed Brown         ierr = MatView(FDexp,vdraw);CHKERRQ(ierr);
1421693365a8SJed Brown         ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);
1422693365a8SJed Brown       }
1423693365a8SJed Brown       if (flag_contour) {ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);}
1424693365a8SJed Brown       ierr = PetscViewerDestroy(&vdraw);CHKERRQ(ierr);
1425693365a8SJed Brown       ierr = MatDestroy(&Bexp_mine);CHKERRQ(ierr);
1426693365a8SJed Brown       ierr = MatDestroy(&FDexp);CHKERRQ(ierr);
1427693365a8SJed Brown     }
1428693365a8SJed Brown   }
14293a40ed3dSBarry Smith   PetscFunctionReturn(0);
14309b94acceSBarry Smith }
14319b94acceSBarry Smith 
14324a2ae208SSatish Balay #undef __FUNCT__
14334a2ae208SSatish Balay #define __FUNCT__ "SNESSetJacobian"
14349b94acceSBarry Smith /*@C
14359b94acceSBarry Smith    SNESSetJacobian - Sets the function to compute Jacobian as well as the
1436044dda88SLois Curfman McInnes    location to store the matrix.
14379b94acceSBarry Smith 
14383f9fe445SBarry Smith    Logically Collective on SNES and Mat
1439c7afd0dbSLois Curfman McInnes 
14409b94acceSBarry Smith    Input Parameters:
1441c7afd0dbSLois Curfman McInnes +  snes - the SNES context
14429b94acceSBarry Smith .  A - Jacobian matrix
14439b94acceSBarry Smith .  B - preconditioner matrix (usually same as the Jacobian)
1444efd51863SBarry Smith .  func - Jacobian evaluation routine (if PETSC_NULL then SNES retains any previously set value)
1445c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined context for private data for the
1446efd51863SBarry Smith          Jacobian evaluation routine (may be PETSC_NULL) (if PETSC_NULL then SNES retains any previously set value)
14479b94acceSBarry Smith 
14489b94acceSBarry Smith    Calling sequence of func:
14498d76a1e5SLois Curfman McInnes $     func (SNES snes,Vec x,Mat *A,Mat *B,int *flag,void *ctx);
14509b94acceSBarry Smith 
1451c7afd0dbSLois Curfman McInnes +  x - input vector
14529b94acceSBarry Smith .  A - Jacobian matrix
14539b94acceSBarry Smith .  B - preconditioner matrix, usually the same as A
1454ac21db08SLois Curfman McInnes .  flag - flag indicating information about the preconditioner matrix
14552b668275SBarry Smith    structure (same as flag in KSPSetOperators()), one of SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER
1456c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined Jacobian context
14579b94acceSBarry Smith 
14589b94acceSBarry Smith    Notes:
145994b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the flag
14602cd2dfdcSLois Curfman McInnes    output parameter in the routine func().  Be sure to read this information!
1461ac21db08SLois Curfman McInnes 
1462ac21db08SLois Curfman McInnes    The routine func() takes Mat * as the matrix arguments rather than Mat.
14639b94acceSBarry Smith    This allows the Jacobian evaluation routine to replace A and/or B with a
14649b94acceSBarry Smith    completely new new matrix structure (not just different matrix elements)
14659b94acceSBarry Smith    when appropriate, for instance, if the nonzero structure is changing
14669b94acceSBarry Smith    throughout the global iterations.
14679b94acceSBarry Smith 
146816913363SBarry Smith    If the A matrix and B matrix are different you must call MatAssemblyBegin/End() on
146916913363SBarry Smith    each matrix.
147016913363SBarry Smith 
1471a8a26c1eSJed Brown    If using SNESDefaultComputeJacobianColor() to assemble a Jacobian, the ctx argument
1472a8a26c1eSJed Brown    must be a MatFDColoring.
1473a8a26c1eSJed Brown 
1474*c3cc8fd1SJed Brown    Other defect-correction schemes can be used by computing a different matrix in place of the Jacobian.  One common
1475*c3cc8fd1SJed Brown    example is to use the "Picard linearization" which only differentiates through the highest order parts of each term.
1476*c3cc8fd1SJed Brown 
147736851e7fSLois Curfman McInnes    Level: beginner
147836851e7fSLois Curfman McInnes 
14799b94acceSBarry Smith .keywords: SNES, nonlinear, set, Jacobian, matrix
14809b94acceSBarry Smith 
14813ec795f1SBarry Smith .seealso: KSPSetOperators(), SNESSetFunction(), MatMFFDComputeJacobian(), SNESDefaultComputeJacobianColor(), MatStructure
14829b94acceSBarry Smith @*/
14837087cfbeSBarry Smith PetscErrorCode  SNESSetJacobian(SNES snes,Mat A,Mat B,PetscErrorCode (*func)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *ctx)
14849b94acceSBarry Smith {
1485dfbe8321SBarry Smith   PetscErrorCode ierr;
14863a7fca6bSBarry Smith 
14873a40ed3dSBarry Smith   PetscFunctionBegin;
14880700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
14890700a824SBarry Smith   if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2);
14900700a824SBarry Smith   if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3);
1491c9780b6fSBarry Smith   if (A) PetscCheckSameComm(snes,1,A,2);
149206975374SJed Brown   if (B) PetscCheckSameComm(snes,1,B,3);
1493e7788613SBarry Smith   if (func) snes->ops->computejacobian = func;
14943a7fca6bSBarry Smith   if (ctx)  snes->jacP                 = ctx;
14953a7fca6bSBarry Smith   if (A) {
14967dcf0eaaSdalcinl     ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
14976bf464f9SBarry Smith     ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr);
14989b94acceSBarry Smith     snes->jacobian = A;
14993a7fca6bSBarry Smith   }
15003a7fca6bSBarry Smith   if (B) {
15017dcf0eaaSdalcinl     ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
15026bf464f9SBarry Smith     ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr);
15039b94acceSBarry Smith     snes->jacobian_pre = B;
15043a7fca6bSBarry Smith   }
15053a40ed3dSBarry Smith   PetscFunctionReturn(0);
15069b94acceSBarry Smith }
150762fef451SLois Curfman McInnes 
15084a2ae208SSatish Balay #undef __FUNCT__
15094a2ae208SSatish Balay #define __FUNCT__ "SNESGetJacobian"
1510c2aafc4cSSatish Balay /*@C
1511b4fd4287SBarry Smith    SNESGetJacobian - Returns the Jacobian matrix and optionally the user
1512b4fd4287SBarry Smith    provided context for evaluating the Jacobian.
1513b4fd4287SBarry Smith 
1514c7afd0dbSLois Curfman McInnes    Not Collective, but Mat object will be parallel if SNES object is
1515c7afd0dbSLois Curfman McInnes 
1516b4fd4287SBarry Smith    Input Parameter:
1517b4fd4287SBarry Smith .  snes - the nonlinear solver context
1518b4fd4287SBarry Smith 
1519b4fd4287SBarry Smith    Output Parameters:
1520c7afd0dbSLois Curfman McInnes +  A - location to stash Jacobian matrix (or PETSC_NULL)
1521b4fd4287SBarry Smith .  B - location to stash preconditioner matrix (or PETSC_NULL)
152270e92668SMatthew Knepley .  func - location to put Jacobian function (or PETSC_NULL)
152370e92668SMatthew Knepley -  ctx - location to stash Jacobian ctx (or PETSC_NULL)
1524fee21e36SBarry Smith 
152536851e7fSLois Curfman McInnes    Level: advanced
152636851e7fSLois Curfman McInnes 
1527b4fd4287SBarry Smith .seealso: SNESSetJacobian(), SNESComputeJacobian()
1528b4fd4287SBarry Smith @*/
15297087cfbeSBarry Smith PetscErrorCode  SNESGetJacobian(SNES snes,Mat *A,Mat *B,PetscErrorCode (**func)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **ctx)
1530b4fd4287SBarry Smith {
15313a40ed3dSBarry Smith   PetscFunctionBegin;
15320700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1533b4fd4287SBarry Smith   if (A)    *A    = snes->jacobian;
1534b4fd4287SBarry Smith   if (B)    *B    = snes->jacobian_pre;
1535e7788613SBarry Smith   if (func) *func = snes->ops->computejacobian;
153670e92668SMatthew Knepley   if (ctx)  *ctx  = snes->jacP;
15373a40ed3dSBarry Smith   PetscFunctionReturn(0);
1538b4fd4287SBarry Smith }
1539b4fd4287SBarry Smith 
15409b94acceSBarry Smith /* ----- Routines to initialize and destroy a nonlinear solver ---- */
15419b94acceSBarry Smith 
15424a2ae208SSatish Balay #undef __FUNCT__
15434a2ae208SSatish Balay #define __FUNCT__ "SNESSetUp"
15449b94acceSBarry Smith /*@
15459b94acceSBarry Smith    SNESSetUp - Sets up the internal data structures for the later use
1546272ac6f2SLois Curfman McInnes    of a nonlinear solver.
15479b94acceSBarry Smith 
1548fee21e36SBarry Smith    Collective on SNES
1549fee21e36SBarry Smith 
1550c7afd0dbSLois Curfman McInnes    Input Parameters:
155170e92668SMatthew Knepley .  snes - the SNES context
1552c7afd0dbSLois Curfman McInnes 
1553272ac6f2SLois Curfman McInnes    Notes:
1554272ac6f2SLois Curfman McInnes    For basic use of the SNES solvers the user need not explicitly call
1555272ac6f2SLois Curfman McInnes    SNESSetUp(), since these actions will automatically occur during
1556272ac6f2SLois Curfman McInnes    the call to SNESSolve().  However, if one wishes to control this
1557272ac6f2SLois Curfman McInnes    phase separately, SNESSetUp() should be called after SNESCreate()
1558272ac6f2SLois Curfman McInnes    and optional routines of the form SNESSetXXX(), but before SNESSolve().
1559272ac6f2SLois Curfman McInnes 
156036851e7fSLois Curfman McInnes    Level: advanced
156136851e7fSLois Curfman McInnes 
15629b94acceSBarry Smith .keywords: SNES, nonlinear, setup
15639b94acceSBarry Smith 
15649b94acceSBarry Smith .seealso: SNESCreate(), SNESSolve(), SNESDestroy()
15659b94acceSBarry Smith @*/
15667087cfbeSBarry Smith PetscErrorCode  SNESSetUp(SNES snes)
15679b94acceSBarry Smith {
1568dfbe8321SBarry Smith   PetscErrorCode ierr;
15693a40ed3dSBarry Smith 
15703a40ed3dSBarry Smith   PetscFunctionBegin;
15710700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
15724dc4c822SBarry Smith   if (snes->setupcalled) PetscFunctionReturn(0);
15739b94acceSBarry Smith 
15747adad957SLisandro Dalcin   if (!((PetscObject)snes)->type_name) {
157585385478SLisandro Dalcin     ierr = SNESSetType(snes,SNESLS);CHKERRQ(ierr);
157685385478SLisandro Dalcin   }
157785385478SLisandro Dalcin 
1578c9b9fda1SJed Brown   if (!snes->vec_func) {
1579c9b9fda1SJed Brown     if (snes->vec_rhs) {
1580c9b9fda1SJed Brown       ierr = VecDuplicate(snes->vec_rhs,&snes->vec_func);CHKERRQ(ierr);
1581c9b9fda1SJed Brown     } else if (snes->vec_sol) {
1582c9b9fda1SJed Brown       ierr = VecDuplicate(snes->vec_sol,&snes->vec_func);CHKERRQ(ierr);
1583c9b9fda1SJed Brown     } else if (snes->dm) {
1584efd51863SBarry Smith       ierr = DMCreateGlobalVector(snes->dm,&snes->vec_func);CHKERRQ(ierr);
1585efd51863SBarry Smith     }
1586c9b9fda1SJed Brown   }
158717186662SBarry Smith   if (snes->vec_func == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be function vector");
158858c9b817SLisandro Dalcin   if (snes->vec_rhs  == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be right hand side vector");
158958c9b817SLisandro Dalcin 
159058c9b817SLisandro Dalcin   if (!snes->vec_sol_update /* && snes->vec_sol */) {
159158c9b817SLisandro Dalcin     ierr = VecDuplicate(snes->vec_sol,&snes->vec_sol_update);CHKERRQ(ierr);
159258c9b817SLisandro Dalcin     ierr = PetscLogObjectParent(snes,snes->vec_sol_update);CHKERRQ(ierr);
159358c9b817SLisandro Dalcin   }
159458c9b817SLisandro Dalcin 
1595ef8dffc7SBarry Smith   if (!snes->ops->computejacobian && snes->dm) {
1596ef8dffc7SBarry Smith     Mat J;
1597ef8dffc7SBarry Smith     ierr = DMGetMatrix(snes->dm,MATAIJ,&J);CHKERRQ(ierr);
1598cab2e9ccSBarry Smith     ierr = SNESSetJacobian(snes,J,J,SNESDMComputeJacobian,PETSC_NULL);CHKERRQ(ierr);
1599cab2e9ccSBarry Smith     ierr = MatDestroy(&J);CHKERRQ(ierr);
16002ef29e96SBarry Smith   } else if (!snes->jacobian && snes->ops->computejacobian == MatMFFDComputeJacobian) {
1601a8248277SBarry Smith     Mat J;
1602a8248277SBarry Smith     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
1603a8248277SBarry Smith     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
1604a8248277SBarry Smith     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
1605a8248277SBarry Smith     ierr = SNESSetJacobian(snes,J,J,MatMFFDComputeJacobian,snes->funP);CHKERRQ(ierr);
1606a8248277SBarry Smith     ierr = MatDestroy(&J);CHKERRQ(ierr);
1607a8248277SBarry Smith   } else if (snes->dm && snes->mf_operator && !snes->jacobian_pre && !snes->jacobian) {
1608a8248277SBarry Smith     Mat J,B;
1609a8248277SBarry Smith     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
1610a8248277SBarry Smith     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
1611a8248277SBarry Smith     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
1612a8248277SBarry Smith     ierr = DMGetMatrix(snes->dm,MATAIJ,&B);CHKERRQ(ierr);
1613a8248277SBarry Smith     ierr = SNESSetJacobian(snes,J,B,SNESDMComputeJacobian,snes->funP);CHKERRQ(ierr);
1614a8248277SBarry Smith     ierr = MatDestroy(&J);CHKERRQ(ierr);
1615a8248277SBarry Smith     ierr = MatDestroy(&B);CHKERRQ(ierr);
1616efd51863SBarry Smith   } else if (snes->dm && !snes->jacobian_pre){
1617efd51863SBarry Smith     Mat J;
1618efd51863SBarry Smith     ierr = DMGetMatrix(snes->dm,MATAIJ,&J);CHKERRQ(ierr);
16193cbb28f5SBarry Smith     ierr = SNESSetJacobian(snes,J,J,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
1620efd51863SBarry Smith     ierr = MatDestroy(&J);CHKERRQ(ierr);
1621ef8dffc7SBarry Smith   }
1622cfaf3a74SBarry 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()");
1623c9b9fda1SJed Brown   if (!snes->vec_func) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_ARG_WRONGSTATE,"Must provide a vector when calling SNESSetFunction() or call SNESSetDM()");
1624efd51863SBarry Smith 
1625b710008aSBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes, &snes->ksp);CHKERRQ(ierr);}
1626b710008aSBarry Smith 
1627d25893d9SBarry Smith   if (snes->ops->usercompute && !snes->user) {
1628d25893d9SBarry Smith     ierr = (*snes->ops->usercompute)(snes,(void**)&snes->user);CHKERRQ(ierr);
1629d25893d9SBarry Smith   }
1630d25893d9SBarry Smith 
1631410397dcSLisandro Dalcin   if (snes->ops->setup) {
1632410397dcSLisandro Dalcin     ierr = (*snes->ops->setup)(snes);CHKERRQ(ierr);
1633410397dcSLisandro Dalcin   }
163458c9b817SLisandro Dalcin 
16357aaed0d8SBarry Smith   snes->setupcalled = PETSC_TRUE;
16363a40ed3dSBarry Smith   PetscFunctionReturn(0);
16379b94acceSBarry Smith }
16389b94acceSBarry Smith 
16394a2ae208SSatish Balay #undef __FUNCT__
164037596af1SLisandro Dalcin #define __FUNCT__ "SNESReset"
164137596af1SLisandro Dalcin /*@
164237596af1SLisandro Dalcin    SNESReset - Resets a SNES context to the snessetupcalled = 0 state and removes any allocated Vecs and Mats
164337596af1SLisandro Dalcin 
164437596af1SLisandro Dalcin    Collective on SNES
164537596af1SLisandro Dalcin 
164637596af1SLisandro Dalcin    Input Parameter:
164737596af1SLisandro Dalcin .  snes - iterative context obtained from SNESCreate()
164837596af1SLisandro Dalcin 
1649d25893d9SBarry Smith    Level: intermediate
1650d25893d9SBarry Smith 
1651d25893d9SBarry Smith    Notes: Also calls the application context destroy routine set with SNESSetComputeApplicationContext()
165237596af1SLisandro Dalcin 
165337596af1SLisandro Dalcin .keywords: SNES, destroy
165437596af1SLisandro Dalcin 
165537596af1SLisandro Dalcin .seealso: SNESCreate(), SNESSetUp(), SNESSolve()
165637596af1SLisandro Dalcin @*/
165737596af1SLisandro Dalcin PetscErrorCode  SNESReset(SNES snes)
165837596af1SLisandro Dalcin {
165937596af1SLisandro Dalcin   PetscErrorCode ierr;
166037596af1SLisandro Dalcin 
166137596af1SLisandro Dalcin   PetscFunctionBegin;
166237596af1SLisandro Dalcin   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1663d25893d9SBarry Smith   if (snes->ops->userdestroy && snes->user) {
1664d25893d9SBarry Smith     ierr       = (*snes->ops->userdestroy)((void**)&snes->user);CHKERRQ(ierr);
1665d25893d9SBarry Smith     snes->user = PETSC_NULL;
1666d25893d9SBarry Smith   }
16678a23116dSBarry Smith   if (snes->pc) {
16688a23116dSBarry Smith     ierr = SNESReset(snes->pc);CHKERRQ(ierr);
16698a23116dSBarry Smith   }
16708a23116dSBarry Smith 
167137596af1SLisandro Dalcin   if (snes->ops->reset) {
167237596af1SLisandro Dalcin     ierr = (*snes->ops->reset)(snes);CHKERRQ(ierr);
167337596af1SLisandro Dalcin   }
167437596af1SLisandro Dalcin   if (snes->ksp) {ierr = KSPReset(snes->ksp);CHKERRQ(ierr);}
16756bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr);
16766bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr);
16776bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_sol_update);CHKERRQ(ierr);
16786bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr);
16796bf464f9SBarry Smith   ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr);
16806bf464f9SBarry Smith   ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr);
168137596af1SLisandro Dalcin   if (snes->work) {ierr = VecDestroyVecs(snes->nwork,&snes->work);CHKERRQ(ierr);}
168237596af1SLisandro Dalcin   if (snes->vwork) {ierr = VecDestroyVecs(snes->nvwork,&snes->vwork);CHKERRQ(ierr);}
168337596af1SLisandro Dalcin   snes->nwork = snes->nvwork = 0;
168437596af1SLisandro Dalcin   snes->setupcalled = PETSC_FALSE;
168537596af1SLisandro Dalcin   PetscFunctionReturn(0);
168637596af1SLisandro Dalcin }
168737596af1SLisandro Dalcin 
168837596af1SLisandro Dalcin #undef __FUNCT__
16894a2ae208SSatish Balay #define __FUNCT__ "SNESDestroy"
169052baeb72SSatish Balay /*@
16919b94acceSBarry Smith    SNESDestroy - Destroys the nonlinear solver context that was created
16929b94acceSBarry Smith    with SNESCreate().
16939b94acceSBarry Smith 
1694c7afd0dbSLois Curfman McInnes    Collective on SNES
1695c7afd0dbSLois Curfman McInnes 
16969b94acceSBarry Smith    Input Parameter:
16979b94acceSBarry Smith .  snes - the SNES context
16989b94acceSBarry Smith 
169936851e7fSLois Curfman McInnes    Level: beginner
170036851e7fSLois Curfman McInnes 
17019b94acceSBarry Smith .keywords: SNES, nonlinear, destroy
17029b94acceSBarry Smith 
170363a78c88SLois Curfman McInnes .seealso: SNESCreate(), SNESSolve()
17049b94acceSBarry Smith @*/
17056bf464f9SBarry Smith PetscErrorCode  SNESDestroy(SNES *snes)
17069b94acceSBarry Smith {
17076849ba73SBarry Smith   PetscErrorCode ierr;
17083a40ed3dSBarry Smith 
17093a40ed3dSBarry Smith   PetscFunctionBegin;
17106bf464f9SBarry Smith   if (!*snes) PetscFunctionReturn(0);
17116bf464f9SBarry Smith   PetscValidHeaderSpecific((*snes),SNES_CLASSID,1);
17126bf464f9SBarry Smith   if (--((PetscObject)(*snes))->refct > 0) {*snes = 0; PetscFunctionReturn(0);}
1713d4bb536fSBarry Smith 
17146bf464f9SBarry Smith   ierr = SNESReset((*snes));CHKERRQ(ierr);
17158a23116dSBarry Smith   ierr = SNESDestroy(&(*snes)->pc);CHKERRQ(ierr);
17166b8b9a38SLisandro Dalcin 
1717be0abb6dSBarry Smith   /* if memory was published with AMS then destroy it */
17186bf464f9SBarry Smith   ierr = PetscObjectDepublish((*snes));CHKERRQ(ierr);
17196bf464f9SBarry Smith   if ((*snes)->ops->destroy) {ierr = (*((*snes))->ops->destroy)((*snes));CHKERRQ(ierr);}
17206d4c513bSLisandro Dalcin 
17216bf464f9SBarry Smith   ierr = DMDestroy(&(*snes)->dm);CHKERRQ(ierr);
17226bf464f9SBarry Smith   ierr = KSPDestroy(&(*snes)->ksp);CHKERRQ(ierr);
17236b8b9a38SLisandro Dalcin 
17246bf464f9SBarry Smith   ierr = PetscFree((*snes)->kspconvctx);CHKERRQ(ierr);
17256bf464f9SBarry Smith   if ((*snes)->ops->convergeddestroy) {
17266bf464f9SBarry Smith     ierr = (*(*snes)->ops->convergeddestroy)((*snes)->cnvP);CHKERRQ(ierr);
17276b8b9a38SLisandro Dalcin   }
17286bf464f9SBarry Smith   if ((*snes)->conv_malloc) {
17296bf464f9SBarry Smith     ierr = PetscFree((*snes)->conv_hist);CHKERRQ(ierr);
17306bf464f9SBarry Smith     ierr = PetscFree((*snes)->conv_hist_its);CHKERRQ(ierr);
173158c9b817SLisandro Dalcin   }
17326bf464f9SBarry Smith   ierr = SNESMonitorCancel((*snes));CHKERRQ(ierr);
1733a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(snes);CHKERRQ(ierr);
17343a40ed3dSBarry Smith   PetscFunctionReturn(0);
17359b94acceSBarry Smith }
17369b94acceSBarry Smith 
17379b94acceSBarry Smith /* ----------- Routines to set solver parameters ---------- */
17389b94acceSBarry Smith 
17394a2ae208SSatish Balay #undef __FUNCT__
1740a8054027SBarry Smith #define __FUNCT__ "SNESSetLagPreconditioner"
1741a8054027SBarry Smith /*@
1742a8054027SBarry Smith    SNESSetLagPreconditioner - Determines when the preconditioner is rebuilt in the nonlinear solve.
1743a8054027SBarry Smith 
17443f9fe445SBarry Smith    Logically Collective on SNES
1745a8054027SBarry Smith 
1746a8054027SBarry Smith    Input Parameters:
1747a8054027SBarry Smith +  snes - the SNES context
1748a8054027SBarry 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
17493b4f5425SBarry Smith          the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that
1750a8054027SBarry Smith 
1751a8054027SBarry Smith    Options Database Keys:
1752a8054027SBarry Smith .    -snes_lag_preconditioner <lag>
1753a8054027SBarry Smith 
1754a8054027SBarry Smith    Notes:
1755a8054027SBarry Smith    The default is 1
1756a8054027SBarry Smith    The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
1757a8054027SBarry Smith    If  -1 is used before the very first nonlinear solve the preconditioner is still built because there is no previous preconditioner to use
1758a8054027SBarry Smith 
1759a8054027SBarry Smith    Level: intermediate
1760a8054027SBarry Smith 
1761a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
1762a8054027SBarry Smith 
1763e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian()
1764a8054027SBarry Smith 
1765a8054027SBarry Smith @*/
17667087cfbeSBarry Smith PetscErrorCode  SNESSetLagPreconditioner(SNES snes,PetscInt lag)
1767a8054027SBarry Smith {
1768a8054027SBarry Smith   PetscFunctionBegin;
17690700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1770e32f2f54SBarry Smith   if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater");
1771e32f2f54SBarry Smith   if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0");
1772c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,lag,2);
1773a8054027SBarry Smith   snes->lagpreconditioner = lag;
1774a8054027SBarry Smith   PetscFunctionReturn(0);
1775a8054027SBarry Smith }
1776a8054027SBarry Smith 
1777a8054027SBarry Smith #undef __FUNCT__
1778efd51863SBarry Smith #define __FUNCT__ "SNESSetGridSequence"
1779efd51863SBarry Smith /*@
1780efd51863SBarry Smith    SNESSetGridSequence - sets the number of steps of grid sequencing that SNES does
1781efd51863SBarry Smith 
1782efd51863SBarry Smith    Logically Collective on SNES
1783efd51863SBarry Smith 
1784efd51863SBarry Smith    Input Parameters:
1785efd51863SBarry Smith +  snes - the SNES context
1786efd51863SBarry Smith -  steps - the number of refinements to do, defaults to 0
1787efd51863SBarry Smith 
1788efd51863SBarry Smith    Options Database Keys:
1789efd51863SBarry Smith .    -snes_grid_sequence <steps>
1790efd51863SBarry Smith 
1791efd51863SBarry Smith    Level: intermediate
1792efd51863SBarry Smith 
1793efd51863SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
1794efd51863SBarry Smith 
1795efd51863SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian()
1796efd51863SBarry Smith 
1797efd51863SBarry Smith @*/
1798efd51863SBarry Smith PetscErrorCode  SNESSetGridSequence(SNES snes,PetscInt steps)
1799efd51863SBarry Smith {
1800efd51863SBarry Smith   PetscFunctionBegin;
1801efd51863SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1802efd51863SBarry Smith   PetscValidLogicalCollectiveInt(snes,steps,2);
1803efd51863SBarry Smith   snes->gridsequence = steps;
1804efd51863SBarry Smith   PetscFunctionReturn(0);
1805efd51863SBarry Smith }
1806efd51863SBarry Smith 
1807efd51863SBarry Smith #undef __FUNCT__
1808a8054027SBarry Smith #define __FUNCT__ "SNESGetLagPreconditioner"
1809a8054027SBarry Smith /*@
1810a8054027SBarry Smith    SNESGetLagPreconditioner - Indicates how often the preconditioner is rebuilt
1811a8054027SBarry Smith 
18123f9fe445SBarry Smith    Not Collective
1813a8054027SBarry Smith 
1814a8054027SBarry Smith    Input Parameter:
1815a8054027SBarry Smith .  snes - the SNES context
1816a8054027SBarry Smith 
1817a8054027SBarry Smith    Output Parameter:
1818a8054027SBarry 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
18193b4f5425SBarry Smith          the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that
1820a8054027SBarry Smith 
1821a8054027SBarry Smith    Options Database Keys:
1822a8054027SBarry Smith .    -snes_lag_preconditioner <lag>
1823a8054027SBarry Smith 
1824a8054027SBarry Smith    Notes:
1825a8054027SBarry Smith    The default is 1
1826a8054027SBarry Smith    The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
1827a8054027SBarry Smith 
1828a8054027SBarry Smith    Level: intermediate
1829a8054027SBarry Smith 
1830a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
1831a8054027SBarry Smith 
1832a8054027SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagPreconditioner()
1833a8054027SBarry Smith 
1834a8054027SBarry Smith @*/
18357087cfbeSBarry Smith PetscErrorCode  SNESGetLagPreconditioner(SNES snes,PetscInt *lag)
1836a8054027SBarry Smith {
1837a8054027SBarry Smith   PetscFunctionBegin;
18380700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1839a8054027SBarry Smith   *lag = snes->lagpreconditioner;
1840a8054027SBarry Smith   PetscFunctionReturn(0);
1841a8054027SBarry Smith }
1842a8054027SBarry Smith 
1843a8054027SBarry Smith #undef __FUNCT__
1844e35cf81dSBarry Smith #define __FUNCT__ "SNESSetLagJacobian"
1845e35cf81dSBarry Smith /*@
1846e35cf81dSBarry Smith    SNESSetLagJacobian - Determines when the Jacobian is rebuilt in the nonlinear solve. See SNESSetLagPreconditioner() for determining how
1847e35cf81dSBarry Smith      often the preconditioner is rebuilt.
1848e35cf81dSBarry Smith 
18493f9fe445SBarry Smith    Logically Collective on SNES
1850e35cf81dSBarry Smith 
1851e35cf81dSBarry Smith    Input Parameters:
1852e35cf81dSBarry Smith +  snes - the SNES context
1853e35cf81dSBarry 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
1854fe3ffe1eSBarry Smith          the Jacobian is built etc. -2 means rebuild at next chance but then never again
1855e35cf81dSBarry Smith 
1856e35cf81dSBarry Smith    Options Database Keys:
1857e35cf81dSBarry Smith .    -snes_lag_jacobian <lag>
1858e35cf81dSBarry Smith 
1859e35cf81dSBarry Smith    Notes:
1860e35cf81dSBarry Smith    The default is 1
1861e35cf81dSBarry Smith    The Jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
1862fe3ffe1eSBarry 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
1863fe3ffe1eSBarry Smith    at the next Newton step but never again (unless it is reset to another value)
1864e35cf81dSBarry Smith 
1865e35cf81dSBarry Smith    Level: intermediate
1866e35cf81dSBarry Smith 
1867e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
1868e35cf81dSBarry Smith 
1869e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagPreconditioner(), SNESGetLagJacobian()
1870e35cf81dSBarry Smith 
1871e35cf81dSBarry Smith @*/
18727087cfbeSBarry Smith PetscErrorCode  SNESSetLagJacobian(SNES snes,PetscInt lag)
1873e35cf81dSBarry Smith {
1874e35cf81dSBarry Smith   PetscFunctionBegin;
18750700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1876e32f2f54SBarry Smith   if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater");
1877e32f2f54SBarry Smith   if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0");
1878c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,lag,2);
1879e35cf81dSBarry Smith   snes->lagjacobian = lag;
1880e35cf81dSBarry Smith   PetscFunctionReturn(0);
1881e35cf81dSBarry Smith }
1882e35cf81dSBarry Smith 
1883e35cf81dSBarry Smith #undef __FUNCT__
1884e35cf81dSBarry Smith #define __FUNCT__ "SNESGetLagJacobian"
1885e35cf81dSBarry Smith /*@
1886e35cf81dSBarry Smith    SNESGetLagJacobian - Indicates how often the Jacobian is rebuilt. See SNESGetLagPreconditioner() to determine when the preconditioner is rebuilt
1887e35cf81dSBarry Smith 
18883f9fe445SBarry Smith    Not Collective
1889e35cf81dSBarry Smith 
1890e35cf81dSBarry Smith    Input Parameter:
1891e35cf81dSBarry Smith .  snes - the SNES context
1892e35cf81dSBarry Smith 
1893e35cf81dSBarry Smith    Output Parameter:
1894e35cf81dSBarry 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
1895e35cf81dSBarry Smith          the Jacobian is built etc.
1896e35cf81dSBarry Smith 
1897e35cf81dSBarry Smith    Options Database Keys:
1898e35cf81dSBarry Smith .    -snes_lag_jacobian <lag>
1899e35cf81dSBarry Smith 
1900e35cf81dSBarry Smith    Notes:
1901e35cf81dSBarry Smith    The default is 1
1902e35cf81dSBarry Smith    The jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
1903e35cf81dSBarry Smith 
1904e35cf81dSBarry Smith    Level: intermediate
1905e35cf81dSBarry Smith 
1906e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
1907e35cf81dSBarry Smith 
1908e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagJacobian(), SNESSetLagPreconditioner(), SNESGetLagPreconditioner()
1909e35cf81dSBarry Smith 
1910e35cf81dSBarry Smith @*/
19117087cfbeSBarry Smith PetscErrorCode  SNESGetLagJacobian(SNES snes,PetscInt *lag)
1912e35cf81dSBarry Smith {
1913e35cf81dSBarry Smith   PetscFunctionBegin;
19140700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1915e35cf81dSBarry Smith   *lag = snes->lagjacobian;
1916e35cf81dSBarry Smith   PetscFunctionReturn(0);
1917e35cf81dSBarry Smith }
1918e35cf81dSBarry Smith 
1919e35cf81dSBarry Smith #undef __FUNCT__
19204a2ae208SSatish Balay #define __FUNCT__ "SNESSetTolerances"
19219b94acceSBarry Smith /*@
1922d7a720efSLois Curfman McInnes    SNESSetTolerances - Sets various parameters used in convergence tests.
19239b94acceSBarry Smith 
19243f9fe445SBarry Smith    Logically Collective on SNES
1925c7afd0dbSLois Curfman McInnes 
19269b94acceSBarry Smith    Input Parameters:
1927c7afd0dbSLois Curfman McInnes +  snes - the SNES context
192870441072SBarry Smith .  abstol - absolute convergence tolerance
192933174efeSLois Curfman McInnes .  rtol - relative convergence tolerance
193033174efeSLois Curfman McInnes .  stol -  convergence tolerance in terms of the norm
193133174efeSLois Curfman McInnes            of the change in the solution between steps
193233174efeSLois Curfman McInnes .  maxit - maximum number of iterations
1933c7afd0dbSLois Curfman McInnes -  maxf - maximum number of function evaluations
1934fee21e36SBarry Smith 
193533174efeSLois Curfman McInnes    Options Database Keys:
193670441072SBarry Smith +    -snes_atol <abstol> - Sets abstol
1937c7afd0dbSLois Curfman McInnes .    -snes_rtol <rtol> - Sets rtol
1938c7afd0dbSLois Curfman McInnes .    -snes_stol <stol> - Sets stol
1939c7afd0dbSLois Curfman McInnes .    -snes_max_it <maxit> - Sets maxit
1940c7afd0dbSLois Curfman McInnes -    -snes_max_funcs <maxf> - Sets maxf
19419b94acceSBarry Smith 
1942d7a720efSLois Curfman McInnes    Notes:
19439b94acceSBarry Smith    The default maximum number of iterations is 50.
19449b94acceSBarry Smith    The default maximum number of function evaluations is 1000.
19459b94acceSBarry Smith 
194636851e7fSLois Curfman McInnes    Level: intermediate
194736851e7fSLois Curfman McInnes 
194833174efeSLois Curfman McInnes .keywords: SNES, nonlinear, set, convergence, tolerances
19499b94acceSBarry Smith 
19502492ecdbSBarry Smith .seealso: SNESSetTrustRegionTolerance()
19519b94acceSBarry Smith @*/
19527087cfbeSBarry Smith PetscErrorCode  SNESSetTolerances(SNES snes,PetscReal abstol,PetscReal rtol,PetscReal stol,PetscInt maxit,PetscInt maxf)
19539b94acceSBarry Smith {
19543a40ed3dSBarry Smith   PetscFunctionBegin;
19550700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1956c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,abstol,2);
1957c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol,3);
1958c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,stol,4);
1959c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxit,5);
1960c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxf,6);
1961c5eb9154SBarry Smith 
1962ab54825eSJed Brown   if (abstol != PETSC_DEFAULT) {
1963ab54825eSJed Brown     if (abstol < 0.0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Absolute tolerance %G must be non-negative",abstol);
1964ab54825eSJed Brown     snes->abstol = abstol;
1965ab54825eSJed Brown   }
1966ab54825eSJed Brown   if (rtol != PETSC_DEFAULT) {
1967ab54825eSJed 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);
1968ab54825eSJed Brown     snes->rtol = rtol;
1969ab54825eSJed Brown   }
1970ab54825eSJed Brown   if (stol != PETSC_DEFAULT) {
1971ab54825eSJed Brown     if (stol < 0.0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Step tolerance %G must be non-negative",stol);
1972ab54825eSJed Brown     snes->xtol = stol;
1973ab54825eSJed Brown   }
1974ab54825eSJed Brown   if (maxit != PETSC_DEFAULT) {
1975ab54825eSJed Brown     if (maxit < 0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of iterations %D must be non-negative",maxit);
1976ab54825eSJed Brown     snes->max_its = maxit;
1977ab54825eSJed Brown   }
1978ab54825eSJed Brown   if (maxf != PETSC_DEFAULT) {
1979ab54825eSJed Brown     if (maxf < 0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of function evaluations %D must be non-negative",maxf);
1980ab54825eSJed Brown     snes->max_funcs = maxf;
1981ab54825eSJed Brown   }
19823a40ed3dSBarry Smith   PetscFunctionReturn(0);
19839b94acceSBarry Smith }
19849b94acceSBarry Smith 
19854a2ae208SSatish Balay #undef __FUNCT__
19864a2ae208SSatish Balay #define __FUNCT__ "SNESGetTolerances"
19879b94acceSBarry Smith /*@
198833174efeSLois Curfman McInnes    SNESGetTolerances - Gets various parameters used in convergence tests.
198933174efeSLois Curfman McInnes 
1990c7afd0dbSLois Curfman McInnes    Not Collective
1991c7afd0dbSLois Curfman McInnes 
199233174efeSLois Curfman McInnes    Input Parameters:
1993c7afd0dbSLois Curfman McInnes +  snes - the SNES context
199485385478SLisandro Dalcin .  atol - absolute convergence tolerance
199533174efeSLois Curfman McInnes .  rtol - relative convergence tolerance
199633174efeSLois Curfman McInnes .  stol -  convergence tolerance in terms of the norm
199733174efeSLois Curfman McInnes            of the change in the solution between steps
199833174efeSLois Curfman McInnes .  maxit - maximum number of iterations
1999c7afd0dbSLois Curfman McInnes -  maxf - maximum number of function evaluations
2000fee21e36SBarry Smith 
200133174efeSLois Curfman McInnes    Notes:
200233174efeSLois Curfman McInnes    The user can specify PETSC_NULL for any parameter that is not needed.
200333174efeSLois Curfman McInnes 
200436851e7fSLois Curfman McInnes    Level: intermediate
200536851e7fSLois Curfman McInnes 
200633174efeSLois Curfman McInnes .keywords: SNES, nonlinear, get, convergence, tolerances
200733174efeSLois Curfman McInnes 
200833174efeSLois Curfman McInnes .seealso: SNESSetTolerances()
200933174efeSLois Curfman McInnes @*/
20107087cfbeSBarry Smith PetscErrorCode  SNESGetTolerances(SNES snes,PetscReal *atol,PetscReal *rtol,PetscReal *stol,PetscInt *maxit,PetscInt *maxf)
201133174efeSLois Curfman McInnes {
20123a40ed3dSBarry Smith   PetscFunctionBegin;
20130700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
201485385478SLisandro Dalcin   if (atol)  *atol  = snes->abstol;
201533174efeSLois Curfman McInnes   if (rtol)  *rtol  = snes->rtol;
201633174efeSLois Curfman McInnes   if (stol)  *stol  = snes->xtol;
201733174efeSLois Curfman McInnes   if (maxit) *maxit = snes->max_its;
201833174efeSLois Curfman McInnes   if (maxf)  *maxf  = snes->max_funcs;
20193a40ed3dSBarry Smith   PetscFunctionReturn(0);
202033174efeSLois Curfman McInnes }
202133174efeSLois Curfman McInnes 
20224a2ae208SSatish Balay #undef __FUNCT__
20234a2ae208SSatish Balay #define __FUNCT__ "SNESSetTrustRegionTolerance"
202433174efeSLois Curfman McInnes /*@
20259b94acceSBarry Smith    SNESSetTrustRegionTolerance - Sets the trust region parameter tolerance.
20269b94acceSBarry Smith 
20273f9fe445SBarry Smith    Logically Collective on SNES
2028fee21e36SBarry Smith 
2029c7afd0dbSLois Curfman McInnes    Input Parameters:
2030c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2031c7afd0dbSLois Curfman McInnes -  tol - tolerance
2032c7afd0dbSLois Curfman McInnes 
20339b94acceSBarry Smith    Options Database Key:
2034c7afd0dbSLois Curfman McInnes .  -snes_trtol <tol> - Sets tol
20359b94acceSBarry Smith 
203636851e7fSLois Curfman McInnes    Level: intermediate
203736851e7fSLois Curfman McInnes 
20389b94acceSBarry Smith .keywords: SNES, nonlinear, set, trust region, tolerance
20399b94acceSBarry Smith 
20402492ecdbSBarry Smith .seealso: SNESSetTolerances()
20419b94acceSBarry Smith @*/
20427087cfbeSBarry Smith PetscErrorCode  SNESSetTrustRegionTolerance(SNES snes,PetscReal tol)
20439b94acceSBarry Smith {
20443a40ed3dSBarry Smith   PetscFunctionBegin;
20450700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2046c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,tol,2);
20479b94acceSBarry Smith   snes->deltatol = tol;
20483a40ed3dSBarry Smith   PetscFunctionReturn(0);
20499b94acceSBarry Smith }
20509b94acceSBarry Smith 
2051df9fa365SBarry Smith /*
2052df9fa365SBarry Smith    Duplicate the lg monitors for SNES from KSP; for some reason with
2053df9fa365SBarry Smith    dynamic libraries things don't work under Sun4 if we just use
2054df9fa365SBarry Smith    macros instead of functions
2055df9fa365SBarry Smith */
20564a2ae208SSatish Balay #undef __FUNCT__
2057a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLG"
20587087cfbeSBarry Smith PetscErrorCode  SNESMonitorLG(SNES snes,PetscInt it,PetscReal norm,void *ctx)
2059ce1608b8SBarry Smith {
2060dfbe8321SBarry Smith   PetscErrorCode ierr;
2061ce1608b8SBarry Smith 
2062ce1608b8SBarry Smith   PetscFunctionBegin;
20630700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2064a6570f20SBarry Smith   ierr = KSPMonitorLG((KSP)snes,it,norm,ctx);CHKERRQ(ierr);
2065ce1608b8SBarry Smith   PetscFunctionReturn(0);
2066ce1608b8SBarry Smith }
2067ce1608b8SBarry Smith 
20684a2ae208SSatish Balay #undef __FUNCT__
2069a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGCreate"
20707087cfbeSBarry Smith PetscErrorCode  SNESMonitorLGCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw)
2071df9fa365SBarry Smith {
2072dfbe8321SBarry Smith   PetscErrorCode ierr;
2073df9fa365SBarry Smith 
2074df9fa365SBarry Smith   PetscFunctionBegin;
2075a6570f20SBarry Smith   ierr = KSPMonitorLGCreate(host,label,x,y,m,n,draw);CHKERRQ(ierr);
2076df9fa365SBarry Smith   PetscFunctionReturn(0);
2077df9fa365SBarry Smith }
2078df9fa365SBarry Smith 
20794a2ae208SSatish Balay #undef __FUNCT__
2080a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGDestroy"
20816bf464f9SBarry Smith PetscErrorCode  SNESMonitorLGDestroy(PetscDrawLG *draw)
2082df9fa365SBarry Smith {
2083dfbe8321SBarry Smith   PetscErrorCode ierr;
2084df9fa365SBarry Smith 
2085df9fa365SBarry Smith   PetscFunctionBegin;
2086a6570f20SBarry Smith   ierr = KSPMonitorLGDestroy(draw);CHKERRQ(ierr);
2087df9fa365SBarry Smith   PetscFunctionReturn(0);
2088df9fa365SBarry Smith }
2089df9fa365SBarry Smith 
20907087cfbeSBarry Smith extern PetscErrorCode  SNESMonitorRange_Private(SNES,PetscInt,PetscReal*);
2091b271bb04SBarry Smith #undef __FUNCT__
2092b271bb04SBarry Smith #define __FUNCT__ "SNESMonitorLGRange"
20937087cfbeSBarry Smith PetscErrorCode  SNESMonitorLGRange(SNES snes,PetscInt n,PetscReal rnorm,void *monctx)
2094b271bb04SBarry Smith {
2095b271bb04SBarry Smith   PetscDrawLG      lg;
2096b271bb04SBarry Smith   PetscErrorCode   ierr;
2097b271bb04SBarry Smith   PetscReal        x,y,per;
2098b271bb04SBarry Smith   PetscViewer      v = (PetscViewer)monctx;
2099b271bb04SBarry Smith   static PetscReal prev; /* should be in the context */
2100b271bb04SBarry Smith   PetscDraw        draw;
2101b271bb04SBarry Smith   PetscFunctionBegin;
2102b271bb04SBarry Smith   if (!monctx) {
2103b271bb04SBarry Smith     MPI_Comm    comm;
2104b271bb04SBarry Smith 
2105b271bb04SBarry Smith     ierr   = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr);
2106b271bb04SBarry Smith     v      = PETSC_VIEWER_DRAW_(comm);
2107b271bb04SBarry Smith   }
2108b271bb04SBarry Smith   ierr   = PetscViewerDrawGetDrawLG(v,0,&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,"Residual norm");CHKERRQ(ierr);
2112b271bb04SBarry Smith   x = (PetscReal) n;
2113b271bb04SBarry Smith   if (rnorm > 0.0) y = log10(rnorm); else y = -15.0;
2114b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
2115b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
2116b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
2117b271bb04SBarry Smith   }
2118b271bb04SBarry Smith 
2119b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,1,&lg);CHKERRQ(ierr);
2120b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
2121b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
2122b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"% elemts > .2*max elemt");CHKERRQ(ierr);
2123b271bb04SBarry Smith   ierr =  SNESMonitorRange_Private(snes,n,&per);CHKERRQ(ierr);
2124b271bb04SBarry Smith   x = (PetscReal) n;
2125b271bb04SBarry Smith   y = 100.0*per;
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,2,&lg);CHKERRQ(ierr);
2132b271bb04SBarry Smith   if (!n) {prev = rnorm;ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
2133b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
2134b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm");CHKERRQ(ierr);
2135b271bb04SBarry Smith   x = (PetscReal) n;
2136b271bb04SBarry Smith   y = (prev - rnorm)/prev;
2137b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
2138b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
2139b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
2140b271bb04SBarry Smith   }
2141b271bb04SBarry Smith 
2142b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,3,&lg);CHKERRQ(ierr);
2143b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
2144b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
2145b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm*(% > .2 max)");CHKERRQ(ierr);
2146b271bb04SBarry Smith   x = (PetscReal) n;
2147b271bb04SBarry Smith   y = (prev - rnorm)/(prev*per);
2148b271bb04SBarry Smith   if (n > 2) { /*skip initial crazy value */
2149b271bb04SBarry Smith     ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
2150b271bb04SBarry Smith   }
2151b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
2152b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
2153b271bb04SBarry Smith   }
2154b271bb04SBarry Smith   prev = rnorm;
2155b271bb04SBarry Smith   PetscFunctionReturn(0);
2156b271bb04SBarry Smith }
2157b271bb04SBarry Smith 
2158b271bb04SBarry Smith #undef __FUNCT__
2159b271bb04SBarry Smith #define __FUNCT__ "SNESMonitorLGRangeCreate"
21607087cfbeSBarry Smith PetscErrorCode  SNESMonitorLGRangeCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw)
2161b271bb04SBarry Smith {
2162b271bb04SBarry Smith   PetscErrorCode ierr;
2163b271bb04SBarry Smith 
2164b271bb04SBarry Smith   PetscFunctionBegin;
2165b271bb04SBarry Smith   ierr = KSPMonitorLGCreate(host,label,x,y,m,n,draw);CHKERRQ(ierr);
2166b271bb04SBarry Smith   PetscFunctionReturn(0);
2167b271bb04SBarry Smith }
2168b271bb04SBarry Smith 
2169b271bb04SBarry Smith #undef __FUNCT__
2170b271bb04SBarry Smith #define __FUNCT__ "SNESMonitorLGRangeDestroy"
21716bf464f9SBarry Smith PetscErrorCode  SNESMonitorLGRangeDestroy(PetscDrawLG *draw)
2172b271bb04SBarry Smith {
2173b271bb04SBarry Smith   PetscErrorCode ierr;
2174b271bb04SBarry Smith 
2175b271bb04SBarry Smith   PetscFunctionBegin;
2176b271bb04SBarry Smith   ierr = KSPMonitorLGDestroy(draw);CHKERRQ(ierr);
2177b271bb04SBarry Smith   PetscFunctionReturn(0);
2178b271bb04SBarry Smith }
2179b271bb04SBarry Smith 
21807a03ce2fSLisandro Dalcin #undef __FUNCT__
21817a03ce2fSLisandro Dalcin #define __FUNCT__ "SNESMonitor"
2182228d79bcSJed Brown /*@
2183228d79bcSJed Brown    SNESMonitor - runs the user provided monitor routines, if they exist
2184228d79bcSJed Brown 
2185228d79bcSJed Brown    Collective on SNES
2186228d79bcSJed Brown 
2187228d79bcSJed Brown    Input Parameters:
2188228d79bcSJed Brown +  snes - nonlinear solver context obtained from SNESCreate()
2189228d79bcSJed Brown .  iter - iteration number
2190228d79bcSJed Brown -  rnorm - relative norm of the residual
2191228d79bcSJed Brown 
2192228d79bcSJed Brown    Notes:
2193228d79bcSJed Brown    This routine is called by the SNES implementations.
2194228d79bcSJed Brown    It does not typically need to be called by the user.
2195228d79bcSJed Brown 
2196228d79bcSJed Brown    Level: developer
2197228d79bcSJed Brown 
2198228d79bcSJed Brown .seealso: SNESMonitorSet()
2199228d79bcSJed Brown @*/
22007a03ce2fSLisandro Dalcin PetscErrorCode  SNESMonitor(SNES snes,PetscInt iter,PetscReal rnorm)
22017a03ce2fSLisandro Dalcin {
22027a03ce2fSLisandro Dalcin   PetscErrorCode ierr;
22037a03ce2fSLisandro Dalcin   PetscInt       i,n = snes->numbermonitors;
22047a03ce2fSLisandro Dalcin 
22057a03ce2fSLisandro Dalcin   PetscFunctionBegin;
22067a03ce2fSLisandro Dalcin   for (i=0; i<n; i++) {
22077a03ce2fSLisandro Dalcin     ierr = (*snes->monitor[i])(snes,iter,rnorm,snes->monitorcontext[i]);CHKERRQ(ierr);
22087a03ce2fSLisandro Dalcin   }
22097a03ce2fSLisandro Dalcin   PetscFunctionReturn(0);
22107a03ce2fSLisandro Dalcin }
22117a03ce2fSLisandro Dalcin 
22129b94acceSBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
22139b94acceSBarry Smith 
22144a2ae208SSatish Balay #undef __FUNCT__
2215a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorSet"
22169b94acceSBarry Smith /*@C
2217a6570f20SBarry Smith    SNESMonitorSet - Sets an ADDITIONAL function that is to be used at every
22189b94acceSBarry Smith    iteration of the nonlinear solver to display the iteration's
22199b94acceSBarry Smith    progress.
22209b94acceSBarry Smith 
22213f9fe445SBarry Smith    Logically Collective on SNES
2222fee21e36SBarry Smith 
2223c7afd0dbSLois Curfman McInnes    Input Parameters:
2224c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2225c7afd0dbSLois Curfman McInnes .  func - monitoring routine
2226b8a78c4aSBarry Smith .  mctx - [optional] user-defined context for private data for the
2227e8105e01SRichard Katz           monitor routine (use PETSC_NULL if no context is desired)
2228b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
2229b3006f0bSLois Curfman McInnes           (may be PETSC_NULL)
22309b94acceSBarry Smith 
2231c7afd0dbSLois Curfman McInnes    Calling sequence of func:
2232a7cc72afSBarry Smith $     int func(SNES snes,PetscInt its, PetscReal norm,void *mctx)
2233c7afd0dbSLois Curfman McInnes 
2234c7afd0dbSLois Curfman McInnes +    snes - the SNES context
2235c7afd0dbSLois Curfman McInnes .    its - iteration number
2236c7afd0dbSLois Curfman McInnes .    norm - 2-norm function value (may be estimated)
223740a0c1c6SLois Curfman McInnes -    mctx - [optional] monitoring context
22389b94acceSBarry Smith 
22399665c990SLois Curfman McInnes    Options Database Keys:
2240a6570f20SBarry Smith +    -snes_monitor        - sets SNESMonitorDefault()
2241a6570f20SBarry Smith .    -snes_monitor_draw    - sets line graph monitor,
2242a6570f20SBarry Smith                             uses SNESMonitorLGCreate()
2243cca6129bSJed Brown -    -snes_monitor_cancel - cancels all monitors that have
2244c7afd0dbSLois Curfman McInnes                             been hardwired into a code by
2245a6570f20SBarry Smith                             calls to SNESMonitorSet(), but
2246c7afd0dbSLois Curfman McInnes                             does not cancel those set via
2247c7afd0dbSLois Curfman McInnes                             the options database.
22489665c990SLois Curfman McInnes 
2249639f9d9dSBarry Smith    Notes:
22506bc08f3fSLois Curfman McInnes    Several different monitoring routines may be set by calling
2251a6570f20SBarry Smith    SNESMonitorSet() multiple times; all will be called in the
22526bc08f3fSLois Curfman McInnes    order in which they were set.
2253639f9d9dSBarry Smith 
2254025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each SNES object
2255025f1a04SBarry Smith 
225636851e7fSLois Curfman McInnes    Level: intermediate
225736851e7fSLois Curfman McInnes 
22589b94acceSBarry Smith .keywords: SNES, nonlinear, set, monitor
22599b94acceSBarry Smith 
2260a6570f20SBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorCancel()
22619b94acceSBarry Smith @*/
2262c2efdce3SBarry Smith PetscErrorCode  SNESMonitorSet(SNES snes,PetscErrorCode (*monitor)(SNES,PetscInt,PetscReal,void*),void *mctx,PetscErrorCode (*monitordestroy)(void**))
22639b94acceSBarry Smith {
2264b90d0a6eSBarry Smith   PetscInt       i;
2265649052a6SBarry Smith   PetscErrorCode ierr;
2266b90d0a6eSBarry Smith 
22673a40ed3dSBarry Smith   PetscFunctionBegin;
22680700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
226917186662SBarry Smith   if (snes->numbermonitors >= MAXSNESMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
2270b90d0a6eSBarry Smith   for (i=0; i<snes->numbermonitors;i++) {
2271649052a6SBarry Smith     if (monitor == snes->monitor[i] && monitordestroy == snes->monitordestroy[i] && mctx == snes->monitorcontext[i]) {
2272649052a6SBarry Smith       if (monitordestroy) {
2273c2efdce3SBarry Smith         ierr = (*monitordestroy)(&mctx);CHKERRQ(ierr);
2274649052a6SBarry Smith       }
2275b90d0a6eSBarry Smith       PetscFunctionReturn(0);
2276b90d0a6eSBarry Smith     }
2277b90d0a6eSBarry Smith   }
2278b90d0a6eSBarry Smith   snes->monitor[snes->numbermonitors]           = monitor;
2279b8a78c4aSBarry Smith   snes->monitordestroy[snes->numbermonitors]    = monitordestroy;
2280639f9d9dSBarry Smith   snes->monitorcontext[snes->numbermonitors++]  = (void*)mctx;
22813a40ed3dSBarry Smith   PetscFunctionReturn(0);
22829b94acceSBarry Smith }
22839b94acceSBarry Smith 
22844a2ae208SSatish Balay #undef __FUNCT__
2285a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorCancel"
22865cd90555SBarry Smith /*@C
2287a6570f20SBarry Smith    SNESMonitorCancel - Clears all the monitor functions for a SNES object.
22885cd90555SBarry Smith 
22893f9fe445SBarry Smith    Logically Collective on SNES
2290c7afd0dbSLois Curfman McInnes 
22915cd90555SBarry Smith    Input Parameters:
22925cd90555SBarry Smith .  snes - the SNES context
22935cd90555SBarry Smith 
22941a480d89SAdministrator    Options Database Key:
2295a6570f20SBarry Smith .  -snes_monitor_cancel - cancels all monitors that have been hardwired
2296a6570f20SBarry Smith     into a code by calls to SNESMonitorSet(), but does not cancel those
2297c7afd0dbSLois Curfman McInnes     set via the options database
22985cd90555SBarry Smith 
22995cd90555SBarry Smith    Notes:
23005cd90555SBarry Smith    There is no way to clear one specific monitor from a SNES object.
23015cd90555SBarry Smith 
230236851e7fSLois Curfman McInnes    Level: intermediate
230336851e7fSLois Curfman McInnes 
23045cd90555SBarry Smith .keywords: SNES, nonlinear, set, monitor
23055cd90555SBarry Smith 
2306a6570f20SBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorSet()
23075cd90555SBarry Smith @*/
23087087cfbeSBarry Smith PetscErrorCode  SNESMonitorCancel(SNES snes)
23095cd90555SBarry Smith {
2310d952e501SBarry Smith   PetscErrorCode ierr;
2311d952e501SBarry Smith   PetscInt       i;
2312d952e501SBarry Smith 
23135cd90555SBarry Smith   PetscFunctionBegin;
23140700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2315d952e501SBarry Smith   for (i=0; i<snes->numbermonitors; i++) {
2316d952e501SBarry Smith     if (snes->monitordestroy[i]) {
23173c4aec1bSBarry Smith       ierr = (*snes->monitordestroy[i])(&snes->monitorcontext[i]);CHKERRQ(ierr);
2318d952e501SBarry Smith     }
2319d952e501SBarry Smith   }
23205cd90555SBarry Smith   snes->numbermonitors = 0;
23215cd90555SBarry Smith   PetscFunctionReturn(0);
23225cd90555SBarry Smith }
23235cd90555SBarry Smith 
23244a2ae208SSatish Balay #undef __FUNCT__
23254a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceTest"
23269b94acceSBarry Smith /*@C
23279b94acceSBarry Smith    SNESSetConvergenceTest - Sets the function that is to be used
23289b94acceSBarry Smith    to test for convergence of the nonlinear iterative solution.
23299b94acceSBarry Smith 
23303f9fe445SBarry Smith    Logically Collective on SNES
2331fee21e36SBarry Smith 
2332c7afd0dbSLois Curfman McInnes    Input Parameters:
2333c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2334c7afd0dbSLois Curfman McInnes .  func - routine to test for convergence
23357f7931b9SBarry Smith .  cctx - [optional] context for private data for the convergence routine  (may be PETSC_NULL)
23367f7931b9SBarry Smith -  destroy - [optional] destructor for the context (may be PETSC_NULL; PETSC_NULL_FUNCTION in Fortran)
23379b94acceSBarry Smith 
2338c7afd0dbSLois Curfman McInnes    Calling sequence of func:
233906ee9f85SBarry Smith $     PetscErrorCode func (SNES snes,PetscInt it,PetscReal xnorm,PetscReal gnorm,PetscReal f,SNESConvergedReason *reason,void *cctx)
2340c7afd0dbSLois Curfman McInnes 
2341c7afd0dbSLois Curfman McInnes +    snes - the SNES context
234206ee9f85SBarry Smith .    it - current iteration (0 is the first and is before any Newton step)
2343c7afd0dbSLois Curfman McInnes .    cctx - [optional] convergence context
2344184914b5SBarry Smith .    reason - reason for convergence/divergence
2345c7afd0dbSLois Curfman McInnes .    xnorm - 2-norm of current iterate
23464b27c08aSLois Curfman McInnes .    gnorm - 2-norm of current step
23474b27c08aSLois Curfman McInnes -    f - 2-norm of function
23489b94acceSBarry Smith 
234936851e7fSLois Curfman McInnes    Level: advanced
235036851e7fSLois Curfman McInnes 
23519b94acceSBarry Smith .keywords: SNES, nonlinear, set, convergence, test
23529b94acceSBarry Smith 
235385385478SLisandro Dalcin .seealso: SNESDefaultConverged(), SNESSkipConverged()
23549b94acceSBarry Smith @*/
23557087cfbeSBarry Smith PetscErrorCode  SNESSetConvergenceTest(SNES snes,PetscErrorCode (*func)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void *cctx,PetscErrorCode (*destroy)(void*))
23569b94acceSBarry Smith {
23577f7931b9SBarry Smith   PetscErrorCode ierr;
23587f7931b9SBarry Smith 
23593a40ed3dSBarry Smith   PetscFunctionBegin;
23600700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
236185385478SLisandro Dalcin   if (!func) func = SNESSkipConverged;
23627f7931b9SBarry Smith   if (snes->ops->convergeddestroy) {
23637f7931b9SBarry Smith     ierr = (*snes->ops->convergeddestroy)(snes->cnvP);CHKERRQ(ierr);
23647f7931b9SBarry Smith   }
236585385478SLisandro Dalcin   snes->ops->converged        = func;
23667f7931b9SBarry Smith   snes->ops->convergeddestroy = destroy;
236785385478SLisandro Dalcin   snes->cnvP                  = cctx;
23683a40ed3dSBarry Smith   PetscFunctionReturn(0);
23699b94acceSBarry Smith }
23709b94acceSBarry Smith 
23714a2ae208SSatish Balay #undef __FUNCT__
23724a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergedReason"
237352baeb72SSatish Balay /*@
2374184914b5SBarry Smith    SNESGetConvergedReason - Gets the reason the SNES iteration was stopped.
2375184914b5SBarry Smith 
2376184914b5SBarry Smith    Not Collective
2377184914b5SBarry Smith 
2378184914b5SBarry Smith    Input Parameter:
2379184914b5SBarry Smith .  snes - the SNES context
2380184914b5SBarry Smith 
2381184914b5SBarry Smith    Output Parameter:
23824d0a8057SBarry Smith .  reason - negative value indicates diverged, positive value converged, see SNESConvergedReason or the
2383184914b5SBarry Smith             manual pages for the individual convergence tests for complete lists
2384184914b5SBarry Smith 
2385184914b5SBarry Smith    Level: intermediate
2386184914b5SBarry Smith 
2387184914b5SBarry Smith    Notes: Can only be called after the call the SNESSolve() is complete.
2388184914b5SBarry Smith 
2389184914b5SBarry Smith .keywords: SNES, nonlinear, set, convergence, test
2390184914b5SBarry Smith 
239185385478SLisandro Dalcin .seealso: SNESSetConvergenceTest(), SNESConvergedReason
2392184914b5SBarry Smith @*/
23937087cfbeSBarry Smith PetscErrorCode  SNESGetConvergedReason(SNES snes,SNESConvergedReason *reason)
2394184914b5SBarry Smith {
2395184914b5SBarry Smith   PetscFunctionBegin;
23960700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
23974482741eSBarry Smith   PetscValidPointer(reason,2);
2398184914b5SBarry Smith   *reason = snes->reason;
2399184914b5SBarry Smith   PetscFunctionReturn(0);
2400184914b5SBarry Smith }
2401184914b5SBarry Smith 
24024a2ae208SSatish Balay #undef __FUNCT__
24034a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceHistory"
2404c9005455SLois Curfman McInnes /*@
2405c9005455SLois Curfman McInnes    SNESSetConvergenceHistory - Sets the array used to hold the convergence history.
2406c9005455SLois Curfman McInnes 
24073f9fe445SBarry Smith    Logically Collective on SNES
2408fee21e36SBarry Smith 
2409c7afd0dbSLois Curfman McInnes    Input Parameters:
2410c7afd0dbSLois Curfman McInnes +  snes - iterative context obtained from SNESCreate()
24118c7482ecSBarry Smith .  a   - array to hold history, this array will contain the function norms computed at each step
2412cd5578b5SBarry Smith .  its - integer array holds the number of linear iterations for each solve.
2413758f92a0SBarry Smith .  na  - size of a and its
241464731454SLois Curfman McInnes -  reset - PETSC_TRUE indicates each new nonlinear solve resets the history counter to zero,
2415758f92a0SBarry Smith            else it continues storing new values for new nonlinear solves after the old ones
2416c7afd0dbSLois Curfman McInnes 
2417308dcc3eSBarry Smith    Notes:
2418308dcc3eSBarry Smith    If 'a' and 'its' are PETSC_NULL then space is allocated for the history. If 'na' PETSC_DECIDE or PETSC_DEFAULT then a
2419308dcc3eSBarry Smith    default array of length 10000 is allocated.
2420308dcc3eSBarry Smith 
2421c9005455SLois Curfman McInnes    This routine is useful, e.g., when running a code for purposes
2422c9005455SLois Curfman McInnes    of accurate performance monitoring, when no I/O should be done
2423c9005455SLois Curfman McInnes    during the section of code that is being timed.
2424c9005455SLois Curfman McInnes 
242536851e7fSLois Curfman McInnes    Level: intermediate
242636851e7fSLois Curfman McInnes 
2427c9005455SLois Curfman McInnes .keywords: SNES, set, convergence, history
2428758f92a0SBarry Smith 
242908405cd6SLois Curfman McInnes .seealso: SNESGetConvergenceHistory()
2430758f92a0SBarry Smith 
2431c9005455SLois Curfman McInnes @*/
24327087cfbeSBarry Smith PetscErrorCode  SNESSetConvergenceHistory(SNES snes,PetscReal a[],PetscInt its[],PetscInt na,PetscBool  reset)
2433c9005455SLois Curfman McInnes {
2434308dcc3eSBarry Smith   PetscErrorCode ierr;
2435308dcc3eSBarry Smith 
24363a40ed3dSBarry Smith   PetscFunctionBegin;
24370700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
24384482741eSBarry Smith   if (na)  PetscValidScalarPointer(a,2);
2439a562a398SLisandro Dalcin   if (its) PetscValidIntPointer(its,3);
2440308dcc3eSBarry Smith   if (na == PETSC_DECIDE || na == PETSC_DEFAULT || !a) {
2441308dcc3eSBarry Smith     if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000;
2442308dcc3eSBarry Smith     ierr = PetscMalloc(na*sizeof(PetscReal),&a);CHKERRQ(ierr);
2443308dcc3eSBarry Smith     ierr = PetscMalloc(na*sizeof(PetscInt),&its);CHKERRQ(ierr);
2444308dcc3eSBarry Smith     snes->conv_malloc   = PETSC_TRUE;
2445308dcc3eSBarry Smith   }
2446c9005455SLois Curfman McInnes   snes->conv_hist       = a;
2447758f92a0SBarry Smith   snes->conv_hist_its   = its;
2448758f92a0SBarry Smith   snes->conv_hist_max   = na;
2449a12bc48fSLisandro Dalcin   snes->conv_hist_len   = 0;
2450758f92a0SBarry Smith   snes->conv_hist_reset = reset;
2451758f92a0SBarry Smith   PetscFunctionReturn(0);
2452758f92a0SBarry Smith }
2453758f92a0SBarry Smith 
2454308dcc3eSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
2455c6db04a5SJed Brown #include <engine.h>   /* MATLAB include file */
2456c6db04a5SJed Brown #include <mex.h>      /* MATLAB include file */
2457308dcc3eSBarry Smith EXTERN_C_BEGIN
2458308dcc3eSBarry Smith #undef __FUNCT__
2459308dcc3eSBarry Smith #define __FUNCT__ "SNESGetConvergenceHistoryMatlab"
2460308dcc3eSBarry Smith mxArray *SNESGetConvergenceHistoryMatlab(SNES snes)
2461308dcc3eSBarry Smith {
2462308dcc3eSBarry Smith   mxArray        *mat;
2463308dcc3eSBarry Smith   PetscInt       i;
2464308dcc3eSBarry Smith   PetscReal      *ar;
2465308dcc3eSBarry Smith 
2466308dcc3eSBarry Smith   PetscFunctionBegin;
2467308dcc3eSBarry Smith   mat  = mxCreateDoubleMatrix(snes->conv_hist_len,1,mxREAL);
2468308dcc3eSBarry Smith   ar   = (PetscReal*) mxGetData(mat);
2469308dcc3eSBarry Smith   for (i=0; i<snes->conv_hist_len; i++) {
2470308dcc3eSBarry Smith     ar[i] = snes->conv_hist[i];
2471308dcc3eSBarry Smith   }
2472308dcc3eSBarry Smith   PetscFunctionReturn(mat);
2473308dcc3eSBarry Smith }
2474308dcc3eSBarry Smith EXTERN_C_END
2475308dcc3eSBarry Smith #endif
2476308dcc3eSBarry Smith 
2477308dcc3eSBarry Smith 
24784a2ae208SSatish Balay #undef __FUNCT__
24794a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergenceHistory"
24800c4c9dddSBarry Smith /*@C
2481758f92a0SBarry Smith    SNESGetConvergenceHistory - Gets the array used to hold the convergence history.
2482758f92a0SBarry Smith 
24833f9fe445SBarry Smith    Not Collective
2484758f92a0SBarry Smith 
2485758f92a0SBarry Smith    Input Parameter:
2486758f92a0SBarry Smith .  snes - iterative context obtained from SNESCreate()
2487758f92a0SBarry Smith 
2488758f92a0SBarry Smith    Output Parameters:
2489758f92a0SBarry Smith .  a   - array to hold history
2490758f92a0SBarry Smith .  its - integer array holds the number of linear iterations (or
2491758f92a0SBarry Smith          negative if not converged) for each solve.
2492758f92a0SBarry Smith -  na  - size of a and its
2493758f92a0SBarry Smith 
2494758f92a0SBarry Smith    Notes:
2495758f92a0SBarry Smith     The calling sequence for this routine in Fortran is
2496758f92a0SBarry Smith $   call SNESGetConvergenceHistory(SNES snes, integer na, integer ierr)
2497758f92a0SBarry Smith 
2498758f92a0SBarry Smith    This routine is useful, e.g., when running a code for purposes
2499758f92a0SBarry Smith    of accurate performance monitoring, when no I/O should be done
2500758f92a0SBarry Smith    during the section of code that is being timed.
2501758f92a0SBarry Smith 
2502758f92a0SBarry Smith    Level: intermediate
2503758f92a0SBarry Smith 
2504758f92a0SBarry Smith .keywords: SNES, get, convergence, history
2505758f92a0SBarry Smith 
2506758f92a0SBarry Smith .seealso: SNESSetConvergencHistory()
2507758f92a0SBarry Smith 
2508758f92a0SBarry Smith @*/
25097087cfbeSBarry Smith PetscErrorCode  SNESGetConvergenceHistory(SNES snes,PetscReal *a[],PetscInt *its[],PetscInt *na)
2510758f92a0SBarry Smith {
2511758f92a0SBarry Smith   PetscFunctionBegin;
25120700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2513758f92a0SBarry Smith   if (a)   *a   = snes->conv_hist;
2514758f92a0SBarry Smith   if (its) *its = snes->conv_hist_its;
2515758f92a0SBarry Smith   if (na)  *na  = snes->conv_hist_len;
25163a40ed3dSBarry Smith   PetscFunctionReturn(0);
2517c9005455SLois Curfman McInnes }
2518c9005455SLois Curfman McInnes 
2519e74ef692SMatthew Knepley #undef __FUNCT__
2520e74ef692SMatthew Knepley #define __FUNCT__ "SNESSetUpdate"
2521ac226902SBarry Smith /*@C
252276b2cf59SMatthew Knepley   SNESSetUpdate - Sets the general-purpose update function called
2523eec8f646SJed Brown   at the beginning of every iteration of the nonlinear solve. Specifically
25247e4bb74cSBarry Smith   it is called just before the Jacobian is "evaluated".
252576b2cf59SMatthew Knepley 
25263f9fe445SBarry Smith   Logically Collective on SNES
252776b2cf59SMatthew Knepley 
252876b2cf59SMatthew Knepley   Input Parameters:
252976b2cf59SMatthew Knepley . snes - The nonlinear solver context
253076b2cf59SMatthew Knepley . func - The function
253176b2cf59SMatthew Knepley 
253276b2cf59SMatthew Knepley   Calling sequence of func:
2533b5d30489SBarry Smith . func (SNES snes, PetscInt step);
253476b2cf59SMatthew Knepley 
253576b2cf59SMatthew Knepley . step - The current step of the iteration
253676b2cf59SMatthew Knepley 
2537fe97e370SBarry Smith   Level: advanced
2538fe97e370SBarry Smith 
2539fe97e370SBarry 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()
2540fe97e370SBarry Smith         This is not used by most users.
254176b2cf59SMatthew Knepley 
254276b2cf59SMatthew Knepley .keywords: SNES, update
2543b5d30489SBarry Smith 
254485385478SLisandro Dalcin .seealso SNESDefaultUpdate(), SNESSetJacobian(), SNESSolve()
254576b2cf59SMatthew Knepley @*/
25467087cfbeSBarry Smith PetscErrorCode  SNESSetUpdate(SNES snes, PetscErrorCode (*func)(SNES, PetscInt))
254776b2cf59SMatthew Knepley {
254876b2cf59SMatthew Knepley   PetscFunctionBegin;
25490700a824SBarry Smith   PetscValidHeaderSpecific(snes, SNES_CLASSID,1);
2550e7788613SBarry Smith   snes->ops->update = func;
255176b2cf59SMatthew Knepley   PetscFunctionReturn(0);
255276b2cf59SMatthew Knepley }
255376b2cf59SMatthew Knepley 
2554e74ef692SMatthew Knepley #undef __FUNCT__
2555e74ef692SMatthew Knepley #define __FUNCT__ "SNESDefaultUpdate"
255676b2cf59SMatthew Knepley /*@
255776b2cf59SMatthew Knepley   SNESDefaultUpdate - The default update function which does nothing.
255876b2cf59SMatthew Knepley 
255976b2cf59SMatthew Knepley   Not collective
256076b2cf59SMatthew Knepley 
256176b2cf59SMatthew Knepley   Input Parameters:
256276b2cf59SMatthew Knepley . snes - The nonlinear solver context
256376b2cf59SMatthew Knepley . step - The current step of the iteration
256476b2cf59SMatthew Knepley 
2565205452f4SMatthew Knepley   Level: intermediate
2566205452f4SMatthew Knepley 
256776b2cf59SMatthew Knepley .keywords: SNES, update
2568a6570f20SBarry Smith .seealso SNESSetUpdate(), SNESDefaultRhsBC(), SNESDefaultShortolutionBC()
256976b2cf59SMatthew Knepley @*/
25707087cfbeSBarry Smith PetscErrorCode  SNESDefaultUpdate(SNES snes, PetscInt step)
257176b2cf59SMatthew Knepley {
257276b2cf59SMatthew Knepley   PetscFunctionBegin;
257376b2cf59SMatthew Knepley   PetscFunctionReturn(0);
257476b2cf59SMatthew Knepley }
257576b2cf59SMatthew Knepley 
25764a2ae208SSatish Balay #undef __FUNCT__
25774a2ae208SSatish Balay #define __FUNCT__ "SNESScaleStep_Private"
25789b94acceSBarry Smith /*
25799b94acceSBarry Smith    SNESScaleStep_Private - Scales a step so that its length is less than the
25809b94acceSBarry Smith    positive parameter delta.
25819b94acceSBarry Smith 
25829b94acceSBarry Smith     Input Parameters:
2583c7afd0dbSLois Curfman McInnes +   snes - the SNES context
25849b94acceSBarry Smith .   y - approximate solution of linear system
25859b94acceSBarry Smith .   fnorm - 2-norm of current function
2586c7afd0dbSLois Curfman McInnes -   delta - trust region size
25879b94acceSBarry Smith 
25889b94acceSBarry Smith     Output Parameters:
2589c7afd0dbSLois Curfman McInnes +   gpnorm - predicted function norm at the new point, assuming local
25909b94acceSBarry Smith     linearization.  The value is zero if the step lies within the trust
25919b94acceSBarry Smith     region, and exceeds zero otherwise.
2592c7afd0dbSLois Curfman McInnes -   ynorm - 2-norm of the step
25939b94acceSBarry Smith 
25949b94acceSBarry Smith     Note:
25954b27c08aSLois Curfman McInnes     For non-trust region methods such as SNESLS, the parameter delta
25969b94acceSBarry Smith     is set to be the maximum allowable step size.
25979b94acceSBarry Smith 
25989b94acceSBarry Smith .keywords: SNES, nonlinear, scale, step
25999b94acceSBarry Smith */
2600dfbe8321SBarry Smith PetscErrorCode SNESScaleStep_Private(SNES snes,Vec y,PetscReal *fnorm,PetscReal *delta,PetscReal *gpnorm,PetscReal *ynorm)
26019b94acceSBarry Smith {
2602064f8208SBarry Smith   PetscReal      nrm;
2603ea709b57SSatish Balay   PetscScalar    cnorm;
2604dfbe8321SBarry Smith   PetscErrorCode ierr;
26053a40ed3dSBarry Smith 
26063a40ed3dSBarry Smith   PetscFunctionBegin;
26070700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
26080700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,2);
2609c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,y,2);
2610184914b5SBarry Smith 
2611064f8208SBarry Smith   ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr);
2612064f8208SBarry Smith   if (nrm > *delta) {
2613064f8208SBarry Smith      nrm = *delta/nrm;
2614064f8208SBarry Smith      *gpnorm = (1.0 - nrm)*(*fnorm);
2615064f8208SBarry Smith      cnorm = nrm;
26162dcb1b2aSMatthew Knepley      ierr = VecScale(y,cnorm);CHKERRQ(ierr);
26179b94acceSBarry Smith      *ynorm = *delta;
26189b94acceSBarry Smith   } else {
26199b94acceSBarry Smith      *gpnorm = 0.0;
2620064f8208SBarry Smith      *ynorm = nrm;
26219b94acceSBarry Smith   }
26223a40ed3dSBarry Smith   PetscFunctionReturn(0);
26239b94acceSBarry Smith }
26249b94acceSBarry Smith 
26254a2ae208SSatish Balay #undef __FUNCT__
26264a2ae208SSatish Balay #define __FUNCT__ "SNESSolve"
26276ce558aeSBarry Smith /*@C
2628f69a0ea3SMatthew Knepley    SNESSolve - Solves a nonlinear system F(x) = b.
2629f69a0ea3SMatthew Knepley    Call SNESSolve() after calling SNESCreate() and optional routines of the form SNESSetXXX().
26309b94acceSBarry Smith 
2631c7afd0dbSLois Curfman McInnes    Collective on SNES
2632c7afd0dbSLois Curfman McInnes 
2633b2002411SLois Curfman McInnes    Input Parameters:
2634c7afd0dbSLois Curfman McInnes +  snes - the SNES context
26353cebf274SJed Brown .  b - the constant part of the equation F(x) = b, or PETSC_NULL to use zero.
263685385478SLisandro Dalcin -  x - the solution vector.
26379b94acceSBarry Smith 
2638b2002411SLois Curfman McInnes    Notes:
26398ddd3da0SLois Curfman McInnes    The user should initialize the vector,x, with the initial guess
26408ddd3da0SLois Curfman McInnes    for the nonlinear solve prior to calling SNESSolve.  In particular,
26418ddd3da0SLois Curfman McInnes    to employ an initial guess of zero, the user should explicitly set
26428ddd3da0SLois Curfman McInnes    this vector to zero by calling VecSet().
26438ddd3da0SLois Curfman McInnes 
264436851e7fSLois Curfman McInnes    Level: beginner
264536851e7fSLois Curfman McInnes 
26469b94acceSBarry Smith .keywords: SNES, nonlinear, solve
26479b94acceSBarry Smith 
264885385478SLisandro Dalcin .seealso: SNESCreate(), SNESDestroy(), SNESSetFunction(), SNESSetJacobian()
26499b94acceSBarry Smith @*/
26507087cfbeSBarry Smith PetscErrorCode  SNESSolve(SNES snes,Vec b,Vec x)
26519b94acceSBarry Smith {
2652dfbe8321SBarry Smith   PetscErrorCode ierr;
2653ace3abfcSBarry Smith   PetscBool      flg;
2654eabae89aSBarry Smith   char           filename[PETSC_MAX_PATH_LEN];
2655eabae89aSBarry Smith   PetscViewer    viewer;
2656efd51863SBarry Smith   PetscInt       grid;
2657052efed2SBarry Smith 
26583a40ed3dSBarry Smith   PetscFunctionBegin;
26590700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
26600700a824SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,3);
2661f69a0ea3SMatthew Knepley   PetscCheckSameComm(snes,1,x,3);
26620700a824SBarry Smith   if (b) PetscValidHeaderSpecific(b,VEC_CLASSID,2);
266385385478SLisandro Dalcin   if (b) PetscCheckSameComm(snes,1,b,2);
266485385478SLisandro Dalcin 
2665a8248277SBarry Smith   for (grid=0; grid<snes->gridsequence; grid++) {ierr = PetscViewerASCIIPushTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm));CHKERRQ(ierr);}
2666efd51863SBarry Smith   for (grid=0; grid<snes->gridsequence+1; grid++) {
2667efd51863SBarry Smith 
266885385478SLisandro Dalcin     /* set solution vector */
2669efd51863SBarry Smith     if (!grid) {ierr = PetscObjectReference((PetscObject)x);CHKERRQ(ierr);}
26706bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr);
267185385478SLisandro Dalcin     snes->vec_sol = x;
267285385478SLisandro Dalcin     /* set afine vector if provided */
267385385478SLisandro Dalcin     if (b) { ierr = PetscObjectReference((PetscObject)b);CHKERRQ(ierr); }
26746bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr);
267585385478SLisandro Dalcin     snes->vec_rhs = b;
267685385478SLisandro Dalcin 
267770e92668SMatthew Knepley     ierr = SNESSetUp(snes);CHKERRQ(ierr);
26783f149594SLisandro Dalcin 
2679d25893d9SBarry Smith     if (!grid && snes->ops->computeinitialguess) {
2680d25893d9SBarry Smith       ierr = (*snes->ops->computeinitialguess)(snes,snes->vec_sol,snes->initialguessP);CHKERRQ(ierr);
2681d25893d9SBarry Smith     }
2682d25893d9SBarry Smith 
2683abc0a331SBarry Smith     if (snes->conv_hist_reset) snes->conv_hist_len = 0;
268450ffb88aSMatthew Knepley     snes->nfuncs = 0; snes->linear_its = 0; snes->numFailures = 0;
2685d5e45103SBarry Smith 
26863f149594SLisandro Dalcin     ierr = PetscLogEventBegin(SNES_Solve,snes,0,0,0);CHKERRQ(ierr);
26874936397dSBarry Smith     ierr = (*snes->ops->solve)(snes);CHKERRQ(ierr);
268885385478SLisandro Dalcin     ierr = PetscLogEventEnd(SNES_Solve,snes,0,0,0);CHKERRQ(ierr);
26894936397dSBarry Smith     if (snes->domainerror){
26904936397dSBarry Smith       snes->reason      = SNES_DIVERGED_FUNCTION_DOMAIN;
26914936397dSBarry Smith       snes->domainerror = PETSC_FALSE;
26924936397dSBarry Smith     }
269317186662SBarry Smith     if (!snes->reason) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Internal error, solver returned without setting converged reason");
26943f149594SLisandro Dalcin 
26957adad957SLisandro Dalcin     ierr = PetscOptionsGetString(((PetscObject)snes)->prefix,"-snes_view",filename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
2696eabae89aSBarry Smith     if (flg && !PetscPreLoadingOn) {
26977adad957SLisandro Dalcin       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,filename,&viewer);CHKERRQ(ierr);
2698eabae89aSBarry Smith       ierr = SNESView(snes,viewer);CHKERRQ(ierr);
26996bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
2700eabae89aSBarry Smith     }
2701eabae89aSBarry Smith 
270290d69ab7SBarry Smith     flg  = PETSC_FALSE;
2703acfcf0e5SJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_test_local_min",&flg,PETSC_NULL);CHKERRQ(ierr);
2704da9b6338SBarry Smith     if (flg && !PetscPreLoadingOn) { ierr = SNESTestLocalMin(snes);CHKERRQ(ierr); }
27055968eb51SBarry Smith     if (snes->printreason) {
2706a8248277SBarry Smith       ierr = PetscViewerASCIIAddTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),((PetscObject)snes)->tablevel);CHKERRQ(ierr);
27075968eb51SBarry Smith       if (snes->reason > 0) {
2708a8248277SBarry Smith         ierr = PetscViewerASCIIPrintf(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),"Nonlinear solve converged due to %s\n",SNESConvergedReasons[snes->reason]);CHKERRQ(ierr);
27095968eb51SBarry Smith       } else {
2710a8248277SBarry Smith         ierr = PetscViewerASCIIPrintf(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),"Nonlinear solve did not converge due to %s\n",SNESConvergedReasons[snes->reason]);CHKERRQ(ierr);
27115968eb51SBarry Smith       }
2712a8248277SBarry Smith       ierr = PetscViewerASCIISubtractTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),((PetscObject)snes)->tablevel);CHKERRQ(ierr);
27135968eb51SBarry Smith     }
27145968eb51SBarry Smith 
2715e113a28aSBarry Smith     if (snes->errorifnotconverged && snes->reason < 0) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_NOT_CONVERGED,"SNESSolve has not converged");
2716efd51863SBarry Smith     if (grid <  snes->gridsequence) {
2717efd51863SBarry Smith       DM  fine;
2718efd51863SBarry Smith       Vec xnew;
2719efd51863SBarry Smith       Mat interp;
2720efd51863SBarry Smith 
2721efd51863SBarry Smith       ierr = DMRefine(snes->dm,((PetscObject)snes)->comm,&fine);CHKERRQ(ierr);
2722efd51863SBarry Smith       ierr = DMGetInterpolation(snes->dm,fine,&interp,PETSC_NULL);CHKERRQ(ierr);
2723efd51863SBarry Smith       ierr = DMCreateGlobalVector(fine,&xnew);CHKERRQ(ierr);
2724efd51863SBarry Smith       ierr = MatInterpolate(interp,x,xnew);CHKERRQ(ierr);
2725efd51863SBarry Smith       ierr = MatDestroy(&interp);CHKERRQ(ierr);
2726efd51863SBarry Smith       x    = xnew;
2727efd51863SBarry Smith 
2728efd51863SBarry Smith       ierr = SNESReset(snes);CHKERRQ(ierr);
2729efd51863SBarry Smith       ierr = SNESSetDM(snes,fine);CHKERRQ(ierr);
2730efd51863SBarry Smith       ierr = DMDestroy(&fine);CHKERRQ(ierr);
2731a8248277SBarry Smith       ierr = PetscViewerASCIIPopTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm));CHKERRQ(ierr);
2732efd51863SBarry Smith     }
2733efd51863SBarry Smith   }
27343a40ed3dSBarry Smith   PetscFunctionReturn(0);
27359b94acceSBarry Smith }
27369b94acceSBarry Smith 
27379b94acceSBarry Smith /* --------- Internal routines for SNES Package --------- */
27389b94acceSBarry Smith 
27394a2ae208SSatish Balay #undef __FUNCT__
27404a2ae208SSatish Balay #define __FUNCT__ "SNESSetType"
274182bf6240SBarry Smith /*@C
27424b0e389bSBarry Smith    SNESSetType - Sets the method for the nonlinear solver.
27439b94acceSBarry Smith 
2744fee21e36SBarry Smith    Collective on SNES
2745fee21e36SBarry Smith 
2746c7afd0dbSLois Curfman McInnes    Input Parameters:
2747c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2748454a90a3SBarry Smith -  type - a known method
2749c7afd0dbSLois Curfman McInnes 
2750c7afd0dbSLois Curfman McInnes    Options Database Key:
2751454a90a3SBarry Smith .  -snes_type <type> - Sets the method; use -help for a list
2752c7afd0dbSLois Curfman McInnes    of available methods (for instance, ls or tr)
2753ae12b187SLois Curfman McInnes 
27549b94acceSBarry Smith    Notes:
2755e090d566SSatish Balay    See "petsc/include/petscsnes.h" for available methods (for instance)
27564b27c08aSLois Curfman McInnes +    SNESLS - Newton's method with line search
2757c7afd0dbSLois Curfman McInnes      (systems of nonlinear equations)
27584b27c08aSLois Curfman McInnes .    SNESTR - Newton's method with trust region
2759c7afd0dbSLois Curfman McInnes      (systems of nonlinear equations)
27609b94acceSBarry Smith 
2761ae12b187SLois Curfman McInnes   Normally, it is best to use the SNESSetFromOptions() command and then
2762ae12b187SLois Curfman McInnes   set the SNES solver type from the options database rather than by using
2763ae12b187SLois Curfman McInnes   this routine.  Using the options database provides the user with
2764ae12b187SLois Curfman McInnes   maximum flexibility in evaluating the many nonlinear solvers.
2765ae12b187SLois Curfman McInnes   The SNESSetType() routine is provided for those situations where it
2766ae12b187SLois Curfman McInnes   is necessary to set the nonlinear solver independently of the command
2767ae12b187SLois Curfman McInnes   line or options database.  This might be the case, for example, when
2768ae12b187SLois Curfman McInnes   the choice of solver changes during the execution of the program,
2769ae12b187SLois Curfman McInnes   and the user's application is taking responsibility for choosing the
2770b0a32e0cSBarry Smith   appropriate method.
277136851e7fSLois Curfman McInnes 
277236851e7fSLois Curfman McInnes   Level: intermediate
2773a703fe33SLois Curfman McInnes 
2774454a90a3SBarry Smith .keywords: SNES, set, type
2775435da068SBarry Smith 
2776435da068SBarry Smith .seealso: SNESType, SNESCreate()
2777435da068SBarry Smith 
27789b94acceSBarry Smith @*/
27797087cfbeSBarry Smith PetscErrorCode  SNESSetType(SNES snes,const SNESType type)
27809b94acceSBarry Smith {
2781dfbe8321SBarry Smith   PetscErrorCode ierr,(*r)(SNES);
2782ace3abfcSBarry Smith   PetscBool      match;
27833a40ed3dSBarry Smith 
27843a40ed3dSBarry Smith   PetscFunctionBegin;
27850700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
27864482741eSBarry Smith   PetscValidCharPointer(type,2);
278782bf6240SBarry Smith 
27886831982aSBarry Smith   ierr = PetscTypeCompare((PetscObject)snes,type,&match);CHKERRQ(ierr);
27890f5bd95cSBarry Smith   if (match) PetscFunctionReturn(0);
279092ff6ae8SBarry Smith 
27914b91b6eaSBarry Smith   ierr =  PetscFListFind(SNESList,((PetscObject)snes)->comm,type,PETSC_TRUE,(void (**)(void)) &r);CHKERRQ(ierr);
2792e32f2f54SBarry Smith   if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested SNES type %s",type);
279375396ef9SLisandro Dalcin   /* Destroy the previous private SNES context */
279475396ef9SLisandro Dalcin   if (snes->ops->destroy) { ierr = (*(snes)->ops->destroy)(snes);CHKERRQ(ierr); }
279575396ef9SLisandro Dalcin   /* Reinitialize function pointers in SNESOps structure */
279675396ef9SLisandro Dalcin   snes->ops->setup          = 0;
279775396ef9SLisandro Dalcin   snes->ops->solve          = 0;
279875396ef9SLisandro Dalcin   snes->ops->view           = 0;
279975396ef9SLisandro Dalcin   snes->ops->setfromoptions = 0;
280075396ef9SLisandro Dalcin   snes->ops->destroy        = 0;
280175396ef9SLisandro Dalcin   /* Call the SNESCreate_XXX routine for this particular Nonlinear solver */
280275396ef9SLisandro Dalcin   snes->setupcalled = PETSC_FALSE;
2803454a90a3SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)snes,type);CHKERRQ(ierr);
280403bfa161SLisandro Dalcin   ierr = (*r)(snes);CHKERRQ(ierr);
28059fb22e1aSBarry Smith #if defined(PETSC_HAVE_AMS)
28069fb22e1aSBarry Smith   if (PetscAMSPublishAll) {
28079fb22e1aSBarry Smith     ierr = PetscObjectAMSPublish((PetscObject)snes);CHKERRQ(ierr);
28089fb22e1aSBarry Smith   }
28099fb22e1aSBarry Smith #endif
28103a40ed3dSBarry Smith   PetscFunctionReturn(0);
28119b94acceSBarry Smith }
28129b94acceSBarry Smith 
2813a847f771SSatish Balay 
28149b94acceSBarry Smith /* --------------------------------------------------------------------- */
28154a2ae208SSatish Balay #undef __FUNCT__
28164a2ae208SSatish Balay #define __FUNCT__ "SNESRegisterDestroy"
281752baeb72SSatish Balay /*@
28189b94acceSBarry Smith    SNESRegisterDestroy - Frees the list of nonlinear solvers that were
2819f1af5d2fSBarry Smith    registered by SNESRegisterDynamic().
28209b94acceSBarry Smith 
2821fee21e36SBarry Smith    Not Collective
2822fee21e36SBarry Smith 
282336851e7fSLois Curfman McInnes    Level: advanced
282436851e7fSLois Curfman McInnes 
28259b94acceSBarry Smith .keywords: SNES, nonlinear, register, destroy
28269b94acceSBarry Smith 
28279b94acceSBarry Smith .seealso: SNESRegisterAll(), SNESRegisterAll()
28289b94acceSBarry Smith @*/
28297087cfbeSBarry Smith PetscErrorCode  SNESRegisterDestroy(void)
28309b94acceSBarry Smith {
2831dfbe8321SBarry Smith   PetscErrorCode ierr;
283282bf6240SBarry Smith 
28333a40ed3dSBarry Smith   PetscFunctionBegin;
28341441b1d3SBarry Smith   ierr = PetscFListDestroy(&SNESList);CHKERRQ(ierr);
28354c49b128SBarry Smith   SNESRegisterAllCalled = PETSC_FALSE;
28363a40ed3dSBarry Smith   PetscFunctionReturn(0);
28379b94acceSBarry Smith }
28389b94acceSBarry Smith 
28394a2ae208SSatish Balay #undef __FUNCT__
28404a2ae208SSatish Balay #define __FUNCT__ "SNESGetType"
28419b94acceSBarry Smith /*@C
28429a28b0a6SLois Curfman McInnes    SNESGetType - Gets the SNES method type and name (as a string).
28439b94acceSBarry Smith 
2844c7afd0dbSLois Curfman McInnes    Not Collective
2845c7afd0dbSLois Curfman McInnes 
28469b94acceSBarry Smith    Input Parameter:
28474b0e389bSBarry Smith .  snes - nonlinear solver context
28489b94acceSBarry Smith 
28499b94acceSBarry Smith    Output Parameter:
28503a7fca6bSBarry Smith .  type - SNES method (a character string)
28519b94acceSBarry Smith 
285236851e7fSLois Curfman McInnes    Level: intermediate
285336851e7fSLois Curfman McInnes 
2854454a90a3SBarry Smith .keywords: SNES, nonlinear, get, type, name
28559b94acceSBarry Smith @*/
28567087cfbeSBarry Smith PetscErrorCode  SNESGetType(SNES snes,const SNESType *type)
28579b94acceSBarry Smith {
28583a40ed3dSBarry Smith   PetscFunctionBegin;
28590700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
28604482741eSBarry Smith   PetscValidPointer(type,2);
28617adad957SLisandro Dalcin   *type = ((PetscObject)snes)->type_name;
28623a40ed3dSBarry Smith   PetscFunctionReturn(0);
28639b94acceSBarry Smith }
28649b94acceSBarry Smith 
28654a2ae208SSatish Balay #undef __FUNCT__
28664a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolution"
286752baeb72SSatish Balay /*@
28689b94acceSBarry Smith    SNESGetSolution - Returns the vector where the approximate solution is
28699b94acceSBarry Smith    stored.
28709b94acceSBarry Smith 
2871c7afd0dbSLois Curfman McInnes    Not Collective, but Vec is parallel if SNES is parallel
2872c7afd0dbSLois Curfman McInnes 
28739b94acceSBarry Smith    Input Parameter:
28749b94acceSBarry Smith .  snes - the SNES context
28759b94acceSBarry Smith 
28769b94acceSBarry Smith    Output Parameter:
28779b94acceSBarry Smith .  x - the solution
28789b94acceSBarry Smith 
287970e92668SMatthew Knepley    Level: intermediate
288036851e7fSLois Curfman McInnes 
28819b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution
28829b94acceSBarry Smith 
288385385478SLisandro Dalcin .seealso:  SNESGetSolutionUpdate(), SNESGetFunction()
28849b94acceSBarry Smith @*/
28857087cfbeSBarry Smith PetscErrorCode  SNESGetSolution(SNES snes,Vec *x)
28869b94acceSBarry Smith {
28873a40ed3dSBarry Smith   PetscFunctionBegin;
28880700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
28894482741eSBarry Smith   PetscValidPointer(x,2);
289085385478SLisandro Dalcin   *x = snes->vec_sol;
289170e92668SMatthew Knepley   PetscFunctionReturn(0);
289270e92668SMatthew Knepley }
289370e92668SMatthew Knepley 
289470e92668SMatthew Knepley #undef __FUNCT__
28954a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolutionUpdate"
289652baeb72SSatish Balay /*@
28979b94acceSBarry Smith    SNESGetSolutionUpdate - Returns the vector where the solution update is
28989b94acceSBarry Smith    stored.
28999b94acceSBarry Smith 
2900c7afd0dbSLois Curfman McInnes    Not Collective, but Vec is parallel if SNES is parallel
2901c7afd0dbSLois Curfman McInnes 
29029b94acceSBarry Smith    Input Parameter:
29039b94acceSBarry Smith .  snes - the SNES context
29049b94acceSBarry Smith 
29059b94acceSBarry Smith    Output Parameter:
29069b94acceSBarry Smith .  x - the solution update
29079b94acceSBarry Smith 
290836851e7fSLois Curfman McInnes    Level: advanced
290936851e7fSLois Curfman McInnes 
29109b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution, update
29119b94acceSBarry Smith 
291285385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction()
29139b94acceSBarry Smith @*/
29147087cfbeSBarry Smith PetscErrorCode  SNESGetSolutionUpdate(SNES snes,Vec *x)
29159b94acceSBarry Smith {
29163a40ed3dSBarry Smith   PetscFunctionBegin;
29170700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
29184482741eSBarry Smith   PetscValidPointer(x,2);
291985385478SLisandro Dalcin   *x = snes->vec_sol_update;
29203a40ed3dSBarry Smith   PetscFunctionReturn(0);
29219b94acceSBarry Smith }
29229b94acceSBarry Smith 
29234a2ae208SSatish Balay #undef __FUNCT__
29244a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunction"
29259b94acceSBarry Smith /*@C
29263638b69dSLois Curfman McInnes    SNESGetFunction - Returns the vector where the function is stored.
29279b94acceSBarry Smith 
2928c7afd0dbSLois Curfman McInnes    Not Collective, but Vec is parallel if SNES is parallel
2929c7afd0dbSLois Curfman McInnes 
29309b94acceSBarry Smith    Input Parameter:
29319b94acceSBarry Smith .  snes - the SNES context
29329b94acceSBarry Smith 
29339b94acceSBarry Smith    Output Parameter:
29347bf4e008SBarry Smith +  r - the function (or PETSC_NULL)
293570e92668SMatthew Knepley .  func - the function (or PETSC_NULL)
293670e92668SMatthew Knepley -  ctx - the function context (or PETSC_NULL)
29379b94acceSBarry Smith 
293836851e7fSLois Curfman McInnes    Level: advanced
293936851e7fSLois Curfman McInnes 
2940a86d99e1SLois Curfman McInnes .keywords: SNES, nonlinear, get, function
29419b94acceSBarry Smith 
29424b27c08aSLois Curfman McInnes .seealso: SNESSetFunction(), SNESGetSolution()
29439b94acceSBarry Smith @*/
29447087cfbeSBarry Smith PetscErrorCode  SNESGetFunction(SNES snes,Vec *r,PetscErrorCode (**func)(SNES,Vec,Vec,void*),void **ctx)
29459b94acceSBarry Smith {
29463a40ed3dSBarry Smith   PetscFunctionBegin;
29470700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
294885385478SLisandro Dalcin   if (r)    *r    = snes->vec_func;
2949e7788613SBarry Smith   if (func) *func = snes->ops->computefunction;
295070e92668SMatthew Knepley   if (ctx)  *ctx  = snes->funP;
29513a40ed3dSBarry Smith   PetscFunctionReturn(0);
29529b94acceSBarry Smith }
29539b94acceSBarry Smith 
29544a2ae208SSatish Balay #undef __FUNCT__
29554a2ae208SSatish Balay #define __FUNCT__ "SNESSetOptionsPrefix"
29563c7409f5SSatish Balay /*@C
29573c7409f5SSatish Balay    SNESSetOptionsPrefix - Sets the prefix used for searching for all
2958d850072dSLois Curfman McInnes    SNES options in the database.
29593c7409f5SSatish Balay 
29603f9fe445SBarry Smith    Logically Collective on SNES
2961fee21e36SBarry Smith 
2962c7afd0dbSLois Curfman McInnes    Input Parameter:
2963c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2964c7afd0dbSLois Curfman McInnes -  prefix - the prefix to prepend to all option names
2965c7afd0dbSLois Curfman McInnes 
2966d850072dSLois Curfman McInnes    Notes:
2967a83b1b31SSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
2968c7afd0dbSLois Curfman McInnes    The first character of all runtime options is AUTOMATICALLY the hyphen.
2969d850072dSLois Curfman McInnes 
297036851e7fSLois Curfman McInnes    Level: advanced
297136851e7fSLois Curfman McInnes 
29723c7409f5SSatish Balay .keywords: SNES, set, options, prefix, database
2973a86d99e1SLois Curfman McInnes 
2974a86d99e1SLois Curfman McInnes .seealso: SNESSetFromOptions()
29753c7409f5SSatish Balay @*/
29767087cfbeSBarry Smith PetscErrorCode  SNESSetOptionsPrefix(SNES snes,const char prefix[])
29773c7409f5SSatish Balay {
2978dfbe8321SBarry Smith   PetscErrorCode ierr;
29793c7409f5SSatish Balay 
29803a40ed3dSBarry Smith   PetscFunctionBegin;
29810700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2982639f9d9dSBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
29831cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
298494b7f48cSBarry Smith   ierr = KSPSetOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr);
29853a40ed3dSBarry Smith   PetscFunctionReturn(0);
29863c7409f5SSatish Balay }
29873c7409f5SSatish Balay 
29884a2ae208SSatish Balay #undef __FUNCT__
29894a2ae208SSatish Balay #define __FUNCT__ "SNESAppendOptionsPrefix"
29903c7409f5SSatish Balay /*@C
2991f525115eSLois Curfman McInnes    SNESAppendOptionsPrefix - Appends to the prefix used for searching for all
2992d850072dSLois Curfman McInnes    SNES options in the database.
29933c7409f5SSatish Balay 
29943f9fe445SBarry Smith    Logically Collective on SNES
2995fee21e36SBarry Smith 
2996c7afd0dbSLois Curfman McInnes    Input Parameters:
2997c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2998c7afd0dbSLois Curfman McInnes -  prefix - the prefix to prepend to all option names
2999c7afd0dbSLois Curfman McInnes 
3000d850072dSLois Curfman McInnes    Notes:
3001a83b1b31SSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
3002c7afd0dbSLois Curfman McInnes    The first character of all runtime options is AUTOMATICALLY the hyphen.
3003d850072dSLois Curfman McInnes 
300436851e7fSLois Curfman McInnes    Level: advanced
300536851e7fSLois Curfman McInnes 
30063c7409f5SSatish Balay .keywords: SNES, append, options, prefix, database
3007a86d99e1SLois Curfman McInnes 
3008a86d99e1SLois Curfman McInnes .seealso: SNESGetOptionsPrefix()
30093c7409f5SSatish Balay @*/
30107087cfbeSBarry Smith PetscErrorCode  SNESAppendOptionsPrefix(SNES snes,const char prefix[])
30113c7409f5SSatish Balay {
3012dfbe8321SBarry Smith   PetscErrorCode ierr;
30133c7409f5SSatish Balay 
30143a40ed3dSBarry Smith   PetscFunctionBegin;
30150700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3016639f9d9dSBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
30171cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
301894b7f48cSBarry Smith   ierr = KSPAppendOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr);
30193a40ed3dSBarry Smith   PetscFunctionReturn(0);
30203c7409f5SSatish Balay }
30213c7409f5SSatish Balay 
30224a2ae208SSatish Balay #undef __FUNCT__
30234a2ae208SSatish Balay #define __FUNCT__ "SNESGetOptionsPrefix"
30249ab63eb5SSatish Balay /*@C
30253c7409f5SSatish Balay    SNESGetOptionsPrefix - Sets the prefix used for searching for all
30263c7409f5SSatish Balay    SNES options in the database.
30273c7409f5SSatish Balay 
3028c7afd0dbSLois Curfman McInnes    Not Collective
3029c7afd0dbSLois Curfman McInnes 
30303c7409f5SSatish Balay    Input Parameter:
30313c7409f5SSatish Balay .  snes - the SNES context
30323c7409f5SSatish Balay 
30333c7409f5SSatish Balay    Output Parameter:
30343c7409f5SSatish Balay .  prefix - pointer to the prefix string used
30353c7409f5SSatish Balay 
30364ef407dbSRichard Tran Mills    Notes: On the fortran side, the user should pass in a string 'prefix' of
30379ab63eb5SSatish Balay    sufficient length to hold the prefix.
30389ab63eb5SSatish Balay 
303936851e7fSLois Curfman McInnes    Level: advanced
304036851e7fSLois Curfman McInnes 
30413c7409f5SSatish Balay .keywords: SNES, get, options, prefix, database
3042a86d99e1SLois Curfman McInnes 
3043a86d99e1SLois Curfman McInnes .seealso: SNESAppendOptionsPrefix()
30443c7409f5SSatish Balay @*/
30457087cfbeSBarry Smith PetscErrorCode  SNESGetOptionsPrefix(SNES snes,const char *prefix[])
30463c7409f5SSatish Balay {
3047dfbe8321SBarry Smith   PetscErrorCode ierr;
30483c7409f5SSatish Balay 
30493a40ed3dSBarry Smith   PetscFunctionBegin;
30500700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3051639f9d9dSBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
30523a40ed3dSBarry Smith   PetscFunctionReturn(0);
30533c7409f5SSatish Balay }
30543c7409f5SSatish Balay 
3055b2002411SLois Curfman McInnes 
30564a2ae208SSatish Balay #undef __FUNCT__
30574a2ae208SSatish Balay #define __FUNCT__ "SNESRegister"
30583cea93caSBarry Smith /*@C
30593cea93caSBarry Smith   SNESRegister - See SNESRegisterDynamic()
30603cea93caSBarry Smith 
30617f6c08e0SMatthew Knepley   Level: advanced
30623cea93caSBarry Smith @*/
30637087cfbeSBarry Smith PetscErrorCode  SNESRegister(const char sname[],const char path[],const char name[],PetscErrorCode (*function)(SNES))
3064b2002411SLois Curfman McInnes {
3065e2d1d2b7SBarry Smith   char           fullname[PETSC_MAX_PATH_LEN];
3066dfbe8321SBarry Smith   PetscErrorCode ierr;
3067b2002411SLois Curfman McInnes 
3068b2002411SLois Curfman McInnes   PetscFunctionBegin;
3069b0a32e0cSBarry Smith   ierr = PetscFListConcat(path,name,fullname);CHKERRQ(ierr);
3070c134de8dSSatish Balay   ierr = PetscFListAdd(&SNESList,sname,fullname,(void (*)(void))function);CHKERRQ(ierr);
3071b2002411SLois Curfman McInnes   PetscFunctionReturn(0);
3072b2002411SLois Curfman McInnes }
3073da9b6338SBarry Smith 
3074da9b6338SBarry Smith #undef __FUNCT__
3075da9b6338SBarry Smith #define __FUNCT__ "SNESTestLocalMin"
30767087cfbeSBarry Smith PetscErrorCode  SNESTestLocalMin(SNES snes)
3077da9b6338SBarry Smith {
3078dfbe8321SBarry Smith   PetscErrorCode ierr;
307977431f27SBarry Smith   PetscInt       N,i,j;
3080da9b6338SBarry Smith   Vec            u,uh,fh;
3081da9b6338SBarry Smith   PetscScalar    value;
3082da9b6338SBarry Smith   PetscReal      norm;
3083da9b6338SBarry Smith 
3084da9b6338SBarry Smith   PetscFunctionBegin;
3085da9b6338SBarry Smith   ierr = SNESGetSolution(snes,&u);CHKERRQ(ierr);
3086da9b6338SBarry Smith   ierr = VecDuplicate(u,&uh);CHKERRQ(ierr);
3087da9b6338SBarry Smith   ierr = VecDuplicate(u,&fh);CHKERRQ(ierr);
3088da9b6338SBarry Smith 
3089da9b6338SBarry Smith   /* currently only works for sequential */
3090da9b6338SBarry Smith   ierr = PetscPrintf(PETSC_COMM_WORLD,"Testing FormFunction() for local min\n");
3091da9b6338SBarry Smith   ierr = VecGetSize(u,&N);CHKERRQ(ierr);
3092da9b6338SBarry Smith   for (i=0; i<N; i++) {
3093da9b6338SBarry Smith     ierr = VecCopy(u,uh);CHKERRQ(ierr);
309477431f27SBarry Smith     ierr  = PetscPrintf(PETSC_COMM_WORLD,"i = %D\n",i);CHKERRQ(ierr);
3095da9b6338SBarry Smith     for (j=-10; j<11; j++) {
3096ccae9161SBarry Smith       value = PetscSign(j)*exp(PetscAbs(j)-10.0);
3097da9b6338SBarry Smith       ierr  = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr);
30983ab0aad5SBarry Smith       ierr  = SNESComputeFunction(snes,uh,fh);CHKERRQ(ierr);
3099da9b6338SBarry Smith       ierr  = VecNorm(fh,NORM_2,&norm);CHKERRQ(ierr);
310077431f27SBarry Smith       ierr  = PetscPrintf(PETSC_COMM_WORLD,"       j norm %D %18.16e\n",j,norm);CHKERRQ(ierr);
3101da9b6338SBarry Smith       value = -value;
3102da9b6338SBarry Smith       ierr  = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr);
3103da9b6338SBarry Smith     }
3104da9b6338SBarry Smith   }
31056bf464f9SBarry Smith   ierr = VecDestroy(&uh);CHKERRQ(ierr);
31066bf464f9SBarry Smith   ierr = VecDestroy(&fh);CHKERRQ(ierr);
3107da9b6338SBarry Smith   PetscFunctionReturn(0);
3108da9b6338SBarry Smith }
310971f87433Sdalcinl 
311071f87433Sdalcinl #undef __FUNCT__
3111fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetUseEW"
311271f87433Sdalcinl /*@
3113fa9f3622SBarry Smith    SNESKSPSetUseEW - Sets SNES use Eisenstat-Walker method for
311471f87433Sdalcinl    computing relative tolerance for linear solvers within an inexact
311571f87433Sdalcinl    Newton method.
311671f87433Sdalcinl 
31173f9fe445SBarry Smith    Logically Collective on SNES
311871f87433Sdalcinl 
311971f87433Sdalcinl    Input Parameters:
312071f87433Sdalcinl +  snes - SNES context
312171f87433Sdalcinl -  flag - PETSC_TRUE or PETSC_FALSE
312271f87433Sdalcinl 
312364ba62caSBarry Smith     Options Database:
312464ba62caSBarry Smith +  -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence
312564ba62caSBarry Smith .  -snes_ksp_ew_version ver - version of  Eisenstat-Walker method
312664ba62caSBarry Smith .  -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0
312764ba62caSBarry Smith .  -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax
312864ba62caSBarry Smith .  -snes_ksp_ew_gamma <gamma> - Sets gamma
312964ba62caSBarry Smith .  -snes_ksp_ew_alpha <alpha> - Sets alpha
313064ba62caSBarry Smith .  -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2
313164ba62caSBarry Smith -  -snes_ksp_ew_threshold <threshold> - Sets threshold
313264ba62caSBarry Smith 
313371f87433Sdalcinl    Notes:
313471f87433Sdalcinl    Currently, the default is to use a constant relative tolerance for
313571f87433Sdalcinl    the inner linear solvers.  Alternatively, one can use the
313671f87433Sdalcinl    Eisenstat-Walker method, where the relative convergence tolerance
313771f87433Sdalcinl    is reset at each Newton iteration according progress of the nonlinear
313871f87433Sdalcinl    solver.
313971f87433Sdalcinl 
314071f87433Sdalcinl    Level: advanced
314171f87433Sdalcinl 
314271f87433Sdalcinl    Reference:
314371f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
314471f87433Sdalcinl    inexact Newton method", SISC 17 (1), pp.16-32, 1996.
314571f87433Sdalcinl 
314671f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton
314771f87433Sdalcinl 
3148fa9f3622SBarry Smith .seealso: SNESKSPGetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW()
314971f87433Sdalcinl @*/
31507087cfbeSBarry Smith PetscErrorCode  SNESKSPSetUseEW(SNES snes,PetscBool  flag)
315171f87433Sdalcinl {
315271f87433Sdalcinl   PetscFunctionBegin;
31530700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3154acfcf0e5SJed Brown   PetscValidLogicalCollectiveBool(snes,flag,2);
315571f87433Sdalcinl   snes->ksp_ewconv = flag;
315671f87433Sdalcinl   PetscFunctionReturn(0);
315771f87433Sdalcinl }
315871f87433Sdalcinl 
315971f87433Sdalcinl #undef __FUNCT__
3160fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetUseEW"
316171f87433Sdalcinl /*@
3162fa9f3622SBarry Smith    SNESKSPGetUseEW - Gets if SNES is using Eisenstat-Walker method
316371f87433Sdalcinl    for computing relative tolerance for linear solvers within an
316471f87433Sdalcinl    inexact Newton method.
316571f87433Sdalcinl 
316671f87433Sdalcinl    Not Collective
316771f87433Sdalcinl 
316871f87433Sdalcinl    Input Parameter:
316971f87433Sdalcinl .  snes - SNES context
317071f87433Sdalcinl 
317171f87433Sdalcinl    Output Parameter:
317271f87433Sdalcinl .  flag - PETSC_TRUE or PETSC_FALSE
317371f87433Sdalcinl 
317471f87433Sdalcinl    Notes:
317571f87433Sdalcinl    Currently, the default is to use a constant relative tolerance for
317671f87433Sdalcinl    the inner linear solvers.  Alternatively, one can use the
317771f87433Sdalcinl    Eisenstat-Walker method, where the relative convergence tolerance
317871f87433Sdalcinl    is reset at each Newton iteration according progress of the nonlinear
317971f87433Sdalcinl    solver.
318071f87433Sdalcinl 
318171f87433Sdalcinl    Level: advanced
318271f87433Sdalcinl 
318371f87433Sdalcinl    Reference:
318471f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
318571f87433Sdalcinl    inexact Newton method", SISC 17 (1), pp.16-32, 1996.
318671f87433Sdalcinl 
318771f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton
318871f87433Sdalcinl 
3189fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW()
319071f87433Sdalcinl @*/
31917087cfbeSBarry Smith PetscErrorCode  SNESKSPGetUseEW(SNES snes, PetscBool  *flag)
319271f87433Sdalcinl {
319371f87433Sdalcinl   PetscFunctionBegin;
31940700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
319571f87433Sdalcinl   PetscValidPointer(flag,2);
319671f87433Sdalcinl   *flag = snes->ksp_ewconv;
319771f87433Sdalcinl   PetscFunctionReturn(0);
319871f87433Sdalcinl }
319971f87433Sdalcinl 
320071f87433Sdalcinl #undef __FUNCT__
3201fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetParametersEW"
320271f87433Sdalcinl /*@
3203fa9f3622SBarry Smith    SNESKSPSetParametersEW - Sets parameters for Eisenstat-Walker
320471f87433Sdalcinl    convergence criteria for the linear solvers within an inexact
320571f87433Sdalcinl    Newton method.
320671f87433Sdalcinl 
32073f9fe445SBarry Smith    Logically Collective on SNES
320871f87433Sdalcinl 
320971f87433Sdalcinl    Input Parameters:
321071f87433Sdalcinl +    snes - SNES context
321171f87433Sdalcinl .    version - version 1, 2 (default is 2) or 3
321271f87433Sdalcinl .    rtol_0 - initial relative tolerance (0 <= rtol_0 < 1)
321371f87433Sdalcinl .    rtol_max - maximum relative tolerance (0 <= rtol_max < 1)
321471f87433Sdalcinl .    gamma - multiplicative factor for version 2 rtol computation
321571f87433Sdalcinl              (0 <= gamma2 <= 1)
321671f87433Sdalcinl .    alpha - power for version 2 rtol computation (1 < alpha <= 2)
321771f87433Sdalcinl .    alpha2 - power for safeguard
321871f87433Sdalcinl -    threshold - threshold for imposing safeguard (0 < threshold < 1)
321971f87433Sdalcinl 
322071f87433Sdalcinl    Note:
322171f87433Sdalcinl    Version 3 was contributed by Luis Chacon, June 2006.
322271f87433Sdalcinl 
322371f87433Sdalcinl    Use PETSC_DEFAULT to retain the default for any of the parameters.
322471f87433Sdalcinl 
322571f87433Sdalcinl    Level: advanced
322671f87433Sdalcinl 
322771f87433Sdalcinl    Reference:
322871f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
322971f87433Sdalcinl    inexact Newton method", Utah State University Math. Stat. Dept. Res.
323071f87433Sdalcinl    Report 6/94/75, June, 1994, to appear in SIAM J. Sci. Comput.
323171f87433Sdalcinl 
323271f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, set, parameters
323371f87433Sdalcinl 
3234fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPGetParametersEW()
323571f87433Sdalcinl @*/
32367087cfbeSBarry Smith PetscErrorCode  SNESKSPSetParametersEW(SNES snes,PetscInt version,PetscReal rtol_0,PetscReal rtol_max,
323771f87433Sdalcinl 							    PetscReal gamma,PetscReal alpha,PetscReal alpha2,PetscReal threshold)
323871f87433Sdalcinl {
3239fa9f3622SBarry Smith   SNESKSPEW *kctx;
324071f87433Sdalcinl   PetscFunctionBegin;
32410700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3242fa9f3622SBarry Smith   kctx = (SNESKSPEW*)snes->kspconvctx;
3243e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing");
3244c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,version,2);
3245c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol_0,3);
3246c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol_max,4);
3247c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,gamma,5);
3248c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,alpha,6);
3249c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,alpha2,7);
3250c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,threshold,8);
325171f87433Sdalcinl 
325271f87433Sdalcinl   if (version != PETSC_DEFAULT)   kctx->version   = version;
325371f87433Sdalcinl   if (rtol_0 != PETSC_DEFAULT)    kctx->rtol_0    = rtol_0;
325471f87433Sdalcinl   if (rtol_max != PETSC_DEFAULT)  kctx->rtol_max  = rtol_max;
325571f87433Sdalcinl   if (gamma != PETSC_DEFAULT)     kctx->gamma     = gamma;
325671f87433Sdalcinl   if (alpha != PETSC_DEFAULT)     kctx->alpha     = alpha;
325771f87433Sdalcinl   if (alpha2 != PETSC_DEFAULT)    kctx->alpha2    = alpha2;
325871f87433Sdalcinl   if (threshold != PETSC_DEFAULT) kctx->threshold = threshold;
325971f87433Sdalcinl 
326071f87433Sdalcinl   if (kctx->version < 1 || kctx->version > 3) {
3261e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 and 3 are supported: %D",kctx->version);
326271f87433Sdalcinl   }
326371f87433Sdalcinl   if (kctx->rtol_0 < 0.0 || kctx->rtol_0 >= 1.0) {
3264e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_0 < 1.0: %G",kctx->rtol_0);
326571f87433Sdalcinl   }
326671f87433Sdalcinl   if (kctx->rtol_max < 0.0 || kctx->rtol_max >= 1.0) {
3267e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_max (%G) < 1.0\n",kctx->rtol_max);
326871f87433Sdalcinl   }
326971f87433Sdalcinl   if (kctx->gamma < 0.0 || kctx->gamma > 1.0) {
3270e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= gamma (%G) <= 1.0\n",kctx->gamma);
327171f87433Sdalcinl   }
327271f87433Sdalcinl   if (kctx->alpha <= 1.0 || kctx->alpha > 2.0) {
3273e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"1.0 < alpha (%G) <= 2.0\n",kctx->alpha);
327471f87433Sdalcinl   }
327571f87433Sdalcinl   if (kctx->threshold <= 0.0 || kctx->threshold >= 1.0) {
3276e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 < threshold (%G) < 1.0\n",kctx->threshold);
327771f87433Sdalcinl   }
327871f87433Sdalcinl   PetscFunctionReturn(0);
327971f87433Sdalcinl }
328071f87433Sdalcinl 
328171f87433Sdalcinl #undef __FUNCT__
3282fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetParametersEW"
328371f87433Sdalcinl /*@
3284fa9f3622SBarry Smith    SNESKSPGetParametersEW - Gets parameters for Eisenstat-Walker
328571f87433Sdalcinl    convergence criteria for the linear solvers within an inexact
328671f87433Sdalcinl    Newton method.
328771f87433Sdalcinl 
328871f87433Sdalcinl    Not Collective
328971f87433Sdalcinl 
329071f87433Sdalcinl    Input Parameters:
329171f87433Sdalcinl      snes - SNES context
329271f87433Sdalcinl 
329371f87433Sdalcinl    Output Parameters:
329471f87433Sdalcinl +    version - version 1, 2 (default is 2) or 3
329571f87433Sdalcinl .    rtol_0 - initial relative tolerance (0 <= rtol_0 < 1)
329671f87433Sdalcinl .    rtol_max - maximum relative tolerance (0 <= rtol_max < 1)
329771f87433Sdalcinl .    gamma - multiplicative factor for version 2 rtol computation
329871f87433Sdalcinl              (0 <= gamma2 <= 1)
329971f87433Sdalcinl .    alpha - power for version 2 rtol computation (1 < alpha <= 2)
330071f87433Sdalcinl .    alpha2 - power for safeguard
330171f87433Sdalcinl -    threshold - threshold for imposing safeguard (0 < threshold < 1)
330271f87433Sdalcinl 
330371f87433Sdalcinl    Level: advanced
330471f87433Sdalcinl 
330571f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, get, parameters
330671f87433Sdalcinl 
3307fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPSetParametersEW()
330871f87433Sdalcinl @*/
33097087cfbeSBarry Smith PetscErrorCode  SNESKSPGetParametersEW(SNES snes,PetscInt *version,PetscReal *rtol_0,PetscReal *rtol_max,
331071f87433Sdalcinl 							    PetscReal *gamma,PetscReal *alpha,PetscReal *alpha2,PetscReal *threshold)
331171f87433Sdalcinl {
3312fa9f3622SBarry Smith   SNESKSPEW *kctx;
331371f87433Sdalcinl   PetscFunctionBegin;
33140700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3315fa9f3622SBarry Smith   kctx = (SNESKSPEW*)snes->kspconvctx;
3316e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing");
331771f87433Sdalcinl   if(version)   *version   = kctx->version;
331871f87433Sdalcinl   if(rtol_0)    *rtol_0    = kctx->rtol_0;
331971f87433Sdalcinl   if(rtol_max)  *rtol_max  = kctx->rtol_max;
332071f87433Sdalcinl   if(gamma)     *gamma     = kctx->gamma;
332171f87433Sdalcinl   if(alpha)     *alpha     = kctx->alpha;
332271f87433Sdalcinl   if(alpha2)    *alpha2    = kctx->alpha2;
332371f87433Sdalcinl   if(threshold) *threshold = kctx->threshold;
332471f87433Sdalcinl   PetscFunctionReturn(0);
332571f87433Sdalcinl }
332671f87433Sdalcinl 
332771f87433Sdalcinl #undef __FUNCT__
3328fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PreSolve"
3329fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PreSolve(SNES snes, KSP ksp, Vec b, Vec x)
333071f87433Sdalcinl {
333171f87433Sdalcinl   PetscErrorCode ierr;
3332fa9f3622SBarry Smith   SNESKSPEW      *kctx = (SNESKSPEW*)snes->kspconvctx;
333371f87433Sdalcinl   PetscReal      rtol=PETSC_DEFAULT,stol;
333471f87433Sdalcinl 
333571f87433Sdalcinl   PetscFunctionBegin;
3336e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists");
333771f87433Sdalcinl   if (!snes->iter) { /* first time in, so use the original user rtol */
333871f87433Sdalcinl     rtol = kctx->rtol_0;
333971f87433Sdalcinl   } else {
334071f87433Sdalcinl     if (kctx->version == 1) {
334171f87433Sdalcinl       rtol = (snes->norm - kctx->lresid_last)/kctx->norm_last;
334271f87433Sdalcinl       if (rtol < 0.0) rtol = -rtol;
334371f87433Sdalcinl       stol = pow(kctx->rtol_last,kctx->alpha2);
334471f87433Sdalcinl       if (stol > kctx->threshold) rtol = PetscMax(rtol,stol);
334571f87433Sdalcinl     } else if (kctx->version == 2) {
334671f87433Sdalcinl       rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha);
334771f87433Sdalcinl       stol = kctx->gamma * pow(kctx->rtol_last,kctx->alpha);
334871f87433Sdalcinl       if (stol > kctx->threshold) rtol = PetscMax(rtol,stol);
334971f87433Sdalcinl     } else if (kctx->version == 3) {/* contributed by Luis Chacon, June 2006. */
335071f87433Sdalcinl       rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha);
335171f87433Sdalcinl       /* safeguard: avoid sharp decrease of rtol */
335271f87433Sdalcinl       stol = kctx->gamma*pow(kctx->rtol_last,kctx->alpha);
335371f87433Sdalcinl       stol = PetscMax(rtol,stol);
335471f87433Sdalcinl       rtol = PetscMin(kctx->rtol_0,stol);
335571f87433Sdalcinl       /* safeguard: avoid oversolving */
335671f87433Sdalcinl       stol = kctx->gamma*(snes->ttol)/snes->norm;
335771f87433Sdalcinl       stol = PetscMax(rtol,stol);
335871f87433Sdalcinl       rtol = PetscMin(kctx->rtol_0,stol);
3359e32f2f54SBarry Smith     } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 or 3 are supported: %D",kctx->version);
336071f87433Sdalcinl   }
336171f87433Sdalcinl   /* safeguard: avoid rtol greater than one */
336271f87433Sdalcinl   rtol = PetscMin(rtol,kctx->rtol_max);
336371f87433Sdalcinl   ierr = KSPSetTolerances(ksp,rtol,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT);CHKERRQ(ierr);
336471f87433Sdalcinl   ierr = PetscInfo3(snes,"iter %D, Eisenstat-Walker (version %D) KSP rtol=%G\n",snes->iter,kctx->version,rtol);CHKERRQ(ierr);
336571f87433Sdalcinl   PetscFunctionReturn(0);
336671f87433Sdalcinl }
336771f87433Sdalcinl 
336871f87433Sdalcinl #undef __FUNCT__
3369fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PostSolve"
3370fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PostSolve(SNES snes, KSP ksp, Vec b, Vec x)
337171f87433Sdalcinl {
337271f87433Sdalcinl   PetscErrorCode ierr;
3373fa9f3622SBarry Smith   SNESKSPEW      *kctx = (SNESKSPEW*)snes->kspconvctx;
337471f87433Sdalcinl   PCSide         pcside;
337571f87433Sdalcinl   Vec            lres;
337671f87433Sdalcinl 
337771f87433Sdalcinl   PetscFunctionBegin;
3378e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists");
337971f87433Sdalcinl   ierr = KSPGetTolerances(ksp,&kctx->rtol_last,0,0,0);CHKERRQ(ierr);
338071f87433Sdalcinl   ierr = SNESGetFunctionNorm(snes,&kctx->norm_last);CHKERRQ(ierr);
338171f87433Sdalcinl   if (kctx->version == 1) {
3382b037da10SBarry Smith     ierr = KSPGetPCSide(ksp,&pcside);CHKERRQ(ierr);
338371f87433Sdalcinl     if (pcside == PC_RIGHT) { /* XXX Should we also test KSP_UNPRECONDITIONED_NORM ? */
338471f87433Sdalcinl       /* KSP residual is true linear residual */
338571f87433Sdalcinl       ierr = KSPGetResidualNorm(ksp,&kctx->lresid_last);CHKERRQ(ierr);
338671f87433Sdalcinl     } else {
338771f87433Sdalcinl       /* KSP residual is preconditioned residual */
338871f87433Sdalcinl       /* compute true linear residual norm */
338971f87433Sdalcinl       ierr = VecDuplicate(b,&lres);CHKERRQ(ierr);
339071f87433Sdalcinl       ierr = MatMult(snes->jacobian,x,lres);CHKERRQ(ierr);
339171f87433Sdalcinl       ierr = VecAYPX(lres,-1.0,b);CHKERRQ(ierr);
339271f87433Sdalcinl       ierr = VecNorm(lres,NORM_2,&kctx->lresid_last);CHKERRQ(ierr);
33936bf464f9SBarry Smith       ierr = VecDestroy(&lres);CHKERRQ(ierr);
339471f87433Sdalcinl     }
339571f87433Sdalcinl   }
339671f87433Sdalcinl   PetscFunctionReturn(0);
339771f87433Sdalcinl }
339871f87433Sdalcinl 
339971f87433Sdalcinl #undef __FUNCT__
340071f87433Sdalcinl #define __FUNCT__ "SNES_KSPSolve"
340171f87433Sdalcinl PetscErrorCode SNES_KSPSolve(SNES snes, KSP ksp, Vec b, Vec x)
340271f87433Sdalcinl {
340371f87433Sdalcinl   PetscErrorCode ierr;
340471f87433Sdalcinl 
340571f87433Sdalcinl   PetscFunctionBegin;
3406fa9f3622SBarry Smith   if (snes->ksp_ewconv) { ierr = SNESKSPEW_PreSolve(snes,ksp,b,x);CHKERRQ(ierr);  }
340771f87433Sdalcinl   ierr = KSPSolve(ksp,b,x);CHKERRQ(ierr);
3408fa9f3622SBarry Smith   if (snes->ksp_ewconv) { ierr = SNESKSPEW_PostSolve(snes,ksp,b,x);CHKERRQ(ierr); }
340971f87433Sdalcinl   PetscFunctionReturn(0);
341071f87433Sdalcinl }
34116c699258SBarry Smith 
34126c699258SBarry Smith #undef __FUNCT__
34136c699258SBarry Smith #define __FUNCT__ "SNESSetDM"
34146c699258SBarry Smith /*@
34156c699258SBarry Smith    SNESSetDM - Sets the DM that may be used by some preconditioners
34166c699258SBarry Smith 
34173f9fe445SBarry Smith    Logically Collective on SNES
34186c699258SBarry Smith 
34196c699258SBarry Smith    Input Parameters:
34206c699258SBarry Smith +  snes - the preconditioner context
34216c699258SBarry Smith -  dm - the dm
34226c699258SBarry Smith 
34236c699258SBarry Smith    Level: intermediate
34246c699258SBarry Smith 
34256c699258SBarry Smith 
34266c699258SBarry Smith .seealso: SNESGetDM(), KSPSetDM(), KSPGetDM()
34276c699258SBarry Smith @*/
34287087cfbeSBarry Smith PetscErrorCode  SNESSetDM(SNES snes,DM dm)
34296c699258SBarry Smith {
34306c699258SBarry Smith   PetscErrorCode ierr;
3431345fed2cSBarry Smith   KSP            ksp;
34326c699258SBarry Smith 
34336c699258SBarry Smith   PetscFunctionBegin;
34340700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3435d0660788SBarry Smith   if (dm) {ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);}
34366bf464f9SBarry Smith   ierr = DMDestroy(&snes->dm);CHKERRQ(ierr);
34376c699258SBarry Smith   snes->dm = dm;
3438345fed2cSBarry Smith   ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
3439345fed2cSBarry Smith   ierr = KSPSetDM(ksp,dm);CHKERRQ(ierr);
3440f22f69f0SBarry Smith   ierr = KSPSetDMActive(ksp,PETSC_FALSE);CHKERRQ(ierr);
34412c155ee1SBarry Smith   if (snes->pc) {
34422c155ee1SBarry Smith     ierr = SNESSetDM(snes->pc, snes->dm);CHKERRQ(ierr);
34432c155ee1SBarry Smith   }
34446c699258SBarry Smith   PetscFunctionReturn(0);
34456c699258SBarry Smith }
34466c699258SBarry Smith 
34476c699258SBarry Smith #undef __FUNCT__
34486c699258SBarry Smith #define __FUNCT__ "SNESGetDM"
34496c699258SBarry Smith /*@
34506c699258SBarry Smith    SNESGetDM - Gets the DM that may be used by some preconditioners
34516c699258SBarry Smith 
34523f9fe445SBarry Smith    Not Collective but DM obtained is parallel on SNES
34536c699258SBarry Smith 
34546c699258SBarry Smith    Input Parameter:
34556c699258SBarry Smith . snes - the preconditioner context
34566c699258SBarry Smith 
34576c699258SBarry Smith    Output Parameter:
34586c699258SBarry Smith .  dm - the dm
34596c699258SBarry Smith 
34606c699258SBarry Smith    Level: intermediate
34616c699258SBarry Smith 
34626c699258SBarry Smith 
34636c699258SBarry Smith .seealso: SNESSetDM(), KSPSetDM(), KSPGetDM()
34646c699258SBarry Smith @*/
34657087cfbeSBarry Smith PetscErrorCode  SNESGetDM(SNES snes,DM *dm)
34666c699258SBarry Smith {
34676c699258SBarry Smith   PetscFunctionBegin;
34680700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
34696c699258SBarry Smith   *dm = snes->dm;
34706c699258SBarry Smith   PetscFunctionReturn(0);
34716c699258SBarry Smith }
34720807856dSBarry Smith 
347331823bd8SMatthew G Knepley #undef __FUNCT__
347431823bd8SMatthew G Knepley #define __FUNCT__ "SNESSetPC"
347531823bd8SMatthew G Knepley /*@
3476fd4b34e9SJed Brown   SNESSetPC - Sets the nonlinear preconditioner to be used.
347731823bd8SMatthew G Knepley 
347831823bd8SMatthew G Knepley   Collective on SNES
347931823bd8SMatthew G Knepley 
348031823bd8SMatthew G Knepley   Input Parameters:
348131823bd8SMatthew G Knepley + snes - iterative context obtained from SNESCreate()
348231823bd8SMatthew G Knepley - pc   - the preconditioner object
348331823bd8SMatthew G Knepley 
348431823bd8SMatthew G Knepley   Notes:
348531823bd8SMatthew G Knepley   Use SNESGetPC() to retrieve the preconditioner context (for example,
348631823bd8SMatthew G Knepley   to configure it using the API).
348731823bd8SMatthew G Knepley 
348831823bd8SMatthew G Knepley   Level: developer
348931823bd8SMatthew G Knepley 
349031823bd8SMatthew G Knepley .keywords: SNES, set, precondition
349131823bd8SMatthew G Knepley .seealso: SNESGetPC()
349231823bd8SMatthew G Knepley @*/
349331823bd8SMatthew G Knepley PetscErrorCode SNESSetPC(SNES snes, SNES pc)
349431823bd8SMatthew G Knepley {
349531823bd8SMatthew G Knepley   PetscErrorCode ierr;
349631823bd8SMatthew G Knepley 
349731823bd8SMatthew G Knepley   PetscFunctionBegin;
349831823bd8SMatthew G Knepley   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
349931823bd8SMatthew G Knepley   PetscValidHeaderSpecific(pc, SNES_CLASSID, 2);
350031823bd8SMatthew G Knepley   PetscCheckSameComm(snes, 1, pc, 2);
350131823bd8SMatthew G Knepley   ierr = PetscObjectReference((PetscObject) pc);CHKERRQ(ierr);
3502bf11d3b6SBarry Smith   ierr = SNESDestroy(&snes->pc);CHKERRQ(ierr);
350331823bd8SMatthew G Knepley   snes->pc = pc;
350431823bd8SMatthew G Knepley   ierr = PetscLogObjectParent(snes, snes->pc);CHKERRQ(ierr);
350531823bd8SMatthew G Knepley   PetscFunctionReturn(0);
350631823bd8SMatthew G Knepley }
350731823bd8SMatthew G Knepley 
350831823bd8SMatthew G Knepley #undef __FUNCT__
350931823bd8SMatthew G Knepley #define __FUNCT__ "SNESGetPC"
351031823bd8SMatthew G Knepley /*@
3511fd4b34e9SJed Brown   SNESGetPC - Returns a pointer to the nonlinear preconditioning context set with SNESSetPC().
351231823bd8SMatthew G Knepley 
351331823bd8SMatthew G Knepley   Not Collective
351431823bd8SMatthew G Knepley 
351531823bd8SMatthew G Knepley   Input Parameter:
351631823bd8SMatthew G Knepley . snes - iterative context obtained from SNESCreate()
351731823bd8SMatthew G Knepley 
351831823bd8SMatthew G Knepley   Output Parameter:
351931823bd8SMatthew G Knepley . pc - preconditioner context
352031823bd8SMatthew G Knepley 
352131823bd8SMatthew G Knepley   Level: developer
352231823bd8SMatthew G Knepley 
352331823bd8SMatthew G Knepley .keywords: SNES, get, preconditioner
352431823bd8SMatthew G Knepley .seealso: SNESSetPC()
352531823bd8SMatthew G Knepley @*/
352631823bd8SMatthew G Knepley PetscErrorCode SNESGetPC(SNES snes, SNES *pc)
352731823bd8SMatthew G Knepley {
352831823bd8SMatthew G Knepley   PetscErrorCode ierr;
352931823bd8SMatthew G Knepley 
353031823bd8SMatthew G Knepley   PetscFunctionBegin;
353131823bd8SMatthew G Knepley   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
353231823bd8SMatthew G Knepley   PetscValidPointer(pc, 2);
353331823bd8SMatthew G Knepley   if (!snes->pc) {
353431823bd8SMatthew G Knepley     ierr = SNESCreate(((PetscObject) snes)->comm, &snes->pc);CHKERRQ(ierr);
35354a0c5b0cSMatthew G Knepley     ierr = PetscObjectIncrementTabLevel((PetscObject) snes->pc, (PetscObject) snes, 1);CHKERRQ(ierr);
353631823bd8SMatthew G Knepley     ierr = PetscLogObjectParent(snes, snes->pc);CHKERRQ(ierr);
353731823bd8SMatthew G Knepley   }
353831823bd8SMatthew G Knepley   *pc = snes->pc;
353931823bd8SMatthew G Knepley   PetscFunctionReturn(0);
354031823bd8SMatthew G Knepley }
354131823bd8SMatthew G Knepley 
354269b4f73cSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
3543c6db04a5SJed Brown #include <mex.h>
354469b4f73cSBarry Smith 
35458f6e6473SBarry Smith typedef struct {char *funcname; mxArray *ctx;} SNESMatlabContext;
35468f6e6473SBarry Smith 
35470807856dSBarry Smith #undef __FUNCT__
35480807856dSBarry Smith #define __FUNCT__ "SNESComputeFunction_Matlab"
35490807856dSBarry Smith /*
35500807856dSBarry Smith    SNESComputeFunction_Matlab - Calls the function that has been set with
35510807856dSBarry Smith                          SNESSetFunctionMatlab().
35520807856dSBarry Smith 
35530807856dSBarry Smith    Collective on SNES
35540807856dSBarry Smith 
35550807856dSBarry Smith    Input Parameters:
35560807856dSBarry Smith +  snes - the SNES context
35570807856dSBarry Smith -  x - input vector
35580807856dSBarry Smith 
35590807856dSBarry Smith    Output Parameter:
35600807856dSBarry Smith .  y - function vector, as set by SNESSetFunction()
35610807856dSBarry Smith 
35620807856dSBarry Smith    Notes:
35630807856dSBarry Smith    SNESComputeFunction() is typically used within nonlinear solvers
35640807856dSBarry Smith    implementations, so most users would not generally call this routine
35650807856dSBarry Smith    themselves.
35660807856dSBarry Smith 
35670807856dSBarry Smith    Level: developer
35680807856dSBarry Smith 
35690807856dSBarry Smith .keywords: SNES, nonlinear, compute, function
35700807856dSBarry Smith 
35710807856dSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction()
357261b2408cSBarry Smith */
35737087cfbeSBarry Smith PetscErrorCode  SNESComputeFunction_Matlab(SNES snes,Vec x,Vec y, void *ctx)
35740807856dSBarry Smith {
3575e650e774SBarry Smith   PetscErrorCode    ierr;
35768f6e6473SBarry Smith   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
35778f6e6473SBarry Smith   int               nlhs = 1,nrhs = 5;
35788f6e6473SBarry Smith   mxArray	    *plhs[1],*prhs[5];
357991621f2eSBarry Smith   long long int     lx = 0,ly = 0,ls = 0;
3580e650e774SBarry Smith 
35810807856dSBarry Smith   PetscFunctionBegin;
35820807856dSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
35830807856dSBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
35840807856dSBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
35850807856dSBarry Smith   PetscCheckSameComm(snes,1,x,2);
35860807856dSBarry Smith   PetscCheckSameComm(snes,1,y,3);
35870807856dSBarry Smith 
35880807856dSBarry Smith   /* call Matlab function in ctx with arguments x and y */
3589e650e774SBarry Smith 
359091621f2eSBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
3591e650e774SBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
3592e650e774SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(x));CHKERRQ(ierr);
359391621f2eSBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
359491621f2eSBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)lx);
359591621f2eSBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)ly);
35968f6e6473SBarry Smith   prhs[3] =  mxCreateString(sctx->funcname);
35978f6e6473SBarry Smith   prhs[4] =  sctx->ctx;
3598b807a863SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeFunctionInternal");CHKERRQ(ierr);
3599e650e774SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
3600e650e774SBarry Smith   mxDestroyArray(prhs[0]);
3601e650e774SBarry Smith   mxDestroyArray(prhs[1]);
3602e650e774SBarry Smith   mxDestroyArray(prhs[2]);
36038f6e6473SBarry Smith   mxDestroyArray(prhs[3]);
3604e650e774SBarry Smith   mxDestroyArray(plhs[0]);
36050807856dSBarry Smith   PetscFunctionReturn(0);
36060807856dSBarry Smith }
36070807856dSBarry Smith 
36080807856dSBarry Smith 
36090807856dSBarry Smith #undef __FUNCT__
36100807856dSBarry Smith #define __FUNCT__ "SNESSetFunctionMatlab"
361161b2408cSBarry Smith /*
36120807856dSBarry Smith    SNESSetFunctionMatlab - Sets the function evaluation routine and function
36130807856dSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
3614e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
36150807856dSBarry Smith 
36160807856dSBarry Smith    Logically Collective on SNES
36170807856dSBarry Smith 
36180807856dSBarry Smith    Input Parameters:
36190807856dSBarry Smith +  snes - the SNES context
36200807856dSBarry Smith .  r - vector to store function value
36210807856dSBarry Smith -  func - function evaluation routine
36220807856dSBarry Smith 
36230807856dSBarry Smith    Calling sequence of func:
362461b2408cSBarry Smith $    func (SNES snes,Vec x,Vec f,void *ctx);
36250807856dSBarry Smith 
36260807856dSBarry Smith 
36270807856dSBarry Smith    Notes:
36280807856dSBarry Smith    The Newton-like methods typically solve linear systems of the form
36290807856dSBarry Smith $      f'(x) x = -f(x),
36300807856dSBarry Smith    where f'(x) denotes the Jacobian matrix and f(x) is the function.
36310807856dSBarry Smith 
36320807856dSBarry Smith    Level: beginner
36330807856dSBarry Smith 
36340807856dSBarry Smith .keywords: SNES, nonlinear, set, function
36350807856dSBarry Smith 
36360807856dSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
363761b2408cSBarry Smith */
36387087cfbeSBarry Smith PetscErrorCode  SNESSetFunctionMatlab(SNES snes,Vec r,const char *func,mxArray *ctx)
36390807856dSBarry Smith {
36400807856dSBarry Smith   PetscErrorCode    ierr;
36418f6e6473SBarry Smith   SNESMatlabContext *sctx;
36420807856dSBarry Smith 
36430807856dSBarry Smith   PetscFunctionBegin;
36448f6e6473SBarry Smith   /* currently sctx is memory bleed */
36458f6e6473SBarry Smith   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
36468f6e6473SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
36478f6e6473SBarry Smith   /*
36488f6e6473SBarry Smith      This should work, but it doesn't
36498f6e6473SBarry Smith   sctx->ctx = ctx;
36508f6e6473SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
36518f6e6473SBarry Smith   */
36528f6e6473SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
36538f6e6473SBarry Smith   ierr = SNESSetFunction(snes,r,SNESComputeFunction_Matlab,sctx);CHKERRQ(ierr);
36540807856dSBarry Smith   PetscFunctionReturn(0);
36550807856dSBarry Smith }
365669b4f73cSBarry Smith 
365761b2408cSBarry Smith #undef __FUNCT__
365861b2408cSBarry Smith #define __FUNCT__ "SNESComputeJacobian_Matlab"
365961b2408cSBarry Smith /*
366061b2408cSBarry Smith    SNESComputeJacobian_Matlab - Calls the function that has been set with
366161b2408cSBarry Smith                          SNESSetJacobianMatlab().
366261b2408cSBarry Smith 
366361b2408cSBarry Smith    Collective on SNES
366461b2408cSBarry Smith 
366561b2408cSBarry Smith    Input Parameters:
366661b2408cSBarry Smith +  snes - the SNES context
366761b2408cSBarry Smith .  x - input vector
366861b2408cSBarry Smith .  A, B - the matrices
366961b2408cSBarry Smith -  ctx - user context
367061b2408cSBarry Smith 
367161b2408cSBarry Smith    Output Parameter:
367261b2408cSBarry Smith .  flag - structure of the matrix
367361b2408cSBarry Smith 
367461b2408cSBarry Smith    Level: developer
367561b2408cSBarry Smith 
367661b2408cSBarry Smith .keywords: SNES, nonlinear, compute, function
367761b2408cSBarry Smith 
367861b2408cSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction()
367961b2408cSBarry Smith @*/
36807087cfbeSBarry Smith PetscErrorCode  SNESComputeJacobian_Matlab(SNES snes,Vec x,Mat *A,Mat *B,MatStructure *flag, void *ctx)
368161b2408cSBarry Smith {
368261b2408cSBarry Smith   PetscErrorCode    ierr;
368361b2408cSBarry Smith   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
368461b2408cSBarry Smith   int               nlhs = 2,nrhs = 6;
368561b2408cSBarry Smith   mxArray	    *plhs[2],*prhs[6];
368661b2408cSBarry Smith   long long int     lx = 0,lA = 0,ls = 0, lB = 0;
368761b2408cSBarry Smith 
368861b2408cSBarry Smith   PetscFunctionBegin;
368961b2408cSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
369061b2408cSBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
369161b2408cSBarry Smith 
369261b2408cSBarry Smith   /* call Matlab function in ctx with arguments x and y */
369361b2408cSBarry Smith 
369461b2408cSBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
369561b2408cSBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
369661b2408cSBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(x));CHKERRQ(ierr);
369761b2408cSBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(x));CHKERRQ(ierr);
369861b2408cSBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
369961b2408cSBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)lx);
370061b2408cSBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lA);
370161b2408cSBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lB);
370261b2408cSBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
370361b2408cSBarry Smith   prhs[5] =  sctx->ctx;
3704b807a863SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeJacobianInternal");CHKERRQ(ierr);
370561b2408cSBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
370661b2408cSBarry Smith   *flag   =  (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr);
370761b2408cSBarry Smith   mxDestroyArray(prhs[0]);
370861b2408cSBarry Smith   mxDestroyArray(prhs[1]);
370961b2408cSBarry Smith   mxDestroyArray(prhs[2]);
371061b2408cSBarry Smith   mxDestroyArray(prhs[3]);
371161b2408cSBarry Smith   mxDestroyArray(prhs[4]);
371261b2408cSBarry Smith   mxDestroyArray(plhs[0]);
371361b2408cSBarry Smith   mxDestroyArray(plhs[1]);
371461b2408cSBarry Smith   PetscFunctionReturn(0);
371561b2408cSBarry Smith }
371661b2408cSBarry Smith 
371761b2408cSBarry Smith 
371861b2408cSBarry Smith #undef __FUNCT__
371961b2408cSBarry Smith #define __FUNCT__ "SNESSetJacobianMatlab"
372061b2408cSBarry Smith /*
372161b2408cSBarry Smith    SNESSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
372261b2408cSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
3723e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
372461b2408cSBarry Smith 
372561b2408cSBarry Smith    Logically Collective on SNES
372661b2408cSBarry Smith 
372761b2408cSBarry Smith    Input Parameters:
372861b2408cSBarry Smith +  snes - the SNES context
372961b2408cSBarry Smith .  A,B - Jacobian matrices
373061b2408cSBarry Smith .  func - function evaluation routine
373161b2408cSBarry Smith -  ctx - user context
373261b2408cSBarry Smith 
373361b2408cSBarry Smith    Calling sequence of func:
373461b2408cSBarry Smith $    flag = func (SNES snes,Vec x,Mat A,Mat B,void *ctx);
373561b2408cSBarry Smith 
373661b2408cSBarry Smith 
373761b2408cSBarry Smith    Level: developer
373861b2408cSBarry Smith 
373961b2408cSBarry Smith .keywords: SNES, nonlinear, set, function
374061b2408cSBarry Smith 
374161b2408cSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
374261b2408cSBarry Smith */
37437087cfbeSBarry Smith PetscErrorCode  SNESSetJacobianMatlab(SNES snes,Mat A,Mat B,const char *func,mxArray *ctx)
374461b2408cSBarry Smith {
374561b2408cSBarry Smith   PetscErrorCode    ierr;
374661b2408cSBarry Smith   SNESMatlabContext *sctx;
374761b2408cSBarry Smith 
374861b2408cSBarry Smith   PetscFunctionBegin;
374961b2408cSBarry Smith   /* currently sctx is memory bleed */
375061b2408cSBarry Smith   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
375161b2408cSBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
375261b2408cSBarry Smith   /*
375361b2408cSBarry Smith      This should work, but it doesn't
375461b2408cSBarry Smith   sctx->ctx = ctx;
375561b2408cSBarry Smith   mexMakeArrayPersistent(sctx->ctx);
375661b2408cSBarry Smith   */
375761b2408cSBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
375861b2408cSBarry Smith   ierr = SNESSetJacobian(snes,A,B,SNESComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
375961b2408cSBarry Smith   PetscFunctionReturn(0);
376061b2408cSBarry Smith }
376169b4f73cSBarry Smith 
3762f9eb7ae2SShri Abhyankar #undef __FUNCT__
3763f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitor_Matlab"
3764f9eb7ae2SShri Abhyankar /*
3765f9eb7ae2SShri Abhyankar    SNESMonitor_Matlab - Calls the function that has been set with SNESMonitorSetMatlab().
3766f9eb7ae2SShri Abhyankar 
3767f9eb7ae2SShri Abhyankar    Collective on SNES
3768f9eb7ae2SShri Abhyankar 
3769f9eb7ae2SShri Abhyankar .seealso: SNESSetFunction(), SNESGetFunction()
3770f9eb7ae2SShri Abhyankar @*/
37717087cfbeSBarry Smith PetscErrorCode  SNESMonitor_Matlab(SNES snes,PetscInt it, PetscReal fnorm, void *ctx)
3772f9eb7ae2SShri Abhyankar {
3773f9eb7ae2SShri Abhyankar   PetscErrorCode  ierr;
377448f37e70SShri Abhyankar   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
3775f9eb7ae2SShri Abhyankar   int             nlhs = 1,nrhs = 6;
3776f9eb7ae2SShri Abhyankar   mxArray	  *plhs[1],*prhs[6];
3777f9eb7ae2SShri Abhyankar   long long int   lx = 0,ls = 0;
3778f9eb7ae2SShri Abhyankar   Vec             x=snes->vec_sol;
3779f9eb7ae2SShri Abhyankar 
3780f9eb7ae2SShri Abhyankar   PetscFunctionBegin;
3781f9eb7ae2SShri Abhyankar   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3782f9eb7ae2SShri Abhyankar 
3783f9eb7ae2SShri Abhyankar   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
3784f9eb7ae2SShri Abhyankar   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
3785f9eb7ae2SShri Abhyankar   prhs[0] =  mxCreateDoubleScalar((double)ls);
3786f9eb7ae2SShri Abhyankar   prhs[1] =  mxCreateDoubleScalar((double)it);
3787f9eb7ae2SShri Abhyankar   prhs[2] =  mxCreateDoubleScalar((double)fnorm);
3788f9eb7ae2SShri Abhyankar   prhs[3] =  mxCreateDoubleScalar((double)lx);
3789f9eb7ae2SShri Abhyankar   prhs[4] =  mxCreateString(sctx->funcname);
3790f9eb7ae2SShri Abhyankar   prhs[5] =  sctx->ctx;
3791f9eb7ae2SShri Abhyankar   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESMonitorInternal");CHKERRQ(ierr);
3792f9eb7ae2SShri Abhyankar   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
3793f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[0]);
3794f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[1]);
3795f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[2]);
3796f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[3]);
3797f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[4]);
3798f9eb7ae2SShri Abhyankar   mxDestroyArray(plhs[0]);
3799f9eb7ae2SShri Abhyankar   PetscFunctionReturn(0);
3800f9eb7ae2SShri Abhyankar }
3801f9eb7ae2SShri Abhyankar 
3802f9eb7ae2SShri Abhyankar 
3803f9eb7ae2SShri Abhyankar #undef __FUNCT__
3804f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitorSetMatlab"
3805f9eb7ae2SShri Abhyankar /*
3806e3c5b3baSBarry Smith    SNESMonitorSetMatlab - Sets the monitor function from MATLAB
3807f9eb7ae2SShri Abhyankar 
3808f9eb7ae2SShri Abhyankar    Level: developer
3809f9eb7ae2SShri Abhyankar 
3810f9eb7ae2SShri Abhyankar .keywords: SNES, nonlinear, set, function
3811f9eb7ae2SShri Abhyankar 
3812f9eb7ae2SShri Abhyankar .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
3813f9eb7ae2SShri Abhyankar */
38147087cfbeSBarry Smith PetscErrorCode  SNESMonitorSetMatlab(SNES snes,const char *func,mxArray *ctx)
3815f9eb7ae2SShri Abhyankar {
3816f9eb7ae2SShri Abhyankar   PetscErrorCode    ierr;
3817f9eb7ae2SShri Abhyankar   SNESMatlabContext *sctx;
3818f9eb7ae2SShri Abhyankar 
3819f9eb7ae2SShri Abhyankar   PetscFunctionBegin;
3820f9eb7ae2SShri Abhyankar   /* currently sctx is memory bleed */
3821f9eb7ae2SShri Abhyankar   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
3822f9eb7ae2SShri Abhyankar   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
3823f9eb7ae2SShri Abhyankar   /*
3824f9eb7ae2SShri Abhyankar      This should work, but it doesn't
3825f9eb7ae2SShri Abhyankar   sctx->ctx = ctx;
3826f9eb7ae2SShri Abhyankar   mexMakeArrayPersistent(sctx->ctx);
3827f9eb7ae2SShri Abhyankar   */
3828f9eb7ae2SShri Abhyankar   sctx->ctx = mxDuplicateArray(ctx);
3829f9eb7ae2SShri Abhyankar   ierr = SNESMonitorSet(snes,SNESMonitor_Matlab,sctx,PETSC_NULL);CHKERRQ(ierr);
3830f9eb7ae2SShri Abhyankar   PetscFunctionReturn(0);
3831f9eb7ae2SShri Abhyankar }
3832f9eb7ae2SShri Abhyankar 
383369b4f73cSBarry Smith #endif
3834