xref: /petsc/src/snes/interface/snes.c (revision 172a4300a15d166383dd982ea1d28e703d4d6711)
19b94acceSBarry Smith 
2b45d2f2cSJed Brown #include <petsc-private/snesimpl.h>      /*I "petscsnes.h"  I*/
36cab3a1bSJed Brown #include <petscdmshell.h>                /*I "petscdmshell.h" I*/
4a64e098fSPeter Brune #include <petscsys.h>                    /*I "petscsys.h" I*/
59b94acceSBarry Smith 
6ace3abfcSBarry Smith PetscBool  SNESRegisterAllCalled = PETSC_FALSE;
78ba1e511SMatthew Knepley PetscFList SNESList              = PETSC_NULL;
88ba1e511SMatthew Knepley 
98ba1e511SMatthew Knepley /* Logging support */
1022c6f798SBarry Smith PetscClassId  SNES_CLASSID, DMSNES_CLASSID;
11f1c6b773SPeter Brune PetscLogEvent  SNES_Solve, SNES_FunctionEval, SNES_JacobianEval, SNES_GSEval;
12a09944afSBarry Smith 
13a09944afSBarry Smith #undef __FUNCT__
14e113a28aSBarry Smith #define __FUNCT__ "SNESSetErrorIfNotConverged"
15e113a28aSBarry Smith /*@
16e113a28aSBarry Smith    SNESSetErrorIfNotConverged - Causes SNESSolve() to generate an error if the solver has not converged.
17e113a28aSBarry Smith 
183f9fe445SBarry Smith    Logically Collective on SNES
19e113a28aSBarry Smith 
20e113a28aSBarry Smith    Input Parameters:
21e113a28aSBarry Smith +  snes - iterative context obtained from SNESCreate()
22e113a28aSBarry Smith -  flg - PETSC_TRUE indicates you want the error generated
23e113a28aSBarry Smith 
24e113a28aSBarry Smith    Options database keys:
25e113a28aSBarry Smith .  -snes_error_if_not_converged : this takes an optional truth value (0/1/no/yes/true/false)
26e113a28aSBarry Smith 
27e113a28aSBarry Smith    Level: intermediate
28e113a28aSBarry Smith 
29e113a28aSBarry Smith    Notes:
30e113a28aSBarry Smith     Normally PETSc continues if a linear solver fails to converge, you can call SNESGetConvergedReason() after a SNESSolve()
31e113a28aSBarry Smith     to determine if it has converged.
32e113a28aSBarry Smith 
33e113a28aSBarry Smith .keywords: SNES, set, initial guess, nonzero
34e113a28aSBarry Smith 
35e113a28aSBarry Smith .seealso: SNESGetErrorIfNotConverged(), KSPGetErrorIfNotConverged(), KSPSetErrorIFNotConverged()
36e113a28aSBarry Smith @*/
377087cfbeSBarry Smith PetscErrorCode  SNESSetErrorIfNotConverged(SNES snes,PetscBool  flg)
38e113a28aSBarry Smith {
39e113a28aSBarry Smith   PetscFunctionBegin;
40e113a28aSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
41acfcf0e5SJed Brown   PetscValidLogicalCollectiveBool(snes,flg,2);
42e113a28aSBarry Smith   snes->errorifnotconverged = flg;
43dd568438SSatish Balay 
44e113a28aSBarry Smith   PetscFunctionReturn(0);
45e113a28aSBarry Smith }
46e113a28aSBarry Smith 
47e113a28aSBarry Smith #undef __FUNCT__
48e113a28aSBarry Smith #define __FUNCT__ "SNESGetErrorIfNotConverged"
49e113a28aSBarry Smith /*@
50e113a28aSBarry Smith    SNESGetErrorIfNotConverged - Will SNESSolve() generate an error if the solver does not converge?
51e113a28aSBarry Smith 
52e113a28aSBarry Smith    Not Collective
53e113a28aSBarry Smith 
54e113a28aSBarry Smith    Input Parameter:
55e113a28aSBarry Smith .  snes - iterative context obtained from SNESCreate()
56e113a28aSBarry Smith 
57e113a28aSBarry Smith    Output Parameter:
58e113a28aSBarry Smith .  flag - PETSC_TRUE if it will generate an error, else PETSC_FALSE
59e113a28aSBarry Smith 
60e113a28aSBarry Smith    Level: intermediate
61e113a28aSBarry Smith 
62e113a28aSBarry Smith .keywords: SNES, set, initial guess, nonzero
63e113a28aSBarry Smith 
64e113a28aSBarry Smith .seealso:  SNESSetErrorIfNotConverged(), KSPGetErrorIfNotConverged(), KSPSetErrorIFNotConverged()
65e113a28aSBarry Smith @*/
667087cfbeSBarry Smith PetscErrorCode  SNESGetErrorIfNotConverged(SNES snes,PetscBool  *flag)
67e113a28aSBarry Smith {
68e113a28aSBarry Smith   PetscFunctionBegin;
69e113a28aSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
70e113a28aSBarry Smith   PetscValidPointer(flag,2);
71e113a28aSBarry Smith   *flag = snes->errorifnotconverged;
72e113a28aSBarry Smith   PetscFunctionReturn(0);
73e113a28aSBarry Smith }
74e113a28aSBarry Smith 
75e113a28aSBarry Smith #undef __FUNCT__
764936397dSBarry Smith #define __FUNCT__ "SNESSetFunctionDomainError"
77e725d27bSBarry Smith /*@
784936397dSBarry Smith    SNESSetFunctionDomainError - tells SNES that the input vector to your FormFunction is not
794936397dSBarry Smith      in the functions domain. For example, negative pressure.
804936397dSBarry Smith 
813f9fe445SBarry Smith    Logically Collective on SNES
824936397dSBarry Smith 
834936397dSBarry Smith    Input Parameters:
846a388c36SPeter Brune .  snes - the SNES context
854936397dSBarry Smith 
8628529972SSatish Balay    Level: advanced
874936397dSBarry Smith 
884936397dSBarry Smith .keywords: SNES, view
894936397dSBarry Smith 
904936397dSBarry Smith .seealso: SNESCreate(), SNESSetFunction()
914936397dSBarry Smith @*/
927087cfbeSBarry Smith PetscErrorCode  SNESSetFunctionDomainError(SNES snes)
934936397dSBarry Smith {
944936397dSBarry Smith   PetscFunctionBegin;
950700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
964936397dSBarry Smith   snes->domainerror = PETSC_TRUE;
974936397dSBarry Smith   PetscFunctionReturn(0);
984936397dSBarry Smith }
994936397dSBarry Smith 
1006a388c36SPeter Brune 
1016a388c36SPeter Brune #undef __FUNCT__
1026a388c36SPeter Brune #define __FUNCT__ "SNESGetFunctionDomainError"
1036a388c36SPeter Brune /*@
104c77b2880SPeter Brune    SNESGetFunctionDomainError - Gets the status of the domain error after a call to SNESComputeFunction;
1056a388c36SPeter Brune 
1066a388c36SPeter Brune    Logically Collective on SNES
1076a388c36SPeter Brune 
1086a388c36SPeter Brune    Input Parameters:
1096a388c36SPeter Brune .  snes - the SNES context
1106a388c36SPeter Brune 
1116a388c36SPeter Brune    Output Parameters:
1126a388c36SPeter Brune .  domainerror Set to PETSC_TRUE if there's a domain error; PETSC_FALSE otherwise.
1136a388c36SPeter Brune 
1146a388c36SPeter Brune    Level: advanced
1156a388c36SPeter Brune 
1166a388c36SPeter Brune .keywords: SNES, view
1176a388c36SPeter Brune 
1186a388c36SPeter Brune .seealso: SNESSetFunctionDomainError, SNESComputeFunction()
1196a388c36SPeter Brune @*/
1206a388c36SPeter Brune PetscErrorCode  SNESGetFunctionDomainError(SNES snes, PetscBool *domainerror)
1216a388c36SPeter Brune {
1226a388c36SPeter Brune   PetscFunctionBegin;
1236a388c36SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1246a388c36SPeter Brune   PetscValidPointer(domainerror, 2);
1256a388c36SPeter Brune   *domainerror = snes->domainerror;
1266a388c36SPeter Brune   PetscFunctionReturn(0);
1276a388c36SPeter Brune }
1286a388c36SPeter Brune 
12955849f57SBarry Smith #undef __FUNCT__
13055849f57SBarry Smith #define __FUNCT__ "SNESLoad"
13155849f57SBarry Smith /*@C
13255849f57SBarry Smith   SNESLoad - Loads a SNES that has been stored in binary  with SNESView().
13355849f57SBarry Smith 
13455849f57SBarry Smith   Collective on PetscViewer
13555849f57SBarry Smith 
13655849f57SBarry Smith   Input Parameters:
13755849f57SBarry Smith + newdm - the newly loaded SNES, this needs to have been created with SNESCreate() or
13855849f57SBarry Smith            some related function before a call to SNESLoad().
13955849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
14055849f57SBarry Smith 
14155849f57SBarry Smith    Level: intermediate
14255849f57SBarry Smith 
14355849f57SBarry Smith   Notes:
14455849f57SBarry Smith    The type is determined by the data in the file, any type set into the SNES before this call is ignored.
14555849f57SBarry Smith 
14655849f57SBarry Smith   Notes for advanced users:
14755849f57SBarry Smith   Most users should not need to know the details of the binary storage
14855849f57SBarry Smith   format, since SNESLoad() and TSView() completely hide these details.
14955849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
15055849f57SBarry Smith   format is
15155849f57SBarry Smith .vb
15255849f57SBarry Smith      has not yet been determined
15355849f57SBarry Smith .ve
15455849f57SBarry Smith 
15555849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), SNESView(), MatLoad(), VecLoad()
15655849f57SBarry Smith @*/
1572d53ad75SBarry Smith PetscErrorCode  SNESLoad(SNES snes, PetscViewer viewer)
15855849f57SBarry Smith {
15955849f57SBarry Smith   PetscErrorCode ierr;
16055849f57SBarry Smith   PetscBool      isbinary;
16155849f57SBarry Smith   PetscInt       classid;
16255849f57SBarry Smith   char           type[256];
16355849f57SBarry Smith   KSP            ksp;
1642d53ad75SBarry Smith   DM             dm;
1652d53ad75SBarry Smith   DMSNES         dmsnes;
16655849f57SBarry Smith 
16755849f57SBarry Smith   PetscFunctionBegin;
1682d53ad75SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
16955849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
17055849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
17155849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
17255849f57SBarry Smith 
17355849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
1742d53ad75SBarry Smith   if (classid != SNES_FILE_CLASSID) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_ARG_WRONG,"Not SNES next in file");
17555849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr);
1762d53ad75SBarry Smith   ierr = SNESSetType(snes, type);CHKERRQ(ierr);
1772d53ad75SBarry Smith   if (snes->ops->load) {
1782d53ad75SBarry Smith     ierr = (*snes->ops->load)(snes,viewer);CHKERRQ(ierr);
179f2c2a1b9SBarry Smith   }
1802d53ad75SBarry Smith   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
1812d53ad75SBarry Smith   ierr = DMGetDMSNES(dm,&dmsnes);CHKERRQ(ierr);
1822d53ad75SBarry Smith   ierr = DMSNESLoad(dmsnes,viewer);CHKERRQ(ierr);
1832d53ad75SBarry Smith   ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
18455849f57SBarry Smith   ierr = KSPLoad(ksp,viewer);CHKERRQ(ierr);
18555849f57SBarry Smith   PetscFunctionReturn(0);
18655849f57SBarry Smith }
1876a388c36SPeter Brune 
1884936397dSBarry Smith #undef __FUNCT__
1894a2ae208SSatish Balay #define __FUNCT__ "SNESView"
1907e2c5f70SBarry Smith /*@C
1919b94acceSBarry Smith    SNESView - Prints the SNES data structure.
1929b94acceSBarry Smith 
1934c49b128SBarry Smith    Collective on SNES
194fee21e36SBarry Smith 
195c7afd0dbSLois Curfman McInnes    Input Parameters:
196c7afd0dbSLois Curfman McInnes +  SNES - the SNES context
197c7afd0dbSLois Curfman McInnes -  viewer - visualization context
198c7afd0dbSLois Curfman McInnes 
1999b94acceSBarry Smith    Options Database Key:
200c8a8ba5cSLois Curfman McInnes .  -snes_view - Calls SNESView() at end of SNESSolve()
2019b94acceSBarry Smith 
2029b94acceSBarry Smith    Notes:
2039b94acceSBarry Smith    The available visualization contexts include
204b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
205b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
206c8a8ba5cSLois Curfman McInnes          output where only the first processor opens
207c8a8ba5cSLois Curfman McInnes          the file.  All other processors send their
208c8a8ba5cSLois Curfman McInnes          data to the first processor to print.
2099b94acceSBarry Smith 
2103e081fefSLois Curfman McInnes    The user can open an alternative visualization context with
211b0a32e0cSBarry Smith    PetscViewerASCIIOpen() - output to a specified file.
2129b94acceSBarry Smith 
21336851e7fSLois Curfman McInnes    Level: beginner
21436851e7fSLois Curfman McInnes 
2159b94acceSBarry Smith .keywords: SNES, view
2169b94acceSBarry Smith 
217b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
2189b94acceSBarry Smith @*/
2197087cfbeSBarry Smith PetscErrorCode  SNESView(SNES snes,PetscViewer viewer)
2209b94acceSBarry Smith {
221fa9f3622SBarry Smith   SNESKSPEW           *kctx;
222dfbe8321SBarry Smith   PetscErrorCode      ierr;
22394b7f48cSBarry Smith   KSP                 ksp;
2247f1410a3SPeter Brune   SNESLineSearch      linesearch;
22572a02f06SBarry Smith   PetscBool           iascii,isstring,isbinary,isdraw;
2262d53ad75SBarry Smith   DMSNES              dmsnes;
2279b94acceSBarry Smith 
2283a40ed3dSBarry Smith   PetscFunctionBegin;
2290700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2303050cee2SBarry Smith   if (!viewer) {
2317adad957SLisandro Dalcin     ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&viewer);CHKERRQ(ierr);
2323050cee2SBarry Smith   }
2330700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
234c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,viewer,2);
23574679c65SBarry Smith 
236251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
237251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
23855849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
23972a02f06SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
24032077d6dSBarry Smith   if (iascii) {
241317d6ea6SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)snes,viewer,"SNES Object");CHKERRQ(ierr);
242e7788613SBarry Smith     if (snes->ops->view) {
243b0a32e0cSBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
244e7788613SBarry Smith       ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr);
245b0a32e0cSBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2460ef38995SBarry Smith     }
24777431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum iterations=%D, maximum function evaluations=%D\n",snes->max_its,snes->max_funcs);CHKERRQ(ierr);
248a83599f4SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  tolerances: relative=%G, absolute=%G, solution=%G\n",
249c60f73f4SPeter Brune                  snes->rtol,snes->abstol,snes->stol);CHKERRQ(ierr);
25077431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",snes->linear_its);CHKERRQ(ierr);
25177431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  total number of function evaluations=%D\n",snes->nfuncs);CHKERRQ(ierr);
25217fe4bdfSPeter Brune     if (snes->gridsequence) {
25317fe4bdfSPeter Brune       ierr = PetscViewerASCIIPrintf(viewer,"  total number of grid sequence refinements=%D\n",snes->gridsequence);CHKERRQ(ierr);
25417fe4bdfSPeter Brune     }
2559b94acceSBarry Smith     if (snes->ksp_ewconv) {
256fa9f3622SBarry Smith       kctx = (SNESKSPEW *)snes->kspconvctx;
2579b94acceSBarry Smith       if (kctx) {
25877431f27SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Eisenstat-Walker computation of KSP relative tolerance (version %D)\n",kctx->version);CHKERRQ(ierr);
259a83599f4SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"    rtol_0=%G, rtol_max=%G, threshold=%G\n",kctx->rtol_0,kctx->rtol_max,kctx->threshold);CHKERRQ(ierr);
260a83599f4SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"    gamma=%G, alpha=%G, alpha2=%G\n",kctx->gamma,kctx->alpha,kctx->alpha2);CHKERRQ(ierr);
2619b94acceSBarry Smith       }
2629b94acceSBarry Smith     }
263eb1f6c34SBarry Smith     if (snes->lagpreconditioner == -1) {
264eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioned is never rebuilt\n");CHKERRQ(ierr);
265eb1f6c34SBarry Smith     } else if (snes->lagpreconditioner > 1) {
266eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioned is rebuilt every %D new Jacobians\n",snes->lagpreconditioner);CHKERRQ(ierr);
267eb1f6c34SBarry Smith     }
268eb1f6c34SBarry Smith     if (snes->lagjacobian == -1) {
269eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Jacobian is never rebuilt\n");CHKERRQ(ierr);
270eb1f6c34SBarry Smith     } else if (snes->lagjacobian > 1) {
27142f4f86dSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Jacobian is rebuilt every %D SNES iterations\n",snes->lagjacobian);CHKERRQ(ierr);
272eb1f6c34SBarry Smith     }
2730f5bd95cSBarry Smith   } else if (isstring) {
274317d6ea6SBarry Smith     const char *type;
275454a90a3SBarry Smith     ierr = SNESGetType(snes,&type);CHKERRQ(ierr);
276b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr);
27755849f57SBarry Smith   } else if (isbinary) {
27855849f57SBarry Smith     PetscInt         classid = SNES_FILE_CLASSID;
27955849f57SBarry Smith     MPI_Comm         comm;
28055849f57SBarry Smith     PetscMPIInt      rank;
28155849f57SBarry Smith     char             type[256];
28255849f57SBarry Smith 
28355849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr);
28455849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
28555849f57SBarry Smith     if (!rank) {
28655849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
28755849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)snes)->type_name,256);CHKERRQ(ierr);
28855849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
28955849f57SBarry Smith     }
29055849f57SBarry Smith     if (snes->ops->view) {
29155849f57SBarry Smith       ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr);
29255849f57SBarry Smith     }
29372a02f06SBarry Smith   } else if (isdraw) {
29472a02f06SBarry Smith     PetscDraw draw;
29572a02f06SBarry Smith     char      str[36];
29689fd9fafSBarry Smith     PetscReal x,y,bottom,h;
29772a02f06SBarry Smith 
29872a02f06SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
29972a02f06SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
30072a02f06SBarry Smith     ierr = PetscStrcpy(str,"SNES: ");CHKERRQ(ierr);
30172a02f06SBarry Smith     ierr = PetscStrcat(str,((PetscObject)snes)->type_name);CHKERRQ(ierr);
30289fd9fafSBarry Smith     ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLUE,PETSC_DRAW_BLACK,str,PETSC_NULL,&h);CHKERRQ(ierr);
30389fd9fafSBarry Smith     bottom = y - h;
30472a02f06SBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
305c4646bacSPeter Brune     if (snes->ops->view) {
306c4646bacSPeter Brune       ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr);
307c4646bacSPeter Brune     }
30872a02f06SBarry Smith   }
30972a02f06SBarry Smith   if (snes->linesearch) {
31072a02f06SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
31172a02f06SBarry Smith     ierr = SNESGetSNESLineSearch(snes, &linesearch);CHKERRQ(ierr);
31272a02f06SBarry Smith     ierr = SNESLineSearchView(linesearch, viewer);CHKERRQ(ierr);
31372a02f06SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
31419bcc07fSBarry Smith   }
31542f4f86dSBarry Smith   if (snes->pc && snes->usespc) {
3164a0c5b0cSMatthew G Knepley     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
3174a0c5b0cSMatthew G Knepley     ierr = SNESView(snes->pc, viewer);CHKERRQ(ierr);
3184a0c5b0cSMatthew G Knepley     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
3194a0c5b0cSMatthew G Knepley   }
3202d53ad75SBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
3212d53ad75SBarry Smith   ierr = DMGetDMSNES(snes->dm,&dmsnes);CHKERRQ(ierr);
3222d53ad75SBarry Smith   ierr = DMSNESView(dmsnes, viewer);CHKERRQ(ierr);
3232d53ad75SBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
3242c155ee1SBarry Smith   if (snes->usesksp) {
3252c155ee1SBarry Smith     ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
326b0a32e0cSBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
32794b7f48cSBarry Smith     ierr = KSPView(ksp,viewer);CHKERRQ(ierr);
328b0a32e0cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
3292c155ee1SBarry Smith   }
33072a02f06SBarry Smith   if (isdraw) {
33172a02f06SBarry Smith     PetscDraw draw;
33272a02f06SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
33372a02f06SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
3347f1410a3SPeter Brune   }
3353a40ed3dSBarry Smith   PetscFunctionReturn(0);
3369b94acceSBarry Smith }
3379b94acceSBarry Smith 
33876b2cf59SMatthew Knepley /*
33976b2cf59SMatthew Knepley   We retain a list of functions that also take SNES command
34076b2cf59SMatthew Knepley   line options. These are called at the end SNESSetFromOptions()
34176b2cf59SMatthew Knepley */
34276b2cf59SMatthew Knepley #define MAXSETFROMOPTIONS 5
343a7cc72afSBarry Smith static PetscInt numberofsetfromoptions;
3446849ba73SBarry Smith static PetscErrorCode (*othersetfromoptions[MAXSETFROMOPTIONS])(SNES);
34576b2cf59SMatthew Knepley 
346e74ef692SMatthew Knepley #undef __FUNCT__
347e74ef692SMatthew Knepley #define __FUNCT__ "SNESAddOptionsChecker"
348ac226902SBarry Smith /*@C
34976b2cf59SMatthew Knepley   SNESAddOptionsChecker - Adds an additional function to check for SNES options.
35076b2cf59SMatthew Knepley 
35176b2cf59SMatthew Knepley   Not Collective
35276b2cf59SMatthew Knepley 
35376b2cf59SMatthew Knepley   Input Parameter:
35476b2cf59SMatthew Knepley . snescheck - function that checks for options
35576b2cf59SMatthew Knepley 
35676b2cf59SMatthew Knepley   Level: developer
35776b2cf59SMatthew Knepley 
35876b2cf59SMatthew Knepley .seealso: SNESSetFromOptions()
35976b2cf59SMatthew Knepley @*/
3607087cfbeSBarry Smith PetscErrorCode  SNESAddOptionsChecker(PetscErrorCode (*snescheck)(SNES))
36176b2cf59SMatthew Knepley {
36276b2cf59SMatthew Knepley   PetscFunctionBegin;
36376b2cf59SMatthew Knepley   if (numberofsetfromoptions >= MAXSETFROMOPTIONS) {
364e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "Too many options checkers, only %D allowed", MAXSETFROMOPTIONS);
36576b2cf59SMatthew Knepley   }
36676b2cf59SMatthew Knepley   othersetfromoptions[numberofsetfromoptions++] = snescheck;
36776b2cf59SMatthew Knepley   PetscFunctionReturn(0);
36876b2cf59SMatthew Knepley }
36976b2cf59SMatthew Knepley 
3707087cfbeSBarry Smith extern PetscErrorCode  SNESDefaultMatrixFreeCreate2(SNES,Vec,Mat*);
371aa3661deSLisandro Dalcin 
372aa3661deSLisandro Dalcin #undef __FUNCT__
373aa3661deSLisandro Dalcin #define __FUNCT__ "SNESSetUpMatrixFree_Private"
374ace3abfcSBarry Smith static PetscErrorCode SNESSetUpMatrixFree_Private(SNES snes, PetscBool  hasOperator, PetscInt version)
375aa3661deSLisandro Dalcin {
376aa3661deSLisandro Dalcin   Mat            J;
377aa3661deSLisandro Dalcin   KSP            ksp;
378aa3661deSLisandro Dalcin   PC             pc;
379ace3abfcSBarry Smith   PetscBool      match;
380aa3661deSLisandro Dalcin   PetscErrorCode ierr;
381aa3661deSLisandro Dalcin 
382aa3661deSLisandro Dalcin   PetscFunctionBegin;
3830700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
384aa3661deSLisandro Dalcin 
38598613b67SLisandro Dalcin   if (!snes->vec_func && (snes->jacobian || snes->jacobian_pre)) {
38698613b67SLisandro Dalcin     Mat A = snes->jacobian, B = snes->jacobian_pre;
38798613b67SLisandro Dalcin     ierr = MatGetVecs(A ? A : B, PETSC_NULL,&snes->vec_func);CHKERRQ(ierr);
38898613b67SLisandro Dalcin   }
38998613b67SLisandro Dalcin 
390aa3661deSLisandro Dalcin   if (version == 1) {
391aa3661deSLisandro Dalcin     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
39298613b67SLisandro Dalcin     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
3939c6ac3b3SBarry Smith     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
394aa3661deSLisandro Dalcin   } else if (version == 2) {
395e32f2f54SBarry Smith     if (!snes->vec_func) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"SNESSetFunction() must be called first");
39682a7e548SBarry Smith #if !defined(PETSC_USE_COMPLEX) && !defined(PETSC_USE_REAL_SINGLE) && !defined(PETSC_USE_REAL___FLOAT128)
397aa3661deSLisandro Dalcin     ierr = SNESDefaultMatrixFreeCreate2(snes,snes->vec_func,&J);CHKERRQ(ierr);
398aa3661deSLisandro Dalcin #else
399e32f2f54SBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP, "matrix-free operator rutines (version 2)");
400aa3661deSLisandro Dalcin #endif
401a8248277SBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "matrix-free operator rutines, only version 1 and 2");
402aa3661deSLisandro Dalcin 
403aa3661deSLisandro Dalcin   ierr = PetscInfo1(snes,"Setting default matrix-free operator routines (version %D)\n", version);CHKERRQ(ierr);
404d3462f78SMatthew Knepley   if (hasOperator) {
4053232da50SPeter Brune 
406aa3661deSLisandro Dalcin     /* This version replaces the user provided Jacobian matrix with a
407aa3661deSLisandro Dalcin        matrix-free version but still employs the user-provided preconditioner matrix. */
408aa3661deSLisandro Dalcin     ierr = SNESSetJacobian(snes,J,0,0,0);CHKERRQ(ierr);
409aa3661deSLisandro Dalcin   } else {
410aa3661deSLisandro Dalcin     /* This version replaces both the user-provided Jacobian and the user-
4113232da50SPeter Brune      provided preconditioner Jacobian with the default matrix free version. */
412*172a4300SPeter Brune     if ((snes->pcside == PC_LEFT) && snes->pc) {
413*172a4300SPeter Brune       ierr = SNESSetJacobian(snes,J,0,0,0);CHKERRQ(ierr);
414*172a4300SPeter Brune     } else {
41528a52e04SBarry Smith       ierr = SNESSetJacobian(snes,J,J,MatMFFDComputeJacobian,0);CHKERRQ(ierr);
416*172a4300SPeter Brune     }
417aa3661deSLisandro Dalcin     /* Force no preconditioner */
418aa3661deSLisandro Dalcin     ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
419aa3661deSLisandro Dalcin     ierr = KSPGetPC(ksp,&pc);CHKERRQ(ierr);
420251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)pc,PCSHELL,&match);CHKERRQ(ierr);
421aa3661deSLisandro Dalcin     if (!match) {
422aa3661deSLisandro Dalcin       ierr = PetscInfo(snes,"Setting default matrix-free preconditioner routines\nThat is no preconditioner is being used\n");CHKERRQ(ierr);
423aa3661deSLisandro Dalcin       ierr = PCSetType(pc,PCNONE);CHKERRQ(ierr);
424aa3661deSLisandro Dalcin     }
425aa3661deSLisandro Dalcin   }
4266bf464f9SBarry Smith   ierr = MatDestroy(&J);CHKERRQ(ierr);
427aa3661deSLisandro Dalcin   PetscFunctionReturn(0);
428aa3661deSLisandro Dalcin }
429aa3661deSLisandro Dalcin 
4304a2ae208SSatish Balay #undef __FUNCT__
431dfe15315SJed Brown #define __FUNCT__ "DMRestrictHook_SNESVecSol"
432dfe15315SJed Brown static PetscErrorCode DMRestrictHook_SNESVecSol(DM dmfine,Mat Restrict,Vec Rscale,Mat Inject,DM dmcoarse,void *ctx)
433dfe15315SJed Brown {
434dfe15315SJed Brown   SNES snes = (SNES)ctx;
435dfe15315SJed Brown   PetscErrorCode ierr;
436dfe15315SJed Brown   Vec Xfine,Xfine_named = PETSC_NULL,Xcoarse;
437dfe15315SJed Brown 
438dfe15315SJed Brown   PetscFunctionBegin;
43916ebb321SJed Brown   if (PetscLogPrintInfo) {
44016ebb321SJed Brown     PetscInt finelevel,coarselevel,fineclevel,coarseclevel;
44116ebb321SJed Brown     ierr = DMGetRefineLevel(dmfine,&finelevel);CHKERRQ(ierr);
44216ebb321SJed Brown     ierr = DMGetCoarsenLevel(dmfine,&fineclevel);CHKERRQ(ierr);
44316ebb321SJed Brown     ierr = DMGetRefineLevel(dmcoarse,&coarselevel);CHKERRQ(ierr);
44416ebb321SJed Brown     ierr = DMGetCoarsenLevel(dmcoarse,&coarseclevel);CHKERRQ(ierr);
44516ebb321SJed Brown     ierr = PetscInfo4(dmfine,"Restricting SNES solution vector from level %D-%D to level %D-%D\n",finelevel,fineclevel,coarselevel,coarseclevel);CHKERRQ(ierr);
44616ebb321SJed Brown   }
447dfe15315SJed Brown   if (dmfine == snes->dm) Xfine = snes->vec_sol;
448dfe15315SJed Brown   else {
449dfe15315SJed Brown     ierr = DMGetNamedGlobalVector(dmfine,"SNESVecSol",&Xfine_named);CHKERRQ(ierr);
450dfe15315SJed Brown     Xfine = Xfine_named;
451dfe15315SJed Brown   }
452dfe15315SJed Brown   ierr = DMGetNamedGlobalVector(dmcoarse,"SNESVecSol",&Xcoarse);CHKERRQ(ierr);
453dfe15315SJed Brown   ierr = MatRestrict(Restrict,Xfine,Xcoarse);CHKERRQ(ierr);
454dfe15315SJed Brown   ierr = VecPointwiseMult(Xcoarse,Xcoarse,Rscale);CHKERRQ(ierr);
455dfe15315SJed Brown   ierr = DMRestoreNamedGlobalVector(dmcoarse,"SNESVecSol",&Xcoarse);CHKERRQ(ierr);
456dfe15315SJed Brown   if (Xfine_named) {ierr = DMRestoreNamedGlobalVector(dmfine,"SNESVecSol",&Xfine_named);CHKERRQ(ierr);}
457dfe15315SJed Brown   PetscFunctionReturn(0);
458dfe15315SJed Brown }
459dfe15315SJed Brown 
460dfe15315SJed Brown #undef __FUNCT__
46116ebb321SJed Brown #define __FUNCT__ "DMCoarsenHook_SNESVecSol"
46216ebb321SJed Brown static PetscErrorCode DMCoarsenHook_SNESVecSol(DM dm,DM dmc,void *ctx)
46316ebb321SJed Brown {
46416ebb321SJed Brown   PetscErrorCode ierr;
46516ebb321SJed Brown 
46616ebb321SJed Brown   PetscFunctionBegin;
46716ebb321SJed Brown   ierr = DMCoarsenHookAdd(dmc,DMCoarsenHook_SNESVecSol,DMRestrictHook_SNESVecSol,ctx);CHKERRQ(ierr);
46816ebb321SJed Brown   PetscFunctionReturn(0);
46916ebb321SJed Brown }
47016ebb321SJed Brown 
47116ebb321SJed Brown #undef __FUNCT__
472caa4e7f2SJed Brown #define __FUNCT__ "KSPComputeOperators_SNES"
473a6950cb2SJed Brown /* This may be called to rediscretize the operator on levels of linear multigrid. The DM shuffle is so the user can
474a6950cb2SJed Brown  * safely call SNESGetDM() in their residual evaluation routine. */
475caa4e7f2SJed Brown static PetscErrorCode KSPComputeOperators_SNES(KSP ksp,Mat A,Mat B,MatStructure *mstruct,void *ctx)
476caa4e7f2SJed Brown {
477caa4e7f2SJed Brown   SNES                        snes = (SNES)ctx;
478caa4e7f2SJed Brown   PetscErrorCode              ierr;
479caa4e7f2SJed Brown   Mat                         Asave = A,Bsave = B;
480dfe15315SJed Brown   Vec                         X,Xnamed = PETSC_NULL;
481dfe15315SJed Brown   DM                          dmsave;
4824e269d77SPeter Brune   void                        *ctxsave;
4834e269d77SPeter Brune   PetscErrorCode              (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
484caa4e7f2SJed Brown 
485caa4e7f2SJed Brown   PetscFunctionBegin;
486dfe15315SJed Brown   dmsave = snes->dm;
487dfe15315SJed Brown   ierr = KSPGetDM(ksp,&snes->dm);CHKERRQ(ierr);
488dfe15315SJed Brown   if (dmsave == snes->dm) X = snes->vec_sol; /* We are on the finest level */
489dfe15315SJed Brown   else {                                     /* We are on a coarser level, this vec was initialized using a DM restrict hook */
490dfe15315SJed Brown     ierr = DMGetNamedGlobalVector(snes->dm,"SNESVecSol",&Xnamed);CHKERRQ(ierr);
491dfe15315SJed Brown     X = Xnamed;
4924e269d77SPeter Brune     ierr = SNESGetJacobian(snes,PETSC_NULL,PETSC_NULL,&jac,&ctxsave);CHKERRQ(ierr);
4934e269d77SPeter Brune     /* If the DM's don't match up, the MatFDColoring context needed for the jacobian won't match up either -- fixit. */
4944e269d77SPeter Brune     if (jac == SNESDefaultComputeJacobianColor) {
4954e269d77SPeter Brune       ierr = SNESSetJacobian(snes,PETSC_NULL,PETSC_NULL,SNESDefaultComputeJacobianColor,0);CHKERRQ(ierr);
496dfe15315SJed Brown     }
4974e269d77SPeter Brune   }
4984e269d77SPeter Brune   /* put the previous context back */
4994e269d77SPeter Brune 
500dfe15315SJed Brown   ierr = SNESComputeJacobian(snes,X,&A,&B,mstruct);CHKERRQ(ierr);
5014e269d77SPeter Brune   if (snes->dm != dmsave && jac == SNESDefaultComputeJacobianColor) {
5024e269d77SPeter Brune     ierr = SNESSetJacobian(snes,PETSC_NULL,PETSC_NULL,jac,ctxsave);CHKERRQ(ierr);
5034e269d77SPeter Brune   }
5044e269d77SPeter Brune 
505caa4e7f2SJed Brown   if (A != Asave || B != Bsave) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_SUP,"No support for changing matrices at this time");
506dfe15315SJed Brown   if (Xnamed) {
507dfe15315SJed Brown     ierr = DMRestoreNamedGlobalVector(snes->dm,"SNESVecSol",&Xnamed);CHKERRQ(ierr);
508dfe15315SJed Brown   }
509dfe15315SJed Brown   snes->dm = dmsave;
510caa4e7f2SJed Brown   PetscFunctionReturn(0);
511caa4e7f2SJed Brown }
512caa4e7f2SJed Brown 
513caa4e7f2SJed Brown #undef __FUNCT__
5146cab3a1bSJed Brown #define __FUNCT__ "SNESSetUpMatrices"
5156cab3a1bSJed Brown /*@
5166cab3a1bSJed Brown    SNESSetUpMatrices - ensures that matrices are available for SNES, to be called by SNESSetUp_XXX()
5176cab3a1bSJed Brown 
5186cab3a1bSJed Brown    Collective
5196cab3a1bSJed Brown 
5206cab3a1bSJed Brown    Input Arguments:
5216cab3a1bSJed Brown .  snes - snes to configure
5226cab3a1bSJed Brown 
5236cab3a1bSJed Brown    Level: developer
5246cab3a1bSJed Brown 
5256cab3a1bSJed Brown .seealso: SNESSetUp()
5266cab3a1bSJed Brown @*/
5276cab3a1bSJed Brown PetscErrorCode SNESSetUpMatrices(SNES snes)
5286cab3a1bSJed Brown {
5296cab3a1bSJed Brown   PetscErrorCode ierr;
5306cab3a1bSJed Brown   DM             dm;
531942e3340SBarry Smith   DMSNES         sdm;
5326cab3a1bSJed Brown 
5336cab3a1bSJed Brown   PetscFunctionBegin;
5346cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
535942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
53622c6f798SBarry Smith   if (!sdm->ops->computejacobian) {
537942e3340SBarry Smith     SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_PLIB,"DMSNES not properly configured");
5383232da50SPeter Brune   } else if (!snes->jacobian && snes->mf) {
5396cab3a1bSJed Brown     Mat J;
5406cab3a1bSJed Brown     void *functx;
5416cab3a1bSJed Brown     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
5426cab3a1bSJed Brown     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
5436cab3a1bSJed Brown     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
5446cab3a1bSJed Brown     ierr = SNESGetFunction(snes,PETSC_NULL,PETSC_NULL,&functx);CHKERRQ(ierr);
5453232da50SPeter Brune     ierr = SNESSetJacobian(snes,J,J,0,0);CHKERRQ(ierr);
5466cab3a1bSJed Brown     ierr = MatDestroy(&J);CHKERRQ(ierr);
547caa4e7f2SJed Brown   } else if (snes->mf_operator && !snes->jacobian_pre && !snes->jacobian) {
5486cab3a1bSJed Brown     Mat J,B;
5496cab3a1bSJed Brown     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
5506cab3a1bSJed Brown     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
5516cab3a1bSJed Brown     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
5526cab3a1bSJed Brown     ierr = DMCreateMatrix(snes->dm,MATAIJ,&B);CHKERRQ(ierr);
55306f20277SJed Brown     /* sdm->computejacobian was already set to reach here */
55406f20277SJed Brown     ierr = SNESSetJacobian(snes,J,B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
5556cab3a1bSJed Brown     ierr = MatDestroy(&J);CHKERRQ(ierr);
5566cab3a1bSJed Brown     ierr = MatDestroy(&B);CHKERRQ(ierr);
557caa4e7f2SJed Brown   } else if (!snes->jacobian_pre) {
5586cab3a1bSJed Brown     Mat J,B;
5596cab3a1bSJed Brown     J = snes->jacobian;
5606cab3a1bSJed Brown     ierr = DMCreateMatrix(snes->dm,MATAIJ,&B);CHKERRQ(ierr);
5616cab3a1bSJed Brown     ierr = SNESSetJacobian(snes,J?J:B,B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
5626cab3a1bSJed Brown     ierr = MatDestroy(&B);CHKERRQ(ierr);
5636cab3a1bSJed Brown   }
564caa4e7f2SJed Brown   {
565caa4e7f2SJed Brown     KSP ksp;
566caa4e7f2SJed Brown     ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
567caa4e7f2SJed Brown     ierr = KSPSetComputeOperators(ksp,KSPComputeOperators_SNES,snes);CHKERRQ(ierr);
56816ebb321SJed Brown     ierr = DMCoarsenHookAdd(snes->dm,DMCoarsenHook_SNESVecSol,DMRestrictHook_SNESVecSol,snes);CHKERRQ(ierr);
569caa4e7f2SJed Brown   }
5706cab3a1bSJed Brown   PetscFunctionReturn(0);
5716cab3a1bSJed Brown }
5726cab3a1bSJed Brown 
5736cab3a1bSJed Brown #undef __FUNCT__
5744a2ae208SSatish Balay #define __FUNCT__ "SNESSetFromOptions"
5759b94acceSBarry Smith /*@
57694b7f48cSBarry Smith    SNESSetFromOptions - Sets various SNES and KSP parameters from user options.
5779b94acceSBarry Smith 
578c7afd0dbSLois Curfman McInnes    Collective on SNES
579c7afd0dbSLois Curfman McInnes 
5809b94acceSBarry Smith    Input Parameter:
5819b94acceSBarry Smith .  snes - the SNES context
5829b94acceSBarry Smith 
58336851e7fSLois Curfman McInnes    Options Database Keys:
584ea630c6eSPeter Brune +  -snes_type <type> - ls, tr, ngmres, ncg, richardson, qn, vi, fas
58582738288SBarry Smith .  -snes_stol - convergence tolerance in terms of the norm
58682738288SBarry Smith                 of the change in the solution between steps
58770441072SBarry Smith .  -snes_atol <abstol> - absolute tolerance of residual norm
588b39c3a46SLois Curfman McInnes .  -snes_rtol <rtol> - relative decrease in tolerance norm from initial
589b39c3a46SLois Curfman McInnes .  -snes_max_it <max_it> - maximum number of iterations
590b39c3a46SLois Curfman McInnes .  -snes_max_funcs <max_funcs> - maximum number of function evaluations
5914839bfe8SBarry Smith .  -snes_max_fail <max_fail> - maximum number of line search failures allowed before stopping, default is none
592ddf469c8SBarry Smith .  -snes_max_linear_solve_fail - number of linear solver failures before SNESSolve() stops
593a8054027SBarry Smith .  -snes_lag_preconditioner <lag> - how often preconditioner is rebuilt (use -1 to never rebuild)
594e35cf81dSBarry Smith .  -snes_lag_jacobian <lag> - how often Jacobian is rebuilt (use -1 to never rebuild)
595b39c3a46SLois Curfman McInnes .  -snes_trtol <trtol> - trust region tolerance
5962492ecdbSBarry Smith .  -snes_no_convergence_test - skip convergence test in nonlinear
59782738288SBarry Smith                                solver; hence iterations will continue until max_it
5981fbbfb26SLois Curfman McInnes                                or some other criterion is reached. Saves expense
59982738288SBarry Smith                                of convergence test
600e8105e01SRichard Katz .  -snes_monitor <optional filename> - prints residual norm at each iteration. if no
601e8105e01SRichard Katz                                        filename given prints to stdout
602a6570f20SBarry Smith .  -snes_monitor_solution - plots solution at each iteration
603a6570f20SBarry Smith .  -snes_monitor_residual - plots residual (not its norm) at each iteration
604a6570f20SBarry Smith .  -snes_monitor_solution_update - plots update to solution at each iteration
6054619e776SBarry Smith .  -snes_monitor_lg_residualnorm - plots residual norm at each iteration
606459f5d12SBarry Smith .  -snes_monitor_lg_range - plots residual norm at each iteration
607e24b481bSBarry Smith .  -snes_fd - use finite differences to compute Jacobian; very slow, only for testing
608e2e60de9SPeter Brune .  -snes_fd_color - use finite differences with coloring to compute Jacobian
6095968eb51SBarry Smith .  -snes_mf_ksp_monitor - if using matrix-free multiply then print h at each KSP iteration
610fee2055bSBarry Smith -  -snes_converged_reason - print the reason for convergence/divergence after each solve
61182738288SBarry Smith 
61282738288SBarry Smith     Options Database for Eisenstat-Walker method:
613fa9f3622SBarry Smith +  -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence
6144b27c08aSLois Curfman McInnes .  -snes_ksp_ew_version ver - version of  Eisenstat-Walker method
61536851e7fSLois Curfman McInnes .  -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0
61636851e7fSLois Curfman McInnes .  -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax
61736851e7fSLois Curfman McInnes .  -snes_ksp_ew_gamma <gamma> - Sets gamma
61836851e7fSLois Curfman McInnes .  -snes_ksp_ew_alpha <alpha> - Sets alpha
61936851e7fSLois Curfman McInnes .  -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2
62036851e7fSLois Curfman McInnes -  -snes_ksp_ew_threshold <threshold> - Sets threshold
62182738288SBarry Smith 
62211ca99fdSLois Curfman McInnes    Notes:
62311ca99fdSLois Curfman McInnes    To see all options, run your program with the -help option or consult
6240598bfebSBarry Smith    the <A href="../../docs/manual.pdf#nameddest=ch_snes">SNES chapter of the users manual</A>.
62583e2fdc7SBarry Smith 
62636851e7fSLois Curfman McInnes    Level: beginner
62736851e7fSLois Curfman McInnes 
6289b94acceSBarry Smith .keywords: SNES, nonlinear, set, options, database
6299b94acceSBarry Smith 
63069ed319cSSatish Balay .seealso: SNESSetOptionsPrefix()
6319b94acceSBarry Smith @*/
6327087cfbeSBarry Smith PetscErrorCode  SNESSetFromOptions(SNES snes)
6339b94acceSBarry Smith {
634d8f46077SPeter Brune   PetscBool               flg,pcset;
635d8f46077SPeter Brune   PetscInt                i,indx,lag,grids;
636aa3661deSLisandro Dalcin   MatStructure            matflag;
63704d7464bSBarry Smith   const char              *deft = SNESNEWTONLS;
63885385478SLisandro Dalcin   const char              *convtests[] = {"default","skip"};
63985385478SLisandro Dalcin   SNESKSPEW               *kctx = NULL;
640e8105e01SRichard Katz   char                    type[256], monfilename[PETSC_MAX_PATH_LEN];
641649052a6SBarry Smith   PetscViewer             monviewer;
64285385478SLisandro Dalcin   PetscErrorCode          ierr;
643c40d0f55SPeter Brune   PCSide                  pcside;
644a64e098fSPeter Brune   const char              *optionsprefix;
6459b94acceSBarry Smith 
6463a40ed3dSBarry Smith   PetscFunctionBegin;
6470700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
648ca161407SBarry Smith 
649186905e3SBarry Smith   if (!SNESRegisterAllCalled) {ierr = SNESRegisterAll(PETSC_NULL);CHKERRQ(ierr);}
6503194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)snes);CHKERRQ(ierr);
6517adad957SLisandro Dalcin     if (((PetscObject)snes)->type_name) { deft = ((PetscObject)snes)->type_name; }
652b0a32e0cSBarry Smith     ierr = PetscOptionsList("-snes_type","Nonlinear solver method","SNESSetType",SNESList,deft,type,256,&flg);CHKERRQ(ierr);
653d64ed03dSBarry Smith     if (flg) {
654186905e3SBarry Smith       ierr = SNESSetType(snes,type);CHKERRQ(ierr);
6557adad957SLisandro Dalcin     } else if (!((PetscObject)snes)->type_name) {
656186905e3SBarry Smith       ierr = SNESSetType(snes,deft);CHKERRQ(ierr);
657d64ed03dSBarry Smith     }
65890d69ab7SBarry Smith     /* not used here, but called so will go into help messaage */
659909c8a9fSBarry Smith     ierr = PetscOptionsName("-snes_view","Print detailed information on solver used","SNESView",0);CHKERRQ(ierr);
66093c39befSBarry Smith 
661c60f73f4SPeter Brune     ierr = PetscOptionsReal("-snes_stol","Stop if step length less than","SNESSetTolerances",snes->stol,&snes->stol,0);CHKERRQ(ierr);
66257034d6fSHong Zhang     ierr = PetscOptionsReal("-snes_atol","Stop if function norm less than","SNESSetTolerances",snes->abstol,&snes->abstol,0);CHKERRQ(ierr);
663186905e3SBarry Smith 
66457034d6fSHong Zhang     ierr = PetscOptionsReal("-snes_rtol","Stop if decrease in function norm less than","SNESSetTolerances",snes->rtol,&snes->rtol,0);CHKERRQ(ierr);
665b0a32e0cSBarry Smith     ierr = PetscOptionsInt("-snes_max_it","Maximum iterations","SNESSetTolerances",snes->max_its,&snes->max_its,PETSC_NULL);CHKERRQ(ierr);
666b0a32e0cSBarry Smith     ierr = PetscOptionsInt("-snes_max_funcs","Maximum function evaluations","SNESSetTolerances",snes->max_funcs,&snes->max_funcs,PETSC_NULL);CHKERRQ(ierr);
66724254dc1SJed Brown     ierr = PetscOptionsInt("-snes_max_fail","Maximum nonlinear step failures","SNESSetMaxNonlinearStepFailures",snes->maxFailures,&snes->maxFailures,PETSC_NULL);CHKERRQ(ierr);
668ddf469c8SBarry Smith     ierr = PetscOptionsInt("-snes_max_linear_solve_fail","Maximum failures in linear solves allowed","SNESSetMaxLinearSolveFailures",snes->maxLinearSolveFailures,&snes->maxLinearSolveFailures,PETSC_NULL);CHKERRQ(ierr);
669acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_error_if_not_converged","Generate error if solver does not converge","SNESSetErrorIfNotConverged",snes->errorifnotconverged,&snes->errorifnotconverged,PETSC_NULL);CHKERRQ(ierr);
67085385478SLisandro Dalcin 
671a8054027SBarry Smith     ierr = PetscOptionsInt("-snes_lag_preconditioner","How often to rebuild preconditioner","SNESSetLagPreconditioner",snes->lagpreconditioner,&lag,&flg);CHKERRQ(ierr);
672a8054027SBarry Smith     if (flg) {
673a8054027SBarry Smith       ierr = SNESSetLagPreconditioner(snes,lag);CHKERRQ(ierr);
674a8054027SBarry Smith     }
675e35cf81dSBarry Smith     ierr = PetscOptionsInt("-snes_lag_jacobian","How often to rebuild Jacobian","SNESSetLagJacobian",snes->lagjacobian,&lag,&flg);CHKERRQ(ierr);
676e35cf81dSBarry Smith     if (flg) {
677e35cf81dSBarry Smith       ierr = SNESSetLagJacobian(snes,lag);CHKERRQ(ierr);
678e35cf81dSBarry Smith     }
679efd51863SBarry Smith     ierr = PetscOptionsInt("-snes_grid_sequence","Use grid sequencing to generate initial guess","SNESSetGridSequence",snes->gridsequence,&grids,&flg);CHKERRQ(ierr);
680efd51863SBarry Smith     if (flg) {
681efd51863SBarry Smith       ierr = SNESSetGridSequence(snes,grids);CHKERRQ(ierr);
682efd51863SBarry Smith     }
683a8054027SBarry Smith 
68485385478SLisandro Dalcin     ierr = PetscOptionsEList("-snes_convergence_test","Convergence test","SNESSetConvergenceTest",convtests,2,"default",&indx,&flg);CHKERRQ(ierr);
68585385478SLisandro Dalcin     if (flg) {
68685385478SLisandro Dalcin       switch (indx) {
6877f7931b9SBarry Smith       case 0: ierr = SNESSetConvergenceTest(snes,SNESDefaultConverged,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); break;
6887f7931b9SBarry Smith       case 1: ierr = SNESSetConvergenceTest(snes,SNESSkipConverged,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);    break;
68985385478SLisandro Dalcin       }
69085385478SLisandro Dalcin     }
69185385478SLisandro Dalcin 
692acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_converged_reason","Print reason for converged or diverged","SNESSolve",snes->printreason,&snes->printreason,PETSC_NULL);CHKERRQ(ierr);
693186905e3SBarry Smith 
694fdacfa88SPeter Brune     ierr = PetscOptionsEList("-snes_norm_type","SNES Norm type","SNESSetNormType",SNESNormTypes,5,"function",&indx,&flg);CHKERRQ(ierr);
695fdacfa88SPeter Brune     if (flg) { ierr = SNESSetNormType(snes,(SNESNormType)indx);CHKERRQ(ierr); }
696fdacfa88SPeter Brune 
69785385478SLisandro Dalcin     kctx = (SNESKSPEW *)snes->kspconvctx;
69885385478SLisandro Dalcin 
699acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_ksp_ew","Use Eisentat-Walker linear system convergence test","SNESKSPSetUseEW",snes->ksp_ewconv,&snes->ksp_ewconv,PETSC_NULL);CHKERRQ(ierr);
700186905e3SBarry Smith 
701fa9f3622SBarry Smith     ierr = PetscOptionsInt("-snes_ksp_ew_version","Version 1, 2 or 3","SNESKSPSetParametersEW",kctx->version,&kctx->version,0);CHKERRQ(ierr);
702fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_rtol0","0 <= rtol0 < 1","SNESKSPSetParametersEW",kctx->rtol_0,&kctx->rtol_0,0);CHKERRQ(ierr);
703fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_rtolmax","0 <= rtolmax < 1","SNESKSPSetParametersEW",kctx->rtol_max,&kctx->rtol_max,0);CHKERRQ(ierr);
704fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_gamma","0 <= gamma <= 1","SNESKSPSetParametersEW",kctx->gamma,&kctx->gamma,0);CHKERRQ(ierr);
705fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_alpha","1 < alpha <= 2","SNESKSPSetParametersEW",kctx->alpha,&kctx->alpha,0);CHKERRQ(ierr);
706fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_alpha2","alpha2","SNESKSPSetParametersEW",kctx->alpha2,&kctx->alpha2,0);CHKERRQ(ierr);
707fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_threshold","0 < threshold < 1","SNESKSPSetParametersEW",kctx->threshold,&kctx->threshold,0);CHKERRQ(ierr);
708186905e3SBarry Smith 
70990d69ab7SBarry Smith     flg  = PETSC_FALSE;
710acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_cancel","Remove all monitors","SNESMonitorCancel",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
711a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorCancel(snes);CHKERRQ(ierr);}
712eabae89aSBarry Smith 
713a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_monitor","Monitor norm of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
714e8105e01SRichard Katz     if (flg) {
715649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
716649052a6SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
717e8105e01SRichard Katz     }
718eabae89aSBarry Smith 
719b271bb04SBarry Smith     ierr = PetscOptionsString("-snes_monitor_range","Monitor range of elements of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
720b271bb04SBarry Smith     if (flg) {
721b271bb04SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorRange,0,0);CHKERRQ(ierr);
722b271bb04SBarry Smith     }
723b271bb04SBarry Smith 
724a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_ratiomonitor","Monitor ratios of norms of function","SNESMonitorSetRatio","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
725eabae89aSBarry Smith     if (flg) {
726649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
727f1bef1bcSMatthew Knepley       ierr = SNESMonitorSetRatio(snes,monviewer);CHKERRQ(ierr);
728e8105e01SRichard Katz     }
729eabae89aSBarry Smith 
730a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_monitor_short","Monitor norm of function (fewer digits)","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
731eabae89aSBarry Smith     if (flg) {
732649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
733649052a6SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorDefaultShort,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
734eabae89aSBarry Smith     }
735eabae89aSBarry Smith 
7365180491cSLisandro Dalcin     ierr = PetscOptionsString("-snes_monitor_python","Use Python function","SNESMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
7375180491cSLisandro Dalcin     if (flg) {ierr = PetscPythonMonitorSet((PetscObject)snes,monfilename);CHKERRQ(ierr);}
7385180491cSLisandro Dalcin 
73990d69ab7SBarry Smith     flg  = PETSC_FALSE;
740acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_solution","Plot solution at each iteration","SNESMonitorSolution",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
741a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolution,0,0);CHKERRQ(ierr);}
74290d69ab7SBarry Smith     flg  = PETSC_FALSE;
743acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_solution_update","Plot correction at each iteration","SNESMonitorSolutionUpdate",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
744a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolutionUpdate,0,0);CHKERRQ(ierr);}
74590d69ab7SBarry Smith     flg  = PETSC_FALSE;
746acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_residual","Plot residual at each iteration","SNESMonitorResidual",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
747a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorResidual,0,0);CHKERRQ(ierr);}
74890d69ab7SBarry Smith     flg  = PETSC_FALSE;
7494619e776SBarry Smith     ierr = PetscOptionsBool("-snes_monitor_lg_residualnorm","Plot function norm at each iteration","SNESMonitorLGResidualNorm",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
750459f5d12SBarry Smith     if (flg) {
751459f5d12SBarry Smith       PetscDrawLG ctx;
752459f5d12SBarry Smith 
753459f5d12SBarry Smith       ierr = SNESMonitorLGCreate(0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,&ctx);CHKERRQ(ierr);
754459f5d12SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorLGResidualNorm,ctx,(PetscErrorCode (*)(void**))SNESMonitorLGDestroy);CHKERRQ(ierr);
755459f5d12SBarry Smith     }
75690d69ab7SBarry Smith     flg  = PETSC_FALSE;
7574619e776SBarry Smith     ierr = PetscOptionsBool("-snes_monitor_lg_range","Plot function range at each iteration","SNESMonitorLGRange",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
758459f5d12SBarry Smith     if (flg) {
759459f5d12SBarry Smith       PetscViewer ctx;
760e24b481bSBarry Smith 
761459f5d12SBarry Smith       ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,&ctx);CHKERRQ(ierr);
762459f5d12SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorLGRange,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
763459f5d12SBarry Smith     }
7642e7541e6SPeter Brune 
7652e7541e6SPeter Brune     flg  = PETSC_FALSE;
7662e7541e6SPeter Brune     ierr = PetscOptionsBool("-snes_monitor_jacupdate_spectrum","Print the change in the spectrum of the Jacobian","SNESMonitorJacUpdateSpectrum",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
7672e7541e6SPeter Brune     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorJacUpdateSpectrum,0,0);CHKERRQ(ierr);}
7682e7541e6SPeter Brune 
76990d69ab7SBarry Smith     flg  = PETSC_FALSE;
770acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_fd","Use finite differences (slow) to compute Jacobian","SNESDefaultComputeJacobian",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
7714b27c08aSLois Curfman McInnes     if (flg) {
7726cab3a1bSJed Brown       void *functx;
7736cab3a1bSJed Brown       ierr = SNESGetFunction(snes,PETSC_NULL,PETSC_NULL,&functx);CHKERRQ(ierr);
7746cab3a1bSJed Brown       ierr = SNESSetJacobian(snes,snes->jacobian,snes->jacobian_pre,SNESDefaultComputeJacobian,functx);CHKERRQ(ierr);
775ae15b995SBarry Smith       ierr = PetscInfo(snes,"Setting default finite difference Jacobian matrix\n");CHKERRQ(ierr);
7769b94acceSBarry Smith     }
777639f9d9dSBarry Smith 
77844848bc4SPeter Brune     flg  = PETSC_FALSE;
77997584545SPeter Brune     ierr = PetscOptionsBool("-snes_fd_function","Use finite differences (slow) to compute function from user objective","SNESDefaultObjectiveComputeFunctionFD",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
78097584545SPeter Brune     if (flg) {
78197584545SPeter Brune       ierr = SNESSetFunction(snes,PETSC_NULL,SNESDefaultObjectiveComputeFunctionFD,PETSC_NULL);CHKERRQ(ierr);
78297584545SPeter Brune     }
78397584545SPeter Brune 
78497584545SPeter Brune     flg  = PETSC_FALSE;
78544848bc4SPeter Brune     ierr = PetscOptionsBool("-snes_fd_color","Use finite differences with coloring to compute Jacobian","SNESDefaultComputeJacobianColor",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
78644848bc4SPeter Brune     if (flg) {
78744848bc4SPeter Brune       void *functx;
78844848bc4SPeter Brune       ierr = SNESGetFunction(snes,PETSC_NULL,PETSC_NULL,&functx);CHKERRQ(ierr);
7890171d955SPeter Brune       ierr = SNESSetJacobian(snes,snes->jacobian,snes->jacobian_pre,SNESDefaultComputeJacobianColor,0);CHKERRQ(ierr);
79044848bc4SPeter Brune       ierr = PetscInfo(snes,"Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
79144848bc4SPeter Brune     }
79244848bc4SPeter Brune 
793aa3661deSLisandro Dalcin     flg = PETSC_FALSE;
794d8f46077SPeter 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);
795d8f46077SPeter Brune     if (flg && snes->mf_operator) {
796a8248277SBarry Smith       snes->mf_operator = PETSC_TRUE;
797d8f46077SPeter Brune       snes->mf = PETSC_TRUE;
798a8248277SBarry Smith     }
799aa3661deSLisandro Dalcin     flg = PETSC_FALSE;
800d8f46077SPeter Brune     ierr = PetscOptionsBool("-snes_mf","Use a Matrix-Free Jacobian with no preconditioner matrix","MatCreateSNESMF",PETSC_FALSE,&snes->mf,&flg);CHKERRQ(ierr);
801d8f46077SPeter Brune     if (!flg && snes->mf_operator) snes->mf = PETSC_TRUE;
802d8f46077SPeter Brune     ierr = PetscOptionsInt("-snes_mf_version","Matrix-Free routines version 1 or 2","None",snes->mf_version,&snes->mf_version,0);CHKERRQ(ierr);
803d28543b3SPeter Brune 
804c40d0f55SPeter Brune     flg = PETSC_FALSE;
805c40d0f55SPeter Brune     ierr = SNESGetPCSide(snes,&pcside);
806c40d0f55SPeter Brune     ierr = PetscOptionsEnum("-snes_npc_side","SNES nonlinear preconditioner side","SNESSetPCSide",PCSides,(PetscEnum)pcside,(PetscEnum*)&pcside,&flg);CHKERRQ(ierr);
807c40d0f55SPeter Brune     if (flg) {ierr = SNESSetPCSide(snes,pcside);CHKERRQ(ierr);}
808c40d0f55SPeter Brune 
80989b92e6fSPeter Brune     /* GS Options */
81089b92e6fSPeter Brune     ierr = PetscOptionsInt("-snes_gs_sweeps","Number of sweeps of GS to apply","SNESComputeGS",snes->gssweeps,&snes->gssweeps,PETSC_NULL);CHKERRQ(ierr);
81189b92e6fSPeter 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);}
825aa3661deSLisandro Dalcin   ierr = KSPGetOperators(snes->ksp,PETSC_NULL,PETSC_NULL,&matflag);
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;
14338ba1e511SMatthew Knepley #ifndef 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;
147489b92e6fSPeter Brune   snes->gssweeps          = 1;
14759b94acceSBarry Smith 
1476c40d0f55SPeter Brune   snes->pcside            = PC_RIGHT;
1477c40d0f55SPeter Brune 
1478d8f46077SPeter Brune   snes->mf                = PETSC_FALSE;
1479d8f46077SPeter Brune   snes->mf_operator       = PETSC_FALSE;
1480d8f46077SPeter Brune   snes->mf_version        = 1;
1481d8f46077SPeter Brune 
14823d4c4710SBarry Smith   snes->numLinearSolveFailures = 0;
14833d4c4710SBarry Smith   snes->maxLinearSolveFailures = 1;
14843d4c4710SBarry Smith 
14859b94acceSBarry Smith   /* Create context to compute Eisenstat-Walker relative tolerance for KSP */
148638f2d2fdSLisandro Dalcin   ierr = PetscNewLog(snes,SNESKSPEW,&kctx);CHKERRQ(ierr);
14879b94acceSBarry Smith   snes->kspconvctx  = (void*)kctx;
14889b94acceSBarry Smith   kctx->version     = 2;
14899b94acceSBarry Smith   kctx->rtol_0      = .3; /* Eisenstat and Walker suggest rtol_0=.5, but
14909b94acceSBarry Smith                              this was too large for some test cases */
149175567043SBarry Smith   kctx->rtol_last   = 0.0;
14929b94acceSBarry Smith   kctx->rtol_max    = .9;
14939b94acceSBarry Smith   kctx->gamma       = 1.0;
149462d1f40fSBarry Smith   kctx->alpha       = .5*(1.0 + PetscSqrtReal(5.0));
149571f87433Sdalcinl   kctx->alpha2      = kctx->alpha;
14969b94acceSBarry Smith   kctx->threshold   = .1;
149775567043SBarry Smith   kctx->lresid_last = 0.0;
149875567043SBarry Smith   kctx->norm_last   = 0.0;
14999b94acceSBarry Smith 
15009b94acceSBarry Smith   *outsnes = snes;
15013a40ed3dSBarry Smith   PetscFunctionReturn(0);
15029b94acceSBarry Smith }
15039b94acceSBarry Smith 
15044a2ae208SSatish Balay #undef __FUNCT__
15054a2ae208SSatish Balay #define __FUNCT__ "SNESSetFunction"
15069b94acceSBarry Smith /*@C
15079b94acceSBarry Smith    SNESSetFunction - Sets the function evaluation routine and function
15089b94acceSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
15099b94acceSBarry Smith    equations.
15109b94acceSBarry Smith 
15113f9fe445SBarry Smith    Logically Collective on SNES
1512fee21e36SBarry Smith 
1513c7afd0dbSLois Curfman McInnes    Input Parameters:
1514c7afd0dbSLois Curfman McInnes +  snes - the SNES context
1515c7afd0dbSLois Curfman McInnes .  r - vector to store function value
1516de044059SHong Zhang .  func - function evaluation routine
1517c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined context for private data for the
1518c7afd0dbSLois Curfman McInnes          function evaluation routine (may be PETSC_NULL)
15199b94acceSBarry Smith 
1520c7afd0dbSLois Curfman McInnes    Calling sequence of func:
15218d76a1e5SLois Curfman McInnes $    func (SNES snes,Vec x,Vec f,void *ctx);
1522c7afd0dbSLois Curfman McInnes 
1523c586c404SJed Brown +  snes - the SNES context
1524c586c404SJed Brown .  x - state at which to evaluate residual
1525c586c404SJed Brown .  f - vector to put residual
1526c7afd0dbSLois Curfman McInnes -  ctx - optional user-defined function context
15279b94acceSBarry Smith 
15289b94acceSBarry Smith    Notes:
15299b94acceSBarry Smith    The Newton-like methods typically solve linear systems of the form
15309b94acceSBarry Smith $      f'(x) x = -f(x),
1531c7afd0dbSLois Curfman McInnes    where f'(x) denotes the Jacobian matrix and f(x) is the function.
15329b94acceSBarry Smith 
153336851e7fSLois Curfman McInnes    Level: beginner
153436851e7fSLois Curfman McInnes 
15359b94acceSBarry Smith .keywords: SNES, nonlinear, set, function
15369b94acceSBarry Smith 
15378b0a5094SBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetPicard()
15389b94acceSBarry Smith @*/
15397087cfbeSBarry Smith PetscErrorCode  SNESSetFunction(SNES snes,Vec r,PetscErrorCode (*func)(SNES,Vec,Vec,void*),void *ctx)
15409b94acceSBarry Smith {
154185385478SLisandro Dalcin   PetscErrorCode ierr;
15426cab3a1bSJed Brown   DM             dm;
15436cab3a1bSJed Brown 
15443a40ed3dSBarry Smith   PetscFunctionBegin;
15450700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1546d2a683ecSLisandro Dalcin   if (r) {
1547d2a683ecSLisandro Dalcin     PetscValidHeaderSpecific(r,VEC_CLASSID,2);
1548d2a683ecSLisandro Dalcin     PetscCheckSameComm(snes,1,r,2);
154985385478SLisandro Dalcin     ierr = PetscObjectReference((PetscObject)r);CHKERRQ(ierr);
15506bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr);
155185385478SLisandro Dalcin     snes->vec_func = r;
1552d2a683ecSLisandro Dalcin   }
15536cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
15546cab3a1bSJed Brown   ierr = DMSNESSetFunction(dm,func,ctx);CHKERRQ(ierr);
15553a40ed3dSBarry Smith   PetscFunctionReturn(0);
15569b94acceSBarry Smith }
15579b94acceSBarry Smith 
1558646217ecSPeter Brune 
1559646217ecSPeter Brune #undef __FUNCT__
1560e4ed7901SPeter Brune #define __FUNCT__ "SNESSetInitialFunction"
1561e4ed7901SPeter Brune /*@C
1562e4ed7901SPeter Brune    SNESSetInitialFunction - Sets the function vector to be used as the
1563e4ed7901SPeter Brune    function norm at the initialization of the method.  In some
1564e4ed7901SPeter Brune    instances, the user has precomputed the function before calling
1565e4ed7901SPeter Brune    SNESSolve.  This function allows one to avoid a redundant call
1566e4ed7901SPeter Brune    to SNESComputeFunction in that case.
1567e4ed7901SPeter Brune 
1568e4ed7901SPeter Brune    Logically Collective on SNES
1569e4ed7901SPeter Brune 
1570e4ed7901SPeter Brune    Input Parameters:
1571e4ed7901SPeter Brune +  snes - the SNES context
1572e4ed7901SPeter Brune -  f - vector to store function value
1573e4ed7901SPeter Brune 
1574e4ed7901SPeter Brune    Notes:
1575e4ed7901SPeter Brune    This should not be modified during the solution procedure.
1576e4ed7901SPeter Brune 
1577e4ed7901SPeter Brune    This is used extensively in the SNESFAS hierarchy and in nonlinear preconditioning.
1578e4ed7901SPeter Brune 
1579e4ed7901SPeter Brune    Level: developer
1580e4ed7901SPeter Brune 
1581e4ed7901SPeter Brune .keywords: SNES, nonlinear, set, function
1582e4ed7901SPeter Brune 
1583e4ed7901SPeter Brune .seealso: SNESSetFunction(), SNESComputeFunction(), SNESSetInitialFunctionNorm()
1584e4ed7901SPeter Brune @*/
1585e4ed7901SPeter Brune PetscErrorCode  SNESSetInitialFunction(SNES snes, Vec f)
1586e4ed7901SPeter Brune {
1587e4ed7901SPeter Brune   PetscErrorCode ierr;
1588e4ed7901SPeter Brune   Vec            vec_func;
1589e4ed7901SPeter Brune 
1590e4ed7901SPeter Brune   PetscFunctionBegin;
1591e4ed7901SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1592e4ed7901SPeter Brune   PetscValidHeaderSpecific(f,VEC_CLASSID,2);
1593e4ed7901SPeter Brune   PetscCheckSameComm(snes,1,f,2);
1594e4ed7901SPeter Brune   ierr = SNESGetFunction(snes,&vec_func,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
1595e4ed7901SPeter Brune   ierr = VecCopy(f, vec_func);CHKERRQ(ierr);
1596217b9c2eSPeter Brune   snes->vec_func_init_set = PETSC_TRUE;
1597e4ed7901SPeter Brune   PetscFunctionReturn(0);
1598e4ed7901SPeter Brune }
1599e4ed7901SPeter Brune 
1600e4ed7901SPeter Brune 
1601e4ed7901SPeter Brune #undef __FUNCT__
1602e4ed7901SPeter Brune #define __FUNCT__ "SNESSetInitialFunctionNorm"
1603e4ed7901SPeter Brune /*@C
1604e4ed7901SPeter Brune    SNESSetInitialFunctionNorm - Sets the function norm to be used as the function norm
1605e4ed7901SPeter Brune    at the initialization of the  method.  In some instances, the user has precomputed
1606e4ed7901SPeter Brune    the function and its norm before calling SNESSolve.  This function allows one to
1607e4ed7901SPeter Brune    avoid a redundant call to SNESComputeFunction() and VecNorm() in that case.
1608e4ed7901SPeter Brune 
1609e4ed7901SPeter Brune    Logically Collective on SNES
1610e4ed7901SPeter Brune 
1611e4ed7901SPeter Brune    Input Parameters:
1612e4ed7901SPeter Brune +  snes - the SNES context
1613e4ed7901SPeter Brune -  fnorm - the norm of F as set by SNESSetInitialFunction()
1614e4ed7901SPeter Brune 
1615e4ed7901SPeter Brune    This is used extensively in the SNESFAS hierarchy and in nonlinear preconditioning.
1616e4ed7901SPeter Brune 
1617e4ed7901SPeter Brune    Level: developer
1618e4ed7901SPeter Brune 
1619e4ed7901SPeter Brune .keywords: SNES, nonlinear, set, function, norm
1620e4ed7901SPeter Brune 
1621e4ed7901SPeter Brune .seealso: SNESSetFunction(), SNESComputeFunction(), SNESSetInitialFunction()
1622e4ed7901SPeter Brune @*/
1623e4ed7901SPeter Brune PetscErrorCode  SNESSetInitialFunctionNorm(SNES snes, PetscReal fnorm)
1624e4ed7901SPeter Brune {
1625e4ed7901SPeter Brune   PetscFunctionBegin;
1626e4ed7901SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1627e4ed7901SPeter Brune   snes->norm_init = fnorm;
1628e4ed7901SPeter Brune   snes->norm_init_set = PETSC_TRUE;
1629e4ed7901SPeter Brune   PetscFunctionReturn(0);
1630e4ed7901SPeter Brune }
1631e4ed7901SPeter Brune 
1632e4ed7901SPeter Brune #undef __FUNCT__
1633534ebe21SPeter Brune #define __FUNCT__ "SNESSetNormType"
1634534ebe21SPeter Brune /*@
1635534ebe21SPeter Brune    SNESSetNormType - Sets the SNESNormType used in covergence and monitoring
1636534ebe21SPeter Brune    of the SNES method.
1637534ebe21SPeter Brune 
1638534ebe21SPeter Brune    Logically Collective on SNES
1639534ebe21SPeter Brune 
1640534ebe21SPeter Brune    Input Parameters:
1641534ebe21SPeter Brune +  snes - the SNES context
1642534ebe21SPeter Brune -  normtype - the type of the norm used
1643534ebe21SPeter Brune 
1644534ebe21SPeter Brune    Notes:
1645534ebe21SPeter Brune    Only certain SNES methods support certain SNESNormTypes.  Most require evaluation
1646534ebe21SPeter Brune    of the nonlinear function and the taking of its norm at every iteration to
1647534ebe21SPeter Brune    even ensure convergence at all.  However, methods such as custom Gauss-Seidel methods
1648534ebe21SPeter Brune    (SNESGS) and the like do not require the norm of the function to be computed, and therfore
1649534ebe21SPeter Brune    may either be monitored for convergence or not.  As these are often used as nonlinear
1650534ebe21SPeter Brune    preconditioners, monitoring the norm of their error is not a useful enterprise within
1651534ebe21SPeter Brune    their solution.
1652534ebe21SPeter Brune 
1653534ebe21SPeter Brune    Level: developer
1654534ebe21SPeter Brune 
1655534ebe21SPeter Brune .keywords: SNES, nonlinear, set, function, norm, type
1656534ebe21SPeter Brune 
1657534ebe21SPeter Brune .seealso: SNESGetNormType(), SNESComputeFunction(), VecNorm(), SNESSetFunction(), SNESSetInitialFunction(), SNESNormType
1658534ebe21SPeter Brune @*/
1659534ebe21SPeter Brune PetscErrorCode  SNESSetNormType(SNES snes, SNESNormType normtype)
1660534ebe21SPeter Brune {
1661534ebe21SPeter Brune   PetscFunctionBegin;
1662534ebe21SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1663534ebe21SPeter Brune   snes->normtype = normtype;
1664534ebe21SPeter Brune   PetscFunctionReturn(0);
1665534ebe21SPeter Brune }
1666534ebe21SPeter Brune 
1667534ebe21SPeter Brune 
1668534ebe21SPeter Brune #undef __FUNCT__
1669534ebe21SPeter Brune #define __FUNCT__ "SNESGetNormType"
1670534ebe21SPeter Brune /*@
1671534ebe21SPeter Brune    SNESGetNormType - Gets the SNESNormType used in covergence and monitoring
1672534ebe21SPeter Brune    of the SNES method.
1673534ebe21SPeter Brune 
1674534ebe21SPeter Brune    Logically Collective on SNES
1675534ebe21SPeter Brune 
1676534ebe21SPeter Brune    Input Parameters:
1677534ebe21SPeter Brune +  snes - the SNES context
1678534ebe21SPeter Brune -  normtype - the type of the norm used
1679534ebe21SPeter Brune 
1680534ebe21SPeter Brune    Level: advanced
1681534ebe21SPeter Brune 
1682534ebe21SPeter Brune .keywords: SNES, nonlinear, set, function, norm, type
1683534ebe21SPeter Brune 
1684534ebe21SPeter Brune .seealso: SNESSetNormType(), SNESComputeFunction(), VecNorm(), SNESSetFunction(), SNESSetInitialFunction(), SNESNormType
1685534ebe21SPeter Brune @*/
1686534ebe21SPeter Brune PetscErrorCode  SNESGetNormType(SNES snes, SNESNormType *normtype)
1687534ebe21SPeter Brune {
1688534ebe21SPeter Brune   PetscFunctionBegin;
1689534ebe21SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1690534ebe21SPeter Brune   *normtype = snes->normtype;
1691534ebe21SPeter Brune   PetscFunctionReturn(0);
1692534ebe21SPeter Brune }
1693534ebe21SPeter Brune 
1694534ebe21SPeter Brune #undef __FUNCT__
1695646217ecSPeter Brune #define __FUNCT__ "SNESSetGS"
1696c79ef259SPeter Brune /*@C
1697c79ef259SPeter Brune    SNESSetGS - Sets the user nonlinear Gauss-Seidel routine for
1698c79ef259SPeter Brune    use with composed nonlinear solvers.
1699c79ef259SPeter Brune 
1700c79ef259SPeter Brune    Input Parameters:
1701c79ef259SPeter Brune +  snes   - the SNES context
1702c79ef259SPeter Brune .  gsfunc - function evaluation routine
1703c79ef259SPeter Brune -  ctx    - [optional] user-defined context for private data for the
1704c79ef259SPeter Brune             smoother evaluation routine (may be PETSC_NULL)
1705c79ef259SPeter Brune 
1706c79ef259SPeter Brune    Calling sequence of func:
1707c79ef259SPeter Brune $    func (SNES snes,Vec x,Vec b,void *ctx);
1708c79ef259SPeter Brune 
1709c79ef259SPeter Brune +  X   - solution vector
1710c79ef259SPeter Brune .  B   - RHS vector
1711d28543b3SPeter Brune -  ctx - optional user-defined Gauss-Seidel context
1712c79ef259SPeter Brune 
1713c79ef259SPeter Brune    Notes:
1714c79ef259SPeter Brune    The GS routines are used by the composed nonlinear solver to generate
1715c79ef259SPeter Brune     a problem appropriate update to the solution, particularly FAS.
1716c79ef259SPeter Brune 
1717d28543b3SPeter Brune    Level: intermediate
1718c79ef259SPeter Brune 
1719d28543b3SPeter Brune .keywords: SNES, nonlinear, set, Gauss-Seidel
1720c79ef259SPeter Brune 
1721c79ef259SPeter Brune .seealso: SNESGetFunction(), SNESComputeGS()
1722c79ef259SPeter Brune @*/
17236cab3a1bSJed Brown PetscErrorCode SNESSetGS(SNES snes,PetscErrorCode (*gsfunc)(SNES,Vec,Vec,void*),void *ctx)
17246cab3a1bSJed Brown {
17256cab3a1bSJed Brown   PetscErrorCode ierr;
17266cab3a1bSJed Brown   DM             dm;
17276cab3a1bSJed Brown 
1728646217ecSPeter Brune   PetscFunctionBegin;
17296cab3a1bSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
17306cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
17316cab3a1bSJed Brown   ierr = DMSNESSetGS(dm,gsfunc,ctx);CHKERRQ(ierr);
1732646217ecSPeter Brune   PetscFunctionReturn(0);
1733646217ecSPeter Brune }
1734646217ecSPeter Brune 
1735d25893d9SBarry Smith #undef __FUNCT__
173689b92e6fSPeter Brune #define __FUNCT__ "SNESSetGSSweeps"
173789b92e6fSPeter Brune /*@
173889b92e6fSPeter Brune    SNESSetGSSweeps - Sets the number of sweeps of GS to use.
173989b92e6fSPeter Brune 
174089b92e6fSPeter Brune    Input Parameters:
174189b92e6fSPeter Brune +  snes   - the SNES context
174289b92e6fSPeter Brune -  sweeps  - the number of sweeps of GS to perform.
174389b92e6fSPeter Brune 
174489b92e6fSPeter Brune    Level: intermediate
174589b92e6fSPeter Brune 
174689b92e6fSPeter Brune .keywords: SNES, nonlinear, set, Gauss-Siedel
174789b92e6fSPeter Brune 
174889b92e6fSPeter Brune .seealso: SNESSetGS(), SNESGetGS(), SNESSetPC(), SNESGetGSSweeps()
174989b92e6fSPeter Brune @*/
175089b92e6fSPeter Brune 
1751c35f09e5SBarry Smith PetscErrorCode SNESSetGSSweeps(SNES snes, PetscInt sweeps)
1752c35f09e5SBarry Smith {
175389b92e6fSPeter Brune   PetscFunctionBegin;
175489b92e6fSPeter Brune   snes->gssweeps = sweeps;
175589b92e6fSPeter Brune   PetscFunctionReturn(0);
175689b92e6fSPeter Brune }
175789b92e6fSPeter Brune 
175889b92e6fSPeter Brune 
175989b92e6fSPeter Brune #undef __FUNCT__
176089b92e6fSPeter Brune #define __FUNCT__ "SNESGetGSSweeps"
176189b92e6fSPeter Brune /*@
176289b92e6fSPeter Brune    SNESGetGSSweeps - Gets the number of sweeps GS will use.
176389b92e6fSPeter Brune 
176489b92e6fSPeter Brune    Input Parameters:
176589b92e6fSPeter Brune .  snes   - the SNES context
176689b92e6fSPeter Brune 
176789b92e6fSPeter Brune    Output Parameters:
176889b92e6fSPeter Brune .  sweeps  - the number of sweeps of GS to perform.
176989b92e6fSPeter Brune 
177089b92e6fSPeter Brune    Level: intermediate
177189b92e6fSPeter Brune 
177289b92e6fSPeter Brune .keywords: SNES, nonlinear, set, Gauss-Siedel
177389b92e6fSPeter Brune 
177489b92e6fSPeter Brune .seealso: SNESSetGS(), SNESGetGS(), SNESSetPC(), SNESSetGSSweeps()
177589b92e6fSPeter Brune @*/
1776c35f09e5SBarry Smith PetscErrorCode SNESGetGSSweeps(SNES snes, PetscInt * sweeps)
1777c35f09e5SBarry Smith {
177889b92e6fSPeter Brune   PetscFunctionBegin;
177989b92e6fSPeter Brune   *sweeps = snes->gssweeps;
178089b92e6fSPeter Brune   PetscFunctionReturn(0);
178189b92e6fSPeter Brune }
178289b92e6fSPeter Brune 
178389b92e6fSPeter Brune #undef __FUNCT__
17848b0a5094SBarry Smith #define __FUNCT__ "SNESPicardComputeFunction"
17858b0a5094SBarry Smith PetscErrorCode  SNESPicardComputeFunction(SNES snes,Vec x,Vec f,void *ctx)
17868b0a5094SBarry Smith {
17878b0a5094SBarry Smith   PetscErrorCode ierr;
1788e03ab78fSPeter Brune   DM             dm;
1789942e3340SBarry Smith   DMSNES         sdm;
17906cab3a1bSJed Brown 
17918b0a5094SBarry Smith   PetscFunctionBegin;
1792e03ab78fSPeter Brune   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
1793942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
17948b0a5094SBarry Smith   /*  A(x)*x - b(x) */
179522c6f798SBarry Smith   if (sdm->ops->computepfunction) {
179622c6f798SBarry Smith     ierr = (*sdm->ops->computepfunction)(snes,x,f,sdm->pctx);CHKERRQ(ierr);
179722c6f798SBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetPicard() to provide Picard function.");
1798e03ab78fSPeter Brune 
179922c6f798SBarry Smith   if (sdm->ops->computepjacobian) {
180022c6f798SBarry Smith     ierr = (*sdm->ops->computepjacobian)(snes,x,&snes->jacobian,&snes->jacobian_pre,&snes->matstruct,sdm->pctx);CHKERRQ(ierr);
180174e1e8c1SBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetPicard() to provide Picard matrix.");
18028b0a5094SBarry Smith   ierr = VecScale(f,-1.0);CHKERRQ(ierr);
180395eabcedSBarry Smith   ierr = MatMultAdd(snes->jacobian,x,f,f);CHKERRQ(ierr);
18048b0a5094SBarry Smith   PetscFunctionReturn(0);
18058b0a5094SBarry Smith }
18068b0a5094SBarry Smith 
18078b0a5094SBarry Smith #undef __FUNCT__
18088b0a5094SBarry Smith #define __FUNCT__ "SNESPicardComputeJacobian"
18098b0a5094SBarry Smith PetscErrorCode  SNESPicardComputeJacobian(SNES snes,Vec x1,Mat *J,Mat *B,MatStructure *flag,void *ctx)
18108b0a5094SBarry Smith {
18118b0a5094SBarry Smith   PetscFunctionBegin;
1812e03ab78fSPeter Brune   /* the jacobian matrix should be pre-filled in SNESPicardComputeFunction */
18138b0a5094SBarry Smith   *flag = snes->matstruct;
18148b0a5094SBarry Smith   PetscFunctionReturn(0);
18158b0a5094SBarry Smith }
18168b0a5094SBarry Smith 
18178b0a5094SBarry Smith #undef __FUNCT__
18188b0a5094SBarry Smith #define __FUNCT__ "SNESSetPicard"
18198b0a5094SBarry Smith /*@C
18200d04baf8SBarry Smith    SNESSetPicard - Use SNES to solve the semilinear-system A(x) x = b(x) via a Picard type iteration (Picard linearization)
18218b0a5094SBarry Smith 
18228b0a5094SBarry Smith    Logically Collective on SNES
18238b0a5094SBarry Smith 
18248b0a5094SBarry Smith    Input Parameters:
18258b0a5094SBarry Smith +  snes - the SNES context
18268b0a5094SBarry Smith .  r - vector to store function value
18278b0a5094SBarry Smith .  func - function evaluation routine
1828f450aa47SBarry 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)
18298b0a5094SBarry Smith .  mat - matrix to store A
18308b0a5094SBarry Smith .  mfunc  - function to compute matrix value
18318b0a5094SBarry Smith -  ctx - [optional] user-defined context for private data for the
18328b0a5094SBarry Smith          function evaluation routine (may be PETSC_NULL)
18338b0a5094SBarry Smith 
18348b0a5094SBarry Smith    Calling sequence of func:
18358b0a5094SBarry Smith $    func (SNES snes,Vec x,Vec f,void *ctx);
18368b0a5094SBarry Smith 
18378b0a5094SBarry Smith +  f - function vector
18388b0a5094SBarry Smith -  ctx - optional user-defined function context
18398b0a5094SBarry Smith 
18408b0a5094SBarry Smith    Calling sequence of mfunc:
18418b0a5094SBarry Smith $     mfunc (SNES snes,Vec x,Mat *jmat,Mat *mat,int *flag,void *ctx);
18428b0a5094SBarry Smith 
18438b0a5094SBarry Smith +  x - input vector
1844f450aa47SBarry Smith .  jmat - Form  matrix of A(x) x - b(x) if available, not there is really no reason to use it in this way since then you can just use SNESSetJacobian(),
18458b0a5094SBarry Smith           normally just pass mat in this location
18468b0a5094SBarry Smith .  mat - form A(x) matrix
18478b0a5094SBarry Smith .  flag - flag indicating information about the preconditioner matrix
18488b0a5094SBarry Smith    structure (same as flag in KSPSetOperators()), one of SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER
18498b0a5094SBarry Smith -  ctx - [optional] user-defined Jacobian context
18508b0a5094SBarry Smith 
18518b0a5094SBarry Smith    Notes:
1852f450aa47SBarry 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
1853f450aa47SBarry 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.
1854f450aa47SBarry Smith 
18558b0a5094SBarry Smith     One can call SNESSetPicard() or SNESSetFunction() (and possibly SNESSetJacobian()) but cannot call both
18568b0a5094SBarry Smith 
18578b0a5094SBarry 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}
18588b0a5094SBarry 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.
18598b0a5094SBarry Smith 
18608b0a5094SBarry Smith      Run with -snes_mf_operator to solve the system with Newton's method using A(x^{n}) to construct the preconditioner.
18618b0a5094SBarry Smith 
18620d04baf8SBarry Smith    We implement the defect correction form of the Picard iteration because it converges much more generally when inexact linear solvers are used then
18630d04baf8SBarry Smith    the direct Picard iteration A(x^n) x^{n+1} = b(x^n)
18648b0a5094SBarry Smith 
18658b0a5094SBarry 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
18668b0a5094SBarry 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
18678b0a5094SBarry Smith    different please contact us at petsc-dev@mcs.anl.gov and we'll have an entirely new argument :-).
18688b0a5094SBarry Smith 
1869f450aa47SBarry Smith    Level: intermediate
18708b0a5094SBarry Smith 
18718b0a5094SBarry Smith .keywords: SNES, nonlinear, set, function
18728b0a5094SBarry Smith 
18730d04baf8SBarry Smith .seealso: SNESGetFunction(), SNESSetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESGetPicard(), SNESLineSearchPreCheckPicard()
18748b0a5094SBarry Smith @*/
18758b0a5094SBarry Smith PetscErrorCode  SNESSetPicard(SNES snes,Vec r,PetscErrorCode (*func)(SNES,Vec,Vec,void*),Mat jmat, Mat mat, PetscErrorCode (*mfunc)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *ctx)
18768b0a5094SBarry Smith {
18778b0a5094SBarry Smith   PetscErrorCode ierr;
1878e03ab78fSPeter Brune   DM             dm;
1879e03ab78fSPeter Brune 
18808b0a5094SBarry Smith   PetscFunctionBegin;
18818b0a5094SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1882e03ab78fSPeter Brune   ierr = SNESGetDM(snes, &dm);CHKERRQ(ierr);
1883e03ab78fSPeter Brune   ierr = DMSNESSetPicard(dm,func,mfunc,ctx);CHKERRQ(ierr);
18848b0a5094SBarry Smith   ierr = SNESSetFunction(snes,r,SNESPicardComputeFunction,ctx);CHKERRQ(ierr);
18858b0a5094SBarry Smith   ierr = SNESSetJacobian(snes,jmat,mat,SNESPicardComputeJacobian,ctx);CHKERRQ(ierr);
18868b0a5094SBarry Smith   PetscFunctionReturn(0);
18878b0a5094SBarry Smith }
18888b0a5094SBarry Smith 
18897971a8bfSPeter Brune 
18907971a8bfSPeter Brune #undef __FUNCT__
18917971a8bfSPeter Brune #define __FUNCT__ "SNESGetPicard"
18927971a8bfSPeter Brune /*@C
18937971a8bfSPeter Brune    SNESGetPicard - Returns the context for the Picard iteration
18947971a8bfSPeter Brune 
18957971a8bfSPeter Brune    Not Collective, but Vec is parallel if SNES is parallel. Collective if Vec is requested, but has not been created yet.
18967971a8bfSPeter Brune 
18977971a8bfSPeter Brune    Input Parameter:
18987971a8bfSPeter Brune .  snes - the SNES context
18997971a8bfSPeter Brune 
19007971a8bfSPeter Brune    Output Parameter:
19017971a8bfSPeter Brune +  r - the function (or PETSC_NULL)
19027971a8bfSPeter Brune .  func - the function (or PETSC_NULL)
19037971a8bfSPeter Brune .  jmat - the picard matrix (or PETSC_NULL)
19047971a8bfSPeter Brune .  mat  - the picard preconditioner matrix (or PETSC_NULL)
19057971a8bfSPeter Brune .  mfunc - the function for matrix evaluation (or PETSC_NULL)
19067971a8bfSPeter Brune -  ctx - the function context (or PETSC_NULL)
19077971a8bfSPeter Brune 
19087971a8bfSPeter Brune    Level: advanced
19097971a8bfSPeter Brune 
19107971a8bfSPeter Brune .keywords: SNES, nonlinear, get, function
19117971a8bfSPeter Brune 
19127971a8bfSPeter Brune .seealso: SNESSetPicard, SNESGetFunction, SNESGetJacobian, SNESGetDM
19137971a8bfSPeter Brune @*/
19147971a8bfSPeter Brune PetscErrorCode  SNESGetPicard(SNES snes,Vec *r,PetscErrorCode (**func)(SNES,Vec,Vec,void*),Mat *jmat, Mat *mat, PetscErrorCode (**mfunc)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **ctx)
19157971a8bfSPeter Brune {
19167971a8bfSPeter Brune   PetscErrorCode ierr;
19177971a8bfSPeter Brune   DM             dm;
19187971a8bfSPeter Brune 
19197971a8bfSPeter Brune   PetscFunctionBegin;
19207971a8bfSPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
19217971a8bfSPeter Brune   ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
19227971a8bfSPeter Brune   ierr = SNESGetJacobian(snes,jmat,mat,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
19237971a8bfSPeter Brune   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
19247971a8bfSPeter Brune   ierr = DMSNESGetPicard(dm,func,mfunc,ctx);CHKERRQ(ierr);
19257971a8bfSPeter Brune   PetscFunctionReturn(0);
19267971a8bfSPeter Brune }
19277971a8bfSPeter Brune 
19288b0a5094SBarry Smith #undef __FUNCT__
1929d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeInitialGuess"
1930d25893d9SBarry Smith /*@C
1931d25893d9SBarry Smith    SNESSetComputeInitialGuess - Sets a routine used to compute an initial guess for the problem
1932d25893d9SBarry Smith 
1933d25893d9SBarry Smith    Logically Collective on SNES
1934d25893d9SBarry Smith 
1935d25893d9SBarry Smith    Input Parameters:
1936d25893d9SBarry Smith +  snes - the SNES context
1937d25893d9SBarry Smith .  func - function evaluation routine
1938d25893d9SBarry Smith -  ctx - [optional] user-defined context for private data for the
1939d25893d9SBarry Smith          function evaluation routine (may be PETSC_NULL)
1940d25893d9SBarry Smith 
1941d25893d9SBarry Smith    Calling sequence of func:
1942d25893d9SBarry Smith $    func (SNES snes,Vec x,void *ctx);
1943d25893d9SBarry Smith 
1944d25893d9SBarry Smith .  f - function vector
1945d25893d9SBarry Smith -  ctx - optional user-defined function context
1946d25893d9SBarry Smith 
1947d25893d9SBarry Smith    Level: intermediate
1948d25893d9SBarry Smith 
1949d25893d9SBarry Smith .keywords: SNES, nonlinear, set, function
1950d25893d9SBarry Smith 
1951d25893d9SBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian()
1952d25893d9SBarry Smith @*/
1953d25893d9SBarry Smith PetscErrorCode  SNESSetComputeInitialGuess(SNES snes,PetscErrorCode (*func)(SNES,Vec,void*),void *ctx)
1954d25893d9SBarry Smith {
1955d25893d9SBarry Smith   PetscFunctionBegin;
1956d25893d9SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1957d25893d9SBarry Smith   if (func) snes->ops->computeinitialguess = func;
1958d25893d9SBarry Smith   if (ctx)  snes->initialguessP            = ctx;
1959d25893d9SBarry Smith   PetscFunctionReturn(0);
1960d25893d9SBarry Smith }
1961d25893d9SBarry Smith 
19623ab0aad5SBarry Smith /* --------------------------------------------------------------- */
19633ab0aad5SBarry Smith #undef __FUNCT__
19641096aae1SMatthew Knepley #define __FUNCT__ "SNESGetRhs"
19651096aae1SMatthew Knepley /*@C
19661096aae1SMatthew Knepley    SNESGetRhs - Gets the vector for solving F(x) = rhs. If rhs is not set
19671096aae1SMatthew Knepley    it assumes a zero right hand side.
19681096aae1SMatthew Knepley 
19693f9fe445SBarry Smith    Logically Collective on SNES
19701096aae1SMatthew Knepley 
19711096aae1SMatthew Knepley    Input Parameter:
19721096aae1SMatthew Knepley .  snes - the SNES context
19731096aae1SMatthew Knepley 
19741096aae1SMatthew Knepley    Output Parameter:
1975bc08b0f1SBarry Smith .  rhs - the right hand side vector or PETSC_NULL if the right hand side vector is null
19761096aae1SMatthew Knepley 
19771096aae1SMatthew Knepley    Level: intermediate
19781096aae1SMatthew Knepley 
19791096aae1SMatthew Knepley .keywords: SNES, nonlinear, get, function, right hand side
19801096aae1SMatthew Knepley 
198185385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
19821096aae1SMatthew Knepley @*/
19837087cfbeSBarry Smith PetscErrorCode  SNESGetRhs(SNES snes,Vec *rhs)
19841096aae1SMatthew Knepley {
19851096aae1SMatthew Knepley   PetscFunctionBegin;
19860700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
19871096aae1SMatthew Knepley   PetscValidPointer(rhs,2);
198885385478SLisandro Dalcin   *rhs = snes->vec_rhs;
19891096aae1SMatthew Knepley   PetscFunctionReturn(0);
19901096aae1SMatthew Knepley }
19911096aae1SMatthew Knepley 
19921096aae1SMatthew Knepley #undef __FUNCT__
19934a2ae208SSatish Balay #define __FUNCT__ "SNESComputeFunction"
19949b94acceSBarry Smith /*@
199536851e7fSLois Curfman McInnes    SNESComputeFunction - Calls the function that has been set with
19969b94acceSBarry Smith                          SNESSetFunction().
19979b94acceSBarry Smith 
1998c7afd0dbSLois Curfman McInnes    Collective on SNES
1999c7afd0dbSLois Curfman McInnes 
20009b94acceSBarry Smith    Input Parameters:
2001c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2002c7afd0dbSLois Curfman McInnes -  x - input vector
20039b94acceSBarry Smith 
20049b94acceSBarry Smith    Output Parameter:
20053638b69dSLois Curfman McInnes .  y - function vector, as set by SNESSetFunction()
20069b94acceSBarry Smith 
20071bffabb2SLois Curfman McInnes    Notes:
200836851e7fSLois Curfman McInnes    SNESComputeFunction() is typically used within nonlinear solvers
200936851e7fSLois Curfman McInnes    implementations, so most users would not generally call this routine
201036851e7fSLois Curfman McInnes    themselves.
201136851e7fSLois Curfman McInnes 
201236851e7fSLois Curfman McInnes    Level: developer
201336851e7fSLois Curfman McInnes 
20149b94acceSBarry Smith .keywords: SNES, nonlinear, compute, function
20159b94acceSBarry Smith 
2016a86d99e1SLois Curfman McInnes .seealso: SNESSetFunction(), SNESGetFunction()
20179b94acceSBarry Smith @*/
20187087cfbeSBarry Smith PetscErrorCode  SNESComputeFunction(SNES snes,Vec x,Vec y)
20199b94acceSBarry Smith {
2020dfbe8321SBarry Smith   PetscErrorCode ierr;
20216cab3a1bSJed Brown   DM             dm;
2022942e3340SBarry Smith   DMSNES         sdm;
20239b94acceSBarry Smith 
20243a40ed3dSBarry Smith   PetscFunctionBegin;
20250700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
20260700a824SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
20270700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
2028c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,x,2);
2029c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,y,3);
20304ec14c9cSBarry Smith   VecValidValues(x,2,PETSC_TRUE);
2031184914b5SBarry Smith 
20326cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
2033942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
2034d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr);
2035c40d0f55SPeter Brune   if (snes->pc && snes->pcside == PC_LEFT) {
2036c40d0f55SPeter Brune     ierr = VecCopy(x,y);CHKERRQ(ierr);
2037c40d0f55SPeter Brune     ierr = SNESSolve(snes->pc,snes->vec_rhs,y);CHKERRQ(ierr);
2038c40d0f55SPeter Brune     ierr = VecAYPX(y,-1.0,x);CHKERRQ(ierr);
203922c6f798SBarry Smith   } else if (sdm->ops->computefunction) {
2040d64ed03dSBarry Smith     PetscStackPush("SNES user function");
204122c6f798SBarry Smith     ierr = (*sdm->ops->computefunction)(snes,x,y,sdm->functionctx);CHKERRQ(ierr);
2042d64ed03dSBarry Smith     PetscStackPop;
2043c90fad12SPeter Brune   } else if (snes->vec_rhs) {
2044c90fad12SPeter Brune     ierr = MatMult(snes->jacobian, x, y);CHKERRQ(ierr);
2045644e2e5bSBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetFunction() or SNESSetDM() before SNESComputeFunction(), likely called from SNESSolve().");
204685385478SLisandro Dalcin   if (snes->vec_rhs) {
204785385478SLisandro Dalcin     ierr = VecAXPY(y,-1.0,snes->vec_rhs);CHKERRQ(ierr);
20483ab0aad5SBarry Smith   }
2049ae3c334cSLois Curfman McInnes   snes->nfuncs++;
2050d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr);
20514ec14c9cSBarry Smith   VecValidValues(y,3,PETSC_FALSE);
20523a40ed3dSBarry Smith   PetscFunctionReturn(0);
20539b94acceSBarry Smith }
20549b94acceSBarry Smith 
20554a2ae208SSatish Balay #undef __FUNCT__
2056646217ecSPeter Brune #define __FUNCT__ "SNESComputeGS"
2057c79ef259SPeter Brune /*@
2058c79ef259SPeter Brune    SNESComputeGS - Calls the Gauss-Seidel function that has been set with
2059c79ef259SPeter Brune                    SNESSetGS().
2060c79ef259SPeter Brune 
2061c79ef259SPeter Brune    Collective on SNES
2062c79ef259SPeter Brune 
2063c79ef259SPeter Brune    Input Parameters:
2064c79ef259SPeter Brune +  snes - the SNES context
2065c79ef259SPeter Brune .  x - input vector
2066c79ef259SPeter Brune -  b - rhs vector
2067c79ef259SPeter Brune 
2068c79ef259SPeter Brune    Output Parameter:
2069c79ef259SPeter Brune .  x - new solution vector
2070c79ef259SPeter Brune 
2071c79ef259SPeter Brune    Notes:
2072c79ef259SPeter Brune    SNESComputeGS() is typically used within composed nonlinear solver
2073c79ef259SPeter Brune    implementations, so most users would not generally call this routine
2074c79ef259SPeter Brune    themselves.
2075c79ef259SPeter Brune 
2076c79ef259SPeter Brune    Level: developer
2077c79ef259SPeter Brune 
2078c79ef259SPeter Brune .keywords: SNES, nonlinear, compute, function
2079c79ef259SPeter Brune 
2080c79ef259SPeter Brune .seealso: SNESSetGS(), SNESComputeFunction()
2081c79ef259SPeter Brune @*/
2082646217ecSPeter Brune PetscErrorCode  SNESComputeGS(SNES snes,Vec b,Vec x)
2083646217ecSPeter Brune {
2084646217ecSPeter Brune   PetscErrorCode ierr;
208589b92e6fSPeter Brune   PetscInt       i;
20866cab3a1bSJed Brown   DM             dm;
2087942e3340SBarry Smith   DMSNES         sdm;
2088646217ecSPeter Brune 
2089646217ecSPeter Brune   PetscFunctionBegin;
2090646217ecSPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2091646217ecSPeter Brune   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
2092646217ecSPeter Brune   if (b) PetscValidHeaderSpecific(b,VEC_CLASSID,3);
2093646217ecSPeter Brune   PetscCheckSameComm(snes,1,x,2);
2094646217ecSPeter Brune   if (b) PetscCheckSameComm(snes,1,b,3);
20954ec14c9cSBarry Smith   if (b) VecValidValues(b,2,PETSC_TRUE);
2096701cf23dSPeter Brune   ierr = PetscLogEventBegin(SNES_GSEval,snes,x,b,0);CHKERRQ(ierr);
20976cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
2098942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
209922c6f798SBarry Smith   if (sdm->ops->computegs) {
210089b92e6fSPeter Brune     for (i = 0; i < snes->gssweeps; i++) {
2101646217ecSPeter Brune       PetscStackPush("SNES user GS");
210222c6f798SBarry Smith       ierr = (*sdm->ops->computegs)(snes,x,b,sdm->gsctx);CHKERRQ(ierr);
2103646217ecSPeter Brune       PetscStackPop;
210489b92e6fSPeter Brune     }
2105646217ecSPeter Brune   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetGS() before SNESComputeGS(), likely called from SNESSolve().");
2106701cf23dSPeter Brune   ierr = PetscLogEventEnd(SNES_GSEval,snes,x,b,0);CHKERRQ(ierr);
21074ec14c9cSBarry Smith   VecValidValues(x,3,PETSC_FALSE);
2108646217ecSPeter Brune   PetscFunctionReturn(0);
2109646217ecSPeter Brune }
2110646217ecSPeter Brune 
2111646217ecSPeter Brune 
2112646217ecSPeter Brune #undef __FUNCT__
21134a2ae208SSatish Balay #define __FUNCT__ "SNESComputeJacobian"
211462fef451SLois Curfman McInnes /*@
211562fef451SLois Curfman McInnes    SNESComputeJacobian - Computes the Jacobian matrix that has been
211662fef451SLois Curfman McInnes    set with SNESSetJacobian().
211762fef451SLois Curfman McInnes 
2118c7afd0dbSLois Curfman McInnes    Collective on SNES and Mat
2119c7afd0dbSLois Curfman McInnes 
212062fef451SLois Curfman McInnes    Input Parameters:
2121c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2122c7afd0dbSLois Curfman McInnes -  x - input vector
212362fef451SLois Curfman McInnes 
212462fef451SLois Curfman McInnes    Output Parameters:
2125c7afd0dbSLois Curfman McInnes +  A - Jacobian matrix
212662fef451SLois Curfman McInnes .  B - optional preconditioning matrix
21272b668275SBarry Smith -  flag - flag indicating matrix structure (one of, SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER)
2128fee21e36SBarry Smith 
2129e35cf81dSBarry Smith   Options Database Keys:
2130e35cf81dSBarry Smith +    -snes_lag_preconditioner <lag>
2131693365a8SJed Brown .    -snes_lag_jacobian <lag>
2132693365a8SJed Brown .    -snes_compare_explicit - Compare the computed Jacobian to the finite difference Jacobian and output the differences
2133693365a8SJed Brown .    -snes_compare_explicit_draw  - Compare the computed Jacobian to the finite difference Jacobian and draw the result
2134693365a8SJed Brown .    -snes_compare_explicit_contour  - Compare the computed Jacobian to the finite difference Jacobian and draw a contour plot with the result
21354c30e9fbSJed Brown .    -snes_compare_operator  - Make the comparison options above use the operator instead of the preconditioning matrix
2136c01495d3SJed Brown .    -snes_compare_coloring - Compute the finite differece Jacobian using coloring and display norms of difference
2137c01495d3SJed Brown .    -snes_compare_coloring_display - Compute the finite differece Jacobian using coloring and display verbose differences
2138c01495d3SJed Brown .    -snes_compare_coloring_threshold - Display only those matrix entries that differ by more than a given threshold
2139c01495d3SJed Brown .    -snes_compare_coloring_threshold_atol - Absolute tolerance for difference in matrix entries to be displayed by -snes_compare_coloring_threshold
2140c01495d3SJed Brown .    -snes_compare_coloring_threshold_rtol - Relative tolerance for difference in matrix entries to be displayed by -snes_compare_coloring_threshold
21414c30e9fbSJed Brown .    -snes_compare_coloring_draw - Compute the finite differece Jacobian using coloring and draw differences
2142c01495d3SJed Brown -    -snes_compare_coloring_draw_contour - Compute the finite differece Jacobian using coloring and show contours of matrices and differences
2143c01495d3SJed Brown 
2144e35cf81dSBarry Smith 
214562fef451SLois Curfman McInnes    Notes:
214662fef451SLois Curfman McInnes    Most users should not need to explicitly call this routine, as it
214762fef451SLois Curfman McInnes    is used internally within the nonlinear solvers.
214862fef451SLois Curfman McInnes 
214994b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
2150dc5a77f8SLois Curfman McInnes    flag parameter.
215162fef451SLois Curfman McInnes 
215236851e7fSLois Curfman McInnes    Level: developer
215336851e7fSLois Curfman McInnes 
215462fef451SLois Curfman McInnes .keywords: SNES, compute, Jacobian, matrix
215562fef451SLois Curfman McInnes 
2156e35cf81dSBarry Smith .seealso:  SNESSetJacobian(), KSPSetOperators(), MatStructure, SNESSetLagPreconditioner(), SNESSetLagJacobian()
215762fef451SLois Curfman McInnes @*/
21587087cfbeSBarry Smith PetscErrorCode  SNESComputeJacobian(SNES snes,Vec X,Mat *A,Mat *B,MatStructure *flg)
21599b94acceSBarry Smith {
2160dfbe8321SBarry Smith   PetscErrorCode ierr;
2161ace3abfcSBarry Smith   PetscBool      flag;
21626cab3a1bSJed Brown   DM             dm;
2163942e3340SBarry Smith   DMSNES         sdm;
21643a40ed3dSBarry Smith 
21653a40ed3dSBarry Smith   PetscFunctionBegin;
21660700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
21670700a824SBarry Smith   PetscValidHeaderSpecific(X,VEC_CLASSID,2);
21684482741eSBarry Smith   PetscValidPointer(flg,5);
2169c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,X,2);
21704ec14c9cSBarry Smith   VecValidValues(X,2,PETSC_TRUE);
21716cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
2172942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
21733232da50SPeter Brune 
217422c6f798SBarry Smith   if (!sdm->ops->computejacobian) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_USER,"Must call SNESSetJacobian(), DMSNESSetJacobian(), DMDASNESSetJacobianLocal(), etc");
2175ebd3b9afSBarry Smith 
2176ebd3b9afSBarry Smith   /* make sure that MatAssemblyBegin/End() is called on A matrix if it is matrix free */
2177ebd3b9afSBarry Smith 
2178fe3ffe1eSBarry Smith   if (snes->lagjacobian == -2) {
2179fe3ffe1eSBarry Smith     snes->lagjacobian = -1;
2180fe3ffe1eSBarry Smith     ierr = PetscInfo(snes,"Recomputing Jacobian/preconditioner because lag is -2 (means compute Jacobian, but then never again) \n");CHKERRQ(ierr);
2181fe3ffe1eSBarry Smith   } else if (snes->lagjacobian == -1) {
2182e35cf81dSBarry Smith     *flg = SAME_PRECONDITIONER;
2183e35cf81dSBarry Smith     ierr = PetscInfo(snes,"Reusing Jacobian/preconditioner because lag is -1\n");CHKERRQ(ierr);
2184251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr);
2185ebd3b9afSBarry Smith     if (flag) {
2186ebd3b9afSBarry Smith       ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
2187ebd3b9afSBarry Smith       ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
2188ebd3b9afSBarry Smith     }
2189e35cf81dSBarry Smith     PetscFunctionReturn(0);
2190e35cf81dSBarry Smith   } else if (snes->lagjacobian > 1 && snes->iter % snes->lagjacobian) {
2191e35cf81dSBarry Smith     *flg = SAME_PRECONDITIONER;
2192e35cf81dSBarry Smith     ierr = PetscInfo2(snes,"Reusing Jacobian/preconditioner because lag is %D and SNES iteration is %D\n",snes->lagjacobian,snes->iter);CHKERRQ(ierr);
2193251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr);
2194ebd3b9afSBarry Smith     if (flag) {
2195ebd3b9afSBarry Smith       ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
2196ebd3b9afSBarry Smith       ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
2197ebd3b9afSBarry Smith     }
2198e35cf81dSBarry Smith     PetscFunctionReturn(0);
2199e35cf81dSBarry Smith   }
2200e35cf81dSBarry Smith 
2201c4fc05e7SBarry Smith   *flg = DIFFERENT_NONZERO_PATTERN;
2202e35cf81dSBarry Smith   ierr = PetscLogEventBegin(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr);
22033232da50SPeter Brune 
2204d64ed03dSBarry Smith   PetscStackPush("SNES user Jacobian function");
220522c6f798SBarry Smith   ierr = (*sdm->ops->computejacobian)(snes,X,A,B,flg,sdm->jacobianctx);CHKERRQ(ierr);
2206d64ed03dSBarry Smith   PetscStackPop;
22073232da50SPeter Brune 
2208d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr);
2209a8054027SBarry Smith 
22103b4f5425SBarry Smith   if (snes->lagpreconditioner == -2) {
22113b4f5425SBarry Smith     ierr = PetscInfo(snes,"Rebuilding preconditioner exactly once since lag is -2\n");CHKERRQ(ierr);
22123b4f5425SBarry Smith     snes->lagpreconditioner = -1;
22133b4f5425SBarry Smith   } else if (snes->lagpreconditioner == -1) {
2214a8054027SBarry Smith     *flg = SAME_PRECONDITIONER;
2215a8054027SBarry Smith     ierr = PetscInfo(snes,"Reusing preconditioner because lag is -1\n");CHKERRQ(ierr);
2216a8054027SBarry Smith   } else if (snes->lagpreconditioner > 1 && snes->iter % snes->lagpreconditioner) {
2217a8054027SBarry Smith     *flg = SAME_PRECONDITIONER;
2218a8054027SBarry Smith     ierr = PetscInfo2(snes,"Reusing preconditioner because lag is %D and SNES iteration is %D\n",snes->lagpreconditioner,snes->iter);CHKERRQ(ierr);
2219a8054027SBarry Smith   }
2220a8054027SBarry Smith 
22216d84be18SBarry Smith   /* make sure user returned a correct Jacobian and preconditioner */
22220700a824SBarry Smith   /* PetscValidHeaderSpecific(*A,MAT_CLASSID,3);
22230700a824SBarry Smith     PetscValidHeaderSpecific(*B,MAT_CLASSID,4);   */
2224693365a8SJed Brown   {
2225693365a8SJed Brown     PetscBool flag = PETSC_FALSE,flag_draw = PETSC_FALSE,flag_contour = PETSC_FALSE,flag_operator = PETSC_FALSE;
2226693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit",&flag,PETSC_NULL);CHKERRQ(ierr);
2227693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw",&flag_draw,PETSC_NULL);CHKERRQ(ierr);
2228693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw_contour",&flag_contour,PETSC_NULL);CHKERRQ(ierr);
2229693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_operator",&flag_operator,PETSC_NULL);CHKERRQ(ierr);
2230693365a8SJed Brown     if (flag || flag_draw || flag_contour) {
2231693365a8SJed Brown       Mat Bexp_mine = PETSC_NULL,Bexp,FDexp;
2232693365a8SJed Brown       MatStructure mstruct;
2233693365a8SJed Brown       PetscViewer vdraw,vstdout;
22346b3a5b13SJed Brown       PetscBool flg;
2235693365a8SJed Brown       if (flag_operator) {
2236693365a8SJed Brown         ierr = MatComputeExplicitOperator(*A,&Bexp_mine);CHKERRQ(ierr);
2237693365a8SJed Brown         Bexp = Bexp_mine;
2238693365a8SJed Brown       } else {
2239693365a8SJed Brown         /* See if the preconditioning matrix can be viewed and added directly */
2240251f4c67SDmitry Karpeev         ierr = PetscObjectTypeCompareAny((PetscObject)*B,&flg,MATSEQAIJ,MATMPIAIJ,MATSEQDENSE,MATMPIDENSE,MATSEQBAIJ,MATMPIBAIJ,MATSEQSBAIJ,MATMPIBAIJ,"");CHKERRQ(ierr);
2241693365a8SJed Brown         if (flg) Bexp = *B;
2242693365a8SJed Brown         else {
2243693365a8SJed Brown           /* If the "preconditioning" matrix is itself MATSHELL or some other type without direct support */
2244693365a8SJed Brown           ierr = MatComputeExplicitOperator(*B,&Bexp_mine);CHKERRQ(ierr);
2245693365a8SJed Brown           Bexp = Bexp_mine;
2246693365a8SJed Brown         }
2247693365a8SJed Brown       }
2248693365a8SJed Brown       ierr = MatConvert(Bexp,MATSAME,MAT_INITIAL_MATRIX,&FDexp);CHKERRQ(ierr);
2249693365a8SJed Brown       ierr = SNESDefaultComputeJacobian(snes,X,&FDexp,&FDexp,&mstruct,NULL);CHKERRQ(ierr);
2250693365a8SJed Brown       ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&vstdout);CHKERRQ(ierr);
2251693365a8SJed Brown       if (flag_draw || flag_contour) {
2252693365a8SJed Brown         ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,0,"Explicit Jacobians",PETSC_DECIDE,PETSC_DECIDE,300,300,&vdraw);CHKERRQ(ierr);
2253693365a8SJed Brown         if (flag_contour) {ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);}
2254693365a8SJed Brown       } else vdraw = PETSC_NULL;
2255693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Explicit %s\n",flag_operator?"Jacobian":"preconditioning Jacobian");CHKERRQ(ierr);
2256693365a8SJed Brown       if (flag) {ierr = MatView(Bexp,vstdout);CHKERRQ(ierr);}
2257693365a8SJed Brown       if (vdraw) {ierr = MatView(Bexp,vdraw);CHKERRQ(ierr);}
2258693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Finite difference Jacobian\n");CHKERRQ(ierr);
2259693365a8SJed Brown       if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);}
2260693365a8SJed Brown       if (vdraw) {ierr = MatView(FDexp,vdraw);CHKERRQ(ierr);}
2261693365a8SJed Brown       ierr = MatAYPX(FDexp,-1.0,Bexp,SAME_NONZERO_PATTERN);CHKERRQ(ierr);
2262693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"User-provided matrix minus finite difference Jacobian\n");CHKERRQ(ierr);
2263693365a8SJed Brown       if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);}
2264693365a8SJed Brown       if (vdraw) {              /* Always use contour for the difference */
2265693365a8SJed Brown         ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);
2266693365a8SJed Brown         ierr = MatView(FDexp,vdraw);CHKERRQ(ierr);
2267693365a8SJed Brown         ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);
2268693365a8SJed Brown       }
2269693365a8SJed Brown       if (flag_contour) {ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);}
2270693365a8SJed Brown       ierr = PetscViewerDestroy(&vdraw);CHKERRQ(ierr);
2271693365a8SJed Brown       ierr = MatDestroy(&Bexp_mine);CHKERRQ(ierr);
2272693365a8SJed Brown       ierr = MatDestroy(&FDexp);CHKERRQ(ierr);
2273693365a8SJed Brown     }
2274693365a8SJed Brown   }
22754c30e9fbSJed Brown   {
22766719d8e4SJed Brown     PetscBool flag = PETSC_FALSE,flag_display = PETSC_FALSE,flag_draw = PETSC_FALSE,flag_contour = PETSC_FALSE,flag_threshold = PETSC_FALSE;
22776719d8e4SJed Brown     PetscReal threshold_atol = PETSC_SQRT_MACHINE_EPSILON,threshold_rtol = 10*PETSC_SQRT_MACHINE_EPSILON;
22784c30e9fbSJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring",&flag,PETSC_NULL);CHKERRQ(ierr);
22796719d8e4SJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_display",&flag_display,PETSC_NULL);CHKERRQ(ierr);
22804c30e9fbSJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_draw",&flag_draw,PETSC_NULL);CHKERRQ(ierr);
22814c30e9fbSJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_draw_contour",&flag_contour,PETSC_NULL);CHKERRQ(ierr);
22826719d8e4SJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold",&flag_threshold,PETSC_NULL);CHKERRQ(ierr);
22836719d8e4SJed Brown     ierr = PetscOptionsGetReal(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold_rtol",&threshold_rtol,PETSC_NULL);CHKERRQ(ierr);
22846719d8e4SJed Brown     ierr = PetscOptionsGetReal(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold_atol",&threshold_atol,PETSC_NULL);CHKERRQ(ierr);
22856719d8e4SJed Brown     if (flag || flag_display || flag_draw || flag_contour || flag_threshold) {
22864c30e9fbSJed Brown       Mat            Bfd;
22874c30e9fbSJed Brown       MatStructure   mstruct;
22884c30e9fbSJed Brown       PetscViewer    vdraw,vstdout;
22894c30e9fbSJed Brown       ISColoring     iscoloring;
22904c30e9fbSJed Brown       MatFDColoring  matfdcoloring;
22914c30e9fbSJed Brown       PetscErrorCode (*func)(SNES,Vec,Vec,void*);
22924c30e9fbSJed Brown       void           *funcctx;
22936719d8e4SJed Brown       PetscReal      norm1,norm2,normmax;
22944c30e9fbSJed Brown 
22954c30e9fbSJed Brown       ierr = MatDuplicate(*B,MAT_DO_NOT_COPY_VALUES,&Bfd);CHKERRQ(ierr);
22964c30e9fbSJed Brown       ierr = MatGetColoring(Bfd,MATCOLORINGSL,&iscoloring);CHKERRQ(ierr);
22974c30e9fbSJed Brown       ierr = MatFDColoringCreate(Bfd,iscoloring,&matfdcoloring);CHKERRQ(ierr);
22984c30e9fbSJed Brown       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
22994c30e9fbSJed Brown 
23004c30e9fbSJed Brown       /* This method of getting the function is currently unreliable since it doesn't work for DM local functions. */
23014c30e9fbSJed Brown       ierr = SNESGetFunction(snes,PETSC_NULL,&func,&funcctx);CHKERRQ(ierr);
23024c30e9fbSJed Brown         ierr = MatFDColoringSetFunction(matfdcoloring,(PetscErrorCode(*)(void))func,funcctx);CHKERRQ(ierr);
23034c30e9fbSJed Brown         ierr = PetscObjectSetOptionsPrefix((PetscObject)matfdcoloring,((PetscObject)snes)->prefix);CHKERRQ(ierr);
23044c30e9fbSJed Brown         ierr = PetscObjectAppendOptionsPrefix((PetscObject)matfdcoloring,"coloring_");CHKERRQ(ierr);
23054c30e9fbSJed Brown         ierr = MatFDColoringSetFromOptions(matfdcoloring);CHKERRQ(ierr);
23064c30e9fbSJed Brown         ierr = MatFDColoringApply(Bfd,matfdcoloring,X,&mstruct,snes);CHKERRQ(ierr);
23074c30e9fbSJed Brown         ierr = MatFDColoringDestroy(&matfdcoloring);CHKERRQ(ierr);
23084c30e9fbSJed Brown 
23094c30e9fbSJed Brown       ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&vstdout);CHKERRQ(ierr);
23104c30e9fbSJed Brown       if (flag_draw || flag_contour) {
23114c30e9fbSJed Brown         ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,0,"Colored Jacobians",PETSC_DECIDE,PETSC_DECIDE,300,300,&vdraw);CHKERRQ(ierr);
23124c30e9fbSJed Brown         if (flag_contour) {ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);}
23134c30e9fbSJed Brown       } else vdraw = PETSC_NULL;
23144c30e9fbSJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Explicit preconditioning Jacobian\n");CHKERRQ(ierr);
23156719d8e4SJed Brown       if (flag_display) {ierr = MatView(*B,vstdout);CHKERRQ(ierr);}
23164c30e9fbSJed Brown       if (vdraw) {ierr = MatView(*B,vdraw);CHKERRQ(ierr);}
23174c30e9fbSJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Colored Finite difference Jacobian\n");CHKERRQ(ierr);
23186719d8e4SJed Brown       if (flag_display) {ierr = MatView(Bfd,vstdout);CHKERRQ(ierr);}
23194c30e9fbSJed Brown       if (vdraw) {ierr = MatView(Bfd,vdraw);CHKERRQ(ierr);}
23204c30e9fbSJed Brown       ierr = MatAYPX(Bfd,-1.0,*B,SAME_NONZERO_PATTERN);CHKERRQ(ierr);
23214c30e9fbSJed Brown       ierr = MatNorm(Bfd,NORM_1,&norm1);CHKERRQ(ierr);
23226719d8e4SJed Brown       ierr = MatNorm(Bfd,NORM_FROBENIUS,&norm2);CHKERRQ(ierr);
23234c30e9fbSJed Brown       ierr = MatNorm(Bfd,NORM_MAX,&normmax);CHKERRQ(ierr);
23246719d8e4SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"User-provided matrix minus finite difference Jacobian, norm1=%G normFrob=%G normmax=%G\n",norm1,norm2,normmax);CHKERRQ(ierr);
23256719d8e4SJed Brown       if (flag_display) {ierr = MatView(Bfd,vstdout);CHKERRQ(ierr);}
23264c30e9fbSJed Brown       if (vdraw) {              /* Always use contour for the difference */
23274c30e9fbSJed Brown         ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);
23284c30e9fbSJed Brown         ierr = MatView(Bfd,vdraw);CHKERRQ(ierr);
23294c30e9fbSJed Brown         ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);
23304c30e9fbSJed Brown       }
23314c30e9fbSJed Brown       if (flag_contour) {ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);}
23326719d8e4SJed Brown 
23336719d8e4SJed Brown       if (flag_threshold) {
23346719d8e4SJed Brown         PetscInt bs,rstart,rend,i;
23356719d8e4SJed Brown         ierr = MatGetBlockSize(*B,&bs);CHKERRQ(ierr);
23366719d8e4SJed Brown         ierr = MatGetOwnershipRange(*B,&rstart,&rend);CHKERRQ(ierr);
23376719d8e4SJed Brown         for (i=rstart; i<rend; i++) {
23386719d8e4SJed Brown           const PetscScalar *ba,*ca;
23396719d8e4SJed Brown           const PetscInt    *bj,*cj;
23406719d8e4SJed Brown           PetscInt          bn,cn,j,maxentrycol = -1,maxdiffcol = -1,maxrdiffcol = -1;
23416719d8e4SJed Brown           PetscReal         maxentry = 0,maxdiff = 0,maxrdiff = 0;
23426719d8e4SJed Brown           ierr = MatGetRow(*B,i,&bn,&bj,&ba);CHKERRQ(ierr);
23436719d8e4SJed Brown           ierr = MatGetRow(Bfd,i,&cn,&cj,&ca);CHKERRQ(ierr);
23446719d8e4SJed Brown           if (bn != cn) SETERRQ(((PetscObject)*A)->comm,PETSC_ERR_PLIB,"Unexpected different nonzero pattern in -snes_compare_coloring_threshold");
23456719d8e4SJed Brown           for (j=0; j<bn; j++) {
23466719d8e4SJed Brown             PetscReal rdiff = PetscAbsScalar(ca[j]) / (threshold_atol + threshold_rtol*PetscAbsScalar(ba[j]));
23476719d8e4SJed Brown             if (PetscAbsScalar(ba[j]) > PetscAbs(maxentry)) {
23486719d8e4SJed Brown               maxentrycol = bj[j];
23496719d8e4SJed Brown               maxentry = PetscRealPart(ba[j]);
23506719d8e4SJed Brown             }
23516719d8e4SJed Brown             if (PetscAbsScalar(ca[j]) > PetscAbs(maxdiff)) {
23526719d8e4SJed Brown               maxdiffcol = bj[j];
23536719d8e4SJed Brown               maxdiff = PetscRealPart(ca[j]);
23546719d8e4SJed Brown             }
23556719d8e4SJed Brown             if (rdiff > maxrdiff) {
23566719d8e4SJed Brown               maxrdiffcol = bj[j];
23576719d8e4SJed Brown               maxrdiff = rdiff;
23586719d8e4SJed Brown             }
23596719d8e4SJed Brown           }
23606719d8e4SJed Brown           if (maxrdiff > 1) {
23616719d8e4SJed 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);
23626719d8e4SJed Brown             for (j=0; j<bn; j++) {
23636719d8e4SJed Brown               PetscReal rdiff;
23646719d8e4SJed Brown               rdiff = PetscAbsScalar(ca[j]) / (threshold_atol + threshold_rtol*PetscAbsScalar(ba[j]));
23656719d8e4SJed Brown               if (rdiff > 1) {
23666719d8e4SJed Brown                 ierr = PetscViewerASCIIPrintf(vstdout," (%D,%G:%G)",bj[j],PetscRealPart(ba[j]),PetscRealPart(ca[j]));CHKERRQ(ierr);
23676719d8e4SJed Brown               }
23686719d8e4SJed Brown             }
23696719d8e4SJed Brown             ierr = PetscViewerASCIIPrintf(vstdout,"\n",i,maxentry,maxdiff,maxrdiff);CHKERRQ(ierr);
23706719d8e4SJed Brown           }
23716719d8e4SJed Brown           ierr = MatRestoreRow(*B,i,&bn,&bj,&ba);CHKERRQ(ierr);
23726719d8e4SJed Brown           ierr = MatRestoreRow(Bfd,i,&cn,&cj,&ca);CHKERRQ(ierr);
23736719d8e4SJed Brown         }
23746719d8e4SJed Brown       }
23754c30e9fbSJed Brown       ierr = PetscViewerDestroy(&vdraw);CHKERRQ(ierr);
23764c30e9fbSJed Brown       ierr = MatDestroy(&Bfd);CHKERRQ(ierr);
23774c30e9fbSJed Brown     }
23784c30e9fbSJed Brown   }
23793a40ed3dSBarry Smith   PetscFunctionReturn(0);
23809b94acceSBarry Smith }
23819b94acceSBarry Smith 
23824a2ae208SSatish Balay #undef __FUNCT__
23834a2ae208SSatish Balay #define __FUNCT__ "SNESSetJacobian"
23849b94acceSBarry Smith /*@C
23859b94acceSBarry Smith    SNESSetJacobian - Sets the function to compute Jacobian as well as the
2386044dda88SLois Curfman McInnes    location to store the matrix.
23879b94acceSBarry Smith 
23883f9fe445SBarry Smith    Logically Collective on SNES and Mat
2389c7afd0dbSLois Curfman McInnes 
23909b94acceSBarry Smith    Input Parameters:
2391c7afd0dbSLois Curfman McInnes +  snes - the SNES context
23929b94acceSBarry Smith .  A - Jacobian matrix
23939b94acceSBarry Smith .  B - preconditioner matrix (usually same as the Jacobian)
2394efd51863SBarry Smith .  func - Jacobian evaluation routine (if PETSC_NULL then SNES retains any previously set value)
2395c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined context for private data for the
2396efd51863SBarry Smith          Jacobian evaluation routine (may be PETSC_NULL) (if PETSC_NULL then SNES retains any previously set value)
23979b94acceSBarry Smith 
23989b94acceSBarry Smith    Calling sequence of func:
23998d76a1e5SLois Curfman McInnes $     func (SNES snes,Vec x,Mat *A,Mat *B,int *flag,void *ctx);
24009b94acceSBarry Smith 
2401c7afd0dbSLois Curfman McInnes +  x - input vector
24029b94acceSBarry Smith .  A - Jacobian matrix
24039b94acceSBarry Smith .  B - preconditioner matrix, usually the same as A
2404ac21db08SLois Curfman McInnes .  flag - flag indicating information about the preconditioner matrix
24052b668275SBarry Smith    structure (same as flag in KSPSetOperators()), one of SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER
2406c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined Jacobian context
24079b94acceSBarry Smith 
24089b94acceSBarry Smith    Notes:
240994b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the flag
24102cd2dfdcSLois Curfman McInnes    output parameter in the routine func().  Be sure to read this information!
2411ac21db08SLois Curfman McInnes 
2412ac21db08SLois Curfman McInnes    The routine func() takes Mat * as the matrix arguments rather than Mat.
24139b94acceSBarry Smith    This allows the Jacobian evaluation routine to replace A and/or B with a
24149b94acceSBarry Smith    completely new new matrix structure (not just different matrix elements)
24159b94acceSBarry Smith    when appropriate, for instance, if the nonzero structure is changing
24169b94acceSBarry Smith    throughout the global iterations.
24179b94acceSBarry Smith 
241816913363SBarry Smith    If the A matrix and B matrix are different you must call MatAssemblyBegin/End() on
241916913363SBarry Smith    each matrix.
242016913363SBarry Smith 
2421a8a26c1eSJed Brown    If using SNESDefaultComputeJacobianColor() to assemble a Jacobian, the ctx argument
2422a8a26c1eSJed Brown    must be a MatFDColoring.
2423a8a26c1eSJed Brown 
2424c3cc8fd1SJed Brown    Other defect-correction schemes can be used by computing a different matrix in place of the Jacobian.  One common
2425c3cc8fd1SJed Brown    example is to use the "Picard linearization" which only differentiates through the highest order parts of each term.
2426c3cc8fd1SJed Brown 
242736851e7fSLois Curfman McInnes    Level: beginner
242836851e7fSLois Curfman McInnes 
24299b94acceSBarry Smith .keywords: SNES, nonlinear, set, Jacobian, matrix
24309b94acceSBarry Smith 
24313ec795f1SBarry Smith .seealso: KSPSetOperators(), SNESSetFunction(), MatMFFDComputeJacobian(), SNESDefaultComputeJacobianColor(), MatStructure
24329b94acceSBarry Smith @*/
24337087cfbeSBarry Smith PetscErrorCode  SNESSetJacobian(SNES snes,Mat A,Mat B,PetscErrorCode (*func)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *ctx)
24349b94acceSBarry Smith {
2435dfbe8321SBarry Smith   PetscErrorCode ierr;
24366cab3a1bSJed Brown   DM             dm;
24373a7fca6bSBarry Smith 
24383a40ed3dSBarry Smith   PetscFunctionBegin;
24390700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
24400700a824SBarry Smith   if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2);
24410700a824SBarry Smith   if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3);
2442c9780b6fSBarry Smith   if (A) PetscCheckSameComm(snes,1,A,2);
244306975374SJed Brown   if (B) PetscCheckSameComm(snes,1,B,3);
24446cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
24456cab3a1bSJed Brown   ierr = DMSNESSetJacobian(dm,func,ctx);CHKERRQ(ierr);
24463a7fca6bSBarry Smith   if (A) {
24477dcf0eaaSdalcinl     ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
24486bf464f9SBarry Smith     ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr);
24499b94acceSBarry Smith     snes->jacobian = A;
24503a7fca6bSBarry Smith   }
24513a7fca6bSBarry Smith   if (B) {
24527dcf0eaaSdalcinl     ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
24536bf464f9SBarry Smith     ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr);
24549b94acceSBarry Smith     snes->jacobian_pre = B;
24553a7fca6bSBarry Smith   }
24563a40ed3dSBarry Smith   PetscFunctionReturn(0);
24579b94acceSBarry Smith }
245862fef451SLois Curfman McInnes 
24594a2ae208SSatish Balay #undef __FUNCT__
24604a2ae208SSatish Balay #define __FUNCT__ "SNESGetJacobian"
2461c2aafc4cSSatish Balay /*@C
2462b4fd4287SBarry Smith    SNESGetJacobian - Returns the Jacobian matrix and optionally the user
2463b4fd4287SBarry Smith    provided context for evaluating the Jacobian.
2464b4fd4287SBarry Smith 
2465c7afd0dbSLois Curfman McInnes    Not Collective, but Mat object will be parallel if SNES object is
2466c7afd0dbSLois Curfman McInnes 
2467b4fd4287SBarry Smith    Input Parameter:
2468b4fd4287SBarry Smith .  snes - the nonlinear solver context
2469b4fd4287SBarry Smith 
2470b4fd4287SBarry Smith    Output Parameters:
2471c7afd0dbSLois Curfman McInnes +  A - location to stash Jacobian matrix (or PETSC_NULL)
2472b4fd4287SBarry Smith .  B - location to stash preconditioner matrix (or PETSC_NULL)
247370e92668SMatthew Knepley .  func - location to put Jacobian function (or PETSC_NULL)
247470e92668SMatthew Knepley -  ctx - location to stash Jacobian ctx (or PETSC_NULL)
2475fee21e36SBarry Smith 
247636851e7fSLois Curfman McInnes    Level: advanced
247736851e7fSLois Curfman McInnes 
2478b4fd4287SBarry Smith .seealso: SNESSetJacobian(), SNESComputeJacobian()
2479b4fd4287SBarry Smith @*/
24807087cfbeSBarry Smith PetscErrorCode SNESGetJacobian(SNES snes,Mat *A,Mat *B,PetscErrorCode (**func)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **ctx)
2481b4fd4287SBarry Smith {
24826cab3a1bSJed Brown   PetscErrorCode ierr;
24836cab3a1bSJed Brown   DM             dm;
2484942e3340SBarry Smith   DMSNES         sdm;
24856cab3a1bSJed Brown 
24863a40ed3dSBarry Smith   PetscFunctionBegin;
24870700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2488b4fd4287SBarry Smith   if (A)    *A    = snes->jacobian;
2489b4fd4287SBarry Smith   if (B)    *B    = snes->jacobian_pre;
24906cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
2491942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
249222c6f798SBarry Smith   if (func) *func = sdm->ops->computejacobian;
24936cab3a1bSJed Brown   if (ctx)  *ctx  = sdm->jacobianctx;
24943a40ed3dSBarry Smith   PetscFunctionReturn(0);
2495b4fd4287SBarry Smith }
2496b4fd4287SBarry Smith 
24979b94acceSBarry Smith /* ----- Routines to initialize and destroy a nonlinear solver ---- */
24989b94acceSBarry Smith 
24994a2ae208SSatish Balay #undef __FUNCT__
25004a2ae208SSatish Balay #define __FUNCT__ "SNESSetUp"
25019b94acceSBarry Smith /*@
25029b94acceSBarry Smith    SNESSetUp - Sets up the internal data structures for the later use
2503272ac6f2SLois Curfman McInnes    of a nonlinear solver.
25049b94acceSBarry Smith 
2505fee21e36SBarry Smith    Collective on SNES
2506fee21e36SBarry Smith 
2507c7afd0dbSLois Curfman McInnes    Input Parameters:
250870e92668SMatthew Knepley .  snes - the SNES context
2509c7afd0dbSLois Curfman McInnes 
2510272ac6f2SLois Curfman McInnes    Notes:
2511272ac6f2SLois Curfman McInnes    For basic use of the SNES solvers the user need not explicitly call
2512272ac6f2SLois Curfman McInnes    SNESSetUp(), since these actions will automatically occur during
2513272ac6f2SLois Curfman McInnes    the call to SNESSolve().  However, if one wishes to control this
2514272ac6f2SLois Curfman McInnes    phase separately, SNESSetUp() should be called after SNESCreate()
2515272ac6f2SLois Curfman McInnes    and optional routines of the form SNESSetXXX(), but before SNESSolve().
2516272ac6f2SLois Curfman McInnes 
251736851e7fSLois Curfman McInnes    Level: advanced
251836851e7fSLois Curfman McInnes 
25199b94acceSBarry Smith .keywords: SNES, nonlinear, setup
25209b94acceSBarry Smith 
25219b94acceSBarry Smith .seealso: SNESCreate(), SNESSolve(), SNESDestroy()
25229b94acceSBarry Smith @*/
25237087cfbeSBarry Smith PetscErrorCode  SNESSetUp(SNES snes)
25249b94acceSBarry Smith {
2525dfbe8321SBarry Smith   PetscErrorCode              ierr;
25266cab3a1bSJed Brown   DM                          dm;
2527942e3340SBarry Smith   DMSNES                      sdm;
2528c35f09e5SBarry Smith   SNESLineSearch              linesearch, pclinesearch;
25296e2a1849SPeter Brune   void                        *lsprectx,*lspostctx;
25306e2a1849SPeter Brune   SNESLineSearchPreCheckFunc  lsprefunc;
25316e2a1849SPeter Brune   SNESLineSearchPostCheckFunc lspostfunc;
25326e2a1849SPeter Brune   PetscErrorCode              (*func)(SNES,Vec,Vec,void*);
25336e2a1849SPeter Brune   Vec                         f,fpc;
25346e2a1849SPeter Brune   void                        *funcctx;
25356e2a1849SPeter Brune   PetscErrorCode              (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
25361eb13d49SPeter Brune   void                        *jacctx,*appctx;
25376e2a1849SPeter Brune   Mat                         A,B;
25383a40ed3dSBarry Smith 
25393a40ed3dSBarry Smith   PetscFunctionBegin;
25400700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
25414dc4c822SBarry Smith   if (snes->setupcalled) PetscFunctionReturn(0);
25429b94acceSBarry Smith 
25437adad957SLisandro Dalcin   if (!((PetscObject)snes)->type_name) {
254404d7464bSBarry Smith     ierr = SNESSetType(snes,SNESNEWTONLS);CHKERRQ(ierr);
254585385478SLisandro Dalcin   }
254685385478SLisandro Dalcin 
2547a63bb30eSJed Brown   ierr = SNESGetFunction(snes,&snes->vec_func,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
254817186662SBarry Smith   if (snes->vec_func == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be function vector");
254958c9b817SLisandro Dalcin   if (snes->vec_rhs  == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be right hand side vector");
255058c9b817SLisandro Dalcin 
255158c9b817SLisandro Dalcin   if (!snes->vec_sol_update /* && snes->vec_sol */) {
255258c9b817SLisandro Dalcin     ierr = VecDuplicate(snes->vec_sol,&snes->vec_sol_update);CHKERRQ(ierr);
255358c9b817SLisandro Dalcin     ierr = PetscLogObjectParent(snes,snes->vec_sol_update);CHKERRQ(ierr);
255458c9b817SLisandro Dalcin   }
255558c9b817SLisandro Dalcin 
25566cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
2557d8f46077SPeter Brune   ierr = DMShellSetGlobalVector(snes->dm,snes->vec_sol);CHKERRQ(ierr);
2558942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
255922c6f798SBarry Smith   if (!sdm->ops->computefunction) SETERRQ(((PetscObject)dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"Function never provided to SNES object");
256022c6f798SBarry Smith   if (!sdm->ops->computejacobian) {
256119f7a02aSBarry Smith     ierr = DMSNESSetJacobian(dm,SNESDefaultComputeJacobianColor,PETSC_NULL);CHKERRQ(ierr);
256219f7a02aSBarry Smith   }
25636cab3a1bSJed Brown   if (!snes->vec_func) {
25646cab3a1bSJed Brown     ierr = DMCreateGlobalVector(dm,&snes->vec_func);CHKERRQ(ierr);
2565214df951SJed Brown   }
2566efd51863SBarry Smith 
2567b710008aSBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes, &snes->ksp);CHKERRQ(ierr);}
2568b710008aSBarry Smith 
2569f1c6b773SPeter Brune   if (!snes->linesearch) {ierr = SNESGetSNESLineSearch(snes, &snes->linesearch);}
25709e764e56SPeter Brune 
2571*172a4300SPeter Brune   if (snes->pc && (snes->pcside == PC_LEFT)) {
2572*172a4300SPeter Brune     snes->mf = PETSC_TRUE;
2573*172a4300SPeter Brune     snes->mf_operator = PETSC_FALSE;
2574*172a4300SPeter Brune   }
2575d8f46077SPeter Brune 
257628a52e04SBarry Smith   if (snes->mf) {
257728a52e04SBarry Smith     ierr = SNESSetUpMatrixFree_Private(snes, snes->mf_operator, snes->mf_version);CHKERRQ(ierr);
257828a52e04SBarry Smith   }
2579d8f46077SPeter Brune 
2580d25893d9SBarry Smith   if (snes->ops->usercompute && !snes->user) {
2581d25893d9SBarry Smith     ierr = (*snes->ops->usercompute)(snes,(void**)&snes->user);CHKERRQ(ierr);
2582d25893d9SBarry Smith   }
2583d25893d9SBarry Smith 
25846e2a1849SPeter Brune   if (snes->pc) {
25856e2a1849SPeter Brune     /* copy the DM over */
25866e2a1849SPeter Brune     ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
25876e2a1849SPeter Brune     ierr = SNESSetDM(snes->pc,dm);CHKERRQ(ierr);
25886e2a1849SPeter Brune 
25896e2a1849SPeter Brune     ierr = SNESGetFunction(snes,&f,&func,&funcctx);CHKERRQ(ierr);
25906e2a1849SPeter Brune     ierr = VecDuplicate(f,&fpc);CHKERRQ(ierr);
25916e2a1849SPeter Brune     ierr = SNESSetFunction(snes->pc,fpc,func,funcctx);CHKERRQ(ierr);
25926e2a1849SPeter Brune     ierr = SNESGetJacobian(snes,&A,&B,&jac,&jacctx);CHKERRQ(ierr);
25936e2a1849SPeter Brune     ierr = SNESSetJacobian(snes->pc,A,B,jac,jacctx);CHKERRQ(ierr);
25941eb13d49SPeter Brune     ierr = SNESGetApplicationContext(snes,&appctx);CHKERRQ(ierr);
25951eb13d49SPeter Brune     ierr = SNESSetApplicationContext(snes->pc,appctx);CHKERRQ(ierr);
25966e2a1849SPeter Brune     ierr = VecDestroy(&fpc);CHKERRQ(ierr);
25976e2a1849SPeter Brune 
25986e2a1849SPeter Brune     /* copy the function pointers over */
25996e2a1849SPeter Brune     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)snes,(PetscObject)snes->pc);CHKERRQ(ierr);
26006e2a1849SPeter Brune 
26016e2a1849SPeter Brune      /* default to 1 iteration */
2602140836e4SPeter Brune     ierr = SNESSetTolerances(snes->pc, 0.0, 0.0, 0.0, 1, snes->pc->max_funcs);CHKERRQ(ierr);
26036e2a1849SPeter Brune     ierr = SNESSetNormType(snes->pc, SNES_NORM_FINAL_ONLY);CHKERRQ(ierr);
26046e2a1849SPeter Brune     ierr = SNESSetFromOptions(snes->pc);CHKERRQ(ierr);
26056e2a1849SPeter Brune 
26066e2a1849SPeter Brune     /* copy the line search context over */
26076e2a1849SPeter Brune     ierr = SNESGetSNESLineSearch(snes,&linesearch);CHKERRQ(ierr);
26086e2a1849SPeter Brune     ierr = SNESGetSNESLineSearch(snes->pc,&pclinesearch);CHKERRQ(ierr);
26096e2a1849SPeter Brune     ierr = SNESLineSearchGetPreCheck(linesearch,&lsprefunc,&lsprectx);CHKERRQ(ierr);
26106e2a1849SPeter Brune     ierr = SNESLineSearchGetPostCheck(linesearch,&lspostfunc,&lspostctx);CHKERRQ(ierr);
26116e2a1849SPeter Brune     ierr = SNESLineSearchSetPreCheck(pclinesearch,lsprefunc,lsprectx);CHKERRQ(ierr);
26126e2a1849SPeter Brune     ierr = SNESLineSearchSetPostCheck(pclinesearch,lspostfunc,lspostctx);CHKERRQ(ierr);
26136e2a1849SPeter Brune     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)linesearch, (PetscObject)pclinesearch);CHKERRQ(ierr);
26146e2a1849SPeter Brune   }
26156e2a1849SPeter Brune 
2616410397dcSLisandro Dalcin   if (snes->ops->setup) {
2617410397dcSLisandro Dalcin     ierr = (*snes->ops->setup)(snes);CHKERRQ(ierr);
2618410397dcSLisandro Dalcin   }
261958c9b817SLisandro Dalcin 
26207aaed0d8SBarry Smith   snes->setupcalled = PETSC_TRUE;
26213a40ed3dSBarry Smith   PetscFunctionReturn(0);
26229b94acceSBarry Smith }
26239b94acceSBarry Smith 
26244a2ae208SSatish Balay #undef __FUNCT__
262537596af1SLisandro Dalcin #define __FUNCT__ "SNESReset"
262637596af1SLisandro Dalcin /*@
262737596af1SLisandro Dalcin    SNESReset - Resets a SNES context to the snessetupcalled = 0 state and removes any allocated Vecs and Mats
262837596af1SLisandro Dalcin 
262937596af1SLisandro Dalcin    Collective on SNES
263037596af1SLisandro Dalcin 
263137596af1SLisandro Dalcin    Input Parameter:
263237596af1SLisandro Dalcin .  snes - iterative context obtained from SNESCreate()
263337596af1SLisandro Dalcin 
2634d25893d9SBarry Smith    Level: intermediate
2635d25893d9SBarry Smith 
2636d25893d9SBarry Smith    Notes: Also calls the application context destroy routine set with SNESSetComputeApplicationContext()
263737596af1SLisandro Dalcin 
263837596af1SLisandro Dalcin .keywords: SNES, destroy
263937596af1SLisandro Dalcin 
264037596af1SLisandro Dalcin .seealso: SNESCreate(), SNESSetUp(), SNESSolve()
264137596af1SLisandro Dalcin @*/
264237596af1SLisandro Dalcin PetscErrorCode  SNESReset(SNES snes)
264337596af1SLisandro Dalcin {
264437596af1SLisandro Dalcin   PetscErrorCode ierr;
264537596af1SLisandro Dalcin 
264637596af1SLisandro Dalcin   PetscFunctionBegin;
264737596af1SLisandro Dalcin   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2648d25893d9SBarry Smith   if (snes->ops->userdestroy && snes->user) {
2649d25893d9SBarry Smith     ierr       = (*snes->ops->userdestroy)((void**)&snes->user);CHKERRQ(ierr);
2650d25893d9SBarry Smith     snes->user = PETSC_NULL;
2651d25893d9SBarry Smith   }
26528a23116dSBarry Smith   if (snes->pc) {
26538a23116dSBarry Smith     ierr = SNESReset(snes->pc);CHKERRQ(ierr);
26548a23116dSBarry Smith   }
26558a23116dSBarry Smith 
265637596af1SLisandro Dalcin   if (snes->ops->reset) {
265737596af1SLisandro Dalcin     ierr = (*snes->ops->reset)(snes);CHKERRQ(ierr);
265837596af1SLisandro Dalcin   }
26599e764e56SPeter Brune   if (snes->ksp) {
26609e764e56SPeter Brune     ierr = KSPReset(snes->ksp);CHKERRQ(ierr);
26619e764e56SPeter Brune   }
26629e764e56SPeter Brune 
26639e764e56SPeter Brune   if (snes->linesearch) {
2664f1c6b773SPeter Brune     ierr = SNESLineSearchReset(snes->linesearch);CHKERRQ(ierr);
26659e764e56SPeter Brune   }
26669e764e56SPeter Brune 
26676bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr);
26686bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr);
26696bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_sol_update);CHKERRQ(ierr);
26706bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr);
26716bf464f9SBarry Smith   ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr);
26726bf464f9SBarry Smith   ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr);
2673c41d97abSJed Brown   ierr = VecDestroyVecs(snes->nwork,&snes->work);CHKERRQ(ierr);
2674c41d97abSJed Brown   ierr = VecDestroyVecs(snes->nvwork,&snes->vwork);CHKERRQ(ierr);
267537596af1SLisandro Dalcin   snes->nwork = snes->nvwork = 0;
267637596af1SLisandro Dalcin   snes->setupcalled = PETSC_FALSE;
267737596af1SLisandro Dalcin   PetscFunctionReturn(0);
267837596af1SLisandro Dalcin }
267937596af1SLisandro Dalcin 
268037596af1SLisandro Dalcin #undef __FUNCT__
26814a2ae208SSatish Balay #define __FUNCT__ "SNESDestroy"
268252baeb72SSatish Balay /*@
26839b94acceSBarry Smith    SNESDestroy - Destroys the nonlinear solver context that was created
26849b94acceSBarry Smith    with SNESCreate().
26859b94acceSBarry Smith 
2686c7afd0dbSLois Curfman McInnes    Collective on SNES
2687c7afd0dbSLois Curfman McInnes 
26889b94acceSBarry Smith    Input Parameter:
26899b94acceSBarry Smith .  snes - the SNES context
26909b94acceSBarry Smith 
269136851e7fSLois Curfman McInnes    Level: beginner
269236851e7fSLois Curfman McInnes 
26939b94acceSBarry Smith .keywords: SNES, nonlinear, destroy
26949b94acceSBarry Smith 
269563a78c88SLois Curfman McInnes .seealso: SNESCreate(), SNESSolve()
26969b94acceSBarry Smith @*/
26976bf464f9SBarry Smith PetscErrorCode  SNESDestroy(SNES *snes)
26989b94acceSBarry Smith {
26996849ba73SBarry Smith   PetscErrorCode ierr;
27003a40ed3dSBarry Smith 
27013a40ed3dSBarry Smith   PetscFunctionBegin;
27026bf464f9SBarry Smith   if (!*snes) PetscFunctionReturn(0);
27036bf464f9SBarry Smith   PetscValidHeaderSpecific((*snes),SNES_CLASSID,1);
27046bf464f9SBarry Smith   if (--((PetscObject)(*snes))->refct > 0) {*snes = 0; PetscFunctionReturn(0);}
2705d4bb536fSBarry Smith 
27066bf464f9SBarry Smith   ierr = SNESReset((*snes));CHKERRQ(ierr);
27078a23116dSBarry Smith   ierr = SNESDestroy(&(*snes)->pc);CHKERRQ(ierr);
27086b8b9a38SLisandro Dalcin 
2709be0abb6dSBarry Smith   /* if memory was published with AMS then destroy it */
27106bf464f9SBarry Smith   ierr = PetscObjectDepublish((*snes));CHKERRQ(ierr);
27116bf464f9SBarry Smith   if ((*snes)->ops->destroy) {ierr = (*((*snes))->ops->destroy)((*snes));CHKERRQ(ierr);}
27126d4c513bSLisandro Dalcin 
27136bf464f9SBarry Smith   ierr = DMDestroy(&(*snes)->dm);CHKERRQ(ierr);
27146bf464f9SBarry Smith   ierr = KSPDestroy(&(*snes)->ksp);CHKERRQ(ierr);
2715f1c6b773SPeter Brune   ierr = SNESLineSearchDestroy(&(*snes)->linesearch);CHKERRQ(ierr);
27166b8b9a38SLisandro Dalcin 
27176bf464f9SBarry Smith   ierr = PetscFree((*snes)->kspconvctx);CHKERRQ(ierr);
27186bf464f9SBarry Smith   if ((*snes)->ops->convergeddestroy) {
27196bf464f9SBarry Smith     ierr = (*(*snes)->ops->convergeddestroy)((*snes)->cnvP);CHKERRQ(ierr);
27206b8b9a38SLisandro Dalcin   }
27216bf464f9SBarry Smith   if ((*snes)->conv_malloc) {
27226bf464f9SBarry Smith     ierr = PetscFree((*snes)->conv_hist);CHKERRQ(ierr);
27236bf464f9SBarry Smith     ierr = PetscFree((*snes)->conv_hist_its);CHKERRQ(ierr);
272458c9b817SLisandro Dalcin   }
27256bf464f9SBarry Smith   ierr = SNESMonitorCancel((*snes));CHKERRQ(ierr);
2726a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(snes);CHKERRQ(ierr);
27273a40ed3dSBarry Smith  PetscFunctionReturn(0);
27289b94acceSBarry Smith }
27299b94acceSBarry Smith 
27309b94acceSBarry Smith /* ----------- Routines to set solver parameters ---------- */
27319b94acceSBarry Smith 
27324a2ae208SSatish Balay #undef __FUNCT__
2733a8054027SBarry Smith #define __FUNCT__ "SNESSetLagPreconditioner"
2734a8054027SBarry Smith /*@
2735a8054027SBarry Smith    SNESSetLagPreconditioner - Determines when the preconditioner is rebuilt in the nonlinear solve.
2736a8054027SBarry Smith 
27373f9fe445SBarry Smith    Logically Collective on SNES
2738a8054027SBarry Smith 
2739a8054027SBarry Smith    Input Parameters:
2740a8054027SBarry Smith +  snes - the SNES context
2741a8054027SBarry 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
27423b4f5425SBarry Smith          the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that
2743a8054027SBarry Smith 
2744a8054027SBarry Smith    Options Database Keys:
2745a8054027SBarry Smith .    -snes_lag_preconditioner <lag>
2746a8054027SBarry Smith 
2747a8054027SBarry Smith    Notes:
2748a8054027SBarry Smith    The default is 1
2749a8054027SBarry Smith    The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
2750a8054027SBarry Smith    If  -1 is used before the very first nonlinear solve the preconditioner is still built because there is no previous preconditioner to use
2751a8054027SBarry Smith 
2752a8054027SBarry Smith    Level: intermediate
2753a8054027SBarry Smith 
2754a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
2755a8054027SBarry Smith 
2756e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian()
2757a8054027SBarry Smith 
2758a8054027SBarry Smith @*/
27597087cfbeSBarry Smith PetscErrorCode  SNESSetLagPreconditioner(SNES snes,PetscInt lag)
2760a8054027SBarry Smith {
2761a8054027SBarry Smith   PetscFunctionBegin;
27620700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2763e32f2f54SBarry Smith   if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater");
2764e32f2f54SBarry Smith   if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0");
2765c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,lag,2);
2766a8054027SBarry Smith   snes->lagpreconditioner = lag;
2767a8054027SBarry Smith   PetscFunctionReturn(0);
2768a8054027SBarry Smith }
2769a8054027SBarry Smith 
2770a8054027SBarry Smith #undef __FUNCT__
2771efd51863SBarry Smith #define __FUNCT__ "SNESSetGridSequence"
2772efd51863SBarry Smith /*@
2773efd51863SBarry Smith    SNESSetGridSequence - sets the number of steps of grid sequencing that SNES does
2774efd51863SBarry Smith 
2775efd51863SBarry Smith    Logically Collective on SNES
2776efd51863SBarry Smith 
2777efd51863SBarry Smith    Input Parameters:
2778efd51863SBarry Smith +  snes - the SNES context
2779efd51863SBarry Smith -  steps - the number of refinements to do, defaults to 0
2780efd51863SBarry Smith 
2781efd51863SBarry Smith    Options Database Keys:
2782efd51863SBarry Smith .    -snes_grid_sequence <steps>
2783efd51863SBarry Smith 
2784efd51863SBarry Smith    Level: intermediate
2785efd51863SBarry Smith 
2786c0df2a02SJed Brown    Notes:
2787c0df2a02SJed Brown    Use SNESGetSolution() to extract the fine grid solution after grid sequencing.
2788c0df2a02SJed Brown 
2789efd51863SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
2790efd51863SBarry Smith 
2791efd51863SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian()
2792efd51863SBarry Smith 
2793efd51863SBarry Smith @*/
2794efd51863SBarry Smith PetscErrorCode  SNESSetGridSequence(SNES snes,PetscInt steps)
2795efd51863SBarry Smith {
2796efd51863SBarry Smith   PetscFunctionBegin;
2797efd51863SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2798efd51863SBarry Smith   PetscValidLogicalCollectiveInt(snes,steps,2);
2799efd51863SBarry Smith   snes->gridsequence = steps;
2800efd51863SBarry Smith   PetscFunctionReturn(0);
2801efd51863SBarry Smith }
2802efd51863SBarry Smith 
2803efd51863SBarry Smith #undef __FUNCT__
2804a8054027SBarry Smith #define __FUNCT__ "SNESGetLagPreconditioner"
2805a8054027SBarry Smith /*@
2806a8054027SBarry Smith    SNESGetLagPreconditioner - Indicates how often the preconditioner is rebuilt
2807a8054027SBarry Smith 
28083f9fe445SBarry Smith    Not Collective
2809a8054027SBarry Smith 
2810a8054027SBarry Smith    Input Parameter:
2811a8054027SBarry Smith .  snes - the SNES context
2812a8054027SBarry Smith 
2813a8054027SBarry Smith    Output Parameter:
2814a8054027SBarry 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
28153b4f5425SBarry Smith          the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that
2816a8054027SBarry Smith 
2817a8054027SBarry Smith    Options Database Keys:
2818a8054027SBarry Smith .    -snes_lag_preconditioner <lag>
2819a8054027SBarry Smith 
2820a8054027SBarry Smith    Notes:
2821a8054027SBarry Smith    The default is 1
2822a8054027SBarry Smith    The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
2823a8054027SBarry Smith 
2824a8054027SBarry Smith    Level: intermediate
2825a8054027SBarry Smith 
2826a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
2827a8054027SBarry Smith 
2828a8054027SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagPreconditioner()
2829a8054027SBarry Smith 
2830a8054027SBarry Smith @*/
28317087cfbeSBarry Smith PetscErrorCode  SNESGetLagPreconditioner(SNES snes,PetscInt *lag)
2832a8054027SBarry Smith {
2833a8054027SBarry Smith   PetscFunctionBegin;
28340700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2835a8054027SBarry Smith   *lag = snes->lagpreconditioner;
2836a8054027SBarry Smith   PetscFunctionReturn(0);
2837a8054027SBarry Smith }
2838a8054027SBarry Smith 
2839a8054027SBarry Smith #undef __FUNCT__
2840e35cf81dSBarry Smith #define __FUNCT__ "SNESSetLagJacobian"
2841e35cf81dSBarry Smith /*@
2842e35cf81dSBarry Smith    SNESSetLagJacobian - Determines when the Jacobian is rebuilt in the nonlinear solve. See SNESSetLagPreconditioner() for determining how
2843e35cf81dSBarry Smith      often the preconditioner is rebuilt.
2844e35cf81dSBarry Smith 
28453f9fe445SBarry Smith    Logically Collective on SNES
2846e35cf81dSBarry Smith 
2847e35cf81dSBarry Smith    Input Parameters:
2848e35cf81dSBarry Smith +  snes - the SNES context
2849e35cf81dSBarry 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
2850fe3ffe1eSBarry Smith          the Jacobian is built etc. -2 means rebuild at next chance but then never again
2851e35cf81dSBarry Smith 
2852e35cf81dSBarry Smith    Options Database Keys:
2853e35cf81dSBarry Smith .    -snes_lag_jacobian <lag>
2854e35cf81dSBarry Smith 
2855e35cf81dSBarry Smith    Notes:
2856e35cf81dSBarry Smith    The default is 1
2857e35cf81dSBarry Smith    The Jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
2858fe3ffe1eSBarry 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
2859fe3ffe1eSBarry Smith    at the next Newton step but never again (unless it is reset to another value)
2860e35cf81dSBarry Smith 
2861e35cf81dSBarry Smith    Level: intermediate
2862e35cf81dSBarry Smith 
2863e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
2864e35cf81dSBarry Smith 
2865e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagPreconditioner(), SNESGetLagJacobian()
2866e35cf81dSBarry Smith 
2867e35cf81dSBarry Smith @*/
28687087cfbeSBarry Smith PetscErrorCode  SNESSetLagJacobian(SNES snes,PetscInt lag)
2869e35cf81dSBarry Smith {
2870e35cf81dSBarry Smith   PetscFunctionBegin;
28710700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2872e32f2f54SBarry Smith   if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater");
2873e32f2f54SBarry Smith   if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0");
2874c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,lag,2);
2875e35cf81dSBarry Smith   snes->lagjacobian = lag;
2876e35cf81dSBarry Smith   PetscFunctionReturn(0);
2877e35cf81dSBarry Smith }
2878e35cf81dSBarry Smith 
2879e35cf81dSBarry Smith #undef __FUNCT__
2880e35cf81dSBarry Smith #define __FUNCT__ "SNESGetLagJacobian"
2881e35cf81dSBarry Smith /*@
2882e35cf81dSBarry Smith    SNESGetLagJacobian - Indicates how often the Jacobian is rebuilt. See SNESGetLagPreconditioner() to determine when the preconditioner is rebuilt
2883e35cf81dSBarry Smith 
28843f9fe445SBarry Smith    Not Collective
2885e35cf81dSBarry Smith 
2886e35cf81dSBarry Smith    Input Parameter:
2887e35cf81dSBarry Smith .  snes - the SNES context
2888e35cf81dSBarry Smith 
2889e35cf81dSBarry Smith    Output Parameter:
2890e35cf81dSBarry 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
2891e35cf81dSBarry Smith          the Jacobian is built etc.
2892e35cf81dSBarry Smith 
2893e35cf81dSBarry Smith    Options Database Keys:
2894e35cf81dSBarry Smith .    -snes_lag_jacobian <lag>
2895e35cf81dSBarry Smith 
2896e35cf81dSBarry Smith    Notes:
2897e35cf81dSBarry Smith    The default is 1
2898e35cf81dSBarry Smith    The jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
2899e35cf81dSBarry Smith 
2900e35cf81dSBarry Smith    Level: intermediate
2901e35cf81dSBarry Smith 
2902e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
2903e35cf81dSBarry Smith 
2904e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagJacobian(), SNESSetLagPreconditioner(), SNESGetLagPreconditioner()
2905e35cf81dSBarry Smith 
2906e35cf81dSBarry Smith @*/
29077087cfbeSBarry Smith PetscErrorCode  SNESGetLagJacobian(SNES snes,PetscInt *lag)
2908e35cf81dSBarry Smith {
2909e35cf81dSBarry Smith   PetscFunctionBegin;
29100700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2911e35cf81dSBarry Smith   *lag = snes->lagjacobian;
2912e35cf81dSBarry Smith   PetscFunctionReturn(0);
2913e35cf81dSBarry Smith }
2914e35cf81dSBarry Smith 
2915e35cf81dSBarry Smith #undef __FUNCT__
29164a2ae208SSatish Balay #define __FUNCT__ "SNESSetTolerances"
29179b94acceSBarry Smith /*@
2918d7a720efSLois Curfman McInnes    SNESSetTolerances - Sets various parameters used in convergence tests.
29199b94acceSBarry Smith 
29203f9fe445SBarry Smith    Logically Collective on SNES
2921c7afd0dbSLois Curfman McInnes 
29229b94acceSBarry Smith    Input Parameters:
2923c7afd0dbSLois Curfman McInnes +  snes - the SNES context
292470441072SBarry Smith .  abstol - absolute convergence tolerance
292533174efeSLois Curfman McInnes .  rtol - relative convergence tolerance
29265358d0d4SBarry Smith .  stol -  convergence tolerance in terms of the norm of the change in the solution between steps,  || delta x || < stol*|| x ||
292733174efeSLois Curfman McInnes .  maxit - maximum number of iterations
2928c7afd0dbSLois Curfman McInnes -  maxf - maximum number of function evaluations
2929fee21e36SBarry Smith 
293033174efeSLois Curfman McInnes    Options Database Keys:
293170441072SBarry Smith +    -snes_atol <abstol> - Sets abstol
2932c7afd0dbSLois Curfman McInnes .    -snes_rtol <rtol> - Sets rtol
2933c7afd0dbSLois Curfman McInnes .    -snes_stol <stol> - Sets stol
2934c7afd0dbSLois Curfman McInnes .    -snes_max_it <maxit> - Sets maxit
2935c7afd0dbSLois Curfman McInnes -    -snes_max_funcs <maxf> - Sets maxf
29369b94acceSBarry Smith 
2937d7a720efSLois Curfman McInnes    Notes:
29389b94acceSBarry Smith    The default maximum number of iterations is 50.
29399b94acceSBarry Smith    The default maximum number of function evaluations is 1000.
29409b94acceSBarry Smith 
294136851e7fSLois Curfman McInnes    Level: intermediate
294236851e7fSLois Curfman McInnes 
294333174efeSLois Curfman McInnes .keywords: SNES, nonlinear, set, convergence, tolerances
29449b94acceSBarry Smith 
29452492ecdbSBarry Smith .seealso: SNESSetTrustRegionTolerance()
29469b94acceSBarry Smith @*/
29477087cfbeSBarry Smith PetscErrorCode  SNESSetTolerances(SNES snes,PetscReal abstol,PetscReal rtol,PetscReal stol,PetscInt maxit,PetscInt maxf)
29489b94acceSBarry Smith {
29493a40ed3dSBarry Smith   PetscFunctionBegin;
29500700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2951c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,abstol,2);
2952c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol,3);
2953c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,stol,4);
2954c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxit,5);
2955c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxf,6);
2956c5eb9154SBarry Smith 
2957ab54825eSJed Brown   if (abstol != PETSC_DEFAULT) {
2958ab54825eSJed Brown     if (abstol < 0.0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Absolute tolerance %G must be non-negative",abstol);
2959ab54825eSJed Brown     snes->abstol = abstol;
2960ab54825eSJed Brown   }
2961ab54825eSJed Brown   if (rtol != PETSC_DEFAULT) {
2962ab54825eSJed 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);
2963ab54825eSJed Brown     snes->rtol = rtol;
2964ab54825eSJed Brown   }
2965ab54825eSJed Brown   if (stol != PETSC_DEFAULT) {
2966ab54825eSJed Brown     if (stol < 0.0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Step tolerance %G must be non-negative",stol);
2967c60f73f4SPeter Brune     snes->stol = stol;
2968ab54825eSJed Brown   }
2969ab54825eSJed Brown   if (maxit != PETSC_DEFAULT) {
2970ab54825eSJed Brown     if (maxit < 0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of iterations %D must be non-negative",maxit);
2971ab54825eSJed Brown     snes->max_its = maxit;
2972ab54825eSJed Brown   }
2973ab54825eSJed Brown   if (maxf != PETSC_DEFAULT) {
2974ab54825eSJed Brown     if (maxf < 0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of function evaluations %D must be non-negative",maxf);
2975ab54825eSJed Brown     snes->max_funcs = maxf;
2976ab54825eSJed Brown   }
297788976e71SPeter Brune   snes->tolerancesset = PETSC_TRUE;
29783a40ed3dSBarry Smith   PetscFunctionReturn(0);
29799b94acceSBarry Smith }
29809b94acceSBarry Smith 
29814a2ae208SSatish Balay #undef __FUNCT__
29824a2ae208SSatish Balay #define __FUNCT__ "SNESGetTolerances"
29839b94acceSBarry Smith /*@
298433174efeSLois Curfman McInnes    SNESGetTolerances - Gets various parameters used in convergence tests.
298533174efeSLois Curfman McInnes 
2986c7afd0dbSLois Curfman McInnes    Not Collective
2987c7afd0dbSLois Curfman McInnes 
298833174efeSLois Curfman McInnes    Input Parameters:
2989c7afd0dbSLois Curfman McInnes +  snes - the SNES context
299085385478SLisandro Dalcin .  atol - absolute convergence tolerance
299133174efeSLois Curfman McInnes .  rtol - relative convergence tolerance
299233174efeSLois Curfman McInnes .  stol -  convergence tolerance in terms of the norm
299333174efeSLois Curfman McInnes            of the change in the solution between steps
299433174efeSLois Curfman McInnes .  maxit - maximum number of iterations
2995c7afd0dbSLois Curfman McInnes -  maxf - maximum number of function evaluations
2996fee21e36SBarry Smith 
299733174efeSLois Curfman McInnes    Notes:
299833174efeSLois Curfman McInnes    The user can specify PETSC_NULL for any parameter that is not needed.
299933174efeSLois Curfman McInnes 
300036851e7fSLois Curfman McInnes    Level: intermediate
300136851e7fSLois Curfman McInnes 
300233174efeSLois Curfman McInnes .keywords: SNES, nonlinear, get, convergence, tolerances
300333174efeSLois Curfman McInnes 
300433174efeSLois Curfman McInnes .seealso: SNESSetTolerances()
300533174efeSLois Curfman McInnes @*/
30067087cfbeSBarry Smith PetscErrorCode  SNESGetTolerances(SNES snes,PetscReal *atol,PetscReal *rtol,PetscReal *stol,PetscInt *maxit,PetscInt *maxf)
300733174efeSLois Curfman McInnes {
30083a40ed3dSBarry Smith   PetscFunctionBegin;
30090700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
301085385478SLisandro Dalcin   if (atol)  *atol  = snes->abstol;
301133174efeSLois Curfman McInnes   if (rtol)  *rtol  = snes->rtol;
3012c60f73f4SPeter Brune   if (stol)  *stol  = snes->stol;
301333174efeSLois Curfman McInnes   if (maxit) *maxit = snes->max_its;
301433174efeSLois Curfman McInnes   if (maxf)  *maxf  = snes->max_funcs;
30153a40ed3dSBarry Smith   PetscFunctionReturn(0);
301633174efeSLois Curfman McInnes }
301733174efeSLois Curfman McInnes 
30184a2ae208SSatish Balay #undef __FUNCT__
30194a2ae208SSatish Balay #define __FUNCT__ "SNESSetTrustRegionTolerance"
302033174efeSLois Curfman McInnes /*@
30219b94acceSBarry Smith    SNESSetTrustRegionTolerance - Sets the trust region parameter tolerance.
30229b94acceSBarry Smith 
30233f9fe445SBarry Smith    Logically Collective on SNES
3024fee21e36SBarry Smith 
3025c7afd0dbSLois Curfman McInnes    Input Parameters:
3026c7afd0dbSLois Curfman McInnes +  snes - the SNES context
3027c7afd0dbSLois Curfman McInnes -  tol - tolerance
3028c7afd0dbSLois Curfman McInnes 
30299b94acceSBarry Smith    Options Database Key:
3030c7afd0dbSLois Curfman McInnes .  -snes_trtol <tol> - Sets tol
30319b94acceSBarry Smith 
303236851e7fSLois Curfman McInnes    Level: intermediate
303336851e7fSLois Curfman McInnes 
30349b94acceSBarry Smith .keywords: SNES, nonlinear, set, trust region, tolerance
30359b94acceSBarry Smith 
30362492ecdbSBarry Smith .seealso: SNESSetTolerances()
30379b94acceSBarry Smith @*/
30387087cfbeSBarry Smith PetscErrorCode  SNESSetTrustRegionTolerance(SNES snes,PetscReal tol)
30399b94acceSBarry Smith {
30403a40ed3dSBarry Smith   PetscFunctionBegin;
30410700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3042c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,tol,2);
30439b94acceSBarry Smith   snes->deltatol = tol;
30443a40ed3dSBarry Smith   PetscFunctionReturn(0);
30459b94acceSBarry Smith }
30469b94acceSBarry Smith 
3047df9fa365SBarry Smith /*
3048df9fa365SBarry Smith    Duplicate the lg monitors for SNES from KSP; for some reason with
3049df9fa365SBarry Smith    dynamic libraries things don't work under Sun4 if we just use
3050df9fa365SBarry Smith    macros instead of functions
3051df9fa365SBarry Smith */
30524a2ae208SSatish Balay #undef __FUNCT__
30534619e776SBarry Smith #define __FUNCT__ "SNESMonitorLGResidualNorm"
30544619e776SBarry Smith PetscErrorCode  SNESMonitorLGResidualNorm(SNES snes,PetscInt it,PetscReal norm,void *ctx)
3055ce1608b8SBarry Smith {
3056dfbe8321SBarry Smith   PetscErrorCode ierr;
3057ce1608b8SBarry Smith 
3058ce1608b8SBarry Smith   PetscFunctionBegin;
30590700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
30601d1e9da1SBarry Smith   ierr = KSPMonitorLGResidualNorm((KSP)snes,it,norm,ctx);CHKERRQ(ierr);
3061ce1608b8SBarry Smith   PetscFunctionReturn(0);
3062ce1608b8SBarry Smith }
3063ce1608b8SBarry Smith 
30644a2ae208SSatish Balay #undef __FUNCT__
3065a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGCreate"
30667087cfbeSBarry Smith PetscErrorCode  SNESMonitorLGCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw)
3067df9fa365SBarry Smith {
3068dfbe8321SBarry Smith   PetscErrorCode ierr;
3069df9fa365SBarry Smith 
3070df9fa365SBarry Smith   PetscFunctionBegin;
30711d1e9da1SBarry Smith   ierr = KSPMonitorLGResidualNormCreate(host,label,x,y,m,n,draw);CHKERRQ(ierr);
3072df9fa365SBarry Smith   PetscFunctionReturn(0);
3073df9fa365SBarry Smith }
3074df9fa365SBarry Smith 
30754a2ae208SSatish Balay #undef __FUNCT__
3076a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGDestroy"
30776bf464f9SBarry Smith PetscErrorCode  SNESMonitorLGDestroy(PetscDrawLG *draw)
3078df9fa365SBarry Smith {
3079dfbe8321SBarry Smith   PetscErrorCode ierr;
3080df9fa365SBarry Smith 
3081df9fa365SBarry Smith   PetscFunctionBegin;
30821d1e9da1SBarry Smith   ierr = KSPMonitorLGResidualNormDestroy(draw);CHKERRQ(ierr);
3083df9fa365SBarry Smith   PetscFunctionReturn(0);
3084df9fa365SBarry Smith }
3085df9fa365SBarry Smith 
30867087cfbeSBarry Smith extern PetscErrorCode  SNESMonitorRange_Private(SNES,PetscInt,PetscReal*);
3087b271bb04SBarry Smith #undef __FUNCT__
3088b271bb04SBarry Smith #define __FUNCT__ "SNESMonitorLGRange"
30897087cfbeSBarry Smith PetscErrorCode  SNESMonitorLGRange(SNES snes,PetscInt n,PetscReal rnorm,void *monctx)
3090b271bb04SBarry Smith {
3091b271bb04SBarry Smith   PetscDrawLG      lg;
3092b271bb04SBarry Smith   PetscErrorCode   ierr;
3093b271bb04SBarry Smith   PetscReal        x,y,per;
3094b271bb04SBarry Smith   PetscViewer      v = (PetscViewer)monctx;
3095b271bb04SBarry Smith   static PetscReal prev; /* should be in the context */
3096b271bb04SBarry Smith   PetscDraw        draw;
3097b271bb04SBarry Smith 
3098459f5d12SBarry Smith   PetscFunctionBegin;
3099b271bb04SBarry Smith   ierr   = PetscViewerDrawGetDrawLG(v,0,&lg);CHKERRQ(ierr);
3100b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
3101b271bb04SBarry Smith   ierr   = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
3102b271bb04SBarry Smith   ierr   = PetscDrawSetTitle(draw,"Residual norm");CHKERRQ(ierr);
3103b271bb04SBarry Smith   x = (PetscReal) n;
3104b271bb04SBarry Smith   if (rnorm > 0.0) y = log10(rnorm); else y = -15.0;
3105b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
3106b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
3107b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
3108b271bb04SBarry Smith   }
3109b271bb04SBarry Smith 
3110b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,1,&lg);CHKERRQ(ierr);
3111b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
3112b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
3113b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"% elemts > .2*max elemt");CHKERRQ(ierr);
3114b271bb04SBarry Smith   ierr =  SNESMonitorRange_Private(snes,n,&per);CHKERRQ(ierr);
3115b271bb04SBarry Smith   x = (PetscReal) n;
3116b271bb04SBarry Smith   y = 100.0*per;
3117b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
3118b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
3119b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
3120b271bb04SBarry Smith   }
3121b271bb04SBarry Smith 
3122b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,2,&lg);CHKERRQ(ierr);
3123b271bb04SBarry Smith   if (!n) {prev = rnorm;ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
3124b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
3125b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm");CHKERRQ(ierr);
3126b271bb04SBarry Smith   x = (PetscReal) n;
3127b271bb04SBarry Smith   y = (prev - rnorm)/prev;
3128b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
3129b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
3130b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
3131b271bb04SBarry Smith   }
3132b271bb04SBarry Smith 
3133b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,3,&lg);CHKERRQ(ierr);
3134b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
3135b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
3136b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm*(% > .2 max)");CHKERRQ(ierr);
3137b271bb04SBarry Smith   x = (PetscReal) n;
3138b271bb04SBarry Smith   y = (prev - rnorm)/(prev*per);
3139b271bb04SBarry Smith   if (n > 2) { /*skip initial crazy value */
3140b271bb04SBarry Smith     ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
3141b271bb04SBarry Smith   }
3142b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
3143b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
3144b271bb04SBarry Smith   }
3145b271bb04SBarry Smith   prev = rnorm;
3146b271bb04SBarry Smith   PetscFunctionReturn(0);
3147b271bb04SBarry Smith }
3148b271bb04SBarry Smith 
3149b271bb04SBarry Smith #undef __FUNCT__
31507a03ce2fSLisandro Dalcin #define __FUNCT__ "SNESMonitor"
3151228d79bcSJed Brown /*@
3152228d79bcSJed Brown    SNESMonitor - runs the user provided monitor routines, if they exist
3153228d79bcSJed Brown 
3154228d79bcSJed Brown    Collective on SNES
3155228d79bcSJed Brown 
3156228d79bcSJed Brown    Input Parameters:
3157228d79bcSJed Brown +  snes - nonlinear solver context obtained from SNESCreate()
3158228d79bcSJed Brown .  iter - iteration number
3159228d79bcSJed Brown -  rnorm - relative norm of the residual
3160228d79bcSJed Brown 
3161228d79bcSJed Brown    Notes:
3162228d79bcSJed Brown    This routine is called by the SNES implementations.
3163228d79bcSJed Brown    It does not typically need to be called by the user.
3164228d79bcSJed Brown 
3165228d79bcSJed Brown    Level: developer
3166228d79bcSJed Brown 
3167228d79bcSJed Brown .seealso: SNESMonitorSet()
3168228d79bcSJed Brown @*/
31697a03ce2fSLisandro Dalcin PetscErrorCode  SNESMonitor(SNES snes,PetscInt iter,PetscReal rnorm)
31707a03ce2fSLisandro Dalcin {
31717a03ce2fSLisandro Dalcin   PetscErrorCode ierr;
31727a03ce2fSLisandro Dalcin   PetscInt       i,n = snes->numbermonitors;
31737a03ce2fSLisandro Dalcin 
31747a03ce2fSLisandro Dalcin   PetscFunctionBegin;
31757a03ce2fSLisandro Dalcin   for (i=0; i<n; i++) {
31767a03ce2fSLisandro Dalcin     ierr = (*snes->monitor[i])(snes,iter,rnorm,snes->monitorcontext[i]);CHKERRQ(ierr);
31777a03ce2fSLisandro Dalcin   }
31787a03ce2fSLisandro Dalcin   PetscFunctionReturn(0);
31797a03ce2fSLisandro Dalcin }
31807a03ce2fSLisandro Dalcin 
31819b94acceSBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
31829b94acceSBarry Smith 
31834a2ae208SSatish Balay #undef __FUNCT__
3184a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorSet"
31859b94acceSBarry Smith /*@C
3186a6570f20SBarry Smith    SNESMonitorSet - Sets an ADDITIONAL function that is to be used at every
31879b94acceSBarry Smith    iteration of the nonlinear solver to display the iteration's
31889b94acceSBarry Smith    progress.
31899b94acceSBarry Smith 
31903f9fe445SBarry Smith    Logically Collective on SNES
3191fee21e36SBarry Smith 
3192c7afd0dbSLois Curfman McInnes    Input Parameters:
3193c7afd0dbSLois Curfman McInnes +  snes - the SNES context
3194c7afd0dbSLois Curfman McInnes .  func - monitoring routine
3195b8a78c4aSBarry Smith .  mctx - [optional] user-defined context for private data for the
3196e8105e01SRichard Katz           monitor routine (use PETSC_NULL if no context is desired)
3197b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
3198b3006f0bSLois Curfman McInnes           (may be PETSC_NULL)
31999b94acceSBarry Smith 
3200c7afd0dbSLois Curfman McInnes    Calling sequence of func:
3201a7cc72afSBarry Smith $     int func(SNES snes,PetscInt its, PetscReal norm,void *mctx)
3202c7afd0dbSLois Curfman McInnes 
3203c7afd0dbSLois Curfman McInnes +    snes - the SNES context
3204c7afd0dbSLois Curfman McInnes .    its - iteration number
3205c7afd0dbSLois Curfman McInnes .    norm - 2-norm function value (may be estimated)
320640a0c1c6SLois Curfman McInnes -    mctx - [optional] monitoring context
32079b94acceSBarry Smith 
32089665c990SLois Curfman McInnes    Options Database Keys:
3209a6570f20SBarry Smith +    -snes_monitor        - sets SNESMonitorDefault()
32104619e776SBarry Smith .    -snes_monitor_lg_residualnorm    - sets line graph monitor,
3211a6570f20SBarry Smith                             uses SNESMonitorLGCreate()
3212cca6129bSJed Brown -    -snes_monitor_cancel - cancels all monitors that have
3213c7afd0dbSLois Curfman McInnes                             been hardwired into a code by
3214a6570f20SBarry Smith                             calls to SNESMonitorSet(), but
3215c7afd0dbSLois Curfman McInnes                             does not cancel those set via
3216c7afd0dbSLois Curfman McInnes                             the options database.
32179665c990SLois Curfman McInnes 
3218639f9d9dSBarry Smith    Notes:
32196bc08f3fSLois Curfman McInnes    Several different monitoring routines may be set by calling
3220a6570f20SBarry Smith    SNESMonitorSet() multiple times; all will be called in the
32216bc08f3fSLois Curfman McInnes    order in which they were set.
3222639f9d9dSBarry Smith 
3223025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each SNES object
3224025f1a04SBarry Smith 
322536851e7fSLois Curfman McInnes    Level: intermediate
322636851e7fSLois Curfman McInnes 
32279b94acceSBarry Smith .keywords: SNES, nonlinear, set, monitor
32289b94acceSBarry Smith 
3229a6570f20SBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorCancel()
32309b94acceSBarry Smith @*/
3231c2efdce3SBarry Smith PetscErrorCode  SNESMonitorSet(SNES snes,PetscErrorCode (*monitor)(SNES,PetscInt,PetscReal,void*),void *mctx,PetscErrorCode (*monitordestroy)(void**))
32329b94acceSBarry Smith {
3233b90d0a6eSBarry Smith   PetscInt       i;
3234649052a6SBarry Smith   PetscErrorCode ierr;
3235b90d0a6eSBarry Smith 
32363a40ed3dSBarry Smith   PetscFunctionBegin;
32370700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
323817186662SBarry Smith   if (snes->numbermonitors >= MAXSNESMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3239b90d0a6eSBarry Smith   for (i=0; i<snes->numbermonitors;i++) {
3240649052a6SBarry Smith     if (monitor == snes->monitor[i] && monitordestroy == snes->monitordestroy[i] && mctx == snes->monitorcontext[i]) {
3241649052a6SBarry Smith       if (monitordestroy) {
3242c2efdce3SBarry Smith         ierr = (*monitordestroy)(&mctx);CHKERRQ(ierr);
3243649052a6SBarry Smith       }
3244b90d0a6eSBarry Smith       PetscFunctionReturn(0);
3245b90d0a6eSBarry Smith     }
3246b90d0a6eSBarry Smith   }
3247b90d0a6eSBarry Smith   snes->monitor[snes->numbermonitors]           = monitor;
3248b8a78c4aSBarry Smith   snes->monitordestroy[snes->numbermonitors]    = monitordestroy;
3249639f9d9dSBarry Smith   snes->monitorcontext[snes->numbermonitors++]  = (void*)mctx;
32503a40ed3dSBarry Smith   PetscFunctionReturn(0);
32519b94acceSBarry Smith }
32529b94acceSBarry Smith 
32534a2ae208SSatish Balay #undef __FUNCT__
3254a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorCancel"
32555cd90555SBarry Smith /*@C
3256a6570f20SBarry Smith    SNESMonitorCancel - Clears all the monitor functions for a SNES object.
32575cd90555SBarry Smith 
32583f9fe445SBarry Smith    Logically Collective on SNES
3259c7afd0dbSLois Curfman McInnes 
32605cd90555SBarry Smith    Input Parameters:
32615cd90555SBarry Smith .  snes - the SNES context
32625cd90555SBarry Smith 
32631a480d89SAdministrator    Options Database Key:
3264a6570f20SBarry Smith .  -snes_monitor_cancel - cancels all monitors that have been hardwired
3265a6570f20SBarry Smith     into a code by calls to SNESMonitorSet(), but does not cancel those
3266c7afd0dbSLois Curfman McInnes     set via the options database
32675cd90555SBarry Smith 
32685cd90555SBarry Smith    Notes:
32695cd90555SBarry Smith    There is no way to clear one specific monitor from a SNES object.
32705cd90555SBarry Smith 
327136851e7fSLois Curfman McInnes    Level: intermediate
327236851e7fSLois Curfman McInnes 
32735cd90555SBarry Smith .keywords: SNES, nonlinear, set, monitor
32745cd90555SBarry Smith 
3275a6570f20SBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorSet()
32765cd90555SBarry Smith @*/
32777087cfbeSBarry Smith PetscErrorCode  SNESMonitorCancel(SNES snes)
32785cd90555SBarry Smith {
3279d952e501SBarry Smith   PetscErrorCode ierr;
3280d952e501SBarry Smith   PetscInt       i;
3281d952e501SBarry Smith 
32825cd90555SBarry Smith   PetscFunctionBegin;
32830700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3284d952e501SBarry Smith   for (i=0; i<snes->numbermonitors; i++) {
3285d952e501SBarry Smith     if (snes->monitordestroy[i]) {
32863c4aec1bSBarry Smith       ierr = (*snes->monitordestroy[i])(&snes->monitorcontext[i]);CHKERRQ(ierr);
3287d952e501SBarry Smith     }
3288d952e501SBarry Smith   }
32895cd90555SBarry Smith   snes->numbermonitors = 0;
32905cd90555SBarry Smith   PetscFunctionReturn(0);
32915cd90555SBarry Smith }
32925cd90555SBarry Smith 
32934a2ae208SSatish Balay #undef __FUNCT__
32944a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceTest"
32959b94acceSBarry Smith /*@C
32969b94acceSBarry Smith    SNESSetConvergenceTest - Sets the function that is to be used
32979b94acceSBarry Smith    to test for convergence of the nonlinear iterative solution.
32989b94acceSBarry Smith 
32993f9fe445SBarry Smith    Logically Collective on SNES
3300fee21e36SBarry Smith 
3301c7afd0dbSLois Curfman McInnes    Input Parameters:
3302c7afd0dbSLois Curfman McInnes +  snes - the SNES context
3303c7afd0dbSLois Curfman McInnes .  func - routine to test for convergence
33047f7931b9SBarry Smith .  cctx - [optional] context for private data for the convergence routine  (may be PETSC_NULL)
33057f7931b9SBarry Smith -  destroy - [optional] destructor for the context (may be PETSC_NULL; PETSC_NULL_FUNCTION in Fortran)
33069b94acceSBarry Smith 
3307c7afd0dbSLois Curfman McInnes    Calling sequence of func:
330806ee9f85SBarry Smith $     PetscErrorCode func (SNES snes,PetscInt it,PetscReal xnorm,PetscReal gnorm,PetscReal f,SNESConvergedReason *reason,void *cctx)
3309c7afd0dbSLois Curfman McInnes 
3310c7afd0dbSLois Curfman McInnes +    snes - the SNES context
331106ee9f85SBarry Smith .    it - current iteration (0 is the first and is before any Newton step)
3312c7afd0dbSLois Curfman McInnes .    cctx - [optional] convergence context
3313184914b5SBarry Smith .    reason - reason for convergence/divergence
3314c7afd0dbSLois Curfman McInnes .    xnorm - 2-norm of current iterate
33154b27c08aSLois Curfman McInnes .    gnorm - 2-norm of current step
33164b27c08aSLois Curfman McInnes -    f - 2-norm of function
33179b94acceSBarry Smith 
331836851e7fSLois Curfman McInnes    Level: advanced
331936851e7fSLois Curfman McInnes 
33209b94acceSBarry Smith .keywords: SNES, nonlinear, set, convergence, test
33219b94acceSBarry Smith 
332285385478SLisandro Dalcin .seealso: SNESDefaultConverged(), SNESSkipConverged()
33239b94acceSBarry Smith @*/
33247087cfbeSBarry Smith PetscErrorCode  SNESSetConvergenceTest(SNES snes,PetscErrorCode (*func)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void *cctx,PetscErrorCode (*destroy)(void*))
33259b94acceSBarry Smith {
33267f7931b9SBarry Smith   PetscErrorCode ierr;
33277f7931b9SBarry Smith 
33283a40ed3dSBarry Smith   PetscFunctionBegin;
33290700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
333085385478SLisandro Dalcin   if (!func) func = SNESSkipConverged;
33317f7931b9SBarry Smith   if (snes->ops->convergeddestroy) {
33327f7931b9SBarry Smith     ierr = (*snes->ops->convergeddestroy)(snes->cnvP);CHKERRQ(ierr);
33337f7931b9SBarry Smith   }
333485385478SLisandro Dalcin   snes->ops->converged        = func;
33357f7931b9SBarry Smith   snes->ops->convergeddestroy = destroy;
333685385478SLisandro Dalcin   snes->cnvP                  = cctx;
33373a40ed3dSBarry Smith   PetscFunctionReturn(0);
33389b94acceSBarry Smith }
33399b94acceSBarry Smith 
33404a2ae208SSatish Balay #undef __FUNCT__
33414a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergedReason"
334252baeb72SSatish Balay /*@
3343184914b5SBarry Smith    SNESGetConvergedReason - Gets the reason the SNES iteration was stopped.
3344184914b5SBarry Smith 
3345184914b5SBarry Smith    Not Collective
3346184914b5SBarry Smith 
3347184914b5SBarry Smith    Input Parameter:
3348184914b5SBarry Smith .  snes - the SNES context
3349184914b5SBarry Smith 
3350184914b5SBarry Smith    Output Parameter:
33514d0a8057SBarry Smith .  reason - negative value indicates diverged, positive value converged, see SNESConvergedReason or the
3352184914b5SBarry Smith             manual pages for the individual convergence tests for complete lists
3353184914b5SBarry Smith 
3354184914b5SBarry Smith    Level: intermediate
3355184914b5SBarry Smith 
3356184914b5SBarry Smith    Notes: Can only be called after the call the SNESSolve() is complete.
3357184914b5SBarry Smith 
3358184914b5SBarry Smith .keywords: SNES, nonlinear, set, convergence, test
3359184914b5SBarry Smith 
336085385478SLisandro Dalcin .seealso: SNESSetConvergenceTest(), SNESConvergedReason
3361184914b5SBarry Smith @*/
33627087cfbeSBarry Smith PetscErrorCode  SNESGetConvergedReason(SNES snes,SNESConvergedReason *reason)
3363184914b5SBarry Smith {
3364184914b5SBarry Smith   PetscFunctionBegin;
33650700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
33664482741eSBarry Smith   PetscValidPointer(reason,2);
3367184914b5SBarry Smith   *reason = snes->reason;
3368184914b5SBarry Smith   PetscFunctionReturn(0);
3369184914b5SBarry Smith }
3370184914b5SBarry Smith 
33714a2ae208SSatish Balay #undef __FUNCT__
33724a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceHistory"
3373c9005455SLois Curfman McInnes /*@
3374c9005455SLois Curfman McInnes    SNESSetConvergenceHistory - Sets the array used to hold the convergence history.
3375c9005455SLois Curfman McInnes 
33763f9fe445SBarry Smith    Logically Collective on SNES
3377fee21e36SBarry Smith 
3378c7afd0dbSLois Curfman McInnes    Input Parameters:
3379c7afd0dbSLois Curfman McInnes +  snes - iterative context obtained from SNESCreate()
33808c7482ecSBarry Smith .  a   - array to hold history, this array will contain the function norms computed at each step
3381cd5578b5SBarry Smith .  its - integer array holds the number of linear iterations for each solve.
3382758f92a0SBarry Smith .  na  - size of a and its
338364731454SLois Curfman McInnes -  reset - PETSC_TRUE indicates each new nonlinear solve resets the history counter to zero,
3384758f92a0SBarry Smith            else it continues storing new values for new nonlinear solves after the old ones
3385c7afd0dbSLois Curfman McInnes 
3386308dcc3eSBarry Smith    Notes:
3387308dcc3eSBarry Smith    If 'a' and 'its' are PETSC_NULL then space is allocated for the history. If 'na' PETSC_DECIDE or PETSC_DEFAULT then a
3388308dcc3eSBarry Smith    default array of length 10000 is allocated.
3389308dcc3eSBarry Smith 
3390c9005455SLois Curfman McInnes    This routine is useful, e.g., when running a code for purposes
3391c9005455SLois Curfman McInnes    of accurate performance monitoring, when no I/O should be done
3392c9005455SLois Curfman McInnes    during the section of code that is being timed.
3393c9005455SLois Curfman McInnes 
339436851e7fSLois Curfman McInnes    Level: intermediate
339536851e7fSLois Curfman McInnes 
3396c9005455SLois Curfman McInnes .keywords: SNES, set, convergence, history
3397758f92a0SBarry Smith 
339808405cd6SLois Curfman McInnes .seealso: SNESGetConvergenceHistory()
3399758f92a0SBarry Smith 
3400c9005455SLois Curfman McInnes @*/
34017087cfbeSBarry Smith PetscErrorCode  SNESSetConvergenceHistory(SNES snes,PetscReal a[],PetscInt its[],PetscInt na,PetscBool  reset)
3402c9005455SLois Curfman McInnes {
3403308dcc3eSBarry Smith   PetscErrorCode ierr;
3404308dcc3eSBarry Smith 
34053a40ed3dSBarry Smith   PetscFunctionBegin;
34060700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
34074482741eSBarry Smith   if (na)  PetscValidScalarPointer(a,2);
3408a562a398SLisandro Dalcin   if (its) PetscValidIntPointer(its,3);
3409308dcc3eSBarry Smith   if (na == PETSC_DECIDE || na == PETSC_DEFAULT || !a) {
3410308dcc3eSBarry Smith     if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000;
3411308dcc3eSBarry Smith     ierr = PetscMalloc(na*sizeof(PetscReal),&a);CHKERRQ(ierr);
3412308dcc3eSBarry Smith     ierr = PetscMalloc(na*sizeof(PetscInt),&its);CHKERRQ(ierr);
3413308dcc3eSBarry Smith     snes->conv_malloc   = PETSC_TRUE;
3414308dcc3eSBarry Smith   }
3415c9005455SLois Curfman McInnes   snes->conv_hist       = a;
3416758f92a0SBarry Smith   snes->conv_hist_its   = its;
3417758f92a0SBarry Smith   snes->conv_hist_max   = na;
3418a12bc48fSLisandro Dalcin   snes->conv_hist_len   = 0;
3419758f92a0SBarry Smith   snes->conv_hist_reset = reset;
3420758f92a0SBarry Smith   PetscFunctionReturn(0);
3421758f92a0SBarry Smith }
3422758f92a0SBarry Smith 
3423308dcc3eSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
3424c6db04a5SJed Brown #include <engine.h>   /* MATLAB include file */
3425c6db04a5SJed Brown #include <mex.h>      /* MATLAB include file */
3426308dcc3eSBarry Smith EXTERN_C_BEGIN
3427308dcc3eSBarry Smith #undef __FUNCT__
3428308dcc3eSBarry Smith #define __FUNCT__ "SNESGetConvergenceHistoryMatlab"
3429308dcc3eSBarry Smith mxArray *SNESGetConvergenceHistoryMatlab(SNES snes)
3430308dcc3eSBarry Smith {
3431308dcc3eSBarry Smith   mxArray   *mat;
3432308dcc3eSBarry Smith   PetscInt  i;
3433308dcc3eSBarry Smith   PetscReal *ar;
3434308dcc3eSBarry Smith 
3435308dcc3eSBarry Smith   PetscFunctionBegin;
3436308dcc3eSBarry Smith   mat  = mxCreateDoubleMatrix(snes->conv_hist_len,1,mxREAL);
3437308dcc3eSBarry Smith   ar   = (PetscReal*) mxGetData(mat);
3438308dcc3eSBarry Smith   for (i=0; i<snes->conv_hist_len; i++) {
3439308dcc3eSBarry Smith     ar[i] = snes->conv_hist[i];
3440308dcc3eSBarry Smith   }
3441308dcc3eSBarry Smith   PetscFunctionReturn(mat);
3442308dcc3eSBarry Smith }
3443308dcc3eSBarry Smith EXTERN_C_END
3444308dcc3eSBarry Smith #endif
3445308dcc3eSBarry Smith 
3446308dcc3eSBarry Smith 
34474a2ae208SSatish Balay #undef __FUNCT__
34484a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergenceHistory"
34490c4c9dddSBarry Smith /*@C
3450758f92a0SBarry Smith    SNESGetConvergenceHistory - Gets the array used to hold the convergence history.
3451758f92a0SBarry Smith 
34523f9fe445SBarry Smith    Not Collective
3453758f92a0SBarry Smith 
3454758f92a0SBarry Smith    Input Parameter:
3455758f92a0SBarry Smith .  snes - iterative context obtained from SNESCreate()
3456758f92a0SBarry Smith 
3457758f92a0SBarry Smith    Output Parameters:
3458758f92a0SBarry Smith .  a   - array to hold history
3459758f92a0SBarry Smith .  its - integer array holds the number of linear iterations (or
3460758f92a0SBarry Smith          negative if not converged) for each solve.
3461758f92a0SBarry Smith -  na  - size of a and its
3462758f92a0SBarry Smith 
3463758f92a0SBarry Smith    Notes:
3464758f92a0SBarry Smith     The calling sequence for this routine in Fortran is
3465758f92a0SBarry Smith $   call SNESGetConvergenceHistory(SNES snes, integer na, integer ierr)
3466758f92a0SBarry Smith 
3467758f92a0SBarry Smith    This routine is useful, e.g., when running a code for purposes
3468758f92a0SBarry Smith    of accurate performance monitoring, when no I/O should be done
3469758f92a0SBarry Smith    during the section of code that is being timed.
3470758f92a0SBarry Smith 
3471758f92a0SBarry Smith    Level: intermediate
3472758f92a0SBarry Smith 
3473758f92a0SBarry Smith .keywords: SNES, get, convergence, history
3474758f92a0SBarry Smith 
3475758f92a0SBarry Smith .seealso: SNESSetConvergencHistory()
3476758f92a0SBarry Smith 
3477758f92a0SBarry Smith @*/
34787087cfbeSBarry Smith PetscErrorCode  SNESGetConvergenceHistory(SNES snes,PetscReal *a[],PetscInt *its[],PetscInt *na)
3479758f92a0SBarry Smith {
3480758f92a0SBarry Smith   PetscFunctionBegin;
34810700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3482758f92a0SBarry Smith   if (a)   *a   = snes->conv_hist;
3483758f92a0SBarry Smith   if (its) *its = snes->conv_hist_its;
3484758f92a0SBarry Smith   if (na)  *na  = snes->conv_hist_len;
34853a40ed3dSBarry Smith   PetscFunctionReturn(0);
3486c9005455SLois Curfman McInnes }
3487c9005455SLois Curfman McInnes 
3488e74ef692SMatthew Knepley #undef __FUNCT__
3489e74ef692SMatthew Knepley #define __FUNCT__ "SNESSetUpdate"
3490ac226902SBarry Smith /*@C
349176b2cf59SMatthew Knepley   SNESSetUpdate - Sets the general-purpose update function called
3492eec8f646SJed Brown   at the beginning of every iteration of the nonlinear solve. Specifically
34937e4bb74cSBarry Smith   it is called just before the Jacobian is "evaluated".
349476b2cf59SMatthew Knepley 
34953f9fe445SBarry Smith   Logically Collective on SNES
349676b2cf59SMatthew Knepley 
349776b2cf59SMatthew Knepley   Input Parameters:
349876b2cf59SMatthew Knepley . snes - The nonlinear solver context
349976b2cf59SMatthew Knepley . func - The function
350076b2cf59SMatthew Knepley 
350176b2cf59SMatthew Knepley   Calling sequence of func:
3502b5d30489SBarry Smith . func (SNES snes, PetscInt step);
350376b2cf59SMatthew Knepley 
350476b2cf59SMatthew Knepley . step - The current step of the iteration
350576b2cf59SMatthew Knepley 
3506fe97e370SBarry Smith   Level: advanced
3507fe97e370SBarry Smith 
3508fe97e370SBarry 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()
3509fe97e370SBarry Smith         This is not used by most users.
351076b2cf59SMatthew Knepley 
351176b2cf59SMatthew Knepley .keywords: SNES, update
3512b5d30489SBarry Smith 
351385385478SLisandro Dalcin .seealso SNESDefaultUpdate(), SNESSetJacobian(), SNESSolve()
351476b2cf59SMatthew Knepley @*/
35157087cfbeSBarry Smith PetscErrorCode  SNESSetUpdate(SNES snes, PetscErrorCode (*func)(SNES, PetscInt))
351676b2cf59SMatthew Knepley {
351776b2cf59SMatthew Knepley   PetscFunctionBegin;
35180700a824SBarry Smith   PetscValidHeaderSpecific(snes, SNES_CLASSID,1);
3519e7788613SBarry Smith   snes->ops->update = func;
352076b2cf59SMatthew Knepley   PetscFunctionReturn(0);
352176b2cf59SMatthew Knepley }
352276b2cf59SMatthew Knepley 
3523e74ef692SMatthew Knepley #undef __FUNCT__
3524e74ef692SMatthew Knepley #define __FUNCT__ "SNESDefaultUpdate"
352576b2cf59SMatthew Knepley /*@
352676b2cf59SMatthew Knepley   SNESDefaultUpdate - The default update function which does nothing.
352776b2cf59SMatthew Knepley 
352876b2cf59SMatthew Knepley   Not collective
352976b2cf59SMatthew Knepley 
353076b2cf59SMatthew Knepley   Input Parameters:
353176b2cf59SMatthew Knepley . snes - The nonlinear solver context
353276b2cf59SMatthew Knepley . step - The current step of the iteration
353376b2cf59SMatthew Knepley 
3534205452f4SMatthew Knepley   Level: intermediate
3535205452f4SMatthew Knepley 
353676b2cf59SMatthew Knepley .keywords: SNES, update
3537a6570f20SBarry Smith .seealso SNESSetUpdate(), SNESDefaultRhsBC(), SNESDefaultShortolutionBC()
353876b2cf59SMatthew Knepley @*/
35397087cfbeSBarry Smith PetscErrorCode  SNESDefaultUpdate(SNES snes, PetscInt step)
354076b2cf59SMatthew Knepley {
354176b2cf59SMatthew Knepley   PetscFunctionBegin;
354276b2cf59SMatthew Knepley   PetscFunctionReturn(0);
354376b2cf59SMatthew Knepley }
354476b2cf59SMatthew Knepley 
35454a2ae208SSatish Balay #undef __FUNCT__
35464a2ae208SSatish Balay #define __FUNCT__ "SNESScaleStep_Private"
35479b94acceSBarry Smith /*
35489b94acceSBarry Smith    SNESScaleStep_Private - Scales a step so that its length is less than the
35499b94acceSBarry Smith    positive parameter delta.
35509b94acceSBarry Smith 
35519b94acceSBarry Smith     Input Parameters:
3552c7afd0dbSLois Curfman McInnes +   snes - the SNES context
35539b94acceSBarry Smith .   y - approximate solution of linear system
35549b94acceSBarry Smith .   fnorm - 2-norm of current function
3555c7afd0dbSLois Curfman McInnes -   delta - trust region size
35569b94acceSBarry Smith 
35579b94acceSBarry Smith     Output Parameters:
3558c7afd0dbSLois Curfman McInnes +   gpnorm - predicted function norm at the new point, assuming local
35599b94acceSBarry Smith     linearization.  The value is zero if the step lies within the trust
35609b94acceSBarry Smith     region, and exceeds zero otherwise.
3561c7afd0dbSLois Curfman McInnes -   ynorm - 2-norm of the step
35629b94acceSBarry Smith 
35639b94acceSBarry Smith     Note:
356404d7464bSBarry Smith     For non-trust region methods such as SNESNEWTONLS, the parameter delta
35659b94acceSBarry Smith     is set to be the maximum allowable step size.
35669b94acceSBarry Smith 
35679b94acceSBarry Smith .keywords: SNES, nonlinear, scale, step
35689b94acceSBarry Smith */
3569dfbe8321SBarry Smith PetscErrorCode SNESScaleStep_Private(SNES snes,Vec y,PetscReal *fnorm,PetscReal *delta,PetscReal *gpnorm,PetscReal *ynorm)
35709b94acceSBarry Smith {
3571064f8208SBarry Smith   PetscReal      nrm;
3572ea709b57SSatish Balay   PetscScalar    cnorm;
3573dfbe8321SBarry Smith   PetscErrorCode ierr;
35743a40ed3dSBarry Smith 
35753a40ed3dSBarry Smith   PetscFunctionBegin;
35760700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
35770700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,2);
3578c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,y,2);
3579184914b5SBarry Smith 
3580064f8208SBarry Smith   ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr);
3581064f8208SBarry Smith   if (nrm > *delta) {
3582064f8208SBarry Smith      nrm = *delta/nrm;
3583064f8208SBarry Smith      *gpnorm = (1.0 - nrm)*(*fnorm);
3584064f8208SBarry Smith      cnorm = nrm;
35852dcb1b2aSMatthew Knepley      ierr = VecScale(y,cnorm);CHKERRQ(ierr);
35869b94acceSBarry Smith      *ynorm = *delta;
35879b94acceSBarry Smith   } else {
35889b94acceSBarry Smith      *gpnorm = 0.0;
3589064f8208SBarry Smith      *ynorm = nrm;
35909b94acceSBarry Smith   }
35913a40ed3dSBarry Smith   PetscFunctionReturn(0);
35929b94acceSBarry Smith }
35939b94acceSBarry Smith 
35944a2ae208SSatish Balay #undef __FUNCT__
35954a2ae208SSatish Balay #define __FUNCT__ "SNESSolve"
35966ce558aeSBarry Smith /*@C
3597f69a0ea3SMatthew Knepley    SNESSolve - Solves a nonlinear system F(x) = b.
3598f69a0ea3SMatthew Knepley    Call SNESSolve() after calling SNESCreate() and optional routines of the form SNESSetXXX().
35999b94acceSBarry Smith 
3600c7afd0dbSLois Curfman McInnes    Collective on SNES
3601c7afd0dbSLois Curfman McInnes 
3602b2002411SLois Curfman McInnes    Input Parameters:
3603c7afd0dbSLois Curfman McInnes +  snes - the SNES context
36043cebf274SJed Brown .  b - the constant part of the equation F(x) = b, or PETSC_NULL to use zero.
360585385478SLisandro Dalcin -  x - the solution vector.
36069b94acceSBarry Smith 
3607b2002411SLois Curfman McInnes    Notes:
36088ddd3da0SLois Curfman McInnes    The user should initialize the vector,x, with the initial guess
36098ddd3da0SLois Curfman McInnes    for the nonlinear solve prior to calling SNESSolve.  In particular,
36108ddd3da0SLois Curfman McInnes    to employ an initial guess of zero, the user should explicitly set
36118ddd3da0SLois Curfman McInnes    this vector to zero by calling VecSet().
36128ddd3da0SLois Curfman McInnes 
361336851e7fSLois Curfman McInnes    Level: beginner
361436851e7fSLois Curfman McInnes 
36159b94acceSBarry Smith .keywords: SNES, nonlinear, solve
36169b94acceSBarry Smith 
3617c0df2a02SJed Brown .seealso: SNESCreate(), SNESDestroy(), SNESSetFunction(), SNESSetJacobian(), SNESSetGridSequence(), SNESGetSolution()
36189b94acceSBarry Smith @*/
36197087cfbeSBarry Smith PetscErrorCode  SNESSolve(SNES snes,Vec b,Vec x)
36209b94acceSBarry Smith {
3621dfbe8321SBarry Smith   PetscErrorCode ierr;
3622ace3abfcSBarry Smith   PetscBool      flg;
3623eabae89aSBarry Smith   char           filename[PETSC_MAX_PATH_LEN];
3624eabae89aSBarry Smith   PetscViewer    viewer;
3625efd51863SBarry Smith   PetscInt       grid;
3626a69afd8bSBarry Smith   Vec            xcreated = PETSC_NULL;
3627caa4e7f2SJed Brown   DM             dm;
3628052efed2SBarry Smith 
36293a40ed3dSBarry Smith   PetscFunctionBegin;
36300700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3631a69afd8bSBarry Smith   if (x) PetscValidHeaderSpecific(x,VEC_CLASSID,3);
3632a69afd8bSBarry Smith   if (x) PetscCheckSameComm(snes,1,x,3);
36330700a824SBarry Smith   if (b) PetscValidHeaderSpecific(b,VEC_CLASSID,2);
363485385478SLisandro Dalcin   if (b) PetscCheckSameComm(snes,1,b,2);
363585385478SLisandro Dalcin 
3636caa4e7f2SJed Brown   if (!x) {
3637caa4e7f2SJed Brown     ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
3638caa4e7f2SJed Brown     ierr = DMCreateGlobalVector(dm,&xcreated);CHKERRQ(ierr);
3639a69afd8bSBarry Smith     x    = xcreated;
3640a69afd8bSBarry Smith   }
3641a69afd8bSBarry Smith 
3642a8248277SBarry Smith   for (grid=0; grid<snes->gridsequence; grid++) {ierr = PetscViewerASCIIPushTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm));CHKERRQ(ierr);}
3643efd51863SBarry Smith   for (grid=0; grid<snes->gridsequence+1; grid++) {
3644efd51863SBarry Smith 
364585385478SLisandro Dalcin     /* set solution vector */
3646efd51863SBarry Smith     if (!grid) {ierr = PetscObjectReference((PetscObject)x);CHKERRQ(ierr);}
36476bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr);
364885385478SLisandro Dalcin     snes->vec_sol = x;
3649caa4e7f2SJed Brown     ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
3650caa4e7f2SJed Brown 
3651caa4e7f2SJed Brown     /* set affine vector if provided */
365285385478SLisandro Dalcin     if (b) { ierr = PetscObjectReference((PetscObject)b);CHKERRQ(ierr); }
36536bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr);
365485385478SLisandro Dalcin     snes->vec_rhs = b;
365585385478SLisandro Dalcin 
365670e92668SMatthew Knepley     ierr = SNESSetUp(snes);CHKERRQ(ierr);
36573f149594SLisandro Dalcin 
36587eee914bSBarry Smith     if (!grid) {
36597eee914bSBarry Smith       if (snes->ops->computeinitialguess) {
3660d25893d9SBarry Smith         ierr = (*snes->ops->computeinitialguess)(snes,snes->vec_sol,snes->initialguessP);CHKERRQ(ierr);
3661d25893d9SBarry Smith       }
3662dd568438SSatish Balay     }
3663d25893d9SBarry Smith 
3664abc0a331SBarry Smith     if (snes->conv_hist_reset) snes->conv_hist_len = 0;
366550ffb88aSMatthew Knepley     snes->nfuncs = 0; snes->linear_its = 0; snes->numFailures = 0;
3666d5e45103SBarry Smith 
36673f149594SLisandro Dalcin     ierr = PetscLogEventBegin(SNES_Solve,snes,0,0,0);CHKERRQ(ierr);
36684936397dSBarry Smith     ierr = (*snes->ops->solve)(snes);CHKERRQ(ierr);
366985385478SLisandro Dalcin     ierr = PetscLogEventEnd(SNES_Solve,snes,0,0,0);CHKERRQ(ierr);
36704936397dSBarry Smith     if (snes->domainerror){
36714936397dSBarry Smith       snes->reason      = SNES_DIVERGED_FUNCTION_DOMAIN;
36724936397dSBarry Smith       snes->domainerror = PETSC_FALSE;
36734936397dSBarry Smith     }
367417186662SBarry Smith     if (!snes->reason) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Internal error, solver returned without setting converged reason");
36753f149594SLisandro Dalcin 
367690d69ab7SBarry Smith     flg  = PETSC_FALSE;
3677acfcf0e5SJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_test_local_min",&flg,PETSC_NULL);CHKERRQ(ierr);
3678da9b6338SBarry Smith     if (flg && !PetscPreLoadingOn) { ierr = SNESTestLocalMin(snes);CHKERRQ(ierr); }
36795968eb51SBarry Smith     if (snes->printreason) {
3680a8248277SBarry Smith       ierr = PetscViewerASCIIAddTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),((PetscObject)snes)->tablevel);CHKERRQ(ierr);
36815968eb51SBarry Smith       if (snes->reason > 0) {
3682c7e7b494SJed 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);
36835968eb51SBarry Smith       } else {
3684c7e7b494SJed 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);
36855968eb51SBarry Smith       }
3686a8248277SBarry Smith       ierr = PetscViewerASCIISubtractTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),((PetscObject)snes)->tablevel);CHKERRQ(ierr);
36875968eb51SBarry Smith     }
36885968eb51SBarry Smith 
3689e113a28aSBarry Smith     if (snes->errorifnotconverged && snes->reason < 0) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_NOT_CONVERGED,"SNESSolve has not converged");
3690efd51863SBarry Smith     if (grid <  snes->gridsequence) {
3691efd51863SBarry Smith       DM  fine;
3692efd51863SBarry Smith       Vec xnew;
3693efd51863SBarry Smith       Mat interp;
3694efd51863SBarry Smith 
3695efd51863SBarry Smith       ierr = DMRefine(snes->dm,((PetscObject)snes)->comm,&fine);CHKERRQ(ierr);
3696c5c77316SJed Brown       if (!fine) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_ARG_INCOMP,"DMRefine() did not perform any refinement, cannot continue grid sequencing");
3697e727c939SJed Brown       ierr = DMCreateInterpolation(snes->dm,fine,&interp,PETSC_NULL);CHKERRQ(ierr);
3698efd51863SBarry Smith       ierr = DMCreateGlobalVector(fine,&xnew);CHKERRQ(ierr);
3699efd51863SBarry Smith       ierr = MatInterpolate(interp,x,xnew);CHKERRQ(ierr);
3700c833c3b5SJed Brown       ierr = DMInterpolate(snes->dm,interp,fine);CHKERRQ(ierr);
3701efd51863SBarry Smith       ierr = MatDestroy(&interp);CHKERRQ(ierr);
3702efd51863SBarry Smith       x    = xnew;
3703efd51863SBarry Smith 
3704efd51863SBarry Smith       ierr = SNESReset(snes);CHKERRQ(ierr);
3705efd51863SBarry Smith       ierr = SNESSetDM(snes,fine);CHKERRQ(ierr);
3706efd51863SBarry Smith       ierr = DMDestroy(&fine);CHKERRQ(ierr);
3707a8248277SBarry Smith       ierr = PetscViewerASCIIPopTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm));CHKERRQ(ierr);
3708efd51863SBarry Smith     }
3709efd51863SBarry Smith   }
37103f7e2da0SPeter Brune   /* monitoring and viewing */
37113f7e2da0SPeter Brune   flg = PETSC_FALSE;
37123f7e2da0SPeter Brune   ierr = PetscOptionsGetString(((PetscObject)snes)->prefix,"-snes_view",filename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
37133f7e2da0SPeter Brune   if (flg && !PetscPreLoadingOn) {
37143f7e2da0SPeter Brune     ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,filename,&viewer);CHKERRQ(ierr);
37153f7e2da0SPeter Brune     ierr = SNESView(snes,viewer);CHKERRQ(ierr);
37163f7e2da0SPeter Brune     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
37173f7e2da0SPeter Brune   }
37183f7e2da0SPeter Brune 
37193f7e2da0SPeter Brune   flg = PETSC_FALSE;
372072a02f06SBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_view_draw",&flg,PETSC_NULL);CHKERRQ(ierr);
372172a02f06SBarry Smith   if (flg) {
3722d724dfffSBarry Smith     PetscDraw draw;
372372a02f06SBarry Smith     ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,PETSC_NULL,"SNES Solver",0,0,600,600,&viewer);CHKERRQ(ierr);
3724d724dfffSBarry Smith     /* need to clear draw initially or -draw_save will not work on draw; cannot use PetscViewerDrawClear() since that only clears created windows */
3725d724dfffSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
3726d724dfffSBarry Smith     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
372772a02f06SBarry Smith     ierr = SNESView(snes,viewer);CHKERRQ(ierr);
372872a02f06SBarry Smith     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
372972a02f06SBarry Smith   }
373072a02f06SBarry Smith 
373172a02f06SBarry Smith   flg = PETSC_FALSE;
37323f7e2da0SPeter Brune   ierr = PetscOptionsGetString(((PetscObject)snes)->prefix,"-snes_view_solution_vtk",filename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
37333f7e2da0SPeter Brune   if (flg) {
37343f7e2da0SPeter Brune     PetscViewer viewer;
37353f7e2da0SPeter Brune     ierr = PetscViewerCreate(((PetscObject)snes)->comm,&viewer);CHKERRQ(ierr);
37363f7e2da0SPeter Brune     ierr = PetscViewerSetType(viewer,PETSCVIEWERVTK);CHKERRQ(ierr);
37373f7e2da0SPeter Brune     ierr = PetscViewerFileSetName(viewer,filename);CHKERRQ(ierr);
37383f7e2da0SPeter Brune     ierr = VecView(snes->vec_sol,viewer);CHKERRQ(ierr);
37393f7e2da0SPeter Brune     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
37403f7e2da0SPeter Brune   }
37413f7e2da0SPeter Brune 
3742a69afd8bSBarry Smith   ierr = VecDestroy(&xcreated);CHKERRQ(ierr);
37433a40ed3dSBarry Smith   PetscFunctionReturn(0);
37449b94acceSBarry Smith }
37459b94acceSBarry Smith 
37469b94acceSBarry Smith /* --------- Internal routines for SNES Package --------- */
37479b94acceSBarry Smith 
37484a2ae208SSatish Balay #undef __FUNCT__
37494a2ae208SSatish Balay #define __FUNCT__ "SNESSetType"
375082bf6240SBarry Smith /*@C
37514b0e389bSBarry Smith    SNESSetType - Sets the method for the nonlinear solver.
37529b94acceSBarry Smith 
3753fee21e36SBarry Smith    Collective on SNES
3754fee21e36SBarry Smith 
3755c7afd0dbSLois Curfman McInnes    Input Parameters:
3756c7afd0dbSLois Curfman McInnes +  snes - the SNES context
3757454a90a3SBarry Smith -  type - a known method
3758c7afd0dbSLois Curfman McInnes 
3759c7afd0dbSLois Curfman McInnes    Options Database Key:
3760454a90a3SBarry Smith .  -snes_type <type> - Sets the method; use -help for a list
376104d7464bSBarry Smith    of available methods (for instance, newtonls or newtontr)
3762ae12b187SLois Curfman McInnes 
37639b94acceSBarry Smith    Notes:
3764e090d566SSatish Balay    See "petsc/include/petscsnes.h" for available methods (for instance)
376504d7464bSBarry Smith +    SNESNEWTONLS - Newton's method with line search
3766c7afd0dbSLois Curfman McInnes      (systems of nonlinear equations)
376704d7464bSBarry Smith .    SNESNEWTONTR - Newton's method with trust region
3768c7afd0dbSLois Curfman McInnes      (systems of nonlinear equations)
37699b94acceSBarry Smith 
3770ae12b187SLois Curfman McInnes   Normally, it is best to use the SNESSetFromOptions() command and then
3771ae12b187SLois Curfman McInnes   set the SNES solver type from the options database rather than by using
3772ae12b187SLois Curfman McInnes   this routine.  Using the options database provides the user with
3773ae12b187SLois Curfman McInnes   maximum flexibility in evaluating the many nonlinear solvers.
3774ae12b187SLois Curfman McInnes   The SNESSetType() routine is provided for those situations where it
3775ae12b187SLois Curfman McInnes   is necessary to set the nonlinear solver independently of the command
3776ae12b187SLois Curfman McInnes   line or options database.  This might be the case, for example, when
3777ae12b187SLois Curfman McInnes   the choice of solver changes during the execution of the program,
3778ae12b187SLois Curfman McInnes   and the user's application is taking responsibility for choosing the
3779b0a32e0cSBarry Smith   appropriate method.
378036851e7fSLois Curfman McInnes 
378136851e7fSLois Curfman McInnes   Level: intermediate
3782a703fe33SLois Curfman McInnes 
3783454a90a3SBarry Smith .keywords: SNES, set, type
3784435da068SBarry Smith 
3785435da068SBarry Smith .seealso: SNESType, SNESCreate()
3786435da068SBarry Smith 
37879b94acceSBarry Smith @*/
378819fd82e9SBarry Smith PetscErrorCode  SNESSetType(SNES snes,SNESType type)
37899b94acceSBarry Smith {
3790dfbe8321SBarry Smith   PetscErrorCode ierr,(*r)(SNES);
3791ace3abfcSBarry Smith   PetscBool      match;
37923a40ed3dSBarry Smith 
37933a40ed3dSBarry Smith   PetscFunctionBegin;
37940700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
37954482741eSBarry Smith   PetscValidCharPointer(type,2);
379682bf6240SBarry Smith 
3797251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)snes,type,&match);CHKERRQ(ierr);
37980f5bd95cSBarry Smith   if (match) PetscFunctionReturn(0);
379992ff6ae8SBarry Smith 
38004b91b6eaSBarry Smith   ierr =  PetscFListFind(SNESList,((PetscObject)snes)->comm,type,PETSC_TRUE,(void (**)(void)) &r);CHKERRQ(ierr);
3801e32f2f54SBarry Smith   if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested SNES type %s",type);
380275396ef9SLisandro Dalcin   /* Destroy the previous private SNES context */
3803b5c23020SJed Brown   if (snes->ops->destroy) {
3804b5c23020SJed Brown     ierr = (*(snes)->ops->destroy)(snes);CHKERRQ(ierr);
3805b5c23020SJed Brown     snes->ops->destroy = PETSC_NULL;
3806b5c23020SJed Brown   }
380775396ef9SLisandro Dalcin   /* Reinitialize function pointers in SNESOps structure */
380875396ef9SLisandro Dalcin   snes->ops->setup          = 0;
380975396ef9SLisandro Dalcin   snes->ops->solve          = 0;
381075396ef9SLisandro Dalcin   snes->ops->view           = 0;
381175396ef9SLisandro Dalcin   snes->ops->setfromoptions = 0;
381275396ef9SLisandro Dalcin   snes->ops->destroy        = 0;
381375396ef9SLisandro Dalcin   /* Call the SNESCreate_XXX routine for this particular Nonlinear solver */
381475396ef9SLisandro Dalcin   snes->setupcalled = PETSC_FALSE;
3815454a90a3SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)snes,type);CHKERRQ(ierr);
381603bfa161SLisandro Dalcin   ierr = (*r)(snes);CHKERRQ(ierr);
38179fb22e1aSBarry Smith #if defined(PETSC_HAVE_AMS)
38189fb22e1aSBarry Smith   if (PetscAMSPublishAll) {
38199fb22e1aSBarry Smith     ierr = PetscObjectAMSPublish((PetscObject)snes);CHKERRQ(ierr);
38209fb22e1aSBarry Smith   }
38219fb22e1aSBarry Smith #endif
38223a40ed3dSBarry Smith   PetscFunctionReturn(0);
38239b94acceSBarry Smith }
38249b94acceSBarry Smith 
3825a847f771SSatish Balay 
38269b94acceSBarry Smith /* --------------------------------------------------------------------- */
38274a2ae208SSatish Balay #undef __FUNCT__
38284a2ae208SSatish Balay #define __FUNCT__ "SNESRegisterDestroy"
382952baeb72SSatish Balay /*@
38309b94acceSBarry Smith    SNESRegisterDestroy - Frees the list of nonlinear solvers that were
3831f1af5d2fSBarry Smith    registered by SNESRegisterDynamic().
38329b94acceSBarry Smith 
3833fee21e36SBarry Smith    Not Collective
3834fee21e36SBarry Smith 
383536851e7fSLois Curfman McInnes    Level: advanced
383636851e7fSLois Curfman McInnes 
38379b94acceSBarry Smith .keywords: SNES, nonlinear, register, destroy
38389b94acceSBarry Smith 
38399b94acceSBarry Smith .seealso: SNESRegisterAll(), SNESRegisterAll()
38409b94acceSBarry Smith @*/
38417087cfbeSBarry Smith PetscErrorCode  SNESRegisterDestroy(void)
38429b94acceSBarry Smith {
3843dfbe8321SBarry Smith   PetscErrorCode ierr;
384482bf6240SBarry Smith 
38453a40ed3dSBarry Smith   PetscFunctionBegin;
38461441b1d3SBarry Smith   ierr = PetscFListDestroy(&SNESList);CHKERRQ(ierr);
38474c49b128SBarry Smith   SNESRegisterAllCalled = PETSC_FALSE;
38483a40ed3dSBarry Smith   PetscFunctionReturn(0);
38499b94acceSBarry Smith }
38509b94acceSBarry Smith 
38514a2ae208SSatish Balay #undef __FUNCT__
38524a2ae208SSatish Balay #define __FUNCT__ "SNESGetType"
38539b94acceSBarry Smith /*@C
38549a28b0a6SLois Curfman McInnes    SNESGetType - Gets the SNES method type and name (as a string).
38559b94acceSBarry Smith 
3856c7afd0dbSLois Curfman McInnes    Not Collective
3857c7afd0dbSLois Curfman McInnes 
38589b94acceSBarry Smith    Input Parameter:
38594b0e389bSBarry Smith .  snes - nonlinear solver context
38609b94acceSBarry Smith 
38619b94acceSBarry Smith    Output Parameter:
38623a7fca6bSBarry Smith .  type - SNES method (a character string)
38639b94acceSBarry Smith 
386436851e7fSLois Curfman McInnes    Level: intermediate
386536851e7fSLois Curfman McInnes 
3866454a90a3SBarry Smith .keywords: SNES, nonlinear, get, type, name
38679b94acceSBarry Smith @*/
386819fd82e9SBarry Smith PetscErrorCode  SNESGetType(SNES snes,SNESType *type)
38699b94acceSBarry Smith {
38703a40ed3dSBarry Smith   PetscFunctionBegin;
38710700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
38724482741eSBarry Smith   PetscValidPointer(type,2);
38737adad957SLisandro Dalcin   *type = ((PetscObject)snes)->type_name;
38743a40ed3dSBarry Smith   PetscFunctionReturn(0);
38759b94acceSBarry Smith }
38769b94acceSBarry Smith 
38774a2ae208SSatish Balay #undef __FUNCT__
38784a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolution"
387952baeb72SSatish Balay /*@
38809b94acceSBarry Smith    SNESGetSolution - Returns the vector where the approximate solution is
3881c0df2a02SJed Brown    stored. This is the fine grid solution when using SNESSetGridSequence().
38829b94acceSBarry Smith 
3883c7afd0dbSLois Curfman McInnes    Not Collective, but Vec is parallel if SNES is parallel
3884c7afd0dbSLois Curfman McInnes 
38859b94acceSBarry Smith    Input Parameter:
38869b94acceSBarry Smith .  snes - the SNES context
38879b94acceSBarry Smith 
38889b94acceSBarry Smith    Output Parameter:
38899b94acceSBarry Smith .  x - the solution
38909b94acceSBarry Smith 
389170e92668SMatthew Knepley    Level: intermediate
389236851e7fSLois Curfman McInnes 
38939b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution
38949b94acceSBarry Smith 
389585385478SLisandro Dalcin .seealso:  SNESGetSolutionUpdate(), SNESGetFunction()
38969b94acceSBarry Smith @*/
38977087cfbeSBarry Smith PetscErrorCode  SNESGetSolution(SNES snes,Vec *x)
38989b94acceSBarry Smith {
38993a40ed3dSBarry Smith   PetscFunctionBegin;
39000700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
39014482741eSBarry Smith   PetscValidPointer(x,2);
390285385478SLisandro Dalcin   *x = snes->vec_sol;
390370e92668SMatthew Knepley   PetscFunctionReturn(0);
390470e92668SMatthew Knepley }
390570e92668SMatthew Knepley 
390670e92668SMatthew Knepley #undef __FUNCT__
39074a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolutionUpdate"
390852baeb72SSatish Balay /*@
39099b94acceSBarry Smith    SNESGetSolutionUpdate - Returns the vector where the solution update is
39109b94acceSBarry Smith    stored.
39119b94acceSBarry Smith 
3912c7afd0dbSLois Curfman McInnes    Not Collective, but Vec is parallel if SNES is parallel
3913c7afd0dbSLois Curfman McInnes 
39149b94acceSBarry Smith    Input Parameter:
39159b94acceSBarry Smith .  snes - the SNES context
39169b94acceSBarry Smith 
39179b94acceSBarry Smith    Output Parameter:
39189b94acceSBarry Smith .  x - the solution update
39199b94acceSBarry Smith 
392036851e7fSLois Curfman McInnes    Level: advanced
392136851e7fSLois Curfman McInnes 
39229b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution, update
39239b94acceSBarry Smith 
392485385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction()
39259b94acceSBarry Smith @*/
39267087cfbeSBarry Smith PetscErrorCode  SNESGetSolutionUpdate(SNES snes,Vec *x)
39279b94acceSBarry Smith {
39283a40ed3dSBarry Smith   PetscFunctionBegin;
39290700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
39304482741eSBarry Smith   PetscValidPointer(x,2);
393185385478SLisandro Dalcin   *x = snes->vec_sol_update;
39323a40ed3dSBarry Smith   PetscFunctionReturn(0);
39339b94acceSBarry Smith }
39349b94acceSBarry Smith 
39354a2ae208SSatish Balay #undef __FUNCT__
39364a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunction"
39379b94acceSBarry Smith /*@C
39383638b69dSLois Curfman McInnes    SNESGetFunction - Returns the vector where the function is stored.
39399b94acceSBarry Smith 
3940a63bb30eSJed Brown    Not Collective, but Vec is parallel if SNES is parallel. Collective if Vec is requested, but has not been created yet.
3941c7afd0dbSLois Curfman McInnes 
39429b94acceSBarry Smith    Input Parameter:
39439b94acceSBarry Smith .  snes - the SNES context
39449b94acceSBarry Smith 
39459b94acceSBarry Smith    Output Parameter:
39467bf4e008SBarry Smith +  r - the function (or PETSC_NULL)
394770e92668SMatthew Knepley .  func - the function (or PETSC_NULL)
394870e92668SMatthew Knepley -  ctx - the function context (or PETSC_NULL)
39499b94acceSBarry Smith 
395036851e7fSLois Curfman McInnes    Level: advanced
395136851e7fSLois Curfman McInnes 
3952a86d99e1SLois Curfman McInnes .keywords: SNES, nonlinear, get, function
39539b94acceSBarry Smith 
39544b27c08aSLois Curfman McInnes .seealso: SNESSetFunction(), SNESGetSolution()
39559b94acceSBarry Smith @*/
39567087cfbeSBarry Smith PetscErrorCode  SNESGetFunction(SNES snes,Vec *r,PetscErrorCode (**func)(SNES,Vec,Vec,void*),void **ctx)
39579b94acceSBarry Smith {
3958a63bb30eSJed Brown   PetscErrorCode ierr;
39596cab3a1bSJed Brown   DM             dm;
3960a63bb30eSJed Brown 
39613a40ed3dSBarry Smith   PetscFunctionBegin;
39620700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3963a63bb30eSJed Brown   if (r) {
3964a63bb30eSJed Brown     if (!snes->vec_func) {
3965a63bb30eSJed Brown       if (snes->vec_rhs) {
3966a63bb30eSJed Brown         ierr = VecDuplicate(snes->vec_rhs,&snes->vec_func);CHKERRQ(ierr);
3967a63bb30eSJed Brown       } else if (snes->vec_sol) {
3968a63bb30eSJed Brown         ierr = VecDuplicate(snes->vec_sol,&snes->vec_func);CHKERRQ(ierr);
3969a63bb30eSJed Brown       } else if (snes->dm) {
3970a63bb30eSJed Brown         ierr = DMCreateGlobalVector(snes->dm,&snes->vec_func);CHKERRQ(ierr);
3971a63bb30eSJed Brown       }
3972a63bb30eSJed Brown     }
3973a63bb30eSJed Brown     *r = snes->vec_func;
3974a63bb30eSJed Brown   }
39756cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
39766cab3a1bSJed Brown   ierr = DMSNESGetFunction(dm,func,ctx);CHKERRQ(ierr);
39773a40ed3dSBarry Smith   PetscFunctionReturn(0);
39789b94acceSBarry Smith }
39799b94acceSBarry Smith 
3980c79ef259SPeter Brune /*@C
3981c79ef259SPeter Brune    SNESGetGS - Returns the GS function and context.
3982c79ef259SPeter Brune 
3983c79ef259SPeter Brune    Input Parameter:
3984c79ef259SPeter Brune .  snes - the SNES context
3985c79ef259SPeter Brune 
3986c79ef259SPeter Brune    Output Parameter:
3987c79ef259SPeter Brune +  gsfunc - the function (or PETSC_NULL)
3988c79ef259SPeter Brune -  ctx    - the function context (or PETSC_NULL)
3989c79ef259SPeter Brune 
3990c79ef259SPeter Brune    Level: advanced
3991c79ef259SPeter Brune 
3992c79ef259SPeter Brune .keywords: SNES, nonlinear, get, function
3993c79ef259SPeter Brune 
3994c79ef259SPeter Brune .seealso: SNESSetGS(), SNESGetFunction()
3995c79ef259SPeter Brune @*/
3996c79ef259SPeter Brune 
39974a2ae208SSatish Balay #undef __FUNCT__
3998646217ecSPeter Brune #define __FUNCT__ "SNESGetGS"
3999646217ecSPeter Brune PetscErrorCode SNESGetGS (SNES snes, PetscErrorCode(**func)(SNES, Vec, Vec, void*), void ** ctx)
4000646217ecSPeter Brune {
40016cab3a1bSJed Brown   PetscErrorCode ierr;
40026cab3a1bSJed Brown   DM             dm;
40036cab3a1bSJed Brown 
4004646217ecSPeter Brune   PetscFunctionBegin;
4005646217ecSPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
40066cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
40076cab3a1bSJed Brown   ierr = DMSNESGetGS(dm,func,ctx);CHKERRQ(ierr);
4008646217ecSPeter Brune   PetscFunctionReturn(0);
4009646217ecSPeter Brune }
4010646217ecSPeter Brune 
40114a2ae208SSatish Balay #undef __FUNCT__
40124a2ae208SSatish Balay #define __FUNCT__ "SNESSetOptionsPrefix"
40133c7409f5SSatish Balay /*@C
40143c7409f5SSatish Balay    SNESSetOptionsPrefix - Sets the prefix used for searching for all
4015d850072dSLois Curfman McInnes    SNES options in the database.
40163c7409f5SSatish Balay 
40173f9fe445SBarry Smith    Logically Collective on SNES
4018fee21e36SBarry Smith 
4019c7afd0dbSLois Curfman McInnes    Input Parameter:
4020c7afd0dbSLois Curfman McInnes +  snes - the SNES context
4021c7afd0dbSLois Curfman McInnes -  prefix - the prefix to prepend to all option names
4022c7afd0dbSLois Curfman McInnes 
4023d850072dSLois Curfman McInnes    Notes:
4024a83b1b31SSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
4025c7afd0dbSLois Curfman McInnes    The first character of all runtime options is AUTOMATICALLY the hyphen.
4026d850072dSLois Curfman McInnes 
402736851e7fSLois Curfman McInnes    Level: advanced
402836851e7fSLois Curfman McInnes 
40293c7409f5SSatish Balay .keywords: SNES, set, options, prefix, database
4030a86d99e1SLois Curfman McInnes 
4031a86d99e1SLois Curfman McInnes .seealso: SNESSetFromOptions()
40323c7409f5SSatish Balay @*/
40337087cfbeSBarry Smith PetscErrorCode  SNESSetOptionsPrefix(SNES snes,const char prefix[])
40343c7409f5SSatish Balay {
4035dfbe8321SBarry Smith   PetscErrorCode ierr;
40363c7409f5SSatish Balay 
40373a40ed3dSBarry Smith   PetscFunctionBegin;
40380700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4039639f9d9dSBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
40401cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
404135f5d045SPeter Brune   if (snes->linesearch) {
404235f5d045SPeter Brune     ierr = SNESGetSNESLineSearch(snes,&snes->linesearch);CHKERRQ(ierr);
404308b6c495SPeter Brune     ierr = PetscObjectSetOptionsPrefix((PetscObject)snes->linesearch,prefix);CHKERRQ(ierr);
404435f5d045SPeter Brune   }
404535f5d045SPeter Brune   ierr = KSPSetOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr);
40463a40ed3dSBarry Smith   PetscFunctionReturn(0);
40473c7409f5SSatish Balay }
40483c7409f5SSatish Balay 
40494a2ae208SSatish Balay #undef __FUNCT__
40504a2ae208SSatish Balay #define __FUNCT__ "SNESAppendOptionsPrefix"
40513c7409f5SSatish Balay /*@C
4052f525115eSLois Curfman McInnes    SNESAppendOptionsPrefix - Appends to the prefix used for searching for all
4053d850072dSLois Curfman McInnes    SNES options in the database.
40543c7409f5SSatish Balay 
40553f9fe445SBarry Smith    Logically Collective on SNES
4056fee21e36SBarry Smith 
4057c7afd0dbSLois Curfman McInnes    Input Parameters:
4058c7afd0dbSLois Curfman McInnes +  snes - the SNES context
4059c7afd0dbSLois Curfman McInnes -  prefix - the prefix to prepend to all option names
4060c7afd0dbSLois Curfman McInnes 
4061d850072dSLois Curfman McInnes    Notes:
4062a83b1b31SSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
4063c7afd0dbSLois Curfman McInnes    The first character of all runtime options is AUTOMATICALLY the hyphen.
4064d850072dSLois Curfman McInnes 
406536851e7fSLois Curfman McInnes    Level: advanced
406636851e7fSLois Curfman McInnes 
40673c7409f5SSatish Balay .keywords: SNES, append, options, prefix, database
4068a86d99e1SLois Curfman McInnes 
4069a86d99e1SLois Curfman McInnes .seealso: SNESGetOptionsPrefix()
40703c7409f5SSatish Balay @*/
40717087cfbeSBarry Smith PetscErrorCode  SNESAppendOptionsPrefix(SNES snes,const char prefix[])
40723c7409f5SSatish Balay {
4073dfbe8321SBarry Smith   PetscErrorCode ierr;
40743c7409f5SSatish Balay 
40753a40ed3dSBarry Smith   PetscFunctionBegin;
40760700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4077639f9d9dSBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
40781cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
407935f5d045SPeter Brune   if (snes->linesearch) {
408035f5d045SPeter Brune     ierr = SNESGetSNESLineSearch(snes,&snes->linesearch);CHKERRQ(ierr);
408108b6c495SPeter Brune     ierr = PetscObjectAppendOptionsPrefix((PetscObject)snes->linesearch,prefix);CHKERRQ(ierr);
408235f5d045SPeter Brune   }
408335f5d045SPeter Brune   ierr = KSPAppendOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr);
40843a40ed3dSBarry Smith   PetscFunctionReturn(0);
40853c7409f5SSatish Balay }
40863c7409f5SSatish Balay 
40874a2ae208SSatish Balay #undef __FUNCT__
40884a2ae208SSatish Balay #define __FUNCT__ "SNESGetOptionsPrefix"
40899ab63eb5SSatish Balay /*@C
40903c7409f5SSatish Balay    SNESGetOptionsPrefix - Sets the prefix used for searching for all
40913c7409f5SSatish Balay    SNES options in the database.
40923c7409f5SSatish Balay 
4093c7afd0dbSLois Curfman McInnes    Not Collective
4094c7afd0dbSLois Curfman McInnes 
40953c7409f5SSatish Balay    Input Parameter:
40963c7409f5SSatish Balay .  snes - the SNES context
40973c7409f5SSatish Balay 
40983c7409f5SSatish Balay    Output Parameter:
40993c7409f5SSatish Balay .  prefix - pointer to the prefix string used
41003c7409f5SSatish Balay 
41014ef407dbSRichard Tran Mills    Notes: On the fortran side, the user should pass in a string 'prefix' of
41029ab63eb5SSatish Balay    sufficient length to hold the prefix.
41039ab63eb5SSatish Balay 
410436851e7fSLois Curfman McInnes    Level: advanced
410536851e7fSLois Curfman McInnes 
41063c7409f5SSatish Balay .keywords: SNES, get, options, prefix, database
4107a86d99e1SLois Curfman McInnes 
4108a86d99e1SLois Curfman McInnes .seealso: SNESAppendOptionsPrefix()
41093c7409f5SSatish Balay @*/
41107087cfbeSBarry Smith PetscErrorCode  SNESGetOptionsPrefix(SNES snes,const char *prefix[])
41113c7409f5SSatish Balay {
4112dfbe8321SBarry Smith   PetscErrorCode ierr;
41133c7409f5SSatish Balay 
41143a40ed3dSBarry Smith   PetscFunctionBegin;
41150700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4116639f9d9dSBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
41173a40ed3dSBarry Smith   PetscFunctionReturn(0);
41183c7409f5SSatish Balay }
41193c7409f5SSatish Balay 
4120b2002411SLois Curfman McInnes 
41214a2ae208SSatish Balay #undef __FUNCT__
41224a2ae208SSatish Balay #define __FUNCT__ "SNESRegister"
41233cea93caSBarry Smith /*@C
41243cea93caSBarry Smith   SNESRegister - See SNESRegisterDynamic()
41253cea93caSBarry Smith 
41267f6c08e0SMatthew Knepley   Level: advanced
41273cea93caSBarry Smith @*/
41287087cfbeSBarry Smith PetscErrorCode  SNESRegister(const char sname[],const char path[],const char name[],PetscErrorCode (*function)(SNES))
4129b2002411SLois Curfman McInnes {
4130e2d1d2b7SBarry Smith   char           fullname[PETSC_MAX_PATH_LEN];
4131dfbe8321SBarry Smith   PetscErrorCode ierr;
4132b2002411SLois Curfman McInnes 
4133b2002411SLois Curfman McInnes   PetscFunctionBegin;
4134b0a32e0cSBarry Smith   ierr = PetscFListConcat(path,name,fullname);CHKERRQ(ierr);
4135c134de8dSSatish Balay   ierr = PetscFListAdd(&SNESList,sname,fullname,(void (*)(void))function);CHKERRQ(ierr);
4136b2002411SLois Curfman McInnes   PetscFunctionReturn(0);
4137b2002411SLois Curfman McInnes }
4138da9b6338SBarry Smith 
4139da9b6338SBarry Smith #undef __FUNCT__
4140da9b6338SBarry Smith #define __FUNCT__ "SNESTestLocalMin"
41417087cfbeSBarry Smith PetscErrorCode  SNESTestLocalMin(SNES snes)
4142da9b6338SBarry Smith {
4143dfbe8321SBarry Smith   PetscErrorCode ierr;
414477431f27SBarry Smith   PetscInt       N,i,j;
4145da9b6338SBarry Smith   Vec            u,uh,fh;
4146da9b6338SBarry Smith   PetscScalar    value;
4147da9b6338SBarry Smith   PetscReal      norm;
4148da9b6338SBarry Smith 
4149da9b6338SBarry Smith   PetscFunctionBegin;
4150da9b6338SBarry Smith   ierr = SNESGetSolution(snes,&u);CHKERRQ(ierr);
4151da9b6338SBarry Smith   ierr = VecDuplicate(u,&uh);CHKERRQ(ierr);
4152da9b6338SBarry Smith   ierr = VecDuplicate(u,&fh);CHKERRQ(ierr);
4153da9b6338SBarry Smith 
4154da9b6338SBarry Smith   /* currently only works for sequential */
4155da9b6338SBarry Smith   ierr = PetscPrintf(PETSC_COMM_WORLD,"Testing FormFunction() for local min\n");
4156da9b6338SBarry Smith   ierr = VecGetSize(u,&N);CHKERRQ(ierr);
4157da9b6338SBarry Smith   for (i=0; i<N; i++) {
4158da9b6338SBarry Smith     ierr = VecCopy(u,uh);CHKERRQ(ierr);
415977431f27SBarry Smith     ierr  = PetscPrintf(PETSC_COMM_WORLD,"i = %D\n",i);CHKERRQ(ierr);
4160da9b6338SBarry Smith     for (j=-10; j<11; j++) {
4161ccae9161SBarry Smith       value = PetscSign(j)*exp(PetscAbs(j)-10.0);
4162da9b6338SBarry Smith       ierr  = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr);
41633ab0aad5SBarry Smith       ierr  = SNESComputeFunction(snes,uh,fh);CHKERRQ(ierr);
4164da9b6338SBarry Smith       ierr  = VecNorm(fh,NORM_2,&norm);CHKERRQ(ierr);
416577431f27SBarry Smith       ierr  = PetscPrintf(PETSC_COMM_WORLD,"       j norm %D %18.16e\n",j,norm);CHKERRQ(ierr);
4166da9b6338SBarry Smith       value = -value;
4167da9b6338SBarry Smith       ierr  = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr);
4168da9b6338SBarry Smith     }
4169da9b6338SBarry Smith   }
41706bf464f9SBarry Smith   ierr = VecDestroy(&uh);CHKERRQ(ierr);
41716bf464f9SBarry Smith   ierr = VecDestroy(&fh);CHKERRQ(ierr);
4172da9b6338SBarry Smith   PetscFunctionReturn(0);
4173da9b6338SBarry Smith }
417471f87433Sdalcinl 
417571f87433Sdalcinl #undef __FUNCT__
4176fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetUseEW"
417771f87433Sdalcinl /*@
4178fa9f3622SBarry Smith    SNESKSPSetUseEW - Sets SNES use Eisenstat-Walker method for
417971f87433Sdalcinl    computing relative tolerance for linear solvers within an inexact
418071f87433Sdalcinl    Newton method.
418171f87433Sdalcinl 
41823f9fe445SBarry Smith    Logically Collective on SNES
418371f87433Sdalcinl 
418471f87433Sdalcinl    Input Parameters:
418571f87433Sdalcinl +  snes - SNES context
418671f87433Sdalcinl -  flag - PETSC_TRUE or PETSC_FALSE
418771f87433Sdalcinl 
418864ba62caSBarry Smith     Options Database:
418964ba62caSBarry Smith +  -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence
419064ba62caSBarry Smith .  -snes_ksp_ew_version ver - version of  Eisenstat-Walker method
419164ba62caSBarry Smith .  -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0
419264ba62caSBarry Smith .  -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax
419364ba62caSBarry Smith .  -snes_ksp_ew_gamma <gamma> - Sets gamma
419464ba62caSBarry Smith .  -snes_ksp_ew_alpha <alpha> - Sets alpha
419564ba62caSBarry Smith .  -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2
419664ba62caSBarry Smith -  -snes_ksp_ew_threshold <threshold> - Sets threshold
419764ba62caSBarry Smith 
419871f87433Sdalcinl    Notes:
419971f87433Sdalcinl    Currently, the default is to use a constant relative tolerance for
420071f87433Sdalcinl    the inner linear solvers.  Alternatively, one can use the
420171f87433Sdalcinl    Eisenstat-Walker method, where the relative convergence tolerance
420271f87433Sdalcinl    is reset at each Newton iteration according progress of the nonlinear
420371f87433Sdalcinl    solver.
420471f87433Sdalcinl 
420571f87433Sdalcinl    Level: advanced
420671f87433Sdalcinl 
420771f87433Sdalcinl    Reference:
420871f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
420971f87433Sdalcinl    inexact Newton method", SISC 17 (1), pp.16-32, 1996.
421071f87433Sdalcinl 
421171f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton
421271f87433Sdalcinl 
4213fa9f3622SBarry Smith .seealso: SNESKSPGetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW()
421471f87433Sdalcinl @*/
42157087cfbeSBarry Smith PetscErrorCode  SNESKSPSetUseEW(SNES snes,PetscBool  flag)
421671f87433Sdalcinl {
421771f87433Sdalcinl   PetscFunctionBegin;
42180700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4219acfcf0e5SJed Brown   PetscValidLogicalCollectiveBool(snes,flag,2);
422071f87433Sdalcinl   snes->ksp_ewconv = flag;
422171f87433Sdalcinl   PetscFunctionReturn(0);
422271f87433Sdalcinl }
422371f87433Sdalcinl 
422471f87433Sdalcinl #undef __FUNCT__
4225fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetUseEW"
422671f87433Sdalcinl /*@
4227fa9f3622SBarry Smith    SNESKSPGetUseEW - Gets if SNES is using Eisenstat-Walker method
422871f87433Sdalcinl    for computing relative tolerance for linear solvers within an
422971f87433Sdalcinl    inexact Newton method.
423071f87433Sdalcinl 
423171f87433Sdalcinl    Not Collective
423271f87433Sdalcinl 
423371f87433Sdalcinl    Input Parameter:
423471f87433Sdalcinl .  snes - SNES context
423571f87433Sdalcinl 
423671f87433Sdalcinl    Output Parameter:
423771f87433Sdalcinl .  flag - PETSC_TRUE or PETSC_FALSE
423871f87433Sdalcinl 
423971f87433Sdalcinl    Notes:
424071f87433Sdalcinl    Currently, the default is to use a constant relative tolerance for
424171f87433Sdalcinl    the inner linear solvers.  Alternatively, one can use the
424271f87433Sdalcinl    Eisenstat-Walker method, where the relative convergence tolerance
424371f87433Sdalcinl    is reset at each Newton iteration according progress of the nonlinear
424471f87433Sdalcinl    solver.
424571f87433Sdalcinl 
424671f87433Sdalcinl    Level: advanced
424771f87433Sdalcinl 
424871f87433Sdalcinl    Reference:
424971f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
425071f87433Sdalcinl    inexact Newton method", SISC 17 (1), pp.16-32, 1996.
425171f87433Sdalcinl 
425271f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton
425371f87433Sdalcinl 
4254fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW()
425571f87433Sdalcinl @*/
42567087cfbeSBarry Smith PetscErrorCode  SNESKSPGetUseEW(SNES snes, PetscBool  *flag)
425771f87433Sdalcinl {
425871f87433Sdalcinl   PetscFunctionBegin;
42590700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
426071f87433Sdalcinl   PetscValidPointer(flag,2);
426171f87433Sdalcinl   *flag = snes->ksp_ewconv;
426271f87433Sdalcinl   PetscFunctionReturn(0);
426371f87433Sdalcinl }
426471f87433Sdalcinl 
426571f87433Sdalcinl #undef __FUNCT__
4266fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetParametersEW"
426771f87433Sdalcinl /*@
4268fa9f3622SBarry Smith    SNESKSPSetParametersEW - Sets parameters for Eisenstat-Walker
426971f87433Sdalcinl    convergence criteria for the linear solvers within an inexact
427071f87433Sdalcinl    Newton method.
427171f87433Sdalcinl 
42723f9fe445SBarry Smith    Logically Collective on SNES
427371f87433Sdalcinl 
427471f87433Sdalcinl    Input Parameters:
427571f87433Sdalcinl +    snes - SNES context
427671f87433Sdalcinl .    version - version 1, 2 (default is 2) or 3
427771f87433Sdalcinl .    rtol_0 - initial relative tolerance (0 <= rtol_0 < 1)
427871f87433Sdalcinl .    rtol_max - maximum relative tolerance (0 <= rtol_max < 1)
427971f87433Sdalcinl .    gamma - multiplicative factor for version 2 rtol computation
428071f87433Sdalcinl              (0 <= gamma2 <= 1)
428171f87433Sdalcinl .    alpha - power for version 2 rtol computation (1 < alpha <= 2)
428271f87433Sdalcinl .    alpha2 - power for safeguard
428371f87433Sdalcinl -    threshold - threshold for imposing safeguard (0 < threshold < 1)
428471f87433Sdalcinl 
428571f87433Sdalcinl    Note:
428671f87433Sdalcinl    Version 3 was contributed by Luis Chacon, June 2006.
428771f87433Sdalcinl 
428871f87433Sdalcinl    Use PETSC_DEFAULT to retain the default for any of the parameters.
428971f87433Sdalcinl 
429071f87433Sdalcinl    Level: advanced
429171f87433Sdalcinl 
429271f87433Sdalcinl    Reference:
429371f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
429471f87433Sdalcinl    inexact Newton method", Utah State University Math. Stat. Dept. Res.
429571f87433Sdalcinl    Report 6/94/75, June, 1994, to appear in SIAM J. Sci. Comput.
429671f87433Sdalcinl 
429771f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, set, parameters
429871f87433Sdalcinl 
4299fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPGetParametersEW()
430071f87433Sdalcinl @*/
43017087cfbeSBarry Smith PetscErrorCode  SNESKSPSetParametersEW(SNES snes,PetscInt version,PetscReal rtol_0,PetscReal rtol_max,
430271f87433Sdalcinl 							    PetscReal gamma,PetscReal alpha,PetscReal alpha2,PetscReal threshold)
430371f87433Sdalcinl {
4304fa9f3622SBarry Smith   SNESKSPEW *kctx;
430571f87433Sdalcinl   PetscFunctionBegin;
43060700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4307fa9f3622SBarry Smith   kctx = (SNESKSPEW*)snes->kspconvctx;
4308e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing");
4309c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,version,2);
4310c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol_0,3);
4311c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol_max,4);
4312c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,gamma,5);
4313c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,alpha,6);
4314c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,alpha2,7);
4315c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,threshold,8);
431671f87433Sdalcinl 
431771f87433Sdalcinl   if (version != PETSC_DEFAULT)   kctx->version   = version;
431871f87433Sdalcinl   if (rtol_0 != PETSC_DEFAULT)    kctx->rtol_0    = rtol_0;
431971f87433Sdalcinl   if (rtol_max != PETSC_DEFAULT)  kctx->rtol_max  = rtol_max;
432071f87433Sdalcinl   if (gamma != PETSC_DEFAULT)     kctx->gamma     = gamma;
432171f87433Sdalcinl   if (alpha != PETSC_DEFAULT)     kctx->alpha     = alpha;
432271f87433Sdalcinl   if (alpha2 != PETSC_DEFAULT)    kctx->alpha2    = alpha2;
432371f87433Sdalcinl   if (threshold != PETSC_DEFAULT) kctx->threshold = threshold;
432471f87433Sdalcinl 
432571f87433Sdalcinl   if (kctx->version < 1 || kctx->version > 3) {
4326e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 and 3 are supported: %D",kctx->version);
432771f87433Sdalcinl   }
432871f87433Sdalcinl   if (kctx->rtol_0 < 0.0 || kctx->rtol_0 >= 1.0) {
4329e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_0 < 1.0: %G",kctx->rtol_0);
433071f87433Sdalcinl   }
433171f87433Sdalcinl   if (kctx->rtol_max < 0.0 || kctx->rtol_max >= 1.0) {
4332e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_max (%G) < 1.0\n",kctx->rtol_max);
433371f87433Sdalcinl   }
433471f87433Sdalcinl   if (kctx->gamma < 0.0 || kctx->gamma > 1.0) {
4335e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= gamma (%G) <= 1.0\n",kctx->gamma);
433671f87433Sdalcinl   }
433771f87433Sdalcinl   if (kctx->alpha <= 1.0 || kctx->alpha > 2.0) {
4338e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"1.0 < alpha (%G) <= 2.0\n",kctx->alpha);
433971f87433Sdalcinl   }
434071f87433Sdalcinl   if (kctx->threshold <= 0.0 || kctx->threshold >= 1.0) {
4341e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 < threshold (%G) < 1.0\n",kctx->threshold);
434271f87433Sdalcinl   }
434371f87433Sdalcinl   PetscFunctionReturn(0);
434471f87433Sdalcinl }
434571f87433Sdalcinl 
434671f87433Sdalcinl #undef __FUNCT__
4347fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetParametersEW"
434871f87433Sdalcinl /*@
4349fa9f3622SBarry Smith    SNESKSPGetParametersEW - Gets parameters for Eisenstat-Walker
435071f87433Sdalcinl    convergence criteria for the linear solvers within an inexact
435171f87433Sdalcinl    Newton method.
435271f87433Sdalcinl 
435371f87433Sdalcinl    Not Collective
435471f87433Sdalcinl 
435571f87433Sdalcinl    Input Parameters:
435671f87433Sdalcinl      snes - SNES context
435771f87433Sdalcinl 
435871f87433Sdalcinl    Output Parameters:
435971f87433Sdalcinl +    version - version 1, 2 (default is 2) or 3
436071f87433Sdalcinl .    rtol_0 - initial relative tolerance (0 <= rtol_0 < 1)
436171f87433Sdalcinl .    rtol_max - maximum relative tolerance (0 <= rtol_max < 1)
436271f87433Sdalcinl .    gamma - multiplicative factor for version 2 rtol computation
436371f87433Sdalcinl              (0 <= gamma2 <= 1)
436471f87433Sdalcinl .    alpha - power for version 2 rtol computation (1 < alpha <= 2)
436571f87433Sdalcinl .    alpha2 - power for safeguard
436671f87433Sdalcinl -    threshold - threshold for imposing safeguard (0 < threshold < 1)
436771f87433Sdalcinl 
436871f87433Sdalcinl    Level: advanced
436971f87433Sdalcinl 
437071f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, get, parameters
437171f87433Sdalcinl 
4372fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPSetParametersEW()
437371f87433Sdalcinl @*/
43747087cfbeSBarry Smith PetscErrorCode  SNESKSPGetParametersEW(SNES snes,PetscInt *version,PetscReal *rtol_0,PetscReal *rtol_max,
437571f87433Sdalcinl 							    PetscReal *gamma,PetscReal *alpha,PetscReal *alpha2,PetscReal *threshold)
437671f87433Sdalcinl {
4377fa9f3622SBarry Smith   SNESKSPEW *kctx;
437871f87433Sdalcinl   PetscFunctionBegin;
43790700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4380fa9f3622SBarry Smith   kctx = (SNESKSPEW*)snes->kspconvctx;
4381e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing");
438271f87433Sdalcinl   if (version)   *version   = kctx->version;
438371f87433Sdalcinl   if (rtol_0)    *rtol_0    = kctx->rtol_0;
438471f87433Sdalcinl   if (rtol_max)  *rtol_max  = kctx->rtol_max;
438571f87433Sdalcinl   if (gamma)     *gamma     = kctx->gamma;
438671f87433Sdalcinl   if (alpha)     *alpha     = kctx->alpha;
438771f87433Sdalcinl   if (alpha2)    *alpha2    = kctx->alpha2;
438871f87433Sdalcinl   if (threshold) *threshold = kctx->threshold;
438971f87433Sdalcinl   PetscFunctionReturn(0);
439071f87433Sdalcinl }
439171f87433Sdalcinl 
439271f87433Sdalcinl #undef __FUNCT__
4393fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PreSolve"
4394fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PreSolve(SNES snes, KSP ksp, Vec b, Vec x)
439571f87433Sdalcinl {
439671f87433Sdalcinl   PetscErrorCode ierr;
4397fa9f3622SBarry Smith   SNESKSPEW      *kctx = (SNESKSPEW*)snes->kspconvctx;
439871f87433Sdalcinl   PetscReal      rtol=PETSC_DEFAULT,stol;
439971f87433Sdalcinl 
440071f87433Sdalcinl   PetscFunctionBegin;
4401e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists");
440271f87433Sdalcinl   if (!snes->iter) { /* first time in, so use the original user rtol */
440371f87433Sdalcinl     rtol = kctx->rtol_0;
440471f87433Sdalcinl   } else {
440571f87433Sdalcinl     if (kctx->version == 1) {
440671f87433Sdalcinl       rtol = (snes->norm - kctx->lresid_last)/kctx->norm_last;
440771f87433Sdalcinl       if (rtol < 0.0) rtol = -rtol;
440871f87433Sdalcinl       stol = pow(kctx->rtol_last,kctx->alpha2);
440971f87433Sdalcinl       if (stol > kctx->threshold) rtol = PetscMax(rtol,stol);
441071f87433Sdalcinl     } else if (kctx->version == 2) {
441171f87433Sdalcinl       rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha);
441271f87433Sdalcinl       stol = kctx->gamma * pow(kctx->rtol_last,kctx->alpha);
441371f87433Sdalcinl       if (stol > kctx->threshold) rtol = PetscMax(rtol,stol);
441471f87433Sdalcinl     } else if (kctx->version == 3) {/* contributed by Luis Chacon, June 2006. */
441571f87433Sdalcinl       rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha);
441671f87433Sdalcinl       /* safeguard: avoid sharp decrease of rtol */
441771f87433Sdalcinl       stol = kctx->gamma*pow(kctx->rtol_last,kctx->alpha);
441871f87433Sdalcinl       stol = PetscMax(rtol,stol);
441971f87433Sdalcinl       rtol = PetscMin(kctx->rtol_0,stol);
442071f87433Sdalcinl       /* safeguard: avoid oversolving */
442171f87433Sdalcinl       stol = kctx->gamma*(snes->ttol)/snes->norm;
442271f87433Sdalcinl       stol = PetscMax(rtol,stol);
442371f87433Sdalcinl       rtol = PetscMin(kctx->rtol_0,stol);
4424e32f2f54SBarry Smith     } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 or 3 are supported: %D",kctx->version);
442571f87433Sdalcinl   }
442671f87433Sdalcinl   /* safeguard: avoid rtol greater than one */
442771f87433Sdalcinl   rtol = PetscMin(rtol,kctx->rtol_max);
442871f87433Sdalcinl   ierr = KSPSetTolerances(ksp,rtol,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT);CHKERRQ(ierr);
442971f87433Sdalcinl   ierr = PetscInfo3(snes,"iter %D, Eisenstat-Walker (version %D) KSP rtol=%G\n",snes->iter,kctx->version,rtol);CHKERRQ(ierr);
443071f87433Sdalcinl   PetscFunctionReturn(0);
443171f87433Sdalcinl }
443271f87433Sdalcinl 
443371f87433Sdalcinl #undef __FUNCT__
4434fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PostSolve"
4435fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PostSolve(SNES snes, KSP ksp, Vec b, Vec x)
443671f87433Sdalcinl {
443771f87433Sdalcinl   PetscErrorCode ierr;
4438fa9f3622SBarry Smith   SNESKSPEW      *kctx = (SNESKSPEW*)snes->kspconvctx;
443971f87433Sdalcinl   PCSide         pcside;
444071f87433Sdalcinl   Vec            lres;
444171f87433Sdalcinl 
444271f87433Sdalcinl   PetscFunctionBegin;
4443e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists");
444471f87433Sdalcinl   ierr = KSPGetTolerances(ksp,&kctx->rtol_last,0,0,0);CHKERRQ(ierr);
444571f87433Sdalcinl   ierr = SNESGetFunctionNorm(snes,&kctx->norm_last);CHKERRQ(ierr);
444671f87433Sdalcinl   if (kctx->version == 1) {
4447b037da10SBarry Smith     ierr = KSPGetPCSide(ksp,&pcside);CHKERRQ(ierr);
444871f87433Sdalcinl     if (pcside == PC_RIGHT) { /* XXX Should we also test KSP_UNPRECONDITIONED_NORM ? */
444971f87433Sdalcinl       /* KSP residual is true linear residual */
445071f87433Sdalcinl       ierr = KSPGetResidualNorm(ksp,&kctx->lresid_last);CHKERRQ(ierr);
445171f87433Sdalcinl     } else {
445271f87433Sdalcinl       /* KSP residual is preconditioned residual */
445371f87433Sdalcinl       /* compute true linear residual norm */
445471f87433Sdalcinl       ierr = VecDuplicate(b,&lres);CHKERRQ(ierr);
445571f87433Sdalcinl       ierr = MatMult(snes->jacobian,x,lres);CHKERRQ(ierr);
445671f87433Sdalcinl       ierr = VecAYPX(lres,-1.0,b);CHKERRQ(ierr);
445771f87433Sdalcinl       ierr = VecNorm(lres,NORM_2,&kctx->lresid_last);CHKERRQ(ierr);
44586bf464f9SBarry Smith       ierr = VecDestroy(&lres);CHKERRQ(ierr);
445971f87433Sdalcinl     }
446071f87433Sdalcinl   }
446171f87433Sdalcinl   PetscFunctionReturn(0);
446271f87433Sdalcinl }
446371f87433Sdalcinl 
446471f87433Sdalcinl #undef __FUNCT__
446571f87433Sdalcinl #define __FUNCT__ "SNES_KSPSolve"
446671f87433Sdalcinl PetscErrorCode SNES_KSPSolve(SNES snes, KSP ksp, Vec b, Vec x)
446771f87433Sdalcinl {
446871f87433Sdalcinl   PetscErrorCode ierr;
446971f87433Sdalcinl 
447071f87433Sdalcinl   PetscFunctionBegin;
4471fa9f3622SBarry Smith   if (snes->ksp_ewconv) { ierr = SNESKSPEW_PreSolve(snes,ksp,b,x);CHKERRQ(ierr);  }
447271f87433Sdalcinl   ierr = KSPSolve(ksp,b,x);CHKERRQ(ierr);
4473fa9f3622SBarry Smith   if (snes->ksp_ewconv) { ierr = SNESKSPEW_PostSolve(snes,ksp,b,x);CHKERRQ(ierr); }
447471f87433Sdalcinl   PetscFunctionReturn(0);
447571f87433Sdalcinl }
44766c699258SBarry Smith 
4477b4615a05SBarry Smith #include <petsc-private/dmimpl.h>
44786c699258SBarry Smith #undef __FUNCT__
44796c699258SBarry Smith #define __FUNCT__ "SNESSetDM"
44806c699258SBarry Smith /*@
44816c699258SBarry Smith    SNESSetDM - Sets the DM that may be used by some preconditioners
44826c699258SBarry Smith 
44833f9fe445SBarry Smith    Logically Collective on SNES
44846c699258SBarry Smith 
44856c699258SBarry Smith    Input Parameters:
44866c699258SBarry Smith +  snes - the preconditioner context
44876c699258SBarry Smith -  dm - the dm
44886c699258SBarry Smith 
44896c699258SBarry Smith    Level: intermediate
44906c699258SBarry Smith 
44916c699258SBarry Smith 
44926c699258SBarry Smith .seealso: SNESGetDM(), KSPSetDM(), KSPGetDM()
44936c699258SBarry Smith @*/
44947087cfbeSBarry Smith PetscErrorCode  SNESSetDM(SNES snes,DM dm)
44956c699258SBarry Smith {
44966c699258SBarry Smith   PetscErrorCode ierr;
4497345fed2cSBarry Smith   KSP            ksp;
4498942e3340SBarry Smith   DMSNES         sdm;
44996c699258SBarry Smith 
45006c699258SBarry Smith   PetscFunctionBegin;
45010700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4502d0660788SBarry Smith   if (dm) {ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);}
4503942e3340SBarry Smith   if (snes->dm) {               /* Move the DMSNES context over to the new DM unless the new DM already has one */
4504b4615a05SBarry Smith     if (snes->dm->dmsnes && snes->dmAuto && !dm->dmsnes) {
4505942e3340SBarry Smith       ierr = DMCopyDMSNES(snes->dm,dm);CHKERRQ(ierr);
4506942e3340SBarry Smith       ierr = DMGetDMSNES(snes->dm,&sdm);CHKERRQ(ierr);
45076cab3a1bSJed Brown       if (sdm->originaldm == snes->dm) { /* Grant write privileges to the replacement DM */
45086cab3a1bSJed Brown         sdm->originaldm = dm;
45096cab3a1bSJed Brown       }
45106cab3a1bSJed Brown     }
45116bf464f9SBarry Smith     ierr = DMDestroy(&snes->dm);CHKERRQ(ierr);
45126cab3a1bSJed Brown   }
45136c699258SBarry Smith   snes->dm = dm;
4514116d1032SJed Brown   snes->dmAuto = PETSC_FALSE;
4515345fed2cSBarry Smith   ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
4516345fed2cSBarry Smith   ierr = KSPSetDM(ksp,dm);CHKERRQ(ierr);
4517f22f69f0SBarry Smith   ierr = KSPSetDMActive(ksp,PETSC_FALSE);CHKERRQ(ierr);
45182c155ee1SBarry Smith   if (snes->pc) {
45192c155ee1SBarry Smith     ierr = SNESSetDM(snes->pc, snes->dm);CHKERRQ(ierr);
4520c40d0f55SPeter Brune     ierr = SNESSetPCSide(snes,snes->pcside);CHKERRQ(ierr);
45212c155ee1SBarry Smith   }
45226c699258SBarry Smith   PetscFunctionReturn(0);
45236c699258SBarry Smith }
45246c699258SBarry Smith 
45256c699258SBarry Smith #undef __FUNCT__
45266c699258SBarry Smith #define __FUNCT__ "SNESGetDM"
45276c699258SBarry Smith /*@
45286c699258SBarry Smith    SNESGetDM - Gets the DM that may be used by some preconditioners
45296c699258SBarry Smith 
45303f9fe445SBarry Smith    Not Collective but DM obtained is parallel on SNES
45316c699258SBarry Smith 
45326c699258SBarry Smith    Input Parameter:
45336c699258SBarry Smith . snes - the preconditioner context
45346c699258SBarry Smith 
45356c699258SBarry Smith    Output Parameter:
45366c699258SBarry Smith .  dm - the dm
45376c699258SBarry Smith 
45386c699258SBarry Smith    Level: intermediate
45396c699258SBarry Smith 
45406c699258SBarry Smith 
45416c699258SBarry Smith .seealso: SNESSetDM(), KSPSetDM(), KSPGetDM()
45426c699258SBarry Smith @*/
45437087cfbeSBarry Smith PetscErrorCode  SNESGetDM(SNES snes,DM *dm)
45446c699258SBarry Smith {
45456cab3a1bSJed Brown   PetscErrorCode ierr;
45466cab3a1bSJed Brown 
45476c699258SBarry Smith   PetscFunctionBegin;
45480700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
45496cab3a1bSJed Brown   if (!snes->dm) {
45506cab3a1bSJed Brown     ierr = DMShellCreate(((PetscObject)snes)->comm,&snes->dm);CHKERRQ(ierr);
4551116d1032SJed Brown     snes->dmAuto = PETSC_TRUE;
45526cab3a1bSJed Brown   }
45536c699258SBarry Smith   *dm = snes->dm;
45546c699258SBarry Smith   PetscFunctionReturn(0);
45556c699258SBarry Smith }
45560807856dSBarry Smith 
455731823bd8SMatthew G Knepley #undef __FUNCT__
455831823bd8SMatthew G Knepley #define __FUNCT__ "SNESSetPC"
455931823bd8SMatthew G Knepley /*@
4560fd4b34e9SJed Brown   SNESSetPC - Sets the nonlinear preconditioner to be used.
456131823bd8SMatthew G Knepley 
456231823bd8SMatthew G Knepley   Collective on SNES
456331823bd8SMatthew G Knepley 
456431823bd8SMatthew G Knepley   Input Parameters:
456531823bd8SMatthew G Knepley + snes - iterative context obtained from SNESCreate()
456631823bd8SMatthew G Knepley - pc   - the preconditioner object
456731823bd8SMatthew G Knepley 
456831823bd8SMatthew G Knepley   Notes:
456931823bd8SMatthew G Knepley   Use SNESGetPC() to retrieve the preconditioner context (for example,
457031823bd8SMatthew G Knepley   to configure it using the API).
457131823bd8SMatthew G Knepley 
457231823bd8SMatthew G Knepley   Level: developer
457331823bd8SMatthew G Knepley 
457431823bd8SMatthew G Knepley .keywords: SNES, set, precondition
457531823bd8SMatthew G Knepley .seealso: SNESGetPC()
457631823bd8SMatthew G Knepley @*/
457731823bd8SMatthew G Knepley PetscErrorCode SNESSetPC(SNES snes, SNES pc)
457831823bd8SMatthew G Knepley {
457931823bd8SMatthew G Knepley   PetscErrorCode ierr;
458031823bd8SMatthew G Knepley 
458131823bd8SMatthew G Knepley   PetscFunctionBegin;
458231823bd8SMatthew G Knepley   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
458331823bd8SMatthew G Knepley   PetscValidHeaderSpecific(pc, SNES_CLASSID, 2);
458431823bd8SMatthew G Knepley   PetscCheckSameComm(snes, 1, pc, 2);
458531823bd8SMatthew G Knepley   ierr = PetscObjectReference((PetscObject) pc);CHKERRQ(ierr);
4586bf11d3b6SBarry Smith   ierr = SNESDestroy(&snes->pc);CHKERRQ(ierr);
458731823bd8SMatthew G Knepley   snes->pc = pc;
458831823bd8SMatthew G Knepley   ierr = PetscLogObjectParent(snes, snes->pc);CHKERRQ(ierr);
458931823bd8SMatthew G Knepley   PetscFunctionReturn(0);
459031823bd8SMatthew G Knepley }
459131823bd8SMatthew G Knepley 
459231823bd8SMatthew G Knepley #undef __FUNCT__
459331823bd8SMatthew G Knepley #define __FUNCT__ "SNESGetPC"
459431823bd8SMatthew G Knepley /*@
4595fd4b34e9SJed Brown   SNESGetPC - Returns a pointer to the nonlinear preconditioning context set with SNESSetPC().
459631823bd8SMatthew G Knepley 
459731823bd8SMatthew G Knepley   Not Collective
459831823bd8SMatthew G Knepley 
459931823bd8SMatthew G Knepley   Input Parameter:
460031823bd8SMatthew G Knepley . snes - iterative context obtained from SNESCreate()
460131823bd8SMatthew G Knepley 
460231823bd8SMatthew G Knepley   Output Parameter:
460331823bd8SMatthew G Knepley . pc - preconditioner context
460431823bd8SMatthew G Knepley 
460531823bd8SMatthew G Knepley   Level: developer
460631823bd8SMatthew G Knepley 
460731823bd8SMatthew G Knepley .keywords: SNES, get, preconditioner
460831823bd8SMatthew G Knepley .seealso: SNESSetPC()
460931823bd8SMatthew G Knepley @*/
461031823bd8SMatthew G Knepley PetscErrorCode SNESGetPC(SNES snes, SNES *pc)
461131823bd8SMatthew G Knepley {
461231823bd8SMatthew G Knepley   PetscErrorCode              ierr;
4613a64e098fSPeter Brune   const char                  *optionsprefix;
461431823bd8SMatthew G Knepley 
461531823bd8SMatthew G Knepley   PetscFunctionBegin;
461631823bd8SMatthew G Knepley   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
461731823bd8SMatthew G Knepley   PetscValidPointer(pc, 2);
461831823bd8SMatthew G Knepley   if (!snes->pc) {
461931823bd8SMatthew G Knepley     ierr = SNESCreate(((PetscObject) snes)->comm,&snes->pc);CHKERRQ(ierr);
46204a0c5b0cSMatthew G Knepley     ierr = PetscObjectIncrementTabLevel((PetscObject)snes->pc,(PetscObject)snes,1);CHKERRQ(ierr);
462131823bd8SMatthew G Knepley     ierr = PetscLogObjectParent(snes,snes->pc);CHKERRQ(ierr);
4622a64e098fSPeter Brune     ierr = SNESGetOptionsPrefix(snes,&optionsprefix);CHKERRQ(ierr);
4623a64e098fSPeter Brune     ierr = SNESSetOptionsPrefix(snes->pc,optionsprefix);CHKERRQ(ierr);
4624a64e098fSPeter Brune     ierr = SNESAppendOptionsPrefix(snes->pc,"npc_");CHKERRQ(ierr);
462531823bd8SMatthew G Knepley   }
462631823bd8SMatthew G Knepley   *pc = snes->pc;
462731823bd8SMatthew G Knepley   PetscFunctionReturn(0);
462831823bd8SMatthew G Knepley }
462931823bd8SMatthew G Knepley 
4630c40d0f55SPeter Brune 
4631c40d0f55SPeter Brune #undef __FUNCT__
4632c40d0f55SPeter Brune #define __FUNCT__ "SNESSetPCSide"
4633c40d0f55SPeter Brune /*@
4634c40d0f55SPeter Brune     SNESSetPCSide - Sets the preconditioning side.
4635c40d0f55SPeter Brune 
4636c40d0f55SPeter Brune     Logically Collective on SNES
4637c40d0f55SPeter Brune 
4638c40d0f55SPeter Brune     Input Parameter:
4639c40d0f55SPeter Brune .   snes - iterative context obtained from SNESCreate()
4640c40d0f55SPeter Brune 
4641c40d0f55SPeter Brune     Output Parameter:
4642c40d0f55SPeter Brune .   side - the preconditioning side, where side is one of
4643c40d0f55SPeter Brune .vb
4644c40d0f55SPeter Brune       PC_LEFT - left preconditioning (default)
4645c40d0f55SPeter Brune       PC_RIGHT - right preconditioning
4646c40d0f55SPeter Brune .ve
4647c40d0f55SPeter Brune 
4648c40d0f55SPeter Brune     Options Database Keys:
4649c40d0f55SPeter Brune .   -snes_pc_side <right,left>
4650c40d0f55SPeter Brune 
4651c40d0f55SPeter Brune     Level: intermediate
4652c40d0f55SPeter Brune 
4653c40d0f55SPeter Brune .keywords: SNES, set, right, left, side, preconditioner, flag
4654c40d0f55SPeter Brune 
4655c40d0f55SPeter Brune .seealso: SNESGetPCSide(), KSPSetPCSide()
4656c40d0f55SPeter Brune @*/
4657c40d0f55SPeter Brune PetscErrorCode  SNESSetPCSide(SNES snes,PCSide side)
4658c40d0f55SPeter Brune {
4659c40d0f55SPeter Brune   PetscFunctionBegin;
4660c40d0f55SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4661c40d0f55SPeter Brune   PetscValidLogicalCollectiveEnum(snes,side,2);
4662c40d0f55SPeter Brune   snes->pcside = side;
4663c40d0f55SPeter Brune   PetscFunctionReturn(0);
4664c40d0f55SPeter Brune }
4665c40d0f55SPeter Brune 
4666c40d0f55SPeter Brune #undef __FUNCT__
4667c40d0f55SPeter Brune #define __FUNCT__ "SNESGetPCSide"
4668c40d0f55SPeter Brune /*@
4669c40d0f55SPeter Brune     SNESGetPCSide - Gets the preconditioning side.
4670c40d0f55SPeter Brune 
4671c40d0f55SPeter Brune     Not Collective
4672c40d0f55SPeter Brune 
4673c40d0f55SPeter Brune     Input Parameter:
4674c40d0f55SPeter Brune .   snes - iterative context obtained from SNESCreate()
4675c40d0f55SPeter Brune 
4676c40d0f55SPeter Brune     Output Parameter:
4677c40d0f55SPeter Brune .   side - the preconditioning side, where side is one of
4678c40d0f55SPeter Brune .vb
4679c40d0f55SPeter Brune       PC_LEFT - left preconditioning (default)
4680c40d0f55SPeter Brune       PC_RIGHT - right preconditioning
4681c40d0f55SPeter Brune .ve
4682c40d0f55SPeter Brune 
4683c40d0f55SPeter Brune     Level: intermediate
4684c40d0f55SPeter Brune 
4685c40d0f55SPeter Brune .keywords: SNES, get, right, left, side, preconditioner, flag
4686c40d0f55SPeter Brune 
4687c40d0f55SPeter Brune .seealso: SNESSetPCSide(), KSPGetPCSide()
4688c40d0f55SPeter Brune @*/
4689c40d0f55SPeter Brune PetscErrorCode  SNESGetPCSide(SNES snes,PCSide *side)
4690c40d0f55SPeter Brune {
4691c40d0f55SPeter Brune   PetscFunctionBegin;
4692c40d0f55SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4693c40d0f55SPeter Brune   PetscValidPointer(side,2);
4694c40d0f55SPeter Brune   *side = snes->pcside;
4695c40d0f55SPeter Brune   PetscFunctionReturn(0);
4696c40d0f55SPeter Brune }
4697c40d0f55SPeter Brune 
46989e764e56SPeter Brune #undef __FUNCT__
4699f1c6b773SPeter Brune #define __FUNCT__ "SNESSetSNESLineSearch"
47009e764e56SPeter Brune /*@
47018141a3b9SPeter Brune   SNESSetSNESLineSearch - Sets the linesearch on the SNES instance.
47029e764e56SPeter Brune 
47039e764e56SPeter Brune   Collective on SNES
47049e764e56SPeter Brune 
47059e764e56SPeter Brune   Input Parameters:
47069e764e56SPeter Brune + snes - iterative context obtained from SNESCreate()
47079e764e56SPeter Brune - linesearch   - the linesearch object
47089e764e56SPeter Brune 
47099e764e56SPeter Brune   Notes:
4710f1c6b773SPeter Brune   Use SNESGetSNESLineSearch() to retrieve the preconditioner context (for example,
47119e764e56SPeter Brune   to configure it using the API).
47129e764e56SPeter Brune 
47139e764e56SPeter Brune   Level: developer
47149e764e56SPeter Brune 
47159e764e56SPeter Brune .keywords: SNES, set, linesearch
4716f1c6b773SPeter Brune .seealso: SNESGetSNESLineSearch()
47179e764e56SPeter Brune @*/
4718f1c6b773SPeter Brune PetscErrorCode SNESSetSNESLineSearch(SNES snes, SNESLineSearch linesearch)
47199e764e56SPeter Brune {
47209e764e56SPeter Brune   PetscErrorCode ierr;
47219e764e56SPeter Brune 
47229e764e56SPeter Brune   PetscFunctionBegin;
47239e764e56SPeter Brune   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
4724f1c6b773SPeter Brune   PetscValidHeaderSpecific(linesearch, SNESLINESEARCH_CLASSID, 2);
47259e764e56SPeter Brune   PetscCheckSameComm(snes, 1, linesearch, 2);
47269e764e56SPeter Brune   ierr = PetscObjectReference((PetscObject) linesearch);CHKERRQ(ierr);
4727f1c6b773SPeter Brune   ierr = SNESLineSearchDestroy(&snes->linesearch);CHKERRQ(ierr);
47289e764e56SPeter Brune   snes->linesearch = linesearch;
47299e764e56SPeter Brune   ierr = PetscLogObjectParent(snes, snes->linesearch);CHKERRQ(ierr);
47309e764e56SPeter Brune   PetscFunctionReturn(0);
47319e764e56SPeter Brune }
47329e764e56SPeter Brune 
47339e764e56SPeter Brune #undef __FUNCT__
4734f1c6b773SPeter Brune #define __FUNCT__ "SNESGetSNESLineSearch"
4735ea5d4fccSPeter Brune /*@C
47368141a3b9SPeter Brune   SNESGetSNESLineSearch - Returns a pointer to the line search context set with SNESSetLineSearch()
47378141a3b9SPeter Brune   or creates a default line search instance associated with the SNES and returns it.
47389e764e56SPeter Brune 
47399e764e56SPeter Brune   Not Collective
47409e764e56SPeter Brune 
47419e764e56SPeter Brune   Input Parameter:
47429e764e56SPeter Brune . snes - iterative context obtained from SNESCreate()
47439e764e56SPeter Brune 
47449e764e56SPeter Brune   Output Parameter:
47459e764e56SPeter Brune . linesearch - linesearch context
47469e764e56SPeter Brune 
47479e764e56SPeter Brune   Level: developer
47489e764e56SPeter Brune 
47499e764e56SPeter Brune .keywords: SNES, get, linesearch
4750f1c6b773SPeter Brune .seealso: SNESSetSNESLineSearch()
47519e764e56SPeter Brune @*/
4752f1c6b773SPeter Brune PetscErrorCode SNESGetSNESLineSearch(SNES snes, SNESLineSearch *linesearch)
47539e764e56SPeter Brune {
47549e764e56SPeter Brune   PetscErrorCode ierr;
47559e764e56SPeter Brune   const char     *optionsprefix;
47569e764e56SPeter Brune 
47579e764e56SPeter Brune   PetscFunctionBegin;
47589e764e56SPeter Brune   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
47599e764e56SPeter Brune   PetscValidPointer(linesearch, 2);
47609e764e56SPeter Brune   if (!snes->linesearch) {
47619e764e56SPeter Brune     ierr = SNESGetOptionsPrefix(snes, &optionsprefix);CHKERRQ(ierr);
4762f1c6b773SPeter Brune     ierr = SNESLineSearchCreate(((PetscObject) snes)->comm, &snes->linesearch);CHKERRQ(ierr);
4763f1c6b773SPeter Brune     ierr = SNESLineSearchSetSNES(snes->linesearch, snes);CHKERRQ(ierr);
4764b1dca40bSPeter Brune     ierr = SNESLineSearchAppendOptionsPrefix(snes->linesearch, optionsprefix);CHKERRQ(ierr);
47659e764e56SPeter Brune     ierr = PetscObjectIncrementTabLevel((PetscObject) snes->linesearch, (PetscObject) snes, 1);CHKERRQ(ierr);
47669e764e56SPeter Brune     ierr = PetscLogObjectParent(snes, snes->linesearch);CHKERRQ(ierr);
47679e764e56SPeter Brune   }
47689e764e56SPeter Brune   *linesearch = snes->linesearch;
47699e764e56SPeter Brune   PetscFunctionReturn(0);
47709e764e56SPeter Brune }
47719e764e56SPeter Brune 
477269b4f73cSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
4773c6db04a5SJed Brown #include <mex.h>
477469b4f73cSBarry Smith 
47758f6e6473SBarry Smith typedef struct {char *funcname; mxArray *ctx;} SNESMatlabContext;
47768f6e6473SBarry Smith 
47770807856dSBarry Smith #undef __FUNCT__
47780807856dSBarry Smith #define __FUNCT__ "SNESComputeFunction_Matlab"
47790807856dSBarry Smith /*
47800807856dSBarry Smith    SNESComputeFunction_Matlab - Calls the function that has been set with
47810807856dSBarry Smith                          SNESSetFunctionMatlab().
47820807856dSBarry Smith 
47830807856dSBarry Smith    Collective on SNES
47840807856dSBarry Smith 
47850807856dSBarry Smith    Input Parameters:
47860807856dSBarry Smith +  snes - the SNES context
47870807856dSBarry Smith -  x - input vector
47880807856dSBarry Smith 
47890807856dSBarry Smith    Output Parameter:
47900807856dSBarry Smith .  y - function vector, as set by SNESSetFunction()
47910807856dSBarry Smith 
47920807856dSBarry Smith    Notes:
47930807856dSBarry Smith    SNESComputeFunction() is typically used within nonlinear solvers
47940807856dSBarry Smith    implementations, so most users would not generally call this routine
47950807856dSBarry Smith    themselves.
47960807856dSBarry Smith 
47970807856dSBarry Smith    Level: developer
47980807856dSBarry Smith 
47990807856dSBarry Smith .keywords: SNES, nonlinear, compute, function
48000807856dSBarry Smith 
48010807856dSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction()
480261b2408cSBarry Smith */
48037087cfbeSBarry Smith PetscErrorCode  SNESComputeFunction_Matlab(SNES snes,Vec x,Vec y, void *ctx)
48040807856dSBarry Smith {
4805e650e774SBarry Smith   PetscErrorCode    ierr;
48068f6e6473SBarry Smith   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
48078f6e6473SBarry Smith   int               nlhs = 1,nrhs = 5;
48088f6e6473SBarry Smith   mxArray	    *plhs[1],*prhs[5];
480991621f2eSBarry Smith   long long int     lx = 0,ly = 0,ls = 0;
4810e650e774SBarry Smith 
48110807856dSBarry Smith   PetscFunctionBegin;
48120807856dSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
48130807856dSBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
48140807856dSBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
48150807856dSBarry Smith   PetscCheckSameComm(snes,1,x,2);
48160807856dSBarry Smith   PetscCheckSameComm(snes,1,y,3);
48170807856dSBarry Smith 
48180807856dSBarry Smith   /* call Matlab function in ctx with arguments x and y */
4819e650e774SBarry Smith 
482091621f2eSBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
4821e650e774SBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
4822e650e774SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(x));CHKERRQ(ierr);
482391621f2eSBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
482491621f2eSBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)lx);
482591621f2eSBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)ly);
48268f6e6473SBarry Smith   prhs[3] =  mxCreateString(sctx->funcname);
48278f6e6473SBarry Smith   prhs[4] =  sctx->ctx;
4828b807a863SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeFunctionInternal");CHKERRQ(ierr);
4829e650e774SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4830e650e774SBarry Smith   mxDestroyArray(prhs[0]);
4831e650e774SBarry Smith   mxDestroyArray(prhs[1]);
4832e650e774SBarry Smith   mxDestroyArray(prhs[2]);
48338f6e6473SBarry Smith   mxDestroyArray(prhs[3]);
4834e650e774SBarry Smith   mxDestroyArray(plhs[0]);
48350807856dSBarry Smith   PetscFunctionReturn(0);
48360807856dSBarry Smith }
48370807856dSBarry Smith 
48380807856dSBarry Smith 
48390807856dSBarry Smith #undef __FUNCT__
48400807856dSBarry Smith #define __FUNCT__ "SNESSetFunctionMatlab"
484161b2408cSBarry Smith /*
48420807856dSBarry Smith    SNESSetFunctionMatlab - Sets the function evaluation routine and function
48430807856dSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
4844e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
48450807856dSBarry Smith 
48460807856dSBarry Smith    Logically Collective on SNES
48470807856dSBarry Smith 
48480807856dSBarry Smith    Input Parameters:
48490807856dSBarry Smith +  snes - the SNES context
48500807856dSBarry Smith .  r - vector to store function value
48510807856dSBarry Smith -  func - function evaluation routine
48520807856dSBarry Smith 
48530807856dSBarry Smith    Calling sequence of func:
485461b2408cSBarry Smith $    func (SNES snes,Vec x,Vec f,void *ctx);
48550807856dSBarry Smith 
48560807856dSBarry Smith 
48570807856dSBarry Smith    Notes:
48580807856dSBarry Smith    The Newton-like methods typically solve linear systems of the form
48590807856dSBarry Smith $      f'(x) x = -f(x),
48600807856dSBarry Smith    where f'(x) denotes the Jacobian matrix and f(x) is the function.
48610807856dSBarry Smith 
48620807856dSBarry Smith    Level: beginner
48630807856dSBarry Smith 
48640807856dSBarry Smith .keywords: SNES, nonlinear, set, function
48650807856dSBarry Smith 
48660807856dSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
486761b2408cSBarry Smith */
48687087cfbeSBarry Smith PetscErrorCode  SNESSetFunctionMatlab(SNES snes,Vec r,const char *func,mxArray *ctx)
48690807856dSBarry Smith {
48700807856dSBarry Smith   PetscErrorCode    ierr;
48718f6e6473SBarry Smith   SNESMatlabContext *sctx;
48720807856dSBarry Smith 
48730807856dSBarry Smith   PetscFunctionBegin;
48748f6e6473SBarry Smith   /* currently sctx is memory bleed */
48758f6e6473SBarry Smith   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
48768f6e6473SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
48778f6e6473SBarry Smith   /*
48788f6e6473SBarry Smith      This should work, but it doesn't
48798f6e6473SBarry Smith   sctx->ctx = ctx;
48808f6e6473SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
48818f6e6473SBarry Smith   */
48828f6e6473SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
48838f6e6473SBarry Smith   ierr = SNESSetFunction(snes,r,SNESComputeFunction_Matlab,sctx);CHKERRQ(ierr);
48840807856dSBarry Smith   PetscFunctionReturn(0);
48850807856dSBarry Smith }
488669b4f73cSBarry Smith 
488761b2408cSBarry Smith #undef __FUNCT__
488861b2408cSBarry Smith #define __FUNCT__ "SNESComputeJacobian_Matlab"
488961b2408cSBarry Smith /*
489061b2408cSBarry Smith    SNESComputeJacobian_Matlab - Calls the function that has been set with
489161b2408cSBarry Smith                          SNESSetJacobianMatlab().
489261b2408cSBarry Smith 
489361b2408cSBarry Smith    Collective on SNES
489461b2408cSBarry Smith 
489561b2408cSBarry Smith    Input Parameters:
489661b2408cSBarry Smith +  snes - the SNES context
489761b2408cSBarry Smith .  x - input vector
489861b2408cSBarry Smith .  A, B - the matrices
489961b2408cSBarry Smith -  ctx - user context
490061b2408cSBarry Smith 
490161b2408cSBarry Smith    Output Parameter:
490261b2408cSBarry Smith .  flag - structure of the matrix
490361b2408cSBarry Smith 
490461b2408cSBarry Smith    Level: developer
490561b2408cSBarry Smith 
490661b2408cSBarry Smith .keywords: SNES, nonlinear, compute, function
490761b2408cSBarry Smith 
490861b2408cSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction()
490961b2408cSBarry Smith @*/
49107087cfbeSBarry Smith PetscErrorCode  SNESComputeJacobian_Matlab(SNES snes,Vec x,Mat *A,Mat *B,MatStructure *flag, void *ctx)
491161b2408cSBarry Smith {
491261b2408cSBarry Smith   PetscErrorCode    ierr;
491361b2408cSBarry Smith   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
491461b2408cSBarry Smith   int               nlhs = 2,nrhs = 6;
491561b2408cSBarry Smith   mxArray	    *plhs[2],*prhs[6];
491661b2408cSBarry Smith   long long int     lx = 0,lA = 0,ls = 0, lB = 0;
491761b2408cSBarry Smith 
491861b2408cSBarry Smith   PetscFunctionBegin;
491961b2408cSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
492061b2408cSBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
492161b2408cSBarry Smith 
492261b2408cSBarry Smith   /* call Matlab function in ctx with arguments x and y */
492361b2408cSBarry Smith 
492461b2408cSBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
492561b2408cSBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
492661b2408cSBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(x));CHKERRQ(ierr);
492761b2408cSBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(x));CHKERRQ(ierr);
492861b2408cSBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
492961b2408cSBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)lx);
493061b2408cSBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lA);
493161b2408cSBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lB);
493261b2408cSBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
493361b2408cSBarry Smith   prhs[5] =  sctx->ctx;
4934b807a863SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeJacobianInternal");CHKERRQ(ierr);
493561b2408cSBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
493661b2408cSBarry Smith   *flag   =  (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr);
493761b2408cSBarry Smith   mxDestroyArray(prhs[0]);
493861b2408cSBarry Smith   mxDestroyArray(prhs[1]);
493961b2408cSBarry Smith   mxDestroyArray(prhs[2]);
494061b2408cSBarry Smith   mxDestroyArray(prhs[3]);
494161b2408cSBarry Smith   mxDestroyArray(prhs[4]);
494261b2408cSBarry Smith   mxDestroyArray(plhs[0]);
494361b2408cSBarry Smith   mxDestroyArray(plhs[1]);
494461b2408cSBarry Smith   PetscFunctionReturn(0);
494561b2408cSBarry Smith }
494661b2408cSBarry Smith 
494761b2408cSBarry Smith 
494861b2408cSBarry Smith #undef __FUNCT__
494961b2408cSBarry Smith #define __FUNCT__ "SNESSetJacobianMatlab"
495061b2408cSBarry Smith /*
495161b2408cSBarry Smith    SNESSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
495261b2408cSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
4953e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
495461b2408cSBarry Smith 
495561b2408cSBarry Smith    Logically Collective on SNES
495661b2408cSBarry Smith 
495761b2408cSBarry Smith    Input Parameters:
495861b2408cSBarry Smith +  snes - the SNES context
495961b2408cSBarry Smith .  A,B - Jacobian matrices
496061b2408cSBarry Smith .  func - function evaluation routine
496161b2408cSBarry Smith -  ctx - user context
496261b2408cSBarry Smith 
496361b2408cSBarry Smith    Calling sequence of func:
496461b2408cSBarry Smith $    flag = func (SNES snes,Vec x,Mat A,Mat B,void *ctx);
496561b2408cSBarry Smith 
496661b2408cSBarry Smith 
496761b2408cSBarry Smith    Level: developer
496861b2408cSBarry Smith 
496961b2408cSBarry Smith .keywords: SNES, nonlinear, set, function
497061b2408cSBarry Smith 
497161b2408cSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
497261b2408cSBarry Smith */
49737087cfbeSBarry Smith PetscErrorCode  SNESSetJacobianMatlab(SNES snes,Mat A,Mat B,const char *func,mxArray *ctx)
497461b2408cSBarry Smith {
497561b2408cSBarry Smith   PetscErrorCode    ierr;
497661b2408cSBarry Smith   SNESMatlabContext *sctx;
497761b2408cSBarry Smith 
497861b2408cSBarry Smith   PetscFunctionBegin;
497961b2408cSBarry Smith   /* currently sctx is memory bleed */
498061b2408cSBarry Smith   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
498161b2408cSBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
498261b2408cSBarry Smith   /*
498361b2408cSBarry Smith      This should work, but it doesn't
498461b2408cSBarry Smith   sctx->ctx = ctx;
498561b2408cSBarry Smith   mexMakeArrayPersistent(sctx->ctx);
498661b2408cSBarry Smith   */
498761b2408cSBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
498861b2408cSBarry Smith   ierr = SNESSetJacobian(snes,A,B,SNESComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
498961b2408cSBarry Smith   PetscFunctionReturn(0);
499061b2408cSBarry Smith }
499169b4f73cSBarry Smith 
4992f9eb7ae2SShri Abhyankar #undef __FUNCT__
4993f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitor_Matlab"
4994f9eb7ae2SShri Abhyankar /*
4995f9eb7ae2SShri Abhyankar    SNESMonitor_Matlab - Calls the function that has been set with SNESMonitorSetMatlab().
4996f9eb7ae2SShri Abhyankar 
4997f9eb7ae2SShri Abhyankar    Collective on SNES
4998f9eb7ae2SShri Abhyankar 
4999f9eb7ae2SShri Abhyankar .seealso: SNESSetFunction(), SNESGetFunction()
5000f9eb7ae2SShri Abhyankar @*/
50017087cfbeSBarry Smith PetscErrorCode  SNESMonitor_Matlab(SNES snes,PetscInt it, PetscReal fnorm, void *ctx)
5002f9eb7ae2SShri Abhyankar {
5003f9eb7ae2SShri Abhyankar   PetscErrorCode  ierr;
500448f37e70SShri Abhyankar   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
5005f9eb7ae2SShri Abhyankar   int             nlhs = 1,nrhs = 6;
5006f9eb7ae2SShri Abhyankar   mxArray	  *plhs[1],*prhs[6];
5007f9eb7ae2SShri Abhyankar   long long int   lx = 0,ls = 0;
5008f9eb7ae2SShri Abhyankar   Vec             x=snes->vec_sol;
5009f9eb7ae2SShri Abhyankar 
5010f9eb7ae2SShri Abhyankar   PetscFunctionBegin;
5011f9eb7ae2SShri Abhyankar   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
5012f9eb7ae2SShri Abhyankar 
5013f9eb7ae2SShri Abhyankar   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
5014f9eb7ae2SShri Abhyankar   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
5015f9eb7ae2SShri Abhyankar   prhs[0] =  mxCreateDoubleScalar((double)ls);
5016f9eb7ae2SShri Abhyankar   prhs[1] =  mxCreateDoubleScalar((double)it);
5017f9eb7ae2SShri Abhyankar   prhs[2] =  mxCreateDoubleScalar((double)fnorm);
5018f9eb7ae2SShri Abhyankar   prhs[3] =  mxCreateDoubleScalar((double)lx);
5019f9eb7ae2SShri Abhyankar   prhs[4] =  mxCreateString(sctx->funcname);
5020f9eb7ae2SShri Abhyankar   prhs[5] =  sctx->ctx;
5021f9eb7ae2SShri Abhyankar   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESMonitorInternal");CHKERRQ(ierr);
5022f9eb7ae2SShri Abhyankar   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5023f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[0]);
5024f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[1]);
5025f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[2]);
5026f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[3]);
5027f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[4]);
5028f9eb7ae2SShri Abhyankar   mxDestroyArray(plhs[0]);
5029f9eb7ae2SShri Abhyankar   PetscFunctionReturn(0);
5030f9eb7ae2SShri Abhyankar }
5031f9eb7ae2SShri Abhyankar 
5032f9eb7ae2SShri Abhyankar 
5033f9eb7ae2SShri Abhyankar #undef __FUNCT__
5034f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitorSetMatlab"
5035f9eb7ae2SShri Abhyankar /*
5036e3c5b3baSBarry Smith    SNESMonitorSetMatlab - Sets the monitor function from MATLAB
5037f9eb7ae2SShri Abhyankar 
5038f9eb7ae2SShri Abhyankar    Level: developer
5039f9eb7ae2SShri Abhyankar 
5040f9eb7ae2SShri Abhyankar .keywords: SNES, nonlinear, set, function
5041f9eb7ae2SShri Abhyankar 
5042f9eb7ae2SShri Abhyankar .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
5043f9eb7ae2SShri Abhyankar */
50447087cfbeSBarry Smith PetscErrorCode  SNESMonitorSetMatlab(SNES snes,const char *func,mxArray *ctx)
5045f9eb7ae2SShri Abhyankar {
5046f9eb7ae2SShri Abhyankar   PetscErrorCode    ierr;
5047f9eb7ae2SShri Abhyankar   SNESMatlabContext *sctx;
5048f9eb7ae2SShri Abhyankar 
5049f9eb7ae2SShri Abhyankar   PetscFunctionBegin;
5050f9eb7ae2SShri Abhyankar   /* currently sctx is memory bleed */
5051f9eb7ae2SShri Abhyankar   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
5052f9eb7ae2SShri Abhyankar   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5053f9eb7ae2SShri Abhyankar   /*
5054f9eb7ae2SShri Abhyankar      This should work, but it doesn't
5055f9eb7ae2SShri Abhyankar   sctx->ctx = ctx;
5056f9eb7ae2SShri Abhyankar   mexMakeArrayPersistent(sctx->ctx);
5057f9eb7ae2SShri Abhyankar   */
5058f9eb7ae2SShri Abhyankar   sctx->ctx = mxDuplicateArray(ctx);
5059f9eb7ae2SShri Abhyankar   ierr = SNESMonitorSet(snes,SNESMonitor_Matlab,sctx,PETSC_NULL);CHKERRQ(ierr);
5060f9eb7ae2SShri Abhyankar   PetscFunctionReturn(0);
5061f9eb7ae2SShri Abhyankar }
5062f9eb7ae2SShri Abhyankar 
506369b4f73cSBarry Smith #endif
5064