xref: /petsc/src/snes/interface/snes.c (revision 55849f575624b3890dfd9b38e2c3ba42c5d7d18f)
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 */
107087cfbeSBarry Smith PetscClassId  SNES_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 
129*55849f57SBarry Smith #undef __FUNCT__
130*55849f57SBarry Smith #define __FUNCT__ "SNESLoad"
131*55849f57SBarry Smith /*@C
132*55849f57SBarry Smith   SNESLoad - Loads a SNES that has been stored in binary  with SNESView().
133*55849f57SBarry Smith 
134*55849f57SBarry Smith   Collective on PetscViewer
135*55849f57SBarry Smith 
136*55849f57SBarry Smith   Input Parameters:
137*55849f57SBarry Smith + newdm - the newly loaded SNES, this needs to have been created with SNESCreate() or
138*55849f57SBarry Smith            some related function before a call to SNESLoad().
139*55849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
140*55849f57SBarry Smith 
141*55849f57SBarry Smith    Level: intermediate
142*55849f57SBarry Smith 
143*55849f57SBarry Smith   Notes:
144*55849f57SBarry Smith    The type is determined by the data in the file, any type set into the SNES before this call is ignored.
145*55849f57SBarry Smith 
146*55849f57SBarry Smith   Notes for advanced users:
147*55849f57SBarry Smith   Most users should not need to know the details of the binary storage
148*55849f57SBarry Smith   format, since SNESLoad() and TSView() completely hide these details.
149*55849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
150*55849f57SBarry Smith   format is
151*55849f57SBarry Smith .vb
152*55849f57SBarry Smith      has not yet been determined
153*55849f57SBarry Smith .ve
154*55849f57SBarry Smith 
155*55849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), SNESView(), MatLoad(), VecLoad()
156*55849f57SBarry Smith @*/
157*55849f57SBarry Smith PetscErrorCode  SNESLoad(SNES newdm, PetscViewer viewer)
158*55849f57SBarry Smith {
159*55849f57SBarry Smith   PetscErrorCode ierr;
160*55849f57SBarry Smith   PetscBool      isbinary;
161*55849f57SBarry Smith   PetscInt       classid;
162*55849f57SBarry Smith   char           type[256];
163*55849f57SBarry Smith   KSP            ksp;
164*55849f57SBarry Smith 
165*55849f57SBarry Smith   PetscFunctionBegin;
166*55849f57SBarry Smith   PetscValidHeaderSpecific(newdm,SNES_CLASSID,1);
167*55849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
168*55849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
169*55849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
170*55849f57SBarry Smith 
171*55849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
172*55849f57SBarry Smith   if (classid != SNES_FILE_CLASSID) SETERRQ(((PetscObject)newdm)->comm,PETSC_ERR_ARG_WRONG,"Not SNES next in file");
173*55849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr);
174*55849f57SBarry Smith   ierr = SNESSetType(newdm, type);CHKERRQ(ierr);
175*55849f57SBarry Smith   ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);
176*55849f57SBarry Smith   ierr = SNESGetKSP(newdm,&ksp);CHKERRQ(ierr);
177*55849f57SBarry Smith   ierr = KSPLoad(ksp,viewer);CHKERRQ(ierr);
178*55849f57SBarry Smith   PetscFunctionReturn(0);
179*55849f57SBarry Smith }
1806a388c36SPeter Brune 
1814936397dSBarry Smith #undef __FUNCT__
1824a2ae208SSatish Balay #define __FUNCT__ "SNESView"
1837e2c5f70SBarry Smith /*@C
1849b94acceSBarry Smith    SNESView - Prints the SNES data structure.
1859b94acceSBarry Smith 
1864c49b128SBarry Smith    Collective on SNES
187fee21e36SBarry Smith 
188c7afd0dbSLois Curfman McInnes    Input Parameters:
189c7afd0dbSLois Curfman McInnes +  SNES - the SNES context
190c7afd0dbSLois Curfman McInnes -  viewer - visualization context
191c7afd0dbSLois Curfman McInnes 
1929b94acceSBarry Smith    Options Database Key:
193c8a8ba5cSLois Curfman McInnes .  -snes_view - Calls SNESView() at end of SNESSolve()
1949b94acceSBarry Smith 
1959b94acceSBarry Smith    Notes:
1969b94acceSBarry Smith    The available visualization contexts include
197b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
198b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
199c8a8ba5cSLois Curfman McInnes          output where only the first processor opens
200c8a8ba5cSLois Curfman McInnes          the file.  All other processors send their
201c8a8ba5cSLois Curfman McInnes          data to the first processor to print.
2029b94acceSBarry Smith 
2033e081fefSLois Curfman McInnes    The user can open an alternative visualization context with
204b0a32e0cSBarry Smith    PetscViewerASCIIOpen() - output to a specified file.
2059b94acceSBarry Smith 
20636851e7fSLois Curfman McInnes    Level: beginner
20736851e7fSLois Curfman McInnes 
2089b94acceSBarry Smith .keywords: SNES, view
2099b94acceSBarry Smith 
210b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
2119b94acceSBarry Smith @*/
2127087cfbeSBarry Smith PetscErrorCode  SNESView(SNES snes,PetscViewer viewer)
2139b94acceSBarry Smith {
214fa9f3622SBarry Smith   SNESKSPEW           *kctx;
215dfbe8321SBarry Smith   PetscErrorCode      ierr;
21694b7f48cSBarry Smith   KSP                 ksp;
2177f1410a3SPeter Brune   SNESLineSearch      linesearch;
218*55849f57SBarry Smith   PetscBool           iascii,isstring,isbinary;
2199b94acceSBarry Smith 
2203a40ed3dSBarry Smith   PetscFunctionBegin;
2210700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2223050cee2SBarry Smith   if (!viewer) {
2237adad957SLisandro Dalcin     ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&viewer);CHKERRQ(ierr);
2243050cee2SBarry Smith   }
2250700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
226c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,viewer,2);
22774679c65SBarry Smith 
228251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
229251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
230*55849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
23132077d6dSBarry Smith   if (iascii) {
232317d6ea6SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)snes,viewer,"SNES Object");CHKERRQ(ierr);
233e7788613SBarry Smith     if (snes->ops->view) {
234b0a32e0cSBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
235e7788613SBarry Smith       ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr);
236b0a32e0cSBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2370ef38995SBarry Smith     }
23877431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum iterations=%D, maximum function evaluations=%D\n",snes->max_its,snes->max_funcs);CHKERRQ(ierr);
239a83599f4SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  tolerances: relative=%G, absolute=%G, solution=%G\n",
240c60f73f4SPeter Brune                  snes->rtol,snes->abstol,snes->stol);CHKERRQ(ierr);
24177431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",snes->linear_its);CHKERRQ(ierr);
24277431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  total number of function evaluations=%D\n",snes->nfuncs);CHKERRQ(ierr);
24317fe4bdfSPeter Brune     if (snes->gridsequence) {
24417fe4bdfSPeter Brune       ierr = PetscViewerASCIIPrintf(viewer,"  total number of grid sequence refinements=%D\n",snes->gridsequence);CHKERRQ(ierr);
24517fe4bdfSPeter Brune     }
2469b94acceSBarry Smith     if (snes->ksp_ewconv) {
247fa9f3622SBarry Smith       kctx = (SNESKSPEW *)snes->kspconvctx;
2489b94acceSBarry Smith       if (kctx) {
24977431f27SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Eisenstat-Walker computation of KSP relative tolerance (version %D)\n",kctx->version);CHKERRQ(ierr);
250a83599f4SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"    rtol_0=%G, rtol_max=%G, threshold=%G\n",kctx->rtol_0,kctx->rtol_max,kctx->threshold);CHKERRQ(ierr);
251a83599f4SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"    gamma=%G, alpha=%G, alpha2=%G\n",kctx->gamma,kctx->alpha,kctx->alpha2);CHKERRQ(ierr);
2529b94acceSBarry Smith       }
2539b94acceSBarry Smith     }
254eb1f6c34SBarry Smith     if (snes->lagpreconditioner == -1) {
255eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioned is never rebuilt\n");CHKERRQ(ierr);
256eb1f6c34SBarry Smith     } else if (snes->lagpreconditioner > 1) {
257eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioned is rebuilt every %D new Jacobians\n",snes->lagpreconditioner);CHKERRQ(ierr);
258eb1f6c34SBarry Smith     }
259eb1f6c34SBarry Smith     if (snes->lagjacobian == -1) {
260eb1f6c34SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Jacobian is never rebuilt\n");CHKERRQ(ierr);
261eb1f6c34SBarry Smith     } else if (snes->lagjacobian > 1) {
26242f4f86dSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Jacobian is rebuilt every %D SNES iterations\n",snes->lagjacobian);CHKERRQ(ierr);
263eb1f6c34SBarry Smith     }
2640f5bd95cSBarry Smith   } else if (isstring) {
265317d6ea6SBarry Smith     const char *type;
266454a90a3SBarry Smith     ierr = SNESGetType(snes,&type);CHKERRQ(ierr);
267b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr);
268*55849f57SBarry Smith   } else if (isbinary) {
269*55849f57SBarry Smith     PetscInt         classid = SNES_FILE_CLASSID;
270*55849f57SBarry Smith     MPI_Comm         comm;
271*55849f57SBarry Smith     PetscMPIInt      rank;
272*55849f57SBarry Smith     char             type[256];
273*55849f57SBarry Smith 
274*55849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr);
275*55849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
276*55849f57SBarry Smith     if (!rank) {
277*55849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
278*55849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)snes)->type_name,256);CHKERRQ(ierr);
279*55849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
280*55849f57SBarry Smith     }
281*55849f57SBarry Smith     if (snes->ops->view) {
282*55849f57SBarry Smith       ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr);
283*55849f57SBarry Smith     }
28419bcc07fSBarry Smith   }
28542f4f86dSBarry Smith   if (snes->pc && snes->usespc) {
2864a0c5b0cSMatthew G Knepley     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2874a0c5b0cSMatthew G Knepley     ierr = SNESView(snes->pc, viewer);CHKERRQ(ierr);
2884a0c5b0cSMatthew G Knepley     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2894a0c5b0cSMatthew G Knepley   }
2902c155ee1SBarry Smith   if (snes->usesksp) {
2912c155ee1SBarry Smith     ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
292b0a32e0cSBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
29394b7f48cSBarry Smith     ierr = KSPView(ksp,viewer);CHKERRQ(ierr);
294b0a32e0cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2952c155ee1SBarry Smith   }
2967f1410a3SPeter Brune   if (snes->linesearch) {
2977f1410a3SPeter Brune     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2987f1410a3SPeter Brune     ierr = SNESGetSNESLineSearch(snes, &linesearch);CHKERRQ(ierr);
2997f1410a3SPeter Brune     ierr = SNESLineSearchView(linesearch, viewer);CHKERRQ(ierr);
3007f1410a3SPeter Brune     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
3017f1410a3SPeter Brune   }
3023a40ed3dSBarry Smith   PetscFunctionReturn(0);
3039b94acceSBarry Smith }
3049b94acceSBarry Smith 
30576b2cf59SMatthew Knepley /*
30676b2cf59SMatthew Knepley   We retain a list of functions that also take SNES command
30776b2cf59SMatthew Knepley   line options. These are called at the end SNESSetFromOptions()
30876b2cf59SMatthew Knepley */
30976b2cf59SMatthew Knepley #define MAXSETFROMOPTIONS 5
310a7cc72afSBarry Smith static PetscInt numberofsetfromoptions;
3116849ba73SBarry Smith static PetscErrorCode (*othersetfromoptions[MAXSETFROMOPTIONS])(SNES);
31276b2cf59SMatthew Knepley 
313e74ef692SMatthew Knepley #undef __FUNCT__
314e74ef692SMatthew Knepley #define __FUNCT__ "SNESAddOptionsChecker"
315ac226902SBarry Smith /*@C
31676b2cf59SMatthew Knepley   SNESAddOptionsChecker - Adds an additional function to check for SNES options.
31776b2cf59SMatthew Knepley 
31876b2cf59SMatthew Knepley   Not Collective
31976b2cf59SMatthew Knepley 
32076b2cf59SMatthew Knepley   Input Parameter:
32176b2cf59SMatthew Knepley . snescheck - function that checks for options
32276b2cf59SMatthew Knepley 
32376b2cf59SMatthew Knepley   Level: developer
32476b2cf59SMatthew Knepley 
32576b2cf59SMatthew Knepley .seealso: SNESSetFromOptions()
32676b2cf59SMatthew Knepley @*/
3277087cfbeSBarry Smith PetscErrorCode  SNESAddOptionsChecker(PetscErrorCode (*snescheck)(SNES))
32876b2cf59SMatthew Knepley {
32976b2cf59SMatthew Knepley   PetscFunctionBegin;
33076b2cf59SMatthew Knepley   if (numberofsetfromoptions >= MAXSETFROMOPTIONS) {
331e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "Too many options checkers, only %D allowed", MAXSETFROMOPTIONS);
33276b2cf59SMatthew Knepley   }
33376b2cf59SMatthew Knepley   othersetfromoptions[numberofsetfromoptions++] = snescheck;
33476b2cf59SMatthew Knepley   PetscFunctionReturn(0);
33576b2cf59SMatthew Knepley }
33676b2cf59SMatthew Knepley 
3377087cfbeSBarry Smith extern PetscErrorCode  SNESDefaultMatrixFreeCreate2(SNES,Vec,Mat*);
338aa3661deSLisandro Dalcin 
339aa3661deSLisandro Dalcin #undef __FUNCT__
340aa3661deSLisandro Dalcin #define __FUNCT__ "SNESSetUpMatrixFree_Private"
341ace3abfcSBarry Smith static PetscErrorCode SNESSetUpMatrixFree_Private(SNES snes, PetscBool  hasOperator, PetscInt version)
342aa3661deSLisandro Dalcin {
343aa3661deSLisandro Dalcin   Mat            J;
344aa3661deSLisandro Dalcin   KSP            ksp;
345aa3661deSLisandro Dalcin   PC             pc;
346ace3abfcSBarry Smith   PetscBool      match;
347aa3661deSLisandro Dalcin   PetscErrorCode ierr;
348aa3661deSLisandro Dalcin 
349aa3661deSLisandro Dalcin   PetscFunctionBegin;
3500700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
351aa3661deSLisandro Dalcin 
35298613b67SLisandro Dalcin   if (!snes->vec_func && (snes->jacobian || snes->jacobian_pre)) {
35398613b67SLisandro Dalcin     Mat A = snes->jacobian, B = snes->jacobian_pre;
35498613b67SLisandro Dalcin     ierr = MatGetVecs(A ? A : B, PETSC_NULL,&snes->vec_func);CHKERRQ(ierr);
35598613b67SLisandro Dalcin   }
35698613b67SLisandro Dalcin 
357aa3661deSLisandro Dalcin   if (version == 1) {
358aa3661deSLisandro Dalcin     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
35998613b67SLisandro Dalcin     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
3609c6ac3b3SBarry Smith     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
361aa3661deSLisandro Dalcin   } else if (version == 2) {
362e32f2f54SBarry Smith     if (!snes->vec_func) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"SNESSetFunction() must be called first");
36382a7e548SBarry Smith #if !defined(PETSC_USE_COMPLEX) && !defined(PETSC_USE_REAL_SINGLE) && !defined(PETSC_USE_REAL___FLOAT128)
364aa3661deSLisandro Dalcin     ierr = SNESDefaultMatrixFreeCreate2(snes,snes->vec_func,&J);CHKERRQ(ierr);
365aa3661deSLisandro Dalcin #else
366e32f2f54SBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP, "matrix-free operator rutines (version 2)");
367aa3661deSLisandro Dalcin #endif
368a8248277SBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "matrix-free operator rutines, only version 1 and 2");
369aa3661deSLisandro Dalcin 
370aa3661deSLisandro Dalcin   ierr = PetscInfo1(snes,"Setting default matrix-free operator routines (version %D)\n", version);CHKERRQ(ierr);
371d3462f78SMatthew Knepley   if (hasOperator) {
3723232da50SPeter Brune 
373aa3661deSLisandro Dalcin     /* This version replaces the user provided Jacobian matrix with a
374aa3661deSLisandro Dalcin        matrix-free version but still employs the user-provided preconditioner matrix. */
375aa3661deSLisandro Dalcin     ierr = SNESSetJacobian(snes,J,0,0,0);CHKERRQ(ierr);
376aa3661deSLisandro Dalcin   } else {
377aa3661deSLisandro Dalcin     /* This version replaces both the user-provided Jacobian and the user-
3783232da50SPeter Brune      provided preconditioner Jacobian with the default matrix free version. */
3793232da50SPeter Brune 
3803232da50SPeter Brune     ierr = SNESSetJacobian(snes,J,J,0,0);CHKERRQ(ierr);
381aa3661deSLisandro Dalcin     /* Force no preconditioner */
382aa3661deSLisandro Dalcin     ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
383aa3661deSLisandro Dalcin     ierr = KSPGetPC(ksp,&pc);CHKERRQ(ierr);
384251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)pc,PCSHELL,&match);CHKERRQ(ierr);
385aa3661deSLisandro Dalcin     if (!match) {
386aa3661deSLisandro Dalcin       ierr = PetscInfo(snes,"Setting default matrix-free preconditioner routines\nThat is no preconditioner is being used\n");CHKERRQ(ierr);
387aa3661deSLisandro Dalcin       ierr = PCSetType(pc,PCNONE);CHKERRQ(ierr);
388aa3661deSLisandro Dalcin     }
389aa3661deSLisandro Dalcin   }
3906bf464f9SBarry Smith   ierr = MatDestroy(&J);CHKERRQ(ierr);
391aa3661deSLisandro Dalcin   PetscFunctionReturn(0);
392aa3661deSLisandro Dalcin }
393aa3661deSLisandro Dalcin 
3944a2ae208SSatish Balay #undef __FUNCT__
395dfe15315SJed Brown #define __FUNCT__ "DMRestrictHook_SNESVecSol"
396dfe15315SJed Brown static PetscErrorCode DMRestrictHook_SNESVecSol(DM dmfine,Mat Restrict,Vec Rscale,Mat Inject,DM dmcoarse,void *ctx)
397dfe15315SJed Brown {
398dfe15315SJed Brown   SNES snes = (SNES)ctx;
399dfe15315SJed Brown   PetscErrorCode ierr;
400dfe15315SJed Brown   Vec Xfine,Xfine_named = PETSC_NULL,Xcoarse;
401dfe15315SJed Brown 
402dfe15315SJed Brown   PetscFunctionBegin;
40316ebb321SJed Brown   if (PetscLogPrintInfo) {
40416ebb321SJed Brown     PetscInt finelevel,coarselevel,fineclevel,coarseclevel;
40516ebb321SJed Brown     ierr = DMGetRefineLevel(dmfine,&finelevel);CHKERRQ(ierr);
40616ebb321SJed Brown     ierr = DMGetCoarsenLevel(dmfine,&fineclevel);CHKERRQ(ierr);
40716ebb321SJed Brown     ierr = DMGetRefineLevel(dmcoarse,&coarselevel);CHKERRQ(ierr);
40816ebb321SJed Brown     ierr = DMGetCoarsenLevel(dmcoarse,&coarseclevel);CHKERRQ(ierr);
40916ebb321SJed Brown     ierr = PetscInfo4(dmfine,"Restricting SNES solution vector from level %D-%D to level %D-%D\n",finelevel,fineclevel,coarselevel,coarseclevel);CHKERRQ(ierr);
41016ebb321SJed Brown   }
411dfe15315SJed Brown   if (dmfine == snes->dm) Xfine = snes->vec_sol;
412dfe15315SJed Brown   else {
413dfe15315SJed Brown     ierr = DMGetNamedGlobalVector(dmfine,"SNESVecSol",&Xfine_named);CHKERRQ(ierr);
414dfe15315SJed Brown     Xfine = Xfine_named;
415dfe15315SJed Brown   }
416dfe15315SJed Brown   ierr = DMGetNamedGlobalVector(dmcoarse,"SNESVecSol",&Xcoarse);CHKERRQ(ierr);
417dfe15315SJed Brown   ierr = MatRestrict(Restrict,Xfine,Xcoarse);CHKERRQ(ierr);
418dfe15315SJed Brown   ierr = VecPointwiseMult(Xcoarse,Xcoarse,Rscale);CHKERRQ(ierr);
419dfe15315SJed Brown   ierr = DMRestoreNamedGlobalVector(dmcoarse,"SNESVecSol",&Xcoarse);CHKERRQ(ierr);
420dfe15315SJed Brown   if (Xfine_named) {ierr = DMRestoreNamedGlobalVector(dmfine,"SNESVecSol",&Xfine_named);CHKERRQ(ierr);}
421dfe15315SJed Brown   PetscFunctionReturn(0);
422dfe15315SJed Brown }
423dfe15315SJed Brown 
424dfe15315SJed Brown #undef __FUNCT__
42516ebb321SJed Brown #define __FUNCT__ "DMCoarsenHook_SNESVecSol"
42616ebb321SJed Brown static PetscErrorCode DMCoarsenHook_SNESVecSol(DM dm,DM dmc,void *ctx)
42716ebb321SJed Brown {
42816ebb321SJed Brown   PetscErrorCode ierr;
42916ebb321SJed Brown 
43016ebb321SJed Brown   PetscFunctionBegin;
43116ebb321SJed Brown   ierr = DMCoarsenHookAdd(dmc,DMCoarsenHook_SNESVecSol,DMRestrictHook_SNESVecSol,ctx);CHKERRQ(ierr);
43216ebb321SJed Brown   PetscFunctionReturn(0);
43316ebb321SJed Brown }
43416ebb321SJed Brown 
43516ebb321SJed Brown #undef __FUNCT__
436caa4e7f2SJed Brown #define __FUNCT__ "KSPComputeOperators_SNES"
437a6950cb2SJed Brown /* This may be called to rediscretize the operator on levels of linear multigrid. The DM shuffle is so the user can
438a6950cb2SJed Brown  * safely call SNESGetDM() in their residual evaluation routine. */
439caa4e7f2SJed Brown static PetscErrorCode KSPComputeOperators_SNES(KSP ksp,Mat A,Mat B,MatStructure *mstruct,void *ctx)
440caa4e7f2SJed Brown {
441caa4e7f2SJed Brown   SNES                        snes = (SNES)ctx;
442caa4e7f2SJed Brown   PetscErrorCode              ierr;
443caa4e7f2SJed Brown   Mat                         Asave = A,Bsave = B;
444dfe15315SJed Brown   Vec                         X,Xnamed = PETSC_NULL;
445dfe15315SJed Brown   DM                          dmsave;
4464e269d77SPeter Brune   void                        *ctxsave;
4474e269d77SPeter Brune   PetscErrorCode              (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
448caa4e7f2SJed Brown 
449caa4e7f2SJed Brown   PetscFunctionBegin;
450dfe15315SJed Brown   dmsave = snes->dm;
451dfe15315SJed Brown   ierr = KSPGetDM(ksp,&snes->dm);CHKERRQ(ierr);
452dfe15315SJed Brown   if (dmsave == snes->dm) X = snes->vec_sol; /* We are on the finest level */
453dfe15315SJed Brown   else {                                     /* We are on a coarser level, this vec was initialized using a DM restrict hook */
454dfe15315SJed Brown     ierr = DMGetNamedGlobalVector(snes->dm,"SNESVecSol",&Xnamed);CHKERRQ(ierr);
455dfe15315SJed Brown     X = Xnamed;
4564e269d77SPeter Brune     ierr = SNESGetJacobian(snes,PETSC_NULL,PETSC_NULL,&jac,&ctxsave);CHKERRQ(ierr);
4574e269d77SPeter Brune     /* If the DM's don't match up, the MatFDColoring context needed for the jacobian won't match up either -- fixit. */
4584e269d77SPeter Brune     if (jac == SNESDefaultComputeJacobianColor) {
4594e269d77SPeter Brune       ierr = SNESSetJacobian(snes,PETSC_NULL,PETSC_NULL,SNESDefaultComputeJacobianColor,0);CHKERRQ(ierr);
460dfe15315SJed Brown     }
4614e269d77SPeter Brune   }
4624e269d77SPeter Brune   /* put the previous context back */
4634e269d77SPeter Brune 
464dfe15315SJed Brown   ierr = SNESComputeJacobian(snes,X,&A,&B,mstruct);CHKERRQ(ierr);
4654e269d77SPeter Brune   if (snes->dm != dmsave && jac == SNESDefaultComputeJacobianColor) {
4664e269d77SPeter Brune     ierr = SNESSetJacobian(snes,PETSC_NULL,PETSC_NULL,jac,ctxsave);CHKERRQ(ierr);
4674e269d77SPeter Brune   }
4684e269d77SPeter Brune 
469caa4e7f2SJed Brown   if (A != Asave || B != Bsave) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_SUP,"No support for changing matrices at this time");
470dfe15315SJed Brown   if (Xnamed) {
471dfe15315SJed Brown     ierr = DMRestoreNamedGlobalVector(snes->dm,"SNESVecSol",&Xnamed);CHKERRQ(ierr);
472dfe15315SJed Brown   }
473dfe15315SJed Brown   snes->dm = dmsave;
474caa4e7f2SJed Brown   PetscFunctionReturn(0);
475caa4e7f2SJed Brown }
476caa4e7f2SJed Brown 
477caa4e7f2SJed Brown #undef __FUNCT__
4786cab3a1bSJed Brown #define __FUNCT__ "SNESSetUpMatrices"
4796cab3a1bSJed Brown /*@
4806cab3a1bSJed Brown    SNESSetUpMatrices - ensures that matrices are available for SNES, to be called by SNESSetUp_XXX()
4816cab3a1bSJed Brown 
4826cab3a1bSJed Brown    Collective
4836cab3a1bSJed Brown 
4846cab3a1bSJed Brown    Input Arguments:
4856cab3a1bSJed Brown .  snes - snes to configure
4866cab3a1bSJed Brown 
4876cab3a1bSJed Brown    Level: developer
4886cab3a1bSJed Brown 
4896cab3a1bSJed Brown .seealso: SNESSetUp()
4906cab3a1bSJed Brown @*/
4916cab3a1bSJed Brown PetscErrorCode SNESSetUpMatrices(SNES snes)
4926cab3a1bSJed Brown {
4936cab3a1bSJed Brown   PetscErrorCode ierr;
4946cab3a1bSJed Brown   DM             dm;
4956cab3a1bSJed Brown   SNESDM         sdm;
4966cab3a1bSJed Brown 
4976cab3a1bSJed Brown   PetscFunctionBegin;
4986cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
4996cab3a1bSJed Brown   ierr = DMSNESGetContext(dm,&sdm);CHKERRQ(ierr);
500caa4e7f2SJed Brown   if (!sdm->computejacobian) {
501a33a0d9fSJed Brown     SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_PLIB,"SNESDM not properly configured");
5023232da50SPeter Brune   } else if (!snes->jacobian && snes->mf) {
5036cab3a1bSJed Brown     Mat J;
5046cab3a1bSJed Brown     void *functx;
5056cab3a1bSJed Brown     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
5066cab3a1bSJed Brown     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
5076cab3a1bSJed Brown     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
5086cab3a1bSJed Brown     ierr = SNESGetFunction(snes,PETSC_NULL,PETSC_NULL,&functx);CHKERRQ(ierr);
5093232da50SPeter Brune     ierr = SNESSetJacobian(snes,J,J,0,0);CHKERRQ(ierr);
5106cab3a1bSJed Brown     ierr = MatDestroy(&J);CHKERRQ(ierr);
511caa4e7f2SJed Brown   } else if (snes->mf_operator && !snes->jacobian_pre && !snes->jacobian) {
5126cab3a1bSJed Brown     Mat J,B;
5136cab3a1bSJed Brown     ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr);
5146cab3a1bSJed Brown     ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr);
5156cab3a1bSJed Brown     ierr = MatSetFromOptions(J);CHKERRQ(ierr);
5166cab3a1bSJed Brown     ierr = DMCreateMatrix(snes->dm,MATAIJ,&B);CHKERRQ(ierr);
51706f20277SJed Brown     /* sdm->computejacobian was already set to reach here */
51806f20277SJed Brown     ierr = SNESSetJacobian(snes,J,B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
5196cab3a1bSJed Brown     ierr = MatDestroy(&J);CHKERRQ(ierr);
5206cab3a1bSJed Brown     ierr = MatDestroy(&B);CHKERRQ(ierr);
521caa4e7f2SJed Brown   } else if (!snes->jacobian_pre) {
5226cab3a1bSJed Brown     Mat J,B;
5236cab3a1bSJed Brown     J = snes->jacobian;
5246cab3a1bSJed Brown     ierr = DMCreateMatrix(snes->dm,MATAIJ,&B);CHKERRQ(ierr);
5256cab3a1bSJed Brown     ierr = SNESSetJacobian(snes,J?J:B,B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
5266cab3a1bSJed Brown     ierr = MatDestroy(&B);CHKERRQ(ierr);
5276cab3a1bSJed Brown   }
528caa4e7f2SJed Brown   {
529caa4e7f2SJed Brown     KSP ksp;
530caa4e7f2SJed Brown     ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
531caa4e7f2SJed Brown     ierr = KSPSetComputeOperators(ksp,KSPComputeOperators_SNES,snes);CHKERRQ(ierr);
53216ebb321SJed Brown     ierr = DMCoarsenHookAdd(snes->dm,DMCoarsenHook_SNESVecSol,DMRestrictHook_SNESVecSol,snes);CHKERRQ(ierr);
533caa4e7f2SJed Brown   }
5346cab3a1bSJed Brown   PetscFunctionReturn(0);
5356cab3a1bSJed Brown }
5366cab3a1bSJed Brown 
5376cab3a1bSJed Brown #undef __FUNCT__
5384a2ae208SSatish Balay #define __FUNCT__ "SNESSetFromOptions"
5399b94acceSBarry Smith /*@
54094b7f48cSBarry Smith    SNESSetFromOptions - Sets various SNES and KSP parameters from user options.
5419b94acceSBarry Smith 
542c7afd0dbSLois Curfman McInnes    Collective on SNES
543c7afd0dbSLois Curfman McInnes 
5449b94acceSBarry Smith    Input Parameter:
5459b94acceSBarry Smith .  snes - the SNES context
5469b94acceSBarry Smith 
54736851e7fSLois Curfman McInnes    Options Database Keys:
548ea630c6eSPeter Brune +  -snes_type <type> - ls, tr, ngmres, ncg, richardson, qn, vi, fas
54982738288SBarry Smith .  -snes_stol - convergence tolerance in terms of the norm
55082738288SBarry Smith                 of the change in the solution between steps
55170441072SBarry Smith .  -snes_atol <abstol> - absolute tolerance of residual norm
552b39c3a46SLois Curfman McInnes .  -snes_rtol <rtol> - relative decrease in tolerance norm from initial
553b39c3a46SLois Curfman McInnes .  -snes_max_it <max_it> - maximum number of iterations
554b39c3a46SLois Curfman McInnes .  -snes_max_funcs <max_funcs> - maximum number of function evaluations
5554839bfe8SBarry Smith .  -snes_max_fail <max_fail> - maximum number of line search failures allowed before stopping, default is none
556ddf469c8SBarry Smith .  -snes_max_linear_solve_fail - number of linear solver failures before SNESSolve() stops
557a8054027SBarry Smith .  -snes_lag_preconditioner <lag> - how often preconditioner is rebuilt (use -1 to never rebuild)
558e35cf81dSBarry Smith .  -snes_lag_jacobian <lag> - how often Jacobian is rebuilt (use -1 to never rebuild)
559b39c3a46SLois Curfman McInnes .  -snes_trtol <trtol> - trust region tolerance
5602492ecdbSBarry Smith .  -snes_no_convergence_test - skip convergence test in nonlinear
56182738288SBarry Smith                                solver; hence iterations will continue until max_it
5621fbbfb26SLois Curfman McInnes                                or some other criterion is reached. Saves expense
56382738288SBarry Smith                                of convergence test
564e8105e01SRichard Katz .  -snes_monitor <optional filename> - prints residual norm at each iteration. if no
565e8105e01SRichard Katz                                        filename given prints to stdout
566a6570f20SBarry Smith .  -snes_monitor_solution - plots solution at each iteration
567a6570f20SBarry Smith .  -snes_monitor_residual - plots residual (not its norm) at each iteration
568a6570f20SBarry Smith .  -snes_monitor_solution_update - plots update to solution at each iteration
5694619e776SBarry Smith .  -snes_monitor_lg_residualnorm - plots residual norm at each iteration
570459f5d12SBarry Smith .  -snes_monitor_lg_range - plots residual norm at each iteration
571e24b481bSBarry Smith .  -snes_fd - use finite differences to compute Jacobian; very slow, only for testing
572e2e60de9SPeter Brune .  -snes_fd_color - use finite differences with coloring to compute Jacobian
5735968eb51SBarry Smith .  -snes_mf_ksp_monitor - if using matrix-free multiply then print h at each KSP iteration
574fee2055bSBarry Smith -  -snes_converged_reason - print the reason for convergence/divergence after each solve
57582738288SBarry Smith 
57682738288SBarry Smith     Options Database for Eisenstat-Walker method:
577fa9f3622SBarry Smith +  -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence
5784b27c08aSLois Curfman McInnes .  -snes_ksp_ew_version ver - version of  Eisenstat-Walker method
57936851e7fSLois Curfman McInnes .  -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0
58036851e7fSLois Curfman McInnes .  -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax
58136851e7fSLois Curfman McInnes .  -snes_ksp_ew_gamma <gamma> - Sets gamma
58236851e7fSLois Curfman McInnes .  -snes_ksp_ew_alpha <alpha> - Sets alpha
58336851e7fSLois Curfman McInnes .  -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2
58436851e7fSLois Curfman McInnes -  -snes_ksp_ew_threshold <threshold> - Sets threshold
58582738288SBarry Smith 
58611ca99fdSLois Curfman McInnes    Notes:
58711ca99fdSLois Curfman McInnes    To see all options, run your program with the -help option or consult
5880598bfebSBarry Smith    the <A href="../../docs/manual.pdf#nameddest=ch_snes">SNES chapter of the users manual</A>.
58983e2fdc7SBarry Smith 
59036851e7fSLois Curfman McInnes    Level: beginner
59136851e7fSLois Curfman McInnes 
5929b94acceSBarry Smith .keywords: SNES, nonlinear, set, options, database
5939b94acceSBarry Smith 
59469ed319cSSatish Balay .seealso: SNESSetOptionsPrefix()
5959b94acceSBarry Smith @*/
5967087cfbeSBarry Smith PetscErrorCode  SNESSetFromOptions(SNES snes)
5979b94acceSBarry Smith {
598d8f46077SPeter Brune   PetscBool               flg,pcset;
599d8f46077SPeter Brune   PetscInt                i,indx,lag,grids;
600aa3661deSLisandro Dalcin   MatStructure            matflag;
60185385478SLisandro Dalcin   const char              *deft = SNESLS;
60285385478SLisandro Dalcin   const char              *convtests[] = {"default","skip"};
60385385478SLisandro Dalcin   SNESKSPEW               *kctx = NULL;
604e8105e01SRichard Katz   char                    type[256], monfilename[PETSC_MAX_PATH_LEN];
605649052a6SBarry Smith   PetscViewer             monviewer;
60685385478SLisandro Dalcin   PetscErrorCode          ierr;
607c40d0f55SPeter Brune   PCSide                  pcside;
608a64e098fSPeter Brune   const char              *optionsprefix;
6099b94acceSBarry Smith 
6103a40ed3dSBarry Smith   PetscFunctionBegin;
6110700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
612ca161407SBarry Smith 
613186905e3SBarry Smith   if (!SNESRegisterAllCalled) {ierr = SNESRegisterAll(PETSC_NULL);CHKERRQ(ierr);}
6143194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)snes);CHKERRQ(ierr);
6157adad957SLisandro Dalcin     if (((PetscObject)snes)->type_name) { deft = ((PetscObject)snes)->type_name; }
616b0a32e0cSBarry Smith     ierr = PetscOptionsList("-snes_type","Nonlinear solver method","SNESSetType",SNESList,deft,type,256,&flg);CHKERRQ(ierr);
617d64ed03dSBarry Smith     if (flg) {
618186905e3SBarry Smith       ierr = SNESSetType(snes,type);CHKERRQ(ierr);
6197adad957SLisandro Dalcin     } else if (!((PetscObject)snes)->type_name) {
620186905e3SBarry Smith       ierr = SNESSetType(snes,deft);CHKERRQ(ierr);
621d64ed03dSBarry Smith     }
62290d69ab7SBarry Smith     /* not used here, but called so will go into help messaage */
623909c8a9fSBarry Smith     ierr = PetscOptionsName("-snes_view","Print detailed information on solver used","SNESView",0);CHKERRQ(ierr);
62493c39befSBarry Smith 
625c60f73f4SPeter Brune     ierr = PetscOptionsReal("-snes_stol","Stop if step length less than","SNESSetTolerances",snes->stol,&snes->stol,0);CHKERRQ(ierr);
62657034d6fSHong Zhang     ierr = PetscOptionsReal("-snes_atol","Stop if function norm less than","SNESSetTolerances",snes->abstol,&snes->abstol,0);CHKERRQ(ierr);
627186905e3SBarry Smith 
62857034d6fSHong Zhang     ierr = PetscOptionsReal("-snes_rtol","Stop if decrease in function norm less than","SNESSetTolerances",snes->rtol,&snes->rtol,0);CHKERRQ(ierr);
629b0a32e0cSBarry Smith     ierr = PetscOptionsInt("-snes_max_it","Maximum iterations","SNESSetTolerances",snes->max_its,&snes->max_its,PETSC_NULL);CHKERRQ(ierr);
630b0a32e0cSBarry Smith     ierr = PetscOptionsInt("-snes_max_funcs","Maximum function evaluations","SNESSetTolerances",snes->max_funcs,&snes->max_funcs,PETSC_NULL);CHKERRQ(ierr);
63124254dc1SJed Brown     ierr = PetscOptionsInt("-snes_max_fail","Maximum nonlinear step failures","SNESSetMaxNonlinearStepFailures",snes->maxFailures,&snes->maxFailures,PETSC_NULL);CHKERRQ(ierr);
632ddf469c8SBarry Smith     ierr = PetscOptionsInt("-snes_max_linear_solve_fail","Maximum failures in linear solves allowed","SNESSetMaxLinearSolveFailures",snes->maxLinearSolveFailures,&snes->maxLinearSolveFailures,PETSC_NULL);CHKERRQ(ierr);
633acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_error_if_not_converged","Generate error if solver does not converge","SNESSetErrorIfNotConverged",snes->errorifnotconverged,&snes->errorifnotconverged,PETSC_NULL);CHKERRQ(ierr);
63485385478SLisandro Dalcin 
635a8054027SBarry Smith     ierr = PetscOptionsInt("-snes_lag_preconditioner","How often to rebuild preconditioner","SNESSetLagPreconditioner",snes->lagpreconditioner,&lag,&flg);CHKERRQ(ierr);
636a8054027SBarry Smith     if (flg) {
637a8054027SBarry Smith       ierr = SNESSetLagPreconditioner(snes,lag);CHKERRQ(ierr);
638a8054027SBarry Smith     }
639e35cf81dSBarry Smith     ierr = PetscOptionsInt("-snes_lag_jacobian","How often to rebuild Jacobian","SNESSetLagJacobian",snes->lagjacobian,&lag,&flg);CHKERRQ(ierr);
640e35cf81dSBarry Smith     if (flg) {
641e35cf81dSBarry Smith       ierr = SNESSetLagJacobian(snes,lag);CHKERRQ(ierr);
642e35cf81dSBarry Smith     }
643efd51863SBarry Smith     ierr = PetscOptionsInt("-snes_grid_sequence","Use grid sequencing to generate initial guess","SNESSetGridSequence",snes->gridsequence,&grids,&flg);CHKERRQ(ierr);
644efd51863SBarry Smith     if (flg) {
645efd51863SBarry Smith       ierr = SNESSetGridSequence(snes,grids);CHKERRQ(ierr);
646efd51863SBarry Smith     }
647a8054027SBarry Smith 
64885385478SLisandro Dalcin     ierr = PetscOptionsEList("-snes_convergence_test","Convergence test","SNESSetConvergenceTest",convtests,2,"default",&indx,&flg);CHKERRQ(ierr);
64985385478SLisandro Dalcin     if (flg) {
65085385478SLisandro Dalcin       switch (indx) {
6517f7931b9SBarry Smith       case 0: ierr = SNESSetConvergenceTest(snes,SNESDefaultConverged,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); break;
6527f7931b9SBarry Smith       case 1: ierr = SNESSetConvergenceTest(snes,SNESSkipConverged,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);    break;
65385385478SLisandro Dalcin       }
65485385478SLisandro Dalcin     }
65585385478SLisandro Dalcin 
656acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_converged_reason","Print reason for converged or diverged","SNESSolve",snes->printreason,&snes->printreason,PETSC_NULL);CHKERRQ(ierr);
657186905e3SBarry Smith 
658fdacfa88SPeter Brune     ierr = PetscOptionsEList("-snes_norm_type","SNES Norm type","SNESSetNormType",SNESNormTypes,5,"function",&indx,&flg);CHKERRQ(ierr);
659fdacfa88SPeter Brune     if (flg) { ierr = SNESSetNormType(snes,(SNESNormType)indx);CHKERRQ(ierr); }
660fdacfa88SPeter Brune 
66185385478SLisandro Dalcin     kctx = (SNESKSPEW *)snes->kspconvctx;
66285385478SLisandro Dalcin 
663acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_ksp_ew","Use Eisentat-Walker linear system convergence test","SNESKSPSetUseEW",snes->ksp_ewconv,&snes->ksp_ewconv,PETSC_NULL);CHKERRQ(ierr);
664186905e3SBarry Smith 
665fa9f3622SBarry Smith     ierr = PetscOptionsInt("-snes_ksp_ew_version","Version 1, 2 or 3","SNESKSPSetParametersEW",kctx->version,&kctx->version,0);CHKERRQ(ierr);
666fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_rtol0","0 <= rtol0 < 1","SNESKSPSetParametersEW",kctx->rtol_0,&kctx->rtol_0,0);CHKERRQ(ierr);
667fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_rtolmax","0 <= rtolmax < 1","SNESKSPSetParametersEW",kctx->rtol_max,&kctx->rtol_max,0);CHKERRQ(ierr);
668fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_gamma","0 <= gamma <= 1","SNESKSPSetParametersEW",kctx->gamma,&kctx->gamma,0);CHKERRQ(ierr);
669fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_alpha","1 < alpha <= 2","SNESKSPSetParametersEW",kctx->alpha,&kctx->alpha,0);CHKERRQ(ierr);
670fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_alpha2","alpha2","SNESKSPSetParametersEW",kctx->alpha2,&kctx->alpha2,0);CHKERRQ(ierr);
671fa9f3622SBarry Smith     ierr = PetscOptionsReal("-snes_ksp_ew_threshold","0 < threshold < 1","SNESKSPSetParametersEW",kctx->threshold,&kctx->threshold,0);CHKERRQ(ierr);
672186905e3SBarry Smith 
67390d69ab7SBarry Smith     flg  = PETSC_FALSE;
674acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_cancel","Remove all monitors","SNESMonitorCancel",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
675a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorCancel(snes);CHKERRQ(ierr);}
676eabae89aSBarry Smith 
677a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_monitor","Monitor norm of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
678e8105e01SRichard Katz     if (flg) {
679649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
680649052a6SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
681e8105e01SRichard Katz     }
682eabae89aSBarry Smith 
683b271bb04SBarry Smith     ierr = PetscOptionsString("-snes_monitor_range","Monitor range of elements of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
684b271bb04SBarry Smith     if (flg) {
685b271bb04SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorRange,0,0);CHKERRQ(ierr);
686b271bb04SBarry Smith     }
687b271bb04SBarry Smith 
688a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_ratiomonitor","Monitor ratios of norms of function","SNESMonitorSetRatio","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
689eabae89aSBarry Smith     if (flg) {
690649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
691f1bef1bcSMatthew Knepley       ierr = SNESMonitorSetRatio(snes,monviewer);CHKERRQ(ierr);
692e8105e01SRichard Katz     }
693eabae89aSBarry Smith 
694a6570f20SBarry Smith     ierr = PetscOptionsString("-snes_monitor_short","Monitor norm of function (fewer digits)","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
695eabae89aSBarry Smith     if (flg) {
696649052a6SBarry Smith       ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr);
697649052a6SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorDefaultShort,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
698eabae89aSBarry Smith     }
699eabae89aSBarry Smith 
7005180491cSLisandro Dalcin     ierr = PetscOptionsString("-snes_monitor_python","Use Python function","SNESMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
7015180491cSLisandro Dalcin     if (flg) {ierr = PetscPythonMonitorSet((PetscObject)snes,monfilename);CHKERRQ(ierr);}
7025180491cSLisandro Dalcin 
70390d69ab7SBarry Smith     flg  = PETSC_FALSE;
704acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_solution","Plot solution at each iteration","SNESMonitorSolution",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
705a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolution,0,0);CHKERRQ(ierr);}
70690d69ab7SBarry Smith     flg  = PETSC_FALSE;
707acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_solution_update","Plot correction at each iteration","SNESMonitorSolutionUpdate",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
708a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolutionUpdate,0,0);CHKERRQ(ierr);}
70990d69ab7SBarry Smith     flg  = PETSC_FALSE;
710acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_monitor_residual","Plot residual at each iteration","SNESMonitorResidual",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
711a6570f20SBarry Smith     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorResidual,0,0);CHKERRQ(ierr);}
71290d69ab7SBarry Smith     flg  = PETSC_FALSE;
7134619e776SBarry Smith     ierr = PetscOptionsBool("-snes_monitor_lg_residualnorm","Plot function norm at each iteration","SNESMonitorLGResidualNorm",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
714459f5d12SBarry Smith     if (flg) {
715459f5d12SBarry Smith       PetscDrawLG ctx;
716459f5d12SBarry Smith 
717459f5d12SBarry Smith       ierr = SNESMonitorLGCreate(0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,&ctx);CHKERRQ(ierr);
718459f5d12SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorLGResidualNorm,ctx,(PetscErrorCode (*)(void**))SNESMonitorLGDestroy);CHKERRQ(ierr);
719459f5d12SBarry Smith     }
72090d69ab7SBarry Smith     flg  = PETSC_FALSE;
7214619e776SBarry Smith     ierr = PetscOptionsBool("-snes_monitor_lg_range","Plot function range at each iteration","SNESMonitorLGRange",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
722459f5d12SBarry Smith     if (flg) {
723459f5d12SBarry Smith       PetscViewer ctx;
724e24b481bSBarry Smith 
725459f5d12SBarry Smith       ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,&ctx);CHKERRQ(ierr);
726459f5d12SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorLGRange,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
727459f5d12SBarry Smith     }
7282e7541e6SPeter Brune 
7292e7541e6SPeter Brune     flg  = PETSC_FALSE;
7302e7541e6SPeter Brune     ierr = PetscOptionsBool("-snes_monitor_jacupdate_spectrum","Print the change in the spectrum of the Jacobian","SNESMonitorJacUpdateSpectrum",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
7312e7541e6SPeter Brune     if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorJacUpdateSpectrum,0,0);CHKERRQ(ierr);}
7322e7541e6SPeter Brune 
73390d69ab7SBarry Smith     flg  = PETSC_FALSE;
734acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_fd","Use finite differences (slow) to compute Jacobian","SNESDefaultComputeJacobian",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
7354b27c08aSLois Curfman McInnes     if (flg) {
7366cab3a1bSJed Brown       void *functx;
7376cab3a1bSJed Brown       ierr = SNESGetFunction(snes,PETSC_NULL,PETSC_NULL,&functx);CHKERRQ(ierr);
7386cab3a1bSJed Brown       ierr = SNESSetJacobian(snes,snes->jacobian,snes->jacobian_pre,SNESDefaultComputeJacobian,functx);CHKERRQ(ierr);
739ae15b995SBarry Smith       ierr = PetscInfo(snes,"Setting default finite difference Jacobian matrix\n");CHKERRQ(ierr);
7409b94acceSBarry Smith     }
741639f9d9dSBarry Smith 
74244848bc4SPeter Brune     flg  = PETSC_FALSE;
74397584545SPeter Brune     ierr = PetscOptionsBool("-snes_fd_function","Use finite differences (slow) to compute function from user objective","SNESDefaultObjectiveComputeFunctionFD",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
74497584545SPeter Brune     if (flg) {
74597584545SPeter Brune       ierr = SNESSetFunction(snes,PETSC_NULL,SNESDefaultObjectiveComputeFunctionFD,PETSC_NULL);CHKERRQ(ierr);
74697584545SPeter Brune     }
74797584545SPeter Brune 
74897584545SPeter Brune     flg  = PETSC_FALSE;
74944848bc4SPeter Brune     ierr = PetscOptionsBool("-snes_fd_color","Use finite differences with coloring to compute Jacobian","SNESDefaultComputeJacobianColor",flg,&flg,PETSC_NULL);CHKERRQ(ierr);
75044848bc4SPeter Brune     if (flg) {
75144848bc4SPeter Brune       void *functx;
75244848bc4SPeter Brune       ierr = SNESGetFunction(snes,PETSC_NULL,PETSC_NULL,&functx);CHKERRQ(ierr);
7530171d955SPeter Brune       ierr = SNESSetJacobian(snes,snes->jacobian,snes->jacobian_pre,SNESDefaultComputeJacobianColor,0);CHKERRQ(ierr);
75444848bc4SPeter Brune       ierr = PetscInfo(snes,"Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
75544848bc4SPeter Brune     }
75644848bc4SPeter Brune 
757aa3661deSLisandro Dalcin     flg = PETSC_FALSE;
758d8f46077SPeter 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);
759d8f46077SPeter Brune     if (flg && snes->mf_operator) {
760a8248277SBarry Smith       snes->mf_operator = PETSC_TRUE;
761d8f46077SPeter Brune       snes->mf = PETSC_TRUE;
762a8248277SBarry Smith     }
763aa3661deSLisandro Dalcin     flg = PETSC_FALSE;
764d8f46077SPeter Brune     ierr = PetscOptionsBool("-snes_mf","Use a Matrix-Free Jacobian with no preconditioner matrix","MatCreateSNESMF",PETSC_FALSE,&snes->mf,&flg);CHKERRQ(ierr);
765d8f46077SPeter Brune     if (!flg && snes->mf_operator) snes->mf = PETSC_TRUE;
766d8f46077SPeter Brune     ierr = PetscOptionsInt("-snes_mf_version","Matrix-Free routines version 1 or 2","None",snes->mf_version,&snes->mf_version,0);CHKERRQ(ierr);
767d28543b3SPeter Brune 
768c40d0f55SPeter Brune     flg = PETSC_FALSE;
769c40d0f55SPeter Brune     ierr = SNESGetPCSide(snes,&pcside);
770c40d0f55SPeter Brune     ierr = PetscOptionsEnum("-snes_npc_side","SNES nonlinear preconditioner side","SNESSetPCSide",PCSides,(PetscEnum)pcside,(PetscEnum*)&pcside,&flg);CHKERRQ(ierr);
771c40d0f55SPeter Brune     if (flg) {ierr = SNESSetPCSide(snes,pcside);CHKERRQ(ierr);}
772c40d0f55SPeter Brune 
77389b92e6fSPeter Brune     /* GS Options */
77489b92e6fSPeter Brune     ierr = PetscOptionsInt("-snes_gs_sweeps","Number of sweeps of GS to apply","SNESComputeGS",snes->gssweeps,&snes->gssweeps,PETSC_NULL);CHKERRQ(ierr);
77589b92e6fSPeter Brune 
77676b2cf59SMatthew Knepley     for (i = 0; i < numberofsetfromoptions; i++) {
77776b2cf59SMatthew Knepley       ierr = (*othersetfromoptions[i])(snes);CHKERRQ(ierr);
77876b2cf59SMatthew Knepley     }
77976b2cf59SMatthew Knepley 
780e7788613SBarry Smith     if (snes->ops->setfromoptions) {
781e7788613SBarry Smith       ierr = (*snes->ops->setfromoptions)(snes);CHKERRQ(ierr);
782639f9d9dSBarry Smith     }
7835d973c19SBarry Smith 
7845d973c19SBarry Smith     /* process any options handlers added with PetscObjectAddOptionsHandler() */
7855d973c19SBarry Smith     ierr = PetscObjectProcessOptionsHandlers((PetscObject)snes);CHKERRQ(ierr);
786b0a32e0cSBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
7874bbc92c1SBarry Smith 
7881cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
789aa3661deSLisandro Dalcin   ierr = KSPGetOperators(snes->ksp,PETSC_NULL,PETSC_NULL,&matflag);
790aa3661deSLisandro Dalcin   ierr = KSPSetOperators(snes->ksp,snes->jacobian,snes->jacobian_pre,matflag);CHKERRQ(ierr);
79185385478SLisandro Dalcin   ierr = KSPSetFromOptions(snes->ksp);CHKERRQ(ierr);
79293993e2dSLois Curfman McInnes 
7939e764e56SPeter Brune   if (!snes->linesearch) {
794f1c6b773SPeter Brune     ierr = SNESGetSNESLineSearch(snes, &snes->linesearch);CHKERRQ(ierr);
7959e764e56SPeter Brune   }
796f1c6b773SPeter Brune   ierr = SNESLineSearchSetFromOptions(snes->linesearch);CHKERRQ(ierr);
7979e764e56SPeter Brune 
79851e86f29SPeter Brune   /* if someone has set the SNES PC type, create it. */
79951e86f29SPeter Brune   ierr = SNESGetOptionsPrefix(snes, &optionsprefix);CHKERRQ(ierr);
80051e86f29SPeter Brune   ierr = PetscOptionsHasName(optionsprefix, "-npc_snes_type", &pcset);CHKERRQ(ierr);
80151e86f29SPeter Brune   if (pcset && (!snes->pc)) {
80251e86f29SPeter Brune     ierr = SNESGetPC(snes, &snes->pc);CHKERRQ(ierr);
80351e86f29SPeter Brune   }
8043a40ed3dSBarry Smith   PetscFunctionReturn(0);
8059b94acceSBarry Smith }
8069b94acceSBarry Smith 
807d25893d9SBarry Smith #undef __FUNCT__
808d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeApplicationContext"
809d25893d9SBarry Smith /*@
810d25893d9SBarry Smith    SNESSetComputeApplicationContext - Sets an optional function to compute a user-defined context for
811d25893d9SBarry Smith    the nonlinear solvers.
812d25893d9SBarry Smith 
813d25893d9SBarry Smith    Logically Collective on SNES
814d25893d9SBarry Smith 
815d25893d9SBarry Smith    Input Parameters:
816d25893d9SBarry Smith +  snes - the SNES context
817d25893d9SBarry Smith .  compute - function to compute the context
818d25893d9SBarry Smith -  destroy - function to destroy the context
819d25893d9SBarry Smith 
820d25893d9SBarry Smith    Level: intermediate
821d25893d9SBarry Smith 
822d25893d9SBarry Smith .keywords: SNES, nonlinear, set, application, context
823d25893d9SBarry Smith 
824d25893d9SBarry Smith .seealso: SNESGetApplicationContext(), SNESSetComputeApplicationContext(), SNESGetApplicationContext()
825d25893d9SBarry Smith @*/
826d25893d9SBarry Smith PetscErrorCode  SNESSetComputeApplicationContext(SNES snes,PetscErrorCode (*compute)(SNES,void**),PetscErrorCode (*destroy)(void**))
827d25893d9SBarry Smith {
828d25893d9SBarry Smith   PetscFunctionBegin;
829d25893d9SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
830d25893d9SBarry Smith   snes->ops->usercompute = compute;
831d25893d9SBarry Smith   snes->ops->userdestroy = destroy;
832d25893d9SBarry Smith   PetscFunctionReturn(0);
833d25893d9SBarry Smith }
834a847f771SSatish Balay 
8354a2ae208SSatish Balay #undef __FUNCT__
8364a2ae208SSatish Balay #define __FUNCT__ "SNESSetApplicationContext"
837b07ff414SBarry Smith /*@
8389b94acceSBarry Smith    SNESSetApplicationContext - Sets the optional user-defined context for
8399b94acceSBarry Smith    the nonlinear solvers.
8409b94acceSBarry Smith 
8413f9fe445SBarry Smith    Logically Collective on SNES
842fee21e36SBarry Smith 
843c7afd0dbSLois Curfman McInnes    Input Parameters:
844c7afd0dbSLois Curfman McInnes +  snes - the SNES context
845c7afd0dbSLois Curfman McInnes -  usrP - optional user context
846c7afd0dbSLois Curfman McInnes 
84736851e7fSLois Curfman McInnes    Level: intermediate
84836851e7fSLois Curfman McInnes 
8499b94acceSBarry Smith .keywords: SNES, nonlinear, set, application, context
8509b94acceSBarry Smith 
851ecaffddaSVictor Eijkhout .seealso: SNESGetApplicationContext()
8529b94acceSBarry Smith @*/
8537087cfbeSBarry Smith PetscErrorCode  SNESSetApplicationContext(SNES snes,void *usrP)
8549b94acceSBarry Smith {
8551b2093e4SBarry Smith   PetscErrorCode ierr;
856b07ff414SBarry Smith   KSP            ksp;
8571b2093e4SBarry Smith 
8583a40ed3dSBarry Smith   PetscFunctionBegin;
8590700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
860b07ff414SBarry Smith   ierr       = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
861b07ff414SBarry Smith   ierr       = KSPSetApplicationContext(ksp,usrP);CHKERRQ(ierr);
8629b94acceSBarry Smith   snes->user = usrP;
8633a40ed3dSBarry Smith   PetscFunctionReturn(0);
8649b94acceSBarry Smith }
86574679c65SBarry Smith 
8664a2ae208SSatish Balay #undef __FUNCT__
8674a2ae208SSatish Balay #define __FUNCT__ "SNESGetApplicationContext"
868b07ff414SBarry Smith /*@
8699b94acceSBarry Smith    SNESGetApplicationContext - Gets the user-defined context for the
8709b94acceSBarry Smith    nonlinear solvers.
8719b94acceSBarry Smith 
872c7afd0dbSLois Curfman McInnes    Not Collective
873c7afd0dbSLois Curfman McInnes 
8749b94acceSBarry Smith    Input Parameter:
8759b94acceSBarry Smith .  snes - SNES context
8769b94acceSBarry Smith 
8779b94acceSBarry Smith    Output Parameter:
8789b94acceSBarry Smith .  usrP - user context
8799b94acceSBarry Smith 
88036851e7fSLois Curfman McInnes    Level: intermediate
88136851e7fSLois Curfman McInnes 
8829b94acceSBarry Smith .keywords: SNES, nonlinear, get, application, context
8839b94acceSBarry Smith 
8849b94acceSBarry Smith .seealso: SNESSetApplicationContext()
8859b94acceSBarry Smith @*/
886e71120c6SJed Brown PetscErrorCode  SNESGetApplicationContext(SNES snes,void *usrP)
8879b94acceSBarry Smith {
8883a40ed3dSBarry Smith   PetscFunctionBegin;
8890700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
890e71120c6SJed Brown   *(void**)usrP = snes->user;
8913a40ed3dSBarry Smith   PetscFunctionReturn(0);
8929b94acceSBarry Smith }
89374679c65SBarry Smith 
8944a2ae208SSatish Balay #undef __FUNCT__
8954a2ae208SSatish Balay #define __FUNCT__ "SNESGetIterationNumber"
8969b94acceSBarry Smith /*@
897c8228a4eSBarry Smith    SNESGetIterationNumber - Gets the number of nonlinear iterations completed
898c8228a4eSBarry Smith    at this time.
8999b94acceSBarry Smith 
900c7afd0dbSLois Curfman McInnes    Not Collective
901c7afd0dbSLois Curfman McInnes 
9029b94acceSBarry Smith    Input Parameter:
9039b94acceSBarry Smith .  snes - SNES context
9049b94acceSBarry Smith 
9059b94acceSBarry Smith    Output Parameter:
9069b94acceSBarry Smith .  iter - iteration number
9079b94acceSBarry Smith 
908c8228a4eSBarry Smith    Notes:
909c8228a4eSBarry Smith    For example, during the computation of iteration 2 this would return 1.
910c8228a4eSBarry Smith 
911c8228a4eSBarry Smith    This is useful for using lagged Jacobians (where one does not recompute the
91208405cd6SLois Curfman McInnes    Jacobian at each SNES iteration). For example, the code
91308405cd6SLois Curfman McInnes .vb
91408405cd6SLois Curfman McInnes       ierr = SNESGetIterationNumber(snes,&it);
91508405cd6SLois Curfman McInnes       if (!(it % 2)) {
91608405cd6SLois Curfman McInnes         [compute Jacobian here]
91708405cd6SLois Curfman McInnes       }
91808405cd6SLois Curfman McInnes .ve
919c8228a4eSBarry Smith    can be used in your ComputeJacobian() function to cause the Jacobian to be
92008405cd6SLois Curfman McInnes    recomputed every second SNES iteration.
921c8228a4eSBarry Smith 
92236851e7fSLois Curfman McInnes    Level: intermediate
92336851e7fSLois Curfman McInnes 
9242b668275SBarry Smith .keywords: SNES, nonlinear, get, iteration, number,
9252b668275SBarry Smith 
926b850b91aSLisandro Dalcin .seealso:   SNESGetFunctionNorm(), SNESGetLinearSolveIterations()
9279b94acceSBarry Smith @*/
9287087cfbeSBarry Smith PetscErrorCode  SNESGetIterationNumber(SNES snes,PetscInt* iter)
9299b94acceSBarry Smith {
9303a40ed3dSBarry Smith   PetscFunctionBegin;
9310700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
9324482741eSBarry Smith   PetscValidIntPointer(iter,2);
9339b94acceSBarry Smith   *iter = snes->iter;
9343a40ed3dSBarry Smith   PetscFunctionReturn(0);
9359b94acceSBarry Smith }
93674679c65SBarry Smith 
9374a2ae208SSatish Balay #undef __FUNCT__
938360c497dSPeter Brune #define __FUNCT__ "SNESSetIterationNumber"
939360c497dSPeter Brune /*@
940360c497dSPeter Brune    SNESSetIterationNumber - Sets the current iteration number.
941360c497dSPeter Brune 
942360c497dSPeter Brune    Not Collective
943360c497dSPeter Brune 
944360c497dSPeter Brune    Input Parameter:
945360c497dSPeter Brune .  snes - SNES context
946360c497dSPeter Brune .  iter - iteration number
947360c497dSPeter Brune 
948360c497dSPeter Brune    Level: developer
949360c497dSPeter Brune 
950360c497dSPeter Brune .keywords: SNES, nonlinear, set, iteration, number,
951360c497dSPeter Brune 
952360c497dSPeter Brune .seealso:   SNESGetFunctionNorm(), SNESGetLinearSolveIterations()
953360c497dSPeter Brune @*/
954360c497dSPeter Brune PetscErrorCode  SNESSetIterationNumber(SNES snes,PetscInt iter)
955360c497dSPeter Brune {
956360c497dSPeter Brune   PetscErrorCode ierr;
957360c497dSPeter Brune 
958360c497dSPeter Brune   PetscFunctionBegin;
959360c497dSPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
960360c497dSPeter Brune   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
961360c497dSPeter Brune   snes->iter = iter;
962360c497dSPeter Brune   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
963360c497dSPeter Brune   PetscFunctionReturn(0);
964360c497dSPeter Brune }
965360c497dSPeter Brune 
966360c497dSPeter Brune #undef __FUNCT__
9674a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunctionNorm"
9689b94acceSBarry Smith /*@
9699b94acceSBarry Smith    SNESGetFunctionNorm - Gets the norm of the current function that was set
9709b94acceSBarry Smith    with SNESSSetFunction().
9719b94acceSBarry Smith 
972c7afd0dbSLois Curfman McInnes    Collective on SNES
973c7afd0dbSLois Curfman McInnes 
9749b94acceSBarry Smith    Input Parameter:
9759b94acceSBarry Smith .  snes - SNES context
9769b94acceSBarry Smith 
9779b94acceSBarry Smith    Output Parameter:
9789b94acceSBarry Smith .  fnorm - 2-norm of function
9799b94acceSBarry Smith 
98036851e7fSLois Curfman McInnes    Level: intermediate
98136851e7fSLois Curfman McInnes 
9829b94acceSBarry Smith .keywords: SNES, nonlinear, get, function, norm
983a86d99e1SLois Curfman McInnes 
984b850b91aSLisandro Dalcin .seealso: SNESGetFunction(), SNESGetIterationNumber(), SNESGetLinearSolveIterations()
9859b94acceSBarry Smith @*/
9867087cfbeSBarry Smith PetscErrorCode  SNESGetFunctionNorm(SNES snes,PetscReal *fnorm)
9879b94acceSBarry Smith {
9883a40ed3dSBarry Smith   PetscFunctionBegin;
9890700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
9904482741eSBarry Smith   PetscValidScalarPointer(fnorm,2);
9919b94acceSBarry Smith   *fnorm = snes->norm;
9923a40ed3dSBarry Smith   PetscFunctionReturn(0);
9939b94acceSBarry Smith }
99474679c65SBarry Smith 
995360c497dSPeter Brune 
996360c497dSPeter Brune #undef __FUNCT__
997360c497dSPeter Brune #define __FUNCT__ "SNESSetFunctionNorm"
998360c497dSPeter Brune /*@
999360c497dSPeter Brune    SNESSetFunctionNorm - Sets the 2-norm of the current function computed using VecNorm().
1000360c497dSPeter Brune 
1001360c497dSPeter Brune    Collective on SNES
1002360c497dSPeter Brune 
1003360c497dSPeter Brune    Input Parameter:
1004360c497dSPeter Brune .  snes - SNES context
1005360c497dSPeter Brune .  fnorm - 2-norm of function
1006360c497dSPeter Brune 
1007360c497dSPeter Brune    Level: developer
1008360c497dSPeter Brune 
1009360c497dSPeter Brune .keywords: SNES, nonlinear, set, function, norm
1010360c497dSPeter Brune 
1011360c497dSPeter Brune .seealso: SNESSetFunction(), SNESSetIterationNumber(), VecNorm().
1012360c497dSPeter Brune @*/
1013360c497dSPeter Brune PetscErrorCode  SNESSetFunctionNorm(SNES snes,PetscReal fnorm)
1014360c497dSPeter Brune {
1015360c497dSPeter Brune 
1016360c497dSPeter Brune   PetscErrorCode ierr;
1017360c497dSPeter Brune 
1018360c497dSPeter Brune   PetscFunctionBegin;
1019360c497dSPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1020360c497dSPeter Brune   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
1021360c497dSPeter Brune   snes->norm = fnorm;
1022360c497dSPeter Brune   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
1023360c497dSPeter Brune   PetscFunctionReturn(0);
1024360c497dSPeter Brune }
1025360c497dSPeter Brune 
10264a2ae208SSatish Balay #undef __FUNCT__
1027b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetNonlinearStepFailures"
10289b94acceSBarry Smith /*@
1029b850b91aSLisandro Dalcin    SNESGetNonlinearStepFailures - Gets the number of unsuccessful steps
10309b94acceSBarry Smith    attempted by the nonlinear solver.
10319b94acceSBarry Smith 
1032c7afd0dbSLois Curfman McInnes    Not Collective
1033c7afd0dbSLois Curfman McInnes 
10349b94acceSBarry Smith    Input Parameter:
10359b94acceSBarry Smith .  snes - SNES context
10369b94acceSBarry Smith 
10379b94acceSBarry Smith    Output Parameter:
10389b94acceSBarry Smith .  nfails - number of unsuccessful steps attempted
10399b94acceSBarry Smith 
1040c96a6f78SLois Curfman McInnes    Notes:
1041c96a6f78SLois Curfman McInnes    This counter is reset to zero for each successive call to SNESSolve().
1042c96a6f78SLois Curfman McInnes 
104336851e7fSLois Curfman McInnes    Level: intermediate
104436851e7fSLois Curfman McInnes 
10459b94acceSBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps
104658ebbce7SBarry Smith 
1047e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(),
104858ebbce7SBarry Smith           SNESSetMaxNonlinearStepFailures(), SNESGetMaxNonlinearStepFailures()
10499b94acceSBarry Smith @*/
10507087cfbeSBarry Smith PetscErrorCode  SNESGetNonlinearStepFailures(SNES snes,PetscInt* nfails)
10519b94acceSBarry Smith {
10523a40ed3dSBarry Smith   PetscFunctionBegin;
10530700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
10544482741eSBarry Smith   PetscValidIntPointer(nfails,2);
105550ffb88aSMatthew Knepley   *nfails = snes->numFailures;
105650ffb88aSMatthew Knepley   PetscFunctionReturn(0);
105750ffb88aSMatthew Knepley }
105850ffb88aSMatthew Knepley 
105950ffb88aSMatthew Knepley #undef __FUNCT__
1060b850b91aSLisandro Dalcin #define __FUNCT__ "SNESSetMaxNonlinearStepFailures"
106150ffb88aSMatthew Knepley /*@
1062b850b91aSLisandro Dalcin    SNESSetMaxNonlinearStepFailures - Sets the maximum number of unsuccessful steps
106350ffb88aSMatthew Knepley    attempted by the nonlinear solver before it gives up.
106450ffb88aSMatthew Knepley 
106550ffb88aSMatthew Knepley    Not Collective
106650ffb88aSMatthew Knepley 
106750ffb88aSMatthew Knepley    Input Parameters:
106850ffb88aSMatthew Knepley +  snes     - SNES context
106950ffb88aSMatthew Knepley -  maxFails - maximum of unsuccessful steps
107050ffb88aSMatthew Knepley 
107150ffb88aSMatthew Knepley    Level: intermediate
107250ffb88aSMatthew Knepley 
107350ffb88aSMatthew Knepley .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps
107458ebbce7SBarry Smith 
1075e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(),
107658ebbce7SBarry Smith           SNESGetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures()
107750ffb88aSMatthew Knepley @*/
10787087cfbeSBarry Smith PetscErrorCode  SNESSetMaxNonlinearStepFailures(SNES snes, PetscInt maxFails)
107950ffb88aSMatthew Knepley {
108050ffb88aSMatthew Knepley   PetscFunctionBegin;
10810700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
108250ffb88aSMatthew Knepley   snes->maxFailures = maxFails;
108350ffb88aSMatthew Knepley   PetscFunctionReturn(0);
108450ffb88aSMatthew Knepley }
108550ffb88aSMatthew Knepley 
108650ffb88aSMatthew Knepley #undef __FUNCT__
1087b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetMaxNonlinearStepFailures"
108850ffb88aSMatthew Knepley /*@
1089b850b91aSLisandro Dalcin    SNESGetMaxNonlinearStepFailures - Gets the maximum number of unsuccessful steps
109050ffb88aSMatthew Knepley    attempted by the nonlinear solver before it gives up.
109150ffb88aSMatthew Knepley 
109250ffb88aSMatthew Knepley    Not Collective
109350ffb88aSMatthew Knepley 
109450ffb88aSMatthew Knepley    Input Parameter:
109550ffb88aSMatthew Knepley .  snes     - SNES context
109650ffb88aSMatthew Knepley 
109750ffb88aSMatthew Knepley    Output Parameter:
109850ffb88aSMatthew Knepley .  maxFails - maximum of unsuccessful steps
109950ffb88aSMatthew Knepley 
110050ffb88aSMatthew Knepley    Level: intermediate
110150ffb88aSMatthew Knepley 
110250ffb88aSMatthew Knepley .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps
110358ebbce7SBarry Smith 
1104e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(),
110558ebbce7SBarry Smith           SNESSetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures()
110658ebbce7SBarry Smith 
110750ffb88aSMatthew Knepley @*/
11087087cfbeSBarry Smith PetscErrorCode  SNESGetMaxNonlinearStepFailures(SNES snes, PetscInt *maxFails)
110950ffb88aSMatthew Knepley {
111050ffb88aSMatthew Knepley   PetscFunctionBegin;
11110700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
11124482741eSBarry Smith   PetscValidIntPointer(maxFails,2);
111350ffb88aSMatthew Knepley   *maxFails = snes->maxFailures;
11143a40ed3dSBarry Smith   PetscFunctionReturn(0);
11159b94acceSBarry Smith }
1116a847f771SSatish Balay 
11174a2ae208SSatish Balay #undef __FUNCT__
11182541af92SBarry Smith #define __FUNCT__ "SNESGetNumberFunctionEvals"
11192541af92SBarry Smith /*@
11202541af92SBarry Smith    SNESGetNumberFunctionEvals - Gets the number of user provided function evaluations
11212541af92SBarry Smith      done by SNES.
11222541af92SBarry Smith 
11232541af92SBarry Smith    Not Collective
11242541af92SBarry Smith 
11252541af92SBarry Smith    Input Parameter:
11262541af92SBarry Smith .  snes     - SNES context
11272541af92SBarry Smith 
11282541af92SBarry Smith    Output Parameter:
11292541af92SBarry Smith .  nfuncs - number of evaluations
11302541af92SBarry Smith 
11312541af92SBarry Smith    Level: intermediate
11322541af92SBarry Smith 
11332541af92SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps
113458ebbce7SBarry Smith 
1135e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures()
11362541af92SBarry Smith @*/
11377087cfbeSBarry Smith PetscErrorCode  SNESGetNumberFunctionEvals(SNES snes, PetscInt *nfuncs)
11382541af92SBarry Smith {
11392541af92SBarry Smith   PetscFunctionBegin;
11400700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
11412541af92SBarry Smith   PetscValidIntPointer(nfuncs,2);
11422541af92SBarry Smith   *nfuncs = snes->nfuncs;
11432541af92SBarry Smith   PetscFunctionReturn(0);
11442541af92SBarry Smith }
11452541af92SBarry Smith 
11462541af92SBarry Smith #undef __FUNCT__
11473d4c4710SBarry Smith #define __FUNCT__ "SNESGetLinearSolveFailures"
11483d4c4710SBarry Smith /*@
11493d4c4710SBarry Smith    SNESGetLinearSolveFailures - Gets the number of failed (non-converged)
11503d4c4710SBarry Smith    linear solvers.
11513d4c4710SBarry Smith 
11523d4c4710SBarry Smith    Not Collective
11533d4c4710SBarry Smith 
11543d4c4710SBarry Smith    Input Parameter:
11553d4c4710SBarry Smith .  snes - SNES context
11563d4c4710SBarry Smith 
11573d4c4710SBarry Smith    Output Parameter:
11583d4c4710SBarry Smith .  nfails - number of failed solves
11593d4c4710SBarry Smith 
11603d4c4710SBarry Smith    Notes:
11613d4c4710SBarry Smith    This counter is reset to zero for each successive call to SNESSolve().
11623d4c4710SBarry Smith 
11633d4c4710SBarry Smith    Level: intermediate
11643d4c4710SBarry Smith 
11653d4c4710SBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps
116658ebbce7SBarry Smith 
1167e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures()
11683d4c4710SBarry Smith @*/
11697087cfbeSBarry Smith PetscErrorCode  SNESGetLinearSolveFailures(SNES snes,PetscInt* nfails)
11703d4c4710SBarry Smith {
11713d4c4710SBarry Smith   PetscFunctionBegin;
11720700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
11733d4c4710SBarry Smith   PetscValidIntPointer(nfails,2);
11743d4c4710SBarry Smith   *nfails = snes->numLinearSolveFailures;
11753d4c4710SBarry Smith   PetscFunctionReturn(0);
11763d4c4710SBarry Smith }
11773d4c4710SBarry Smith 
11783d4c4710SBarry Smith #undef __FUNCT__
11793d4c4710SBarry Smith #define __FUNCT__ "SNESSetMaxLinearSolveFailures"
11803d4c4710SBarry Smith /*@
11813d4c4710SBarry Smith    SNESSetMaxLinearSolveFailures - the number of failed linear solve attempts
11823d4c4710SBarry Smith    allowed before SNES returns with a diverged reason of SNES_DIVERGED_LINEAR_SOLVE
11833d4c4710SBarry Smith 
11843f9fe445SBarry Smith    Logically Collective on SNES
11853d4c4710SBarry Smith 
11863d4c4710SBarry Smith    Input Parameters:
11873d4c4710SBarry Smith +  snes     - SNES context
11883d4c4710SBarry Smith -  maxFails - maximum allowed linear solve failures
11893d4c4710SBarry Smith 
11903d4c4710SBarry Smith    Level: intermediate
11913d4c4710SBarry Smith 
1192a6796414SBarry Smith    Notes: By default this is 0; that is SNES returns on the first failed linear solve
11933d4c4710SBarry Smith 
11943d4c4710SBarry Smith .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps
11953d4c4710SBarry Smith 
119658ebbce7SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations()
11973d4c4710SBarry Smith @*/
11987087cfbeSBarry Smith PetscErrorCode  SNESSetMaxLinearSolveFailures(SNES snes, PetscInt maxFails)
11993d4c4710SBarry Smith {
12003d4c4710SBarry Smith   PetscFunctionBegin;
12010700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1202c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxFails,2);
12033d4c4710SBarry Smith   snes->maxLinearSolveFailures = maxFails;
12043d4c4710SBarry Smith   PetscFunctionReturn(0);
12053d4c4710SBarry Smith }
12063d4c4710SBarry Smith 
12073d4c4710SBarry Smith #undef __FUNCT__
12083d4c4710SBarry Smith #define __FUNCT__ "SNESGetMaxLinearSolveFailures"
12093d4c4710SBarry Smith /*@
12103d4c4710SBarry Smith    SNESGetMaxLinearSolveFailures - gets the maximum number of linear solve failures that
12113d4c4710SBarry Smith      are allowed before SNES terminates
12123d4c4710SBarry Smith 
12133d4c4710SBarry Smith    Not Collective
12143d4c4710SBarry Smith 
12153d4c4710SBarry Smith    Input Parameter:
12163d4c4710SBarry Smith .  snes     - SNES context
12173d4c4710SBarry Smith 
12183d4c4710SBarry Smith    Output Parameter:
12193d4c4710SBarry Smith .  maxFails - maximum of unsuccessful solves allowed
12203d4c4710SBarry Smith 
12213d4c4710SBarry Smith    Level: intermediate
12223d4c4710SBarry Smith 
12233d4c4710SBarry Smith    Notes: By default this is 1; that is SNES returns on the first failed linear solve
12243d4c4710SBarry Smith 
12253d4c4710SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps
12263d4c4710SBarry Smith 
1227e1c61ce8SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(),
12283d4c4710SBarry Smith @*/
12297087cfbeSBarry Smith PetscErrorCode  SNESGetMaxLinearSolveFailures(SNES snes, PetscInt *maxFails)
12303d4c4710SBarry Smith {
12313d4c4710SBarry Smith   PetscFunctionBegin;
12320700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
12333d4c4710SBarry Smith   PetscValidIntPointer(maxFails,2);
12343d4c4710SBarry Smith   *maxFails = snes->maxLinearSolveFailures;
12353d4c4710SBarry Smith   PetscFunctionReturn(0);
12363d4c4710SBarry Smith }
12373d4c4710SBarry Smith 
12383d4c4710SBarry Smith #undef __FUNCT__
1239b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetLinearSolveIterations"
1240c96a6f78SLois Curfman McInnes /*@
1241b850b91aSLisandro Dalcin    SNESGetLinearSolveIterations - Gets the total number of linear iterations
1242c96a6f78SLois Curfman McInnes    used by the nonlinear solver.
1243c96a6f78SLois Curfman McInnes 
1244c7afd0dbSLois Curfman McInnes    Not Collective
1245c7afd0dbSLois Curfman McInnes 
1246c96a6f78SLois Curfman McInnes    Input Parameter:
1247c96a6f78SLois Curfman McInnes .  snes - SNES context
1248c96a6f78SLois Curfman McInnes 
1249c96a6f78SLois Curfman McInnes    Output Parameter:
1250c96a6f78SLois Curfman McInnes .  lits - number of linear iterations
1251c96a6f78SLois Curfman McInnes 
1252c96a6f78SLois Curfman McInnes    Notes:
1253c96a6f78SLois Curfman McInnes    This counter is reset to zero for each successive call to SNESSolve().
1254c96a6f78SLois Curfman McInnes 
125536851e7fSLois Curfman McInnes    Level: intermediate
125636851e7fSLois Curfman McInnes 
1257c96a6f78SLois Curfman McInnes .keywords: SNES, nonlinear, get, number, linear, iterations
12582b668275SBarry Smith 
12598c7482ecSBarry Smith .seealso:  SNESGetIterationNumber(), SNESGetFunctionNorm(), SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures()
1260c96a6f78SLois Curfman McInnes @*/
12617087cfbeSBarry Smith PetscErrorCode  SNESGetLinearSolveIterations(SNES snes,PetscInt* lits)
1262c96a6f78SLois Curfman McInnes {
12633a40ed3dSBarry Smith   PetscFunctionBegin;
12640700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
12654482741eSBarry Smith   PetscValidIntPointer(lits,2);
1266c96a6f78SLois Curfman McInnes   *lits = snes->linear_its;
12673a40ed3dSBarry Smith   PetscFunctionReturn(0);
1268c96a6f78SLois Curfman McInnes }
1269c96a6f78SLois Curfman McInnes 
12704a2ae208SSatish Balay #undef __FUNCT__
127194b7f48cSBarry Smith #define __FUNCT__ "SNESGetKSP"
127252baeb72SSatish Balay /*@
127394b7f48cSBarry Smith    SNESGetKSP - Returns the KSP context for a SNES solver.
12749b94acceSBarry Smith 
127594b7f48cSBarry Smith    Not Collective, but if SNES object is parallel, then KSP object is parallel
1276c7afd0dbSLois Curfman McInnes 
12779b94acceSBarry Smith    Input Parameter:
12789b94acceSBarry Smith .  snes - the SNES context
12799b94acceSBarry Smith 
12809b94acceSBarry Smith    Output Parameter:
128194b7f48cSBarry Smith .  ksp - the KSP context
12829b94acceSBarry Smith 
12839b94acceSBarry Smith    Notes:
128494b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
12859b94acceSBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
12862999313aSBarry Smith    PC contexts as well.
12879b94acceSBarry Smith 
128836851e7fSLois Curfman McInnes    Level: beginner
128936851e7fSLois Curfman McInnes 
129094b7f48cSBarry Smith .keywords: SNES, nonlinear, get, KSP, context
12919b94acceSBarry Smith 
12922999313aSBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP()
12939b94acceSBarry Smith @*/
12947087cfbeSBarry Smith PetscErrorCode  SNESGetKSP(SNES snes,KSP *ksp)
12959b94acceSBarry Smith {
12961cee3971SBarry Smith   PetscErrorCode ierr;
12971cee3971SBarry Smith 
12983a40ed3dSBarry Smith   PetscFunctionBegin;
12990700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
13004482741eSBarry Smith   PetscValidPointer(ksp,2);
13011cee3971SBarry Smith 
13021cee3971SBarry Smith   if (!snes->ksp) {
13031cee3971SBarry Smith     ierr = KSPCreate(((PetscObject)snes)->comm,&snes->ksp);CHKERRQ(ierr);
13041cee3971SBarry Smith     ierr = PetscObjectIncrementTabLevel((PetscObject)snes->ksp,(PetscObject)snes,1);CHKERRQ(ierr);
13051cee3971SBarry Smith     ierr = PetscLogObjectParent(snes,snes->ksp);CHKERRQ(ierr);
13061cee3971SBarry Smith   }
130794b7f48cSBarry Smith   *ksp = snes->ksp;
13083a40ed3dSBarry Smith   PetscFunctionReturn(0);
13099b94acceSBarry Smith }
131082bf6240SBarry Smith 
13114a2ae208SSatish Balay #undef __FUNCT__
13122999313aSBarry Smith #define __FUNCT__ "SNESSetKSP"
13132999313aSBarry Smith /*@
13142999313aSBarry Smith    SNESSetKSP - Sets a KSP context for the SNES object to use
13152999313aSBarry Smith 
13162999313aSBarry Smith    Not Collective, but the SNES and KSP objects must live on the same MPI_Comm
13172999313aSBarry Smith 
13182999313aSBarry Smith    Input Parameters:
13192999313aSBarry Smith +  snes - the SNES context
13202999313aSBarry Smith -  ksp - the KSP context
13212999313aSBarry Smith 
13222999313aSBarry Smith    Notes:
13232999313aSBarry Smith    The SNES object already has its KSP object, you can obtain with SNESGetKSP()
13242999313aSBarry Smith    so this routine is rarely needed.
13252999313aSBarry Smith 
13262999313aSBarry Smith    The KSP object that is already in the SNES object has its reference count
13272999313aSBarry Smith    decreased by one.
13282999313aSBarry Smith 
13292999313aSBarry Smith    Level: developer
13302999313aSBarry Smith 
13312999313aSBarry Smith .keywords: SNES, nonlinear, get, KSP, context
13322999313aSBarry Smith 
13332999313aSBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP()
13342999313aSBarry Smith @*/
13357087cfbeSBarry Smith PetscErrorCode  SNESSetKSP(SNES snes,KSP ksp)
13362999313aSBarry Smith {
13372999313aSBarry Smith   PetscErrorCode ierr;
13382999313aSBarry Smith 
13392999313aSBarry Smith   PetscFunctionBegin;
13400700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
13410700a824SBarry Smith   PetscValidHeaderSpecific(ksp,KSP_CLASSID,2);
13422999313aSBarry Smith   PetscCheckSameComm(snes,1,ksp,2);
13437dcf0eaaSdalcinl   ierr = PetscObjectReference((PetscObject)ksp);CHKERRQ(ierr);
1344906ed7ccSBarry Smith   if (snes->ksp) {ierr = PetscObjectDereference((PetscObject)snes->ksp);CHKERRQ(ierr);}
13452999313aSBarry Smith   snes->ksp = ksp;
13462999313aSBarry Smith   PetscFunctionReturn(0);
13472999313aSBarry Smith }
13482999313aSBarry Smith 
13497adad957SLisandro Dalcin #if 0
13502999313aSBarry Smith #undef __FUNCT__
13514a2ae208SSatish Balay #define __FUNCT__ "SNESPublish_Petsc"
13526849ba73SBarry Smith static PetscErrorCode SNESPublish_Petsc(PetscObject obj)
1353e24b481bSBarry Smith {
1354e24b481bSBarry Smith   PetscFunctionBegin;
1355e24b481bSBarry Smith   PetscFunctionReturn(0);
1356e24b481bSBarry Smith }
13577adad957SLisandro Dalcin #endif
1358e24b481bSBarry Smith 
13599b94acceSBarry Smith /* -----------------------------------------------------------*/
13604a2ae208SSatish Balay #undef __FUNCT__
13614a2ae208SSatish Balay #define __FUNCT__ "SNESCreate"
136252baeb72SSatish Balay /*@
13639b94acceSBarry Smith    SNESCreate - Creates a nonlinear solver context.
13649b94acceSBarry Smith 
1365c7afd0dbSLois Curfman McInnes    Collective on MPI_Comm
1366c7afd0dbSLois Curfman McInnes 
1367c7afd0dbSLois Curfman McInnes    Input Parameters:
1368906ed7ccSBarry Smith .  comm - MPI communicator
13699b94acceSBarry Smith 
13709b94acceSBarry Smith    Output Parameter:
13719b94acceSBarry Smith .  outsnes - the new SNES context
13729b94acceSBarry Smith 
1373c7afd0dbSLois Curfman McInnes    Options Database Keys:
1374c7afd0dbSLois Curfman McInnes +   -snes_mf - Activates default matrix-free Jacobian-vector products,
1375c7afd0dbSLois Curfman McInnes                and no preconditioning matrix
1376c7afd0dbSLois Curfman McInnes .   -snes_mf_operator - Activates default matrix-free Jacobian-vector
1377c7afd0dbSLois Curfman McInnes                products, and a user-provided preconditioning matrix
1378c7afd0dbSLois Curfman McInnes                as set by SNESSetJacobian()
1379c7afd0dbSLois Curfman McInnes -   -snes_fd - Uses (slow!) finite differences to compute Jacobian
1380c1f60f51SBarry Smith 
138136851e7fSLois Curfman McInnes    Level: beginner
138236851e7fSLois Curfman McInnes 
13839b94acceSBarry Smith .keywords: SNES, nonlinear, create, context
13849b94acceSBarry Smith 
1385a8054027SBarry Smith .seealso: SNESSolve(), SNESDestroy(), SNES, SNESSetLagPreconditioner()
1386a8054027SBarry Smith 
13879b94acceSBarry Smith @*/
13887087cfbeSBarry Smith PetscErrorCode  SNESCreate(MPI_Comm comm,SNES *outsnes)
13899b94acceSBarry Smith {
1390dfbe8321SBarry Smith   PetscErrorCode      ierr;
13919b94acceSBarry Smith   SNES                snes;
1392fa9f3622SBarry Smith   SNESKSPEW           *kctx;
139337fcc0dbSBarry Smith 
13943a40ed3dSBarry Smith   PetscFunctionBegin;
1395ed1caa07SMatthew Knepley   PetscValidPointer(outsnes,2);
13968ba1e511SMatthew Knepley   *outsnes = PETSC_NULL;
13978ba1e511SMatthew Knepley #ifndef PETSC_USE_DYNAMIC_LIBRARIES
13988ba1e511SMatthew Knepley   ierr = SNESInitializePackage(PETSC_NULL);CHKERRQ(ierr);
13998ba1e511SMatthew Knepley #endif
14008ba1e511SMatthew Knepley 
14013194b578SJed Brown   ierr = PetscHeaderCreate(snes,_p_SNES,struct _SNESOps,SNES_CLASSID,0,"SNES","Nonlinear solver","SNES",comm,SNESDestroy,SNESView);CHKERRQ(ierr);
14027adad957SLisandro Dalcin 
140385385478SLisandro Dalcin   snes->ops->converged    = SNESDefaultConverged;
14042c155ee1SBarry Smith   snes->usesksp           = PETSC_TRUE;
140588976e71SPeter Brune   snes->tolerancesset     = PETSC_FALSE;
14069b94acceSBarry Smith   snes->max_its           = 50;
14079750a799SBarry Smith   snes->max_funcs         = 10000;
14089b94acceSBarry Smith   snes->norm              = 0.0;
1409fdacfa88SPeter Brune   snes->normtype          = SNES_NORM_FUNCTION;
1410b4874afaSBarry Smith   snes->rtol              = 1.e-8;
1411b4874afaSBarry Smith   snes->ttol              = 0.0;
141270441072SBarry Smith   snes->abstol            = 1.e-50;
1413c60f73f4SPeter Brune   snes->stol              = 1.e-8;
14144b27c08aSLois Curfman McInnes   snes->deltatol          = 1.e-12;
14159b94acceSBarry Smith   snes->nfuncs            = 0;
141650ffb88aSMatthew Knepley   snes->numFailures       = 0;
141750ffb88aSMatthew Knepley   snes->maxFailures       = 1;
14187a00f4a9SLois Curfman McInnes   snes->linear_its        = 0;
1419e35cf81dSBarry Smith   snes->lagjacobian       = 1;
1420a8054027SBarry Smith   snes->lagpreconditioner = 1;
1421639f9d9dSBarry Smith   snes->numbermonitors    = 0;
14229b94acceSBarry Smith   snes->data              = 0;
14234dc4c822SBarry Smith   snes->setupcalled       = PETSC_FALSE;
1424186905e3SBarry Smith   snes->ksp_ewconv        = PETSC_FALSE;
14256f24a144SLois Curfman McInnes   snes->nwork             = 0;
142658c9b817SLisandro Dalcin   snes->work              = 0;
142758c9b817SLisandro Dalcin   snes->nvwork            = 0;
142858c9b817SLisandro Dalcin   snes->vwork             = 0;
1429758f92a0SBarry Smith   snes->conv_hist_len     = 0;
1430758f92a0SBarry Smith   snes->conv_hist_max     = 0;
1431758f92a0SBarry Smith   snes->conv_hist         = PETSC_NULL;
1432758f92a0SBarry Smith   snes->conv_hist_its     = PETSC_NULL;
1433758f92a0SBarry Smith   snes->conv_hist_reset   = PETSC_TRUE;
1434e4ed7901SPeter Brune   snes->vec_func_init_set = PETSC_FALSE;
1435e4ed7901SPeter Brune   snes->norm_init         = 0.;
1436e4ed7901SPeter Brune   snes->norm_init_set     = PETSC_FALSE;
1437184914b5SBarry Smith   snes->reason            = SNES_CONVERGED_ITERATING;
143889b92e6fSPeter Brune   snes->gssweeps          = 1;
14399b94acceSBarry Smith 
1440c40d0f55SPeter Brune   snes->pcside            = PC_RIGHT;
1441c40d0f55SPeter Brune 
1442d8f46077SPeter Brune   snes->mf                = PETSC_FALSE;
1443d8f46077SPeter Brune   snes->mf_operator       = PETSC_FALSE;
1444d8f46077SPeter Brune   snes->mf_version        = 1;
1445d8f46077SPeter Brune 
14463d4c4710SBarry Smith   snes->numLinearSolveFailures = 0;
14473d4c4710SBarry Smith   snes->maxLinearSolveFailures = 1;
14483d4c4710SBarry Smith 
14499b94acceSBarry Smith   /* Create context to compute Eisenstat-Walker relative tolerance for KSP */
145038f2d2fdSLisandro Dalcin   ierr = PetscNewLog(snes,SNESKSPEW,&kctx);CHKERRQ(ierr);
14519b94acceSBarry Smith   snes->kspconvctx  = (void*)kctx;
14529b94acceSBarry Smith   kctx->version     = 2;
14539b94acceSBarry Smith   kctx->rtol_0      = .3; /* Eisenstat and Walker suggest rtol_0=.5, but
14549b94acceSBarry Smith                              this was too large for some test cases */
145575567043SBarry Smith   kctx->rtol_last   = 0.0;
14569b94acceSBarry Smith   kctx->rtol_max    = .9;
14579b94acceSBarry Smith   kctx->gamma       = 1.0;
145862d1f40fSBarry Smith   kctx->alpha       = .5*(1.0 + PetscSqrtReal(5.0));
145971f87433Sdalcinl   kctx->alpha2      = kctx->alpha;
14609b94acceSBarry Smith   kctx->threshold   = .1;
146175567043SBarry Smith   kctx->lresid_last = 0.0;
146275567043SBarry Smith   kctx->norm_last   = 0.0;
14639b94acceSBarry Smith 
14649b94acceSBarry Smith   *outsnes = snes;
14653a40ed3dSBarry Smith   PetscFunctionReturn(0);
14669b94acceSBarry Smith }
14679b94acceSBarry Smith 
14684a2ae208SSatish Balay #undef __FUNCT__
14694a2ae208SSatish Balay #define __FUNCT__ "SNESSetFunction"
14709b94acceSBarry Smith /*@C
14719b94acceSBarry Smith    SNESSetFunction - Sets the function evaluation routine and function
14729b94acceSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
14739b94acceSBarry Smith    equations.
14749b94acceSBarry Smith 
14753f9fe445SBarry Smith    Logically Collective on SNES
1476fee21e36SBarry Smith 
1477c7afd0dbSLois Curfman McInnes    Input Parameters:
1478c7afd0dbSLois Curfman McInnes +  snes - the SNES context
1479c7afd0dbSLois Curfman McInnes .  r - vector to store function value
1480de044059SHong Zhang .  func - function evaluation routine
1481c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined context for private data for the
1482c7afd0dbSLois Curfman McInnes          function evaluation routine (may be PETSC_NULL)
14839b94acceSBarry Smith 
1484c7afd0dbSLois Curfman McInnes    Calling sequence of func:
14858d76a1e5SLois Curfman McInnes $    func (SNES snes,Vec x,Vec f,void *ctx);
1486c7afd0dbSLois Curfman McInnes 
1487c586c404SJed Brown +  snes - the SNES context
1488c586c404SJed Brown .  x - state at which to evaluate residual
1489c586c404SJed Brown .  f - vector to put residual
1490c7afd0dbSLois Curfman McInnes -  ctx - optional user-defined function context
14919b94acceSBarry Smith 
14929b94acceSBarry Smith    Notes:
14939b94acceSBarry Smith    The Newton-like methods typically solve linear systems of the form
14949b94acceSBarry Smith $      f'(x) x = -f(x),
1495c7afd0dbSLois Curfman McInnes    where f'(x) denotes the Jacobian matrix and f(x) is the function.
14969b94acceSBarry Smith 
149736851e7fSLois Curfman McInnes    Level: beginner
149836851e7fSLois Curfman McInnes 
14999b94acceSBarry Smith .keywords: SNES, nonlinear, set, function
15009b94acceSBarry Smith 
15018b0a5094SBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetPicard()
15029b94acceSBarry Smith @*/
15037087cfbeSBarry Smith PetscErrorCode  SNESSetFunction(SNES snes,Vec r,PetscErrorCode (*func)(SNES,Vec,Vec,void*),void *ctx)
15049b94acceSBarry Smith {
150585385478SLisandro Dalcin   PetscErrorCode ierr;
15066cab3a1bSJed Brown   DM             dm;
15076cab3a1bSJed Brown 
15083a40ed3dSBarry Smith   PetscFunctionBegin;
15090700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1510d2a683ecSLisandro Dalcin   if (r) {
1511d2a683ecSLisandro Dalcin     PetscValidHeaderSpecific(r,VEC_CLASSID,2);
1512d2a683ecSLisandro Dalcin     PetscCheckSameComm(snes,1,r,2);
151385385478SLisandro Dalcin     ierr = PetscObjectReference((PetscObject)r);CHKERRQ(ierr);
15146bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr);
151585385478SLisandro Dalcin     snes->vec_func = r;
1516d2a683ecSLisandro Dalcin   }
15176cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
15186cab3a1bSJed Brown   ierr = DMSNESSetFunction(dm,func,ctx);CHKERRQ(ierr);
15193a40ed3dSBarry Smith   PetscFunctionReturn(0);
15209b94acceSBarry Smith }
15219b94acceSBarry Smith 
1522646217ecSPeter Brune 
1523646217ecSPeter Brune #undef __FUNCT__
1524e4ed7901SPeter Brune #define __FUNCT__ "SNESSetInitialFunction"
1525e4ed7901SPeter Brune /*@C
1526e4ed7901SPeter Brune    SNESSetInitialFunction - Sets the function vector to be used as the
1527e4ed7901SPeter Brune    function norm at the initialization of the method.  In some
1528e4ed7901SPeter Brune    instances, the user has precomputed the function before calling
1529e4ed7901SPeter Brune    SNESSolve.  This function allows one to avoid a redundant call
1530e4ed7901SPeter Brune    to SNESComputeFunction in that case.
1531e4ed7901SPeter Brune 
1532e4ed7901SPeter Brune    Logically Collective on SNES
1533e4ed7901SPeter Brune 
1534e4ed7901SPeter Brune    Input Parameters:
1535e4ed7901SPeter Brune +  snes - the SNES context
1536e4ed7901SPeter Brune -  f - vector to store function value
1537e4ed7901SPeter Brune 
1538e4ed7901SPeter Brune    Notes:
1539e4ed7901SPeter Brune    This should not be modified during the solution procedure.
1540e4ed7901SPeter Brune 
1541e4ed7901SPeter Brune    This is used extensively in the SNESFAS hierarchy and in nonlinear preconditioning.
1542e4ed7901SPeter Brune 
1543e4ed7901SPeter Brune    Level: developer
1544e4ed7901SPeter Brune 
1545e4ed7901SPeter Brune .keywords: SNES, nonlinear, set, function
1546e4ed7901SPeter Brune 
1547e4ed7901SPeter Brune .seealso: SNESSetFunction(), SNESComputeFunction(), SNESSetInitialFunctionNorm()
1548e4ed7901SPeter Brune @*/
1549e4ed7901SPeter Brune PetscErrorCode  SNESSetInitialFunction(SNES snes, Vec f)
1550e4ed7901SPeter Brune {
1551e4ed7901SPeter Brune   PetscErrorCode ierr;
1552e4ed7901SPeter Brune   Vec            vec_func;
1553e4ed7901SPeter Brune 
1554e4ed7901SPeter Brune   PetscFunctionBegin;
1555e4ed7901SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1556e4ed7901SPeter Brune   PetscValidHeaderSpecific(f,VEC_CLASSID,2);
1557e4ed7901SPeter Brune   PetscCheckSameComm(snes,1,f,2);
1558e4ed7901SPeter Brune   ierr = SNESGetFunction(snes,&vec_func,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
1559e4ed7901SPeter Brune   ierr = VecCopy(f, vec_func);CHKERRQ(ierr);
1560217b9c2eSPeter Brune   snes->vec_func_init_set = PETSC_TRUE;
1561e4ed7901SPeter Brune   PetscFunctionReturn(0);
1562e4ed7901SPeter Brune }
1563e4ed7901SPeter Brune 
1564e4ed7901SPeter Brune 
1565e4ed7901SPeter Brune #undef __FUNCT__
1566e4ed7901SPeter Brune #define __FUNCT__ "SNESSetInitialFunctionNorm"
1567e4ed7901SPeter Brune /*@C
1568e4ed7901SPeter Brune    SNESSetInitialFunctionNorm - Sets the function norm to be used as the function norm
1569e4ed7901SPeter Brune    at the initialization of the  method.  In some instances, the user has precomputed
1570e4ed7901SPeter Brune    the function and its norm before calling SNESSolve.  This function allows one to
1571e4ed7901SPeter Brune    avoid a redundant call to SNESComputeFunction() and VecNorm() in that case.
1572e4ed7901SPeter Brune 
1573e4ed7901SPeter Brune    Logically Collective on SNES
1574e4ed7901SPeter Brune 
1575e4ed7901SPeter Brune    Input Parameters:
1576e4ed7901SPeter Brune +  snes - the SNES context
1577e4ed7901SPeter Brune -  fnorm - the norm of F as set by SNESSetInitialFunction()
1578e4ed7901SPeter Brune 
1579e4ed7901SPeter Brune    This is used extensively in the SNESFAS hierarchy and in nonlinear preconditioning.
1580e4ed7901SPeter Brune 
1581e4ed7901SPeter Brune    Level: developer
1582e4ed7901SPeter Brune 
1583e4ed7901SPeter Brune .keywords: SNES, nonlinear, set, function, norm
1584e4ed7901SPeter Brune 
1585e4ed7901SPeter Brune .seealso: SNESSetFunction(), SNESComputeFunction(), SNESSetInitialFunction()
1586e4ed7901SPeter Brune @*/
1587e4ed7901SPeter Brune PetscErrorCode  SNESSetInitialFunctionNorm(SNES snes, PetscReal fnorm)
1588e4ed7901SPeter Brune {
1589e4ed7901SPeter Brune   PetscFunctionBegin;
1590e4ed7901SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1591e4ed7901SPeter Brune   snes->norm_init = fnorm;
1592e4ed7901SPeter Brune   snes->norm_init_set = PETSC_TRUE;
1593e4ed7901SPeter Brune   PetscFunctionReturn(0);
1594e4ed7901SPeter Brune }
1595e4ed7901SPeter Brune 
1596e4ed7901SPeter Brune #undef __FUNCT__
1597534ebe21SPeter Brune #define __FUNCT__ "SNESSetNormType"
1598534ebe21SPeter Brune /*@
1599534ebe21SPeter Brune    SNESSetNormType - Sets the SNESNormType used in covergence and monitoring
1600534ebe21SPeter Brune    of the SNES method.
1601534ebe21SPeter Brune 
1602534ebe21SPeter Brune    Logically Collective on SNES
1603534ebe21SPeter Brune 
1604534ebe21SPeter Brune    Input Parameters:
1605534ebe21SPeter Brune +  snes - the SNES context
1606534ebe21SPeter Brune -  normtype - the type of the norm used
1607534ebe21SPeter Brune 
1608534ebe21SPeter Brune    Notes:
1609534ebe21SPeter Brune    Only certain SNES methods support certain SNESNormTypes.  Most require evaluation
1610534ebe21SPeter Brune    of the nonlinear function and the taking of its norm at every iteration to
1611534ebe21SPeter Brune    even ensure convergence at all.  However, methods such as custom Gauss-Seidel methods
1612534ebe21SPeter Brune    (SNESGS) and the like do not require the norm of the function to be computed, and therfore
1613534ebe21SPeter Brune    may either be monitored for convergence or not.  As these are often used as nonlinear
1614534ebe21SPeter Brune    preconditioners, monitoring the norm of their error is not a useful enterprise within
1615534ebe21SPeter Brune    their solution.
1616534ebe21SPeter Brune 
1617534ebe21SPeter Brune    Level: developer
1618534ebe21SPeter Brune 
1619534ebe21SPeter Brune .keywords: SNES, nonlinear, set, function, norm, type
1620534ebe21SPeter Brune 
1621534ebe21SPeter Brune .seealso: SNESGetNormType(), SNESComputeFunction(), VecNorm(), SNESSetFunction(), SNESSetInitialFunction(), SNESNormType
1622534ebe21SPeter Brune @*/
1623534ebe21SPeter Brune PetscErrorCode  SNESSetNormType(SNES snes, SNESNormType normtype)
1624534ebe21SPeter Brune {
1625534ebe21SPeter Brune   PetscFunctionBegin;
1626534ebe21SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1627534ebe21SPeter Brune   snes->normtype = normtype;
1628534ebe21SPeter Brune   PetscFunctionReturn(0);
1629534ebe21SPeter Brune }
1630534ebe21SPeter Brune 
1631534ebe21SPeter Brune 
1632534ebe21SPeter Brune #undef __FUNCT__
1633534ebe21SPeter Brune #define __FUNCT__ "SNESGetNormType"
1634534ebe21SPeter Brune /*@
1635534ebe21SPeter Brune    SNESGetNormType - Gets 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    Level: advanced
1645534ebe21SPeter Brune 
1646534ebe21SPeter Brune .keywords: SNES, nonlinear, set, function, norm, type
1647534ebe21SPeter Brune 
1648534ebe21SPeter Brune .seealso: SNESSetNormType(), SNESComputeFunction(), VecNorm(), SNESSetFunction(), SNESSetInitialFunction(), SNESNormType
1649534ebe21SPeter Brune @*/
1650534ebe21SPeter Brune PetscErrorCode  SNESGetNormType(SNES snes, SNESNormType *normtype)
1651534ebe21SPeter Brune {
1652534ebe21SPeter Brune   PetscFunctionBegin;
1653534ebe21SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1654534ebe21SPeter Brune   *normtype = snes->normtype;
1655534ebe21SPeter Brune   PetscFunctionReturn(0);
1656534ebe21SPeter Brune }
1657534ebe21SPeter Brune 
1658534ebe21SPeter Brune #undef __FUNCT__
1659646217ecSPeter Brune #define __FUNCT__ "SNESSetGS"
1660c79ef259SPeter Brune /*@C
1661c79ef259SPeter Brune    SNESSetGS - Sets the user nonlinear Gauss-Seidel routine for
1662c79ef259SPeter Brune    use with composed nonlinear solvers.
1663c79ef259SPeter Brune 
1664c79ef259SPeter Brune    Input Parameters:
1665c79ef259SPeter Brune +  snes   - the SNES context
1666c79ef259SPeter Brune .  gsfunc - function evaluation routine
1667c79ef259SPeter Brune -  ctx    - [optional] user-defined context for private data for the
1668c79ef259SPeter Brune             smoother evaluation routine (may be PETSC_NULL)
1669c79ef259SPeter Brune 
1670c79ef259SPeter Brune    Calling sequence of func:
1671c79ef259SPeter Brune $    func (SNES snes,Vec x,Vec b,void *ctx);
1672c79ef259SPeter Brune 
1673c79ef259SPeter Brune +  X   - solution vector
1674c79ef259SPeter Brune .  B   - RHS vector
1675d28543b3SPeter Brune -  ctx - optional user-defined Gauss-Seidel context
1676c79ef259SPeter Brune 
1677c79ef259SPeter Brune    Notes:
1678c79ef259SPeter Brune    The GS routines are used by the composed nonlinear solver to generate
1679c79ef259SPeter Brune     a problem appropriate update to the solution, particularly FAS.
1680c79ef259SPeter Brune 
1681d28543b3SPeter Brune    Level: intermediate
1682c79ef259SPeter Brune 
1683d28543b3SPeter Brune .keywords: SNES, nonlinear, set, Gauss-Seidel
1684c79ef259SPeter Brune 
1685c79ef259SPeter Brune .seealso: SNESGetFunction(), SNESComputeGS()
1686c79ef259SPeter Brune @*/
16876cab3a1bSJed Brown PetscErrorCode SNESSetGS(SNES snes,PetscErrorCode (*gsfunc)(SNES,Vec,Vec,void*),void *ctx)
16886cab3a1bSJed Brown {
16896cab3a1bSJed Brown   PetscErrorCode ierr;
16906cab3a1bSJed Brown   DM             dm;
16916cab3a1bSJed Brown 
1692646217ecSPeter Brune   PetscFunctionBegin;
16936cab3a1bSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
16946cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
16956cab3a1bSJed Brown   ierr = DMSNESSetGS(dm,gsfunc,ctx);CHKERRQ(ierr);
1696646217ecSPeter Brune   PetscFunctionReturn(0);
1697646217ecSPeter Brune }
1698646217ecSPeter Brune 
1699d25893d9SBarry Smith #undef __FUNCT__
170089b92e6fSPeter Brune #define __FUNCT__ "SNESSetGSSweeps"
170189b92e6fSPeter Brune /*@
170289b92e6fSPeter Brune    SNESSetGSSweeps - Sets the number of sweeps of GS to use.
170389b92e6fSPeter Brune 
170489b92e6fSPeter Brune    Input Parameters:
170589b92e6fSPeter Brune +  snes   - the SNES context
170689b92e6fSPeter Brune -  sweeps  - the number of sweeps of GS to perform.
170789b92e6fSPeter Brune 
170889b92e6fSPeter Brune    Level: intermediate
170989b92e6fSPeter Brune 
171089b92e6fSPeter Brune .keywords: SNES, nonlinear, set, Gauss-Siedel
171189b92e6fSPeter Brune 
171289b92e6fSPeter Brune .seealso: SNESSetGS(), SNESGetGS(), SNESSetPC(), SNESGetGSSweeps()
171389b92e6fSPeter Brune @*/
171489b92e6fSPeter Brune 
1715c35f09e5SBarry Smith PetscErrorCode SNESSetGSSweeps(SNES snes, PetscInt sweeps)
1716c35f09e5SBarry Smith {
171789b92e6fSPeter Brune   PetscFunctionBegin;
171889b92e6fSPeter Brune   snes->gssweeps = sweeps;
171989b92e6fSPeter Brune   PetscFunctionReturn(0);
172089b92e6fSPeter Brune }
172189b92e6fSPeter Brune 
172289b92e6fSPeter Brune 
172389b92e6fSPeter Brune #undef __FUNCT__
172489b92e6fSPeter Brune #define __FUNCT__ "SNESGetGSSweeps"
172589b92e6fSPeter Brune /*@
172689b92e6fSPeter Brune    SNESGetGSSweeps - Gets the number of sweeps GS will use.
172789b92e6fSPeter Brune 
172889b92e6fSPeter Brune    Input Parameters:
172989b92e6fSPeter Brune .  snes   - the SNES context
173089b92e6fSPeter Brune 
173189b92e6fSPeter Brune    Output Parameters:
173289b92e6fSPeter Brune .  sweeps  - the number of sweeps of GS to perform.
173389b92e6fSPeter Brune 
173489b92e6fSPeter Brune    Level: intermediate
173589b92e6fSPeter Brune 
173689b92e6fSPeter Brune .keywords: SNES, nonlinear, set, Gauss-Siedel
173789b92e6fSPeter Brune 
173889b92e6fSPeter Brune .seealso: SNESSetGS(), SNESGetGS(), SNESSetPC(), SNESSetGSSweeps()
173989b92e6fSPeter Brune @*/
1740c35f09e5SBarry Smith PetscErrorCode SNESGetGSSweeps(SNES snes, PetscInt * sweeps)
1741c35f09e5SBarry Smith {
174289b92e6fSPeter Brune   PetscFunctionBegin;
174389b92e6fSPeter Brune   *sweeps = snes->gssweeps;
174489b92e6fSPeter Brune   PetscFunctionReturn(0);
174589b92e6fSPeter Brune }
174689b92e6fSPeter Brune 
174789b92e6fSPeter Brune #undef __FUNCT__
17488b0a5094SBarry Smith #define __FUNCT__ "SNESPicardComputeFunction"
17498b0a5094SBarry Smith PetscErrorCode  SNESPicardComputeFunction(SNES snes,Vec x,Vec f,void *ctx)
17508b0a5094SBarry Smith {
17518b0a5094SBarry Smith   PetscErrorCode ierr;
1752e03ab78fSPeter Brune   DM             dm;
1753e03ab78fSPeter Brune   SNESDM         sdm;
17546cab3a1bSJed Brown 
17558b0a5094SBarry Smith   PetscFunctionBegin;
1756e03ab78fSPeter Brune   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
1757e03ab78fSPeter Brune   ierr = DMSNESGetContext(dm,&sdm);CHKERRQ(ierr);
17588b0a5094SBarry Smith   /*  A(x)*x - b(x) */
1759e03ab78fSPeter Brune   if (sdm->computepfunction) {
1760e03ab78fSPeter Brune     ierr = (*sdm->computepfunction)(snes,x,f,sdm->pctx);CHKERRQ(ierr);
1761e03ab78fSPeter Brune   } else if (snes->dm) {
1762e03ab78fSPeter Brune     ierr = DMComputeFunction(snes->dm,x,f);CHKERRQ(ierr);
1763e03ab78fSPeter Brune   } else {
1764e03ab78fSPeter Brune     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetPicard() or SNESSetDM() before SNESPicardComputeFunction to provide Picard function.");
1765e03ab78fSPeter Brune   }
1766e03ab78fSPeter Brune 
1767e03ab78fSPeter Brune   if (sdm->computepjacobian) {
1768e03ab78fSPeter Brune     ierr = (*sdm->computepjacobian)(snes,x,&snes->jacobian,&snes->jacobian_pre,&snes->matstruct,sdm->pctx);CHKERRQ(ierr);
1769e03ab78fSPeter Brune   } else if (snes->dm) {
1770e03ab78fSPeter Brune     ierr = DMComputeJacobian(snes->dm,x,snes->jacobian,snes->jacobian_pre,&snes->matstruct);CHKERRQ(ierr);
1771e03ab78fSPeter Brune   } else {
1772e03ab78fSPeter Brune     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetPicard() or SNESSetDM() before SNESPicardComputeFunction to provide Picard matrix.");
1773e03ab78fSPeter Brune   }
1774e03ab78fSPeter Brune 
17758b0a5094SBarry Smith   ierr = VecView(x,PETSC_VIEWER_BINARY_WORLD);CHKERRQ(ierr);
17768b0a5094SBarry Smith   ierr = VecView(f,PETSC_VIEWER_BINARY_WORLD);CHKERRQ(ierr);
17778b0a5094SBarry Smith   ierr = VecScale(f,-1.0);CHKERRQ(ierr);
17788b0a5094SBarry Smith   ierr = MatMultAdd(snes->jacobian_pre,x,f,f);CHKERRQ(ierr);
17798b0a5094SBarry Smith   PetscFunctionReturn(0);
17808b0a5094SBarry Smith }
17818b0a5094SBarry Smith 
17828b0a5094SBarry Smith #undef __FUNCT__
17838b0a5094SBarry Smith #define __FUNCT__ "SNESPicardComputeJacobian"
17848b0a5094SBarry Smith PetscErrorCode  SNESPicardComputeJacobian(SNES snes,Vec x1,Mat *J,Mat *B,MatStructure *flag,void *ctx)
17858b0a5094SBarry Smith {
17868b0a5094SBarry Smith   PetscFunctionBegin;
1787e03ab78fSPeter Brune   /* the jacobian matrix should be pre-filled in SNESPicardComputeFunction */
17888b0a5094SBarry Smith   *flag = snes->matstruct;
17898b0a5094SBarry Smith   PetscFunctionReturn(0);
17908b0a5094SBarry Smith }
17918b0a5094SBarry Smith 
17928b0a5094SBarry Smith #undef __FUNCT__
17938b0a5094SBarry Smith #define __FUNCT__ "SNESSetPicard"
17948b0a5094SBarry Smith /*@C
17950d04baf8SBarry Smith    SNESSetPicard - Use SNES to solve the semilinear-system A(x) x = b(x) via a Picard type iteration (Picard linearization)
17968b0a5094SBarry Smith 
17978b0a5094SBarry Smith    Logically Collective on SNES
17988b0a5094SBarry Smith 
17998b0a5094SBarry Smith    Input Parameters:
18008b0a5094SBarry Smith +  snes - the SNES context
18018b0a5094SBarry Smith .  r - vector to store function value
18028b0a5094SBarry Smith .  func - function evaluation routine
18038b0a5094SBarry Smith .  jmat - normally the same as mat but you can pass another matrix for which you compute the Jacobian of A(x) x - b(x) (see jmat below)
18048b0a5094SBarry Smith .  mat - matrix to store A
18058b0a5094SBarry Smith .  mfunc  - function to compute matrix value
18068b0a5094SBarry Smith -  ctx - [optional] user-defined context for private data for the
18078b0a5094SBarry Smith          function evaluation routine (may be PETSC_NULL)
18088b0a5094SBarry Smith 
18098b0a5094SBarry Smith    Calling sequence of func:
18108b0a5094SBarry Smith $    func (SNES snes,Vec x,Vec f,void *ctx);
18118b0a5094SBarry Smith 
18128b0a5094SBarry Smith +  f - function vector
18138b0a5094SBarry Smith -  ctx - optional user-defined function context
18148b0a5094SBarry Smith 
18158b0a5094SBarry Smith    Calling sequence of mfunc:
18168b0a5094SBarry Smith $     mfunc (SNES snes,Vec x,Mat *jmat,Mat *mat,int *flag,void *ctx);
18178b0a5094SBarry Smith 
18188b0a5094SBarry Smith +  x - input vector
18198b0a5094SBarry Smith .  jmat - Form Jacobian 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(),
18208b0a5094SBarry Smith           normally just pass mat in this location
18218b0a5094SBarry Smith .  mat - form A(x) matrix
18228b0a5094SBarry Smith .  flag - flag indicating information about the preconditioner matrix
18238b0a5094SBarry Smith    structure (same as flag in KSPSetOperators()), one of SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER
18248b0a5094SBarry Smith -  ctx - [optional] user-defined Jacobian context
18258b0a5094SBarry Smith 
18268b0a5094SBarry Smith    Notes:
18278b0a5094SBarry Smith     One can call SNESSetPicard() or SNESSetFunction() (and possibly SNESSetJacobian()) but cannot call both
18288b0a5094SBarry Smith 
18298b0a5094SBarry 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}
18308b0a5094SBarry 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.
18318b0a5094SBarry Smith 
18328b0a5094SBarry Smith      Run with -snes_mf_operator to solve the system with Newton's method using A(x^{n}) to construct the preconditioner.
18338b0a5094SBarry Smith 
18340d04baf8SBarry Smith    We implement the defect correction form of the Picard iteration because it converges much more generally when inexact linear solvers are used then
18350d04baf8SBarry Smith    the direct Picard iteration A(x^n) x^{n+1} = b(x^n)
18368b0a5094SBarry Smith 
18378b0a5094SBarry 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
18388b0a5094SBarry 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
18398b0a5094SBarry Smith    different please contact us at petsc-dev@mcs.anl.gov and we'll have an entirely new argument :-).
18408b0a5094SBarry Smith 
18418b0a5094SBarry Smith    Level: beginner
18428b0a5094SBarry Smith 
18438b0a5094SBarry Smith .keywords: SNES, nonlinear, set, function
18448b0a5094SBarry Smith 
18450d04baf8SBarry Smith .seealso: SNESGetFunction(), SNESSetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESGetPicard(), SNESLineSearchPreCheckPicard()
18468b0a5094SBarry Smith @*/
18478b0a5094SBarry 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)
18488b0a5094SBarry Smith {
18498b0a5094SBarry Smith   PetscErrorCode ierr;
1850e03ab78fSPeter Brune   DM             dm;
1851e03ab78fSPeter Brune 
18528b0a5094SBarry Smith   PetscFunctionBegin;
18538b0a5094SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1854e03ab78fSPeter Brune   ierr = SNESGetDM(snes, &dm);CHKERRQ(ierr);
1855e03ab78fSPeter Brune   ierr = DMSNESSetPicard(dm,func,mfunc,ctx);CHKERRQ(ierr);
18568b0a5094SBarry Smith   ierr = SNESSetFunction(snes,r,SNESPicardComputeFunction,ctx);CHKERRQ(ierr);
18578b0a5094SBarry Smith   ierr = SNESSetJacobian(snes,jmat,mat,SNESPicardComputeJacobian,ctx);CHKERRQ(ierr);
18588b0a5094SBarry Smith   PetscFunctionReturn(0);
18598b0a5094SBarry Smith }
18608b0a5094SBarry Smith 
18617971a8bfSPeter Brune 
18627971a8bfSPeter Brune #undef __FUNCT__
18637971a8bfSPeter Brune #define __FUNCT__ "SNESGetPicard"
18647971a8bfSPeter Brune /*@C
18657971a8bfSPeter Brune    SNESGetPicard - Returns the context for the Picard iteration
18667971a8bfSPeter Brune 
18677971a8bfSPeter Brune    Not Collective, but Vec is parallel if SNES is parallel. Collective if Vec is requested, but has not been created yet.
18687971a8bfSPeter Brune 
18697971a8bfSPeter Brune    Input Parameter:
18707971a8bfSPeter Brune .  snes - the SNES context
18717971a8bfSPeter Brune 
18727971a8bfSPeter Brune    Output Parameter:
18737971a8bfSPeter Brune +  r - the function (or PETSC_NULL)
18747971a8bfSPeter Brune .  func - the function (or PETSC_NULL)
18757971a8bfSPeter Brune .  jmat - the picard matrix (or PETSC_NULL)
18767971a8bfSPeter Brune .  mat  - the picard preconditioner matrix (or PETSC_NULL)
18777971a8bfSPeter Brune .  mfunc - the function for matrix evaluation (or PETSC_NULL)
18787971a8bfSPeter Brune -  ctx - the function context (or PETSC_NULL)
18797971a8bfSPeter Brune 
18807971a8bfSPeter Brune    Level: advanced
18817971a8bfSPeter Brune 
18827971a8bfSPeter Brune .keywords: SNES, nonlinear, get, function
18837971a8bfSPeter Brune 
18847971a8bfSPeter Brune .seealso: SNESSetPicard, SNESGetFunction, SNESGetJacobian, SNESGetDM
18857971a8bfSPeter Brune @*/
18867971a8bfSPeter 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)
18877971a8bfSPeter Brune {
18887971a8bfSPeter Brune   PetscErrorCode ierr;
18897971a8bfSPeter Brune   DM             dm;
18907971a8bfSPeter Brune 
18917971a8bfSPeter Brune   PetscFunctionBegin;
18927971a8bfSPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
18937971a8bfSPeter Brune   ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
18947971a8bfSPeter Brune   ierr = SNESGetJacobian(snes,jmat,mat,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
18957971a8bfSPeter Brune   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
18967971a8bfSPeter Brune   ierr = DMSNESGetPicard(dm,func,mfunc,ctx);CHKERRQ(ierr);
18977971a8bfSPeter Brune   PetscFunctionReturn(0);
18987971a8bfSPeter Brune }
18997971a8bfSPeter Brune 
19008b0a5094SBarry Smith #undef __FUNCT__
1901d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeInitialGuess"
1902d25893d9SBarry Smith /*@C
1903d25893d9SBarry Smith    SNESSetComputeInitialGuess - Sets a routine used to compute an initial guess for the problem
1904d25893d9SBarry Smith 
1905d25893d9SBarry Smith    Logically Collective on SNES
1906d25893d9SBarry Smith 
1907d25893d9SBarry Smith    Input Parameters:
1908d25893d9SBarry Smith +  snes - the SNES context
1909d25893d9SBarry Smith .  func - function evaluation routine
1910d25893d9SBarry Smith -  ctx - [optional] user-defined context for private data for the
1911d25893d9SBarry Smith          function evaluation routine (may be PETSC_NULL)
1912d25893d9SBarry Smith 
1913d25893d9SBarry Smith    Calling sequence of func:
1914d25893d9SBarry Smith $    func (SNES snes,Vec x,void *ctx);
1915d25893d9SBarry Smith 
1916d25893d9SBarry Smith .  f - function vector
1917d25893d9SBarry Smith -  ctx - optional user-defined function context
1918d25893d9SBarry Smith 
1919d25893d9SBarry Smith    Level: intermediate
1920d25893d9SBarry Smith 
1921d25893d9SBarry Smith .keywords: SNES, nonlinear, set, function
1922d25893d9SBarry Smith 
1923d25893d9SBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian()
1924d25893d9SBarry Smith @*/
1925d25893d9SBarry Smith PetscErrorCode  SNESSetComputeInitialGuess(SNES snes,PetscErrorCode (*func)(SNES,Vec,void*),void *ctx)
1926d25893d9SBarry Smith {
1927d25893d9SBarry Smith   PetscFunctionBegin;
1928d25893d9SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1929d25893d9SBarry Smith   if (func) snes->ops->computeinitialguess = func;
1930d25893d9SBarry Smith   if (ctx)  snes->initialguessP            = ctx;
1931d25893d9SBarry Smith   PetscFunctionReturn(0);
1932d25893d9SBarry Smith }
1933d25893d9SBarry Smith 
19343ab0aad5SBarry Smith /* --------------------------------------------------------------- */
19353ab0aad5SBarry Smith #undef __FUNCT__
19361096aae1SMatthew Knepley #define __FUNCT__ "SNESGetRhs"
19371096aae1SMatthew Knepley /*@C
19381096aae1SMatthew Knepley    SNESGetRhs - Gets the vector for solving F(x) = rhs. If rhs is not set
19391096aae1SMatthew Knepley    it assumes a zero right hand side.
19401096aae1SMatthew Knepley 
19413f9fe445SBarry Smith    Logically Collective on SNES
19421096aae1SMatthew Knepley 
19431096aae1SMatthew Knepley    Input Parameter:
19441096aae1SMatthew Knepley .  snes - the SNES context
19451096aae1SMatthew Knepley 
19461096aae1SMatthew Knepley    Output Parameter:
1947bc08b0f1SBarry Smith .  rhs - the right hand side vector or PETSC_NULL if the right hand side vector is null
19481096aae1SMatthew Knepley 
19491096aae1SMatthew Knepley    Level: intermediate
19501096aae1SMatthew Knepley 
19511096aae1SMatthew Knepley .keywords: SNES, nonlinear, get, function, right hand side
19521096aae1SMatthew Knepley 
195385385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
19541096aae1SMatthew Knepley @*/
19557087cfbeSBarry Smith PetscErrorCode  SNESGetRhs(SNES snes,Vec *rhs)
19561096aae1SMatthew Knepley {
19571096aae1SMatthew Knepley   PetscFunctionBegin;
19580700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
19591096aae1SMatthew Knepley   PetscValidPointer(rhs,2);
196085385478SLisandro Dalcin   *rhs = snes->vec_rhs;
19611096aae1SMatthew Knepley   PetscFunctionReturn(0);
19621096aae1SMatthew Knepley }
19631096aae1SMatthew Knepley 
19641096aae1SMatthew Knepley #undef __FUNCT__
19654a2ae208SSatish Balay #define __FUNCT__ "SNESComputeFunction"
19669b94acceSBarry Smith /*@
196736851e7fSLois Curfman McInnes    SNESComputeFunction - Calls the function that has been set with
19689b94acceSBarry Smith                          SNESSetFunction().
19699b94acceSBarry Smith 
1970c7afd0dbSLois Curfman McInnes    Collective on SNES
1971c7afd0dbSLois Curfman McInnes 
19729b94acceSBarry Smith    Input Parameters:
1973c7afd0dbSLois Curfman McInnes +  snes - the SNES context
1974c7afd0dbSLois Curfman McInnes -  x - input vector
19759b94acceSBarry Smith 
19769b94acceSBarry Smith    Output Parameter:
19773638b69dSLois Curfman McInnes .  y - function vector, as set by SNESSetFunction()
19789b94acceSBarry Smith 
19791bffabb2SLois Curfman McInnes    Notes:
198036851e7fSLois Curfman McInnes    SNESComputeFunction() is typically used within nonlinear solvers
198136851e7fSLois Curfman McInnes    implementations, so most users would not generally call this routine
198236851e7fSLois Curfman McInnes    themselves.
198336851e7fSLois Curfman McInnes 
198436851e7fSLois Curfman McInnes    Level: developer
198536851e7fSLois Curfman McInnes 
19869b94acceSBarry Smith .keywords: SNES, nonlinear, compute, function
19879b94acceSBarry Smith 
1988a86d99e1SLois Curfman McInnes .seealso: SNESSetFunction(), SNESGetFunction()
19899b94acceSBarry Smith @*/
19907087cfbeSBarry Smith PetscErrorCode  SNESComputeFunction(SNES snes,Vec x,Vec y)
19919b94acceSBarry Smith {
1992dfbe8321SBarry Smith   PetscErrorCode ierr;
19936cab3a1bSJed Brown   DM             dm;
19946cab3a1bSJed Brown   SNESDM         sdm;
19959b94acceSBarry Smith 
19963a40ed3dSBarry Smith   PetscFunctionBegin;
19970700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
19980700a824SBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
19990700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
2000c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,x,2);
2001c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,y,3);
20024ec14c9cSBarry Smith   VecValidValues(x,2,PETSC_TRUE);
2003184914b5SBarry Smith 
20046cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
20056cab3a1bSJed Brown   ierr = DMSNESGetContext(dm,&sdm);CHKERRQ(ierr);
2006d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr);
2007c40d0f55SPeter Brune   if (snes->pc && snes->pcside == PC_LEFT) {
2008c40d0f55SPeter Brune     ierr = VecCopy(x,y);CHKERRQ(ierr);
2009c40d0f55SPeter Brune     ierr = SNESSolve(snes->pc,snes->vec_rhs,y);CHKERRQ(ierr);
2010c40d0f55SPeter Brune     ierr = VecAYPX(y,-1.0,x);CHKERRQ(ierr);
2011c40d0f55SPeter Brune   } else if (sdm->computefunction) {
2012d64ed03dSBarry Smith     PetscStackPush("SNES user function");
20136cab3a1bSJed Brown     ierr = (*sdm->computefunction)(snes,x,y,sdm->functionctx);CHKERRQ(ierr);
2014d64ed03dSBarry Smith     PetscStackPop;
201573250ac0SBarry Smith   } else if (snes->dm) {
2016644e2e5bSBarry Smith     ierr = DMComputeFunction(snes->dm,x,y);CHKERRQ(ierr);
2017c90fad12SPeter Brune   } else if (snes->vec_rhs) {
2018c90fad12SPeter Brune     ierr = MatMult(snes->jacobian, x, y);CHKERRQ(ierr);
2019644e2e5bSBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetFunction() or SNESSetDM() before SNESComputeFunction(), likely called from SNESSolve().");
202085385478SLisandro Dalcin   if (snes->vec_rhs) {
202185385478SLisandro Dalcin     ierr = VecAXPY(y,-1.0,snes->vec_rhs);CHKERRQ(ierr);
20223ab0aad5SBarry Smith   }
2023ae3c334cSLois Curfman McInnes   snes->nfuncs++;
2024d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr);
20254ec14c9cSBarry Smith   VecValidValues(y,3,PETSC_FALSE);
20263a40ed3dSBarry Smith   PetscFunctionReturn(0);
20279b94acceSBarry Smith }
20289b94acceSBarry Smith 
20294a2ae208SSatish Balay #undef __FUNCT__
2030646217ecSPeter Brune #define __FUNCT__ "SNESComputeGS"
2031c79ef259SPeter Brune /*@
2032c79ef259SPeter Brune    SNESComputeGS - Calls the Gauss-Seidel function that has been set with
2033c79ef259SPeter Brune                    SNESSetGS().
2034c79ef259SPeter Brune 
2035c79ef259SPeter Brune    Collective on SNES
2036c79ef259SPeter Brune 
2037c79ef259SPeter Brune    Input Parameters:
2038c79ef259SPeter Brune +  snes - the SNES context
2039c79ef259SPeter Brune .  x - input vector
2040c79ef259SPeter Brune -  b - rhs vector
2041c79ef259SPeter Brune 
2042c79ef259SPeter Brune    Output Parameter:
2043c79ef259SPeter Brune .  x - new solution vector
2044c79ef259SPeter Brune 
2045c79ef259SPeter Brune    Notes:
2046c79ef259SPeter Brune    SNESComputeGS() is typically used within composed nonlinear solver
2047c79ef259SPeter Brune    implementations, so most users would not generally call this routine
2048c79ef259SPeter Brune    themselves.
2049c79ef259SPeter Brune 
2050c79ef259SPeter Brune    Level: developer
2051c79ef259SPeter Brune 
2052c79ef259SPeter Brune .keywords: SNES, nonlinear, compute, function
2053c79ef259SPeter Brune 
2054c79ef259SPeter Brune .seealso: SNESSetGS(), SNESComputeFunction()
2055c79ef259SPeter Brune @*/
2056646217ecSPeter Brune PetscErrorCode  SNESComputeGS(SNES snes,Vec b,Vec x)
2057646217ecSPeter Brune {
2058646217ecSPeter Brune   PetscErrorCode ierr;
205989b92e6fSPeter Brune   PetscInt       i;
20606cab3a1bSJed Brown   DM             dm;
20616cab3a1bSJed Brown   SNESDM         sdm;
2062646217ecSPeter Brune 
2063646217ecSPeter Brune   PetscFunctionBegin;
2064646217ecSPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2065646217ecSPeter Brune   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
2066646217ecSPeter Brune   if (b) PetscValidHeaderSpecific(b,VEC_CLASSID,3);
2067646217ecSPeter Brune   PetscCheckSameComm(snes,1,x,2);
2068646217ecSPeter Brune   if (b) PetscCheckSameComm(snes,1,b,3);
20694ec14c9cSBarry Smith   if (b) VecValidValues(b,2,PETSC_TRUE);
2070701cf23dSPeter Brune   ierr = PetscLogEventBegin(SNES_GSEval,snes,x,b,0);CHKERRQ(ierr);
20716cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
20726cab3a1bSJed Brown   ierr = DMSNESGetContext(dm,&sdm);CHKERRQ(ierr);
20736cab3a1bSJed Brown   if (sdm->computegs) {
207489b92e6fSPeter Brune     for (i = 0; i < snes->gssweeps; i++) {
2075646217ecSPeter Brune       PetscStackPush("SNES user GS");
20766cab3a1bSJed Brown       ierr = (*sdm->computegs)(snes,x,b,sdm->gsctx);CHKERRQ(ierr);
2077646217ecSPeter Brune       PetscStackPop;
207889b92e6fSPeter Brune     }
2079646217ecSPeter Brune   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetGS() before SNESComputeGS(), likely called from SNESSolve().");
2080701cf23dSPeter Brune   ierr = PetscLogEventEnd(SNES_GSEval,snes,x,b,0);CHKERRQ(ierr);
20814ec14c9cSBarry Smith   VecValidValues(x,3,PETSC_FALSE);
2082646217ecSPeter Brune   PetscFunctionReturn(0);
2083646217ecSPeter Brune }
2084646217ecSPeter Brune 
2085646217ecSPeter Brune 
2086646217ecSPeter Brune #undef __FUNCT__
20874a2ae208SSatish Balay #define __FUNCT__ "SNESComputeJacobian"
208862fef451SLois Curfman McInnes /*@
208962fef451SLois Curfman McInnes    SNESComputeJacobian - Computes the Jacobian matrix that has been
209062fef451SLois Curfman McInnes    set with SNESSetJacobian().
209162fef451SLois Curfman McInnes 
2092c7afd0dbSLois Curfman McInnes    Collective on SNES and Mat
2093c7afd0dbSLois Curfman McInnes 
209462fef451SLois Curfman McInnes    Input Parameters:
2095c7afd0dbSLois Curfman McInnes +  snes - the SNES context
2096c7afd0dbSLois Curfman McInnes -  x - input vector
209762fef451SLois Curfman McInnes 
209862fef451SLois Curfman McInnes    Output Parameters:
2099c7afd0dbSLois Curfman McInnes +  A - Jacobian matrix
210062fef451SLois Curfman McInnes .  B - optional preconditioning matrix
21012b668275SBarry Smith -  flag - flag indicating matrix structure (one of, SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER)
2102fee21e36SBarry Smith 
2103e35cf81dSBarry Smith   Options Database Keys:
2104e35cf81dSBarry Smith +    -snes_lag_preconditioner <lag>
2105693365a8SJed Brown .    -snes_lag_jacobian <lag>
2106693365a8SJed Brown .    -snes_compare_explicit - Compare the computed Jacobian to the finite difference Jacobian and output the differences
2107693365a8SJed Brown .    -snes_compare_explicit_draw  - Compare the computed Jacobian to the finite difference Jacobian and draw the result
2108693365a8SJed Brown .    -snes_compare_explicit_contour  - Compare the computed Jacobian to the finite difference Jacobian and draw a contour plot with the result
21094c30e9fbSJed Brown .    -snes_compare_operator  - Make the comparison options above use the operator instead of the preconditioning matrix
2110c01495d3SJed Brown .    -snes_compare_coloring - Compute the finite differece Jacobian using coloring and display norms of difference
2111c01495d3SJed Brown .    -snes_compare_coloring_display - Compute the finite differece Jacobian using coloring and display verbose differences
2112c01495d3SJed Brown .    -snes_compare_coloring_threshold - Display only those matrix entries that differ by more than a given threshold
2113c01495d3SJed Brown .    -snes_compare_coloring_threshold_atol - Absolute tolerance for difference in matrix entries to be displayed by -snes_compare_coloring_threshold
2114c01495d3SJed Brown .    -snes_compare_coloring_threshold_rtol - Relative tolerance for difference in matrix entries to be displayed by -snes_compare_coloring_threshold
21154c30e9fbSJed Brown .    -snes_compare_coloring_draw - Compute the finite differece Jacobian using coloring and draw differences
2116c01495d3SJed Brown -    -snes_compare_coloring_draw_contour - Compute the finite differece Jacobian using coloring and show contours of matrices and differences
2117c01495d3SJed Brown 
2118e35cf81dSBarry Smith 
211962fef451SLois Curfman McInnes    Notes:
212062fef451SLois Curfman McInnes    Most users should not need to explicitly call this routine, as it
212162fef451SLois Curfman McInnes    is used internally within the nonlinear solvers.
212262fef451SLois Curfman McInnes 
212394b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
2124dc5a77f8SLois Curfman McInnes    flag parameter.
212562fef451SLois Curfman McInnes 
212636851e7fSLois Curfman McInnes    Level: developer
212736851e7fSLois Curfman McInnes 
212862fef451SLois Curfman McInnes .keywords: SNES, compute, Jacobian, matrix
212962fef451SLois Curfman McInnes 
2130e35cf81dSBarry Smith .seealso:  SNESSetJacobian(), KSPSetOperators(), MatStructure, SNESSetLagPreconditioner(), SNESSetLagJacobian()
213162fef451SLois Curfman McInnes @*/
21327087cfbeSBarry Smith PetscErrorCode  SNESComputeJacobian(SNES snes,Vec X,Mat *A,Mat *B,MatStructure *flg)
21339b94acceSBarry Smith {
2134dfbe8321SBarry Smith   PetscErrorCode ierr;
2135ace3abfcSBarry Smith   PetscBool      flag;
21366cab3a1bSJed Brown   DM             dm;
21376cab3a1bSJed Brown   SNESDM         sdm;
21383a40ed3dSBarry Smith 
21393a40ed3dSBarry Smith   PetscFunctionBegin;
21400700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
21410700a824SBarry Smith   PetscValidHeaderSpecific(X,VEC_CLASSID,2);
21424482741eSBarry Smith   PetscValidPointer(flg,5);
2143c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,X,2);
21444ec14c9cSBarry Smith   VecValidValues(X,2,PETSC_TRUE);
21456cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
21466cab3a1bSJed Brown   ierr = DMSNESGetContext(dm,&sdm);CHKERRQ(ierr);
21473232da50SPeter Brune 
21486cab3a1bSJed Brown   if (!sdm->computejacobian) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_USER,"Must call SNESSetJacobian(), DMSNESSetJacobian(), DMDASNESSetJacobianLocal(), etc");
2149ebd3b9afSBarry Smith 
2150ebd3b9afSBarry Smith   /* make sure that MatAssemblyBegin/End() is called on A matrix if it is matrix free */
2151ebd3b9afSBarry Smith 
2152fe3ffe1eSBarry Smith   if (snes->lagjacobian == -2) {
2153fe3ffe1eSBarry Smith     snes->lagjacobian = -1;
2154fe3ffe1eSBarry Smith     ierr = PetscInfo(snes,"Recomputing Jacobian/preconditioner because lag is -2 (means compute Jacobian, but then never again) \n");CHKERRQ(ierr);
2155fe3ffe1eSBarry Smith   } else if (snes->lagjacobian == -1) {
2156e35cf81dSBarry Smith     *flg = SAME_PRECONDITIONER;
2157e35cf81dSBarry Smith     ierr = PetscInfo(snes,"Reusing Jacobian/preconditioner because lag is -1\n");CHKERRQ(ierr);
2158251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr);
2159ebd3b9afSBarry Smith     if (flag) {
2160ebd3b9afSBarry Smith       ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
2161ebd3b9afSBarry Smith       ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
2162ebd3b9afSBarry Smith     }
2163e35cf81dSBarry Smith     PetscFunctionReturn(0);
2164e35cf81dSBarry Smith   } else if (snes->lagjacobian > 1 && snes->iter % snes->lagjacobian) {
2165e35cf81dSBarry Smith     *flg = SAME_PRECONDITIONER;
2166e35cf81dSBarry Smith     ierr = PetscInfo2(snes,"Reusing Jacobian/preconditioner because lag is %D and SNES iteration is %D\n",snes->lagjacobian,snes->iter);CHKERRQ(ierr);
2167251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr);
2168ebd3b9afSBarry Smith     if (flag) {
2169ebd3b9afSBarry Smith       ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
2170ebd3b9afSBarry Smith       ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
2171ebd3b9afSBarry Smith     }
2172e35cf81dSBarry Smith     PetscFunctionReturn(0);
2173e35cf81dSBarry Smith   }
2174e35cf81dSBarry Smith 
2175c4fc05e7SBarry Smith   *flg = DIFFERENT_NONZERO_PATTERN;
2176e35cf81dSBarry Smith   ierr = PetscLogEventBegin(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr);
21773232da50SPeter Brune 
2178d64ed03dSBarry Smith   PetscStackPush("SNES user Jacobian function");
21793232da50SPeter Brune   if (snes->mf && !snes->mf_operator) {
21803232da50SPeter Brune     ierr = MatMFFDComputeJacobian(snes,X,A,B,flg,sdm->jacobianctx);CHKERRQ(ierr);
21813232da50SPeter Brune   } else {
21826cab3a1bSJed Brown     ierr = (*sdm->computejacobian)(snes,X,A,B,flg,sdm->jacobianctx);CHKERRQ(ierr);
21833232da50SPeter Brune   }
2184d64ed03dSBarry Smith   PetscStackPop;
21853232da50SPeter Brune 
2186d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr);
2187a8054027SBarry Smith 
21883b4f5425SBarry Smith   if (snes->lagpreconditioner == -2) {
21893b4f5425SBarry Smith     ierr = PetscInfo(snes,"Rebuilding preconditioner exactly once since lag is -2\n");CHKERRQ(ierr);
21903b4f5425SBarry Smith     snes->lagpreconditioner = -1;
21913b4f5425SBarry Smith   } else if (snes->lagpreconditioner == -1) {
2192a8054027SBarry Smith     *flg = SAME_PRECONDITIONER;
2193a8054027SBarry Smith     ierr = PetscInfo(snes,"Reusing preconditioner because lag is -1\n");CHKERRQ(ierr);
2194a8054027SBarry Smith   } else if (snes->lagpreconditioner > 1 && snes->iter % snes->lagpreconditioner) {
2195a8054027SBarry Smith     *flg = SAME_PRECONDITIONER;
2196a8054027SBarry Smith     ierr = PetscInfo2(snes,"Reusing preconditioner because lag is %D and SNES iteration is %D\n",snes->lagpreconditioner,snes->iter);CHKERRQ(ierr);
2197a8054027SBarry Smith   }
2198a8054027SBarry Smith 
21996d84be18SBarry Smith   /* make sure user returned a correct Jacobian and preconditioner */
22000700a824SBarry Smith   /* PetscValidHeaderSpecific(*A,MAT_CLASSID,3);
22010700a824SBarry Smith     PetscValidHeaderSpecific(*B,MAT_CLASSID,4);   */
2202693365a8SJed Brown   {
2203693365a8SJed Brown     PetscBool flag = PETSC_FALSE,flag_draw = PETSC_FALSE,flag_contour = PETSC_FALSE,flag_operator = PETSC_FALSE;
2204693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit",&flag,PETSC_NULL);CHKERRQ(ierr);
2205693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw",&flag_draw,PETSC_NULL);CHKERRQ(ierr);
2206693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw_contour",&flag_contour,PETSC_NULL);CHKERRQ(ierr);
2207693365a8SJed Brown     ierr  = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_operator",&flag_operator,PETSC_NULL);CHKERRQ(ierr);
2208693365a8SJed Brown     if (flag || flag_draw || flag_contour) {
2209693365a8SJed Brown       Mat Bexp_mine = PETSC_NULL,Bexp,FDexp;
2210693365a8SJed Brown       MatStructure mstruct;
2211693365a8SJed Brown       PetscViewer vdraw,vstdout;
22126b3a5b13SJed Brown       PetscBool flg;
2213693365a8SJed Brown       if (flag_operator) {
2214693365a8SJed Brown         ierr = MatComputeExplicitOperator(*A,&Bexp_mine);CHKERRQ(ierr);
2215693365a8SJed Brown         Bexp = Bexp_mine;
2216693365a8SJed Brown       } else {
2217693365a8SJed Brown         /* See if the preconditioning matrix can be viewed and added directly */
2218251f4c67SDmitry Karpeev         ierr = PetscObjectTypeCompareAny((PetscObject)*B,&flg,MATSEQAIJ,MATMPIAIJ,MATSEQDENSE,MATMPIDENSE,MATSEQBAIJ,MATMPIBAIJ,MATSEQSBAIJ,MATMPIBAIJ,"");CHKERRQ(ierr);
2219693365a8SJed Brown         if (flg) Bexp = *B;
2220693365a8SJed Brown         else {
2221693365a8SJed Brown           /* If the "preconditioning" matrix is itself MATSHELL or some other type without direct support */
2222693365a8SJed Brown           ierr = MatComputeExplicitOperator(*B,&Bexp_mine);CHKERRQ(ierr);
2223693365a8SJed Brown           Bexp = Bexp_mine;
2224693365a8SJed Brown         }
2225693365a8SJed Brown       }
2226693365a8SJed Brown       ierr = MatConvert(Bexp,MATSAME,MAT_INITIAL_MATRIX,&FDexp);CHKERRQ(ierr);
2227693365a8SJed Brown       ierr = SNESDefaultComputeJacobian(snes,X,&FDexp,&FDexp,&mstruct,NULL);CHKERRQ(ierr);
2228693365a8SJed Brown       ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&vstdout);CHKERRQ(ierr);
2229693365a8SJed Brown       if (flag_draw || flag_contour) {
2230693365a8SJed Brown         ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,0,"Explicit Jacobians",PETSC_DECIDE,PETSC_DECIDE,300,300,&vdraw);CHKERRQ(ierr);
2231693365a8SJed Brown         if (flag_contour) {ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);}
2232693365a8SJed Brown       } else vdraw = PETSC_NULL;
2233693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Explicit %s\n",flag_operator?"Jacobian":"preconditioning Jacobian");CHKERRQ(ierr);
2234693365a8SJed Brown       if (flag) {ierr = MatView(Bexp,vstdout);CHKERRQ(ierr);}
2235693365a8SJed Brown       if (vdraw) {ierr = MatView(Bexp,vdraw);CHKERRQ(ierr);}
2236693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Finite difference Jacobian\n");CHKERRQ(ierr);
2237693365a8SJed Brown       if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);}
2238693365a8SJed Brown       if (vdraw) {ierr = MatView(FDexp,vdraw);CHKERRQ(ierr);}
2239693365a8SJed Brown       ierr = MatAYPX(FDexp,-1.0,Bexp,SAME_NONZERO_PATTERN);CHKERRQ(ierr);
2240693365a8SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"User-provided matrix minus finite difference Jacobian\n");CHKERRQ(ierr);
2241693365a8SJed Brown       if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);}
2242693365a8SJed Brown       if (vdraw) {              /* Always use contour for the difference */
2243693365a8SJed Brown         ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);
2244693365a8SJed Brown         ierr = MatView(FDexp,vdraw);CHKERRQ(ierr);
2245693365a8SJed Brown         ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);
2246693365a8SJed Brown       }
2247693365a8SJed Brown       if (flag_contour) {ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);}
2248693365a8SJed Brown       ierr = PetscViewerDestroy(&vdraw);CHKERRQ(ierr);
2249693365a8SJed Brown       ierr = MatDestroy(&Bexp_mine);CHKERRQ(ierr);
2250693365a8SJed Brown       ierr = MatDestroy(&FDexp);CHKERRQ(ierr);
2251693365a8SJed Brown     }
2252693365a8SJed Brown   }
22534c30e9fbSJed Brown   {
22546719d8e4SJed Brown     PetscBool flag = PETSC_FALSE,flag_display = PETSC_FALSE,flag_draw = PETSC_FALSE,flag_contour = PETSC_FALSE,flag_threshold = PETSC_FALSE;
22556719d8e4SJed Brown     PetscReal threshold_atol = PETSC_SQRT_MACHINE_EPSILON,threshold_rtol = 10*PETSC_SQRT_MACHINE_EPSILON;
22564c30e9fbSJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring",&flag,PETSC_NULL);CHKERRQ(ierr);
22576719d8e4SJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_display",&flag_display,PETSC_NULL);CHKERRQ(ierr);
22584c30e9fbSJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_draw",&flag_draw,PETSC_NULL);CHKERRQ(ierr);
22594c30e9fbSJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_draw_contour",&flag_contour,PETSC_NULL);CHKERRQ(ierr);
22606719d8e4SJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold",&flag_threshold,PETSC_NULL);CHKERRQ(ierr);
22616719d8e4SJed Brown     ierr = PetscOptionsGetReal(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold_rtol",&threshold_rtol,PETSC_NULL);CHKERRQ(ierr);
22626719d8e4SJed Brown     ierr = PetscOptionsGetReal(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold_atol",&threshold_atol,PETSC_NULL);CHKERRQ(ierr);
22636719d8e4SJed Brown     if (flag || flag_display || flag_draw || flag_contour || flag_threshold) {
22644c30e9fbSJed Brown       Mat            Bfd;
22654c30e9fbSJed Brown       MatStructure   mstruct;
22664c30e9fbSJed Brown       PetscViewer    vdraw,vstdout;
22674c30e9fbSJed Brown       ISColoring     iscoloring;
22684c30e9fbSJed Brown       MatFDColoring  matfdcoloring;
22694c30e9fbSJed Brown       PetscErrorCode (*func)(SNES,Vec,Vec,void*);
22704c30e9fbSJed Brown       void           *funcctx;
22716719d8e4SJed Brown       PetscReal      norm1,norm2,normmax;
22724c30e9fbSJed Brown 
22734c30e9fbSJed Brown       ierr = MatDuplicate(*B,MAT_DO_NOT_COPY_VALUES,&Bfd);CHKERRQ(ierr);
22744c30e9fbSJed Brown       ierr = MatGetColoring(Bfd,MATCOLORINGSL,&iscoloring);CHKERRQ(ierr);
22754c30e9fbSJed Brown       ierr = MatFDColoringCreate(Bfd,iscoloring,&matfdcoloring);CHKERRQ(ierr);
22764c30e9fbSJed Brown       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
22774c30e9fbSJed Brown 
22784c30e9fbSJed Brown       /* This method of getting the function is currently unreliable since it doesn't work for DM local functions. */
22794c30e9fbSJed Brown       ierr = SNESGetFunction(snes,PETSC_NULL,&func,&funcctx);CHKERRQ(ierr);
22804c30e9fbSJed Brown         ierr = MatFDColoringSetFunction(matfdcoloring,(PetscErrorCode(*)(void))func,funcctx);CHKERRQ(ierr);
22814c30e9fbSJed Brown         ierr = PetscObjectSetOptionsPrefix((PetscObject)matfdcoloring,((PetscObject)snes)->prefix);CHKERRQ(ierr);
22824c30e9fbSJed Brown         ierr = PetscObjectAppendOptionsPrefix((PetscObject)matfdcoloring,"coloring_");CHKERRQ(ierr);
22834c30e9fbSJed Brown         ierr = MatFDColoringSetFromOptions(matfdcoloring);CHKERRQ(ierr);
22844c30e9fbSJed Brown         ierr = MatFDColoringApply(Bfd,matfdcoloring,X,&mstruct,snes);CHKERRQ(ierr);
22854c30e9fbSJed Brown         ierr = MatFDColoringDestroy(&matfdcoloring);CHKERRQ(ierr);
22864c30e9fbSJed Brown 
22874c30e9fbSJed Brown       ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&vstdout);CHKERRQ(ierr);
22884c30e9fbSJed Brown       if (flag_draw || flag_contour) {
22894c30e9fbSJed Brown         ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,0,"Colored Jacobians",PETSC_DECIDE,PETSC_DECIDE,300,300,&vdraw);CHKERRQ(ierr);
22904c30e9fbSJed Brown         if (flag_contour) {ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);}
22914c30e9fbSJed Brown       } else vdraw = PETSC_NULL;
22924c30e9fbSJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Explicit preconditioning Jacobian\n");CHKERRQ(ierr);
22936719d8e4SJed Brown       if (flag_display) {ierr = MatView(*B,vstdout);CHKERRQ(ierr);}
22944c30e9fbSJed Brown       if (vdraw) {ierr = MatView(*B,vdraw);CHKERRQ(ierr);}
22954c30e9fbSJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"Colored Finite difference Jacobian\n");CHKERRQ(ierr);
22966719d8e4SJed Brown       if (flag_display) {ierr = MatView(Bfd,vstdout);CHKERRQ(ierr);}
22974c30e9fbSJed Brown       if (vdraw) {ierr = MatView(Bfd,vdraw);CHKERRQ(ierr);}
22984c30e9fbSJed Brown       ierr = MatAYPX(Bfd,-1.0,*B,SAME_NONZERO_PATTERN);CHKERRQ(ierr);
22994c30e9fbSJed Brown       ierr = MatNorm(Bfd,NORM_1,&norm1);CHKERRQ(ierr);
23006719d8e4SJed Brown       ierr = MatNorm(Bfd,NORM_FROBENIUS,&norm2);CHKERRQ(ierr);
23014c30e9fbSJed Brown       ierr = MatNorm(Bfd,NORM_MAX,&normmax);CHKERRQ(ierr);
23026719d8e4SJed Brown       ierr = PetscViewerASCIIPrintf(vstdout,"User-provided matrix minus finite difference Jacobian, norm1=%G normFrob=%G normmax=%G\n",norm1,norm2,normmax);CHKERRQ(ierr);
23036719d8e4SJed Brown       if (flag_display) {ierr = MatView(Bfd,vstdout);CHKERRQ(ierr);}
23044c30e9fbSJed Brown       if (vdraw) {              /* Always use contour for the difference */
23054c30e9fbSJed Brown         ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);
23064c30e9fbSJed Brown         ierr = MatView(Bfd,vdraw);CHKERRQ(ierr);
23074c30e9fbSJed Brown         ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);
23084c30e9fbSJed Brown       }
23094c30e9fbSJed Brown       if (flag_contour) {ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);}
23106719d8e4SJed Brown 
23116719d8e4SJed Brown       if (flag_threshold) {
23126719d8e4SJed Brown         PetscInt bs,rstart,rend,i;
23136719d8e4SJed Brown         ierr = MatGetBlockSize(*B,&bs);CHKERRQ(ierr);
23146719d8e4SJed Brown         ierr = MatGetOwnershipRange(*B,&rstart,&rend);CHKERRQ(ierr);
23156719d8e4SJed Brown         for (i=rstart; i<rend; i++) {
23166719d8e4SJed Brown           const PetscScalar *ba,*ca;
23176719d8e4SJed Brown           const PetscInt    *bj,*cj;
23186719d8e4SJed Brown           PetscInt          bn,cn,j,maxentrycol = -1,maxdiffcol = -1,maxrdiffcol = -1;
23196719d8e4SJed Brown           PetscReal         maxentry = 0,maxdiff = 0,maxrdiff = 0;
23206719d8e4SJed Brown           ierr = MatGetRow(*B,i,&bn,&bj,&ba);CHKERRQ(ierr);
23216719d8e4SJed Brown           ierr = MatGetRow(Bfd,i,&cn,&cj,&ca);CHKERRQ(ierr);
23226719d8e4SJed Brown           if (bn != cn) SETERRQ(((PetscObject)*A)->comm,PETSC_ERR_PLIB,"Unexpected different nonzero pattern in -snes_compare_coloring_threshold");
23236719d8e4SJed Brown           for (j=0; j<bn; j++) {
23246719d8e4SJed Brown             PetscReal rdiff = PetscAbsScalar(ca[j]) / (threshold_atol + threshold_rtol*PetscAbsScalar(ba[j]));
23256719d8e4SJed Brown             if (PetscAbsScalar(ba[j]) > PetscAbs(maxentry)) {
23266719d8e4SJed Brown               maxentrycol = bj[j];
23276719d8e4SJed Brown               maxentry = PetscRealPart(ba[j]);
23286719d8e4SJed Brown             }
23296719d8e4SJed Brown             if (PetscAbsScalar(ca[j]) > PetscAbs(maxdiff)) {
23306719d8e4SJed Brown               maxdiffcol = bj[j];
23316719d8e4SJed Brown               maxdiff = PetscRealPart(ca[j]);
23326719d8e4SJed Brown             }
23336719d8e4SJed Brown             if (rdiff > maxrdiff) {
23346719d8e4SJed Brown               maxrdiffcol = bj[j];
23356719d8e4SJed Brown               maxrdiff = rdiff;
23366719d8e4SJed Brown             }
23376719d8e4SJed Brown           }
23386719d8e4SJed Brown           if (maxrdiff > 1) {
23396719d8e4SJed 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);
23406719d8e4SJed Brown             for (j=0; j<bn; j++) {
23416719d8e4SJed Brown               PetscReal rdiff;
23426719d8e4SJed Brown               rdiff = PetscAbsScalar(ca[j]) / (threshold_atol + threshold_rtol*PetscAbsScalar(ba[j]));
23436719d8e4SJed Brown               if (rdiff > 1) {
23446719d8e4SJed Brown                 ierr = PetscViewerASCIIPrintf(vstdout," (%D,%G:%G)",bj[j],PetscRealPart(ba[j]),PetscRealPart(ca[j]));CHKERRQ(ierr);
23456719d8e4SJed Brown               }
23466719d8e4SJed Brown             }
23476719d8e4SJed Brown             ierr = PetscViewerASCIIPrintf(vstdout,"\n",i,maxentry,maxdiff,maxrdiff);CHKERRQ(ierr);
23486719d8e4SJed Brown           }
23496719d8e4SJed Brown           ierr = MatRestoreRow(*B,i,&bn,&bj,&ba);CHKERRQ(ierr);
23506719d8e4SJed Brown           ierr = MatRestoreRow(Bfd,i,&cn,&cj,&ca);CHKERRQ(ierr);
23516719d8e4SJed Brown         }
23526719d8e4SJed Brown       }
23534c30e9fbSJed Brown       ierr = PetscViewerDestroy(&vdraw);CHKERRQ(ierr);
23544c30e9fbSJed Brown       ierr = MatDestroy(&Bfd);CHKERRQ(ierr);
23554c30e9fbSJed Brown     }
23564c30e9fbSJed Brown   }
23573a40ed3dSBarry Smith   PetscFunctionReturn(0);
23589b94acceSBarry Smith }
23599b94acceSBarry Smith 
23604a2ae208SSatish Balay #undef __FUNCT__
23614a2ae208SSatish Balay #define __FUNCT__ "SNESSetJacobian"
23629b94acceSBarry Smith /*@C
23639b94acceSBarry Smith    SNESSetJacobian - Sets the function to compute Jacobian as well as the
2364044dda88SLois Curfman McInnes    location to store the matrix.
23659b94acceSBarry Smith 
23663f9fe445SBarry Smith    Logically Collective on SNES and Mat
2367c7afd0dbSLois Curfman McInnes 
23689b94acceSBarry Smith    Input Parameters:
2369c7afd0dbSLois Curfman McInnes +  snes - the SNES context
23709b94acceSBarry Smith .  A - Jacobian matrix
23719b94acceSBarry Smith .  B - preconditioner matrix (usually same as the Jacobian)
2372efd51863SBarry Smith .  func - Jacobian evaluation routine (if PETSC_NULL then SNES retains any previously set value)
2373c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined context for private data for the
2374efd51863SBarry Smith          Jacobian evaluation routine (may be PETSC_NULL) (if PETSC_NULL then SNES retains any previously set value)
23759b94acceSBarry Smith 
23769b94acceSBarry Smith    Calling sequence of func:
23778d76a1e5SLois Curfman McInnes $     func (SNES snes,Vec x,Mat *A,Mat *B,int *flag,void *ctx);
23789b94acceSBarry Smith 
2379c7afd0dbSLois Curfman McInnes +  x - input vector
23809b94acceSBarry Smith .  A - Jacobian matrix
23819b94acceSBarry Smith .  B - preconditioner matrix, usually the same as A
2382ac21db08SLois Curfman McInnes .  flag - flag indicating information about the preconditioner matrix
23832b668275SBarry Smith    structure (same as flag in KSPSetOperators()), one of SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER
2384c7afd0dbSLois Curfman McInnes -  ctx - [optional] user-defined Jacobian context
23859b94acceSBarry Smith 
23869b94acceSBarry Smith    Notes:
238794b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the flag
23882cd2dfdcSLois Curfman McInnes    output parameter in the routine func().  Be sure to read this information!
2389ac21db08SLois Curfman McInnes 
2390ac21db08SLois Curfman McInnes    The routine func() takes Mat * as the matrix arguments rather than Mat.
23919b94acceSBarry Smith    This allows the Jacobian evaluation routine to replace A and/or B with a
23929b94acceSBarry Smith    completely new new matrix structure (not just different matrix elements)
23939b94acceSBarry Smith    when appropriate, for instance, if the nonzero structure is changing
23949b94acceSBarry Smith    throughout the global iterations.
23959b94acceSBarry Smith 
239616913363SBarry Smith    If the A matrix and B matrix are different you must call MatAssemblyBegin/End() on
239716913363SBarry Smith    each matrix.
239816913363SBarry Smith 
2399a8a26c1eSJed Brown    If using SNESDefaultComputeJacobianColor() to assemble a Jacobian, the ctx argument
2400a8a26c1eSJed Brown    must be a MatFDColoring.
2401a8a26c1eSJed Brown 
2402c3cc8fd1SJed Brown    Other defect-correction schemes can be used by computing a different matrix in place of the Jacobian.  One common
2403c3cc8fd1SJed Brown    example is to use the "Picard linearization" which only differentiates through the highest order parts of each term.
2404c3cc8fd1SJed Brown 
240536851e7fSLois Curfman McInnes    Level: beginner
240636851e7fSLois Curfman McInnes 
24079b94acceSBarry Smith .keywords: SNES, nonlinear, set, Jacobian, matrix
24089b94acceSBarry Smith 
24093ec795f1SBarry Smith .seealso: KSPSetOperators(), SNESSetFunction(), MatMFFDComputeJacobian(), SNESDefaultComputeJacobianColor(), MatStructure
24109b94acceSBarry Smith @*/
24117087cfbeSBarry Smith PetscErrorCode  SNESSetJacobian(SNES snes,Mat A,Mat B,PetscErrorCode (*func)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *ctx)
24129b94acceSBarry Smith {
2413dfbe8321SBarry Smith   PetscErrorCode ierr;
24146cab3a1bSJed Brown   DM             dm;
24153a7fca6bSBarry Smith 
24163a40ed3dSBarry Smith   PetscFunctionBegin;
24170700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
24180700a824SBarry Smith   if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2);
24190700a824SBarry Smith   if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3);
2420c9780b6fSBarry Smith   if (A) PetscCheckSameComm(snes,1,A,2);
242106975374SJed Brown   if (B) PetscCheckSameComm(snes,1,B,3);
24226cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
24236cab3a1bSJed Brown   ierr = DMSNESSetJacobian(dm,func,ctx);CHKERRQ(ierr);
24243a7fca6bSBarry Smith   if (A) {
24257dcf0eaaSdalcinl     ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
24266bf464f9SBarry Smith     ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr);
24279b94acceSBarry Smith     snes->jacobian = A;
24283a7fca6bSBarry Smith   }
24293a7fca6bSBarry Smith   if (B) {
24307dcf0eaaSdalcinl     ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
24316bf464f9SBarry Smith     ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr);
24329b94acceSBarry Smith     snes->jacobian_pre = B;
24333a7fca6bSBarry Smith   }
24343a40ed3dSBarry Smith   PetscFunctionReturn(0);
24359b94acceSBarry Smith }
243662fef451SLois Curfman McInnes 
24374a2ae208SSatish Balay #undef __FUNCT__
24384a2ae208SSatish Balay #define __FUNCT__ "SNESGetJacobian"
2439c2aafc4cSSatish Balay /*@C
2440b4fd4287SBarry Smith    SNESGetJacobian - Returns the Jacobian matrix and optionally the user
2441b4fd4287SBarry Smith    provided context for evaluating the Jacobian.
2442b4fd4287SBarry Smith 
2443c7afd0dbSLois Curfman McInnes    Not Collective, but Mat object will be parallel if SNES object is
2444c7afd0dbSLois Curfman McInnes 
2445b4fd4287SBarry Smith    Input Parameter:
2446b4fd4287SBarry Smith .  snes - the nonlinear solver context
2447b4fd4287SBarry Smith 
2448b4fd4287SBarry Smith    Output Parameters:
2449c7afd0dbSLois Curfman McInnes +  A - location to stash Jacobian matrix (or PETSC_NULL)
2450b4fd4287SBarry Smith .  B - location to stash preconditioner matrix (or PETSC_NULL)
245170e92668SMatthew Knepley .  func - location to put Jacobian function (or PETSC_NULL)
245270e92668SMatthew Knepley -  ctx - location to stash Jacobian ctx (or PETSC_NULL)
2453fee21e36SBarry Smith 
245436851e7fSLois Curfman McInnes    Level: advanced
245536851e7fSLois Curfman McInnes 
2456b4fd4287SBarry Smith .seealso: SNESSetJacobian(), SNESComputeJacobian()
2457b4fd4287SBarry Smith @*/
24587087cfbeSBarry Smith PetscErrorCode SNESGetJacobian(SNES snes,Mat *A,Mat *B,PetscErrorCode (**func)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **ctx)
2459b4fd4287SBarry Smith {
24606cab3a1bSJed Brown   PetscErrorCode ierr;
24616cab3a1bSJed Brown   DM             dm;
24626cab3a1bSJed Brown   SNESDM         sdm;
24636cab3a1bSJed Brown 
24643a40ed3dSBarry Smith   PetscFunctionBegin;
24650700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2466b4fd4287SBarry Smith   if (A)    *A    = snes->jacobian;
2467b4fd4287SBarry Smith   if (B)    *B    = snes->jacobian_pre;
24686cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
24696cab3a1bSJed Brown   ierr = DMSNESGetContext(dm,&sdm);CHKERRQ(ierr);
24706cab3a1bSJed Brown   if (func) *func = sdm->computejacobian;
24716cab3a1bSJed Brown   if (ctx)  *ctx  = sdm->jacobianctx;
24723a40ed3dSBarry Smith   PetscFunctionReturn(0);
2473b4fd4287SBarry Smith }
2474b4fd4287SBarry Smith 
24759b94acceSBarry Smith /* ----- Routines to initialize and destroy a nonlinear solver ---- */
24769b94acceSBarry Smith 
24774a2ae208SSatish Balay #undef __FUNCT__
24784a2ae208SSatish Balay #define __FUNCT__ "SNESSetUp"
24799b94acceSBarry Smith /*@
24809b94acceSBarry Smith    SNESSetUp - Sets up the internal data structures for the later use
2481272ac6f2SLois Curfman McInnes    of a nonlinear solver.
24829b94acceSBarry Smith 
2483fee21e36SBarry Smith    Collective on SNES
2484fee21e36SBarry Smith 
2485c7afd0dbSLois Curfman McInnes    Input Parameters:
248670e92668SMatthew Knepley .  snes - the SNES context
2487c7afd0dbSLois Curfman McInnes 
2488272ac6f2SLois Curfman McInnes    Notes:
2489272ac6f2SLois Curfman McInnes    For basic use of the SNES solvers the user need not explicitly call
2490272ac6f2SLois Curfman McInnes    SNESSetUp(), since these actions will automatically occur during
2491272ac6f2SLois Curfman McInnes    the call to SNESSolve().  However, if one wishes to control this
2492272ac6f2SLois Curfman McInnes    phase separately, SNESSetUp() should be called after SNESCreate()
2493272ac6f2SLois Curfman McInnes    and optional routines of the form SNESSetXXX(), but before SNESSolve().
2494272ac6f2SLois Curfman McInnes 
249536851e7fSLois Curfman McInnes    Level: advanced
249636851e7fSLois Curfman McInnes 
24979b94acceSBarry Smith .keywords: SNES, nonlinear, setup
24989b94acceSBarry Smith 
24999b94acceSBarry Smith .seealso: SNESCreate(), SNESSolve(), SNESDestroy()
25009b94acceSBarry Smith @*/
25017087cfbeSBarry Smith PetscErrorCode  SNESSetUp(SNES snes)
25029b94acceSBarry Smith {
2503dfbe8321SBarry Smith   PetscErrorCode              ierr;
25046cab3a1bSJed Brown   DM                          dm;
25056cab3a1bSJed Brown   SNESDM                      sdm;
2506c35f09e5SBarry Smith   SNESLineSearch              linesearch, pclinesearch;
25076e2a1849SPeter Brune   void                        *lsprectx,*lspostctx;
25086e2a1849SPeter Brune   SNESLineSearchPreCheckFunc  lsprefunc;
25096e2a1849SPeter Brune   SNESLineSearchPostCheckFunc lspostfunc;
25106e2a1849SPeter Brune   PetscErrorCode              (*func)(SNES,Vec,Vec,void*);
25116e2a1849SPeter Brune   Vec                         f,fpc;
25126e2a1849SPeter Brune   void                        *funcctx;
25136e2a1849SPeter Brune   PetscErrorCode              (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
25141eb13d49SPeter Brune   void                        *jacctx,*appctx;
25156e2a1849SPeter Brune   Mat                         A,B;
25163a40ed3dSBarry Smith 
25173a40ed3dSBarry Smith   PetscFunctionBegin;
25180700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
25194dc4c822SBarry Smith   if (snes->setupcalled) PetscFunctionReturn(0);
25209b94acceSBarry Smith 
25217adad957SLisandro Dalcin   if (!((PetscObject)snes)->type_name) {
252285385478SLisandro Dalcin     ierr = SNESSetType(snes,SNESLS);CHKERRQ(ierr);
252385385478SLisandro Dalcin   }
252485385478SLisandro Dalcin 
2525a63bb30eSJed Brown   ierr = SNESGetFunction(snes,&snes->vec_func,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
252617186662SBarry Smith   if (snes->vec_func == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be function vector");
252758c9b817SLisandro Dalcin   if (snes->vec_rhs  == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be right hand side vector");
252858c9b817SLisandro Dalcin 
252958c9b817SLisandro Dalcin   if (!snes->vec_sol_update /* && snes->vec_sol */) {
253058c9b817SLisandro Dalcin     ierr = VecDuplicate(snes->vec_sol,&snes->vec_sol_update);CHKERRQ(ierr);
253158c9b817SLisandro Dalcin     ierr = PetscLogObjectParent(snes,snes->vec_sol_update);CHKERRQ(ierr);
253258c9b817SLisandro Dalcin   }
253358c9b817SLisandro Dalcin 
25346cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
2535d8f46077SPeter Brune   ierr = DMShellSetGlobalVector(snes->dm,snes->vec_sol);CHKERRQ(ierr);
25366cab3a1bSJed Brown   ierr = DMSNESSetUpLegacy(dm);CHKERRQ(ierr); /* To be removed when function routines are taken out of the DM package */
25376cab3a1bSJed Brown   ierr = DMSNESGetContext(dm,&sdm);CHKERRQ(ierr);
25386cab3a1bSJed Brown   if (!sdm->computefunction) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_ARG_WRONGSTATE,"Must provide a residual function with SNESSetFunction(), DMSNESSetFunction(), DMDASNESSetFunctionLocal(), etc");
25396cab3a1bSJed Brown   if (!snes->vec_func) {
25406cab3a1bSJed Brown     ierr = DMCreateGlobalVector(dm,&snes->vec_func);CHKERRQ(ierr);
2541214df951SJed Brown   }
2542efd51863SBarry Smith 
2543b710008aSBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes, &snes->ksp);CHKERRQ(ierr);}
2544b710008aSBarry Smith 
2545f1c6b773SPeter Brune   if (!snes->linesearch) {ierr = SNESGetSNESLineSearch(snes, &snes->linesearch);}
25469e764e56SPeter Brune 
2547c40d0f55SPeter Brune   if (snes->pc && (snes->pcside == PC_LEFT)) snes->mf = PETSC_TRUE;
2548d8f46077SPeter Brune 
2549d8f46077SPeter Brune   if (snes->mf) { ierr = SNESSetUpMatrixFree_Private(snes, snes->mf_operator, snes->mf_version);CHKERRQ(ierr); }
2550d8f46077SPeter Brune 
2551d8f46077SPeter Brune 
2552d25893d9SBarry Smith   if (snes->ops->usercompute && !snes->user) {
2553d25893d9SBarry Smith     ierr = (*snes->ops->usercompute)(snes,(void**)&snes->user);CHKERRQ(ierr);
2554d25893d9SBarry Smith   }
2555d25893d9SBarry Smith 
25566e2a1849SPeter Brune   if (snes->pc) {
25576e2a1849SPeter Brune     /* copy the DM over */
25586e2a1849SPeter Brune     ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
25596e2a1849SPeter Brune     ierr = SNESSetDM(snes->pc,dm);CHKERRQ(ierr);
25606e2a1849SPeter Brune 
25616e2a1849SPeter Brune     /* copy the legacy SNES context not related to the DM over*/
25626e2a1849SPeter Brune     ierr = SNESGetFunction(snes,&f,&func,&funcctx);CHKERRQ(ierr);
25636e2a1849SPeter Brune     ierr = VecDuplicate(f,&fpc);CHKERRQ(ierr);
25646e2a1849SPeter Brune     ierr = SNESSetFunction(snes->pc,fpc,func,funcctx);CHKERRQ(ierr);
25656e2a1849SPeter Brune     ierr = SNESGetJacobian(snes,&A,&B,&jac,&jacctx);CHKERRQ(ierr);
25666e2a1849SPeter Brune     ierr = SNESSetJacobian(snes->pc,A,B,jac,jacctx);CHKERRQ(ierr);
25671eb13d49SPeter Brune     ierr = SNESGetApplicationContext(snes,&appctx);CHKERRQ(ierr);
25681eb13d49SPeter Brune     ierr = SNESSetApplicationContext(snes->pc,appctx);CHKERRQ(ierr);
25696e2a1849SPeter Brune     ierr = VecDestroy(&fpc);CHKERRQ(ierr);
25706e2a1849SPeter Brune 
25716e2a1849SPeter Brune     /* copy the function pointers over */
25726e2a1849SPeter Brune     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)snes,(PetscObject)snes->pc);CHKERRQ(ierr);
25736e2a1849SPeter Brune 
25746e2a1849SPeter Brune      /* default to 1 iteration */
2575140836e4SPeter Brune     ierr = SNESSetTolerances(snes->pc, 0.0, 0.0, 0.0, 1, snes->pc->max_funcs);CHKERRQ(ierr);
25766e2a1849SPeter Brune     ierr = SNESSetNormType(snes->pc, SNES_NORM_FINAL_ONLY);CHKERRQ(ierr);
25776e2a1849SPeter Brune     ierr = SNESSetFromOptions(snes->pc);CHKERRQ(ierr);
25786e2a1849SPeter Brune 
25796e2a1849SPeter Brune     /* copy the line search context over */
25806e2a1849SPeter Brune     ierr = SNESGetSNESLineSearch(snes,&linesearch);CHKERRQ(ierr);
25816e2a1849SPeter Brune     ierr = SNESGetSNESLineSearch(snes->pc,&pclinesearch);CHKERRQ(ierr);
25826e2a1849SPeter Brune     ierr = SNESLineSearchGetPreCheck(linesearch,&lsprefunc,&lsprectx);CHKERRQ(ierr);
25836e2a1849SPeter Brune     ierr = SNESLineSearchGetPostCheck(linesearch,&lspostfunc,&lspostctx);CHKERRQ(ierr);
25846e2a1849SPeter Brune     ierr = SNESLineSearchSetPreCheck(pclinesearch,lsprefunc,lsprectx);CHKERRQ(ierr);
25856e2a1849SPeter Brune     ierr = SNESLineSearchSetPostCheck(pclinesearch,lspostfunc,lspostctx);CHKERRQ(ierr);
25866e2a1849SPeter Brune     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)linesearch, (PetscObject)pclinesearch);CHKERRQ(ierr);
25876e2a1849SPeter Brune   }
25886e2a1849SPeter Brune 
2589410397dcSLisandro Dalcin   if (snes->ops->setup) {
2590410397dcSLisandro Dalcin     ierr = (*snes->ops->setup)(snes);CHKERRQ(ierr);
2591410397dcSLisandro Dalcin   }
259258c9b817SLisandro Dalcin 
25937aaed0d8SBarry Smith   snes->setupcalled = PETSC_TRUE;
25943a40ed3dSBarry Smith   PetscFunctionReturn(0);
25959b94acceSBarry Smith }
25969b94acceSBarry Smith 
25974a2ae208SSatish Balay #undef __FUNCT__
259837596af1SLisandro Dalcin #define __FUNCT__ "SNESReset"
259937596af1SLisandro Dalcin /*@
260037596af1SLisandro Dalcin    SNESReset - Resets a SNES context to the snessetupcalled = 0 state and removes any allocated Vecs and Mats
260137596af1SLisandro Dalcin 
260237596af1SLisandro Dalcin    Collective on SNES
260337596af1SLisandro Dalcin 
260437596af1SLisandro Dalcin    Input Parameter:
260537596af1SLisandro Dalcin .  snes - iterative context obtained from SNESCreate()
260637596af1SLisandro Dalcin 
2607d25893d9SBarry Smith    Level: intermediate
2608d25893d9SBarry Smith 
2609d25893d9SBarry Smith    Notes: Also calls the application context destroy routine set with SNESSetComputeApplicationContext()
261037596af1SLisandro Dalcin 
261137596af1SLisandro Dalcin .keywords: SNES, destroy
261237596af1SLisandro Dalcin 
261337596af1SLisandro Dalcin .seealso: SNESCreate(), SNESSetUp(), SNESSolve()
261437596af1SLisandro Dalcin @*/
261537596af1SLisandro Dalcin PetscErrorCode  SNESReset(SNES snes)
261637596af1SLisandro Dalcin {
261737596af1SLisandro Dalcin   PetscErrorCode ierr;
261837596af1SLisandro Dalcin 
261937596af1SLisandro Dalcin   PetscFunctionBegin;
262037596af1SLisandro Dalcin   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2621d25893d9SBarry Smith   if (snes->ops->userdestroy && snes->user) {
2622d25893d9SBarry Smith     ierr       = (*snes->ops->userdestroy)((void**)&snes->user);CHKERRQ(ierr);
2623d25893d9SBarry Smith     snes->user = PETSC_NULL;
2624d25893d9SBarry Smith   }
26258a23116dSBarry Smith   if (snes->pc) {
26268a23116dSBarry Smith     ierr = SNESReset(snes->pc);CHKERRQ(ierr);
26278a23116dSBarry Smith   }
26288a23116dSBarry Smith 
262937596af1SLisandro Dalcin   if (snes->ops->reset) {
263037596af1SLisandro Dalcin     ierr = (*snes->ops->reset)(snes);CHKERRQ(ierr);
263137596af1SLisandro Dalcin   }
26329e764e56SPeter Brune   if (snes->ksp) {
26339e764e56SPeter Brune     ierr = KSPReset(snes->ksp);CHKERRQ(ierr);
26349e764e56SPeter Brune   }
26359e764e56SPeter Brune 
26369e764e56SPeter Brune   if (snes->linesearch) {
2637f1c6b773SPeter Brune     ierr = SNESLineSearchReset(snes->linesearch);CHKERRQ(ierr);
26389e764e56SPeter Brune   }
26399e764e56SPeter Brune 
26406bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr);
26416bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr);
26426bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_sol_update);CHKERRQ(ierr);
26436bf464f9SBarry Smith   ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr);
26446bf464f9SBarry Smith   ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr);
26456bf464f9SBarry Smith   ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr);
2646c41d97abSJed Brown   ierr = VecDestroyVecs(snes->nwork,&snes->work);CHKERRQ(ierr);
2647c41d97abSJed Brown   ierr = VecDestroyVecs(snes->nvwork,&snes->vwork);CHKERRQ(ierr);
264837596af1SLisandro Dalcin   snes->nwork = snes->nvwork = 0;
264937596af1SLisandro Dalcin   snes->setupcalled = PETSC_FALSE;
265037596af1SLisandro Dalcin   PetscFunctionReturn(0);
265137596af1SLisandro Dalcin }
265237596af1SLisandro Dalcin 
265337596af1SLisandro Dalcin #undef __FUNCT__
26544a2ae208SSatish Balay #define __FUNCT__ "SNESDestroy"
265552baeb72SSatish Balay /*@
26569b94acceSBarry Smith    SNESDestroy - Destroys the nonlinear solver context that was created
26579b94acceSBarry Smith    with SNESCreate().
26589b94acceSBarry Smith 
2659c7afd0dbSLois Curfman McInnes    Collective on SNES
2660c7afd0dbSLois Curfman McInnes 
26619b94acceSBarry Smith    Input Parameter:
26629b94acceSBarry Smith .  snes - the SNES context
26639b94acceSBarry Smith 
266436851e7fSLois Curfman McInnes    Level: beginner
266536851e7fSLois Curfman McInnes 
26669b94acceSBarry Smith .keywords: SNES, nonlinear, destroy
26679b94acceSBarry Smith 
266863a78c88SLois Curfman McInnes .seealso: SNESCreate(), SNESSolve()
26699b94acceSBarry Smith @*/
26706bf464f9SBarry Smith PetscErrorCode  SNESDestroy(SNES *snes)
26719b94acceSBarry Smith {
26726849ba73SBarry Smith   PetscErrorCode ierr;
26733a40ed3dSBarry Smith 
26743a40ed3dSBarry Smith   PetscFunctionBegin;
26756bf464f9SBarry Smith   if (!*snes) PetscFunctionReturn(0);
26766bf464f9SBarry Smith   PetscValidHeaderSpecific((*snes),SNES_CLASSID,1);
26776bf464f9SBarry Smith   if (--((PetscObject)(*snes))->refct > 0) {*snes = 0; PetscFunctionReturn(0);}
2678d4bb536fSBarry Smith 
26796bf464f9SBarry Smith   ierr = SNESReset((*snes));CHKERRQ(ierr);
26808a23116dSBarry Smith   ierr = SNESDestroy(&(*snes)->pc);CHKERRQ(ierr);
26816b8b9a38SLisandro Dalcin 
2682be0abb6dSBarry Smith   /* if memory was published with AMS then destroy it */
26836bf464f9SBarry Smith   ierr = PetscObjectDepublish((*snes));CHKERRQ(ierr);
26846bf464f9SBarry Smith   if ((*snes)->ops->destroy) {ierr = (*((*snes))->ops->destroy)((*snes));CHKERRQ(ierr);}
26856d4c513bSLisandro Dalcin 
26866bf464f9SBarry Smith   ierr = DMDestroy(&(*snes)->dm);CHKERRQ(ierr);
26876bf464f9SBarry Smith   ierr = KSPDestroy(&(*snes)->ksp);CHKERRQ(ierr);
2688f1c6b773SPeter Brune   ierr = SNESLineSearchDestroy(&(*snes)->linesearch);CHKERRQ(ierr);
26896b8b9a38SLisandro Dalcin 
26906bf464f9SBarry Smith   ierr = PetscFree((*snes)->kspconvctx);CHKERRQ(ierr);
26916bf464f9SBarry Smith   if ((*snes)->ops->convergeddestroy) {
26926bf464f9SBarry Smith     ierr = (*(*snes)->ops->convergeddestroy)((*snes)->cnvP);CHKERRQ(ierr);
26936b8b9a38SLisandro Dalcin   }
26946bf464f9SBarry Smith   if ((*snes)->conv_malloc) {
26956bf464f9SBarry Smith     ierr = PetscFree((*snes)->conv_hist);CHKERRQ(ierr);
26966bf464f9SBarry Smith     ierr = PetscFree((*snes)->conv_hist_its);CHKERRQ(ierr);
269758c9b817SLisandro Dalcin   }
26986bf464f9SBarry Smith   ierr = SNESMonitorCancel((*snes));CHKERRQ(ierr);
2699a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(snes);CHKERRQ(ierr);
27003a40ed3dSBarry Smith  PetscFunctionReturn(0);
27019b94acceSBarry Smith }
27029b94acceSBarry Smith 
27039b94acceSBarry Smith /* ----------- Routines to set solver parameters ---------- */
27049b94acceSBarry Smith 
27054a2ae208SSatish Balay #undef __FUNCT__
2706a8054027SBarry Smith #define __FUNCT__ "SNESSetLagPreconditioner"
2707a8054027SBarry Smith /*@
2708a8054027SBarry Smith    SNESSetLagPreconditioner - Determines when the preconditioner is rebuilt in the nonlinear solve.
2709a8054027SBarry Smith 
27103f9fe445SBarry Smith    Logically Collective on SNES
2711a8054027SBarry Smith 
2712a8054027SBarry Smith    Input Parameters:
2713a8054027SBarry Smith +  snes - the SNES context
2714a8054027SBarry 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
27153b4f5425SBarry Smith          the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that
2716a8054027SBarry Smith 
2717a8054027SBarry Smith    Options Database Keys:
2718a8054027SBarry Smith .    -snes_lag_preconditioner <lag>
2719a8054027SBarry Smith 
2720a8054027SBarry Smith    Notes:
2721a8054027SBarry Smith    The default is 1
2722a8054027SBarry Smith    The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
2723a8054027SBarry Smith    If  -1 is used before the very first nonlinear solve the preconditioner is still built because there is no previous preconditioner to use
2724a8054027SBarry Smith 
2725a8054027SBarry Smith    Level: intermediate
2726a8054027SBarry Smith 
2727a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
2728a8054027SBarry Smith 
2729e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian()
2730a8054027SBarry Smith 
2731a8054027SBarry Smith @*/
27327087cfbeSBarry Smith PetscErrorCode  SNESSetLagPreconditioner(SNES snes,PetscInt lag)
2733a8054027SBarry Smith {
2734a8054027SBarry Smith   PetscFunctionBegin;
27350700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2736e32f2f54SBarry Smith   if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater");
2737e32f2f54SBarry Smith   if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0");
2738c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,lag,2);
2739a8054027SBarry Smith   snes->lagpreconditioner = lag;
2740a8054027SBarry Smith   PetscFunctionReturn(0);
2741a8054027SBarry Smith }
2742a8054027SBarry Smith 
2743a8054027SBarry Smith #undef __FUNCT__
2744efd51863SBarry Smith #define __FUNCT__ "SNESSetGridSequence"
2745efd51863SBarry Smith /*@
2746efd51863SBarry Smith    SNESSetGridSequence - sets the number of steps of grid sequencing that SNES does
2747efd51863SBarry Smith 
2748efd51863SBarry Smith    Logically Collective on SNES
2749efd51863SBarry Smith 
2750efd51863SBarry Smith    Input Parameters:
2751efd51863SBarry Smith +  snes - the SNES context
2752efd51863SBarry Smith -  steps - the number of refinements to do, defaults to 0
2753efd51863SBarry Smith 
2754efd51863SBarry Smith    Options Database Keys:
2755efd51863SBarry Smith .    -snes_grid_sequence <steps>
2756efd51863SBarry Smith 
2757efd51863SBarry Smith    Level: intermediate
2758efd51863SBarry Smith 
2759c0df2a02SJed Brown    Notes:
2760c0df2a02SJed Brown    Use SNESGetSolution() to extract the fine grid solution after grid sequencing.
2761c0df2a02SJed Brown 
2762efd51863SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
2763efd51863SBarry Smith 
2764efd51863SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian()
2765efd51863SBarry Smith 
2766efd51863SBarry Smith @*/
2767efd51863SBarry Smith PetscErrorCode  SNESSetGridSequence(SNES snes,PetscInt steps)
2768efd51863SBarry Smith {
2769efd51863SBarry Smith   PetscFunctionBegin;
2770efd51863SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2771efd51863SBarry Smith   PetscValidLogicalCollectiveInt(snes,steps,2);
2772efd51863SBarry Smith   snes->gridsequence = steps;
2773efd51863SBarry Smith   PetscFunctionReturn(0);
2774efd51863SBarry Smith }
2775efd51863SBarry Smith 
2776efd51863SBarry Smith #undef __FUNCT__
2777a8054027SBarry Smith #define __FUNCT__ "SNESGetLagPreconditioner"
2778a8054027SBarry Smith /*@
2779a8054027SBarry Smith    SNESGetLagPreconditioner - Indicates how often the preconditioner is rebuilt
2780a8054027SBarry Smith 
27813f9fe445SBarry Smith    Not Collective
2782a8054027SBarry Smith 
2783a8054027SBarry Smith    Input Parameter:
2784a8054027SBarry Smith .  snes - the SNES context
2785a8054027SBarry Smith 
2786a8054027SBarry Smith    Output Parameter:
2787a8054027SBarry 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
27883b4f5425SBarry Smith          the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that
2789a8054027SBarry Smith 
2790a8054027SBarry Smith    Options Database Keys:
2791a8054027SBarry Smith .    -snes_lag_preconditioner <lag>
2792a8054027SBarry Smith 
2793a8054027SBarry Smith    Notes:
2794a8054027SBarry Smith    The default is 1
2795a8054027SBarry Smith    The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
2796a8054027SBarry Smith 
2797a8054027SBarry Smith    Level: intermediate
2798a8054027SBarry Smith 
2799a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
2800a8054027SBarry Smith 
2801a8054027SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagPreconditioner()
2802a8054027SBarry Smith 
2803a8054027SBarry Smith @*/
28047087cfbeSBarry Smith PetscErrorCode  SNESGetLagPreconditioner(SNES snes,PetscInt *lag)
2805a8054027SBarry Smith {
2806a8054027SBarry Smith   PetscFunctionBegin;
28070700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2808a8054027SBarry Smith   *lag = snes->lagpreconditioner;
2809a8054027SBarry Smith   PetscFunctionReturn(0);
2810a8054027SBarry Smith }
2811a8054027SBarry Smith 
2812a8054027SBarry Smith #undef __FUNCT__
2813e35cf81dSBarry Smith #define __FUNCT__ "SNESSetLagJacobian"
2814e35cf81dSBarry Smith /*@
2815e35cf81dSBarry Smith    SNESSetLagJacobian - Determines when the Jacobian is rebuilt in the nonlinear solve. See SNESSetLagPreconditioner() for determining how
2816e35cf81dSBarry Smith      often the preconditioner is rebuilt.
2817e35cf81dSBarry Smith 
28183f9fe445SBarry Smith    Logically Collective on SNES
2819e35cf81dSBarry Smith 
2820e35cf81dSBarry Smith    Input Parameters:
2821e35cf81dSBarry Smith +  snes - the SNES context
2822e35cf81dSBarry 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
2823fe3ffe1eSBarry Smith          the Jacobian is built etc. -2 means rebuild at next chance but then never again
2824e35cf81dSBarry Smith 
2825e35cf81dSBarry Smith    Options Database Keys:
2826e35cf81dSBarry Smith .    -snes_lag_jacobian <lag>
2827e35cf81dSBarry Smith 
2828e35cf81dSBarry Smith    Notes:
2829e35cf81dSBarry Smith    The default is 1
2830e35cf81dSBarry Smith    The Jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
2831fe3ffe1eSBarry 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
2832fe3ffe1eSBarry Smith    at the next Newton step but never again (unless it is reset to another value)
2833e35cf81dSBarry Smith 
2834e35cf81dSBarry Smith    Level: intermediate
2835e35cf81dSBarry Smith 
2836e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
2837e35cf81dSBarry Smith 
2838e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagPreconditioner(), SNESGetLagJacobian()
2839e35cf81dSBarry Smith 
2840e35cf81dSBarry Smith @*/
28417087cfbeSBarry Smith PetscErrorCode  SNESSetLagJacobian(SNES snes,PetscInt lag)
2842e35cf81dSBarry Smith {
2843e35cf81dSBarry Smith   PetscFunctionBegin;
28440700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2845e32f2f54SBarry Smith   if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater");
2846e32f2f54SBarry Smith   if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0");
2847c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,lag,2);
2848e35cf81dSBarry Smith   snes->lagjacobian = lag;
2849e35cf81dSBarry Smith   PetscFunctionReturn(0);
2850e35cf81dSBarry Smith }
2851e35cf81dSBarry Smith 
2852e35cf81dSBarry Smith #undef __FUNCT__
2853e35cf81dSBarry Smith #define __FUNCT__ "SNESGetLagJacobian"
2854e35cf81dSBarry Smith /*@
2855e35cf81dSBarry Smith    SNESGetLagJacobian - Indicates how often the Jacobian is rebuilt. See SNESGetLagPreconditioner() to determine when the preconditioner is rebuilt
2856e35cf81dSBarry Smith 
28573f9fe445SBarry Smith    Not Collective
2858e35cf81dSBarry Smith 
2859e35cf81dSBarry Smith    Input Parameter:
2860e35cf81dSBarry Smith .  snes - the SNES context
2861e35cf81dSBarry Smith 
2862e35cf81dSBarry Smith    Output Parameter:
2863e35cf81dSBarry 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
2864e35cf81dSBarry Smith          the Jacobian is built etc.
2865e35cf81dSBarry Smith 
2866e35cf81dSBarry Smith    Options Database Keys:
2867e35cf81dSBarry Smith .    -snes_lag_jacobian <lag>
2868e35cf81dSBarry Smith 
2869e35cf81dSBarry Smith    Notes:
2870e35cf81dSBarry Smith    The default is 1
2871e35cf81dSBarry Smith    The jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1
2872e35cf81dSBarry Smith 
2873e35cf81dSBarry Smith    Level: intermediate
2874e35cf81dSBarry Smith 
2875e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances
2876e35cf81dSBarry Smith 
2877e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagJacobian(), SNESSetLagPreconditioner(), SNESGetLagPreconditioner()
2878e35cf81dSBarry Smith 
2879e35cf81dSBarry Smith @*/
28807087cfbeSBarry Smith PetscErrorCode  SNESGetLagJacobian(SNES snes,PetscInt *lag)
2881e35cf81dSBarry Smith {
2882e35cf81dSBarry Smith   PetscFunctionBegin;
28830700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2884e35cf81dSBarry Smith   *lag = snes->lagjacobian;
2885e35cf81dSBarry Smith   PetscFunctionReturn(0);
2886e35cf81dSBarry Smith }
2887e35cf81dSBarry Smith 
2888e35cf81dSBarry Smith #undef __FUNCT__
28894a2ae208SSatish Balay #define __FUNCT__ "SNESSetTolerances"
28909b94acceSBarry Smith /*@
2891d7a720efSLois Curfman McInnes    SNESSetTolerances - Sets various parameters used in convergence tests.
28929b94acceSBarry Smith 
28933f9fe445SBarry Smith    Logically Collective on SNES
2894c7afd0dbSLois Curfman McInnes 
28959b94acceSBarry Smith    Input Parameters:
2896c7afd0dbSLois Curfman McInnes +  snes - the SNES context
289770441072SBarry Smith .  abstol - absolute convergence tolerance
289833174efeSLois Curfman McInnes .  rtol - relative convergence tolerance
289933174efeSLois Curfman McInnes .  stol -  convergence tolerance in terms of the norm
290033174efeSLois Curfman McInnes            of the change in the solution between steps
290133174efeSLois Curfman McInnes .  maxit - maximum number of iterations
2902c7afd0dbSLois Curfman McInnes -  maxf - maximum number of function evaluations
2903fee21e36SBarry Smith 
290433174efeSLois Curfman McInnes    Options Database Keys:
290570441072SBarry Smith +    -snes_atol <abstol> - Sets abstol
2906c7afd0dbSLois Curfman McInnes .    -snes_rtol <rtol> - Sets rtol
2907c7afd0dbSLois Curfman McInnes .    -snes_stol <stol> - Sets stol
2908c7afd0dbSLois Curfman McInnes .    -snes_max_it <maxit> - Sets maxit
2909c7afd0dbSLois Curfman McInnes -    -snes_max_funcs <maxf> - Sets maxf
29109b94acceSBarry Smith 
2911d7a720efSLois Curfman McInnes    Notes:
29129b94acceSBarry Smith    The default maximum number of iterations is 50.
29139b94acceSBarry Smith    The default maximum number of function evaluations is 1000.
29149b94acceSBarry Smith 
291536851e7fSLois Curfman McInnes    Level: intermediate
291636851e7fSLois Curfman McInnes 
291733174efeSLois Curfman McInnes .keywords: SNES, nonlinear, set, convergence, tolerances
29189b94acceSBarry Smith 
29192492ecdbSBarry Smith .seealso: SNESSetTrustRegionTolerance()
29209b94acceSBarry Smith @*/
29217087cfbeSBarry Smith PetscErrorCode  SNESSetTolerances(SNES snes,PetscReal abstol,PetscReal rtol,PetscReal stol,PetscInt maxit,PetscInt maxf)
29229b94acceSBarry Smith {
29233a40ed3dSBarry Smith   PetscFunctionBegin;
29240700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
2925c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,abstol,2);
2926c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol,3);
2927c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,stol,4);
2928c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxit,5);
2929c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,maxf,6);
2930c5eb9154SBarry Smith 
2931ab54825eSJed Brown   if (abstol != PETSC_DEFAULT) {
2932ab54825eSJed Brown     if (abstol < 0.0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Absolute tolerance %G must be non-negative",abstol);
2933ab54825eSJed Brown     snes->abstol = abstol;
2934ab54825eSJed Brown   }
2935ab54825eSJed Brown   if (rtol != PETSC_DEFAULT) {
2936ab54825eSJed 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);
2937ab54825eSJed Brown     snes->rtol = rtol;
2938ab54825eSJed Brown   }
2939ab54825eSJed Brown   if (stol != PETSC_DEFAULT) {
2940ab54825eSJed Brown     if (stol < 0.0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Step tolerance %G must be non-negative",stol);
2941c60f73f4SPeter Brune     snes->stol = stol;
2942ab54825eSJed Brown   }
2943ab54825eSJed Brown   if (maxit != PETSC_DEFAULT) {
2944ab54825eSJed Brown     if (maxit < 0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of iterations %D must be non-negative",maxit);
2945ab54825eSJed Brown     snes->max_its = maxit;
2946ab54825eSJed Brown   }
2947ab54825eSJed Brown   if (maxf != PETSC_DEFAULT) {
2948ab54825eSJed Brown     if (maxf < 0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of function evaluations %D must be non-negative",maxf);
2949ab54825eSJed Brown     snes->max_funcs = maxf;
2950ab54825eSJed Brown   }
295188976e71SPeter Brune   snes->tolerancesset = PETSC_TRUE;
29523a40ed3dSBarry Smith   PetscFunctionReturn(0);
29539b94acceSBarry Smith }
29549b94acceSBarry Smith 
29554a2ae208SSatish Balay #undef __FUNCT__
29564a2ae208SSatish Balay #define __FUNCT__ "SNESGetTolerances"
29579b94acceSBarry Smith /*@
295833174efeSLois Curfman McInnes    SNESGetTolerances - Gets various parameters used in convergence tests.
295933174efeSLois Curfman McInnes 
2960c7afd0dbSLois Curfman McInnes    Not Collective
2961c7afd0dbSLois Curfman McInnes 
296233174efeSLois Curfman McInnes    Input Parameters:
2963c7afd0dbSLois Curfman McInnes +  snes - the SNES context
296485385478SLisandro Dalcin .  atol - absolute convergence tolerance
296533174efeSLois Curfman McInnes .  rtol - relative convergence tolerance
296633174efeSLois Curfman McInnes .  stol -  convergence tolerance in terms of the norm
296733174efeSLois Curfman McInnes            of the change in the solution between steps
296833174efeSLois Curfman McInnes .  maxit - maximum number of iterations
2969c7afd0dbSLois Curfman McInnes -  maxf - maximum number of function evaluations
2970fee21e36SBarry Smith 
297133174efeSLois Curfman McInnes    Notes:
297233174efeSLois Curfman McInnes    The user can specify PETSC_NULL for any parameter that is not needed.
297333174efeSLois Curfman McInnes 
297436851e7fSLois Curfman McInnes    Level: intermediate
297536851e7fSLois Curfman McInnes 
297633174efeSLois Curfman McInnes .keywords: SNES, nonlinear, get, convergence, tolerances
297733174efeSLois Curfman McInnes 
297833174efeSLois Curfman McInnes .seealso: SNESSetTolerances()
297933174efeSLois Curfman McInnes @*/
29807087cfbeSBarry Smith PetscErrorCode  SNESGetTolerances(SNES snes,PetscReal *atol,PetscReal *rtol,PetscReal *stol,PetscInt *maxit,PetscInt *maxf)
298133174efeSLois Curfman McInnes {
29823a40ed3dSBarry Smith   PetscFunctionBegin;
29830700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
298485385478SLisandro Dalcin   if (atol)  *atol  = snes->abstol;
298533174efeSLois Curfman McInnes   if (rtol)  *rtol  = snes->rtol;
2986c60f73f4SPeter Brune   if (stol)  *stol  = snes->stol;
298733174efeSLois Curfman McInnes   if (maxit) *maxit = snes->max_its;
298833174efeSLois Curfman McInnes   if (maxf)  *maxf  = snes->max_funcs;
29893a40ed3dSBarry Smith   PetscFunctionReturn(0);
299033174efeSLois Curfman McInnes }
299133174efeSLois Curfman McInnes 
29924a2ae208SSatish Balay #undef __FUNCT__
29934a2ae208SSatish Balay #define __FUNCT__ "SNESSetTrustRegionTolerance"
299433174efeSLois Curfman McInnes /*@
29959b94acceSBarry Smith    SNESSetTrustRegionTolerance - Sets the trust region parameter tolerance.
29969b94acceSBarry Smith 
29973f9fe445SBarry Smith    Logically Collective on SNES
2998fee21e36SBarry Smith 
2999c7afd0dbSLois Curfman McInnes    Input Parameters:
3000c7afd0dbSLois Curfman McInnes +  snes - the SNES context
3001c7afd0dbSLois Curfman McInnes -  tol - tolerance
3002c7afd0dbSLois Curfman McInnes 
30039b94acceSBarry Smith    Options Database Key:
3004c7afd0dbSLois Curfman McInnes .  -snes_trtol <tol> - Sets tol
30059b94acceSBarry Smith 
300636851e7fSLois Curfman McInnes    Level: intermediate
300736851e7fSLois Curfman McInnes 
30089b94acceSBarry Smith .keywords: SNES, nonlinear, set, trust region, tolerance
30099b94acceSBarry Smith 
30102492ecdbSBarry Smith .seealso: SNESSetTolerances()
30119b94acceSBarry Smith @*/
30127087cfbeSBarry Smith PetscErrorCode  SNESSetTrustRegionTolerance(SNES snes,PetscReal tol)
30139b94acceSBarry Smith {
30143a40ed3dSBarry Smith   PetscFunctionBegin;
30150700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3016c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,tol,2);
30179b94acceSBarry Smith   snes->deltatol = tol;
30183a40ed3dSBarry Smith   PetscFunctionReturn(0);
30199b94acceSBarry Smith }
30209b94acceSBarry Smith 
3021df9fa365SBarry Smith /*
3022df9fa365SBarry Smith    Duplicate the lg monitors for SNES from KSP; for some reason with
3023df9fa365SBarry Smith    dynamic libraries things don't work under Sun4 if we just use
3024df9fa365SBarry Smith    macros instead of functions
3025df9fa365SBarry Smith */
30264a2ae208SSatish Balay #undef __FUNCT__
30274619e776SBarry Smith #define __FUNCT__ "SNESMonitorLGResidualNorm"
30284619e776SBarry Smith PetscErrorCode  SNESMonitorLGResidualNorm(SNES snes,PetscInt it,PetscReal norm,void *ctx)
3029ce1608b8SBarry Smith {
3030dfbe8321SBarry Smith   PetscErrorCode ierr;
3031ce1608b8SBarry Smith 
3032ce1608b8SBarry Smith   PetscFunctionBegin;
30330700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
30341d1e9da1SBarry Smith   ierr = KSPMonitorLGResidualNorm((KSP)snes,it,norm,ctx);CHKERRQ(ierr);
3035ce1608b8SBarry Smith   PetscFunctionReturn(0);
3036ce1608b8SBarry Smith }
3037ce1608b8SBarry Smith 
30384a2ae208SSatish Balay #undef __FUNCT__
3039a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGCreate"
30407087cfbeSBarry Smith PetscErrorCode  SNESMonitorLGCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw)
3041df9fa365SBarry Smith {
3042dfbe8321SBarry Smith   PetscErrorCode ierr;
3043df9fa365SBarry Smith 
3044df9fa365SBarry Smith   PetscFunctionBegin;
30451d1e9da1SBarry Smith   ierr = KSPMonitorLGResidualNormCreate(host,label,x,y,m,n,draw);CHKERRQ(ierr);
3046df9fa365SBarry Smith   PetscFunctionReturn(0);
3047df9fa365SBarry Smith }
3048df9fa365SBarry Smith 
30494a2ae208SSatish Balay #undef __FUNCT__
3050a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGDestroy"
30516bf464f9SBarry Smith PetscErrorCode  SNESMonitorLGDestroy(PetscDrawLG *draw)
3052df9fa365SBarry Smith {
3053dfbe8321SBarry Smith   PetscErrorCode ierr;
3054df9fa365SBarry Smith 
3055df9fa365SBarry Smith   PetscFunctionBegin;
30561d1e9da1SBarry Smith   ierr = KSPMonitorLGResidualNormDestroy(draw);CHKERRQ(ierr);
3057df9fa365SBarry Smith   PetscFunctionReturn(0);
3058df9fa365SBarry Smith }
3059df9fa365SBarry Smith 
30607087cfbeSBarry Smith extern PetscErrorCode  SNESMonitorRange_Private(SNES,PetscInt,PetscReal*);
3061b271bb04SBarry Smith #undef __FUNCT__
3062b271bb04SBarry Smith #define __FUNCT__ "SNESMonitorLGRange"
30637087cfbeSBarry Smith PetscErrorCode  SNESMonitorLGRange(SNES snes,PetscInt n,PetscReal rnorm,void *monctx)
3064b271bb04SBarry Smith {
3065b271bb04SBarry Smith   PetscDrawLG      lg;
3066b271bb04SBarry Smith   PetscErrorCode   ierr;
3067b271bb04SBarry Smith   PetscReal        x,y,per;
3068b271bb04SBarry Smith   PetscViewer      v = (PetscViewer)monctx;
3069b271bb04SBarry Smith   static PetscReal prev; /* should be in the context */
3070b271bb04SBarry Smith   PetscDraw        draw;
3071b271bb04SBarry Smith 
3072459f5d12SBarry Smith   PetscFunctionBegin;
3073b271bb04SBarry Smith   ierr   = PetscViewerDrawGetDrawLG(v,0,&lg);CHKERRQ(ierr);
3074b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
3075b271bb04SBarry Smith   ierr   = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
3076b271bb04SBarry Smith   ierr   = PetscDrawSetTitle(draw,"Residual norm");CHKERRQ(ierr);
3077b271bb04SBarry Smith   x = (PetscReal) n;
3078b271bb04SBarry Smith   if (rnorm > 0.0) y = log10(rnorm); else y = -15.0;
3079b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
3080b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
3081b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
3082b271bb04SBarry Smith   }
3083b271bb04SBarry Smith 
3084b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,1,&lg);CHKERRQ(ierr);
3085b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
3086b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
3087b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"% elemts > .2*max elemt");CHKERRQ(ierr);
3088b271bb04SBarry Smith   ierr =  SNESMonitorRange_Private(snes,n,&per);CHKERRQ(ierr);
3089b271bb04SBarry Smith   x = (PetscReal) n;
3090b271bb04SBarry Smith   y = 100.0*per;
3091b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
3092b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
3093b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
3094b271bb04SBarry Smith   }
3095b271bb04SBarry Smith 
3096b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,2,&lg);CHKERRQ(ierr);
3097b271bb04SBarry Smith   if (!n) {prev = rnorm;ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
3098b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
3099b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm");CHKERRQ(ierr);
3100b271bb04SBarry Smith   x = (PetscReal) n;
3101b271bb04SBarry Smith   y = (prev - rnorm)/prev;
3102b271bb04SBarry Smith   ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
3103b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
3104b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
3105b271bb04SBarry Smith   }
3106b271bb04SBarry Smith 
3107b271bb04SBarry Smith   ierr = PetscViewerDrawGetDrawLG(v,3,&lg);CHKERRQ(ierr);
3108b271bb04SBarry Smith   if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);}
3109b271bb04SBarry Smith   ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr);
3110b271bb04SBarry Smith   ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm*(% > .2 max)");CHKERRQ(ierr);
3111b271bb04SBarry Smith   x = (PetscReal) n;
3112b271bb04SBarry Smith   y = (prev - rnorm)/(prev*per);
3113b271bb04SBarry Smith   if (n > 2) { /*skip initial crazy value */
3114b271bb04SBarry Smith     ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr);
3115b271bb04SBarry Smith   }
3116b271bb04SBarry Smith   if (n < 20 || !(n % 5)) {
3117b271bb04SBarry Smith     ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr);
3118b271bb04SBarry Smith   }
3119b271bb04SBarry Smith   prev = rnorm;
3120b271bb04SBarry Smith   PetscFunctionReturn(0);
3121b271bb04SBarry Smith }
3122b271bb04SBarry Smith 
3123b271bb04SBarry Smith #undef __FUNCT__
31247a03ce2fSLisandro Dalcin #define __FUNCT__ "SNESMonitor"
3125228d79bcSJed Brown /*@
3126228d79bcSJed Brown    SNESMonitor - runs the user provided monitor routines, if they exist
3127228d79bcSJed Brown 
3128228d79bcSJed Brown    Collective on SNES
3129228d79bcSJed Brown 
3130228d79bcSJed Brown    Input Parameters:
3131228d79bcSJed Brown +  snes - nonlinear solver context obtained from SNESCreate()
3132228d79bcSJed Brown .  iter - iteration number
3133228d79bcSJed Brown -  rnorm - relative norm of the residual
3134228d79bcSJed Brown 
3135228d79bcSJed Brown    Notes:
3136228d79bcSJed Brown    This routine is called by the SNES implementations.
3137228d79bcSJed Brown    It does not typically need to be called by the user.
3138228d79bcSJed Brown 
3139228d79bcSJed Brown    Level: developer
3140228d79bcSJed Brown 
3141228d79bcSJed Brown .seealso: SNESMonitorSet()
3142228d79bcSJed Brown @*/
31437a03ce2fSLisandro Dalcin PetscErrorCode  SNESMonitor(SNES snes,PetscInt iter,PetscReal rnorm)
31447a03ce2fSLisandro Dalcin {
31457a03ce2fSLisandro Dalcin   PetscErrorCode ierr;
31467a03ce2fSLisandro Dalcin   PetscInt       i,n = snes->numbermonitors;
31477a03ce2fSLisandro Dalcin 
31487a03ce2fSLisandro Dalcin   PetscFunctionBegin;
31497a03ce2fSLisandro Dalcin   for (i=0; i<n; i++) {
31507a03ce2fSLisandro Dalcin     ierr = (*snes->monitor[i])(snes,iter,rnorm,snes->monitorcontext[i]);CHKERRQ(ierr);
31517a03ce2fSLisandro Dalcin   }
31527a03ce2fSLisandro Dalcin   PetscFunctionReturn(0);
31537a03ce2fSLisandro Dalcin }
31547a03ce2fSLisandro Dalcin 
31559b94acceSBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
31569b94acceSBarry Smith 
31574a2ae208SSatish Balay #undef __FUNCT__
3158a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorSet"
31599b94acceSBarry Smith /*@C
3160a6570f20SBarry Smith    SNESMonitorSet - Sets an ADDITIONAL function that is to be used at every
31619b94acceSBarry Smith    iteration of the nonlinear solver to display the iteration's
31629b94acceSBarry Smith    progress.
31639b94acceSBarry Smith 
31643f9fe445SBarry Smith    Logically Collective on SNES
3165fee21e36SBarry Smith 
3166c7afd0dbSLois Curfman McInnes    Input Parameters:
3167c7afd0dbSLois Curfman McInnes +  snes - the SNES context
3168c7afd0dbSLois Curfman McInnes .  func - monitoring routine
3169b8a78c4aSBarry Smith .  mctx - [optional] user-defined context for private data for the
3170e8105e01SRichard Katz           monitor routine (use PETSC_NULL if no context is desired)
3171b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
3172b3006f0bSLois Curfman McInnes           (may be PETSC_NULL)
31739b94acceSBarry Smith 
3174c7afd0dbSLois Curfman McInnes    Calling sequence of func:
3175a7cc72afSBarry Smith $     int func(SNES snes,PetscInt its, PetscReal norm,void *mctx)
3176c7afd0dbSLois Curfman McInnes 
3177c7afd0dbSLois Curfman McInnes +    snes - the SNES context
3178c7afd0dbSLois Curfman McInnes .    its - iteration number
3179c7afd0dbSLois Curfman McInnes .    norm - 2-norm function value (may be estimated)
318040a0c1c6SLois Curfman McInnes -    mctx - [optional] monitoring context
31819b94acceSBarry Smith 
31829665c990SLois Curfman McInnes    Options Database Keys:
3183a6570f20SBarry Smith +    -snes_monitor        - sets SNESMonitorDefault()
31844619e776SBarry Smith .    -snes_monitor_lg_residualnorm    - sets line graph monitor,
3185a6570f20SBarry Smith                             uses SNESMonitorLGCreate()
3186cca6129bSJed Brown -    -snes_monitor_cancel - cancels all monitors that have
3187c7afd0dbSLois Curfman McInnes                             been hardwired into a code by
3188a6570f20SBarry Smith                             calls to SNESMonitorSet(), but
3189c7afd0dbSLois Curfman McInnes                             does not cancel those set via
3190c7afd0dbSLois Curfman McInnes                             the options database.
31919665c990SLois Curfman McInnes 
3192639f9d9dSBarry Smith    Notes:
31936bc08f3fSLois Curfman McInnes    Several different monitoring routines may be set by calling
3194a6570f20SBarry Smith    SNESMonitorSet() multiple times; all will be called in the
31956bc08f3fSLois Curfman McInnes    order in which they were set.
3196639f9d9dSBarry Smith 
3197025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each SNES object
3198025f1a04SBarry Smith 
319936851e7fSLois Curfman McInnes    Level: intermediate
320036851e7fSLois Curfman McInnes 
32019b94acceSBarry Smith .keywords: SNES, nonlinear, set, monitor
32029b94acceSBarry Smith 
3203a6570f20SBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorCancel()
32049b94acceSBarry Smith @*/
3205c2efdce3SBarry Smith PetscErrorCode  SNESMonitorSet(SNES snes,PetscErrorCode (*monitor)(SNES,PetscInt,PetscReal,void*),void *mctx,PetscErrorCode (*monitordestroy)(void**))
32069b94acceSBarry Smith {
3207b90d0a6eSBarry Smith   PetscInt       i;
3208649052a6SBarry Smith   PetscErrorCode ierr;
3209b90d0a6eSBarry Smith 
32103a40ed3dSBarry Smith   PetscFunctionBegin;
32110700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
321217186662SBarry Smith   if (snes->numbermonitors >= MAXSNESMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3213b90d0a6eSBarry Smith   for (i=0; i<snes->numbermonitors;i++) {
3214649052a6SBarry Smith     if (monitor == snes->monitor[i] && monitordestroy == snes->monitordestroy[i] && mctx == snes->monitorcontext[i]) {
3215649052a6SBarry Smith       if (monitordestroy) {
3216c2efdce3SBarry Smith         ierr = (*monitordestroy)(&mctx);CHKERRQ(ierr);
3217649052a6SBarry Smith       }
3218b90d0a6eSBarry Smith       PetscFunctionReturn(0);
3219b90d0a6eSBarry Smith     }
3220b90d0a6eSBarry Smith   }
3221b90d0a6eSBarry Smith   snes->monitor[snes->numbermonitors]           = monitor;
3222b8a78c4aSBarry Smith   snes->monitordestroy[snes->numbermonitors]    = monitordestroy;
3223639f9d9dSBarry Smith   snes->monitorcontext[snes->numbermonitors++]  = (void*)mctx;
32243a40ed3dSBarry Smith   PetscFunctionReturn(0);
32259b94acceSBarry Smith }
32269b94acceSBarry Smith 
32274a2ae208SSatish Balay #undef __FUNCT__
3228a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorCancel"
32295cd90555SBarry Smith /*@C
3230a6570f20SBarry Smith    SNESMonitorCancel - Clears all the monitor functions for a SNES object.
32315cd90555SBarry Smith 
32323f9fe445SBarry Smith    Logically Collective on SNES
3233c7afd0dbSLois Curfman McInnes 
32345cd90555SBarry Smith    Input Parameters:
32355cd90555SBarry Smith .  snes - the SNES context
32365cd90555SBarry Smith 
32371a480d89SAdministrator    Options Database Key:
3238a6570f20SBarry Smith .  -snes_monitor_cancel - cancels all monitors that have been hardwired
3239a6570f20SBarry Smith     into a code by calls to SNESMonitorSet(), but does not cancel those
3240c7afd0dbSLois Curfman McInnes     set via the options database
32415cd90555SBarry Smith 
32425cd90555SBarry Smith    Notes:
32435cd90555SBarry Smith    There is no way to clear one specific monitor from a SNES object.
32445cd90555SBarry Smith 
324536851e7fSLois Curfman McInnes    Level: intermediate
324636851e7fSLois Curfman McInnes 
32475cd90555SBarry Smith .keywords: SNES, nonlinear, set, monitor
32485cd90555SBarry Smith 
3249a6570f20SBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorSet()
32505cd90555SBarry Smith @*/
32517087cfbeSBarry Smith PetscErrorCode  SNESMonitorCancel(SNES snes)
32525cd90555SBarry Smith {
3253d952e501SBarry Smith   PetscErrorCode ierr;
3254d952e501SBarry Smith   PetscInt       i;
3255d952e501SBarry Smith 
32565cd90555SBarry Smith   PetscFunctionBegin;
32570700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3258d952e501SBarry Smith   for (i=0; i<snes->numbermonitors; i++) {
3259d952e501SBarry Smith     if (snes->monitordestroy[i]) {
32603c4aec1bSBarry Smith       ierr = (*snes->monitordestroy[i])(&snes->monitorcontext[i]);CHKERRQ(ierr);
3261d952e501SBarry Smith     }
3262d952e501SBarry Smith   }
32635cd90555SBarry Smith   snes->numbermonitors = 0;
32645cd90555SBarry Smith   PetscFunctionReturn(0);
32655cd90555SBarry Smith }
32665cd90555SBarry Smith 
32674a2ae208SSatish Balay #undef __FUNCT__
32684a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceTest"
32699b94acceSBarry Smith /*@C
32709b94acceSBarry Smith    SNESSetConvergenceTest - Sets the function that is to be used
32719b94acceSBarry Smith    to test for convergence of the nonlinear iterative solution.
32729b94acceSBarry Smith 
32733f9fe445SBarry Smith    Logically Collective on SNES
3274fee21e36SBarry Smith 
3275c7afd0dbSLois Curfman McInnes    Input Parameters:
3276c7afd0dbSLois Curfman McInnes +  snes - the SNES context
3277c7afd0dbSLois Curfman McInnes .  func - routine to test for convergence
32787f7931b9SBarry Smith .  cctx - [optional] context for private data for the convergence routine  (may be PETSC_NULL)
32797f7931b9SBarry Smith -  destroy - [optional] destructor for the context (may be PETSC_NULL; PETSC_NULL_FUNCTION in Fortran)
32809b94acceSBarry Smith 
3281c7afd0dbSLois Curfman McInnes    Calling sequence of func:
328206ee9f85SBarry Smith $     PetscErrorCode func (SNES snes,PetscInt it,PetscReal xnorm,PetscReal gnorm,PetscReal f,SNESConvergedReason *reason,void *cctx)
3283c7afd0dbSLois Curfman McInnes 
3284c7afd0dbSLois Curfman McInnes +    snes - the SNES context
328506ee9f85SBarry Smith .    it - current iteration (0 is the first and is before any Newton step)
3286c7afd0dbSLois Curfman McInnes .    cctx - [optional] convergence context
3287184914b5SBarry Smith .    reason - reason for convergence/divergence
3288c7afd0dbSLois Curfman McInnes .    xnorm - 2-norm of current iterate
32894b27c08aSLois Curfman McInnes .    gnorm - 2-norm of current step
32904b27c08aSLois Curfman McInnes -    f - 2-norm of function
32919b94acceSBarry Smith 
329236851e7fSLois Curfman McInnes    Level: advanced
329336851e7fSLois Curfman McInnes 
32949b94acceSBarry Smith .keywords: SNES, nonlinear, set, convergence, test
32959b94acceSBarry Smith 
329685385478SLisandro Dalcin .seealso: SNESDefaultConverged(), SNESSkipConverged()
32979b94acceSBarry Smith @*/
32987087cfbeSBarry Smith PetscErrorCode  SNESSetConvergenceTest(SNES snes,PetscErrorCode (*func)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void *cctx,PetscErrorCode (*destroy)(void*))
32999b94acceSBarry Smith {
33007f7931b9SBarry Smith   PetscErrorCode ierr;
33017f7931b9SBarry Smith 
33023a40ed3dSBarry Smith   PetscFunctionBegin;
33030700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
330485385478SLisandro Dalcin   if (!func) func = SNESSkipConverged;
33057f7931b9SBarry Smith   if (snes->ops->convergeddestroy) {
33067f7931b9SBarry Smith     ierr = (*snes->ops->convergeddestroy)(snes->cnvP);CHKERRQ(ierr);
33077f7931b9SBarry Smith   }
330885385478SLisandro Dalcin   snes->ops->converged        = func;
33097f7931b9SBarry Smith   snes->ops->convergeddestroy = destroy;
331085385478SLisandro Dalcin   snes->cnvP                  = cctx;
33113a40ed3dSBarry Smith   PetscFunctionReturn(0);
33129b94acceSBarry Smith }
33139b94acceSBarry Smith 
33144a2ae208SSatish Balay #undef __FUNCT__
33154a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergedReason"
331652baeb72SSatish Balay /*@
3317184914b5SBarry Smith    SNESGetConvergedReason - Gets the reason the SNES iteration was stopped.
3318184914b5SBarry Smith 
3319184914b5SBarry Smith    Not Collective
3320184914b5SBarry Smith 
3321184914b5SBarry Smith    Input Parameter:
3322184914b5SBarry Smith .  snes - the SNES context
3323184914b5SBarry Smith 
3324184914b5SBarry Smith    Output Parameter:
33254d0a8057SBarry Smith .  reason - negative value indicates diverged, positive value converged, see SNESConvergedReason or the
3326184914b5SBarry Smith             manual pages for the individual convergence tests for complete lists
3327184914b5SBarry Smith 
3328184914b5SBarry Smith    Level: intermediate
3329184914b5SBarry Smith 
3330184914b5SBarry Smith    Notes: Can only be called after the call the SNESSolve() is complete.
3331184914b5SBarry Smith 
3332184914b5SBarry Smith .keywords: SNES, nonlinear, set, convergence, test
3333184914b5SBarry Smith 
333485385478SLisandro Dalcin .seealso: SNESSetConvergenceTest(), SNESConvergedReason
3335184914b5SBarry Smith @*/
33367087cfbeSBarry Smith PetscErrorCode  SNESGetConvergedReason(SNES snes,SNESConvergedReason *reason)
3337184914b5SBarry Smith {
3338184914b5SBarry Smith   PetscFunctionBegin;
33390700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
33404482741eSBarry Smith   PetscValidPointer(reason,2);
3341184914b5SBarry Smith   *reason = snes->reason;
3342184914b5SBarry Smith   PetscFunctionReturn(0);
3343184914b5SBarry Smith }
3344184914b5SBarry Smith 
33454a2ae208SSatish Balay #undef __FUNCT__
33464a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceHistory"
3347c9005455SLois Curfman McInnes /*@
3348c9005455SLois Curfman McInnes    SNESSetConvergenceHistory - Sets the array used to hold the convergence history.
3349c9005455SLois Curfman McInnes 
33503f9fe445SBarry Smith    Logically Collective on SNES
3351fee21e36SBarry Smith 
3352c7afd0dbSLois Curfman McInnes    Input Parameters:
3353c7afd0dbSLois Curfman McInnes +  snes - iterative context obtained from SNESCreate()
33548c7482ecSBarry Smith .  a   - array to hold history, this array will contain the function norms computed at each step
3355cd5578b5SBarry Smith .  its - integer array holds the number of linear iterations for each solve.
3356758f92a0SBarry Smith .  na  - size of a and its
335764731454SLois Curfman McInnes -  reset - PETSC_TRUE indicates each new nonlinear solve resets the history counter to zero,
3358758f92a0SBarry Smith            else it continues storing new values for new nonlinear solves after the old ones
3359c7afd0dbSLois Curfman McInnes 
3360308dcc3eSBarry Smith    Notes:
3361308dcc3eSBarry Smith    If 'a' and 'its' are PETSC_NULL then space is allocated for the history. If 'na' PETSC_DECIDE or PETSC_DEFAULT then a
3362308dcc3eSBarry Smith    default array of length 10000 is allocated.
3363308dcc3eSBarry Smith 
3364c9005455SLois Curfman McInnes    This routine is useful, e.g., when running a code for purposes
3365c9005455SLois Curfman McInnes    of accurate performance monitoring, when no I/O should be done
3366c9005455SLois Curfman McInnes    during the section of code that is being timed.
3367c9005455SLois Curfman McInnes 
336836851e7fSLois Curfman McInnes    Level: intermediate
336936851e7fSLois Curfman McInnes 
3370c9005455SLois Curfman McInnes .keywords: SNES, set, convergence, history
3371758f92a0SBarry Smith 
337208405cd6SLois Curfman McInnes .seealso: SNESGetConvergenceHistory()
3373758f92a0SBarry Smith 
3374c9005455SLois Curfman McInnes @*/
33757087cfbeSBarry Smith PetscErrorCode  SNESSetConvergenceHistory(SNES snes,PetscReal a[],PetscInt its[],PetscInt na,PetscBool  reset)
3376c9005455SLois Curfman McInnes {
3377308dcc3eSBarry Smith   PetscErrorCode ierr;
3378308dcc3eSBarry Smith 
33793a40ed3dSBarry Smith   PetscFunctionBegin;
33800700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
33814482741eSBarry Smith   if (na)  PetscValidScalarPointer(a,2);
3382a562a398SLisandro Dalcin   if (its) PetscValidIntPointer(its,3);
3383308dcc3eSBarry Smith   if (na == PETSC_DECIDE || na == PETSC_DEFAULT || !a) {
3384308dcc3eSBarry Smith     if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000;
3385308dcc3eSBarry Smith     ierr = PetscMalloc(na*sizeof(PetscReal),&a);CHKERRQ(ierr);
3386308dcc3eSBarry Smith     ierr = PetscMalloc(na*sizeof(PetscInt),&its);CHKERRQ(ierr);
3387308dcc3eSBarry Smith     snes->conv_malloc   = PETSC_TRUE;
3388308dcc3eSBarry Smith   }
3389c9005455SLois Curfman McInnes   snes->conv_hist       = a;
3390758f92a0SBarry Smith   snes->conv_hist_its   = its;
3391758f92a0SBarry Smith   snes->conv_hist_max   = na;
3392a12bc48fSLisandro Dalcin   snes->conv_hist_len   = 0;
3393758f92a0SBarry Smith   snes->conv_hist_reset = reset;
3394758f92a0SBarry Smith   PetscFunctionReturn(0);
3395758f92a0SBarry Smith }
3396758f92a0SBarry Smith 
3397308dcc3eSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
3398c6db04a5SJed Brown #include <engine.h>   /* MATLAB include file */
3399c6db04a5SJed Brown #include <mex.h>      /* MATLAB include file */
3400308dcc3eSBarry Smith EXTERN_C_BEGIN
3401308dcc3eSBarry Smith #undef __FUNCT__
3402308dcc3eSBarry Smith #define __FUNCT__ "SNESGetConvergenceHistoryMatlab"
3403308dcc3eSBarry Smith mxArray *SNESGetConvergenceHistoryMatlab(SNES snes)
3404308dcc3eSBarry Smith {
3405308dcc3eSBarry Smith   mxArray   *mat;
3406308dcc3eSBarry Smith   PetscInt  i;
3407308dcc3eSBarry Smith   PetscReal *ar;
3408308dcc3eSBarry Smith 
3409308dcc3eSBarry Smith   PetscFunctionBegin;
3410308dcc3eSBarry Smith   mat  = mxCreateDoubleMatrix(snes->conv_hist_len,1,mxREAL);
3411308dcc3eSBarry Smith   ar   = (PetscReal*) mxGetData(mat);
3412308dcc3eSBarry Smith   for (i=0; i<snes->conv_hist_len; i++) {
3413308dcc3eSBarry Smith     ar[i] = snes->conv_hist[i];
3414308dcc3eSBarry Smith   }
3415308dcc3eSBarry Smith   PetscFunctionReturn(mat);
3416308dcc3eSBarry Smith }
3417308dcc3eSBarry Smith EXTERN_C_END
3418308dcc3eSBarry Smith #endif
3419308dcc3eSBarry Smith 
3420308dcc3eSBarry Smith 
34214a2ae208SSatish Balay #undef __FUNCT__
34224a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergenceHistory"
34230c4c9dddSBarry Smith /*@C
3424758f92a0SBarry Smith    SNESGetConvergenceHistory - Gets the array used to hold the convergence history.
3425758f92a0SBarry Smith 
34263f9fe445SBarry Smith    Not Collective
3427758f92a0SBarry Smith 
3428758f92a0SBarry Smith    Input Parameter:
3429758f92a0SBarry Smith .  snes - iterative context obtained from SNESCreate()
3430758f92a0SBarry Smith 
3431758f92a0SBarry Smith    Output Parameters:
3432758f92a0SBarry Smith .  a   - array to hold history
3433758f92a0SBarry Smith .  its - integer array holds the number of linear iterations (or
3434758f92a0SBarry Smith          negative if not converged) for each solve.
3435758f92a0SBarry Smith -  na  - size of a and its
3436758f92a0SBarry Smith 
3437758f92a0SBarry Smith    Notes:
3438758f92a0SBarry Smith     The calling sequence for this routine in Fortran is
3439758f92a0SBarry Smith $   call SNESGetConvergenceHistory(SNES snes, integer na, integer ierr)
3440758f92a0SBarry Smith 
3441758f92a0SBarry Smith    This routine is useful, e.g., when running a code for purposes
3442758f92a0SBarry Smith    of accurate performance monitoring, when no I/O should be done
3443758f92a0SBarry Smith    during the section of code that is being timed.
3444758f92a0SBarry Smith 
3445758f92a0SBarry Smith    Level: intermediate
3446758f92a0SBarry Smith 
3447758f92a0SBarry Smith .keywords: SNES, get, convergence, history
3448758f92a0SBarry Smith 
3449758f92a0SBarry Smith .seealso: SNESSetConvergencHistory()
3450758f92a0SBarry Smith 
3451758f92a0SBarry Smith @*/
34527087cfbeSBarry Smith PetscErrorCode  SNESGetConvergenceHistory(SNES snes,PetscReal *a[],PetscInt *its[],PetscInt *na)
3453758f92a0SBarry Smith {
3454758f92a0SBarry Smith   PetscFunctionBegin;
34550700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3456758f92a0SBarry Smith   if (a)   *a   = snes->conv_hist;
3457758f92a0SBarry Smith   if (its) *its = snes->conv_hist_its;
3458758f92a0SBarry Smith   if (na)  *na  = snes->conv_hist_len;
34593a40ed3dSBarry Smith   PetscFunctionReturn(0);
3460c9005455SLois Curfman McInnes }
3461c9005455SLois Curfman McInnes 
3462e74ef692SMatthew Knepley #undef __FUNCT__
3463e74ef692SMatthew Knepley #define __FUNCT__ "SNESSetUpdate"
3464ac226902SBarry Smith /*@C
346576b2cf59SMatthew Knepley   SNESSetUpdate - Sets the general-purpose update function called
3466eec8f646SJed Brown   at the beginning of every iteration of the nonlinear solve. Specifically
34677e4bb74cSBarry Smith   it is called just before the Jacobian is "evaluated".
346876b2cf59SMatthew Knepley 
34693f9fe445SBarry Smith   Logically Collective on SNES
347076b2cf59SMatthew Knepley 
347176b2cf59SMatthew Knepley   Input Parameters:
347276b2cf59SMatthew Knepley . snes - The nonlinear solver context
347376b2cf59SMatthew Knepley . func - The function
347476b2cf59SMatthew Knepley 
347576b2cf59SMatthew Knepley   Calling sequence of func:
3476b5d30489SBarry Smith . func (SNES snes, PetscInt step);
347776b2cf59SMatthew Knepley 
347876b2cf59SMatthew Knepley . step - The current step of the iteration
347976b2cf59SMatthew Knepley 
3480fe97e370SBarry Smith   Level: advanced
3481fe97e370SBarry Smith 
3482fe97e370SBarry 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()
3483fe97e370SBarry Smith         This is not used by most users.
348476b2cf59SMatthew Knepley 
348576b2cf59SMatthew Knepley .keywords: SNES, update
3486b5d30489SBarry Smith 
348785385478SLisandro Dalcin .seealso SNESDefaultUpdate(), SNESSetJacobian(), SNESSolve()
348876b2cf59SMatthew Knepley @*/
34897087cfbeSBarry Smith PetscErrorCode  SNESSetUpdate(SNES snes, PetscErrorCode (*func)(SNES, PetscInt))
349076b2cf59SMatthew Knepley {
349176b2cf59SMatthew Knepley   PetscFunctionBegin;
34920700a824SBarry Smith   PetscValidHeaderSpecific(snes, SNES_CLASSID,1);
3493e7788613SBarry Smith   snes->ops->update = func;
349476b2cf59SMatthew Knepley   PetscFunctionReturn(0);
349576b2cf59SMatthew Knepley }
349676b2cf59SMatthew Knepley 
3497e74ef692SMatthew Knepley #undef __FUNCT__
3498e74ef692SMatthew Knepley #define __FUNCT__ "SNESDefaultUpdate"
349976b2cf59SMatthew Knepley /*@
350076b2cf59SMatthew Knepley   SNESDefaultUpdate - The default update function which does nothing.
350176b2cf59SMatthew Knepley 
350276b2cf59SMatthew Knepley   Not collective
350376b2cf59SMatthew Knepley 
350476b2cf59SMatthew Knepley   Input Parameters:
350576b2cf59SMatthew Knepley . snes - The nonlinear solver context
350676b2cf59SMatthew Knepley . step - The current step of the iteration
350776b2cf59SMatthew Knepley 
3508205452f4SMatthew Knepley   Level: intermediate
3509205452f4SMatthew Knepley 
351076b2cf59SMatthew Knepley .keywords: SNES, update
3511a6570f20SBarry Smith .seealso SNESSetUpdate(), SNESDefaultRhsBC(), SNESDefaultShortolutionBC()
351276b2cf59SMatthew Knepley @*/
35137087cfbeSBarry Smith PetscErrorCode  SNESDefaultUpdate(SNES snes, PetscInt step)
351476b2cf59SMatthew Knepley {
351576b2cf59SMatthew Knepley   PetscFunctionBegin;
351676b2cf59SMatthew Knepley   PetscFunctionReturn(0);
351776b2cf59SMatthew Knepley }
351876b2cf59SMatthew Knepley 
35194a2ae208SSatish Balay #undef __FUNCT__
35204a2ae208SSatish Balay #define __FUNCT__ "SNESScaleStep_Private"
35219b94acceSBarry Smith /*
35229b94acceSBarry Smith    SNESScaleStep_Private - Scales a step so that its length is less than the
35239b94acceSBarry Smith    positive parameter delta.
35249b94acceSBarry Smith 
35259b94acceSBarry Smith     Input Parameters:
3526c7afd0dbSLois Curfman McInnes +   snes - the SNES context
35279b94acceSBarry Smith .   y - approximate solution of linear system
35289b94acceSBarry Smith .   fnorm - 2-norm of current function
3529c7afd0dbSLois Curfman McInnes -   delta - trust region size
35309b94acceSBarry Smith 
35319b94acceSBarry Smith     Output Parameters:
3532c7afd0dbSLois Curfman McInnes +   gpnorm - predicted function norm at the new point, assuming local
35339b94acceSBarry Smith     linearization.  The value is zero if the step lies within the trust
35349b94acceSBarry Smith     region, and exceeds zero otherwise.
3535c7afd0dbSLois Curfman McInnes -   ynorm - 2-norm of the step
35369b94acceSBarry Smith 
35379b94acceSBarry Smith     Note:
35384b27c08aSLois Curfman McInnes     For non-trust region methods such as SNESLS, the parameter delta
35399b94acceSBarry Smith     is set to be the maximum allowable step size.
35409b94acceSBarry Smith 
35419b94acceSBarry Smith .keywords: SNES, nonlinear, scale, step
35429b94acceSBarry Smith */
3543dfbe8321SBarry Smith PetscErrorCode SNESScaleStep_Private(SNES snes,Vec y,PetscReal *fnorm,PetscReal *delta,PetscReal *gpnorm,PetscReal *ynorm)
35449b94acceSBarry Smith {
3545064f8208SBarry Smith   PetscReal      nrm;
3546ea709b57SSatish Balay   PetscScalar    cnorm;
3547dfbe8321SBarry Smith   PetscErrorCode ierr;
35483a40ed3dSBarry Smith 
35493a40ed3dSBarry Smith   PetscFunctionBegin;
35500700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
35510700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,2);
3552c9780b6fSBarry Smith   PetscCheckSameComm(snes,1,y,2);
3553184914b5SBarry Smith 
3554064f8208SBarry Smith   ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr);
3555064f8208SBarry Smith   if (nrm > *delta) {
3556064f8208SBarry Smith      nrm = *delta/nrm;
3557064f8208SBarry Smith      *gpnorm = (1.0 - nrm)*(*fnorm);
3558064f8208SBarry Smith      cnorm = nrm;
35592dcb1b2aSMatthew Knepley      ierr = VecScale(y,cnorm);CHKERRQ(ierr);
35609b94acceSBarry Smith      *ynorm = *delta;
35619b94acceSBarry Smith   } else {
35629b94acceSBarry Smith      *gpnorm = 0.0;
3563064f8208SBarry Smith      *ynorm = nrm;
35649b94acceSBarry Smith   }
35653a40ed3dSBarry Smith   PetscFunctionReturn(0);
35669b94acceSBarry Smith }
35679b94acceSBarry Smith 
35684a2ae208SSatish Balay #undef __FUNCT__
35694a2ae208SSatish Balay #define __FUNCT__ "SNESSolve"
35706ce558aeSBarry Smith /*@C
3571f69a0ea3SMatthew Knepley    SNESSolve - Solves a nonlinear system F(x) = b.
3572f69a0ea3SMatthew Knepley    Call SNESSolve() after calling SNESCreate() and optional routines of the form SNESSetXXX().
35739b94acceSBarry Smith 
3574c7afd0dbSLois Curfman McInnes    Collective on SNES
3575c7afd0dbSLois Curfman McInnes 
3576b2002411SLois Curfman McInnes    Input Parameters:
3577c7afd0dbSLois Curfman McInnes +  snes - the SNES context
35783cebf274SJed Brown .  b - the constant part of the equation F(x) = b, or PETSC_NULL to use zero.
357985385478SLisandro Dalcin -  x - the solution vector.
35809b94acceSBarry Smith 
3581b2002411SLois Curfman McInnes    Notes:
35828ddd3da0SLois Curfman McInnes    The user should initialize the vector,x, with the initial guess
35838ddd3da0SLois Curfman McInnes    for the nonlinear solve prior to calling SNESSolve.  In particular,
35848ddd3da0SLois Curfman McInnes    to employ an initial guess of zero, the user should explicitly set
35858ddd3da0SLois Curfman McInnes    this vector to zero by calling VecSet().
35868ddd3da0SLois Curfman McInnes 
358736851e7fSLois Curfman McInnes    Level: beginner
358836851e7fSLois Curfman McInnes 
35899b94acceSBarry Smith .keywords: SNES, nonlinear, solve
35909b94acceSBarry Smith 
3591c0df2a02SJed Brown .seealso: SNESCreate(), SNESDestroy(), SNESSetFunction(), SNESSetJacobian(), SNESSetGridSequence(), SNESGetSolution()
35929b94acceSBarry Smith @*/
35937087cfbeSBarry Smith PetscErrorCode  SNESSolve(SNES snes,Vec b,Vec x)
35949b94acceSBarry Smith {
3595dfbe8321SBarry Smith   PetscErrorCode ierr;
3596ace3abfcSBarry Smith   PetscBool      flg;
3597eabae89aSBarry Smith   char           filename[PETSC_MAX_PATH_LEN];
3598eabae89aSBarry Smith   PetscViewer    viewer;
3599efd51863SBarry Smith   PetscInt       grid;
3600a69afd8bSBarry Smith   Vec            xcreated = PETSC_NULL;
3601caa4e7f2SJed Brown   DM             dm;
3602052efed2SBarry Smith 
36033a40ed3dSBarry Smith   PetscFunctionBegin;
36040700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3605a69afd8bSBarry Smith   if (x) PetscValidHeaderSpecific(x,VEC_CLASSID,3);
3606a69afd8bSBarry Smith   if (x) PetscCheckSameComm(snes,1,x,3);
36070700a824SBarry Smith   if (b) PetscValidHeaderSpecific(b,VEC_CLASSID,2);
360885385478SLisandro Dalcin   if (b) PetscCheckSameComm(snes,1,b,2);
360985385478SLisandro Dalcin 
3610caa4e7f2SJed Brown   if (!x) {
3611caa4e7f2SJed Brown     ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
3612caa4e7f2SJed Brown     ierr = DMCreateGlobalVector(dm,&xcreated);CHKERRQ(ierr);
3613a69afd8bSBarry Smith     x    = xcreated;
3614a69afd8bSBarry Smith   }
3615a69afd8bSBarry Smith 
3616a8248277SBarry Smith   for (grid=0; grid<snes->gridsequence; grid++) {ierr = PetscViewerASCIIPushTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm));CHKERRQ(ierr);}
3617efd51863SBarry Smith   for (grid=0; grid<snes->gridsequence+1; grid++) {
3618efd51863SBarry Smith 
361985385478SLisandro Dalcin     /* set solution vector */
3620efd51863SBarry Smith     if (!grid) {ierr = PetscObjectReference((PetscObject)x);CHKERRQ(ierr);}
36216bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr);
362285385478SLisandro Dalcin     snes->vec_sol = x;
3623caa4e7f2SJed Brown     ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
3624caa4e7f2SJed Brown 
3625caa4e7f2SJed Brown     /* set affine vector if provided */
362685385478SLisandro Dalcin     if (b) { ierr = PetscObjectReference((PetscObject)b);CHKERRQ(ierr); }
36276bf464f9SBarry Smith     ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr);
362885385478SLisandro Dalcin     snes->vec_rhs = b;
362985385478SLisandro Dalcin 
363070e92668SMatthew Knepley     ierr = SNESSetUp(snes);CHKERRQ(ierr);
36313f149594SLisandro Dalcin 
36327eee914bSBarry Smith     if (!grid) {
36337eee914bSBarry Smith       if (snes->ops->computeinitialguess) {
3634d25893d9SBarry Smith         ierr = (*snes->ops->computeinitialguess)(snes,snes->vec_sol,snes->initialguessP);CHKERRQ(ierr);
3635dd568438SSatish Balay       } else if (snes->dm) {
3636dd568438SSatish Balay         PetscBool ig;
3637dd568438SSatish Balay         ierr = DMHasInitialGuess(snes->dm,&ig);CHKERRQ(ierr);
3638dd568438SSatish Balay         if (ig) {
36397eee914bSBarry Smith           ierr = DMComputeInitialGuess(snes->dm,snes->vec_sol);CHKERRQ(ierr);
36407eee914bSBarry Smith         }
3641d25893d9SBarry Smith       }
3642dd568438SSatish Balay     }
3643d25893d9SBarry Smith 
3644abc0a331SBarry Smith     if (snes->conv_hist_reset) snes->conv_hist_len = 0;
364550ffb88aSMatthew Knepley     snes->nfuncs = 0; snes->linear_its = 0; snes->numFailures = 0;
3646d5e45103SBarry Smith 
36473f149594SLisandro Dalcin     ierr = PetscLogEventBegin(SNES_Solve,snes,0,0,0);CHKERRQ(ierr);
36484936397dSBarry Smith     ierr = (*snes->ops->solve)(snes);CHKERRQ(ierr);
364985385478SLisandro Dalcin     ierr = PetscLogEventEnd(SNES_Solve,snes,0,0,0);CHKERRQ(ierr);
36504936397dSBarry Smith     if (snes->domainerror){
36514936397dSBarry Smith       snes->reason      = SNES_DIVERGED_FUNCTION_DOMAIN;
36524936397dSBarry Smith       snes->domainerror = PETSC_FALSE;
36534936397dSBarry Smith     }
365417186662SBarry Smith     if (!snes->reason) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Internal error, solver returned without setting converged reason");
36553f149594SLisandro Dalcin 
365690d69ab7SBarry Smith     flg  = PETSC_FALSE;
3657acfcf0e5SJed Brown     ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_test_local_min",&flg,PETSC_NULL);CHKERRQ(ierr);
3658da9b6338SBarry Smith     if (flg && !PetscPreLoadingOn) { ierr = SNESTestLocalMin(snes);CHKERRQ(ierr); }
36595968eb51SBarry Smith     if (snes->printreason) {
3660a8248277SBarry Smith       ierr = PetscViewerASCIIAddTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),((PetscObject)snes)->tablevel);CHKERRQ(ierr);
36615968eb51SBarry Smith       if (snes->reason > 0) {
3662c7e7b494SJed 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);
36635968eb51SBarry Smith       } else {
3664c7e7b494SJed 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);
36655968eb51SBarry Smith       }
3666a8248277SBarry Smith       ierr = PetscViewerASCIISubtractTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),((PetscObject)snes)->tablevel);CHKERRQ(ierr);
36675968eb51SBarry Smith     }
36685968eb51SBarry Smith 
3669e113a28aSBarry Smith     if (snes->errorifnotconverged && snes->reason < 0) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_NOT_CONVERGED,"SNESSolve has not converged");
3670efd51863SBarry Smith     if (grid <  snes->gridsequence) {
3671efd51863SBarry Smith       DM  fine;
3672efd51863SBarry Smith       Vec xnew;
3673efd51863SBarry Smith       Mat interp;
3674efd51863SBarry Smith 
3675efd51863SBarry Smith       ierr = DMRefine(snes->dm,((PetscObject)snes)->comm,&fine);CHKERRQ(ierr);
3676c5c77316SJed Brown       if (!fine) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_ARG_INCOMP,"DMRefine() did not perform any refinement, cannot continue grid sequencing");
3677e727c939SJed Brown       ierr = DMCreateInterpolation(snes->dm,fine,&interp,PETSC_NULL);CHKERRQ(ierr);
3678efd51863SBarry Smith       ierr = DMCreateGlobalVector(fine,&xnew);CHKERRQ(ierr);
3679efd51863SBarry Smith       ierr = MatInterpolate(interp,x,xnew);CHKERRQ(ierr);
3680c833c3b5SJed Brown       ierr = DMInterpolate(snes->dm,interp,fine);CHKERRQ(ierr);
3681efd51863SBarry Smith       ierr = MatDestroy(&interp);CHKERRQ(ierr);
3682efd51863SBarry Smith       x    = xnew;
3683efd51863SBarry Smith 
3684efd51863SBarry Smith       ierr = SNESReset(snes);CHKERRQ(ierr);
3685efd51863SBarry Smith       ierr = SNESSetDM(snes,fine);CHKERRQ(ierr);
3686efd51863SBarry Smith       ierr = DMDestroy(&fine);CHKERRQ(ierr);
3687a8248277SBarry Smith       ierr = PetscViewerASCIIPopTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm));CHKERRQ(ierr);
3688efd51863SBarry Smith     }
3689efd51863SBarry Smith   }
36903f7e2da0SPeter Brune   /* monitoring and viewing */
36913f7e2da0SPeter Brune   flg = PETSC_FALSE;
36923f7e2da0SPeter Brune   ierr = PetscOptionsGetString(((PetscObject)snes)->prefix,"-snes_view",filename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
36933f7e2da0SPeter Brune   if (flg && !PetscPreLoadingOn) {
36943f7e2da0SPeter Brune     ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,filename,&viewer);CHKERRQ(ierr);
36953f7e2da0SPeter Brune     ierr = SNESView(snes,viewer);CHKERRQ(ierr);
36963f7e2da0SPeter Brune     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
36973f7e2da0SPeter Brune   }
36983f7e2da0SPeter Brune 
36993f7e2da0SPeter Brune   flg = PETSC_FALSE;
37003f7e2da0SPeter Brune   ierr = PetscOptionsGetString(((PetscObject)snes)->prefix,"-snes_view_solution_vtk",filename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
37013f7e2da0SPeter Brune   if (flg) {
37023f7e2da0SPeter Brune     PetscViewer viewer;
37033f7e2da0SPeter Brune     ierr = PetscViewerCreate(((PetscObject)snes)->comm,&viewer);CHKERRQ(ierr);
37043f7e2da0SPeter Brune     ierr = PetscViewerSetType(viewer,PETSCVIEWERVTK);CHKERRQ(ierr);
37053f7e2da0SPeter Brune     ierr = PetscViewerFileSetName(viewer,filename);CHKERRQ(ierr);
37063f7e2da0SPeter Brune     ierr = VecView(snes->vec_sol,viewer);CHKERRQ(ierr);
37073f7e2da0SPeter Brune     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
37083f7e2da0SPeter Brune   }
37093f7e2da0SPeter Brune 
3710a69afd8bSBarry Smith   ierr = VecDestroy(&xcreated);CHKERRQ(ierr);
37113a40ed3dSBarry Smith   PetscFunctionReturn(0);
37129b94acceSBarry Smith }
37139b94acceSBarry Smith 
37149b94acceSBarry Smith /* --------- Internal routines for SNES Package --------- */
37159b94acceSBarry Smith 
37164a2ae208SSatish Balay #undef __FUNCT__
37174a2ae208SSatish Balay #define __FUNCT__ "SNESSetType"
371882bf6240SBarry Smith /*@C
37194b0e389bSBarry Smith    SNESSetType - Sets the method for the nonlinear solver.
37209b94acceSBarry Smith 
3721fee21e36SBarry Smith    Collective on SNES
3722fee21e36SBarry Smith 
3723c7afd0dbSLois Curfman McInnes    Input Parameters:
3724c7afd0dbSLois Curfman McInnes +  snes - the SNES context
3725454a90a3SBarry Smith -  type - a known method
3726c7afd0dbSLois Curfman McInnes 
3727c7afd0dbSLois Curfman McInnes    Options Database Key:
3728454a90a3SBarry Smith .  -snes_type <type> - Sets the method; use -help for a list
3729c7afd0dbSLois Curfman McInnes    of available methods (for instance, ls or tr)
3730ae12b187SLois Curfman McInnes 
37319b94acceSBarry Smith    Notes:
3732e090d566SSatish Balay    See "petsc/include/petscsnes.h" for available methods (for instance)
37334b27c08aSLois Curfman McInnes +    SNESLS - Newton's method with line search
3734c7afd0dbSLois Curfman McInnes      (systems of nonlinear equations)
37354b27c08aSLois Curfman McInnes .    SNESTR - Newton's method with trust region
3736c7afd0dbSLois Curfman McInnes      (systems of nonlinear equations)
37379b94acceSBarry Smith 
3738ae12b187SLois Curfman McInnes   Normally, it is best to use the SNESSetFromOptions() command and then
3739ae12b187SLois Curfman McInnes   set the SNES solver type from the options database rather than by using
3740ae12b187SLois Curfman McInnes   this routine.  Using the options database provides the user with
3741ae12b187SLois Curfman McInnes   maximum flexibility in evaluating the many nonlinear solvers.
3742ae12b187SLois Curfman McInnes   The SNESSetType() routine is provided for those situations where it
3743ae12b187SLois Curfman McInnes   is necessary to set the nonlinear solver independently of the command
3744ae12b187SLois Curfman McInnes   line or options database.  This might be the case, for example, when
3745ae12b187SLois Curfman McInnes   the choice of solver changes during the execution of the program,
3746ae12b187SLois Curfman McInnes   and the user's application is taking responsibility for choosing the
3747b0a32e0cSBarry Smith   appropriate method.
374836851e7fSLois Curfman McInnes 
374936851e7fSLois Curfman McInnes   Level: intermediate
3750a703fe33SLois Curfman McInnes 
3751454a90a3SBarry Smith .keywords: SNES, set, type
3752435da068SBarry Smith 
3753435da068SBarry Smith .seealso: SNESType, SNESCreate()
3754435da068SBarry Smith 
37559b94acceSBarry Smith @*/
375619fd82e9SBarry Smith PetscErrorCode  SNESSetType(SNES snes,SNESType type)
37579b94acceSBarry Smith {
3758dfbe8321SBarry Smith   PetscErrorCode ierr,(*r)(SNES);
3759ace3abfcSBarry Smith   PetscBool      match;
37603a40ed3dSBarry Smith 
37613a40ed3dSBarry Smith   PetscFunctionBegin;
37620700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
37634482741eSBarry Smith   PetscValidCharPointer(type,2);
376482bf6240SBarry Smith 
3765251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)snes,type,&match);CHKERRQ(ierr);
37660f5bd95cSBarry Smith   if (match) PetscFunctionReturn(0);
376792ff6ae8SBarry Smith 
37684b91b6eaSBarry Smith   ierr =  PetscFListFind(SNESList,((PetscObject)snes)->comm,type,PETSC_TRUE,(void (**)(void)) &r);CHKERRQ(ierr);
3769e32f2f54SBarry Smith   if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested SNES type %s",type);
377075396ef9SLisandro Dalcin   /* Destroy the previous private SNES context */
3771b5c23020SJed Brown   if (snes->ops->destroy) {
3772b5c23020SJed Brown     ierr = (*(snes)->ops->destroy)(snes);CHKERRQ(ierr);
3773b5c23020SJed Brown     snes->ops->destroy = PETSC_NULL;
3774b5c23020SJed Brown   }
377575396ef9SLisandro Dalcin   /* Reinitialize function pointers in SNESOps structure */
377675396ef9SLisandro Dalcin   snes->ops->setup          = 0;
377775396ef9SLisandro Dalcin   snes->ops->solve          = 0;
377875396ef9SLisandro Dalcin   snes->ops->view           = 0;
377975396ef9SLisandro Dalcin   snes->ops->setfromoptions = 0;
378075396ef9SLisandro Dalcin   snes->ops->destroy        = 0;
378175396ef9SLisandro Dalcin   /* Call the SNESCreate_XXX routine for this particular Nonlinear solver */
378275396ef9SLisandro Dalcin   snes->setupcalled = PETSC_FALSE;
3783454a90a3SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)snes,type);CHKERRQ(ierr);
378403bfa161SLisandro Dalcin   ierr = (*r)(snes);CHKERRQ(ierr);
37859fb22e1aSBarry Smith #if defined(PETSC_HAVE_AMS)
37869fb22e1aSBarry Smith   if (PetscAMSPublishAll) {
37879fb22e1aSBarry Smith     ierr = PetscObjectAMSPublish((PetscObject)snes);CHKERRQ(ierr);
37889fb22e1aSBarry Smith   }
37899fb22e1aSBarry Smith #endif
37903a40ed3dSBarry Smith   PetscFunctionReturn(0);
37919b94acceSBarry Smith }
37929b94acceSBarry Smith 
3793a847f771SSatish Balay 
37949b94acceSBarry Smith /* --------------------------------------------------------------------- */
37954a2ae208SSatish Balay #undef __FUNCT__
37964a2ae208SSatish Balay #define __FUNCT__ "SNESRegisterDestroy"
379752baeb72SSatish Balay /*@
37989b94acceSBarry Smith    SNESRegisterDestroy - Frees the list of nonlinear solvers that were
3799f1af5d2fSBarry Smith    registered by SNESRegisterDynamic().
38009b94acceSBarry Smith 
3801fee21e36SBarry Smith    Not Collective
3802fee21e36SBarry Smith 
380336851e7fSLois Curfman McInnes    Level: advanced
380436851e7fSLois Curfman McInnes 
38059b94acceSBarry Smith .keywords: SNES, nonlinear, register, destroy
38069b94acceSBarry Smith 
38079b94acceSBarry Smith .seealso: SNESRegisterAll(), SNESRegisterAll()
38089b94acceSBarry Smith @*/
38097087cfbeSBarry Smith PetscErrorCode  SNESRegisterDestroy(void)
38109b94acceSBarry Smith {
3811dfbe8321SBarry Smith   PetscErrorCode ierr;
381282bf6240SBarry Smith 
38133a40ed3dSBarry Smith   PetscFunctionBegin;
38141441b1d3SBarry Smith   ierr = PetscFListDestroy(&SNESList);CHKERRQ(ierr);
38154c49b128SBarry Smith   SNESRegisterAllCalled = PETSC_FALSE;
38163a40ed3dSBarry Smith   PetscFunctionReturn(0);
38179b94acceSBarry Smith }
38189b94acceSBarry Smith 
38194a2ae208SSatish Balay #undef __FUNCT__
38204a2ae208SSatish Balay #define __FUNCT__ "SNESGetType"
38219b94acceSBarry Smith /*@C
38229a28b0a6SLois Curfman McInnes    SNESGetType - Gets the SNES method type and name (as a string).
38239b94acceSBarry Smith 
3824c7afd0dbSLois Curfman McInnes    Not Collective
3825c7afd0dbSLois Curfman McInnes 
38269b94acceSBarry Smith    Input Parameter:
38274b0e389bSBarry Smith .  snes - nonlinear solver context
38289b94acceSBarry Smith 
38299b94acceSBarry Smith    Output Parameter:
38303a7fca6bSBarry Smith .  type - SNES method (a character string)
38319b94acceSBarry Smith 
383236851e7fSLois Curfman McInnes    Level: intermediate
383336851e7fSLois Curfman McInnes 
3834454a90a3SBarry Smith .keywords: SNES, nonlinear, get, type, name
38359b94acceSBarry Smith @*/
383619fd82e9SBarry Smith PetscErrorCode  SNESGetType(SNES snes,SNESType *type)
38379b94acceSBarry Smith {
38383a40ed3dSBarry Smith   PetscFunctionBegin;
38390700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
38404482741eSBarry Smith   PetscValidPointer(type,2);
38417adad957SLisandro Dalcin   *type = ((PetscObject)snes)->type_name;
38423a40ed3dSBarry Smith   PetscFunctionReturn(0);
38439b94acceSBarry Smith }
38449b94acceSBarry Smith 
38454a2ae208SSatish Balay #undef __FUNCT__
38464a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolution"
384752baeb72SSatish Balay /*@
38489b94acceSBarry Smith    SNESGetSolution - Returns the vector where the approximate solution is
3849c0df2a02SJed Brown    stored. This is the fine grid solution when using SNESSetGridSequence().
38509b94acceSBarry Smith 
3851c7afd0dbSLois Curfman McInnes    Not Collective, but Vec is parallel if SNES is parallel
3852c7afd0dbSLois Curfman McInnes 
38539b94acceSBarry Smith    Input Parameter:
38549b94acceSBarry Smith .  snes - the SNES context
38559b94acceSBarry Smith 
38569b94acceSBarry Smith    Output Parameter:
38579b94acceSBarry Smith .  x - the solution
38589b94acceSBarry Smith 
385970e92668SMatthew Knepley    Level: intermediate
386036851e7fSLois Curfman McInnes 
38619b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution
38629b94acceSBarry Smith 
386385385478SLisandro Dalcin .seealso:  SNESGetSolutionUpdate(), SNESGetFunction()
38649b94acceSBarry Smith @*/
38657087cfbeSBarry Smith PetscErrorCode  SNESGetSolution(SNES snes,Vec *x)
38669b94acceSBarry Smith {
38673a40ed3dSBarry Smith   PetscFunctionBegin;
38680700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
38694482741eSBarry Smith   PetscValidPointer(x,2);
387085385478SLisandro Dalcin   *x = snes->vec_sol;
387170e92668SMatthew Knepley   PetscFunctionReturn(0);
387270e92668SMatthew Knepley }
387370e92668SMatthew Knepley 
387470e92668SMatthew Knepley #undef __FUNCT__
38754a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolutionUpdate"
387652baeb72SSatish Balay /*@
38779b94acceSBarry Smith    SNESGetSolutionUpdate - Returns the vector where the solution update is
38789b94acceSBarry Smith    stored.
38799b94acceSBarry Smith 
3880c7afd0dbSLois Curfman McInnes    Not Collective, but Vec is parallel if SNES is parallel
3881c7afd0dbSLois Curfman McInnes 
38829b94acceSBarry Smith    Input Parameter:
38839b94acceSBarry Smith .  snes - the SNES context
38849b94acceSBarry Smith 
38859b94acceSBarry Smith    Output Parameter:
38869b94acceSBarry Smith .  x - the solution update
38879b94acceSBarry Smith 
388836851e7fSLois Curfman McInnes    Level: advanced
388936851e7fSLois Curfman McInnes 
38909b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution, update
38919b94acceSBarry Smith 
389285385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction()
38939b94acceSBarry Smith @*/
38947087cfbeSBarry Smith PetscErrorCode  SNESGetSolutionUpdate(SNES snes,Vec *x)
38959b94acceSBarry Smith {
38963a40ed3dSBarry Smith   PetscFunctionBegin;
38970700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
38984482741eSBarry Smith   PetscValidPointer(x,2);
389985385478SLisandro Dalcin   *x = snes->vec_sol_update;
39003a40ed3dSBarry Smith   PetscFunctionReturn(0);
39019b94acceSBarry Smith }
39029b94acceSBarry Smith 
39034a2ae208SSatish Balay #undef __FUNCT__
39044a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunction"
39059b94acceSBarry Smith /*@C
39063638b69dSLois Curfman McInnes    SNESGetFunction - Returns the vector where the function is stored.
39079b94acceSBarry Smith 
3908a63bb30eSJed Brown    Not Collective, but Vec is parallel if SNES is parallel. Collective if Vec is requested, but has not been created yet.
3909c7afd0dbSLois Curfman McInnes 
39109b94acceSBarry Smith    Input Parameter:
39119b94acceSBarry Smith .  snes - the SNES context
39129b94acceSBarry Smith 
39139b94acceSBarry Smith    Output Parameter:
39147bf4e008SBarry Smith +  r - the function (or PETSC_NULL)
391570e92668SMatthew Knepley .  func - the function (or PETSC_NULL)
391670e92668SMatthew Knepley -  ctx - the function context (or PETSC_NULL)
39179b94acceSBarry Smith 
391836851e7fSLois Curfman McInnes    Level: advanced
391936851e7fSLois Curfman McInnes 
3920a86d99e1SLois Curfman McInnes .keywords: SNES, nonlinear, get, function
39219b94acceSBarry Smith 
39224b27c08aSLois Curfman McInnes .seealso: SNESSetFunction(), SNESGetSolution()
39239b94acceSBarry Smith @*/
39247087cfbeSBarry Smith PetscErrorCode  SNESGetFunction(SNES snes,Vec *r,PetscErrorCode (**func)(SNES,Vec,Vec,void*),void **ctx)
39259b94acceSBarry Smith {
3926a63bb30eSJed Brown   PetscErrorCode ierr;
39276cab3a1bSJed Brown   DM             dm;
3928a63bb30eSJed Brown 
39293a40ed3dSBarry Smith   PetscFunctionBegin;
39300700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
3931a63bb30eSJed Brown   if (r) {
3932a63bb30eSJed Brown     if (!snes->vec_func) {
3933a63bb30eSJed Brown       if (snes->vec_rhs) {
3934a63bb30eSJed Brown         ierr = VecDuplicate(snes->vec_rhs,&snes->vec_func);CHKERRQ(ierr);
3935a63bb30eSJed Brown       } else if (snes->vec_sol) {
3936a63bb30eSJed Brown         ierr = VecDuplicate(snes->vec_sol,&snes->vec_func);CHKERRQ(ierr);
3937a63bb30eSJed Brown       } else if (snes->dm) {
3938a63bb30eSJed Brown         ierr = DMCreateGlobalVector(snes->dm,&snes->vec_func);CHKERRQ(ierr);
3939a63bb30eSJed Brown       }
3940a63bb30eSJed Brown     }
3941a63bb30eSJed Brown     *r = snes->vec_func;
3942a63bb30eSJed Brown   }
39436cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
39446cab3a1bSJed Brown   ierr = DMSNESGetFunction(dm,func,ctx);CHKERRQ(ierr);
39453a40ed3dSBarry Smith   PetscFunctionReturn(0);
39469b94acceSBarry Smith }
39479b94acceSBarry Smith 
3948c79ef259SPeter Brune /*@C
3949c79ef259SPeter Brune    SNESGetGS - Returns the GS function and context.
3950c79ef259SPeter Brune 
3951c79ef259SPeter Brune    Input Parameter:
3952c79ef259SPeter Brune .  snes - the SNES context
3953c79ef259SPeter Brune 
3954c79ef259SPeter Brune    Output Parameter:
3955c79ef259SPeter Brune +  gsfunc - the function (or PETSC_NULL)
3956c79ef259SPeter Brune -  ctx    - the function context (or PETSC_NULL)
3957c79ef259SPeter Brune 
3958c79ef259SPeter Brune    Level: advanced
3959c79ef259SPeter Brune 
3960c79ef259SPeter Brune .keywords: SNES, nonlinear, get, function
3961c79ef259SPeter Brune 
3962c79ef259SPeter Brune .seealso: SNESSetGS(), SNESGetFunction()
3963c79ef259SPeter Brune @*/
3964c79ef259SPeter Brune 
39654a2ae208SSatish Balay #undef __FUNCT__
3966646217ecSPeter Brune #define __FUNCT__ "SNESGetGS"
3967646217ecSPeter Brune PetscErrorCode SNESGetGS (SNES snes, PetscErrorCode(**func)(SNES, Vec, Vec, void*), void ** ctx)
3968646217ecSPeter Brune {
39696cab3a1bSJed Brown   PetscErrorCode ierr;
39706cab3a1bSJed Brown   DM             dm;
39716cab3a1bSJed Brown 
3972646217ecSPeter Brune   PetscFunctionBegin;
3973646217ecSPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
39746cab3a1bSJed Brown   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
39756cab3a1bSJed Brown   ierr = DMSNESGetGS(dm,func,ctx);CHKERRQ(ierr);
3976646217ecSPeter Brune   PetscFunctionReturn(0);
3977646217ecSPeter Brune }
3978646217ecSPeter Brune 
39794a2ae208SSatish Balay #undef __FUNCT__
39804a2ae208SSatish Balay #define __FUNCT__ "SNESSetOptionsPrefix"
39813c7409f5SSatish Balay /*@C
39823c7409f5SSatish Balay    SNESSetOptionsPrefix - Sets the prefix used for searching for all
3983d850072dSLois Curfman McInnes    SNES options in the database.
39843c7409f5SSatish Balay 
39853f9fe445SBarry Smith    Logically Collective on SNES
3986fee21e36SBarry Smith 
3987c7afd0dbSLois Curfman McInnes    Input Parameter:
3988c7afd0dbSLois Curfman McInnes +  snes - the SNES context
3989c7afd0dbSLois Curfman McInnes -  prefix - the prefix to prepend to all option names
3990c7afd0dbSLois Curfman McInnes 
3991d850072dSLois Curfman McInnes    Notes:
3992a83b1b31SSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
3993c7afd0dbSLois Curfman McInnes    The first character of all runtime options is AUTOMATICALLY the hyphen.
3994d850072dSLois Curfman McInnes 
399536851e7fSLois Curfman McInnes    Level: advanced
399636851e7fSLois Curfman McInnes 
39973c7409f5SSatish Balay .keywords: SNES, set, options, prefix, database
3998a86d99e1SLois Curfman McInnes 
3999a86d99e1SLois Curfman McInnes .seealso: SNESSetFromOptions()
40003c7409f5SSatish Balay @*/
40017087cfbeSBarry Smith PetscErrorCode  SNESSetOptionsPrefix(SNES snes,const char prefix[])
40023c7409f5SSatish Balay {
4003dfbe8321SBarry Smith   PetscErrorCode ierr;
40043c7409f5SSatish Balay 
40053a40ed3dSBarry Smith   PetscFunctionBegin;
40060700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4007639f9d9dSBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
40081cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
400935f5d045SPeter Brune   if (snes->linesearch) {
401035f5d045SPeter Brune     ierr = SNESGetSNESLineSearch(snes,&snes->linesearch);CHKERRQ(ierr);
401108b6c495SPeter Brune     ierr = PetscObjectSetOptionsPrefix((PetscObject)snes->linesearch,prefix);CHKERRQ(ierr);
401235f5d045SPeter Brune   }
401335f5d045SPeter Brune   ierr = KSPSetOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr);
40143a40ed3dSBarry Smith   PetscFunctionReturn(0);
40153c7409f5SSatish Balay }
40163c7409f5SSatish Balay 
40174a2ae208SSatish Balay #undef __FUNCT__
40184a2ae208SSatish Balay #define __FUNCT__ "SNESAppendOptionsPrefix"
40193c7409f5SSatish Balay /*@C
4020f525115eSLois Curfman McInnes    SNESAppendOptionsPrefix - Appends to the prefix used for searching for all
4021d850072dSLois Curfman McInnes    SNES options in the database.
40223c7409f5SSatish Balay 
40233f9fe445SBarry Smith    Logically Collective on SNES
4024fee21e36SBarry Smith 
4025c7afd0dbSLois Curfman McInnes    Input Parameters:
4026c7afd0dbSLois Curfman McInnes +  snes - the SNES context
4027c7afd0dbSLois Curfman McInnes -  prefix - the prefix to prepend to all option names
4028c7afd0dbSLois Curfman McInnes 
4029d850072dSLois Curfman McInnes    Notes:
4030a83b1b31SSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
4031c7afd0dbSLois Curfman McInnes    The first character of all runtime options is AUTOMATICALLY the hyphen.
4032d850072dSLois Curfman McInnes 
403336851e7fSLois Curfman McInnes    Level: advanced
403436851e7fSLois Curfman McInnes 
40353c7409f5SSatish Balay .keywords: SNES, append, options, prefix, database
4036a86d99e1SLois Curfman McInnes 
4037a86d99e1SLois Curfman McInnes .seealso: SNESGetOptionsPrefix()
40383c7409f5SSatish Balay @*/
40397087cfbeSBarry Smith PetscErrorCode  SNESAppendOptionsPrefix(SNES snes,const char prefix[])
40403c7409f5SSatish Balay {
4041dfbe8321SBarry Smith   PetscErrorCode ierr;
40423c7409f5SSatish Balay 
40433a40ed3dSBarry Smith   PetscFunctionBegin;
40440700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4045639f9d9dSBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
40461cee3971SBarry Smith   if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);}
404735f5d045SPeter Brune   if (snes->linesearch) {
404835f5d045SPeter Brune     ierr = SNESGetSNESLineSearch(snes,&snes->linesearch);CHKERRQ(ierr);
404908b6c495SPeter Brune     ierr = PetscObjectAppendOptionsPrefix((PetscObject)snes->linesearch,prefix);CHKERRQ(ierr);
405035f5d045SPeter Brune   }
405135f5d045SPeter Brune   ierr = KSPAppendOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr);
40523a40ed3dSBarry Smith   PetscFunctionReturn(0);
40533c7409f5SSatish Balay }
40543c7409f5SSatish Balay 
40554a2ae208SSatish Balay #undef __FUNCT__
40564a2ae208SSatish Balay #define __FUNCT__ "SNESGetOptionsPrefix"
40579ab63eb5SSatish Balay /*@C
40583c7409f5SSatish Balay    SNESGetOptionsPrefix - Sets the prefix used for searching for all
40593c7409f5SSatish Balay    SNES options in the database.
40603c7409f5SSatish Balay 
4061c7afd0dbSLois Curfman McInnes    Not Collective
4062c7afd0dbSLois Curfman McInnes 
40633c7409f5SSatish Balay    Input Parameter:
40643c7409f5SSatish Balay .  snes - the SNES context
40653c7409f5SSatish Balay 
40663c7409f5SSatish Balay    Output Parameter:
40673c7409f5SSatish Balay .  prefix - pointer to the prefix string used
40683c7409f5SSatish Balay 
40694ef407dbSRichard Tran Mills    Notes: On the fortran side, the user should pass in a string 'prefix' of
40709ab63eb5SSatish Balay    sufficient length to hold the prefix.
40719ab63eb5SSatish Balay 
407236851e7fSLois Curfman McInnes    Level: advanced
407336851e7fSLois Curfman McInnes 
40743c7409f5SSatish Balay .keywords: SNES, get, options, prefix, database
4075a86d99e1SLois Curfman McInnes 
4076a86d99e1SLois Curfman McInnes .seealso: SNESAppendOptionsPrefix()
40773c7409f5SSatish Balay @*/
40787087cfbeSBarry Smith PetscErrorCode  SNESGetOptionsPrefix(SNES snes,const char *prefix[])
40793c7409f5SSatish Balay {
4080dfbe8321SBarry Smith   PetscErrorCode ierr;
40813c7409f5SSatish Balay 
40823a40ed3dSBarry Smith   PetscFunctionBegin;
40830700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4084639f9d9dSBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr);
40853a40ed3dSBarry Smith   PetscFunctionReturn(0);
40863c7409f5SSatish Balay }
40873c7409f5SSatish Balay 
4088b2002411SLois Curfman McInnes 
40894a2ae208SSatish Balay #undef __FUNCT__
40904a2ae208SSatish Balay #define __FUNCT__ "SNESRegister"
40913cea93caSBarry Smith /*@C
40923cea93caSBarry Smith   SNESRegister - See SNESRegisterDynamic()
40933cea93caSBarry Smith 
40947f6c08e0SMatthew Knepley   Level: advanced
40953cea93caSBarry Smith @*/
40967087cfbeSBarry Smith PetscErrorCode  SNESRegister(const char sname[],const char path[],const char name[],PetscErrorCode (*function)(SNES))
4097b2002411SLois Curfman McInnes {
4098e2d1d2b7SBarry Smith   char           fullname[PETSC_MAX_PATH_LEN];
4099dfbe8321SBarry Smith   PetscErrorCode ierr;
4100b2002411SLois Curfman McInnes 
4101b2002411SLois Curfman McInnes   PetscFunctionBegin;
4102b0a32e0cSBarry Smith   ierr = PetscFListConcat(path,name,fullname);CHKERRQ(ierr);
4103c134de8dSSatish Balay   ierr = PetscFListAdd(&SNESList,sname,fullname,(void (*)(void))function);CHKERRQ(ierr);
4104b2002411SLois Curfman McInnes   PetscFunctionReturn(0);
4105b2002411SLois Curfman McInnes }
4106da9b6338SBarry Smith 
4107da9b6338SBarry Smith #undef __FUNCT__
4108da9b6338SBarry Smith #define __FUNCT__ "SNESTestLocalMin"
41097087cfbeSBarry Smith PetscErrorCode  SNESTestLocalMin(SNES snes)
4110da9b6338SBarry Smith {
4111dfbe8321SBarry Smith   PetscErrorCode ierr;
411277431f27SBarry Smith   PetscInt       N,i,j;
4113da9b6338SBarry Smith   Vec            u,uh,fh;
4114da9b6338SBarry Smith   PetscScalar    value;
4115da9b6338SBarry Smith   PetscReal      norm;
4116da9b6338SBarry Smith 
4117da9b6338SBarry Smith   PetscFunctionBegin;
4118da9b6338SBarry Smith   ierr = SNESGetSolution(snes,&u);CHKERRQ(ierr);
4119da9b6338SBarry Smith   ierr = VecDuplicate(u,&uh);CHKERRQ(ierr);
4120da9b6338SBarry Smith   ierr = VecDuplicate(u,&fh);CHKERRQ(ierr);
4121da9b6338SBarry Smith 
4122da9b6338SBarry Smith   /* currently only works for sequential */
4123da9b6338SBarry Smith   ierr = PetscPrintf(PETSC_COMM_WORLD,"Testing FormFunction() for local min\n");
4124da9b6338SBarry Smith   ierr = VecGetSize(u,&N);CHKERRQ(ierr);
4125da9b6338SBarry Smith   for (i=0; i<N; i++) {
4126da9b6338SBarry Smith     ierr = VecCopy(u,uh);CHKERRQ(ierr);
412777431f27SBarry Smith     ierr  = PetscPrintf(PETSC_COMM_WORLD,"i = %D\n",i);CHKERRQ(ierr);
4128da9b6338SBarry Smith     for (j=-10; j<11; j++) {
4129ccae9161SBarry Smith       value = PetscSign(j)*exp(PetscAbs(j)-10.0);
4130da9b6338SBarry Smith       ierr  = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr);
41313ab0aad5SBarry Smith       ierr  = SNESComputeFunction(snes,uh,fh);CHKERRQ(ierr);
4132da9b6338SBarry Smith       ierr  = VecNorm(fh,NORM_2,&norm);CHKERRQ(ierr);
413377431f27SBarry Smith       ierr  = PetscPrintf(PETSC_COMM_WORLD,"       j norm %D %18.16e\n",j,norm);CHKERRQ(ierr);
4134da9b6338SBarry Smith       value = -value;
4135da9b6338SBarry Smith       ierr  = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr);
4136da9b6338SBarry Smith     }
4137da9b6338SBarry Smith   }
41386bf464f9SBarry Smith   ierr = VecDestroy(&uh);CHKERRQ(ierr);
41396bf464f9SBarry Smith   ierr = VecDestroy(&fh);CHKERRQ(ierr);
4140da9b6338SBarry Smith   PetscFunctionReturn(0);
4141da9b6338SBarry Smith }
414271f87433Sdalcinl 
414371f87433Sdalcinl #undef __FUNCT__
4144fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetUseEW"
414571f87433Sdalcinl /*@
4146fa9f3622SBarry Smith    SNESKSPSetUseEW - Sets SNES use Eisenstat-Walker method for
414771f87433Sdalcinl    computing relative tolerance for linear solvers within an inexact
414871f87433Sdalcinl    Newton method.
414971f87433Sdalcinl 
41503f9fe445SBarry Smith    Logically Collective on SNES
415171f87433Sdalcinl 
415271f87433Sdalcinl    Input Parameters:
415371f87433Sdalcinl +  snes - SNES context
415471f87433Sdalcinl -  flag - PETSC_TRUE or PETSC_FALSE
415571f87433Sdalcinl 
415664ba62caSBarry Smith     Options Database:
415764ba62caSBarry Smith +  -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence
415864ba62caSBarry Smith .  -snes_ksp_ew_version ver - version of  Eisenstat-Walker method
415964ba62caSBarry Smith .  -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0
416064ba62caSBarry Smith .  -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax
416164ba62caSBarry Smith .  -snes_ksp_ew_gamma <gamma> - Sets gamma
416264ba62caSBarry Smith .  -snes_ksp_ew_alpha <alpha> - Sets alpha
416364ba62caSBarry Smith .  -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2
416464ba62caSBarry Smith -  -snes_ksp_ew_threshold <threshold> - Sets threshold
416564ba62caSBarry Smith 
416671f87433Sdalcinl    Notes:
416771f87433Sdalcinl    Currently, the default is to use a constant relative tolerance for
416871f87433Sdalcinl    the inner linear solvers.  Alternatively, one can use the
416971f87433Sdalcinl    Eisenstat-Walker method, where the relative convergence tolerance
417071f87433Sdalcinl    is reset at each Newton iteration according progress of the nonlinear
417171f87433Sdalcinl    solver.
417271f87433Sdalcinl 
417371f87433Sdalcinl    Level: advanced
417471f87433Sdalcinl 
417571f87433Sdalcinl    Reference:
417671f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
417771f87433Sdalcinl    inexact Newton method", SISC 17 (1), pp.16-32, 1996.
417871f87433Sdalcinl 
417971f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton
418071f87433Sdalcinl 
4181fa9f3622SBarry Smith .seealso: SNESKSPGetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW()
418271f87433Sdalcinl @*/
41837087cfbeSBarry Smith PetscErrorCode  SNESKSPSetUseEW(SNES snes,PetscBool  flag)
418471f87433Sdalcinl {
418571f87433Sdalcinl   PetscFunctionBegin;
41860700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4187acfcf0e5SJed Brown   PetscValidLogicalCollectiveBool(snes,flag,2);
418871f87433Sdalcinl   snes->ksp_ewconv = flag;
418971f87433Sdalcinl   PetscFunctionReturn(0);
419071f87433Sdalcinl }
419171f87433Sdalcinl 
419271f87433Sdalcinl #undef __FUNCT__
4193fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetUseEW"
419471f87433Sdalcinl /*@
4195fa9f3622SBarry Smith    SNESKSPGetUseEW - Gets if SNES is using Eisenstat-Walker method
419671f87433Sdalcinl    for computing relative tolerance for linear solvers within an
419771f87433Sdalcinl    inexact Newton method.
419871f87433Sdalcinl 
419971f87433Sdalcinl    Not Collective
420071f87433Sdalcinl 
420171f87433Sdalcinl    Input Parameter:
420271f87433Sdalcinl .  snes - SNES context
420371f87433Sdalcinl 
420471f87433Sdalcinl    Output Parameter:
420571f87433Sdalcinl .  flag - PETSC_TRUE or PETSC_FALSE
420671f87433Sdalcinl 
420771f87433Sdalcinl    Notes:
420871f87433Sdalcinl    Currently, the default is to use a constant relative tolerance for
420971f87433Sdalcinl    the inner linear solvers.  Alternatively, one can use the
421071f87433Sdalcinl    Eisenstat-Walker method, where the relative convergence tolerance
421171f87433Sdalcinl    is reset at each Newton iteration according progress of the nonlinear
421271f87433Sdalcinl    solver.
421371f87433Sdalcinl 
421471f87433Sdalcinl    Level: advanced
421571f87433Sdalcinl 
421671f87433Sdalcinl    Reference:
421771f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
421871f87433Sdalcinl    inexact Newton method", SISC 17 (1), pp.16-32, 1996.
421971f87433Sdalcinl 
422071f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton
422171f87433Sdalcinl 
4222fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW()
422371f87433Sdalcinl @*/
42247087cfbeSBarry Smith PetscErrorCode  SNESKSPGetUseEW(SNES snes, PetscBool  *flag)
422571f87433Sdalcinl {
422671f87433Sdalcinl   PetscFunctionBegin;
42270700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
422871f87433Sdalcinl   PetscValidPointer(flag,2);
422971f87433Sdalcinl   *flag = snes->ksp_ewconv;
423071f87433Sdalcinl   PetscFunctionReturn(0);
423171f87433Sdalcinl }
423271f87433Sdalcinl 
423371f87433Sdalcinl #undef __FUNCT__
4234fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetParametersEW"
423571f87433Sdalcinl /*@
4236fa9f3622SBarry Smith    SNESKSPSetParametersEW - Sets parameters for Eisenstat-Walker
423771f87433Sdalcinl    convergence criteria for the linear solvers within an inexact
423871f87433Sdalcinl    Newton method.
423971f87433Sdalcinl 
42403f9fe445SBarry Smith    Logically Collective on SNES
424171f87433Sdalcinl 
424271f87433Sdalcinl    Input Parameters:
424371f87433Sdalcinl +    snes - SNES context
424471f87433Sdalcinl .    version - version 1, 2 (default is 2) or 3
424571f87433Sdalcinl .    rtol_0 - initial relative tolerance (0 <= rtol_0 < 1)
424671f87433Sdalcinl .    rtol_max - maximum relative tolerance (0 <= rtol_max < 1)
424771f87433Sdalcinl .    gamma - multiplicative factor for version 2 rtol computation
424871f87433Sdalcinl              (0 <= gamma2 <= 1)
424971f87433Sdalcinl .    alpha - power for version 2 rtol computation (1 < alpha <= 2)
425071f87433Sdalcinl .    alpha2 - power for safeguard
425171f87433Sdalcinl -    threshold - threshold for imposing safeguard (0 < threshold < 1)
425271f87433Sdalcinl 
425371f87433Sdalcinl    Note:
425471f87433Sdalcinl    Version 3 was contributed by Luis Chacon, June 2006.
425571f87433Sdalcinl 
425671f87433Sdalcinl    Use PETSC_DEFAULT to retain the default for any of the parameters.
425771f87433Sdalcinl 
425871f87433Sdalcinl    Level: advanced
425971f87433Sdalcinl 
426071f87433Sdalcinl    Reference:
426171f87433Sdalcinl    S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an
426271f87433Sdalcinl    inexact Newton method", Utah State University Math. Stat. Dept. Res.
426371f87433Sdalcinl    Report 6/94/75, June, 1994, to appear in SIAM J. Sci. Comput.
426471f87433Sdalcinl 
426571f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, set, parameters
426671f87433Sdalcinl 
4267fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPGetParametersEW()
426871f87433Sdalcinl @*/
42697087cfbeSBarry Smith PetscErrorCode  SNESKSPSetParametersEW(SNES snes,PetscInt version,PetscReal rtol_0,PetscReal rtol_max,
427071f87433Sdalcinl 							    PetscReal gamma,PetscReal alpha,PetscReal alpha2,PetscReal threshold)
427171f87433Sdalcinl {
4272fa9f3622SBarry Smith   SNESKSPEW *kctx;
427371f87433Sdalcinl   PetscFunctionBegin;
42740700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4275fa9f3622SBarry Smith   kctx = (SNESKSPEW*)snes->kspconvctx;
4276e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing");
4277c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(snes,version,2);
4278c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol_0,3);
4279c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,rtol_max,4);
4280c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,gamma,5);
4281c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,alpha,6);
4282c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,alpha2,7);
4283c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(snes,threshold,8);
428471f87433Sdalcinl 
428571f87433Sdalcinl   if (version != PETSC_DEFAULT)   kctx->version   = version;
428671f87433Sdalcinl   if (rtol_0 != PETSC_DEFAULT)    kctx->rtol_0    = rtol_0;
428771f87433Sdalcinl   if (rtol_max != PETSC_DEFAULT)  kctx->rtol_max  = rtol_max;
428871f87433Sdalcinl   if (gamma != PETSC_DEFAULT)     kctx->gamma     = gamma;
428971f87433Sdalcinl   if (alpha != PETSC_DEFAULT)     kctx->alpha     = alpha;
429071f87433Sdalcinl   if (alpha2 != PETSC_DEFAULT)    kctx->alpha2    = alpha2;
429171f87433Sdalcinl   if (threshold != PETSC_DEFAULT) kctx->threshold = threshold;
429271f87433Sdalcinl 
429371f87433Sdalcinl   if (kctx->version < 1 || kctx->version > 3) {
4294e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 and 3 are supported: %D",kctx->version);
429571f87433Sdalcinl   }
429671f87433Sdalcinl   if (kctx->rtol_0 < 0.0 || kctx->rtol_0 >= 1.0) {
4297e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_0 < 1.0: %G",kctx->rtol_0);
429871f87433Sdalcinl   }
429971f87433Sdalcinl   if (kctx->rtol_max < 0.0 || kctx->rtol_max >= 1.0) {
4300e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_max (%G) < 1.0\n",kctx->rtol_max);
430171f87433Sdalcinl   }
430271f87433Sdalcinl   if (kctx->gamma < 0.0 || kctx->gamma > 1.0) {
4303e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= gamma (%G) <= 1.0\n",kctx->gamma);
430471f87433Sdalcinl   }
430571f87433Sdalcinl   if (kctx->alpha <= 1.0 || kctx->alpha > 2.0) {
4306e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"1.0 < alpha (%G) <= 2.0\n",kctx->alpha);
430771f87433Sdalcinl   }
430871f87433Sdalcinl   if (kctx->threshold <= 0.0 || kctx->threshold >= 1.0) {
4309e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 < threshold (%G) < 1.0\n",kctx->threshold);
431071f87433Sdalcinl   }
431171f87433Sdalcinl   PetscFunctionReturn(0);
431271f87433Sdalcinl }
431371f87433Sdalcinl 
431471f87433Sdalcinl #undef __FUNCT__
4315fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetParametersEW"
431671f87433Sdalcinl /*@
4317fa9f3622SBarry Smith    SNESKSPGetParametersEW - Gets parameters for Eisenstat-Walker
431871f87433Sdalcinl    convergence criteria for the linear solvers within an inexact
431971f87433Sdalcinl    Newton method.
432071f87433Sdalcinl 
432171f87433Sdalcinl    Not Collective
432271f87433Sdalcinl 
432371f87433Sdalcinl    Input Parameters:
432471f87433Sdalcinl      snes - SNES context
432571f87433Sdalcinl 
432671f87433Sdalcinl    Output Parameters:
432771f87433Sdalcinl +    version - version 1, 2 (default is 2) or 3
432871f87433Sdalcinl .    rtol_0 - initial relative tolerance (0 <= rtol_0 < 1)
432971f87433Sdalcinl .    rtol_max - maximum relative tolerance (0 <= rtol_max < 1)
433071f87433Sdalcinl .    gamma - multiplicative factor for version 2 rtol computation
433171f87433Sdalcinl              (0 <= gamma2 <= 1)
433271f87433Sdalcinl .    alpha - power for version 2 rtol computation (1 < alpha <= 2)
433371f87433Sdalcinl .    alpha2 - power for safeguard
433471f87433Sdalcinl -    threshold - threshold for imposing safeguard (0 < threshold < 1)
433571f87433Sdalcinl 
433671f87433Sdalcinl    Level: advanced
433771f87433Sdalcinl 
433871f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, get, parameters
433971f87433Sdalcinl 
4340fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPSetParametersEW()
434171f87433Sdalcinl @*/
43427087cfbeSBarry Smith PetscErrorCode  SNESKSPGetParametersEW(SNES snes,PetscInt *version,PetscReal *rtol_0,PetscReal *rtol_max,
434371f87433Sdalcinl 							    PetscReal *gamma,PetscReal *alpha,PetscReal *alpha2,PetscReal *threshold)
434471f87433Sdalcinl {
4345fa9f3622SBarry Smith   SNESKSPEW *kctx;
434671f87433Sdalcinl   PetscFunctionBegin;
43470700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4348fa9f3622SBarry Smith   kctx = (SNESKSPEW*)snes->kspconvctx;
4349e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing");
435071f87433Sdalcinl   if (version)   *version   = kctx->version;
435171f87433Sdalcinl   if (rtol_0)    *rtol_0    = kctx->rtol_0;
435271f87433Sdalcinl   if (rtol_max)  *rtol_max  = kctx->rtol_max;
435371f87433Sdalcinl   if (gamma)     *gamma     = kctx->gamma;
435471f87433Sdalcinl   if (alpha)     *alpha     = kctx->alpha;
435571f87433Sdalcinl   if (alpha2)    *alpha2    = kctx->alpha2;
435671f87433Sdalcinl   if (threshold) *threshold = kctx->threshold;
435771f87433Sdalcinl   PetscFunctionReturn(0);
435871f87433Sdalcinl }
435971f87433Sdalcinl 
436071f87433Sdalcinl #undef __FUNCT__
4361fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PreSolve"
4362fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PreSolve(SNES snes, KSP ksp, Vec b, Vec x)
436371f87433Sdalcinl {
436471f87433Sdalcinl   PetscErrorCode ierr;
4365fa9f3622SBarry Smith   SNESKSPEW      *kctx = (SNESKSPEW*)snes->kspconvctx;
436671f87433Sdalcinl   PetscReal      rtol=PETSC_DEFAULT,stol;
436771f87433Sdalcinl 
436871f87433Sdalcinl   PetscFunctionBegin;
4369e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists");
437071f87433Sdalcinl   if (!snes->iter) { /* first time in, so use the original user rtol */
437171f87433Sdalcinl     rtol = kctx->rtol_0;
437271f87433Sdalcinl   } else {
437371f87433Sdalcinl     if (kctx->version == 1) {
437471f87433Sdalcinl       rtol = (snes->norm - kctx->lresid_last)/kctx->norm_last;
437571f87433Sdalcinl       if (rtol < 0.0) rtol = -rtol;
437671f87433Sdalcinl       stol = pow(kctx->rtol_last,kctx->alpha2);
437771f87433Sdalcinl       if (stol > kctx->threshold) rtol = PetscMax(rtol,stol);
437871f87433Sdalcinl     } else if (kctx->version == 2) {
437971f87433Sdalcinl       rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha);
438071f87433Sdalcinl       stol = kctx->gamma * pow(kctx->rtol_last,kctx->alpha);
438171f87433Sdalcinl       if (stol > kctx->threshold) rtol = PetscMax(rtol,stol);
438271f87433Sdalcinl     } else if (kctx->version == 3) {/* contributed by Luis Chacon, June 2006. */
438371f87433Sdalcinl       rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha);
438471f87433Sdalcinl       /* safeguard: avoid sharp decrease of rtol */
438571f87433Sdalcinl       stol = kctx->gamma*pow(kctx->rtol_last,kctx->alpha);
438671f87433Sdalcinl       stol = PetscMax(rtol,stol);
438771f87433Sdalcinl       rtol = PetscMin(kctx->rtol_0,stol);
438871f87433Sdalcinl       /* safeguard: avoid oversolving */
438971f87433Sdalcinl       stol = kctx->gamma*(snes->ttol)/snes->norm;
439071f87433Sdalcinl       stol = PetscMax(rtol,stol);
439171f87433Sdalcinl       rtol = PetscMin(kctx->rtol_0,stol);
4392e32f2f54SBarry Smith     } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 or 3 are supported: %D",kctx->version);
439371f87433Sdalcinl   }
439471f87433Sdalcinl   /* safeguard: avoid rtol greater than one */
439571f87433Sdalcinl   rtol = PetscMin(rtol,kctx->rtol_max);
439671f87433Sdalcinl   ierr = KSPSetTolerances(ksp,rtol,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT);CHKERRQ(ierr);
439771f87433Sdalcinl   ierr = PetscInfo3(snes,"iter %D, Eisenstat-Walker (version %D) KSP rtol=%G\n",snes->iter,kctx->version,rtol);CHKERRQ(ierr);
439871f87433Sdalcinl   PetscFunctionReturn(0);
439971f87433Sdalcinl }
440071f87433Sdalcinl 
440171f87433Sdalcinl #undef __FUNCT__
4402fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PostSolve"
4403fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PostSolve(SNES snes, KSP ksp, Vec b, Vec x)
440471f87433Sdalcinl {
440571f87433Sdalcinl   PetscErrorCode ierr;
4406fa9f3622SBarry Smith   SNESKSPEW      *kctx = (SNESKSPEW*)snes->kspconvctx;
440771f87433Sdalcinl   PCSide         pcside;
440871f87433Sdalcinl   Vec            lres;
440971f87433Sdalcinl 
441071f87433Sdalcinl   PetscFunctionBegin;
4411e32f2f54SBarry Smith   if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists");
441271f87433Sdalcinl   ierr = KSPGetTolerances(ksp,&kctx->rtol_last,0,0,0);CHKERRQ(ierr);
441371f87433Sdalcinl   ierr = SNESGetFunctionNorm(snes,&kctx->norm_last);CHKERRQ(ierr);
441471f87433Sdalcinl   if (kctx->version == 1) {
4415b037da10SBarry Smith     ierr = KSPGetPCSide(ksp,&pcside);CHKERRQ(ierr);
441671f87433Sdalcinl     if (pcside == PC_RIGHT) { /* XXX Should we also test KSP_UNPRECONDITIONED_NORM ? */
441771f87433Sdalcinl       /* KSP residual is true linear residual */
441871f87433Sdalcinl       ierr = KSPGetResidualNorm(ksp,&kctx->lresid_last);CHKERRQ(ierr);
441971f87433Sdalcinl     } else {
442071f87433Sdalcinl       /* KSP residual is preconditioned residual */
442171f87433Sdalcinl       /* compute true linear residual norm */
442271f87433Sdalcinl       ierr = VecDuplicate(b,&lres);CHKERRQ(ierr);
442371f87433Sdalcinl       ierr = MatMult(snes->jacobian,x,lres);CHKERRQ(ierr);
442471f87433Sdalcinl       ierr = VecAYPX(lres,-1.0,b);CHKERRQ(ierr);
442571f87433Sdalcinl       ierr = VecNorm(lres,NORM_2,&kctx->lresid_last);CHKERRQ(ierr);
44266bf464f9SBarry Smith       ierr = VecDestroy(&lres);CHKERRQ(ierr);
442771f87433Sdalcinl     }
442871f87433Sdalcinl   }
442971f87433Sdalcinl   PetscFunctionReturn(0);
443071f87433Sdalcinl }
443171f87433Sdalcinl 
443271f87433Sdalcinl #undef __FUNCT__
443371f87433Sdalcinl #define __FUNCT__ "SNES_KSPSolve"
443471f87433Sdalcinl PetscErrorCode SNES_KSPSolve(SNES snes, KSP ksp, Vec b, Vec x)
443571f87433Sdalcinl {
443671f87433Sdalcinl   PetscErrorCode ierr;
443771f87433Sdalcinl 
443871f87433Sdalcinl   PetscFunctionBegin;
4439fa9f3622SBarry Smith   if (snes->ksp_ewconv) { ierr = SNESKSPEW_PreSolve(snes,ksp,b,x);CHKERRQ(ierr);  }
444071f87433Sdalcinl   ierr = KSPSolve(ksp,b,x);CHKERRQ(ierr);
4441fa9f3622SBarry Smith   if (snes->ksp_ewconv) { ierr = SNESKSPEW_PostSolve(snes,ksp,b,x);CHKERRQ(ierr); }
444271f87433Sdalcinl   PetscFunctionReturn(0);
444371f87433Sdalcinl }
44446c699258SBarry Smith 
44456c699258SBarry Smith #undef __FUNCT__
44466c699258SBarry Smith #define __FUNCT__ "SNESSetDM"
44476c699258SBarry Smith /*@
44486c699258SBarry Smith    SNESSetDM - Sets the DM that may be used by some preconditioners
44496c699258SBarry Smith 
44503f9fe445SBarry Smith    Logically Collective on SNES
44516c699258SBarry Smith 
44526c699258SBarry Smith    Input Parameters:
44536c699258SBarry Smith +  snes - the preconditioner context
44546c699258SBarry Smith -  dm - the dm
44556c699258SBarry Smith 
44566c699258SBarry Smith    Level: intermediate
44576c699258SBarry Smith 
44586c699258SBarry Smith 
44596c699258SBarry Smith .seealso: SNESGetDM(), KSPSetDM(), KSPGetDM()
44606c699258SBarry Smith @*/
44617087cfbeSBarry Smith PetscErrorCode  SNESSetDM(SNES snes,DM dm)
44626c699258SBarry Smith {
44636c699258SBarry Smith   PetscErrorCode ierr;
4464345fed2cSBarry Smith   KSP            ksp;
44656cab3a1bSJed Brown   SNESDM         sdm;
44666c699258SBarry Smith 
44676c699258SBarry Smith   PetscFunctionBegin;
44680700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4469d0660788SBarry Smith   if (dm) {ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);}
44706cab3a1bSJed Brown   if (snes->dm) {               /* Move the SNESDM context over to the new DM unless the new DM already has one */
44716cab3a1bSJed Brown     PetscContainer oldcontainer,container;
44726cab3a1bSJed Brown     ierr = PetscObjectQuery((PetscObject)snes->dm,"SNESDM",(PetscObject*)&oldcontainer);CHKERRQ(ierr);
44736cab3a1bSJed Brown     ierr = PetscObjectQuery((PetscObject)dm,"SNESDM",(PetscObject*)&container);CHKERRQ(ierr);
4474116d1032SJed Brown     if (oldcontainer && snes->dmAuto && !container) {
44756cab3a1bSJed Brown       ierr = DMSNESCopyContext(snes->dm,dm);CHKERRQ(ierr);
44766cab3a1bSJed Brown       ierr = DMSNESGetContext(snes->dm,&sdm);CHKERRQ(ierr);
44776cab3a1bSJed Brown       if (sdm->originaldm == snes->dm) { /* Grant write privileges to the replacement DM */
44786cab3a1bSJed Brown         sdm->originaldm = dm;
44796cab3a1bSJed Brown       }
44806cab3a1bSJed Brown     }
44816bf464f9SBarry Smith     ierr = DMDestroy(&snes->dm);CHKERRQ(ierr);
44826cab3a1bSJed Brown   }
44836c699258SBarry Smith   snes->dm = dm;
4484116d1032SJed Brown   snes->dmAuto = PETSC_FALSE;
4485345fed2cSBarry Smith   ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
4486345fed2cSBarry Smith   ierr = KSPSetDM(ksp,dm);CHKERRQ(ierr);
4487f22f69f0SBarry Smith   ierr = KSPSetDMActive(ksp,PETSC_FALSE);CHKERRQ(ierr);
44882c155ee1SBarry Smith   if (snes->pc) {
44892c155ee1SBarry Smith     ierr = SNESSetDM(snes->pc, snes->dm);CHKERRQ(ierr);
4490c40d0f55SPeter Brune     ierr = SNESSetPCSide(snes,snes->pcside);CHKERRQ(ierr);
44912c155ee1SBarry Smith   }
44926c699258SBarry Smith   PetscFunctionReturn(0);
44936c699258SBarry Smith }
44946c699258SBarry Smith 
44956c699258SBarry Smith #undef __FUNCT__
44966c699258SBarry Smith #define __FUNCT__ "SNESGetDM"
44976c699258SBarry Smith /*@
44986c699258SBarry Smith    SNESGetDM - Gets the DM that may be used by some preconditioners
44996c699258SBarry Smith 
45003f9fe445SBarry Smith    Not Collective but DM obtained is parallel on SNES
45016c699258SBarry Smith 
45026c699258SBarry Smith    Input Parameter:
45036c699258SBarry Smith . snes - the preconditioner context
45046c699258SBarry Smith 
45056c699258SBarry Smith    Output Parameter:
45066c699258SBarry Smith .  dm - the dm
45076c699258SBarry Smith 
45086c699258SBarry Smith    Level: intermediate
45096c699258SBarry Smith 
45106c699258SBarry Smith 
45116c699258SBarry Smith .seealso: SNESSetDM(), KSPSetDM(), KSPGetDM()
45126c699258SBarry Smith @*/
45137087cfbeSBarry Smith PetscErrorCode  SNESGetDM(SNES snes,DM *dm)
45146c699258SBarry Smith {
45156cab3a1bSJed Brown   PetscErrorCode ierr;
45166cab3a1bSJed Brown 
45176c699258SBarry Smith   PetscFunctionBegin;
45180700a824SBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
45196cab3a1bSJed Brown   if (!snes->dm) {
45206cab3a1bSJed Brown     ierr = DMShellCreate(((PetscObject)snes)->comm,&snes->dm);CHKERRQ(ierr);
4521116d1032SJed Brown     snes->dmAuto = PETSC_TRUE;
45226cab3a1bSJed Brown   }
45236c699258SBarry Smith   *dm = snes->dm;
45246c699258SBarry Smith   PetscFunctionReturn(0);
45256c699258SBarry Smith }
45260807856dSBarry Smith 
452731823bd8SMatthew G Knepley #undef __FUNCT__
452831823bd8SMatthew G Knepley #define __FUNCT__ "SNESSetPC"
452931823bd8SMatthew G Knepley /*@
4530fd4b34e9SJed Brown   SNESSetPC - Sets the nonlinear preconditioner to be used.
453131823bd8SMatthew G Knepley 
453231823bd8SMatthew G Knepley   Collective on SNES
453331823bd8SMatthew G Knepley 
453431823bd8SMatthew G Knepley   Input Parameters:
453531823bd8SMatthew G Knepley + snes - iterative context obtained from SNESCreate()
453631823bd8SMatthew G Knepley - pc   - the preconditioner object
453731823bd8SMatthew G Knepley 
453831823bd8SMatthew G Knepley   Notes:
453931823bd8SMatthew G Knepley   Use SNESGetPC() to retrieve the preconditioner context (for example,
454031823bd8SMatthew G Knepley   to configure it using the API).
454131823bd8SMatthew G Knepley 
454231823bd8SMatthew G Knepley   Level: developer
454331823bd8SMatthew G Knepley 
454431823bd8SMatthew G Knepley .keywords: SNES, set, precondition
454531823bd8SMatthew G Knepley .seealso: SNESGetPC()
454631823bd8SMatthew G Knepley @*/
454731823bd8SMatthew G Knepley PetscErrorCode SNESSetPC(SNES snes, SNES pc)
454831823bd8SMatthew G Knepley {
454931823bd8SMatthew G Knepley   PetscErrorCode ierr;
455031823bd8SMatthew G Knepley 
455131823bd8SMatthew G Knepley   PetscFunctionBegin;
455231823bd8SMatthew G Knepley   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
455331823bd8SMatthew G Knepley   PetscValidHeaderSpecific(pc, SNES_CLASSID, 2);
455431823bd8SMatthew G Knepley   PetscCheckSameComm(snes, 1, pc, 2);
455531823bd8SMatthew G Knepley   ierr = PetscObjectReference((PetscObject) pc);CHKERRQ(ierr);
4556bf11d3b6SBarry Smith   ierr = SNESDestroy(&snes->pc);CHKERRQ(ierr);
455731823bd8SMatthew G Knepley   snes->pc = pc;
455831823bd8SMatthew G Knepley   ierr = PetscLogObjectParent(snes, snes->pc);CHKERRQ(ierr);
455931823bd8SMatthew G Knepley   PetscFunctionReturn(0);
456031823bd8SMatthew G Knepley }
456131823bd8SMatthew G Knepley 
456231823bd8SMatthew G Knepley #undef __FUNCT__
456331823bd8SMatthew G Knepley #define __FUNCT__ "SNESGetPC"
456431823bd8SMatthew G Knepley /*@
4565fd4b34e9SJed Brown   SNESGetPC - Returns a pointer to the nonlinear preconditioning context set with SNESSetPC().
456631823bd8SMatthew G Knepley 
456731823bd8SMatthew G Knepley   Not Collective
456831823bd8SMatthew G Knepley 
456931823bd8SMatthew G Knepley   Input Parameter:
457031823bd8SMatthew G Knepley . snes - iterative context obtained from SNESCreate()
457131823bd8SMatthew G Knepley 
457231823bd8SMatthew G Knepley   Output Parameter:
457331823bd8SMatthew G Knepley . pc - preconditioner context
457431823bd8SMatthew G Knepley 
457531823bd8SMatthew G Knepley   Level: developer
457631823bd8SMatthew G Knepley 
457731823bd8SMatthew G Knepley .keywords: SNES, get, preconditioner
457831823bd8SMatthew G Knepley .seealso: SNESSetPC()
457931823bd8SMatthew G Knepley @*/
458031823bd8SMatthew G Knepley PetscErrorCode SNESGetPC(SNES snes, SNES *pc)
458131823bd8SMatthew G Knepley {
458231823bd8SMatthew G Knepley   PetscErrorCode              ierr;
4583a64e098fSPeter Brune   const char                  *optionsprefix;
458431823bd8SMatthew G Knepley 
458531823bd8SMatthew G Knepley   PetscFunctionBegin;
458631823bd8SMatthew G Knepley   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
458731823bd8SMatthew G Knepley   PetscValidPointer(pc, 2);
458831823bd8SMatthew G Knepley   if (!snes->pc) {
458931823bd8SMatthew G Knepley     ierr = SNESCreate(((PetscObject) snes)->comm,&snes->pc);CHKERRQ(ierr);
45904a0c5b0cSMatthew G Knepley     ierr = PetscObjectIncrementTabLevel((PetscObject)snes->pc,(PetscObject)snes,1);CHKERRQ(ierr);
459131823bd8SMatthew G Knepley     ierr = PetscLogObjectParent(snes,snes->pc);CHKERRQ(ierr);
4592a64e098fSPeter Brune     ierr = SNESGetOptionsPrefix(snes,&optionsprefix);CHKERRQ(ierr);
4593a64e098fSPeter Brune     ierr = SNESSetOptionsPrefix(snes->pc,optionsprefix);CHKERRQ(ierr);
4594a64e098fSPeter Brune     ierr = SNESAppendOptionsPrefix(snes->pc,"npc_");CHKERRQ(ierr);
459531823bd8SMatthew G Knepley   }
459631823bd8SMatthew G Knepley   *pc = snes->pc;
459731823bd8SMatthew G Knepley   PetscFunctionReturn(0);
459831823bd8SMatthew G Knepley }
459931823bd8SMatthew G Knepley 
4600c40d0f55SPeter Brune 
4601c40d0f55SPeter Brune #undef __FUNCT__
4602c40d0f55SPeter Brune #define __FUNCT__ "SNESSetPCSide"
4603c40d0f55SPeter Brune /*@
4604c40d0f55SPeter Brune     SNESSetPCSide - Sets the preconditioning side.
4605c40d0f55SPeter Brune 
4606c40d0f55SPeter Brune     Logically Collective on SNES
4607c40d0f55SPeter Brune 
4608c40d0f55SPeter Brune     Input Parameter:
4609c40d0f55SPeter Brune .   snes - iterative context obtained from SNESCreate()
4610c40d0f55SPeter Brune 
4611c40d0f55SPeter Brune     Output Parameter:
4612c40d0f55SPeter Brune .   side - the preconditioning side, where side is one of
4613c40d0f55SPeter Brune .vb
4614c40d0f55SPeter Brune       PC_LEFT - left preconditioning (default)
4615c40d0f55SPeter Brune       PC_RIGHT - right preconditioning
4616c40d0f55SPeter Brune .ve
4617c40d0f55SPeter Brune 
4618c40d0f55SPeter Brune     Options Database Keys:
4619c40d0f55SPeter Brune .   -snes_pc_side <right,left>
4620c40d0f55SPeter Brune 
4621c40d0f55SPeter Brune     Level: intermediate
4622c40d0f55SPeter Brune 
4623c40d0f55SPeter Brune .keywords: SNES, set, right, left, side, preconditioner, flag
4624c40d0f55SPeter Brune 
4625c40d0f55SPeter Brune .seealso: SNESGetPCSide(), KSPSetPCSide()
4626c40d0f55SPeter Brune @*/
4627c40d0f55SPeter Brune PetscErrorCode  SNESSetPCSide(SNES snes,PCSide side)
4628c40d0f55SPeter Brune {
4629c40d0f55SPeter Brune   PetscFunctionBegin;
4630c40d0f55SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4631c40d0f55SPeter Brune   PetscValidLogicalCollectiveEnum(snes,side,2);
4632c40d0f55SPeter Brune   snes->pcside = side;
4633c40d0f55SPeter Brune   PetscFunctionReturn(0);
4634c40d0f55SPeter Brune }
4635c40d0f55SPeter Brune 
4636c40d0f55SPeter Brune #undef __FUNCT__
4637c40d0f55SPeter Brune #define __FUNCT__ "SNESGetPCSide"
4638c40d0f55SPeter Brune /*@
4639c40d0f55SPeter Brune     SNESGetPCSide - Gets the preconditioning side.
4640c40d0f55SPeter Brune 
4641c40d0f55SPeter Brune     Not Collective
4642c40d0f55SPeter Brune 
4643c40d0f55SPeter Brune     Input Parameter:
4644c40d0f55SPeter Brune .   snes - iterative context obtained from SNESCreate()
4645c40d0f55SPeter Brune 
4646c40d0f55SPeter Brune     Output Parameter:
4647c40d0f55SPeter Brune .   side - the preconditioning side, where side is one of
4648c40d0f55SPeter Brune .vb
4649c40d0f55SPeter Brune       PC_LEFT - left preconditioning (default)
4650c40d0f55SPeter Brune       PC_RIGHT - right preconditioning
4651c40d0f55SPeter Brune .ve
4652c40d0f55SPeter Brune 
4653c40d0f55SPeter Brune     Level: intermediate
4654c40d0f55SPeter Brune 
4655c40d0f55SPeter Brune .keywords: SNES, get, right, left, side, preconditioner, flag
4656c40d0f55SPeter Brune 
4657c40d0f55SPeter Brune .seealso: SNESSetPCSide(), KSPGetPCSide()
4658c40d0f55SPeter Brune @*/
4659c40d0f55SPeter Brune PetscErrorCode  SNESGetPCSide(SNES snes,PCSide *side)
4660c40d0f55SPeter Brune {
4661c40d0f55SPeter Brune   PetscFunctionBegin;
4662c40d0f55SPeter Brune   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4663c40d0f55SPeter Brune   PetscValidPointer(side,2);
4664c40d0f55SPeter Brune   *side = snes->pcside;
4665c40d0f55SPeter Brune   PetscFunctionReturn(0);
4666c40d0f55SPeter Brune }
4667c40d0f55SPeter Brune 
46689e764e56SPeter Brune #undef __FUNCT__
4669f1c6b773SPeter Brune #define __FUNCT__ "SNESSetSNESLineSearch"
46709e764e56SPeter Brune /*@
46718141a3b9SPeter Brune   SNESSetSNESLineSearch - Sets the linesearch on the SNES instance.
46729e764e56SPeter Brune 
46739e764e56SPeter Brune   Collective on SNES
46749e764e56SPeter Brune 
46759e764e56SPeter Brune   Input Parameters:
46769e764e56SPeter Brune + snes - iterative context obtained from SNESCreate()
46779e764e56SPeter Brune - linesearch   - the linesearch object
46789e764e56SPeter Brune 
46799e764e56SPeter Brune   Notes:
4680f1c6b773SPeter Brune   Use SNESGetSNESLineSearch() to retrieve the preconditioner context (for example,
46819e764e56SPeter Brune   to configure it using the API).
46829e764e56SPeter Brune 
46839e764e56SPeter Brune   Level: developer
46849e764e56SPeter Brune 
46859e764e56SPeter Brune .keywords: SNES, set, linesearch
4686f1c6b773SPeter Brune .seealso: SNESGetSNESLineSearch()
46879e764e56SPeter Brune @*/
4688f1c6b773SPeter Brune PetscErrorCode SNESSetSNESLineSearch(SNES snes, SNESLineSearch linesearch)
46899e764e56SPeter Brune {
46909e764e56SPeter Brune   PetscErrorCode ierr;
46919e764e56SPeter Brune 
46929e764e56SPeter Brune   PetscFunctionBegin;
46939e764e56SPeter Brune   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
4694f1c6b773SPeter Brune   PetscValidHeaderSpecific(linesearch, SNESLINESEARCH_CLASSID, 2);
46959e764e56SPeter Brune   PetscCheckSameComm(snes, 1, linesearch, 2);
46969e764e56SPeter Brune   ierr = PetscObjectReference((PetscObject) linesearch);CHKERRQ(ierr);
4697f1c6b773SPeter Brune   ierr = SNESLineSearchDestroy(&snes->linesearch);CHKERRQ(ierr);
46989e764e56SPeter Brune   snes->linesearch = linesearch;
46999e764e56SPeter Brune   ierr = PetscLogObjectParent(snes, snes->linesearch);CHKERRQ(ierr);
47009e764e56SPeter Brune   PetscFunctionReturn(0);
47019e764e56SPeter Brune }
47029e764e56SPeter Brune 
47039e764e56SPeter Brune #undef __FUNCT__
4704f1c6b773SPeter Brune #define __FUNCT__ "SNESGetSNESLineSearch"
4705ea5d4fccSPeter Brune /*@C
47068141a3b9SPeter Brune   SNESGetSNESLineSearch - Returns a pointer to the line search context set with SNESSetLineSearch()
47078141a3b9SPeter Brune   or creates a default line search instance associated with the SNES and returns it.
47089e764e56SPeter Brune 
47099e764e56SPeter Brune   Not Collective
47109e764e56SPeter Brune 
47119e764e56SPeter Brune   Input Parameter:
47129e764e56SPeter Brune . snes - iterative context obtained from SNESCreate()
47139e764e56SPeter Brune 
47149e764e56SPeter Brune   Output Parameter:
47159e764e56SPeter Brune . linesearch - linesearch context
47169e764e56SPeter Brune 
47179e764e56SPeter Brune   Level: developer
47189e764e56SPeter Brune 
47199e764e56SPeter Brune .keywords: SNES, get, linesearch
4720f1c6b773SPeter Brune .seealso: SNESSetSNESLineSearch()
47219e764e56SPeter Brune @*/
4722f1c6b773SPeter Brune PetscErrorCode SNESGetSNESLineSearch(SNES snes, SNESLineSearch *linesearch)
47239e764e56SPeter Brune {
47249e764e56SPeter Brune   PetscErrorCode ierr;
47259e764e56SPeter Brune   const char     *optionsprefix;
47269e764e56SPeter Brune 
47279e764e56SPeter Brune   PetscFunctionBegin;
47289e764e56SPeter Brune   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
47299e764e56SPeter Brune   PetscValidPointer(linesearch, 2);
47309e764e56SPeter Brune   if (!snes->linesearch) {
47319e764e56SPeter Brune     ierr = SNESGetOptionsPrefix(snes, &optionsprefix);CHKERRQ(ierr);
4732f1c6b773SPeter Brune     ierr = SNESLineSearchCreate(((PetscObject) snes)->comm, &snes->linesearch);CHKERRQ(ierr);
4733f1c6b773SPeter Brune     ierr = SNESLineSearchSetSNES(snes->linesearch, snes);CHKERRQ(ierr);
4734b1dca40bSPeter Brune     ierr = SNESLineSearchAppendOptionsPrefix(snes->linesearch, optionsprefix);CHKERRQ(ierr);
47359e764e56SPeter Brune     ierr = PetscObjectIncrementTabLevel((PetscObject) snes->linesearch, (PetscObject) snes, 1);CHKERRQ(ierr);
47369e764e56SPeter Brune     ierr = PetscLogObjectParent(snes, snes->linesearch);CHKERRQ(ierr);
47379e764e56SPeter Brune   }
47389e764e56SPeter Brune   *linesearch = snes->linesearch;
47399e764e56SPeter Brune   PetscFunctionReturn(0);
47409e764e56SPeter Brune }
47419e764e56SPeter Brune 
474269b4f73cSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
4743c6db04a5SJed Brown #include <mex.h>
474469b4f73cSBarry Smith 
47458f6e6473SBarry Smith typedef struct {char *funcname; mxArray *ctx;} SNESMatlabContext;
47468f6e6473SBarry Smith 
47470807856dSBarry Smith #undef __FUNCT__
47480807856dSBarry Smith #define __FUNCT__ "SNESComputeFunction_Matlab"
47490807856dSBarry Smith /*
47500807856dSBarry Smith    SNESComputeFunction_Matlab - Calls the function that has been set with
47510807856dSBarry Smith                          SNESSetFunctionMatlab().
47520807856dSBarry Smith 
47530807856dSBarry Smith    Collective on SNES
47540807856dSBarry Smith 
47550807856dSBarry Smith    Input Parameters:
47560807856dSBarry Smith +  snes - the SNES context
47570807856dSBarry Smith -  x - input vector
47580807856dSBarry Smith 
47590807856dSBarry Smith    Output Parameter:
47600807856dSBarry Smith .  y - function vector, as set by SNESSetFunction()
47610807856dSBarry Smith 
47620807856dSBarry Smith    Notes:
47630807856dSBarry Smith    SNESComputeFunction() is typically used within nonlinear solvers
47640807856dSBarry Smith    implementations, so most users would not generally call this routine
47650807856dSBarry Smith    themselves.
47660807856dSBarry Smith 
47670807856dSBarry Smith    Level: developer
47680807856dSBarry Smith 
47690807856dSBarry Smith .keywords: SNES, nonlinear, compute, function
47700807856dSBarry Smith 
47710807856dSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction()
477261b2408cSBarry Smith */
47737087cfbeSBarry Smith PetscErrorCode  SNESComputeFunction_Matlab(SNES snes,Vec x,Vec y, void *ctx)
47740807856dSBarry Smith {
4775e650e774SBarry Smith   PetscErrorCode    ierr;
47768f6e6473SBarry Smith   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
47778f6e6473SBarry Smith   int               nlhs = 1,nrhs = 5;
47788f6e6473SBarry Smith   mxArray	    *plhs[1],*prhs[5];
477991621f2eSBarry Smith   long long int     lx = 0,ly = 0,ls = 0;
4780e650e774SBarry Smith 
47810807856dSBarry Smith   PetscFunctionBegin;
47820807856dSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
47830807856dSBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
47840807856dSBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
47850807856dSBarry Smith   PetscCheckSameComm(snes,1,x,2);
47860807856dSBarry Smith   PetscCheckSameComm(snes,1,y,3);
47870807856dSBarry Smith 
47880807856dSBarry Smith   /* call Matlab function in ctx with arguments x and y */
4789e650e774SBarry Smith 
479091621f2eSBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
4791e650e774SBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
4792e650e774SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(x));CHKERRQ(ierr);
479391621f2eSBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
479491621f2eSBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)lx);
479591621f2eSBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)ly);
47968f6e6473SBarry Smith   prhs[3] =  mxCreateString(sctx->funcname);
47978f6e6473SBarry Smith   prhs[4] =  sctx->ctx;
4798b807a863SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeFunctionInternal");CHKERRQ(ierr);
4799e650e774SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4800e650e774SBarry Smith   mxDestroyArray(prhs[0]);
4801e650e774SBarry Smith   mxDestroyArray(prhs[1]);
4802e650e774SBarry Smith   mxDestroyArray(prhs[2]);
48038f6e6473SBarry Smith   mxDestroyArray(prhs[3]);
4804e650e774SBarry Smith   mxDestroyArray(plhs[0]);
48050807856dSBarry Smith   PetscFunctionReturn(0);
48060807856dSBarry Smith }
48070807856dSBarry Smith 
48080807856dSBarry Smith 
48090807856dSBarry Smith #undef __FUNCT__
48100807856dSBarry Smith #define __FUNCT__ "SNESSetFunctionMatlab"
481161b2408cSBarry Smith /*
48120807856dSBarry Smith    SNESSetFunctionMatlab - Sets the function evaluation routine and function
48130807856dSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
4814e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
48150807856dSBarry Smith 
48160807856dSBarry Smith    Logically Collective on SNES
48170807856dSBarry Smith 
48180807856dSBarry Smith    Input Parameters:
48190807856dSBarry Smith +  snes - the SNES context
48200807856dSBarry Smith .  r - vector to store function value
48210807856dSBarry Smith -  func - function evaluation routine
48220807856dSBarry Smith 
48230807856dSBarry Smith    Calling sequence of func:
482461b2408cSBarry Smith $    func (SNES snes,Vec x,Vec f,void *ctx);
48250807856dSBarry Smith 
48260807856dSBarry Smith 
48270807856dSBarry Smith    Notes:
48280807856dSBarry Smith    The Newton-like methods typically solve linear systems of the form
48290807856dSBarry Smith $      f'(x) x = -f(x),
48300807856dSBarry Smith    where f'(x) denotes the Jacobian matrix and f(x) is the function.
48310807856dSBarry Smith 
48320807856dSBarry Smith    Level: beginner
48330807856dSBarry Smith 
48340807856dSBarry Smith .keywords: SNES, nonlinear, set, function
48350807856dSBarry Smith 
48360807856dSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
483761b2408cSBarry Smith */
48387087cfbeSBarry Smith PetscErrorCode  SNESSetFunctionMatlab(SNES snes,Vec r,const char *func,mxArray *ctx)
48390807856dSBarry Smith {
48400807856dSBarry Smith   PetscErrorCode    ierr;
48418f6e6473SBarry Smith   SNESMatlabContext *sctx;
48420807856dSBarry Smith 
48430807856dSBarry Smith   PetscFunctionBegin;
48448f6e6473SBarry Smith   /* currently sctx is memory bleed */
48458f6e6473SBarry Smith   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
48468f6e6473SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
48478f6e6473SBarry Smith   /*
48488f6e6473SBarry Smith      This should work, but it doesn't
48498f6e6473SBarry Smith   sctx->ctx = ctx;
48508f6e6473SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
48518f6e6473SBarry Smith   */
48528f6e6473SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
48538f6e6473SBarry Smith   ierr = SNESSetFunction(snes,r,SNESComputeFunction_Matlab,sctx);CHKERRQ(ierr);
48540807856dSBarry Smith   PetscFunctionReturn(0);
48550807856dSBarry Smith }
485669b4f73cSBarry Smith 
485761b2408cSBarry Smith #undef __FUNCT__
485861b2408cSBarry Smith #define __FUNCT__ "SNESComputeJacobian_Matlab"
485961b2408cSBarry Smith /*
486061b2408cSBarry Smith    SNESComputeJacobian_Matlab - Calls the function that has been set with
486161b2408cSBarry Smith                          SNESSetJacobianMatlab().
486261b2408cSBarry Smith 
486361b2408cSBarry Smith    Collective on SNES
486461b2408cSBarry Smith 
486561b2408cSBarry Smith    Input Parameters:
486661b2408cSBarry Smith +  snes - the SNES context
486761b2408cSBarry Smith .  x - input vector
486861b2408cSBarry Smith .  A, B - the matrices
486961b2408cSBarry Smith -  ctx - user context
487061b2408cSBarry Smith 
487161b2408cSBarry Smith    Output Parameter:
487261b2408cSBarry Smith .  flag - structure of the matrix
487361b2408cSBarry Smith 
487461b2408cSBarry Smith    Level: developer
487561b2408cSBarry Smith 
487661b2408cSBarry Smith .keywords: SNES, nonlinear, compute, function
487761b2408cSBarry Smith 
487861b2408cSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction()
487961b2408cSBarry Smith @*/
48807087cfbeSBarry Smith PetscErrorCode  SNESComputeJacobian_Matlab(SNES snes,Vec x,Mat *A,Mat *B,MatStructure *flag, void *ctx)
488161b2408cSBarry Smith {
488261b2408cSBarry Smith   PetscErrorCode    ierr;
488361b2408cSBarry Smith   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
488461b2408cSBarry Smith   int               nlhs = 2,nrhs = 6;
488561b2408cSBarry Smith   mxArray	    *plhs[2],*prhs[6];
488661b2408cSBarry Smith   long long int     lx = 0,lA = 0,ls = 0, lB = 0;
488761b2408cSBarry Smith 
488861b2408cSBarry Smith   PetscFunctionBegin;
488961b2408cSBarry Smith   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
489061b2408cSBarry Smith   PetscValidHeaderSpecific(x,VEC_CLASSID,2);
489161b2408cSBarry Smith 
489261b2408cSBarry Smith   /* call Matlab function in ctx with arguments x and y */
489361b2408cSBarry Smith 
489461b2408cSBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
489561b2408cSBarry Smith   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
489661b2408cSBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(x));CHKERRQ(ierr);
489761b2408cSBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(x));CHKERRQ(ierr);
489861b2408cSBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
489961b2408cSBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)lx);
490061b2408cSBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lA);
490161b2408cSBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lB);
490261b2408cSBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
490361b2408cSBarry Smith   prhs[5] =  sctx->ctx;
4904b807a863SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeJacobianInternal");CHKERRQ(ierr);
490561b2408cSBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
490661b2408cSBarry Smith   *flag   =  (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr);
490761b2408cSBarry Smith   mxDestroyArray(prhs[0]);
490861b2408cSBarry Smith   mxDestroyArray(prhs[1]);
490961b2408cSBarry Smith   mxDestroyArray(prhs[2]);
491061b2408cSBarry Smith   mxDestroyArray(prhs[3]);
491161b2408cSBarry Smith   mxDestroyArray(prhs[4]);
491261b2408cSBarry Smith   mxDestroyArray(plhs[0]);
491361b2408cSBarry Smith   mxDestroyArray(plhs[1]);
491461b2408cSBarry Smith   PetscFunctionReturn(0);
491561b2408cSBarry Smith }
491661b2408cSBarry Smith 
491761b2408cSBarry Smith 
491861b2408cSBarry Smith #undef __FUNCT__
491961b2408cSBarry Smith #define __FUNCT__ "SNESSetJacobianMatlab"
492061b2408cSBarry Smith /*
492161b2408cSBarry Smith    SNESSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
492261b2408cSBarry Smith    vector for use by the SNES routines in solving systems of nonlinear
4923e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
492461b2408cSBarry Smith 
492561b2408cSBarry Smith    Logically Collective on SNES
492661b2408cSBarry Smith 
492761b2408cSBarry Smith    Input Parameters:
492861b2408cSBarry Smith +  snes - the SNES context
492961b2408cSBarry Smith .  A,B - Jacobian matrices
493061b2408cSBarry Smith .  func - function evaluation routine
493161b2408cSBarry Smith -  ctx - user context
493261b2408cSBarry Smith 
493361b2408cSBarry Smith    Calling sequence of func:
493461b2408cSBarry Smith $    flag = func (SNES snes,Vec x,Mat A,Mat B,void *ctx);
493561b2408cSBarry Smith 
493661b2408cSBarry Smith 
493761b2408cSBarry Smith    Level: developer
493861b2408cSBarry Smith 
493961b2408cSBarry Smith .keywords: SNES, nonlinear, set, function
494061b2408cSBarry Smith 
494161b2408cSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
494261b2408cSBarry Smith */
49437087cfbeSBarry Smith PetscErrorCode  SNESSetJacobianMatlab(SNES snes,Mat A,Mat B,const char *func,mxArray *ctx)
494461b2408cSBarry Smith {
494561b2408cSBarry Smith   PetscErrorCode    ierr;
494661b2408cSBarry Smith   SNESMatlabContext *sctx;
494761b2408cSBarry Smith 
494861b2408cSBarry Smith   PetscFunctionBegin;
494961b2408cSBarry Smith   /* currently sctx is memory bleed */
495061b2408cSBarry Smith   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
495161b2408cSBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
495261b2408cSBarry Smith   /*
495361b2408cSBarry Smith      This should work, but it doesn't
495461b2408cSBarry Smith   sctx->ctx = ctx;
495561b2408cSBarry Smith   mexMakeArrayPersistent(sctx->ctx);
495661b2408cSBarry Smith   */
495761b2408cSBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
495861b2408cSBarry Smith   ierr = SNESSetJacobian(snes,A,B,SNESComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
495961b2408cSBarry Smith   PetscFunctionReturn(0);
496061b2408cSBarry Smith }
496169b4f73cSBarry Smith 
4962f9eb7ae2SShri Abhyankar #undef __FUNCT__
4963f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitor_Matlab"
4964f9eb7ae2SShri Abhyankar /*
4965f9eb7ae2SShri Abhyankar    SNESMonitor_Matlab - Calls the function that has been set with SNESMonitorSetMatlab().
4966f9eb7ae2SShri Abhyankar 
4967f9eb7ae2SShri Abhyankar    Collective on SNES
4968f9eb7ae2SShri Abhyankar 
4969f9eb7ae2SShri Abhyankar .seealso: SNESSetFunction(), SNESGetFunction()
4970f9eb7ae2SShri Abhyankar @*/
49717087cfbeSBarry Smith PetscErrorCode  SNESMonitor_Matlab(SNES snes,PetscInt it, PetscReal fnorm, void *ctx)
4972f9eb7ae2SShri Abhyankar {
4973f9eb7ae2SShri Abhyankar   PetscErrorCode  ierr;
497448f37e70SShri Abhyankar   SNESMatlabContext *sctx = (SNESMatlabContext *)ctx;
4975f9eb7ae2SShri Abhyankar   int             nlhs = 1,nrhs = 6;
4976f9eb7ae2SShri Abhyankar   mxArray	  *plhs[1],*prhs[6];
4977f9eb7ae2SShri Abhyankar   long long int   lx = 0,ls = 0;
4978f9eb7ae2SShri Abhyankar   Vec             x=snes->vec_sol;
4979f9eb7ae2SShri Abhyankar 
4980f9eb7ae2SShri Abhyankar   PetscFunctionBegin;
4981f9eb7ae2SShri Abhyankar   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
4982f9eb7ae2SShri Abhyankar 
4983f9eb7ae2SShri Abhyankar   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
4984f9eb7ae2SShri Abhyankar   ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr);
4985f9eb7ae2SShri Abhyankar   prhs[0] =  mxCreateDoubleScalar((double)ls);
4986f9eb7ae2SShri Abhyankar   prhs[1] =  mxCreateDoubleScalar((double)it);
4987f9eb7ae2SShri Abhyankar   prhs[2] =  mxCreateDoubleScalar((double)fnorm);
4988f9eb7ae2SShri Abhyankar   prhs[3] =  mxCreateDoubleScalar((double)lx);
4989f9eb7ae2SShri Abhyankar   prhs[4] =  mxCreateString(sctx->funcname);
4990f9eb7ae2SShri Abhyankar   prhs[5] =  sctx->ctx;
4991f9eb7ae2SShri Abhyankar   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESMonitorInternal");CHKERRQ(ierr);
4992f9eb7ae2SShri Abhyankar   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4993f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[0]);
4994f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[1]);
4995f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[2]);
4996f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[3]);
4997f9eb7ae2SShri Abhyankar   mxDestroyArray(prhs[4]);
4998f9eb7ae2SShri Abhyankar   mxDestroyArray(plhs[0]);
4999f9eb7ae2SShri Abhyankar   PetscFunctionReturn(0);
5000f9eb7ae2SShri Abhyankar }
5001f9eb7ae2SShri Abhyankar 
5002f9eb7ae2SShri Abhyankar 
5003f9eb7ae2SShri Abhyankar #undef __FUNCT__
5004f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitorSetMatlab"
5005f9eb7ae2SShri Abhyankar /*
5006e3c5b3baSBarry Smith    SNESMonitorSetMatlab - Sets the monitor function from MATLAB
5007f9eb7ae2SShri Abhyankar 
5008f9eb7ae2SShri Abhyankar    Level: developer
5009f9eb7ae2SShri Abhyankar 
5010f9eb7ae2SShri Abhyankar .keywords: SNES, nonlinear, set, function
5011f9eb7ae2SShri Abhyankar 
5012f9eb7ae2SShri Abhyankar .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction()
5013f9eb7ae2SShri Abhyankar */
50147087cfbeSBarry Smith PetscErrorCode  SNESMonitorSetMatlab(SNES snes,const char *func,mxArray *ctx)
5015f9eb7ae2SShri Abhyankar {
5016f9eb7ae2SShri Abhyankar   PetscErrorCode    ierr;
5017f9eb7ae2SShri Abhyankar   SNESMatlabContext *sctx;
5018f9eb7ae2SShri Abhyankar 
5019f9eb7ae2SShri Abhyankar   PetscFunctionBegin;
5020f9eb7ae2SShri Abhyankar   /* currently sctx is memory bleed */
5021f9eb7ae2SShri Abhyankar   ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr);
5022f9eb7ae2SShri Abhyankar   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5023f9eb7ae2SShri Abhyankar   /*
5024f9eb7ae2SShri Abhyankar      This should work, but it doesn't
5025f9eb7ae2SShri Abhyankar   sctx->ctx = ctx;
5026f9eb7ae2SShri Abhyankar   mexMakeArrayPersistent(sctx->ctx);
5027f9eb7ae2SShri Abhyankar   */
5028f9eb7ae2SShri Abhyankar   sctx->ctx = mxDuplicateArray(ctx);
5029f9eb7ae2SShri Abhyankar   ierr = SNESMonitorSet(snes,SNESMonitor_Matlab,sctx,PETSC_NULL);CHKERRQ(ierr);
5030f9eb7ae2SShri Abhyankar   PetscFunctionReturn(0);
5031f9eb7ae2SShri Abhyankar }
5032f9eb7ae2SShri Abhyankar 
503369b4f73cSBarry Smith #endif
5034