xref: /petsc/src/snes/interface/snes.c (revision 519f805a543c2a7f195bcba21173bb2cdfadb956)
19b94acceSBarry Smith 
2b45d2f2cSJed Brown #include <petsc-private/snesimpl.h>      /*I "petscsnes.h"  I*/
307475bc1SBarry Smith #include <petscdmshell.h>
49b94acceSBarry Smith 
5ace3abfcSBarry Smith PetscBool         SNESRegisterAllCalled = PETSC_FALSE;
6140e18c1SBarry Smith PetscFunctionList SNESList              = PETSC_NULL;
78ba1e511SMatthew Knepley 
88ba1e511SMatthew Knepley /* Logging support */
922c6f798SBarry Smith PetscClassId  SNES_CLASSID, DMSNES_CLASSID;
10f1c6b773SPeter Brune PetscLogEvent  SNES_Solve, SNES_FunctionEval, SNES_JacobianEval, SNES_GSEval;
11a09944afSBarry Smith 
12a09944afSBarry Smith #undef __FUNCT__
13e113a28aSBarry Smith #define __FUNCT__ "SNESSetErrorIfNotConverged"
14e113a28aSBarry Smith /*@
15e113a28aSBarry Smith    SNESSetErrorIfNotConverged - Causes SNESSolve() to generate an error if the solver has not converged.
16e113a28aSBarry Smith 
173f9fe445SBarry Smith    Logically Collective on SNES
18e113a28aSBarry Smith 
19e113a28aSBarry Smith    Input Parameters:
20e113a28aSBarry Smith +  snes - iterative context obtained from SNESCreate()
21e113a28aSBarry Smith -  flg - PETSC_TRUE indicates you want the error generated
22e113a28aSBarry Smith 
23e113a28aSBarry Smith    Options database keys:
24e113a28aSBarry Smith .  -snes_error_if_not_converged : this takes an optional truth value (0/1/no/yes/true/false)
25e113a28aSBarry Smith 
26e113a28aSBarry Smith    Level: intermediate
27e113a28aSBarry Smith 
28e113a28aSBarry Smith    Notes:
29e113a28aSBarry Smith     Normally PETSc continues if a linear solver fails to converge, you can call SNESGetConvergedReason() after a SNESSolve()
30e113a28aSBarry Smith     to determine if it has converged.
31e113a28aSBarry Smith 
32e113a28aSBarry Smith .keywords: SNES, set, initial guess, nonzero
33e113a28aSBarry Smith 
34e113a28aSBarry Smith .seealso: SNESGetErrorIfNotConverged(), KSPGetErrorIfNotConverged(), KSPSetErrorIFNotConverged()
35e113a28aSBarry Smith @*/
367087cfbeSBarry Smith PetscErrorCode  SNESSetErrorIfNotConverged(SNES snes,PetscBool  flg)
37e113a28aSBarry Smith {
38e113a28aSBarry Smith   PetscFunctionBegin;
39e113a28aSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
40acfcf0e5SJed Brown   PetscValidLogicalCollectiveBool(snes,flg,2);
41e113a28aSBarry Smith   snes->errorifnotconverged = flg;
42e113a28aSBarry Smith   PetscFunctionReturn(0);
43e113a28aSBarry Smith }
44e113a28aSBarry Smith 
45e113a28aSBarry Smith #undef __FUNCT__
46e113a28aSBarry Smith #define __FUNCT__ "SNESGetErrorIfNotConverged"
47e113a28aSBarry Smith /*@
48e113a28aSBarry Smith    SNESGetErrorIfNotConverged - Will SNESSolve() generate an error if the solver does not converge?
49e113a28aSBarry Smith 
50e113a28aSBarry Smith    Not Collective
51e113a28aSBarry Smith 
52e113a28aSBarry Smith    Input Parameter:
53e113a28aSBarry Smith .  snes - iterative context obtained from SNESCreate()
54e113a28aSBarry Smith 
55e113a28aSBarry Smith    Output Parameter:
56e113a28aSBarry Smith .  flag - PETSC_TRUE if it will generate an error, else PETSC_FALSE
57e113a28aSBarry Smith 
58e113a28aSBarry Smith    Level: intermediate
59e113a28aSBarry Smith 
60e113a28aSBarry Smith .keywords: SNES, set, initial guess, nonzero
61e113a28aSBarry Smith 
62e113a28aSBarry Smith .seealso:  SNESSetErrorIfNotConverged(), KSPGetErrorIfNotConverged(), KSPSetErrorIFNotConverged()
63e113a28aSBarry Smith @*/
647087cfbeSBarry Smith PetscErrorCode  SNESGetErrorIfNotConverged(SNES snes,PetscBool  *flag)
65e113a28aSBarry Smith {
66e113a28aSBarry Smith   PetscFunctionBegin;
67e113a28aSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
68e113a28aSBarry Smith   PetscValidPointer(flag,2);
69e113a28aSBarry Smith   *flag = snes->errorifnotconverged;
70e113a28aSBarry Smith   PetscFunctionReturn(0);
71e113a28aSBarry Smith }
72e113a28aSBarry Smith 
73e113a28aSBarry Smith #undef __FUNCT__
744936397dSBarry Smith #define __FUNCT__ "SNESSetFunctionDomainError"
75e725d27bSBarry Smith /*@
76bf388a1fSBarry Smith    SNESSetFunctionDomainError - tells SNES that the input vector to your SNESFunction is not
774936397dSBarry Smith      in the functions domain. For example, negative pressure.
784936397dSBarry Smith 
793f9fe445SBarry Smith    Logically Collective on SNES
804936397dSBarry Smith 
814936397dSBarry Smith    Input Parameters:
826a388c36SPeter Brune .  snes - the SNES context
834936397dSBarry Smith 
8428529972SSatish Balay    Level: advanced
854936397dSBarry Smith 
864936397dSBarry Smith .keywords: SNES, view
874936397dSBarry Smith 
88bf388a1fSBarry Smith .seealso: SNESCreate(), SNESSetFunction(), SNESFunction
894936397dSBarry Smith @*/
907087cfbeSBarry Smith PetscErrorCode  SNESSetFunctionDomainError(SNES snes)
914936397dSBarry Smith {
924936397dSBarry Smith   PetscFunctionBegin;
930700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
944936397dSBarry Smith   snes->domainerror = PETSC_TRUE;
954936397dSBarry Smith   PetscFunctionReturn(0);
964936397dSBarry Smith }
974936397dSBarry Smith 
986a388c36SPeter Brune #undef __FUNCT__
996a388c36SPeter Brune #define __FUNCT__ "SNESGetFunctionDomainError"
1006a388c36SPeter Brune /*@
101c77b2880SPeter Brune    SNESGetFunctionDomainError - Gets the status of the domain error after a call to SNESComputeFunction;
1026a388c36SPeter Brune 
1036a388c36SPeter Brune    Logically Collective on SNES
1046a388c36SPeter Brune 
1056a388c36SPeter Brune    Input Parameters:
1066a388c36SPeter Brune .  snes - the SNES context
1076a388c36SPeter Brune 
1086a388c36SPeter Brune    Output Parameters:
109bf388a1fSBarry Smith .  domainerror - Set to PETSC_TRUE if there's a domain error; PETSC_FALSE otherwise.
1106a388c36SPeter Brune 
1116a388c36SPeter Brune    Level: advanced
1126a388c36SPeter Brune 
1136a388c36SPeter Brune .keywords: SNES, view
1146a388c36SPeter Brune 
115bf388a1fSBarry Smith .seealso: SNESSetFunctionDomainError(), SNESComputeFunction()
1166a388c36SPeter Brune @*/
1176a388c36SPeter Brune PetscErrorCode  SNESGetFunctionDomainError(SNES snes, PetscBool *domainerror)
1186a388c36SPeter Brune {
1196a388c36SPeter Brune   PetscFunctionBegin;
1206a388c36SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1216a388c36SPeter Brune   PetscValidPointer(domainerror, 2);
1226a388c36SPeter Brune   *domainerror = snes->domainerror;
1236a388c36SPeter Brune   PetscFunctionReturn(0);
1246a388c36SPeter Brune }
1256a388c36SPeter Brune 
12655849f57SBarry Smith #undef __FUNCT__
12755849f57SBarry Smith #define __FUNCT__ "SNESLoad"
12855849f57SBarry Smith /*@C
12955849f57SBarry Smith   SNESLoad - Loads a SNES that has been stored in binary  with SNESView().
13055849f57SBarry Smith 
13155849f57SBarry Smith   Collective on PetscViewer
13255849f57SBarry Smith 
13355849f57SBarry Smith   Input Parameters:
13455849f57SBarry Smith + newdm - the newly loaded SNES, this needs to have been created with SNESCreate() or
13555849f57SBarry Smith            some related function before a call to SNESLoad().
13655849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
13755849f57SBarry Smith 
13855849f57SBarry Smith    Level: intermediate
13955849f57SBarry Smith 
14055849f57SBarry Smith   Notes:
14155849f57SBarry Smith    The type is determined by the data in the file, any type set into the SNES before this call is ignored.
14255849f57SBarry Smith 
14355849f57SBarry Smith   Notes for advanced users:
14455849f57SBarry Smith   Most users should not need to know the details of the binary storage
14555849f57SBarry Smith   format, since SNESLoad() and TSView() completely hide these details.
14655849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
14755849f57SBarry Smith   format is
14855849f57SBarry Smith .vb
14955849f57SBarry Smith      has not yet been determined
15055849f57SBarry Smith .ve
15155849f57SBarry Smith 
15255849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), SNESView(), MatLoad(), VecLoad()
15355849f57SBarry Smith @*/
1542d53ad75SBarry Smith PetscErrorCode  SNESLoad(SNES snes, PetscViewer viewer)
15555849f57SBarry Smith {
15655849f57SBarry Smith   PetscErrorCode ierr;
15755849f57SBarry Smith   PetscBool      isbinary;
15855849f57SBarry Smith   PetscInt       classid;
15955849f57SBarry Smith   char           type[256];
16055849f57SBarry Smith   KSP            ksp;
1612d53ad75SBarry Smith   DM             dm;
1622d53ad75SBarry Smith   DMSNES         dmsnes;
16355849f57SBarry Smith 
16455849f57SBarry Smith   PetscFunctionBegin;
1652d53ad75SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
16655849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
16755849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
16855849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
16955849f57SBarry Smith 
17055849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
1712d53ad75SBarry Smith   if (classid != SNES_FILE_CLASSID) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_ARG_WRONG,"Not SNES next in file");
17255849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr);
1732d53ad75SBarry Smith   ierr = SNESSetType(snes, type);CHKERRQ(ierr);
1742d53ad75SBarry Smith   if (snes->ops->load) {
1752d53ad75SBarry Smith     ierr = (*snes->ops->load)(snes,viewer);CHKERRQ(ierr);
176f2c2a1b9SBarry Smith   }
1772d53ad75SBarry Smith   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
1782d53ad75SBarry Smith   ierr = DMGetDMSNES(dm,&dmsnes);CHKERRQ(ierr);
1792d53ad75SBarry Smith   ierr = DMSNESLoad(dmsnes,viewer);CHKERRQ(ierr);
1802d53ad75SBarry Smith   ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
18155849f57SBarry Smith   ierr = KSPLoad(ksp,viewer);CHKERRQ(ierr);
18255849f57SBarry Smith   PetscFunctionReturn(0);
18355849f57SBarry Smith }
1846a388c36SPeter Brune 
1854936397dSBarry Smith #undef __FUNCT__
1864a2ae208SSatish Balay #define __FUNCT__ "SNESView"
1877e2c5f70SBarry Smith /*@C
1889b94acceSBarry Smith    SNESView - Prints the SNES data structure.
1899b94acceSBarry Smith 
1904c49b128SBarry Smith    Collective on SNES
191fee21e36SBarry Smith 
192c7afd0dbSLois Curfman McInnes    Input Parameters:
193c7afd0dbSLois Curfman McInnes +  SNES - the SNES context
194c7afd0dbSLois Curfman McInnes -  viewer - visualization context
195c7afd0dbSLois Curfman McInnes 
1969b94acceSBarry Smith    Options Database Key:
197c8a8ba5cSLois Curfman McInnes .  -snes_view - Calls SNESView() at end of SNESSolve()
1989b94acceSBarry Smith 
1999b94acceSBarry Smith    Notes:
2009b94acceSBarry Smith    The available visualization contexts include
201b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
202b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
203c8a8ba5cSLois Curfman McInnes          output where only the first processor opens
204c8a8ba5cSLois Curfman McInnes          the file.  All other processors send their
205c8a8ba5cSLois Curfman McInnes          data to the first processor to print.
2069b94acceSBarry Smith 
2073e081fefSLois Curfman McInnes    The user can open an alternative visualization context with
208b0a32e0cSBarry Smith    PetscViewerASCIIOpen() - output to a specified file.
2099b94acceSBarry Smith 
21036851e7fSLois Curfman McInnes    Level: beginner
21136851e7fSLois Curfman McInnes 
2129b94acceSBarry Smith .keywords: SNES, view
2139b94acceSBarry Smith 
214b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
2159b94acceSBarry Smith @*/
2167087cfbeSBarry Smith PetscErrorCode  SNESView(SNES snes,PetscViewer viewer)
2179b94acceSBarry Smith {
218fa9f3622SBarry Smith   SNESKSPEW           *kctx;
219dfbe8321SBarry Smith   PetscErrorCode      ierr;
22094b7f48cSBarry Smith   KSP                 ksp;
2217f1410a3SPeter Brune   SNESLineSearch      linesearch;
22272a02f06SBarry Smith   PetscBool           iascii,isstring,isbinary,isdraw;
2232d53ad75SBarry Smith   DMSNES              dmsnes;
2249b94acceSBarry Smith 
2253a40ed3dSBarry Smith   PetscFunctionBegin;
2260700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2273050cee2SBarry Smith   if (!viewer) {
2287adad957SLisandro Dalcin     ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&viewer);CHKERRQ(ierr);
2293050cee2SBarry Smith   }
2300700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
231c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,viewer,2);
23274679c65SBarry Smith 
233251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
234251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
23555849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
23672a02f06SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
23732077d6dSBarry Smith   if (iascii) {
238317d6ea6SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)snes,viewer,"SNES Object");CHKERRQ(ierr);
239e7788613SBarry Smith     if (snes->ops->view) {
240b0a32e0cSBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
241e7788613SBarry Smith       ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr);
242b0a32e0cSBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2430ef38995SBarry Smith     }
24477431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum iterations=%D, maximum function evaluations=%D\n",snes->max_its,snes->max_funcs);CHKERRQ(ierr);
245a83599f4SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  tolerances: relative=%G, absolute=%G, solution=%G\n",
246c60f73f4SPeter Brune                  snes->rtol,snes->abstol,snes->stol);CHKERRQ(ierr);
24777431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",snes->linear_its);CHKERRQ(ierr);
24877431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  total number of function evaluations=%D\n",snes->nfuncs);CHKERRQ(ierr);
24917fe4bdfSPeter Brune     if (snes->gridsequence) {
25017fe4bdfSPeter Brune       ierr = PetscViewerASCIIPrintf(viewer,"  total number of grid sequence refinements=%D\n",snes->gridsequence);CHKERRQ(ierr);
25117fe4bdfSPeter Brune     }
2529b94acceSBarry Smith     if (snes->ksp_ewconv) {
253fa9f3622SBarry Smith       kctx = (SNESKSPEW *)snes->kspconvctx;
2549b94acceSBarry Smith       if (kctx) {
25577431f27SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Eisenstat-Walker computation of KSP relative tolerance (version %D)\n",kctx->version);CHKERRQ(ierr);
256a83599f4SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"    rtol_0=%G, rtol_max=%G, threshold=%G\n",kctx->rtol_0,kctx->rtol_max,kctx->threshold);CHKERRQ(ierr);
257a83599f4SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"    gamma=%G, alpha=%G, alpha2=%G\n",kctx->gamma,kctx->alpha,kctx->alpha2);CHKERRQ(ierr);
2589b94acceSBarry Smith       }
2599b94acceSBarry Smith     }
260eb1f6c34SBarry Smith     if (snes->lagpreconditioner == -1) {
261eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioned is never rebuilt\n");CHKERRQ(ierr);
262eb1f6c34SBarry Smith     } else if (snes->lagpreconditioner > 1) {
263eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioned is rebuilt every %D new Jacobians\n",snes->lagpreconditioner);CHKERRQ(ierr);
264eb1f6c34SBarry Smith     }
265eb1f6c34SBarry Smith     if (snes->lagjacobian == -1) {
266eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Jacobian is never rebuilt\n");CHKERRQ(ierr);
267eb1f6c34SBarry Smith     } else if (snes->lagjacobian > 1) {
26842f4f86dSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Jacobian is rebuilt every %D SNES iterations\n",snes->lagjacobian);CHKERRQ(ierr);
269eb1f6c34SBarry Smith     }
2700f5bd95cSBarry Smith   } else if (isstring) {
271317d6ea6SBarry Smith     const char *type;
272454a90a3SBarry Smith     ierr = SNESGetType(snes,&type);CHKERRQ(ierr);
273b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr);
27455849f57SBarry Smith   } else if (isbinary) {
27555849f57SBarry Smith     PetscInt         classid = SNES_FILE_CLASSID;
27655849f57SBarry Smith     MPI_Comm         comm;
27755849f57SBarry Smith     PetscMPIInt      rank;
27855849f57SBarry Smith     char             type[256];
27955849f57SBarry Smith 
28055849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr);
28155849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
28255849f57SBarry Smith     if (!rank) {
28355849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
28455849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)snes)->type_name,256);CHKERRQ(ierr);
28555849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
28655849f57SBarry Smith     }
28755849f57SBarry Smith     if (snes->ops->view) {
28855849f57SBarry Smith       ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr);
28955849f57SBarry Smith     }
29072a02f06SBarry Smith   } else if (isdraw) {
29172a02f06SBarry Smith     PetscDraw draw;
29272a02f06SBarry Smith     char      str[36];
29389fd9fafSBarry Smith     PetscReal x,y,bottom,h;
29472a02f06SBarry Smith 
29572a02f06SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
29672a02f06SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
29772a02f06SBarry Smith     ierr = PetscStrcpy(str,"SNES: ");CHKERRQ(ierr);
29872a02f06SBarry Smith     ierr = PetscStrcat(str,((PetscObject)snes)->type_name);CHKERRQ(ierr);
29989fd9fafSBarry Smith     ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLUE,PETSC_DRAW_BLACK,str,PETSC_NULL,&h);CHKERRQ(ierr);
30089fd9fafSBarry Smith     bottom = y - h;
30172a02f06SBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
302c4646bacSPeter Brune     if (snes->ops->view) {
303c4646bacSPeter Brune       ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr);
304c4646bacSPeter Brune     }
30572a02f06SBarry Smith   }
30672a02f06SBarry Smith   if (snes->linesearch) {
30772a02f06SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
30872a02f06SBarry Smith     ierr = SNESGetSNESLineSearch(snes, &linesearch);CHKERRQ(ierr);
30972a02f06SBarry Smith     ierr = SNESLineSearchView(linesearch, viewer);CHKERRQ(ierr);
31072a02f06SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
31119bcc07fSBarry Smith   }
31242f4f86dSBarry Smith   if (snes->pc && snes->usespc) {
3134a0c5b0cSMatthew G Knepley     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
3144a0c5b0cSMatthew G Knepley     ierr = SNESView(snes->pc, viewer);CHKERRQ(ierr);
3154a0c5b0cSMatthew G Knepley     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
3164a0c5b0cSMatthew G Knepley   }
3172d53ad75SBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
3182d53ad75SBarry Smith   ierr = DMGetDMSNES(snes->dm,&dmsnes);CHKERRQ(ierr);
3192d53ad75SBarry Smith   ierr = DMSNESView(dmsnes, viewer);CHKERRQ(ierr);
3202d53ad75SBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
3212c155ee1SBarry Smith   if (snes->usesksp) {
3222c155ee1SBarry Smith     ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
323b0a32e0cSBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
32494b7f48cSBarry Smith     ierr = KSPView(ksp,viewer);CHKERRQ(ierr);
325b0a32e0cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
3262c155ee1SBarry Smith   }
32772a02f06SBarry Smith   if (isdraw) {
32872a02f06SBarry Smith     PetscDraw draw;
32972a02f06SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
33072a02f06SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
3317f1410a3SPeter Brune   }
3323a40ed3dSBarry Smith   PetscFunctionReturn(0);
3339b94acceSBarry Smith }
3349b94acceSBarry Smith 
33576b2cf59SMatthew Knepley /*
33676b2cf59SMatthew Knepley   We retain a list of functions that also take SNES command
33776b2cf59SMatthew Knepley   line options. These are called at the end SNESSetFromOptions()
33876b2cf59SMatthew Knepley */
33976b2cf59SMatthew Knepley #define MAXSETFROMOPTIONS 5
340a7cc72afSBarry Smith static PetscInt numberofsetfromoptions;
3416849ba73SBarry Smith static PetscErrorCode (*othersetfromoptions[MAXSETFROMOPTIONS])(SNES);
34276b2cf59SMatthew Knepley 
343e74ef692SMatthew Knepley #undef __FUNCT__
344e74ef692SMatthew Knepley #define __FUNCT__ "SNESAddOptionsChecker"
345ac226902SBarry Smith /*@C
34676b2cf59SMatthew Knepley   SNESAddOptionsChecker - Adds an additional function to check for SNES options.
34776b2cf59SMatthew Knepley 
34876b2cf59SMatthew Knepley   Not Collective
34976b2cf59SMatthew Knepley 
35076b2cf59SMatthew Knepley   Input Parameter:
35176b2cf59SMatthew Knepley . snescheck - function that checks for options
35276b2cf59SMatthew Knepley 
35376b2cf59SMatthew Knepley   Level: developer
35476b2cf59SMatthew Knepley 
35576b2cf59SMatthew Knepley .seealso: SNESSetFromOptions()
35676b2cf59SMatthew Knepley @*/
3577087cfbeSBarry Smith PetscErrorCode  SNESAddOptionsChecker(PetscErrorCode (*snescheck)(SNES))
35876b2cf59SMatthew Knepley {
35976b2cf59SMatthew Knepley   PetscFunctionBegin;
36076b2cf59SMatthew Knepley   if (numberofsetfromoptions >= MAXSETFROMOPTIONS) {
361e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "Too many options checkers, only %D allowed", MAXSETFROMOPTIONS);
36276b2cf59SMatthew Knepley   }
36376b2cf59SMatthew Knepley   othersetfromoptions[numberofsetfromoptions++] = snescheck;
36476b2cf59SMatthew Knepley   PetscFunctionReturn(0);
36576b2cf59SMatthew Knepley }
36676b2cf59SMatthew Knepley 
3677087cfbeSBarry Smith extern PetscErrorCode  SNESDefaultMatrixFreeCreate2(SNES,Vec,Mat*);
368aa3661deSLisandro Dalcin 
369aa3661deSLisandro Dalcin #undef __FUNCT__
370aa3661deSLisandro Dalcin #define __FUNCT__ "SNESSetUpMatrixFree_Private"
371ace3abfcSBarry Smith static PetscErrorCode SNESSetUpMatrixFree_Private(SNES snes, PetscBool  hasOperator, PetscInt version)
372aa3661deSLisandro Dalcin {
373aa3661deSLisandro Dalcin   Mat            J;
374aa3661deSLisandro Dalcin   KSP            ksp;
375aa3661deSLisandro Dalcin   PC             pc;
376ace3abfcSBarry Smith   PetscBool      match;
377aa3661deSLisandro Dalcin   PetscErrorCode ierr;
378aa3661deSLisandro Dalcin 
379aa3661deSLisandro Dalcin   PetscFunctionBegin;
3800700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
381aa3661deSLisandro Dalcin 
38298613b67SLisandro Dalcin   if (!snes->vec_func && (snes->jacobian || snes->jacobian_pre)) {
38398613b67SLisandro Dalcin     Mat A = snes->jacobian, B = snes->jacobian_pre;
38498613b67SLisandro Dalcin     ierr = MatGetVecs(A ? A : B, PETSC_NULL,&snes->vec_func);CHKERRQ(ierr);
38598613b67SLisandro Dalcin   }
38698613b67SLisandro Dalcin 
387aa3661deSLisandro Dalcin   if (version == 1) {
388aa3661deSLisandro Dalcin     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
38998613b67SLisandro Dalcin     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
3909c6ac3b3SBarry Smith     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
391aa3661deSLisandro Dalcin   } else if (version == 2) {
392e32f2f54SBarry Smith     if (!snes->vec_func) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"SNESSetFunction() must be called first");
39382a7e548SBarry Smith #if !defined(PETSC_USE_COMPLEX) && !defined(PETSC_USE_REAL_SINGLE) && !defined(PETSC_USE_REAL___FLOAT128)
394aa3661deSLisandro Dalcin     ierr = SNESDefaultMatrixFreeCreate2(snes,snes->vec_func,&J);CHKERRQ(ierr);
395aa3661deSLisandro Dalcin #else
396e32f2f54SBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP, "matrix-free operator rutines (version 2)");
397aa3661deSLisandro Dalcin #endif
398a8248277SBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "matrix-free operator rutines, only version 1 and 2");
399aa3661deSLisandro Dalcin 
400aa3661deSLisandro Dalcin   ierr = PetscInfo1(snes,"Setting default matrix-free operator routines (version %D)\n", version);CHKERRQ(ierr);
401d3462f78SMatthew Knepley   if (hasOperator) {
4023232da50SPeter Brune 
403aa3661deSLisandro Dalcin     /* This version replaces the user provided Jacobian matrix with a
404aa3661deSLisandro Dalcin        matrix-free version but still employs the user-provided preconditioner matrix. */
405aa3661deSLisandro Dalcin     ierr = SNESSetJacobian(snes,J,0,0,0);CHKERRQ(ierr);
406aa3661deSLisandro Dalcin   } else {
407aa3661deSLisandro Dalcin     /* This version replaces both the user-provided Jacobian and the user-
4083232da50SPeter Brune      provided preconditioner Jacobian with the default matrix free version. */
409172a4300SPeter Brune     if ((snes->pcside == PC_LEFT) && snes->pc) {
410172a4300SPeter Brune       ierr = SNESSetJacobian(snes,J,0,0,0);CHKERRQ(ierr);
411172a4300SPeter Brune     } else {
41228a52e04SBarry Smith       ierr = SNESSetJacobian(snes,J,J,MatMFFDComputeJacobian,0);CHKERRQ(ierr);
413172a4300SPeter Brune     }
414aa3661deSLisandro Dalcin     /* Force no preconditioner */
415aa3661deSLisandro Dalcin     ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
416aa3661deSLisandro Dalcin     ierr = KSPGetPC(ksp,&pc);CHKERRQ(ierr);
417251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)pc,PCSHELL,&match);CHKERRQ(ierr);
418aa3661deSLisandro Dalcin     if (!match) {
419aa3661deSLisandro Dalcin       ierr = PetscInfo(snes,"Setting default matrix-free preconditioner routines\nThat is no preconditioner is being used\n");CHKERRQ(ierr);
420aa3661deSLisandro Dalcin       ierr = PCSetType(pc,PCNONE);CHKERRQ(ierr);
421aa3661deSLisandro Dalcin     }
422aa3661deSLisandro Dalcin   }
4236bf464f9SBarry Smith   ierr = MatDestroy(&J);CHKERRQ(ierr);
424aa3661deSLisandro Dalcin   PetscFunctionReturn(0);
425aa3661deSLisandro Dalcin }
426aa3661deSLisandro Dalcin 
4274a2ae208SSatish Balay #undef __FUNCT__
428dfe15315SJed Brown #define __FUNCT__ "DMRestrictHook_SNESVecSol"
429dfe15315SJed Brown static PetscErrorCode DMRestrictHook_SNESVecSol(DM dmfine,Mat Restrict,Vec Rscale,Mat Inject,DM dmcoarse,void *ctx)
430dfe15315SJed Brown {
431dfe15315SJed Brown   SNES snes = (SNES)ctx;
432dfe15315SJed Brown   PetscErrorCode ierr;
433dfe15315SJed Brown   Vec Xfine,Xfine_named = PETSC_NULL,Xcoarse;
434dfe15315SJed Brown 
435dfe15315SJed Brown   PetscFunctionBegin;
43616ebb321SJed Brown   if (PetscLogPrintInfo) {
43716ebb321SJed Brown     PetscInt finelevel,coarselevel,fineclevel,coarseclevel;
43816ebb321SJed Brown     ierr = DMGetRefineLevel(dmfine,&finelevel);CHKERRQ(ierr);
43916ebb321SJed Brown     ierr = DMGetCoarsenLevel(dmfine,&fineclevel);CHKERRQ(ierr);
44016ebb321SJed Brown     ierr = DMGetRefineLevel(dmcoarse,&coarselevel);CHKERRQ(ierr);
44116ebb321SJed Brown     ierr = DMGetCoarsenLevel(dmcoarse,&coarseclevel);CHKERRQ(ierr);
44216ebb321SJed Brown     ierr = PetscInfo4(dmfine,"Restricting SNES solution vector from level %D-%D to level %D-%D\n",finelevel,fineclevel,coarselevel,coarseclevel);CHKERRQ(ierr);
44316ebb321SJed Brown   }
444dfe15315SJed Brown   if (dmfine == snes->dm) Xfine = snes->vec_sol;
445dfe15315SJed Brown   else {
446dfe15315SJed Brown     ierr = DMGetNamedGlobalVector(dmfine,"SNESVecSol",&Xfine_named);CHKERRQ(ierr);
447dfe15315SJed Brown     Xfine = Xfine_named;
448dfe15315SJed Brown   }
449dfe15315SJed Brown   ierr = DMGetNamedGlobalVector(dmcoarse,"SNESVecSol",&Xcoarse);CHKERRQ(ierr);
450dfe15315SJed Brown   ierr = MatRestrict(Restrict,Xfine,Xcoarse);CHKERRQ(ierr);
451dfe15315SJed Brown   ierr = VecPointwiseMult(Xcoarse,Xcoarse,Rscale);CHKERRQ(ierr);
452dfe15315SJed Brown   ierr = DMRestoreNamedGlobalVector(dmcoarse,"SNESVecSol",&Xcoarse);CHKERRQ(ierr);
453dfe15315SJed Brown   if (Xfine_named) {ierr = DMRestoreNamedGlobalVector(dmfine,"SNESVecSol",&Xfine_named);CHKERRQ(ierr);}
454dfe15315SJed Brown   PetscFunctionReturn(0);
455dfe15315SJed Brown }
456dfe15315SJed Brown 
457dfe15315SJed Brown #undef __FUNCT__
45816ebb321SJed Brown #define __FUNCT__ "DMCoarsenHook_SNESVecSol"
45916ebb321SJed Brown static PetscErrorCode DMCoarsenHook_SNESVecSol(DM dm,DM dmc,void *ctx)
46016ebb321SJed Brown {
46116ebb321SJed Brown   PetscErrorCode ierr;
46216ebb321SJed Brown 
46316ebb321SJed Brown   PetscFunctionBegin;
46416ebb321SJed Brown   ierr = DMCoarsenHookAdd(dmc,DMCoarsenHook_SNESVecSol,DMRestrictHook_SNESVecSol,ctx);CHKERRQ(ierr);
46516ebb321SJed Brown   PetscFunctionReturn(0);
46616ebb321SJed Brown }
46716ebb321SJed Brown 
46816ebb321SJed Brown #undef __FUNCT__
469caa4e7f2SJed Brown #define __FUNCT__ "KSPComputeOperators_SNES"
470a6950cb2SJed Brown /* This may be called to rediscretize the operator on levels of linear multigrid. The DM shuffle is so the user can
471a6950cb2SJed Brown  * safely call SNESGetDM() in their residual evaluation routine. */
472caa4e7f2SJed Brown static PetscErrorCode KSPComputeOperators_SNES(KSP ksp,Mat A,Mat B,MatStructure *mstruct,void *ctx)
473caa4e7f2SJed Brown {
474caa4e7f2SJed Brown   SNES                        snes = (SNES)ctx;
475caa4e7f2SJed Brown   PetscErrorCode              ierr;
476caa4e7f2SJed Brown   Mat                         Asave = A,Bsave = B;
477dfe15315SJed Brown   Vec                         X,Xnamed = PETSC_NULL;
478dfe15315SJed Brown   DM                          dmsave;
4794e269d77SPeter Brune   void                        *ctxsave;
4804e269d77SPeter Brune   PetscErrorCode              (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
481caa4e7f2SJed Brown 
482caa4e7f2SJed Brown   PetscFunctionBegin;
483dfe15315SJed Brown   dmsave = snes->dm;
484dfe15315SJed Brown   ierr = KSPGetDM(ksp,&snes->dm);CHKERRQ(ierr);
485dfe15315SJed Brown   if (dmsave == snes->dm) X = snes->vec_sol; /* We are on the finest level */
486dfe15315SJed Brown   else {                                     /* We are on a coarser level, this vec was initialized using a DM restrict hook */
487dfe15315SJed Brown     ierr = DMGetNamedGlobalVector(snes->dm,"SNESVecSol",&Xnamed);CHKERRQ(ierr);
488dfe15315SJed Brown     X = Xnamed;
4894e269d77SPeter Brune     ierr = SNESGetJacobian(snes,PETSC_NULL,PETSC_NULL,&jac,&ctxsave);CHKERRQ(ierr);
4904e269d77SPeter Brune     /* If the DM's don't match up, the MatFDColoring context needed for the jacobian won't match up either -- fixit. */
4914e269d77SPeter Brune     if (jac == SNESDefaultComputeJacobianColor) {
4924e269d77SPeter Brune       ierr = SNESSetJacobian(snes,PETSC_NULL,PETSC_NULL,SNESDefaultComputeJacobianColor,0);CHKERRQ(ierr);
493dfe15315SJed Brown     }
4944e269d77SPeter Brune   }
4954e269d77SPeter Brune   /* put the previous context back */
4964e269d77SPeter Brune 
497dfe15315SJed Brown   ierr = SNESComputeJacobian(snes,X,&A,&B,mstruct);CHKERRQ(ierr);
4984e269d77SPeter Brune   if (snes->dm != dmsave && jac == SNESDefaultComputeJacobianColor) {
4994e269d77SPeter Brune     ierr = SNESSetJacobian(snes,PETSC_NULL,PETSC_NULL,jac,ctxsave);CHKERRQ(ierr);
5004e269d77SPeter Brune   }
5014e269d77SPeter Brune 
502caa4e7f2SJed Brown   if (A != Asave || B != Bsave) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_SUP,"No support for changing matrices at this time");
503dfe15315SJed Brown   if (Xnamed) {
504dfe15315SJed Brown     ierr = DMRestoreNamedGlobalVector(snes->dm,"SNESVecSol",&Xnamed);CHKERRQ(ierr);
505dfe15315SJed Brown   }
506dfe15315SJed Brown   snes->dm = dmsave;
507caa4e7f2SJed Brown   PetscFunctionReturn(0);
508caa4e7f2SJed Brown }
509caa4e7f2SJed Brown 
510caa4e7f2SJed Brown #undef __FUNCT__
5116cab3a1bSJed Brown #define __FUNCT__ "SNESSetUpMatrices"
5126cab3a1bSJed Brown /*@
5136cab3a1bSJed Brown    SNESSetUpMatrices - ensures that matrices are available for SNES, to be called by SNESSetUp_XXX()
5146cab3a1bSJed Brown 
5156cab3a1bSJed Brown    Collective
5166cab3a1bSJed Brown 
5176cab3a1bSJed Brown    Input Arguments:
5186cab3a1bSJed Brown .  snes - snes to configure
5196cab3a1bSJed Brown 
5206cab3a1bSJed Brown    Level: developer
5216cab3a1bSJed Brown 
5226cab3a1bSJed Brown .seealso: SNESSetUp()
5236cab3a1bSJed Brown @*/
5246cab3a1bSJed Brown PetscErrorCode SNESSetUpMatrices(SNES snes)
5256cab3a1bSJed Brown {
5266cab3a1bSJed Brown   PetscErrorCode ierr;
5276cab3a1bSJed Brown   DM             dm;
528942e3340SBarry Smith   DMSNES         sdm;
5296cab3a1bSJed Brown 
5306cab3a1bSJed Brown   PetscFunctionBegin;
5316cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
532942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
53322c6f798SBarry Smith   if (!sdm->ops->computejacobian) {
534942e3340SBarry Smith     SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_PLIB,"DMSNES not properly configured");
5353232da50SPeter Brune   } else if (!snes->jacobian && snes->mf) {
5366cab3a1bSJed Brown     Mat J;
5376cab3a1bSJed Brown     void *functx;
5386cab3a1bSJed Brown     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
5396cab3a1bSJed Brown     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
5406cab3a1bSJed Brown     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
5416cab3a1bSJed Brown     ierr = SNESGetFunction(snes,PETSC_NULL,PETSC_NULL,&functx);CHKERRQ(ierr);
5423232da50SPeter Brune     ierr = SNESSetJacobian(snes,J,J,0,0);CHKERRQ(ierr);
5436cab3a1bSJed Brown     ierr = MatDestroy(&J);CHKERRQ(ierr);
544caa4e7f2SJed Brown   } else if (snes->mf_operator && !snes->jacobian_pre && !snes->jacobian) {
5456cab3a1bSJed Brown     Mat J,B;
5466cab3a1bSJed Brown     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
5476cab3a1bSJed Brown     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
5486cab3a1bSJed Brown     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
5496cab3a1bSJed Brown     ierr = DMCreateMatrix(snes->dm,MATAIJ,&B);CHKERRQ(ierr);
55006f20277SJed Brown     /* sdm->computejacobian was already set to reach here */
55106f20277SJed Brown     ierr = SNESSetJacobian(snes,J,B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
5526cab3a1bSJed Brown     ierr = MatDestroy(&J);CHKERRQ(ierr);
5536cab3a1bSJed Brown     ierr = MatDestroy(&B);CHKERRQ(ierr);
554caa4e7f2SJed Brown   } else if (!snes->jacobian_pre) {
5556cab3a1bSJed Brown     Mat J,B;
5566cab3a1bSJed Brown     J = snes->jacobian;
5576cab3a1bSJed Brown     ierr = DMCreateMatrix(snes->dm,MATAIJ,&B);CHKERRQ(ierr);
5586cab3a1bSJed Brown     ierr = SNESSetJacobian(snes,J?J:B,B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
5596cab3a1bSJed Brown     ierr = MatDestroy(&B);CHKERRQ(ierr);
5606cab3a1bSJed Brown   }
561caa4e7f2SJed Brown   {
562caa4e7f2SJed Brown     KSP ksp;
563caa4e7f2SJed Brown     ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
564caa4e7f2SJed Brown     ierr = KSPSetComputeOperators(ksp,KSPComputeOperators_SNES,snes);CHKERRQ(ierr);
56516ebb321SJed Brown     ierr = DMCoarsenHookAdd(snes->dm,DMCoarsenHook_SNESVecSol,DMRestrictHook_SNESVecSol,snes);CHKERRQ(ierr);
566caa4e7f2SJed Brown   }
5676cab3a1bSJed Brown   PetscFunctionReturn(0);
5686cab3a1bSJed Brown }
5696cab3a1bSJed Brown 
5706cab3a1bSJed Brown #undef __FUNCT__
5714a2ae208SSatish Balay #define __FUNCT__ "SNESSetFromOptions"
5729b94acceSBarry Smith /*@
57394b7f48cSBarry Smith    SNESSetFromOptions - Sets various SNES and KSP parameters from user options.
5749b94acceSBarry Smith 
575c7afd0dbSLois Curfman McInnes    Collective on SNES
576c7afd0dbSLois Curfman McInnes 
5779b94acceSBarry Smith    Input Parameter:
5789b94acceSBarry Smith .  snes - the SNES context
5799b94acceSBarry Smith 
58036851e7fSLois Curfman McInnes    Options Database Keys:
581ea630c6eSPeter Brune +  -snes_type <type> - ls, tr, ngmres, ncg, richardson, qn, vi, fas
58282738288SBarry Smith .  -snes_stol - convergence tolerance in terms of the norm
58382738288SBarry Smith                 of the change in the solution between steps
58470441072SBarry Smith .  -snes_atol <abstol> - absolute tolerance of residual norm
585b39c3a46SLois Curfman McInnes .  -snes_rtol <rtol> - relative decrease in tolerance norm from initial
586b39c3a46SLois Curfman McInnes .  -snes_max_it <max_it> - maximum number of iterations
587b39c3a46SLois Curfman McInnes .  -snes_max_funcs <max_funcs> - maximum number of function evaluations
5884839bfe8SBarry Smith .  -snes_max_fail <max_fail> - maximum number of line search failures allowed before stopping, default is none
589ddf469c8SBarry Smith .  -snes_max_linear_solve_fail - number of linear solver failures before SNESSolve() stops
590a8054027SBarry Smith .  -snes_lag_preconditioner <lag> - how often preconditioner is rebuilt (use -1 to never rebuild)
591e35cf81dSBarry Smith .  -snes_lag_jacobian <lag> - how often Jacobian is rebuilt (use -1 to never rebuild)
592b39c3a46SLois Curfman McInnes .  -snes_trtol <trtol> - trust region tolerance
5932492ecdbSBarry Smith .  -snes_no_convergence_test - skip convergence test in nonlinear
59482738288SBarry Smith                                solver; hence iterations will continue until max_it
5951fbbfb26SLois Curfman McInnes                                or some other criterion is reached. Saves expense
59682738288SBarry Smith                                of convergence test
597e8105e01SRichard Katz .  -snes_monitor <optional filename> - prints residual norm at each iteration. if no
598e8105e01SRichard Katz                                        filename given prints to stdout
599a6570f20SBarry Smith .  -snes_monitor_solution - plots solution at each iteration
600a6570f20SBarry Smith .  -snes_monitor_residual - plots residual (not its norm) at each iteration
601a6570f20SBarry Smith .  -snes_monitor_solution_update - plots update to solution at each iteration
6024619e776SBarry Smith .  -snes_monitor_lg_residualnorm - plots residual norm at each iteration
603459f5d12SBarry Smith .  -snes_monitor_lg_range - plots residual norm at each iteration
604e24b481bSBarry Smith .  -snes_fd - use finite differences to compute Jacobian; very slow, only for testing
605e2e60de9SPeter Brune .  -snes_fd_color - use finite differences with coloring to compute Jacobian
6065968eb51SBarry Smith .  -snes_mf_ksp_monitor - if using matrix-free multiply then print h at each KSP iteration
607fee2055bSBarry Smith -  -snes_converged_reason - print the reason for convergence/divergence after each solve
60882738288SBarry Smith 
60982738288SBarry Smith     Options Database for Eisenstat-Walker method:
610fa9f3622SBarry Smith +  -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence
6114b27c08aSLois Curfman McInnes .  -snes_ksp_ew_version ver - version of  Eisenstat-Walker method
61236851e7fSLois Curfman McInnes .  -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0
61336851e7fSLois Curfman McInnes .  -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax
61436851e7fSLois Curfman McInnes .  -snes_ksp_ew_gamma <gamma> - Sets gamma
61536851e7fSLois Curfman McInnes .  -snes_ksp_ew_alpha <alpha> - Sets alpha
61636851e7fSLois Curfman McInnes .  -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2
61736851e7fSLois Curfman McInnes -  -snes_ksp_ew_threshold <threshold> - Sets threshold
61882738288SBarry Smith 
61911ca99fdSLois Curfman McInnes    Notes:
62011ca99fdSLois Curfman McInnes    To see all options, run your program with the -help option or consult
6210598bfebSBarry Smith    the <A href="../../docs/manual.pdf#nameddest=ch_snes">SNES chapter of the users manual</A>.
62283e2fdc7SBarry Smith 
62336851e7fSLois Curfman McInnes    Level: beginner
62436851e7fSLois Curfman McInnes 
6259b94acceSBarry Smith .keywords: SNES, nonlinear, set, options, database
6269b94acceSBarry Smith 
62769ed319cSSatish Balay .seealso: SNESSetOptionsPrefix()
6289b94acceSBarry Smith @*/
6297087cfbeSBarry Smith PetscErrorCode  SNESSetFromOptions(SNES snes)
6309b94acceSBarry Smith {
631d8f46077SPeter Brune   PetscBool               flg,pcset;
632d8f46077SPeter Brune   PetscInt                i,indx,lag,grids;
633aa3661deSLisandro Dalcin   MatStructure            matflag;
63404d7464bSBarry Smith   const char              *deft = SNESNEWTONLS;
63585385478SLisandro Dalcin   const char              *convtests[] = {"default","skip"};
63685385478SLisandro Dalcin   SNESKSPEW               *kctx = NULL;
637e8105e01SRichard Katz   char                    type[256], monfilename[PETSC_MAX_PATH_LEN];
638649052a6SBarry Smith   PetscViewer             monviewer;
63985385478SLisandro Dalcin   PetscErrorCode          ierr;
640c40d0f55SPeter Brune   PCSide                  pcside;
641a64e098fSPeter Brune   const char              *optionsprefix;
6429b94acceSBarry Smith 
6433a40ed3dSBarry Smith   PetscFunctionBegin;
6440700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
645ca161407SBarry Smith 
646186905e3SBarry Smith   if (!SNESRegisterAllCalled) {ierr = SNESRegisterAll(PETSC_NULL);CHKERRQ(ierr);}
6473194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)snes);CHKERRQ(ierr);
6487adad957SLisandro Dalcin     if (((PetscObject)snes)->type_name) { deft = ((PetscObject)snes)->type_name; }
649b0a32e0cSBarry Smith     ierr = PetscOptionsList("-snes_type","Nonlinear solver method","SNESSetType",SNESList,deft,type,256,&flg);CHKERRQ(ierr);
650d64ed03dSBarry Smith     if (flg) {
651186905e3SBarry Smith       ierr = SNESSetType(snes,type);CHKERRQ(ierr);
6527adad957SLisandro Dalcin     } else if (!((PetscObject)snes)->type_name) {
653186905e3SBarry Smith       ierr = SNESSetType(snes,deft);CHKERRQ(ierr);
654d64ed03dSBarry Smith     }
65590d69ab7SBarry Smith     /* not used here, but called so will go into help messaage */
656909c8a9fSBarry Smith     ierr = PetscOptionsName("-snes_view","Print detailed information on solver used","SNESView",0);CHKERRQ(ierr);
65793c39befSBarry Smith 
658c60f73f4SPeter Brune     ierr = PetscOptionsReal("-snes_stol","Stop if step length less than","SNESSetTolerances",snes->stol,&snes->stol,0);CHKERRQ(ierr);
65957034d6fSHong Zhang     ierr = PetscOptionsReal("-snes_atol","Stop if function norm less than","SNESSetTolerances",snes->abstol,&snes->abstol,0);CHKERRQ(ierr);
660186905e3SBarry Smith 
66157034d6fSHong Zhang     ierr = PetscOptionsReal("-snes_rtol","Stop if decrease in function norm less than","SNESSetTolerances",snes->rtol,&snes->rtol,0);CHKERRQ(ierr);
662b0a32e0cSBarry Smith     ierr = PetscOptionsInt("-snes_max_it","Maximum iterations","SNESSetTolerances",snes->max_its,&snes->max_its,PETSC_NULL);CHKERRQ(ierr);
663b0a32e0cSBarry Smith     ierr = PetscOptionsInt("-snes_max_funcs","Maximum function evaluations","SNESSetTolerances",snes->max_funcs,&snes->max_funcs,PETSC_NULL);CHKERRQ(ierr);
66424254dc1SJed Brown     ierr = PetscOptionsInt("-snes_max_fail","Maximum nonlinear step failures","SNESSetMaxNonlinearStepFailures",snes->maxFailures,&snes->maxFailures,PETSC_NULL);CHKERRQ(ierr);
665ddf469c8SBarry Smith     ierr = PetscOptionsInt("-snes_max_linear_solve_fail","Maximum failures in linear solves allowed","SNESSetMaxLinearSolveFailures",snes->maxLinearSolveFailures,&snes->maxLinearSolveFailures,PETSC_NULL);CHKERRQ(ierr);
666acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_error_if_not_converged","Generate error if solver does not converge","SNESSetErrorIfNotConverged",snes->errorifnotconverged,&snes->errorifnotconverged,PETSC_NULL);CHKERRQ(ierr);
66785385478SLisandro Dalcin 
668a8054027SBarry Smith     ierr = PetscOptionsInt("-snes_lag_preconditioner","How often to rebuild preconditioner","SNESSetLagPreconditioner",snes->lagpreconditioner,&lag,&flg);CHKERRQ(ierr);
669a8054027SBarry Smith     if (flg) {
670a8054027SBarry Smith       ierr = SNESSetLagPreconditioner(snes,lag);CHKERRQ(ierr);
671a8054027SBarry Smith     }
672e35cf81dSBarry Smith     ierr = PetscOptionsInt("-snes_lag_jacobian","How often to rebuild Jacobian","SNESSetLagJacobian",snes->lagjacobian,&lag,&flg);CHKERRQ(ierr);
673e35cf81dSBarry Smith     if (flg) {
674e35cf81dSBarry Smith       ierr = SNESSetLagJacobian(snes,lag);CHKERRQ(ierr);
675e35cf81dSBarry Smith     }
676efd51863SBarry Smith     ierr = PetscOptionsInt("-snes_grid_sequence","Use grid sequencing to generate initial guess","SNESSetGridSequence",snes->gridsequence,&grids,&flg);CHKERRQ(ierr);
677efd51863SBarry Smith     if (flg) {
678efd51863SBarry Smith       ierr = SNESSetGridSequence(snes,grids);CHKERRQ(ierr);
679efd51863SBarry Smith     }
680a8054027SBarry Smith 
68185385478SLisandro Dalcin     ierr = PetscOptionsEList("-snes_convergence_test","Convergence test","SNESSetConvergenceTest",convtests,2,"default",&indx,&flg);CHKERRQ(ierr);
68285385478SLisandro Dalcin     if (flg) {
68385385478SLisandro Dalcin       switch (indx) {
6847f7931b9SBarry Smith       case 0: ierr = SNESSetConvergenceTest(snes,SNESDefaultConverged,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); break;
6857f7931b9SBarry Smith       case 1: ierr = SNESSetConvergenceTest(snes,SNESSkipConverged,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);    break;
68685385478SLisandro Dalcin       }
68785385478SLisandro Dalcin     }
68885385478SLisandro Dalcin 
689acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_converged_reason","Print reason for converged or diverged","SNESSolve",snes->printreason,&snes->printreason,PETSC_NULL);CHKERRQ(ierr);
690186905e3SBarry Smith 
691fdacfa88SPeter Brune     ierr = PetscOptionsEList("-snes_norm_type","SNES Norm type","SNESSetNormType",SNESNormTypes,5,"function",&indx,&flg);CHKERRQ(ierr);
692fdacfa88SPeter Brune     if (flg) { ierr = SNESSetNormType(snes,(SNESNormType)indx);CHKERRQ(ierr); }
693fdacfa88SPeter Brune 
69485385478SLisandro Dalcin     kctx = (SNESKSPEW *)snes->kspconvctx;
69585385478SLisandro Dalcin 
696acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_ksp_ew","Use Eisentat-Walker linear system convergence test","SNESKSPSetUseEW",snes->ksp_ewconv,&snes->ksp_ewconv,PETSC_NULL);CHKERRQ(ierr);
697186905e3SBarry Smith 
698fa9f3622SBarry Smith     ierr = PetscOptionsInt("-snes_ksp_ew_version","Version 1, 2 or 3","SNESKSPSetParametersEW",kctx->version,&kctx->version,0);CHKERRQ(ierr);
699fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_rtol0","0 <= rtol0 < 1","SNESKSPSetParametersEW",kctx->rtol_0,&kctx->rtol_0,0);CHKERRQ(ierr);
700fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_rtolmax","0 <= rtolmax < 1","SNESKSPSetParametersEW",kctx->rtol_max,&kctx->rtol_max,0);CHKERRQ(ierr);
701fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_gamma","0 <= gamma <= 1","SNESKSPSetParametersEW",kctx->gamma,&kctx->gamma,0);CHKERRQ(ierr);
702fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_alpha","1 < alpha <= 2","SNESKSPSetParametersEW",kctx->alpha,&kctx->alpha,0);CHKERRQ(ierr);
703fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_alpha2","alpha2","SNESKSPSetParametersEW",kctx->alpha2,&kctx->alpha2,0);CHKERRQ(ierr);
704fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_threshold","0 < threshold < 1","SNESKSPSetParametersEW",kctx->threshold,&kctx->threshold,0);CHKERRQ(ierr);
705186905e3SBarry Smith 
70690d69ab7SBarry Smith     flg  = PETSC_FALSE;
7075341784dSBarry Smith     ierr = PetscOptionsBool("-snes_check_jacobian","Check each Jacobian with a differenced one","SNESUpdateCheckJacobian",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
7085341784dSBarry Smith     if (flg) {
7095341784dSBarry Smith       ierr = SNESSetUpdate(snes,SNESUpdateCheckJacobian);CHKERRQ(ierr);
7105341784dSBarry Smith     }
7115341784dSBarry Smith 
7125341784dSBarry Smith     flg  = PETSC_FALSE;
713acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_cancel","Remove all monitors","SNESMonitorCancel",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
714a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorCancel(snes);CHKERRQ(ierr);}
715eabae89aSBarry Smith 
716a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_monitor","Monitor norm of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
717e8105e01SRichard Katz     if (flg) {
718649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
719649052a6SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
720e8105e01SRichard Katz     }
721eabae89aSBarry Smith 
722b271bb04SBarry Smith     ierr = PetscOptionsString("-snes_monitor_range","Monitor range of elements of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
723b271bb04SBarry Smith     if (flg) {
724b271bb04SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorRange,0,0);CHKERRQ(ierr);
725b271bb04SBarry Smith     }
726b271bb04SBarry Smith 
727a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_ratiomonitor","Monitor ratios of norms of function","SNESMonitorSetRatio","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
728eabae89aSBarry Smith     if (flg) {
729649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
730f1bef1bcSMatthew Knepley       ierr = SNESMonitorSetRatio(snes,monviewer);CHKERRQ(ierr);
731e8105e01SRichard Katz     }
732eabae89aSBarry Smith 
733a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_monitor_short","Monitor norm of function (fewer digits)","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
734eabae89aSBarry Smith     if (flg) {
735649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
736649052a6SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorDefaultShort,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
737eabae89aSBarry Smith     }
738eabae89aSBarry Smith 
7395180491cSLisandro Dalcin     ierr = PetscOptionsString("-snes_monitor_python","Use Python function","SNESMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
7405180491cSLisandro Dalcin     if (flg) {ierr = PetscPythonMonitorSet((PetscObject)snes,monfilename);CHKERRQ(ierr);}
7415180491cSLisandro Dalcin 
74290d69ab7SBarry Smith     flg  = PETSC_FALSE;
743acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_solution","Plot solution at each iteration","SNESMonitorSolution",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
744a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolution,0,0);CHKERRQ(ierr);}
74590d69ab7SBarry Smith     flg  = PETSC_FALSE;
746acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_solution_update","Plot correction at each iteration","SNESMonitorSolutionUpdate",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
747a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolutionUpdate,0,0);CHKERRQ(ierr);}
74890d69ab7SBarry Smith     flg  = PETSC_FALSE;
749acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_residual","Plot residual at each iteration","SNESMonitorResidual",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
750a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorResidual,0,0);CHKERRQ(ierr);}
75190d69ab7SBarry Smith     flg  = PETSC_FALSE;
7524619e776SBarry Smith     ierr = PetscOptionsBool("-snes_monitor_lg_residualnorm","Plot function norm at each iteration","SNESMonitorLGResidualNorm",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
753459f5d12SBarry Smith     if (flg) {
754459f5d12SBarry Smith       PetscDrawLG ctx;
755459f5d12SBarry Smith 
756459f5d12SBarry Smith       ierr = SNESMonitorLGCreate(0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,&ctx);CHKERRQ(ierr);
757459f5d12SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorLGResidualNorm,ctx,(PetscErrorCode (*)(void**))SNESMonitorLGDestroy);CHKERRQ(ierr);
758459f5d12SBarry Smith     }
75990d69ab7SBarry Smith     flg  = PETSC_FALSE;
7604619e776SBarry Smith     ierr = PetscOptionsBool("-snes_monitor_lg_range","Plot function range at each iteration","SNESMonitorLGRange",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
761459f5d12SBarry Smith     if (flg) {
762459f5d12SBarry Smith       PetscViewer ctx;
763e24b481bSBarry Smith 
764459f5d12SBarry Smith       ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,&ctx);CHKERRQ(ierr);
765459f5d12SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorLGRange,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
766459f5d12SBarry Smith     }
7672e7541e6SPeter Brune 
7682e7541e6SPeter Brune     flg  = PETSC_FALSE;
7692e7541e6SPeter Brune     ierr = PetscOptionsBool("-snes_monitor_jacupdate_spectrum","Print the change in the spectrum of the Jacobian","SNESMonitorJacUpdateSpectrum",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
7702e7541e6SPeter Brune     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorJacUpdateSpectrum,0,0);CHKERRQ(ierr);}
7712e7541e6SPeter Brune 
77290d69ab7SBarry Smith     flg  = PETSC_FALSE;
773acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_fd","Use finite differences (slow) to compute Jacobian","SNESDefaultComputeJacobian",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
7744b27c08aSLois Curfman McInnes     if (flg) {
7756cab3a1bSJed Brown       void *functx;
7766cab3a1bSJed Brown       ierr = SNESGetFunction(snes,PETSC_NULL,PETSC_NULL,&functx);CHKERRQ(ierr);
7776cab3a1bSJed Brown       ierr = SNESSetJacobian(snes,snes->jacobian,snes->jacobian_pre,SNESDefaultComputeJacobian,functx);CHKERRQ(ierr);
778ae15b995SBarry Smith       ierr = PetscInfo(snes,"Setting default finite difference Jacobian matrix\n");CHKERRQ(ierr);
7799b94acceSBarry Smith     }
780639f9d9dSBarry Smith 
78144848bc4SPeter Brune     flg  = PETSC_FALSE;
78297584545SPeter Brune     ierr = PetscOptionsBool("-snes_fd_function","Use finite differences (slow) to compute function from user objective","SNESDefaultObjectiveComputeFunctionFD",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
78397584545SPeter Brune     if (flg) {
78497584545SPeter Brune       ierr = SNESSetFunction(snes,PETSC_NULL,SNESDefaultObjectiveComputeFunctionFD,PETSC_NULL);CHKERRQ(ierr);
78597584545SPeter Brune     }
78697584545SPeter Brune 
78797584545SPeter Brune     flg  = PETSC_FALSE;
78844848bc4SPeter Brune     ierr = PetscOptionsBool("-snes_fd_color","Use finite differences with coloring to compute Jacobian","SNESDefaultComputeJacobianColor",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
78944848bc4SPeter Brune     if (flg) {
79044848bc4SPeter Brune       void *functx;
79144848bc4SPeter Brune       ierr = SNESGetFunction(snes,PETSC_NULL,PETSC_NULL,&functx);CHKERRQ(ierr);
7920171d955SPeter Brune       ierr = SNESSetJacobian(snes,snes->jacobian,snes->jacobian_pre,SNESDefaultComputeJacobianColor,0);CHKERRQ(ierr);
79344848bc4SPeter Brune       ierr = PetscInfo(snes,"Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
79444848bc4SPeter Brune     }
79544848bc4SPeter Brune 
796aa3661deSLisandro Dalcin     flg = PETSC_FALSE;
797d8f46077SPeter Brune     ierr = PetscOptionsBool("-snes_mf_operator","Use a Matrix-Free Jacobian with user-provided preconditioner matrix","MatCreateSNESMF",PETSC_FALSE,&snes->mf_operator,&flg);CHKERRQ(ierr);
798d8f46077SPeter Brune     if (flg && snes->mf_operator) {
799a8248277SBarry Smith       snes->mf_operator = PETSC_TRUE;
800d8f46077SPeter Brune       snes->mf = PETSC_TRUE;
801a8248277SBarry Smith     }
802aa3661deSLisandro Dalcin     flg = PETSC_FALSE;
803d8f46077SPeter Brune     ierr = PetscOptionsBool("-snes_mf","Use a Matrix-Free Jacobian with no preconditioner matrix","MatCreateSNESMF",PETSC_FALSE,&snes->mf,&flg);CHKERRQ(ierr);
804d8f46077SPeter Brune     if (!flg && snes->mf_operator) snes->mf = PETSC_TRUE;
805d8f46077SPeter Brune     ierr = PetscOptionsInt("-snes_mf_version","Matrix-Free routines version 1 or 2","None",snes->mf_version,&snes->mf_version,0);CHKERRQ(ierr);
806d28543b3SPeter Brune 
807c40d0f55SPeter Brune     flg = PETSC_FALSE;
80822d28d08SBarry Smith     ierr = SNESGetPCSide(snes,&pcside);CHKERRQ(ierr);
809c40d0f55SPeter Brune     ierr = PetscOptionsEnum("-snes_npc_side","SNES nonlinear preconditioner side","SNESSetPCSide",PCSides,(PetscEnum)pcside,(PetscEnum*)&pcside,&flg);CHKERRQ(ierr);
810c40d0f55SPeter Brune     if (flg) {ierr = SNESSetPCSide(snes,pcside);CHKERRQ(ierr);}
811c40d0f55SPeter Brune 
81276b2cf59SMatthew Knepley     for (i = 0; i < numberofsetfromoptions; i++) {
81376b2cf59SMatthew Knepley       ierr = (*othersetfromoptions[i])(snes);CHKERRQ(ierr);
81476b2cf59SMatthew Knepley     }
81576b2cf59SMatthew Knepley 
816e7788613SBarry Smith     if (snes->ops->setfromoptions) {
817e7788613SBarry Smith       ierr = (*snes->ops->setfromoptions)(snes);CHKERRQ(ierr);
818639f9d9dSBarry Smith     }
8195d973c19SBarry Smith 
8205d973c19SBarry Smith     /* process any options handlers added with PetscObjectAddOptionsHandler() */
8215d973c19SBarry Smith     ierr = PetscObjectProcessOptionsHandlers((PetscObject)snes);CHKERRQ(ierr);
822b0a32e0cSBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
8234bbc92c1SBarry Smith 
8241cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
82522d28d08SBarry Smith   ierr = KSPGetOperators(snes->ksp,PETSC_NULL,PETSC_NULL,&matflag);CHKERRQ(ierr);
826aa3661deSLisandro Dalcin   ierr = KSPSetOperators(snes->ksp,snes->jacobian,snes->jacobian_pre,matflag);CHKERRQ(ierr);
82785385478SLisandro Dalcin   ierr = KSPSetFromOptions(snes->ksp);CHKERRQ(ierr);
82893993e2dSLois Curfman McInnes 
8299e764e56SPeter Brune   if (!snes->linesearch) {
830f1c6b773SPeter Brune     ierr = SNESGetSNESLineSearch(snes, &snes->linesearch);CHKERRQ(ierr);
8319e764e56SPeter Brune   }
832f1c6b773SPeter Brune   ierr = SNESLineSearchSetFromOptions(snes->linesearch);CHKERRQ(ierr);
8339e764e56SPeter Brune 
83451e86f29SPeter Brune   /* if someone has set the SNES PC type, create it. */
83551e86f29SPeter Brune   ierr = SNESGetOptionsPrefix(snes, &optionsprefix);CHKERRQ(ierr);
83651e86f29SPeter Brune   ierr = PetscOptionsHasName(optionsprefix, "-npc_snes_type", &pcset);CHKERRQ(ierr);
83751e86f29SPeter Brune   if (pcset && (!snes->pc)) {
83851e86f29SPeter Brune     ierr = SNESGetPC(snes, &snes->pc);CHKERRQ(ierr);
83951e86f29SPeter Brune   }
8403a40ed3dSBarry Smith   PetscFunctionReturn(0);
8419b94acceSBarry Smith }
8429b94acceSBarry Smith 
843d25893d9SBarry Smith #undef __FUNCT__
844d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeApplicationContext"
845d25893d9SBarry Smith /*@
846d25893d9SBarry Smith    SNESSetComputeApplicationContext - Sets an optional function to compute a user-defined context for
847d25893d9SBarry Smith    the nonlinear solvers.
848d25893d9SBarry Smith 
849d25893d9SBarry Smith    Logically Collective on SNES
850d25893d9SBarry Smith 
851d25893d9SBarry Smith    Input Parameters:
852d25893d9SBarry Smith +  snes - the SNES context
853d25893d9SBarry Smith .  compute - function to compute the context
854d25893d9SBarry Smith -  destroy - function to destroy the context
855d25893d9SBarry Smith 
856d25893d9SBarry Smith    Level: intermediate
857d25893d9SBarry Smith 
858d25893d9SBarry Smith .keywords: SNES, nonlinear, set, application, context
859d25893d9SBarry Smith 
860d25893d9SBarry Smith .seealso: SNESGetApplicationContext(), SNESSetComputeApplicationContext(), SNESGetApplicationContext()
861d25893d9SBarry Smith @*/
862d25893d9SBarry Smith PetscErrorCode  SNESSetComputeApplicationContext(SNES snes,PetscErrorCode (*compute)(SNES,void**),PetscErrorCode (*destroy)(void**))
863d25893d9SBarry Smith {
864d25893d9SBarry Smith   PetscFunctionBegin;
865d25893d9SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
866d25893d9SBarry Smith   snes->ops->usercompute = compute;
867d25893d9SBarry Smith   snes->ops->userdestroy = destroy;
868d25893d9SBarry Smith   PetscFunctionReturn(0);
869d25893d9SBarry Smith }
870a847f771SSatish Balay 
8714a2ae208SSatish Balay #undef __FUNCT__
8724a2ae208SSatish Balay #define __FUNCT__ "SNESSetApplicationContext"
873b07ff414SBarry Smith /*@
8749b94acceSBarry Smith    SNESSetApplicationContext - Sets the optional user-defined context for
8759b94acceSBarry Smith    the nonlinear solvers.
8769b94acceSBarry Smith 
8773f9fe445SBarry Smith    Logically Collective on SNES
878fee21e36SBarry Smith 
879c7afd0dbSLois Curfman McInnes    Input Parameters:
880c7afd0dbSLois Curfman McInnes +  snes - the SNES context
881c7afd0dbSLois Curfman McInnes -  usrP - optional user context
882c7afd0dbSLois Curfman McInnes 
88336851e7fSLois Curfman McInnes    Level: intermediate
88436851e7fSLois Curfman McInnes 
8859b94acceSBarry Smith .keywords: SNES, nonlinear, set, application, context
8869b94acceSBarry Smith 
887ecaffddaSVictor Eijkhout .seealso: SNESGetApplicationContext()
8889b94acceSBarry Smith @*/
8897087cfbeSBarry Smith PetscErrorCode  SNESSetApplicationContext(SNES snes,void *usrP)
8909b94acceSBarry Smith {
8911b2093e4SBarry Smith   PetscErrorCode ierr;
892b07ff414SBarry Smith   KSP            ksp;
8931b2093e4SBarry Smith 
8943a40ed3dSBarry Smith   PetscFunctionBegin;
8950700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
896b07ff414SBarry Smith   ierr       = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
897b07ff414SBarry Smith   ierr       = KSPSetApplicationContext(ksp,usrP);CHKERRQ(ierr);
8989b94acceSBarry Smith   snes->user = usrP;
8993a40ed3dSBarry Smith   PetscFunctionReturn(0);
9009b94acceSBarry Smith }
90174679c65SBarry Smith 
9024a2ae208SSatish Balay #undef __FUNCT__
9034a2ae208SSatish Balay #define __FUNCT__ "SNESGetApplicationContext"
904b07ff414SBarry Smith /*@
9059b94acceSBarry Smith    SNESGetApplicationContext - Gets the user-defined context for the
9069b94acceSBarry Smith    nonlinear solvers.
9079b94acceSBarry Smith 
908c7afd0dbSLois Curfman McInnes    Not Collective
909c7afd0dbSLois Curfman McInnes 
9109b94acceSBarry Smith    Input Parameter:
9119b94acceSBarry Smith .  snes - SNES context
9129b94acceSBarry Smith 
9139b94acceSBarry Smith    Output Parameter:
9149b94acceSBarry Smith .  usrP - user context
9159b94acceSBarry Smith 
91636851e7fSLois Curfman McInnes    Level: intermediate
91736851e7fSLois Curfman McInnes 
9189b94acceSBarry Smith .keywords: SNES, nonlinear, get, application, context
9199b94acceSBarry Smith 
9209b94acceSBarry Smith .seealso: SNESSetApplicationContext()
9219b94acceSBarry Smith @*/
922e71120c6SJed Brown PetscErrorCode  SNESGetApplicationContext(SNES snes,void *usrP)
9239b94acceSBarry Smith {
9243a40ed3dSBarry Smith   PetscFunctionBegin;
9250700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
926e71120c6SJed Brown   *(void**)usrP = snes->user;
9273a40ed3dSBarry Smith   PetscFunctionReturn(0);
9289b94acceSBarry Smith }
92974679c65SBarry Smith 
9304a2ae208SSatish Balay #undef __FUNCT__
9314a2ae208SSatish Balay #define __FUNCT__ "SNESGetIterationNumber"
9329b94acceSBarry Smith /*@
933c8228a4eSBarry Smith    SNESGetIterationNumber - Gets the number of nonlinear iterations completed
934c8228a4eSBarry Smith    at this time.
9359b94acceSBarry Smith 
936c7afd0dbSLois Curfman McInnes    Not Collective
937c7afd0dbSLois Curfman McInnes 
9389b94acceSBarry Smith    Input Parameter:
9399b94acceSBarry Smith .  snes - SNES context
9409b94acceSBarry Smith 
9419b94acceSBarry Smith    Output Parameter:
9429b94acceSBarry Smith .  iter - iteration number
9439b94acceSBarry Smith 
944c8228a4eSBarry Smith    Notes:
945c8228a4eSBarry Smith    For example, during the computation of iteration 2 this would return 1.
946c8228a4eSBarry Smith 
947c8228a4eSBarry Smith    This is useful for using lagged Jacobians (where one does not recompute the
94808405cd6SLois Curfman McInnes    Jacobian at each SNES iteration). For example, the code
94908405cd6SLois Curfman McInnes .vb
95008405cd6SLois Curfman McInnes       ierr = SNESGetIterationNumber(snes,&it);
95108405cd6SLois Curfman McInnes       if (!(it % 2)) {
95208405cd6SLois Curfman McInnes         [compute Jacobian here]
95308405cd6SLois Curfman McInnes       }
95408405cd6SLois Curfman McInnes .ve
955c8228a4eSBarry Smith    can be used in your ComputeJacobian() function to cause the Jacobian to be
95608405cd6SLois Curfman McInnes    recomputed every second SNES iteration.
957c8228a4eSBarry Smith 
95836851e7fSLois Curfman McInnes    Level: intermediate
95936851e7fSLois Curfman McInnes 
9602b668275SBarry Smith .keywords: SNES, nonlinear, get, iteration, number,
9612b668275SBarry Smith 
962b850b91aSLisandro Dalcin .seealso:   SNESGetFunctionNorm(), SNESGetLinearSolveIterations()
9639b94acceSBarry Smith @*/
9647087cfbeSBarry Smith PetscErrorCode  SNESGetIterationNumber(SNES snes,PetscInt* iter)
9659b94acceSBarry Smith {
9663a40ed3dSBarry Smith   PetscFunctionBegin;
9670700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
9684482741eSBarry Smith   PetscValidIntPointer(iter,2);
9699b94acceSBarry Smith   *iter = snes->iter;
9703a40ed3dSBarry Smith   PetscFunctionReturn(0);
9719b94acceSBarry Smith }
97274679c65SBarry Smith 
9734a2ae208SSatish Balay #undef __FUNCT__
974360c497dSPeter Brune #define __FUNCT__ "SNESSetIterationNumber"
975360c497dSPeter Brune /*@
976360c497dSPeter Brune    SNESSetIterationNumber - Sets the current iteration number.
977360c497dSPeter Brune 
978360c497dSPeter Brune    Not Collective
979360c497dSPeter Brune 
980360c497dSPeter Brune    Input Parameter:
981360c497dSPeter Brune .  snes - SNES context
982360c497dSPeter Brune .  iter - iteration number
983360c497dSPeter Brune 
984360c497dSPeter Brune    Level: developer
985360c497dSPeter Brune 
986360c497dSPeter Brune .keywords: SNES, nonlinear, set, iteration, number,
987360c497dSPeter Brune 
988360c497dSPeter Brune .seealso:   SNESGetFunctionNorm(), SNESGetLinearSolveIterations()
989360c497dSPeter Brune @*/
990360c497dSPeter Brune PetscErrorCode  SNESSetIterationNumber(SNES snes,PetscInt iter)
991360c497dSPeter Brune {
992360c497dSPeter Brune   PetscErrorCode ierr;
993360c497dSPeter Brune 
994360c497dSPeter Brune   PetscFunctionBegin;
995360c497dSPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
996360c497dSPeter Brune   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
997360c497dSPeter Brune   snes->iter = iter;
998360c497dSPeter Brune   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
999360c497dSPeter Brune   PetscFunctionReturn(0);
1000360c497dSPeter Brune }
1001360c497dSPeter Brune 
1002360c497dSPeter Brune #undef __FUNCT__
10034a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunctionNorm"
10049b94acceSBarry Smith /*@
10059b94acceSBarry Smith    SNESGetFunctionNorm - Gets the norm of the current function that was set
10069b94acceSBarry Smith    with SNESSSetFunction().
10079b94acceSBarry Smith 
1008c7afd0dbSLois Curfman McInnes    Collective on SNES
1009c7afd0dbSLois Curfman McInnes 
10109b94acceSBarry Smith    Input Parameter:
10119b94acceSBarry Smith .  snes - SNES context
10129b94acceSBarry Smith 
10139b94acceSBarry Smith    Output Parameter:
10149b94acceSBarry Smith .  fnorm - 2-norm of function
10159b94acceSBarry Smith 
101636851e7fSLois Curfman McInnes    Level: intermediate
101736851e7fSLois Curfman McInnes 
10189b94acceSBarry Smith .keywords: SNES, nonlinear, get, function, norm
1019a86d99e1SLois Curfman McInnes 
1020b850b91aSLisandro Dalcin .seealso: SNESGetFunction(), SNESGetIterationNumber(), SNESGetLinearSolveIterations()
10219b94acceSBarry Smith @*/
10227087cfbeSBarry Smith PetscErrorCode  SNESGetFunctionNorm(SNES snes,PetscReal *fnorm)
10239b94acceSBarry Smith {
10243a40ed3dSBarry Smith   PetscFunctionBegin;
10250700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
10264482741eSBarry Smith   PetscValidScalarPointer(fnorm,2);
10279b94acceSBarry Smith   *fnorm = snes->norm;
10283a40ed3dSBarry Smith   PetscFunctionReturn(0);
10299b94acceSBarry Smith }
103074679c65SBarry Smith 
1031360c497dSPeter Brune 
1032360c497dSPeter Brune #undef __FUNCT__
1033360c497dSPeter Brune #define __FUNCT__ "SNESSetFunctionNorm"
1034360c497dSPeter Brune /*@
1035360c497dSPeter Brune    SNESSetFunctionNorm - Sets the 2-norm of the current function computed using VecNorm().
1036360c497dSPeter Brune 
1037360c497dSPeter Brune    Collective on SNES
1038360c497dSPeter Brune 
1039360c497dSPeter Brune    Input Parameter:
1040360c497dSPeter Brune .  snes - SNES context
1041360c497dSPeter Brune .  fnorm - 2-norm of function
1042360c497dSPeter Brune 
1043360c497dSPeter Brune    Level: developer
1044360c497dSPeter Brune 
1045360c497dSPeter Brune .keywords: SNES, nonlinear, set, function, norm
1046360c497dSPeter Brune 
1047360c497dSPeter Brune .seealso: SNESSetFunction(), SNESSetIterationNumber(), VecNorm().
1048360c497dSPeter Brune @*/
1049360c497dSPeter Brune PetscErrorCode  SNESSetFunctionNorm(SNES snes,PetscReal fnorm)
1050360c497dSPeter Brune {
1051360c497dSPeter Brune 
1052360c497dSPeter Brune   PetscErrorCode ierr;
1053360c497dSPeter Brune 
1054360c497dSPeter Brune   PetscFunctionBegin;
1055360c497dSPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1056360c497dSPeter Brune   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
1057360c497dSPeter Brune   snes->norm = fnorm;
1058360c497dSPeter Brune   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
1059360c497dSPeter Brune   PetscFunctionReturn(0);
1060360c497dSPeter Brune }
1061360c497dSPeter Brune 
10624a2ae208SSatish Balay #undef __FUNCT__
1063b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetNonlinearStepFailures"
10649b94acceSBarry Smith /*@
1065b850b91aSLisandro Dalcin    SNESGetNonlinearStepFailures - Gets the number of unsuccessful steps
10669b94acceSBarry Smith    attempted by the nonlinear solver.
10679b94acceSBarry Smith 
1068c7afd0dbSLois Curfman McInnes    Not Collective
1069c7afd0dbSLois Curfman McInnes 
10709b94acceSBarry Smith    Input Parameter:
10719b94acceSBarry Smith .  snes - SNES context
10729b94acceSBarry Smith 
10739b94acceSBarry Smith    Output Parameter:
10749b94acceSBarry Smith .  nfails - number of unsuccessful steps attempted
10759b94acceSBarry Smith 
1076c96a6f78SLois Curfman McInnes    Notes:
1077c96a6f78SLois Curfman McInnes    This counter is reset to zero for each successive call to SNESSolve().
1078c96a6f78SLois Curfman McInnes 
107936851e7fSLois Curfman McInnes    Level: intermediate
108036851e7fSLois Curfman McInnes 
10819b94acceSBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps
108258ebbce7SBarry Smith 
1083e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(),
108458ebbce7SBarry Smith           SNESSetMaxNonlinearStepFailures(), SNESGetMaxNonlinearStepFailures()
10859b94acceSBarry Smith @*/
10867087cfbeSBarry Smith PetscErrorCode  SNESGetNonlinearStepFailures(SNES snes,PetscInt* nfails)
10879b94acceSBarry Smith {
10883a40ed3dSBarry Smith   PetscFunctionBegin;
10890700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
10904482741eSBarry Smith   PetscValidIntPointer(nfails,2);
109150ffb88aSMatthew Knepley   *nfails = snes->numFailures;
109250ffb88aSMatthew Knepley   PetscFunctionReturn(0);
109350ffb88aSMatthew Knepley }
109450ffb88aSMatthew Knepley 
109550ffb88aSMatthew Knepley #undef __FUNCT__
1096b850b91aSLisandro Dalcin #define __FUNCT__ "SNESSetMaxNonlinearStepFailures"
109750ffb88aSMatthew Knepley /*@
1098b850b91aSLisandro Dalcin    SNESSetMaxNonlinearStepFailures - Sets the maximum number of unsuccessful steps
109950ffb88aSMatthew Knepley    attempted by the nonlinear solver before it gives up.
110050ffb88aSMatthew Knepley 
110150ffb88aSMatthew Knepley    Not Collective
110250ffb88aSMatthew Knepley 
110350ffb88aSMatthew Knepley    Input Parameters:
110450ffb88aSMatthew Knepley +  snes     - SNES context
110550ffb88aSMatthew Knepley -  maxFails - maximum of unsuccessful steps
110650ffb88aSMatthew Knepley 
110750ffb88aSMatthew Knepley    Level: intermediate
110850ffb88aSMatthew Knepley 
110950ffb88aSMatthew Knepley .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps
111058ebbce7SBarry Smith 
1111e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(),
111258ebbce7SBarry Smith           SNESGetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures()
111350ffb88aSMatthew Knepley @*/
11147087cfbeSBarry Smith PetscErrorCode  SNESSetMaxNonlinearStepFailures(SNES snes, PetscInt maxFails)
111550ffb88aSMatthew Knepley {
111650ffb88aSMatthew Knepley   PetscFunctionBegin;
11170700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
111850ffb88aSMatthew Knepley   snes->maxFailures = maxFails;
111950ffb88aSMatthew Knepley   PetscFunctionReturn(0);
112050ffb88aSMatthew Knepley }
112150ffb88aSMatthew Knepley 
112250ffb88aSMatthew Knepley #undef __FUNCT__
1123b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetMaxNonlinearStepFailures"
112450ffb88aSMatthew Knepley /*@
1125b850b91aSLisandro Dalcin    SNESGetMaxNonlinearStepFailures - Gets the maximum number of unsuccessful steps
112650ffb88aSMatthew Knepley    attempted by the nonlinear solver before it gives up.
112750ffb88aSMatthew Knepley 
112850ffb88aSMatthew Knepley    Not Collective
112950ffb88aSMatthew Knepley 
113050ffb88aSMatthew Knepley    Input Parameter:
113150ffb88aSMatthew Knepley .  snes     - SNES context
113250ffb88aSMatthew Knepley 
113350ffb88aSMatthew Knepley    Output Parameter:
113450ffb88aSMatthew Knepley .  maxFails - maximum of unsuccessful steps
113550ffb88aSMatthew Knepley 
113650ffb88aSMatthew Knepley    Level: intermediate
113750ffb88aSMatthew Knepley 
113850ffb88aSMatthew Knepley .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps
113958ebbce7SBarry Smith 
1140e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(),
114158ebbce7SBarry Smith           SNESSetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures()
114258ebbce7SBarry Smith 
114350ffb88aSMatthew Knepley @*/
11447087cfbeSBarry Smith PetscErrorCode  SNESGetMaxNonlinearStepFailures(SNES snes, PetscInt *maxFails)
114550ffb88aSMatthew Knepley {
114650ffb88aSMatthew Knepley   PetscFunctionBegin;
11470700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
11484482741eSBarry Smith   PetscValidIntPointer(maxFails,2);
114950ffb88aSMatthew Knepley   *maxFails = snes->maxFailures;
11503a40ed3dSBarry Smith   PetscFunctionReturn(0);
11519b94acceSBarry Smith }
1152a847f771SSatish Balay 
11534a2ae208SSatish Balay #undef __FUNCT__
11542541af92SBarry Smith #define __FUNCT__ "SNESGetNumberFunctionEvals"
11552541af92SBarry Smith /*@
11562541af92SBarry Smith    SNESGetNumberFunctionEvals - Gets the number of user provided function evaluations
11572541af92SBarry Smith      done by SNES.
11582541af92SBarry Smith 
11592541af92SBarry Smith    Not Collective
11602541af92SBarry Smith 
11612541af92SBarry Smith    Input Parameter:
11622541af92SBarry Smith .  snes     - SNES context
11632541af92SBarry Smith 
11642541af92SBarry Smith    Output Parameter:
11652541af92SBarry Smith .  nfuncs - number of evaluations
11662541af92SBarry Smith 
11672541af92SBarry Smith    Level: intermediate
11682541af92SBarry Smith 
11692541af92SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps
117058ebbce7SBarry Smith 
1171e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures()
11722541af92SBarry Smith @*/
11737087cfbeSBarry Smith PetscErrorCode  SNESGetNumberFunctionEvals(SNES snes, PetscInt *nfuncs)
11742541af92SBarry Smith {
11752541af92SBarry Smith   PetscFunctionBegin;
11760700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
11772541af92SBarry Smith   PetscValidIntPointer(nfuncs,2);
11782541af92SBarry Smith   *nfuncs = snes->nfuncs;
11792541af92SBarry Smith   PetscFunctionReturn(0);
11802541af92SBarry Smith }
11812541af92SBarry Smith 
11822541af92SBarry Smith #undef __FUNCT__
11833d4c4710SBarry Smith #define __FUNCT__ "SNESGetLinearSolveFailures"
11843d4c4710SBarry Smith /*@
11853d4c4710SBarry Smith    SNESGetLinearSolveFailures - Gets the number of failed (non-converged)
11863d4c4710SBarry Smith    linear solvers.
11873d4c4710SBarry Smith 
11883d4c4710SBarry Smith    Not Collective
11893d4c4710SBarry Smith 
11903d4c4710SBarry Smith    Input Parameter:
11913d4c4710SBarry Smith .  snes - SNES context
11923d4c4710SBarry Smith 
11933d4c4710SBarry Smith    Output Parameter:
11943d4c4710SBarry Smith .  nfails - number of failed solves
11953d4c4710SBarry Smith 
11963d4c4710SBarry Smith    Notes:
11973d4c4710SBarry Smith    This counter is reset to zero for each successive call to SNESSolve().
11983d4c4710SBarry Smith 
11993d4c4710SBarry Smith    Level: intermediate
12003d4c4710SBarry Smith 
12013d4c4710SBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps
120258ebbce7SBarry Smith 
1203e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures()
12043d4c4710SBarry Smith @*/
12057087cfbeSBarry Smith PetscErrorCode  SNESGetLinearSolveFailures(SNES snes,PetscInt* nfails)
12063d4c4710SBarry Smith {
12073d4c4710SBarry Smith   PetscFunctionBegin;
12080700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
12093d4c4710SBarry Smith   PetscValidIntPointer(nfails,2);
12103d4c4710SBarry Smith   *nfails = snes->numLinearSolveFailures;
12113d4c4710SBarry Smith   PetscFunctionReturn(0);
12123d4c4710SBarry Smith }
12133d4c4710SBarry Smith 
12143d4c4710SBarry Smith #undef __FUNCT__
12153d4c4710SBarry Smith #define __FUNCT__ "SNESSetMaxLinearSolveFailures"
12163d4c4710SBarry Smith /*@
12173d4c4710SBarry Smith    SNESSetMaxLinearSolveFailures - the number of failed linear solve attempts
12183d4c4710SBarry Smith    allowed before SNES returns with a diverged reason of SNES_DIVERGED_LINEAR_SOLVE
12193d4c4710SBarry Smith 
12203f9fe445SBarry Smith    Logically Collective on SNES
12213d4c4710SBarry Smith 
12223d4c4710SBarry Smith    Input Parameters:
12233d4c4710SBarry Smith +  snes     - SNES context
12243d4c4710SBarry Smith -  maxFails - maximum allowed linear solve failures
12253d4c4710SBarry Smith 
12263d4c4710SBarry Smith    Level: intermediate
12273d4c4710SBarry Smith 
1228a6796414SBarry Smith    Notes: By default this is 0; that is SNES returns on the first failed linear solve
12293d4c4710SBarry Smith 
12303d4c4710SBarry Smith .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps
12313d4c4710SBarry Smith 
123258ebbce7SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations()
12333d4c4710SBarry Smith @*/
12347087cfbeSBarry Smith PetscErrorCode  SNESSetMaxLinearSolveFailures(SNES snes, PetscInt maxFails)
12353d4c4710SBarry Smith {
12363d4c4710SBarry Smith   PetscFunctionBegin;
12370700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1238c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxFails,2);
12393d4c4710SBarry Smith   snes->maxLinearSolveFailures = maxFails;
12403d4c4710SBarry Smith   PetscFunctionReturn(0);
12413d4c4710SBarry Smith }
12423d4c4710SBarry Smith 
12433d4c4710SBarry Smith #undef __FUNCT__
12443d4c4710SBarry Smith #define __FUNCT__ "SNESGetMaxLinearSolveFailures"
12453d4c4710SBarry Smith /*@
12463d4c4710SBarry Smith    SNESGetMaxLinearSolveFailures - gets the maximum number of linear solve failures that
12473d4c4710SBarry Smith      are allowed before SNES terminates
12483d4c4710SBarry Smith 
12493d4c4710SBarry Smith    Not Collective
12503d4c4710SBarry Smith 
12513d4c4710SBarry Smith    Input Parameter:
12523d4c4710SBarry Smith .  snes     - SNES context
12533d4c4710SBarry Smith 
12543d4c4710SBarry Smith    Output Parameter:
12553d4c4710SBarry Smith .  maxFails - maximum of unsuccessful solves allowed
12563d4c4710SBarry Smith 
12573d4c4710SBarry Smith    Level: intermediate
12583d4c4710SBarry Smith 
12593d4c4710SBarry Smith    Notes: By default this is 1; that is SNES returns on the first failed linear solve
12603d4c4710SBarry Smith 
12613d4c4710SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps
12623d4c4710SBarry Smith 
1263e1c61ce8SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(),
12643d4c4710SBarry Smith @*/
12657087cfbeSBarry Smith PetscErrorCode  SNESGetMaxLinearSolveFailures(SNES snes, PetscInt *maxFails)
12663d4c4710SBarry Smith {
12673d4c4710SBarry Smith   PetscFunctionBegin;
12680700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
12693d4c4710SBarry Smith   PetscValidIntPointer(maxFails,2);
12703d4c4710SBarry Smith   *maxFails = snes->maxLinearSolveFailures;
12713d4c4710SBarry Smith   PetscFunctionReturn(0);
12723d4c4710SBarry Smith }
12733d4c4710SBarry Smith 
12743d4c4710SBarry Smith #undef __FUNCT__
1275b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetLinearSolveIterations"
1276c96a6f78SLois Curfman McInnes /*@
1277b850b91aSLisandro Dalcin    SNESGetLinearSolveIterations - Gets the total number of linear iterations
1278c96a6f78SLois Curfman McInnes    used by the nonlinear solver.
1279c96a6f78SLois Curfman McInnes 
1280c7afd0dbSLois Curfman McInnes    Not Collective
1281c7afd0dbSLois Curfman McInnes 
1282c96a6f78SLois Curfman McInnes    Input Parameter:
1283c96a6f78SLois Curfman McInnes .  snes - SNES context
1284c96a6f78SLois Curfman McInnes 
1285c96a6f78SLois Curfman McInnes    Output Parameter:
1286c96a6f78SLois Curfman McInnes .  lits - number of linear iterations
1287c96a6f78SLois Curfman McInnes 
1288c96a6f78SLois Curfman McInnes    Notes:
1289c96a6f78SLois Curfman McInnes    This counter is reset to zero for each successive call to SNESSolve().
1290c96a6f78SLois Curfman McInnes 
129136851e7fSLois Curfman McInnes    Level: intermediate
129236851e7fSLois Curfman McInnes 
1293c96a6f78SLois Curfman McInnes .keywords: SNES, nonlinear, get, number, linear, iterations
12942b668275SBarry Smith 
12958c7482ecSBarry Smith .seealso:  SNESGetIterationNumber(), SNESGetFunctionNorm(), SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures()
1296c96a6f78SLois Curfman McInnes @*/
12977087cfbeSBarry Smith PetscErrorCode  SNESGetLinearSolveIterations(SNES snes,PetscInt* lits)
1298c96a6f78SLois Curfman McInnes {
12993a40ed3dSBarry Smith   PetscFunctionBegin;
13000700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
13014482741eSBarry Smith   PetscValidIntPointer(lits,2);
1302c96a6f78SLois Curfman McInnes   *lits = snes->linear_its;
13033a40ed3dSBarry Smith   PetscFunctionReturn(0);
1304c96a6f78SLois Curfman McInnes }
1305c96a6f78SLois Curfman McInnes 
13064a2ae208SSatish Balay #undef __FUNCT__
130794b7f48cSBarry Smith #define __FUNCT__ "SNESGetKSP"
130852baeb72SSatish Balay /*@
130994b7f48cSBarry Smith    SNESGetKSP - Returns the KSP context for a SNES solver.
13109b94acceSBarry Smith 
131194b7f48cSBarry Smith    Not Collective, but if SNES object is parallel, then KSP object is parallel
1312c7afd0dbSLois Curfman McInnes 
13139b94acceSBarry Smith    Input Parameter:
13149b94acceSBarry Smith .  snes - the SNES context
13159b94acceSBarry Smith 
13169b94acceSBarry Smith    Output Parameter:
131794b7f48cSBarry Smith .  ksp - the KSP context
13189b94acceSBarry Smith 
13199b94acceSBarry Smith    Notes:
132094b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
13219b94acceSBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
13222999313aSBarry Smith    PC contexts as well.
13239b94acceSBarry Smith 
132436851e7fSLois Curfman McInnes    Level: beginner
132536851e7fSLois Curfman McInnes 
132694b7f48cSBarry Smith .keywords: SNES, nonlinear, get, KSP, context
13279b94acceSBarry Smith 
13282999313aSBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP()
13299b94acceSBarry Smith @*/
13307087cfbeSBarry Smith PetscErrorCode  SNESGetKSP(SNES snes,KSP *ksp)
13319b94acceSBarry Smith {
13321cee3971SBarry Smith   PetscErrorCode ierr;
13331cee3971SBarry Smith 
13343a40ed3dSBarry Smith   PetscFunctionBegin;
13350700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
13364482741eSBarry Smith   PetscValidPointer(ksp,2);
13371cee3971SBarry Smith 
13381cee3971SBarry Smith   if (!snes->ksp) {
13391cee3971SBarry Smith     ierr = KSPCreate(((PetscObject)snes)->comm,&snes->ksp);CHKERRQ(ierr);
13401cee3971SBarry Smith     ierr = PetscObjectIncrementTabLevel((PetscObject)snes->ksp,(PetscObject)snes,1);CHKERRQ(ierr);
13411cee3971SBarry Smith     ierr = PetscLogObjectParent(snes,snes->ksp);CHKERRQ(ierr);
13421cee3971SBarry Smith   }
134394b7f48cSBarry Smith   *ksp = snes->ksp;
13443a40ed3dSBarry Smith   PetscFunctionReturn(0);
13459b94acceSBarry Smith }
134682bf6240SBarry Smith 
13474a2ae208SSatish Balay #undef __FUNCT__
13482999313aSBarry Smith #define __FUNCT__ "SNESSetKSP"
13492999313aSBarry Smith /*@
13502999313aSBarry Smith    SNESSetKSP - Sets a KSP context for the SNES object to use
13512999313aSBarry Smith 
13522999313aSBarry Smith    Not Collective, but the SNES and KSP objects must live on the same MPI_Comm
13532999313aSBarry Smith 
13542999313aSBarry Smith    Input Parameters:
13552999313aSBarry Smith +  snes - the SNES context
13562999313aSBarry Smith -  ksp - the KSP context
13572999313aSBarry Smith 
13582999313aSBarry Smith    Notes:
13592999313aSBarry Smith    The SNES object already has its KSP object, you can obtain with SNESGetKSP()
13602999313aSBarry Smith    so this routine is rarely needed.
13612999313aSBarry Smith 
13622999313aSBarry Smith    The KSP object that is already in the SNES object has its reference count
13632999313aSBarry Smith    decreased by one.
13642999313aSBarry Smith 
13652999313aSBarry Smith    Level: developer
13662999313aSBarry Smith 
13672999313aSBarry Smith .keywords: SNES, nonlinear, get, KSP, context
13682999313aSBarry Smith 
13692999313aSBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP()
13702999313aSBarry Smith @*/
13717087cfbeSBarry Smith PetscErrorCode  SNESSetKSP(SNES snes,KSP ksp)
13722999313aSBarry Smith {
13732999313aSBarry Smith   PetscErrorCode ierr;
13742999313aSBarry Smith 
13752999313aSBarry Smith   PetscFunctionBegin;
13760700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
13770700a824SBarry Smith   PetscValidHeaderSpecific(ksp,KSP_CLASSID,2);
13782999313aSBarry Smith   PetscCheckSameComm(snes,1,ksp,2);
13797dcf0eaaSdalcinl   ierr = PetscObjectReference((PetscObject)ksp);CHKERRQ(ierr);
1380906ed7ccSBarry Smith   if (snes->ksp) {ierr = PetscObjectDereference((PetscObject)snes->ksp);CHKERRQ(ierr);}
13812999313aSBarry Smith   snes->ksp = ksp;
13822999313aSBarry Smith   PetscFunctionReturn(0);
13832999313aSBarry Smith }
13842999313aSBarry Smith 
13857adad957SLisandro Dalcin #if 0
13862999313aSBarry Smith #undef __FUNCT__
13874a2ae208SSatish Balay #define __FUNCT__ "SNESPublish_Petsc"
13886849ba73SBarry Smith static PetscErrorCode SNESPublish_Petsc(PetscObject obj)
1389e24b481bSBarry Smith {
1390e24b481bSBarry Smith   PetscFunctionBegin;
1391e24b481bSBarry Smith   PetscFunctionReturn(0);
1392e24b481bSBarry Smith }
13937adad957SLisandro Dalcin #endif
1394e24b481bSBarry Smith 
13959b94acceSBarry Smith /* -----------------------------------------------------------*/
13964a2ae208SSatish Balay #undef __FUNCT__
13974a2ae208SSatish Balay #define __FUNCT__ "SNESCreate"
139852baeb72SSatish Balay /*@
13999b94acceSBarry Smith    SNESCreate - Creates a nonlinear solver context.
14009b94acceSBarry Smith 
1401c7afd0dbSLois Curfman McInnes    Collective on MPI_Comm
1402c7afd0dbSLois Curfman McInnes 
1403c7afd0dbSLois Curfman McInnes    Input Parameters:
1404906ed7ccSBarry Smith .  comm - MPI communicator
14059b94acceSBarry Smith 
14069b94acceSBarry Smith    Output Parameter:
14079b94acceSBarry Smith .  outsnes - the new SNES context
14089b94acceSBarry Smith 
1409c7afd0dbSLois Curfman McInnes    Options Database Keys:
1410c7afd0dbSLois Curfman McInnes +   -snes_mf - Activates default matrix-free Jacobian-vector products,
1411c7afd0dbSLois Curfman McInnes                and no preconditioning matrix
1412c7afd0dbSLois Curfman McInnes .   -snes_mf_operator - Activates default matrix-free Jacobian-vector
1413c7afd0dbSLois Curfman McInnes                products, and a user-provided preconditioning matrix
1414c7afd0dbSLois Curfman McInnes                as set by SNESSetJacobian()
1415c7afd0dbSLois Curfman McInnes -   -snes_fd - Uses (slow!) finite differences to compute Jacobian
1416c1f60f51SBarry Smith 
141736851e7fSLois Curfman McInnes    Level: beginner
141836851e7fSLois Curfman McInnes 
14199b94acceSBarry Smith .keywords: SNES, nonlinear, create, context
14209b94acceSBarry Smith 
1421a8054027SBarry Smith .seealso: SNESSolve(), SNESDestroy(), SNES, SNESSetLagPreconditioner()
1422a8054027SBarry Smith 
14239b94acceSBarry Smith @*/
14247087cfbeSBarry Smith PetscErrorCode  SNESCreate(MPI_Comm comm,SNES *outsnes)
14259b94acceSBarry Smith {
1426dfbe8321SBarry Smith   PetscErrorCode      ierr;
14279b94acceSBarry Smith   SNES                snes;
1428fa9f3622SBarry Smith   SNESKSPEW           *kctx;
142937fcc0dbSBarry Smith 
14303a40ed3dSBarry Smith   PetscFunctionBegin;
1431ed1caa07SMatthew Knepley   PetscValidPointer(outsnes,2);
14328ba1e511SMatthew Knepley   *outsnes = PETSC_NULL;
1433*519f805aSKarl Rupp #if !defined(PETSC_USE_DYNAMIC_LIBRARIES)
14348ba1e511SMatthew Knepley   ierr = SNESInitializePackage(PETSC_NULL);CHKERRQ(ierr);
14358ba1e511SMatthew Knepley #endif
14368ba1e511SMatthew Knepley 
14373194b578SJed Brown   ierr = PetscHeaderCreate(snes,_p_SNES,struct _SNESOps,SNES_CLASSID,0,"SNES","Nonlinear solver","SNES",comm,SNESDestroy,SNESView);CHKERRQ(ierr);
14387adad957SLisandro Dalcin 
143985385478SLisandro Dalcin   snes->ops->converged    = SNESDefaultConverged;
14402c155ee1SBarry Smith   snes->usesksp           = PETSC_TRUE;
144188976e71SPeter Brune   snes->tolerancesset     = PETSC_FALSE;
14429b94acceSBarry Smith   snes->max_its           = 50;
14439750a799SBarry Smith   snes->max_funcs         = 10000;
14449b94acceSBarry Smith   snes->norm              = 0.0;
1445fdacfa88SPeter Brune   snes->normtype          = SNES_NORM_FUNCTION;
1446b4874afaSBarry Smith   snes->rtol              = 1.e-8;
1447b4874afaSBarry Smith   snes->ttol              = 0.0;
144870441072SBarry Smith   snes->abstol            = 1.e-50;
1449c60f73f4SPeter Brune   snes->stol              = 1.e-8;
14504b27c08aSLois Curfman McInnes   snes->deltatol          = 1.e-12;
14519b94acceSBarry Smith   snes->nfuncs            = 0;
145250ffb88aSMatthew Knepley   snes->numFailures       = 0;
145350ffb88aSMatthew Knepley   snes->maxFailures       = 1;
14547a00f4a9SLois Curfman McInnes   snes->linear_its        = 0;
1455e35cf81dSBarry Smith   snes->lagjacobian       = 1;
1456a8054027SBarry Smith   snes->lagpreconditioner = 1;
1457639f9d9dSBarry Smith   snes->numbermonitors    = 0;
14589b94acceSBarry Smith   snes->data              = 0;
14594dc4c822SBarry Smith   snes->setupcalled       = PETSC_FALSE;
1460186905e3SBarry Smith   snes->ksp_ewconv        = PETSC_FALSE;
14616f24a144SLois Curfman McInnes   snes->nwork             = 0;
146258c9b817SLisandro Dalcin   snes->work              = 0;
146358c9b817SLisandro Dalcin   snes->nvwork            = 0;
146458c9b817SLisandro Dalcin   snes->vwork             = 0;
1465758f92a0SBarry Smith   snes->conv_hist_len     = 0;
1466758f92a0SBarry Smith   snes->conv_hist_max     = 0;
1467758f92a0SBarry Smith   snes->conv_hist         = PETSC_NULL;
1468758f92a0SBarry Smith   snes->conv_hist_its     = PETSC_NULL;
1469758f92a0SBarry Smith   snes->conv_hist_reset   = PETSC_TRUE;
1470e4ed7901SPeter Brune   snes->vec_func_init_set = PETSC_FALSE;
1471e4ed7901SPeter Brune   snes->norm_init         = 0.;
1472e4ed7901SPeter Brune   snes->norm_init_set     = PETSC_FALSE;
1473184914b5SBarry Smith   snes->reason            = SNES_CONVERGED_ITERATING;
14749b94acceSBarry Smith 
1475c40d0f55SPeter Brune   snes->pcside            = PC_RIGHT;
1476c40d0f55SPeter Brune 
1477d8f46077SPeter Brune   snes->mf                = PETSC_FALSE;
1478d8f46077SPeter Brune   snes->mf_operator       = PETSC_FALSE;
1479d8f46077SPeter Brune   snes->mf_version        = 1;
1480d8f46077SPeter Brune 
14813d4c4710SBarry Smith   snes->numLinearSolveFailures = 0;
14823d4c4710SBarry Smith   snes->maxLinearSolveFailures = 1;
14833d4c4710SBarry Smith 
14849b94acceSBarry Smith   /* Create context to compute Eisenstat-Walker relative tolerance for KSP */
148538f2d2fdSLisandro Dalcin   ierr = PetscNewLog(snes,SNESKSPEW,&kctx);CHKERRQ(ierr);
14869b94acceSBarry Smith   snes->kspconvctx  = (void*)kctx;
14879b94acceSBarry Smith   kctx->version     = 2;
14889b94acceSBarry Smith   kctx->rtol_0      = .3; /* Eisenstat and Walker suggest rtol_0=.5, but
14899b94acceSBarry Smith                              this was too large for some test cases */
149075567043SBarry Smith   kctx->rtol_last   = 0.0;
14919b94acceSBarry Smith   kctx->rtol_max    = .9;
14929b94acceSBarry Smith   kctx->gamma       = 1.0;
149362d1f40fSBarry Smith   kctx->alpha       = .5*(1.0 + PetscSqrtReal(5.0));
149471f87433Sdalcinl   kctx->alpha2      = kctx->alpha;
14959b94acceSBarry Smith   kctx->threshold   = .1;
149675567043SBarry Smith   kctx->lresid_last = 0.0;
149775567043SBarry Smith   kctx->norm_last   = 0.0;
14989b94acceSBarry Smith 
14999b94acceSBarry Smith   *outsnes = snes;
15003a40ed3dSBarry Smith   PetscFunctionReturn(0);
15019b94acceSBarry Smith }
15029b94acceSBarry Smith 
150388f0584fSBarry Smith /*MC
150418e2ec27SBarry Smith     SNESFunction - functional form used to convey the nonlinear function to be solved by SNES
150588f0584fSBarry Smith 
150688f0584fSBarry Smith      Synopsis:
1507f2ba6396SBarry Smith      #include "petscsnes.h"
150888f0584fSBarry Smith      SNESFunction(SNES snes,Vec x,Vec f,void *ctx);
150988f0584fSBarry Smith 
151088f0584fSBarry Smith      Input Parameters:
151188f0584fSBarry Smith +     snes - the SNES context
151288f0584fSBarry Smith .     x    - state at which to evaluate residual
151388f0584fSBarry Smith -     ctx     - optional user-defined function context, passed in with SNESSetFunction()
151488f0584fSBarry Smith 
151588f0584fSBarry Smith      Output Parameter:
151688f0584fSBarry Smith .     f  - vector to put residual (function value)
151788f0584fSBarry Smith 
151888f0584fSBarry Smith .seealso:   SNESSetFunction(), SNESGetFunction()
151988f0584fSBarry Smith M*/
152088f0584fSBarry Smith 
15214a2ae208SSatish Balay #undef __FUNCT__
15224a2ae208SSatish Balay #define __FUNCT__ "SNESSetFunction"
15239b94acceSBarry Smith /*@C
15249b94acceSBarry Smith    SNESSetFunction - Sets the function evaluation routine and function
15259b94acceSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
15269b94acceSBarry Smith    equations.
15279b94acceSBarry Smith 
15283f9fe445SBarry Smith    Logically Collective on SNES
1529fee21e36SBarry Smith 
1530c7afd0dbSLois Curfman McInnes    Input Parameters:
1531c7afd0dbSLois Curfman McInnes +  snes - the SNES context
1532c7afd0dbSLois Curfman McInnes .  r - vector to store function value
153388f0584fSBarry Smith .  SNESFunction - function evaluation routine
1534c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined context for private data for the
1535c7afd0dbSLois Curfman McInnes          function evaluation routine (may be PETSC_NULL)
15369b94acceSBarry Smith 
15379b94acceSBarry Smith    Notes:
15389b94acceSBarry Smith    The Newton-like methods typically solve linear systems of the form
15399b94acceSBarry Smith $      f'(x) x = -f(x),
1540c7afd0dbSLois Curfman McInnes    where f'(x) denotes the Jacobian matrix and f(x) is the function.
15419b94acceSBarry Smith 
154236851e7fSLois Curfman McInnes    Level: beginner
154336851e7fSLois Curfman McInnes 
15449b94acceSBarry Smith .keywords: SNES, nonlinear, set, function
15459b94acceSBarry Smith 
1546bf388a1fSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetPicard(), SNESFunction
15479b94acceSBarry Smith @*/
154888f0584fSBarry Smith PetscErrorCode  SNESSetFunction(SNES snes,Vec r,PetscErrorCode (*SNESFunction)(SNES,Vec,Vec,void*),void *ctx)
15499b94acceSBarry Smith {
155085385478SLisandro Dalcin   PetscErrorCode ierr;
15516cab3a1bSJed Brown   DM             dm;
15526cab3a1bSJed Brown 
15533a40ed3dSBarry Smith   PetscFunctionBegin;
15540700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1555d2a683ecSLisandro Dalcin   if (r) {
1556d2a683ecSLisandro Dalcin     PetscValidHeaderSpecific(r,VEC_CLASSID,2);
1557d2a683ecSLisandro Dalcin     PetscCheckSameComm(snes,1,r,2);
155885385478SLisandro Dalcin     ierr = PetscObjectReference((PetscObject)r);CHKERRQ(ierr);
15596bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr);
156085385478SLisandro Dalcin     snes->vec_func = r;
1561d2a683ecSLisandro Dalcin   }
15626cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
156388f0584fSBarry Smith   ierr = DMSNESSetFunction(dm,SNESFunction,ctx);CHKERRQ(ierr);
15643a40ed3dSBarry Smith   PetscFunctionReturn(0);
15659b94acceSBarry Smith }
15669b94acceSBarry Smith 
1567646217ecSPeter Brune 
1568646217ecSPeter Brune #undef __FUNCT__
1569e4ed7901SPeter Brune #define __FUNCT__ "SNESSetInitialFunction"
1570e4ed7901SPeter Brune /*@C
1571e4ed7901SPeter Brune    SNESSetInitialFunction - Sets the function vector to be used as the
1572e4ed7901SPeter Brune    function norm at the initialization of the method.  In some
1573e4ed7901SPeter Brune    instances, the user has precomputed the function before calling
1574e4ed7901SPeter Brune    SNESSolve.  This function allows one to avoid a redundant call
1575e4ed7901SPeter Brune    to SNESComputeFunction in that case.
1576e4ed7901SPeter Brune 
1577e4ed7901SPeter Brune    Logically Collective on SNES
1578e4ed7901SPeter Brune 
1579e4ed7901SPeter Brune    Input Parameters:
1580e4ed7901SPeter Brune +  snes - the SNES context
1581e4ed7901SPeter Brune -  f - vector to store function value
1582e4ed7901SPeter Brune 
1583e4ed7901SPeter Brune    Notes:
1584e4ed7901SPeter Brune    This should not be modified during the solution procedure.
1585e4ed7901SPeter Brune 
1586e4ed7901SPeter Brune    This is used extensively in the SNESFAS hierarchy and in nonlinear preconditioning.
1587e4ed7901SPeter Brune 
1588e4ed7901SPeter Brune    Level: developer
1589e4ed7901SPeter Brune 
1590e4ed7901SPeter Brune .keywords: SNES, nonlinear, set, function
1591e4ed7901SPeter Brune 
1592e4ed7901SPeter Brune .seealso: SNESSetFunction(), SNESComputeFunction(), SNESSetInitialFunctionNorm()
1593e4ed7901SPeter Brune @*/
1594e4ed7901SPeter Brune PetscErrorCode  SNESSetInitialFunction(SNES snes, Vec f)
1595e4ed7901SPeter Brune {
1596e4ed7901SPeter Brune   PetscErrorCode ierr;
1597e4ed7901SPeter Brune   Vec            vec_func;
1598e4ed7901SPeter Brune 
1599e4ed7901SPeter Brune   PetscFunctionBegin;
1600e4ed7901SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1601e4ed7901SPeter Brune   PetscValidHeaderSpecific(f,VEC_CLASSID,2);
1602e4ed7901SPeter Brune   PetscCheckSameComm(snes,1,f,2);
1603e4ed7901SPeter Brune   ierr = SNESGetFunction(snes,&vec_func,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
1604e4ed7901SPeter Brune   ierr = VecCopy(f, vec_func);CHKERRQ(ierr);
1605217b9c2eSPeter Brune   snes->vec_func_init_set = PETSC_TRUE;
1606e4ed7901SPeter Brune   PetscFunctionReturn(0);
1607e4ed7901SPeter Brune }
1608e4ed7901SPeter Brune 
1609e4ed7901SPeter Brune 
1610e4ed7901SPeter Brune #undef __FUNCT__
1611e4ed7901SPeter Brune #define __FUNCT__ "SNESSetInitialFunctionNorm"
1612e4ed7901SPeter Brune /*@C
1613e4ed7901SPeter Brune    SNESSetInitialFunctionNorm - Sets the function norm to be used as the function norm
1614e4ed7901SPeter Brune    at the initialization of the  method.  In some instances, the user has precomputed
1615e4ed7901SPeter Brune    the function and its norm before calling SNESSolve.  This function allows one to
1616e4ed7901SPeter Brune    avoid a redundant call to SNESComputeFunction() and VecNorm() in that case.
1617e4ed7901SPeter Brune 
1618e4ed7901SPeter Brune    Logically Collective on SNES
1619e4ed7901SPeter Brune 
1620e4ed7901SPeter Brune    Input Parameters:
1621e4ed7901SPeter Brune +  snes - the SNES context
1622e4ed7901SPeter Brune -  fnorm - the norm of F as set by SNESSetInitialFunction()
1623e4ed7901SPeter Brune 
1624e4ed7901SPeter Brune    This is used extensively in the SNESFAS hierarchy and in nonlinear preconditioning.
1625e4ed7901SPeter Brune 
1626e4ed7901SPeter Brune    Level: developer
1627e4ed7901SPeter Brune 
1628e4ed7901SPeter Brune .keywords: SNES, nonlinear, set, function, norm
1629e4ed7901SPeter Brune 
1630e4ed7901SPeter Brune .seealso: SNESSetFunction(), SNESComputeFunction(), SNESSetInitialFunction()
1631e4ed7901SPeter Brune @*/
1632e4ed7901SPeter Brune PetscErrorCode  SNESSetInitialFunctionNorm(SNES snes, PetscReal fnorm)
1633e4ed7901SPeter Brune {
1634e4ed7901SPeter Brune   PetscFunctionBegin;
1635e4ed7901SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1636e4ed7901SPeter Brune   snes->norm_init = fnorm;
1637e4ed7901SPeter Brune   snes->norm_init_set = PETSC_TRUE;
1638e4ed7901SPeter Brune   PetscFunctionReturn(0);
1639e4ed7901SPeter Brune }
1640e4ed7901SPeter Brune 
1641e4ed7901SPeter Brune #undef __FUNCT__
1642534ebe21SPeter Brune #define __FUNCT__ "SNESSetNormType"
1643534ebe21SPeter Brune /*@
1644534ebe21SPeter Brune    SNESSetNormType - Sets the SNESNormType used in covergence and monitoring
1645534ebe21SPeter Brune    of the SNES method.
1646534ebe21SPeter Brune 
1647534ebe21SPeter Brune    Logically Collective on SNES
1648534ebe21SPeter Brune 
1649534ebe21SPeter Brune    Input Parameters:
1650534ebe21SPeter Brune +  snes - the SNES context
1651534ebe21SPeter Brune -  normtype - the type of the norm used
1652534ebe21SPeter Brune 
1653534ebe21SPeter Brune    Notes:
1654534ebe21SPeter Brune    Only certain SNES methods support certain SNESNormTypes.  Most require evaluation
1655534ebe21SPeter Brune    of the nonlinear function and the taking of its norm at every iteration to
1656534ebe21SPeter Brune    even ensure convergence at all.  However, methods such as custom Gauss-Seidel methods
1657534ebe21SPeter Brune    (SNESGS) and the like do not require the norm of the function to be computed, and therfore
1658534ebe21SPeter Brune    may either be monitored for convergence or not.  As these are often used as nonlinear
1659534ebe21SPeter Brune    preconditioners, monitoring the norm of their error is not a useful enterprise within
1660534ebe21SPeter Brune    their solution.
1661534ebe21SPeter Brune 
1662534ebe21SPeter Brune    Level: developer
1663534ebe21SPeter Brune 
1664534ebe21SPeter Brune .keywords: SNES, nonlinear, set, function, norm, type
1665534ebe21SPeter Brune 
1666534ebe21SPeter Brune .seealso: SNESGetNormType(), SNESComputeFunction(), VecNorm(), SNESSetFunction(), SNESSetInitialFunction(), SNESNormType
1667534ebe21SPeter Brune @*/
1668534ebe21SPeter Brune PetscErrorCode  SNESSetNormType(SNES snes, SNESNormType normtype)
1669534ebe21SPeter Brune {
1670534ebe21SPeter Brune   PetscFunctionBegin;
1671534ebe21SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1672534ebe21SPeter Brune   snes->normtype = normtype;
1673534ebe21SPeter Brune   PetscFunctionReturn(0);
1674534ebe21SPeter Brune }
1675534ebe21SPeter Brune 
1676534ebe21SPeter Brune 
1677534ebe21SPeter Brune #undef __FUNCT__
1678534ebe21SPeter Brune #define __FUNCT__ "SNESGetNormType"
1679534ebe21SPeter Brune /*@
1680534ebe21SPeter Brune    SNESGetNormType - Gets the SNESNormType used in covergence and monitoring
1681534ebe21SPeter Brune    of the SNES method.
1682534ebe21SPeter Brune 
1683534ebe21SPeter Brune    Logically Collective on SNES
1684534ebe21SPeter Brune 
1685534ebe21SPeter Brune    Input Parameters:
1686534ebe21SPeter Brune +  snes - the SNES context
1687534ebe21SPeter Brune -  normtype - the type of the norm used
1688534ebe21SPeter Brune 
1689534ebe21SPeter Brune    Level: advanced
1690534ebe21SPeter Brune 
1691534ebe21SPeter Brune .keywords: SNES, nonlinear, set, function, norm, type
1692534ebe21SPeter Brune 
1693534ebe21SPeter Brune .seealso: SNESSetNormType(), SNESComputeFunction(), VecNorm(), SNESSetFunction(), SNESSetInitialFunction(), SNESNormType
1694534ebe21SPeter Brune @*/
1695534ebe21SPeter Brune PetscErrorCode  SNESGetNormType(SNES snes, SNESNormType *normtype)
1696534ebe21SPeter Brune {
1697534ebe21SPeter Brune   PetscFunctionBegin;
1698534ebe21SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1699534ebe21SPeter Brune   *normtype = snes->normtype;
1700534ebe21SPeter Brune   PetscFunctionReturn(0);
1701534ebe21SPeter Brune }
1702534ebe21SPeter Brune 
1703bf388a1fSBarry Smith /*MC
1704bf388a1fSBarry Smith     SNESGSFunction - function used to convey a Gauss-Seidel sweep on the nonlinear function
1705bf388a1fSBarry Smith 
1706bf388a1fSBarry Smith      Synopsis:
1707bf388a1fSBarry Smith      #include "petscsnes.h"
1708bf388a1fSBarry Smith $    SNESGSFunction(SNES snes,Vec x,Vec b,void *ctx);
1709bf388a1fSBarry Smith 
1710bf388a1fSBarry Smith +  X   - solution vector
1711bf388a1fSBarry Smith .  B   - RHS vector
1712bf388a1fSBarry Smith -  ctx - optional user-defined Gauss-Seidel context
1713bf388a1fSBarry Smith 
1714bf388a1fSBarry Smith .seealso:   SNESSetGS(), SNESGetGS()
1715bf388a1fSBarry Smith M*/
1716bf388a1fSBarry Smith 
1717534ebe21SPeter Brune #undef __FUNCT__
1718646217ecSPeter Brune #define __FUNCT__ "SNESSetGS"
1719c79ef259SPeter Brune /*@C
1720c79ef259SPeter Brune    SNESSetGS - Sets the user nonlinear Gauss-Seidel routine for
1721c79ef259SPeter Brune    use with composed nonlinear solvers.
1722c79ef259SPeter Brune 
1723c79ef259SPeter Brune    Input Parameters:
1724c79ef259SPeter Brune +  snes   - the SNES context
1725bf388a1fSBarry Smith .  SNESGSFunction - function evaluation routine
1726c79ef259SPeter Brune -  ctx    - [optional] user-defined context for private data for the
1727c79ef259SPeter Brune             smoother evaluation routine (may be PETSC_NULL)
1728c79ef259SPeter Brune 
1729c79ef259SPeter Brune    Notes:
1730c79ef259SPeter Brune    The GS routines are used by the composed nonlinear solver to generate
1731c79ef259SPeter Brune     a problem appropriate update to the solution, particularly FAS.
1732c79ef259SPeter Brune 
1733d28543b3SPeter Brune    Level: intermediate
1734c79ef259SPeter Brune 
1735d28543b3SPeter Brune .keywords: SNES, nonlinear, set, Gauss-Seidel
1736c79ef259SPeter Brune 
1737c79ef259SPeter Brune .seealso: SNESGetFunction(), SNESComputeGS()
1738c79ef259SPeter Brune @*/
1739bf388a1fSBarry Smith PetscErrorCode SNESSetGS(SNES snes,PetscErrorCode (*SNESGSFunction)(SNES,Vec,Vec,void*),void *ctx)
17406cab3a1bSJed Brown {
17416cab3a1bSJed Brown   PetscErrorCode ierr;
17426cab3a1bSJed Brown   DM             dm;
17436cab3a1bSJed Brown 
1744646217ecSPeter Brune   PetscFunctionBegin;
17456cab3a1bSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
17466cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
1747bf388a1fSBarry Smith   ierr = DMSNESSetGS(dm,SNESGSFunction,ctx);CHKERRQ(ierr);
1748646217ecSPeter Brune   PetscFunctionReturn(0);
1749646217ecSPeter Brune }
1750646217ecSPeter Brune 
1751d25893d9SBarry Smith #undef __FUNCT__
17528b0a5094SBarry Smith #define __FUNCT__ "SNESPicardComputeFunction"
17538b0a5094SBarry Smith PetscErrorCode  SNESPicardComputeFunction(SNES snes,Vec x,Vec f,void *ctx)
17548b0a5094SBarry Smith {
17558b0a5094SBarry Smith   PetscErrorCode ierr;
1756e03ab78fSPeter Brune   DM             dm;
1757942e3340SBarry Smith   DMSNES         sdm;
17586cab3a1bSJed Brown 
17598b0a5094SBarry Smith   PetscFunctionBegin;
1760e03ab78fSPeter Brune   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
1761942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
17628b0a5094SBarry Smith   /*  A(x)*x - b(x) */
176322c6f798SBarry Smith   if (sdm->ops->computepfunction) {
176422c6f798SBarry Smith     ierr = (*sdm->ops->computepfunction)(snes,x,f,sdm->pctx);CHKERRQ(ierr);
176522c6f798SBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetPicard() to provide Picard function.");
1766e03ab78fSPeter Brune 
176722c6f798SBarry Smith   if (sdm->ops->computepjacobian) {
176822c6f798SBarry Smith     ierr = (*sdm->ops->computepjacobian)(snes,x,&snes->jacobian,&snes->jacobian_pre,&snes->matstruct,sdm->pctx);CHKERRQ(ierr);
176974e1e8c1SBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetPicard() to provide Picard matrix.");
17708b0a5094SBarry Smith   ierr = VecScale(f,-1.0);CHKERRQ(ierr);
177195eabcedSBarry Smith   ierr = MatMultAdd(snes->jacobian,x,f,f);CHKERRQ(ierr);
17728b0a5094SBarry Smith   PetscFunctionReturn(0);
17738b0a5094SBarry Smith }
17748b0a5094SBarry Smith 
17758b0a5094SBarry Smith #undef __FUNCT__
17768b0a5094SBarry Smith #define __FUNCT__ "SNESPicardComputeJacobian"
17778b0a5094SBarry Smith PetscErrorCode  SNESPicardComputeJacobian(SNES snes,Vec x1,Mat *J,Mat *B,MatStructure *flag,void *ctx)
17788b0a5094SBarry Smith {
17798b0a5094SBarry Smith   PetscFunctionBegin;
1780e03ab78fSPeter Brune   /* the jacobian matrix should be pre-filled in SNESPicardComputeFunction */
17818b0a5094SBarry Smith   *flag = snes->matstruct;
17828b0a5094SBarry Smith   PetscFunctionReturn(0);
17838b0a5094SBarry Smith }
17848b0a5094SBarry Smith 
17858b0a5094SBarry Smith #undef __FUNCT__
17868b0a5094SBarry Smith #define __FUNCT__ "SNESSetPicard"
17878b0a5094SBarry Smith /*@C
17880d04baf8SBarry Smith    SNESSetPicard - Use SNES to solve the semilinear-system A(x) x = b(x) via a Picard type iteration (Picard linearization)
17898b0a5094SBarry Smith 
17908b0a5094SBarry Smith    Logically Collective on SNES
17918b0a5094SBarry Smith 
17928b0a5094SBarry Smith    Input Parameters:
17938b0a5094SBarry Smith +  snes - the SNES context
17948b0a5094SBarry Smith .  r - vector to store function value
1795bf388a1fSBarry Smith .  SNESFunction - function evaluation routine
1796f450aa47SBarry Smith .  jmat - normally the same as mat but you can pass another matrix for which you compute A(x) x - b(x) (see jmat below)
17978b0a5094SBarry Smith .  mat - matrix to store A
1798bf388a1fSBarry Smith .  SNESJacobianFunction  - function to compute matrix value
17998b0a5094SBarry Smith -  ctx - [optional] user-defined context for private data for the
18008b0a5094SBarry Smith          function evaluation routine (may be PETSC_NULL)
18018b0a5094SBarry Smith 
18028b0a5094SBarry Smith    Notes:
1803f450aa47SBarry Smith     We do not recomemend using this routine. It is far better to provide the nonlinear function F() and some approximation to the Jacobian and use
1804f450aa47SBarry Smith     an approximate Newton solver. This interface is provided to allow porting/testing a previous Picard based code in PETSc before converting it to approximate Newton.
1805f450aa47SBarry Smith 
18068b0a5094SBarry Smith     One can call SNESSetPicard() or SNESSetFunction() (and possibly SNESSetJacobian()) but cannot call both
18078b0a5094SBarry Smith 
18088b0a5094SBarry Smith $     Solves the equation A(x) x = b(x) via the defect correction algorithm A(x^{n}) (x^{n+1} - x^{n}) = b(x^{n}) - A(x^{n})x^{n}
18098b0a5094SBarry Smith $     Note that when an exact solver is used this corresponds to the "classic" Picard A(x^{n}) x^{n+1} = b(x^{n}) iteration.
18108b0a5094SBarry Smith 
18118b0a5094SBarry Smith      Run with -snes_mf_operator to solve the system with Newton's method using A(x^{n}) to construct the preconditioner.
18128b0a5094SBarry Smith 
18130d04baf8SBarry Smith    We implement the defect correction form of the Picard iteration because it converges much more generally when inexact linear solvers are used then
18140d04baf8SBarry Smith    the direct Picard iteration A(x^n) x^{n+1} = b(x^n)
18158b0a5094SBarry Smith 
18168b0a5094SBarry Smith    There is some controversity over the definition of a Picard iteration for nonlinear systems but almost everyone agrees that it involves a linear solve and some
18178b0a5094SBarry Smith    believe it is the iteration  A(x^{n}) x^{n+1} = b(x^{n}) hence we use the name Picard. If anyone has an authoritative  reference that defines the Picard iteration
18188b0a5094SBarry Smith    different please contact us at petsc-dev@mcs.anl.gov and we'll have an entirely new argument :-).
18198b0a5094SBarry Smith 
1820f450aa47SBarry Smith    Level: intermediate
18218b0a5094SBarry Smith 
18228b0a5094SBarry Smith .keywords: SNES, nonlinear, set, function
18238b0a5094SBarry Smith 
18240d04baf8SBarry Smith .seealso: SNESGetFunction(), SNESSetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESGetPicard(), SNESLineSearchPreCheckPicard()
18258b0a5094SBarry Smith @*/
1826bf388a1fSBarry Smith PetscErrorCode  SNESSetPicard(SNES snes,Vec r,PetscErrorCode (*SNESFunction)(SNES,Vec,Vec,void*),Mat jmat, Mat mat, PetscErrorCode (*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *ctx)
18278b0a5094SBarry Smith {
18288b0a5094SBarry Smith   PetscErrorCode ierr;
1829e03ab78fSPeter Brune   DM             dm;
1830e03ab78fSPeter Brune 
18318b0a5094SBarry Smith   PetscFunctionBegin;
18328b0a5094SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1833e03ab78fSPeter Brune   ierr = SNESGetDM(snes, &dm);CHKERRQ(ierr);
1834bf388a1fSBarry Smith   ierr = DMSNESSetPicard(dm,SNESFunction,SNESJacobianFunction,ctx);CHKERRQ(ierr);
18358b0a5094SBarry Smith   ierr = SNESSetFunction(snes,r,SNESPicardComputeFunction,ctx);CHKERRQ(ierr);
18368b0a5094SBarry Smith   ierr = SNESSetJacobian(snes,jmat,mat,SNESPicardComputeJacobian,ctx);CHKERRQ(ierr);
18378b0a5094SBarry Smith   PetscFunctionReturn(0);
18388b0a5094SBarry Smith }
18398b0a5094SBarry Smith 
18407971a8bfSPeter Brune #undef __FUNCT__
18417971a8bfSPeter Brune #define __FUNCT__ "SNESGetPicard"
18427971a8bfSPeter Brune /*@C
18437971a8bfSPeter Brune    SNESGetPicard - Returns the context for the Picard iteration
18447971a8bfSPeter Brune 
18457971a8bfSPeter Brune    Not Collective, but Vec is parallel if SNES is parallel. Collective if Vec is requested, but has not been created yet.
18467971a8bfSPeter Brune 
18477971a8bfSPeter Brune    Input Parameter:
18487971a8bfSPeter Brune .  snes - the SNES context
18497971a8bfSPeter Brune 
18507971a8bfSPeter Brune    Output Parameter:
18517971a8bfSPeter Brune +  r - the function (or PETSC_NULL)
1852bf388a1fSBarry Smith .  SNESFunction - the function (or PETSC_NULL)
18537971a8bfSPeter Brune .  jmat - the picard matrix (or PETSC_NULL)
18547971a8bfSPeter Brune .  mat  - the picard preconditioner matrix (or PETSC_NULL)
1855bf388a1fSBarry Smith .  SNESJacobianFunction - the function for matrix evaluation (or PETSC_NULL)
18567971a8bfSPeter Brune -  ctx - the function context (or PETSC_NULL)
18577971a8bfSPeter Brune 
18587971a8bfSPeter Brune    Level: advanced
18597971a8bfSPeter Brune 
18607971a8bfSPeter Brune .keywords: SNES, nonlinear, get, function
18617971a8bfSPeter Brune 
1862bf388a1fSBarry Smith .seealso: SNESSetPicard, SNESGetFunction, SNESGetJacobian, SNESGetDM, SNESFunction, SNESJacobianFunction
18637971a8bfSPeter Brune @*/
1864bf388a1fSBarry Smith PetscErrorCode  SNESGetPicard(SNES snes,Vec *r,PetscErrorCode (**SNESFunction)(SNES,Vec,Vec,void*),Mat *jmat, Mat *mat, PetscErrorCode (**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **ctx)
18657971a8bfSPeter Brune {
18667971a8bfSPeter Brune   PetscErrorCode ierr;
18677971a8bfSPeter Brune   DM             dm;
18687971a8bfSPeter Brune 
18697971a8bfSPeter Brune   PetscFunctionBegin;
18707971a8bfSPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
18717971a8bfSPeter Brune   ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
18727971a8bfSPeter Brune   ierr = SNESGetJacobian(snes,jmat,mat,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
18737971a8bfSPeter Brune   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
1874bf388a1fSBarry Smith   ierr = DMSNESGetPicard(dm,SNESFunction,SNESJacobianFunction,ctx);CHKERRQ(ierr);
18757971a8bfSPeter Brune   PetscFunctionReturn(0);
18767971a8bfSPeter Brune }
18777971a8bfSPeter Brune 
18788b0a5094SBarry Smith #undef __FUNCT__
1879d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeInitialGuess"
1880d25893d9SBarry Smith /*@C
1881d25893d9SBarry Smith    SNESSetComputeInitialGuess - Sets a routine used to compute an initial guess for the problem
1882d25893d9SBarry Smith 
1883d25893d9SBarry Smith    Logically Collective on SNES
1884d25893d9SBarry Smith 
1885d25893d9SBarry Smith    Input Parameters:
1886d25893d9SBarry Smith +  snes - the SNES context
1887d25893d9SBarry Smith .  func - function evaluation routine
1888d25893d9SBarry Smith -  ctx - [optional] user-defined context for private data for the
1889d25893d9SBarry Smith          function evaluation routine (may be PETSC_NULL)
1890d25893d9SBarry Smith 
1891d25893d9SBarry Smith    Calling sequence of func:
1892d25893d9SBarry Smith $    func (SNES snes,Vec x,void *ctx);
1893d25893d9SBarry Smith 
1894d25893d9SBarry Smith .  f - function vector
1895d25893d9SBarry Smith -  ctx - optional user-defined function context
1896d25893d9SBarry Smith 
1897d25893d9SBarry Smith    Level: intermediate
1898d25893d9SBarry Smith 
1899d25893d9SBarry Smith .keywords: SNES, nonlinear, set, function
1900d25893d9SBarry Smith 
1901d25893d9SBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian()
1902d25893d9SBarry Smith @*/
1903d25893d9SBarry Smith PetscErrorCode  SNESSetComputeInitialGuess(SNES snes,PetscErrorCode (*func)(SNES,Vec,void*),void *ctx)
1904d25893d9SBarry Smith {
1905d25893d9SBarry Smith   PetscFunctionBegin;
1906d25893d9SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1907d25893d9SBarry Smith   if (func) snes->ops->computeinitialguess = func;
1908d25893d9SBarry Smith   if (ctx)  snes->initialguessP            = ctx;
1909d25893d9SBarry Smith   PetscFunctionReturn(0);
1910d25893d9SBarry Smith }
1911d25893d9SBarry Smith 
19123ab0aad5SBarry Smith /* --------------------------------------------------------------- */
19133ab0aad5SBarry Smith #undef __FUNCT__
19141096aae1SMatthew Knepley #define __FUNCT__ "SNESGetRhs"
19151096aae1SMatthew Knepley /*@C
19161096aae1SMatthew Knepley    SNESGetRhs - Gets the vector for solving F(x) = rhs. If rhs is not set
19171096aae1SMatthew Knepley    it assumes a zero right hand side.
19181096aae1SMatthew Knepley 
19193f9fe445SBarry Smith    Logically Collective on SNES
19201096aae1SMatthew Knepley 
19211096aae1SMatthew Knepley    Input Parameter:
19221096aae1SMatthew Knepley .  snes - the SNES context
19231096aae1SMatthew Knepley 
19241096aae1SMatthew Knepley    Output Parameter:
1925bc08b0f1SBarry Smith .  rhs - the right hand side vector or PETSC_NULL if the right hand side vector is null
19261096aae1SMatthew Knepley 
19271096aae1SMatthew Knepley    Level: intermediate
19281096aae1SMatthew Knepley 
19291096aae1SMatthew Knepley .keywords: SNES, nonlinear, get, function, right hand side
19301096aae1SMatthew Knepley 
193185385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
19321096aae1SMatthew Knepley @*/
19337087cfbeSBarry Smith PetscErrorCode  SNESGetRhs(SNES snes,Vec *rhs)
19341096aae1SMatthew Knepley {
19351096aae1SMatthew Knepley   PetscFunctionBegin;
19360700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
19371096aae1SMatthew Knepley   PetscValidPointer(rhs,2);
193885385478SLisandro Dalcin   *rhs = snes->vec_rhs;
19391096aae1SMatthew Knepley   PetscFunctionReturn(0);
19401096aae1SMatthew Knepley }
19411096aae1SMatthew Knepley 
19421096aae1SMatthew Knepley #undef __FUNCT__
19434a2ae208SSatish Balay #define __FUNCT__ "SNESComputeFunction"
19449b94acceSBarry Smith /*@
1945bf388a1fSBarry Smith    SNESComputeFunction - Calls the function that has been set with SNESSetFunction().
19469b94acceSBarry Smith 
1947c7afd0dbSLois Curfman McInnes    Collective on SNES
1948c7afd0dbSLois Curfman McInnes 
19499b94acceSBarry Smith    Input Parameters:
1950c7afd0dbSLois Curfman McInnes +  snes - the SNES context
1951c7afd0dbSLois Curfman McInnes -  x - input vector
19529b94acceSBarry Smith 
19539b94acceSBarry Smith    Output Parameter:
19543638b69dSLois Curfman McInnes .  y - function vector, as set by SNESSetFunction()
19559b94acceSBarry Smith 
19561bffabb2SLois Curfman McInnes    Notes:
195736851e7fSLois Curfman McInnes    SNESComputeFunction() is typically used within nonlinear solvers
195836851e7fSLois Curfman McInnes    implementations, so most users would not generally call this routine
195936851e7fSLois Curfman McInnes    themselves.
196036851e7fSLois Curfman McInnes 
196136851e7fSLois Curfman McInnes    Level: developer
196236851e7fSLois Curfman McInnes 
19639b94acceSBarry Smith .keywords: SNES, nonlinear, compute, function
19649b94acceSBarry Smith 
1965a86d99e1SLois Curfman McInnes .seealso: SNESSetFunction(), SNESGetFunction()
19669b94acceSBarry Smith @*/
19677087cfbeSBarry Smith PetscErrorCode  SNESComputeFunction(SNES snes,Vec x,Vec y)
19689b94acceSBarry Smith {
1969dfbe8321SBarry Smith   PetscErrorCode ierr;
19706cab3a1bSJed Brown   DM             dm;
1971942e3340SBarry Smith   DMSNES         sdm;
19729b94acceSBarry Smith 
19733a40ed3dSBarry Smith   PetscFunctionBegin;
19740700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
19750700a824SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
19760700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
1977c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,x,2);
1978c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,y,3);
19794ec14c9cSBarry Smith   VecValidValues(x,2,PETSC_TRUE);
1980184914b5SBarry Smith 
19816cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
1982942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
1983d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr);
1984c40d0f55SPeter Brune   if (snes->pc && snes->pcside == PC_LEFT) {
1985c40d0f55SPeter Brune     ierr = VecCopy(x,y);CHKERRQ(ierr);
1986c40d0f55SPeter Brune     ierr = SNESSolve(snes->pc,snes->vec_rhs,y);CHKERRQ(ierr);
1987c40d0f55SPeter Brune     ierr = VecAYPX(y,-1.0,x);CHKERRQ(ierr);
198822c6f798SBarry Smith   } else if (sdm->ops->computefunction) {
1989d64ed03dSBarry Smith     PetscStackPush("SNES user function");
199022c6f798SBarry Smith     ierr = (*sdm->ops->computefunction)(snes,x,y,sdm->functionctx);CHKERRQ(ierr);
1991d64ed03dSBarry Smith     PetscStackPop;
1992c90fad12SPeter Brune   } else if (snes->vec_rhs) {
1993c90fad12SPeter Brune     ierr = MatMult(snes->jacobian, x, y);CHKERRQ(ierr);
1994644e2e5bSBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetFunction() or SNESSetDM() before SNESComputeFunction(), likely called from SNESSolve().");
199585385478SLisandro Dalcin   if (snes->vec_rhs) {
199685385478SLisandro Dalcin     ierr = VecAXPY(y,-1.0,snes->vec_rhs);CHKERRQ(ierr);
19973ab0aad5SBarry Smith   }
1998ae3c334cSLois Curfman McInnes   snes->nfuncs++;
1999d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr);
20004ec14c9cSBarry Smith   VecValidValues(y,3,PETSC_FALSE);
20013a40ed3dSBarry Smith   PetscFunctionReturn(0);
20029b94acceSBarry Smith }
20039b94acceSBarry Smith 
20044a2ae208SSatish Balay #undef __FUNCT__
2005646217ecSPeter Brune #define __FUNCT__ "SNESComputeGS"
2006c79ef259SPeter Brune /*@
2007bf388a1fSBarry Smith    SNESComputeGS - Calls the Gauss-Seidel function that has been set with  SNESSetGS().
2008c79ef259SPeter Brune 
2009c79ef259SPeter Brune    Collective on SNES
2010c79ef259SPeter Brune 
2011c79ef259SPeter Brune    Input Parameters:
2012c79ef259SPeter Brune +  snes - the SNES context
2013c79ef259SPeter Brune .  x - input vector
2014c79ef259SPeter Brune -  b - rhs vector
2015c79ef259SPeter Brune 
2016c79ef259SPeter Brune    Output Parameter:
2017c79ef259SPeter Brune .  x - new solution vector
2018c79ef259SPeter Brune 
2019c79ef259SPeter Brune    Notes:
2020c79ef259SPeter Brune    SNESComputeGS() is typically used within composed nonlinear solver
2021c79ef259SPeter Brune    implementations, so most users would not generally call this routine
2022c79ef259SPeter Brune    themselves.
2023c79ef259SPeter Brune 
2024c79ef259SPeter Brune    Level: developer
2025c79ef259SPeter Brune 
2026c79ef259SPeter Brune .keywords: SNES, nonlinear, compute, function
2027c79ef259SPeter Brune 
2028c79ef259SPeter Brune .seealso: SNESSetGS(), SNESComputeFunction()
2029c79ef259SPeter Brune @*/
2030646217ecSPeter Brune PetscErrorCode  SNESComputeGS(SNES snes,Vec b,Vec x)
2031646217ecSPeter Brune {
2032646217ecSPeter Brune   PetscErrorCode ierr;
20336cab3a1bSJed Brown   DM             dm;
2034942e3340SBarry Smith   DMSNES         sdm;
2035646217ecSPeter Brune 
2036646217ecSPeter Brune   PetscFunctionBegin;
2037646217ecSPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2038646217ecSPeter Brune   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
2039646217ecSPeter Brune   if (b) PetscValidHeaderSpecific(b,VEC_CLASSID,3);
2040646217ecSPeter Brune   PetscCheckSameComm(snes,1,x,2);
2041646217ecSPeter Brune   if (b) PetscCheckSameComm(snes,1,b,3);
20424ec14c9cSBarry Smith   if (b) VecValidValues(b,2,PETSC_TRUE);
2043701cf23dSPeter Brune   ierr = PetscLogEventBegin(SNES_GSEval,snes,x,b,0);CHKERRQ(ierr);
20446cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
2045942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
204622c6f798SBarry Smith   if (sdm->ops->computegs) {
2047646217ecSPeter Brune     PetscStackPush("SNES user GS");
204822c6f798SBarry Smith     ierr = (*sdm->ops->computegs)(snes,x,b,sdm->gsctx);CHKERRQ(ierr);
2049646217ecSPeter Brune     PetscStackPop;
2050646217ecSPeter Brune   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetGS() before SNESComputeGS(), likely called from SNESSolve().");
2051701cf23dSPeter Brune   ierr = PetscLogEventEnd(SNES_GSEval,snes,x,b,0);CHKERRQ(ierr);
20524ec14c9cSBarry Smith   VecValidValues(x,3,PETSC_FALSE);
2053646217ecSPeter Brune   PetscFunctionReturn(0);
2054646217ecSPeter Brune }
2055646217ecSPeter Brune 
2056646217ecSPeter Brune #undef __FUNCT__
20574a2ae208SSatish Balay #define __FUNCT__ "SNESComputeJacobian"
205862fef451SLois Curfman McInnes /*@
2059bf388a1fSBarry Smith    SNESComputeJacobian - Computes the Jacobian matrix that has been set with SNESSetJacobian().
206062fef451SLois Curfman McInnes 
2061c7afd0dbSLois Curfman McInnes    Collective on SNES and Mat
2062c7afd0dbSLois Curfman McInnes 
206362fef451SLois Curfman McInnes    Input Parameters:
2064c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2065c7afd0dbSLois Curfman McInnes -  x - input vector
206662fef451SLois Curfman McInnes 
206762fef451SLois Curfman McInnes    Output Parameters:
2068c7afd0dbSLois Curfman McInnes +  A - Jacobian matrix
206962fef451SLois Curfman McInnes .  B - optional preconditioning matrix
20702b668275SBarry Smith -  flag - flag indicating matrix structure (one of, SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER)
2071fee21e36SBarry Smith 
2072e35cf81dSBarry Smith   Options Database Keys:
2073e35cf81dSBarry Smith +    -snes_lag_preconditioner <lag>
2074693365a8SJed Brown .    -snes_lag_jacobian <lag>
2075693365a8SJed Brown .    -snes_compare_explicit - Compare the computed Jacobian to the finite difference Jacobian and output the differences
2076693365a8SJed Brown .    -snes_compare_explicit_draw  - Compare the computed Jacobian to the finite difference Jacobian and draw the result
2077693365a8SJed Brown .    -snes_compare_explicit_contour  - Compare the computed Jacobian to the finite difference Jacobian and draw a contour plot with the result
20784c30e9fbSJed Brown .    -snes_compare_operator  - Make the comparison options above use the operator instead of the preconditioning matrix
2079c01495d3SJed Brown .    -snes_compare_coloring - Compute the finite differece Jacobian using coloring and display norms of difference
2080c01495d3SJed Brown .    -snes_compare_coloring_display - Compute the finite differece Jacobian using coloring and display verbose differences
2081c01495d3SJed Brown .    -snes_compare_coloring_threshold - Display only those matrix entries that differ by more than a given threshold
2082c01495d3SJed Brown .    -snes_compare_coloring_threshold_atol - Absolute tolerance for difference in matrix entries to be displayed by -snes_compare_coloring_threshold
2083c01495d3SJed Brown .    -snes_compare_coloring_threshold_rtol - Relative tolerance for difference in matrix entries to be displayed by -snes_compare_coloring_threshold
20844c30e9fbSJed Brown .    -snes_compare_coloring_draw - Compute the finite differece Jacobian using coloring and draw differences
2085c01495d3SJed Brown -    -snes_compare_coloring_draw_contour - Compute the finite differece Jacobian using coloring and show contours of matrices and differences
2086c01495d3SJed Brown 
2087e35cf81dSBarry Smith 
208862fef451SLois Curfman McInnes    Notes:
208962fef451SLois Curfman McInnes    Most users should not need to explicitly call this routine, as it
209062fef451SLois Curfman McInnes    is used internally within the nonlinear solvers.
209162fef451SLois Curfman McInnes 
209294b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
2093dc5a77f8SLois Curfman McInnes    flag parameter.
209462fef451SLois Curfman McInnes 
209536851e7fSLois Curfman McInnes    Level: developer
209636851e7fSLois Curfman McInnes 
209762fef451SLois Curfman McInnes .keywords: SNES, compute, Jacobian, matrix
209862fef451SLois Curfman McInnes 
2099e35cf81dSBarry Smith .seealso:  SNESSetJacobian(), KSPSetOperators(), MatStructure, SNESSetLagPreconditioner(), SNESSetLagJacobian()
210062fef451SLois Curfman McInnes @*/
21017087cfbeSBarry Smith PetscErrorCode  SNESComputeJacobian(SNES snes,Vec X,Mat *A,Mat *B,MatStructure *flg)
21029b94acceSBarry Smith {
2103dfbe8321SBarry Smith   PetscErrorCode ierr;
2104ace3abfcSBarry Smith   PetscBool      flag;
21056cab3a1bSJed Brown   DM             dm;
2106942e3340SBarry Smith   DMSNES         sdm;
21073a40ed3dSBarry Smith 
21083a40ed3dSBarry Smith   PetscFunctionBegin;
21090700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
21100700a824SBarry Smith   PetscValidHeaderSpecific(X,VEC_CLASSID,2);
21114482741eSBarry Smith   PetscValidPointer(flg,5);
2112c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,X,2);
21134ec14c9cSBarry Smith   VecValidValues(X,2,PETSC_TRUE);
21146cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
2115942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
21163232da50SPeter Brune 
211722c6f798SBarry Smith   if (!sdm->ops->computejacobian) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_USER,"Must call SNESSetJacobian(), DMSNESSetJacobian(), DMDASNESSetJacobianLocal(), etc");
2118ebd3b9afSBarry Smith 
2119ebd3b9afSBarry Smith   /* make sure that MatAssemblyBegin/End() is called on A matrix if it is matrix free */
2120ebd3b9afSBarry Smith 
2121fe3ffe1eSBarry Smith   if (snes->lagjacobian == -2) {
2122fe3ffe1eSBarry Smith     snes->lagjacobian = -1;
2123fe3ffe1eSBarry Smith     ierr = PetscInfo(snes,"Recomputing Jacobian/preconditioner because lag is -2 (means compute Jacobian, but then never again) \n");CHKERRQ(ierr);
2124fe3ffe1eSBarry Smith   } else if (snes->lagjacobian == -1) {
2125e35cf81dSBarry Smith     *flg = SAME_PRECONDITIONER;
2126e35cf81dSBarry Smith     ierr = PetscInfo(snes,"Reusing Jacobian/preconditioner because lag is -1\n");CHKERRQ(ierr);
2127251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr);
2128ebd3b9afSBarry Smith     if (flag) {
2129ebd3b9afSBarry Smith       ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
2130ebd3b9afSBarry Smith       ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
2131ebd3b9afSBarry Smith     }
2132e35cf81dSBarry Smith     PetscFunctionReturn(0);
2133e35cf81dSBarry Smith   } else if (snes->lagjacobian > 1 && snes->iter % snes->lagjacobian) {
2134e35cf81dSBarry Smith     *flg = SAME_PRECONDITIONER;
2135e35cf81dSBarry Smith     ierr = PetscInfo2(snes,"Reusing Jacobian/preconditioner because lag is %D and SNES iteration is %D\n",snes->lagjacobian,snes->iter);CHKERRQ(ierr);
2136251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr);
2137ebd3b9afSBarry Smith     if (flag) {
2138ebd3b9afSBarry Smith       ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
2139ebd3b9afSBarry Smith       ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
2140ebd3b9afSBarry Smith     }
2141e35cf81dSBarry Smith     PetscFunctionReturn(0);
2142e35cf81dSBarry Smith   }
2143e35cf81dSBarry Smith 
2144c4fc05e7SBarry Smith   *flg = DIFFERENT_NONZERO_PATTERN;
2145e35cf81dSBarry Smith   ierr = PetscLogEventBegin(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr);
21463232da50SPeter Brune 
2147d64ed03dSBarry Smith   PetscStackPush("SNES user Jacobian function");
214822c6f798SBarry Smith   ierr = (*sdm->ops->computejacobian)(snes,X,A,B,flg,sdm->jacobianctx);CHKERRQ(ierr);
2149d64ed03dSBarry Smith   PetscStackPop;
21503232da50SPeter Brune 
2151d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr);
2152a8054027SBarry Smith 
21533b4f5425SBarry Smith   if (snes->lagpreconditioner == -2) {
21543b4f5425SBarry Smith     ierr = PetscInfo(snes,"Rebuilding preconditioner exactly once since lag is -2\n");CHKERRQ(ierr);
21553b4f5425SBarry Smith     snes->lagpreconditioner = -1;
21563b4f5425SBarry Smith   } else if (snes->lagpreconditioner == -1) {
2157a8054027SBarry Smith     *flg = SAME_PRECONDITIONER;
2158a8054027SBarry Smith     ierr = PetscInfo(snes,"Reusing preconditioner because lag is -1\n");CHKERRQ(ierr);
2159a8054027SBarry Smith   } else if (snes->lagpreconditioner > 1 && snes->iter % snes->lagpreconditioner) {
2160a8054027SBarry Smith     *flg = SAME_PRECONDITIONER;
2161a8054027SBarry Smith     ierr = PetscInfo2(snes,"Reusing preconditioner because lag is %D and SNES iteration is %D\n",snes->lagpreconditioner,snes->iter);CHKERRQ(ierr);
2162a8054027SBarry Smith   }
2163a8054027SBarry Smith 
21646d84be18SBarry Smith   /* make sure user returned a correct Jacobian and preconditioner */
21650700a824SBarry Smith   /* PetscValidHeaderSpecific(*A,MAT_CLASSID,3);
21660700a824SBarry Smith     PetscValidHeaderSpecific(*B,MAT_CLASSID,4);   */
2167693365a8SJed Brown   {
2168693365a8SJed Brown     PetscBool flag = PETSC_FALSE,flag_draw = PETSC_FALSE,flag_contour = PETSC_FALSE,flag_operator = PETSC_FALSE;
2169693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit",&flag,PETSC_NULL);CHKERRQ(ierr);
2170693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw",&flag_draw,PETSC_NULL);CHKERRQ(ierr);
2171693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw_contour",&flag_contour,PETSC_NULL);CHKERRQ(ierr);
2172693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_operator",&flag_operator,PETSC_NULL);CHKERRQ(ierr);
2173693365a8SJed Brown     if (flag || flag_draw || flag_contour) {
2174693365a8SJed Brown       Mat Bexp_mine = PETSC_NULL,Bexp,FDexp;
2175693365a8SJed Brown       MatStructure mstruct;
2176693365a8SJed Brown       PetscViewer vdraw,vstdout;
21776b3a5b13SJed Brown       PetscBool flg;
2178693365a8SJed Brown       if (flag_operator) {
2179693365a8SJed Brown         ierr = MatComputeExplicitOperator(*A,&Bexp_mine);CHKERRQ(ierr);
2180693365a8SJed Brown         Bexp = Bexp_mine;
2181693365a8SJed Brown       } else {
2182693365a8SJed Brown         /* See if the preconditioning matrix can be viewed and added directly */
2183251f4c67SDmitry Karpeev         ierr = PetscObjectTypeCompareAny((PetscObject)*B,&flg,MATSEQAIJ,MATMPIAIJ,MATSEQDENSE,MATMPIDENSE,MATSEQBAIJ,MATMPIBAIJ,MATSEQSBAIJ,MATMPIBAIJ,"");CHKERRQ(ierr);
2184693365a8SJed Brown         if (flg) Bexp = *B;
2185693365a8SJed Brown         else {
2186693365a8SJed Brown           /* If the "preconditioning" matrix is itself MATSHELL or some other type without direct support */
2187693365a8SJed Brown           ierr = MatComputeExplicitOperator(*B,&Bexp_mine);CHKERRQ(ierr);
2188693365a8SJed Brown           Bexp = Bexp_mine;
2189693365a8SJed Brown         }
2190693365a8SJed Brown       }
2191693365a8SJed Brown       ierr = MatConvert(Bexp,MATSAME,MAT_INITIAL_MATRIX,&FDexp);CHKERRQ(ierr);
2192693365a8SJed Brown       ierr = SNESDefaultComputeJacobian(snes,X,&FDexp,&FDexp,&mstruct,NULL);CHKERRQ(ierr);
2193693365a8SJed Brown       ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&vstdout);CHKERRQ(ierr);
2194693365a8SJed Brown       if (flag_draw || flag_contour) {
2195693365a8SJed Brown         ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,0,"Explicit Jacobians",PETSC_DECIDE,PETSC_DECIDE,300,300,&vdraw);CHKERRQ(ierr);
2196693365a8SJed Brown         if (flag_contour) {ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);}
2197693365a8SJed Brown       } else vdraw = PETSC_NULL;
2198693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Explicit %s\n",flag_operator?"Jacobian":"preconditioning Jacobian");CHKERRQ(ierr);
2199693365a8SJed Brown       if (flag) {ierr = MatView(Bexp,vstdout);CHKERRQ(ierr);}
2200693365a8SJed Brown       if (vdraw) {ierr = MatView(Bexp,vdraw);CHKERRQ(ierr);}
2201693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Finite difference Jacobian\n");CHKERRQ(ierr);
2202693365a8SJed Brown       if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);}
2203693365a8SJed Brown       if (vdraw) {ierr = MatView(FDexp,vdraw);CHKERRQ(ierr);}
2204693365a8SJed Brown       ierr = MatAYPX(FDexp,-1.0,Bexp,SAME_NONZERO_PATTERN);CHKERRQ(ierr);
2205693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"User-provided matrix minus finite difference Jacobian\n");CHKERRQ(ierr);
2206693365a8SJed Brown       if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);}
2207693365a8SJed Brown       if (vdraw) {              /* Always use contour for the difference */
2208693365a8SJed Brown         ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);
2209693365a8SJed Brown         ierr = MatView(FDexp,vdraw);CHKERRQ(ierr);
2210693365a8SJed Brown         ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);
2211693365a8SJed Brown       }
2212693365a8SJed Brown       if (flag_contour) {ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);}
2213693365a8SJed Brown       ierr = PetscViewerDestroy(&vdraw);CHKERRQ(ierr);
2214693365a8SJed Brown       ierr = MatDestroy(&Bexp_mine);CHKERRQ(ierr);
2215693365a8SJed Brown       ierr = MatDestroy(&FDexp);CHKERRQ(ierr);
2216693365a8SJed Brown     }
2217693365a8SJed Brown   }
22184c30e9fbSJed Brown   {
22196719d8e4SJed Brown     PetscBool flag = PETSC_FALSE,flag_display = PETSC_FALSE,flag_draw = PETSC_FALSE,flag_contour = PETSC_FALSE,flag_threshold = PETSC_FALSE;
22206719d8e4SJed Brown     PetscReal threshold_atol = PETSC_SQRT_MACHINE_EPSILON,threshold_rtol = 10*PETSC_SQRT_MACHINE_EPSILON;
22214c30e9fbSJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring",&flag,PETSC_NULL);CHKERRQ(ierr);
22226719d8e4SJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_display",&flag_display,PETSC_NULL);CHKERRQ(ierr);
22234c30e9fbSJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_draw",&flag_draw,PETSC_NULL);CHKERRQ(ierr);
22244c30e9fbSJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_draw_contour",&flag_contour,PETSC_NULL);CHKERRQ(ierr);
22256719d8e4SJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold",&flag_threshold,PETSC_NULL);CHKERRQ(ierr);
22266719d8e4SJed Brown     ierr = PetscOptionsGetReal(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold_rtol",&threshold_rtol,PETSC_NULL);CHKERRQ(ierr);
22276719d8e4SJed Brown     ierr = PetscOptionsGetReal(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold_atol",&threshold_atol,PETSC_NULL);CHKERRQ(ierr);
22286719d8e4SJed Brown     if (flag || flag_display || flag_draw || flag_contour || flag_threshold) {
22294c30e9fbSJed Brown       Mat            Bfd;
22304c30e9fbSJed Brown       MatStructure   mstruct;
22314c30e9fbSJed Brown       PetscViewer    vdraw,vstdout;
22324c30e9fbSJed Brown       ISColoring     iscoloring;
22334c30e9fbSJed Brown       MatFDColoring  matfdcoloring;
22344c30e9fbSJed Brown       PetscErrorCode (*func)(SNES,Vec,Vec,void*);
22354c30e9fbSJed Brown       void           *funcctx;
22366719d8e4SJed Brown       PetscReal      norm1,norm2,normmax;
22374c30e9fbSJed Brown 
22384c30e9fbSJed Brown       ierr = MatDuplicate(*B,MAT_DO_NOT_COPY_VALUES,&Bfd);CHKERRQ(ierr);
22394c30e9fbSJed Brown       ierr = MatGetColoring(Bfd,MATCOLORINGSL,&iscoloring);CHKERRQ(ierr);
22404c30e9fbSJed Brown       ierr = MatFDColoringCreate(Bfd,iscoloring,&matfdcoloring);CHKERRQ(ierr);
22414c30e9fbSJed Brown       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
22424c30e9fbSJed Brown 
22434c30e9fbSJed Brown       /* This method of getting the function is currently unreliable since it doesn't work for DM local functions. */
22444c30e9fbSJed Brown       ierr = SNESGetFunction(snes,PETSC_NULL,&func,&funcctx);CHKERRQ(ierr);
22454c30e9fbSJed Brown         ierr = MatFDColoringSetFunction(matfdcoloring,(PetscErrorCode(*)(void))func,funcctx);CHKERRQ(ierr);
22464c30e9fbSJed Brown         ierr = PetscObjectSetOptionsPrefix((PetscObject)matfdcoloring,((PetscObject)snes)->prefix);CHKERRQ(ierr);
22474c30e9fbSJed Brown         ierr = PetscObjectAppendOptionsPrefix((PetscObject)matfdcoloring,"coloring_");CHKERRQ(ierr);
22484c30e9fbSJed Brown         ierr = MatFDColoringSetFromOptions(matfdcoloring);CHKERRQ(ierr);
22494c30e9fbSJed Brown         ierr = MatFDColoringApply(Bfd,matfdcoloring,X,&mstruct,snes);CHKERRQ(ierr);
22504c30e9fbSJed Brown         ierr = MatFDColoringDestroy(&matfdcoloring);CHKERRQ(ierr);
22514c30e9fbSJed Brown 
22524c30e9fbSJed Brown       ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&vstdout);CHKERRQ(ierr);
22534c30e9fbSJed Brown       if (flag_draw || flag_contour) {
22544c30e9fbSJed Brown         ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,0,"Colored Jacobians",PETSC_DECIDE,PETSC_DECIDE,300,300,&vdraw);CHKERRQ(ierr);
22554c30e9fbSJed Brown         if (flag_contour) {ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);}
22564c30e9fbSJed Brown       } else vdraw = PETSC_NULL;
22574c30e9fbSJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Explicit preconditioning Jacobian\n");CHKERRQ(ierr);
22586719d8e4SJed Brown       if (flag_display) {ierr = MatView(*B,vstdout);CHKERRQ(ierr);}
22594c30e9fbSJed Brown       if (vdraw) {ierr = MatView(*B,vdraw);CHKERRQ(ierr);}
22604c30e9fbSJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Colored Finite difference Jacobian\n");CHKERRQ(ierr);
22616719d8e4SJed Brown       if (flag_display) {ierr = MatView(Bfd,vstdout);CHKERRQ(ierr);}
22624c30e9fbSJed Brown       if (vdraw) {ierr = MatView(Bfd,vdraw);CHKERRQ(ierr);}
22634c30e9fbSJed Brown       ierr = MatAYPX(Bfd,-1.0,*B,SAME_NONZERO_PATTERN);CHKERRQ(ierr);
22644c30e9fbSJed Brown       ierr = MatNorm(Bfd,NORM_1,&norm1);CHKERRQ(ierr);
22656719d8e4SJed Brown       ierr = MatNorm(Bfd,NORM_FROBENIUS,&norm2);CHKERRQ(ierr);
22664c30e9fbSJed Brown       ierr = MatNorm(Bfd,NORM_MAX,&normmax);CHKERRQ(ierr);
22676719d8e4SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"User-provided matrix minus finite difference Jacobian, norm1=%G normFrob=%G normmax=%G\n",norm1,norm2,normmax);CHKERRQ(ierr);
22686719d8e4SJed Brown       if (flag_display) {ierr = MatView(Bfd,vstdout);CHKERRQ(ierr);}
22694c30e9fbSJed Brown       if (vdraw) {              /* Always use contour for the difference */
22704c30e9fbSJed Brown         ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);
22714c30e9fbSJed Brown         ierr = MatView(Bfd,vdraw);CHKERRQ(ierr);
22724c30e9fbSJed Brown         ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);
22734c30e9fbSJed Brown       }
22744c30e9fbSJed Brown       if (flag_contour) {ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);}
22756719d8e4SJed Brown 
22766719d8e4SJed Brown       if (flag_threshold) {
22776719d8e4SJed Brown         PetscInt bs,rstart,rend,i;
22786719d8e4SJed Brown         ierr = MatGetBlockSize(*B,&bs);CHKERRQ(ierr);
22796719d8e4SJed Brown         ierr = MatGetOwnershipRange(*B,&rstart,&rend);CHKERRQ(ierr);
22806719d8e4SJed Brown         for (i=rstart; i<rend; i++) {
22816719d8e4SJed Brown           const PetscScalar *ba,*ca;
22826719d8e4SJed Brown           const PetscInt    *bj,*cj;
22836719d8e4SJed Brown           PetscInt          bn,cn,j,maxentrycol = -1,maxdiffcol = -1,maxrdiffcol = -1;
22846719d8e4SJed Brown           PetscReal         maxentry = 0,maxdiff = 0,maxrdiff = 0;
22856719d8e4SJed Brown           ierr = MatGetRow(*B,i,&bn,&bj,&ba);CHKERRQ(ierr);
22866719d8e4SJed Brown           ierr = MatGetRow(Bfd,i,&cn,&cj,&ca);CHKERRQ(ierr);
22876719d8e4SJed Brown           if (bn != cn) SETERRQ(((PetscObject)*A)->comm,PETSC_ERR_PLIB,"Unexpected different nonzero pattern in -snes_compare_coloring_threshold");
22886719d8e4SJed Brown           for (j=0; j<bn; j++) {
22896719d8e4SJed Brown             PetscReal rdiff = PetscAbsScalar(ca[j]) / (threshold_atol + threshold_rtol*PetscAbsScalar(ba[j]));
22906719d8e4SJed Brown             if (PetscAbsScalar(ba[j]) > PetscAbs(maxentry)) {
22916719d8e4SJed Brown               maxentrycol = bj[j];
22926719d8e4SJed Brown               maxentry = PetscRealPart(ba[j]);
22936719d8e4SJed Brown             }
22946719d8e4SJed Brown             if (PetscAbsScalar(ca[j]) > PetscAbs(maxdiff)) {
22956719d8e4SJed Brown               maxdiffcol = bj[j];
22966719d8e4SJed Brown               maxdiff = PetscRealPart(ca[j]);
22976719d8e4SJed Brown             }
22986719d8e4SJed Brown             if (rdiff > maxrdiff) {
22996719d8e4SJed Brown               maxrdiffcol = bj[j];
23006719d8e4SJed Brown               maxrdiff = rdiff;
23016719d8e4SJed Brown             }
23026719d8e4SJed Brown           }
23036719d8e4SJed Brown           if (maxrdiff > 1) {
23046719d8e4SJed Brown             ierr = PetscViewerASCIIPrintf(vstdout,"row %D (maxentry=%G at %D, maxdiff=%G at %D, maxrdiff=%G at %D):",i,maxentry,maxentrycol,maxdiff,maxdiffcol,maxrdiff,maxrdiffcol);CHKERRQ(ierr);
23056719d8e4SJed Brown             for (j=0; j<bn; j++) {
23066719d8e4SJed Brown               PetscReal rdiff;
23076719d8e4SJed Brown               rdiff = PetscAbsScalar(ca[j]) / (threshold_atol + threshold_rtol*PetscAbsScalar(ba[j]));
23086719d8e4SJed Brown               if (rdiff > 1) {
23096719d8e4SJed Brown                 ierr = PetscViewerASCIIPrintf(vstdout," (%D,%G:%G)",bj[j],PetscRealPart(ba[j]),PetscRealPart(ca[j]));CHKERRQ(ierr);
23106719d8e4SJed Brown               }
23116719d8e4SJed Brown             }
23126719d8e4SJed Brown             ierr = PetscViewerASCIIPrintf(vstdout,"\n",i,maxentry,maxdiff,maxrdiff);CHKERRQ(ierr);
23136719d8e4SJed Brown           }
23146719d8e4SJed Brown           ierr = MatRestoreRow(*B,i,&bn,&bj,&ba);CHKERRQ(ierr);
23156719d8e4SJed Brown           ierr = MatRestoreRow(Bfd,i,&cn,&cj,&ca);CHKERRQ(ierr);
23166719d8e4SJed Brown         }
23176719d8e4SJed Brown       }
23184c30e9fbSJed Brown       ierr = PetscViewerDestroy(&vdraw);CHKERRQ(ierr);
23194c30e9fbSJed Brown       ierr = MatDestroy(&Bfd);CHKERRQ(ierr);
23204c30e9fbSJed Brown     }
23214c30e9fbSJed Brown   }
23223a40ed3dSBarry Smith   PetscFunctionReturn(0);
23239b94acceSBarry Smith }
23249b94acceSBarry Smith 
2325bf388a1fSBarry Smith /*MC
2326bf388a1fSBarry Smith     SNESJacobianFunction - function used to convey the nonlinear Jacobian of the function to be solved by SNES
2327bf388a1fSBarry Smith 
2328bf388a1fSBarry Smith      Synopsis:
2329bf388a1fSBarry Smith      #include "petscsnes.h"
2330bf388a1fSBarry Smith $     SNESJacobianFunction(SNES snes,Vec x,Mat *A,Mat *B,int *flag,void *ctx);
2331bf388a1fSBarry Smith 
2332bf388a1fSBarry Smith +  x - input vector
2333bf388a1fSBarry Smith .  A - Jacobian matrix
2334bf388a1fSBarry Smith .  B - preconditioner matrix, usually the same as A
2335bf388a1fSBarry Smith .  flag - flag indicating information about the preconditioner matrix
2336bf388a1fSBarry Smith    structure (same as flag in KSPSetOperators()), one of SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER
2337bf388a1fSBarry Smith -  ctx - [optional] user-defined Jacobian context
2338bf388a1fSBarry Smith 
2339bf388a1fSBarry Smith .seealso:   SNESSetFunction(), SNESGetFunction(), SNESSetJacobian(), SNESGetJacobian()
2340bf388a1fSBarry Smith M*/
2341bf388a1fSBarry Smith 
23424a2ae208SSatish Balay #undef __FUNCT__
23434a2ae208SSatish Balay #define __FUNCT__ "SNESSetJacobian"
23449b94acceSBarry Smith /*@C
23459b94acceSBarry Smith    SNESSetJacobian - Sets the function to compute Jacobian as well as the
2346044dda88SLois Curfman McInnes    location to store the matrix.
23479b94acceSBarry Smith 
23483f9fe445SBarry Smith    Logically Collective on SNES and Mat
2349c7afd0dbSLois Curfman McInnes 
23509b94acceSBarry Smith    Input Parameters:
2351c7afd0dbSLois Curfman McInnes +  snes - the SNES context
23529b94acceSBarry Smith .  A - Jacobian matrix
23539b94acceSBarry Smith .  B - preconditioner matrix (usually same as the Jacobian)
2354bf388a1fSBarry Smith .  SNESJacobianFunction - Jacobian evaluation routine (if PETSC_NULL then SNES retains any previously set value)
2355c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined context for private data for the
2356efd51863SBarry Smith          Jacobian evaluation routine (may be PETSC_NULL) (if PETSC_NULL then SNES retains any previously set value)
23579b94acceSBarry Smith 
23589b94acceSBarry Smith    Notes:
235994b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the flag
23602cd2dfdcSLois Curfman McInnes    output parameter in the routine func().  Be sure to read this information!
2361ac21db08SLois Curfman McInnes 
2362ac21db08SLois Curfman McInnes    The routine func() takes Mat * as the matrix arguments rather than Mat.
23639b94acceSBarry Smith    This allows the Jacobian evaluation routine to replace A and/or B with a
23649b94acceSBarry Smith    completely new new matrix structure (not just different matrix elements)
23659b94acceSBarry Smith    when appropriate, for instance, if the nonzero structure is changing
23669b94acceSBarry Smith    throughout the global iterations.
23679b94acceSBarry Smith 
236816913363SBarry Smith    If the A matrix and B matrix are different you must call MatAssemblyBegin/End() on
236916913363SBarry Smith    each matrix.
237016913363SBarry Smith 
2371a8a26c1eSJed Brown    If using SNESDefaultComputeJacobianColor() to assemble a Jacobian, the ctx argument
2372a8a26c1eSJed Brown    must be a MatFDColoring.
2373a8a26c1eSJed Brown 
2374c3cc8fd1SJed Brown    Other defect-correction schemes can be used by computing a different matrix in place of the Jacobian.  One common
2375c3cc8fd1SJed Brown    example is to use the "Picard linearization" which only differentiates through the highest order parts of each term.
2376c3cc8fd1SJed Brown 
237736851e7fSLois Curfman McInnes    Level: beginner
237836851e7fSLois Curfman McInnes 
23799b94acceSBarry Smith .keywords: SNES, nonlinear, set, Jacobian, matrix
23809b94acceSBarry Smith 
2381bf388a1fSBarry Smith .seealso: KSPSetOperators(), SNESSetFunction(), MatMFFDComputeJacobian(), SNESDefaultComputeJacobianColor(), MatStructure, SNESJacobianFunction
23829b94acceSBarry Smith @*/
2383bf388a1fSBarry Smith PetscErrorCode  SNESSetJacobian(SNES snes,Mat A,Mat B,PetscErrorCode (*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *ctx)
23849b94acceSBarry Smith {
2385dfbe8321SBarry Smith   PetscErrorCode ierr;
23866cab3a1bSJed Brown   DM             dm;
23873a7fca6bSBarry Smith 
23883a40ed3dSBarry Smith   PetscFunctionBegin;
23890700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
23900700a824SBarry Smith   if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2);
23910700a824SBarry Smith   if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3);
2392c9780b6fSBarry Smith   if (A) PetscCheckSameComm(snes,1,A,2);
239306975374SJed Brown   if (B) PetscCheckSameComm(snes,1,B,3);
23946cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
2395bf388a1fSBarry Smith   ierr = DMSNESSetJacobian(dm,SNESJacobianFunction,ctx);CHKERRQ(ierr);
23963a7fca6bSBarry Smith   if (A) {
23977dcf0eaaSdalcinl     ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
23986bf464f9SBarry Smith     ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr);
23999b94acceSBarry Smith     snes->jacobian = A;
24003a7fca6bSBarry Smith   }
24013a7fca6bSBarry Smith   if (B) {
24027dcf0eaaSdalcinl     ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
24036bf464f9SBarry Smith     ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr);
24049b94acceSBarry Smith     snes->jacobian_pre = B;
24053a7fca6bSBarry Smith   }
24063a40ed3dSBarry Smith   PetscFunctionReturn(0);
24079b94acceSBarry Smith }
240862fef451SLois Curfman McInnes 
24094a2ae208SSatish Balay #undef __FUNCT__
24104a2ae208SSatish Balay #define __FUNCT__ "SNESGetJacobian"
2411c2aafc4cSSatish Balay /*@C
2412b4fd4287SBarry Smith    SNESGetJacobian - Returns the Jacobian matrix and optionally the user
2413b4fd4287SBarry Smith    provided context for evaluating the Jacobian.
2414b4fd4287SBarry Smith 
2415c7afd0dbSLois Curfman McInnes    Not Collective, but Mat object will be parallel if SNES object is
2416c7afd0dbSLois Curfman McInnes 
2417b4fd4287SBarry Smith    Input Parameter:
2418b4fd4287SBarry Smith .  snes - the nonlinear solver context
2419b4fd4287SBarry Smith 
2420b4fd4287SBarry Smith    Output Parameters:
2421c7afd0dbSLois Curfman McInnes +  A - location to stash Jacobian matrix (or PETSC_NULL)
2422b4fd4287SBarry Smith .  B - location to stash preconditioner matrix (or PETSC_NULL)
2423bf388a1fSBarry Smith .  SNESJacobianFunction - location to put Jacobian function (or PETSC_NULL)
242470e92668SMatthew Knepley -  ctx - location to stash Jacobian ctx (or PETSC_NULL)
2425fee21e36SBarry Smith 
242636851e7fSLois Curfman McInnes    Level: advanced
242736851e7fSLois Curfman McInnes 
2428b4fd4287SBarry Smith .seealso: SNESSetJacobian(), SNESComputeJacobian()
2429b4fd4287SBarry Smith @*/
2430bf388a1fSBarry Smith PetscErrorCode SNESGetJacobian(SNES snes,Mat *A,Mat *B,PetscErrorCode (**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **ctx)
2431b4fd4287SBarry Smith {
24326cab3a1bSJed Brown   PetscErrorCode ierr;
24336cab3a1bSJed Brown   DM             dm;
2434942e3340SBarry Smith   DMSNES         sdm;
24356cab3a1bSJed Brown 
24363a40ed3dSBarry Smith   PetscFunctionBegin;
24370700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2438b4fd4287SBarry Smith   if (A)    *A    = snes->jacobian;
2439b4fd4287SBarry Smith   if (B)    *B    = snes->jacobian_pre;
24406cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
2441942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
2442bf388a1fSBarry Smith   if (SNESJacobianFunction) *SNESJacobianFunction = sdm->ops->computejacobian;
24436cab3a1bSJed Brown   if (ctx)  *ctx  = sdm->jacobianctx;
24443a40ed3dSBarry Smith   PetscFunctionReturn(0);
2445b4fd4287SBarry Smith }
2446b4fd4287SBarry Smith 
24474a2ae208SSatish Balay #undef __FUNCT__
24484a2ae208SSatish Balay #define __FUNCT__ "SNESSetUp"
24499b94acceSBarry Smith /*@
24509b94acceSBarry Smith    SNESSetUp - Sets up the internal data structures for the later use
2451272ac6f2SLois Curfman McInnes    of a nonlinear solver.
24529b94acceSBarry Smith 
2453fee21e36SBarry Smith    Collective on SNES
2454fee21e36SBarry Smith 
2455c7afd0dbSLois Curfman McInnes    Input Parameters:
245670e92668SMatthew Knepley .  snes - the SNES context
2457c7afd0dbSLois Curfman McInnes 
2458272ac6f2SLois Curfman McInnes    Notes:
2459272ac6f2SLois Curfman McInnes    For basic use of the SNES solvers the user need not explicitly call
2460272ac6f2SLois Curfman McInnes    SNESSetUp(), since these actions will automatically occur during
2461272ac6f2SLois Curfman McInnes    the call to SNESSolve().  However, if one wishes to control this
2462272ac6f2SLois Curfman McInnes    phase separately, SNESSetUp() should be called after SNESCreate()
2463272ac6f2SLois Curfman McInnes    and optional routines of the form SNESSetXXX(), but before SNESSolve().
2464272ac6f2SLois Curfman McInnes 
246536851e7fSLois Curfman McInnes    Level: advanced
246636851e7fSLois Curfman McInnes 
24679b94acceSBarry Smith .keywords: SNES, nonlinear, setup
24689b94acceSBarry Smith 
24699b94acceSBarry Smith .seealso: SNESCreate(), SNESSolve(), SNESDestroy()
24709b94acceSBarry Smith @*/
24717087cfbeSBarry Smith PetscErrorCode  SNESSetUp(SNES snes)
24729b94acceSBarry Smith {
2473dfbe8321SBarry Smith   PetscErrorCode ierr;
24746cab3a1bSJed Brown   DM             dm;
2475942e3340SBarry Smith   DMSNES         sdm;
2476c35f09e5SBarry Smith   SNESLineSearch linesearch, pclinesearch;
24776e2a1849SPeter Brune   void           *lsprectx,*lspostctx;
24786b2b7091SBarry Smith   PetscErrorCode (*precheck)(SNESLineSearch,Vec,Vec,PetscBool*,void*);
24796b2b7091SBarry Smith   PetscErrorCode (*postcheck)(SNESLineSearch,Vec,Vec,Vec,PetscBool *,PetscBool *,void*);
24806e2a1849SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
24816e2a1849SPeter Brune   Vec            f,fpc;
24826e2a1849SPeter Brune   void           *funcctx;
24836e2a1849SPeter Brune   PetscErrorCode (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
24841eb13d49SPeter Brune   void           *jacctx,*appctx;
24856e2a1849SPeter Brune   Mat            A,B;
24863a40ed3dSBarry Smith 
24873a40ed3dSBarry Smith   PetscFunctionBegin;
24880700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
24894dc4c822SBarry Smith   if (snes->setupcalled) PetscFunctionReturn(0);
24909b94acceSBarry Smith 
24917adad957SLisandro Dalcin   if (!((PetscObject)snes)->type_name) {
249204d7464bSBarry Smith     ierr = SNESSetType(snes,SNESNEWTONLS);CHKERRQ(ierr);
249385385478SLisandro Dalcin   }
249485385478SLisandro Dalcin 
2495a63bb30eSJed Brown   ierr = SNESGetFunction(snes,&snes->vec_func,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
249617186662SBarry Smith   if (snes->vec_func == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be function vector");
249758c9b817SLisandro Dalcin   if (snes->vec_rhs  == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be right hand side vector");
249858c9b817SLisandro Dalcin 
249958c9b817SLisandro Dalcin   if (!snes->vec_sol_update /* && snes->vec_sol */) {
250058c9b817SLisandro Dalcin     ierr = VecDuplicate(snes->vec_sol,&snes->vec_sol_update);CHKERRQ(ierr);
250158c9b817SLisandro Dalcin     ierr = PetscLogObjectParent(snes,snes->vec_sol_update);CHKERRQ(ierr);
250258c9b817SLisandro Dalcin   }
250358c9b817SLisandro Dalcin 
25046cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
2505d8f46077SPeter Brune   ierr = DMShellSetGlobalVector(snes->dm,snes->vec_sol);CHKERRQ(ierr);
2506942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
250722c6f798SBarry Smith   if (!sdm->ops->computefunction) SETERRQ(((PetscObject)dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"Function never provided to SNES object");
250822c6f798SBarry Smith   if (!sdm->ops->computejacobian) {
250919f7a02aSBarry Smith     ierr = DMSNESSetJacobian(dm,SNESDefaultComputeJacobianColor,PETSC_NULL);CHKERRQ(ierr);
251019f7a02aSBarry Smith   }
25116cab3a1bSJed Brown   if (!snes->vec_func) {
25126cab3a1bSJed Brown     ierr = DMCreateGlobalVector(dm,&snes->vec_func);CHKERRQ(ierr);
2513214df951SJed Brown   }
2514efd51863SBarry Smith 
251522d28d08SBarry Smith   if (!snes->ksp) {
251622d28d08SBarry Smith     ierr = SNESGetKSP(snes, &snes->ksp);CHKERRQ(ierr);
251722d28d08SBarry Smith   }
2518b710008aSBarry Smith 
251922d28d08SBarry Smith   if (!snes->linesearch) {
252022d28d08SBarry Smith     ierr = SNESGetSNESLineSearch(snes, &snes->linesearch);CHKERRQ(ierr);
252122d28d08SBarry Smith   }
25229e764e56SPeter Brune 
2523172a4300SPeter Brune   if (snes->pc && (snes->pcside == PC_LEFT)) {
2524172a4300SPeter Brune     snes->mf = PETSC_TRUE;
2525172a4300SPeter Brune     snes->mf_operator = PETSC_FALSE;
2526172a4300SPeter Brune   }
2527d8f46077SPeter Brune 
252828a52e04SBarry Smith   if (snes->mf) {
252928a52e04SBarry Smith     ierr = SNESSetUpMatrixFree_Private(snes, snes->mf_operator, snes->mf_version);CHKERRQ(ierr);
253028a52e04SBarry Smith   }
2531d8f46077SPeter Brune 
2532d25893d9SBarry Smith   if (snes->ops->usercompute && !snes->user) {
2533d25893d9SBarry Smith     ierr = (*snes->ops->usercompute)(snes,(void**)&snes->user);CHKERRQ(ierr);
2534d25893d9SBarry Smith   }
2535d25893d9SBarry Smith 
25366e2a1849SPeter Brune   if (snes->pc) {
25376e2a1849SPeter Brune     /* copy the DM over */
25386e2a1849SPeter Brune     ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
25396e2a1849SPeter Brune     ierr = SNESSetDM(snes->pc,dm);CHKERRQ(ierr);
25406e2a1849SPeter Brune 
25416e2a1849SPeter Brune     ierr = SNESGetFunction(snes,&f,&func,&funcctx);CHKERRQ(ierr);
25426e2a1849SPeter Brune     ierr = VecDuplicate(f,&fpc);CHKERRQ(ierr);
25436e2a1849SPeter Brune     ierr = SNESSetFunction(snes->pc,fpc,func,funcctx);CHKERRQ(ierr);
25446e2a1849SPeter Brune     ierr = SNESGetJacobian(snes,&A,&B,&jac,&jacctx);CHKERRQ(ierr);
25456e2a1849SPeter Brune     ierr = SNESSetJacobian(snes->pc,A,B,jac,jacctx);CHKERRQ(ierr);
25461eb13d49SPeter Brune     ierr = SNESGetApplicationContext(snes,&appctx);CHKERRQ(ierr);
25471eb13d49SPeter Brune     ierr = SNESSetApplicationContext(snes->pc,appctx);CHKERRQ(ierr);
25486e2a1849SPeter Brune     ierr = VecDestroy(&fpc);CHKERRQ(ierr);
25496e2a1849SPeter Brune 
25506e2a1849SPeter Brune     /* copy the function pointers over */
25516e2a1849SPeter Brune     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)snes,(PetscObject)snes->pc);CHKERRQ(ierr);
25526e2a1849SPeter Brune 
25536e2a1849SPeter Brune      /* default to 1 iteration */
2554140836e4SPeter Brune     ierr = SNESSetTolerances(snes->pc, 0.0, 0.0, 0.0, 1, snes->pc->max_funcs);CHKERRQ(ierr);
25556e2a1849SPeter Brune     ierr = SNESSetNormType(snes->pc, SNES_NORM_FINAL_ONLY);CHKERRQ(ierr);
25566e2a1849SPeter Brune     ierr = SNESSetFromOptions(snes->pc);CHKERRQ(ierr);
25576e2a1849SPeter Brune 
25586e2a1849SPeter Brune     /* copy the line search context over */
25596e2a1849SPeter Brune     ierr = SNESGetSNESLineSearch(snes,&linesearch);CHKERRQ(ierr);
25606e2a1849SPeter Brune     ierr = SNESGetSNESLineSearch(snes->pc,&pclinesearch);CHKERRQ(ierr);
25616b2b7091SBarry Smith     ierr = SNESLineSearchGetPreCheck(linesearch,&precheck,&lsprectx);CHKERRQ(ierr);
25626b2b7091SBarry Smith     ierr = SNESLineSearchGetPostCheck(linesearch,&postcheck,&lspostctx);CHKERRQ(ierr);
25636b2b7091SBarry Smith     ierr = SNESLineSearchSetPreCheck(pclinesearch,precheck,lsprectx);CHKERRQ(ierr);
25646b2b7091SBarry Smith     ierr = SNESLineSearchSetPostCheck(pclinesearch,postcheck,lspostctx);CHKERRQ(ierr);
25656e2a1849SPeter Brune     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)linesearch, (PetscObject)pclinesearch);CHKERRQ(ierr);
25666e2a1849SPeter Brune   }
25676e2a1849SPeter Brune 
2568410397dcSLisandro Dalcin   if (snes->ops->setup) {
2569410397dcSLisandro Dalcin     ierr = (*snes->ops->setup)(snes);CHKERRQ(ierr);
2570410397dcSLisandro Dalcin   }
257158c9b817SLisandro Dalcin 
25727aaed0d8SBarry Smith   snes->setupcalled = PETSC_TRUE;
25733a40ed3dSBarry Smith   PetscFunctionReturn(0);
25749b94acceSBarry Smith }
25759b94acceSBarry Smith 
25764a2ae208SSatish Balay #undef __FUNCT__
257737596af1SLisandro Dalcin #define __FUNCT__ "SNESReset"
257837596af1SLisandro Dalcin /*@
257937596af1SLisandro Dalcin    SNESReset - Resets a SNES context to the snessetupcalled = 0 state and removes any allocated Vecs and Mats
258037596af1SLisandro Dalcin 
258137596af1SLisandro Dalcin    Collective on SNES
258237596af1SLisandro Dalcin 
258337596af1SLisandro Dalcin    Input Parameter:
258437596af1SLisandro Dalcin .  snes - iterative context obtained from SNESCreate()
258537596af1SLisandro Dalcin 
2586d25893d9SBarry Smith    Level: intermediate
2587d25893d9SBarry Smith 
2588d25893d9SBarry Smith    Notes: Also calls the application context destroy routine set with SNESSetComputeApplicationContext()
258937596af1SLisandro Dalcin 
259037596af1SLisandro Dalcin .keywords: SNES, destroy
259137596af1SLisandro Dalcin 
259237596af1SLisandro Dalcin .seealso: SNESCreate(), SNESSetUp(), SNESSolve()
259337596af1SLisandro Dalcin @*/
259437596af1SLisandro Dalcin PetscErrorCode  SNESReset(SNES snes)
259537596af1SLisandro Dalcin {
259637596af1SLisandro Dalcin   PetscErrorCode ierr;
259737596af1SLisandro Dalcin 
259837596af1SLisandro Dalcin   PetscFunctionBegin;
259937596af1SLisandro Dalcin   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2600d25893d9SBarry Smith   if (snes->ops->userdestroy && snes->user) {
2601d25893d9SBarry Smith     ierr       = (*snes->ops->userdestroy)((void**)&snes->user);CHKERRQ(ierr);
2602d25893d9SBarry Smith     snes->user = PETSC_NULL;
2603d25893d9SBarry Smith   }
26048a23116dSBarry Smith   if (snes->pc) {
26058a23116dSBarry Smith     ierr = SNESReset(snes->pc);CHKERRQ(ierr);
26068a23116dSBarry Smith   }
26078a23116dSBarry Smith 
260837596af1SLisandro Dalcin   if (snes->ops->reset) {
260937596af1SLisandro Dalcin     ierr = (*snes->ops->reset)(snes);CHKERRQ(ierr);
261037596af1SLisandro Dalcin   }
26119e764e56SPeter Brune   if (snes->ksp) {
26129e764e56SPeter Brune     ierr = KSPReset(snes->ksp);CHKERRQ(ierr);
26139e764e56SPeter Brune   }
26149e764e56SPeter Brune 
26159e764e56SPeter Brune   if (snes->linesearch) {
2616f1c6b773SPeter Brune     ierr = SNESLineSearchReset(snes->linesearch);CHKERRQ(ierr);
26179e764e56SPeter Brune   }
26189e764e56SPeter Brune 
26196bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr);
26206bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr);
26216bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_sol_update);CHKERRQ(ierr);
26226bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr);
26236bf464f9SBarry Smith   ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr);
26246bf464f9SBarry Smith   ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr);
2625c41d97abSJed Brown   ierr = VecDestroyVecs(snes->nwork,&snes->work);CHKERRQ(ierr);
2626c41d97abSJed Brown   ierr = VecDestroyVecs(snes->nvwork,&snes->vwork);CHKERRQ(ierr);
262737596af1SLisandro Dalcin   snes->nwork = snes->nvwork = 0;
262837596af1SLisandro Dalcin   snes->setupcalled = PETSC_FALSE;
262937596af1SLisandro Dalcin   PetscFunctionReturn(0);
263037596af1SLisandro Dalcin }
263137596af1SLisandro Dalcin 
263237596af1SLisandro Dalcin #undef __FUNCT__
26334a2ae208SSatish Balay #define __FUNCT__ "SNESDestroy"
263452baeb72SSatish Balay /*@
26359b94acceSBarry Smith    SNESDestroy - Destroys the nonlinear solver context that was created
26369b94acceSBarry Smith    with SNESCreate().
26379b94acceSBarry Smith 
2638c7afd0dbSLois Curfman McInnes    Collective on SNES
2639c7afd0dbSLois Curfman McInnes 
26409b94acceSBarry Smith    Input Parameter:
26419b94acceSBarry Smith .  snes - the SNES context
26429b94acceSBarry Smith 
264336851e7fSLois Curfman McInnes    Level: beginner
264436851e7fSLois Curfman McInnes 
26459b94acceSBarry Smith .keywords: SNES, nonlinear, destroy
26469b94acceSBarry Smith 
264763a78c88SLois Curfman McInnes .seealso: SNESCreate(), SNESSolve()
26489b94acceSBarry Smith @*/
26496bf464f9SBarry Smith PetscErrorCode  SNESDestroy(SNES *snes)
26509b94acceSBarry Smith {
26516849ba73SBarry Smith   PetscErrorCode ierr;
26523a40ed3dSBarry Smith 
26533a40ed3dSBarry Smith   PetscFunctionBegin;
26546bf464f9SBarry Smith   if (!*snes) PetscFunctionReturn(0);
26556bf464f9SBarry Smith   PetscValidHeaderSpecific((*snes),SNES_CLASSID,1);
26566bf464f9SBarry Smith   if (--((PetscObject)(*snes))->refct > 0) {*snes = 0; PetscFunctionReturn(0);}
2657d4bb536fSBarry Smith 
26586bf464f9SBarry Smith   ierr = SNESReset((*snes));CHKERRQ(ierr);
26598a23116dSBarry Smith   ierr = SNESDestroy(&(*snes)->pc);CHKERRQ(ierr);
26606b8b9a38SLisandro Dalcin 
2661be0abb6dSBarry Smith   /* if memory was published with AMS then destroy it */
26626bf464f9SBarry Smith   ierr = PetscObjectDepublish((*snes));CHKERRQ(ierr);
26636bf464f9SBarry Smith   if ((*snes)->ops->destroy) {ierr = (*((*snes))->ops->destroy)((*snes));CHKERRQ(ierr);}
26646d4c513bSLisandro Dalcin 
26656bf464f9SBarry Smith   ierr = DMDestroy(&(*snes)->dm);CHKERRQ(ierr);
26666bf464f9SBarry Smith   ierr = KSPDestroy(&(*snes)->ksp);CHKERRQ(ierr);
2667f1c6b773SPeter Brune   ierr = SNESLineSearchDestroy(&(*snes)->linesearch);CHKERRQ(ierr);
26686b8b9a38SLisandro Dalcin 
26696bf464f9SBarry Smith   ierr = PetscFree((*snes)->kspconvctx);CHKERRQ(ierr);
26706bf464f9SBarry Smith   if ((*snes)->ops->convergeddestroy) {
26716bf464f9SBarry Smith     ierr = (*(*snes)->ops->convergeddestroy)((*snes)->cnvP);CHKERRQ(ierr);
26726b8b9a38SLisandro Dalcin   }
26736bf464f9SBarry Smith   if ((*snes)->conv_malloc) {
26746bf464f9SBarry Smith     ierr = PetscFree((*snes)->conv_hist);CHKERRQ(ierr);
26756bf464f9SBarry Smith     ierr = PetscFree((*snes)->conv_hist_its);CHKERRQ(ierr);
267658c9b817SLisandro Dalcin   }
26776bf464f9SBarry Smith   ierr = SNESMonitorCancel((*snes));CHKERRQ(ierr);
2678a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(snes);CHKERRQ(ierr);
26793a40ed3dSBarry Smith  PetscFunctionReturn(0);
26809b94acceSBarry Smith }
26819b94acceSBarry Smith 
26829b94acceSBarry Smith /* ----------- Routines to set solver parameters ---------- */
26839b94acceSBarry Smith 
26844a2ae208SSatish Balay #undef __FUNCT__
2685a8054027SBarry Smith #define __FUNCT__ "SNESSetLagPreconditioner"
2686a8054027SBarry Smith /*@
2687a8054027SBarry Smith    SNESSetLagPreconditioner - Determines when the preconditioner is rebuilt in the nonlinear solve.
2688a8054027SBarry Smith 
26893f9fe445SBarry Smith    Logically Collective on SNES
2690a8054027SBarry Smith 
2691a8054027SBarry Smith    Input Parameters:
2692a8054027SBarry Smith +  snes - the SNES context
2693a8054027SBarry 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
26943b4f5425SBarry Smith          the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that
2695a8054027SBarry Smith 
2696a8054027SBarry Smith    Options Database Keys:
2697a8054027SBarry Smith .    -snes_lag_preconditioner <lag>
2698a8054027SBarry Smith 
2699a8054027SBarry Smith    Notes:
2700a8054027SBarry Smith    The default is 1
2701a8054027SBarry Smith    The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
2702a8054027SBarry Smith    If  -1 is used before the very first nonlinear solve the preconditioner is still built because there is no previous preconditioner to use
2703a8054027SBarry Smith 
2704a8054027SBarry Smith    Level: intermediate
2705a8054027SBarry Smith 
2706a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
2707a8054027SBarry Smith 
2708e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian()
2709a8054027SBarry Smith 
2710a8054027SBarry Smith @*/
27117087cfbeSBarry Smith PetscErrorCode  SNESSetLagPreconditioner(SNES snes,PetscInt lag)
2712a8054027SBarry Smith {
2713a8054027SBarry Smith   PetscFunctionBegin;
27140700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2715e32f2f54SBarry Smith   if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater");
2716e32f2f54SBarry Smith   if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0");
2717c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,lag,2);
2718a8054027SBarry Smith   snes->lagpreconditioner = lag;
2719a8054027SBarry Smith   PetscFunctionReturn(0);
2720a8054027SBarry Smith }
2721a8054027SBarry Smith 
2722a8054027SBarry Smith #undef __FUNCT__
2723efd51863SBarry Smith #define __FUNCT__ "SNESSetGridSequence"
2724efd51863SBarry Smith /*@
2725efd51863SBarry Smith    SNESSetGridSequence - sets the number of steps of grid sequencing that SNES does
2726efd51863SBarry Smith 
2727efd51863SBarry Smith    Logically Collective on SNES
2728efd51863SBarry Smith 
2729efd51863SBarry Smith    Input Parameters:
2730efd51863SBarry Smith +  snes - the SNES context
2731efd51863SBarry Smith -  steps - the number of refinements to do, defaults to 0
2732efd51863SBarry Smith 
2733efd51863SBarry Smith    Options Database Keys:
2734efd51863SBarry Smith .    -snes_grid_sequence <steps>
2735efd51863SBarry Smith 
2736efd51863SBarry Smith    Level: intermediate
2737efd51863SBarry Smith 
2738c0df2a02SJed Brown    Notes:
2739c0df2a02SJed Brown    Use SNESGetSolution() to extract the fine grid solution after grid sequencing.
2740c0df2a02SJed Brown 
2741efd51863SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
2742efd51863SBarry Smith 
2743efd51863SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian()
2744efd51863SBarry Smith 
2745efd51863SBarry Smith @*/
2746efd51863SBarry Smith PetscErrorCode  SNESSetGridSequence(SNES snes,PetscInt steps)
2747efd51863SBarry Smith {
2748efd51863SBarry Smith   PetscFunctionBegin;
2749efd51863SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2750efd51863SBarry Smith   PetscValidLogicalCollectiveInt(snes,steps,2);
2751efd51863SBarry Smith   snes->gridsequence = steps;
2752efd51863SBarry Smith   PetscFunctionReturn(0);
2753efd51863SBarry Smith }
2754efd51863SBarry Smith 
2755efd51863SBarry Smith #undef __FUNCT__
2756a8054027SBarry Smith #define __FUNCT__ "SNESGetLagPreconditioner"
2757a8054027SBarry Smith /*@
2758a8054027SBarry Smith    SNESGetLagPreconditioner - Indicates how often the preconditioner is rebuilt
2759a8054027SBarry Smith 
27603f9fe445SBarry Smith    Not Collective
2761a8054027SBarry Smith 
2762a8054027SBarry Smith    Input Parameter:
2763a8054027SBarry Smith .  snes - the SNES context
2764a8054027SBarry Smith 
2765a8054027SBarry Smith    Output Parameter:
2766a8054027SBarry 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
27673b4f5425SBarry Smith          the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that
2768a8054027SBarry Smith 
2769a8054027SBarry Smith    Options Database Keys:
2770a8054027SBarry Smith .    -snes_lag_preconditioner <lag>
2771a8054027SBarry Smith 
2772a8054027SBarry Smith    Notes:
2773a8054027SBarry Smith    The default is 1
2774a8054027SBarry Smith    The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
2775a8054027SBarry Smith 
2776a8054027SBarry Smith    Level: intermediate
2777a8054027SBarry Smith 
2778a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
2779a8054027SBarry Smith 
2780a8054027SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagPreconditioner()
2781a8054027SBarry Smith 
2782a8054027SBarry Smith @*/
27837087cfbeSBarry Smith PetscErrorCode  SNESGetLagPreconditioner(SNES snes,PetscInt *lag)
2784a8054027SBarry Smith {
2785a8054027SBarry Smith   PetscFunctionBegin;
27860700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2787a8054027SBarry Smith   *lag = snes->lagpreconditioner;
2788a8054027SBarry Smith   PetscFunctionReturn(0);
2789a8054027SBarry Smith }
2790a8054027SBarry Smith 
2791a8054027SBarry Smith #undef __FUNCT__
2792e35cf81dSBarry Smith #define __FUNCT__ "SNESSetLagJacobian"
2793e35cf81dSBarry Smith /*@
2794e35cf81dSBarry Smith    SNESSetLagJacobian - Determines when the Jacobian is rebuilt in the nonlinear solve. See SNESSetLagPreconditioner() for determining how
2795e35cf81dSBarry Smith      often the preconditioner is rebuilt.
2796e35cf81dSBarry Smith 
27973f9fe445SBarry Smith    Logically Collective on SNES
2798e35cf81dSBarry Smith 
2799e35cf81dSBarry Smith    Input Parameters:
2800e35cf81dSBarry Smith +  snes - the SNES context
2801e35cf81dSBarry 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
2802fe3ffe1eSBarry Smith          the Jacobian is built etc. -2 means rebuild at next chance but then never again
2803e35cf81dSBarry Smith 
2804e35cf81dSBarry Smith    Options Database Keys:
2805e35cf81dSBarry Smith .    -snes_lag_jacobian <lag>
2806e35cf81dSBarry Smith 
2807e35cf81dSBarry Smith    Notes:
2808e35cf81dSBarry Smith    The default is 1
2809e35cf81dSBarry Smith    The Jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
2810fe3ffe1eSBarry 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
2811fe3ffe1eSBarry Smith    at the next Newton step but never again (unless it is reset to another value)
2812e35cf81dSBarry Smith 
2813e35cf81dSBarry Smith    Level: intermediate
2814e35cf81dSBarry Smith 
2815e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
2816e35cf81dSBarry Smith 
2817e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagPreconditioner(), SNESGetLagJacobian()
2818e35cf81dSBarry Smith 
2819e35cf81dSBarry Smith @*/
28207087cfbeSBarry Smith PetscErrorCode  SNESSetLagJacobian(SNES snes,PetscInt lag)
2821e35cf81dSBarry Smith {
2822e35cf81dSBarry Smith   PetscFunctionBegin;
28230700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2824e32f2f54SBarry Smith   if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater");
2825e32f2f54SBarry Smith   if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0");
2826c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,lag,2);
2827e35cf81dSBarry Smith   snes->lagjacobian = lag;
2828e35cf81dSBarry Smith   PetscFunctionReturn(0);
2829e35cf81dSBarry Smith }
2830e35cf81dSBarry Smith 
2831e35cf81dSBarry Smith #undef __FUNCT__
2832e35cf81dSBarry Smith #define __FUNCT__ "SNESGetLagJacobian"
2833e35cf81dSBarry Smith /*@
2834e35cf81dSBarry Smith    SNESGetLagJacobian - Indicates how often the Jacobian is rebuilt. See SNESGetLagPreconditioner() to determine when the preconditioner is rebuilt
2835e35cf81dSBarry Smith 
28363f9fe445SBarry Smith    Not Collective
2837e35cf81dSBarry Smith 
2838e35cf81dSBarry Smith    Input Parameter:
2839e35cf81dSBarry Smith .  snes - the SNES context
2840e35cf81dSBarry Smith 
2841e35cf81dSBarry Smith    Output Parameter:
2842e35cf81dSBarry 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
2843e35cf81dSBarry Smith          the Jacobian is built etc.
2844e35cf81dSBarry Smith 
2845e35cf81dSBarry Smith    Options Database Keys:
2846e35cf81dSBarry Smith .    -snes_lag_jacobian <lag>
2847e35cf81dSBarry Smith 
2848e35cf81dSBarry Smith    Notes:
2849e35cf81dSBarry Smith    The default is 1
2850e35cf81dSBarry Smith    The jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
2851e35cf81dSBarry Smith 
2852e35cf81dSBarry Smith    Level: intermediate
2853e35cf81dSBarry Smith 
2854e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
2855e35cf81dSBarry Smith 
2856e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagJacobian(), SNESSetLagPreconditioner(), SNESGetLagPreconditioner()
2857e35cf81dSBarry Smith 
2858e35cf81dSBarry Smith @*/
28597087cfbeSBarry Smith PetscErrorCode  SNESGetLagJacobian(SNES snes,PetscInt *lag)
2860e35cf81dSBarry Smith {
2861e35cf81dSBarry Smith   PetscFunctionBegin;
28620700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2863e35cf81dSBarry Smith   *lag = snes->lagjacobian;
2864e35cf81dSBarry Smith   PetscFunctionReturn(0);
2865e35cf81dSBarry Smith }
2866e35cf81dSBarry Smith 
2867e35cf81dSBarry Smith #undef __FUNCT__
28684a2ae208SSatish Balay #define __FUNCT__ "SNESSetTolerances"
28699b94acceSBarry Smith /*@
2870d7a720efSLois Curfman McInnes    SNESSetTolerances - Sets various parameters used in convergence tests.
28719b94acceSBarry Smith 
28723f9fe445SBarry Smith    Logically Collective on SNES
2873c7afd0dbSLois Curfman McInnes 
28749b94acceSBarry Smith    Input Parameters:
2875c7afd0dbSLois Curfman McInnes +  snes - the SNES context
287670441072SBarry Smith .  abstol - absolute convergence tolerance
287733174efeSLois Curfman McInnes .  rtol - relative convergence tolerance
28785358d0d4SBarry Smith .  stol -  convergence tolerance in terms of the norm of the change in the solution between steps,  || delta x || < stol*|| x ||
287933174efeSLois Curfman McInnes .  maxit - maximum number of iterations
2880c7afd0dbSLois Curfman McInnes -  maxf - maximum number of function evaluations
2881fee21e36SBarry Smith 
288233174efeSLois Curfman McInnes    Options Database Keys:
288370441072SBarry Smith +    -snes_atol <abstol> - Sets abstol
2884c7afd0dbSLois Curfman McInnes .    -snes_rtol <rtol> - Sets rtol
2885c7afd0dbSLois Curfman McInnes .    -snes_stol <stol> - Sets stol
2886c7afd0dbSLois Curfman McInnes .    -snes_max_it <maxit> - Sets maxit
2887c7afd0dbSLois Curfman McInnes -    -snes_max_funcs <maxf> - Sets maxf
28889b94acceSBarry Smith 
2889d7a720efSLois Curfman McInnes    Notes:
28909b94acceSBarry Smith    The default maximum number of iterations is 50.
28919b94acceSBarry Smith    The default maximum number of function evaluations is 1000.
28929b94acceSBarry Smith 
289336851e7fSLois Curfman McInnes    Level: intermediate
289436851e7fSLois Curfman McInnes 
289533174efeSLois Curfman McInnes .keywords: SNES, nonlinear, set, convergence, tolerances
28969b94acceSBarry Smith 
28972492ecdbSBarry Smith .seealso: SNESSetTrustRegionTolerance()
28989b94acceSBarry Smith @*/
28997087cfbeSBarry Smith PetscErrorCode  SNESSetTolerances(SNES snes,PetscReal abstol,PetscReal rtol,PetscReal stol,PetscInt maxit,PetscInt maxf)
29009b94acceSBarry Smith {
29013a40ed3dSBarry Smith   PetscFunctionBegin;
29020700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2903c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,abstol,2);
2904c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol,3);
2905c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,stol,4);
2906c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxit,5);
2907c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxf,6);
2908c5eb9154SBarry Smith 
2909ab54825eSJed Brown   if (abstol != PETSC_DEFAULT) {
2910ab54825eSJed Brown     if (abstol < 0.0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Absolute tolerance %G must be non-negative",abstol);
2911ab54825eSJed Brown     snes->abstol = abstol;
2912ab54825eSJed Brown   }
2913ab54825eSJed Brown   if (rtol != PETSC_DEFAULT) {
2914ab54825eSJed 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);
2915ab54825eSJed Brown     snes->rtol = rtol;
2916ab54825eSJed Brown   }
2917ab54825eSJed Brown   if (stol != PETSC_DEFAULT) {
2918ab54825eSJed Brown     if (stol < 0.0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Step tolerance %G must be non-negative",stol);
2919c60f73f4SPeter Brune     snes->stol = stol;
2920ab54825eSJed Brown   }
2921ab54825eSJed Brown   if (maxit != PETSC_DEFAULT) {
2922ab54825eSJed Brown     if (maxit < 0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of iterations %D must be non-negative",maxit);
2923ab54825eSJed Brown     snes->max_its = maxit;
2924ab54825eSJed Brown   }
2925ab54825eSJed Brown   if (maxf != PETSC_DEFAULT) {
2926ab54825eSJed Brown     if (maxf < 0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of function evaluations %D must be non-negative",maxf);
2927ab54825eSJed Brown     snes->max_funcs = maxf;
2928ab54825eSJed Brown   }
292988976e71SPeter Brune   snes->tolerancesset = PETSC_TRUE;
29303a40ed3dSBarry Smith   PetscFunctionReturn(0);
29319b94acceSBarry Smith }
29329b94acceSBarry Smith 
29334a2ae208SSatish Balay #undef __FUNCT__
29344a2ae208SSatish Balay #define __FUNCT__ "SNESGetTolerances"
29359b94acceSBarry Smith /*@
293633174efeSLois Curfman McInnes    SNESGetTolerances - Gets various parameters used in convergence tests.
293733174efeSLois Curfman McInnes 
2938c7afd0dbSLois Curfman McInnes    Not Collective
2939c7afd0dbSLois Curfman McInnes 
294033174efeSLois Curfman McInnes    Input Parameters:
2941c7afd0dbSLois Curfman McInnes +  snes - the SNES context
294285385478SLisandro Dalcin .  atol - absolute convergence tolerance
294333174efeSLois Curfman McInnes .  rtol - relative convergence tolerance
294433174efeSLois Curfman McInnes .  stol -  convergence tolerance in terms of the norm
294533174efeSLois Curfman McInnes            of the change in the solution between steps
294633174efeSLois Curfman McInnes .  maxit - maximum number of iterations
2947c7afd0dbSLois Curfman McInnes -  maxf - maximum number of function evaluations
2948fee21e36SBarry Smith 
294933174efeSLois Curfman McInnes    Notes:
295033174efeSLois Curfman McInnes    The user can specify PETSC_NULL for any parameter that is not needed.
295133174efeSLois Curfman McInnes 
295236851e7fSLois Curfman McInnes    Level: intermediate
295336851e7fSLois Curfman McInnes 
295433174efeSLois Curfman McInnes .keywords: SNES, nonlinear, get, convergence, tolerances
295533174efeSLois Curfman McInnes 
295633174efeSLois Curfman McInnes .seealso: SNESSetTolerances()
295733174efeSLois Curfman McInnes @*/
29587087cfbeSBarry Smith PetscErrorCode  SNESGetTolerances(SNES snes,PetscReal *atol,PetscReal *rtol,PetscReal *stol,PetscInt *maxit,PetscInt *maxf)
295933174efeSLois Curfman McInnes {
29603a40ed3dSBarry Smith   PetscFunctionBegin;
29610700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
296285385478SLisandro Dalcin   if (atol)  *atol  = snes->abstol;
296333174efeSLois Curfman McInnes   if (rtol)  *rtol  = snes->rtol;
2964c60f73f4SPeter Brune   if (stol)  *stol  = snes->stol;
296533174efeSLois Curfman McInnes   if (maxit) *maxit = snes->max_its;
296633174efeSLois Curfman McInnes   if (maxf)  *maxf  = snes->max_funcs;
29673a40ed3dSBarry Smith   PetscFunctionReturn(0);
296833174efeSLois Curfman McInnes }
296933174efeSLois Curfman McInnes 
29704a2ae208SSatish Balay #undef __FUNCT__
29714a2ae208SSatish Balay #define __FUNCT__ "SNESSetTrustRegionTolerance"
297233174efeSLois Curfman McInnes /*@
29739b94acceSBarry Smith    SNESSetTrustRegionTolerance - Sets the trust region parameter tolerance.
29749b94acceSBarry Smith 
29753f9fe445SBarry Smith    Logically Collective on SNES
2976fee21e36SBarry Smith 
2977c7afd0dbSLois Curfman McInnes    Input Parameters:
2978c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2979c7afd0dbSLois Curfman McInnes -  tol - tolerance
2980c7afd0dbSLois Curfman McInnes 
29819b94acceSBarry Smith    Options Database Key:
2982c7afd0dbSLois Curfman McInnes .  -snes_trtol <tol> - Sets tol
29839b94acceSBarry Smith 
298436851e7fSLois Curfman McInnes    Level: intermediate
298536851e7fSLois Curfman McInnes 
29869b94acceSBarry Smith .keywords: SNES, nonlinear, set, trust region, tolerance
29879b94acceSBarry Smith 
29882492ecdbSBarry Smith .seealso: SNESSetTolerances()
29899b94acceSBarry Smith @*/
29907087cfbeSBarry Smith PetscErrorCode  SNESSetTrustRegionTolerance(SNES snes,PetscReal tol)
29919b94acceSBarry Smith {
29923a40ed3dSBarry Smith   PetscFunctionBegin;
29930700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2994c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,tol,2);
29959b94acceSBarry Smith   snes->deltatol = tol;
29963a40ed3dSBarry Smith   PetscFunctionReturn(0);
29979b94acceSBarry Smith }
29989b94acceSBarry Smith 
2999df9fa365SBarry Smith /*
3000df9fa365SBarry Smith    Duplicate the lg monitors for SNES from KSP; for some reason with
3001df9fa365SBarry Smith    dynamic libraries things don't work under Sun4 if we just use
3002df9fa365SBarry Smith    macros instead of functions
3003df9fa365SBarry Smith */
30044a2ae208SSatish Balay #undef __FUNCT__
30054619e776SBarry Smith #define __FUNCT__ "SNESMonitorLGResidualNorm"
30064619e776SBarry Smith PetscErrorCode  SNESMonitorLGResidualNorm(SNES snes,PetscInt it,PetscReal norm,void *ctx)
3007ce1608b8SBarry Smith {
3008dfbe8321SBarry Smith   PetscErrorCode ierr;
3009ce1608b8SBarry Smith 
3010ce1608b8SBarry Smith   PetscFunctionBegin;
30110700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
30121d1e9da1SBarry Smith   ierr = KSPMonitorLGResidualNorm((KSP)snes,it,norm,ctx);CHKERRQ(ierr);
3013ce1608b8SBarry Smith   PetscFunctionReturn(0);
3014ce1608b8SBarry Smith }
3015ce1608b8SBarry Smith 
30164a2ae208SSatish Balay #undef __FUNCT__
3017a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGCreate"
30187087cfbeSBarry Smith PetscErrorCode  SNESMonitorLGCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw)
3019df9fa365SBarry Smith {
3020dfbe8321SBarry Smith   PetscErrorCode ierr;
3021df9fa365SBarry Smith 
3022df9fa365SBarry Smith   PetscFunctionBegin;
30231d1e9da1SBarry Smith   ierr = KSPMonitorLGResidualNormCreate(host,label,x,y,m,n,draw);CHKERRQ(ierr);
3024df9fa365SBarry Smith   PetscFunctionReturn(0);
3025df9fa365SBarry Smith }
3026df9fa365SBarry Smith 
30274a2ae208SSatish Balay #undef __FUNCT__
3028a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGDestroy"
30296bf464f9SBarry Smith PetscErrorCode  SNESMonitorLGDestroy(PetscDrawLG *draw)
3030df9fa365SBarry Smith {
3031dfbe8321SBarry Smith   PetscErrorCode ierr;
3032df9fa365SBarry Smith 
3033df9fa365SBarry Smith   PetscFunctionBegin;
30341d1e9da1SBarry Smith   ierr = KSPMonitorLGResidualNormDestroy(draw);CHKERRQ(ierr);
3035df9fa365SBarry Smith   PetscFunctionReturn(0);
3036df9fa365SBarry Smith }
3037df9fa365SBarry Smith 
30387087cfbeSBarry Smith extern PetscErrorCode  SNESMonitorRange_Private(SNES,PetscInt,PetscReal*);
3039b271bb04SBarry Smith #undef __FUNCT__
3040b271bb04SBarry Smith #define __FUNCT__ "SNESMonitorLGRange"
30417087cfbeSBarry Smith PetscErrorCode  SNESMonitorLGRange(SNES snes,PetscInt n,PetscReal rnorm,void *monctx)
3042b271bb04SBarry Smith {
3043b271bb04SBarry Smith   PetscDrawLG      lg;
3044b271bb04SBarry Smith   PetscErrorCode   ierr;
3045b271bb04SBarry Smith   PetscReal        x,y,per;
3046b271bb04SBarry Smith   PetscViewer      v = (PetscViewer)monctx;
3047b271bb04SBarry Smith   static PetscReal prev; /* should be in the context */
3048b271bb04SBarry Smith   PetscDraw        draw;
3049b271bb04SBarry Smith 
3050459f5d12SBarry Smith   PetscFunctionBegin;
3051b271bb04SBarry Smith   ierr   = PetscViewerDrawGetDrawLG(v,0,&lg);CHKERRQ(ierr);
3052b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
3053b271bb04SBarry Smith   ierr   = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
3054b271bb04SBarry Smith   ierr   = PetscDrawSetTitle(draw,"Residual norm");CHKERRQ(ierr);
3055b271bb04SBarry Smith   x = (PetscReal) n;
3056b271bb04SBarry Smith   if (rnorm > 0.0) y = log10(rnorm); else y = -15.0;
3057b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
3058b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
3059b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
3060b271bb04SBarry Smith   }
3061b271bb04SBarry Smith 
3062b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,1,&lg);CHKERRQ(ierr);
3063b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
3064b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
3065b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"% elemts > .2*max elemt");CHKERRQ(ierr);
3066b271bb04SBarry Smith   ierr =  SNESMonitorRange_Private(snes,n,&per);CHKERRQ(ierr);
3067b271bb04SBarry Smith   x = (PetscReal) n;
3068b271bb04SBarry Smith   y = 100.0*per;
3069b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
3070b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
3071b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
3072b271bb04SBarry Smith   }
3073b271bb04SBarry Smith 
3074b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,2,&lg);CHKERRQ(ierr);
3075b271bb04SBarry Smith   if (!n) {prev = rnorm;ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
3076b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
3077b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm");CHKERRQ(ierr);
3078b271bb04SBarry Smith   x = (PetscReal) n;
3079b271bb04SBarry Smith   y = (prev - rnorm)/prev;
3080b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
3081b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
3082b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
3083b271bb04SBarry Smith   }
3084b271bb04SBarry Smith 
3085b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,3,&lg);CHKERRQ(ierr);
3086b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
3087b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
3088b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm*(% > .2 max)");CHKERRQ(ierr);
3089b271bb04SBarry Smith   x = (PetscReal) n;
3090b271bb04SBarry Smith   y = (prev - rnorm)/(prev*per);
3091b271bb04SBarry Smith   if (n > 2) { /*skip initial crazy value */
3092b271bb04SBarry Smith     ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
3093b271bb04SBarry Smith   }
3094b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
3095b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
3096b271bb04SBarry Smith   }
3097b271bb04SBarry Smith   prev = rnorm;
3098b271bb04SBarry Smith   PetscFunctionReturn(0);
3099b271bb04SBarry Smith }
3100b271bb04SBarry Smith 
3101b271bb04SBarry Smith #undef __FUNCT__
31027a03ce2fSLisandro Dalcin #define __FUNCT__ "SNESMonitor"
3103228d79bcSJed Brown /*@
3104228d79bcSJed Brown    SNESMonitor - runs the user provided monitor routines, if they exist
3105228d79bcSJed Brown 
3106228d79bcSJed Brown    Collective on SNES
3107228d79bcSJed Brown 
3108228d79bcSJed Brown    Input Parameters:
3109228d79bcSJed Brown +  snes - nonlinear solver context obtained from SNESCreate()
3110228d79bcSJed Brown .  iter - iteration number
3111228d79bcSJed Brown -  rnorm - relative norm of the residual
3112228d79bcSJed Brown 
3113228d79bcSJed Brown    Notes:
3114228d79bcSJed Brown    This routine is called by the SNES implementations.
3115228d79bcSJed Brown    It does not typically need to be called by the user.
3116228d79bcSJed Brown 
3117228d79bcSJed Brown    Level: developer
3118228d79bcSJed Brown 
3119228d79bcSJed Brown .seealso: SNESMonitorSet()
3120228d79bcSJed Brown @*/
31217a03ce2fSLisandro Dalcin PetscErrorCode  SNESMonitor(SNES snes,PetscInt iter,PetscReal rnorm)
31227a03ce2fSLisandro Dalcin {
31237a03ce2fSLisandro Dalcin   PetscErrorCode ierr;
31247a03ce2fSLisandro Dalcin   PetscInt       i,n = snes->numbermonitors;
31257a03ce2fSLisandro Dalcin 
31267a03ce2fSLisandro Dalcin   PetscFunctionBegin;
31277a03ce2fSLisandro Dalcin   for (i=0; i<n; i++) {
31287a03ce2fSLisandro Dalcin     ierr = (*snes->monitor[i])(snes,iter,rnorm,snes->monitorcontext[i]);CHKERRQ(ierr);
31297a03ce2fSLisandro Dalcin   }
31307a03ce2fSLisandro Dalcin   PetscFunctionReturn(0);
31317a03ce2fSLisandro Dalcin }
31327a03ce2fSLisandro Dalcin 
31339b94acceSBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
31349b94acceSBarry Smith 
3135bf388a1fSBarry Smith /*MC
3136bf388a1fSBarry Smith     SNESMonitorFunction - functional form passed to SNESMonitorSet() to monitor convergence of nonlinear solver
3137bf388a1fSBarry Smith 
3138bf388a1fSBarry Smith      Synopsis:
3139bf388a1fSBarry Smith      #include "petscsnes.h"
3140bf388a1fSBarry Smith $    PetscErrorCode SNESMonitorFunction(SNES snes,PetscInt its, PetscReal norm,void *mctx)
3141bf388a1fSBarry Smith 
3142bf388a1fSBarry Smith +    snes - the SNES context
3143bf388a1fSBarry Smith .    its - iteration number
3144bf388a1fSBarry Smith .    norm - 2-norm function value (may be estimated)
3145bf388a1fSBarry Smith -    mctx - [optional] monitoring context
3146bf388a1fSBarry Smith 
3147bf388a1fSBarry Smith .seealso:   SNESMonitorSet(), SNESMonitorGet()
3148bf388a1fSBarry Smith M*/
3149bf388a1fSBarry Smith 
31504a2ae208SSatish Balay #undef __FUNCT__
3151a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorSet"
31529b94acceSBarry Smith /*@C
3153a6570f20SBarry Smith    SNESMonitorSet - Sets an ADDITIONAL function that is to be used at every
31549b94acceSBarry Smith    iteration of the nonlinear solver to display the iteration's
31559b94acceSBarry Smith    progress.
31569b94acceSBarry Smith 
31573f9fe445SBarry Smith    Logically Collective on SNES
3158fee21e36SBarry Smith 
3159c7afd0dbSLois Curfman McInnes    Input Parameters:
3160c7afd0dbSLois Curfman McInnes +  snes - the SNES context
3161bf388a1fSBarry Smith .  SNESMonitorFunction - monitoring routine
3162b8a78c4aSBarry Smith .  mctx - [optional] user-defined context for private data for the
3163e8105e01SRichard Katz           monitor routine (use PETSC_NULL if no context is desired)
3164b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
3165b3006f0bSLois Curfman McInnes           (may be PETSC_NULL)
31669b94acceSBarry Smith 
31679665c990SLois Curfman McInnes    Options Database Keys:
3168a6570f20SBarry Smith +    -snes_monitor        - sets SNESMonitorDefault()
31694619e776SBarry Smith .    -snes_monitor_lg_residualnorm    - sets line graph monitor,
3170a6570f20SBarry Smith                             uses SNESMonitorLGCreate()
3171cca6129bSJed Brown -    -snes_monitor_cancel - cancels all monitors that have
3172c7afd0dbSLois Curfman McInnes                             been hardwired into a code by
3173a6570f20SBarry Smith                             calls to SNESMonitorSet(), but
3174c7afd0dbSLois Curfman McInnes                             does not cancel those set via
3175c7afd0dbSLois Curfman McInnes                             the options database.
31769665c990SLois Curfman McInnes 
3177639f9d9dSBarry Smith    Notes:
31786bc08f3fSLois Curfman McInnes    Several different monitoring routines may be set by calling
3179a6570f20SBarry Smith    SNESMonitorSet() multiple times; all will be called in the
31806bc08f3fSLois Curfman McInnes    order in which they were set.
3181639f9d9dSBarry Smith 
3182025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each SNES object
3183025f1a04SBarry Smith 
318436851e7fSLois Curfman McInnes    Level: intermediate
318536851e7fSLois Curfman McInnes 
31869b94acceSBarry Smith .keywords: SNES, nonlinear, set, monitor
31879b94acceSBarry Smith 
3188bf388a1fSBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorCancel(), SNESMonitorFunction
31899b94acceSBarry Smith @*/
3190bf388a1fSBarry Smith PetscErrorCode  SNESMonitorSet(SNES snes,PetscErrorCode (*SNESMonitorFunction)(SNES,PetscInt,PetscReal,void*),void *mctx,PetscErrorCode (*monitordestroy)(void**))
31919b94acceSBarry Smith {
3192b90d0a6eSBarry Smith   PetscInt       i;
3193649052a6SBarry Smith   PetscErrorCode ierr;
3194b90d0a6eSBarry Smith 
31953a40ed3dSBarry Smith   PetscFunctionBegin;
31960700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
319717186662SBarry Smith   if (snes->numbermonitors >= MAXSNESMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3198b90d0a6eSBarry Smith   for (i=0; i<snes->numbermonitors;i++) {
3199bf388a1fSBarry Smith     if (SNESMonitorFunction == snes->monitor[i] && monitordestroy == snes->monitordestroy[i] && mctx == snes->monitorcontext[i]) {
3200649052a6SBarry Smith       if (monitordestroy) {
3201c2efdce3SBarry Smith         ierr = (*monitordestroy)(&mctx);CHKERRQ(ierr);
3202649052a6SBarry Smith       }
3203b90d0a6eSBarry Smith       PetscFunctionReturn(0);
3204b90d0a6eSBarry Smith     }
3205b90d0a6eSBarry Smith   }
3206bf388a1fSBarry Smith   snes->monitor[snes->numbermonitors]           = SNESMonitorFunction;
3207b8a78c4aSBarry Smith   snes->monitordestroy[snes->numbermonitors]    = monitordestroy;
3208639f9d9dSBarry Smith   snes->monitorcontext[snes->numbermonitors++]  = (void*)mctx;
32093a40ed3dSBarry Smith   PetscFunctionReturn(0);
32109b94acceSBarry Smith }
32119b94acceSBarry Smith 
32124a2ae208SSatish Balay #undef __FUNCT__
3213a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorCancel"
32145cd90555SBarry Smith /*@C
3215a6570f20SBarry Smith    SNESMonitorCancel - Clears all the monitor functions for a SNES object.
32165cd90555SBarry Smith 
32173f9fe445SBarry Smith    Logically Collective on SNES
3218c7afd0dbSLois Curfman McInnes 
32195cd90555SBarry Smith    Input Parameters:
32205cd90555SBarry Smith .  snes - the SNES context
32215cd90555SBarry Smith 
32221a480d89SAdministrator    Options Database Key:
3223a6570f20SBarry Smith .  -snes_monitor_cancel - cancels all monitors that have been hardwired
3224a6570f20SBarry Smith     into a code by calls to SNESMonitorSet(), but does not cancel those
3225c7afd0dbSLois Curfman McInnes     set via the options database
32265cd90555SBarry Smith 
32275cd90555SBarry Smith    Notes:
32285cd90555SBarry Smith    There is no way to clear one specific monitor from a SNES object.
32295cd90555SBarry Smith 
323036851e7fSLois Curfman McInnes    Level: intermediate
323136851e7fSLois Curfman McInnes 
32325cd90555SBarry Smith .keywords: SNES, nonlinear, set, monitor
32335cd90555SBarry Smith 
3234a6570f20SBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorSet()
32355cd90555SBarry Smith @*/
32367087cfbeSBarry Smith PetscErrorCode  SNESMonitorCancel(SNES snes)
32375cd90555SBarry Smith {
3238d952e501SBarry Smith   PetscErrorCode ierr;
3239d952e501SBarry Smith   PetscInt       i;
3240d952e501SBarry Smith 
32415cd90555SBarry Smith   PetscFunctionBegin;
32420700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3243d952e501SBarry Smith   for (i=0; i<snes->numbermonitors; i++) {
3244d952e501SBarry Smith     if (snes->monitordestroy[i]) {
32453c4aec1bSBarry Smith       ierr = (*snes->monitordestroy[i])(&snes->monitorcontext[i]);CHKERRQ(ierr);
3246d952e501SBarry Smith     }
3247d952e501SBarry Smith   }
32485cd90555SBarry Smith   snes->numbermonitors = 0;
32495cd90555SBarry Smith   PetscFunctionReturn(0);
32505cd90555SBarry Smith }
32515cd90555SBarry Smith 
3252bf388a1fSBarry Smith /*MC
3253bf388a1fSBarry Smith     SNESConvergenceTestFunction - functional form used for testing of convergence of nonlinear solver
3254bf388a1fSBarry Smith 
3255bf388a1fSBarry Smith      Synopsis:
3256bf388a1fSBarry Smith      #include "petscsnes.h"
3257bf388a1fSBarry Smith $     PetscErrorCode SNESConvergenceTest(SNES snes,PetscInt it,PetscReal xnorm,PetscReal gnorm,PetscReal f,SNESConvergedReason *reason,void *cctx)
3258bf388a1fSBarry Smith 
3259bf388a1fSBarry Smith +    snes - the SNES context
3260bf388a1fSBarry Smith .    it - current iteration (0 is the first and is before any Newton step)
3261bf388a1fSBarry Smith .    cctx - [optional] convergence context
3262bf388a1fSBarry Smith .    reason - reason for convergence/divergence
3263bf388a1fSBarry Smith .    xnorm - 2-norm of current iterate
3264bf388a1fSBarry Smith .    gnorm - 2-norm of current step
3265bf388a1fSBarry Smith -    f - 2-norm of function
3266bf388a1fSBarry Smith 
3267bf388a1fSBarry Smith 
3268bf388a1fSBarry Smith .seealso:   SNESSetConvergenceTest(), SNESGetConvergenceTest()
3269bf388a1fSBarry Smith M*/
3270bf388a1fSBarry Smith 
32714a2ae208SSatish Balay #undef __FUNCT__
32724a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceTest"
32739b94acceSBarry Smith /*@C
32749b94acceSBarry Smith    SNESSetConvergenceTest - Sets the function that is to be used
32759b94acceSBarry Smith    to test for convergence of the nonlinear iterative solution.
32769b94acceSBarry Smith 
32773f9fe445SBarry Smith    Logically Collective on SNES
3278fee21e36SBarry Smith 
3279c7afd0dbSLois Curfman McInnes    Input Parameters:
3280c7afd0dbSLois Curfman McInnes +  snes - the SNES context
3281bf388a1fSBarry Smith .  SNESConvergenceTestFunction - routine to test for convergence
32827f7931b9SBarry Smith .  cctx - [optional] context for private data for the convergence routine  (may be PETSC_NULL)
32837f7931b9SBarry Smith -  destroy - [optional] destructor for the context (may be PETSC_NULL; PETSC_NULL_FUNCTION in Fortran)
32849b94acceSBarry Smith 
328536851e7fSLois Curfman McInnes    Level: advanced
328636851e7fSLois Curfman McInnes 
32879b94acceSBarry Smith .keywords: SNES, nonlinear, set, convergence, test
32889b94acceSBarry Smith 
3289bf388a1fSBarry Smith .seealso: SNESDefaultConverged(), SNESSkipConverged(), SNESConvergenceTestFunction
32909b94acceSBarry Smith @*/
3291bf388a1fSBarry Smith PetscErrorCode  SNESSetConvergenceTest(SNES snes,PetscErrorCode (*SNESConvergenceTestFunction)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void *cctx,PetscErrorCode (*destroy)(void*))
32929b94acceSBarry Smith {
32937f7931b9SBarry Smith   PetscErrorCode ierr;
32947f7931b9SBarry Smith 
32953a40ed3dSBarry Smith   PetscFunctionBegin;
32960700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3297bf388a1fSBarry Smith   if (!SNESConvergenceTestFunction) SNESConvergenceTestFunction = SNESSkipConverged;
32987f7931b9SBarry Smith   if (snes->ops->convergeddestroy) {
32997f7931b9SBarry Smith     ierr = (*snes->ops->convergeddestroy)(snes->cnvP);CHKERRQ(ierr);
33007f7931b9SBarry Smith   }
3301bf388a1fSBarry Smith   snes->ops->converged        = SNESConvergenceTestFunction;
33027f7931b9SBarry Smith   snes->ops->convergeddestroy = destroy;
330385385478SLisandro Dalcin   snes->cnvP                  = cctx;
33043a40ed3dSBarry Smith   PetscFunctionReturn(0);
33059b94acceSBarry Smith }
33069b94acceSBarry Smith 
33074a2ae208SSatish Balay #undef __FUNCT__
33084a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergedReason"
330952baeb72SSatish Balay /*@
3310184914b5SBarry Smith    SNESGetConvergedReason - Gets the reason the SNES iteration was stopped.
3311184914b5SBarry Smith 
3312184914b5SBarry Smith    Not Collective
3313184914b5SBarry Smith 
3314184914b5SBarry Smith    Input Parameter:
3315184914b5SBarry Smith .  snes - the SNES context
3316184914b5SBarry Smith 
3317184914b5SBarry Smith    Output Parameter:
33184d0a8057SBarry Smith .  reason - negative value indicates diverged, positive value converged, see SNESConvergedReason or the
3319184914b5SBarry Smith             manual pages for the individual convergence tests for complete lists
3320184914b5SBarry Smith 
3321184914b5SBarry Smith    Level: intermediate
3322184914b5SBarry Smith 
3323184914b5SBarry Smith    Notes: Can only be called after the call the SNESSolve() is complete.
3324184914b5SBarry Smith 
3325184914b5SBarry Smith .keywords: SNES, nonlinear, set, convergence, test
3326184914b5SBarry Smith 
332785385478SLisandro Dalcin .seealso: SNESSetConvergenceTest(), SNESConvergedReason
3328184914b5SBarry Smith @*/
33297087cfbeSBarry Smith PetscErrorCode  SNESGetConvergedReason(SNES snes,SNESConvergedReason *reason)
3330184914b5SBarry Smith {
3331184914b5SBarry Smith   PetscFunctionBegin;
33320700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
33334482741eSBarry Smith   PetscValidPointer(reason,2);
3334184914b5SBarry Smith   *reason = snes->reason;
3335184914b5SBarry Smith   PetscFunctionReturn(0);
3336184914b5SBarry Smith }
3337184914b5SBarry Smith 
33384a2ae208SSatish Balay #undef __FUNCT__
33394a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceHistory"
3340c9005455SLois Curfman McInnes /*@
3341c9005455SLois Curfman McInnes    SNESSetConvergenceHistory - Sets the array used to hold the convergence history.
3342c9005455SLois Curfman McInnes 
33433f9fe445SBarry Smith    Logically Collective on SNES
3344fee21e36SBarry Smith 
3345c7afd0dbSLois Curfman McInnes    Input Parameters:
3346c7afd0dbSLois Curfman McInnes +  snes - iterative context obtained from SNESCreate()
33478c7482ecSBarry Smith .  a   - array to hold history, this array will contain the function norms computed at each step
3348cd5578b5SBarry Smith .  its - integer array holds the number of linear iterations for each solve.
3349758f92a0SBarry Smith .  na  - size of a and its
335064731454SLois Curfman McInnes -  reset - PETSC_TRUE indicates each new nonlinear solve resets the history counter to zero,
3351758f92a0SBarry Smith            else it continues storing new values for new nonlinear solves after the old ones
3352c7afd0dbSLois Curfman McInnes 
3353308dcc3eSBarry Smith    Notes:
3354308dcc3eSBarry Smith    If 'a' and 'its' are PETSC_NULL then space is allocated for the history. If 'na' PETSC_DECIDE or PETSC_DEFAULT then a
3355308dcc3eSBarry Smith    default array of length 10000 is allocated.
3356308dcc3eSBarry Smith 
3357c9005455SLois Curfman McInnes    This routine is useful, e.g., when running a code for purposes
3358c9005455SLois Curfman McInnes    of accurate performance monitoring, when no I/O should be done
3359c9005455SLois Curfman McInnes    during the section of code that is being timed.
3360c9005455SLois Curfman McInnes 
336136851e7fSLois Curfman McInnes    Level: intermediate
336236851e7fSLois Curfman McInnes 
3363c9005455SLois Curfman McInnes .keywords: SNES, set, convergence, history
3364758f92a0SBarry Smith 
336508405cd6SLois Curfman McInnes .seealso: SNESGetConvergenceHistory()
3366758f92a0SBarry Smith 
3367c9005455SLois Curfman McInnes @*/
33687087cfbeSBarry Smith PetscErrorCode  SNESSetConvergenceHistory(SNES snes,PetscReal a[],PetscInt its[],PetscInt na,PetscBool  reset)
3369c9005455SLois Curfman McInnes {
3370308dcc3eSBarry Smith   PetscErrorCode ierr;
3371308dcc3eSBarry Smith 
33723a40ed3dSBarry Smith   PetscFunctionBegin;
33730700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
33744482741eSBarry Smith   if (na)  PetscValidScalarPointer(a,2);
3375a562a398SLisandro Dalcin   if (its) PetscValidIntPointer(its,3);
3376308dcc3eSBarry Smith   if (na == PETSC_DECIDE || na == PETSC_DEFAULT || !a) {
3377308dcc3eSBarry Smith     if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000;
3378308dcc3eSBarry Smith     ierr = PetscMalloc(na*sizeof(PetscReal),&a);CHKERRQ(ierr);
3379308dcc3eSBarry Smith     ierr = PetscMalloc(na*sizeof(PetscInt),&its);CHKERRQ(ierr);
3380308dcc3eSBarry Smith     snes->conv_malloc   = PETSC_TRUE;
3381308dcc3eSBarry Smith   }
3382c9005455SLois Curfman McInnes   snes->conv_hist       = a;
3383758f92a0SBarry Smith   snes->conv_hist_its   = its;
3384758f92a0SBarry Smith   snes->conv_hist_max   = na;
3385a12bc48fSLisandro Dalcin   snes->conv_hist_len   = 0;
3386758f92a0SBarry Smith   snes->conv_hist_reset = reset;
3387758f92a0SBarry Smith   PetscFunctionReturn(0);
3388758f92a0SBarry Smith }
3389758f92a0SBarry Smith 
3390308dcc3eSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
3391c6db04a5SJed Brown #include <engine.h>   /* MATLAB include file */
3392c6db04a5SJed Brown #include <mex.h>      /* MATLAB include file */
3393308dcc3eSBarry Smith EXTERN_C_BEGIN
3394308dcc3eSBarry Smith #undef __FUNCT__
3395308dcc3eSBarry Smith #define __FUNCT__ "SNESGetConvergenceHistoryMatlab"
3396308dcc3eSBarry Smith mxArray *SNESGetConvergenceHistoryMatlab(SNES snes)
3397308dcc3eSBarry Smith {
3398308dcc3eSBarry Smith   mxArray   *mat;
3399308dcc3eSBarry Smith   PetscInt  i;
3400308dcc3eSBarry Smith   PetscReal *ar;
3401308dcc3eSBarry Smith 
3402308dcc3eSBarry Smith   PetscFunctionBegin;
3403308dcc3eSBarry Smith   mat  = mxCreateDoubleMatrix(snes->conv_hist_len,1,mxREAL);
3404308dcc3eSBarry Smith   ar   = (PetscReal*) mxGetData(mat);
3405308dcc3eSBarry Smith   for (i=0; i<snes->conv_hist_len; i++) {
3406308dcc3eSBarry Smith     ar[i] = snes->conv_hist[i];
3407308dcc3eSBarry Smith   }
3408308dcc3eSBarry Smith   PetscFunctionReturn(mat);
3409308dcc3eSBarry Smith }
3410308dcc3eSBarry Smith EXTERN_C_END
3411308dcc3eSBarry Smith #endif
3412308dcc3eSBarry Smith 
34134a2ae208SSatish Balay #undef __FUNCT__
34144a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergenceHistory"
34150c4c9dddSBarry Smith /*@C
3416758f92a0SBarry Smith    SNESGetConvergenceHistory - Gets the array used to hold the convergence history.
3417758f92a0SBarry Smith 
34183f9fe445SBarry Smith    Not Collective
3419758f92a0SBarry Smith 
3420758f92a0SBarry Smith    Input Parameter:
3421758f92a0SBarry Smith .  snes - iterative context obtained from SNESCreate()
3422758f92a0SBarry Smith 
3423758f92a0SBarry Smith    Output Parameters:
3424758f92a0SBarry Smith .  a   - array to hold history
3425758f92a0SBarry Smith .  its - integer array holds the number of linear iterations (or
3426758f92a0SBarry Smith          negative if not converged) for each solve.
3427758f92a0SBarry Smith -  na  - size of a and its
3428758f92a0SBarry Smith 
3429758f92a0SBarry Smith    Notes:
3430758f92a0SBarry Smith     The calling sequence for this routine in Fortran is
3431758f92a0SBarry Smith $   call SNESGetConvergenceHistory(SNES snes, integer na, integer ierr)
3432758f92a0SBarry Smith 
3433758f92a0SBarry Smith    This routine is useful, e.g., when running a code for purposes
3434758f92a0SBarry Smith    of accurate performance monitoring, when no I/O should be done
3435758f92a0SBarry Smith    during the section of code that is being timed.
3436758f92a0SBarry Smith 
3437758f92a0SBarry Smith    Level: intermediate
3438758f92a0SBarry Smith 
3439758f92a0SBarry Smith .keywords: SNES, get, convergence, history
3440758f92a0SBarry Smith 
3441758f92a0SBarry Smith .seealso: SNESSetConvergencHistory()
3442758f92a0SBarry Smith 
3443758f92a0SBarry Smith @*/
34447087cfbeSBarry Smith PetscErrorCode  SNESGetConvergenceHistory(SNES snes,PetscReal *a[],PetscInt *its[],PetscInt *na)
3445758f92a0SBarry Smith {
3446758f92a0SBarry Smith   PetscFunctionBegin;
34470700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3448758f92a0SBarry Smith   if (a)   *a   = snes->conv_hist;
3449758f92a0SBarry Smith   if (its) *its = snes->conv_hist_its;
3450758f92a0SBarry Smith   if (na)  *na  = snes->conv_hist_len;
34513a40ed3dSBarry Smith   PetscFunctionReturn(0);
3452c9005455SLois Curfman McInnes }
3453c9005455SLois Curfman McInnes 
3454e74ef692SMatthew Knepley #undef __FUNCT__
3455e74ef692SMatthew Knepley #define __FUNCT__ "SNESSetUpdate"
3456ac226902SBarry Smith /*@C
345776b2cf59SMatthew Knepley   SNESSetUpdate - Sets the general-purpose update function called
3458eec8f646SJed Brown   at the beginning of every iteration of the nonlinear solve. Specifically
34597e4bb74cSBarry Smith   it is called just before the Jacobian is "evaluated".
346076b2cf59SMatthew Knepley 
34613f9fe445SBarry Smith   Logically Collective on SNES
346276b2cf59SMatthew Knepley 
346376b2cf59SMatthew Knepley   Input Parameters:
346476b2cf59SMatthew Knepley . snes - The nonlinear solver context
346576b2cf59SMatthew Knepley . func - The function
346676b2cf59SMatthew Knepley 
346776b2cf59SMatthew Knepley   Calling sequence of func:
3468b5d30489SBarry Smith . func (SNES snes, PetscInt step);
346976b2cf59SMatthew Knepley 
347076b2cf59SMatthew Knepley . step - The current step of the iteration
347176b2cf59SMatthew Knepley 
3472fe97e370SBarry Smith   Level: advanced
3473fe97e370SBarry Smith 
3474fe97e370SBarry 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()
3475fe97e370SBarry Smith         This is not used by most users.
347676b2cf59SMatthew Knepley 
347776b2cf59SMatthew Knepley .keywords: SNES, update
3478b5d30489SBarry Smith 
347985385478SLisandro Dalcin .seealso SNESDefaultUpdate(), SNESSetJacobian(), SNESSolve()
348076b2cf59SMatthew Knepley @*/
34817087cfbeSBarry Smith PetscErrorCode  SNESSetUpdate(SNES snes, PetscErrorCode (*func)(SNES, PetscInt))
348276b2cf59SMatthew Knepley {
348376b2cf59SMatthew Knepley   PetscFunctionBegin;
34840700a824SBarry Smith   PetscValidHeaderSpecific(snes, SNES_CLASSID,1);
3485e7788613SBarry Smith   snes->ops->update = func;
348676b2cf59SMatthew Knepley   PetscFunctionReturn(0);
348776b2cf59SMatthew Knepley }
348876b2cf59SMatthew Knepley 
3489e74ef692SMatthew Knepley #undef __FUNCT__
3490e74ef692SMatthew Knepley #define __FUNCT__ "SNESDefaultUpdate"
349176b2cf59SMatthew Knepley /*@
349276b2cf59SMatthew Knepley   SNESDefaultUpdate - The default update function which does nothing.
349376b2cf59SMatthew Knepley 
349476b2cf59SMatthew Knepley   Not collective
349576b2cf59SMatthew Knepley 
349676b2cf59SMatthew Knepley   Input Parameters:
349776b2cf59SMatthew Knepley . snes - The nonlinear solver context
349876b2cf59SMatthew Knepley . step - The current step of the iteration
349976b2cf59SMatthew Knepley 
3500205452f4SMatthew Knepley   Level: intermediate
3501205452f4SMatthew Knepley 
350276b2cf59SMatthew Knepley .keywords: SNES, update
3503a6570f20SBarry Smith .seealso SNESSetUpdate(), SNESDefaultRhsBC(), SNESDefaultShortolutionBC()
350476b2cf59SMatthew Knepley @*/
35057087cfbeSBarry Smith PetscErrorCode  SNESDefaultUpdate(SNES snes, PetscInt step)
350676b2cf59SMatthew Knepley {
350776b2cf59SMatthew Knepley   PetscFunctionBegin;
350876b2cf59SMatthew Knepley   PetscFunctionReturn(0);
350976b2cf59SMatthew Knepley }
351076b2cf59SMatthew Knepley 
35114a2ae208SSatish Balay #undef __FUNCT__
35124a2ae208SSatish Balay #define __FUNCT__ "SNESScaleStep_Private"
35139b94acceSBarry Smith /*
35149b94acceSBarry Smith    SNESScaleStep_Private - Scales a step so that its length is less than the
35159b94acceSBarry Smith    positive parameter delta.
35169b94acceSBarry Smith 
35179b94acceSBarry Smith     Input Parameters:
3518c7afd0dbSLois Curfman McInnes +   snes - the SNES context
35199b94acceSBarry Smith .   y - approximate solution of linear system
35209b94acceSBarry Smith .   fnorm - 2-norm of current function
3521c7afd0dbSLois Curfman McInnes -   delta - trust region size
35229b94acceSBarry Smith 
35239b94acceSBarry Smith     Output Parameters:
3524c7afd0dbSLois Curfman McInnes +   gpnorm - predicted function norm at the new point, assuming local
35259b94acceSBarry Smith     linearization.  The value is zero if the step lies within the trust
35269b94acceSBarry Smith     region, and exceeds zero otherwise.
3527c7afd0dbSLois Curfman McInnes -   ynorm - 2-norm of the step
35289b94acceSBarry Smith 
35299b94acceSBarry Smith     Note:
353004d7464bSBarry Smith     For non-trust region methods such as SNESNEWTONLS, the parameter delta
35319b94acceSBarry Smith     is set to be the maximum allowable step size.
35329b94acceSBarry Smith 
35339b94acceSBarry Smith .keywords: SNES, nonlinear, scale, step
35349b94acceSBarry Smith */
3535dfbe8321SBarry Smith PetscErrorCode SNESScaleStep_Private(SNES snes,Vec y,PetscReal *fnorm,PetscReal *delta,PetscReal *gpnorm,PetscReal *ynorm)
35369b94acceSBarry Smith {
3537064f8208SBarry Smith   PetscReal      nrm;
3538ea709b57SSatish Balay   PetscScalar    cnorm;
3539dfbe8321SBarry Smith   PetscErrorCode ierr;
35403a40ed3dSBarry Smith 
35413a40ed3dSBarry Smith   PetscFunctionBegin;
35420700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
35430700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,2);
3544c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,y,2);
3545184914b5SBarry Smith 
3546064f8208SBarry Smith   ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr);
3547064f8208SBarry Smith   if (nrm > *delta) {
3548064f8208SBarry Smith      nrm = *delta/nrm;
3549064f8208SBarry Smith      *gpnorm = (1.0 - nrm)*(*fnorm);
3550064f8208SBarry Smith      cnorm = nrm;
35512dcb1b2aSMatthew Knepley      ierr = VecScale(y,cnorm);CHKERRQ(ierr);
35529b94acceSBarry Smith      *ynorm = *delta;
35539b94acceSBarry Smith   } else {
35549b94acceSBarry Smith      *gpnorm = 0.0;
3555064f8208SBarry Smith      *ynorm = nrm;
35569b94acceSBarry Smith   }
35573a40ed3dSBarry Smith   PetscFunctionReturn(0);
35589b94acceSBarry Smith }
35599b94acceSBarry Smith 
35604a2ae208SSatish Balay #undef __FUNCT__
35614a2ae208SSatish Balay #define __FUNCT__ "SNESSolve"
35626ce558aeSBarry Smith /*@C
3563f69a0ea3SMatthew Knepley    SNESSolve - Solves a nonlinear system F(x) = b.
3564f69a0ea3SMatthew Knepley    Call SNESSolve() after calling SNESCreate() and optional routines of the form SNESSetXXX().
35659b94acceSBarry Smith 
3566c7afd0dbSLois Curfman McInnes    Collective on SNES
3567c7afd0dbSLois Curfman McInnes 
3568b2002411SLois Curfman McInnes    Input Parameters:
3569c7afd0dbSLois Curfman McInnes +  snes - the SNES context
35703cebf274SJed Brown .  b - the constant part of the equation F(x) = b, or PETSC_NULL to use zero.
357185385478SLisandro Dalcin -  x - the solution vector.
35729b94acceSBarry Smith 
3573b2002411SLois Curfman McInnes    Notes:
35748ddd3da0SLois Curfman McInnes    The user should initialize the vector,x, with the initial guess
35758ddd3da0SLois Curfman McInnes    for the nonlinear solve prior to calling SNESSolve.  In particular,
35768ddd3da0SLois Curfman McInnes    to employ an initial guess of zero, the user should explicitly set
35778ddd3da0SLois Curfman McInnes    this vector to zero by calling VecSet().
35788ddd3da0SLois Curfman McInnes 
357936851e7fSLois Curfman McInnes    Level: beginner
358036851e7fSLois Curfman McInnes 
35819b94acceSBarry Smith .keywords: SNES, nonlinear, solve
35829b94acceSBarry Smith 
3583c0df2a02SJed Brown .seealso: SNESCreate(), SNESDestroy(), SNESSetFunction(), SNESSetJacobian(), SNESSetGridSequence(), SNESGetSolution()
35849b94acceSBarry Smith @*/
35857087cfbeSBarry Smith PetscErrorCode  SNESSolve(SNES snes,Vec b,Vec x)
35869b94acceSBarry Smith {
3587dfbe8321SBarry Smith   PetscErrorCode    ierr;
3588ace3abfcSBarry Smith   PetscBool         flg;
3589eabae89aSBarry Smith   PetscViewer       viewer;
3590efd51863SBarry Smith   PetscInt          grid;
3591a69afd8bSBarry Smith   Vec               xcreated = PETSC_NULL;
3592caa4e7f2SJed Brown   DM                dm;
3593cffb1e40SBarry Smith   PetscViewerFormat format;
3594052efed2SBarry Smith 
35953a40ed3dSBarry Smith   PetscFunctionBegin;
35960700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3597a69afd8bSBarry Smith   if (x) PetscValidHeaderSpecific(x,VEC_CLASSID,3);
3598a69afd8bSBarry Smith   if (x) PetscCheckSameComm(snes,1,x,3);
35990700a824SBarry Smith   if (b) PetscValidHeaderSpecific(b,VEC_CLASSID,2);
360085385478SLisandro Dalcin   if (b) PetscCheckSameComm(snes,1,b,2);
360185385478SLisandro Dalcin 
3602caa4e7f2SJed Brown   if (!x) {
3603caa4e7f2SJed Brown     ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
3604caa4e7f2SJed Brown     ierr = DMCreateGlobalVector(dm,&xcreated);CHKERRQ(ierr);
3605a69afd8bSBarry Smith     x    = xcreated;
3606a69afd8bSBarry Smith   }
3607a69afd8bSBarry Smith 
3608a8248277SBarry Smith   for (grid=0; grid<snes->gridsequence; grid++) {ierr = PetscViewerASCIIPushTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm));CHKERRQ(ierr);}
3609efd51863SBarry Smith   for (grid=0; grid<snes->gridsequence+1; grid++) {
3610efd51863SBarry Smith 
361185385478SLisandro Dalcin     /* set solution vector */
3612efd51863SBarry Smith     if (!grid) {ierr = PetscObjectReference((PetscObject)x);CHKERRQ(ierr);}
36136bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr);
361485385478SLisandro Dalcin     snes->vec_sol = x;
3615caa4e7f2SJed Brown     ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
3616caa4e7f2SJed Brown 
3617caa4e7f2SJed Brown     /* set affine vector if provided */
361885385478SLisandro Dalcin     if (b) { ierr = PetscObjectReference((PetscObject)b);CHKERRQ(ierr); }
36196bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr);
362085385478SLisandro Dalcin     snes->vec_rhs = b;
362185385478SLisandro Dalcin 
362270e92668SMatthew Knepley     ierr = SNESSetUp(snes);CHKERRQ(ierr);
36233f149594SLisandro Dalcin 
36247eee914bSBarry Smith     if (!grid) {
36257eee914bSBarry Smith       if (snes->ops->computeinitialguess) {
3626d25893d9SBarry Smith         ierr = (*snes->ops->computeinitialguess)(snes,snes->vec_sol,snes->initialguessP);CHKERRQ(ierr);
3627d25893d9SBarry Smith       }
3628dd568438SSatish Balay     }
3629d25893d9SBarry Smith 
3630abc0a331SBarry Smith     if (snes->conv_hist_reset) snes->conv_hist_len = 0;
363150ffb88aSMatthew Knepley     snes->nfuncs = 0; snes->linear_its = 0; snes->numFailures = 0;
3632d5e45103SBarry Smith 
36333f149594SLisandro Dalcin     ierr = PetscLogEventBegin(SNES_Solve,snes,0,0,0);CHKERRQ(ierr);
36344936397dSBarry Smith     ierr = (*snes->ops->solve)(snes);CHKERRQ(ierr);
363585385478SLisandro Dalcin     ierr = PetscLogEventEnd(SNES_Solve,snes,0,0,0);CHKERRQ(ierr);
36364936397dSBarry Smith     if (snes->domainerror) {
36374936397dSBarry Smith       snes->reason      = SNES_DIVERGED_FUNCTION_DOMAIN;
36384936397dSBarry Smith       snes->domainerror = PETSC_FALSE;
36394936397dSBarry Smith     }
364017186662SBarry Smith     if (!snes->reason) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Internal error, solver returned without setting converged reason");
36413f149594SLisandro Dalcin 
364290d69ab7SBarry Smith     flg  = PETSC_FALSE;
3643acfcf0e5SJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_test_local_min",&flg,PETSC_NULL);CHKERRQ(ierr);
3644da9b6338SBarry Smith     if (flg && !PetscPreLoadingOn) { ierr = SNESTestLocalMin(snes);CHKERRQ(ierr); }
36455968eb51SBarry Smith     if (snes->printreason) {
3646a8248277SBarry Smith       ierr = PetscViewerASCIIAddTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),((PetscObject)snes)->tablevel);CHKERRQ(ierr);
36475968eb51SBarry Smith       if (snes->reason > 0) {
3648c7e7b494SJed Brown         ierr = PetscViewerASCIIPrintf(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),"Nonlinear solve converged due to %s iterations %D\n",SNESConvergedReasons[snes->reason],snes->iter);CHKERRQ(ierr);
36495968eb51SBarry Smith       } else {
3650c7e7b494SJed Brown         ierr = PetscViewerASCIIPrintf(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),"Nonlinear solve did not converge due to %s iterations %D\n",SNESConvergedReasons[snes->reason],snes->iter);CHKERRQ(ierr);
36515968eb51SBarry Smith       }
3652a8248277SBarry Smith       ierr = PetscViewerASCIISubtractTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),((PetscObject)snes)->tablevel);CHKERRQ(ierr);
36535968eb51SBarry Smith     }
36545968eb51SBarry Smith 
3655e113a28aSBarry Smith     if (snes->errorifnotconverged && snes->reason < 0) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_NOT_CONVERGED,"SNESSolve has not converged");
3656efd51863SBarry Smith     if (grid <  snes->gridsequence) {
3657efd51863SBarry Smith       DM  fine;
3658efd51863SBarry Smith       Vec xnew;
3659efd51863SBarry Smith       Mat interp;
3660efd51863SBarry Smith 
3661efd51863SBarry Smith       ierr = DMRefine(snes->dm,((PetscObject)snes)->comm,&fine);CHKERRQ(ierr);
3662c5c77316SJed Brown       if (!fine) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_ARG_INCOMP,"DMRefine() did not perform any refinement, cannot continue grid sequencing");
3663e727c939SJed Brown       ierr = DMCreateInterpolation(snes->dm,fine,&interp,PETSC_NULL);CHKERRQ(ierr);
3664efd51863SBarry Smith       ierr = DMCreateGlobalVector(fine,&xnew);CHKERRQ(ierr);
3665efd51863SBarry Smith       ierr = MatInterpolate(interp,x,xnew);CHKERRQ(ierr);
3666c833c3b5SJed Brown       ierr = DMInterpolate(snes->dm,interp,fine);CHKERRQ(ierr);
3667efd51863SBarry Smith       ierr = MatDestroy(&interp);CHKERRQ(ierr);
3668efd51863SBarry Smith       x    = xnew;
3669efd51863SBarry Smith 
3670efd51863SBarry Smith       ierr = SNESReset(snes);CHKERRQ(ierr);
3671efd51863SBarry Smith       ierr = SNESSetDM(snes,fine);CHKERRQ(ierr);
3672efd51863SBarry Smith       ierr = DMDestroy(&fine);CHKERRQ(ierr);
3673a8248277SBarry Smith       ierr = PetscViewerASCIIPopTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm));CHKERRQ(ierr);
3674efd51863SBarry Smith     }
3675efd51863SBarry Smith   }
36763f7e2da0SPeter Brune   /* monitoring and viewing */
3677cffb1e40SBarry Smith   ierr = PetscOptionsGetViewer(((PetscObject)snes)->comm,((PetscObject)snes)->prefix,"-snes_view",&viewer,&format,&flg);CHKERRQ(ierr);
36783f7e2da0SPeter Brune   if (flg && !PetscPreLoadingOn) {
3679cffb1e40SBarry Smith     ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr);
36803f7e2da0SPeter Brune     ierr = SNESView(snes,viewer);CHKERRQ(ierr);
3681cffb1e40SBarry Smith     ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3682cffb1e40SBarry Smith     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
368372a02f06SBarry Smith   }
36840d2bece7SBarry Smith   ierr = VecViewFromOptions(snes->vec_sol,"-snes_view_solution");CHKERRQ(ierr);
36853f7e2da0SPeter Brune 
3686a69afd8bSBarry Smith   ierr = VecDestroy(&xcreated);CHKERRQ(ierr);
36873a40ed3dSBarry Smith   PetscFunctionReturn(0);
36889b94acceSBarry Smith }
36899b94acceSBarry Smith 
36909b94acceSBarry Smith /* --------- Internal routines for SNES Package --------- */
36919b94acceSBarry Smith 
36924a2ae208SSatish Balay #undef __FUNCT__
36934a2ae208SSatish Balay #define __FUNCT__ "SNESSetType"
369482bf6240SBarry Smith /*@C
36954b0e389bSBarry Smith    SNESSetType - Sets the method for the nonlinear solver.
36969b94acceSBarry Smith 
3697fee21e36SBarry Smith    Collective on SNES
3698fee21e36SBarry Smith 
3699c7afd0dbSLois Curfman McInnes    Input Parameters:
3700c7afd0dbSLois Curfman McInnes +  snes - the SNES context
3701454a90a3SBarry Smith -  type - a known method
3702c7afd0dbSLois Curfman McInnes 
3703c7afd0dbSLois Curfman McInnes    Options Database Key:
3704454a90a3SBarry Smith .  -snes_type <type> - Sets the method; use -help for a list
370504d7464bSBarry Smith    of available methods (for instance, newtonls or newtontr)
3706ae12b187SLois Curfman McInnes 
37079b94acceSBarry Smith    Notes:
3708e090d566SSatish Balay    See "petsc/include/petscsnes.h" for available methods (for instance)
370904d7464bSBarry Smith +    SNESNEWTONLS - Newton's method with line search
3710c7afd0dbSLois Curfman McInnes      (systems of nonlinear equations)
371104d7464bSBarry Smith .    SNESNEWTONTR - Newton's method with trust region
3712c7afd0dbSLois Curfman McInnes      (systems of nonlinear equations)
37139b94acceSBarry Smith 
3714ae12b187SLois Curfman McInnes   Normally, it is best to use the SNESSetFromOptions() command and then
3715ae12b187SLois Curfman McInnes   set the SNES solver type from the options database rather than by using
3716ae12b187SLois Curfman McInnes   this routine.  Using the options database provides the user with
3717ae12b187SLois Curfman McInnes   maximum flexibility in evaluating the many nonlinear solvers.
3718ae12b187SLois Curfman McInnes   The SNESSetType() routine is provided for those situations where it
3719ae12b187SLois Curfman McInnes   is necessary to set the nonlinear solver independently of the command
3720ae12b187SLois Curfman McInnes   line or options database.  This might be the case, for example, when
3721ae12b187SLois Curfman McInnes   the choice of solver changes during the execution of the program,
3722ae12b187SLois Curfman McInnes   and the user's application is taking responsibility for choosing the
3723b0a32e0cSBarry Smith   appropriate method.
372436851e7fSLois Curfman McInnes 
372536851e7fSLois Curfman McInnes   Level: intermediate
3726a703fe33SLois Curfman McInnes 
3727454a90a3SBarry Smith .keywords: SNES, set, type
3728435da068SBarry Smith 
3729435da068SBarry Smith .seealso: SNESType, SNESCreate()
3730435da068SBarry Smith 
37319b94acceSBarry Smith @*/
373219fd82e9SBarry Smith PetscErrorCode  SNESSetType(SNES snes,SNESType type)
37339b94acceSBarry Smith {
3734dfbe8321SBarry Smith   PetscErrorCode ierr,(*r)(SNES);
3735ace3abfcSBarry Smith   PetscBool      match;
37363a40ed3dSBarry Smith 
37373a40ed3dSBarry Smith   PetscFunctionBegin;
37380700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
37394482741eSBarry Smith   PetscValidCharPointer(type,2);
374082bf6240SBarry Smith 
3741251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)snes,type,&match);CHKERRQ(ierr);
37420f5bd95cSBarry Smith   if (match) PetscFunctionReturn(0);
374392ff6ae8SBarry Smith 
3744140e18c1SBarry Smith   ierr =  PetscFunctionListFind(((PetscObject)snes)->comm,SNESList,type,PETSC_TRUE,(void (**)(void)) &r);CHKERRQ(ierr);
3745e32f2f54SBarry Smith   if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested SNES type %s",type);
374675396ef9SLisandro Dalcin   /* Destroy the previous private SNES context */
3747b5c23020SJed Brown   if (snes->ops->destroy) {
3748b5c23020SJed Brown     ierr = (*(snes)->ops->destroy)(snes);CHKERRQ(ierr);
3749b5c23020SJed Brown     snes->ops->destroy = PETSC_NULL;
3750b5c23020SJed Brown   }
375175396ef9SLisandro Dalcin   /* Reinitialize function pointers in SNESOps structure */
375275396ef9SLisandro Dalcin   snes->ops->setup          = 0;
375375396ef9SLisandro Dalcin   snes->ops->solve          = 0;
375475396ef9SLisandro Dalcin   snes->ops->view           = 0;
375575396ef9SLisandro Dalcin   snes->ops->setfromoptions = 0;
375675396ef9SLisandro Dalcin   snes->ops->destroy        = 0;
375775396ef9SLisandro Dalcin   /* Call the SNESCreate_XXX routine for this particular Nonlinear solver */
375875396ef9SLisandro Dalcin   snes->setupcalled = PETSC_FALSE;
3759454a90a3SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)snes,type);CHKERRQ(ierr);
376003bfa161SLisandro Dalcin   ierr = (*r)(snes);CHKERRQ(ierr);
37619fb22e1aSBarry Smith #if defined(PETSC_HAVE_AMS)
37629fb22e1aSBarry Smith   if (PetscAMSPublishAll) {
37639fb22e1aSBarry Smith     ierr = PetscObjectAMSPublish((PetscObject)snes);CHKERRQ(ierr);
37649fb22e1aSBarry Smith   }
37659fb22e1aSBarry Smith #endif
37663a40ed3dSBarry Smith   PetscFunctionReturn(0);
37679b94acceSBarry Smith }
37689b94acceSBarry Smith 
37699b94acceSBarry Smith /* --------------------------------------------------------------------- */
37704a2ae208SSatish Balay #undef __FUNCT__
37714a2ae208SSatish Balay #define __FUNCT__ "SNESRegisterDestroy"
377252baeb72SSatish Balay /*@
37739b94acceSBarry Smith    SNESRegisterDestroy - Frees the list of nonlinear solvers that were
3774f1af5d2fSBarry Smith    registered by SNESRegisterDynamic().
37759b94acceSBarry Smith 
3776fee21e36SBarry Smith    Not Collective
3777fee21e36SBarry Smith 
377836851e7fSLois Curfman McInnes    Level: advanced
377936851e7fSLois Curfman McInnes 
37809b94acceSBarry Smith .keywords: SNES, nonlinear, register, destroy
37819b94acceSBarry Smith 
378277f415f2SJed Brown .seealso: SNESRegisterAll()
37839b94acceSBarry Smith @*/
37847087cfbeSBarry Smith PetscErrorCode  SNESRegisterDestroy(void)
37859b94acceSBarry Smith {
3786dfbe8321SBarry Smith   PetscErrorCode ierr;
378782bf6240SBarry Smith 
37883a40ed3dSBarry Smith   PetscFunctionBegin;
3789140e18c1SBarry Smith   ierr = PetscFunctionListDestroy(&SNESList);CHKERRQ(ierr);
37904c49b128SBarry Smith   SNESRegisterAllCalled = PETSC_FALSE;
37913a40ed3dSBarry Smith   PetscFunctionReturn(0);
37929b94acceSBarry Smith }
37939b94acceSBarry Smith 
37944a2ae208SSatish Balay #undef __FUNCT__
37954a2ae208SSatish Balay #define __FUNCT__ "SNESGetType"
37969b94acceSBarry Smith /*@C
37979a28b0a6SLois Curfman McInnes    SNESGetType - Gets the SNES method type and name (as a string).
37989b94acceSBarry Smith 
3799c7afd0dbSLois Curfman McInnes    Not Collective
3800c7afd0dbSLois Curfman McInnes 
38019b94acceSBarry Smith    Input Parameter:
38024b0e389bSBarry Smith .  snes - nonlinear solver context
38039b94acceSBarry Smith 
38049b94acceSBarry Smith    Output Parameter:
38053a7fca6bSBarry Smith .  type - SNES method (a character string)
38069b94acceSBarry Smith 
380736851e7fSLois Curfman McInnes    Level: intermediate
380836851e7fSLois Curfman McInnes 
3809454a90a3SBarry Smith .keywords: SNES, nonlinear, get, type, name
38109b94acceSBarry Smith @*/
381119fd82e9SBarry Smith PetscErrorCode  SNESGetType(SNES snes,SNESType *type)
38129b94acceSBarry Smith {
38133a40ed3dSBarry Smith   PetscFunctionBegin;
38140700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
38154482741eSBarry Smith   PetscValidPointer(type,2);
38167adad957SLisandro Dalcin   *type = ((PetscObject)snes)->type_name;
38173a40ed3dSBarry Smith   PetscFunctionReturn(0);
38189b94acceSBarry Smith }
38199b94acceSBarry Smith 
38204a2ae208SSatish Balay #undef __FUNCT__
38214a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolution"
382252baeb72SSatish Balay /*@
38239b94acceSBarry Smith    SNESGetSolution - Returns the vector where the approximate solution is
3824c0df2a02SJed Brown    stored. This is the fine grid solution when using SNESSetGridSequence().
38259b94acceSBarry Smith 
3826c7afd0dbSLois Curfman McInnes    Not Collective, but Vec is parallel if SNES is parallel
3827c7afd0dbSLois Curfman McInnes 
38289b94acceSBarry Smith    Input Parameter:
38299b94acceSBarry Smith .  snes - the SNES context
38309b94acceSBarry Smith 
38319b94acceSBarry Smith    Output Parameter:
38329b94acceSBarry Smith .  x - the solution
38339b94acceSBarry Smith 
383470e92668SMatthew Knepley    Level: intermediate
383536851e7fSLois Curfman McInnes 
38369b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution
38379b94acceSBarry Smith 
383885385478SLisandro Dalcin .seealso:  SNESGetSolutionUpdate(), SNESGetFunction()
38399b94acceSBarry Smith @*/
38407087cfbeSBarry Smith PetscErrorCode  SNESGetSolution(SNES snes,Vec *x)
38419b94acceSBarry Smith {
38423a40ed3dSBarry Smith   PetscFunctionBegin;
38430700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
38444482741eSBarry Smith   PetscValidPointer(x,2);
384585385478SLisandro Dalcin   *x = snes->vec_sol;
384670e92668SMatthew Knepley   PetscFunctionReturn(0);
384770e92668SMatthew Knepley }
384870e92668SMatthew Knepley 
384970e92668SMatthew Knepley #undef __FUNCT__
38504a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolutionUpdate"
385152baeb72SSatish Balay /*@
38529b94acceSBarry Smith    SNESGetSolutionUpdate - Returns the vector where the solution update is
38539b94acceSBarry Smith    stored.
38549b94acceSBarry Smith 
3855c7afd0dbSLois Curfman McInnes    Not Collective, but Vec is parallel if SNES is parallel
3856c7afd0dbSLois Curfman McInnes 
38579b94acceSBarry Smith    Input Parameter:
38589b94acceSBarry Smith .  snes - the SNES context
38599b94acceSBarry Smith 
38609b94acceSBarry Smith    Output Parameter:
38619b94acceSBarry Smith .  x - the solution update
38629b94acceSBarry Smith 
386336851e7fSLois Curfman McInnes    Level: advanced
386436851e7fSLois Curfman McInnes 
38659b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution, update
38669b94acceSBarry Smith 
386785385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction()
38689b94acceSBarry Smith @*/
38697087cfbeSBarry Smith PetscErrorCode  SNESGetSolutionUpdate(SNES snes,Vec *x)
38709b94acceSBarry Smith {
38713a40ed3dSBarry Smith   PetscFunctionBegin;
38720700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
38734482741eSBarry Smith   PetscValidPointer(x,2);
387485385478SLisandro Dalcin   *x = snes->vec_sol_update;
38753a40ed3dSBarry Smith   PetscFunctionReturn(0);
38769b94acceSBarry Smith }
38779b94acceSBarry Smith 
38784a2ae208SSatish Balay #undef __FUNCT__
38794a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunction"
38809b94acceSBarry Smith /*@C
38813638b69dSLois Curfman McInnes    SNESGetFunction - Returns the vector where the function is stored.
38829b94acceSBarry Smith 
3883a63bb30eSJed Brown    Not Collective, but Vec is parallel if SNES is parallel. Collective if Vec is requested, but has not been created yet.
3884c7afd0dbSLois Curfman McInnes 
38859b94acceSBarry Smith    Input Parameter:
38869b94acceSBarry Smith .  snes - the SNES context
38879b94acceSBarry Smith 
38889b94acceSBarry Smith    Output Parameter:
3889bf388a1fSBarry Smith +  r - the vector that is used to store residuals (or PETSC_NULL if you don't want it)
3890bf388a1fSBarry Smith .  SNESFunction- the function (or PETSC_NULL if you don't want it)
3891bf388a1fSBarry Smith -  ctx - the function context (or PETSC_NULL if you don't want it)
38929b94acceSBarry Smith 
389336851e7fSLois Curfman McInnes    Level: advanced
389436851e7fSLois Curfman McInnes 
3895a86d99e1SLois Curfman McInnes .keywords: SNES, nonlinear, get, function
38969b94acceSBarry Smith 
3897bf388a1fSBarry Smith .seealso: SNESSetFunction(), SNESGetSolution(), SNESFunction
38989b94acceSBarry Smith @*/
3899bf388a1fSBarry Smith PetscErrorCode  SNESGetFunction(SNES snes,Vec *r,PetscErrorCode (**SNESFunction)(SNES,Vec,Vec,void*),void **ctx)
39009b94acceSBarry Smith {
3901a63bb30eSJed Brown   PetscErrorCode ierr;
39026cab3a1bSJed Brown   DM             dm;
3903a63bb30eSJed Brown 
39043a40ed3dSBarry Smith   PetscFunctionBegin;
39050700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3906a63bb30eSJed Brown   if (r) {
3907a63bb30eSJed Brown     if (!snes->vec_func) {
3908a63bb30eSJed Brown       if (snes->vec_rhs) {
3909a63bb30eSJed Brown         ierr = VecDuplicate(snes->vec_rhs,&snes->vec_func);CHKERRQ(ierr);
3910a63bb30eSJed Brown       } else if (snes->vec_sol) {
3911a63bb30eSJed Brown         ierr = VecDuplicate(snes->vec_sol,&snes->vec_func);CHKERRQ(ierr);
3912a63bb30eSJed Brown       } else if (snes->dm) {
3913a63bb30eSJed Brown         ierr = DMCreateGlobalVector(snes->dm,&snes->vec_func);CHKERRQ(ierr);
3914a63bb30eSJed Brown       }
3915a63bb30eSJed Brown     }
3916a63bb30eSJed Brown     *r = snes->vec_func;
3917a63bb30eSJed Brown   }
39186cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
3919bf388a1fSBarry Smith   ierr = DMSNESGetFunction(dm,SNESFunction,ctx);CHKERRQ(ierr);
39203a40ed3dSBarry Smith   PetscFunctionReturn(0);
39219b94acceSBarry Smith }
39229b94acceSBarry Smith 
3923c79ef259SPeter Brune /*@C
3924c79ef259SPeter Brune    SNESGetGS - Returns the GS function and context.
3925c79ef259SPeter Brune 
3926c79ef259SPeter Brune    Input Parameter:
3927c79ef259SPeter Brune .  snes - the SNES context
3928c79ef259SPeter Brune 
3929c79ef259SPeter Brune    Output Parameter:
3930bf388a1fSBarry Smith +  SNESGSFunction - the function (or PETSC_NULL)
3931c79ef259SPeter Brune -  ctx    - the function context (or PETSC_NULL)
3932c79ef259SPeter Brune 
3933c79ef259SPeter Brune    Level: advanced
3934c79ef259SPeter Brune 
3935c79ef259SPeter Brune .keywords: SNES, nonlinear, get, function
3936c79ef259SPeter Brune 
3937c79ef259SPeter Brune .seealso: SNESSetGS(), SNESGetFunction()
3938c79ef259SPeter Brune @*/
3939c79ef259SPeter Brune 
39404a2ae208SSatish Balay #undef __FUNCT__
3941646217ecSPeter Brune #define __FUNCT__ "SNESGetGS"
3942bf388a1fSBarry Smith PetscErrorCode SNESGetGS (SNES snes, PetscErrorCode (**SNESGSFunction)(SNES, Vec, Vec, void*), void ** ctx)
3943646217ecSPeter Brune {
39446cab3a1bSJed Brown   PetscErrorCode ierr;
39456cab3a1bSJed Brown   DM             dm;
39466cab3a1bSJed Brown 
3947646217ecSPeter Brune   PetscFunctionBegin;
3948646217ecSPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
39496cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
3950bf388a1fSBarry Smith   ierr = DMSNESGetGS(dm,SNESGSFunction,ctx);CHKERRQ(ierr);
3951646217ecSPeter Brune   PetscFunctionReturn(0);
3952646217ecSPeter Brune }
3953646217ecSPeter Brune 
39544a2ae208SSatish Balay #undef __FUNCT__
39554a2ae208SSatish Balay #define __FUNCT__ "SNESSetOptionsPrefix"
39563c7409f5SSatish Balay /*@C
39573c7409f5SSatish Balay    SNESSetOptionsPrefix - Sets the prefix used for searching for all
3958d850072dSLois Curfman McInnes    SNES options in the database.
39593c7409f5SSatish Balay 
39603f9fe445SBarry Smith    Logically Collective on SNES
3961fee21e36SBarry Smith 
3962c7afd0dbSLois Curfman McInnes    Input Parameter:
3963c7afd0dbSLois Curfman McInnes +  snes - the SNES context
3964c7afd0dbSLois Curfman McInnes -  prefix - the prefix to prepend to all option names
3965c7afd0dbSLois Curfman McInnes 
3966d850072dSLois Curfman McInnes    Notes:
3967a83b1b31SSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
3968c7afd0dbSLois Curfman McInnes    The first character of all runtime options is AUTOMATICALLY the hyphen.
3969d850072dSLois Curfman McInnes 
397036851e7fSLois Curfman McInnes    Level: advanced
397136851e7fSLois Curfman McInnes 
39723c7409f5SSatish Balay .keywords: SNES, set, options, prefix, database
3973a86d99e1SLois Curfman McInnes 
3974a86d99e1SLois Curfman McInnes .seealso: SNESSetFromOptions()
39753c7409f5SSatish Balay @*/
39767087cfbeSBarry Smith PetscErrorCode  SNESSetOptionsPrefix(SNES snes,const char prefix[])
39773c7409f5SSatish Balay {
3978dfbe8321SBarry Smith   PetscErrorCode ierr;
39793c7409f5SSatish Balay 
39803a40ed3dSBarry Smith   PetscFunctionBegin;
39810700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3982639f9d9dSBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
39831cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
398435f5d045SPeter Brune   if (snes->linesearch) {
398535f5d045SPeter Brune     ierr = SNESGetSNESLineSearch(snes,&snes->linesearch);CHKERRQ(ierr);
398608b6c495SPeter Brune     ierr = PetscObjectSetOptionsPrefix((PetscObject)snes->linesearch,prefix);CHKERRQ(ierr);
398735f5d045SPeter Brune   }
398835f5d045SPeter Brune   ierr = KSPSetOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr);
39893a40ed3dSBarry Smith   PetscFunctionReturn(0);
39903c7409f5SSatish Balay }
39913c7409f5SSatish Balay 
39924a2ae208SSatish Balay #undef __FUNCT__
39934a2ae208SSatish Balay #define __FUNCT__ "SNESAppendOptionsPrefix"
39943c7409f5SSatish Balay /*@C
3995f525115eSLois Curfman McInnes    SNESAppendOptionsPrefix - Appends to the prefix used for searching for all
3996d850072dSLois Curfman McInnes    SNES options in the database.
39973c7409f5SSatish Balay 
39983f9fe445SBarry Smith    Logically Collective on SNES
3999fee21e36SBarry Smith 
4000c7afd0dbSLois Curfman McInnes    Input Parameters:
4001c7afd0dbSLois Curfman McInnes +  snes - the SNES context
4002c7afd0dbSLois Curfman McInnes -  prefix - the prefix to prepend to all option names
4003c7afd0dbSLois Curfman McInnes 
4004d850072dSLois Curfman McInnes    Notes:
4005a83b1b31SSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
4006c7afd0dbSLois Curfman McInnes    The first character of all runtime options is AUTOMATICALLY the hyphen.
4007d850072dSLois Curfman McInnes 
400836851e7fSLois Curfman McInnes    Level: advanced
400936851e7fSLois Curfman McInnes 
40103c7409f5SSatish Balay .keywords: SNES, append, options, prefix, database
4011a86d99e1SLois Curfman McInnes 
4012a86d99e1SLois Curfman McInnes .seealso: SNESGetOptionsPrefix()
40133c7409f5SSatish Balay @*/
40147087cfbeSBarry Smith PetscErrorCode  SNESAppendOptionsPrefix(SNES snes,const char prefix[])
40153c7409f5SSatish Balay {
4016dfbe8321SBarry Smith   PetscErrorCode ierr;
40173c7409f5SSatish Balay 
40183a40ed3dSBarry Smith   PetscFunctionBegin;
40190700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4020639f9d9dSBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
40211cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
402235f5d045SPeter Brune   if (snes->linesearch) {
402335f5d045SPeter Brune     ierr = SNESGetSNESLineSearch(snes,&snes->linesearch);CHKERRQ(ierr);
402408b6c495SPeter Brune     ierr = PetscObjectAppendOptionsPrefix((PetscObject)snes->linesearch,prefix);CHKERRQ(ierr);
402535f5d045SPeter Brune   }
402635f5d045SPeter Brune   ierr = KSPAppendOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr);
40273a40ed3dSBarry Smith   PetscFunctionReturn(0);
40283c7409f5SSatish Balay }
40293c7409f5SSatish Balay 
40304a2ae208SSatish Balay #undef __FUNCT__
40314a2ae208SSatish Balay #define __FUNCT__ "SNESGetOptionsPrefix"
40329ab63eb5SSatish Balay /*@C
40333c7409f5SSatish Balay    SNESGetOptionsPrefix - Sets the prefix used for searching for all
40343c7409f5SSatish Balay    SNES options in the database.
40353c7409f5SSatish Balay 
4036c7afd0dbSLois Curfman McInnes    Not Collective
4037c7afd0dbSLois Curfman McInnes 
40383c7409f5SSatish Balay    Input Parameter:
40393c7409f5SSatish Balay .  snes - the SNES context
40403c7409f5SSatish Balay 
40413c7409f5SSatish Balay    Output Parameter:
40423c7409f5SSatish Balay .  prefix - pointer to the prefix string used
40433c7409f5SSatish Balay 
40444ef407dbSRichard Tran Mills    Notes: On the fortran side, the user should pass in a string 'prefix' of
40459ab63eb5SSatish Balay    sufficient length to hold the prefix.
40469ab63eb5SSatish Balay 
404736851e7fSLois Curfman McInnes    Level: advanced
404836851e7fSLois Curfman McInnes 
40493c7409f5SSatish Balay .keywords: SNES, get, options, prefix, database
4050a86d99e1SLois Curfman McInnes 
4051a86d99e1SLois Curfman McInnes .seealso: SNESAppendOptionsPrefix()
40523c7409f5SSatish Balay @*/
40537087cfbeSBarry Smith PetscErrorCode  SNESGetOptionsPrefix(SNES snes,const char *prefix[])
40543c7409f5SSatish Balay {
4055dfbe8321SBarry Smith   PetscErrorCode ierr;
40563c7409f5SSatish Balay 
40573a40ed3dSBarry Smith   PetscFunctionBegin;
40580700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4059639f9d9dSBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
40603a40ed3dSBarry Smith   PetscFunctionReturn(0);
40613c7409f5SSatish Balay }
40623c7409f5SSatish Balay 
4063b2002411SLois Curfman McInnes 
40644a2ae208SSatish Balay #undef __FUNCT__
40654a2ae208SSatish Balay #define __FUNCT__ "SNESRegister"
40663cea93caSBarry Smith /*@C
40673cea93caSBarry Smith   SNESRegister - See SNESRegisterDynamic()
40683cea93caSBarry Smith 
40697f6c08e0SMatthew Knepley   Level: advanced
40703cea93caSBarry Smith @*/
40717087cfbeSBarry Smith PetscErrorCode  SNESRegister(const char sname[],const char path[],const char name[],PetscErrorCode (*function)(SNES))
4072b2002411SLois Curfman McInnes {
4073e2d1d2b7SBarry Smith   char           fullname[PETSC_MAX_PATH_LEN];
4074dfbe8321SBarry Smith   PetscErrorCode ierr;
4075b2002411SLois Curfman McInnes 
4076b2002411SLois Curfman McInnes   PetscFunctionBegin;
4077140e18c1SBarry Smith   ierr = PetscFunctionListConcat(path,name,fullname);CHKERRQ(ierr);
4078140e18c1SBarry Smith   ierr = PetscFunctionListAdd(PETSC_COMM_WORLD,&SNESList,sname,fullname,(void (*)(void))function);CHKERRQ(ierr);
4079b2002411SLois Curfman McInnes   PetscFunctionReturn(0);
4080b2002411SLois Curfman McInnes }
4081da9b6338SBarry Smith 
4082da9b6338SBarry Smith #undef __FUNCT__
4083da9b6338SBarry Smith #define __FUNCT__ "SNESTestLocalMin"
40847087cfbeSBarry Smith PetscErrorCode  SNESTestLocalMin(SNES snes)
4085da9b6338SBarry Smith {
4086dfbe8321SBarry Smith   PetscErrorCode ierr;
408777431f27SBarry Smith   PetscInt       N,i,j;
4088da9b6338SBarry Smith   Vec            u,uh,fh;
4089da9b6338SBarry Smith   PetscScalar    value;
4090da9b6338SBarry Smith   PetscReal      norm;
4091da9b6338SBarry Smith 
4092da9b6338SBarry Smith   PetscFunctionBegin;
4093da9b6338SBarry Smith   ierr = SNESGetSolution(snes,&u);CHKERRQ(ierr);
4094da9b6338SBarry Smith   ierr = VecDuplicate(u,&uh);CHKERRQ(ierr);
4095da9b6338SBarry Smith   ierr = VecDuplicate(u,&fh);CHKERRQ(ierr);
4096da9b6338SBarry Smith 
4097da9b6338SBarry Smith   /* currently only works for sequential */
409822d28d08SBarry Smith   ierr = PetscPrintf(PETSC_COMM_WORLD,"Testing FormFunction() for local min\n");CHKERRQ(ierr);
4099da9b6338SBarry Smith   ierr = VecGetSize(u,&N);CHKERRQ(ierr);
4100da9b6338SBarry Smith   for (i=0; i<N; i++) {
4101da9b6338SBarry Smith     ierr = VecCopy(u,uh);CHKERRQ(ierr);
410277431f27SBarry Smith     ierr  = PetscPrintf(PETSC_COMM_WORLD,"i = %D\n",i);CHKERRQ(ierr);
4103da9b6338SBarry Smith     for (j=-10; j<11; j++) {
4104ccae9161SBarry Smith       value = PetscSign(j)*exp(PetscAbs(j)-10.0);
4105da9b6338SBarry Smith       ierr  = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr);
41063ab0aad5SBarry Smith       ierr  = SNESComputeFunction(snes,uh,fh);CHKERRQ(ierr);
4107da9b6338SBarry Smith       ierr  = VecNorm(fh,NORM_2,&norm);CHKERRQ(ierr);
410877431f27SBarry Smith       ierr  = PetscPrintf(PETSC_COMM_WORLD,"       j norm %D %18.16e\n",j,norm);CHKERRQ(ierr);
4109da9b6338SBarry Smith       value = -value;
4110da9b6338SBarry Smith       ierr  = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr);
4111da9b6338SBarry Smith     }
4112da9b6338SBarry Smith   }
41136bf464f9SBarry Smith   ierr = VecDestroy(&uh);CHKERRQ(ierr);
41146bf464f9SBarry Smith   ierr = VecDestroy(&fh);CHKERRQ(ierr);
4115da9b6338SBarry Smith   PetscFunctionReturn(0);
4116da9b6338SBarry Smith }
411771f87433Sdalcinl 
411871f87433Sdalcinl #undef __FUNCT__
4119fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetUseEW"
412071f87433Sdalcinl /*@
4121fa9f3622SBarry Smith    SNESKSPSetUseEW - Sets SNES use Eisenstat-Walker method for
412271f87433Sdalcinl    computing relative tolerance for linear solvers within an inexact
412371f87433Sdalcinl    Newton method.
412471f87433Sdalcinl 
41253f9fe445SBarry Smith    Logically Collective on SNES
412671f87433Sdalcinl 
412771f87433Sdalcinl    Input Parameters:
412871f87433Sdalcinl +  snes - SNES context
412971f87433Sdalcinl -  flag - PETSC_TRUE or PETSC_FALSE
413071f87433Sdalcinl 
413164ba62caSBarry Smith     Options Database:
413264ba62caSBarry Smith +  -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence
413364ba62caSBarry Smith .  -snes_ksp_ew_version ver - version of  Eisenstat-Walker method
413464ba62caSBarry Smith .  -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0
413564ba62caSBarry Smith .  -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax
413664ba62caSBarry Smith .  -snes_ksp_ew_gamma <gamma> - Sets gamma
413764ba62caSBarry Smith .  -snes_ksp_ew_alpha <alpha> - Sets alpha
413864ba62caSBarry Smith .  -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2
413964ba62caSBarry Smith -  -snes_ksp_ew_threshold <threshold> - Sets threshold
414064ba62caSBarry Smith 
414171f87433Sdalcinl    Notes:
414271f87433Sdalcinl    Currently, the default is to use a constant relative tolerance for
414371f87433Sdalcinl    the inner linear solvers.  Alternatively, one can use the
414471f87433Sdalcinl    Eisenstat-Walker method, where the relative convergence tolerance
414571f87433Sdalcinl    is reset at each Newton iteration according progress of the nonlinear
414671f87433Sdalcinl    solver.
414771f87433Sdalcinl 
414871f87433Sdalcinl    Level: advanced
414971f87433Sdalcinl 
415071f87433Sdalcinl    Reference:
415171f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
415271f87433Sdalcinl    inexact Newton method", SISC 17 (1), pp.16-32, 1996.
415371f87433Sdalcinl 
415471f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton
415571f87433Sdalcinl 
4156fa9f3622SBarry Smith .seealso: SNESKSPGetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW()
415771f87433Sdalcinl @*/
41587087cfbeSBarry Smith PetscErrorCode  SNESKSPSetUseEW(SNES snes,PetscBool  flag)
415971f87433Sdalcinl {
416071f87433Sdalcinl   PetscFunctionBegin;
41610700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4162acfcf0e5SJed Brown   PetscValidLogicalCollectiveBool(snes,flag,2);
416371f87433Sdalcinl   snes->ksp_ewconv = flag;
416471f87433Sdalcinl   PetscFunctionReturn(0);
416571f87433Sdalcinl }
416671f87433Sdalcinl 
416771f87433Sdalcinl #undef __FUNCT__
4168fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetUseEW"
416971f87433Sdalcinl /*@
4170fa9f3622SBarry Smith    SNESKSPGetUseEW - Gets if SNES is using Eisenstat-Walker method
417171f87433Sdalcinl    for computing relative tolerance for linear solvers within an
417271f87433Sdalcinl    inexact Newton method.
417371f87433Sdalcinl 
417471f87433Sdalcinl    Not Collective
417571f87433Sdalcinl 
417671f87433Sdalcinl    Input Parameter:
417771f87433Sdalcinl .  snes - SNES context
417871f87433Sdalcinl 
417971f87433Sdalcinl    Output Parameter:
418071f87433Sdalcinl .  flag - PETSC_TRUE or PETSC_FALSE
418171f87433Sdalcinl 
418271f87433Sdalcinl    Notes:
418371f87433Sdalcinl    Currently, the default is to use a constant relative tolerance for
418471f87433Sdalcinl    the inner linear solvers.  Alternatively, one can use the
418571f87433Sdalcinl    Eisenstat-Walker method, where the relative convergence tolerance
418671f87433Sdalcinl    is reset at each Newton iteration according progress of the nonlinear
418771f87433Sdalcinl    solver.
418871f87433Sdalcinl 
418971f87433Sdalcinl    Level: advanced
419071f87433Sdalcinl 
419171f87433Sdalcinl    Reference:
419271f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
419371f87433Sdalcinl    inexact Newton method", SISC 17 (1), pp.16-32, 1996.
419471f87433Sdalcinl 
419571f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton
419671f87433Sdalcinl 
4197fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW()
419871f87433Sdalcinl @*/
41997087cfbeSBarry Smith PetscErrorCode  SNESKSPGetUseEW(SNES snes, PetscBool  *flag)
420071f87433Sdalcinl {
420171f87433Sdalcinl   PetscFunctionBegin;
42020700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
420371f87433Sdalcinl   PetscValidPointer(flag,2);
420471f87433Sdalcinl   *flag = snes->ksp_ewconv;
420571f87433Sdalcinl   PetscFunctionReturn(0);
420671f87433Sdalcinl }
420771f87433Sdalcinl 
420871f87433Sdalcinl #undef __FUNCT__
4209fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetParametersEW"
421071f87433Sdalcinl /*@
4211fa9f3622SBarry Smith    SNESKSPSetParametersEW - Sets parameters for Eisenstat-Walker
421271f87433Sdalcinl    convergence criteria for the linear solvers within an inexact
421371f87433Sdalcinl    Newton method.
421471f87433Sdalcinl 
42153f9fe445SBarry Smith    Logically Collective on SNES
421671f87433Sdalcinl 
421771f87433Sdalcinl    Input Parameters:
421871f87433Sdalcinl +    snes - SNES context
421971f87433Sdalcinl .    version - version 1, 2 (default is 2) or 3
422071f87433Sdalcinl .    rtol_0 - initial relative tolerance (0 <= rtol_0 < 1)
422171f87433Sdalcinl .    rtol_max - maximum relative tolerance (0 <= rtol_max < 1)
422271f87433Sdalcinl .    gamma - multiplicative factor for version 2 rtol computation
422371f87433Sdalcinl              (0 <= gamma2 <= 1)
422471f87433Sdalcinl .    alpha - power for version 2 rtol computation (1 < alpha <= 2)
422571f87433Sdalcinl .    alpha2 - power for safeguard
422671f87433Sdalcinl -    threshold - threshold for imposing safeguard (0 < threshold < 1)
422771f87433Sdalcinl 
422871f87433Sdalcinl    Note:
422971f87433Sdalcinl    Version 3 was contributed by Luis Chacon, June 2006.
423071f87433Sdalcinl 
423171f87433Sdalcinl    Use PETSC_DEFAULT to retain the default for any of the parameters.
423271f87433Sdalcinl 
423371f87433Sdalcinl    Level: advanced
423471f87433Sdalcinl 
423571f87433Sdalcinl    Reference:
423671f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
423771f87433Sdalcinl    inexact Newton method", Utah State University Math. Stat. Dept. Res.
423871f87433Sdalcinl    Report 6/94/75, June, 1994, to appear in SIAM J. Sci. Comput.
423971f87433Sdalcinl 
424071f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, set, parameters
424171f87433Sdalcinl 
4242fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPGetParametersEW()
424371f87433Sdalcinl @*/
42447087cfbeSBarry Smith PetscErrorCode  SNESKSPSetParametersEW(SNES snes,PetscInt version,PetscReal rtol_0,PetscReal rtol_max,
424571f87433Sdalcinl                                                             PetscReal gamma,PetscReal alpha,PetscReal alpha2,PetscReal threshold)
424671f87433Sdalcinl {
4247fa9f3622SBarry Smith   SNESKSPEW *kctx;
424871f87433Sdalcinl   PetscFunctionBegin;
42490700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4250fa9f3622SBarry Smith   kctx = (SNESKSPEW*)snes->kspconvctx;
4251e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing");
4252c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,version,2);
4253c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol_0,3);
4254c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol_max,4);
4255c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,gamma,5);
4256c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,alpha,6);
4257c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,alpha2,7);
4258c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,threshold,8);
425971f87433Sdalcinl 
426071f87433Sdalcinl   if (version != PETSC_DEFAULT)   kctx->version   = version;
426171f87433Sdalcinl   if (rtol_0 != PETSC_DEFAULT)    kctx->rtol_0    = rtol_0;
426271f87433Sdalcinl   if (rtol_max != PETSC_DEFAULT)  kctx->rtol_max  = rtol_max;
426371f87433Sdalcinl   if (gamma != PETSC_DEFAULT)     kctx->gamma     = gamma;
426471f87433Sdalcinl   if (alpha != PETSC_DEFAULT)     kctx->alpha     = alpha;
426571f87433Sdalcinl   if (alpha2 != PETSC_DEFAULT)    kctx->alpha2    = alpha2;
426671f87433Sdalcinl   if (threshold != PETSC_DEFAULT) kctx->threshold = threshold;
426771f87433Sdalcinl 
426871f87433Sdalcinl   if (kctx->version < 1 || kctx->version > 3) {
4269e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 and 3 are supported: %D",kctx->version);
427071f87433Sdalcinl   }
427171f87433Sdalcinl   if (kctx->rtol_0 < 0.0 || kctx->rtol_0 >= 1.0) {
4272e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_0 < 1.0: %G",kctx->rtol_0);
427371f87433Sdalcinl   }
427471f87433Sdalcinl   if (kctx->rtol_max < 0.0 || kctx->rtol_max >= 1.0) {
4275e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_max (%G) < 1.0\n",kctx->rtol_max);
427671f87433Sdalcinl   }
427771f87433Sdalcinl   if (kctx->gamma < 0.0 || kctx->gamma > 1.0) {
4278e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= gamma (%G) <= 1.0\n",kctx->gamma);
427971f87433Sdalcinl   }
428071f87433Sdalcinl   if (kctx->alpha <= 1.0 || kctx->alpha > 2.0) {
4281e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"1.0 < alpha (%G) <= 2.0\n",kctx->alpha);
428271f87433Sdalcinl   }
428371f87433Sdalcinl   if (kctx->threshold <= 0.0 || kctx->threshold >= 1.0) {
4284e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 < threshold (%G) < 1.0\n",kctx->threshold);
428571f87433Sdalcinl   }
428671f87433Sdalcinl   PetscFunctionReturn(0);
428771f87433Sdalcinl }
428871f87433Sdalcinl 
428971f87433Sdalcinl #undef __FUNCT__
4290fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetParametersEW"
429171f87433Sdalcinl /*@
4292fa9f3622SBarry Smith    SNESKSPGetParametersEW - Gets parameters for Eisenstat-Walker
429371f87433Sdalcinl    convergence criteria for the linear solvers within an inexact
429471f87433Sdalcinl    Newton method.
429571f87433Sdalcinl 
429671f87433Sdalcinl    Not Collective
429771f87433Sdalcinl 
429871f87433Sdalcinl    Input Parameters:
429971f87433Sdalcinl      snes - SNES context
430071f87433Sdalcinl 
430171f87433Sdalcinl    Output Parameters:
430271f87433Sdalcinl +    version - version 1, 2 (default is 2) or 3
430371f87433Sdalcinl .    rtol_0 - initial relative tolerance (0 <= rtol_0 < 1)
430471f87433Sdalcinl .    rtol_max - maximum relative tolerance (0 <= rtol_max < 1)
4305bf388a1fSBarry Smith .    gamma - multiplicative factor for version 2 rtol computation (0 <= gamma2 <= 1)
430671f87433Sdalcinl .    alpha - power for version 2 rtol computation (1 < alpha <= 2)
430771f87433Sdalcinl .    alpha2 - power for safeguard
430871f87433Sdalcinl -    threshold - threshold for imposing safeguard (0 < threshold < 1)
430971f87433Sdalcinl 
431071f87433Sdalcinl    Level: advanced
431171f87433Sdalcinl 
431271f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, get, parameters
431371f87433Sdalcinl 
4314fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPSetParametersEW()
431571f87433Sdalcinl @*/
4316bf388a1fSBarry Smith PetscErrorCode  SNESKSPGetParametersEW(SNES snes,PetscInt *version,PetscReal *rtol_0,PetscReal *rtol_max,PetscReal *gamma,PetscReal *alpha,PetscReal *alpha2,PetscReal *threshold)
431771f87433Sdalcinl {
4318fa9f3622SBarry Smith   SNESKSPEW *kctx;
431971f87433Sdalcinl   PetscFunctionBegin;
43200700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4321fa9f3622SBarry Smith   kctx = (SNESKSPEW*)snes->kspconvctx;
4322e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing");
432371f87433Sdalcinl   if (version)   *version   = kctx->version;
432471f87433Sdalcinl   if (rtol_0)    *rtol_0    = kctx->rtol_0;
432571f87433Sdalcinl   if (rtol_max)  *rtol_max  = kctx->rtol_max;
432671f87433Sdalcinl   if (gamma)     *gamma     = kctx->gamma;
432771f87433Sdalcinl   if (alpha)     *alpha     = kctx->alpha;
432871f87433Sdalcinl   if (alpha2)    *alpha2    = kctx->alpha2;
432971f87433Sdalcinl   if (threshold) *threshold = kctx->threshold;
433071f87433Sdalcinl   PetscFunctionReturn(0);
433171f87433Sdalcinl }
433271f87433Sdalcinl 
433371f87433Sdalcinl #undef __FUNCT__
4334fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PreSolve"
4335fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PreSolve(SNES snes, KSP ksp, Vec b, Vec x)
433671f87433Sdalcinl {
433771f87433Sdalcinl   PetscErrorCode ierr;
4338fa9f3622SBarry Smith   SNESKSPEW      *kctx = (SNESKSPEW*)snes->kspconvctx;
433971f87433Sdalcinl   PetscReal      rtol=PETSC_DEFAULT,stol;
434071f87433Sdalcinl 
434171f87433Sdalcinl   PetscFunctionBegin;
4342e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists");
434371f87433Sdalcinl   if (!snes->iter) { /* first time in, so use the original user rtol */
434471f87433Sdalcinl     rtol = kctx->rtol_0;
434571f87433Sdalcinl   } else {
434671f87433Sdalcinl     if (kctx->version == 1) {
434771f87433Sdalcinl       rtol = (snes->norm - kctx->lresid_last)/kctx->norm_last;
434871f87433Sdalcinl       if (rtol < 0.0) rtol = -rtol;
434971f87433Sdalcinl       stol = pow(kctx->rtol_last,kctx->alpha2);
435071f87433Sdalcinl       if (stol > kctx->threshold) rtol = PetscMax(rtol,stol);
435171f87433Sdalcinl     } else if (kctx->version == 2) {
435271f87433Sdalcinl       rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha);
435371f87433Sdalcinl       stol = kctx->gamma * pow(kctx->rtol_last,kctx->alpha);
435471f87433Sdalcinl       if (stol > kctx->threshold) rtol = PetscMax(rtol,stol);
435571f87433Sdalcinl     } else if (kctx->version == 3) {/* contributed by Luis Chacon, June 2006. */
435671f87433Sdalcinl       rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha);
435771f87433Sdalcinl       /* safeguard: avoid sharp decrease of rtol */
435871f87433Sdalcinl       stol = kctx->gamma*pow(kctx->rtol_last,kctx->alpha);
435971f87433Sdalcinl       stol = PetscMax(rtol,stol);
436071f87433Sdalcinl       rtol = PetscMin(kctx->rtol_0,stol);
436171f87433Sdalcinl       /* safeguard: avoid oversolving */
436271f87433Sdalcinl       stol = kctx->gamma*(snes->ttol)/snes->norm;
436371f87433Sdalcinl       stol = PetscMax(rtol,stol);
436471f87433Sdalcinl       rtol = PetscMin(kctx->rtol_0,stol);
4365e32f2f54SBarry Smith     } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 or 3 are supported: %D",kctx->version);
436671f87433Sdalcinl   }
436771f87433Sdalcinl   /* safeguard: avoid rtol greater than one */
436871f87433Sdalcinl   rtol = PetscMin(rtol,kctx->rtol_max);
436971f87433Sdalcinl   ierr = KSPSetTolerances(ksp,rtol,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT);CHKERRQ(ierr);
437071f87433Sdalcinl   ierr = PetscInfo3(snes,"iter %D, Eisenstat-Walker (version %D) KSP rtol=%G\n",snes->iter,kctx->version,rtol);CHKERRQ(ierr);
437171f87433Sdalcinl   PetscFunctionReturn(0);
437271f87433Sdalcinl }
437371f87433Sdalcinl 
437471f87433Sdalcinl #undef __FUNCT__
4375fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PostSolve"
4376fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PostSolve(SNES snes, KSP ksp, Vec b, Vec x)
437771f87433Sdalcinl {
437871f87433Sdalcinl   PetscErrorCode ierr;
4379fa9f3622SBarry Smith   SNESKSPEW      *kctx = (SNESKSPEW*)snes->kspconvctx;
438071f87433Sdalcinl   PCSide         pcside;
438171f87433Sdalcinl   Vec            lres;
438271f87433Sdalcinl 
438371f87433Sdalcinl   PetscFunctionBegin;
4384e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists");
438571f87433Sdalcinl   ierr = KSPGetTolerances(ksp,&kctx->rtol_last,0,0,0);CHKERRQ(ierr);
438671f87433Sdalcinl   ierr = SNESGetFunctionNorm(snes,&kctx->norm_last);CHKERRQ(ierr);
438771f87433Sdalcinl   if (kctx->version == 1) {
4388b037da10SBarry Smith     ierr = KSPGetPCSide(ksp,&pcside);CHKERRQ(ierr);
438971f87433Sdalcinl     if (pcside == PC_RIGHT) { /* XXX Should we also test KSP_UNPRECONDITIONED_NORM ? */
439071f87433Sdalcinl       /* KSP residual is true linear residual */
439171f87433Sdalcinl       ierr = KSPGetResidualNorm(ksp,&kctx->lresid_last);CHKERRQ(ierr);
439271f87433Sdalcinl     } else {
439371f87433Sdalcinl       /* KSP residual is preconditioned residual */
439471f87433Sdalcinl       /* compute true linear residual norm */
439571f87433Sdalcinl       ierr = VecDuplicate(b,&lres);CHKERRQ(ierr);
439671f87433Sdalcinl       ierr = MatMult(snes->jacobian,x,lres);CHKERRQ(ierr);
439771f87433Sdalcinl       ierr = VecAYPX(lres,-1.0,b);CHKERRQ(ierr);
439871f87433Sdalcinl       ierr = VecNorm(lres,NORM_2,&kctx->lresid_last);CHKERRQ(ierr);
43996bf464f9SBarry Smith       ierr = VecDestroy(&lres);CHKERRQ(ierr);
440071f87433Sdalcinl     }
440171f87433Sdalcinl   }
440271f87433Sdalcinl   PetscFunctionReturn(0);
440371f87433Sdalcinl }
440471f87433Sdalcinl 
440571f87433Sdalcinl #undef __FUNCT__
440671f87433Sdalcinl #define __FUNCT__ "SNES_KSPSolve"
440771f87433Sdalcinl PetscErrorCode SNES_KSPSolve(SNES snes, KSP ksp, Vec b, Vec x)
440871f87433Sdalcinl {
440971f87433Sdalcinl   PetscErrorCode ierr;
441071f87433Sdalcinl 
441171f87433Sdalcinl   PetscFunctionBegin;
4412fa9f3622SBarry Smith   if (snes->ksp_ewconv) { ierr = SNESKSPEW_PreSolve(snes,ksp,b,x);CHKERRQ(ierr);  }
441371f87433Sdalcinl   ierr = KSPSolve(ksp,b,x);CHKERRQ(ierr);
4414fa9f3622SBarry Smith   if (snes->ksp_ewconv) { ierr = SNESKSPEW_PostSolve(snes,ksp,b,x);CHKERRQ(ierr); }
441571f87433Sdalcinl   PetscFunctionReturn(0);
441671f87433Sdalcinl }
44176c699258SBarry Smith 
4418b4615a05SBarry Smith #include <petsc-private/dmimpl.h>
44196c699258SBarry Smith #undef __FUNCT__
44206c699258SBarry Smith #define __FUNCT__ "SNESSetDM"
44216c699258SBarry Smith /*@
44226c699258SBarry Smith    SNESSetDM - Sets the DM that may be used by some preconditioners
44236c699258SBarry Smith 
44243f9fe445SBarry Smith    Logically Collective on SNES
44256c699258SBarry Smith 
44266c699258SBarry Smith    Input Parameters:
44276c699258SBarry Smith +  snes - the preconditioner context
44286c699258SBarry Smith -  dm - the dm
44296c699258SBarry Smith 
44306c699258SBarry Smith    Level: intermediate
44316c699258SBarry Smith 
44326c699258SBarry Smith .seealso: SNESGetDM(), KSPSetDM(), KSPGetDM()
44336c699258SBarry Smith @*/
44347087cfbeSBarry Smith PetscErrorCode  SNESSetDM(SNES snes,DM dm)
44356c699258SBarry Smith {
44366c699258SBarry Smith   PetscErrorCode ierr;
4437345fed2cSBarry Smith   KSP            ksp;
4438942e3340SBarry Smith   DMSNES         sdm;
44396c699258SBarry Smith 
44406c699258SBarry Smith   PetscFunctionBegin;
44410700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4442d0660788SBarry Smith   if (dm) {ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);}
4443942e3340SBarry Smith   if (snes->dm) {               /* Move the DMSNES context over to the new DM unless the new DM already has one */
4444b4615a05SBarry Smith     if (snes->dm->dmsnes && snes->dmAuto && !dm->dmsnes) {
4445942e3340SBarry Smith       ierr = DMCopyDMSNES(snes->dm,dm);CHKERRQ(ierr);
4446942e3340SBarry Smith       ierr = DMGetDMSNES(snes->dm,&sdm);CHKERRQ(ierr);
44476cab3a1bSJed Brown       if (sdm->originaldm == snes->dm) { /* Grant write privileges to the replacement DM */
44486cab3a1bSJed Brown         sdm->originaldm = dm;
44496cab3a1bSJed Brown       }
44506cab3a1bSJed Brown     }
44516bf464f9SBarry Smith     ierr = DMDestroy(&snes->dm);CHKERRQ(ierr);
44526cab3a1bSJed Brown   }
44536c699258SBarry Smith   snes->dm = dm;
4454116d1032SJed Brown   snes->dmAuto = PETSC_FALSE;
4455345fed2cSBarry Smith   ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
4456345fed2cSBarry Smith   ierr = KSPSetDM(ksp,dm);CHKERRQ(ierr);
4457f22f69f0SBarry Smith   ierr = KSPSetDMActive(ksp,PETSC_FALSE);CHKERRQ(ierr);
44582c155ee1SBarry Smith   if (snes->pc) {
44592c155ee1SBarry Smith     ierr = SNESSetDM(snes->pc, snes->dm);CHKERRQ(ierr);
4460c40d0f55SPeter Brune     ierr = SNESSetPCSide(snes,snes->pcside);CHKERRQ(ierr);
44612c155ee1SBarry Smith   }
44626c699258SBarry Smith   PetscFunctionReturn(0);
44636c699258SBarry Smith }
44646c699258SBarry Smith 
44656c699258SBarry Smith #undef __FUNCT__
44666c699258SBarry Smith #define __FUNCT__ "SNESGetDM"
44676c699258SBarry Smith /*@
44686c699258SBarry Smith    SNESGetDM - Gets the DM that may be used by some preconditioners
44696c699258SBarry Smith 
44703f9fe445SBarry Smith    Not Collective but DM obtained is parallel on SNES
44716c699258SBarry Smith 
44726c699258SBarry Smith    Input Parameter:
44736c699258SBarry Smith . snes - the preconditioner context
44746c699258SBarry Smith 
44756c699258SBarry Smith    Output Parameter:
44766c699258SBarry Smith .  dm - the dm
44776c699258SBarry Smith 
44786c699258SBarry Smith    Level: intermediate
44796c699258SBarry Smith 
44806c699258SBarry Smith .seealso: SNESSetDM(), KSPSetDM(), KSPGetDM()
44816c699258SBarry Smith @*/
44827087cfbeSBarry Smith PetscErrorCode  SNESGetDM(SNES snes,DM *dm)
44836c699258SBarry Smith {
44846cab3a1bSJed Brown   PetscErrorCode ierr;
44856cab3a1bSJed Brown 
44866c699258SBarry Smith   PetscFunctionBegin;
44870700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
44886cab3a1bSJed Brown   if (!snes->dm) {
44896cab3a1bSJed Brown     ierr = DMShellCreate(((PetscObject)snes)->comm,&snes->dm);CHKERRQ(ierr);
4490116d1032SJed Brown     snes->dmAuto = PETSC_TRUE;
44916cab3a1bSJed Brown   }
44926c699258SBarry Smith   *dm = snes->dm;
44936c699258SBarry Smith   PetscFunctionReturn(0);
44946c699258SBarry Smith }
44950807856dSBarry Smith 
449631823bd8SMatthew G Knepley #undef __FUNCT__
449731823bd8SMatthew G Knepley #define __FUNCT__ "SNESSetPC"
449831823bd8SMatthew G Knepley /*@
4499fd4b34e9SJed Brown   SNESSetPC - Sets the nonlinear preconditioner to be used.
450031823bd8SMatthew G Knepley 
450131823bd8SMatthew G Knepley   Collective on SNES
450231823bd8SMatthew G Knepley 
450331823bd8SMatthew G Knepley   Input Parameters:
450431823bd8SMatthew G Knepley + snes - iterative context obtained from SNESCreate()
450531823bd8SMatthew G Knepley - pc   - the preconditioner object
450631823bd8SMatthew G Knepley 
450731823bd8SMatthew G Knepley   Notes:
450831823bd8SMatthew G Knepley   Use SNESGetPC() to retrieve the preconditioner context (for example,
450931823bd8SMatthew G Knepley   to configure it using the API).
451031823bd8SMatthew G Knepley 
451131823bd8SMatthew G Knepley   Level: developer
451231823bd8SMatthew G Knepley 
451331823bd8SMatthew G Knepley .keywords: SNES, set, precondition
451431823bd8SMatthew G Knepley .seealso: SNESGetPC()
451531823bd8SMatthew G Knepley @*/
451631823bd8SMatthew G Knepley PetscErrorCode SNESSetPC(SNES snes, SNES pc)
451731823bd8SMatthew G Knepley {
451831823bd8SMatthew G Knepley   PetscErrorCode ierr;
451931823bd8SMatthew G Knepley 
452031823bd8SMatthew G Knepley   PetscFunctionBegin;
452131823bd8SMatthew G Knepley   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
452231823bd8SMatthew G Knepley   PetscValidHeaderSpecific(pc, SNES_CLASSID, 2);
452331823bd8SMatthew G Knepley   PetscCheckSameComm(snes, 1, pc, 2);
452431823bd8SMatthew G Knepley   ierr = PetscObjectReference((PetscObject) pc);CHKERRQ(ierr);
4525bf11d3b6SBarry Smith   ierr = SNESDestroy(&snes->pc);CHKERRQ(ierr);
452631823bd8SMatthew G Knepley   snes->pc = pc;
452731823bd8SMatthew G Knepley   ierr = PetscLogObjectParent(snes, snes->pc);CHKERRQ(ierr);
452831823bd8SMatthew G Knepley   PetscFunctionReturn(0);
452931823bd8SMatthew G Knepley }
453031823bd8SMatthew G Knepley 
453131823bd8SMatthew G Knepley #undef __FUNCT__
453231823bd8SMatthew G Knepley #define __FUNCT__ "SNESGetPC"
453331823bd8SMatthew G Knepley /*@
4534fd4b34e9SJed Brown   SNESGetPC - Returns a pointer to the nonlinear preconditioning context set with SNESSetPC().
453531823bd8SMatthew G Knepley 
453631823bd8SMatthew G Knepley   Not Collective
453731823bd8SMatthew G Knepley 
453831823bd8SMatthew G Knepley   Input Parameter:
453931823bd8SMatthew G Knepley . snes - iterative context obtained from SNESCreate()
454031823bd8SMatthew G Knepley 
454131823bd8SMatthew G Knepley   Output Parameter:
454231823bd8SMatthew G Knepley . pc - preconditioner context
454331823bd8SMatthew G Knepley 
454431823bd8SMatthew G Knepley   Level: developer
454531823bd8SMatthew G Knepley 
454631823bd8SMatthew G Knepley .keywords: SNES, get, preconditioner
454731823bd8SMatthew G Knepley .seealso: SNESSetPC()
454831823bd8SMatthew G Knepley @*/
454931823bd8SMatthew G Knepley PetscErrorCode SNESGetPC(SNES snes, SNES *pc)
455031823bd8SMatthew G Knepley {
455131823bd8SMatthew G Knepley   PetscErrorCode              ierr;
4552a64e098fSPeter Brune   const char                  *optionsprefix;
455331823bd8SMatthew G Knepley 
455431823bd8SMatthew G Knepley   PetscFunctionBegin;
455531823bd8SMatthew G Knepley   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
455631823bd8SMatthew G Knepley   PetscValidPointer(pc, 2);
455731823bd8SMatthew G Knepley   if (!snes->pc) {
455831823bd8SMatthew G Knepley     ierr = SNESCreate(((PetscObject) snes)->comm,&snes->pc);CHKERRQ(ierr);
45594a0c5b0cSMatthew G Knepley     ierr = PetscObjectIncrementTabLevel((PetscObject)snes->pc,(PetscObject)snes,1);CHKERRQ(ierr);
456031823bd8SMatthew G Knepley     ierr = PetscLogObjectParent(snes,snes->pc);CHKERRQ(ierr);
4561a64e098fSPeter Brune     ierr = SNESGetOptionsPrefix(snes,&optionsprefix);CHKERRQ(ierr);
4562a64e098fSPeter Brune     ierr = SNESSetOptionsPrefix(snes->pc,optionsprefix);CHKERRQ(ierr);
4563a64e098fSPeter Brune     ierr = SNESAppendOptionsPrefix(snes->pc,"npc_");CHKERRQ(ierr);
456431823bd8SMatthew G Knepley   }
456531823bd8SMatthew G Knepley   *pc = snes->pc;
456631823bd8SMatthew G Knepley   PetscFunctionReturn(0);
456731823bd8SMatthew G Knepley }
456831823bd8SMatthew G Knepley 
4569c40d0f55SPeter Brune #undef __FUNCT__
4570c40d0f55SPeter Brune #define __FUNCT__ "SNESSetPCSide"
4571c40d0f55SPeter Brune /*@
4572c40d0f55SPeter Brune     SNESSetPCSide - Sets the preconditioning side.
4573c40d0f55SPeter Brune 
4574c40d0f55SPeter Brune     Logically Collective on SNES
4575c40d0f55SPeter Brune 
4576c40d0f55SPeter Brune     Input Parameter:
4577c40d0f55SPeter Brune .   snes - iterative context obtained from SNESCreate()
4578c40d0f55SPeter Brune 
4579c40d0f55SPeter Brune     Output Parameter:
4580c40d0f55SPeter Brune .   side - the preconditioning side, where side is one of
4581c40d0f55SPeter Brune .vb
4582c40d0f55SPeter Brune       PC_LEFT - left preconditioning (default)
4583c40d0f55SPeter Brune       PC_RIGHT - right preconditioning
4584c40d0f55SPeter Brune .ve
4585c40d0f55SPeter Brune 
4586c40d0f55SPeter Brune     Options Database Keys:
4587c40d0f55SPeter Brune .   -snes_pc_side <right,left>
4588c40d0f55SPeter Brune 
4589c40d0f55SPeter Brune     Level: intermediate
4590c40d0f55SPeter Brune 
4591c40d0f55SPeter Brune .keywords: SNES, set, right, left, side, preconditioner, flag
4592c40d0f55SPeter Brune 
4593c40d0f55SPeter Brune .seealso: SNESGetPCSide(), KSPSetPCSide()
4594c40d0f55SPeter Brune @*/
4595c40d0f55SPeter Brune PetscErrorCode  SNESSetPCSide(SNES snes,PCSide side)
4596c40d0f55SPeter Brune {
4597c40d0f55SPeter Brune   PetscFunctionBegin;
4598c40d0f55SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4599c40d0f55SPeter Brune   PetscValidLogicalCollectiveEnum(snes,side,2);
4600c40d0f55SPeter Brune   snes->pcside = side;
4601c40d0f55SPeter Brune   PetscFunctionReturn(0);
4602c40d0f55SPeter Brune }
4603c40d0f55SPeter Brune 
4604c40d0f55SPeter Brune #undef __FUNCT__
4605c40d0f55SPeter Brune #define __FUNCT__ "SNESGetPCSide"
4606c40d0f55SPeter Brune /*@
4607c40d0f55SPeter Brune     SNESGetPCSide - Gets the preconditioning side.
4608c40d0f55SPeter Brune 
4609c40d0f55SPeter Brune     Not Collective
4610c40d0f55SPeter Brune 
4611c40d0f55SPeter Brune     Input Parameter:
4612c40d0f55SPeter Brune .   snes - iterative context obtained from SNESCreate()
4613c40d0f55SPeter Brune 
4614c40d0f55SPeter Brune     Output Parameter:
4615c40d0f55SPeter Brune .   side - the preconditioning side, where side is one of
4616c40d0f55SPeter Brune .vb
4617c40d0f55SPeter Brune       PC_LEFT - left preconditioning (default)
4618c40d0f55SPeter Brune       PC_RIGHT - right preconditioning
4619c40d0f55SPeter Brune .ve
4620c40d0f55SPeter Brune 
4621c40d0f55SPeter Brune     Level: intermediate
4622c40d0f55SPeter Brune 
4623c40d0f55SPeter Brune .keywords: SNES, get, right, left, side, preconditioner, flag
4624c40d0f55SPeter Brune 
4625c40d0f55SPeter Brune .seealso: SNESSetPCSide(), KSPGetPCSide()
4626c40d0f55SPeter Brune @*/
4627c40d0f55SPeter Brune PetscErrorCode  SNESGetPCSide(SNES snes,PCSide *side)
4628c40d0f55SPeter Brune {
4629c40d0f55SPeter Brune   PetscFunctionBegin;
4630c40d0f55SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4631c40d0f55SPeter Brune   PetscValidPointer(side,2);
4632c40d0f55SPeter Brune   *side = snes->pcside;
4633c40d0f55SPeter Brune   PetscFunctionReturn(0);
4634c40d0f55SPeter Brune }
4635c40d0f55SPeter Brune 
46369e764e56SPeter Brune #undef __FUNCT__
4637f1c6b773SPeter Brune #define __FUNCT__ "SNESSetSNESLineSearch"
46389e764e56SPeter Brune /*@
46398141a3b9SPeter Brune   SNESSetSNESLineSearch - Sets the linesearch on the SNES instance.
46409e764e56SPeter Brune 
46419e764e56SPeter Brune   Collective on SNES
46429e764e56SPeter Brune 
46439e764e56SPeter Brune   Input Parameters:
46449e764e56SPeter Brune + snes - iterative context obtained from SNESCreate()
46459e764e56SPeter Brune - linesearch   - the linesearch object
46469e764e56SPeter Brune 
46479e764e56SPeter Brune   Notes:
4648f1c6b773SPeter Brune   Use SNESGetSNESLineSearch() to retrieve the preconditioner context (for example,
46499e764e56SPeter Brune   to configure it using the API).
46509e764e56SPeter Brune 
46519e764e56SPeter Brune   Level: developer
46529e764e56SPeter Brune 
46539e764e56SPeter Brune .keywords: SNES, set, linesearch
4654f1c6b773SPeter Brune .seealso: SNESGetSNESLineSearch()
46559e764e56SPeter Brune @*/
4656f1c6b773SPeter Brune PetscErrorCode SNESSetSNESLineSearch(SNES snes, SNESLineSearch linesearch)
46579e764e56SPeter Brune {
46589e764e56SPeter Brune   PetscErrorCode ierr;
46599e764e56SPeter Brune 
46609e764e56SPeter Brune   PetscFunctionBegin;
46619e764e56SPeter Brune   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
4662f1c6b773SPeter Brune   PetscValidHeaderSpecific(linesearch, SNESLINESEARCH_CLASSID, 2);
46639e764e56SPeter Brune   PetscCheckSameComm(snes, 1, linesearch, 2);
46649e764e56SPeter Brune   ierr = PetscObjectReference((PetscObject) linesearch);CHKERRQ(ierr);
4665f1c6b773SPeter Brune   ierr = SNESLineSearchDestroy(&snes->linesearch);CHKERRQ(ierr);
46669e764e56SPeter Brune   snes->linesearch = linesearch;
46679e764e56SPeter Brune   ierr = PetscLogObjectParent(snes, snes->linesearch);CHKERRQ(ierr);
46689e764e56SPeter Brune   PetscFunctionReturn(0);
46699e764e56SPeter Brune }
46709e764e56SPeter Brune 
46719e764e56SPeter Brune #undef __FUNCT__
4672f1c6b773SPeter Brune #define __FUNCT__ "SNESGetSNESLineSearch"
4673ea5d4fccSPeter Brune /*@C
46748141a3b9SPeter Brune   SNESGetSNESLineSearch - Returns a pointer to the line search context set with SNESSetLineSearch()
46758141a3b9SPeter Brune   or creates a default line search instance associated with the SNES and returns it.
46769e764e56SPeter Brune 
46779e764e56SPeter Brune   Not Collective
46789e764e56SPeter Brune 
46799e764e56SPeter Brune   Input Parameter:
46809e764e56SPeter Brune . snes - iterative context obtained from SNESCreate()
46819e764e56SPeter Brune 
46829e764e56SPeter Brune   Output Parameter:
46839e764e56SPeter Brune . linesearch - linesearch context
46849e764e56SPeter Brune 
46859e764e56SPeter Brune   Level: developer
46869e764e56SPeter Brune 
46879e764e56SPeter Brune .keywords: SNES, get, linesearch
4688f1c6b773SPeter Brune .seealso: SNESSetSNESLineSearch()
46899e764e56SPeter Brune @*/
4690f1c6b773SPeter Brune PetscErrorCode SNESGetSNESLineSearch(SNES snes, SNESLineSearch *linesearch)
46919e764e56SPeter Brune {
46929e764e56SPeter Brune   PetscErrorCode ierr;
46939e764e56SPeter Brune   const char     *optionsprefix;
46949e764e56SPeter Brune 
46959e764e56SPeter Brune   PetscFunctionBegin;
46969e764e56SPeter Brune   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
46979e764e56SPeter Brune   PetscValidPointer(linesearch, 2);
46989e764e56SPeter Brune   if (!snes->linesearch) {
46999e764e56SPeter Brune     ierr = SNESGetOptionsPrefix(snes, &optionsprefix);CHKERRQ(ierr);
4700f1c6b773SPeter Brune     ierr = SNESLineSearchCreate(((PetscObject) snes)->comm, &snes->linesearch);CHKERRQ(ierr);
4701f1c6b773SPeter Brune     ierr = SNESLineSearchSetSNES(snes->linesearch, snes);CHKERRQ(ierr);
4702b1dca40bSPeter Brune     ierr = SNESLineSearchAppendOptionsPrefix(snes->linesearch, optionsprefix);CHKERRQ(ierr);
47039e764e56SPeter Brune     ierr = PetscObjectIncrementTabLevel((PetscObject) snes->linesearch, (PetscObject) snes, 1);CHKERRQ(ierr);
47049e764e56SPeter Brune     ierr = PetscLogObjectParent(snes, snes->linesearch);CHKERRQ(ierr);
47059e764e56SPeter Brune   }
47069e764e56SPeter Brune   *linesearch = snes->linesearch;
47079e764e56SPeter Brune   PetscFunctionReturn(0);
47089e764e56SPeter Brune }
47099e764e56SPeter Brune 
471069b4f73cSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
4711c6db04a5SJed Brown #include <mex.h>
471269b4f73cSBarry Smith 
47138f6e6473SBarry Smith typedef struct {char *funcname; mxArray *ctx;} SNESMatlabContext;
47148f6e6473SBarry Smith 
47150807856dSBarry Smith #undef __FUNCT__
47160807856dSBarry Smith #define __FUNCT__ "SNESComputeFunction_Matlab"
47170807856dSBarry Smith /*
4718bf388a1fSBarry Smith    SNESComputeFunction_Matlab - Calls the function that has been set with SNESSetFunctionMatlab().
47190807856dSBarry Smith 
47200807856dSBarry Smith    Collective on SNES
47210807856dSBarry Smith 
47220807856dSBarry Smith    Input Parameters:
47230807856dSBarry Smith +  snes - the SNES context
47240807856dSBarry Smith -  x - input vector
47250807856dSBarry Smith 
47260807856dSBarry Smith    Output Parameter:
47270807856dSBarry Smith .  y - function vector, as set by SNESSetFunction()
47280807856dSBarry Smith 
47290807856dSBarry Smith    Notes:
47300807856dSBarry Smith    SNESComputeFunction() is typically used within nonlinear solvers
47310807856dSBarry Smith    implementations, so most users would not generally call this routine
47320807856dSBarry Smith    themselves.
47330807856dSBarry Smith 
47340807856dSBarry Smith    Level: developer
47350807856dSBarry Smith 
47360807856dSBarry Smith .keywords: SNES, nonlinear, compute, function
47370807856dSBarry Smith 
47380807856dSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction()
473961b2408cSBarry Smith */
47407087cfbeSBarry Smith PetscErrorCode  SNESComputeFunction_Matlab(SNES snes,Vec x,Vec y, void *ctx)
47410807856dSBarry Smith {
4742e650e774SBarry Smith   PetscErrorCode    ierr;
47438f6e6473SBarry Smith   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
47448f6e6473SBarry Smith   int               nlhs = 1,nrhs = 5;
47458f6e6473SBarry Smith   mxArray           *plhs[1],*prhs[5];
474691621f2eSBarry Smith   long long int     lx = 0,ly = 0,ls = 0;
4747e650e774SBarry Smith 
47480807856dSBarry Smith   PetscFunctionBegin;
47490807856dSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
47500807856dSBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
47510807856dSBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
47520807856dSBarry Smith   PetscCheckSameComm(snes,1,x,2);
47530807856dSBarry Smith   PetscCheckSameComm(snes,1,y,3);
47540807856dSBarry Smith 
47550807856dSBarry Smith   /* call Matlab function in ctx with arguments x and y */
4756e650e774SBarry Smith 
475791621f2eSBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
4758e650e774SBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
4759e650e774SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(x));CHKERRQ(ierr);
476091621f2eSBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
476191621f2eSBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)lx);
476291621f2eSBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)ly);
47638f6e6473SBarry Smith   prhs[3] =  mxCreateString(sctx->funcname);
47648f6e6473SBarry Smith   prhs[4] =  sctx->ctx;
4765b807a863SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeFunctionInternal");CHKERRQ(ierr);
4766e650e774SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4767e650e774SBarry Smith   mxDestroyArray(prhs[0]);
4768e650e774SBarry Smith   mxDestroyArray(prhs[1]);
4769e650e774SBarry Smith   mxDestroyArray(prhs[2]);
47708f6e6473SBarry Smith   mxDestroyArray(prhs[3]);
4771e650e774SBarry Smith   mxDestroyArray(plhs[0]);
47720807856dSBarry Smith   PetscFunctionReturn(0);
47730807856dSBarry Smith }
47740807856dSBarry Smith 
47750807856dSBarry Smith #undef __FUNCT__
47760807856dSBarry Smith #define __FUNCT__ "SNESSetFunctionMatlab"
477761b2408cSBarry Smith /*
47780807856dSBarry Smith    SNESSetFunctionMatlab - Sets the function evaluation routine and function
47790807856dSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
4780e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
47810807856dSBarry Smith 
47820807856dSBarry Smith    Logically Collective on SNES
47830807856dSBarry Smith 
47840807856dSBarry Smith    Input Parameters:
47850807856dSBarry Smith +  snes - the SNES context
47860807856dSBarry Smith .  r - vector to store function value
4787bf388a1fSBarry Smith -  SNESFunction - function evaluation routine
47880807856dSBarry Smith 
47890807856dSBarry Smith    Notes:
47900807856dSBarry Smith    The Newton-like methods typically solve linear systems of the form
47910807856dSBarry Smith $      f'(x) x = -f(x),
47920807856dSBarry Smith    where f'(x) denotes the Jacobian matrix and f(x) is the function.
47930807856dSBarry Smith 
47940807856dSBarry Smith    Level: beginner
47950807856dSBarry Smith 
47960807856dSBarry Smith .keywords: SNES, nonlinear, set, function
47970807856dSBarry Smith 
47980807856dSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
479961b2408cSBarry Smith */
4800bf388a1fSBarry Smith PetscErrorCode  SNESSetFunctionMatlab(SNES snes,Vec r,const char *SNESFunction,mxArray *ctx)
48010807856dSBarry Smith {
48020807856dSBarry Smith   PetscErrorCode    ierr;
48038f6e6473SBarry Smith   SNESMatlabContext *sctx;
48040807856dSBarry Smith 
48050807856dSBarry Smith   PetscFunctionBegin;
48068f6e6473SBarry Smith   /* currently sctx is memory bleed */
48078f6e6473SBarry Smith   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
4808bf388a1fSBarry Smith   ierr = PetscStrallocpy(SNESFunction,&sctx->funcname);CHKERRQ(ierr);
48098f6e6473SBarry Smith   /*
48108f6e6473SBarry Smith      This should work, but it doesn't
48118f6e6473SBarry Smith   sctx->ctx = ctx;
48128f6e6473SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
48138f6e6473SBarry Smith   */
48148f6e6473SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
48158f6e6473SBarry Smith   ierr = SNESSetFunction(snes,r,SNESComputeFunction_Matlab,sctx);CHKERRQ(ierr);
48160807856dSBarry Smith   PetscFunctionReturn(0);
48170807856dSBarry Smith }
481869b4f73cSBarry Smith 
481961b2408cSBarry Smith #undef __FUNCT__
482061b2408cSBarry Smith #define __FUNCT__ "SNESComputeJacobian_Matlab"
482161b2408cSBarry Smith /*
4822bf388a1fSBarry Smith    SNESComputeJacobian_Matlab - Calls the function that has been set with SNESSetJacobianMatlab().
482361b2408cSBarry Smith 
482461b2408cSBarry Smith    Collective on SNES
482561b2408cSBarry Smith 
482661b2408cSBarry Smith    Input Parameters:
482761b2408cSBarry Smith +  snes - the SNES context
482861b2408cSBarry Smith .  x - input vector
482961b2408cSBarry Smith .  A, B - the matrices
483061b2408cSBarry Smith -  ctx - user context
483161b2408cSBarry Smith 
483261b2408cSBarry Smith    Output Parameter:
483361b2408cSBarry Smith .  flag - structure of the matrix
483461b2408cSBarry Smith 
483561b2408cSBarry Smith    Level: developer
483661b2408cSBarry Smith 
483761b2408cSBarry Smith .keywords: SNES, nonlinear, compute, function
483861b2408cSBarry Smith 
483961b2408cSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction()
484061b2408cSBarry Smith @*/
48417087cfbeSBarry Smith PetscErrorCode  SNESComputeJacobian_Matlab(SNES snes,Vec x,Mat *A,Mat *B,MatStructure *flag, void *ctx)
484261b2408cSBarry Smith {
484361b2408cSBarry Smith   PetscErrorCode    ierr;
484461b2408cSBarry Smith   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
484561b2408cSBarry Smith   int               nlhs = 2,nrhs = 6;
484661b2408cSBarry Smith   mxArray           *plhs[2],*prhs[6];
484761b2408cSBarry Smith   long long int     lx = 0,lA = 0,ls = 0, lB = 0;
484861b2408cSBarry Smith 
484961b2408cSBarry Smith   PetscFunctionBegin;
485061b2408cSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
485161b2408cSBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
485261b2408cSBarry Smith 
485361b2408cSBarry Smith   /* call Matlab function in ctx with arguments x and y */
485461b2408cSBarry Smith 
485561b2408cSBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
485661b2408cSBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
485761b2408cSBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(x));CHKERRQ(ierr);
485861b2408cSBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(x));CHKERRQ(ierr);
485961b2408cSBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
486061b2408cSBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)lx);
486161b2408cSBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lA);
486261b2408cSBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lB);
486361b2408cSBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
486461b2408cSBarry Smith   prhs[5] =  sctx->ctx;
4865b807a863SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeJacobianInternal");CHKERRQ(ierr);
486661b2408cSBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
486761b2408cSBarry Smith   *flag   =  (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr);
486861b2408cSBarry Smith   mxDestroyArray(prhs[0]);
486961b2408cSBarry Smith   mxDestroyArray(prhs[1]);
487061b2408cSBarry Smith   mxDestroyArray(prhs[2]);
487161b2408cSBarry Smith   mxDestroyArray(prhs[3]);
487261b2408cSBarry Smith   mxDestroyArray(prhs[4]);
487361b2408cSBarry Smith   mxDestroyArray(plhs[0]);
487461b2408cSBarry Smith   mxDestroyArray(plhs[1]);
487561b2408cSBarry Smith   PetscFunctionReturn(0);
487661b2408cSBarry Smith }
487761b2408cSBarry Smith 
487861b2408cSBarry Smith #undef __FUNCT__
487961b2408cSBarry Smith #define __FUNCT__ "SNESSetJacobianMatlab"
488061b2408cSBarry Smith /*
488161b2408cSBarry Smith    SNESSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
488261b2408cSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
4883e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
488461b2408cSBarry Smith 
488561b2408cSBarry Smith    Logically Collective on SNES
488661b2408cSBarry Smith 
488761b2408cSBarry Smith    Input Parameters:
488861b2408cSBarry Smith +  snes - the SNES context
488961b2408cSBarry Smith .  A,B - Jacobian matrices
4890bf388a1fSBarry Smith .  SNESJacobianFunction - function evaluation routine
489161b2408cSBarry Smith -  ctx - user context
489261b2408cSBarry Smith 
489361b2408cSBarry Smith    Level: developer
489461b2408cSBarry Smith 
489561b2408cSBarry Smith .keywords: SNES, nonlinear, set, function
489661b2408cSBarry Smith 
4897bf388a1fSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction(), SNESJacobianFunction
489861b2408cSBarry Smith */
4899bf388a1fSBarry Smith PetscErrorCode  SNESSetJacobianMatlab(SNES snes,Mat A,Mat B,const char *SNESJacobianFunction,mxArray *ctx)
490061b2408cSBarry Smith {
490161b2408cSBarry Smith   PetscErrorCode    ierr;
490261b2408cSBarry Smith   SNESMatlabContext *sctx;
490361b2408cSBarry Smith 
490461b2408cSBarry Smith   PetscFunctionBegin;
490561b2408cSBarry Smith   /* currently sctx is memory bleed */
490661b2408cSBarry Smith   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
4907bf388a1fSBarry Smith   ierr = PetscStrallocpy(SNESJacobianFunction,&sctx->funcname);CHKERRQ(ierr);
490861b2408cSBarry Smith   /*
490961b2408cSBarry Smith      This should work, but it doesn't
491061b2408cSBarry Smith   sctx->ctx = ctx;
491161b2408cSBarry Smith   mexMakeArrayPersistent(sctx->ctx);
491261b2408cSBarry Smith   */
491361b2408cSBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
491461b2408cSBarry Smith   ierr = SNESSetJacobian(snes,A,B,SNESComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
491561b2408cSBarry Smith   PetscFunctionReturn(0);
491661b2408cSBarry Smith }
491769b4f73cSBarry Smith 
4918f9eb7ae2SShri Abhyankar #undef __FUNCT__
4919f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitor_Matlab"
4920f9eb7ae2SShri Abhyankar /*
4921f9eb7ae2SShri Abhyankar    SNESMonitor_Matlab - Calls the function that has been set with SNESMonitorSetMatlab().
4922f9eb7ae2SShri Abhyankar 
4923f9eb7ae2SShri Abhyankar    Collective on SNES
4924f9eb7ae2SShri Abhyankar 
4925f9eb7ae2SShri Abhyankar .seealso: SNESSetFunction(), SNESGetFunction()
4926f9eb7ae2SShri Abhyankar @*/
49277087cfbeSBarry Smith PetscErrorCode  SNESMonitor_Matlab(SNES snes,PetscInt it, PetscReal fnorm, void *ctx)
4928f9eb7ae2SShri Abhyankar {
4929f9eb7ae2SShri Abhyankar   PetscErrorCode    ierr;
493048f37e70SShri Abhyankar   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
4931f9eb7ae2SShri Abhyankar   int               nlhs = 1,nrhs = 6;
4932f9eb7ae2SShri Abhyankar   mxArray           *plhs[1],*prhs[6];
4933f9eb7ae2SShri Abhyankar   long long int     lx = 0,ls = 0;
4934f9eb7ae2SShri Abhyankar   Vec               x=snes->vec_sol;
4935f9eb7ae2SShri Abhyankar 
4936f9eb7ae2SShri Abhyankar   PetscFunctionBegin;
4937f9eb7ae2SShri Abhyankar   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4938f9eb7ae2SShri Abhyankar 
4939f9eb7ae2SShri Abhyankar   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
4940f9eb7ae2SShri Abhyankar   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
4941f9eb7ae2SShri Abhyankar   prhs[0] =  mxCreateDoubleScalar((double)ls);
4942f9eb7ae2SShri Abhyankar   prhs[1] =  mxCreateDoubleScalar((double)it);
4943f9eb7ae2SShri Abhyankar   prhs[2] =  mxCreateDoubleScalar((double)fnorm);
4944f9eb7ae2SShri Abhyankar   prhs[3] =  mxCreateDoubleScalar((double)lx);
4945f9eb7ae2SShri Abhyankar   prhs[4] =  mxCreateString(sctx->funcname);
4946f9eb7ae2SShri Abhyankar   prhs[5] =  sctx->ctx;
4947f9eb7ae2SShri Abhyankar   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESMonitorInternal");CHKERRQ(ierr);
4948f9eb7ae2SShri Abhyankar   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4949f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[0]);
4950f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[1]);
4951f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[2]);
4952f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[3]);
4953f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[4]);
4954f9eb7ae2SShri Abhyankar   mxDestroyArray(plhs[0]);
4955f9eb7ae2SShri Abhyankar   PetscFunctionReturn(0);
4956f9eb7ae2SShri Abhyankar }
4957f9eb7ae2SShri Abhyankar 
4958f9eb7ae2SShri Abhyankar #undef __FUNCT__
4959f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitorSetMatlab"
4960f9eb7ae2SShri Abhyankar /*
4961e3c5b3baSBarry Smith    SNESMonitorSetMatlab - Sets the monitor function from MATLAB
4962f9eb7ae2SShri Abhyankar 
4963f9eb7ae2SShri Abhyankar    Level: developer
4964f9eb7ae2SShri Abhyankar 
4965f9eb7ae2SShri Abhyankar .keywords: SNES, nonlinear, set, function
4966f9eb7ae2SShri Abhyankar 
4967f9eb7ae2SShri Abhyankar .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
4968f9eb7ae2SShri Abhyankar */
4969bf388a1fSBarry Smith PetscErrorCode  SNESMonitorSetMatlab(SNES snes,const char *SNESMonitorFunction,mxArray *ctx)
4970f9eb7ae2SShri Abhyankar {
4971f9eb7ae2SShri Abhyankar   PetscErrorCode    ierr;
4972f9eb7ae2SShri Abhyankar   SNESMatlabContext *sctx;
4973f9eb7ae2SShri Abhyankar 
4974f9eb7ae2SShri Abhyankar   PetscFunctionBegin;
4975f9eb7ae2SShri Abhyankar   /* currently sctx is memory bleed */
4976f9eb7ae2SShri Abhyankar   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
4977bf388a1fSBarry Smith   ierr = PetscStrallocpy(SNESMonitorFunction,&sctx->funcname);CHKERRQ(ierr);
4978f9eb7ae2SShri Abhyankar   /*
4979f9eb7ae2SShri Abhyankar      This should work, but it doesn't
4980f9eb7ae2SShri Abhyankar   sctx->ctx = ctx;
4981f9eb7ae2SShri Abhyankar   mexMakeArrayPersistent(sctx->ctx);
4982f9eb7ae2SShri Abhyankar   */
4983f9eb7ae2SShri Abhyankar   sctx->ctx = mxDuplicateArray(ctx);
4984f9eb7ae2SShri Abhyankar   ierr = SNESMonitorSet(snes,SNESMonitor_Matlab,sctx,PETSC_NULL);CHKERRQ(ierr);
4985f9eb7ae2SShri Abhyankar   PetscFunctionReturn(0);
4986f9eb7ae2SShri Abhyankar }
4987f9eb7ae2SShri Abhyankar 
498869b4f73cSBarry Smith #endif
4989